1 /*************************************************
2 * Exim - an Internet mail transport agent *
3 *************************************************/
5 /* Copyright (c) University of Cambridge 1995 - 2016 */
6 /* See the file NOTICE for conditions of use and distribution. */
8 /* The main code for delivering a message. */
12 #include "transports/smtp.h"
17 /* Data block for keeping track of subprocesses for parallel remote
20 typedef struct pardata {
21 address_item *addrlist; /* chain of addresses */
22 address_item *addr; /* next address data expected for */
23 pid_t pid; /* subprocess pid */
24 int fd; /* pipe fd for getting result from subprocess */
25 int transport_count; /* returned transport count value */
26 BOOL done; /* no more data needed */
27 uschar *msg; /* error message */
28 uschar *return_path; /* return_path for these addresses */
31 /* Values for the process_recipients variable */
33 enum { RECIP_ACCEPT, RECIP_IGNORE, RECIP_DEFER,
34 RECIP_FAIL, RECIP_FAIL_FILTER, RECIP_FAIL_TIMEOUT,
37 /* Mutually recursive functions for marking addresses done. */
39 static void child_done(address_item *, uschar *);
40 static void address_done(address_item *, uschar *);
42 /* Table for turning base-62 numbers into binary */
44 static uschar tab62[] =
45 {0,1,2,3,4,5,6,7,8,9,0,0,0,0,0,0, /* 0-9 */
46 0,10,11,12,13,14,15,16,17,18,19,20, /* A-K */
47 21,22,23,24,25,26,27,28,29,30,31,32, /* L-W */
48 33,34,35, 0, 0, 0, 0, 0, /* X-Z */
49 0,36,37,38,39,40,41,42,43,44,45,46, /* a-k */
50 47,48,49,50,51,52,53,54,55,56,57,58, /* l-w */
54 /*************************************************
55 * Local static variables *
56 *************************************************/
58 /* addr_duplicate is global because it needs to be seen from the Envelope-To
61 static address_item *addr_defer = NULL;
62 static address_item *addr_failed = NULL;
63 static address_item *addr_fallback = NULL;
64 static address_item *addr_local = NULL;
65 static address_item *addr_new = NULL;
66 static address_item *addr_remote = NULL;
67 static address_item *addr_route = NULL;
68 static address_item *addr_succeed = NULL;
69 static address_item *addr_dsntmp = NULL;
70 static address_item *addr_senddsn = NULL;
72 static FILE *message_log = NULL;
73 static BOOL update_spool;
74 static BOOL remove_journal;
75 static int parcount = 0;
76 static pardata *parlist = NULL;
77 static int return_count;
78 static uschar *frozen_info = US"";
79 static uschar *used_return_path = NULL;
83 /*************************************************
84 * Make a new address item *
85 *************************************************/
87 /* This function gets the store and initializes with default values. The
88 transport_return value defaults to DEFER, so that any unexpected failure to
89 deliver does not wipe out the message. The default unique string is set to a
90 copy of the address, so that its domain can be lowercased.
93 address the RFC822 address string
94 copy force a copy of the address
96 Returns: a pointer to an initialized address_item
100 deliver_make_addr(uschar *address, BOOL copy)
102 address_item *addr = store_get(sizeof(address_item));
103 *addr = address_defaults;
104 if (copy) address = string_copy(address);
105 addr->address = address;
106 addr->unique = string_copy(address);
113 /*************************************************
114 * Set expansion values for an address *
115 *************************************************/
117 /* Certain expansion variables are valid only when handling an address or
118 address list. This function sets them up or clears the values, according to its
122 addr the address in question, or NULL to clear values
127 deliver_set_expansions(address_item *addr)
131 const uschar ***p = address_expansions;
132 while (*p) **p++ = NULL;
136 /* Exactly what gets set depends on whether there is one or more addresses, and
137 what they contain. These first ones are always set, taking their values from
138 the first address. */
140 if (!addr->host_list)
142 deliver_host = deliver_host_address = US"";
143 deliver_host_port = 0;
147 deliver_host = addr->host_list->name;
148 deliver_host_address = addr->host_list->address;
149 deliver_host_port = addr->host_list->port;
152 deliver_recipients = addr;
153 deliver_address_data = addr->prop.address_data;
154 deliver_domain_data = addr->prop.domain_data;
155 deliver_localpart_data = addr->prop.localpart_data;
157 /* These may be unset for multiple addresses */
159 deliver_domain = addr->domain;
160 self_hostname = addr->self_hostname;
162 #ifdef EXPERIMENTAL_BRIGHTMAIL
163 bmi_deliver = 1; /* deliver by default */
164 bmi_alt_location = NULL;
165 bmi_base64_verdict = NULL;
166 bmi_base64_tracker_verdict = NULL;
169 /* If there's only one address we can set everything. */
173 address_item *addr_orig;
175 deliver_localpart = addr->local_part;
176 deliver_localpart_prefix = addr->prefix;
177 deliver_localpart_suffix = addr->suffix;
179 for (addr_orig = addr; addr_orig->parent; addr_orig = addr_orig->parent) ;
180 deliver_domain_orig = addr_orig->domain;
182 /* Re-instate any prefix and suffix in the original local part. In all
183 normal cases, the address will have a router associated with it, and we can
184 choose the caseful or caseless version accordingly. However, when a system
185 filter sets up a pipe, file, or autoreply delivery, no router is involved.
186 In this case, though, there won't be any prefix or suffix to worry about. */
188 deliver_localpart_orig = !addr_orig->router
189 ? addr_orig->local_part
190 : addr_orig->router->caseful_local_part
191 ? addr_orig->cc_local_part
192 : addr_orig->lc_local_part;
194 /* If there's a parent, make its domain and local part available, and if
195 delivering to a pipe or file, or sending an autoreply, get the local
196 part from the parent. For pipes and files, put the pipe or file string
197 into address_pipe and address_file. */
201 deliver_domain_parent = addr->parent->domain;
202 deliver_localpart_parent = !addr->parent->router
203 ? addr->parent->local_part
204 : addr->parent->router->caseful_local_part
205 ? addr->parent->cc_local_part
206 : addr->parent->lc_local_part;
208 /* File deliveries have their own flag because they need to be picked out
209 as special more often. */
211 if (testflag(addr, af_pfr))
213 if (testflag(addr, af_file)) address_file = addr->local_part;
214 else if (deliver_localpart[0] == '|') address_pipe = addr->local_part;
215 deliver_localpart = addr->parent->local_part;
216 deliver_localpart_prefix = addr->parent->prefix;
217 deliver_localpart_suffix = addr->parent->suffix;
221 #ifdef EXPERIMENTAL_BRIGHTMAIL
222 /* Set expansion variables related to Brightmail AntiSpam */
223 bmi_base64_verdict = bmi_get_base64_verdict(deliver_localpart_orig, deliver_domain_orig);
224 bmi_base64_tracker_verdict = bmi_get_base64_tracker_verdict(bmi_base64_verdict);
225 /* get message delivery status (0 - don't deliver | 1 - deliver) */
226 bmi_deliver = bmi_get_delivery_status(bmi_base64_verdict);
227 /* if message is to be delivered, get eventual alternate location */
228 if (bmi_deliver == 1)
229 bmi_alt_location = bmi_get_alt_location(bmi_base64_verdict);
234 /* For multiple addresses, don't set local part, and leave the domain and
235 self_hostname set only if it is the same for all of them. It is possible to
236 have multiple pipe and file addresses, but only when all addresses have routed
237 to the same pipe or file. */
242 if (testflag(addr, af_pfr))
244 if (testflag(addr, af_file)) address_file = addr->local_part;
245 else if (addr->local_part[0] == '|') address_pipe = addr->local_part;
247 for (addr2 = addr->next; addr2; addr2 = addr2->next)
249 if (deliver_domain && Ustrcmp(deliver_domain, addr2->domain) != 0)
250 deliver_domain = NULL;
252 && ( !addr2->self_hostname
253 || Ustrcmp(self_hostname, addr2->self_hostname) != 0
255 self_hostname = NULL;
256 if (!deliver_domain && !self_hostname) break;
264 /*************************************************
265 * Open a msglog file *
266 *************************************************/
268 /* This function is used both for normal message logs, and for files in the
269 msglog directory that are used to catch output from pipes. Try to create the
270 directory if it does not exist. From release 4.21, normal message logs should
271 be created when the message is received.
273 Called from deliver_message(), can be operating as root.
276 filename the file name
277 mode the mode required
278 error used for saying what failed
280 Returns: a file descriptor, or -1 (with errno set)
284 open_msglog_file(uschar *filename, int mode, uschar **error)
288 for (i = 2; i > 0; i--)
297 O_WRONLY|O_APPEND|O_CREAT, mode);
300 /* Set the close-on-exec flag and change the owner to the exim uid/gid (this
301 function is called as root). Double check the mode, because the group setting
302 doesn't always get set automatically. */
305 (void)fcntl(fd, F_SETFD, fcntl(fd, F_GETFD) | FD_CLOEXEC);
307 if (fchown(fd, exim_uid, exim_gid) < 0)
312 if (fchmod(fd, mode) < 0)
322 (void)directory_make(spool_directory,
323 spool_sname(US"msglog", message_subdir),
324 MSGLOG_DIRECTORY_MODE, TRUE);
334 /*************************************************
335 * Write to msglog if required *
336 *************************************************/
338 /* Write to the message log, if configured. This function may also be called
342 format a string format
348 deliver_msglog(const char *format, ...)
351 if (!message_logs) return;
352 va_start(ap, format);
353 vfprintf(message_log, format, ap);
361 /*************************************************
362 * Replicate status for batch *
363 *************************************************/
365 /* When a transport handles a batch of addresses, it may treat them
366 individually, or it may just put the status in the first one, and return FALSE,
367 requesting that the status be copied to all the others externally. This is the
368 replication function. As well as the status, it copies the transport pointer,
369 which may have changed if appendfile passed the addresses on to a different
372 Argument: pointer to the first address in a chain
377 replicate_status(address_item *addr)
380 for (addr2 = addr->next; addr2; addr2 = addr2->next)
382 addr2->transport = addr->transport;
383 addr2->transport_return = addr->transport_return;
384 addr2->basic_errno = addr->basic_errno;
385 addr2->more_errno = addr->more_errno;
386 addr2->delivery_usec = addr->delivery_usec;
387 addr2->special_action = addr->special_action;
388 addr2->message = addr->message;
389 addr2->user_message = addr->user_message;
395 /*************************************************
396 * Compare lists of hosts *
397 *************************************************/
399 /* This function is given two pointers to chains of host items, and it yields
400 TRUE if the lists refer to the same hosts in the same order, except that
402 (1) Multiple hosts with the same non-negative MX values are permitted to appear
403 in different orders. Round-robinning nameservers can cause this to happen.
405 (2) Multiple hosts with the same negative MX values less than MX_NONE are also
406 permitted to appear in different orders. This is caused by randomizing
409 This enables Exim to use a single SMTP transaction for sending to two entirely
410 different domains that happen to end up pointing at the same hosts.
413 one points to the first host list
414 two points to the second host list
416 Returns: TRUE if the lists refer to the same host set
420 same_hosts(host_item *one, host_item *two)
424 if (Ustrcmp(one->name, two->name) != 0)
427 host_item *end_one = one;
428 host_item *end_two = two;
430 /* Batch up only if there was no MX and the list was not randomized */
432 if (mx == MX_NONE) return FALSE;
434 /* Find the ends of the shortest sequence of identical MX values */
436 while ( end_one->next && end_one->next->mx == mx
437 && end_two->next && end_two->next->mx == mx)
439 end_one = end_one->next;
440 end_two = end_two->next;
443 /* If there aren't any duplicates, there's no match. */
445 if (end_one == one) return FALSE;
447 /* For each host in the 'one' sequence, check that it appears in the 'two'
448 sequence, returning FALSE if not. */
453 for (hi = two; hi != end_two->next; hi = hi->next)
454 if (Ustrcmp(one->name, hi->name) == 0) break;
455 if (hi == end_two->next) return FALSE;
456 if (one == end_one) break;
460 /* All the hosts in the 'one' sequence were found in the 'two' sequence.
461 Ensure both are pointing at the last host, and carry on as for equality. */
466 /* if the names matched but ports do not, mismatch */
467 else if (one->port != two->port)
476 /* True if both are NULL */
483 /*************************************************
484 * Compare header lines *
485 *************************************************/
487 /* This function is given two pointers to chains of header items, and it yields
488 TRUE if they are the same header texts in the same order.
491 one points to the first header list
492 two points to the second header list
494 Returns: TRUE if the lists refer to the same header set
498 same_headers(header_line *one, header_line *two)
500 for (;; one = one->next, two = two->next)
502 if (one == two) return TRUE; /* Includes the case where both NULL */
503 if (!one || !two) return FALSE;
504 if (Ustrcmp(one->text, two->text) != 0) return FALSE;
510 /*************************************************
511 * Compare string settings *
512 *************************************************/
514 /* This function is given two pointers to strings, and it returns
515 TRUE if they are the same pointer, or if the two strings are the same.
518 one points to the first string
519 two points to the second string
521 Returns: TRUE or FALSE
525 same_strings(uschar *one, uschar *two)
527 if (one == two) return TRUE; /* Includes the case where both NULL */
528 if (!one || !two) return FALSE;
529 return (Ustrcmp(one, two) == 0);
534 /*************************************************
535 * Compare uid/gid for addresses *
536 *************************************************/
538 /* This function is given a transport and two addresses. It yields TRUE if the
539 uid/gid/initgroups settings for the two addresses are going to be the same when
544 addr1 the first address
545 addr2 the second address
547 Returns: TRUE or FALSE
551 same_ugid(transport_instance *tp, address_item *addr1, address_item *addr2)
553 if ( !tp->uid_set && !tp->expand_uid
554 && !tp->deliver_as_creator
555 && ( testflag(addr1, af_uid_set) != testflag(addr2, af_gid_set)
556 || ( testflag(addr1, af_uid_set)
557 && ( addr1->uid != addr2->uid
558 || testflag(addr1, af_initgroups) != testflag(addr2, af_initgroups)
562 if ( !tp->gid_set && !tp->expand_gid
563 && ( testflag(addr1, af_gid_set) != testflag(addr2, af_gid_set)
564 || ( testflag(addr1, af_gid_set)
565 && addr1->gid != addr2->gid
575 /*************************************************
576 * Record that an address is complete *
577 *************************************************/
579 /* This function records that an address is complete. This is straightforward
580 for most addresses, where the unique address is just the full address with the
581 domain lower cased. For homonyms (addresses that are the same as one of their
582 ancestors) their are complications. Their unique addresses have \x\ prepended
583 (where x = 0, 1, 2...), so that de-duplication works correctly for siblings and
586 Exim used to record the unique addresses of homonyms as "complete". This,
587 however, fails when the pattern of redirection varies over time (e.g. if taking
588 unseen copies at only some times of day) because the prepended numbers may vary
589 from one delivery run to the next. This problem is solved by never recording
590 prepended unique addresses as complete. Instead, when a homonymic address has
591 actually been delivered via a transport, we record its basic unique address
592 followed by the name of the transport. This is checked in subsequent delivery
593 runs whenever an address is routed to a transport.
595 If the completed address is a top-level one (has no parent, which means it
596 cannot be homonymic) we also add the original address to the non-recipients
597 tree, so that it gets recorded in the spool file and therefore appears as
598 "done" in any spool listings. The original address may differ from the unique
599 address in the case of the domain.
601 Finally, this function scans the list of duplicates, marks as done any that
602 match this address, and calls child_done() for their ancestors.
605 addr address item that has been completed
606 now current time as a string
612 address_done(address_item *addr, uschar *now)
616 update_spool = TRUE; /* Ensure spool gets updated */
618 /* Top-level address */
622 tree_add_nonrecipient(addr->unique);
623 tree_add_nonrecipient(addr->address);
626 /* Homonymous child address */
628 else if (testflag(addr, af_homonym))
631 tree_add_nonrecipient(
632 string_sprintf("%s/%s", addr->unique + 3, addr->transport->name));
635 /* Non-homonymous child address */
637 else tree_add_nonrecipient(addr->unique);
639 /* Check the list of duplicate addresses and ensure they are now marked
642 for (dup = addr_duplicate; dup; dup = dup->next)
643 if (Ustrcmp(addr->unique, dup->unique) == 0)
645 tree_add_nonrecipient(dup->unique);
646 child_done(dup, now);
653 /*************************************************
654 * Decrease counts in parents and mark done *
655 *************************************************/
657 /* This function is called when an address is complete. If there is a parent
658 address, its count of children is decremented. If there are still other
659 children outstanding, the function exits. Otherwise, if the count has become
660 zero, address_done() is called to mark the parent and its duplicates complete.
661 Then loop for any earlier ancestors.
664 addr points to the completed address item
665 now the current time as a string, for writing to the message log
671 child_done(address_item *addr, uschar *now)
677 if (--addr->child_count > 0) return; /* Incomplete parent */
678 address_done(addr, now);
680 /* Log the completion of all descendents only when there is no ancestor with
681 the same original address. */
683 for (aa = addr->parent; aa; aa = aa->parent)
684 if (Ustrcmp(aa->address, addr->address) == 0) break;
687 deliver_msglog("%s %s: children all complete\n", now, addr->address);
688 DEBUG(D_deliver) debug_printf("%s: children all complete\n", addr->address);
694 /*************************************************
695 * Delivery logging support functions *
696 *************************************************/
698 /* The LOGGING() checks in d_log_interface() are complicated for backwards
699 compatibility. When outgoing interface logging was originally added, it was
700 conditional on just incoming_interface (which is off by default). The
701 outgoing_interface option is on by default to preserve this behaviour, but
702 you can enable incoming_interface and disable outgoing_interface to get I=
703 fields on incoming lines only.
707 addr The address to be logged
709 Returns: New value for s
713 d_log_interface(gstring * g)
715 if (LOGGING(incoming_interface) && LOGGING(outgoing_interface)
716 && sending_ip_address)
718 g = string_append(g, 2, US" I=[", sending_ip_address);
719 g = LOGGING(outgoing_port)
720 ? string_append(g, 2, US"]:", string_sprintf("%d", sending_port))
721 : string_catn(g, US"]", 1);
729 d_hostlog(gstring * g, address_item * addr)
731 host_item * h = addr->host_used;
733 g = string_append(g, 2, US" H=", h->name);
735 if (LOGGING(dnssec) && h->dnssec == DS_YES)
736 g = string_catn(g, US" DS", 3);
738 g = string_append(g, 3, US" [", h->address, US"]");
740 if (LOGGING(outgoing_port))
741 g = string_append(g, 2, US":", string_sprintf("%d", h->port));
744 if (LOGGING(proxy) && proxy_local_address)
746 g = string_append(g, 3, US" PRX=[", proxy_local_address, US"]");
747 if (LOGGING(outgoing_port))
748 g = string_append(g, 2, US":", string_sprintf("%d", proxy_local_port));
752 g = d_log_interface(g);
754 if (testflag(addr, af_tcp_fastopen))
755 g = string_catn(g, US" TFO", 4);
766 d_tlslog(gstring * s, address_item * addr)
768 if (LOGGING(tls_cipher) && addr->cipher)
769 s = string_append(s, 2, US" X=", addr->cipher);
770 if (LOGGING(tls_certificate_verified) && addr->cipher)
771 s = string_append(s, 2, US" CV=",
772 testflag(addr, af_cert_verified)
774 #ifdef EXPERIMENTAL_DANE
775 testflag(addr, af_dane_verified)
781 if (LOGGING(tls_peerdn) && addr->peerdn)
782 s = string_append(s, 3, US" DN=\"", string_printing(addr->peerdn), US"\"");
790 #ifndef DISABLE_EVENT
792 event_raise(uschar * action, const uschar * event, uschar * ev_data)
798 debug_printf("Event(%s): event_action=|%s| delivery_IP=%s\n",
800 action, deliver_host_address);
803 event_data = ev_data;
805 if (!(s = expand_string(action)) && *expand_string_message)
806 log_write(0, LOG_MAIN|LOG_PANIC,
807 "failed to expand event_action %s in %s: %s\n",
808 event, transport_name, expand_string_message);
810 event_name = event_data = NULL;
812 /* If the expansion returns anything but an empty string, flag for
813 the caller to modify his normal processing
818 debug_printf("Event(%s): event_action returned \"%s\"\n", event, s);
826 msg_event_raise(const uschar * event, const address_item * addr)
828 const uschar * save_domain = deliver_domain;
829 uschar * save_local = deliver_localpart;
830 const uschar * save_host = deliver_host;
831 const uschar * save_address = deliver_host_address;
832 const int save_port = deliver_host_port;
834 if (!addr->transport)
837 router_name = addr->router ? addr->router->name : NULL;
838 transport_name = addr->transport->name;
839 deliver_domain = addr->domain;
840 deliver_localpart = addr->local_part;
841 deliver_host = addr->host_used ? addr->host_used->name : NULL;
843 (void) event_raise(addr->transport->event_action, event,
845 || Ustrcmp(addr->transport->driver_name, "smtp") == 0
846 || Ustrcmp(addr->transport->driver_name, "lmtp") == 0
847 ? addr->message : NULL);
849 deliver_host_port = save_port;
850 deliver_host_address = save_address;
851 deliver_host = save_host;
852 deliver_localpart = save_local;
853 deliver_domain = save_domain;
854 router_name = transport_name = NULL;
856 #endif /*DISABLE_EVENT*/
860 /******************************************************************************/
863 /*************************************************
864 * Generate local prt for logging *
865 *************************************************/
867 /* This function is a subroutine for use in string_log_address() below.
870 addr the address being logged
871 yield the current dynamic buffer pointer
873 Returns: the new value of the buffer pointer
877 string_get_localpart(address_item * addr, gstring * yield)
882 if (testflag(addr, af_include_affixes) && s)
885 if (testflag(addr, af_utf8_downcvt))
886 s = string_localpart_utf8_to_alabel(s, NULL);
888 yield = string_cat(yield, s);
891 s = addr->local_part;
893 if (testflag(addr, af_utf8_downcvt))
894 s = string_localpart_utf8_to_alabel(s, NULL);
896 yield = string_cat(yield, s);
899 if (testflag(addr, af_include_affixes) && s)
902 if (testflag(addr, af_utf8_downcvt))
903 s = string_localpart_utf8_to_alabel(s, NULL);
905 yield = string_cat(yield, s);
912 /*************************************************
913 * Generate log address list *
914 *************************************************/
916 /* This function generates a list consisting of an address and its parents, for
917 use in logging lines. For saved onetime aliased addresses, the onetime parent
918 field is used. If the address was delivered by a transport with rcpt_include_
919 affixes set, the af_include_affixes bit will be set in the address. In that
920 case, we include the affixes here too.
923 g points to growing-string struct
924 addr bottom (ultimate) address
925 all_parents if TRUE, include all parents
926 success TRUE for successful delivery
928 Returns: a growable string in dynamic store
932 string_log_address(gstring * g,
933 address_item *addr, BOOL all_parents, BOOL success)
935 BOOL add_topaddr = TRUE;
936 address_item *topaddr;
938 /* Find the ultimate parent */
940 for (topaddr = addr; topaddr->parent; topaddr = topaddr->parent) ;
942 /* We start with just the local part for pipe, file, and reply deliveries, and
943 for successful local deliveries from routers that have the log_as_local flag
944 set. File deliveries from filters can be specified as non-absolute paths in
945 cases where the transport is going to complete the path. If there is an error
946 before this happens (expansion failure) the local part will not be updated, and
947 so won't necessarily look like a path. Add extra text for this case. */
949 if ( testflag(addr, af_pfr)
951 && addr->router && addr->router->log_as_local
952 && addr->transport && addr->transport->info->local
955 if (testflag(addr, af_file) && addr->local_part[0] != '/')
956 g = string_catn(g, CUS"save ", 5);
957 g = string_get_localpart(addr, g);
960 /* Other deliveries start with the full address. It we have split it into local
961 part and domain, use those fields. Some early failures can happen before the
962 splitting is done; in those cases use the original field. */
966 uschar * cmp = g->s + g->ptr;
968 if (addr->local_part)
971 g = string_get_localpart(addr, g);
972 g = string_catn(g, US"@", 1);
975 if (testflag(addr, af_utf8_downcvt))
976 s = string_localpart_utf8_to_alabel(s, NULL);
978 g = string_cat(g, s);
981 g = string_cat(g, addr->address);
983 /* If the address we are going to print is the same as the top address,
984 and all parents are not being included, don't add on the top address. First
985 of all, do a caseless comparison; if this succeeds, do a caseful comparison
986 on the local parts. */
987 /*XXX dodgy coding. the string at "cmp" might not be nul-terminated if
988 we had to extend the allocation! */
991 if ( strcmpic(cmp, topaddr->address) == 0
992 && Ustrncmp(cmp, topaddr->address, Ustrchr(cmp, '@') - cmp) == 0
993 && !addr->onetime_parent
994 && (!all_parents || !addr->parent || addr->parent == topaddr)
999 /* If all parents are requested, or this is a local pipe/file/reply, and
1000 there is at least one intermediate parent, show it in brackets, and continue
1001 with all of them if all are wanted. */
1003 if ( (all_parents || testflag(addr, af_pfr))
1005 && addr->parent != topaddr)
1008 address_item *addr2;
1009 for (addr2 = addr->parent; addr2 != topaddr; addr2 = addr2->parent)
1011 g = string_catn(g, s, 2);
1012 g = string_cat (g, addr2->address);
1013 if (!all_parents) break;
1016 g = string_catn(g, US")", 1);
1019 /* Add the top address if it is required */
1022 g = string_append(g, 3,
1024 addr->onetime_parent ? addr->onetime_parent : topaddr->address,
1033 timesince(struct timeval * diff, struct timeval * then)
1035 gettimeofday(diff, NULL);
1036 diff->tv_sec -= then->tv_sec;
1037 if ((diff->tv_usec -= then->tv_usec) < 0)
1040 diff->tv_usec += 1000*1000;
1047 string_timediff(struct timeval * diff)
1049 static uschar buf[sizeof("0.000s")];
1051 if (diff->tv_sec >= 5 || !LOGGING(millisec))
1052 return readconf_printtime((int)diff->tv_sec);
1054 sprintf(CS buf, "%d.%03ds", (int)diff->tv_sec, (int)diff->tv_usec/1000);
1060 string_timesince(struct timeval * then)
1062 struct timeval diff;
1064 timesince(&diff, then);
1065 return string_timediff(&diff);
1068 /******************************************************************************/
1072 /* If msg is NULL this is a delivery log and logchar is used. Otherwise
1073 this is a nonstandard call; no two-character delivery flag is written
1074 but sender-host and sender are prefixed and "msg" is inserted in the log line.
1077 flags passed to log_write()
1080 delivery_log(int flags, address_item * addr, int logchar, uschar * msg)
1082 gstring * g; /* Used for a temporary, expanding buffer, for building log lines */
1083 void * reset_point; /* released afterwards. */
1085 /* Log the delivery on the main log. We use an extensible string to build up
1086 the log line, and reset the store afterwards. Remote deliveries should always
1087 have a pointer to the host item that succeeded; local deliveries can have a
1088 pointer to a single host item in their host list, for use by the transport. */
1090 #ifndef DISABLE_EVENT
1091 /* presume no successful remote delivery */
1092 lookup_dnssec_authenticated = NULL;
1095 g = reset_point = string_get(256);
1098 g = string_append(g, 2, host_and_ident(TRUE), US" ");
1101 g->s[0] = logchar; g->ptr = 1;
1102 g = string_catn(g, US"> ", 2);
1104 g = string_log_address(g, addr, LOGGING(all_parents), TRUE);
1106 if (LOGGING(sender_on_delivery) || msg)
1107 g = string_append(g, 3, US" F=<",
1109 testflag(addr, af_utf8_downcvt)
1110 ? string_address_utf8_to_alabel(sender_address, NULL)
1117 g = string_append(g, 2, US" Q=", queue_name);
1119 #ifdef EXPERIMENTAL_SRS
1120 if(addr->prop.srs_sender)
1121 g = string_append(g, 3, US" SRS=<", addr->prop.srs_sender, US">");
1124 /* You might think that the return path must always be set for a successful
1125 delivery; indeed, I did for some time, until this statement crashed. The case
1126 when it is not set is for a delivery to /dev/null which is optimised by not
1127 being run at all. */
1129 if (used_return_path && LOGGING(return_path_on_delivery))
1130 g = string_append(g, 3, US" P=<", used_return_path, US">");
1133 g = string_append(g, 2, US" ", msg);
1135 /* For a delivery from a system filter, there may not be a router */
1137 g = string_append(g, 2, US" R=", addr->router->name);
1139 g = string_append(g, 2, US" T=", addr->transport->name);
1141 if (LOGGING(delivery_size))
1142 g = string_append(g, 2, US" S=",
1143 string_sprintf("%d", transport_count));
1145 /* Local delivery */
1147 if (addr->transport->info->local)
1149 if (addr->host_list)
1150 g = string_append(g, 2, US" H=", addr->host_list->name);
1151 g = d_log_interface(g);
1152 if (addr->shadow_message)
1153 g = string_cat(g, addr->shadow_message);
1156 /* Remote delivery */
1160 if (addr->host_used)
1162 g = d_hostlog(g, addr);
1163 if (continue_sequence > 1)
1164 g = string_catn(g, US"*", 1);
1166 #ifndef DISABLE_EVENT
1167 deliver_host_address = addr->host_used->address;
1168 deliver_host_port = addr->host_used->port;
1169 deliver_host = addr->host_used->name;
1171 /* DNS lookup status */
1172 lookup_dnssec_authenticated = addr->host_used->dnssec==DS_YES ? US"yes"
1173 : addr->host_used->dnssec==DS_NO ? US"no"
1179 g = d_tlslog(g, addr);
1182 if (addr->authenticator)
1184 g = string_append(g, 2, US" A=", addr->authenticator);
1187 g = string_append(g, 2, US":", addr->auth_id);
1188 if (LOGGING(smtp_mailauth) && addr->auth_sndr)
1189 g = string_append(g, 2, US":", addr->auth_sndr);
1193 #ifndef DISABLE_PRDR
1194 if (testflag(addr, af_prdr_used))
1195 g = string_catn(g, US" PRDR", 5);
1198 if (testflag(addr, af_chunking_used))
1199 g = string_catn(g, US" K", 2);
1202 /* confirmation message (SMTP (host_used) and LMTP (driver_name)) */
1204 if ( LOGGING(smtp_confirmation)
1206 && (addr->host_used || Ustrcmp(addr->transport->driver_name, "lmtp") == 0)
1210 unsigned lim = big_buffer_size < 1024 ? big_buffer_size : 1024;
1211 uschar *p = big_buffer;
1212 uschar *ss = addr->message;
1214 for (i = 0; i < lim && ss[i] != 0; i++) /* limit logged amount */
1216 if (ss[i] == '\"' || ss[i] == '\\') *p++ = '\\'; /* quote \ and " */
1221 g = string_append(g, 2, US" C=", big_buffer);
1224 /* Time on queue and actual time taken to deliver */
1226 if (LOGGING(queue_time))
1227 g = string_append(g, 2, US" QT=",
1228 string_timesince(&received_time));
1230 if (LOGGING(deliver_time))
1232 struct timeval diff = {.tv_sec = addr->more_errno, .tv_usec = addr->delivery_usec};
1233 g = string_append(g, 2, US" DT=", string_timediff(&diff));
1236 /* string_cat() always leaves room for the terminator. Release the
1237 store we used to build the line after writing it. */
1239 log_write(0, flags, "%s", string_from_gstring(g));
1241 #ifndef DISABLE_EVENT
1242 if (!msg) msg_event_raise(US"msg:delivery", addr);
1245 store_reset(reset_point);
1252 deferral_log(address_item * addr, uschar * now,
1253 int logflags, uschar * driver_name, uschar * driver_kind)
1258 /* Build up the line that is used for both the message log and the main
1261 g = reset_point = string_get(256);
1263 /* Create the address string for logging. Must not do this earlier, because
1264 an OK result may be changed to FAIL when a pipe returns text. */
1266 g = string_log_address(g, addr, LOGGING(all_parents), FALSE);
1269 g = string_append(g, 2, US" Q=", queue_name);
1271 /* Either driver_name contains something and driver_kind contains
1272 " router" or " transport" (note the leading space), or driver_name is
1273 a null string and driver_kind contains "routing" without the leading
1274 space, if all routing has been deferred. When a domain has been held,
1275 so nothing has been done at all, both variables contain null strings. */
1279 if (driver_kind[1] == 't' && addr->router)
1280 g = string_append(g, 2, US" R=", addr->router->name);
1281 g = string_cat(g, string_sprintf(" %c=%s", toupper(driver_kind[1]), driver_name));
1283 else if (driver_kind)
1284 g = string_append(g, 2, US" ", driver_kind);
1286 /*XXX need an s+s+p sprintf */
1287 g = string_cat(g, string_sprintf(" defer (%d)", addr->basic_errno));
1289 if (addr->basic_errno > 0)
1290 g = string_append(g, 2, US": ",
1291 US strerror(addr->basic_errno));
1293 if (addr->host_used)
1295 g = string_append(g, 5,
1296 US" H=", addr->host_used->name,
1297 US" [", addr->host_used->address, US"]");
1298 if (LOGGING(outgoing_port))
1300 int port = addr->host_used->port;
1301 g = string_append(g, 2,
1302 US":", port == PORT_NONE ? US"25" : string_sprintf("%d", port));
1307 g = string_append(g, 2, US": ", addr->message);
1309 (void) string_from_gstring(g);
1311 /* Log the deferment in the message log, but don't clutter it
1312 up with retry-time defers after the first delivery attempt. */
1314 if (deliver_firsttime || addr->basic_errno > ERRNO_RETRY_BASE)
1315 deliver_msglog("%s %s\n", now, g->s);
1317 /* Write the main log and reset the store.
1318 For errors of the type "retry time not reached" (also remotes skipped
1319 on queue run), logging is controlled by L_retry_defer. Note that this kind
1320 of error number is negative, and all the retry ones are less than any
1324 log_write(addr->basic_errno <= ERRNO_RETRY_BASE ? L_retry_defer : 0, logflags,
1327 store_reset(reset_point);
1334 failure_log(address_item * addr, uschar * driver_kind, uschar * now)
1337 gstring * g = reset_point = string_get(256);
1339 /* Build up the log line for the message and main logs */
1341 /* Create the address string for logging. Must not do this earlier, because
1342 an OK result may be changed to FAIL when a pipe returns text. */
1344 g = string_log_address(g, addr, LOGGING(all_parents), FALSE);
1346 if (LOGGING(sender_on_delivery))
1347 g = string_append(g, 3, US" F=<", sender_address, US">");
1350 g = string_append(g, 2, US" Q=", queue_name);
1352 /* Return path may not be set if no delivery actually happened */
1354 if (used_return_path && LOGGING(return_path_on_delivery))
1355 g = string_append(g, 3, US" P=<", used_return_path, US">");
1358 g = string_append(g, 2, US" R=", addr->router->name);
1359 if (addr->transport)
1360 g = string_append(g, 2, US" T=", addr->transport->name);
1362 if (addr->host_used)
1363 g = d_hostlog(g, addr);
1366 g = d_tlslog(g, addr);
1369 if (addr->basic_errno > 0)
1370 g = string_append(g, 2, US": ", US strerror(addr->basic_errno));
1373 g = string_append(g, 2, US": ", addr->message);
1375 (void) string_from_gstring(g);
1377 /* Do the logging. For the message log, "routing failed" for those cases,
1378 just to make it clearer. */
1381 deliver_msglog("%s %s failed for %s\n", now, driver_kind, g->s);
1383 deliver_msglog("%s %s\n", now, g->s);
1385 log_write(0, LOG_MAIN, "** %s", g->s);
1387 #ifndef DISABLE_EVENT
1388 msg_event_raise(US"msg:fail:delivery", addr);
1391 store_reset(reset_point);
1397 /*************************************************
1398 * Actions at the end of handling an address *
1399 *************************************************/
1401 /* This is a function for processing a single address when all that can be done
1402 with it has been done.
1405 addr points to the address block
1406 result the result of the delivery attempt
1407 logflags flags for log_write() (LOG_MAIN and/or LOG_PANIC)
1408 driver_type indicates which type of driver (transport, or router) was last
1409 to process the address
1410 logchar '=' or '-' for use when logging deliveries with => or ->
1416 post_process_one(address_item *addr, int result, int logflags, int driver_type,
1419 uschar *now = tod_stamp(tod_log);
1420 uschar *driver_kind = NULL;
1421 uschar *driver_name = NULL;
1423 DEBUG(D_deliver) debug_printf("post-process %s (%d)\n", addr->address, result);
1425 /* Set up driver kind and name for logging. Disable logging if the router or
1426 transport has disabled it. */
1428 if (driver_type == EXIM_DTYPE_TRANSPORT)
1430 if (addr->transport)
1432 driver_name = addr->transport->name;
1433 driver_kind = US" transport";
1434 disable_logging = addr->transport->disable_logging;
1436 else driver_kind = US"transporting";
1438 else if (driver_type == EXIM_DTYPE_ROUTER)
1442 driver_name = addr->router->name;
1443 driver_kind = US" router";
1444 disable_logging = addr->router->disable_logging;
1446 else driver_kind = US"routing";
1449 /* If there's an error message set, ensure that it contains only printing
1450 characters - it should, but occasionally things slip in and this at least
1451 stops the log format from getting wrecked. We also scan the message for an LDAP
1452 expansion item that has a password setting, and flatten the password. This is a
1453 fudge, but I don't know a cleaner way of doing this. (If the item is badly
1454 malformed, it won't ever have gone near LDAP.) */
1458 const uschar * s = string_printing(addr->message);
1460 /* deconst cast ok as string_printing known to have alloc'n'copied */
1461 addr->message = expand_hide_passwords(US s);
1464 /* If we used a transport that has one of the "return_output" options set, and
1465 if it did in fact generate some output, then for return_output we treat the
1466 message as failed if it was not already set that way, so that the output gets
1467 returned to the sender, provided there is a sender to send it to. For
1468 return_fail_output, do this only if the delivery failed. Otherwise we just
1469 unlink the file, and remove the name so that if the delivery failed, we don't
1470 try to send back an empty or unwanted file. The log_output options operate only
1471 on a non-empty file.
1473 In any case, we close the message file, because we cannot afford to leave a
1474 file-descriptor for one address while processing (maybe very many) others. */
1476 if (addr->return_file >= 0 && addr->return_filename)
1478 BOOL return_output = FALSE;
1479 struct stat statbuf;
1480 (void)EXIMfsync(addr->return_file);
1482 /* If there is no output, do nothing. */
1484 if (fstat(addr->return_file, &statbuf) == 0 && statbuf.st_size > 0)
1486 transport_instance *tb = addr->transport;
1488 /* Handle logging options */
1491 || result == FAIL && tb->log_fail_output
1492 || result == DEFER && tb->log_defer_output
1496 FILE *f = Ufopen(addr->return_filename, "rb");
1498 log_write(0, LOG_MAIN|LOG_PANIC, "failed to open %s to log output "
1499 "from %s transport: %s", addr->return_filename, tb->name,
1502 if ((s = US Ufgets(big_buffer, big_buffer_size, f)))
1504 uschar *p = big_buffer + Ustrlen(big_buffer);
1506 while (p > big_buffer && isspace(p[-1])) p--;
1508 sp = string_printing(big_buffer);
1509 log_write(0, LOG_MAIN, "<%s>: %s transport output: %s",
1510 addr->address, tb->name, sp);
1515 /* Handle returning options, but only if there is an address to return
1518 if (sender_address[0] != 0 || addr->prop.errors_address)
1519 if (tb->return_output)
1521 addr->transport_return = result = FAIL;
1522 if (addr->basic_errno == 0 && !addr->message)
1523 addr->message = US"return message generated";
1524 return_output = TRUE;
1527 if (tb->return_fail_output && result == FAIL) return_output = TRUE;
1530 /* Get rid of the file unless it might be returned, but close it in
1535 Uunlink(addr->return_filename);
1536 addr->return_filename = NULL;
1537 addr->return_file = -1;
1540 (void)close(addr->return_file);
1543 /* The success case happens only after delivery by a transport. */
1547 addr->next = addr_succeed;
1548 addr_succeed = addr;
1550 /* Call address_done() to ensure that we don't deliver to this address again,
1551 and write appropriate things to the message log. If it is a child address, we
1552 call child_done() to scan the ancestors and mark them complete if this is the
1553 last child to complete. */
1555 address_done(addr, now);
1556 DEBUG(D_deliver) debug_printf("%s delivered\n", addr->address);
1559 deliver_msglog("%s %s: %s%s succeeded\n", now, addr->address,
1560 driver_name, driver_kind);
1563 deliver_msglog("%s %s <%s>: %s%s succeeded\n", now, addr->address,
1564 addr->parent->address, driver_name, driver_kind);
1565 child_done(addr, now);
1568 /* Certificates for logging (via events) */
1570 tls_out.ourcert = addr->ourcert;
1571 addr->ourcert = NULL;
1572 tls_out.peercert = addr->peercert;
1573 addr->peercert = NULL;
1575 tls_out.cipher = addr->cipher;
1576 tls_out.peerdn = addr->peerdn;
1577 tls_out.ocsp = addr->ocsp;
1578 # ifdef EXPERIMENTAL_DANE
1579 tls_out.dane_verified = testflag(addr, af_dane_verified);
1583 delivery_log(LOG_MAIN, addr, logchar, NULL);
1586 tls_free_cert(&tls_out.ourcert);
1587 tls_free_cert(&tls_out.peercert);
1588 tls_out.cipher = NULL;
1589 tls_out.peerdn = NULL;
1590 tls_out.ocsp = OCSP_NOT_REQ;
1591 # ifdef EXPERIMENTAL_DANE
1592 tls_out.dane_verified = FALSE;
1598 /* Soft failure, or local delivery process failed; freezing may be
1601 else if (result == DEFER || result == PANIC)
1603 if (result == PANIC) logflags |= LOG_PANIC;
1605 /* This puts them on the chain in reverse order. Do not change this, because
1606 the code for handling retries assumes that the one with the retry
1607 information is last. */
1609 addr->next = addr_defer;
1612 /* The only currently implemented special action is to freeze the
1613 message. Logging of this is done later, just before the -H file is
1616 if (addr->special_action == SPECIAL_FREEZE)
1618 deliver_freeze = TRUE;
1619 deliver_frozen_at = time(NULL);
1620 update_spool = TRUE;
1623 /* If doing a 2-stage queue run, we skip writing to either the message
1624 log or the main log for SMTP defers. */
1626 if (!queue_2stage || addr->basic_errno != 0)
1627 deferral_log(addr, now, logflags, driver_name, driver_kind);
1631 /* Hard failure. If there is an address to which an error message can be sent,
1632 put this address on the failed list. If not, put it on the deferred list and
1633 freeze the mail message for human attention. The latter action can also be
1634 explicitly requested by a router or transport. */
1638 /* If this is a delivery error, or a message for which no replies are
1639 wanted, and the message's age is greater than ignore_bounce_errors_after,
1640 force the af_ignore_error flag. This will cause the address to be discarded
1641 later (with a log entry). */
1643 if (!*sender_address && message_age >= ignore_bounce_errors_after)
1644 addr->prop.ignore_error = TRUE;
1646 /* Freeze the message if requested, or if this is a bounce message (or other
1647 message with null sender) and this address does not have its own errors
1648 address. However, don't freeze if errors are being ignored. The actual code
1649 to ignore occurs later, instead of sending a message. Logging of freezing
1650 occurs later, just before writing the -H file. */
1652 if ( !addr->prop.ignore_error
1653 && ( addr->special_action == SPECIAL_FREEZE
1654 || (sender_address[0] == 0 && !addr->prop.errors_address)
1657 frozen_info = addr->special_action == SPECIAL_FREEZE
1659 : sender_local && !local_error_message
1660 ? US" (message created with -f <>)"
1661 : US" (delivery error message)";
1662 deliver_freeze = TRUE;
1663 deliver_frozen_at = time(NULL);
1664 update_spool = TRUE;
1666 /* The address is put on the defer rather than the failed queue, because
1667 the message is being retained. */
1669 addr->next = addr_defer;
1673 /* Don't put the address on the nonrecipients tree yet; wait until an
1674 error message has been successfully sent. */
1678 addr->next = addr_failed;
1682 failure_log(addr, driver_name ? NULL : driver_kind, now);
1685 /* Ensure logging is turned on again in all cases */
1687 disable_logging = FALSE;
1693 /*************************************************
1694 * Address-independent error *
1695 *************************************************/
1697 /* This function is called when there's an error that is not dependent on a
1698 particular address, such as an expansion string failure. It puts the error into
1699 all the addresses in a batch, logs the incident on the main and panic logs, and
1700 clears the expansions. It is mostly called from local_deliver(), but can be
1701 called for a remote delivery via findugid().
1704 logit TRUE if (MAIN+PANIC) logging required
1705 addr the first of the chain of addresses
1707 format format string for error message, or NULL if already set in addr
1708 ... arguments for the format
1714 common_error(BOOL logit, address_item *addr, int code, uschar *format, ...)
1716 address_item *addr2;
1717 addr->basic_errno = code;
1723 va_start(ap, format);
1724 if (!string_vformat(buffer, sizeof(buffer), CS format, ap))
1725 log_write(0, LOG_MAIN|LOG_PANIC_DIE,
1726 "common_error expansion was longer than " SIZE_T_FMT, sizeof(buffer));
1728 addr->message = string_copy(buffer);
1731 for (addr2 = addr->next; addr2; addr2 = addr2->next)
1733 addr2->basic_errno = code;
1734 addr2->message = addr->message;
1737 if (logit) log_write(0, LOG_MAIN|LOG_PANIC, "%s", addr->message);
1738 deliver_set_expansions(NULL);
1744 /*************************************************
1745 * Check a "never users" list *
1746 *************************************************/
1748 /* This function is called to check whether a uid is on one of the two "never
1752 uid the uid to be checked
1753 nusers the list to be scanned; the first item in the list is the count
1755 Returns: TRUE if the uid is on the list
1759 check_never_users(uid_t uid, uid_t *nusers)
1762 if (!nusers) return FALSE;
1763 for (i = 1; i <= (int)(nusers[0]); i++) if (nusers[i] == uid) return TRUE;
1769 /*************************************************
1770 * Find uid and gid for a transport *
1771 *************************************************/
1773 /* This function is called for both local and remote deliveries, to find the
1774 uid/gid under which to run the delivery. The values are taken preferentially
1775 from the transport (either explicit or deliver_as_creator), then from the
1776 address (i.e. the router), and if nothing is set, the exim uid/gid are used. If
1777 the resulting uid is on the "never_users" or the "fixed_never_users" list, a
1778 panic error is logged, and the function fails (which normally leads to delivery
1782 addr the address (possibly a chain)
1784 uidp pointer to uid field
1785 gidp pointer to gid field
1786 igfp pointer to the use_initgroups field
1788 Returns: FALSE if failed - error has been set in address(es)
1792 findugid(address_item *addr, transport_instance *tp, uid_t *uidp, gid_t *gidp,
1796 BOOL gid_set = FALSE;
1798 /* Default initgroups flag comes from the transport */
1800 *igfp = tp->initgroups;
1802 /* First see if there's a gid on the transport, either fixed or expandable.
1803 The expanding function always logs failure itself. */
1810 else if (tp->expand_gid)
1812 if (!route_find_expanded_group(tp->expand_gid, tp->name, US"transport", gidp,
1815 common_error(FALSE, addr, ERRNO_GIDFAIL, NULL);
1821 /* If the transport did not set a group, see if the router did. */
1823 if (!gid_set && testflag(addr, af_gid_set))
1829 /* Pick up a uid from the transport if one is set. */
1831 if (tp->uid_set) *uidp = tp->uid;
1833 /* Otherwise, try for an expandable uid field. If it ends up as a numeric id,
1834 it does not provide a passwd value from which a gid can be taken. */
1836 else if (tp->expand_uid)
1839 if (!route_find_expanded_user(tp->expand_uid, tp->name, US"transport", &pw,
1840 uidp, &(addr->message)))
1842 common_error(FALSE, addr, ERRNO_UIDFAIL, NULL);
1852 /* If the transport doesn't set the uid, test the deliver_as_creator flag. */
1854 else if (tp->deliver_as_creator)
1856 *uidp = originator_uid;
1859 *gidp = originator_gid;
1864 /* Otherwise see if the address specifies the uid and if so, take it and its
1867 else if (testflag(addr, af_uid_set))
1870 *igfp = testflag(addr, af_initgroups);
1873 /* Nothing has specified the uid - default to the Exim user, and group if the
1886 /* If no gid is set, it is a disaster. We default to the Exim gid only if
1887 defaulting to the Exim uid. In other words, if the configuration has specified
1888 a uid, it must also provide a gid. */
1892 common_error(TRUE, addr, ERRNO_GIDFAIL, US"User set without group for "
1893 "%s transport", tp->name);
1897 /* Check that the uid is not on the lists of banned uids that may not be used
1898 for delivery processes. */
1900 nuname = check_never_users(*uidp, never_users)
1902 : check_never_users(*uidp, fixed_never_users)
1903 ? US"fixed_never_users"
1907 common_error(TRUE, addr, ERRNO_UIDFAIL, US"User %ld set for %s transport "
1908 "is on the %s list", (long int)(*uidp), tp->name, nuname);
1920 /*************************************************
1921 * Check the size of a message for a transport *
1922 *************************************************/
1924 /* Checks that the message isn't too big for the selected transport.
1925 This is called only when it is known that the limit is set.
1929 addr the (first) address being delivered
1932 DEFER expansion failed or did not yield an integer
1933 FAIL message too big
1937 check_message_size(transport_instance *tp, address_item *addr)
1942 deliver_set_expansions(addr);
1943 size_limit = expand_string_integer(tp->message_size_limit, TRUE);
1944 deliver_set_expansions(NULL);
1946 if (expand_string_message)
1949 addr->message = size_limit == -1
1950 ? string_sprintf("failed to expand message_size_limit "
1951 "in %s transport: %s", tp->name, expand_string_message)
1952 : string_sprintf("invalid message_size_limit "
1953 "in %s transport: %s", tp->name, expand_string_message);
1955 else if (size_limit > 0 && message_size > size_limit)
1959 string_sprintf("message is too big (transport limit = %d)",
1968 /*************************************************
1969 * Transport-time check for a previous delivery *
1970 *************************************************/
1972 /* Check that this base address hasn't previously been delivered to its routed
1973 transport. If it has been delivered, mark it done. The check is necessary at
1974 delivery time in order to handle homonymic addresses correctly in cases where
1975 the pattern of redirection changes between delivery attempts (so the unique
1976 fields change). Non-homonymic previous delivery is detected earlier, at routing
1977 time (which saves unnecessary routing).
1980 addr the address item
1981 testing TRUE if testing wanted only, without side effects
1983 Returns: TRUE if previously delivered by the transport
1987 previously_transported(address_item *addr, BOOL testing)
1989 (void)string_format(big_buffer, big_buffer_size, "%s/%s",
1990 addr->unique + (testflag(addr, af_homonym)? 3:0), addr->transport->name);
1992 if (tree_search(tree_nonrecipients, big_buffer) != 0)
1994 DEBUG(D_deliver|D_route|D_transport)
1995 debug_printf("%s was previously delivered (%s transport): discarded\n",
1996 addr->address, addr->transport->name);
1997 if (!testing) child_done(addr, tod_stamp(tod_log));
2006 /******************************************************
2007 * Check for a given header in a header string *
2008 ******************************************************/
2010 /* This function is used when generating quota warnings. The configuration may
2011 specify any header lines it likes in quota_warn_message. If certain of them are
2012 missing, defaults are inserted, so we need to be able to test for the presence
2016 hdr the required header name
2017 hstring the header string
2019 Returns: TRUE the header is in the string
2020 FALSE the header is not in the string
2024 contains_header(uschar *hdr, uschar *hstring)
2026 int len = Ustrlen(hdr);
2027 uschar *p = hstring;
2030 if (strncmpic(p, hdr, len) == 0)
2033 while (*p == ' ' || *p == '\t') p++;
2034 if (*p == ':') return TRUE;
2036 while (*p != 0 && *p != '\n') p++;
2037 if (*p == '\n') p++;
2045 /*************************************************
2046 * Perform a local delivery *
2047 *************************************************/
2049 /* Each local delivery is performed in a separate process which sets its
2050 uid and gid as specified. This is a safer way than simply changing and
2051 restoring using seteuid(); there is a body of opinion that seteuid() cannot be
2052 used safely. From release 4, Exim no longer makes any use of it. Besides, not
2053 all systems have seteuid().
2055 If the uid/gid are specified in the transport_instance, they are used; the
2056 transport initialization must ensure that either both or neither are set.
2057 Otherwise, the values associated with the address are used. If neither are set,
2058 it is a configuration error.
2060 The transport or the address may specify a home directory (transport over-
2061 rides), and if they do, this is set as $home. If neither have set a working
2062 directory, this value is used for that as well. Otherwise $home is left unset
2063 and the cwd is set to "/" - a directory that should be accessible to all users.
2065 Using a separate process makes it more complicated to get error information
2066 back. We use a pipe to pass the return code and also an error code and error
2067 text string back to the parent process.
2070 addr points to an address block for this delivery; for "normal" local
2071 deliveries this is the only address to be delivered, but for
2072 pseudo-remote deliveries (e.g. by batch SMTP to a file or pipe)
2073 a number of addresses can be handled simultaneously, and in this
2074 case addr will point to a chain of addresses with the same
2077 shadowing TRUE if running a shadow transport; this causes output from pipes
2084 deliver_local(address_item *addr, BOOL shadowing)
2086 BOOL use_initgroups;
2089 int status, len, rc;
2092 uschar *working_directory;
2093 address_item *addr2;
2094 transport_instance *tp = addr->transport;
2096 /* Set up the return path from the errors or sender address. If the transport
2097 has its own return path setting, expand it and replace the existing value. */
2099 if(addr->prop.errors_address)
2100 return_path = addr->prop.errors_address;
2101 #ifdef EXPERIMENTAL_SRS
2102 else if (addr->prop.srs_sender)
2103 return_path = addr->prop.srs_sender;
2106 return_path = sender_address;
2108 if (tp->return_path)
2110 uschar *new_return_path = expand_string(tp->return_path);
2111 if (!new_return_path)
2113 if (!expand_string_forcedfail)
2115 common_error(TRUE, addr, ERRNO_EXPANDFAIL,
2116 US"Failed to expand return path \"%s\" in %s transport: %s",
2117 tp->return_path, tp->name, expand_string_message);
2121 else return_path = new_return_path;
2124 /* For local deliveries, one at a time, the value used for logging can just be
2125 set directly, once and for all. */
2127 used_return_path = return_path;
2129 /* Sort out the uid, gid, and initgroups flag. If an error occurs, the message
2130 gets put into the address(es), and the expansions are unset, so we can just
2133 if (!findugid(addr, tp, &uid, &gid, &use_initgroups)) return;
2135 /* See if either the transport or the address specifies a home directory. A
2136 home directory set in the address may already be expanded; a flag is set to
2137 indicate that. In other cases we must expand it. */
2139 if ( (deliver_home = tp->home_dir) /* Set in transport, or */
2140 || ( (deliver_home = addr->home_dir) /* Set in address and */
2141 && !testflag(addr, af_home_expanded) /* not expanded */
2144 uschar *rawhome = deliver_home;
2145 deliver_home = NULL; /* in case it contains $home */
2146 if (!(deliver_home = expand_string(rawhome)))
2148 common_error(TRUE, addr, ERRNO_EXPANDFAIL, US"home directory \"%s\" failed "
2149 "to expand for %s transport: %s", rawhome, tp->name,
2150 expand_string_message);
2153 if (*deliver_home != '/')
2155 common_error(TRUE, addr, ERRNO_NOTABSOLUTE, US"home directory path \"%s\" "
2156 "is not absolute for %s transport", deliver_home, tp->name);
2161 /* See if either the transport or the address specifies a current directory,
2162 and if so, expand it. If nothing is set, use the home directory, unless it is
2163 also unset in which case use "/", which is assumed to be a directory to which
2164 all users have access. It is necessary to be in a visible directory for some
2165 operating systems when running pipes, as some commands (e.g. "rm" under Solaris
2166 2.5) require this. */
2168 working_directory = tp->current_dir ? tp->current_dir : addr->current_dir;
2169 if (working_directory)
2171 uschar *raw = working_directory;
2172 if (!(working_directory = expand_string(raw)))
2174 common_error(TRUE, addr, ERRNO_EXPANDFAIL, US"current directory \"%s\" "
2175 "failed to expand for %s transport: %s", raw, tp->name,
2176 expand_string_message);
2179 if (*working_directory != '/')
2181 common_error(TRUE, addr, ERRNO_NOTABSOLUTE, US"current directory path "
2182 "\"%s\" is not absolute for %s transport", working_directory, tp->name);
2186 else working_directory = deliver_home ? deliver_home : US"/";
2188 /* If one of the return_output flags is set on the transport, create and open a
2189 file in the message log directory for the transport to write its output onto.
2190 This is mainly used by pipe transports. The file needs to be unique to the
2191 address. This feature is not available for shadow transports. */
2194 && ( tp->return_output || tp->return_fail_output
2195 || tp->log_output || tp->log_fail_output || tp->log_defer_output
2200 addr->return_filename =
2201 spool_fname(US"msglog", message_subdir, message_id,
2202 string_sprintf("-%d-%d", getpid(), return_count++));
2204 if ((addr->return_file = open_msglog_file(addr->return_filename, 0400, &error)) < 0)
2206 common_error(TRUE, addr, errno, US"Unable to %s file for %s transport "
2207 "to return message: %s", error, tp->name, strerror(errno));
2212 /* Create the pipe for inter-process communication. */
2216 common_error(TRUE, addr, ERRNO_PIPEFAIL, US"Creation of pipe failed: %s",
2221 /* Now fork the process to do the real work in the subprocess, but first
2222 ensure that all cached resources are freed so that the subprocess starts with
2223 a clean slate and doesn't interfere with the parent process. */
2227 if ((pid = fork()) == 0)
2229 BOOL replicate = TRUE;
2231 /* Prevent core dumps, as we don't want them in users' home directories.
2232 HP-UX doesn't have RLIMIT_CORE; I don't know how to do this in that
2233 system. Some experimental/developing systems (e.g. GNU/Hurd) may define
2234 RLIMIT_CORE but not support it in setrlimit(). For such systems, do not
2235 complain if the error is "not supported".
2237 There are two scenarios where changing the max limit has an effect. In one,
2238 the user is using a .forward and invoking a command of their choice via pipe;
2239 for these, we do need the max limit to be 0 unless the admin chooses to
2240 permit an increased limit. In the other, the command is invoked directly by
2241 the transport and is under administrator control, thus being able to raise
2242 the limit aids in debugging. So there's no general always-right answer.
2244 Thus we inhibit core-dumps completely but let individual transports, while
2245 still root, re-raise the limits back up to aid debugging. We make the
2246 default be no core-dumps -- few enough people can use core dumps in
2247 diagnosis that it's reasonable to make them something that has to be explicitly requested.
2254 if (setrlimit(RLIMIT_CORE, &rl) < 0)
2256 # ifdef SETRLIMIT_NOT_SUPPORTED
2257 if (errno != ENOSYS && errno != ENOTSUP)
2259 log_write(0, LOG_MAIN|LOG_PANIC, "setrlimit(RLIMIT_CORE) failed: %s",
2264 /* Reset the random number generator, so different processes don't all
2265 have the same sequence. */
2269 /* If the transport has a setup entry, call this first, while still
2270 privileged. (Appendfile uses this to expand quota, for example, while
2271 able to read private files.) */
2273 if (addr->transport->setup)
2274 switch((addr->transport->setup)(addr->transport, addr, NULL, uid, gid,
2278 addr->transport_return = DEFER;
2282 addr->transport_return = PANIC;
2286 /* Ignore SIGINT and SIGTERM during delivery. Also ignore SIGUSR1, as
2287 when the process becomes unprivileged, it won't be able to write to the
2288 process log. SIGHUP is ignored throughout exim, except when it is being
2291 signal(SIGINT, SIG_IGN);
2292 signal(SIGTERM, SIG_IGN);
2293 signal(SIGUSR1, SIG_IGN);
2295 /* Close the unwanted half of the pipe, and set close-on-exec for the other
2296 half - for transports that exec things (e.g. pipe). Then set the required
2299 (void)close(pfd[pipe_read]);
2300 (void)fcntl(pfd[pipe_write], F_SETFD, fcntl(pfd[pipe_write], F_GETFD) |
2302 exim_setugid(uid, gid, use_initgroups,
2303 string_sprintf("local delivery to %s <%s> transport=%s", addr->local_part,
2304 addr->address, addr->transport->name));
2308 address_item *batched;
2309 debug_printf(" home=%s current=%s\n", deliver_home, working_directory);
2310 for (batched = addr->next; batched; batched = batched->next)
2311 debug_printf("additional batched address: %s\n", batched->address);
2314 /* Set an appropriate working directory. */
2316 if (Uchdir(working_directory) < 0)
2318 addr->transport_return = DEFER;
2319 addr->basic_errno = errno;
2320 addr->message = string_sprintf("failed to chdir to %s", working_directory);
2323 /* If successful, call the transport */
2328 set_process_info("delivering %s to %s using %s", message_id,
2329 addr->local_part, addr->transport->name);
2331 /* Setting this global in the subprocess means we need never clear it */
2332 transport_name = addr->transport->name;
2334 /* If a transport filter has been specified, set up its argument list.
2335 Any errors will get put into the address, and FALSE yielded. */
2337 if (addr->transport->filter_command)
2339 ok = transport_set_up_command(&transport_filter_argv,
2340 addr->transport->filter_command,
2341 TRUE, PANIC, addr, US"transport filter", NULL);
2342 transport_filter_timeout = addr->transport->filter_timeout;
2344 else transport_filter_argv = NULL;
2348 debug_print_string(addr->transport->debug_string);
2349 replicate = !(addr->transport->info->code)(addr->transport, addr);
2353 /* Pass the results back down the pipe. If necessary, first replicate the
2354 status in the top address to the others in the batch. The label is the
2355 subject of a goto when a call to the transport's setup function fails. We
2356 pass the pointer to the transport back in case it got changed as a result of
2357 file_format in appendfile. */
2361 if (replicate) replicate_status(addr);
2362 for (addr2 = addr; addr2; addr2 = addr2->next)
2365 int local_part_length = Ustrlen(addr2->local_part);
2369 if( (ret = write(pfd[pipe_write], &addr2->transport_return, sizeof(int))) != sizeof(int)
2370 || (ret = write(pfd[pipe_write], &transport_count, sizeof(transport_count))) != sizeof(transport_count)
2371 || (ret = write(pfd[pipe_write], &addr2->flags, sizeof(addr2->flags))) != sizeof(addr2->flags)
2372 || (ret = write(pfd[pipe_write], &addr2->basic_errno, sizeof(int))) != sizeof(int)
2373 || (ret = write(pfd[pipe_write], &addr2->more_errno, sizeof(int))) != sizeof(int)
2374 || (ret = write(pfd[pipe_write], &addr2->delivery_usec, sizeof(int))) != sizeof(int)
2375 || (ret = write(pfd[pipe_write], &addr2->special_action, sizeof(int))) != sizeof(int)
2376 || (ret = write(pfd[pipe_write], &addr2->transport,
2377 sizeof(transport_instance *))) != sizeof(transport_instance *)
2379 /* For a file delivery, pass back the local part, in case the original
2380 was only part of the final delivery path. This gives more complete
2383 || (testflag(addr2, af_file)
2384 && ( (ret = write(pfd[pipe_write], &local_part_length, sizeof(int))) != sizeof(int)
2385 || (ret = write(pfd[pipe_write], addr2->local_part, local_part_length)) != local_part_length
2389 log_write(0, LOG_MAIN|LOG_PANIC, "Failed writing transport results to pipe: %s",
2390 ret == -1 ? strerror(errno) : "short write");
2392 /* Now any messages */
2394 for (i = 0, s = addr2->message; i < 2; i++, s = addr2->user_message)
2396 int message_length = s ? Ustrlen(s) + 1 : 0;
2397 if( (ret = write(pfd[pipe_write], &message_length, sizeof(int))) != sizeof(int)
2398 || message_length > 0 && (ret = write(pfd[pipe_write], s, message_length)) != message_length
2400 log_write(0, LOG_MAIN|LOG_PANIC, "Failed writing transport results to pipe: %s",
2401 ret == -1 ? strerror(errno) : "short write");
2405 /* OK, this process is now done. Free any cached resources that it opened,
2406 and close the pipe we were writing down before exiting. */
2408 (void)close(pfd[pipe_write]);
2413 /* Back in the main process: panic if the fork did not succeed. This seems
2414 better than returning an error - if forking is failing it is probably best
2415 not to try other deliveries for this message. */
2418 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Fork failed for local delivery to %s",
2421 /* Read the pipe to get the delivery status codes and error messages. Our copy
2422 of the writing end must be closed first, as otherwise read() won't return zero
2423 on an empty pipe. We check that a status exists for each address before
2424 overwriting the address structure. If data is missing, the default DEFER status
2425 will remain. Afterwards, close the reading end. */
2427 (void)close(pfd[pipe_write]);
2429 for (addr2 = addr; addr2; addr2 = addr2->next)
2431 if ((len = read(pfd[pipe_read], &status, sizeof(int))) > 0)
2436 addr2->transport_return = status;
2437 len = read(pfd[pipe_read], &transport_count,
2438 sizeof(transport_count));
2439 len = read(pfd[pipe_read], &addr2->flags, sizeof(addr2->flags));
2440 len = read(pfd[pipe_read], &addr2->basic_errno, sizeof(int));
2441 len = read(pfd[pipe_read], &addr2->more_errno, sizeof(int));
2442 len = read(pfd[pipe_read], &addr2->delivery_usec, sizeof(int));
2443 len = read(pfd[pipe_read], &addr2->special_action, sizeof(int));
2444 len = read(pfd[pipe_read], &addr2->transport,
2445 sizeof(transport_instance *));
2447 if (testflag(addr2, af_file))
2450 if ( read(pfd[pipe_read], &llen, sizeof(int)) != sizeof(int)
2451 || llen > 64*4 /* limit from rfc 5821, times I18N factor */
2454 log_write(0, LOG_MAIN|LOG_PANIC, "bad local_part length read"
2455 " from delivery subprocess");
2458 /* sanity-checked llen so disable the Coverity error */
2459 /* coverity[tainted_data] */
2460 if (read(pfd[pipe_read], big_buffer, llen) != llen)
2462 log_write(0, LOG_MAIN|LOG_PANIC, "bad local_part read"
2463 " from delivery subprocess");
2466 big_buffer[llen] = 0;
2467 addr2->local_part = string_copy(big_buffer);
2470 for (i = 0, sptr = &addr2->message; i < 2; i++, sptr = &addr2->user_message)
2473 len = read(pfd[pipe_read], &message_length, sizeof(int));
2474 if (message_length > 0)
2476 len = read(pfd[pipe_read], big_buffer, message_length);
2477 big_buffer[big_buffer_size-1] = '\0'; /* guard byte */
2478 if (len > 0) *sptr = string_copy(big_buffer);
2485 log_write(0, LOG_MAIN|LOG_PANIC, "failed to read delivery status for %s "
2486 "from delivery subprocess", addr2->unique);
2491 (void)close(pfd[pipe_read]);
2493 /* Unless shadowing, write all successful addresses immediately to the journal
2494 file, to ensure they are recorded asap. For homonymic addresses, use the base
2495 address plus the transport name. Failure to write the journal is panic-worthy,
2496 but don't stop, as it may prove possible subsequently to update the spool file
2497 in order to record the delivery. */
2501 for (addr2 = addr; addr2; addr2 = addr2->next)
2502 if (addr2->transport_return == OK)
2504 if (testflag(addr2, af_homonym))
2505 sprintf(CS big_buffer, "%.500s/%s\n", addr2->unique + 3, tp->name);
2507 sprintf(CS big_buffer, "%.500s\n", addr2->unique);
2509 /* In the test harness, wait just a bit to let the subprocess finish off
2510 any debug output etc first. */
2512 if (running_in_test_harness) millisleep(300);
2514 DEBUG(D_deliver) debug_printf("journalling %s", big_buffer);
2515 len = Ustrlen(big_buffer);
2516 if (write(journal_fd, big_buffer, len) != len)
2517 log_write(0, LOG_MAIN|LOG_PANIC, "failed to update journal for %s: %s",
2518 big_buffer, strerror(errno));
2521 /* Ensure the journal file is pushed out to disk. */
2523 if (EXIMfsync(journal_fd) < 0)
2524 log_write(0, LOG_MAIN|LOG_PANIC, "failed to fsync journal: %s",
2528 /* Wait for the process to finish. If it terminates with a non-zero code,
2529 freeze the message (except for SIGTERM, SIGKILL and SIGQUIT), but leave the
2530 status values of all the addresses as they are. Take care to handle the case
2531 when the subprocess doesn't seem to exist. This has been seen on one system
2532 when Exim was called from an MUA that set SIGCHLD to SIG_IGN. When that
2533 happens, wait() doesn't recognize the termination of child processes. Exim now
2534 resets SIGCHLD to SIG_DFL, but this code should still be robust. */
2536 while ((rc = wait(&status)) != pid)
2537 if (rc < 0 && errno == ECHILD) /* Process has vanished */
2539 log_write(0, LOG_MAIN, "%s transport process vanished unexpectedly",
2540 addr->transport->driver_name);
2545 if ((status & 0xffff) != 0)
2547 int msb = (status >> 8) & 255;
2548 int lsb = status & 255;
2549 int code = (msb == 0)? (lsb & 0x7f) : msb;
2550 if (msb != 0 || (code != SIGTERM && code != SIGKILL && code != SIGQUIT))
2551 addr->special_action = SPECIAL_FREEZE;
2552 log_write(0, LOG_MAIN|LOG_PANIC, "%s transport process returned non-zero "
2553 "status 0x%04x: %s %d",
2554 addr->transport->driver_name,
2556 msb == 0 ? "terminated by signal" : "exit code",
2560 /* If SPECIAL_WARN is set in the top address, send a warning message. */
2562 if (addr->special_action == SPECIAL_WARN && addr->transport->warn_message)
2565 uschar *warn_message;
2568 DEBUG(D_deliver) debug_printf("Warning message requested by transport\n");
2570 if (!(warn_message = expand_string(addr->transport->warn_message)))
2571 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand \"%s\" (warning "
2572 "message for %s transport): %s", addr->transport->warn_message,
2573 addr->transport->name, expand_string_message);
2575 else if ((pid = child_open_exim(&fd)) > 0)
2577 FILE *f = fdopen(fd, "wb");
2578 if (errors_reply_to && !contains_header(US"Reply-To", warn_message))
2579 fprintf(f, "Reply-To: %s\n", errors_reply_to);
2580 fprintf(f, "Auto-Submitted: auto-replied\n");
2581 if (!contains_header(US"From", warn_message))
2583 fprintf(f, "%s", CS warn_message);
2585 /* Close and wait for child process to complete, without a timeout. */
2588 (void)child_close(pid, 0);
2591 addr->special_action = SPECIAL_NONE;
2598 /* Check transport for the given concurrency limit. Return TRUE if over
2599 the limit (or an expansion failure), else FALSE and if there was a limit,
2600 the key for the hints database used for the concurrency count. */
2603 tpt_parallel_check(transport_instance * tp, address_item * addr, uschar ** key)
2605 unsigned max_parallel;
2607 if (!tp->max_parallel) return FALSE;
2609 max_parallel = (unsigned) expand_string_integer(tp->max_parallel, TRUE);
2610 if (expand_string_message)
2612 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand max_parallel option "
2613 "in %s transport (%s): %s", tp->name, addr->address,
2614 expand_string_message);
2618 if (max_parallel > 0)
2620 uschar * serialize_key = string_sprintf("tpt-serialize-%s", tp->name);
2621 if (!enq_start(serialize_key, max_parallel))
2623 address_item * next;
2625 debug_printf("skipping tpt %s because concurrency limit %u reached\n",
2626 tp->name, max_parallel);
2630 addr->message = US"concurrency limit reached for transport";
2631 addr->basic_errno = ERRNO_TRETRY;
2632 post_process_one(addr, DEFER, LOG_MAIN, EXIM_DTYPE_TRANSPORT, 0);
2633 } while ((addr = next));
2636 *key = serialize_key;
2643 /*************************************************
2644 * Do local deliveries *
2645 *************************************************/
2647 /* This function processes the list of addresses in addr_local. True local
2648 deliveries are always done one address at a time. However, local deliveries can
2649 be batched up in some cases. Typically this is when writing batched SMTP output
2650 files for use by some external transport mechanism, or when running local
2651 deliveries over LMTP.
2658 do_local_deliveries(void)
2661 open_db *dbm_file = NULL;
2662 time_t now = time(NULL);
2664 /* Loop until we have exhausted the supply of local deliveries */
2668 struct timeval delivery_start;
2669 struct timeval deliver_time;
2670 address_item *addr2, *addr3, *nextaddr;
2671 int logflags = LOG_MAIN;
2672 int logchar = dont_deliver? '*' : '=';
2673 transport_instance *tp;
2674 uschar * serialize_key = NULL;
2676 /* Pick the first undelivered address off the chain */
2678 address_item *addr = addr_local;
2679 addr_local = addr->next;
2682 DEBUG(D_deliver|D_transport)
2683 debug_printf("--------> %s <--------\n", addr->address);
2685 /* An internal disaster if there is no transport. Should not occur! */
2687 if (!(tp = addr->transport))
2689 logflags |= LOG_PANIC;
2690 disable_logging = FALSE; /* Jic */
2691 addr->message = addr->router
2692 ? string_sprintf("No transport set by %s router", addr->router->name)
2693 : string_sprintf("No transport set by system filter");
2694 post_process_one(addr, DEFER, logflags, EXIM_DTYPE_TRANSPORT, 0);
2698 /* Check that this base address hasn't previously been delivered to this
2699 transport. The check is necessary at this point to handle homonymic addresses
2700 correctly in cases where the pattern of redirection changes between delivery
2701 attempts. Non-homonymic previous delivery is detected earlier, at routing
2704 if (previously_transported(addr, FALSE)) continue;
2706 /* There are weird cases where logging is disabled */
2708 disable_logging = tp->disable_logging;
2710 /* Check for batched addresses and possible amalgamation. Skip all the work
2711 if either batch_max <= 1 or there aren't any other addresses for local
2714 if (tp->batch_max > 1 && addr_local)
2716 int batch_count = 1;
2717 BOOL uses_dom = readconf_depends((driver_instance *)tp, US"domain");
2718 BOOL uses_lp = ( testflag(addr, af_pfr)
2719 && (testflag(addr, af_file) || addr->local_part[0] == '|')
2721 || readconf_depends((driver_instance *)tp, US"local_part");
2722 uschar *batch_id = NULL;
2723 address_item **anchor = &addr_local;
2724 address_item *last = addr;
2727 /* Expand the batch_id string for comparison with other addresses.
2728 Expansion failure suppresses batching. */
2732 deliver_set_expansions(addr);
2733 batch_id = expand_string(tp->batch_id);
2734 deliver_set_expansions(NULL);
2737 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand batch_id option "
2738 "in %s transport (%s): %s", tp->name, addr->address,
2739 expand_string_message);
2740 batch_count = tp->batch_max;
2744 /* Until we reach the batch_max limit, pick off addresses which have the
2745 same characteristics. These are:
2748 not previously delivered (see comment about 50 lines above)
2749 same local part if the transport's configuration contains $local_part
2750 or if this is a file or pipe delivery from a redirection
2751 same domain if the transport's configuration contains $domain
2753 same additional headers
2754 same headers to be removed
2755 same uid/gid for running the transport
2756 same first host if a host list is set
2759 while ((next = *anchor) && batch_count < tp->batch_max)
2762 tp == next->transport
2763 && !previously_transported(next, TRUE)
2764 && testflag(addr, af_pfr) == testflag(next, af_pfr)
2765 && testflag(addr, af_file) == testflag(next, af_file)
2766 && (!uses_lp || Ustrcmp(next->local_part, addr->local_part) == 0)
2767 && (!uses_dom || Ustrcmp(next->domain, addr->domain) == 0)
2768 && same_strings(next->prop.errors_address, addr->prop.errors_address)
2769 && same_headers(next->prop.extra_headers, addr->prop.extra_headers)
2770 && same_strings(next->prop.remove_headers, addr->prop.remove_headers)
2771 && same_ugid(tp, addr, next)
2772 && ( !addr->host_list && !next->host_list
2775 && Ustrcmp(addr->host_list->name, next->host_list->name) == 0
2778 /* If the transport has a batch_id setting, batch_id will be non-NULL
2779 from the expansion outside the loop. Expand for this address and compare.
2780 Expansion failure makes this address ineligible for batching. */
2785 address_item *save_nextnext = next->next;
2786 next->next = NULL; /* Expansion for a single address */
2787 deliver_set_expansions(next);
2788 next->next = save_nextnext;
2789 bid = expand_string(tp->batch_id);
2790 deliver_set_expansions(NULL);
2793 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand batch_id option "
2794 "in %s transport (%s): %s", tp->name, next->address,
2795 expand_string_message);
2798 else ok = (Ustrcmp(batch_id, bid) == 0);
2801 /* Take address into batch if OK. */
2805 *anchor = next->next; /* Include the address */
2811 else anchor = &next->next; /* Skip the address */
2815 /* We now have one or more addresses that can be delivered in a batch. Check
2816 whether the transport is prepared to accept a message of this size. If not,
2817 fail them all forthwith. If the expansion fails, or does not yield an
2818 integer, defer delivery. */
2820 if (tp->message_size_limit)
2822 int rc = check_message_size(tp, addr);
2825 replicate_status(addr);
2829 post_process_one(addr, rc, logflags, EXIM_DTYPE_TRANSPORT, 0);
2832 continue; /* With next batch of addresses */
2836 /* If we are not running the queue, or if forcing, all deliveries will be
2837 attempted. Otherwise, we must respect the retry times for each address. Even
2838 when not doing this, we need to set up the retry key string, and determine
2839 whether a retry record exists, because after a successful delivery, a delete
2840 retry item must be set up. Keep the retry database open only for the duration
2841 of these checks, rather than for all local deliveries, because some local
2842 deliveries (e.g. to pipes) can take a substantial time. */
2844 if (!(dbm_file = dbfn_open(US"retry", O_RDONLY, &dbblock, FALSE)))
2846 DEBUG(D_deliver|D_retry|D_hints_lookup)
2847 debug_printf("no retry data available\n");
2854 BOOL ok = TRUE; /* to deliver this address */
2857 /* Set up the retry key to include the domain or not, and change its
2858 leading character from "R" to "T". Must make a copy before doing this,
2859 because the old key may be pointed to from a "delete" retry item after
2862 retry_key = string_copy(
2863 tp->retry_use_local_part ? addr2->address_retry_key :
2864 addr2->domain_retry_key);
2867 /* Inspect the retry data. If there is no hints file, delivery happens. */
2871 dbdata_retry *retry_record = dbfn_read(dbm_file, retry_key);
2873 /* If there is no retry record, delivery happens. If there is,
2874 remember it exists so it can be deleted after a successful delivery. */
2878 setflag(addr2, af_lt_retry_exists);
2880 /* A retry record exists for this address. If queue running and not
2881 forcing, inspect its contents. If the record is too old, or if its
2882 retry time has come, or if it has passed its cutoff time, delivery
2887 debug_printf("retry record exists: age=%s ",
2888 readconf_printtime(now - retry_record->time_stamp));
2889 debug_printf("(max %s)\n", readconf_printtime(retry_data_expire));
2890 debug_printf(" time to retry = %s expired = %d\n",
2891 readconf_printtime(retry_record->next_try - now),
2892 retry_record->expired);
2895 if (queue_running && !deliver_force)
2897 ok = (now - retry_record->time_stamp > retry_data_expire)
2898 || (now >= retry_record->next_try)
2899 || retry_record->expired;
2901 /* If we haven't reached the retry time, there is one more check
2902 to do, which is for the ultimate address timeout. */
2905 ok = retry_ultimate_address_timeout(retry_key, addr2->domain,
2909 else DEBUG(D_retry) debug_printf("no retry record exists\n");
2912 /* This address is to be delivered. Leave it on the chain. */
2917 addr2 = addr2->next;
2920 /* This address is to be deferred. Take it out of the chain, and
2921 post-process it as complete. Must take it out of the chain first,
2922 because post processing puts it on another chain. */
2926 address_item *this = addr2;
2927 this->message = US"Retry time not yet reached";
2928 this->basic_errno = ERRNO_LRETRY;
2929 addr2 = addr3 ? (addr3->next = addr2->next)
2930 : (addr = addr2->next);
2931 post_process_one(this, DEFER, logflags, EXIM_DTYPE_TRANSPORT, 0);
2935 if (dbm_file) dbfn_close(dbm_file);
2937 /* If there are no addresses left on the chain, they all deferred. Loop
2938 for the next set of addresses. */
2940 if (!addr) continue;
2942 /* If the transport is limited for parallellism, enforce that here.
2943 We use a hints DB entry, incremented here and decremented after
2944 the transport (and any shadow transport) completes. */
2946 if (tpt_parallel_check(tp, addr, &serialize_key))
2948 if (expand_string_message)
2950 logflags |= LOG_PANIC;
2954 post_process_one(addr, DEFER, logflags, EXIM_DTYPE_TRANSPORT, 0);
2955 } while ((addr = addr2));
2957 continue; /* Loop for the next set of addresses. */
2961 /* So, finally, we do have some addresses that can be passed to the
2962 transport. Before doing so, set up variables that are relevant to a
2965 deliver_set_expansions(addr);
2967 gettimeofday(&delivery_start, NULL);
2968 deliver_local(addr, FALSE);
2969 timesince(&deliver_time, &delivery_start);
2971 /* If a shadow transport (which must perforce be another local transport), is
2972 defined, and its condition is met, we must pass the message to the shadow
2973 too, but only those addresses that succeeded. We do this by making a new
2974 chain of addresses - also to keep the original chain uncontaminated. We must
2975 use a chain rather than doing it one by one, because the shadow transport may
2978 NOTE: if the condition fails because of a lookup defer, there is nothing we
2982 && ( !tp->shadow_condition
2983 || expand_check_condition(tp->shadow_condition, tp->name, US"transport")
2986 transport_instance *stp;
2987 address_item *shadow_addr = NULL;
2988 address_item **last = &shadow_addr;
2990 for (stp = transports; stp; stp = stp->next)
2991 if (Ustrcmp(stp->name, tp->shadow) == 0) break;
2994 log_write(0, LOG_MAIN|LOG_PANIC, "shadow transport \"%s\" not found ",
2997 /* Pick off the addresses that have succeeded, and make clones. Put into
2998 the shadow_message field a pointer to the shadow_message field of the real
3001 else for (addr2 = addr; addr2; addr2 = addr2->next)
3002 if (addr2->transport_return == OK)
3004 addr3 = store_get(sizeof(address_item));
3007 addr3->shadow_message = US &addr2->shadow_message;
3008 addr3->transport = stp;
3009 addr3->transport_return = DEFER;
3010 addr3->return_filename = NULL;
3011 addr3->return_file = -1;
3013 last = &addr3->next;
3016 /* If we found any addresses to shadow, run the delivery, and stick any
3017 message back into the shadow_message field in the original. */
3021 int save_count = transport_count;
3023 DEBUG(D_deliver|D_transport)
3024 debug_printf(">>>>>>>>>>>>>>>> Shadow delivery >>>>>>>>>>>>>>>>\n");
3025 deliver_local(shadow_addr, TRUE);
3027 for(; shadow_addr; shadow_addr = shadow_addr->next)
3029 int sresult = shadow_addr->transport_return;
3030 *(uschar **)shadow_addr->shadow_message =
3032 ? string_sprintf(" ST=%s", stp->name)
3033 : string_sprintf(" ST=%s (%s%s%s)", stp->name,
3034 shadow_addr->basic_errno <= 0
3036 : US strerror(shadow_addr->basic_errno),
3037 shadow_addr->basic_errno <= 0 || !shadow_addr->message
3040 shadow_addr->message
3041 ? shadow_addr->message
3042 : shadow_addr->basic_errno <= 0
3046 DEBUG(D_deliver|D_transport)
3047 debug_printf("%s shadow transport returned %s for %s\n",
3049 sresult == OK ? "OK" :
3050 sresult == DEFER ? "DEFER" :
3051 sresult == FAIL ? "FAIL" :
3052 sresult == PANIC ? "PANIC" : "?",
3053 shadow_addr->address);
3056 DEBUG(D_deliver|D_transport)
3057 debug_printf(">>>>>>>>>>>>>>>> End shadow delivery >>>>>>>>>>>>>>>>\n");
3059 transport_count = save_count; /* Restore original transport count */
3063 /* Cancel the expansions that were set up for the delivery. */
3065 deliver_set_expansions(NULL);
3067 /* If the transport was parallelism-limited, decrement the hints DB record. */
3069 if (serialize_key) enq_end(serialize_key);
3071 /* Now we can process the results of the real transport. We must take each
3072 address off the chain first, because post_process_one() puts it on another
3075 for (addr2 = addr; addr2; addr2 = nextaddr)
3077 int result = addr2->transport_return;
3078 nextaddr = addr2->next;
3080 DEBUG(D_deliver|D_transport)
3081 debug_printf("%s transport returned %s for %s\n",
3083 result == OK ? "OK" :
3084 result == DEFER ? "DEFER" :
3085 result == FAIL ? "FAIL" :
3086 result == PANIC ? "PANIC" : "?",
3089 /* If there is a retry_record, or if delivery is deferred, build a retry
3090 item for setting a new retry time or deleting the old retry record from
3091 the database. These items are handled all together after all addresses
3092 have been handled (so the database is open just for a short time for
3095 if (result == DEFER || testflag(addr2, af_lt_retry_exists))
3097 int flags = result == DEFER ? 0 : rf_delete;
3098 uschar *retry_key = string_copy(tp->retry_use_local_part
3099 ? addr2->address_retry_key : addr2->domain_retry_key);
3101 retry_add_item(addr2, retry_key, flags);
3104 /* Done with this address */
3108 addr2->more_errno = deliver_time.tv_sec;
3109 addr2->delivery_usec = deliver_time.tv_usec;
3111 post_process_one(addr2, result, logflags, EXIM_DTYPE_TRANSPORT, logchar);
3113 /* If a pipe delivery generated text to be sent back, the result may be
3114 changed to FAIL, and we must copy this for subsequent addresses in the
3117 if (addr2->transport_return != result)
3119 for (addr3 = nextaddr; addr3; addr3 = addr3->next)
3121 addr3->transport_return = addr2->transport_return;
3122 addr3->basic_errno = addr2->basic_errno;
3123 addr3->message = addr2->message;
3125 result = addr2->transport_return;
3128 /* Whether or not the result was changed to FAIL, we need to copy the
3129 return_file value from the first address into all the addresses of the
3130 batch, so they are all listed in the error message. */
3132 addr2->return_file = addr->return_file;
3134 /* Change log character for recording successful deliveries. */
3136 if (result == OK) logchar = '-';
3138 } /* Loop back for next batch of addresses */
3144 /*************************************************
3145 * Sort remote deliveries *
3146 *************************************************/
3148 /* This function is called if remote_sort_domains is set. It arranges that the
3149 chain of addresses for remote deliveries is ordered according to the strings
3150 specified. Try to make this shuffling reasonably efficient by handling
3151 sequences of addresses rather than just single ones.
3158 sort_remote_deliveries(void)
3161 address_item **aptr = &addr_remote;
3162 const uschar *listptr = remote_sort_domains;
3167 && (pattern = string_nextinlist(&listptr, &sep, patbuf, sizeof(patbuf)))
3170 address_item *moved = NULL;
3171 address_item **bptr = &moved;
3175 address_item **next;
3176 deliver_domain = (*aptr)->domain; /* set $domain */
3177 if (match_isinlist(deliver_domain, (const uschar **)&pattern, UCHAR_MAX+1,
3178 &domainlist_anchor, NULL, MCL_DOMAIN, TRUE, NULL) == OK)
3180 aptr = &(*aptr)->next;
3184 next = &(*aptr)->next;
3186 && (deliver_domain = (*next)->domain, /* Set $domain */
3187 match_isinlist(deliver_domain, (const uschar **)&pattern, UCHAR_MAX+1,
3188 &domainlist_anchor, NULL, MCL_DOMAIN, TRUE, NULL)) != OK
3190 next = &(*next)->next;
3192 /* If the batch of non-matchers is at the end, add on any that were
3193 extracted further up the chain, and end this iteration. Otherwise,
3194 extract them from the chain and hang on the moved chain. */
3206 aptr = &(*aptr)->next;
3209 /* If the loop ended because the final address matched, *aptr will
3210 be NULL. Add on to the end any extracted non-matching addresses. If
3211 *aptr is not NULL, the loop ended via "break" when *next is null, that
3212 is, there was a string of non-matching addresses at the end. In this
3213 case the extracted addresses have already been added on the end. */
3215 if (!*aptr) *aptr = moved;
3221 debug_printf("remote addresses after sorting:\n");
3222 for (addr = addr_remote; addr; addr = addr->next)
3223 debug_printf(" %s\n", addr->address);
3229 /*************************************************
3230 * Read from pipe for remote delivery subprocess *
3231 *************************************************/
3233 /* This function is called when the subprocess is complete, but can also be
3234 called before it is complete, in order to empty a pipe that is full (to prevent
3235 deadlock). It must therefore keep track of its progress in the parlist data
3238 We read the pipe to get the delivery status codes and a possible error message
3239 for each address, optionally preceded by unusability data for the hosts and
3240 also by optional retry data.
3242 Read in large chunks into the big buffer and then scan through, interpreting
3243 the data therein. In most cases, only a single read will be necessary. No
3244 individual item will ever be anywhere near 2500 bytes in length, so by ensuring
3245 that we read the next chunk when there is less than 2500 bytes left in the
3246 non-final chunk, we can assume each item is complete in the buffer before
3247 handling it. Each item is written using a single write(), which is atomic for
3248 small items (less than PIPE_BUF, which seems to be at least 512 in any Unix and
3249 often bigger) so even if we are reading while the subprocess is still going, we
3250 should never have only a partial item in the buffer.
3252 hs12: This assumption is not true anymore, since we got quit large items (certificate
3253 information and such)
3256 poffset the offset of the parlist item
3257 eop TRUE if the process has completed
3259 Returns: TRUE if the terminating 'Z' item has been read,
3260 or there has been a disaster (i.e. no more data needed);
3265 par_read_pipe(int poffset, BOOL eop)
3268 pardata *p = parlist + poffset;
3269 address_item *addrlist = p->addrlist;
3270 address_item *addr = p->addr;
3274 uschar *msg = p->msg;
3275 BOOL done = p->done;
3277 /* Loop through all items, reading from the pipe when necessary. The pipe
3278 used to be non-blocking. But I do not see a reason for using non-blocking I/O
3279 here, as the preceding select() tells us, if data is available for reading.
3281 A read() on a "selected" handle should never block, but(!) it may return
3282 less data then we expected. (The buffer size we pass to read() shouldn't be
3283 understood as a "request", but as a "limit".)
3285 Each separate item is written to the pipe in a timely manner. But, especially for
3286 larger items, the read(2) may already return partial data from the write(2).
3288 The write is atomic mostly (depending on the amount written), but atomic does
3289 not imply "all or noting", it just is "not intermixed" with other writes on the
3290 same channel (pipe).
3294 DEBUG(D_deliver) debug_printf("reading pipe for subprocess %d (%s)\n",
3295 (int)p->pid, eop? "ended" : "not ended yet");
3299 retry_item *r, **rp;
3300 uschar pipeheader[PIPE_HEADER_SIZE+1];
3301 uschar *id = &pipeheader[0];
3302 uschar *subid = &pipeheader[1];
3303 uschar *ptr = big_buffer;
3304 size_t required = PIPE_HEADER_SIZE; /* first the pipehaeder, later the data */
3307 DEBUG(D_deliver) debug_printf(
3308 "expect %lu bytes (pipeheader) from tpt process %d\n", (u_long)required, pid);
3310 /* We require(!) all the PIPE_HEADER_SIZE bytes here, as we know,
3311 they're written in a timely manner, so waiting for the write shouldn't hurt a lot.
3312 If we get less, we can assume the subprocess do be done and do not expect any further
3313 information from it. */
3315 got = readn(fd, pipeheader, required);
3316 if (got != required)
3318 msg = string_sprintf("got " SSIZE_T_FMT " of %d bytes (pipeheader) "
3319 "from transport process %d for transport %s",
3320 got, PIPE_HEADER_SIZE, pid, addr->transport->driver_name);
3325 pipeheader[PIPE_HEADER_SIZE] = '\0';
3327 debug_printf("got %ld bytes (pipeheader) from transport process %d\n",
3331 /* If we can't decode the pipeheader, the subprocess seems to have a
3332 problem, we do not expect any furher information from it. */
3334 required = Ustrtol(pipeheader+2, &endc, 10);
3337 msg = string_sprintf("failed to read pipe "
3338 "from transport process %d for transport %s: error decoding size from header",
3339 pid, addr->transport->driver_name);
3346 debug_printf("expect %lu bytes (pipedata) from transport process %d\n",
3347 (u_long)required, pid);
3349 /* Same as above, the transport process will write the bytes announced
3350 in a timely manner, so we can just wait for the bytes, getting less than expected
3351 is considered a problem of the subprocess, we do not expect anything else from it. */
3352 got = readn(fd, big_buffer, required);
3353 if (got != required)
3355 msg = string_sprintf("got only " SSIZE_T_FMT " of " SIZE_T_FMT
3356 " bytes (pipedata) from transport process %d for transport %s",
3357 got, required, pid, addr->transport->driver_name);
3362 /* Handle each possible type of item, assuming the complete item is
3363 available in store. */
3367 /* Host items exist only if any hosts were marked unusable. Match
3368 up by checking the IP address. */
3371 for (h = addrlist->host_list; h; h = h->next)
3373 if (!h->address || Ustrcmp(h->address, ptr+2) != 0) continue;
3381 /* Retry items are sent in a preceding R item for each address. This is
3382 kept separate to keep each message short enough to guarantee it won't
3383 be split in the pipe. Hopefully, in the majority of cases, there won't in
3384 fact be any retry items at all.
3386 The complete set of retry items might include an item to delete a
3387 routing retry if there was a previous routing delay. However, routing
3388 retries are also used when a remote transport identifies an address error.
3389 In that case, there may also be an "add" item for the same key. Arrange
3390 that a "delete" item is dropped in favour of an "add" item. */
3393 if (!addr) goto ADDR_MISMATCH;
3395 DEBUG(D_deliver|D_retry)
3396 debug_printf("reading retry information for %s from subprocess\n",
3399 /* Cut out any "delete" items on the list. */
3401 for (rp = &addr->retries; (r = *rp); rp = &r->next)
3402 if (Ustrcmp(r->key, ptr+1) == 0) /* Found item with same key */
3404 if (!(r->flags & rf_delete)) break; /* It was not "delete" */
3405 *rp = r->next; /* Excise a delete item */
3406 DEBUG(D_deliver|D_retry)
3407 debug_printf(" existing delete item dropped\n");
3410 /* We want to add a delete item only if there is no non-delete item;
3411 however we still have to step ptr through the data. */
3413 if (!r || !(*ptr & rf_delete))
3415 r = store_get(sizeof(retry_item));
3416 r->next = addr->retries;
3419 r->key = string_copy(ptr);
3421 memcpy(&r->basic_errno, ptr, sizeof(r->basic_errno));
3422 ptr += sizeof(r->basic_errno);
3423 memcpy(&r->more_errno, ptr, sizeof(r->more_errno));
3424 ptr += sizeof(r->more_errno);
3425 r->message = *ptr ? string_copy(ptr) : NULL;
3426 DEBUG(D_deliver|D_retry) debug_printf(" added %s item\n",
3427 r->flags & rf_delete ? "delete" : "retry");
3432 DEBUG(D_deliver|D_retry)
3433 debug_printf(" delete item not added: non-delete item exists\n");
3436 ptr += sizeof(r->basic_errno) + sizeof(r->more_errno);
3442 /* Put the amount of data written into the parlist block */
3445 memcpy(&(p->transport_count), ptr, sizeof(transport_count));
3446 ptr += sizeof(transport_count);
3449 /* Address items are in the order of items on the address chain. We
3450 remember the current address value in case this function is called
3451 several times to empty the pipe in stages. Information about delivery
3452 over TLS is sent in a preceding X item for each address. We don't put
3453 it in with the other info, in order to keep each message short enough to
3454 guarantee it won't be split in the pipe. */
3458 if (!addr) goto ADDR_MISMATCH; /* Below, in 'A' handler */
3462 addr->cipher = NULL;
3463 addr->peerdn = NULL;
3466 addr->cipher = string_copy(ptr);
3469 addr->peerdn = string_copy(ptr);
3474 (void) tls_import_cert(ptr, &addr->peercert);
3476 addr->peercert = NULL;
3481 (void) tls_import_cert(ptr, &addr->ourcert);
3483 addr->ourcert = NULL;
3486 # ifndef DISABLE_OCSP
3488 addr->ocsp = *ptr ? *ptr - '0' : OCSP_NOT_REQ;
3494 #endif /*SUPPORT_TLS*/
3496 case 'C': /* client authenticator information */
3499 case '1': addr->authenticator = *ptr ? string_copy(ptr) : NULL; break;
3500 case '2': addr->auth_id = *ptr ? string_copy(ptr) : NULL; break;
3501 case '3': addr->auth_sndr = *ptr ? string_copy(ptr) : NULL; break;
3506 #ifndef DISABLE_PRDR
3508 setflag(addr, af_prdr_used);
3513 setflag(addr, af_chunking_used);
3517 setflag(addr, af_tcp_fastopen_conn);
3518 if (*subid > '0') setflag(addr, af_tcp_fastopen);
3522 if (!addr) goto ADDR_MISMATCH;
3523 memcpy(&(addr->dsn_aware), ptr, sizeof(addr->dsn_aware));
3524 ptr += sizeof(addr->dsn_aware);
3525 DEBUG(D_deliver) debug_printf("DSN read: addr->dsn_aware = %d\n", addr->dsn_aware);
3532 msg = string_sprintf("address count mismatch for data read from pipe "
3533 "for transport process %d for transport %s", pid,
3534 addrlist->transport->driver_name);
3541 #ifdef SUPPORT_SOCKS
3542 case '2': /* proxy information; must arrive before A0 and applies to that addr XXX oops*/
3543 proxy_session = TRUE; /*XXX should this be cleared somewhere? */
3548 proxy_local_address = string_copy(ptr);
3550 memcpy(&proxy_local_port, ptr, sizeof(proxy_local_port));
3551 ptr += sizeof(proxy_local_port);
3556 #ifdef EXPERIMENTAL_DSN_INFO
3557 case '1': /* must arrive before A0, and applies to that addr */
3558 /* Two strings: smtp_greeting and helo_response */
3559 addr->smtp_greeting = string_copy(ptr);
3561 addr->helo_response = string_copy(ptr);
3567 DEBUG(D_deliver) debug_printf("A0 %s tret %d\n", addr->address, *ptr);
3568 addr->transport_return = *ptr++;
3569 addr->special_action = *ptr++;
3570 memcpy(&addr->basic_errno, ptr, sizeof(addr->basic_errno));
3571 ptr += sizeof(addr->basic_errno);
3572 memcpy(&addr->more_errno, ptr, sizeof(addr->more_errno));
3573 ptr += sizeof(addr->more_errno);
3574 memcpy(&addr->delivery_usec, ptr, sizeof(addr->delivery_usec));
3575 ptr += sizeof(addr->delivery_usec);
3576 memcpy(&addr->flags, ptr, sizeof(addr->flags));
3577 ptr += sizeof(addr->flags);
3578 addr->message = *ptr ? string_copy(ptr) : NULL;
3580 addr->user_message = *ptr ? string_copy(ptr) : NULL;
3583 /* Always two strings for host information, followed by the port number and DNSSEC mark */
3587 h = store_get(sizeof(host_item));
3588 h->name = string_copy(ptr);
3590 h->address = string_copy(ptr);
3592 memcpy(&h->port, ptr, sizeof(h->port));
3593 ptr += sizeof(h->port);
3594 h->dnssec = *ptr == '2' ? DS_YES
3595 : *ptr == '1' ? DS_NO
3598 addr->host_used = h;
3602 /* Finished with this address */
3609 /* Local interface address/port */
3611 if (*ptr) sending_ip_address = string_copy(ptr);
3613 if (*ptr) sending_port = atoi(CS ptr);
3617 /* Z marks the logical end of the data. It is followed by '0' if
3618 continue_transport was NULL at the end of transporting, otherwise '1'.
3619 We need to know when it becomes NULL during a delivery down a passed SMTP
3620 channel so that we don't try to pass anything more down it. Of course, for
3621 most normal messages it will remain NULL all the time. */
3626 continue_transport = NULL;
3627 continue_hostname = NULL;
3630 DEBUG(D_deliver) debug_printf("Z0%c item read\n", *ptr);
3633 /* Anything else is a disaster. */
3636 msg = string_sprintf("malformed data (%d) read from pipe for transport "
3637 "process %d for transport %s", ptr[-1], pid,
3638 addr->transport->driver_name);
3644 /* The done flag is inspected externally, to determine whether or not to
3645 call the function again when the process finishes. */
3649 /* If the process hadn't finished, and we haven't seen the end of the data
3650 or if we suffered a disaster, update the rest of the state, and return FALSE to
3651 indicate "not finished". */
3660 /* Close our end of the pipe, to prevent deadlock if the far end is still
3661 pushing stuff into it. */
3666 /* If we have finished without error, but haven't had data for every address,
3667 something is wrong. */
3670 msg = string_sprintf("insufficient address data read from pipe "
3671 "for transport process %d for transport %s", pid,
3672 addr->transport->driver_name);
3674 /* If an error message is set, something has gone wrong in getting back
3675 the delivery data. Put the message into each address and freeze it. */
3678 for (addr = addrlist; addr; addr = addr->next)
3680 addr->transport_return = DEFER;
3681 addr->special_action = SPECIAL_FREEZE;
3682 addr->message = msg;
3683 log_write(0, LOG_MAIN|LOG_PANIC, "Delivery status for %s: %s\n", addr->address, addr->message);
3686 /* Return TRUE to indicate we have got all we need from this process, even
3687 if it hasn't actually finished yet. */
3694 /*************************************************
3695 * Post-process a set of remote addresses *
3696 *************************************************/
3698 /* Do what has to be done immediately after a remote delivery for each set of
3699 addresses, then re-write the spool if necessary. Note that post_process_one
3700 puts the address on an appropriate queue; hence we must fish off the next
3701 one first. This function is also called if there is a problem with setting
3702 up a subprocess to do a remote delivery in parallel. In this case, the final
3703 argument contains a message, and the action must be forced to DEFER.
3706 addr pointer to chain of address items
3707 logflags flags for logging
3708 msg NULL for normal cases; -> error message for unexpected problems
3709 fallback TRUE if processing fallback hosts
3715 remote_post_process(address_item *addr, int logflags, uschar *msg,
3720 /* If any host addresses were found to be unusable, add them to the unusable
3721 tree so that subsequent deliveries don't try them. */
3723 for (h = addr->host_list; h; h = h->next)
3725 if (h->status >= hstatus_unusable) tree_add_unusable(h);
3727 /* Now handle each address on the chain. The transport has placed '=' or '-'
3728 into the special_action field for each successful delivery. */
3732 address_item *next = addr->next;
3734 /* If msg == NULL (normal processing) and the result is DEFER and we are
3735 processing the main hosts and there are fallback hosts available, put the
3736 address on the list for fallback delivery. */
3738 if ( addr->transport_return == DEFER
3739 && addr->fallback_hosts
3744 addr->host_list = addr->fallback_hosts;
3745 addr->next = addr_fallback;
3746 addr_fallback = addr;
3747 DEBUG(D_deliver) debug_printf("%s queued for fallback host(s)\n", addr->address);
3750 /* If msg is set (=> unexpected problem), set it in the address before
3751 doing the ordinary post processing. */
3757 addr->message = msg;
3758 addr->transport_return = DEFER;
3760 (void)post_process_one(addr, addr->transport_return, logflags,
3761 EXIM_DTYPE_TRANSPORT, addr->special_action);
3769 /* If we have just delivered down a passed SMTP channel, and that was
3770 the last address, the channel will have been closed down. Now that
3771 we have logged that delivery, set continue_sequence to 1 so that
3772 any subsequent deliveries don't get "*" incorrectly logged. */
3774 if (!continue_transport) continue_sequence = 1;
3779 /*************************************************
3780 * Wait for one remote delivery subprocess *
3781 *************************************************/
3783 /* This function is called while doing remote deliveries when either the
3784 maximum number of processes exist and we need one to complete so that another
3785 can be created, or when waiting for the last ones to complete. It must wait for
3786 the completion of one subprocess, empty the control block slot, and return a
3787 pointer to the address chain.
3790 Returns: pointer to the chain of addresses handled by the process;
3791 NULL if no subprocess found - this is an unexpected error
3794 static address_item *
3797 int poffset, status;
3798 address_item *addr, *addrlist;
3801 set_process_info("delivering %s: waiting for a remote delivery subprocess "
3802 "to finish", message_id);
3804 /* Loop until either a subprocess completes, or there are no subprocesses in
3805 existence - in which case give an error return. We cannot proceed just by
3806 waiting for a completion, because a subprocess may have filled up its pipe, and
3807 be waiting for it to be emptied. Therefore, if no processes have finished, we
3808 wait for one of the pipes to acquire some data by calling select(), with a
3809 timeout just in case.
3811 The simple approach is just to iterate after reading data from a ready pipe.
3812 This leads to non-ideal behaviour when the subprocess has written its final Z
3813 item, closed the pipe, and is in the process of exiting (the common case). A
3814 call to waitpid() yields nothing completed, but select() shows the pipe ready -
3815 reading it yields EOF, so you end up with busy-waiting until the subprocess has
3818 To avoid this, if all the data that is needed has been read from a subprocess
3819 after select(), an explicit wait() for it is done. We know that all it is doing
3820 is writing to the pipe and then exiting, so the wait should not be long.
3822 The non-blocking waitpid() is to some extent just insurance; if we could
3823 reliably detect end-of-file on the pipe, we could always know when to do a
3824 blocking wait() for a completed process. However, because some systems use
3825 NDELAY, which doesn't distinguish between EOF and pipe empty, it is easier to
3826 use code that functions without the need to recognize EOF.
3828 There's a double loop here just in case we end up with a process that is not in
3829 the list of remote delivery processes. Something has obviously gone wrong if
3830 this is the case. (For example, a process that is incorrectly left over from
3831 routing or local deliveries might be found.) The damage can be minimized by
3832 looping back and looking for another process. If there aren't any, the error
3833 return will happen. */
3835 for (;;) /* Normally we do not repeat this loop */
3837 while ((pid = waitpid(-1, &status, WNOHANG)) <= 0)
3840 fd_set select_pipes;
3841 int maxpipe, readycount;
3843 /* A return value of -1 can mean several things. If errno != ECHILD, it
3844 either means invalid options (which we discount), or that this process was
3845 interrupted by a signal. Just loop to try the waitpid() again.
3847 If errno == ECHILD, waitpid() is telling us that there are no subprocesses
3848 in existence. This should never happen, and is an unexpected error.
3849 However, there is a nasty complication when running under Linux. If "strace
3850 -f" is being used under Linux to trace this process and its children,
3851 subprocesses are "stolen" from their parents and become the children of the
3852 tracing process. A general wait such as the one we've just obeyed returns
3853 as if there are no children while subprocesses are running. Once a
3854 subprocess completes, it is restored to the parent, and waitpid(-1) finds
3855 it. Thanks to Joachim Wieland for finding all this out and suggesting a
3858 This does not happen using "truss" on Solaris, nor (I think) with other
3859 tracing facilities on other OS. It seems to be specific to Linux.
3861 What we do to get round this is to use kill() to see if any of our
3862 subprocesses are still in existence. If kill() gives an OK return, we know
3863 it must be for one of our processes - it can't be for a re-use of the pid,
3864 because if our process had finished, waitpid() would have found it. If any
3865 of our subprocesses are in existence, we proceed to use select() as if
3866 waitpid() had returned zero. I think this is safe. */
3870 if (errno != ECHILD) continue; /* Repeats the waitpid() */
3873 debug_printf("waitpid() returned -1/ECHILD: checking explicitly "
3874 "for process existence\n");
3876 for (poffset = 0; poffset < remote_max_parallel; poffset++)
3878 if ((pid = parlist[poffset].pid) != 0 && kill(pid, 0) == 0)
3880 DEBUG(D_deliver) debug_printf("process %d still exists: assume "
3881 "stolen by strace\n", (int)pid);
3882 break; /* With poffset set */
3886 if (poffset >= remote_max_parallel)
3888 DEBUG(D_deliver) debug_printf("*** no delivery children found\n");
3889 return NULL; /* This is the error return */
3893 /* A pid value greater than 0 breaks the "while" loop. A negative value has
3894 been handled above. A return value of zero means that there is at least one
3895 subprocess, but there are no completed subprocesses. See if any pipes are
3896 ready with any data for reading. */
3898 DEBUG(D_deliver) debug_printf("selecting on subprocess pipes\n");
3901 FD_ZERO(&select_pipes);
3902 for (poffset = 0; poffset < remote_max_parallel; poffset++)
3903 if (parlist[poffset].pid != 0)
3905 int fd = parlist[poffset].fd;
3906 FD_SET(fd, &select_pipes);
3907 if (fd > maxpipe) maxpipe = fd;
3910 /* Stick in a 60-second timeout, just in case. */
3915 readycount = select(maxpipe + 1, (SELECT_ARG2_TYPE *)&select_pipes,
3918 /* Scan through the pipes and read any that are ready; use the count
3919 returned by select() to stop when there are no more. Select() can return
3920 with no processes (e.g. if interrupted). This shouldn't matter.
3922 If par_read_pipe() returns TRUE, it means that either the terminating Z was
3923 read, or there was a disaster. In either case, we are finished with this
3924 process. Do an explicit wait() for the process and break the main loop if
3927 It turns out that we have to deal with the case of an interrupted system
3928 call, which can happen on some operating systems if the signal handling is
3929 set up to do that by default. */
3932 readycount > 0 && poffset < remote_max_parallel;
3935 if ( (pid = parlist[poffset].pid) != 0
3936 && FD_ISSET(parlist[poffset].fd, &select_pipes)
3940 if (par_read_pipe(poffset, FALSE)) /* Finished with this pipe */
3941 for (;;) /* Loop for signals */
3943 pid_t endedpid = waitpid(pid, &status, 0);
3944 if (endedpid == pid) goto PROCESS_DONE;
3945 if (endedpid != (pid_t)(-1) || errno != EINTR)
3946 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Unexpected error return "
3947 "%d (errno = %d) from waitpid() for process %d",
3948 (int)endedpid, errno, (int)pid);
3953 /* Now go back and look for a completed subprocess again. */
3956 /* A completed process was detected by the non-blocking waitpid(). Find the
3957 data block that corresponds to this subprocess. */
3959 for (poffset = 0; poffset < remote_max_parallel; poffset++)
3960 if (pid == parlist[poffset].pid) break;
3962 /* Found the data block; this is a known remote delivery process. We don't
3963 need to repeat the outer loop. This should be what normally happens. */
3965 if (poffset < remote_max_parallel) break;
3967 /* This situation is an error, but it's probably better to carry on looking
3968 for another process than to give up (as we used to do). */
3970 log_write(0, LOG_MAIN|LOG_PANIC, "Process %d finished: not found in remote "
3971 "transport process list", pid);
3972 } /* End of the "for" loop */
3974 /* Come here when all the data was completely read after a select(), and
3975 the process in pid has been wait()ed for. */
3982 debug_printf("remote delivery process %d ended\n", (int)pid);
3984 debug_printf("remote delivery process %d ended: status=%04x\n", (int)pid,
3988 set_process_info("delivering %s", message_id);
3990 /* Get the chain of processed addresses */
3992 addrlist = parlist[poffset].addrlist;
3994 /* If the process did not finish cleanly, record an error and freeze (except
3995 for SIGTERM, SIGKILL and SIGQUIT), and also ensure the journal is not removed,
3996 in case the delivery did actually happen. */
3998 if ((status & 0xffff) != 0)
4001 int msb = (status >> 8) & 255;
4002 int lsb = status & 255;
4003 int code = (msb == 0)? (lsb & 0x7f) : msb;
4005 msg = string_sprintf("%s transport process returned non-zero status 0x%04x: "
4007 addrlist->transport->driver_name,
4009 (msb == 0)? "terminated by signal" : "exit code",
4012 if (msb != 0 || (code != SIGTERM && code != SIGKILL && code != SIGQUIT))
4013 addrlist->special_action = SPECIAL_FREEZE;
4015 for (addr = addrlist; addr; addr = addr->next)
4017 addr->transport_return = DEFER;
4018 addr->message = msg;
4021 remove_journal = FALSE;
4024 /* Else complete reading the pipe to get the result of the delivery, if all
4025 the data has not yet been obtained. */
4027 else if (!parlist[poffset].done) (void)par_read_pipe(poffset, TRUE);
4029 /* Put the data count and return path into globals, mark the data slot unused,
4030 decrement the count of subprocesses, and return the address chain. */
4032 transport_count = parlist[poffset].transport_count;
4033 used_return_path = parlist[poffset].return_path;
4034 parlist[poffset].pid = 0;
4041 /*************************************************
4042 * Wait for subprocesses and post-process *
4043 *************************************************/
4045 /* This function waits for subprocesses until the number that are still running
4046 is below a given threshold. For each complete subprocess, the addresses are
4047 post-processed. If we can't find a running process, there is some shambles.
4048 Better not bomb out, as that might lead to multiple copies of the message. Just
4049 log and proceed as if all done.
4052 max maximum number of subprocesses to leave running
4053 fallback TRUE if processing fallback hosts
4059 par_reduce(int max, BOOL fallback)
4061 while (parcount > max)
4063 address_item *doneaddr = par_wait();
4066 log_write(0, LOG_MAIN|LOG_PANIC,
4067 "remote delivery process count got out of step");
4072 transport_instance * tp = doneaddr->transport;
4073 if (tp->max_parallel)
4074 enq_end(string_sprintf("tpt-serialize-%s", tp->name));
4076 remote_post_process(doneaddr, LOG_MAIN, NULL, fallback);
4082 rmt_dlv_checked_write(int fd, char id, char subid, void * buf, ssize_t size)
4084 uschar pipe_header[PIPE_HEADER_SIZE+1];
4085 size_t total_len = PIPE_HEADER_SIZE + size;
4087 struct iovec iov[2] = {
4088 { pipe_header, PIPE_HEADER_SIZE }, /* indication about the data to expect */
4089 { buf, size } /* *the* data */
4094 /* we assume that size can't get larger then BIG_BUFFER_SIZE which currently is set to 16k */
4095 /* complain to log if someone tries with buffer sizes we can't handle*/
4097 if (size > BIG_BUFFER_SIZE-1)
4099 log_write(0, LOG_MAIN|LOG_PANIC_DIE,
4100 "Failed writing transport result to pipe: can't handle buffers > %d bytes. truncating!\n",
4102 size = BIG_BUFFER_SIZE;
4105 /* Should we check that we do not write more than PIPE_BUF? What would
4108 /* convert size to human readable string prepended by id and subid */
4109 if (PIPE_HEADER_SIZE != snprintf(CS pipe_header, PIPE_HEADER_SIZE+1, "%c%c%05ld",
4110 id, subid, (long)size))
4111 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "header snprintf failed\n");
4113 DEBUG(D_deliver) debug_printf("header write id:%c,subid:%c,size:%ld,final:%s\n",
4114 id, subid, (long)size, pipe_header);
4116 if ((ret = writev(fd, iov, 2)) != total_len)
4117 log_write(0, LOG_MAIN|LOG_PANIC_DIE,
4118 "Failed writing transport result to pipe (%ld of %ld bytes): %s",
4119 (long)ret, (long)total_len, ret == -1 ? strerror(errno) : "short write");
4122 /*************************************************
4123 * Do remote deliveries *
4124 *************************************************/
4126 /* This function is called to process the addresses in addr_remote. We must
4127 pick off the queue all addresses that have the same transport, remote
4128 destination, and errors address, and hand them to the transport in one go,
4129 subject to some configured limitations. If this is a run to continue delivering
4130 to an existing delivery channel, skip all but those addresses that can go to
4131 that channel. The skipped addresses just get deferred.
4133 If mua_wrapper is set, all addresses must be able to be sent in a single
4134 transaction. If not, this function yields FALSE.
4136 In Exim 4, remote deliveries are always done in separate processes, even
4137 if remote_max_parallel = 1 or if there's only one delivery to do. The reason
4138 is so that the base process can retain privilege. This makes the
4139 implementation of fallback transports feasible (though not initially done.)
4141 We create up to the configured number of subprocesses, each of which passes
4142 back the delivery state via a pipe. (However, when sending down an existing
4143 connection, remote_max_parallel is forced to 1.)
4146 fallback TRUE if processing fallback hosts
4148 Returns: TRUE normally
4149 FALSE if mua_wrapper is set and the addresses cannot all be sent
4154 do_remote_deliveries(BOOL fallback)
4160 parcount = 0; /* Number of executing subprocesses */
4162 /* When sending down an existing channel, only do one delivery at a time.
4163 We use a local variable (parmax) to hold the maximum number of processes;
4164 this gets reduced from remote_max_parallel if we can't create enough pipes. */
4166 if (continue_transport) remote_max_parallel = 1;
4167 parmax = remote_max_parallel;
4169 /* If the data for keeping a list of processes hasn't yet been
4174 parlist = store_get(remote_max_parallel * sizeof(pardata));
4175 for (poffset = 0; poffset < remote_max_parallel; poffset++)
4176 parlist[poffset].pid = 0;
4179 /* Now loop for each remote delivery */
4181 for (delivery_count = 0; addr_remote; delivery_count++)
4187 int address_count = 1;
4188 int address_count_max;
4190 BOOL use_initgroups;
4191 BOOL pipe_done = FALSE;
4192 transport_instance *tp;
4193 address_item **anchor = &addr_remote;
4194 address_item *addr = addr_remote;
4195 address_item *last = addr;
4198 uschar * serialize_key = NULL;
4200 /* Pull the first address right off the list. */
4202 addr_remote = addr->next;
4205 DEBUG(D_deliver|D_transport)
4206 debug_printf("--------> %s <--------\n", addr->address);
4208 /* If no transport has been set, there has been a big screw-up somewhere. */
4210 if (!(tp = addr->transport))
4212 disable_logging = FALSE; /* Jic */
4213 panicmsg = US"No transport set by router";
4214 goto panic_continue;
4217 /* Check that this base address hasn't previously been delivered to this
4218 transport. The check is necessary at this point to handle homonymic addresses
4219 correctly in cases where the pattern of redirection changes between delivery
4220 attempts. Non-homonymic previous delivery is detected earlier, at routing
4223 if (previously_transported(addr, FALSE)) continue;
4225 /* Force failure if the message is too big. */
4227 if (tp->message_size_limit)
4229 int rc = check_message_size(tp, addr);
4232 addr->transport_return = rc;
4233 remote_post_process(addr, LOG_MAIN, NULL, fallback);
4238 /* Get the flag which specifies whether the transport can handle different
4239 domains that nevertheless resolve to the same set of hosts. If it needs
4240 expanding, get variables set: $address_data, $domain_data, $localpart_data,
4241 $host, $host_address, $host_port. */
4242 if (tp->expand_multi_domain)
4243 deliver_set_expansions(addr);
4245 if (exp_bool(addr, US"transport", tp->name, D_transport,
4246 US"multi_domain", tp->multi_domain, tp->expand_multi_domain,
4247 &multi_domain) != OK)
4249 deliver_set_expansions(NULL);
4250 panicmsg = addr->message;
4251 goto panic_continue;
4254 /* Get the maximum it can handle in one envelope, with zero meaning
4255 unlimited, which is forced for the MUA wrapper case. */
4257 address_count_max = tp->max_addresses;
4258 if (address_count_max == 0 || mua_wrapper) address_count_max = 999999;
4261 /************************************************************************/
4262 /***** This is slightly experimental code, but should be safe. *****/
4264 /* The address_count_max value is the maximum number of addresses that the
4265 transport can send in one envelope. However, the transport must be capable of
4266 dealing with any number of addresses. If the number it gets exceeds its
4267 envelope limitation, it must send multiple copies of the message. This can be
4268 done over a single connection for SMTP, so uses less resources than making
4269 multiple connections. On the other hand, if remote_max_parallel is greater
4270 than one, it is perhaps a good idea to use parallel processing to move the
4271 message faster, even if that results in multiple simultaneous connections to
4274 How can we come to some compromise between these two ideals? What we do is to
4275 limit the number of addresses passed to a single instance of a transport to
4276 the greater of (a) its address limit (rcpt_max for SMTP) and (b) the total
4277 number of addresses routed to remote transports divided by
4278 remote_max_parallel. For example, if the message has 100 remote recipients,
4279 remote max parallel is 2, and rcpt_max is 10, we'd never send more than 50 at
4280 once. But if rcpt_max is 100, we could send up to 100.
4282 Of course, not all the remotely addresses in a message are going to go to the
4283 same set of hosts (except in smarthost configurations), so this is just a
4284 heuristic way of dividing up the work.
4286 Furthermore (1), because this may not be wanted in some cases, and also to
4287 cope with really pathological cases, there is also a limit to the number of
4288 messages that are sent over one connection. This is the same limit that is
4289 used when sending several different messages over the same connection.
4290 Continue_sequence is set when in this situation, to the number sent so
4291 far, including this message.
4293 Furthermore (2), when somebody explicitly sets the maximum value to 1, it
4294 is probably because they are using VERP, in which case they want to pass only
4295 one address at a time to the transport, in order to be able to use
4296 $local_part and $domain in constructing a new return path. We could test for
4297 the use of these variables, but as it is so likely they will be used when the
4298 maximum is 1, we don't bother. Just leave the value alone. */
4300 if ( address_count_max != 1
4301 && address_count_max < remote_delivery_count/remote_max_parallel
4304 int new_max = remote_delivery_count/remote_max_parallel;
4305 int message_max = tp->connection_max_messages;
4306 if (connection_max_messages >= 0) message_max = connection_max_messages;
4307 message_max -= continue_sequence - 1;
4308 if (message_max > 0 && new_max > address_count_max * message_max)
4309 new_max = address_count_max * message_max;
4310 address_count_max = new_max;
4313 /************************************************************************/
4316 /* Pick off all addresses which have the same transport, errors address,
4317 destination, and extra headers. In some cases they point to the same host
4318 list, but we also need to check for identical host lists generated from
4319 entirely different domains. The host list pointers can be NULL in the case
4320 where the hosts are defined in the transport. There is also a configured
4321 maximum limit of addresses that can be handled at once (see comments above
4322 for how it is computed).
4323 If the transport does not handle multiple domains, enforce that also,
4324 and if it might need a per-address check for this, re-evaluate it.
4327 while ((next = *anchor) && address_count < address_count_max)
4330 if ( (multi_domain || Ustrcmp(next->domain, addr->domain) == 0)
4331 && tp == next->transport
4332 && same_hosts(next->host_list, addr->host_list)
4333 && same_strings(next->prop.errors_address, addr->prop.errors_address)
4334 && same_headers(next->prop.extra_headers, addr->prop.extra_headers)
4335 && same_ugid(tp, next, addr)
4336 && ( next->prop.remove_headers == addr->prop.remove_headers
4337 || ( next->prop.remove_headers
4338 && addr->prop.remove_headers
4339 && Ustrcmp(next->prop.remove_headers, addr->prop.remove_headers) == 0
4343 (void)(!tp->expand_multi_domain || ((void)deliver_set_expansions(next), 1)),
4345 US"transport", next->transport->name, D_transport,
4346 US"multi_domain", next->transport->multi_domain,
4347 next->transport->expand_multi_domain, &md) == OK
4352 *anchor = next->next;
4354 next->first = addr; /* remember top one (for retry processing) */
4359 else anchor = &(next->next);
4360 deliver_set_expansions(NULL);
4363 /* If we are acting as an MUA wrapper, all addresses must go in a single
4364 transaction. If not, put them back on the chain and yield FALSE. */
4366 if (mua_wrapper && addr_remote)
4368 last->next = addr_remote;
4373 /* If the transport is limited for parallellism, enforce that here.
4374 The hints DB entry is decremented in par_reduce(), when we reap the
4375 transport process. */
4377 if (tpt_parallel_check(tp, addr, &serialize_key))
4378 if ((panicmsg = expand_string_message))
4379 goto panic_continue;
4381 continue; /* Loop for the next set of addresses. */
4383 /* Set up the expansion variables for this set of addresses */
4385 deliver_set_expansions(addr);
4387 /* Ensure any transport-set auth info is fresh */
4388 addr->authenticator = addr->auth_id = addr->auth_sndr = NULL;
4390 /* Compute the return path, expanding a new one if required. The old one
4391 must be set first, as it might be referred to in the expansion. */
4393 if(addr->prop.errors_address)
4394 return_path = addr->prop.errors_address;
4395 #ifdef EXPERIMENTAL_SRS
4396 else if(addr->prop.srs_sender)
4397 return_path = addr->prop.srs_sender;
4400 return_path = sender_address;
4402 if (tp->return_path)
4404 uschar *new_return_path = expand_string(tp->return_path);
4405 if (new_return_path)
4406 return_path = new_return_path;
4407 else if (!expand_string_forcedfail)
4409 panicmsg = string_sprintf("Failed to expand return path \"%s\": %s",
4410 tp->return_path, expand_string_message);
4415 /* Find the uid, gid, and use_initgroups setting for this transport. Failure
4416 logs and sets up error messages, so we just post-process and continue with
4417 the next address. */
4419 if (!findugid(addr, tp, &uid, &gid, &use_initgroups))
4425 /* If this transport has a setup function, call it now so that it gets
4426 run in this process and not in any subprocess. That way, the results of
4427 any setup that are retained by the transport can be reusable. One of the
4428 things the setup does is to set the fallback host lists in the addresses.
4429 That is why it is called at this point, before the continue delivery
4430 processing, because that might use the fallback hosts. */
4433 (void)((tp->setup)(addr->transport, addr, NULL, uid, gid, NULL));
4435 /* If we have a connection still open from a verify stage (lazy-close)
4436 treat it as if it is a continued connection (apart from the counter used
4437 for the log line mark). */
4439 if (cutthrough.fd >= 0 && cutthrough.callout_hold_only)
4442 debug_printf("lazy-callout-close: have conn still open from verification\n");
4443 continue_transport = cutthrough.transport;
4444 continue_hostname = string_copy(cutthrough.host.name);
4445 continue_host_address = string_copy(cutthrough.host.address);
4446 continue_sequence = 1;
4447 sending_ip_address = cutthrough.snd_ip;
4448 sending_port = cutthrough.snd_port;
4449 smtp_peer_options = cutthrough.peer_options;
4452 /* If this is a run to continue delivery down an already-established
4453 channel, check that this set of addresses matches the transport and
4454 the channel. If it does not, defer the addresses. If a host list exists,
4455 we must check that the continue host is on the list. Otherwise, the
4456 host is set in the transport. */
4458 continue_more = FALSE; /* In case got set for the last lot */
4459 if (continue_transport)
4461 BOOL ok = Ustrcmp(continue_transport, tp->name) == 0;
4463 /* If the transport is about to override the host list do not check
4464 it here but take the cost of running the transport process to discover
4465 if the continued_hostname connection is suitable. This is a layering
4466 violation which is unfortunate as it requires we haul in the smtp
4471 smtp_transport_options_block * ob;
4473 if ( !( Ustrcmp(tp->info->driver_name, "smtp") == 0
4474 && (ob = (smtp_transport_options_block *)tp->options_block)
4475 && ob->hosts_override && ob->hosts
4482 for (h = addr->host_list; h; h = h->next)
4483 if (Ustrcmp(h->name, continue_hostname) == 0)
4484 /*XXX should also check port here */
4485 { ok = TRUE; break; }
4489 /* Addresses not suitable; defer or queue for fallback hosts (which
4490 might be the continue host) and skip to next address. */
4494 DEBUG(D_deliver) debug_printf("not suitable for continue_transport (%s)\n",
4495 Ustrcmp(continue_transport, tp->name) != 0
4496 ? string_sprintf("tpt %s vs %s", continue_transport, tp->name)
4497 : string_sprintf("no host matching %s", continue_hostname));
4498 if (serialize_key) enq_end(serialize_key);
4500 if (addr->fallback_hosts && !fallback)
4502 for (next = addr; ; next = next->next)
4504 next->host_list = next->fallback_hosts;
4505 DEBUG(D_deliver) debug_printf("%s queued for fallback host(s)\n", next->address);
4506 if (!next->next) break;
4508 next->next = addr_fallback;
4509 addr_fallback = addr;
4514 for (next = addr; ; next = next->next)
4516 DEBUG(D_deliver) debug_printf(" %s to def list\n", next->address);
4517 if (!next->next) break;
4519 next->next = addr_defer;
4526 /* Set a flag indicating whether there are further addresses that list
4527 the continued host. This tells the transport to leave the channel open,
4528 but not to pass it to another delivery process. We'd like to do that
4529 for non-continue_transport cases too but the knowlege of which host is
4530 connected to is too hard to manage. Perhaps we need a finer-grain
4531 interface to the transport. */
4533 for (next = addr_remote; next && !continue_more; next = next->next)
4536 for (h = next->host_list; h; h = h->next)
4537 if (Ustrcmp(h->name, continue_hostname) == 0)
4538 { continue_more = TRUE; break; }
4542 /* The transports set up the process info themselves as they may connect
4543 to more than one remote machine. They also have to set up the filter
4544 arguments, if required, so that the host name and address are available
4547 transport_filter_argv = NULL;
4549 /* Create the pipe for inter-process communication. If pipe creation
4550 fails, it is probably because the value of remote_max_parallel is so
4551 large that too many file descriptors for pipes have been created. Arrange
4552 to wait for a process to finish, and then try again. If we still can't
4553 create a pipe when all processes have finished, break the retry loop. */
4557 if (pipe(pfd) == 0) pipe_done = TRUE;
4558 else if (parcount > 0) parmax = parcount;
4561 /* We need to make the reading end of the pipe non-blocking. There are
4562 two different options for this. Exim is cunningly (I hope!) coded so
4563 that it can use either of them, though it prefers O_NONBLOCK, which
4564 distinguishes between EOF and no-more-data. */
4566 /* The data appears in a timely manner and we already did a select on
4567 all pipes, so I do not see a reason to use non-blocking IO here
4570 (void)fcntl(pfd[pipe_read], F_SETFL, O_NONBLOCK);
4572 (void)fcntl(pfd[pipe_read], F_SETFL, O_NDELAY);
4576 /* If the maximum number of subprocesses already exist, wait for a process
4577 to finish. If we ran out of file descriptors, parmax will have been reduced
4578 from its initial value of remote_max_parallel. */
4580 par_reduce(parmax - 1, fallback);
4583 /* If we failed to create a pipe and there were no processes to wait
4584 for, we have to give up on this one. Do this outside the above loop
4585 so that we can continue the main loop. */
4589 panicmsg = string_sprintf("unable to create pipe: %s", strerror(errno));
4593 /* Find a free slot in the pardata list. Must do this after the possible
4594 waiting for processes to finish, because a terminating process will free
4597 for (poffset = 0; poffset < remote_max_parallel; poffset++)
4598 if (parlist[poffset].pid == 0)
4601 /* If there isn't one, there has been a horrible disaster. */
4603 if (poffset >= remote_max_parallel)
4605 (void)close(pfd[pipe_write]);
4606 (void)close(pfd[pipe_read]);
4607 panicmsg = US"Unexpectedly no free subprocess slot";
4611 /* Now fork a subprocess to do the remote delivery, but before doing so,
4612 ensure that any cached resources are released so as not to interfere with
4613 what happens in the subprocess. */
4618 if ((pid = fork()) == 0)
4620 int fd = pfd[pipe_write];
4622 DEBUG(D_deliver) debug_selector |= D_pid; // hs12
4624 /* Setting this global in the subprocess means we need never clear it */
4625 transport_name = tp->name;
4627 /* There are weird circumstances in which logging is disabled */
4628 disable_logging = tp->disable_logging;
4630 /* Show pids on debug output if parallelism possible */
4632 if (parmax > 1 && (parcount > 0 || addr_remote))
4634 DEBUG(D_any|D_v) debug_selector |= D_pid;
4635 DEBUG(D_deliver) debug_printf("Remote delivery process started\n");
4638 /* Reset the random number generator, so different processes don't all
4639 have the same sequence. In the test harness we want different, but
4640 predictable settings for each delivery process, so do something explicit
4641 here rather they rely on the fixed reset in the random number function. */
4643 random_seed = running_in_test_harness ? 42 + 2*delivery_count : 0;
4645 /* Set close-on-exec on the pipe so that it doesn't get passed on to
4646 a new process that may be forked to do another delivery down the same
4649 (void)fcntl(fd, F_SETFD, fcntl(fd, F_GETFD) | FD_CLOEXEC);
4651 /* Close open file descriptors for the pipes of other processes
4652 that are running in parallel. */
4654 for (poffset = 0; poffset < remote_max_parallel; poffset++)
4655 if (parlist[poffset].pid != 0) (void)close(parlist[poffset].fd);
4657 /* This process has inherited a copy of the file descriptor
4658 for the data file, but its file pointer is shared with all the
4659 other processes running in parallel. Therefore, we have to re-open
4660 the file in order to get a new file descriptor with its own
4661 file pointer. We don't need to lock it, as the lock is held by
4662 the parent process. There doesn't seem to be any way of doing
4663 a dup-with-new-file-pointer. */
4665 (void)close(deliver_datafile);
4667 uschar * fname = spool_fname(US"input", message_subdir, message_id, US"-D");
4669 if ((deliver_datafile = Uopen(fname,
4673 O_RDWR | O_APPEND, 0)) < 0)
4674 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Failed to reopen %s for remote "
4675 "parallel delivery: %s", fname, strerror(errno));
4678 /* Set the close-on-exec flag */
4680 (void)fcntl(deliver_datafile, F_SETFD, fcntl(deliver_datafile, F_GETFD) |
4684 /* Set the uid/gid of this process; bombs out on failure. */
4686 exim_setugid(uid, gid, use_initgroups,
4687 string_sprintf("remote delivery to %s with transport=%s",
4688 addr->address, tp->name));
4690 /* Close the unwanted half of this process' pipe, set the process state,
4691 and run the transport. Afterwards, transport_count will contain the number
4692 of bytes written. */
4694 (void)close(pfd[pipe_read]);
4695 set_process_info("delivering %s using %s", message_id, tp->name);
4696 debug_print_string(tp->debug_string);
4697 if (!(tp->info->code)(addr->transport, addr)) replicate_status(addr);
4699 set_process_info("delivering %s (just run %s for %s%s in subprocess)",
4700 message_id, tp->name, addr->address, addr->next ? ", ..." : "");
4702 /* Ensure any cached resources that we used are now released */
4706 /* Pass the result back down the pipe. This is a lot more information
4707 than is needed for a local delivery. We have to send back the error
4708 status for each address, the usability status for each host that is
4709 flagged as unusable, and all the retry items. When TLS is in use, we
4710 send also the cipher and peerdn information. Each type of information
4711 is flagged by an identifying byte, and is then in a fixed format (with
4712 strings terminated by zeros), and there is a final terminator at the
4713 end. The host information and retry information is all attached to
4714 the first address, so that gets sent at the start. */
4716 /* Host unusability information: for most success cases this will
4719 for (h = addr->host_list; h; h = h->next)
4721 if (!h->address || h->status < hstatus_unusable) continue;
4722 sprintf(CS big_buffer, "%c%c%s", h->status, h->why, h->address);
4723 rmt_dlv_checked_write(fd, 'H', '0', big_buffer, Ustrlen(big_buffer+2) + 3);
4726 /* The number of bytes written. This is the same for each address. Even
4727 if we sent several copies of the message down the same connection, the
4728 size of each one is the same, and it's that value we have got because
4729 transport_count gets reset before calling transport_write_message(). */
4731 memcpy(big_buffer, &transport_count, sizeof(transport_count));
4732 rmt_dlv_checked_write(fd, 'S', '0', big_buffer, sizeof(transport_count));
4734 /* Information about what happened to each address. Four item types are
4735 used: an optional 'X' item first, for TLS information, then an optional "C"
4736 item for any client-auth info followed by 'R' items for any retry settings,
4737 and finally an 'A' item for the remaining data. */
4739 for(; addr; addr = addr->next)
4744 /* The certificate verification status goes into the flags */
4745 if (tls_out.certificate_verified) setflag(addr, af_cert_verified);
4746 #ifdef EXPERIMENTAL_DANE
4747 if (tls_out.dane_verified) setflag(addr, af_dane_verified);
4750 /* Use an X item only if there's something to send */
4754 ptr = big_buffer + sprintf(CS big_buffer, "%.128s", addr->cipher) + 1;
4758 ptr += sprintf(CS ptr, "%.512s", addr->peerdn) + 1;
4760 rmt_dlv_checked_write(fd, 'X', '1', big_buffer, ptr - big_buffer);
4762 else if (continue_proxy_cipher)
4764 ptr = big_buffer + sprintf(CS big_buffer, "%.128s", continue_proxy_cipher) + 1;
4766 rmt_dlv_checked_write(fd, 'X', '1', big_buffer, ptr - big_buffer);
4772 if (!tls_export_cert(ptr, big_buffer_size-2, addr->peercert))
4776 rmt_dlv_checked_write(fd, 'X', '2', big_buffer, ptr - big_buffer);
4781 if (!tls_export_cert(ptr, big_buffer_size-2, addr->ourcert))
4785 rmt_dlv_checked_write(fd, 'X', '3', big_buffer, ptr - big_buffer);
4787 # ifndef DISABLE_OCSP
4788 if (addr->ocsp > OCSP_NOT_REQ)
4790 ptr = big_buffer + sprintf(CS big_buffer, "%c", addr->ocsp + '0') + 1;
4791 rmt_dlv_checked_write(fd, 'X', '4', big_buffer, ptr - big_buffer);
4794 #endif /*SUPPORT_TLS*/
4796 if (client_authenticator)
4798 ptr = big_buffer + sprintf(CS big_buffer, "%.64s", client_authenticator) + 1;
4799 rmt_dlv_checked_write(fd, 'C', '1', big_buffer, ptr - big_buffer);
4801 if (client_authenticated_id)
4803 ptr = big_buffer + sprintf(CS big_buffer, "%.64s", client_authenticated_id) + 1;
4804 rmt_dlv_checked_write(fd, 'C', '2', big_buffer, ptr - big_buffer);
4806 if (client_authenticated_sender)
4808 ptr = big_buffer + sprintf(CS big_buffer, "%.64s", client_authenticated_sender) + 1;
4809 rmt_dlv_checked_write(fd, 'C', '3', big_buffer, ptr - big_buffer);
4812 #ifndef DISABLE_PRDR
4813 if (testflag(addr, af_prdr_used))
4814 rmt_dlv_checked_write(fd, 'P', '0', NULL, 0);
4817 if (testflag(addr, af_chunking_used))
4818 rmt_dlv_checked_write(fd, 'K', '0', NULL, 0);
4820 if (testflag(addr, af_tcp_fastopen_conn))
4821 rmt_dlv_checked_write(fd, 'T',
4822 testflag(addr, af_tcp_fastopen) ? '1' : '0', NULL, 0);
4824 memcpy(big_buffer, &addr->dsn_aware, sizeof(addr->dsn_aware));
4825 rmt_dlv_checked_write(fd, 'D', '0', big_buffer, sizeof(addr->dsn_aware));
4827 /* Retry information: for most success cases this will be null. */
4829 for (r = addr->retries; r; r = r->next)
4831 sprintf(CS big_buffer, "%c%.500s", r->flags, r->key);
4832 ptr = big_buffer + Ustrlen(big_buffer+2) + 3;
4833 memcpy(ptr, &r->basic_errno, sizeof(r->basic_errno));
4834 ptr += sizeof(r->basic_errno);
4835 memcpy(ptr, &r->more_errno, sizeof(r->more_errno));
4836 ptr += sizeof(r->more_errno);
4837 if (!r->message) *ptr++ = 0; else
4839 sprintf(CS ptr, "%.512s", r->message);
4842 rmt_dlv_checked_write(fd, 'R', '0', big_buffer, ptr - big_buffer);
4845 #ifdef SUPPORT_SOCKS
4846 if (LOGGING(proxy) && proxy_session)
4849 if (proxy_local_address)
4851 DEBUG(D_deliver) debug_printf("proxy_local_address '%s'\n", proxy_local_address);
4852 ptr = big_buffer + sprintf(CS ptr, "%.128s", proxy_local_address) + 1;
4853 DEBUG(D_deliver) debug_printf("proxy_local_port %d\n", proxy_local_port);
4854 memcpy(ptr, &proxy_local_port, sizeof(proxy_local_port));
4855 ptr += sizeof(proxy_local_port);
4859 rmt_dlv_checked_write(fd, 'A', '2', big_buffer, ptr - big_buffer);
4863 #ifdef EXPERIMENTAL_DSN_INFO
4864 /*um, are they really per-addr? Other per-conn stuff is not (auth, tls). But host_used is! */
4865 if (addr->smtp_greeting)
4867 DEBUG(D_deliver) debug_printf("smtp_greeting '%s'\n", addr->smtp_greeting);
4868 ptr = big_buffer + sprintf(CS big_buffer, "%.128s", addr->smtp_greeting) + 1;
4869 if (addr->helo_response)
4871 DEBUG(D_deliver) debug_printf("helo_response '%s'\n", addr->helo_response);
4872 ptr += sprintf(CS ptr, "%.128s", addr->helo_response) + 1;
4876 rmt_dlv_checked_write(fd, 'A', '1', big_buffer, ptr - big_buffer);
4880 /* The rest of the information goes in an 'A0' item. */
4882 sprintf(CS big_buffer, "%c%c", addr->transport_return, addr->special_action);
4883 ptr = big_buffer + 2;
4884 memcpy(ptr, &addr->basic_errno, sizeof(addr->basic_errno));
4885 ptr += sizeof(addr->basic_errno);
4886 memcpy(ptr, &addr->more_errno, sizeof(addr->more_errno));
4887 ptr += sizeof(addr->more_errno);
4888 memcpy(ptr, &addr->delivery_usec, sizeof(addr->delivery_usec));
4889 ptr += sizeof(addr->delivery_usec);
4890 memcpy(ptr, &addr->flags, sizeof(addr->flags));
4891 ptr += sizeof(addr->flags);
4893 if (!addr->message) *ptr++ = 0; else
4894 ptr += sprintf(CS ptr, "%.1024s", addr->message) + 1;
4896 if (!addr->user_message) *ptr++ = 0; else
4897 ptr += sprintf(CS ptr, "%.1024s", addr->user_message) + 1;
4899 if (!addr->host_used) *ptr++ = 0; else
4901 ptr += sprintf(CS ptr, "%.256s", addr->host_used->name) + 1;
4902 ptr += sprintf(CS ptr, "%.64s", addr->host_used->address) + 1;
4903 memcpy(ptr, &addr->host_used->port, sizeof(addr->host_used->port));
4904 ptr += sizeof(addr->host_used->port);
4906 /* DNS lookup status */
4907 *ptr++ = addr->host_used->dnssec==DS_YES ? '2'
4908 : addr->host_used->dnssec==DS_NO ? '1' : '0';
4911 rmt_dlv_checked_write(fd, 'A', '0', big_buffer, ptr - big_buffer);
4914 /* Local interface address/port */
4915 #ifdef EXPERIMENTAL_DSN_INFO
4916 if (sending_ip_address)
4918 if (LOGGING(incoming_interface) && sending_ip_address)
4922 ptr = big_buffer + sprintf(CS big_buffer, "%.128s", sending_ip_address) + 1;
4923 ptr += sprintf(CS ptr, "%d", sending_port) + 1;
4924 rmt_dlv_checked_write(fd, 'I', '0', big_buffer, ptr - big_buffer);
4927 /* Add termination flag, close the pipe, and that's it. The character
4928 after 'Z' indicates whether continue_transport is now NULL or not.
4929 A change from non-NULL to NULL indicates a problem with a continuing
4932 big_buffer[0] = continue_transport ? '1' : '0';
4933 rmt_dlv_checked_write(fd, 'Z', '0', big_buffer, 1);
4938 /* Back in the mainline: close the unwanted half of the pipe. */
4940 (void)close(pfd[pipe_write]);
4942 /* If we have a connection still open from a verify stage (lazy-close)
4943 release its TLS library context (if any) as responsibility was passed to
4944 the delivery child process. */
4946 if (cutthrough.fd >= 0 && cutthrough.callout_hold_only)
4949 tls_close(FALSE, FALSE);
4951 (void) close(cutthrough.fd);
4952 release_cutthrough_connection(US"passed to transport proc");
4955 /* Fork failed; defer with error message */
4959 (void)close(pfd[pipe_read]);
4960 panicmsg = string_sprintf("fork failed for remote delivery to %s: %s",
4961 addr->domain, strerror(errno));
4965 /* Fork succeeded; increment the count, and remember relevant data for
4966 when the process finishes. */
4969 parlist[poffset].addrlist = parlist[poffset].addr = addr;
4970 parlist[poffset].pid = pid;
4971 parlist[poffset].fd = pfd[pipe_read];
4972 parlist[poffset].done = FALSE;
4973 parlist[poffset].msg = NULL;
4974 parlist[poffset].return_path = return_path;
4976 /* If the process we've just started is sending a message down an existing
4977 channel, wait for it now. This ensures that only one such process runs at
4978 once, whatever the value of remote_max parallel. Otherwise, we might try to
4979 send two or more messages simultaneously down the same channel. This could
4980 happen if there are different domains that include the same host in otherwise
4981 different host lists.
4983 Also, if the transport closes down the channel, this information gets back
4984 (continue_transport gets set to NULL) before we consider any other addresses
4987 if (continue_transport) par_reduce(0, fallback);
4989 /* Otherwise, if we are running in the test harness, wait a bit, to let the
4990 newly created process get going before we create another process. This should
4991 ensure repeatability in the tests. We only need to wait a tad. */
4993 else if (running_in_test_harness) millisleep(500);
4998 if (serialize_key) enq_end(serialize_key);
5000 remote_post_process(addr, LOG_MAIN|LOG_PANIC, panicmsg, fallback);
5004 /* Reached the end of the list of addresses. Wait for all the subprocesses that
5005 are still running and post-process their addresses. */
5007 par_reduce(0, fallback);
5014 /*************************************************
5015 * Split an address into local part and domain *
5016 *************************************************/
5018 /* This function initializes an address for routing by splitting it up into a
5019 local part and a domain. The local part is set up twice - once in its original
5020 casing, and once in lower case, and it is dequoted. We also do the "percent
5021 hack" for configured domains. This may lead to a DEFER result if a lookup
5022 defers. When a percent-hacking takes place, we insert a copy of the original
5023 address as a new parent of this address, as if we have had a redirection.
5026 addr points to an addr_item block containing the address
5029 DEFER - could not determine if domain is %-hackable
5033 deliver_split_address(address_item * addr)
5035 uschar * address = addr->address;
5040 if (!(domain = Ustrrchr(address, '@')))
5041 return DEFER; /* should always have a domain, but just in case... */
5043 len = domain - address;
5044 addr->domain = string_copylc(domain+1); /* Domains are always caseless */
5046 /* The implication in the RFCs (though I can't say I've seen it spelled out
5047 explicitly) is that quoting should be removed from local parts at the point
5048 where they are locally interpreted. [The new draft "821" is more explicit on
5049 this, Jan 1999.] We know the syntax is valid, so this can be done by simply
5050 removing quoting backslashes and any unquoted doublequotes. */
5052 t = addr->cc_local_part = store_get(len+1);
5056 if (c == '\"') continue;
5066 /* We do the percent hack only for those domains that are listed in
5067 percent_hack_domains. A loop is required, to copy with multiple %-hacks. */
5069 if (percent_hack_domains)
5072 uschar *new_address = NULL;
5073 uschar *local_part = addr->cc_local_part;
5075 deliver_domain = addr->domain; /* set $domain */
5077 while ( (rc = match_isinlist(deliver_domain, (const uschar **)&percent_hack_domains, 0,
5078 &domainlist_anchor, addr->domain_cache, MCL_DOMAIN, TRUE, NULL))
5080 && (t = Ustrrchr(local_part, '%')) != NULL
5083 new_address = string_copy(local_part);
5084 new_address[t - local_part] = '@';
5085 deliver_domain = string_copylc(t+1);
5086 local_part = string_copyn(local_part, t - local_part);
5089 if (rc == DEFER) return DEFER; /* lookup deferred */
5091 /* If hackery happened, set up new parent and alter the current address. */
5095 address_item *new_parent = store_get(sizeof(address_item));
5096 *new_parent = *addr;
5097 addr->parent = new_parent;
5098 new_parent->child_count = 1;
5099 addr->address = new_address;
5100 addr->unique = string_copy(new_address);
5101 addr->domain = deliver_domain;
5102 addr->cc_local_part = local_part;
5103 DEBUG(D_deliver) debug_printf("%%-hack changed address to: %s\n",
5108 /* Create the lowercased version of the final local part, and make that the
5109 default one to be used. */
5111 addr->local_part = addr->lc_local_part = string_copylc(addr->cc_local_part);
5118 /*************************************************
5119 * Get next error message text *
5120 *************************************************/
5122 /* If f is not NULL, read the next "paragraph", from a customized error message
5123 text file, terminated by a line containing ****, and expand it.
5126 f NULL or a file to read from
5127 which string indicating which string (for errors)
5129 Returns: NULL or an expanded string
5133 next_emf(FILE *f, uschar *which)
5139 if (!f) return NULL;
5141 if (!Ufgets(buffer, sizeof(buffer), f) || Ustrcmp(buffer, "****\n") == 0)
5144 para = string_get(256);
5147 para = string_cat(para, buffer);
5148 if (!Ufgets(buffer, sizeof(buffer), f) || Ustrcmp(buffer, "****\n") == 0)
5151 if ((yield = expand_string(string_from_gstring(para))))
5154 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand string from "
5155 "bounce_message_file or warn_message_file (%s): %s", which,
5156 expand_string_message);
5163 /*************************************************
5164 * Close down a passed transport channel *
5165 *************************************************/
5167 /* This function is called when a passed transport channel cannot be used.
5168 It attempts to close it down tidily. The yield is always DELIVER_NOT_ATTEMPTED
5169 so that the function call can be the argument of a "return" statement.
5172 Returns: DELIVER_NOT_ATTEMPTED
5176 continue_closedown(void)
5178 if (continue_transport)
5180 transport_instance *t;
5181 for (t = transports; t; t = t->next)
5182 if (Ustrcmp(t->name, continue_transport) == 0)
5184 if (t->info->closedown) (t->info->closedown)(t);
5188 return DELIVER_NOT_ATTEMPTED;
5194 /*************************************************
5195 * Print address information *
5196 *************************************************/
5198 /* This function is called to output an address, or information about an
5199 address, for bounce or defer messages. If the hide_child flag is set, all we
5200 output is the original ancestor address.
5203 addr points to the address
5204 f the FILE to print to
5205 si an initial string
5206 sc a continuation string for before "generated"
5209 Returns: TRUE if the address is not hidden
5213 print_address_information(address_item *addr, FILE *f, uschar *si, uschar *sc,
5217 uschar *printed = US"";
5218 address_item *ancestor = addr;
5219 while (ancestor->parent) ancestor = ancestor->parent;
5221 fprintf(f, "%s", CS si);
5223 if (addr->parent && testflag(addr, af_hide_child))
5225 printed = US"an undisclosed address";
5228 else if (!testflag(addr, af_pfr) || !addr->parent)
5229 printed = addr->address;
5233 uschar *s = addr->address;
5236 if (addr->address[0] == '>') { ss = US"mail"; s++; }
5237 else if (addr->address[0] == '|') ss = US"pipe";
5240 fprintf(f, "%s to %s%sgenerated by ", ss, s, sc);
5241 printed = addr->parent->address;
5244 fprintf(f, "%s", CS string_printing(printed));
5246 if (ancestor != addr)
5248 uschar *original = ancestor->onetime_parent;
5249 if (!original) original= ancestor->address;
5250 if (strcmpic(original, printed) != 0)
5251 fprintf(f, "%s(%sgenerated from %s)", sc,
5252 ancestor != addr->parent ? "ultimately " : "",
5253 string_printing(original));
5256 if (addr->host_used)
5257 fprintf(f, "\n host %s [%s]",
5258 addr->host_used->name, addr->host_used->address);
5260 fprintf(f, "%s", CS se);
5268 /*************************************************
5269 * Print error for an address *
5270 *************************************************/
5272 /* This function is called to print the error information out of an address for
5273 a bounce or a warning message. It tries to format the message reasonably by
5274 introducing newlines. All lines are indented by 4; the initial printing
5275 position must be set before calling.
5277 This function used always to print the error. Nowadays we want to restrict it
5278 to cases such as LMTP/SMTP errors from a remote host, and errors from :fail:
5279 and filter "fail". We no longer pass other information willy-nilly in bounce
5280 and warning messages. Text in user_message is always output; text in message
5281 only if the af_pass_message flag is set.
5285 f the FILE to print on
5292 print_address_error(address_item *addr, FILE *f, uschar *t)
5294 int count = Ustrlen(t);
5295 uschar *s = testflag(addr, af_pass_message)? addr->message : NULL;
5297 if (!s && !(s = addr->user_message))
5300 fprintf(f, "\n %s", t);
5303 if (*s == '\\' && s[1] == 'n')
5313 if (*s++ == ':' && isspace(*s) && count > 45)
5315 fprintf(f, "\n "); /* sic (because space follows) */
5322 /***********************************************************
5323 * Print Diagnostic-Code for an address *
5324 ************************************************************/
5326 /* This function is called to print the error information out of an address for
5327 a bounce or a warning message. It tries to format the message reasonably as
5328 required by RFC 3461 by adding a space after each newline
5330 it uses the same logic as print_address_error() above. if af_pass_message is true
5331 and addr->message is set it uses the remote host answer. if not addr->user_message
5332 is used instead if available.
5336 f the FILE to print on
5342 print_dsn_diagnostic_code(const address_item *addr, FILE *f)
5344 uschar *s = testflag(addr, af_pass_message) ? addr->message : NULL;
5346 /* af_pass_message and addr->message set ? print remote host answer */
5350 debug_printf("DSN Diagnostic-Code: addr->message = %s\n", addr->message);
5352 /* search first ": ". we assume to find the remote-MTA answer there */
5353 if (!(s = Ustrstr(addr->message, ": ")))
5354 return; /* not found, bail out */
5355 s += 2; /* skip ": " */
5356 fprintf(f, "Diagnostic-Code: smtp; ");
5358 /* no message available. do nothing */
5362 if (*s == '\\' && s[1] == 'n')
5364 fputs("\n ", f); /* as defined in RFC 3461 */
5374 /*************************************************
5375 * Check list of addresses for duplication *
5376 *************************************************/
5378 /* This function was introduced when the test for duplicate addresses that are
5379 not pipes, files, or autoreplies was moved from the middle of routing to when
5380 routing was complete. That was to fix obscure cases when the routing history
5381 affects the subsequent routing of identical addresses. This function is called
5382 after routing, to check that the final routed addresses are not duplicates.
5384 If we detect a duplicate, we remember what it is a duplicate of. Note that
5385 pipe, file, and autoreply de-duplication is handled during routing, so we must
5386 leave such "addresses" alone here, as otherwise they will incorrectly be
5389 Argument: address of list anchor
5394 do_duplicate_check(address_item **anchor)
5397 while ((addr = *anchor))
5400 if (testflag(addr, af_pfr))
5402 anchor = &(addr->next);
5404 else if ((tnode = tree_search(tree_duplicates, addr->unique)))
5406 DEBUG(D_deliver|D_route)
5407 debug_printf("%s is a duplicate address: discarded\n", addr->unique);
5408 *anchor = addr->next;
5409 addr->dupof = tnode->data.ptr;
5410 addr->next = addr_duplicate;
5411 addr_duplicate = addr;
5415 tree_add_duplicate(addr->unique, addr);
5416 anchor = &(addr->next);
5424 /*************************************************
5425 * Deliver one message *
5426 *************************************************/
5428 /* This is the function which is called when a message is to be delivered. It
5429 is passed the id of the message. It is possible that the message no longer
5430 exists, if some other process has delivered it, and it is also possible that
5431 the message is being worked on by another process, in which case the data file
5434 If no delivery is attempted for any of the above reasons, the function returns
5435 DELIVER_NOT_ATTEMPTED.
5437 If the give_up flag is set true, do not attempt any deliveries, but instead
5438 fail all outstanding addresses and return the message to the sender (or
5441 A delivery operation has a process all to itself; we never deliver more than
5442 one message in the same process. Therefore we needn't worry too much about
5445 Liable to be called as root.
5448 id the id of the message to be delivered
5449 forced TRUE if delivery was forced by an administrator; this overrides
5450 retry delays and causes a delivery to be tried regardless
5451 give_up TRUE if an administrator has requested that delivery attempts
5454 Returns: When the global variable mua_wrapper is FALSE:
5455 DELIVER_ATTEMPTED_NORMAL if a delivery attempt was made
5456 DELIVER_NOT_ATTEMPTED otherwise (see comment above)
5457 When the global variable mua_wrapper is TRUE:
5458 DELIVER_MUA_SUCCEEDED if delivery succeeded
5459 DELIVER_MUA_FAILED if delivery failed
5460 DELIVER_NOT_ATTEMPTED if not attempted (should not occur)
5464 deliver_message(uschar *id, BOOL forced, BOOL give_up)
5467 int final_yield = DELIVER_ATTEMPTED_NORMAL;
5468 time_t now = time(NULL);
5469 address_item *addr_last = NULL;
5470 uschar *filter_message = NULL;
5471 int process_recipients = RECIP_ACCEPT;
5474 extern int acl_where;
5476 uschar *info = queue_run_pid == (pid_t)0
5477 ? string_sprintf("delivering %s", id)
5478 : string_sprintf("delivering %s (queue run pid %d)", id, queue_run_pid);
5480 /* If the D_process_info bit is on, set_process_info() will output debugging
5481 information. If not, we want to show this initial information if D_deliver or
5482 D_queue_run is set or in verbose mode. */
5484 set_process_info("%s", info);
5486 if ( !(debug_selector & D_process_info)
5487 && (debug_selector & (D_deliver|D_queue_run|D_v))
5489 debug_printf("%s\n", info);
5491 /* Ensure that we catch any subprocesses that are created. Although Exim
5492 sets SIG_DFL as its initial default, some routes through the code end up
5493 here with it set to SIG_IGN - cases where a non-synchronous delivery process
5494 has been forked, but no re-exec has been done. We use sigaction rather than
5495 plain signal() on those OS where SA_NOCLDWAIT exists, because we want to be
5496 sure it is turned off. (There was a problem on AIX with this.) */
5500 struct sigaction act;
5501 act.sa_handler = SIG_DFL;
5502 sigemptyset(&(act.sa_mask));
5504 sigaction(SIGCHLD, &act, NULL);
5507 signal(SIGCHLD, SIG_DFL);
5510 /* Make the forcing flag available for routers and transports, set up the
5511 global message id field, and initialize the count for returned files and the
5512 message size. This use of strcpy() is OK because the length id is checked when
5513 it is obtained from a command line (the -M or -q options), and otherwise it is
5514 known to be a valid message id. */
5516 Ustrcpy(message_id, id);
5517 deliver_force = forced;
5521 /* Initialize some flags */
5523 update_spool = FALSE;
5524 remove_journal = TRUE;
5526 /* Set a known context for any ACLs we call via expansions */
5527 acl_where = ACL_WHERE_DELIVERY;
5529 /* Reset the random number generator, so that if several delivery processes are
5530 started from a queue runner that has already used random numbers (for sorting),
5531 they don't all get the same sequence. */
5535 /* Open and lock the message's data file. Exim locks on this one because the
5536 header file may get replaced as it is re-written during the delivery process.
5537 Any failures cause messages to be written to the log, except for missing files
5538 while queue running - another process probably completed delivery. As part of
5539 opening the data file, message_subdir gets set. */
5541 if ((deliver_datafile = spool_open_datafile(id)) < 0)
5542 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5544 /* The value of message_size at this point has been set to the data length,
5545 plus one for the blank line that notionally precedes the data. */
5547 /* Now read the contents of the header file, which will set up the headers in
5548 store, and also the list of recipients and the tree of non-recipients and
5549 assorted flags. It updates message_size. If there is a reading or format error,
5550 give up; if the message has been around for sufficiently long, remove it. */
5553 uschar * spoolname = string_sprintf("%s-H", id);
5554 if ((rc = spool_read_header(spoolname, TRUE, TRUE)) != spool_read_OK)
5556 if (errno == ERRNO_SPOOLFORMAT)
5558 struct stat statbuf;
5559 if (Ustat(spool_fname(US"input", message_subdir, spoolname, US""),
5561 log_write(0, LOG_MAIN, "Format error in spool file %s: "
5562 "size=" OFF_T_FMT, spoolname, statbuf.st_size);
5564 log_write(0, LOG_MAIN, "Format error in spool file %s", spoolname);
5567 log_write(0, LOG_MAIN, "Error reading spool file %s: %s", spoolname,
5570 /* If we managed to read the envelope data, received_time contains the
5571 time the message was received. Otherwise, we can calculate it from the
5574 if (rc != spool_read_hdrerror)
5576 received_time.tv_sec = received_time.tv_usec = 0;
5577 /*XXX subsec precision?*/
5578 for (i = 0; i < 6; i++)
5579 received_time.tv_sec = received_time.tv_sec * BASE_62 + tab62[id[i] - '0'];
5582 /* If we've had this malformed message too long, sling it. */
5584 if (now - received_time.tv_sec > keep_malformed)
5586 Uunlink(spool_fname(US"msglog", message_subdir, id, US""));
5587 Uunlink(spool_fname(US"input", message_subdir, id, US"-D"));
5588 Uunlink(spool_fname(US"input", message_subdir, id, US"-H"));
5589 Uunlink(spool_fname(US"input", message_subdir, id, US"-J"));
5590 log_write(0, LOG_MAIN, "Message removed because older than %s",
5591 readconf_printtime(keep_malformed));
5594 (void)close(deliver_datafile);
5595 deliver_datafile = -1;
5596 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5600 /* The spool header file has been read. Look to see if there is an existing
5601 journal file for this message. If there is, it means that a previous delivery
5602 attempt crashed (program or host) before it could update the spool header file.
5603 Read the list of delivered addresses from the journal and add them to the
5604 nonrecipients tree. Then update the spool file. We can leave the journal in
5605 existence, as it will get further successful deliveries added to it in this
5606 run, and it will be deleted if this function gets to its end successfully.
5607 Otherwise it might be needed again. */
5610 uschar * fname = spool_fname(US"input", message_subdir, id, US"-J");
5613 if ( (journal_fd = Uopen(fname, O_RDWR|O_APPEND
5621 && lseek(journal_fd, 0, SEEK_SET) == 0
5622 && (jread = fdopen(journal_fd, "rb"))
5625 while (Ufgets(big_buffer, big_buffer_size, jread))
5627 int n = Ustrlen(big_buffer);
5628 big_buffer[n-1] = 0;
5629 tree_add_nonrecipient(big_buffer);
5630 DEBUG(D_deliver) debug_printf("Previously delivered address %s taken from "
5631 "journal file\n", big_buffer);
5634 if ((journal_fd = dup(fileno(jread))) < 0)
5635 journal_fd = fileno(jread);
5637 (void) fclose(jread); /* Try to not leak the FILE resource */
5639 /* Panic-dies on error */
5640 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
5642 else if (errno != ENOENT)
5644 log_write(0, LOG_MAIN|LOG_PANIC, "attempt to open journal for reading gave: "
5645 "%s", strerror(errno));
5646 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5649 /* A null recipients list indicates some kind of disaster. */
5651 if (!recipients_list)
5653 (void)close(deliver_datafile);
5654 deliver_datafile = -1;
5655 log_write(0, LOG_MAIN, "Spool error: no recipients for %s", fname);
5656 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5661 /* Handle a message that is frozen. There are a number of different things that
5662 can happen, but in the default situation, unless forced, no delivery is
5667 #ifdef SUPPORT_MOVE_FROZEN_MESSAGES
5668 /* Moving to another directory removes the message from Exim's view. Other
5669 tools must be used to deal with it. Logging of this action happens in
5670 spool_move_message() and its subfunctions. */
5672 if ( move_frozen_messages
5673 && spool_move_message(id, message_subdir, US"", US"F")
5675 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5678 /* For all frozen messages (bounces or not), timeout_frozen_after sets the
5679 maximum time to keep messages that are frozen. Thaw if we reach it, with a
5680 flag causing all recipients to be failed. The time is the age of the
5681 message, not the time since freezing. */
5683 if (timeout_frozen_after > 0 && message_age >= timeout_frozen_after)
5685 log_write(0, LOG_MAIN, "cancelled by timeout_frozen_after");
5686 process_recipients = RECIP_FAIL_TIMEOUT;
5689 /* For bounce messages (and others with no sender), thaw if the error message
5690 ignore timer is exceeded. The message will be discarded if this delivery
5693 else if (!*sender_address && message_age >= ignore_bounce_errors_after)
5694 log_write(0, LOG_MAIN, "Unfrozen by errmsg timer");
5696 /* If this is a bounce message, or there's no auto thaw, or we haven't
5697 reached the auto thaw time yet, and this delivery is not forced by an admin
5698 user, do not attempt delivery of this message. Note that forced is set for
5699 continuing messages down the same channel, in order to skip load checking and
5700 ignore hold domains, but we don't want unfreezing in that case. */
5704 if ( ( sender_address[0] == 0
5706 || now <= deliver_frozen_at + auto_thaw
5708 && ( !forced || !deliver_force_thaw
5709 || !admin_user || continue_hostname
5712 (void)close(deliver_datafile);
5713 deliver_datafile = -1;
5714 log_write(L_skip_delivery, LOG_MAIN, "Message is frozen");
5715 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5718 /* If delivery was forced (by an admin user), assume a manual thaw.
5719 Otherwise it's an auto thaw. */
5723 deliver_manual_thaw = TRUE;
5724 log_write(0, LOG_MAIN, "Unfrozen by forced delivery");
5726 else log_write(0, LOG_MAIN, "Unfrozen by auto-thaw");
5729 /* We get here if any of the rules for unfreezing have triggered. */
5731 deliver_freeze = FALSE;
5732 update_spool = TRUE;
5736 /* Open the message log file if we are using them. This records details of
5737 deliveries, deferments, and failures for the benefit of the mail administrator.
5738 The log is not used by exim itself to track the progress of a message; that is
5739 done by rewriting the header spool file. */
5743 uschar * fname = spool_fname(US"msglog", message_subdir, id, US"");
5747 if ((fd = open_msglog_file(fname, SPOOL_MODE, &error)) < 0)
5749 log_write(0, LOG_MAIN|LOG_PANIC, "Couldn't %s message log %s: %s", error,
5750 fname, strerror(errno));
5751 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5754 /* Make a C stream out of it. */
5756 if (!(message_log = fdopen(fd, "a")))
5758 log_write(0, LOG_MAIN|LOG_PANIC, "Couldn't fdopen message log %s: %s",
5759 fname, strerror(errno));
5760 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5765 /* If asked to give up on a message, log who did it, and set the action for all
5770 struct passwd *pw = getpwuid(real_uid);
5771 log_write(0, LOG_MAIN, "cancelled by %s",
5772 pw ? US pw->pw_name : string_sprintf("uid %ld", (long int)real_uid));
5773 process_recipients = RECIP_FAIL;
5776 /* Otherwise, if there are too many Received: headers, fail all recipients. */
5778 else if (received_count > received_headers_max)
5779 process_recipients = RECIP_FAIL_LOOP;
5781 /* Otherwise, if a system-wide, address-independent message filter is
5782 specified, run it now, except in the case when we are failing all recipients as
5783 a result of timeout_frozen_after. If the system filter yields "delivered", then
5784 ignore the true recipients of the message. Failure of the filter file is
5785 logged, and the delivery attempt fails. */
5787 else if (system_filter && process_recipients != RECIP_FAIL_TIMEOUT)
5792 redirect_block redirect;
5794 if (system_filter_uid_set)
5796 ugid.uid = system_filter_uid;
5797 ugid.gid = system_filter_gid;
5798 ugid.uid_set = ugid.gid_set = TRUE;
5802 ugid.uid_set = ugid.gid_set = FALSE;
5805 return_path = sender_address;
5806 enable_dollar_recipients = TRUE; /* Permit $recipients in system filter */
5807 system_filtering = TRUE;
5809 /* Any error in the filter file causes a delivery to be abandoned. */
5811 redirect.string = system_filter;
5812 redirect.isfile = TRUE;
5813 redirect.check_owner = redirect.check_group = FALSE;
5814 redirect.owners = NULL;
5815 redirect.owngroups = NULL;
5817 redirect.modemask = 0;
5819 DEBUG(D_deliver|D_filter) debug_printf("running system filter\n");
5822 &redirect, /* Where the data is */
5823 RDO_DEFER | /* Turn on all the enabling options */
5824 RDO_FAIL | /* Leave off all the disabling options */
5829 NULL, /* No :include: restriction (not used in filter) */
5830 NULL, /* No sieve vacation directory (not sieve!) */
5831 NULL, /* No sieve enotify mailto owner (not sieve!) */
5832 NULL, /* No sieve user address (not sieve!) */
5833 NULL, /* No sieve subaddress (not sieve!) */
5834 &ugid, /* uid/gid data */
5835 &addr_new, /* Where to hang generated addresses */
5836 &filter_message, /* Where to put error message */
5837 NULL, /* Don't skip syntax errors */
5838 &filtertype, /* Will always be set to FILTER_EXIM for this call */
5839 US"system filter"); /* For error messages */
5841 DEBUG(D_deliver|D_filter) debug_printf("system filter returned %d\n", rc);
5843 if (rc == FF_ERROR || rc == FF_NONEXIST)
5845 (void)close(deliver_datafile);
5846 deliver_datafile = -1;
5847 log_write(0, LOG_MAIN|LOG_PANIC, "Error in system filter: %s",
5848 string_printing(filter_message));
5849 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5852 /* Reset things. If the filter message is an empty string, which can happen
5853 for a filter "fail" or "freeze" command with no text, reset it to NULL. */
5855 system_filtering = FALSE;
5856 enable_dollar_recipients = FALSE;
5857 if (filter_message && filter_message[0] == 0) filter_message = NULL;
5859 /* Save the values of the system filter variables so that user filters
5862 memcpy(filter_sn, filter_n, sizeof(filter_sn));
5864 /* The filter can request that delivery of the original addresses be
5869 process_recipients = RECIP_DEFER;
5870 deliver_msglog("Delivery deferred by system filter\n");
5871 log_write(0, LOG_MAIN, "Delivery deferred by system filter");
5874 /* The filter can request that a message be frozen, but this does not
5875 take place if the message has been manually thawed. In that case, we must
5876 unset "delivered", which is forced by the "freeze" command to make -bF
5879 else if (rc == FF_FREEZE && !deliver_manual_thaw)
5881 deliver_freeze = TRUE;
5882 deliver_frozen_at = time(NULL);
5883 process_recipients = RECIP_DEFER;
5884 frozen_info = string_sprintf(" by the system filter%s%s",
5885 filter_message ? US": " : US"",
5886 filter_message ? filter_message : US"");
5889 /* The filter can request that a message be failed. The error message may be
5890 quite long - it is sent back to the sender in the bounce - but we don't want
5891 to fill up the log with repetitions of it. If it starts with << then the text
5892 between << and >> is written to the log, with the rest left for the bounce
5895 else if (rc == FF_FAIL)
5897 uschar *colon = US"";
5898 uschar *logmsg = US"";
5901 process_recipients = RECIP_FAIL_FILTER;
5907 if ( filter_message[0] == '<'
5908 && filter_message[1] == '<'
5909 && (logend = Ustrstr(filter_message, ">>"))
5912 logmsg = filter_message + 2;
5913 loglen = logend - logmsg;
5914 filter_message = logend + 2;
5915 if (filter_message[0] == 0) filter_message = NULL;
5919 logmsg = filter_message;
5920 loglen = Ustrlen(filter_message);
5924 log_write(0, LOG_MAIN, "cancelled by system filter%s%.*s", colon, loglen,
5928 /* Delivery can be restricted only to those recipients (if any) that the
5929 filter specified. */
5931 else if (rc == FF_DELIVERED)
5933 process_recipients = RECIP_IGNORE;
5935 log_write(0, LOG_MAIN, "original recipients ignored (system filter)");
5937 log_write(0, LOG_MAIN, "=> discarded (system filter)");
5940 /* If any new addresses were created by the filter, fake up a "parent"
5941 for them. This is necessary for pipes, etc., which are expected to have
5942 parents, and it also gives some sensible logging for others. Allow
5943 pipes, files, and autoreplies, and run them as the filter uid if set,
5944 otherwise as the current uid. */
5948 int uid = (system_filter_uid_set)? system_filter_uid : geteuid();
5949 int gid = (system_filter_gid_set)? system_filter_gid : getegid();
5951 /* The text "system-filter" is tested in transport_set_up_command() and in
5952 set_up_shell_command() in the pipe transport, to enable them to permit
5953 $recipients, so don't change it here without also changing it there. */
5955 address_item *p = addr_new;
5956 address_item *parent = deliver_make_addr(US"system-filter", FALSE);
5958 parent->domain = string_copylc(qualify_domain_recipient);
5959 parent->local_part = US"system-filter";
5961 /* As part of this loop, we arrange for addr_last to end up pointing
5962 at the final address. This is used if we go on to add addresses for the
5963 original recipients. */
5967 if (parent->child_count == USHRT_MAX)
5968 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "system filter generated more "
5969 "than %d delivery addresses", USHRT_MAX);
5970 parent->child_count++;
5973 if (testflag(p, af_pfr))
5979 setflag(p, af_uid_set);
5980 setflag(p, af_gid_set);
5981 setflag(p, af_allow_file);
5982 setflag(p, af_allow_pipe);
5983 setflag(p, af_allow_reply);
5985 /* Find the name of the system filter's appropriate pfr transport */
5987 if (p->address[0] == '|')
5990 tpname = system_filter_pipe_transport;
5991 address_pipe = p->address;
5993 else if (p->address[0] == '>')
5996 tpname = system_filter_reply_transport;
6000 if (p->address[Ustrlen(p->address)-1] == '/')
6002 type = US"directory";
6003 tpname = system_filter_directory_transport;
6008 tpname = system_filter_file_transport;
6010 address_file = p->address;
6013 /* Now find the actual transport, first expanding the name. We have
6014 set address_file or address_pipe above. */
6018 uschar *tmp = expand_string(tpname);
6019 address_file = address_pipe = NULL;
6021 p->message = string_sprintf("failed to expand \"%s\" as a "
6022 "system filter transport name", tpname);
6026 p->message = string_sprintf("system_filter_%s_transport is unset",
6031 transport_instance *tp;
6032 for (tp = transports; tp; tp = tp->next)
6033 if (Ustrcmp(tp->name, tpname) == 0)
6039 p->message = string_sprintf("failed to find \"%s\" transport "
6040 "for system filter delivery", tpname);
6043 /* If we couldn't set up a transport, defer the delivery, putting the
6044 error on the panic log as well as the main log. */
6048 address_item *badp = p;
6050 if (!addr_last) addr_new = p; else addr_last->next = p;
6051 badp->local_part = badp->address; /* Needed for log line */
6052 post_process_one(badp, DEFER, LOG_MAIN|LOG_PANIC, EXIM_DTYPE_ROUTER, 0);
6055 } /* End of pfr handling */
6057 /* Either a non-pfr delivery, or we found a transport */
6059 DEBUG(D_deliver|D_filter)
6060 debug_printf("system filter added %s\n", p->address);
6064 } /* Loop through all addr_new addresses */
6069 /* Scan the recipients list, and for every one that is not in the non-
6070 recipients tree, add an addr item to the chain of new addresses. If the pno
6071 value is non-negative, we must set the onetime parent from it. This which
6072 points to the relevant entry in the recipients list.
6074 This processing can be altered by the setting of the process_recipients
6075 variable, which is changed if recipients are to be ignored, failed, or
6076 deferred. This can happen as a result of system filter activity, or if the -Mg
6077 option is used to fail all of them.
6079 Duplicate addresses are handled later by a different tree structure; we can't
6080 just extend the non-recipients tree, because that will be re-written to the
6081 spool if the message is deferred, and in any case there are casing
6082 complications for local addresses. */
6084 if (process_recipients != RECIP_IGNORE)
6085 for (i = 0; i < recipients_count; i++)
6086 if (!tree_search(tree_nonrecipients, recipients_list[i].address))
6088 recipient_item *r = recipients_list + i;
6089 address_item *new = deliver_make_addr(r->address, FALSE);
6090 new->prop.errors_address = r->errors_to;
6092 if ((new->prop.utf8_msg = message_smtputf8))
6094 new->prop.utf8_downcvt = message_utf8_downconvert == 1;
6095 new->prop.utf8_downcvt_maybe = message_utf8_downconvert == -1;
6096 DEBUG(D_deliver) debug_printf("utf8, downconvert %s\n",
6097 new->prop.utf8_downcvt ? "yes"
6098 : new->prop.utf8_downcvt_maybe ? "ifneeded"
6104 new->onetime_parent = recipients_list[r->pno].address;
6106 /* If DSN support is enabled, set the dsn flags and the original receipt
6107 to be passed on to other DSN enabled MTAs */
6108 new->dsn_flags = r->dsn_flags & rf_dsnflags;
6109 new->dsn_orcpt = r->orcpt;
6110 DEBUG(D_deliver) debug_printf("DSN: set orcpt: %s flags: %d\n",
6111 new->dsn_orcpt, new->dsn_flags);
6113 switch (process_recipients)
6115 /* RECIP_DEFER is set when a system filter freezes a message. */
6118 new->next = addr_defer;
6123 /* RECIP_FAIL_FILTER is set when a system filter has obeyed a "fail"
6126 case RECIP_FAIL_FILTER:
6128 filter_message ? filter_message : US"delivery cancelled";
6129 setflag(new, af_pass_message);
6130 goto RECIP_QUEUE_FAILED; /* below */
6133 /* RECIP_FAIL_TIMEOUT is set when a message is frozen, but is older
6134 than the value in timeout_frozen_after. Treat non-bounce messages
6135 similarly to -Mg; for bounce messages we just want to discard, so
6136 don't put the address on the failed list. The timeout has already
6139 case RECIP_FAIL_TIMEOUT:
6140 new->message = US"delivery cancelled; message timed out";
6141 goto RECIP_QUEUE_FAILED; /* below */
6144 /* RECIP_FAIL is set when -Mg has been used. */
6147 new->message = US"delivery cancelled by administrator";
6150 /* Common code for the failure cases above. If this is not a bounce
6151 message, put the address on the failed list so that it is used to
6152 create a bounce. Otherwise do nothing - this just discards the address.
6153 The incident has already been logged. */
6156 if (sender_address[0] != 0)
6158 new->next = addr_failed;
6164 /* RECIP_FAIL_LOOP is set when there are too many Received: headers
6165 in the message. Process each address as a routing failure; if this
6166 is a bounce message, it will get frozen. */
6168 case RECIP_FAIL_LOOP:
6169 new->message = US"Too many \"Received\" headers - suspected mail loop";
6170 post_process_one(new, FAIL, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
6174 /* Value should be RECIP_ACCEPT; take this as the safe default. */
6177 if (!addr_new) addr_new = new; else addr_last->next = new;
6182 #ifndef DISABLE_EVENT
6183 if (process_recipients != RECIP_ACCEPT)
6185 uschar * save_local = deliver_localpart;
6186 const uschar * save_domain = deliver_domain;
6188 deliver_localpart = expand_string(
6189 string_sprintf("${local_part:%s}", new->address));
6190 deliver_domain = expand_string(
6191 string_sprintf("${domain:%s}", new->address));
6193 (void) event_raise(event_action,
6194 US"msg:fail:internal", new->message);
6196 deliver_localpart = save_local;
6197 deliver_domain = save_domain;
6205 debug_printf("Delivery address list:\n");
6206 for (p = addr_new; p; p = p->next)
6207 debug_printf(" %s %s\n", p->address,
6208 p->onetime_parent ? p->onetime_parent : US"");
6211 /* Set up the buffers used for copying over the file when delivering. */
6213 deliver_in_buffer = store_malloc(DELIVER_IN_BUFFER_SIZE);
6214 deliver_out_buffer = store_malloc(DELIVER_OUT_BUFFER_SIZE);
6218 /* Until there are no more new addresses, handle each one as follows:
6220 . If this is a generated address (indicated by the presence of a parent
6221 pointer) then check to see whether it is a pipe, file, or autoreply, and
6222 if so, handle it directly here. The router that produced the address will
6223 have set the allow flags into the address, and also set the uid/gid required.
6224 Having the routers generate new addresses and then checking them here at
6225 the outer level is tidier than making each router do the checking, and
6226 means that routers don't need access to the failed address queue.
6228 . Break up the address into local part and domain, and make lowercased
6229 versions of these strings. We also make unquoted versions of the local part.
6231 . Handle the percent hack for those domains for which it is valid.
6233 . For child addresses, determine if any of the parents have the same address.
6234 If so, generate a different string for previous delivery checking. Without
6235 this code, if the address spqr generates spqr via a forward or alias file,
6236 delivery of the generated spqr stops further attempts at the top level spqr,
6237 which is not what is wanted - it may have generated other addresses.
6239 . Check on the retry database to see if routing was previously deferred, but
6240 only if in a queue run. Addresses that are to be routed are put on the
6241 addr_route chain. Addresses that are to be deferred are put on the
6242 addr_defer chain. We do all the checking first, so as not to keep the
6243 retry database open any longer than necessary.
6245 . Now we run the addresses through the routers. A router may put the address
6246 on either the addr_local or the addr_remote chain for local or remote
6247 delivery, respectively, or put it on the addr_failed chain if it is
6248 undeliveable, or it may generate child addresses and put them on the
6249 addr_new chain, or it may defer an address. All the chain anchors are
6250 passed as arguments so that the routers can be called for verification
6253 . If new addresses have been generated by the routers, da capo.
6256 header_rewritten = FALSE; /* No headers rewritten yet */
6257 while (addr_new) /* Loop until all addresses dealt with */
6259 address_item *addr, *parent;
6261 /* Failure to open the retry database is treated the same as if it does
6262 not exist. In both cases, dbm_file is NULL. */
6264 if (!(dbm_file = dbfn_open(US"retry", O_RDONLY, &dbblock, FALSE)))
6265 DEBUG(D_deliver|D_retry|D_route|D_hints_lookup)
6266 debug_printf("no retry data available\n");
6268 /* Scan the current batch of new addresses, to handle pipes, files and
6269 autoreplies, and determine which others are ready for routing. */
6276 dbdata_retry *domain_retry_record;
6277 dbdata_retry *address_retry_record;
6280 addr_new = addr->next;
6282 DEBUG(D_deliver|D_retry|D_route)
6284 debug_printf(">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>\n");
6285 debug_printf("Considering: %s\n", addr->address);
6288 /* Handle generated address that is a pipe or a file or an autoreply. */
6290 if (testflag(addr, af_pfr))
6292 /* If an autoreply in a filter could not generate a syntactically valid
6293 address, give up forthwith. Set af_ignore_error so that we don't try to
6294 generate a bounce. */
6296 if (testflag(addr, af_bad_reply))
6298 addr->basic_errno = ERRNO_BADADDRESS2;
6299 addr->local_part = addr->address;
6301 US"filter autoreply generated syntactically invalid recipient";
6302 addr->prop.ignore_error = TRUE;
6303 (void) post_process_one(addr, FAIL, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
6304 continue; /* with the next new address */
6307 /* If two different users specify delivery to the same pipe or file or
6308 autoreply, there should be two different deliveries, so build a unique
6309 string that incorporates the original address, and use this for
6310 duplicate testing and recording delivery, and also for retrying. */
6313 string_sprintf("%s:%s", addr->address, addr->parent->unique +
6314 (testflag(addr->parent, af_homonym)? 3:0));
6316 addr->address_retry_key = addr->domain_retry_key =
6317 string_sprintf("T:%s", addr->unique);
6319 /* If a filter file specifies two deliveries to the same pipe or file,
6320 we want to de-duplicate, but this is probably not wanted for two mail
6321 commands to the same address, where probably both should be delivered.
6322 So, we have to invent a different unique string in that case. Just
6323 keep piling '>' characters on the front. */
6325 if (addr->address[0] == '>')
6327 while (tree_search(tree_duplicates, addr->unique))
6328 addr->unique = string_sprintf(">%s", addr->unique);
6331 else if ((tnode = tree_search(tree_duplicates, addr->unique)))
6333 DEBUG(D_deliver|D_route)
6334 debug_printf("%s is a duplicate address: discarded\n", addr->address);
6335 addr->dupof = tnode->data.ptr;
6336 addr->next = addr_duplicate;
6337 addr_duplicate = addr;
6341 DEBUG(D_deliver|D_route) debug_printf("unique = %s\n", addr->unique);
6343 /* Check for previous delivery */
6345 if (tree_search(tree_nonrecipients, addr->unique))
6347 DEBUG(D_deliver|D_route)
6348 debug_printf("%s was previously delivered: discarded\n", addr->address);
6349 child_done(addr, tod_stamp(tod_log));
6353 /* Save for checking future duplicates */
6355 tree_add_duplicate(addr->unique, addr);
6357 /* Set local part and domain */
6359 addr->local_part = addr->address;
6360 addr->domain = addr->parent->domain;
6362 /* Ensure that the delivery is permitted. */
6364 if (testflag(addr, af_file))
6366 if (!testflag(addr, af_allow_file))
6368 addr->basic_errno = ERRNO_FORBIDFILE;
6369 addr->message = US"delivery to file forbidden";
6370 (void)post_process_one(addr, FAIL, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
6371 continue; /* with the next new address */
6374 else if (addr->address[0] == '|')
6376 if (!testflag(addr, af_allow_pipe))
6378 addr->basic_errno = ERRNO_FORBIDPIPE;
6379 addr->message = US"delivery to pipe forbidden";
6380 (void)post_process_one(addr, FAIL, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
6381 continue; /* with the next new address */
6384 else if (!testflag(addr, af_allow_reply))
6386 addr->basic_errno = ERRNO_FORBIDREPLY;
6387 addr->message = US"autoreply forbidden";
6388 (void)post_process_one(addr, FAIL, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
6389 continue; /* with the next new address */
6392 /* If the errno field is already set to BADTRANSPORT, it indicates
6393 failure to expand a transport string, or find the associated transport,
6394 or an unset transport when one is required. Leave this test till now so
6395 that the forbid errors are given in preference. */
6397 if (addr->basic_errno == ERRNO_BADTRANSPORT)
6399 (void)post_process_one(addr, DEFER, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
6403 /* Treat /dev/null as a special case and abandon the delivery. This
6404 avoids having to specify a uid on the transport just for this case.
6405 Arrange for the transport name to be logged as "**bypassed**". */
6407 if (Ustrcmp(addr->address, "/dev/null") == 0)
6409 uschar *save = addr->transport->name;
6410 addr->transport->name = US"**bypassed**";
6411 (void)post_process_one(addr, OK, LOG_MAIN, EXIM_DTYPE_TRANSPORT, '=');
6412 addr->transport->name = save;
6413 continue; /* with the next new address */
6416 /* Pipe, file, or autoreply delivery is to go ahead as a normal local
6419 DEBUG(D_deliver|D_route)
6420 debug_printf("queued for %s transport\n", addr->transport->name);
6421 addr->next = addr_local;
6423 continue; /* with the next new address */
6426 /* Handle normal addresses. First, split up into local part and domain,
6427 handling the %-hack if necessary. There is the possibility of a defer from
6428 a lookup in percent_hack_domains. */
6430 if ((rc = deliver_split_address(addr)) == DEFER)
6432 addr->message = US"cannot check percent_hack_domains";
6433 addr->basic_errno = ERRNO_LISTDEFER;
6434 (void)post_process_one(addr, DEFER, LOG_MAIN, EXIM_DTYPE_NONE, 0);
6438 /* Check to see if the domain is held. If so, proceed only if the
6439 delivery was forced by hand. */
6441 deliver_domain = addr->domain; /* set $domain */
6442 if ( !forced && hold_domains
6443 && (rc = match_isinlist(addr->domain, (const uschar **)&hold_domains, 0,
6444 &domainlist_anchor, addr->domain_cache, MCL_DOMAIN, TRUE,
6450 addr->message = US"hold_domains lookup deferred";
6451 addr->basic_errno = ERRNO_LISTDEFER;
6455 addr->message = US"domain is held";
6456 addr->basic_errno = ERRNO_HELD;
6458 (void)post_process_one(addr, DEFER, LOG_MAIN, EXIM_DTYPE_NONE, 0);
6462 /* Now we can check for duplicates and previously delivered addresses. In
6463 order to do this, we have to generate a "unique" value for each address,
6464 because there may be identical actual addresses in a line of descendents.
6465 The "unique" field is initialized to the same value as the "address" field,
6466 but gets changed here to cope with identically-named descendents. */
6468 for (parent = addr->parent; parent; parent = parent->parent)
6469 if (strcmpic(addr->address, parent->address) == 0) break;
6471 /* If there's an ancestor with the same name, set the homonym flag. This
6472 influences how deliveries are recorded. Then add a prefix on the front of
6473 the unique address. We use \n\ where n starts at 0 and increases each time.
6474 It is unlikely to pass 9, but if it does, it may look odd but will still
6475 work. This means that siblings or cousins with the same names are treated
6476 as duplicates, which is what we want. */
6480 setflag(addr, af_homonym);
6481 if (parent->unique[0] != '\\')
6482 addr->unique = string_sprintf("\\0\\%s", addr->address);
6484 addr->unique = string_sprintf("\\%c\\%s", parent->unique[1] + 1,
6488 /* Ensure that the domain in the unique field is lower cased, because
6489 domains are always handled caselessly. */
6491 p = Ustrrchr(addr->unique, '@');
6492 while (*p != 0) { *p = tolower(*p); p++; }
6494 DEBUG(D_deliver|D_route) debug_printf("unique = %s\n", addr->unique);
6496 if (tree_search(tree_nonrecipients, addr->unique))
6498 DEBUG(D_deliver|D_route)
6499 debug_printf("%s was previously delivered: discarded\n", addr->unique);
6500 child_done(addr, tod_stamp(tod_log));
6504 /* Get the routing retry status, saving the two retry keys (with and
6505 without the local part) for subsequent use. If there is no retry record for
6506 the standard address routing retry key, we look for the same key with the
6507 sender attached, because this form is used by the smtp transport after a
6508 4xx response to RCPT when address_retry_include_sender is true. */
6510 addr->domain_retry_key = string_sprintf("R:%s", addr->domain);
6511 addr->address_retry_key = string_sprintf("R:%s@%s", addr->local_part,
6516 domain_retry_record = dbfn_read(dbm_file, addr->domain_retry_key);
6517 if ( domain_retry_record
6518 && now - domain_retry_record->time_stamp > retry_data_expire
6520 domain_retry_record = NULL; /* Ignore if too old */
6522 address_retry_record = dbfn_read(dbm_file, addr->address_retry_key);
6523 if ( address_retry_record
6524 && now - address_retry_record->time_stamp > retry_data_expire
6526 address_retry_record = NULL; /* Ignore if too old */
6528 if (!address_retry_record)
6530 uschar *altkey = string_sprintf("%s:<%s>", addr->address_retry_key,
6532 address_retry_record = dbfn_read(dbm_file, altkey);
6533 if ( address_retry_record
6534 && now - address_retry_record->time_stamp > retry_data_expire)
6535 address_retry_record = NULL; /* Ignore if too old */
6539 domain_retry_record = address_retry_record = NULL;
6541 DEBUG(D_deliver|D_retry)
6543 if (!domain_retry_record)
6544 debug_printf("no domain retry record\n");
6545 if (!address_retry_record)
6546 debug_printf("no address retry record\n");
6549 /* If we are sending a message down an existing SMTP connection, we must
6550 assume that the message which created the connection managed to route
6551 an address to that connection. We do not want to run the risk of taking
6552 a long time over routing here, because if we do, the server at the other
6553 end of the connection may time it out. This is especially true for messages
6554 with lots of addresses. For this kind of delivery, queue_running is not
6555 set, so we would normally route all addresses. We take a pragmatic approach
6556 and defer routing any addresses that have any kind of domain retry record.
6557 That is, we don't even look at their retry times. It doesn't matter if this
6558 doesn't work occasionally. This is all just an optimization, after all.
6560 The reason for not doing the same for address retries is that they normally
6561 arise from 4xx responses, not DNS timeouts. */
6563 if (continue_hostname && domain_retry_record)
6565 addr->message = US"reusing SMTP connection skips previous routing defer";
6566 addr->basic_errno = ERRNO_RRETRY;
6567 (void)post_process_one(addr, DEFER, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
6570 /* If we are in a queue run, defer routing unless there is no retry data or
6571 we've passed the next retry time, or this message is forced. In other
6572 words, ignore retry data when not in a queue run.
6574 However, if the domain retry time has expired, always allow the routing
6575 attempt. If it fails again, the address will be failed. This ensures that
6576 each address is routed at least once, even after long-term routing
6579 If there is an address retry, check that too; just wait for the next
6580 retry time. This helps with the case when the temporary error on the
6581 address was really message-specific rather than address specific, since
6582 it allows other messages through.
6584 We also wait for the next retry time if this is a message sent down an
6585 existing SMTP connection (even though that will be forced). Otherwise there
6586 will be far too many attempts for an address that gets a 4xx error. In
6587 fact, after such an error, we should not get here because, the host should
6588 not be remembered as one this message needs. However, there was a bug that
6589 used to cause this to happen, so it is best to be on the safe side.
6591 Even if we haven't reached the retry time in the hints, there is one more
6592 check to do, which is for the ultimate address timeout. We only do this
6593 check if there is an address retry record and there is not a domain retry
6594 record; this implies that previous attempts to handle the address had the
6595 retry_use_local_parts option turned on. We use this as an approximation
6596 for the destination being like a local delivery, for example delivery over
6597 LMTP to an IMAP message store. In this situation users are liable to bump
6598 into their quota and thereby have intermittently successful deliveries,
6599 which keep the retry record fresh, which can lead to us perpetually
6600 deferring messages. */
6602 else if ( ( queue_running && !deliver_force
6603 || continue_hostname
6605 && ( ( domain_retry_record
6606 && now < domain_retry_record->next_try
6607 && !domain_retry_record->expired
6609 || ( address_retry_record
6610 && now < address_retry_record->next_try
6612 && ( domain_retry_record
6613 || !address_retry_record
6614 || !retry_ultimate_address_timeout(addr->address_retry_key,
6615 addr->domain, address_retry_record, now)
6618 addr->message = US"retry time not reached";
6619 addr->basic_errno = ERRNO_RRETRY;
6620 (void)post_process_one(addr, DEFER, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
6623 /* The domain is OK for routing. Remember if retry data exists so it
6624 can be cleaned up after a successful delivery. */
6628 if (domain_retry_record || address_retry_record)
6629 setflag(addr, af_dr_retry_exists);
6630 addr->next = addr_route;
6632 DEBUG(D_deliver|D_route)
6633 debug_printf("%s: queued for routing\n", addr->address);
6637 /* The database is closed while routing is actually happening. Requests to
6638 update it are put on a chain and all processed together at the end. */
6640 if (dbm_file) dbfn_close(dbm_file);
6642 /* If queue_domains is set, we don't even want to try routing addresses in
6643 those domains. During queue runs, queue_domains is forced to be unset.
6644 Optimize by skipping this pass through the addresses if nothing is set. */
6646 if (!deliver_force && queue_domains)
6648 address_item *okaddr = NULL;
6651 address_item *addr = addr_route;
6652 addr_route = addr->next;
6654 deliver_domain = addr->domain; /* set $domain */
6655 if ((rc = match_isinlist(addr->domain, (const uschar **)&queue_domains, 0,
6656 &domainlist_anchor, addr->domain_cache, MCL_DOMAIN, TRUE, NULL))
6660 addr->basic_errno = ERRNO_LISTDEFER;
6661 addr->message = US"queue_domains lookup deferred";
6662 (void)post_process_one(addr, DEFER, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
6666 addr->next = okaddr;
6671 addr->basic_errno = ERRNO_QUEUE_DOMAIN;
6672 addr->message = US"domain is in queue_domains";
6673 (void)post_process_one(addr, DEFER, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
6677 addr_route = okaddr;
6680 /* Now route those addresses that are not deferred. */
6685 address_item *addr = addr_route;
6686 const uschar *old_domain = addr->domain;
6687 uschar *old_unique = addr->unique;
6688 addr_route = addr->next;
6691 /* Just in case some router parameter refers to it. */
6693 if (!(return_path = addr->prop.errors_address))
6694 return_path = sender_address;
6696 /* If a router defers an address, add a retry item. Whether or not to
6697 use the local part in the key is a property of the router. */
6699 if ((rc = route_address(addr, &addr_local, &addr_remote, &addr_new,
6700 &addr_succeed, v_none)) == DEFER)
6701 retry_add_item(addr,
6702 addr->router->retry_use_local_part
6703 ? string_sprintf("R:%s@%s", addr->local_part, addr->domain)
6704 : string_sprintf("R:%s", addr->domain),
6707 /* Otherwise, if there is an existing retry record in the database, add
6708 retry items to delete both forms. We must also allow for the possibility
6709 of a routing retry that includes the sender address. Since the domain might
6710 have been rewritten (expanded to fully qualified) as a result of routing,
6711 ensure that the rewritten form is also deleted. */
6713 else if (testflag(addr, af_dr_retry_exists))
6715 uschar *altkey = string_sprintf("%s:<%s>", addr->address_retry_key,
6717 retry_add_item(addr, altkey, rf_delete);
6718 retry_add_item(addr, addr->address_retry_key, rf_delete);
6719 retry_add_item(addr, addr->domain_retry_key, rf_delete);
6720 if (Ustrcmp(addr->domain, old_domain) != 0)
6721 retry_add_item(addr, string_sprintf("R:%s", old_domain), rf_delete);
6724 /* DISCARD is given for :blackhole: and "seen finish". The event has been
6725 logged, but we need to ensure the address (and maybe parents) is marked
6730 address_done(addr, tod_stamp(tod_log));
6731 continue; /* route next address */
6734 /* The address is finished with (failed or deferred). */
6738 (void)post_process_one(addr, rc, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
6739 continue; /* route next address */
6742 /* The address has been routed. If the router changed the domain, it will
6743 also have changed the unique address. We have to test whether this address
6744 has already been delivered, because it's the unique address that finally
6747 if ( addr->unique != old_unique
6748 && tree_search(tree_nonrecipients, addr->unique) != 0
6751 DEBUG(D_deliver|D_route) debug_printf("%s was previously delivered: "
6752 "discarded\n", addr->address);
6753 if (addr_remote == addr) addr_remote = addr->next;
6754 else if (addr_local == addr) addr_local = addr->next;
6757 /* If the router has same_domain_copy_routing set, we are permitted to copy
6758 the routing for any other addresses with the same domain. This is an
6759 optimisation to save repeated DNS lookups for "standard" remote domain
6760 routing. The option is settable only on routers that generate host lists.
6761 We play it very safe, and do the optimization only if the address is routed
6762 to a remote transport, there are no header changes, and the domain was not
6763 modified by the router. */
6765 if ( addr_remote == addr
6766 && addr->router->same_domain_copy_routing
6767 && !addr->prop.extra_headers
6768 && !addr->prop.remove_headers
6769 && old_domain == addr->domain
6772 address_item **chain = &addr_route;
6775 address_item *addr2 = *chain;
6776 if (Ustrcmp(addr2->domain, addr->domain) != 0)
6778 chain = &(addr2->next);
6782 /* Found a suitable address; take it off the routing list and add it to
6783 the remote delivery list. */
6785 *chain = addr2->next;
6786 addr2->next = addr_remote;
6787 addr_remote = addr2;
6789 /* Copy the routing data */
6791 addr2->domain = addr->domain;
6792 addr2->router = addr->router;
6793 addr2->transport = addr->transport;
6794 addr2->host_list = addr->host_list;
6795 addr2->fallback_hosts = addr->fallback_hosts;
6796 addr2->prop.errors_address = addr->prop.errors_address;
6797 copyflag(addr2, addr, af_hide_child);
6798 copyflag(addr2, addr, af_local_host_removed);
6800 DEBUG(D_deliver|D_route)
6801 debug_printf(">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>\n"
6803 "Routing for %s copied from %s\n",
6804 addr2->address, addr2->address, addr->address);
6807 } /* Continue with routing the next address. */
6808 } /* Loop to process any child addresses that the routers created, and
6809 any rerouted addresses that got put back on the new chain. */
6812 /* Debugging: show the results of the routing */
6814 DEBUG(D_deliver|D_retry|D_route)
6817 debug_printf(">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>\n");
6818 debug_printf("After routing:\n Local deliveries:\n");
6819 for (p = addr_local; p; p = p->next)
6820 debug_printf(" %s\n", p->address);
6822 debug_printf(" Remote deliveries:\n");
6823 for (p = addr_remote; p; p = p->next)
6824 debug_printf(" %s\n", p->address);
6826 debug_printf(" Failed addresses:\n");
6827 for (p = addr_failed; p; p = p->next)
6828 debug_printf(" %s\n", p->address);
6830 debug_printf(" Deferred addresses:\n");
6831 for (p = addr_defer; p; p = p->next)
6832 debug_printf(" %s\n", p->address);
6835 /* Free any resources that were cached during routing. */
6840 /* These two variables are set only during routing, after check_local_user.
6841 Ensure they are not set in transports. */
6843 local_user_gid = (gid_t)(-1);
6844 local_user_uid = (uid_t)(-1);
6846 /* Check for any duplicate addresses. This check is delayed until after
6847 routing, because the flexibility of the routing configuration means that
6848 identical addresses with different parentage may end up being redirected to
6849 different addresses. Checking for duplicates too early (as we previously used
6850 to) makes this kind of thing not work. */
6852 do_duplicate_check(&addr_local);
6853 do_duplicate_check(&addr_remote);
6855 /* When acting as an MUA wrapper, we proceed only if all addresses route to a
6856 remote transport. The check that they all end up in one transaction happens in
6857 the do_remote_deliveries() function. */
6860 && (addr_local || addr_failed || addr_defer)
6864 uschar *which, *colon, *msg;
6871 else if (addr_defer)
6874 which = US"deferred";
6882 while (addr->parent) addr = addr->parent;
6887 msg = addr->message;
6889 else colon = msg = US"";
6891 /* We don't need to log here for a forced failure as it will already
6892 have been logged. Defer will also have been logged, but as a defer, so we do
6893 need to do the failure logging. */
6895 if (addr != addr_failed)
6896 log_write(0, LOG_MAIN, "** %s routing yielded a %s delivery",
6897 addr->address, which);
6899 /* Always write an error to the caller */
6901 fprintf(stderr, "routing %s yielded a %s delivery%s%s\n", addr->address,
6904 final_yield = DELIVER_MUA_FAILED;
6905 addr_failed = addr_defer = NULL; /* So that we remove the message */
6906 goto DELIVERY_TIDYUP;
6910 /* If this is a run to continue deliveries to an external channel that is
6911 already set up, defer any local deliveries. */
6913 if (continue_transport)
6917 address_item *addr = addr_defer;
6918 while (addr->next) addr = addr->next;
6919 addr->next = addr_local;
6922 addr_defer = addr_local;
6927 /* Because address rewriting can happen in the routers, we should not really do
6928 ANY deliveries until all addresses have been routed, so that all recipients of
6929 the message get the same headers. However, this is in practice not always
6930 possible, since sometimes remote addresses give DNS timeouts for days on end.
6931 The pragmatic approach is to deliver what we can now, saving any rewritten
6932 headers so that at least the next lot of recipients benefit from the rewriting
6933 that has already been done.
6935 If any headers have been rewritten during routing, update the spool file to
6936 remember them for all subsequent deliveries. This can be delayed till later if
6937 there is only address to be delivered - if it succeeds the spool write need not
6940 if ( header_rewritten
6941 && ( addr_local && (addr_local->next || addr_remote)
6942 || addr_remote && addr_remote->next
6945 /* Panic-dies on error */
6946 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
6947 header_rewritten = FALSE;
6951 /* If there are any deliveries to be and we do not already have the journal
6952 file, create it. This is used to record successful deliveries as soon as
6953 possible after each delivery is known to be complete. A file opened with
6954 O_APPEND is used so that several processes can run simultaneously.
6956 The journal is just insurance against crashes. When the spool file is
6957 ultimately updated at the end of processing, the journal is deleted. If a
6958 journal is found to exist at the start of delivery, the addresses listed
6959 therein are added to the non-recipients. */
6961 if (addr_local || addr_remote)
6965 uschar * fname = spool_fname(US"input", message_subdir, id, US"-J");
6967 if ((journal_fd = Uopen(fname,
6971 O_WRONLY|O_APPEND|O_CREAT|O_EXCL, SPOOL_MODE)) < 0)
6973 log_write(0, LOG_MAIN|LOG_PANIC, "Couldn't open journal file %s: %s",
6974 fname, strerror(errno));
6975 return DELIVER_NOT_ATTEMPTED;
6978 /* Set the close-on-exec flag, make the file owned by Exim, and ensure
6979 that the mode is correct - the group setting doesn't always seem to get
6980 set automatically. */
6982 if( fchown(journal_fd, exim_uid, exim_gid)
6983 || fchmod(journal_fd, SPOOL_MODE)
6985 || fcntl(journal_fd, F_SETFD, fcntl(journal_fd, F_GETFD) | FD_CLOEXEC)
6989 int ret = Uunlink(fname);
6990 log_write(0, LOG_MAIN|LOG_PANIC, "Couldn't set perms on journal file %s: %s",
6991 fname, strerror(errno));
6992 if(ret && errno != ENOENT)
6993 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s",
6994 fname, strerror(errno));
6995 return DELIVER_NOT_ATTEMPTED;
6999 else if (journal_fd >= 0)
7007 /* Now we can get down to the business of actually doing deliveries. Local
7008 deliveries are done first, then remote ones. If ever the problems of how to
7009 handle fallback transports are figured out, this section can be put into a loop
7010 for handling fallbacks, though the uid switching will have to be revised. */
7012 /* Precompile a regex that is used to recognize a parameter in response
7013 to an LHLO command, if is isn't already compiled. This may be used on both
7014 local and remote LMTP deliveries. */
7016 if (!regex_IGNOREQUOTA)
7018 regex_must_compile(US"\\n250[\\s\\-]IGNOREQUOTA(\\s|\\n|$)", FALSE, TRUE);
7020 /* Handle local deliveries */
7024 DEBUG(D_deliver|D_transport)
7025 debug_printf(">>>>>>>>>>>>>>>> Local deliveries >>>>>>>>>>>>>>>>\n");
7026 do_local_deliveries();
7027 disable_logging = FALSE;
7030 /* If queue_run_local is set, we do not want to attempt any remote deliveries,
7031 so just queue them all. */
7033 if (queue_run_local)
7036 address_item *addr = addr_remote;
7037 addr_remote = addr->next;
7039 addr->basic_errno = ERRNO_LOCAL_ONLY;
7040 addr->message = US"remote deliveries suppressed";
7041 (void)post_process_one(addr, DEFER, LOG_MAIN, EXIM_DTYPE_TRANSPORT, 0);
7044 /* Handle remote deliveries */
7048 DEBUG(D_deliver|D_transport)
7049 debug_printf(">>>>>>>>>>>>>>>> Remote deliveries >>>>>>>>>>>>>>>>\n");
7051 /* Precompile some regex that are used to recognize parameters in response
7052 to an EHLO command, if they aren't already compiled. */
7056 /* Now sort the addresses if required, and do the deliveries. The yield of
7057 do_remote_deliveries is FALSE when mua_wrapper is set and all addresses
7058 cannot be delivered in one transaction. */
7060 if (remote_sort_domains) sort_remote_deliveries();
7061 if (!do_remote_deliveries(FALSE))
7063 log_write(0, LOG_MAIN, "** mua_wrapper is set but recipients cannot all "
7064 "be delivered in one transaction");
7065 fprintf(stderr, "delivery to smarthost failed (configuration problem)\n");
7067 final_yield = DELIVER_MUA_FAILED;
7068 addr_failed = addr_defer = NULL; /* So that we remove the message */
7069 goto DELIVERY_TIDYUP;
7072 /* See if any of the addresses that failed got put on the queue for delivery
7073 to their fallback hosts. We do it this way because often the same fallback
7074 host is used for many domains, so all can be sent in a single transaction
7075 (if appropriately configured). */
7077 if (addr_fallback && !mua_wrapper)
7079 DEBUG(D_deliver) debug_printf("Delivering to fallback hosts\n");
7080 addr_remote = addr_fallback;
7081 addr_fallback = NULL;
7082 if (remote_sort_domains) sort_remote_deliveries();
7083 do_remote_deliveries(TRUE);
7085 disable_logging = FALSE;
7089 /* All deliveries are now complete. Ignore SIGTERM during this tidying up
7090 phase, to minimize cases of half-done things. */
7093 debug_printf(">>>>>>>>>>>>>>>> deliveries are done >>>>>>>>>>>>>>>>\n");
7094 cancel_cutthrough_connection(TRUE, US"deliveries are done");
7096 /* Root privilege is no longer needed */
7098 exim_setugid(exim_uid, exim_gid, FALSE, US"post-delivery tidying");
7100 set_process_info("tidying up after delivering %s", message_id);
7101 signal(SIGTERM, SIG_IGN);
7103 /* When we are acting as an MUA wrapper, the smtp transport will either have
7104 succeeded for all addresses, or failed them all in normal cases. However, there
7105 are some setup situations (e.g. when a named port does not exist) that cause an
7106 immediate exit with deferral of all addresses. Convert those into failures. We
7107 do not ever want to retry, nor do we want to send a bounce message. */
7113 address_item *addr, *nextaddr;
7114 for (addr = addr_defer; addr; addr = nextaddr)
7116 log_write(0, LOG_MAIN, "** %s mua_wrapper forced failure for deferred "
7117 "delivery", addr->address);
7118 nextaddr = addr->next;
7119 addr->next = addr_failed;
7125 /* Now all should either have succeeded or failed. */
7128 final_yield = DELIVER_MUA_SUCCEEDED;
7132 uschar *s = addr_failed->user_message;
7134 if (!s) s = addr_failed->message;
7136 fprintf(stderr, "Delivery failed: ");
7137 if (addr_failed->basic_errno > 0)
7139 fprintf(stderr, "%s", strerror(addr_failed->basic_errno));
7140 if (s) fprintf(stderr, ": ");
7142 if ((host = addr_failed->host_used))
7143 fprintf(stderr, "H=%s [%s]: ", host->name, host->address);
7145 fprintf(stderr, "%s", CS s);
7146 else if (addr_failed->basic_errno <= 0)
7147 fprintf(stderr, "unknown error");
7148 fprintf(stderr, "\n");
7150 final_yield = DELIVER_MUA_FAILED;
7155 /* In a normal configuration, we now update the retry database. This is done in
7156 one fell swoop at the end in order not to keep opening and closing (and
7157 locking) the database. The code for handling retries is hived off into a
7158 separate module for convenience. We pass it the addresses of the various
7159 chains, because deferred addresses can get moved onto the failed chain if the
7160 retry cutoff time has expired for all alternative destinations. Bypass the
7161 updating of the database if the -N flag is set, which is a debugging thing that
7162 prevents actual delivery. */
7164 else if (!dont_deliver)
7165 retry_update(&addr_defer, &addr_failed, &addr_succeed);
7167 /* Send DSN for successful messages if requested */
7168 addr_senddsn = NULL;
7170 for (addr_dsntmp = addr_succeed; addr_dsntmp; addr_dsntmp = addr_dsntmp->next)
7172 /* af_ignore_error not honored here. it's not an error */
7173 DEBUG(D_deliver) debug_printf("DSN: processing router : %s\n"
7174 "DSN: processing successful delivery address: %s\n"
7175 "DSN: Sender_address: %s\n"
7176 "DSN: orcpt: %s flags: %d\n"
7177 "DSN: envid: %s ret: %d\n"
7178 "DSN: Final recipient: %s\n"
7179 "DSN: Remote SMTP server supports DSN: %d\n",
7180 addr_dsntmp->router->name,
7181 addr_dsntmp->address,
7183 addr_dsntmp->dsn_orcpt, addr_dsntmp->dsn_flags,
7185 addr_dsntmp->address,
7186 addr_dsntmp->dsn_aware
7189 /* send report if next hop not DSN aware or a router flagged "last DSN hop"
7190 and a report was requested */
7191 if ( ( addr_dsntmp->dsn_aware != dsn_support_yes
7192 || addr_dsntmp->dsn_flags & rf_dsnlasthop
7194 && addr_dsntmp->dsn_flags & rf_dsnflags
7195 && addr_dsntmp->dsn_flags & rf_notify_success
7198 /* copy and relink address_item and send report with all of them at once later */
7199 address_item * addr_next = addr_senddsn;
7200 addr_senddsn = store_get(sizeof(address_item));
7201 *addr_senddsn = *addr_dsntmp;
7202 addr_senddsn->next = addr_next;
7205 DEBUG(D_deliver) debug_printf("DSN: not sending DSN success message\n");
7213 /* create exim process to send message */
7214 pid = child_open_exim(&fd);
7216 DEBUG(D_deliver) debug_printf("DSN: child_open_exim returns: %d\n", pid);
7218 if (pid < 0) /* Creation of child failed */
7220 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Process %d (parent %d) failed to "
7221 "create child process to send failure message: %s", getpid(),
7222 getppid(), strerror(errno));
7224 DEBUG(D_deliver) debug_printf("DSN: child_open_exim failed\n");
7226 else /* Creation of child succeeded */
7228 FILE *f = fdopen(fd, "wb");
7229 /* header only as required by RFC. only failure DSN needs to honor RET=FULL */
7231 transport_ctx tctx = {{0}};
7234 debug_printf("sending error message to: %s\n", sender_address);
7236 /* build unique id for MIME boundary */
7237 bound = string_sprintf(TIME_T_FMT "-eximdsn-%d", time(NULL), rand());
7238 DEBUG(D_deliver) debug_printf("DSN: MIME boundary: %s\n", bound);
7240 if (errors_reply_to)
7241 fprintf(f, "Reply-To: %s\n", errors_reply_to);
7243 fprintf(f, "Auto-Submitted: auto-generated\n"
7244 "From: Mail Delivery System <Mailer-Daemon@%s>\n"
7246 "Subject: Delivery Status Notification\n"
7247 "Content-Type: multipart/report; report-type=delivery-status; boundary=%s\n"
7248 "MIME-Version: 1.0\n\n"
7251 "Content-type: text/plain; charset=us-ascii\n\n"
7253 "This message was created automatically by mail delivery software.\n"
7254 " ----- The following addresses had successful delivery notifications -----\n",
7255 qualify_domain_sender, sender_address, bound, bound);
7257 for (addr_dsntmp = addr_senddsn; addr_dsntmp;
7258 addr_dsntmp = addr_dsntmp->next)
7259 fprintf(f, "<%s> (relayed %s)\n\n",
7260 addr_dsntmp->address,
7261 (addr_dsntmp->dsn_flags & rf_dsnlasthop) == 1
7262 ? "via non DSN router"
7263 : addr_dsntmp->dsn_aware == dsn_support_no
7264 ? "to non-DSN-aware mailer"
7265 : "via non \"Remote SMTP\" router"
7269 "Content-type: message/delivery-status\n\n"
7270 "Reporting-MTA: dns; %s\n",
7271 bound, smtp_active_hostname);
7274 { /* must be decoded from xtext: see RFC 3461:6.3a */
7276 if (auth_xtextdecode(dsn_envid, &xdec_envid) > 0)
7277 fprintf(f, "Original-Envelope-ID: %s\n", dsn_envid);
7279 fprintf(f, "X-Original-Envelope-ID: error decoding xtext formatted ENVID\n");
7283 for (addr_dsntmp = addr_senddsn;
7285 addr_dsntmp = addr_dsntmp->next)
7287 if (addr_dsntmp->dsn_orcpt)
7288 fprintf(f,"Original-Recipient: %s\n", addr_dsntmp->dsn_orcpt);
7290 fprintf(f, "Action: delivered\n"
7291 "Final-Recipient: rfc822;%s\n"
7293 addr_dsntmp->address);
7295 if (addr_dsntmp->host_used && addr_dsntmp->host_used->name)
7296 fprintf(f, "Remote-MTA: dns; %s\nDiagnostic-Code: smtp; 250 Ok\n\n",
7297 addr_dsntmp->host_used->name);
7299 fprintf(f, "Diagnostic-Code: X-Exim; relayed via non %s router\n\n",
7300 (addr_dsntmp->dsn_flags & rf_dsnlasthop) == 1 ? "DSN" : "SMTP");
7303 fprintf(f, "--%s\nContent-type: text/rfc822-headers\n\n", bound);
7306 transport_filter_argv = NULL; /* Just in case */
7307 return_path = sender_address; /* In case not previously set */
7309 /* Write the original email out */
7311 tctx.u.fd = fileno(f);
7312 tctx.options = topt_add_return_path | topt_no_body;
7313 transport_write_message(&tctx, 0);
7316 fprintf(f,"\n--%s--\n", bound);
7320 rc = child_close(pid, 0); /* Waits for child to close, no timeout */
7324 /* If any addresses failed, we must send a message to somebody, unless
7325 af_ignore_error is set, in which case no action is taken. It is possible for
7326 several messages to get sent if there are addresses with different
7333 uschar *logtod = tod_stamp(tod_log);
7335 address_item *handled_addr = NULL;
7336 address_item **paddr;
7337 address_item *msgchain = NULL;
7338 address_item **pmsgchain = &msgchain;
7340 /* There are weird cases when logging is disabled in the transport. However,
7341 there may not be a transport (address failed by a router). */
7343 disable_logging = FALSE;
7344 if (addr_failed->transport)
7345 disable_logging = addr_failed->transport->disable_logging;
7348 debug_printf("processing failed address %s\n", addr_failed->address);
7350 /* There are only two ways an address in a bounce message can get here:
7352 (1) When delivery was initially deferred, but has now timed out (in the call
7353 to retry_update() above). We can detect this by testing for
7354 af_retry_timedout. If the address does not have its own errors address,
7355 we arrange to ignore the error.
7357 (2) If delivery failures for bounce messages are being ignored. We can detect
7358 this by testing for af_ignore_error. This will also be set if a bounce
7359 message has been autothawed and the ignore_bounce_errors_after time has
7360 passed. It might also be set if a router was explicitly configured to
7361 ignore errors (errors_to = "").
7363 If neither of these cases obtains, something has gone wrong. Log the
7364 incident, but then ignore the error. */
7366 if (sender_address[0] == 0 && !addr_failed->prop.errors_address)
7368 if ( !testflag(addr_failed, af_retry_timedout)
7369 && !addr_failed->prop.ignore_error)
7370 log_write(0, LOG_MAIN|LOG_PANIC, "internal error: bounce message "
7371 "failure is neither frozen nor ignored (it's been ignored)");
7373 addr_failed->prop.ignore_error = TRUE;
7376 /* If the first address on the list has af_ignore_error set, just remove
7377 it from the list, throw away any saved message file, log it, and
7378 mark the recipient done. */
7380 if ( addr_failed->prop.ignore_error
7381 || ( addr_failed->dsn_flags & rf_dsnflags
7382 && (addr_failed->dsn_flags & rf_notify_failure) != rf_notify_failure
7386 addr_failed = addr->next;
7387 if (addr->return_filename) Uunlink(addr->return_filename);
7389 log_write(0, LOG_MAIN, "%s%s%s%s: error ignored",
7391 !addr->parent ? US"" : US" <",
7392 !addr->parent ? US"" : addr->parent->address,
7393 !addr->parent ? US"" : US">");
7395 address_done(addr, logtod);
7396 child_done(addr, logtod);
7397 /* Panic-dies on error */
7398 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
7401 /* Otherwise, handle the sending of a message. Find the error address for
7402 the first address, then send a message that includes all failed addresses
7403 that have the same error address. Note the bounce_recipient is a global so
7404 that it can be accessed by $bounce_recipient while creating a customized
7409 if (!(bounce_recipient = addr_failed->prop.errors_address))
7410 bounce_recipient = sender_address;
7412 /* Make a subprocess to send a message */
7414 if ((pid = child_open_exim(&fd)) < 0)
7415 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Process %d (parent %d) failed to "
7416 "create child process to send failure message: %s", getpid(),
7417 getppid(), strerror(errno));
7419 /* Creation of child succeeded */
7426 uschar *bcc, *emf_text;
7427 FILE *f = fdopen(fd, "wb");
7429 BOOL to_sender = strcmpic(sender_address, bounce_recipient) == 0;
7430 int max = (bounce_return_size_limit/DELIVER_IN_BUFFER_SIZE + 1) *
7431 DELIVER_IN_BUFFER_SIZE;
7433 uschar *dsnlimitmsg;
7434 uschar *dsnnotifyhdr;
7438 debug_printf("sending error message to: %s\n", bounce_recipient);
7440 /* Scan the addresses for all that have the same errors address, removing
7441 them from the addr_failed chain, and putting them on msgchain. */
7443 paddr = &addr_failed;
7444 for (addr = addr_failed; addr; addr = *paddr)
7445 if (Ustrcmp(bounce_recipient, addr->prop.errors_address
7446 ? addr->prop.errors_address : sender_address) == 0)
7447 { /* The same - dechain */
7448 *paddr = addr->next;
7451 pmsgchain = &(addr->next);
7454 paddr = &addr->next; /* Not the same; skip */
7456 /* Include X-Failed-Recipients: for automatic interpretation, but do
7457 not let any one header line get too long. We do this by starting a
7458 new header every 50 recipients. Omit any addresses for which the
7459 "hide_child" flag is set. */
7461 for (addr = msgchain; addr; addr = addr->next)
7463 if (testflag(addr, af_hide_child)) continue;
7471 ? "X-Failed-Recipients: "
7473 testflag(addr, af_pfr) && addr->parent
7474 ? string_printing(addr->parent->address)
7475 : string_printing(addr->address));
7477 if (rcount > 0) fprintf(f, "\n");
7479 /* Output the standard headers */
7481 if (errors_reply_to)
7482 fprintf(f, "Reply-To: %s\n", errors_reply_to);
7483 fprintf(f, "Auto-Submitted: auto-replied\n");
7485 fprintf(f, "To: %s\n", bounce_recipient);
7487 /* generate boundary string and output MIME-Headers */
7488 bound = string_sprintf(TIME_T_FMT "-eximdsn-%d", time(NULL), rand());
7490 fprintf(f, "Content-Type: multipart/report;"
7491 " report-type=delivery-status; boundary=%s\n"
7492 "MIME-Version: 1.0\n",
7495 /* Open a template file if one is provided. Log failure to open, but
7496 carry on - default texts will be used. */
7498 if (bounce_message_file)
7499 if (!(emf = Ufopen(bounce_message_file, "rb")))
7500 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to open %s for error "
7501 "message texts: %s", bounce_message_file, strerror(errno));
7503 /* Quietly copy to configured additional addresses if required. */
7505 if ((bcc = moan_check_errorcopy(bounce_recipient)))
7506 fprintf(f, "Bcc: %s\n", bcc);
7508 /* The texts for the message can be read from a template file; if there
7509 isn't one, or if it is too short, built-in texts are used. The first
7510 emf text is a Subject: and any other headers. */
7512 if ((emf_text = next_emf(emf, US"header")))
7513 fprintf(f, "%s\n", emf_text);
7515 fprintf(f, "Subject: Mail delivery failed%s\n\n",
7516 to_sender? ": returning message to sender" : "");
7518 /* output human readable part as text/plain section */
7520 "Content-type: text/plain; charset=us-ascii\n\n",
7523 if ((emf_text = next_emf(emf, US"intro")))
7524 fprintf(f, "%s", CS emf_text);
7528 /* This message has been reworded several times. It seems to be confusing to
7529 somebody, however it is worded. I have retreated to the original, simple
7531 "This message was created automatically by mail delivery software.\n");
7533 if (bounce_message_text)
7534 fprintf(f, "%s", CS bounce_message_text);
7537 "\nA message that you sent could not be delivered to one or more of its\n"
7538 "recipients. This is a permanent error. The following address(es) failed:\n");
7541 "\nA message sent by\n\n <%s>\n\n"
7542 "could not be delivered to one or more of its recipients. The following\n"
7543 "address(es) failed:\n", sender_address);
7547 /* Process the addresses, leaving them on the msgchain if they have a
7548 file name for a return message. (There has already been a check in
7549 post_process_one() for the existence of data in the message file.) A TRUE
7550 return from print_address_information() means that the address is not
7554 for (addr = msgchain; addr; addr = *paddr)
7556 if (print_address_information(addr, f, US" ", US"\n ", US""))
7557 print_address_error(addr, f, US"");
7559 /* End the final line for the address */
7563 /* Leave on msgchain if there's a return file. */
7565 if (addr->return_file >= 0)
7567 paddr = &(addr->next);
7571 /* Else save so that we can tick off the recipient when the
7576 *paddr = addr->next;
7577 addr->next = handled_addr;
7578 handled_addr = addr;
7584 /* Get the next text, whether we need it or not, so as to be
7585 positioned for the one after. */
7587 emf_text = next_emf(emf, US"generated text");
7589 /* If there were any file messages passed by the local transports,
7590 include them in the message. Then put the address on the handled chain.
7591 In the case of a batch of addresses that were all sent to the same
7592 transport, the return_file field in all of them will contain the same
7593 fd, and the return_filename field in the *last* one will be set (to the
7594 name of the file). */
7598 address_item *nextaddr;
7601 fprintf(f, "%s", CS emf_text);
7604 "The following text was generated during the delivery "
7605 "attempt%s:\n", (filecount > 1)? "s" : "");
7607 for (addr = msgchain; addr; addr = nextaddr)
7610 address_item *topaddr = addr;
7612 /* List all the addresses that relate to this file */
7615 while(addr) /* Insurance */
7617 print_address_information(addr, f, US"------ ", US"\n ",
7619 if (addr->return_filename) break;
7624 /* Now copy the file */
7626 if (!(fm = Ufopen(addr->return_filename, "rb")))
7627 fprintf(f, " +++ Exim error... failed to open text file: %s\n",
7631 while ((ch = fgetc(fm)) != EOF) fputc(ch, f);
7634 Uunlink(addr->return_filename);
7636 /* Can now add to handled chain, first fishing off the next
7637 address on the msgchain. */
7639 nextaddr = addr->next;
7640 addr->next = handled_addr;
7641 handled_addr = topaddr;
7646 /* output machine readable part */
7648 if (message_smtputf8)
7650 "Content-type: message/global-delivery-status\n\n"
7651 "Reporting-MTA: dns; %s\n",
7652 bound, smtp_active_hostname);
7656 "Content-type: message/delivery-status\n\n"
7657 "Reporting-MTA: dns; %s\n",
7658 bound, smtp_active_hostname);
7662 /* must be decoded from xtext: see RFC 3461:6.3a */
7664 if (auth_xtextdecode(dsn_envid, &xdec_envid) > 0)
7665 fprintf(f, "Original-Envelope-ID: %s\n", dsn_envid);
7667 fprintf(f, "X-Original-Envelope-ID: error decoding xtext formatted ENVID\n");
7671 for (addr = handled_addr; addr; addr = addr->next)
7674 fprintf(f, "Action: failed\n"
7675 "Final-Recipient: rfc822;%s\n"
7678 if ((hu = addr->host_used) && hu->name)
7681 fprintf(f, "Remote-MTA: dns; %s\n", hu->name);
7682 #ifdef EXPERIMENTAL_DSN_INFO
7685 uschar * p = hu->port == 25
7686 ? US"" : string_sprintf(":%d", hu->port);
7687 fprintf(f, "Remote-MTA: X-ip; [%s]%s\n", hu->address, p);
7689 if ((s = addr->smtp_greeting) && *s)
7690 fprintf(f, "X-Remote-MTA-smtp-greeting: X-str; %s\n", s);
7691 if ((s = addr->helo_response) && *s)
7692 fprintf(f, "X-Remote-MTA-helo-response: X-str; %s\n", s);
7693 if ((s = addr->message) && *s)
7694 fprintf(f, "X-Exim-Diagnostic: X-str; %s\n", s);
7696 print_dsn_diagnostic_code(addr, f);
7701 /* Now copy the message, trying to give an intelligible comment if
7702 it is too long for it all to be copied. The limit isn't strictly
7703 applied because of the buffering. There is, however, an option
7704 to suppress copying altogether. */
7706 emf_text = next_emf(emf, US"copy");
7709 we ignore the intro text from template and add
7710 the text for bounce_return_size_limit at the end.
7712 bounce_return_message is ignored
7713 in case RET= is defined we honor these values
7714 otherwise bounce_return_body is honored.
7716 bounce_return_size_limit is always honored.
7719 fprintf(f, "--%s\n", bound);
7721 dsnlimitmsg = US"X-Exim-DSN-Information: Due to administrative limits only headers are returned";
7722 dsnnotifyhdr = NULL;
7723 topt = topt_add_return_path;
7725 /* RET=HDRS? top priority */
7726 if (dsn_ret == dsn_ret_hdrs)
7727 topt |= topt_no_body;
7730 struct stat statbuf;
7732 /* no full body return at all? */
7733 if (!bounce_return_body)
7735 topt |= topt_no_body;
7736 /* add header if we overrule RET=FULL */
7737 if (dsn_ret == dsn_ret_full)
7738 dsnnotifyhdr = dsnlimitmsg;
7740 /* line length limited... return headers only if oversize */
7741 /* size limited ... return headers only if limit reached */
7742 else if ( max_received_linelength > bounce_return_linesize_limit
7743 || ( bounce_return_size_limit > 0
7744 && fstat(deliver_datafile, &statbuf) == 0
7745 && statbuf.st_size > max
7748 topt |= topt_no_body;
7749 dsnnotifyhdr = dsnlimitmsg;
7754 if (message_smtputf8)
7755 fputs(topt & topt_no_body ? "Content-type: message/global-headers\n\n"
7756 : "Content-type: message/global\n\n",
7760 fputs(topt & topt_no_body ? "Content-type: text/rfc822-headers\n\n"
7761 : "Content-type: message/rfc822\n\n",
7765 transport_filter_argv = NULL; /* Just in case */
7766 return_path = sender_address; /* In case not previously set */
7767 { /* Dummy transport for headers add */
7768 transport_ctx tctx = {{0}};
7769 transport_instance tb = {0};
7771 tctx.u.fd = fileno(f);
7773 tctx.options = topt;
7774 tb.add_headers = dsnnotifyhdr;
7776 transport_write_message(&tctx, 0);
7780 /* we never add the final text. close the file */
7784 fprintf(f, "\n--%s--\n", bound);
7786 /* Close the file, which should send an EOF to the child process
7787 that is receiving the message. Wait for it to finish. */
7790 rc = child_close(pid, 0); /* Waits for child to close, no timeout */
7792 /* In the test harness, let the child do it's thing first. */
7794 if (running_in_test_harness) millisleep(500);
7796 /* If the process failed, there was some disaster in setting up the
7797 error message. Unless the message is very old, ensure that addr_defer
7798 is non-null, which will have the effect of leaving the message on the
7799 spool. The failed addresses will get tried again next time. However, we
7800 don't really want this to happen too often, so freeze the message unless
7801 there are some genuine deferred addresses to try. To do this we have
7802 to call spool_write_header() here, because with no genuine deferred
7803 addresses the normal code below doesn't get run. */
7808 if (now - received_time.tv_sec < retry_maximum_timeout && !addr_defer)
7810 addr_defer = (address_item *)(+1);
7811 deliver_freeze = TRUE;
7812 deliver_frozen_at = time(NULL);
7813 /* Panic-dies on error */
7814 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
7817 deliver_msglog("Process failed (%d) when writing error message "
7818 "to %s%s", rc, bounce_recipient, s);
7819 log_write(0, LOG_MAIN, "Process failed (%d) when writing error message "
7820 "to %s%s", rc, bounce_recipient, s);
7823 /* The message succeeded. Ensure that the recipients that failed are
7824 now marked finished with on the spool and their parents updated. */
7828 for (addr = handled_addr; addr; addr = addr->next)
7830 address_done(addr, logtod);
7831 child_done(addr, logtod);
7833 /* Panic-dies on error */
7834 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
7840 disable_logging = FALSE; /* In case left set */
7842 /* Come here from the mua_wrapper case if routing goes wrong */
7846 /* If there are now no deferred addresses, we are done. Preserve the
7847 message log if so configured, and we are using them. Otherwise, sling it.
7848 Then delete the message itself. */
7856 fname = spool_fname(US"msglog", message_subdir, id, US"");
7857 if (preserve_message_logs)
7860 uschar * moname = spool_fname(US"msglog.OLD", US"", id, US"");
7862 if ((rc = Urename(fname, moname)) < 0)
7864 (void)directory_make(spool_directory,
7865 spool_sname(US"msglog.OLD", US""),
7866 MSGLOG_DIRECTORY_MODE, TRUE);
7867 rc = Urename(fname, moname);
7870 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to move %s to the "
7871 "msglog.OLD directory", fname);
7874 if (Uunlink(fname) < 0)
7875 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s",
7876 fname, strerror(errno));
7879 /* Remove the two message files. */
7881 fname = spool_fname(US"input", message_subdir, id, US"-D");
7882 if (Uunlink(fname) < 0)
7883 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s",
7884 fname, strerror(errno));
7885 fname = spool_fname(US"input", message_subdir, id, US"-H");
7886 if (Uunlink(fname) < 0)
7887 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s",
7888 fname, strerror(errno));
7890 /* Log the end of this message, with queue time if requested. */
7892 if (LOGGING(queue_time_overall))
7893 log_write(0, LOG_MAIN, "Completed QT=%s",
7894 string_timesince(&received_time));
7896 log_write(0, LOG_MAIN, "Completed");
7898 /* Unset deliver_freeze so that we won't try to move the spool files further down */
7899 deliver_freeze = FALSE;
7901 #ifndef DISABLE_EVENT
7902 (void) event_raise(event_action, US"msg:complete", NULL);
7906 /* If there are deferred addresses, we are keeping this message because it is
7907 not yet completed. Lose any temporary files that were catching output from
7908 pipes for any of the deferred addresses, handle one-time aliases, and see if
7909 the message has been on the queue for so long that it is time to send a warning
7910 message to the sender, unless it is a mailer-daemon. If all deferred addresses
7911 have the same domain, we can set deliver_domain for the expansion of
7912 delay_warning_ condition - if any of them are pipes, files, or autoreplies, use
7913 the parent's domain.
7915 If all the deferred addresses have an error number that indicates "retry time
7916 not reached", skip sending the warning message, because it won't contain the
7917 reason for the delay. It will get sent at the next real delivery attempt.
7918 However, if at least one address has tried, we'd better include all of them in
7921 If we can't make a process to send the message, don't worry.
7923 For mailing list expansions we want to send the warning message to the
7924 mailing list manager. We can't do a perfect job here, as some addresses may
7925 have different errors addresses, but if we take the errors address from
7926 each deferred address it will probably be right in most cases.
7928 If addr_defer == +1, it means there was a problem sending an error message
7929 for failed addresses, and there were no "real" deferred addresses. The value
7930 was set just to keep the message on the spool, so there is nothing to do here.
7933 else if (addr_defer != (address_item *)(+1))
7936 uschar *recipients = US"";
7937 BOOL delivery_attempted = FALSE;
7939 deliver_domain = testflag(addr_defer, af_pfr)
7940 ? addr_defer->parent->domain : addr_defer->domain;
7942 for (addr = addr_defer; addr; addr = addr->next)
7944 address_item *otaddr;
7946 if (addr->basic_errno > ERRNO_RETRY_BASE) delivery_attempted = TRUE;
7950 const uschar *d = testflag(addr, af_pfr)
7951 ? addr->parent->domain : addr->domain;
7953 /* The domain may be unset for an address that has never been routed
7954 because the system filter froze the message. */
7956 if (!d || Ustrcmp(d, deliver_domain) != 0)
7957 deliver_domain = NULL;
7960 if (addr->return_filename) Uunlink(addr->return_filename);
7962 /* Handle the case of one-time aliases. If any address in the ancestry
7963 of this one is flagged, ensure it is in the recipients list, suitably
7964 flagged, and that its parent is marked delivered. */
7966 for (otaddr = addr; otaddr; otaddr = otaddr->parent)
7967 if (otaddr->onetime_parent) break;
7972 int t = recipients_count;
7974 for (i = 0; i < recipients_count; i++)
7976 uschar *r = recipients_list[i].address;
7977 if (Ustrcmp(otaddr->onetime_parent, r) == 0) t = i;
7978 if (Ustrcmp(otaddr->address, r) == 0) break;
7981 /* Didn't find the address already in the list, and did find the
7982 ultimate parent's address in the list, and they really are different
7983 (i.e. not from an identity-redirect). After adding the recipient,
7984 update the errors address in the recipients list. */
7986 if ( i >= recipients_count && t < recipients_count
7987 && Ustrcmp(otaddr->address, otaddr->parent->address) != 0)
7989 DEBUG(D_deliver) debug_printf("one_time: adding %s in place of %s\n",
7990 otaddr->address, otaddr->parent->address);
7991 receive_add_recipient(otaddr->address, t);
7992 recipients_list[recipients_count-1].errors_to = otaddr->prop.errors_address;
7993 tree_add_nonrecipient(otaddr->parent->address);
7994 update_spool = TRUE;
7998 /* Except for error messages, ensure that either the errors address for
7999 this deferred address or, if there is none, the sender address, is on the
8000 list of recipients for a warning message. */
8002 if (sender_address[0])
8004 uschar * s = addr->prop.errors_address;
8005 if (!s) s = sender_address;
8006 if (Ustrstr(recipients, s) == NULL)
8007 recipients = string_sprintf("%s%s%s", recipients,
8008 recipients[0] ? "," : "", s);
8012 /* Send a warning message if the conditions are right. If the condition check
8013 fails because of a lookup defer, there is nothing we can do. The warning
8014 is not sent. Another attempt will be made at the next delivery attempt (if
8018 && delivery_attempted
8019 && ( ((addr_defer->dsn_flags & rf_dsnflags) == 0)
8020 || (addr_defer->dsn_flags & rf_notify_delay) == rf_notify_delay
8022 && delay_warning[1] > 0
8023 && sender_address[0] != 0
8024 && ( !delay_warning_condition
8025 || expand_check_condition(delay_warning_condition,
8026 US"delay_warning", US"option")
8032 int queue_time = time(NULL) - received_time.tv_sec;
8034 /* When running in the test harness, there's an option that allows us to
8035 fudge this time so as to get repeatability of the tests. Take the first
8036 time off the list. In queue runs, the list pointer gets updated in the
8039 if (running_in_test_harness && fudged_queue_times[0] != 0)
8041 int qt = readconf_readtime(fudged_queue_times, '/', FALSE);
8044 DEBUG(D_deliver) debug_printf("fudged queue_times = %s\n",
8045 fudged_queue_times);
8050 /* See how many warnings we should have sent by now */
8052 for (count = 0; count < delay_warning[1]; count++)
8053 if (queue_time < delay_warning[count+2]) break;
8055 show_time = delay_warning[count+1];
8057 if (count >= delay_warning[1])
8060 int last_gap = show_time;
8061 if (count > 1) last_gap -= delay_warning[count];
8062 extra = (queue_time - delay_warning[count+1])/last_gap;
8063 show_time += last_gap * extra;
8069 debug_printf("time on queue = %s\n", readconf_printtime(queue_time));
8070 debug_printf("warning counts: required %d done %d\n", count,
8074 /* We have computed the number of warnings there should have been by now.
8075 If there haven't been enough, send one, and up the count to what it should
8078 if (warning_count < count)
8082 pid_t pid = child_open_exim(&fd);
8088 FILE *f = fdopen(fd, "wb");
8090 transport_ctx tctx = {{0}};
8092 if (warn_message_file)
8093 if (!(wmf = Ufopen(warn_message_file, "rb")))
8094 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to open %s for warning "
8095 "message texts: %s", warn_message_file, strerror(errno));
8097 warnmsg_recipients = recipients;
8098 warnmsg_delay = queue_time < 120*60
8099 ? string_sprintf("%d minutes", show_time/60)
8100 : string_sprintf("%d hours", show_time/3600);
8102 if (errors_reply_to)
8103 fprintf(f, "Reply-To: %s\n", errors_reply_to);
8104 fprintf(f, "Auto-Submitted: auto-replied\n");
8106 fprintf(f, "To: %s\n", recipients);
8108 /* generated boundary string and output MIME-Headers */
8109 bound = string_sprintf(TIME_T_FMT "-eximdsn-%d", time(NULL), rand());
8111 fprintf(f, "Content-Type: multipart/report;"
8112 " report-type=delivery-status; boundary=%s\n"
8113 "MIME-Version: 1.0\n",
8116 if ((wmf_text = next_emf(wmf, US"header")))
8117 fprintf(f, "%s\n", wmf_text);
8119 fprintf(f, "Subject: Warning: message %s delayed %s\n\n",
8120 message_id, warnmsg_delay);
8122 /* output human readable part as text/plain section */
8124 "Content-type: text/plain; charset=us-ascii\n\n",
8127 if ((wmf_text = next_emf(wmf, US"intro")))
8128 fprintf(f, "%s", CS wmf_text);
8132 "This message was created automatically by mail delivery software.\n");
8134 if (Ustrcmp(recipients, sender_address) == 0)
8136 "A message that you sent has not yet been delivered to one or more of its\n"
8137 "recipients after more than ");
8141 "A message sent by\n\n <%s>\n\n"
8142 "has not yet been delivered to one or more of its recipients after more than \n",
8145 fprintf(f, "%s on the queue on %s.\n\n"
8146 "The message identifier is: %s\n",
8147 warnmsg_delay, primary_hostname, message_id);
8149 for (h = header_list; h; h = h->next)
8150 if (strncmpic(h->text, US"Subject:", 8) == 0)
8151 fprintf(f, "The subject of the message is: %s", h->text + 9);
8152 else if (strncmpic(h->text, US"Date:", 5) == 0)
8153 fprintf(f, "The date of the message is: %s", h->text + 6);
8156 fprintf(f, "The address%s to which the message has not yet been "
8158 !addr_defer->next ? "" : "es",
8159 !addr_defer->next ? "is": "are");
8162 /* List the addresses, with error information if allowed */
8164 /* store addr_defer for machine readable part */
8165 address_item *addr_dsndefer = addr_defer;
8169 address_item *addr = addr_defer;
8170 addr_defer = addr->next;
8171 if (print_address_information(addr, f, US" ", US"\n ", US""))
8172 print_address_error(addr, f, US"Delay reason: ");
8181 if ((wmf_text = next_emf(wmf, US"final")))
8182 fprintf(f, "%s", CS wmf_text);
8188 "No action is required on your part. Delivery attempts will continue for\n"
8189 "some time, and this warning may be repeated at intervals if the message\n"
8190 "remains undelivered. Eventually the mail delivery software will give up,\n"
8191 "and when that happens, the message will be returned to you.\n");
8194 /* output machine readable part */
8195 fprintf(f, "\n--%s\n"
8196 "Content-type: message/delivery-status\n\n"
8197 "Reporting-MTA: dns; %s\n",
8199 smtp_active_hostname);
8204 /* must be decoded from xtext: see RFC 3461:6.3a */
8206 if (auth_xtextdecode(dsn_envid, &xdec_envid) > 0)
8207 fprintf(f,"Original-Envelope-ID: %s\n", dsn_envid);
8209 fprintf(f,"X-Original-Envelope-ID: error decoding xtext formatted ENVID\n");
8213 for ( ; addr_dsndefer; addr_dsndefer = addr_dsndefer->next)
8215 if (addr_dsndefer->dsn_orcpt)
8216 fprintf(f, "Original-Recipient: %s\n", addr_dsndefer->dsn_orcpt);
8218 fprintf(f, "Action: delayed\n"
8219 "Final-Recipient: rfc822;%s\n"
8221 addr_dsndefer->address);
8222 if (addr_dsndefer->host_used && addr_dsndefer->host_used->name)
8224 fprintf(f, "Remote-MTA: dns; %s\n",
8225 addr_dsndefer->host_used->name);
8226 print_dsn_diagnostic_code(addr_dsndefer, f);
8232 "Content-type: text/rfc822-headers\n\n",
8236 /* header only as required by RFC. only failure DSN needs to honor RET=FULL */
8237 tctx.u.fd = fileno(f);
8238 tctx.options = topt_add_return_path | topt_no_body;
8239 transport_filter_argv = NULL; /* Just in case */
8240 return_path = sender_address; /* In case not previously set */
8242 /* Write the original email out */
8243 transport_write_message(&tctx, 0);
8246 fprintf(f,"\n--%s--\n", bound);
8250 /* Close and wait for child process to complete, without a timeout.
8251 If there's an error, don't update the count. */
8254 if (child_close(pid, 0) == 0)
8256 warning_count = count;
8257 update_spool = TRUE; /* Ensure spool rewritten */
8263 /* Clear deliver_domain */
8265 deliver_domain = NULL;
8267 /* If this was a first delivery attempt, unset the first time flag, and
8268 ensure that the spool gets updated. */
8270 if (deliver_firsttime)
8272 deliver_firsttime = FALSE;
8273 update_spool = TRUE;
8276 /* If delivery was frozen and freeze_tell is set, generate an appropriate
8277 message, unless the message is a local error message (to avoid loops). Then
8278 log the freezing. If the text in "frozen_info" came from a system filter,
8279 it has been escaped into printing characters so as not to mess up log lines.
8280 For the "tell" message, we turn \n back into newline. Also, insert a newline
8281 near the start instead of the ": " string. */
8285 if (freeze_tell && freeze_tell[0] != 0 && !local_error_message)
8287 uschar *s = string_copy(frozen_info);
8288 uschar *ss = Ustrstr(s, " by the system filter: ");
8299 if (*ss == '\\' && ss[1] == 'n')
8306 moan_tell_someone(freeze_tell, addr_defer, US"Message frozen",
8307 "Message %s has been frozen%s.\nThe sender is <%s>.\n", message_id,
8311 /* Log freezing just before we update the -H file, to minimize the chance
8312 of a race problem. */
8314 deliver_msglog("*** Frozen%s\n", frozen_info);
8315 log_write(0, LOG_MAIN, "Frozen%s", frozen_info);
8318 /* If there have been any updates to the non-recipients list, or other things
8319 that get written to the spool, we must now update the spool header file so
8320 that it has the right information for the next delivery attempt. If there
8321 was more than one address being delivered, the header_change update is done
8322 earlier, in case one succeeds and then something crashes. */
8325 debug_printf("delivery deferred: update_spool=%d header_rewritten=%d\n",
8326 update_spool, header_rewritten);
8328 if (update_spool || header_rewritten)
8329 /* Panic-dies on error */
8330 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
8333 /* Finished with the message log. If the message is complete, it will have
8334 been unlinked or renamed above. */
8336 if (message_logs) (void)fclose(message_log);
8338 /* Now we can close and remove the journal file. Its only purpose is to record
8339 successfully completed deliveries asap so that this information doesn't get
8340 lost if Exim (or the machine) crashes. Forgetting about a failed delivery is
8341 not serious, as trying it again is not harmful. The journal might not be open
8342 if all addresses were deferred at routing or directing. Nevertheless, we must
8343 remove it if it exists (may have been lying around from a crash during the
8344 previous delivery attempt). We don't remove the journal if a delivery
8345 subprocess failed to pass back delivery information; this is controlled by
8346 the remove_journal flag. When the journal is left, we also don't move the
8347 message off the main spool if frozen and the option is set. It should get moved
8348 at the next attempt, after the journal has been inspected. */
8350 if (journal_fd >= 0) (void)close(journal_fd);
8354 uschar * fname = spool_fname(US"input", message_subdir, id, US"-J");
8356 if (Uunlink(fname) < 0 && errno != ENOENT)
8357 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s", fname,
8360 /* Move the message off the spool if requested */
8362 #ifdef SUPPORT_MOVE_FROZEN_MESSAGES
8363 if (deliver_freeze && move_frozen_messages)
8364 (void)spool_move_message(id, message_subdir, US"", US"F");
8368 /* Closing the data file frees the lock; if the file has been unlinked it
8369 will go away. Otherwise the message becomes available for another process
8372 (void)close(deliver_datafile);
8373 deliver_datafile = -1;
8374 DEBUG(D_deliver) debug_printf("end delivery of %s\n", id);
8376 /* It is unlikely that there will be any cached resources, since they are
8377 released after routing, and in the delivery subprocesses. However, it's
8378 possible for an expansion for something afterwards (for example,
8379 expand_check_condition) to do a lookup. We must therefore be sure everything is
8383 acl_where = ACL_WHERE_UNKNOWN;
8392 #ifdef EXIM_TFO_PROBE
8395 tcp_fastopen_ok = TRUE;
8399 if (!regex_PIPELINING) regex_PIPELINING =
8400 regex_must_compile(US"\\n250[\\s\\-]PIPELINING(\\s|\\n|$)", FALSE, TRUE);
8402 if (!regex_SIZE) regex_SIZE =
8403 regex_must_compile(US"\\n250[\\s\\-]SIZE(\\s|\\n|$)", FALSE, TRUE);
8405 if (!regex_AUTH) regex_AUTH =
8406 regex_must_compile(US"\\n250[\\s\\-]AUTH\\s+([\\-\\w\\s]+)(?:\\n|$)",
8410 if (!regex_STARTTLS) regex_STARTTLS =
8411 regex_must_compile(US"\\n250[\\s\\-]STARTTLS(\\s|\\n|$)", FALSE, TRUE);
8414 if (!regex_CHUNKING) regex_CHUNKING =
8415 regex_must_compile(US"\\n250[\\s\\-]CHUNKING(\\s|\\n|$)", FALSE, TRUE);
8417 #ifndef DISABLE_PRDR
8418 if (!regex_PRDR) regex_PRDR =
8419 regex_must_compile(US"\\n250[\\s\\-]PRDR(\\s|\\n|$)", FALSE, TRUE);
8423 if (!regex_UTF8) regex_UTF8 =
8424 regex_must_compile(US"\\n250[\\s\\-]SMTPUTF8(\\s|\\n|$)", FALSE, TRUE);
8427 if (!regex_DSN) regex_DSN =
8428 regex_must_compile(US"\\n250[\\s\\-]DSN(\\s|\\n|$)", FALSE, TRUE);
8430 if (!regex_IGNOREQUOTA) regex_IGNOREQUOTA =
8431 regex_must_compile(US"\\n250[\\s\\-]IGNOREQUOTA(\\s|\\n|$)", FALSE, TRUE);
8436 deliver_get_sender_address (uschar * id)
8439 uschar * new_sender_address,
8440 * save_sender_address;
8441 BOOL save_qr = queue_running;
8444 /* make spool_open_datafile non-noisy on fail */
8446 queue_running = TRUE;
8448 /* Side effect: message_subdir is set for the (possibly split) spool directory */
8450 deliver_datafile = spool_open_datafile(id);
8451 queue_running = save_qr;
8452 if (deliver_datafile < 0)
8455 /* Save and restore the global sender_address. I'm not sure if we should
8456 not save/restore all the other global variables too, because
8457 spool_read_header() may change all of them. But OTOH, when this
8458 deliver_get_sender_address() gets called, the current message is done
8459 already and nobody needs the globals anymore. (HS12, 2015-08-21) */
8461 spoolname = string_sprintf("%s-H", id);
8462 save_sender_address = sender_address;
8464 rc = spool_read_header(spoolname, TRUE, TRUE);
8466 new_sender_address = sender_address;
8467 sender_address = save_sender_address;
8469 if (rc != spool_read_OK)
8472 assert(new_sender_address);
8474 (void)close(deliver_datafile);
8475 deliver_datafile = -1;
8477 return new_sender_address;
8483 delivery_re_exec(int exec_type)
8487 if (cutthrough.fd >= 0 && cutthrough.callout_hold_only)
8489 int pfd[2], channel_fd = cutthrough.fd, pid;
8491 smtp_peer_options = cutthrough.peer_options;
8492 continue_sequence = 0;
8495 if (cutthrough.is_tls)
8497 smtp_peer_options |= OPTION_TLS;
8498 sending_ip_address = cutthrough.snd_ip;
8499 sending_port = cutthrough.snd_port;
8501 where = US"socketpair";
8502 if (socketpair(AF_UNIX, SOCK_STREAM, 0, pfd) != 0)
8506 if ((pid = fork()) < 0)
8509 else if (pid == 0) /* child: fork again to totally disconnect */
8513 _exit(pid ? EXIT_FAILURE : EXIT_SUCCESS);
8514 smtp_proxy_tls(big_buffer, big_buffer_size, pfd[0], 5*60);
8519 waitpid(pid, NULL, 0);
8520 (void) close(channel_fd); /* release the client socket */
8521 channel_fd = pfd[1];
8525 transport_do_pass_socket(cutthrough.transport, cutthrough.host.name,
8526 cutthrough.host.address, message_id, channel_fd);
8530 cancel_cutthrough_connection(TRUE, US"non-continued delivery");
8531 (void) child_exec_exim(exec_type, FALSE, NULL, FALSE, 2, US"-Mc", message_id);
8533 return; /* compiler quietening; control does not reach here. */
8537 LOG_MAIN | (exec_type == CEE_EXEC_EXIT ? LOG_PANIC : LOG_PANIC_DIE),
8538 "delivery re-exec %s failed: %s", where, strerror(errno));
8540 /* Get here if exec_type == CEE_EXEC_EXIT.
8541 Note: this must be _exit(), not exit(). */
8543 _exit(EX_EXECFAILED);
8548 /* End of deliver.c */