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. */
15 /* Data block for keeping track of subprocesses for parallel remote
18 typedef struct pardata {
19 address_item *addrlist; /* chain of addresses */
20 address_item *addr; /* next address data expected for */
21 pid_t pid; /* subprocess pid */
22 int fd; /* pipe fd for getting result from subprocess */
23 int transport_count; /* returned transport count value */
24 BOOL done; /* no more data needed */
25 uschar *msg; /* error message */
26 uschar *return_path; /* return_path for these addresses */
29 /* Values for the process_recipients variable */
31 enum { RECIP_ACCEPT, RECIP_IGNORE, RECIP_DEFER,
32 RECIP_FAIL, RECIP_FAIL_FILTER, RECIP_FAIL_TIMEOUT,
35 /* Mutually recursive functions for marking addresses done. */
37 static void child_done(address_item *, uschar *);
38 static void address_done(address_item *, uschar *);
40 /* Table for turning base-62 numbers into binary */
42 static uschar tab62[] =
43 {0,1,2,3,4,5,6,7,8,9,0,0,0,0,0,0, /* 0-9 */
44 0,10,11,12,13,14,15,16,17,18,19,20, /* A-K */
45 21,22,23,24,25,26,27,28,29,30,31,32, /* L-W */
46 33,34,35, 0, 0, 0, 0, 0, /* X-Z */
47 0,36,37,38,39,40,41,42,43,44,45,46, /* a-k */
48 47,48,49,50,51,52,53,54,55,56,57,58, /* l-w */
52 /*************************************************
53 * Local static variables *
54 *************************************************/
56 /* addr_duplicate is global because it needs to be seen from the Envelope-To
59 static address_item *addr_defer = NULL;
60 static address_item *addr_failed = NULL;
61 static address_item *addr_fallback = NULL;
62 static address_item *addr_local = NULL;
63 static address_item *addr_new = NULL;
64 static address_item *addr_remote = NULL;
65 static address_item *addr_route = NULL;
66 static address_item *addr_succeed = NULL;
67 static address_item *addr_dsntmp = NULL;
68 static address_item *addr_senddsn = NULL;
70 static FILE *message_log = NULL;
71 static BOOL update_spool;
72 static BOOL remove_journal;
73 static int parcount = 0;
74 static pardata *parlist = NULL;
75 static int return_count;
76 static uschar *frozen_info = US"";
77 static uschar *used_return_path = NULL;
81 /*************************************************
82 * Make a new address item *
83 *************************************************/
85 /* This function gets the store and initializes with default values. The
86 transport_return value defaults to DEFER, so that any unexpected failure to
87 deliver does not wipe out the message. The default unique string is set to a
88 copy of the address, so that its domain can be lowercased.
91 address the RFC822 address string
92 copy force a copy of the address
94 Returns: a pointer to an initialized address_item
98 deliver_make_addr(uschar *address, BOOL copy)
100 address_item *addr = store_get(sizeof(address_item));
101 *addr = address_defaults;
102 if (copy) address = string_copy(address);
103 addr->address = address;
104 addr->unique = string_copy(address);
111 /*************************************************
112 * Set expansion values for an address *
113 *************************************************/
115 /* Certain expansion variables are valid only when handling an address or
116 address list. This function sets them up or clears the values, according to its
120 addr the address in question, or NULL to clear values
125 deliver_set_expansions(address_item *addr)
129 const uschar ***p = address_expansions;
130 while (*p) **p++ = NULL;
134 /* Exactly what gets set depends on whether there is one or more addresses, and
135 what they contain. These first ones are always set, taking their values from
136 the first address. */
138 if (!addr->host_list)
140 deliver_host = deliver_host_address = US"";
141 deliver_host_port = 0;
145 deliver_host = addr->host_list->name;
146 deliver_host_address = addr->host_list->address;
147 deliver_host_port = addr->host_list->port;
150 deliver_recipients = addr;
151 deliver_address_data = addr->prop.address_data;
152 deliver_domain_data = addr->prop.domain_data;
153 deliver_localpart_data = addr->prop.localpart_data;
155 /* These may be unset for multiple addresses */
157 deliver_domain = addr->domain;
158 self_hostname = addr->self_hostname;
160 #ifdef EXPERIMENTAL_BRIGHTMAIL
161 bmi_deliver = 1; /* deliver by default */
162 bmi_alt_location = NULL;
163 bmi_base64_verdict = NULL;
164 bmi_base64_tracker_verdict = NULL;
167 /* If there's only one address we can set everything. */
171 address_item *addr_orig;
173 deliver_localpart = addr->local_part;
174 deliver_localpart_prefix = addr->prefix;
175 deliver_localpart_suffix = addr->suffix;
177 for (addr_orig = addr; addr_orig->parent; addr_orig = addr_orig->parent) ;
178 deliver_domain_orig = addr_orig->domain;
180 /* Re-instate any prefix and suffix in the original local part. In all
181 normal cases, the address will have a router associated with it, and we can
182 choose the caseful or caseless version accordingly. However, when a system
183 filter sets up a pipe, file, or autoreply delivery, no router is involved.
184 In this case, though, there won't be any prefix or suffix to worry about. */
186 deliver_localpart_orig = !addr_orig->router
187 ? addr_orig->local_part
188 : addr_orig->router->caseful_local_part
189 ? addr_orig->cc_local_part
190 : addr_orig->lc_local_part;
192 /* If there's a parent, make its domain and local part available, and if
193 delivering to a pipe or file, or sending an autoreply, get the local
194 part from the parent. For pipes and files, put the pipe or file string
195 into address_pipe and address_file. */
199 deliver_domain_parent = addr->parent->domain;
200 deliver_localpart_parent = !addr->parent->router
201 ? addr->parent->local_part
202 : addr->parent->router->caseful_local_part
203 ? addr->parent->cc_local_part
204 : addr->parent->lc_local_part;
206 /* File deliveries have their own flag because they need to be picked out
207 as special more often. */
209 if (testflag(addr, af_pfr))
211 if (testflag(addr, af_file)) address_file = addr->local_part;
212 else if (deliver_localpart[0] == '|') address_pipe = addr->local_part;
213 deliver_localpart = addr->parent->local_part;
214 deliver_localpart_prefix = addr->parent->prefix;
215 deliver_localpart_suffix = addr->parent->suffix;
219 #ifdef EXPERIMENTAL_BRIGHTMAIL
220 /* Set expansion variables related to Brightmail AntiSpam */
221 bmi_base64_verdict = bmi_get_base64_verdict(deliver_localpart_orig, deliver_domain_orig);
222 bmi_base64_tracker_verdict = bmi_get_base64_tracker_verdict(bmi_base64_verdict);
223 /* get message delivery status (0 - don't deliver | 1 - deliver) */
224 bmi_deliver = bmi_get_delivery_status(bmi_base64_verdict);
225 /* if message is to be delivered, get eventual alternate location */
226 if (bmi_deliver == 1)
227 bmi_alt_location = bmi_get_alt_location(bmi_base64_verdict);
232 /* For multiple addresses, don't set local part, and leave the domain and
233 self_hostname set only if it is the same for all of them. It is possible to
234 have multiple pipe and file addresses, but only when all addresses have routed
235 to the same pipe or file. */
240 if (testflag(addr, af_pfr))
242 if (testflag(addr, af_file)) address_file = addr->local_part;
243 else if (addr->local_part[0] == '|') address_pipe = addr->local_part;
245 for (addr2 = addr->next; addr2; addr2 = addr2->next)
247 if (deliver_domain && Ustrcmp(deliver_domain, addr2->domain) != 0)
248 deliver_domain = NULL;
250 && ( !addr2->self_hostname
251 || Ustrcmp(self_hostname, addr2->self_hostname) != 0
253 self_hostname = NULL;
254 if (!deliver_domain && !self_hostname) break;
262 /*************************************************
263 * Open a msglog file *
264 *************************************************/
266 /* This function is used both for normal message logs, and for files in the
267 msglog directory that are used to catch output from pipes. Try to create the
268 directory if it does not exist. From release 4.21, normal message logs should
269 be created when the message is received.
271 Called from deliver_message(), can be operating as root.
274 filename the file name
275 mode the mode required
276 error used for saying what failed
278 Returns: a file descriptor, or -1 (with errno set)
282 open_msglog_file(uschar *filename, int mode, uschar **error)
286 for (i = 2; i > 0; i--)
295 O_WRONLY|O_APPEND|O_CREAT, mode);
298 /* Set the close-on-exec flag and change the owner to the exim uid/gid (this
299 function is called as root). Double check the mode, because the group setting
300 doesn't always get set automatically. */
303 (void)fcntl(fd, F_SETFD, fcntl(fd, F_GETFD) | FD_CLOEXEC);
305 if (fchown(fd, exim_uid, exim_gid) < 0)
310 if (fchmod(fd, mode) < 0)
320 (void)directory_make(spool_directory,
321 spool_sname(US"msglog", message_subdir),
322 MSGLOG_DIRECTORY_MODE, TRUE);
332 /*************************************************
333 * Write to msglog if required *
334 *************************************************/
336 /* Write to the message log, if configured. This function may also be called
340 format a string format
346 deliver_msglog(const char *format, ...)
349 if (!message_logs) return;
350 va_start(ap, format);
351 vfprintf(message_log, format, ap);
359 /*************************************************
360 * Replicate status for batch *
361 *************************************************/
363 /* When a transport handles a batch of addresses, it may treat them
364 individually, or it may just put the status in the first one, and return FALSE,
365 requesting that the status be copied to all the others externally. This is the
366 replication function. As well as the status, it copies the transport pointer,
367 which may have changed if appendfile passed the addresses on to a different
370 Argument: pointer to the first address in a chain
375 replicate_status(address_item *addr)
378 for (addr2 = addr->next; addr2; addr2 = addr2->next)
380 addr2->transport = addr->transport;
381 addr2->transport_return = addr->transport_return;
382 addr2->basic_errno = addr->basic_errno;
383 addr2->more_errno = addr->more_errno;
384 addr2->special_action = addr->special_action;
385 addr2->message = addr->message;
386 addr2->user_message = addr->user_message;
392 /*************************************************
393 * Compare lists of hosts *
394 *************************************************/
396 /* This function is given two pointers to chains of host items, and it yields
397 TRUE if the lists refer to the same hosts in the same order, except that
399 (1) Multiple hosts with the same non-negative MX values are permitted to appear
400 in different orders. Round-robinning nameservers can cause this to happen.
402 (2) Multiple hosts with the same negative MX values less than MX_NONE are also
403 permitted to appear in different orders. This is caused by randomizing
406 This enables Exim to use a single SMTP transaction for sending to two entirely
407 different domains that happen to end up pointing at the same hosts.
410 one points to the first host list
411 two points to the second host list
413 Returns: TRUE if the lists refer to the same host set
417 same_hosts(host_item *one, host_item *two)
421 if (Ustrcmp(one->name, two->name) != 0)
424 host_item *end_one = one;
425 host_item *end_two = two;
427 /* Batch up only if there was no MX and the list was not randomized */
429 if (mx == MX_NONE) return FALSE;
431 /* Find the ends of the shortest sequence of identical MX values */
433 while ( end_one->next && end_one->next->mx == mx
434 && end_two->next && end_two->next->mx == mx)
436 end_one = end_one->next;
437 end_two = end_two->next;
440 /* If there aren't any duplicates, there's no match. */
442 if (end_one == one) return FALSE;
444 /* For each host in the 'one' sequence, check that it appears in the 'two'
445 sequence, returning FALSE if not. */
450 for (hi = two; hi != end_two->next; hi = hi->next)
451 if (Ustrcmp(one->name, hi->name) == 0) break;
452 if (hi == end_two->next) return FALSE;
453 if (one == end_one) break;
457 /* All the hosts in the 'one' sequence were found in the 'two' sequence.
458 Ensure both are pointing at the last host, and carry on as for equality. */
463 /* if the names matched but ports do not, mismatch */
464 else if (one->port != two->port)
473 /* True if both are NULL */
480 /*************************************************
481 * Compare header lines *
482 *************************************************/
484 /* This function is given two pointers to chains of header items, and it yields
485 TRUE if they are the same header texts in the same order.
488 one points to the first header list
489 two points to the second header list
491 Returns: TRUE if the lists refer to the same header set
495 same_headers(header_line *one, header_line *two)
497 for (;; one = one->next, two = two->next)
499 if (one == two) return TRUE; /* Includes the case where both NULL */
500 if (!one || !two) return FALSE;
501 if (Ustrcmp(one->text, two->text) != 0) return FALSE;
507 /*************************************************
508 * Compare string settings *
509 *************************************************/
511 /* This function is given two pointers to strings, and it returns
512 TRUE if they are the same pointer, or if the two strings are the same.
515 one points to the first string
516 two points to the second string
518 Returns: TRUE or FALSE
522 same_strings(uschar *one, uschar *two)
524 if (one == two) return TRUE; /* Includes the case where both NULL */
525 if (!one || !two) return FALSE;
526 return (Ustrcmp(one, two) == 0);
531 /*************************************************
532 * Compare uid/gid for addresses *
533 *************************************************/
535 /* This function is given a transport and two addresses. It yields TRUE if the
536 uid/gid/initgroups settings for the two addresses are going to be the same when
541 addr1 the first address
542 addr2 the second address
544 Returns: TRUE or FALSE
548 same_ugid(transport_instance *tp, address_item *addr1, address_item *addr2)
550 if ( !tp->uid_set && !tp->expand_uid
551 && !tp->deliver_as_creator
552 && ( testflag(addr1, af_uid_set) != testflag(addr2, af_gid_set)
553 || ( testflag(addr1, af_uid_set)
554 && ( addr1->uid != addr2->uid
555 || testflag(addr1, af_initgroups) != testflag(addr2, af_initgroups)
559 if ( !tp->gid_set && !tp->expand_gid
560 && ( testflag(addr1, af_gid_set) != testflag(addr2, af_gid_set)
561 || ( testflag(addr1, af_gid_set)
562 && addr1->gid != addr2->gid
572 /*************************************************
573 * Record that an address is complete *
574 *************************************************/
576 /* This function records that an address is complete. This is straightforward
577 for most addresses, where the unique address is just the full address with the
578 domain lower cased. For homonyms (addresses that are the same as one of their
579 ancestors) their are complications. Their unique addresses have \x\ prepended
580 (where x = 0, 1, 2...), so that de-duplication works correctly for siblings and
583 Exim used to record the unique addresses of homonyms as "complete". This,
584 however, fails when the pattern of redirection varies over time (e.g. if taking
585 unseen copies at only some times of day) because the prepended numbers may vary
586 from one delivery run to the next. This problem is solved by never recording
587 prepended unique addresses as complete. Instead, when a homonymic address has
588 actually been delivered via a transport, we record its basic unique address
589 followed by the name of the transport. This is checked in subsequent delivery
590 runs whenever an address is routed to a transport.
592 If the completed address is a top-level one (has no parent, which means it
593 cannot be homonymic) we also add the original address to the non-recipients
594 tree, so that it gets recorded in the spool file and therefore appears as
595 "done" in any spool listings. The original address may differ from the unique
596 address in the case of the domain.
598 Finally, this function scans the list of duplicates, marks as done any that
599 match this address, and calls child_done() for their ancestors.
602 addr address item that has been completed
603 now current time as a string
609 address_done(address_item *addr, uschar *now)
613 update_spool = TRUE; /* Ensure spool gets updated */
615 /* Top-level address */
619 tree_add_nonrecipient(addr->unique);
620 tree_add_nonrecipient(addr->address);
623 /* Homonymous child address */
625 else if (testflag(addr, af_homonym))
628 tree_add_nonrecipient(
629 string_sprintf("%s/%s", addr->unique + 3, addr->transport->name));
632 /* Non-homonymous child address */
634 else tree_add_nonrecipient(addr->unique);
636 /* Check the list of duplicate addresses and ensure they are now marked
639 for (dup = addr_duplicate; dup; dup = dup->next)
640 if (Ustrcmp(addr->unique, dup->unique) == 0)
642 tree_add_nonrecipient(dup->unique);
643 child_done(dup, now);
650 /*************************************************
651 * Decrease counts in parents and mark done *
652 *************************************************/
654 /* This function is called when an address is complete. If there is a parent
655 address, its count of children is decremented. If there are still other
656 children outstanding, the function exits. Otherwise, if the count has become
657 zero, address_done() is called to mark the parent and its duplicates complete.
658 Then loop for any earlier ancestors.
661 addr points to the completed address item
662 now the current time as a string, for writing to the message log
668 child_done(address_item *addr, uschar *now)
674 if (--addr->child_count > 0) return; /* Incomplete parent */
675 address_done(addr, now);
677 /* Log the completion of all descendents only when there is no ancestor with
678 the same original address. */
680 for (aa = addr->parent; aa; aa = aa->parent)
681 if (Ustrcmp(aa->address, addr->address) == 0) break;
684 deliver_msglog("%s %s: children all complete\n", now, addr->address);
685 DEBUG(D_deliver) debug_printf("%s: children all complete\n", addr->address);
691 /*************************************************
692 * Delivery logging support functions *
693 *************************************************/
695 /* The LOGGING() checks in d_log_interface() are complicated for backwards
696 compatibility. When outgoing interface logging was originally added, it was
697 conditional on just incoming_interface (which is off by default). The
698 outgoing_interface option is on by default to preserve this behaviour, but
699 you can enable incoming_interface and disable outgoing_interface to get I=
700 fields on incoming lines only.
703 s The log line buffer
704 sizep Pointer to the buffer size
705 ptrp Pointer to current index into buffer
706 addr The address to be logged
708 Returns: New value for s
712 d_log_interface(uschar *s, int *sizep, int *ptrp)
714 if (LOGGING(incoming_interface) && LOGGING(outgoing_interface)
715 && sending_ip_address)
717 s = string_append(s, sizep, ptrp, 2, US" I=[", sending_ip_address);
718 s = LOGGING(outgoing_port)
719 ? string_append(s, sizep, ptrp, 2, US"]:",
720 string_sprintf("%d", sending_port))
721 : string_catn(s, sizep, ptrp, US"]", 1);
729 d_hostlog(uschar * s, int * sp, int * pp, address_item * addr)
731 host_item * h = addr->host_used;
733 s = string_append(s, sp, pp, 2, US" H=", h->name);
735 if (LOGGING(dnssec) && h->dnssec == DS_YES)
736 s = string_catn(s, sp, pp, US" DS", 3);
738 s = string_append(s, sp, pp, 3, US" [", h->address, US"]");
740 if (LOGGING(outgoing_port))
741 s = string_append(s, sp, pp, 2, US":", string_sprintf("%d", h->port));
744 if (LOGGING(proxy) && proxy_local_address)
746 s = string_append(s, sp, pp, 3, US" PRX=[", proxy_local_address, US"]");
747 if (LOGGING(outgoing_port))
748 s = string_append(s, sp, pp, 2, US":", string_sprintf("%d",
753 return d_log_interface(s, sp, pp);
762 d_tlslog(uschar * s, int * sizep, int * ptrp, address_item * addr)
764 if (LOGGING(tls_cipher) && addr->cipher)
765 s = string_append(s, sizep, ptrp, 2, US" X=", addr->cipher);
766 if (LOGGING(tls_certificate_verified) && addr->cipher)
767 s = string_append(s, sizep, ptrp, 2, US" CV=",
768 testflag(addr, af_cert_verified)
770 #ifdef EXPERIMENTAL_DANE
771 testflag(addr, af_dane_verified)
777 if (LOGGING(tls_peerdn) && addr->peerdn)
778 s = string_append(s, sizep, ptrp, 3, US" DN=\"",
779 string_printing(addr->peerdn), US"\"");
787 #ifndef DISABLE_EVENT
789 event_raise(uschar * action, const uschar * event, uschar * ev_data)
795 debug_printf("Event(%s): event_action=|%s| delivery_IP=%s\n",
797 action, deliver_host_address);
800 event_data = ev_data;
802 if (!(s = expand_string(action)) && *expand_string_message)
803 log_write(0, LOG_MAIN|LOG_PANIC,
804 "failed to expand event_action %s in %s: %s\n",
805 event, transport_name, expand_string_message);
807 event_name = event_data = NULL;
809 /* If the expansion returns anything but an empty string, flag for
810 the caller to modify his normal processing
815 debug_printf("Event(%s): event_action returned \"%s\"\n", event, s);
823 msg_event_raise(const uschar * event, const address_item * addr)
825 const uschar * save_domain = deliver_domain;
826 uschar * save_local = deliver_localpart;
827 const uschar * save_host = deliver_host;
828 const uschar * save_address = deliver_host_address;
829 const int save_port = deliver_host_port;
831 if (!addr->transport)
834 router_name = addr->router ? addr->router->name : NULL;
835 transport_name = addr->transport->name;
836 deliver_domain = addr->domain;
837 deliver_localpart = addr->local_part;
838 deliver_host = addr->host_used ? addr->host_used->name : NULL;
840 (void) event_raise(addr->transport->event_action, event,
842 || Ustrcmp(addr->transport->driver_name, "smtp") == 0
843 || Ustrcmp(addr->transport->driver_name, "lmtp") == 0
844 ? addr->message : NULL);
846 deliver_host_port = save_port;
847 deliver_host_address = save_address;
848 deliver_host = save_host;
849 deliver_localpart = save_local;
850 deliver_domain = save_domain;
851 router_name = transport_name = NULL;
853 #endif /*DISABLE_EVENT*/
857 /******************************************************************************/
860 /*************************************************
861 * Generate local prt for logging *
862 *************************************************/
864 /* This function is a subroutine for use in string_log_address() below.
867 addr the address being logged
868 yield the current dynamic buffer pointer
869 sizeptr points to current size
870 ptrptr points to current insert pointer
872 Returns: the new value of the buffer pointer
876 string_get_localpart(address_item *addr, uschar *yield, int *sizeptr,
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, sizeptr, ptrptr, 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, sizeptr, ptrptr, 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, sizeptr, ptrptr, 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 str points to start of growing string, or NULL
924 size points to current allocation for string
925 ptr points to offset for append point; updated on exit
926 addr bottom (ultimate) address
927 all_parents if TRUE, include all parents
928 success TRUE for successful delivery
930 Returns: a growable string in dynamic store
934 string_log_address(uschar * str, int * size, int * ptr,
935 address_item *addr, BOOL all_parents, BOOL success)
937 BOOL add_topaddr = TRUE;
938 address_item *topaddr;
940 /* Find the ultimate parent */
942 for (topaddr = addr; topaddr->parent; topaddr = topaddr->parent) ;
944 /* We start with just the local part for pipe, file, and reply deliveries, and
945 for successful local deliveries from routers that have the log_as_local flag
946 set. File deliveries from filters can be specified as non-absolute paths in
947 cases where the transport is going to complete the path. If there is an error
948 before this happens (expansion failure) the local part will not be updated, and
949 so won't necessarily look like a path. Add extra text for this case. */
951 if ( testflag(addr, af_pfr)
953 && addr->router && addr->router->log_as_local
954 && addr->transport && addr->transport->info->local
957 if (testflag(addr, af_file) && addr->local_part[0] != '/')
958 str = string_catn(str, size, ptr, CUS"save ", 5);
959 str = string_get_localpart(addr, str, size, ptr);
962 /* Other deliveries start with the full address. It we have split it into local
963 part and domain, use those fields. Some early failures can happen before the
964 splitting is done; in those cases use the original field. */
968 uschar * cmp = str + *ptr;
970 if (addr->local_part)
973 str = string_get_localpart(addr, str, size, ptr);
974 str = string_catn(str, size, ptr, US"@", 1);
977 if (testflag(addr, af_utf8_downcvt))
978 s = string_localpart_utf8_to_alabel(s, NULL);
980 str = string_cat(str, size, ptr, s);
983 str = string_cat(str, size, ptr, addr->address);
985 /* If the address we are going to print is the same as the top address,
986 and all parents are not being included, don't add on the top address. First
987 of all, do a caseless comparison; if this succeeds, do a caseful comparison
988 on the local parts. */
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 str = string_catn(str, size, ptr, s, 2);
1012 str = string_cat (str, size, ptr, addr2->address);
1013 if (!all_parents) break;
1016 str = string_catn(str, size, ptr, US")", 1);
1019 /* Add the top address if it is required */
1022 str = string_append(str, size, ptr, 3,
1024 addr->onetime_parent ? addr->onetime_parent : topaddr->address,
1031 /******************************************************************************/
1035 /* If msg is NULL this is a delivery log and logchar is used. Otherwise
1036 this is a nonstandard call; no two-character delivery flag is written
1037 but sender-host and sender are prefixed and "msg" is inserted in the log line.
1040 flags passed to log_write()
1043 delivery_log(int flags, address_item * addr, int logchar, uschar * msg)
1045 int size = 256; /* Used for a temporary, */
1046 int ptr = 0; /* expanding buffer, for */
1047 uschar * s; /* building log lines; */
1048 void * reset_point; /* released afterwards. */
1050 /* Log the delivery on the main log. We use an extensible string to build up
1051 the log line, and reset the store afterwards. Remote deliveries should always
1052 have a pointer to the host item that succeeded; local deliveries can have a
1053 pointer to a single host item in their host list, for use by the transport. */
1055 #ifndef DISABLE_EVENT
1056 /* presume no successful remote delivery */
1057 lookup_dnssec_authenticated = NULL;
1060 s = reset_point = store_get(size);
1063 s = string_append(s, &size, &ptr, 2, host_and_ident(TRUE), US" ");
1067 s = string_catn(s, &size, &ptr, US"> ", 2);
1069 s = string_log_address(s, &size, &ptr, addr, LOGGING(all_parents), TRUE);
1071 if (LOGGING(sender_on_delivery) || msg)
1072 s = string_append(s, &size, &ptr, 3, US" F=<",
1074 testflag(addr, af_utf8_downcvt)
1075 ? string_address_utf8_to_alabel(sender_address, NULL)
1082 s = string_append(s, &size, &ptr, 2, US" Q=", queue_name);
1084 #ifdef EXPERIMENTAL_SRS
1085 if(addr->prop.srs_sender)
1086 s = string_append(s, &size, &ptr, 3, US" SRS=<", addr->prop.srs_sender, US">");
1089 /* You might think that the return path must always be set for a successful
1090 delivery; indeed, I did for some time, until this statement crashed. The case
1091 when it is not set is for a delivery to /dev/null which is optimised by not
1092 being run at all. */
1094 if (used_return_path && LOGGING(return_path_on_delivery))
1095 s = string_append(s, &size, &ptr, 3, US" P=<", used_return_path, US">");
1098 s = string_append(s, &size, &ptr, 2, US" ", msg);
1100 /* For a delivery from a system filter, there may not be a router */
1102 s = string_append(s, &size, &ptr, 2, US" R=", addr->router->name);
1104 s = string_append(s, &size, &ptr, 2, US" T=", addr->transport->name);
1106 if (LOGGING(delivery_size))
1107 s = string_append(s, &size, &ptr, 2, US" S=",
1108 string_sprintf("%d", transport_count));
1110 /* Local delivery */
1112 if (addr->transport->info->local)
1114 if (addr->host_list)
1115 s = string_append(s, &size, &ptr, 2, US" H=", addr->host_list->name);
1116 s = d_log_interface(s, &size, &ptr);
1117 if (addr->shadow_message)
1118 s = string_cat(s, &size, &ptr, addr->shadow_message);
1121 /* Remote delivery */
1125 if (addr->host_used)
1127 s = d_hostlog(s, &size, &ptr, addr);
1128 if (continue_sequence > 1)
1129 s = string_catn(s, &size, &ptr, US"*", 1);
1131 #ifndef DISABLE_EVENT
1132 deliver_host_address = addr->host_used->address;
1133 deliver_host_port = addr->host_used->port;
1134 deliver_host = addr->host_used->name;
1136 /* DNS lookup status */
1137 lookup_dnssec_authenticated = addr->host_used->dnssec==DS_YES ? US"yes"
1138 : addr->host_used->dnssec==DS_NO ? US"no"
1144 s = d_tlslog(s, &size, &ptr, addr);
1147 if (addr->authenticator)
1149 s = string_append(s, &size, &ptr, 2, US" A=", addr->authenticator);
1152 s = string_append(s, &size, &ptr, 2, US":", addr->auth_id);
1153 if (LOGGING(smtp_mailauth) && addr->auth_sndr)
1154 s = string_append(s, &size, &ptr, 2, US":", addr->auth_sndr);
1158 #ifndef DISABLE_PRDR
1159 if (addr->flags & af_prdr_used)
1160 s = string_catn(s, &size, &ptr, US" PRDR", 5);
1163 if (addr->flags & af_chunking_used)
1164 s = string_catn(s, &size, &ptr, US" K", 2);
1167 /* confirmation message (SMTP (host_used) and LMTP (driver_name)) */
1169 if ( LOGGING(smtp_confirmation)
1171 && (addr->host_used || Ustrcmp(addr->transport->driver_name, "lmtp") == 0)
1175 unsigned lim = big_buffer_size < 1024 ? big_buffer_size : 1024;
1176 uschar *p = big_buffer;
1177 uschar *ss = addr->message;
1179 for (i = 0; i < lim && ss[i] != 0; i++) /* limit logged amount */
1181 if (ss[i] == '\"' || ss[i] == '\\') *p++ = '\\'; /* quote \ and " */
1186 s = string_append(s, &size, &ptr, 2, US" C=", big_buffer);
1189 /* Time on queue and actual time taken to deliver */
1191 if (LOGGING(queue_time))
1192 s = string_append(s, &size, &ptr, 2, US" QT=",
1193 readconf_printtime( (int) ((long)time(NULL) - (long)received_time)) );
1195 if (LOGGING(deliver_time))
1196 s = string_append(s, &size, &ptr, 2, US" DT=",
1197 readconf_printtime(addr->more_errno));
1199 /* string_cat() always leaves room for the terminator. Release the
1200 store we used to build the line after writing it. */
1203 log_write(0, flags, "%s", s);
1205 #ifndef DISABLE_EVENT
1206 if (!msg) msg_event_raise(US"msg:delivery", addr);
1209 store_reset(reset_point);
1216 deferral_log(address_item * addr, uschar * now,
1217 int logflags, uschar * driver_name, uschar * driver_kind)
1219 int size = 256; /* Used for a temporary, */
1220 int ptr = 0; /* expanding buffer, for */
1221 uschar * s; /* building log lines; */
1222 void * reset_point; /* released afterwards. */
1226 /* Build up the line that is used for both the message log and the main
1229 s = reset_point = store_get(size);
1231 /* Create the address string for logging. Must not do this earlier, because
1232 an OK result may be changed to FAIL when a pipe returns text. */
1234 s = string_log_address(s, &size, &ptr, addr, LOGGING(all_parents), FALSE);
1237 s = string_append(s, &size, &ptr, 2, US" Q=", queue_name);
1239 /* Either driver_name contains something and driver_kind contains
1240 " router" or " transport" (note the leading space), or driver_name is
1241 a null string and driver_kind contains "routing" without the leading
1242 space, if all routing has been deferred. When a domain has been held,
1243 so nothing has been done at all, both variables contain null strings. */
1247 if (driver_kind[1] == 't' && addr->router)
1248 s = string_append(s, &size, &ptr, 2, US" R=", addr->router->name);
1250 ss[1] = toupper(driver_kind[1]);
1251 s = string_append(s, &size, &ptr, 2, ss, driver_name);
1253 else if (driver_kind)
1254 s = string_append(s, &size, &ptr, 2, US" ", driver_kind);
1256 /*XXX need an s+s+p sprintf */
1257 sprintf(CS ss, " defer (%d)", addr->basic_errno);
1258 s = string_cat(s, &size, &ptr, ss);
1260 if (addr->basic_errno > 0)
1261 s = string_append(s, &size, &ptr, 2, US": ",
1262 US strerror(addr->basic_errno));
1264 if (addr->host_used)
1266 s = string_append(s, &size, &ptr, 5,
1267 US" H=", addr->host_used->name,
1268 US" [", addr->host_used->address, US"]");
1269 if (LOGGING(outgoing_port))
1271 int port = addr->host_used->port;
1272 s = string_append(s, &size, &ptr, 2,
1273 US":", port == PORT_NONE ? US"25" : string_sprintf("%d", port));
1278 s = string_append(s, &size, &ptr, 2, US": ", addr->message);
1282 /* Log the deferment in the message log, but don't clutter it
1283 up with retry-time defers after the first delivery attempt. */
1285 if (deliver_firsttime || addr->basic_errno > ERRNO_RETRY_BASE)
1286 deliver_msglog("%s %s\n", now, s);
1288 /* Write the main log and reset the store.
1289 For errors of the type "retry time not reached" (also remotes skipped
1290 on queue run), logging is controlled by L_retry_defer. Note that this kind
1291 of error number is negative, and all the retry ones are less than any
1295 log_write(addr->basic_errno <= ERRNO_RETRY_BASE ? L_retry_defer : 0, logflags,
1298 store_reset(reset_point);
1305 failure_log(address_item * addr, uschar * driver_kind, uschar * now)
1307 int size = 256; /* Used for a temporary, */
1308 int ptr = 0; /* expanding buffer, for */
1309 uschar * s; /* building log lines; */
1310 void * reset_point; /* released afterwards. */
1312 /* Build up the log line for the message and main logs */
1314 s = reset_point = store_get(size);
1316 /* Create the address string for logging. Must not do this earlier, because
1317 an OK result may be changed to FAIL when a pipe returns text. */
1319 s = string_log_address(s, &size, &ptr, addr, LOGGING(all_parents), FALSE);
1321 if (LOGGING(sender_on_delivery))
1322 s = string_append(s, &size, &ptr, 3, US" F=<", sender_address, US">");
1325 s = string_append(s, &size, &ptr, 2, US" Q=", queue_name);
1327 /* Return path may not be set if no delivery actually happened */
1329 if (used_return_path && LOGGING(return_path_on_delivery))
1330 s = string_append(s, &size, &ptr, 3, US" P=<", used_return_path, US">");
1333 s = string_append(s, &size, &ptr, 2, US" R=", addr->router->name);
1334 if (addr->transport)
1335 s = string_append(s, &size, &ptr, 2, US" T=", addr->transport->name);
1337 if (addr->host_used)
1338 s = d_hostlog(s, &size, &ptr, addr);
1341 s = d_tlslog(s, &size, &ptr, addr);
1344 if (addr->basic_errno > 0)
1345 s = string_append(s, &size, &ptr, 2, US": ", US strerror(addr->basic_errno));
1348 s = string_append(s, &size, &ptr, 2, US": ", addr->message);
1352 /* Do the logging. For the message log, "routing failed" for those cases,
1353 just to make it clearer. */
1356 deliver_msglog("%s %s failed for %s\n", now, driver_kind, s);
1358 deliver_msglog("%s %s\n", now, s);
1360 log_write(0, LOG_MAIN, "** %s", s);
1362 #ifndef DISABLE_EVENT
1363 msg_event_raise(US"msg:fail:delivery", addr);
1366 store_reset(reset_point);
1372 /*************************************************
1373 * Actions at the end of handling an address *
1374 *************************************************/
1376 /* This is a function for processing a single address when all that can be done
1377 with it has been done.
1380 addr points to the address block
1381 result the result of the delivery attempt
1382 logflags flags for log_write() (LOG_MAIN and/or LOG_PANIC)
1383 driver_type indicates which type of driver (transport, or router) was last
1384 to process the address
1385 logchar '=' or '-' for use when logging deliveries with => or ->
1391 post_process_one(address_item *addr, int result, int logflags, int driver_type,
1394 uschar *now = tod_stamp(tod_log);
1395 uschar *driver_kind = NULL;
1396 uschar *driver_name = NULL;
1398 DEBUG(D_deliver) debug_printf("post-process %s (%d)\n", addr->address, result);
1400 /* Set up driver kind and name for logging. Disable logging if the router or
1401 transport has disabled it. */
1403 if (driver_type == DTYPE_TRANSPORT)
1405 if (addr->transport)
1407 driver_name = addr->transport->name;
1408 driver_kind = US" transport";
1409 disable_logging = addr->transport->disable_logging;
1411 else driver_kind = US"transporting";
1413 else if (driver_type == DTYPE_ROUTER)
1417 driver_name = addr->router->name;
1418 driver_kind = US" router";
1419 disable_logging = addr->router->disable_logging;
1421 else driver_kind = US"routing";
1424 /* If there's an error message set, ensure that it contains only printing
1425 characters - it should, but occasionally things slip in and this at least
1426 stops the log format from getting wrecked. We also scan the message for an LDAP
1427 expansion item that has a password setting, and flatten the password. This is a
1428 fudge, but I don't know a cleaner way of doing this. (If the item is badly
1429 malformed, it won't ever have gone near LDAP.) */
1433 const uschar * s = string_printing(addr->message);
1435 /* deconst cast ok as string_printing known to have alloc'n'copied */
1436 addr->message = expand_hide_passwords(US s);
1439 /* If we used a transport that has one of the "return_output" options set, and
1440 if it did in fact generate some output, then for return_output we treat the
1441 message as failed if it was not already set that way, so that the output gets
1442 returned to the sender, provided there is a sender to send it to. For
1443 return_fail_output, do this only if the delivery failed. Otherwise we just
1444 unlink the file, and remove the name so that if the delivery failed, we don't
1445 try to send back an empty or unwanted file. The log_output options operate only
1446 on a non-empty file.
1448 In any case, we close the message file, because we cannot afford to leave a
1449 file-descriptor for one address while processing (maybe very many) others. */
1451 if (addr->return_file >= 0 && addr->return_filename)
1453 BOOL return_output = FALSE;
1454 struct stat statbuf;
1455 (void)EXIMfsync(addr->return_file);
1457 /* If there is no output, do nothing. */
1459 if (fstat(addr->return_file, &statbuf) == 0 && statbuf.st_size > 0)
1461 transport_instance *tb = addr->transport;
1463 /* Handle logging options */
1466 || result == FAIL && tb->log_fail_output
1467 || result == DEFER && tb->log_defer_output
1471 FILE *f = Ufopen(addr->return_filename, "rb");
1473 log_write(0, LOG_MAIN|LOG_PANIC, "failed to open %s to log output "
1474 "from %s transport: %s", addr->return_filename, tb->name,
1477 if ((s = US Ufgets(big_buffer, big_buffer_size, f)))
1479 uschar *p = big_buffer + Ustrlen(big_buffer);
1481 while (p > big_buffer && isspace(p[-1])) p--;
1483 sp = string_printing(big_buffer);
1484 log_write(0, LOG_MAIN, "<%s>: %s transport output: %s",
1485 addr->address, tb->name, sp);
1490 /* Handle returning options, but only if there is an address to return
1493 if (sender_address[0] != 0 || addr->prop.errors_address)
1494 if (tb->return_output)
1496 addr->transport_return = result = FAIL;
1497 if (addr->basic_errno == 0 && !addr->message)
1498 addr->message = US"return message generated";
1499 return_output = TRUE;
1502 if (tb->return_fail_output && result == FAIL) return_output = TRUE;
1505 /* Get rid of the file unless it might be returned, but close it in
1510 Uunlink(addr->return_filename);
1511 addr->return_filename = NULL;
1512 addr->return_file = -1;
1515 (void)close(addr->return_file);
1518 /* The success case happens only after delivery by a transport. */
1522 addr->next = addr_succeed;
1523 addr_succeed = addr;
1525 /* Call address_done() to ensure that we don't deliver to this address again,
1526 and write appropriate things to the message log. If it is a child address, we
1527 call child_done() to scan the ancestors and mark them complete if this is the
1528 last child to complete. */
1530 address_done(addr, now);
1531 DEBUG(D_deliver) debug_printf("%s delivered\n", addr->address);
1534 deliver_msglog("%s %s: %s%s succeeded\n", now, addr->address,
1535 driver_name, driver_kind);
1538 deliver_msglog("%s %s <%s>: %s%s succeeded\n", now, addr->address,
1539 addr->parent->address, driver_name, driver_kind);
1540 child_done(addr, now);
1543 /* Certificates for logging (via events) */
1545 tls_out.ourcert = addr->ourcert;
1546 addr->ourcert = NULL;
1547 tls_out.peercert = addr->peercert;
1548 addr->peercert = NULL;
1550 tls_out.cipher = addr->cipher;
1551 tls_out.peerdn = addr->peerdn;
1552 tls_out.ocsp = addr->ocsp;
1553 # ifdef EXPERIMENTAL_DANE
1554 tls_out.dane_verified = testflag(addr, af_dane_verified);
1558 delivery_log(LOG_MAIN, addr, logchar, NULL);
1561 tls_free_cert(&tls_out.ourcert);
1562 tls_free_cert(&tls_out.peercert);
1563 tls_out.cipher = NULL;
1564 tls_out.peerdn = NULL;
1565 tls_out.ocsp = OCSP_NOT_REQ;
1566 # ifdef EXPERIMENTAL_DANE
1567 tls_out.dane_verified = FALSE;
1573 /* Soft failure, or local delivery process failed; freezing may be
1576 else if (result == DEFER || result == PANIC)
1578 if (result == PANIC) logflags |= LOG_PANIC;
1580 /* This puts them on the chain in reverse order. Do not change this, because
1581 the code for handling retries assumes that the one with the retry
1582 information is last. */
1584 addr->next = addr_defer;
1587 /* The only currently implemented special action is to freeze the
1588 message. Logging of this is done later, just before the -H file is
1591 if (addr->special_action == SPECIAL_FREEZE)
1593 deliver_freeze = TRUE;
1594 deliver_frozen_at = time(NULL);
1595 update_spool = TRUE;
1598 /* If doing a 2-stage queue run, we skip writing to either the message
1599 log or the main log for SMTP defers. */
1601 if (!queue_2stage || addr->basic_errno != 0)
1602 deferral_log(addr, now, logflags, driver_name, driver_kind);
1606 /* Hard failure. If there is an address to which an error message can be sent,
1607 put this address on the failed list. If not, put it on the deferred list and
1608 freeze the mail message for human attention. The latter action can also be
1609 explicitly requested by a router or transport. */
1613 /* If this is a delivery error, or a message for which no replies are
1614 wanted, and the message's age is greater than ignore_bounce_errors_after,
1615 force the af_ignore_error flag. This will cause the address to be discarded
1616 later (with a log entry). */
1618 if (!*sender_address && message_age >= ignore_bounce_errors_after)
1619 setflag(addr, af_ignore_error);
1621 /* Freeze the message if requested, or if this is a bounce message (or other
1622 message with null sender) and this address does not have its own errors
1623 address. However, don't freeze if errors are being ignored. The actual code
1624 to ignore occurs later, instead of sending a message. Logging of freezing
1625 occurs later, just before writing the -H file. */
1627 if ( !testflag(addr, af_ignore_error)
1628 && ( addr->special_action == SPECIAL_FREEZE
1629 || (sender_address[0] == 0 && !addr->prop.errors_address)
1632 frozen_info = addr->special_action == SPECIAL_FREEZE
1634 : sender_local && !local_error_message
1635 ? US" (message created with -f <>)"
1636 : US" (delivery error message)";
1637 deliver_freeze = TRUE;
1638 deliver_frozen_at = time(NULL);
1639 update_spool = TRUE;
1641 /* The address is put on the defer rather than the failed queue, because
1642 the message is being retained. */
1644 addr->next = addr_defer;
1648 /* Don't put the address on the nonrecipients tree yet; wait until an
1649 error message has been successfully sent. */
1653 addr->next = addr_failed;
1657 failure_log(addr, driver_name ? NULL : driver_kind, now);
1660 /* Ensure logging is turned on again in all cases */
1662 disable_logging = FALSE;
1668 /*************************************************
1669 * Address-independent error *
1670 *************************************************/
1672 /* This function is called when there's an error that is not dependent on a
1673 particular address, such as an expansion string failure. It puts the error into
1674 all the addresses in a batch, logs the incident on the main and panic logs, and
1675 clears the expansions. It is mostly called from local_deliver(), but can be
1676 called for a remote delivery via findugid().
1679 logit TRUE if (MAIN+PANIC) logging required
1680 addr the first of the chain of addresses
1682 format format string for error message, or NULL if already set in addr
1683 ... arguments for the format
1689 common_error(BOOL logit, address_item *addr, int code, uschar *format, ...)
1691 address_item *addr2;
1692 addr->basic_errno = code;
1698 va_start(ap, format);
1699 if (!string_vformat(buffer, sizeof(buffer), CS format, ap))
1700 log_write(0, LOG_MAIN|LOG_PANIC_DIE,
1701 "common_error expansion was longer than " SIZE_T_FMT, sizeof(buffer));
1703 addr->message = string_copy(buffer);
1706 for (addr2 = addr->next; addr2; addr2 = addr2->next)
1708 addr2->basic_errno = code;
1709 addr2->message = addr->message;
1712 if (logit) log_write(0, LOG_MAIN|LOG_PANIC, "%s", addr->message);
1713 deliver_set_expansions(NULL);
1719 /*************************************************
1720 * Check a "never users" list *
1721 *************************************************/
1723 /* This function is called to check whether a uid is on one of the two "never
1727 uid the uid to be checked
1728 nusers the list to be scanned; the first item in the list is the count
1730 Returns: TRUE if the uid is on the list
1734 check_never_users(uid_t uid, uid_t *nusers)
1737 if (!nusers) return FALSE;
1738 for (i = 1; i <= (int)(nusers[0]); i++) if (nusers[i] == uid) return TRUE;
1744 /*************************************************
1745 * Find uid and gid for a transport *
1746 *************************************************/
1748 /* This function is called for both local and remote deliveries, to find the
1749 uid/gid under which to run the delivery. The values are taken preferentially
1750 from the transport (either explicit or deliver_as_creator), then from the
1751 address (i.e. the router), and if nothing is set, the exim uid/gid are used. If
1752 the resulting uid is on the "never_users" or the "fixed_never_users" list, a
1753 panic error is logged, and the function fails (which normally leads to delivery
1757 addr the address (possibly a chain)
1759 uidp pointer to uid field
1760 gidp pointer to gid field
1761 igfp pointer to the use_initgroups field
1763 Returns: FALSE if failed - error has been set in address(es)
1767 findugid(address_item *addr, transport_instance *tp, uid_t *uidp, gid_t *gidp,
1771 BOOL gid_set = FALSE;
1773 /* Default initgroups flag comes from the transport */
1775 *igfp = tp->initgroups;
1777 /* First see if there's a gid on the transport, either fixed or expandable.
1778 The expanding function always logs failure itself. */
1785 else if (tp->expand_gid)
1787 if (!route_find_expanded_group(tp->expand_gid, tp->name, US"transport", gidp,
1790 common_error(FALSE, addr, ERRNO_GIDFAIL, NULL);
1796 /* If the transport did not set a group, see if the router did. */
1798 if (!gid_set && testflag(addr, af_gid_set))
1804 /* Pick up a uid from the transport if one is set. */
1806 if (tp->uid_set) *uidp = tp->uid;
1808 /* Otherwise, try for an expandable uid field. If it ends up as a numeric id,
1809 it does not provide a passwd value from which a gid can be taken. */
1811 else if (tp->expand_uid)
1814 if (!route_find_expanded_user(tp->expand_uid, tp->name, US"transport", &pw,
1815 uidp, &(addr->message)))
1817 common_error(FALSE, addr, ERRNO_UIDFAIL, NULL);
1827 /* If the transport doesn't set the uid, test the deliver_as_creator flag. */
1829 else if (tp->deliver_as_creator)
1831 *uidp = originator_uid;
1834 *gidp = originator_gid;
1839 /* Otherwise see if the address specifies the uid and if so, take it and its
1842 else if (testflag(addr, af_uid_set))
1845 *igfp = testflag(addr, af_initgroups);
1848 /* Nothing has specified the uid - default to the Exim user, and group if the
1861 /* If no gid is set, it is a disaster. We default to the Exim gid only if
1862 defaulting to the Exim uid. In other words, if the configuration has specified
1863 a uid, it must also provide a gid. */
1867 common_error(TRUE, addr, ERRNO_GIDFAIL, US"User set without group for "
1868 "%s transport", tp->name);
1872 /* Check that the uid is not on the lists of banned uids that may not be used
1873 for delivery processes. */
1875 nuname = check_never_users(*uidp, never_users)
1877 : check_never_users(*uidp, fixed_never_users)
1878 ? US"fixed_never_users"
1882 common_error(TRUE, addr, ERRNO_UIDFAIL, US"User %ld set for %s transport "
1883 "is on the %s list", (long int)(*uidp), tp->name, nuname);
1895 /*************************************************
1896 * Check the size of a message for a transport *
1897 *************************************************/
1899 /* Checks that the message isn't too big for the selected transport.
1900 This is called only when it is known that the limit is set.
1904 addr the (first) address being delivered
1907 DEFER expansion failed or did not yield an integer
1908 FAIL message too big
1912 check_message_size(transport_instance *tp, address_item *addr)
1917 deliver_set_expansions(addr);
1918 size_limit = expand_string_integer(tp->message_size_limit, TRUE);
1919 deliver_set_expansions(NULL);
1921 if (expand_string_message)
1924 addr->message = size_limit == -1
1925 ? string_sprintf("failed to expand message_size_limit "
1926 "in %s transport: %s", tp->name, expand_string_message)
1927 : string_sprintf("invalid message_size_limit "
1928 "in %s transport: %s", tp->name, expand_string_message);
1930 else if (size_limit > 0 && message_size > size_limit)
1934 string_sprintf("message is too big (transport limit = %d)",
1943 /*************************************************
1944 * Transport-time check for a previous delivery *
1945 *************************************************/
1947 /* Check that this base address hasn't previously been delivered to its routed
1948 transport. If it has been delivered, mark it done. The check is necessary at
1949 delivery time in order to handle homonymic addresses correctly in cases where
1950 the pattern of redirection changes between delivery attempts (so the unique
1951 fields change). Non-homonymic previous delivery is detected earlier, at routing
1952 time (which saves unnecessary routing).
1955 addr the address item
1956 testing TRUE if testing wanted only, without side effects
1958 Returns: TRUE if previously delivered by the transport
1962 previously_transported(address_item *addr, BOOL testing)
1964 (void)string_format(big_buffer, big_buffer_size, "%s/%s",
1965 addr->unique + (testflag(addr, af_homonym)? 3:0), addr->transport->name);
1967 if (tree_search(tree_nonrecipients, big_buffer) != 0)
1969 DEBUG(D_deliver|D_route|D_transport)
1970 debug_printf("%s was previously delivered (%s transport): discarded\n",
1971 addr->address, addr->transport->name);
1972 if (!testing) child_done(addr, tod_stamp(tod_log));
1981 /******************************************************
1982 * Check for a given header in a header string *
1983 ******************************************************/
1985 /* This function is used when generating quota warnings. The configuration may
1986 specify any header lines it likes in quota_warn_message. If certain of them are
1987 missing, defaults are inserted, so we need to be able to test for the presence
1991 hdr the required header name
1992 hstring the header string
1994 Returns: TRUE the header is in the string
1995 FALSE the header is not in the string
1999 contains_header(uschar *hdr, uschar *hstring)
2001 int len = Ustrlen(hdr);
2002 uschar *p = hstring;
2005 if (strncmpic(p, hdr, len) == 0)
2008 while (*p == ' ' || *p == '\t') p++;
2009 if (*p == ':') return TRUE;
2011 while (*p != 0 && *p != '\n') p++;
2012 if (*p == '\n') p++;
2020 /*************************************************
2021 * Perform a local delivery *
2022 *************************************************/
2024 /* Each local delivery is performed in a separate process which sets its
2025 uid and gid as specified. This is a safer way than simply changing and
2026 restoring using seteuid(); there is a body of opinion that seteuid() cannot be
2027 used safely. From release 4, Exim no longer makes any use of it. Besides, not
2028 all systems have seteuid().
2030 If the uid/gid are specified in the transport_instance, they are used; the
2031 transport initialization must ensure that either both or neither are set.
2032 Otherwise, the values associated with the address are used. If neither are set,
2033 it is a configuration error.
2035 The transport or the address may specify a home directory (transport over-
2036 rides), and if they do, this is set as $home. If neither have set a working
2037 directory, this value is used for that as well. Otherwise $home is left unset
2038 and the cwd is set to "/" - a directory that should be accessible to all users.
2040 Using a separate process makes it more complicated to get error information
2041 back. We use a pipe to pass the return code and also an error code and error
2042 text string back to the parent process.
2045 addr points to an address block for this delivery; for "normal" local
2046 deliveries this is the only address to be delivered, but for
2047 pseudo-remote deliveries (e.g. by batch SMTP to a file or pipe)
2048 a number of addresses can be handled simultaneously, and in this
2049 case addr will point to a chain of addresses with the same
2052 shadowing TRUE if running a shadow transport; this causes output from pipes
2059 deliver_local(address_item *addr, BOOL shadowing)
2061 BOOL use_initgroups;
2064 int status, len, rc;
2067 uschar *working_directory;
2068 address_item *addr2;
2069 transport_instance *tp = addr->transport;
2071 /* Set up the return path from the errors or sender address. If the transport
2072 has its own return path setting, expand it and replace the existing value. */
2074 if(addr->prop.errors_address)
2075 return_path = addr->prop.errors_address;
2076 #ifdef EXPERIMENTAL_SRS
2077 else if (addr->prop.srs_sender)
2078 return_path = addr->prop.srs_sender;
2081 return_path = sender_address;
2083 if (tp->return_path)
2085 uschar *new_return_path = expand_string(tp->return_path);
2086 if (!new_return_path)
2088 if (!expand_string_forcedfail)
2090 common_error(TRUE, addr, ERRNO_EXPANDFAIL,
2091 US"Failed to expand return path \"%s\" in %s transport: %s",
2092 tp->return_path, tp->name, expand_string_message);
2096 else return_path = new_return_path;
2099 /* For local deliveries, one at a time, the value used for logging can just be
2100 set directly, once and for all. */
2102 used_return_path = return_path;
2104 /* Sort out the uid, gid, and initgroups flag. If an error occurs, the message
2105 gets put into the address(es), and the expansions are unset, so we can just
2108 if (!findugid(addr, tp, &uid, &gid, &use_initgroups)) return;
2110 /* See if either the transport or the address specifies a home directory. A
2111 home directory set in the address may already be expanded; a flag is set to
2112 indicate that. In other cases we must expand it. */
2114 if ( (deliver_home = tp->home_dir) /* Set in transport, or */
2115 || ( (deliver_home = addr->home_dir) /* Set in address and */
2116 && !testflag(addr, af_home_expanded) /* not expanded */
2119 uschar *rawhome = deliver_home;
2120 deliver_home = NULL; /* in case it contains $home */
2121 if (!(deliver_home = expand_string(rawhome)))
2123 common_error(TRUE, addr, ERRNO_EXPANDFAIL, US"home directory \"%s\" failed "
2124 "to expand for %s transport: %s", rawhome, tp->name,
2125 expand_string_message);
2128 if (*deliver_home != '/')
2130 common_error(TRUE, addr, ERRNO_NOTABSOLUTE, US"home directory path \"%s\" "
2131 "is not absolute for %s transport", deliver_home, tp->name);
2136 /* See if either the transport or the address specifies a current directory,
2137 and if so, expand it. If nothing is set, use the home directory, unless it is
2138 also unset in which case use "/", which is assumed to be a directory to which
2139 all users have access. It is necessary to be in a visible directory for some
2140 operating systems when running pipes, as some commands (e.g. "rm" under Solaris
2141 2.5) require this. */
2143 working_directory = tp->current_dir ? tp->current_dir : addr->current_dir;
2144 if (working_directory)
2146 uschar *raw = working_directory;
2147 if (!(working_directory = expand_string(raw)))
2149 common_error(TRUE, addr, ERRNO_EXPANDFAIL, US"current directory \"%s\" "
2150 "failed to expand for %s transport: %s", raw, tp->name,
2151 expand_string_message);
2154 if (*working_directory != '/')
2156 common_error(TRUE, addr, ERRNO_NOTABSOLUTE, US"current directory path "
2157 "\"%s\" is not absolute for %s transport", working_directory, tp->name);
2161 else working_directory = deliver_home ? deliver_home : US"/";
2163 /* If one of the return_output flags is set on the transport, create and open a
2164 file in the message log directory for the transport to write its output onto.
2165 This is mainly used by pipe transports. The file needs to be unique to the
2166 address. This feature is not available for shadow transports. */
2169 && ( tp->return_output || tp->return_fail_output
2170 || tp->log_output || tp->log_fail_output || tp->log_defer_output
2175 addr->return_filename =
2176 spool_fname(US"msglog", message_subdir, message_id,
2177 string_sprintf("-%d-%d", getpid(), return_count++));
2179 if ((addr->return_file = open_msglog_file(addr->return_filename, 0400, &error)) < 0)
2181 common_error(TRUE, addr, errno, US"Unable to %s file for %s transport "
2182 "to return message: %s", error, tp->name, strerror(errno));
2187 /* Create the pipe for inter-process communication. */
2191 common_error(TRUE, addr, ERRNO_PIPEFAIL, US"Creation of pipe failed: %s",
2196 /* Now fork the process to do the real work in the subprocess, but first
2197 ensure that all cached resources are freed so that the subprocess starts with
2198 a clean slate and doesn't interfere with the parent process. */
2202 if ((pid = fork()) == 0)
2204 BOOL replicate = TRUE;
2206 /* Prevent core dumps, as we don't want them in users' home directories.
2207 HP-UX doesn't have RLIMIT_CORE; I don't know how to do this in that
2208 system. Some experimental/developing systems (e.g. GNU/Hurd) may define
2209 RLIMIT_CORE but not support it in setrlimit(). For such systems, do not
2210 complain if the error is "not supported".
2212 There are two scenarios where changing the max limit has an effect. In one,
2213 the user is using a .forward and invoking a command of their choice via pipe;
2214 for these, we do need the max limit to be 0 unless the admin chooses to
2215 permit an increased limit. In the other, the command is invoked directly by
2216 the transport and is under administrator control, thus being able to raise
2217 the limit aids in debugging. So there's no general always-right answer.
2219 Thus we inhibit core-dumps completely but let individual transports, while
2220 still root, re-raise the limits back up to aid debugging. We make the
2221 default be no core-dumps -- few enough people can use core dumps in
2222 diagnosis that it's reasonable to make them something that has to be explicitly requested.
2229 if (setrlimit(RLIMIT_CORE, &rl) < 0)
2231 # ifdef SETRLIMIT_NOT_SUPPORTED
2232 if (errno != ENOSYS && errno != ENOTSUP)
2234 log_write(0, LOG_MAIN|LOG_PANIC, "setrlimit(RLIMIT_CORE) failed: %s",
2239 /* Reset the random number generator, so different processes don't all
2240 have the same sequence. */
2244 /* If the transport has a setup entry, call this first, while still
2245 privileged. (Appendfile uses this to expand quota, for example, while
2246 able to read private files.) */
2248 if (addr->transport->setup)
2249 switch((addr->transport->setup)(addr->transport, addr, NULL, uid, gid,
2253 addr->transport_return = DEFER;
2257 addr->transport_return = PANIC;
2261 /* Ignore SIGINT and SIGTERM during delivery. Also ignore SIGUSR1, as
2262 when the process becomes unprivileged, it won't be able to write to the
2263 process log. SIGHUP is ignored throughout exim, except when it is being
2266 signal(SIGINT, SIG_IGN);
2267 signal(SIGTERM, SIG_IGN);
2268 signal(SIGUSR1, SIG_IGN);
2270 /* Close the unwanted half of the pipe, and set close-on-exec for the other
2271 half - for transports that exec things (e.g. pipe). Then set the required
2274 (void)close(pfd[pipe_read]);
2275 (void)fcntl(pfd[pipe_write], F_SETFD, fcntl(pfd[pipe_write], F_GETFD) |
2277 exim_setugid(uid, gid, use_initgroups,
2278 string_sprintf("local delivery to %s <%s> transport=%s", addr->local_part,
2279 addr->address, addr->transport->name));
2283 address_item *batched;
2284 debug_printf(" home=%s current=%s\n", deliver_home, working_directory);
2285 for (batched = addr->next; batched; batched = batched->next)
2286 debug_printf("additional batched address: %s\n", batched->address);
2289 /* Set an appropriate working directory. */
2291 if (Uchdir(working_directory) < 0)
2293 addr->transport_return = DEFER;
2294 addr->basic_errno = errno;
2295 addr->message = string_sprintf("failed to chdir to %s", working_directory);
2298 /* If successful, call the transport */
2303 set_process_info("delivering %s to %s using %s", message_id,
2304 addr->local_part, addr->transport->name);
2306 /* Setting this global in the subprocess means we need never clear it */
2307 transport_name = addr->transport->name;
2309 /* If a transport filter has been specified, set up its argument list.
2310 Any errors will get put into the address, and FALSE yielded. */
2312 if (addr->transport->filter_command)
2314 ok = transport_set_up_command(&transport_filter_argv,
2315 addr->transport->filter_command,
2316 TRUE, PANIC, addr, US"transport filter", NULL);
2317 transport_filter_timeout = addr->transport->filter_timeout;
2319 else transport_filter_argv = NULL;
2323 debug_print_string(addr->transport->debug_string);
2324 replicate = !(addr->transport->info->code)(addr->transport, addr);
2328 /* Pass the results back down the pipe. If necessary, first replicate the
2329 status in the top address to the others in the batch. The label is the
2330 subject of a goto when a call to the transport's setup function fails. We
2331 pass the pointer to the transport back in case it got changed as a result of
2332 file_format in appendfile. */
2336 if (replicate) replicate_status(addr);
2337 for (addr2 = addr; addr2; addr2 = addr2->next)
2340 int local_part_length = Ustrlen(addr2->local_part);
2344 if( (ret = write(pfd[pipe_write], &addr2->transport_return, sizeof(int))) != sizeof(int)
2345 || (ret = write(pfd[pipe_write], &transport_count, sizeof(transport_count))) != sizeof(transport_count)
2346 || (ret = write(pfd[pipe_write], &addr2->flags, sizeof(addr2->flags))) != sizeof(addr2->flags)
2347 || (ret = write(pfd[pipe_write], &addr2->basic_errno, sizeof(int))) != sizeof(int)
2348 || (ret = write(pfd[pipe_write], &addr2->more_errno, sizeof(int))) != sizeof(int)
2349 || (ret = write(pfd[pipe_write], &addr2->special_action, sizeof(int))) != sizeof(int)
2350 || (ret = write(pfd[pipe_write], &addr2->transport,
2351 sizeof(transport_instance *))) != sizeof(transport_instance *)
2353 /* For a file delivery, pass back the local part, in case the original
2354 was only part of the final delivery path. This gives more complete
2357 || (testflag(addr2, af_file)
2358 && ( (ret = write(pfd[pipe_write], &local_part_length, sizeof(int))) != sizeof(int)
2359 || (ret = write(pfd[pipe_write], addr2->local_part, local_part_length)) != local_part_length
2363 log_write(0, LOG_MAIN|LOG_PANIC, "Failed writing transport results to pipe: %s",
2364 ret == -1 ? strerror(errno) : "short write");
2366 /* Now any messages */
2368 for (i = 0, s = addr2->message; i < 2; i++, s = addr2->user_message)
2370 int message_length = s ? Ustrlen(s) + 1 : 0;
2371 if( (ret = write(pfd[pipe_write], &message_length, sizeof(int))) != sizeof(int)
2372 || message_length > 0 && (ret = write(pfd[pipe_write], s, message_length)) != message_length
2374 log_write(0, LOG_MAIN|LOG_PANIC, "Failed writing transport results to pipe: %s",
2375 ret == -1 ? strerror(errno) : "short write");
2379 /* OK, this process is now done. Free any cached resources that it opened,
2380 and close the pipe we were writing down before exiting. */
2382 (void)close(pfd[pipe_write]);
2387 /* Back in the main process: panic if the fork did not succeed. This seems
2388 better than returning an error - if forking is failing it is probably best
2389 not to try other deliveries for this message. */
2392 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Fork failed for local delivery to %s",
2395 /* Read the pipe to get the delivery status codes and error messages. Our copy
2396 of the writing end must be closed first, as otherwise read() won't return zero
2397 on an empty pipe. We check that a status exists for each address before
2398 overwriting the address structure. If data is missing, the default DEFER status
2399 will remain. Afterwards, close the reading end. */
2401 (void)close(pfd[pipe_write]);
2403 for (addr2 = addr; addr2; addr2 = addr2->next)
2405 if ((len = read(pfd[pipe_read], &status, sizeof(int))) > 0)
2410 addr2->transport_return = status;
2411 len = read(pfd[pipe_read], &transport_count,
2412 sizeof(transport_count));
2413 len = read(pfd[pipe_read], &addr2->flags, sizeof(addr2->flags));
2414 len = read(pfd[pipe_read], &addr2->basic_errno, sizeof(int));
2415 len = read(pfd[pipe_read], &addr2->more_errno, sizeof(int));
2416 len = read(pfd[pipe_read], &addr2->special_action, sizeof(int));
2417 len = read(pfd[pipe_read], &addr2->transport,
2418 sizeof(transport_instance *));
2420 if (testflag(addr2, af_file))
2423 if ( read(pfd[pipe_read], &llen, sizeof(int)) != sizeof(int)
2424 || llen > 64*4 /* limit from rfc 5821, times I18N factor */
2427 log_write(0, LOG_MAIN|LOG_PANIC, "bad local_part length read"
2428 " from delivery subprocess");
2431 /* sanity-checked llen so disable the Coverity error */
2432 /* coverity[tainted_data] */
2433 if (read(pfd[pipe_read], big_buffer, llen) != llen)
2435 log_write(0, LOG_MAIN|LOG_PANIC, "bad local_part read"
2436 " from delivery subprocess");
2439 big_buffer[llen] = 0;
2440 addr2->local_part = string_copy(big_buffer);
2443 for (i = 0, sptr = &addr2->message; i < 2; i++, sptr = &addr2->user_message)
2446 len = read(pfd[pipe_read], &message_length, sizeof(int));
2447 if (message_length > 0)
2449 len = read(pfd[pipe_read], big_buffer, message_length);
2450 big_buffer[big_buffer_size-1] = '\0'; /* guard byte */
2451 if (len > 0) *sptr = string_copy(big_buffer);
2458 log_write(0, LOG_MAIN|LOG_PANIC, "failed to read delivery status for %s "
2459 "from delivery subprocess", addr2->unique);
2464 (void)close(pfd[pipe_read]);
2466 /* Unless shadowing, write all successful addresses immediately to the journal
2467 file, to ensure they are recorded asap. For homonymic addresses, use the base
2468 address plus the transport name. Failure to write the journal is panic-worthy,
2469 but don't stop, as it may prove possible subsequently to update the spool file
2470 in order to record the delivery. */
2474 for (addr2 = addr; addr2; addr2 = addr2->next)
2475 if (addr2->transport_return == OK)
2477 if (testflag(addr2, af_homonym))
2478 sprintf(CS big_buffer, "%.500s/%s\n", addr2->unique + 3, tp->name);
2480 sprintf(CS big_buffer, "%.500s\n", addr2->unique);
2482 /* In the test harness, wait just a bit to let the subprocess finish off
2483 any debug output etc first. */
2485 if (running_in_test_harness) millisleep(300);
2487 DEBUG(D_deliver) debug_printf("journalling %s", big_buffer);
2488 len = Ustrlen(big_buffer);
2489 if (write(journal_fd, big_buffer, len) != len)
2490 log_write(0, LOG_MAIN|LOG_PANIC, "failed to update journal for %s: %s",
2491 big_buffer, strerror(errno));
2494 /* Ensure the journal file is pushed out to disk. */
2496 if (EXIMfsync(journal_fd) < 0)
2497 log_write(0, LOG_MAIN|LOG_PANIC, "failed to fsync journal: %s",
2501 /* Wait for the process to finish. If it terminates with a non-zero code,
2502 freeze the message (except for SIGTERM, SIGKILL and SIGQUIT), but leave the
2503 status values of all the addresses as they are. Take care to handle the case
2504 when the subprocess doesn't seem to exist. This has been seen on one system
2505 when Exim was called from an MUA that set SIGCHLD to SIG_IGN. When that
2506 happens, wait() doesn't recognize the termination of child processes. Exim now
2507 resets SIGCHLD to SIG_DFL, but this code should still be robust. */
2509 while ((rc = wait(&status)) != pid)
2510 if (rc < 0 && errno == ECHILD) /* Process has vanished */
2512 log_write(0, LOG_MAIN, "%s transport process vanished unexpectedly",
2513 addr->transport->driver_name);
2518 if ((status & 0xffff) != 0)
2520 int msb = (status >> 8) & 255;
2521 int lsb = status & 255;
2522 int code = (msb == 0)? (lsb & 0x7f) : msb;
2523 if (msb != 0 || (code != SIGTERM && code != SIGKILL && code != SIGQUIT))
2524 addr->special_action = SPECIAL_FREEZE;
2525 log_write(0, LOG_MAIN|LOG_PANIC, "%s transport process returned non-zero "
2526 "status 0x%04x: %s %d",
2527 addr->transport->driver_name,
2529 msb == 0 ? "terminated by signal" : "exit code",
2533 /* If SPECIAL_WARN is set in the top address, send a warning message. */
2535 if (addr->special_action == SPECIAL_WARN && addr->transport->warn_message)
2538 uschar *warn_message;
2541 DEBUG(D_deliver) debug_printf("Warning message requested by transport\n");
2543 if (!(warn_message = expand_string(addr->transport->warn_message)))
2544 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand \"%s\" (warning "
2545 "message for %s transport): %s", addr->transport->warn_message,
2546 addr->transport->name, expand_string_message);
2548 else if ((pid = child_open_exim(&fd)) > 0)
2550 FILE *f = fdopen(fd, "wb");
2551 if (errors_reply_to && !contains_header(US"Reply-To", warn_message))
2552 fprintf(f, "Reply-To: %s\n", errors_reply_to);
2553 fprintf(f, "Auto-Submitted: auto-replied\n");
2554 if (!contains_header(US"From", warn_message))
2556 fprintf(f, "%s", CS warn_message);
2558 /* Close and wait for child process to complete, without a timeout. */
2561 (void)child_close(pid, 0);
2564 addr->special_action = SPECIAL_NONE;
2571 /* Check transport for the given concurrency limit. Return TRUE if over
2572 the limit (or an expansion failure), else FALSE and if there was a limit,
2573 the key for the hints database used for the concurrency count. */
2576 tpt_parallel_check(transport_instance * tp, address_item * addr, uschar ** key)
2578 unsigned max_parallel;
2580 if (!tp->max_parallel) return FALSE;
2582 max_parallel = (unsigned) expand_string_integer(tp->max_parallel, TRUE);
2583 if (expand_string_message)
2585 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand max_parallel option "
2586 "in %s transport (%s): %s", tp->name, addr->address,
2587 expand_string_message);
2591 if (max_parallel > 0)
2593 uschar * serialize_key = string_sprintf("tpt-serialize-%s", tp->name);
2594 if (!enq_start(serialize_key, max_parallel))
2596 address_item * next;
2598 debug_printf("skipping tpt %s because concurrency limit %u reached\n",
2599 tp->name, max_parallel);
2603 addr->message = US"concurrency limit reached for transport";
2604 addr->basic_errno = ERRNO_TRETRY;
2605 post_process_one(addr, DEFER, LOG_MAIN, DTYPE_TRANSPORT, 0);
2606 } while ((addr = next));
2609 *key = serialize_key;
2616 /*************************************************
2617 * Do local deliveries *
2618 *************************************************/
2620 /* This function processes the list of addresses in addr_local. True local
2621 deliveries are always done one address at a time. However, local deliveries can
2622 be batched up in some cases. Typically this is when writing batched SMTP output
2623 files for use by some external transport mechanism, or when running local
2624 deliveries over LMTP.
2631 do_local_deliveries(void)
2634 open_db *dbm_file = NULL;
2635 time_t now = time(NULL);
2637 /* Loop until we have exhausted the supply of local deliveries */
2641 time_t delivery_start;
2643 address_item *addr2, *addr3, *nextaddr;
2644 int logflags = LOG_MAIN;
2645 int logchar = dont_deliver? '*' : '=';
2646 transport_instance *tp;
2647 uschar * serialize_key = NULL;
2649 /* Pick the first undelivered address off the chain */
2651 address_item *addr = addr_local;
2652 addr_local = addr->next;
2655 DEBUG(D_deliver|D_transport)
2656 debug_printf("--------> %s <--------\n", addr->address);
2658 /* An internal disaster if there is no transport. Should not occur! */
2660 if (!(tp = addr->transport))
2662 logflags |= LOG_PANIC;
2663 disable_logging = FALSE; /* Jic */
2664 addr->message = addr->router
2665 ? string_sprintf("No transport set by %s router", addr->router->name)
2666 : string_sprintf("No transport set by system filter");
2667 post_process_one(addr, DEFER, logflags, DTYPE_TRANSPORT, 0);
2671 /* Check that this base address hasn't previously been delivered to this
2672 transport. The check is necessary at this point to handle homonymic addresses
2673 correctly in cases where the pattern of redirection changes between delivery
2674 attempts. Non-homonymic previous delivery is detected earlier, at routing
2677 if (previously_transported(addr, FALSE)) continue;
2679 /* There are weird cases where logging is disabled */
2681 disable_logging = tp->disable_logging;
2683 /* Check for batched addresses and possible amalgamation. Skip all the work
2684 if either batch_max <= 1 or there aren't any other addresses for local
2687 if (tp->batch_max > 1 && addr_local)
2689 int batch_count = 1;
2690 BOOL uses_dom = readconf_depends((driver_instance *)tp, US"domain");
2691 BOOL uses_lp = ( testflag(addr, af_pfr)
2692 && (testflag(addr, af_file) || addr->local_part[0] == '|')
2694 || readconf_depends((driver_instance *)tp, US"local_part");
2695 uschar *batch_id = NULL;
2696 address_item **anchor = &addr_local;
2697 address_item *last = addr;
2700 /* Expand the batch_id string for comparison with other addresses.
2701 Expansion failure suppresses batching. */
2705 deliver_set_expansions(addr);
2706 batch_id = expand_string(tp->batch_id);
2707 deliver_set_expansions(NULL);
2710 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand batch_id option "
2711 "in %s transport (%s): %s", tp->name, addr->address,
2712 expand_string_message);
2713 batch_count = tp->batch_max;
2717 /* Until we reach the batch_max limit, pick off addresses which have the
2718 same characteristics. These are:
2721 not previously delivered (see comment about 50 lines above)
2722 same local part if the transport's configuration contains $local_part
2723 or if this is a file or pipe delivery from a redirection
2724 same domain if the transport's configuration contains $domain
2726 same additional headers
2727 same headers to be removed
2728 same uid/gid for running the transport
2729 same first host if a host list is set
2732 while ((next = *anchor) && batch_count < tp->batch_max)
2735 tp == next->transport
2736 && !previously_transported(next, TRUE)
2737 && (addr->flags & (af_pfr|af_file)) == (next->flags & (af_pfr|af_file))
2738 && (!uses_lp || Ustrcmp(next->local_part, addr->local_part) == 0)
2739 && (!uses_dom || Ustrcmp(next->domain, addr->domain) == 0)
2740 && same_strings(next->prop.errors_address, addr->prop.errors_address)
2741 && same_headers(next->prop.extra_headers, addr->prop.extra_headers)
2742 && same_strings(next->prop.remove_headers, addr->prop.remove_headers)
2743 && same_ugid(tp, addr, next)
2744 && ( !addr->host_list && !next->host_list
2747 && Ustrcmp(addr->host_list->name, next->host_list->name) == 0
2750 /* If the transport has a batch_id setting, batch_id will be non-NULL
2751 from the expansion outside the loop. Expand for this address and compare.
2752 Expansion failure makes this address ineligible for batching. */
2757 address_item *save_nextnext = next->next;
2758 next->next = NULL; /* Expansion for a single address */
2759 deliver_set_expansions(next);
2760 next->next = save_nextnext;
2761 bid = expand_string(tp->batch_id);
2762 deliver_set_expansions(NULL);
2765 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand batch_id option "
2766 "in %s transport (%s): %s", tp->name, next->address,
2767 expand_string_message);
2770 else ok = (Ustrcmp(batch_id, bid) == 0);
2773 /* Take address into batch if OK. */
2777 *anchor = next->next; /* Include the address */
2783 else anchor = &next->next; /* Skip the address */
2787 /* We now have one or more addresses that can be delivered in a batch. Check
2788 whether the transport is prepared to accept a message of this size. If not,
2789 fail them all forthwith. If the expansion fails, or does not yield an
2790 integer, defer delivery. */
2792 if (tp->message_size_limit)
2794 int rc = check_message_size(tp, addr);
2797 replicate_status(addr);
2801 post_process_one(addr, rc, logflags, DTYPE_TRANSPORT, 0);
2804 continue; /* With next batch of addresses */
2808 /* If we are not running the queue, or if forcing, all deliveries will be
2809 attempted. Otherwise, we must respect the retry times for each address. Even
2810 when not doing this, we need to set up the retry key string, and determine
2811 whether a retry record exists, because after a successful delivery, a delete
2812 retry item must be set up. Keep the retry database open only for the duration
2813 of these checks, rather than for all local deliveries, because some local
2814 deliveries (e.g. to pipes) can take a substantial time. */
2816 if (!(dbm_file = dbfn_open(US"retry", O_RDONLY, &dbblock, FALSE)))
2818 DEBUG(D_deliver|D_retry|D_hints_lookup)
2819 debug_printf("no retry data available\n");
2826 BOOL ok = TRUE; /* to deliver this address */
2829 /* Set up the retry key to include the domain or not, and change its
2830 leading character from "R" to "T". Must make a copy before doing this,
2831 because the old key may be pointed to from a "delete" retry item after
2834 retry_key = string_copy(
2835 tp->retry_use_local_part ? addr2->address_retry_key :
2836 addr2->domain_retry_key);
2839 /* Inspect the retry data. If there is no hints file, delivery happens. */
2843 dbdata_retry *retry_record = dbfn_read(dbm_file, retry_key);
2845 /* If there is no retry record, delivery happens. If there is,
2846 remember it exists so it can be deleted after a successful delivery. */
2850 setflag(addr2, af_lt_retry_exists);
2852 /* A retry record exists for this address. If queue running and not
2853 forcing, inspect its contents. If the record is too old, or if its
2854 retry time has come, or if it has passed its cutoff time, delivery
2859 debug_printf("retry record exists: age=%s ",
2860 readconf_printtime(now - retry_record->time_stamp));
2861 debug_printf("(max %s)\n", readconf_printtime(retry_data_expire));
2862 debug_printf(" time to retry = %s expired = %d\n",
2863 readconf_printtime(retry_record->next_try - now),
2864 retry_record->expired);
2867 if (queue_running && !deliver_force)
2869 ok = (now - retry_record->time_stamp > retry_data_expire)
2870 || (now >= retry_record->next_try)
2871 || retry_record->expired;
2873 /* If we haven't reached the retry time, there is one more check
2874 to do, which is for the ultimate address timeout. */
2877 ok = retry_ultimate_address_timeout(retry_key, addr2->domain,
2881 else DEBUG(D_retry) debug_printf("no retry record exists\n");
2884 /* This address is to be delivered. Leave it on the chain. */
2889 addr2 = addr2->next;
2892 /* This address is to be deferred. Take it out of the chain, and
2893 post-process it as complete. Must take it out of the chain first,
2894 because post processing puts it on another chain. */
2898 address_item *this = addr2;
2899 this->message = US"Retry time not yet reached";
2900 this->basic_errno = ERRNO_LRETRY;
2901 addr2 = addr3 ? (addr3->next = addr2->next)
2902 : (addr = addr2->next);
2903 post_process_one(this, DEFER, logflags, DTYPE_TRANSPORT, 0);
2907 if (dbm_file) dbfn_close(dbm_file);
2909 /* If there are no addresses left on the chain, they all deferred. Loop
2910 for the next set of addresses. */
2912 if (!addr) continue;
2914 /* If the transport is limited for parallellism, enforce that here.
2915 We use a hints DB entry, incremented here and decremented after
2916 the transport (and any shadow transport) completes. */
2918 if (tpt_parallel_check(tp, addr, &serialize_key))
2920 if (expand_string_message)
2922 logflags |= LOG_PANIC;
2926 post_process_one(addr, DEFER, logflags, DTYPE_TRANSPORT, 0);
2927 } while ((addr = addr2));
2929 continue; /* Loop for the next set of addresses. */
2933 /* So, finally, we do have some addresses that can be passed to the
2934 transport. Before doing so, set up variables that are relevant to a
2937 deliver_set_expansions(addr);
2938 delivery_start = time(NULL);
2939 deliver_local(addr, FALSE);
2940 deliver_time = (int)(time(NULL) - delivery_start);
2942 /* If a shadow transport (which must perforce be another local transport), is
2943 defined, and its condition is met, we must pass the message to the shadow
2944 too, but only those addresses that succeeded. We do this by making a new
2945 chain of addresses - also to keep the original chain uncontaminated. We must
2946 use a chain rather than doing it one by one, because the shadow transport may
2949 NOTE: if the condition fails because of a lookup defer, there is nothing we
2953 && ( !tp->shadow_condition
2954 || expand_check_condition(tp->shadow_condition, tp->name, US"transport")
2957 transport_instance *stp;
2958 address_item *shadow_addr = NULL;
2959 address_item **last = &shadow_addr;
2961 for (stp = transports; stp; stp = stp->next)
2962 if (Ustrcmp(stp->name, tp->shadow) == 0) break;
2965 log_write(0, LOG_MAIN|LOG_PANIC, "shadow transport \"%s\" not found ",
2968 /* Pick off the addresses that have succeeded, and make clones. Put into
2969 the shadow_message field a pointer to the shadow_message field of the real
2972 else for (addr2 = addr; addr2; addr2 = addr2->next)
2973 if (addr2->transport_return == OK)
2975 addr3 = store_get(sizeof(address_item));
2978 addr3->shadow_message = US &addr2->shadow_message;
2979 addr3->transport = stp;
2980 addr3->transport_return = DEFER;
2981 addr3->return_filename = NULL;
2982 addr3->return_file = -1;
2984 last = &addr3->next;
2987 /* If we found any addresses to shadow, run the delivery, and stick any
2988 message back into the shadow_message field in the original. */
2992 int save_count = transport_count;
2994 DEBUG(D_deliver|D_transport)
2995 debug_printf(">>>>>>>>>>>>>>>> Shadow delivery >>>>>>>>>>>>>>>>\n");
2996 deliver_local(shadow_addr, TRUE);
2998 for(; shadow_addr; shadow_addr = shadow_addr->next)
3000 int sresult = shadow_addr->transport_return;
3001 *(uschar **)shadow_addr->shadow_message =
3003 ? string_sprintf(" ST=%s", stp->name)
3004 : string_sprintf(" ST=%s (%s%s%s)", stp->name,
3005 shadow_addr->basic_errno <= 0
3007 : US strerror(shadow_addr->basic_errno),
3008 shadow_addr->basic_errno <= 0 || !shadow_addr->message
3011 shadow_addr->message
3012 ? shadow_addr->message
3013 : shadow_addr->basic_errno <= 0
3017 DEBUG(D_deliver|D_transport)
3018 debug_printf("%s shadow transport returned %s for %s\n",
3020 sresult == OK ? "OK" :
3021 sresult == DEFER ? "DEFER" :
3022 sresult == FAIL ? "FAIL" :
3023 sresult == PANIC ? "PANIC" : "?",
3024 shadow_addr->address);
3027 DEBUG(D_deliver|D_transport)
3028 debug_printf(">>>>>>>>>>>>>>>> End shadow delivery >>>>>>>>>>>>>>>>\n");
3030 transport_count = save_count; /* Restore original transport count */
3034 /* Cancel the expansions that were set up for the delivery. */
3036 deliver_set_expansions(NULL);
3038 /* If the transport was parallelism-limited, decrement the hints DB record. */
3040 if (serialize_key) enq_end(serialize_key);
3042 /* Now we can process the results of the real transport. We must take each
3043 address off the chain first, because post_process_one() puts it on another
3046 for (addr2 = addr; addr2; addr2 = nextaddr)
3048 int result = addr2->transport_return;
3049 nextaddr = addr2->next;
3051 DEBUG(D_deliver|D_transport)
3052 debug_printf("%s transport returned %s for %s\n",
3054 result == OK ? "OK" :
3055 result == DEFER ? "DEFER" :
3056 result == FAIL ? "FAIL" :
3057 result == PANIC ? "PANIC" : "?",
3060 /* If there is a retry_record, or if delivery is deferred, build a retry
3061 item for setting a new retry time or deleting the old retry record from
3062 the database. These items are handled all together after all addresses
3063 have been handled (so the database is open just for a short time for
3066 if (result == DEFER || testflag(addr2, af_lt_retry_exists))
3068 int flags = result == DEFER ? 0 : rf_delete;
3069 uschar *retry_key = string_copy(tp->retry_use_local_part
3070 ? addr2->address_retry_key : addr2->domain_retry_key);
3072 retry_add_item(addr2, retry_key, flags);
3075 /* Done with this address */
3077 if (result == OK) addr2->more_errno = deliver_time;
3078 post_process_one(addr2, result, logflags, DTYPE_TRANSPORT, logchar);
3080 /* If a pipe delivery generated text to be sent back, the result may be
3081 changed to FAIL, and we must copy this for subsequent addresses in the
3084 if (addr2->transport_return != result)
3086 for (addr3 = nextaddr; addr3; addr3 = addr3->next)
3088 addr3->transport_return = addr2->transport_return;
3089 addr3->basic_errno = addr2->basic_errno;
3090 addr3->message = addr2->message;
3092 result = addr2->transport_return;
3095 /* Whether or not the result was changed to FAIL, we need to copy the
3096 return_file value from the first address into all the addresses of the
3097 batch, so they are all listed in the error message. */
3099 addr2->return_file = addr->return_file;
3101 /* Change log character for recording successful deliveries. */
3103 if (result == OK) logchar = '-';
3105 } /* Loop back for next batch of addresses */
3111 /*************************************************
3112 * Sort remote deliveries *
3113 *************************************************/
3115 /* This function is called if remote_sort_domains is set. It arranges that the
3116 chain of addresses for remote deliveries is ordered according to the strings
3117 specified. Try to make this shuffling reasonably efficient by handling
3118 sequences of addresses rather than just single ones.
3125 sort_remote_deliveries(void)
3128 address_item **aptr = &addr_remote;
3129 const uschar *listptr = remote_sort_domains;
3134 && (pattern = string_nextinlist(&listptr, &sep, patbuf, sizeof(patbuf)))
3137 address_item *moved = NULL;
3138 address_item **bptr = &moved;
3142 address_item **next;
3143 deliver_domain = (*aptr)->domain; /* set $domain */
3144 if (match_isinlist(deliver_domain, (const uschar **)&pattern, UCHAR_MAX+1,
3145 &domainlist_anchor, NULL, MCL_DOMAIN, TRUE, NULL) == OK)
3147 aptr = &(*aptr)->next;
3151 next = &(*aptr)->next;
3153 && (deliver_domain = (*next)->domain, /* Set $domain */
3154 match_isinlist(deliver_domain, (const uschar **)&pattern, UCHAR_MAX+1,
3155 &domainlist_anchor, NULL, MCL_DOMAIN, TRUE, NULL)) != OK
3157 next = &(*next)->next;
3159 /* If the batch of non-matchers is at the end, add on any that were
3160 extracted further up the chain, and end this iteration. Otherwise,
3161 extract them from the chain and hang on the moved chain. */
3173 aptr = &(*aptr)->next;
3176 /* If the loop ended because the final address matched, *aptr will
3177 be NULL. Add on to the end any extracted non-matching addresses. If
3178 *aptr is not NULL, the loop ended via "break" when *next is null, that
3179 is, there was a string of non-matching addresses at the end. In this
3180 case the extracted addresses have already been added on the end. */
3182 if (!*aptr) *aptr = moved;
3188 debug_printf("remote addresses after sorting:\n");
3189 for (addr = addr_remote; addr; addr = addr->next)
3190 debug_printf(" %s\n", addr->address);
3196 /*************************************************
3197 * Read from pipe for remote delivery subprocess *
3198 *************************************************/
3200 /* This function is called when the subprocess is complete, but can also be
3201 called before it is complete, in order to empty a pipe that is full (to prevent
3202 deadlock). It must therefore keep track of its progress in the parlist data
3205 We read the pipe to get the delivery status codes and a possible error message
3206 for each address, optionally preceded by unusability data for the hosts and
3207 also by optional retry data.
3209 Read in large chunks into the big buffer and then scan through, interpreting
3210 the data therein. In most cases, only a single read will be necessary. No
3211 individual item will ever be anywhere near 2500 bytes in length, so by ensuring
3212 that we read the next chunk when there is less than 2500 bytes left in the
3213 non-final chunk, we can assume each item is complete in the buffer before
3214 handling it. Each item is written using a single write(), which is atomic for
3215 small items (less than PIPE_BUF, which seems to be at least 512 in any Unix and
3216 often bigger) so even if we are reading while the subprocess is still going, we
3217 should never have only a partial item in the buffer.
3220 poffset the offset of the parlist item
3221 eop TRUE if the process has completed
3223 Returns: TRUE if the terminating 'Z' item has been read,
3224 or there has been a disaster (i.e. no more data needed);
3229 par_read_pipe(int poffset, BOOL eop)
3232 pardata *p = parlist + poffset;
3233 address_item *addrlist = p->addrlist;
3234 address_item *addr = p->addr;
3237 uschar *endptr = big_buffer;
3238 uschar *ptr = endptr;
3239 uschar *msg = p->msg;
3240 BOOL done = p->done;
3241 BOOL finished = FALSE;
3242 /* minimum size to read is header size including id, subid and length */
3243 int required = PIPE_HEADER_SIZE;
3245 /* Loop through all items, reading from the pipe when necessary. The pipe
3246 is set up to be non-blocking, but there are two different Unix mechanisms in
3247 use. Exim uses O_NONBLOCK if it is defined. This returns 0 for end of file,
3248 and EAGAIN for no more data. If O_NONBLOCK is not defined, Exim uses O_NDELAY,
3249 which returns 0 for both end of file and no more data. We distinguish the
3250 two cases by taking 0 as end of file only when we know the process has
3253 Each separate item is written to the pipe in a single write(), and as they are
3254 all short items, the writes will all be atomic and we should never find
3255 ourselves in the position of having read an incomplete item. "Short" in this
3256 case can mean up to about 1K in the case when there is a long error message
3257 associated with an address. */
3259 DEBUG(D_deliver) debug_printf("reading pipe for subprocess %d (%s)\n",
3260 (int)p->pid, eop? "ended" : "not ended");
3264 retry_item *r, **rp;
3265 int remaining = endptr - ptr;
3266 uschar header[PIPE_HEADER_SIZE + 1];
3270 /* Read (first time) or top up the chars in the buffer if necessary.
3271 There will be only one read if we get all the available data (i.e. don't
3272 fill the buffer completely). */
3274 if (remaining < required && !finished)
3277 int available = big_buffer_size - remaining;
3279 if (remaining > 0) memmove(big_buffer, ptr, remaining);
3282 endptr = big_buffer + remaining;
3283 len = read(fd, endptr, available);
3285 DEBUG(D_deliver) debug_printf("read() yielded %d\n", len);
3287 /* If the result is EAGAIN and the process is not complete, just
3288 stop reading any more and process what we have already. */
3292 if (!eop && errno == EAGAIN) len = 0; else
3294 msg = string_sprintf("failed to read pipe from transport process "
3295 "%d for transport %s: %s", pid, addr->transport->driver_name,
3301 /* If the length is zero (eof or no-more-data), just process what we
3302 already have. Note that if the process is still running and we have
3303 read all the data in the pipe (but less that "available") then we
3304 won't read any more, as "finished" will get set. */
3308 finished = len != available;
3311 /* If we are at the end of the available data, exit the loop. */
3312 if (ptr >= endptr) break;
3314 /* copy and read header */
3315 memcpy(header, ptr, PIPE_HEADER_SIZE);
3316 header[PIPE_HEADER_SIZE] = '\0';
3319 required = Ustrtol(header + 2, &endc, 10) + PIPE_HEADER_SIZE; /* header + data */
3322 msg = string_sprintf("failed to read pipe from transport process "
3323 "%d for transport %s: error reading size from header", pid, addr->transport->driver_name);
3329 debug_printf("header read id:%c,subid:%c,size:%s,required:%d,remaining:%d,finished:%d\n",
3330 id, subid, header+2, required, remaining, finished);
3332 /* is there room for the dataset we want to read ? */
3333 if (required > big_buffer_size - PIPE_HEADER_SIZE)
3335 msg = string_sprintf("failed to read pipe from transport process "
3336 "%d for transport %s: big_buffer too small! required size=%d buffer size=%d", pid, addr->transport->driver_name,
3337 required, big_buffer_size - PIPE_HEADER_SIZE);
3342 /* We wrote all datasets with atomic write() calls. Remaining < required only
3343 happens if big_buffer was too small to get all available data from pipe;
3344 finished has to be false as well. */
3346 if (remaining < required)
3350 msg = string_sprintf("failed to read pipe from transport process "
3351 "%d for transport %s: required size=%d > remaining size=%d and finished=true",
3352 pid, addr->transport->driver_name, required, remaining);
3357 /* Step past the header */
3358 ptr += PIPE_HEADER_SIZE;
3360 /* Handle each possible type of item, assuming the complete item is
3361 available in store. */
3365 /* Host items exist only if any hosts were marked unusable. Match
3366 up by checking the IP address. */
3369 for (h = addrlist->host_list; h; h = h->next)
3371 if (!h->address || Ustrcmp(h->address, ptr+2) != 0) continue;
3379 /* Retry items are sent in a preceding R item for each address. This is
3380 kept separate to keep each message short enough to guarantee it won't
3381 be split in the pipe. Hopefully, in the majority of cases, there won't in
3382 fact be any retry items at all.
3384 The complete set of retry items might include an item to delete a
3385 routing retry if there was a previous routing delay. However, routing
3386 retries are also used when a remote transport identifies an address error.
3387 In that case, there may also be an "add" item for the same key. Arrange
3388 that a "delete" item is dropped in favour of an "add" item. */
3391 if (!addr) goto ADDR_MISMATCH;
3393 DEBUG(D_deliver|D_retry)
3394 debug_printf("reading retry information for %s from subprocess\n",
3397 /* Cut out any "delete" items on the list. */
3399 for (rp = &addr->retries; (r = *rp); rp = &r->next)
3400 if (Ustrcmp(r->key, ptr+1) == 0) /* Found item with same key */
3402 if ((r->flags & rf_delete) == 0) break; /* It was not "delete" */
3403 *rp = r->next; /* Excise a delete item */
3404 DEBUG(D_deliver|D_retry)
3405 debug_printf(" existing delete item dropped\n");
3408 /* We want to add a delete item only if there is no non-delete item;
3409 however we still have to step ptr through the data. */
3411 if (!r || !(*ptr & rf_delete))
3413 r = store_get(sizeof(retry_item));
3414 r->next = addr->retries;
3417 r->key = string_copy(ptr);
3419 memcpy(&(r->basic_errno), ptr, sizeof(r->basic_errno));
3420 ptr += sizeof(r->basic_errno);
3421 memcpy(&(r->more_errno), ptr, sizeof(r->more_errno));
3422 ptr += sizeof(r->more_errno);
3423 r->message = (*ptr)? string_copy(ptr) : NULL;
3424 DEBUG(D_deliver|D_retry)
3425 debug_printf(" added %s item\n",
3426 ((r->flags & rf_delete) == 0)? "retry" : "delete");
3431 DEBUG(D_deliver|D_retry)
3432 debug_printf(" delete item not added: non-delete item exists\n");
3435 ptr += sizeof(r->basic_errno) + sizeof(r->more_errno);
3441 /* Put the amount of data written into the parlist block */
3444 memcpy(&(p->transport_count), ptr, sizeof(transport_count));
3445 ptr += sizeof(transport_count);
3448 /* Address items are in the order of items on the address chain. We
3449 remember the current address value in case this function is called
3450 several times to empty the pipe in stages. Information about delivery
3451 over TLS is sent in a preceding X item for each address. We don't put
3452 it in with the other info, in order to keep each message short enough to
3453 guarantee it won't be split in the pipe. */
3457 if (!addr) goto ADDR_MISMATCH; /* Below, in 'A' handler */
3461 addr->cipher = NULL;
3462 addr->peerdn = NULL;
3465 addr->cipher = string_copy(ptr);
3468 addr->peerdn = string_copy(ptr);
3473 (void) tls_import_cert(ptr, &addr->peercert);
3475 addr->peercert = NULL;
3480 (void) tls_import_cert(ptr, &addr->ourcert);
3482 addr->ourcert = NULL;
3485 # ifndef DISABLE_OCSP
3487 addr->ocsp = *ptr ? *ptr - '0' : OCSP_NOT_REQ;
3493 #endif /*SUPPORT_TLS*/
3495 case 'C': /* client authenticator information */
3499 addr->authenticator = (*ptr)? string_copy(ptr) : NULL;
3502 addr->auth_id = (*ptr)? string_copy(ptr) : NULL;
3505 addr->auth_sndr = (*ptr)? string_copy(ptr) : NULL;
3511 #ifndef DISABLE_PRDR
3513 addr->flags |= af_prdr_used;
3518 addr->flags |= af_chunking_used;
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 addr->transport_return = *ptr++;
3568 addr->special_action = *ptr++;
3569 memcpy(&(addr->basic_errno), ptr, sizeof(addr->basic_errno));
3570 ptr += sizeof(addr->basic_errno);
3571 memcpy(&(addr->more_errno), ptr, sizeof(addr->more_errno));
3572 ptr += sizeof(addr->more_errno);
3573 memcpy(&(addr->flags), ptr, sizeof(addr->flags));
3574 ptr += sizeof(addr->flags);
3575 addr->message = (*ptr)? string_copy(ptr) : NULL;
3577 addr->user_message = (*ptr)? string_copy(ptr) : NULL;
3580 /* Always two strings for host information, followed by the port number and DNSSEC mark */
3584 h = store_get(sizeof(host_item));
3585 h->name = string_copy(ptr);
3587 h->address = string_copy(ptr);
3589 memcpy(&(h->port), ptr, sizeof(h->port));
3590 ptr += sizeof(h->port);
3591 h->dnssec = *ptr == '2' ? DS_YES
3592 : *ptr == '1' ? DS_NO
3595 addr->host_used = h;
3599 /* Finished with this address */
3606 /* Local interface address/port */
3608 if (*ptr) sending_ip_address = string_copy(ptr);
3610 if (*ptr) sending_port = atoi(CS ptr);
3614 /* Z marks the logical end of the data. It is followed by '0' if
3615 continue_transport was NULL at the end of transporting, otherwise '1'.
3616 We need to know when it becomes NULL during a delivery down a passed SMTP
3617 channel so that we don't try to pass anything more down it. Of course, for
3618 most normal messages it will remain NULL all the time. */
3623 continue_transport = NULL;
3624 continue_hostname = NULL;
3627 DEBUG(D_deliver) debug_printf("Z0%c item read\n", *ptr);
3630 /* Anything else is a disaster. */
3633 msg = string_sprintf("malformed data (%d) read from pipe for transport "
3634 "process %d for transport %s", ptr[-1], pid,
3635 addr->transport->driver_name);
3641 /* The done flag is inspected externally, to determine whether or not to
3642 call the function again when the process finishes. */
3646 /* If the process hadn't finished, and we haven't seen the end of the data
3647 or suffered a disaster, update the rest of the state, and return FALSE to
3648 indicate "not finished". */
3657 /* Close our end of the pipe, to prevent deadlock if the far end is still
3658 pushing stuff into it. */
3663 /* If we have finished without error, but haven't had data for every address,
3664 something is wrong. */
3667 msg = string_sprintf("insufficient address data read from pipe "
3668 "for transport process %d for transport %s", pid,
3669 addr->transport->driver_name);
3671 /* If an error message is set, something has gone wrong in getting back
3672 the delivery data. Put the message into each address and freeze it. */
3675 for (addr = addrlist; addr; addr = addr->next)
3677 addr->transport_return = DEFER;
3678 addr->special_action = SPECIAL_FREEZE;
3679 addr->message = msg;
3682 /* Return TRUE to indicate we have got all we need from this process, even
3683 if it hasn't actually finished yet. */
3690 /*************************************************
3691 * Post-process a set of remote addresses *
3692 *************************************************/
3694 /* Do what has to be done immediately after a remote delivery for each set of
3695 addresses, then re-write the spool if necessary. Note that post_process_one
3696 puts the address on an appropriate queue; hence we must fish off the next
3697 one first. This function is also called if there is a problem with setting
3698 up a subprocess to do a remote delivery in parallel. In this case, the final
3699 argument contains a message, and the action must be forced to DEFER.
3702 addr pointer to chain of address items
3703 logflags flags for logging
3704 msg NULL for normal cases; -> error message for unexpected problems
3705 fallback TRUE if processing fallback hosts
3711 remote_post_process(address_item *addr, int logflags, uschar *msg,
3716 /* If any host addresses were found to be unusable, add them to the unusable
3717 tree so that subsequent deliveries don't try them. */
3719 for (h = addr->host_list; h; h = h->next)
3721 if (h->status >= hstatus_unusable) tree_add_unusable(h);
3723 /* Now handle each address on the chain. The transport has placed '=' or '-'
3724 into the special_action field for each successful delivery. */
3728 address_item *next = addr->next;
3730 /* If msg == NULL (normal processing) and the result is DEFER and we are
3731 processing the main hosts and there are fallback hosts available, put the
3732 address on the list for fallback delivery. */
3734 if ( addr->transport_return == DEFER
3735 && addr->fallback_hosts
3740 addr->host_list = addr->fallback_hosts;
3741 addr->next = addr_fallback;
3742 addr_fallback = addr;
3743 DEBUG(D_deliver) debug_printf("%s queued for fallback host(s)\n", addr->address);
3746 /* If msg is set (=> unexpected problem), set it in the address before
3747 doing the ordinary post processing. */
3753 addr->message = msg;
3754 addr->transport_return = DEFER;
3756 (void)post_process_one(addr, addr->transport_return, logflags,
3757 DTYPE_TRANSPORT, addr->special_action);
3765 /* If we have just delivered down a passed SMTP channel, and that was
3766 the last address, the channel will have been closed down. Now that
3767 we have logged that delivery, set continue_sequence to 1 so that
3768 any subsequent deliveries don't get "*" incorrectly logged. */
3770 if (!continue_transport) continue_sequence = 1;
3775 /*************************************************
3776 * Wait for one remote delivery subprocess *
3777 *************************************************/
3779 /* This function is called while doing remote deliveries when either the
3780 maximum number of processes exist and we need one to complete so that another
3781 can be created, or when waiting for the last ones to complete. It must wait for
3782 the completion of one subprocess, empty the control block slot, and return a
3783 pointer to the address chain.
3786 Returns: pointer to the chain of addresses handled by the process;
3787 NULL if no subprocess found - this is an unexpected error
3790 static address_item *
3793 int poffset, status;
3794 address_item *addr, *addrlist;
3797 set_process_info("delivering %s: waiting for a remote delivery subprocess "
3798 "to finish", message_id);
3800 /* Loop until either a subprocess completes, or there are no subprocesses in
3801 existence - in which case give an error return. We cannot proceed just by
3802 waiting for a completion, because a subprocess may have filled up its pipe, and
3803 be waiting for it to be emptied. Therefore, if no processes have finished, we
3804 wait for one of the pipes to acquire some data by calling select(), with a
3805 timeout just in case.
3807 The simple approach is just to iterate after reading data from a ready pipe.
3808 This leads to non-ideal behaviour when the subprocess has written its final Z
3809 item, closed the pipe, and is in the process of exiting (the common case). A
3810 call to waitpid() yields nothing completed, but select() shows the pipe ready -
3811 reading it yields EOF, so you end up with busy-waiting until the subprocess has
3814 To avoid this, if all the data that is needed has been read from a subprocess
3815 after select(), an explicit wait() for it is done. We know that all it is doing
3816 is writing to the pipe and then exiting, so the wait should not be long.
3818 The non-blocking waitpid() is to some extent just insurance; if we could
3819 reliably detect end-of-file on the pipe, we could always know when to do a
3820 blocking wait() for a completed process. However, because some systems use
3821 NDELAY, which doesn't distinguish between EOF and pipe empty, it is easier to
3822 use code that functions without the need to recognize EOF.
3824 There's a double loop here just in case we end up with a process that is not in
3825 the list of remote delivery processes. Something has obviously gone wrong if
3826 this is the case. (For example, a process that is incorrectly left over from
3827 routing or local deliveries might be found.) The damage can be minimized by
3828 looping back and looking for another process. If there aren't any, the error
3829 return will happen. */
3831 for (;;) /* Normally we do not repeat this loop */
3833 while ((pid = waitpid(-1, &status, WNOHANG)) <= 0)
3836 fd_set select_pipes;
3837 int maxpipe, readycount;
3839 /* A return value of -1 can mean several things. If errno != ECHILD, it
3840 either means invalid options (which we discount), or that this process was
3841 interrupted by a signal. Just loop to try the waitpid() again.
3843 If errno == ECHILD, waitpid() is telling us that there are no subprocesses
3844 in existence. This should never happen, and is an unexpected error.
3845 However, there is a nasty complication when running under Linux. If "strace
3846 -f" is being used under Linux to trace this process and its children,
3847 subprocesses are "stolen" from their parents and become the children of the
3848 tracing process. A general wait such as the one we've just obeyed returns
3849 as if there are no children while subprocesses are running. Once a
3850 subprocess completes, it is restored to the parent, and waitpid(-1) finds
3851 it. Thanks to Joachim Wieland for finding all this out and suggesting a
3854 This does not happen using "truss" on Solaris, nor (I think) with other
3855 tracing facilities on other OS. It seems to be specific to Linux.
3857 What we do to get round this is to use kill() to see if any of our
3858 subprocesses are still in existence. If kill() gives an OK return, we know
3859 it must be for one of our processes - it can't be for a re-use of the pid,
3860 because if our process had finished, waitpid() would have found it. If any
3861 of our subprocesses are in existence, we proceed to use select() as if
3862 waitpid() had returned zero. I think this is safe. */
3866 if (errno != ECHILD) continue; /* Repeats the waitpid() */
3869 debug_printf("waitpid() returned -1/ECHILD: checking explicitly "
3870 "for process existence\n");
3872 for (poffset = 0; poffset < remote_max_parallel; poffset++)
3874 if ((pid = parlist[poffset].pid) != 0 && kill(pid, 0) == 0)
3876 DEBUG(D_deliver) debug_printf("process %d still exists: assume "
3877 "stolen by strace\n", (int)pid);
3878 break; /* With poffset set */
3882 if (poffset >= remote_max_parallel)
3884 DEBUG(D_deliver) debug_printf("*** no delivery children found\n");
3885 return NULL; /* This is the error return */
3889 /* A pid value greater than 0 breaks the "while" loop. A negative value has
3890 been handled above. A return value of zero means that there is at least one
3891 subprocess, but there are no completed subprocesses. See if any pipes are
3892 ready with any data for reading. */
3894 DEBUG(D_deliver) debug_printf("selecting on subprocess pipes\n");
3897 FD_ZERO(&select_pipes);
3898 for (poffset = 0; poffset < remote_max_parallel; poffset++)
3900 if (parlist[poffset].pid != 0)
3902 int fd = parlist[poffset].fd;
3903 FD_SET(fd, &select_pipes);
3904 if (fd > maxpipe) maxpipe = fd;
3908 /* Stick in a 60-second timeout, just in case. */
3913 readycount = select(maxpipe + 1, (SELECT_ARG2_TYPE *)&select_pipes,
3916 /* Scan through the pipes and read any that are ready; use the count
3917 returned by select() to stop when there are no more. Select() can return
3918 with no processes (e.g. if interrupted). This shouldn't matter.
3920 If par_read_pipe() returns TRUE, it means that either the terminating Z was
3921 read, or there was a disaster. In either case, we are finished with this
3922 process. Do an explicit wait() for the process and break the main loop if
3925 It turns out that we have to deal with the case of an interrupted system
3926 call, which can happen on some operating systems if the signal handling is
3927 set up to do that by default. */
3930 readycount > 0 && poffset < remote_max_parallel;
3933 if ( (pid = parlist[poffset].pid) != 0
3934 && FD_ISSET(parlist[poffset].fd, &select_pipes)
3938 if (par_read_pipe(poffset, FALSE)) /* Finished with this pipe */
3940 for (;;) /* Loop for signals */
3942 pid_t endedpid = waitpid(pid, &status, 0);
3943 if (endedpid == pid) goto PROCESS_DONE;
3944 if (endedpid != (pid_t)(-1) || errno != EINTR)
3945 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Unexpected error return "
3946 "%d (errno = %d) from waitpid() for process %d",
3947 (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);
4085 rmt_dlv_checked_write(int fd, char id, char subid, void * buf, int size)
4087 uschar writebuffer[PIPE_HEADER_SIZE + BIG_BUFFER_SIZE];
4091 /* we assume that size can't get larger then BIG_BUFFER_SIZE which currently is set to 16k */
4092 /* complain to log if someone tries with buffer sizes we can't handle*/
4096 log_write(0, LOG_MAIN|LOG_PANIC_DIE,
4097 "Failed writing transport result to pipe: can't handle buffers > 99999 bytes. truncating!\n");
4101 /* to keep the write() atomic we build header in writebuffer and copy buf behind */
4102 /* two write() calls would increase the complexity of reading from pipe */
4104 /* convert size to human readable string prepended by id and subid */
4105 header_length = snprintf(CS writebuffer, PIPE_HEADER_SIZE+1, "%c%c%05d", id, subid, size);
4106 if (header_length != PIPE_HEADER_SIZE)
4108 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "header snprintf failed\n");
4109 writebuffer[0] = '\0';
4112 DEBUG(D_deliver) debug_printf("header write id:%c,subid:%c,size:%d,final:%s\n",
4113 id, subid, size, writebuffer);
4115 if (buf && size > 0)
4116 memcpy(writebuffer + PIPE_HEADER_SIZE, buf, size);
4118 size += PIPE_HEADER_SIZE;
4119 if ((ret = write(fd, writebuffer, size)) != size)
4120 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Failed writing transport result to pipe: %s\n",
4121 ret == -1 ? strerror(errno) : "short write");
4124 /*************************************************
4125 * Do remote deliveries *
4126 *************************************************/
4128 /* This function is called to process the addresses in addr_remote. We must
4129 pick off the queue all addresses that have the same transport, remote
4130 destination, and errors address, and hand them to the transport in one go,
4131 subject to some configured limitations. If this is a run to continue delivering
4132 to an existing delivery channel, skip all but those addresses that can go to
4133 that channel. The skipped addresses just get deferred.
4135 If mua_wrapper is set, all addresses must be able to be sent in a single
4136 transaction. If not, this function yields FALSE.
4138 In Exim 4, remote deliveries are always done in separate processes, even
4139 if remote_max_parallel = 1 or if there's only one delivery to do. The reason
4140 is so that the base process can retain privilege. This makes the
4141 implementation of fallback transports feasible (though not initially done.)
4143 We create up to the configured number of subprocesses, each of which passes
4144 back the delivery state via a pipe. (However, when sending down an existing
4145 connection, remote_max_parallel is forced to 1.)
4148 fallback TRUE if processing fallback hosts
4150 Returns: TRUE normally
4151 FALSE if mua_wrapper is set and the addresses cannot all be sent
4156 do_remote_deliveries(BOOL fallback)
4162 parcount = 0; /* Number of executing subprocesses */
4164 /* When sending down an existing channel, only do one delivery at a time.
4165 We use a local variable (parmax) to hold the maximum number of processes;
4166 this gets reduced from remote_max_parallel if we can't create enough pipes. */
4168 if (continue_transport) remote_max_parallel = 1;
4169 parmax = remote_max_parallel;
4171 /* If the data for keeping a list of processes hasn't yet been
4176 parlist = store_get(remote_max_parallel * sizeof(pardata));
4177 for (poffset = 0; poffset < remote_max_parallel; poffset++)
4178 parlist[poffset].pid = 0;
4181 /* Now loop for each remote delivery */
4183 for (delivery_count = 0; addr_remote; delivery_count++)
4189 int address_count = 1;
4190 int address_count_max;
4192 BOOL use_initgroups;
4193 BOOL pipe_done = FALSE;
4194 transport_instance *tp;
4195 address_item **anchor = &addr_remote;
4196 address_item *addr = addr_remote;
4197 address_item *last = addr;
4200 uschar * serialize_key = NULL;
4202 /* Pull the first address right off the list. */
4204 addr_remote = addr->next;
4207 DEBUG(D_deliver|D_transport)
4208 debug_printf("--------> %s <--------\n", addr->address);
4210 /* If no transport has been set, there has been a big screw-up somewhere. */
4212 if (!(tp = addr->transport))
4214 disable_logging = FALSE; /* Jic */
4215 panicmsg = US"No transport set by router";
4216 goto panic_continue;
4219 /* Check that this base address hasn't previously been delivered to this
4220 transport. The check is necessary at this point to handle homonymic addresses
4221 correctly in cases where the pattern of redirection changes between delivery
4222 attempts. Non-homonymic previous delivery is detected earlier, at routing
4225 if (previously_transported(addr, FALSE)) continue;
4227 /* Force failure if the message is too big. */
4229 if (tp->message_size_limit)
4231 int rc = check_message_size(tp, addr);
4234 addr->transport_return = rc;
4235 remote_post_process(addr, LOG_MAIN, NULL, fallback);
4240 /* Get the flag which specifies whether the transport can handle different
4241 domains that nevertheless resolve to the same set of hosts. If it needs
4242 expanding, get variables set: $address_data, $domain_data, $localpart_data,
4243 $host, $host_address, $host_port. */
4244 if (tp->expand_multi_domain)
4245 deliver_set_expansions(addr);
4247 if (exp_bool(addr, US"transport", tp->name, D_transport,
4248 US"multi_domain", tp->multi_domain, tp->expand_multi_domain,
4249 &multi_domain) != OK)
4251 deliver_set_expansions(NULL);
4252 panicmsg = addr->message;
4253 goto panic_continue;
4256 /* Get the maximum it can handle in one envelope, with zero meaning
4257 unlimited, which is forced for the MUA wrapper case. */
4259 address_count_max = tp->max_addresses;
4260 if (address_count_max == 0 || mua_wrapper) address_count_max = 999999;
4263 /************************************************************************/
4264 /***** This is slightly experimental code, but should be safe. *****/
4266 /* The address_count_max value is the maximum number of addresses that the
4267 transport can send in one envelope. However, the transport must be capable of
4268 dealing with any number of addresses. If the number it gets exceeds its
4269 envelope limitation, it must send multiple copies of the message. This can be
4270 done over a single connection for SMTP, so uses less resources than making
4271 multiple connections. On the other hand, if remote_max_parallel is greater
4272 than one, it is perhaps a good idea to use parallel processing to move the
4273 message faster, even if that results in multiple simultaneous connections to
4276 How can we come to some compromise between these two ideals? What we do is to
4277 limit the number of addresses passed to a single instance of a transport to
4278 the greater of (a) its address limit (rcpt_max for SMTP) and (b) the total
4279 number of addresses routed to remote transports divided by
4280 remote_max_parallel. For example, if the message has 100 remote recipients,
4281 remote max parallel is 2, and rcpt_max is 10, we'd never send more than 50 at
4282 once. But if rcpt_max is 100, we could send up to 100.
4284 Of course, not all the remotely addresses in a message are going to go to the
4285 same set of hosts (except in smarthost configurations), so this is just a
4286 heuristic way of dividing up the work.
4288 Furthermore (1), because this may not be wanted in some cases, and also to
4289 cope with really pathological cases, there is also a limit to the number of
4290 messages that are sent over one connection. This is the same limit that is
4291 used when sending several different messages over the same connection.
4292 Continue_sequence is set when in this situation, to the number sent so
4293 far, including this message.
4295 Furthermore (2), when somebody explicitly sets the maximum value to 1, it
4296 is probably because they are using VERP, in which case they want to pass only
4297 one address at a time to the transport, in order to be able to use
4298 $local_part and $domain in constructing a new return path. We could test for
4299 the use of these variables, but as it is so likely they will be used when the
4300 maximum is 1, we don't bother. Just leave the value alone. */
4302 if ( address_count_max != 1
4303 && address_count_max < remote_delivery_count/remote_max_parallel
4306 int new_max = remote_delivery_count/remote_max_parallel;
4307 int message_max = tp->connection_max_messages;
4308 if (connection_max_messages >= 0) message_max = connection_max_messages;
4309 message_max -= continue_sequence - 1;
4310 if (message_max > 0 && new_max > address_count_max * message_max)
4311 new_max = address_count_max * message_max;
4312 address_count_max = new_max;
4315 /************************************************************************/
4318 /* Pick off all addresses which have the same transport, errors address,
4319 destination, and extra headers. In some cases they point to the same host
4320 list, but we also need to check for identical host lists generated from
4321 entirely different domains. The host list pointers can be NULL in the case
4322 where the hosts are defined in the transport. There is also a configured
4323 maximum limit of addresses that can be handled at once (see comments above
4324 for how it is computed).
4325 If the transport does not handle multiple domains, enforce that also,
4326 and if it might need a per-address check for this, re-evaluate it.
4329 while ((next = *anchor) && address_count < address_count_max)
4332 if ( (multi_domain || Ustrcmp(next->domain, addr->domain) == 0)
4333 && tp == next->transport
4334 && same_hosts(next->host_list, addr->host_list)
4335 && same_strings(next->prop.errors_address, addr->prop.errors_address)
4336 && same_headers(next->prop.extra_headers, addr->prop.extra_headers)
4337 && same_ugid(tp, next, addr)
4338 && ( next->prop.remove_headers == addr->prop.remove_headers
4339 || ( next->prop.remove_headers
4340 && addr->prop.remove_headers
4341 && Ustrcmp(next->prop.remove_headers, addr->prop.remove_headers) == 0
4345 (void)(!tp->expand_multi_domain || ((void)deliver_set_expansions(next), 1)),
4347 US"transport", next->transport->name, D_transport,
4348 US"multi_domain", next->transport->multi_domain,
4349 next->transport->expand_multi_domain, &md) == OK
4354 *anchor = next->next;
4356 next->first = addr; /* remember top one (for retry processing) */
4361 else anchor = &(next->next);
4362 deliver_set_expansions(NULL);
4365 /* If we are acting as an MUA wrapper, all addresses must go in a single
4366 transaction. If not, put them back on the chain and yield FALSE. */
4368 if (mua_wrapper && addr_remote)
4370 last->next = addr_remote;
4375 /* If the transport is limited for parallellism, enforce that here.
4376 The hints DB entry is decremented in par_reduce(), when we reap the
4377 transport process. */
4379 if (tpt_parallel_check(tp, addr, &serialize_key))
4380 if ((panicmsg = expand_string_message))
4381 goto panic_continue;
4383 continue; /* Loop for the next set of addresses. */
4385 /* Set up the expansion variables for this set of addresses */
4387 deliver_set_expansions(addr);
4389 /* Ensure any transport-set auth info is fresh */
4390 addr->authenticator = addr->auth_id = addr->auth_sndr = NULL;
4392 /* Compute the return path, expanding a new one if required. The old one
4393 must be set first, as it might be referred to in the expansion. */
4395 if(addr->prop.errors_address)
4396 return_path = addr->prop.errors_address;
4397 #ifdef EXPERIMENTAL_SRS
4398 else if(addr->prop.srs_sender)
4399 return_path = addr->prop.srs_sender;
4402 return_path = sender_address;
4404 if (tp->return_path)
4406 uschar *new_return_path = expand_string(tp->return_path);
4407 if (new_return_path)
4408 return_path = new_return_path;
4409 else if (!expand_string_forcedfail)
4411 panicmsg = string_sprintf("Failed to expand return path \"%s\": %s",
4412 tp->return_path, expand_string_message);
4417 /* Find the uid, gid, and use_initgroups setting for this transport. Failure
4418 logs and sets up error messages, so we just post-process and continue with
4419 the next address. */
4421 if (!findugid(addr, tp, &uid, &gid, &use_initgroups))
4427 /* If this transport has a setup function, call it now so that it gets
4428 run in this process and not in any subprocess. That way, the results of
4429 any setup that are retained by the transport can be reusable. One of the
4430 things the setup does is to set the fallback host lists in the addresses.
4431 That is why it is called at this point, before the continue delivery
4432 processing, because that might use the fallback hosts. */
4435 (void)((tp->setup)(addr->transport, addr, NULL, uid, gid, NULL));
4437 /* If this is a run to continue delivery down an already-established
4438 channel, check that this set of addresses matches the transport and
4439 the channel. If it does not, defer the addresses. If a host list exists,
4440 we must check that the continue host is on the list. Otherwise, the
4441 host is set in the transport. */
4443 continue_more = FALSE; /* In case got set for the last lot */
4444 if (continue_transport)
4446 BOOL ok = Ustrcmp(continue_transport, tp->name) == 0;
4447 if (ok && addr->host_list)
4451 for (h = addr->host_list; h; h = h->next)
4452 if (Ustrcmp(h->name, continue_hostname) == 0)
4453 /*XXX should also check port here */
4454 { ok = TRUE; break; }
4457 /* Addresses not suitable; defer or queue for fallback hosts (which
4458 might be the continue host) and skip to next address. */
4462 DEBUG(D_deliver) debug_printf("not suitable for continue_transport\n");
4463 if (serialize_key) enq_end(serialize_key);
4465 if (addr->fallback_hosts && !fallback)
4467 for (next = addr; ; next = next->next)
4469 next->host_list = next->fallback_hosts;
4470 DEBUG(D_deliver) debug_printf("%s queued for fallback host(s)\n", next->address);
4471 if (!next->next) break;
4473 next->next = addr_fallback;
4474 addr_fallback = addr;
4479 for (next = addr; ; next = next->next)
4481 DEBUG(D_deliver) debug_printf(" %s to def list\n", next->address);
4482 if (!next->next) break;
4484 next->next = addr_defer;
4491 /* Set a flag indicating whether there are further addresses that list
4492 the continued host. This tells the transport to leave the channel open,
4493 but not to pass it to another delivery process. */
4495 for (next = addr_remote; next; next = next->next)
4498 for (h = next->host_list; h; h = h->next)
4499 if (Ustrcmp(h->name, continue_hostname) == 0)
4500 { continue_more = TRUE; break; }
4504 /* The transports set up the process info themselves as they may connect
4505 to more than one remote machine. They also have to set up the filter
4506 arguments, if required, so that the host name and address are available
4509 transport_filter_argv = NULL;
4511 /* Create the pipe for inter-process communication. If pipe creation
4512 fails, it is probably because the value of remote_max_parallel is so
4513 large that too many file descriptors for pipes have been created. Arrange
4514 to wait for a process to finish, and then try again. If we still can't
4515 create a pipe when all processes have finished, break the retry loop. */
4519 if (pipe(pfd) == 0) pipe_done = TRUE;
4520 else if (parcount > 0) parmax = parcount;
4523 /* We need to make the reading end of the pipe non-blocking. There are
4524 two different options for this. Exim is cunningly (I hope!) coded so
4525 that it can use either of them, though it prefers O_NONBLOCK, which
4526 distinguishes between EOF and no-more-data. */
4529 (void)fcntl(pfd[pipe_read], F_SETFL, O_NONBLOCK);
4531 (void)fcntl(pfd[pipe_read], F_SETFL, O_NDELAY);
4534 /* If the maximum number of subprocesses already exist, wait for a process
4535 to finish. If we ran out of file descriptors, parmax will have been reduced
4536 from its initial value of remote_max_parallel. */
4538 par_reduce(parmax - 1, fallback);
4541 /* If we failed to create a pipe and there were no processes to wait
4542 for, we have to give up on this one. Do this outside the above loop
4543 so that we can continue the main loop. */
4547 panicmsg = string_sprintf("unable to create pipe: %s", strerror(errno));
4551 /* Find a free slot in the pardata list. Must do this after the possible
4552 waiting for processes to finish, because a terminating process will free
4555 for (poffset = 0; poffset < remote_max_parallel; poffset++)
4556 if (parlist[poffset].pid == 0)
4559 /* If there isn't one, there has been a horrible disaster. */
4561 if (poffset >= remote_max_parallel)
4563 (void)close(pfd[pipe_write]);
4564 (void)close(pfd[pipe_read]);
4565 panicmsg = US"Unexpectedly no free subprocess slot";
4569 /* Now fork a subprocess to do the remote delivery, but before doing so,
4570 ensure that any cached resources are released so as not to interfere with
4571 what happens in the subprocess. */
4575 if ((pid = fork()) == 0)
4577 int fd = pfd[pipe_write];
4580 /* Setting this global in the subprocess means we need never clear it */
4581 transport_name = tp->name;
4583 /* There are weird circumstances in which logging is disabled */
4584 disable_logging = tp->disable_logging;
4586 /* Show pids on debug output if parallelism possible */
4588 if (parmax > 1 && (parcount > 0 || addr_remote))
4590 DEBUG(D_any|D_v) debug_selector |= D_pid;
4591 DEBUG(D_deliver) debug_printf("Remote delivery process started\n");
4594 /* Reset the random number generator, so different processes don't all
4595 have the same sequence. In the test harness we want different, but
4596 predictable settings for each delivery process, so do something explicit
4597 here rather they rely on the fixed reset in the random number function. */
4599 random_seed = running_in_test_harness? 42 + 2*delivery_count : 0;
4601 /* Set close-on-exec on the pipe so that it doesn't get passed on to
4602 a new process that may be forked to do another delivery down the same
4605 (void)fcntl(fd, F_SETFD, fcntl(fd, F_GETFD) | FD_CLOEXEC);
4607 /* Close open file descriptors for the pipes of other processes
4608 that are running in parallel. */
4610 for (poffset = 0; poffset < remote_max_parallel; poffset++)
4611 if (parlist[poffset].pid != 0) (void)close(parlist[poffset].fd);
4613 /* This process has inherited a copy of the file descriptor
4614 for the data file, but its file pointer is shared with all the
4615 other processes running in parallel. Therefore, we have to re-open
4616 the file in order to get a new file descriptor with its own
4617 file pointer. We don't need to lock it, as the lock is held by
4618 the parent process. There doesn't seem to be any way of doing
4619 a dup-with-new-file-pointer. */
4621 (void)close(deliver_datafile);
4623 uschar * fname = spool_fname(US"input", message_subdir, message_id, US"-D");
4625 if ((deliver_datafile = Uopen(fname,
4629 O_RDWR | O_APPEND, 0)) < 0)
4630 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Failed to reopen %s for remote "
4631 "parallel delivery: %s", fname, strerror(errno));
4634 /* Set the close-on-exec flag */
4636 (void)fcntl(deliver_datafile, F_SETFD, fcntl(deliver_datafile, F_GETFD) |
4640 /* Set the uid/gid of this process; bombs out on failure. */
4642 exim_setugid(uid, gid, use_initgroups,
4643 string_sprintf("remote delivery to %s with transport=%s",
4644 addr->address, tp->name));
4646 /* Close the unwanted half of this process' pipe, set the process state,
4647 and run the transport. Afterwards, transport_count will contain the number
4648 of bytes written. */
4650 (void)close(pfd[pipe_read]);
4651 set_process_info("delivering %s using %s", message_id, tp->name);
4652 debug_print_string(tp->debug_string);
4653 if (!(tp->info->code)(addr->transport, addr)) replicate_status(addr);
4655 set_process_info("delivering %s (just run %s for %s%s in subprocess)",
4656 message_id, tp->name, addr->address, addr->next ? ", ..." : "");
4658 /* Ensure any cached resources that we used are now released */
4662 /* Pass the result back down the pipe. This is a lot more information
4663 than is needed for a local delivery. We have to send back the error
4664 status for each address, the usability status for each host that is
4665 flagged as unusable, and all the retry items. When TLS is in use, we
4666 send also the cipher and peerdn information. Each type of information
4667 is flagged by an identifying byte, and is then in a fixed format (with
4668 strings terminated by zeros), and there is a final terminator at the
4669 end. The host information and retry information is all attached to
4670 the first address, so that gets sent at the start. */
4672 /* Host unusability information: for most success cases this will
4675 for (h = addr->host_list; h; h = h->next)
4677 if (!h->address || h->status < hstatus_unusable) continue;
4678 sprintf(CS big_buffer, "%c%c%s", h->status, h->why, h->address);
4679 rmt_dlv_checked_write(fd, 'H', '0', big_buffer, Ustrlen(big_buffer+2) + 3);
4682 /* The number of bytes written. This is the same for each address. Even
4683 if we sent several copies of the message down the same connection, the
4684 size of each one is the same, and it's that value we have got because
4685 transport_count gets reset before calling transport_write_message(). */
4687 memcpy(big_buffer, &transport_count, sizeof(transport_count));
4688 rmt_dlv_checked_write(fd, 'S', '0', big_buffer, sizeof(transport_count));
4690 /* Information about what happened to each address. Four item types are
4691 used: an optional 'X' item first, for TLS information, then an optional "C"
4692 item for any client-auth info followed by 'R' items for any retry settings,
4693 and finally an 'A' item for the remaining data. */
4695 for(; addr; addr = addr->next)
4700 /* The certificate verification status goes into the flags */
4701 if (tls_out.certificate_verified) setflag(addr, af_cert_verified);
4702 #ifdef EXPERIMENTAL_DANE
4703 if (tls_out.dane_verified) setflag(addr, af_dane_verified);
4706 /* Use an X item only if there's something to send */
4710 ptr = big_buffer + sprintf(CS big_buffer, "%.128s", addr->cipher) + 1;
4714 ptr += sprintf(CS ptr, "%.512s", addr->peerdn) + 1;
4716 rmt_dlv_checked_write(fd, 'X', '1', big_buffer, ptr - big_buffer);
4718 else if (continue_proxy) /* known TLS, but no cipher info */
4719 rmt_dlv_checked_write(fd, 'X', '1', US"*\0", 3);
4724 if (!tls_export_cert(ptr, big_buffer_size-2, addr->peercert))
4728 rmt_dlv_checked_write(fd, 'X', '2', big_buffer, ptr - big_buffer);
4733 if (!tls_export_cert(ptr, big_buffer_size-2, addr->ourcert))
4737 rmt_dlv_checked_write(fd, 'X', '3', big_buffer, ptr - big_buffer);
4739 # ifndef DISABLE_OCSP
4740 if (addr->ocsp > OCSP_NOT_REQ)
4742 ptr = big_buffer + sprintf(CS big_buffer, "%c", addr->ocsp + '0') + 1;
4743 rmt_dlv_checked_write(fd, 'X', '4', big_buffer, ptr - big_buffer);
4746 #endif /*SUPPORT_TLS*/
4748 if (client_authenticator)
4750 ptr = big_buffer + sprintf(CS big_buffer, "%.64s", client_authenticator) + 1;
4751 rmt_dlv_checked_write(fd, 'C', '1', big_buffer, ptr - big_buffer);
4753 if (client_authenticated_id)
4755 ptr = big_buffer + sprintf(CS big_buffer, "%.64s", client_authenticated_id) + 1;
4756 rmt_dlv_checked_write(fd, 'C', '2', big_buffer, ptr - big_buffer);
4758 if (client_authenticated_sender)
4760 ptr = big_buffer + sprintf(CS big_buffer, "%.64s", client_authenticated_sender) + 1;
4761 rmt_dlv_checked_write(fd, 'C', '3', big_buffer, ptr - big_buffer);
4764 #ifndef DISABLE_PRDR
4765 if (addr->flags & af_prdr_used)
4766 rmt_dlv_checked_write(fd, 'P', '0', NULL, 0);
4769 if (addr->flags & af_chunking_used)
4770 rmt_dlv_checked_write(fd, 'K', '0', NULL, 0);
4772 memcpy(big_buffer, &addr->dsn_aware, sizeof(addr->dsn_aware));
4773 rmt_dlv_checked_write(fd, 'D', '0', big_buffer, sizeof(addr->dsn_aware));
4774 DEBUG(D_deliver) debug_printf("DSN write: addr->dsn_aware = %d\n", addr->dsn_aware);
4776 /* Retry information: for most success cases this will be null. */
4778 for (r = addr->retries; r; r = r->next)
4780 sprintf(CS big_buffer, "%c%.500s", r->flags, r->key);
4781 ptr = big_buffer + Ustrlen(big_buffer+2) + 3;
4782 memcpy(ptr, &(r->basic_errno), sizeof(r->basic_errno));
4783 ptr += sizeof(r->basic_errno);
4784 memcpy(ptr, &(r->more_errno), sizeof(r->more_errno));
4785 ptr += sizeof(r->more_errno);
4786 if (!r->message) *ptr++ = 0; else
4788 sprintf(CS ptr, "%.512s", r->message);
4791 rmt_dlv_checked_write(fd, 'R', '0', big_buffer, ptr - big_buffer);
4794 #ifdef SUPPORT_SOCKS
4795 if (LOGGING(proxy) && proxy_session)
4798 if (proxy_local_address)
4800 DEBUG(D_deliver) debug_printf("proxy_local_address '%s'\n", proxy_local_address);
4801 ptr = big_buffer + sprintf(CS ptr, "%.128s", proxy_local_address) + 1;
4802 DEBUG(D_deliver) debug_printf("proxy_local_port %d\n", proxy_local_port);
4803 memcpy(ptr, &proxy_local_port, sizeof(proxy_local_port));
4804 ptr += sizeof(proxy_local_port);
4808 rmt_dlv_checked_write(fd, 'A', '2', big_buffer, ptr - big_buffer);
4812 #ifdef EXPERIMENTAL_DSN_INFO
4813 /*um, are they really per-addr? Other per-conn stuff is not (auth, tls). But host_used is! */
4814 if (addr->smtp_greeting)
4816 DEBUG(D_deliver) debug_printf("smtp_greeting '%s'\n", addr->smtp_greeting);
4817 ptr = big_buffer + sprintf(CS big_buffer, "%.128s", addr->smtp_greeting) + 1;
4818 if (addr->helo_response)
4820 DEBUG(D_deliver) debug_printf("helo_response '%s'\n", addr->helo_response);
4821 ptr += sprintf(CS ptr, "%.128s", addr->helo_response) + 1;
4825 rmt_dlv_checked_write(fd, 'A', '1', big_buffer, ptr - big_buffer);
4829 /* The rest of the information goes in an 'A0' item. */
4831 sprintf(CS big_buffer, "%c%c", addr->transport_return, addr->special_action);
4832 ptr = big_buffer + 2;
4833 memcpy(ptr, &(addr->basic_errno), sizeof(addr->basic_errno));
4834 ptr += sizeof(addr->basic_errno);
4835 memcpy(ptr, &(addr->more_errno), sizeof(addr->more_errno));
4836 ptr += sizeof(addr->more_errno);
4837 memcpy(ptr, &(addr->flags), sizeof(addr->flags));
4838 ptr += sizeof(addr->flags);
4840 if (!addr->message) *ptr++ = 0; else
4841 ptr += sprintf(CS ptr, "%.1024s", addr->message) + 1;
4843 if (!addr->user_message) *ptr++ = 0; else
4844 ptr += sprintf(CS ptr, "%.1024s", addr->user_message) + 1;
4846 if (!addr->host_used) *ptr++ = 0; else
4848 ptr += sprintf(CS ptr, "%.256s", addr->host_used->name) + 1;
4849 ptr += sprintf(CS ptr, "%.64s", addr->host_used->address) + 1;
4850 memcpy(ptr, &(addr->host_used->port), sizeof(addr->host_used->port));
4851 ptr += sizeof(addr->host_used->port);
4853 /* DNS lookup status */
4854 *ptr++ = addr->host_used->dnssec==DS_YES ? '2'
4855 : addr->host_used->dnssec==DS_NO ? '1' : '0';
4858 rmt_dlv_checked_write(fd, 'A', '0', big_buffer, ptr - big_buffer);
4861 /* Local interface address/port */
4862 #ifdef EXPERIMENTAL_DSN_INFO
4863 if (sending_ip_address)
4865 if (LOGGING(incoming_interface) && sending_ip_address)
4869 ptr = big_buffer + sprintf(CS big_buffer, "%.128s", sending_ip_address) + 1;
4870 ptr += sprintf(CS ptr, "%d", sending_port) + 1;
4871 rmt_dlv_checked_write(fd, 'I', '0', big_buffer, ptr - big_buffer);
4874 /* Add termination flag, close the pipe, and that's it. The character
4875 after 'Z' indicates whether continue_transport is now NULL or not.
4876 A change from non-NULL to NULL indicates a problem with a continuing
4879 big_buffer[0] = continue_transport ? '1' : '0';
4880 rmt_dlv_checked_write(fd, 'Z', '0', big_buffer, 1);
4885 /* Back in the mainline: close the unwanted half of the pipe. */
4887 (void)close(pfd[pipe_write]);
4889 /* Fork failed; defer with error message */
4893 (void)close(pfd[pipe_read]);
4894 panicmsg = string_sprintf("fork failed for remote delivery to %s: %s",
4895 addr->domain, strerror(errno));
4899 /* Fork succeeded; increment the count, and remember relevant data for
4900 when the process finishes. */
4903 parlist[poffset].addrlist = parlist[poffset].addr = addr;
4904 parlist[poffset].pid = pid;
4905 parlist[poffset].fd = pfd[pipe_read];
4906 parlist[poffset].done = FALSE;
4907 parlist[poffset].msg = NULL;
4908 parlist[poffset].return_path = return_path;
4910 /* If the process we've just started is sending a message down an existing
4911 channel, wait for it now. This ensures that only one such process runs at
4912 once, whatever the value of remote_max parallel. Otherwise, we might try to
4913 send two or more messages simultaneously down the same channel. This could
4914 happen if there are different domains that include the same host in otherwise
4915 different host lists.
4917 Also, if the transport closes down the channel, this information gets back
4918 (continue_transport gets set to NULL) before we consider any other addresses
4921 if (continue_transport) par_reduce(0, fallback);
4923 /* Otherwise, if we are running in the test harness, wait a bit, to let the
4924 newly created process get going before we create another process. This should
4925 ensure repeatability in the tests. We only need to wait a tad. */
4927 else if (running_in_test_harness) millisleep(500);
4932 if (serialize_key) enq_end(serialize_key);
4934 remote_post_process(addr, LOG_MAIN|LOG_PANIC, panicmsg, fallback);
4938 /* Reached the end of the list of addresses. Wait for all the subprocesses that
4939 are still running and post-process their addresses. */
4941 par_reduce(0, fallback);
4948 /*************************************************
4949 * Split an address into local part and domain *
4950 *************************************************/
4952 /* This function initializes an address for routing by splitting it up into a
4953 local part and a domain. The local part is set up twice - once in its original
4954 casing, and once in lower case, and it is dequoted. We also do the "percent
4955 hack" for configured domains. This may lead to a DEFER result if a lookup
4956 defers. When a percent-hacking takes place, we insert a copy of the original
4957 address as a new parent of this address, as if we have had a redirection.
4960 addr points to an addr_item block containing the address
4963 DEFER - could not determine if domain is %-hackable
4967 deliver_split_address(address_item * addr)
4969 uschar * address = addr->address;
4974 if (!(domain = Ustrrchr(address, '@')))
4975 return DEFER; /* should always have a domain, but just in case... */
4977 len = domain - address;
4978 addr->domain = string_copylc(domain+1); /* Domains are always caseless */
4980 /* The implication in the RFCs (though I can't say I've seen it spelled out
4981 explicitly) is that quoting should be removed from local parts at the point
4982 where they are locally interpreted. [The new draft "821" is more explicit on
4983 this, Jan 1999.] We know the syntax is valid, so this can be done by simply
4984 removing quoting backslashes and any unquoted doublequotes. */
4986 t = addr->cc_local_part = store_get(len+1);
4990 if (c == '\"') continue;
5000 /* We do the percent hack only for those domains that are listed in
5001 percent_hack_domains. A loop is required, to copy with multiple %-hacks. */
5003 if (percent_hack_domains)
5006 uschar *new_address = NULL;
5007 uschar *local_part = addr->cc_local_part;
5009 deliver_domain = addr->domain; /* set $domain */
5011 while ( (rc = match_isinlist(deliver_domain, (const uschar **)&percent_hack_domains, 0,
5012 &domainlist_anchor, addr->domain_cache, MCL_DOMAIN, TRUE, NULL))
5014 && (t = Ustrrchr(local_part, '%')) != NULL
5017 new_address = string_copy(local_part);
5018 new_address[t - local_part] = '@';
5019 deliver_domain = string_copylc(t+1);
5020 local_part = string_copyn(local_part, t - local_part);
5023 if (rc == DEFER) return DEFER; /* lookup deferred */
5025 /* If hackery happened, set up new parent and alter the current address. */
5029 address_item *new_parent = store_get(sizeof(address_item));
5030 *new_parent = *addr;
5031 addr->parent = new_parent;
5032 new_parent->child_count = 1;
5033 addr->address = new_address;
5034 addr->unique = string_copy(new_address);
5035 addr->domain = deliver_domain;
5036 addr->cc_local_part = local_part;
5037 DEBUG(D_deliver) debug_printf("%%-hack changed address to: %s\n",
5042 /* Create the lowercased version of the final local part, and make that the
5043 default one to be used. */
5045 addr->local_part = addr->lc_local_part = string_copylc(addr->cc_local_part);
5052 /*************************************************
5053 * Get next error message text *
5054 *************************************************/
5056 /* If f is not NULL, read the next "paragraph", from a customized error message
5057 text file, terminated by a line containing ****, and expand it.
5060 f NULL or a file to read from
5061 which string indicating which string (for errors)
5063 Returns: NULL or an expanded string
5067 next_emf(FILE *f, uschar *which)
5071 uschar *para, *yield;
5074 if (!f) return NULL;
5076 if (!Ufgets(buffer, sizeof(buffer), f) || Ustrcmp(buffer, "****\n") == 0)
5079 para = store_get(size);
5082 para = string_cat(para, &size, &ptr, buffer);
5083 if (!Ufgets(buffer, sizeof(buffer), f) || Ustrcmp(buffer, "****\n") == 0)
5088 if ((yield = expand_string(para)))
5091 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand string from "
5092 "bounce_message_file or warn_message_file (%s): %s", which,
5093 expand_string_message);
5100 /*************************************************
5101 * Close down a passed transport channel *
5102 *************************************************/
5104 /* This function is called when a passed transport channel cannot be used.
5105 It attempts to close it down tidily. The yield is always DELIVER_NOT_ATTEMPTED
5106 so that the function call can be the argument of a "return" statement.
5109 Returns: DELIVER_NOT_ATTEMPTED
5113 continue_closedown(void)
5115 if (continue_transport)
5117 transport_instance *t;
5118 for (t = transports; t; t = t->next)
5119 if (Ustrcmp(t->name, continue_transport) == 0)
5121 if (t->info->closedown) (t->info->closedown)(t);
5125 return DELIVER_NOT_ATTEMPTED;
5131 /*************************************************
5132 * Print address information *
5133 *************************************************/
5135 /* This function is called to output an address, or information about an
5136 address, for bounce or defer messages. If the hide_child flag is set, all we
5137 output is the original ancestor address.
5140 addr points to the address
5141 f the FILE to print to
5142 si an initial string
5143 sc a continuation string for before "generated"
5146 Returns: TRUE if the address is not hidden
5150 print_address_information(address_item *addr, FILE *f, uschar *si, uschar *sc,
5154 uschar *printed = US"";
5155 address_item *ancestor = addr;
5156 while (ancestor->parent) ancestor = ancestor->parent;
5158 fprintf(f, "%s", CS si);
5160 if (addr->parent && testflag(addr, af_hide_child))
5162 printed = US"an undisclosed address";
5165 else if (!testflag(addr, af_pfr) || !addr->parent)
5166 printed = addr->address;
5170 uschar *s = addr->address;
5173 if (addr->address[0] == '>') { ss = US"mail"; s++; }
5174 else if (addr->address[0] == '|') ss = US"pipe";
5177 fprintf(f, "%s to %s%sgenerated by ", ss, s, sc);
5178 printed = addr->parent->address;
5181 fprintf(f, "%s", CS string_printing(printed));
5183 if (ancestor != addr)
5185 uschar *original = ancestor->onetime_parent;
5186 if (!original) original= ancestor->address;
5187 if (strcmpic(original, printed) != 0)
5188 fprintf(f, "%s(%sgenerated from %s)", sc,
5189 ancestor != addr->parent ? "ultimately " : "",
5190 string_printing(original));
5193 if (addr->host_used)
5194 fprintf(f, "\n host %s [%s]",
5195 addr->host_used->name, addr->host_used->address);
5197 fprintf(f, "%s", CS se);
5205 /*************************************************
5206 * Print error for an address *
5207 *************************************************/
5209 /* This function is called to print the error information out of an address for
5210 a bounce or a warning message. It tries to format the message reasonably by
5211 introducing newlines. All lines are indented by 4; the initial printing
5212 position must be set before calling.
5214 This function used always to print the error. Nowadays we want to restrict it
5215 to cases such as LMTP/SMTP errors from a remote host, and errors from :fail:
5216 and filter "fail". We no longer pass other information willy-nilly in bounce
5217 and warning messages. Text in user_message is always output; text in message
5218 only if the af_pass_message flag is set.
5222 f the FILE to print on
5229 print_address_error(address_item *addr, FILE *f, uschar *t)
5231 int count = Ustrlen(t);
5232 uschar *s = testflag(addr, af_pass_message)? addr->message : NULL;
5234 if (!s && !(s = addr->user_message))
5237 fprintf(f, "\n %s", t);
5240 if (*s == '\\' && s[1] == 'n')
5250 if (*s++ == ':' && isspace(*s) && count > 45)
5252 fprintf(f, "\n "); /* sic (because space follows) */
5259 /***********************************************************
5260 * Print Diagnostic-Code for an address *
5261 ************************************************************/
5263 /* This function is called to print the error information out of an address for
5264 a bounce or a warning message. It tries to format the message reasonably as
5265 required by RFC 3461 by adding a space after each newline
5267 it uses the same logic as print_address_error() above. if af_pass_message is true
5268 and addr->message is set it uses the remote host answer. if not addr->user_message
5269 is used instead if available.
5273 f the FILE to print on
5279 print_dsn_diagnostic_code(const address_item *addr, FILE *f)
5281 uschar *s = testflag(addr, af_pass_message) ? addr->message : NULL;
5283 /* af_pass_message and addr->message set ? print remote host answer */
5287 debug_printf("DSN Diagnostic-Code: addr->message = %s\n", addr->message);
5289 /* search first ": ". we assume to find the remote-MTA answer there */
5290 if (!(s = Ustrstr(addr->message, ": ")))
5291 return; /* not found, bail out */
5292 s += 2; /* skip ": " */
5293 fprintf(f, "Diagnostic-Code: smtp; ");
5295 /* no message available. do nothing */
5299 if (*s == '\\' && s[1] == 'n')
5301 fputs("\n ", f); /* as defined in RFC 3461 */
5311 /*************************************************
5312 * Check list of addresses for duplication *
5313 *************************************************/
5315 /* This function was introduced when the test for duplicate addresses that are
5316 not pipes, files, or autoreplies was moved from the middle of routing to when
5317 routing was complete. That was to fix obscure cases when the routing history
5318 affects the subsequent routing of identical addresses. This function is called
5319 after routing, to check that the final routed addresses are not duplicates.
5321 If we detect a duplicate, we remember what it is a duplicate of. Note that
5322 pipe, file, and autoreply de-duplication is handled during routing, so we must
5323 leave such "addresses" alone here, as otherwise they will incorrectly be
5326 Argument: address of list anchor
5331 do_duplicate_check(address_item **anchor)
5334 while ((addr = *anchor))
5337 if (testflag(addr, af_pfr))
5339 anchor = &(addr->next);
5341 else if ((tnode = tree_search(tree_duplicates, addr->unique)))
5343 DEBUG(D_deliver|D_route)
5344 debug_printf("%s is a duplicate address: discarded\n", addr->unique);
5345 *anchor = addr->next;
5346 addr->dupof = tnode->data.ptr;
5347 addr->next = addr_duplicate;
5348 addr_duplicate = addr;
5352 tree_add_duplicate(addr->unique, addr);
5353 anchor = &(addr->next);
5361 /*************************************************
5362 * Deliver one message *
5363 *************************************************/
5365 /* This is the function which is called when a message is to be delivered. It
5366 is passed the id of the message. It is possible that the message no longer
5367 exists, if some other process has delivered it, and it is also possible that
5368 the message is being worked on by another process, in which case the data file
5371 If no delivery is attempted for any of the above reasons, the function returns
5372 DELIVER_NOT_ATTEMPTED.
5374 If the give_up flag is set true, do not attempt any deliveries, but instead
5375 fail all outstanding addresses and return the message to the sender (or
5378 A delivery operation has a process all to itself; we never deliver more than
5379 one message in the same process. Therefore we needn't worry too much about
5382 Liable to be called as root.
5385 id the id of the message to be delivered
5386 forced TRUE if delivery was forced by an administrator; this overrides
5387 retry delays and causes a delivery to be tried regardless
5388 give_up TRUE if an administrator has requested that delivery attempts
5391 Returns: When the global variable mua_wrapper is FALSE:
5392 DELIVER_ATTEMPTED_NORMAL if a delivery attempt was made
5393 DELIVER_NOT_ATTEMPTED otherwise (see comment above)
5394 When the global variable mua_wrapper is TRUE:
5395 DELIVER_MUA_SUCCEEDED if delivery succeeded
5396 DELIVER_MUA_FAILED if delivery failed
5397 DELIVER_NOT_ATTEMPTED if not attempted (should not occur)
5401 deliver_message(uschar *id, BOOL forced, BOOL give_up)
5404 int final_yield = DELIVER_ATTEMPTED_NORMAL;
5405 time_t now = time(NULL);
5406 address_item *addr_last = NULL;
5407 uschar *filter_message = NULL;
5408 int process_recipients = RECIP_ACCEPT;
5411 extern int acl_where;
5413 uschar *info = queue_run_pid == (pid_t)0
5414 ? string_sprintf("delivering %s", id)
5415 : string_sprintf("delivering %s (queue run pid %d)", id, queue_run_pid);
5417 /* If the D_process_info bit is on, set_process_info() will output debugging
5418 information. If not, we want to show this initial information if D_deliver or
5419 D_queue_run is set or in verbose mode. */
5421 set_process_info("%s", info);
5423 if ( !(debug_selector & D_process_info)
5424 && (debug_selector & (D_deliver|D_queue_run|D_v))
5426 debug_printf("%s\n", info);
5428 /* Ensure that we catch any subprocesses that are created. Although Exim
5429 sets SIG_DFL as its initial default, some routes through the code end up
5430 here with it set to SIG_IGN - cases where a non-synchronous delivery process
5431 has been forked, but no re-exec has been done. We use sigaction rather than
5432 plain signal() on those OS where SA_NOCLDWAIT exists, because we want to be
5433 sure it is turned off. (There was a problem on AIX with this.) */
5437 struct sigaction act;
5438 act.sa_handler = SIG_DFL;
5439 sigemptyset(&(act.sa_mask));
5441 sigaction(SIGCHLD, &act, NULL);
5444 signal(SIGCHLD, SIG_DFL);
5447 /* Make the forcing flag available for routers and transports, set up the
5448 global message id field, and initialize the count for returned files and the
5449 message size. This use of strcpy() is OK because the length id is checked when
5450 it is obtained from a command line (the -M or -q options), and otherwise it is
5451 known to be a valid message id. */
5453 Ustrcpy(message_id, id);
5454 deliver_force = forced;
5458 /* Initialize some flags */
5460 update_spool = FALSE;
5461 remove_journal = TRUE;
5463 /* Set a known context for any ACLs we call via expansions */
5464 acl_where = ACL_WHERE_DELIVERY;
5466 /* Reset the random number generator, so that if several delivery processes are
5467 started from a queue runner that has already used random numbers (for sorting),
5468 they don't all get the same sequence. */
5472 /* Open and lock the message's data file. Exim locks on this one because the
5473 header file may get replaced as it is re-written during the delivery process.
5474 Any failures cause messages to be written to the log, except for missing files
5475 while queue running - another process probably completed delivery. As part of
5476 opening the data file, message_subdir gets set. */
5478 if ((deliver_datafile = spool_open_datafile(id)) < 0)
5479 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5481 /* The value of message_size at this point has been set to the data length,
5482 plus one for the blank line that notionally precedes the data. */
5484 /* Now read the contents of the header file, which will set up the headers in
5485 store, and also the list of recipients and the tree of non-recipients and
5486 assorted flags. It updates message_size. If there is a reading or format error,
5487 give up; if the message has been around for sufficiently long, remove it. */
5490 uschar * spoolname = string_sprintf("%s-H", id);
5491 if ((rc = spool_read_header(spoolname, TRUE, TRUE)) != spool_read_OK)
5493 if (errno == ERRNO_SPOOLFORMAT)
5495 struct stat statbuf;
5496 if (Ustat(spool_fname(US"input", message_subdir, spoolname, US""),
5498 log_write(0, LOG_MAIN, "Format error in spool file %s: "
5499 "size=" OFF_T_FMT, spoolname, statbuf.st_size);
5501 log_write(0, LOG_MAIN, "Format error in spool file %s", spoolname);
5504 log_write(0, LOG_MAIN, "Error reading spool file %s: %s", spoolname,
5507 /* If we managed to read the envelope data, received_time contains the
5508 time the message was received. Otherwise, we can calculate it from the
5511 if (rc != spool_read_hdrerror)
5514 for (i = 0; i < 6; i++)
5515 received_time = received_time * BASE_62 + tab62[id[i] - '0'];
5518 /* If we've had this malformed message too long, sling it. */
5520 if (now - received_time > keep_malformed)
5522 Uunlink(spool_fname(US"msglog", message_subdir, id, US""));
5523 Uunlink(spool_fname(US"input", message_subdir, id, US"-D"));
5524 Uunlink(spool_fname(US"input", message_subdir, id, US"-H"));
5525 Uunlink(spool_fname(US"input", message_subdir, id, US"-J"));
5526 log_write(0, LOG_MAIN, "Message removed because older than %s",
5527 readconf_printtime(keep_malformed));
5530 (void)close(deliver_datafile);
5531 deliver_datafile = -1;
5532 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5536 /* The spool header file has been read. Look to see if there is an existing
5537 journal file for this message. If there is, it means that a previous delivery
5538 attempt crashed (program or host) before it could update the spool header file.
5539 Read the list of delivered addresses from the journal and add them to the
5540 nonrecipients tree. Then update the spool file. We can leave the journal in
5541 existence, as it will get further successful deliveries added to it in this
5542 run, and it will be deleted if this function gets to its end successfully.
5543 Otherwise it might be needed again. */
5546 uschar * fname = spool_fname(US"input", message_subdir, id, US"-J");
5549 if ( (journal_fd = Uopen(fname, O_RDWR|O_APPEND
5557 && lseek(journal_fd, 0, SEEK_SET) == 0
5558 && (jread = fdopen(journal_fd, "rb"))
5561 while (Ufgets(big_buffer, big_buffer_size, jread))
5563 int n = Ustrlen(big_buffer);
5564 big_buffer[n-1] = 0;
5565 tree_add_nonrecipient(big_buffer);
5566 DEBUG(D_deliver) debug_printf("Previously delivered address %s taken from "
5567 "journal file\n", big_buffer);
5570 if ((journal_fd = dup(fileno(jread))) < 0)
5571 journal_fd = fileno(jread);
5573 (void) fclose(jread); /* Try to not leak the FILE resource */
5575 /* Panic-dies on error */
5576 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
5578 else if (errno != ENOENT)
5580 log_write(0, LOG_MAIN|LOG_PANIC, "attempt to open journal for reading gave: "
5581 "%s", strerror(errno));
5582 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5585 /* A null recipients list indicates some kind of disaster. */
5587 if (!recipients_list)
5589 (void)close(deliver_datafile);
5590 deliver_datafile = -1;
5591 log_write(0, LOG_MAIN, "Spool error: no recipients for %s", fname);
5592 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5597 /* Handle a message that is frozen. There are a number of different things that
5598 can happen, but in the default situation, unless forced, no delivery is
5603 #ifdef SUPPORT_MOVE_FROZEN_MESSAGES
5604 /* Moving to another directory removes the message from Exim's view. Other
5605 tools must be used to deal with it. Logging of this action happens in
5606 spool_move_message() and its subfunctions. */
5608 if ( move_frozen_messages
5609 && spool_move_message(id, message_subdir, US"", US"F")
5611 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5614 /* For all frozen messages (bounces or not), timeout_frozen_after sets the
5615 maximum time to keep messages that are frozen. Thaw if we reach it, with a
5616 flag causing all recipients to be failed. The time is the age of the
5617 message, not the time since freezing. */
5619 if (timeout_frozen_after > 0 && message_age >= timeout_frozen_after)
5621 log_write(0, LOG_MAIN, "cancelled by timeout_frozen_after");
5622 process_recipients = RECIP_FAIL_TIMEOUT;
5625 /* For bounce messages (and others with no sender), thaw if the error message
5626 ignore timer is exceeded. The message will be discarded if this delivery
5629 else if (!*sender_address && message_age >= ignore_bounce_errors_after)
5630 log_write(0, LOG_MAIN, "Unfrozen by errmsg timer");
5632 /* If this is a bounce message, or there's no auto thaw, or we haven't
5633 reached the auto thaw time yet, and this delivery is not forced by an admin
5634 user, do not attempt delivery of this message. Note that forced is set for
5635 continuing messages down the same channel, in order to skip load checking and
5636 ignore hold domains, but we don't want unfreezing in that case. */
5640 if ( ( sender_address[0] == 0
5642 || now <= deliver_frozen_at + auto_thaw
5644 && ( !forced || !deliver_force_thaw
5645 || !admin_user || continue_hostname
5648 (void)close(deliver_datafile);
5649 deliver_datafile = -1;
5650 log_write(L_skip_delivery, LOG_MAIN, "Message is frozen");
5651 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5654 /* If delivery was forced (by an admin user), assume a manual thaw.
5655 Otherwise it's an auto thaw. */
5659 deliver_manual_thaw = TRUE;
5660 log_write(0, LOG_MAIN, "Unfrozen by forced delivery");
5662 else log_write(0, LOG_MAIN, "Unfrozen by auto-thaw");
5665 /* We get here if any of the rules for unfreezing have triggered. */
5667 deliver_freeze = FALSE;
5668 update_spool = TRUE;
5672 /* Open the message log file if we are using them. This records details of
5673 deliveries, deferments, and failures for the benefit of the mail administrator.
5674 The log is not used by exim itself to track the progress of a message; that is
5675 done by rewriting the header spool file. */
5679 uschar * fname = spool_fname(US"msglog", message_subdir, id, US"");
5683 if ((fd = open_msglog_file(fname, SPOOL_MODE, &error)) < 0)
5685 log_write(0, LOG_MAIN|LOG_PANIC, "Couldn't %s message log %s: %s", error,
5686 fname, strerror(errno));
5687 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5690 /* Make a C stream out of it. */
5692 if (!(message_log = fdopen(fd, "a")))
5694 log_write(0, LOG_MAIN|LOG_PANIC, "Couldn't fdopen message log %s: %s",
5695 fname, strerror(errno));
5696 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5701 /* If asked to give up on a message, log who did it, and set the action for all
5706 struct passwd *pw = getpwuid(real_uid);
5707 log_write(0, LOG_MAIN, "cancelled by %s",
5708 pw ? US pw->pw_name : string_sprintf("uid %ld", (long int)real_uid));
5709 process_recipients = RECIP_FAIL;
5712 /* Otherwise, if there are too many Received: headers, fail all recipients. */
5714 else if (received_count > received_headers_max)
5715 process_recipients = RECIP_FAIL_LOOP;
5717 /* Otherwise, if a system-wide, address-independent message filter is
5718 specified, run it now, except in the case when we are failing all recipients as
5719 a result of timeout_frozen_after. If the system filter yields "delivered", then
5720 ignore the true recipients of the message. Failure of the filter file is
5721 logged, and the delivery attempt fails. */
5723 else if (system_filter && process_recipients != RECIP_FAIL_TIMEOUT)
5728 redirect_block redirect;
5730 if (system_filter_uid_set)
5732 ugid.uid = system_filter_uid;
5733 ugid.gid = system_filter_gid;
5734 ugid.uid_set = ugid.gid_set = TRUE;
5738 ugid.uid_set = ugid.gid_set = FALSE;
5741 return_path = sender_address;
5742 enable_dollar_recipients = TRUE; /* Permit $recipients in system filter */
5743 system_filtering = TRUE;
5745 /* Any error in the filter file causes a delivery to be abandoned. */
5747 redirect.string = system_filter;
5748 redirect.isfile = TRUE;
5749 redirect.check_owner = redirect.check_group = FALSE;
5750 redirect.owners = NULL;
5751 redirect.owngroups = NULL;
5753 redirect.modemask = 0;
5755 DEBUG(D_deliver|D_filter) debug_printf("running system filter\n");
5758 &redirect, /* Where the data is */
5759 RDO_DEFER | /* Turn on all the enabling options */
5760 RDO_FAIL | /* Leave off all the disabling options */
5765 NULL, /* No :include: restriction (not used in filter) */
5766 NULL, /* No sieve vacation directory (not sieve!) */
5767 NULL, /* No sieve enotify mailto owner (not sieve!) */
5768 NULL, /* No sieve user address (not sieve!) */
5769 NULL, /* No sieve subaddress (not sieve!) */
5770 &ugid, /* uid/gid data */
5771 &addr_new, /* Where to hang generated addresses */
5772 &filter_message, /* Where to put error message */
5773 NULL, /* Don't skip syntax errors */
5774 &filtertype, /* Will always be set to FILTER_EXIM for this call */
5775 US"system filter"); /* For error messages */
5777 DEBUG(D_deliver|D_filter) debug_printf("system filter returned %d\n", rc);
5779 if (rc == FF_ERROR || rc == FF_NONEXIST)
5781 (void)close(deliver_datafile);
5782 deliver_datafile = -1;
5783 log_write(0, LOG_MAIN|LOG_PANIC, "Error in system filter: %s",
5784 string_printing(filter_message));
5785 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5788 /* Reset things. If the filter message is an empty string, which can happen
5789 for a filter "fail" or "freeze" command with no text, reset it to NULL. */
5791 system_filtering = FALSE;
5792 enable_dollar_recipients = FALSE;
5793 if (filter_message && filter_message[0] == 0) filter_message = NULL;
5795 /* Save the values of the system filter variables so that user filters
5798 memcpy(filter_sn, filter_n, sizeof(filter_sn));
5800 /* The filter can request that delivery of the original addresses be
5805 process_recipients = RECIP_DEFER;
5806 deliver_msglog("Delivery deferred by system filter\n");
5807 log_write(0, LOG_MAIN, "Delivery deferred by system filter");
5810 /* The filter can request that a message be frozen, but this does not
5811 take place if the message has been manually thawed. In that case, we must
5812 unset "delivered", which is forced by the "freeze" command to make -bF
5815 else if (rc == FF_FREEZE && !deliver_manual_thaw)
5817 deliver_freeze = TRUE;
5818 deliver_frozen_at = time(NULL);
5819 process_recipients = RECIP_DEFER;
5820 frozen_info = string_sprintf(" by the system filter%s%s",
5821 filter_message ? US": " : US"",
5822 filter_message ? filter_message : US"");
5825 /* The filter can request that a message be failed. The error message may be
5826 quite long - it is sent back to the sender in the bounce - but we don't want
5827 to fill up the log with repetitions of it. If it starts with << then the text
5828 between << and >> is written to the log, with the rest left for the bounce
5831 else if (rc == FF_FAIL)
5833 uschar *colon = US"";
5834 uschar *logmsg = US"";
5837 process_recipients = RECIP_FAIL_FILTER;
5843 if ( filter_message[0] == '<'
5844 && filter_message[1] == '<'
5845 && (logend = Ustrstr(filter_message, ">>"))
5848 logmsg = filter_message + 2;
5849 loglen = logend - logmsg;
5850 filter_message = logend + 2;
5851 if (filter_message[0] == 0) filter_message = NULL;
5855 logmsg = filter_message;
5856 loglen = Ustrlen(filter_message);
5860 log_write(0, LOG_MAIN, "cancelled by system filter%s%.*s", colon, loglen,
5864 /* Delivery can be restricted only to those recipients (if any) that the
5865 filter specified. */
5867 else if (rc == FF_DELIVERED)
5869 process_recipients = RECIP_IGNORE;
5871 log_write(0, LOG_MAIN, "original recipients ignored (system filter)");
5873 log_write(0, LOG_MAIN, "=> discarded (system filter)");
5876 /* If any new addresses were created by the filter, fake up a "parent"
5877 for them. This is necessary for pipes, etc., which are expected to have
5878 parents, and it also gives some sensible logging for others. Allow
5879 pipes, files, and autoreplies, and run them as the filter uid if set,
5880 otherwise as the current uid. */
5884 int uid = (system_filter_uid_set)? system_filter_uid : geteuid();
5885 int gid = (system_filter_gid_set)? system_filter_gid : getegid();
5887 /* The text "system-filter" is tested in transport_set_up_command() and in
5888 set_up_shell_command() in the pipe transport, to enable them to permit
5889 $recipients, so don't change it here without also changing it there. */
5891 address_item *p = addr_new;
5892 address_item *parent = deliver_make_addr(US"system-filter", FALSE);
5894 parent->domain = string_copylc(qualify_domain_recipient);
5895 parent->local_part = US"system-filter";
5897 /* As part of this loop, we arrange for addr_last to end up pointing
5898 at the final address. This is used if we go on to add addresses for the
5899 original recipients. */
5903 if (parent->child_count == USHRT_MAX)
5904 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "system filter generated more "
5905 "than %d delivery addresses", USHRT_MAX);
5906 parent->child_count++;
5909 if (testflag(p, af_pfr))
5915 setflag(p, af_uid_set |
5921 /* Find the name of the system filter's appropriate pfr transport */
5923 if (p->address[0] == '|')
5926 tpname = system_filter_pipe_transport;
5927 address_pipe = p->address;
5929 else if (p->address[0] == '>')
5932 tpname = system_filter_reply_transport;
5936 if (p->address[Ustrlen(p->address)-1] == '/')
5938 type = US"directory";
5939 tpname = system_filter_directory_transport;
5944 tpname = system_filter_file_transport;
5946 address_file = p->address;
5949 /* Now find the actual transport, first expanding the name. We have
5950 set address_file or address_pipe above. */
5954 uschar *tmp = expand_string(tpname);
5955 address_file = address_pipe = NULL;
5957 p->message = string_sprintf("failed to expand \"%s\" as a "
5958 "system filter transport name", tpname);
5962 p->message = string_sprintf("system_filter_%s_transport is unset",
5967 transport_instance *tp;
5968 for (tp = transports; tp; tp = tp->next)
5969 if (Ustrcmp(tp->name, tpname) == 0)
5975 p->message = string_sprintf("failed to find \"%s\" transport "
5976 "for system filter delivery", tpname);
5979 /* If we couldn't set up a transport, defer the delivery, putting the
5980 error on the panic log as well as the main log. */
5984 address_item *badp = p;
5986 if (!addr_last) addr_new = p; else addr_last->next = p;
5987 badp->local_part = badp->address; /* Needed for log line */
5988 post_process_one(badp, DEFER, LOG_MAIN|LOG_PANIC, DTYPE_ROUTER, 0);
5991 } /* End of pfr handling */
5993 /* Either a non-pfr delivery, or we found a transport */
5995 DEBUG(D_deliver|D_filter)
5996 debug_printf("system filter added %s\n", p->address);
6000 } /* Loop through all addr_new addresses */
6005 /* Scan the recipients list, and for every one that is not in the non-
6006 recipients tree, add an addr item to the chain of new addresses. If the pno
6007 value is non-negative, we must set the onetime parent from it. This which
6008 points to the relevant entry in the recipients list.
6010 This processing can be altered by the setting of the process_recipients
6011 variable, which is changed if recipients are to be ignored, failed, or
6012 deferred. This can happen as a result of system filter activity, or if the -Mg
6013 option is used to fail all of them.
6015 Duplicate addresses are handled later by a different tree structure; we can't
6016 just extend the non-recipients tree, because that will be re-written to the
6017 spool if the message is deferred, and in any case there are casing
6018 complications for local addresses. */
6020 if (process_recipients != RECIP_IGNORE)
6022 for (i = 0; i < recipients_count; i++)
6024 if (!tree_search(tree_nonrecipients, recipients_list[i].address))
6026 recipient_item *r = recipients_list + i;
6027 address_item *new = deliver_make_addr(r->address, FALSE);
6028 new->prop.errors_address = r->errors_to;
6030 if ((new->prop.utf8_msg = message_smtputf8))
6032 new->prop.utf8_downcvt = message_utf8_downconvert == 1;
6033 new->prop.utf8_downcvt_maybe = message_utf8_downconvert == -1;
6034 DEBUG(D_deliver) debug_printf("utf8, downconvert %s\n",
6035 new->prop.utf8_downcvt ? "yes"
6036 : new->prop.utf8_downcvt_maybe ? "ifneeded"
6042 new->onetime_parent = recipients_list[r->pno].address;
6044 /* If DSN support is enabled, set the dsn flags and the original receipt
6045 to be passed on to other DSN enabled MTAs */
6046 new->dsn_flags = r->dsn_flags & rf_dsnflags;
6047 new->dsn_orcpt = r->orcpt;
6048 DEBUG(D_deliver) debug_printf("DSN: set orcpt: %s flags: %d\n",
6049 new->dsn_orcpt, new->dsn_flags);
6051 switch (process_recipients)
6053 /* RECIP_DEFER is set when a system filter freezes a message. */
6056 new->next = addr_defer;
6061 /* RECIP_FAIL_FILTER is set when a system filter has obeyed a "fail"
6064 case RECIP_FAIL_FILTER:
6066 filter_message ? filter_message : US"delivery cancelled";
6067 setflag(new, af_pass_message);
6068 goto RECIP_QUEUE_FAILED; /* below */
6071 /* RECIP_FAIL_TIMEOUT is set when a message is frozen, but is older
6072 than the value in timeout_frozen_after. Treat non-bounce messages
6073 similarly to -Mg; for bounce messages we just want to discard, so
6074 don't put the address on the failed list. The timeout has already
6077 case RECIP_FAIL_TIMEOUT:
6078 new->message = US"delivery cancelled; message timed out";
6079 goto RECIP_QUEUE_FAILED; /* below */
6082 /* RECIP_FAIL is set when -Mg has been used. */
6085 new->message = US"delivery cancelled by administrator";
6088 /* Common code for the failure cases above. If this is not a bounce
6089 message, put the address on the failed list so that it is used to
6090 create a bounce. Otherwise do nothing - this just discards the address.
6091 The incident has already been logged. */
6094 if (sender_address[0] != 0)
6096 new->next = addr_failed;
6102 /* RECIP_FAIL_LOOP is set when there are too many Received: headers
6103 in the message. Process each address as a routing failure; if this
6104 is a bounce message, it will get frozen. */
6106 case RECIP_FAIL_LOOP:
6107 new->message = US"Too many \"Received\" headers - suspected mail loop";
6108 post_process_one(new, FAIL, LOG_MAIN, DTYPE_ROUTER, 0);
6112 /* Value should be RECIP_ACCEPT; take this as the safe default. */
6115 if (!addr_new) addr_new = new; else addr_last->next = new;
6120 #ifndef DISABLE_EVENT
6121 if (process_recipients != RECIP_ACCEPT)
6123 uschar * save_local = deliver_localpart;
6124 const uschar * save_domain = deliver_domain;
6126 deliver_localpart = expand_string(
6127 string_sprintf("${local_part:%s}", new->address));
6128 deliver_domain = expand_string(
6129 string_sprintf("${domain:%s}", new->address));
6131 (void) event_raise(event_action,
6132 US"msg:fail:internal", new->message);
6134 deliver_localpart = save_local;
6135 deliver_domain = save_domain;
6145 debug_printf("Delivery address list:\n");
6146 for (p = addr_new; p; p = p->next)
6147 debug_printf(" %s %s\n", p->address,
6148 p->onetime_parent ? p->onetime_parent : US"");
6151 /* Set up the buffers used for copying over the file when delivering. */
6153 deliver_in_buffer = store_malloc(DELIVER_IN_BUFFER_SIZE);
6154 deliver_out_buffer = store_malloc(DELIVER_OUT_BUFFER_SIZE);
6158 /* Until there are no more new addresses, handle each one as follows:
6160 . If this is a generated address (indicated by the presence of a parent
6161 pointer) then check to see whether it is a pipe, file, or autoreply, and
6162 if so, handle it directly here. The router that produced the address will
6163 have set the allow flags into the address, and also set the uid/gid required.
6164 Having the routers generate new addresses and then checking them here at
6165 the outer level is tidier than making each router do the checking, and
6166 means that routers don't need access to the failed address queue.
6168 . Break up the address into local part and domain, and make lowercased
6169 versions of these strings. We also make unquoted versions of the local part.
6171 . Handle the percent hack for those domains for which it is valid.
6173 . For child addresses, determine if any of the parents have the same address.
6174 If so, generate a different string for previous delivery checking. Without
6175 this code, if the address spqr generates spqr via a forward or alias file,
6176 delivery of the generated spqr stops further attempts at the top level spqr,
6177 which is not what is wanted - it may have generated other addresses.
6179 . Check on the retry database to see if routing was previously deferred, but
6180 only if in a queue run. Addresses that are to be routed are put on the
6181 addr_route chain. Addresses that are to be deferred are put on the
6182 addr_defer chain. We do all the checking first, so as not to keep the
6183 retry database open any longer than necessary.
6185 . Now we run the addresses through the routers. A router may put the address
6186 on either the addr_local or the addr_remote chain for local or remote
6187 delivery, respectively, or put it on the addr_failed chain if it is
6188 undeliveable, or it may generate child addresses and put them on the
6189 addr_new chain, or it may defer an address. All the chain anchors are
6190 passed as arguments so that the routers can be called for verification
6193 . If new addresses have been generated by the routers, da capo.
6196 header_rewritten = FALSE; /* No headers rewritten yet */
6197 while (addr_new) /* Loop until all addresses dealt with */
6199 address_item *addr, *parent;
6201 /* Failure to open the retry database is treated the same as if it does
6202 not exist. In both cases, dbm_file is NULL. */
6204 if (!(dbm_file = dbfn_open(US"retry", O_RDONLY, &dbblock, FALSE)))
6206 DEBUG(D_deliver|D_retry|D_route|D_hints_lookup)
6207 debug_printf("no retry data available\n");
6210 /* Scan the current batch of new addresses, to handle pipes, files and
6211 autoreplies, and determine which others are ready for routing. */
6218 dbdata_retry *domain_retry_record;
6219 dbdata_retry *address_retry_record;
6222 addr_new = addr->next;
6224 DEBUG(D_deliver|D_retry|D_route)
6226 debug_printf(">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>\n");
6227 debug_printf("Considering: %s\n", addr->address);
6230 /* Handle generated address that is a pipe or a file or an autoreply. */
6232 if (testflag(addr, af_pfr))
6234 /* If an autoreply in a filter could not generate a syntactically valid
6235 address, give up forthwith. Set af_ignore_error so that we don't try to
6236 generate a bounce. */
6238 if (testflag(addr, af_bad_reply))
6240 addr->basic_errno = ERRNO_BADADDRESS2;
6241 addr->local_part = addr->address;
6243 US"filter autoreply generated syntactically invalid recipient";
6244 setflag(addr, af_ignore_error);
6245 (void)post_process_one(addr, FAIL, LOG_MAIN, DTYPE_ROUTER, 0);
6246 continue; /* with the next new address */
6249 /* If two different users specify delivery to the same pipe or file or
6250 autoreply, there should be two different deliveries, so build a unique
6251 string that incorporates the original address, and use this for
6252 duplicate testing and recording delivery, and also for retrying. */
6255 string_sprintf("%s:%s", addr->address, addr->parent->unique +
6256 (testflag(addr->parent, af_homonym)? 3:0));
6258 addr->address_retry_key = addr->domain_retry_key =
6259 string_sprintf("T:%s", addr->unique);
6261 /* If a filter file specifies two deliveries to the same pipe or file,
6262 we want to de-duplicate, but this is probably not wanted for two mail
6263 commands to the same address, where probably both should be delivered.
6264 So, we have to invent a different unique string in that case. Just
6265 keep piling '>' characters on the front. */
6267 if (addr->address[0] == '>')
6269 while (tree_search(tree_duplicates, addr->unique))
6270 addr->unique = string_sprintf(">%s", addr->unique);
6273 else if ((tnode = tree_search(tree_duplicates, addr->unique)))
6275 DEBUG(D_deliver|D_route)
6276 debug_printf("%s is a duplicate address: discarded\n", addr->address);
6277 addr->dupof = tnode->data.ptr;
6278 addr->next = addr_duplicate;
6279 addr_duplicate = addr;
6283 DEBUG(D_deliver|D_route) debug_printf("unique = %s\n", addr->unique);
6285 /* Check for previous delivery */
6287 if (tree_search(tree_nonrecipients, addr->unique))
6289 DEBUG(D_deliver|D_route)
6290 debug_printf("%s was previously delivered: discarded\n", addr->address);
6291 child_done(addr, tod_stamp(tod_log));
6295 /* Save for checking future duplicates */
6297 tree_add_duplicate(addr->unique, addr);
6299 /* Set local part and domain */
6301 addr->local_part = addr->address;
6302 addr->domain = addr->parent->domain;
6304 /* Ensure that the delivery is permitted. */
6306 if (testflag(addr, af_file))
6308 if (!testflag(addr, af_allow_file))
6310 addr->basic_errno = ERRNO_FORBIDFILE;
6311 addr->message = US"delivery to file forbidden";
6312 (void)post_process_one(addr, FAIL, LOG_MAIN, DTYPE_ROUTER, 0);
6313 continue; /* with the next new address */
6316 else if (addr->address[0] == '|')
6318 if (!testflag(addr, af_allow_pipe))
6320 addr->basic_errno = ERRNO_FORBIDPIPE;
6321 addr->message = US"delivery to pipe forbidden";
6322 (void)post_process_one(addr, FAIL, LOG_MAIN, DTYPE_ROUTER, 0);
6323 continue; /* with the next new address */
6326 else if (!testflag(addr, af_allow_reply))
6328 addr->basic_errno = ERRNO_FORBIDREPLY;
6329 addr->message = US"autoreply forbidden";
6330 (void)post_process_one(addr, FAIL, LOG_MAIN, DTYPE_ROUTER, 0);
6331 continue; /* with the next new address */
6334 /* If the errno field is already set to BADTRANSPORT, it indicates
6335 failure to expand a transport string, or find the associated transport,
6336 or an unset transport when one is required. Leave this test till now so
6337 that the forbid errors are given in preference. */
6339 if (addr->basic_errno == ERRNO_BADTRANSPORT)
6341 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_ROUTER, 0);
6345 /* Treat /dev/null as a special case and abandon the delivery. This
6346 avoids having to specify a uid on the transport just for this case.
6347 Arrange for the transport name to be logged as "**bypassed**". */
6349 if (Ustrcmp(addr->address, "/dev/null") == 0)
6351 uschar *save = addr->transport->name;
6352 addr->transport->name = US"**bypassed**";
6353 (void)post_process_one(addr, OK, LOG_MAIN, DTYPE_TRANSPORT, '=');
6354 addr->transport->name = save;
6355 continue; /* with the next new address */
6358 /* Pipe, file, or autoreply delivery is to go ahead as a normal local
6361 DEBUG(D_deliver|D_route)
6362 debug_printf("queued for %s transport\n", addr->transport->name);
6363 addr->next = addr_local;
6365 continue; /* with the next new address */
6368 /* Handle normal addresses. First, split up into local part and domain,
6369 handling the %-hack if necessary. There is the possibility of a defer from
6370 a lookup in percent_hack_domains. */
6372 if ((rc = deliver_split_address(addr)) == DEFER)
6374 addr->message = US"cannot check percent_hack_domains";
6375 addr->basic_errno = ERRNO_LISTDEFER;
6376 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_NONE, 0);
6380 /* Check to see if the domain is held. If so, proceed only if the
6381 delivery was forced by hand. */
6383 deliver_domain = addr->domain; /* set $domain */
6384 if ( !forced && hold_domains
6385 && (rc = match_isinlist(addr->domain, (const uschar **)&hold_domains, 0,
6386 &domainlist_anchor, addr->domain_cache, MCL_DOMAIN, TRUE,
6392 addr->message = US"hold_domains lookup deferred";
6393 addr->basic_errno = ERRNO_LISTDEFER;
6397 addr->message = US"domain is held";
6398 addr->basic_errno = ERRNO_HELD;
6400 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_NONE, 0);
6404 /* Now we can check for duplicates and previously delivered addresses. In
6405 order to do this, we have to generate a "unique" value for each address,
6406 because there may be identical actual addresses in a line of descendents.
6407 The "unique" field is initialized to the same value as the "address" field,
6408 but gets changed here to cope with identically-named descendents. */
6410 for (parent = addr->parent; parent; parent = parent->parent)
6411 if (strcmpic(addr->address, parent->address) == 0) break;
6413 /* If there's an ancestor with the same name, set the homonym flag. This
6414 influences how deliveries are recorded. Then add a prefix on the front of
6415 the unique address. We use \n\ where n starts at 0 and increases each time.
6416 It is unlikely to pass 9, but if it does, it may look odd but will still
6417 work. This means that siblings or cousins with the same names are treated
6418 as duplicates, which is what we want. */
6422 setflag(addr, af_homonym);
6423 if (parent->unique[0] != '\\')
6424 addr->unique = string_sprintf("\\0\\%s", addr->address);
6426 addr->unique = string_sprintf("\\%c\\%s", parent->unique[1] + 1,
6430 /* Ensure that the domain in the unique field is lower cased, because
6431 domains are always handled caselessly. */
6433 p = Ustrrchr(addr->unique, '@');
6434 while (*p != 0) { *p = tolower(*p); p++; }
6436 DEBUG(D_deliver|D_route) debug_printf("unique = %s\n", addr->unique);
6438 if (tree_search(tree_nonrecipients, addr->unique))
6440 DEBUG(D_deliver|D_route)
6441 debug_printf("%s was previously delivered: discarded\n", addr->unique);
6442 child_done(addr, tod_stamp(tod_log));
6446 /* Get the routing retry status, saving the two retry keys (with and
6447 without the local part) for subsequent use. If there is no retry record for
6448 the standard address routing retry key, we look for the same key with the
6449 sender attached, because this form is used by the smtp transport after a
6450 4xx response to RCPT when address_retry_include_sender is true. */
6452 addr->domain_retry_key = string_sprintf("R:%s", addr->domain);
6453 addr->address_retry_key = string_sprintf("R:%s@%s", addr->local_part,
6458 domain_retry_record = dbfn_read(dbm_file, addr->domain_retry_key);
6459 if ( domain_retry_record
6460 && now - domain_retry_record->time_stamp > retry_data_expire
6462 domain_retry_record = NULL; /* Ignore if too old */
6464 address_retry_record = dbfn_read(dbm_file, addr->address_retry_key);
6465 if ( address_retry_record
6466 && now - address_retry_record->time_stamp > retry_data_expire
6468 address_retry_record = NULL; /* Ignore if too old */
6470 if (!address_retry_record)
6472 uschar *altkey = string_sprintf("%s:<%s>", addr->address_retry_key,
6474 address_retry_record = dbfn_read(dbm_file, altkey);
6475 if ( address_retry_record
6476 && now - address_retry_record->time_stamp > retry_data_expire)
6477 address_retry_record = NULL; /* Ignore if too old */
6481 domain_retry_record = address_retry_record = NULL;
6483 DEBUG(D_deliver|D_retry)
6485 if (!domain_retry_record)
6486 debug_printf("no domain retry record\n");
6487 if (!address_retry_record)
6488 debug_printf("no address retry record\n");
6491 /* If we are sending a message down an existing SMTP connection, we must
6492 assume that the message which created the connection managed to route
6493 an address to that connection. We do not want to run the risk of taking
6494 a long time over routing here, because if we do, the server at the other
6495 end of the connection may time it out. This is especially true for messages
6496 with lots of addresses. For this kind of delivery, queue_running is not
6497 set, so we would normally route all addresses. We take a pragmatic approach
6498 and defer routing any addresses that have any kind of domain retry record.
6499 That is, we don't even look at their retry times. It doesn't matter if this
6500 doesn't work occasionally. This is all just an optimization, after all.
6502 The reason for not doing the same for address retries is that they normally
6503 arise from 4xx responses, not DNS timeouts. */
6505 if (continue_hostname && domain_retry_record)
6507 addr->message = US"reusing SMTP connection skips previous routing defer";
6508 addr->basic_errno = ERRNO_RRETRY;
6509 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_ROUTER, 0);
6512 /* If we are in a queue run, defer routing unless there is no retry data or
6513 we've passed the next retry time, or this message is forced. In other
6514 words, ignore retry data when not in a queue run.
6516 However, if the domain retry time has expired, always allow the routing
6517 attempt. If it fails again, the address will be failed. This ensures that
6518 each address is routed at least once, even after long-term routing
6521 If there is an address retry, check that too; just wait for the next
6522 retry time. This helps with the case when the temporary error on the
6523 address was really message-specific rather than address specific, since
6524 it allows other messages through.
6526 We also wait for the next retry time if this is a message sent down an
6527 existing SMTP connection (even though that will be forced). Otherwise there
6528 will be far too many attempts for an address that gets a 4xx error. In
6529 fact, after such an error, we should not get here because, the host should
6530 not be remembered as one this message needs. However, there was a bug that
6531 used to cause this to happen, so it is best to be on the safe side.
6533 Even if we haven't reached the retry time in the hints, there is one more
6534 check to do, which is for the ultimate address timeout. We only do this
6535 check if there is an address retry record and there is not a domain retry
6536 record; this implies that previous attempts to handle the address had the
6537 retry_use_local_parts option turned on. We use this as an approximation
6538 for the destination being like a local delivery, for example delivery over
6539 LMTP to an IMAP message store. In this situation users are liable to bump
6540 into their quota and thereby have intermittently successful deliveries,
6541 which keep the retry record fresh, which can lead to us perpetually
6542 deferring messages. */
6544 else if ( ( queue_running && !deliver_force
6545 || continue_hostname
6547 && ( ( domain_retry_record
6548 && now < domain_retry_record->next_try
6549 && !domain_retry_record->expired
6551 || ( address_retry_record
6552 && now < address_retry_record->next_try
6554 && ( domain_retry_record
6555 || !address_retry_record
6556 || !retry_ultimate_address_timeout(addr->address_retry_key,
6557 addr->domain, address_retry_record, now)
6560 addr->message = US"retry time not reached";
6561 addr->basic_errno = ERRNO_RRETRY;
6562 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_ROUTER, 0);
6565 /* The domain is OK for routing. Remember if retry data exists so it
6566 can be cleaned up after a successful delivery. */
6570 if (domain_retry_record || address_retry_record)
6571 setflag(addr, af_dr_retry_exists);
6572 addr->next = addr_route;
6574 DEBUG(D_deliver|D_route)
6575 debug_printf("%s: queued for routing\n", addr->address);
6579 /* The database is closed while routing is actually happening. Requests to
6580 update it are put on a chain and all processed together at the end. */
6582 if (dbm_file) dbfn_close(dbm_file);
6584 /* If queue_domains is set, we don't even want to try routing addresses in
6585 those domains. During queue runs, queue_domains is forced to be unset.
6586 Optimize by skipping this pass through the addresses if nothing is set. */
6588 if (!deliver_force && queue_domains)
6590 address_item *okaddr = NULL;
6593 address_item *addr = addr_route;
6594 addr_route = addr->next;
6596 deliver_domain = addr->domain; /* set $domain */
6597 if ((rc = match_isinlist(addr->domain, (const uschar **)&queue_domains, 0,
6598 &domainlist_anchor, addr->domain_cache, MCL_DOMAIN, TRUE, NULL))
6603 addr->basic_errno = ERRNO_LISTDEFER;
6604 addr->message = US"queue_domains lookup deferred";
6605 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_ROUTER, 0);
6609 addr->next = okaddr;
6615 addr->basic_errno = ERRNO_QUEUE_DOMAIN;
6616 addr->message = US"domain is in queue_domains";
6617 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_ROUTER, 0);
6621 addr_route = okaddr;
6624 /* Now route those addresses that are not deferred. */
6629 address_item *addr = addr_route;
6630 const uschar *old_domain = addr->domain;
6631 uschar *old_unique = addr->unique;
6632 addr_route = addr->next;
6635 /* Just in case some router parameter refers to it. */
6637 if (!(return_path = addr->prop.errors_address))
6638 return_path = sender_address;
6640 /* If a router defers an address, add a retry item. Whether or not to
6641 use the local part in the key is a property of the router. */
6643 if ((rc = route_address(addr, &addr_local, &addr_remote, &addr_new,
6644 &addr_succeed, v_none)) == DEFER)
6645 retry_add_item(addr,
6646 addr->router->retry_use_local_part
6647 ? string_sprintf("R:%s@%s", addr->local_part, addr->domain)
6648 : string_sprintf("R:%s", addr->domain),
6651 /* Otherwise, if there is an existing retry record in the database, add
6652 retry items to delete both forms. We must also allow for the possibility
6653 of a routing retry that includes the sender address. Since the domain might
6654 have been rewritten (expanded to fully qualified) as a result of routing,
6655 ensure that the rewritten form is also deleted. */
6657 else if (testflag(addr, af_dr_retry_exists))
6659 uschar *altkey = string_sprintf("%s:<%s>", addr->address_retry_key,
6661 retry_add_item(addr, altkey, rf_delete);
6662 retry_add_item(addr, addr->address_retry_key, rf_delete);
6663 retry_add_item(addr, addr->domain_retry_key, rf_delete);
6664 if (Ustrcmp(addr->domain, old_domain) != 0)
6665 retry_add_item(addr, string_sprintf("R:%s", old_domain), rf_delete);
6668 /* DISCARD is given for :blackhole: and "seen finish". The event has been
6669 logged, but we need to ensure the address (and maybe parents) is marked
6674 address_done(addr, tod_stamp(tod_log));
6675 continue; /* route next address */
6678 /* The address is finished with (failed or deferred). */
6682 (void)post_process_one(addr, rc, LOG_MAIN, DTYPE_ROUTER, 0);
6683 continue; /* route next address */
6686 /* The address has been routed. If the router changed the domain, it will
6687 also have changed the unique address. We have to test whether this address
6688 has already been delivered, because it's the unique address that finally
6691 if ( addr->unique != old_unique
6692 && tree_search(tree_nonrecipients, addr->unique) != 0
6695 DEBUG(D_deliver|D_route) debug_printf("%s was previously delivered: "
6696 "discarded\n", addr->address);
6697 if (addr_remote == addr) addr_remote = addr->next;
6698 else if (addr_local == addr) addr_local = addr->next;
6701 /* If the router has same_domain_copy_routing set, we are permitted to copy
6702 the routing for any other addresses with the same domain. This is an
6703 optimisation to save repeated DNS lookups for "standard" remote domain
6704 routing. The option is settable only on routers that generate host lists.
6705 We play it very safe, and do the optimization only if the address is routed
6706 to a remote transport, there are no header changes, and the domain was not
6707 modified by the router. */
6709 if ( addr_remote == addr
6710 && addr->router->same_domain_copy_routing
6711 && !addr->prop.extra_headers
6712 && !addr->prop.remove_headers
6713 && old_domain == addr->domain
6716 address_item **chain = &addr_route;
6719 address_item *addr2 = *chain;
6720 if (Ustrcmp(addr2->domain, addr->domain) != 0)
6722 chain = &(addr2->next);
6726 /* Found a suitable address; take it off the routing list and add it to
6727 the remote delivery list. */
6729 *chain = addr2->next;
6730 addr2->next = addr_remote;
6731 addr_remote = addr2;
6733 /* Copy the routing data */
6735 addr2->domain = addr->domain;
6736 addr2->router = addr->router;
6737 addr2->transport = addr->transport;
6738 addr2->host_list = addr->host_list;
6739 addr2->fallback_hosts = addr->fallback_hosts;
6740 addr2->prop.errors_address = addr->prop.errors_address;
6741 copyflag(addr2, addr, af_hide_child | af_local_host_removed);
6743 DEBUG(D_deliver|D_route)
6745 debug_printf(">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>\n"
6747 "Routing for %s copied from %s\n",
6748 addr2->address, addr2->address, addr->address);
6752 } /* Continue with routing the next address. */
6753 } /* Loop to process any child addresses that the routers created, and
6754 any rerouted addresses that got put back on the new chain. */
6757 /* Debugging: show the results of the routing */
6759 DEBUG(D_deliver|D_retry|D_route)
6762 debug_printf(">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>\n");
6763 debug_printf("After routing:\n Local deliveries:\n");
6764 for (p = addr_local; p; p = p->next)
6765 debug_printf(" %s\n", p->address);
6767 debug_printf(" Remote deliveries:\n");
6768 for (p = addr_remote; p; p = p->next)
6769 debug_printf(" %s\n", p->address);
6771 debug_printf(" Failed addresses:\n");
6772 for (p = addr_failed; p; p = p->next)
6773 debug_printf(" %s\n", p->address);
6775 debug_printf(" Deferred addresses:\n");
6776 for (p = addr_defer; p; p = p->next)
6777 debug_printf(" %s\n", p->address);
6780 /* Free any resources that were cached during routing. */
6785 /* These two variables are set only during routing, after check_local_user.
6786 Ensure they are not set in transports. */
6788 local_user_gid = (gid_t)(-1);
6789 local_user_uid = (uid_t)(-1);
6791 /* Check for any duplicate addresses. This check is delayed until after
6792 routing, because the flexibility of the routing configuration means that
6793 identical addresses with different parentage may end up being redirected to
6794 different addresses. Checking for duplicates too early (as we previously used
6795 to) makes this kind of thing not work. */
6797 do_duplicate_check(&addr_local);
6798 do_duplicate_check(&addr_remote);
6800 /* When acting as an MUA wrapper, we proceed only if all addresses route to a
6801 remote transport. The check that they all end up in one transaction happens in
6802 the do_remote_deliveries() function. */
6805 && (addr_local || addr_failed || addr_defer)
6809 uschar *which, *colon, *msg;
6816 else if (addr_defer)
6819 which = US"deferred";
6827 while (addr->parent) addr = addr->parent;
6832 msg = addr->message;
6834 else colon = msg = US"";
6836 /* We don't need to log here for a forced failure as it will already
6837 have been logged. Defer will also have been logged, but as a defer, so we do
6838 need to do the failure logging. */
6840 if (addr != addr_failed)
6841 log_write(0, LOG_MAIN, "** %s routing yielded a %s delivery",
6842 addr->address, which);
6844 /* Always write an error to the caller */
6846 fprintf(stderr, "routing %s yielded a %s delivery%s%s\n", addr->address,
6849 final_yield = DELIVER_MUA_FAILED;
6850 addr_failed = addr_defer = NULL; /* So that we remove the message */
6851 goto DELIVERY_TIDYUP;
6855 /* If this is a run to continue deliveries to an external channel that is
6856 already set up, defer any local deliveries. */
6858 if (continue_transport)
6862 address_item *addr = addr_defer;
6863 while (addr->next) addr = addr->next;
6864 addr->next = addr_local;
6867 addr_defer = addr_local;
6872 /* Because address rewriting can happen in the routers, we should not really do
6873 ANY deliveries until all addresses have been routed, so that all recipients of
6874 the message get the same headers. However, this is in practice not always
6875 possible, since sometimes remote addresses give DNS timeouts for days on end.
6876 The pragmatic approach is to deliver what we can now, saving any rewritten
6877 headers so that at least the next lot of recipients benefit from the rewriting
6878 that has already been done.
6880 If any headers have been rewritten during routing, update the spool file to
6881 remember them for all subsequent deliveries. This can be delayed till later if
6882 there is only address to be delivered - if it succeeds the spool write need not
6885 if ( header_rewritten
6886 && ( addr_local && (addr_local->next || addr_remote)
6887 || addr_remote && addr_remote->next
6890 /* Panic-dies on error */
6891 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
6892 header_rewritten = FALSE;
6896 /* If there are any deliveries to be and we do not already have the journal
6897 file, create it. This is used to record successful deliveries as soon as
6898 possible after each delivery is known to be complete. A file opened with
6899 O_APPEND is used so that several processes can run simultaneously.
6901 The journal is just insurance against crashes. When the spool file is
6902 ultimately updated at the end of processing, the journal is deleted. If a
6903 journal is found to exist at the start of delivery, the addresses listed
6904 therein are added to the non-recipients. */
6906 if (addr_local || addr_remote)
6910 uschar * fname = spool_fname(US"input", message_subdir, id, US"-J");
6912 if ((journal_fd = Uopen(fname,
6916 O_WRONLY|O_APPEND|O_CREAT|O_EXCL, SPOOL_MODE)) < 0)
6918 log_write(0, LOG_MAIN|LOG_PANIC, "Couldn't open journal file %s: %s",
6919 fname, strerror(errno));
6920 return DELIVER_NOT_ATTEMPTED;
6923 /* Set the close-on-exec flag, make the file owned by Exim, and ensure
6924 that the mode is correct - the group setting doesn't always seem to get
6925 set automatically. */
6927 if( fchown(journal_fd, exim_uid, exim_gid)
6928 || fchmod(journal_fd, SPOOL_MODE)
6930 || fcntl(journal_fd, F_SETFD, fcntl(journal_fd, F_GETFD) | FD_CLOEXEC)
6934 int ret = Uunlink(fname);
6935 log_write(0, LOG_MAIN|LOG_PANIC, "Couldn't set perms on journal file %s: %s",
6936 fname, strerror(errno));
6937 if(ret && errno != ENOENT)
6938 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s",
6939 fname, strerror(errno));
6940 return DELIVER_NOT_ATTEMPTED;
6944 else if (journal_fd >= 0)
6952 /* Now we can get down to the business of actually doing deliveries. Local
6953 deliveries are done first, then remote ones. If ever the problems of how to
6954 handle fallback transports are figured out, this section can be put into a loop
6955 for handling fallbacks, though the uid switching will have to be revised. */
6957 /* Precompile a regex that is used to recognize a parameter in response
6958 to an LHLO command, if is isn't already compiled. This may be used on both
6959 local and remote LMTP deliveries. */
6961 if (!regex_IGNOREQUOTA)
6963 regex_must_compile(US"\\n250[\\s\\-]IGNOREQUOTA(\\s|\\n|$)", FALSE, TRUE);
6965 /* Handle local deliveries */
6969 DEBUG(D_deliver|D_transport)
6970 debug_printf(">>>>>>>>>>>>>>>> Local deliveries >>>>>>>>>>>>>>>>\n");
6971 do_local_deliveries();
6972 disable_logging = FALSE;
6975 /* If queue_run_local is set, we do not want to attempt any remote deliveries,
6976 so just queue them all. */
6978 if (queue_run_local)
6981 address_item *addr = addr_remote;
6982 addr_remote = addr->next;
6984 addr->basic_errno = ERRNO_LOCAL_ONLY;
6985 addr->message = US"remote deliveries suppressed";
6986 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_TRANSPORT, 0);
6989 /* Handle remote deliveries */
6993 DEBUG(D_deliver|D_transport)
6994 debug_printf(">>>>>>>>>>>>>>>> Remote deliveries >>>>>>>>>>>>>>>>\n");
6996 /* Precompile some regex that are used to recognize parameters in response
6997 to an EHLO command, if they aren't already compiled. */
7001 /* Now sort the addresses if required, and do the deliveries. The yield of
7002 do_remote_deliveries is FALSE when mua_wrapper is set and all addresses
7003 cannot be delivered in one transaction. */
7005 if (remote_sort_domains) sort_remote_deliveries();
7006 if (!do_remote_deliveries(FALSE))
7008 log_write(0, LOG_MAIN, "** mua_wrapper is set but recipients cannot all "
7009 "be delivered in one transaction");
7010 fprintf(stderr, "delivery to smarthost failed (configuration problem)\n");
7012 final_yield = DELIVER_MUA_FAILED;
7013 addr_failed = addr_defer = NULL; /* So that we remove the message */
7014 goto DELIVERY_TIDYUP;
7017 /* See if any of the addresses that failed got put on the queue for delivery
7018 to their fallback hosts. We do it this way because often the same fallback
7019 host is used for many domains, so all can be sent in a single transaction
7020 (if appropriately configured). */
7022 if (addr_fallback && !mua_wrapper)
7024 DEBUG(D_deliver) debug_printf("Delivering to fallback hosts\n");
7025 addr_remote = addr_fallback;
7026 addr_fallback = NULL;
7027 if (remote_sort_domains) sort_remote_deliveries();
7028 do_remote_deliveries(TRUE);
7030 disable_logging = FALSE;
7034 /* All deliveries are now complete. Ignore SIGTERM during this tidying up
7035 phase, to minimize cases of half-done things. */
7038 debug_printf(">>>>>>>>>>>>>>>> deliveries are done >>>>>>>>>>>>>>>>\n");
7040 /* Root privilege is no longer needed */
7042 exim_setugid(exim_uid, exim_gid, FALSE, US"post-delivery tidying");
7044 set_process_info("tidying up after delivering %s", message_id);
7045 signal(SIGTERM, SIG_IGN);
7047 /* When we are acting as an MUA wrapper, the smtp transport will either have
7048 succeeded for all addresses, or failed them all in normal cases. However, there
7049 are some setup situations (e.g. when a named port does not exist) that cause an
7050 immediate exit with deferral of all addresses. Convert those into failures. We
7051 do not ever want to retry, nor do we want to send a bounce message. */
7057 address_item *addr, *nextaddr;
7058 for (addr = addr_defer; addr; addr = nextaddr)
7060 log_write(0, LOG_MAIN, "** %s mua_wrapper forced failure for deferred "
7061 "delivery", addr->address);
7062 nextaddr = addr->next;
7063 addr->next = addr_failed;
7069 /* Now all should either have succeeded or failed. */
7072 final_yield = DELIVER_MUA_SUCCEEDED;
7076 uschar *s = addr_failed->user_message;
7078 if (!s) s = addr_failed->message;
7080 fprintf(stderr, "Delivery failed: ");
7081 if (addr_failed->basic_errno > 0)
7083 fprintf(stderr, "%s", strerror(addr_failed->basic_errno));
7084 if (s) fprintf(stderr, ": ");
7086 if ((host = addr_failed->host_used))
7087 fprintf(stderr, "H=%s [%s]: ", host->name, host->address);
7089 fprintf(stderr, "%s", CS s);
7090 else if (addr_failed->basic_errno <= 0)
7091 fprintf(stderr, "unknown error");
7092 fprintf(stderr, "\n");
7094 final_yield = DELIVER_MUA_FAILED;
7099 /* In a normal configuration, we now update the retry database. This is done in
7100 one fell swoop at the end in order not to keep opening and closing (and
7101 locking) the database. The code for handling retries is hived off into a
7102 separate module for convenience. We pass it the addresses of the various
7103 chains, because deferred addresses can get moved onto the failed chain if the
7104 retry cutoff time has expired for all alternative destinations. Bypass the
7105 updating of the database if the -N flag is set, which is a debugging thing that
7106 prevents actual delivery. */
7108 else if (!dont_deliver)
7109 retry_update(&addr_defer, &addr_failed, &addr_succeed);
7111 /* Send DSN for successful messages if requested */
7112 addr_senddsn = NULL;
7114 for (addr_dsntmp = addr_succeed; addr_dsntmp; addr_dsntmp = addr_dsntmp->next)
7116 /* af_ignore_error not honored here. it's not an error */
7117 DEBUG(D_deliver) debug_printf("DSN: processing router : %s\n"
7118 "DSN: processing successful delivery address: %s\n"
7119 "DSN: Sender_address: %s\n"
7120 "DSN: orcpt: %s flags: %d\n"
7121 "DSN: envid: %s ret: %d\n"
7122 "DSN: Final recipient: %s\n"
7123 "DSN: Remote SMTP server supports DSN: %d\n",
7124 addr_dsntmp->router->name,
7125 addr_dsntmp->address,
7127 addr_dsntmp->dsn_orcpt, addr_dsntmp->dsn_flags,
7129 addr_dsntmp->address,
7130 addr_dsntmp->dsn_aware
7133 /* send report if next hop not DSN aware or a router flagged "last DSN hop"
7134 and a report was requested */
7135 if ( ( addr_dsntmp->dsn_aware != dsn_support_yes
7136 || addr_dsntmp->dsn_flags & rf_dsnlasthop
7138 && addr_dsntmp->dsn_flags & rf_dsnflags
7139 && addr_dsntmp->dsn_flags & rf_notify_success
7142 /* copy and relink address_item and send report with all of them at once later */
7143 address_item * addr_next = addr_senddsn;
7144 addr_senddsn = store_get(sizeof(address_item));
7145 *addr_senddsn = *addr_dsntmp;
7146 addr_senddsn->next = addr_next;
7149 DEBUG(D_deliver) debug_printf("DSN: not sending DSN success message\n");
7157 /* create exim process to send message */
7158 pid = child_open_exim(&fd);
7160 DEBUG(D_deliver) debug_printf("DSN: child_open_exim returns: %d\n", pid);
7162 if (pid < 0) /* Creation of child failed */
7164 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Process %d (parent %d) failed to "
7165 "create child process to send failure message: %s", getpid(),
7166 getppid(), strerror(errno));
7168 DEBUG(D_deliver) debug_printf("DSN: child_open_exim failed\n");
7170 else /* Creation of child succeeded */
7172 FILE *f = fdopen(fd, "wb");
7173 /* header only as required by RFC. only failure DSN needs to honor RET=FULL */
7175 transport_ctx tctx = {0};
7178 debug_printf("sending error message to: %s\n", sender_address);
7180 /* build unique id for MIME boundary */
7181 bound = string_sprintf(TIME_T_FMT "-eximdsn-%d", time(NULL), rand());
7182 DEBUG(D_deliver) debug_printf("DSN: MIME boundary: %s\n", bound);
7184 if (errors_reply_to)
7185 fprintf(f, "Reply-To: %s\n", errors_reply_to);
7187 fprintf(f, "Auto-Submitted: auto-generated\n"
7188 "From: Mail Delivery System <Mailer-Daemon@%s>\n"
7190 "Subject: Delivery Status Notification\n"
7191 "Content-Type: multipart/report; report-type=delivery-status; boundary=%s\n"
7192 "MIME-Version: 1.0\n\n"
7195 "Content-type: text/plain; charset=us-ascii\n\n"
7197 "This message was created automatically by mail delivery software.\n"
7198 " ----- The following addresses had successful delivery notifications -----\n",
7199 qualify_domain_sender, sender_address, bound, bound);
7201 for (addr_dsntmp = addr_senddsn; addr_dsntmp;
7202 addr_dsntmp = addr_dsntmp->next)
7203 fprintf(f, "<%s> (relayed %s)\n\n",
7204 addr_dsntmp->address,
7205 (addr_dsntmp->dsn_flags & rf_dsnlasthop) == 1
7206 ? "via non DSN router"
7207 : addr_dsntmp->dsn_aware == dsn_support_no
7208 ? "to non-DSN-aware mailer"
7209 : "via non \"Remote SMTP\" router"
7213 "Content-type: message/delivery-status\n\n"
7214 "Reporting-MTA: dns; %s\n",
7215 bound, smtp_active_hostname);
7218 { /* must be decoded from xtext: see RFC 3461:6.3a */
7220 if (auth_xtextdecode(dsn_envid, &xdec_envid) > 0)
7221 fprintf(f, "Original-Envelope-ID: %s\n", dsn_envid);
7223 fprintf(f, "X-Original-Envelope-ID: error decoding xtext formatted ENVID\n");
7227 for (addr_dsntmp = addr_senddsn;
7229 addr_dsntmp = addr_dsntmp->next)
7231 if (addr_dsntmp->dsn_orcpt)
7232 fprintf(f,"Original-Recipient: %s\n", addr_dsntmp->dsn_orcpt);
7234 fprintf(f, "Action: delivered\n"
7235 "Final-Recipient: rfc822;%s\n"
7237 addr_dsntmp->address);
7239 if (addr_dsntmp->host_used && addr_dsntmp->host_used->name)
7240 fprintf(f, "Remote-MTA: dns; %s\nDiagnostic-Code: smtp; 250 Ok\n\n",
7241 addr_dsntmp->host_used->name);
7243 fprintf(f, "Diagnostic-Code: X-Exim; relayed via non %s router\n\n",
7244 (addr_dsntmp->dsn_flags & rf_dsnlasthop) == 1 ? "DSN" : "SMTP");
7247 fprintf(f, "--%s\nContent-type: text/rfc822-headers\n\n", bound);
7250 transport_filter_argv = NULL; /* Just in case */
7251 return_path = sender_address; /* In case not previously set */
7253 /* Write the original email out */
7255 tctx.options = topt_add_return_path | topt_no_body;
7256 transport_write_message(fileno(f), &tctx, 0);
7259 fprintf(f,"\n--%s--\n", bound);
7263 rc = child_close(pid, 0); /* Waits for child to close, no timeout */
7267 /* If any addresses failed, we must send a message to somebody, unless
7268 af_ignore_error is set, in which case no action is taken. It is possible for
7269 several messages to get sent if there are addresses with different
7276 uschar *logtod = tod_stamp(tod_log);
7278 address_item *handled_addr = NULL;
7279 address_item **paddr;
7280 address_item *msgchain = NULL;
7281 address_item **pmsgchain = &msgchain;
7283 /* There are weird cases when logging is disabled in the transport. However,
7284 there may not be a transport (address failed by a router). */
7286 disable_logging = FALSE;
7287 if (addr_failed->transport)
7288 disable_logging = addr_failed->transport->disable_logging;
7291 debug_printf("processing failed address %s\n", addr_failed->address);
7293 /* There are only two ways an address in a bounce message can get here:
7295 (1) When delivery was initially deferred, but has now timed out (in the call
7296 to retry_update() above). We can detect this by testing for
7297 af_retry_timedout. If the address does not have its own errors address,
7298 we arrange to ignore the error.
7300 (2) If delivery failures for bounce messages are being ignored. We can detect
7301 this by testing for af_ignore_error. This will also be set if a bounce
7302 message has been autothawed and the ignore_bounce_errors_after time has
7303 passed. It might also be set if a router was explicitly configured to
7304 ignore errors (errors_to = "").
7306 If neither of these cases obtains, something has gone wrong. Log the
7307 incident, but then ignore the error. */
7309 if (sender_address[0] == 0 && !addr_failed->prop.errors_address)
7311 if ( !testflag(addr_failed, af_retry_timedout)
7312 && !testflag(addr_failed, af_ignore_error))
7314 log_write(0, LOG_MAIN|LOG_PANIC, "internal error: bounce message "
7315 "failure is neither frozen nor ignored (it's been ignored)");
7317 setflag(addr_failed, af_ignore_error);
7320 /* If the first address on the list has af_ignore_error set, just remove
7321 it from the list, throw away any saved message file, log it, and
7322 mark the recipient done. */
7324 if ( testflag(addr_failed, af_ignore_error)
7325 || ( addr_failed->dsn_flags & rf_dsnflags
7326 && (addr_failed->dsn_flags & rf_notify_failure) != rf_notify_failure
7330 addr_failed = addr->next;
7331 if (addr->return_filename) Uunlink(addr->return_filename);
7333 log_write(0, LOG_MAIN, "%s%s%s%s: error ignored",
7335 !addr->parent ? US"" : US" <",
7336 !addr->parent ? US"" : addr->parent->address,
7337 !addr->parent ? US"" : US">");
7339 address_done(addr, logtod);
7340 child_done(addr, logtod);
7341 /* Panic-dies on error */
7342 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
7345 /* Otherwise, handle the sending of a message. Find the error address for
7346 the first address, then send a message that includes all failed addresses
7347 that have the same error address. Note the bounce_recipient is a global so
7348 that it can be accessed by $bounce_recipient while creating a customized
7353 if (!(bounce_recipient = addr_failed->prop.errors_address))
7354 bounce_recipient = sender_address;
7356 /* Make a subprocess to send a message */
7358 if ((pid = child_open_exim(&fd)) < 0)
7359 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Process %d (parent %d) failed to "
7360 "create child process to send failure message: %s", getpid(),
7361 getppid(), strerror(errno));
7363 /* Creation of child succeeded */
7370 uschar *bcc, *emf_text;
7371 FILE *f = fdopen(fd, "wb");
7373 BOOL to_sender = strcmpic(sender_address, bounce_recipient) == 0;
7374 int max = (bounce_return_size_limit/DELIVER_IN_BUFFER_SIZE + 1) *
7375 DELIVER_IN_BUFFER_SIZE;
7377 uschar *dsnlimitmsg;
7378 uschar *dsnnotifyhdr;
7382 debug_printf("sending error message to: %s\n", bounce_recipient);
7384 /* Scan the addresses for all that have the same errors address, removing
7385 them from the addr_failed chain, and putting them on msgchain. */
7387 paddr = &addr_failed;
7388 for (addr = addr_failed; addr; addr = *paddr)
7389 if (Ustrcmp(bounce_recipient, addr->prop.errors_address
7390 ? addr->prop.errors_address : sender_address) == 0)
7391 { /* The same - dechain */
7392 *paddr = addr->next;
7395 pmsgchain = &(addr->next);
7398 paddr = &addr->next; /* Not the same; skip */
7400 /* Include X-Failed-Recipients: for automatic interpretation, but do
7401 not let any one header line get too long. We do this by starting a
7402 new header every 50 recipients. Omit any addresses for which the
7403 "hide_child" flag is set. */
7405 for (addr = msgchain; addr; addr = addr->next)
7407 if (testflag(addr, af_hide_child)) continue;
7415 ? "X-Failed-Recipients: "
7417 testflag(addr, af_pfr) && addr->parent
7418 ? string_printing(addr->parent->address)
7419 : string_printing(addr->address));
7421 if (rcount > 0) fprintf(f, "\n");
7423 /* Output the standard headers */
7425 if (errors_reply_to)
7426 fprintf(f, "Reply-To: %s\n", errors_reply_to);
7427 fprintf(f, "Auto-Submitted: auto-replied\n");
7429 fprintf(f, "To: %s\n", bounce_recipient);
7431 /* generate boundary string and output MIME-Headers */
7432 bound = string_sprintf(TIME_T_FMT "-eximdsn-%d", time(NULL), rand());
7434 fprintf(f, "Content-Type: multipart/report;"
7435 " report-type=delivery-status; boundary=%s\n"
7436 "MIME-Version: 1.0\n",
7439 /* Open a template file if one is provided. Log failure to open, but
7440 carry on - default texts will be used. */
7442 if (bounce_message_file)
7443 if (!(emf = Ufopen(bounce_message_file, "rb")))
7444 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to open %s for error "
7445 "message texts: %s", bounce_message_file, strerror(errno));
7447 /* Quietly copy to configured additional addresses if required. */
7449 if ((bcc = moan_check_errorcopy(bounce_recipient)))
7450 fprintf(f, "Bcc: %s\n", bcc);
7452 /* The texts for the message can be read from a template file; if there
7453 isn't one, or if it is too short, built-in texts are used. The first
7454 emf text is a Subject: and any other headers. */
7456 if ((emf_text = next_emf(emf, US"header")))
7457 fprintf(f, "%s\n", emf_text);
7459 fprintf(f, "Subject: Mail delivery failed%s\n\n",
7460 to_sender? ": returning message to sender" : "");
7462 /* output human readable part as text/plain section */
7464 "Content-type: text/plain; charset=us-ascii\n\n",
7467 if ((emf_text = next_emf(emf, US"intro")))
7468 fprintf(f, "%s", CS emf_text);
7472 /* This message has been reworded several times. It seems to be confusing to
7473 somebody, however it is worded. I have retreated to the original, simple
7475 "This message was created automatically by mail delivery software.\n");
7477 if (bounce_message_text)
7478 fprintf(f, "%s", CS bounce_message_text);
7481 "\nA message that you sent could not be delivered to one or more of its\n"
7482 "recipients. This is a permanent error. The following address(es) failed:\n");
7485 "\nA message sent by\n\n <%s>\n\n"
7486 "could not be delivered to one or more of its recipients. The following\n"
7487 "address(es) failed:\n", sender_address);
7491 /* Process the addresses, leaving them on the msgchain if they have a
7492 file name for a return message. (There has already been a check in
7493 post_process_one() for the existence of data in the message file.) A TRUE
7494 return from print_address_information() means that the address is not
7498 for (addr = msgchain; addr; addr = *paddr)
7500 if (print_address_information(addr, f, US" ", US"\n ", US""))
7501 print_address_error(addr, f, US"");
7503 /* End the final line for the address */
7507 /* Leave on msgchain if there's a return file. */
7509 if (addr->return_file >= 0)
7511 paddr = &(addr->next);
7515 /* Else save so that we can tick off the recipient when the
7520 *paddr = addr->next;
7521 addr->next = handled_addr;
7522 handled_addr = addr;
7528 /* Get the next text, whether we need it or not, so as to be
7529 positioned for the one after. */
7531 emf_text = next_emf(emf, US"generated text");
7533 /* If there were any file messages passed by the local transports,
7534 include them in the message. Then put the address on the handled chain.
7535 In the case of a batch of addresses that were all sent to the same
7536 transport, the return_file field in all of them will contain the same
7537 fd, and the return_filename field in the *last* one will be set (to the
7538 name of the file). */
7542 address_item *nextaddr;
7545 fprintf(f, "%s", CS emf_text);
7548 "The following text was generated during the delivery "
7549 "attempt%s:\n", (filecount > 1)? "s" : "");
7551 for (addr = msgchain; addr; addr = nextaddr)
7554 address_item *topaddr = addr;
7556 /* List all the addresses that relate to this file */
7559 while(addr) /* Insurance */
7561 print_address_information(addr, f, US"------ ", US"\n ",
7563 if (addr->return_filename) break;
7568 /* Now copy the file */
7570 if (!(fm = Ufopen(addr->return_filename, "rb")))
7571 fprintf(f, " +++ Exim error... failed to open text file: %s\n",
7575 while ((ch = fgetc(fm)) != EOF) fputc(ch, f);
7578 Uunlink(addr->return_filename);
7580 /* Can now add to handled chain, first fishing off the next
7581 address on the msgchain. */
7583 nextaddr = addr->next;
7584 addr->next = handled_addr;
7585 handled_addr = topaddr;
7590 /* output machine readable part */
7592 if (message_smtputf8)
7594 "Content-type: message/global-delivery-status\n\n"
7595 "Reporting-MTA: dns; %s\n",
7596 bound, smtp_active_hostname);
7600 "Content-type: message/delivery-status\n\n"
7601 "Reporting-MTA: dns; %s\n",
7602 bound, smtp_active_hostname);
7606 /* must be decoded from xtext: see RFC 3461:6.3a */
7608 if (auth_xtextdecode(dsn_envid, &xdec_envid) > 0)
7609 fprintf(f, "Original-Envelope-ID: %s\n", dsn_envid);
7611 fprintf(f, "X-Original-Envelope-ID: error decoding xtext formatted ENVID\n");
7615 for (addr = handled_addr; addr; addr = addr->next)
7618 fprintf(f, "Action: failed\n"
7619 "Final-Recipient: rfc822;%s\n"
7622 if ((hu = addr->host_used) && hu->name)
7625 fprintf(f, "Remote-MTA: dns; %s\n", hu->name);
7626 #ifdef EXPERIMENTAL_DSN_INFO
7629 uschar * p = hu->port == 25
7630 ? US"" : string_sprintf(":%d", hu->port);
7631 fprintf(f, "Remote-MTA: X-ip; [%s]%s\n", hu->address, p);
7633 if ((s = addr->smtp_greeting) && *s)
7634 fprintf(f, "X-Remote-MTA-smtp-greeting: X-str; %s\n", s);
7635 if ((s = addr->helo_response) && *s)
7636 fprintf(f, "X-Remote-MTA-helo-response: X-str; %s\n", s);
7637 if ((s = addr->message) && *s)
7638 fprintf(f, "X-Exim-Diagnostic: X-str; %s\n", s);
7640 print_dsn_diagnostic_code(addr, f);
7645 /* Now copy the message, trying to give an intelligible comment if
7646 it is too long for it all to be copied. The limit isn't strictly
7647 applied because of the buffering. There is, however, an option
7648 to suppress copying altogether. */
7650 emf_text = next_emf(emf, US"copy");
7653 we ignore the intro text from template and add
7654 the text for bounce_return_size_limit at the end.
7656 bounce_return_message is ignored
7657 in case RET= is defined we honor these values
7658 otherwise bounce_return_body is honored.
7660 bounce_return_size_limit is always honored.
7663 fprintf(f, "--%s\n", bound);
7665 dsnlimitmsg = US"X-Exim-DSN-Information: Due to administrative limits only headers are returned";
7666 dsnnotifyhdr = NULL;
7667 topt = topt_add_return_path;
7669 /* RET=HDRS? top priority */
7670 if (dsn_ret == dsn_ret_hdrs)
7671 topt |= topt_no_body;
7674 struct stat statbuf;
7676 /* no full body return at all? */
7677 if (!bounce_return_body)
7679 topt |= topt_no_body;
7680 /* add header if we overrule RET=FULL */
7681 if (dsn_ret == dsn_ret_full)
7682 dsnnotifyhdr = dsnlimitmsg;
7684 /* line length limited... return headers only if oversize */
7685 /* size limited ... return headers only if limit reached */
7686 else if ( max_received_linelength > bounce_return_linesize_limit
7687 || ( bounce_return_size_limit > 0
7688 && fstat(deliver_datafile, &statbuf) == 0
7689 && statbuf.st_size > max
7692 topt |= topt_no_body;
7693 dsnnotifyhdr = dsnlimitmsg;
7698 if (message_smtputf8)
7699 fputs(topt & topt_no_body ? "Content-type: message/global-headers\n\n"
7700 : "Content-type: message/global\n\n",
7704 fputs(topt & topt_no_body ? "Content-type: text/rfc822-headers\n\n"
7705 : "Content-type: message/rfc822\n\n",
7709 transport_filter_argv = NULL; /* Just in case */
7710 return_path = sender_address; /* In case not previously set */
7711 { /* Dummy transport for headers add */
7712 transport_ctx tctx = {0};
7713 transport_instance tb = {0};
7716 tctx.options = topt;
7717 tb.add_headers = dsnnotifyhdr;
7719 transport_write_message(fileno(f), &tctx, 0);
7723 /* we never add the final text. close the file */
7727 fprintf(f, "\n--%s--\n", bound);
7729 /* Close the file, which should send an EOF to the child process
7730 that is receiving the message. Wait for it to finish. */
7733 rc = child_close(pid, 0); /* Waits for child to close, no timeout */
7735 /* In the test harness, let the child do it's thing first. */
7737 if (running_in_test_harness) millisleep(500);
7739 /* If the process failed, there was some disaster in setting up the
7740 error message. Unless the message is very old, ensure that addr_defer
7741 is non-null, which will have the effect of leaving the message on the
7742 spool. The failed addresses will get tried again next time. However, we
7743 don't really want this to happen too often, so freeze the message unless
7744 there are some genuine deferred addresses to try. To do this we have
7745 to call spool_write_header() here, because with no genuine deferred
7746 addresses the normal code below doesn't get run. */
7751 if (now - received_time < retry_maximum_timeout && !addr_defer)
7753 addr_defer = (address_item *)(+1);
7754 deliver_freeze = TRUE;
7755 deliver_frozen_at = time(NULL);
7756 /* Panic-dies on error */
7757 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
7760 deliver_msglog("Process failed (%d) when writing error message "
7761 "to %s%s", rc, bounce_recipient, s);
7762 log_write(0, LOG_MAIN, "Process failed (%d) when writing error message "
7763 "to %s%s", rc, bounce_recipient, s);
7766 /* The message succeeded. Ensure that the recipients that failed are
7767 now marked finished with on the spool and their parents updated. */
7771 for (addr = handled_addr; addr; addr = addr->next)
7773 address_done(addr, logtod);
7774 child_done(addr, logtod);
7776 /* Panic-dies on error */
7777 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
7783 disable_logging = FALSE; /* In case left set */
7785 /* Come here from the mua_wrapper case if routing goes wrong */
7789 /* If there are now no deferred addresses, we are done. Preserve the
7790 message log if so configured, and we are using them. Otherwise, sling it.
7791 Then delete the message itself. */
7799 fname = spool_fname(US"msglog", message_subdir, id, US"");
7800 if (preserve_message_logs)
7803 uschar * moname = spool_fname(US"msglog.OLD", US"", id, US"");
7805 if ((rc = Urename(fname, moname)) < 0)
7807 (void)directory_make(spool_directory,
7808 spool_sname(US"msglog.OLD", US""),
7809 MSGLOG_DIRECTORY_MODE, TRUE);
7810 rc = Urename(fname, moname);
7813 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to move %s to the "
7814 "msglog.OLD directory", fname);
7817 if (Uunlink(fname) < 0)
7818 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s",
7819 fname, strerror(errno));
7822 /* Remove the two message files. */
7824 fname = spool_fname(US"input", message_subdir, id, US"-D");
7825 if (Uunlink(fname) < 0)
7826 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s",
7827 fname, strerror(errno));
7828 fname = spool_fname(US"input", message_subdir, id, US"-H");
7829 if (Uunlink(fname) < 0)
7830 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s",
7831 fname, strerror(errno));
7833 /* Log the end of this message, with queue time if requested. */
7835 if (LOGGING(queue_time_overall))
7836 log_write(0, LOG_MAIN, "Completed QT=%s",
7837 readconf_printtime( (int) ((long)time(NULL) - (long)received_time)) );
7839 log_write(0, LOG_MAIN, "Completed");
7841 /* Unset deliver_freeze so that we won't try to move the spool files further down */
7842 deliver_freeze = FALSE;
7844 #ifndef DISABLE_EVENT
7845 (void) event_raise(event_action, US"msg:complete", NULL);
7849 /* If there are deferred addresses, we are keeping this message because it is
7850 not yet completed. Lose any temporary files that were catching output from
7851 pipes for any of the deferred addresses, handle one-time aliases, and see if
7852 the message has been on the queue for so long that it is time to send a warning
7853 message to the sender, unless it is a mailer-daemon. If all deferred addresses
7854 have the same domain, we can set deliver_domain for the expansion of
7855 delay_warning_ condition - if any of them are pipes, files, or autoreplies, use
7856 the parent's domain.
7858 If all the deferred addresses have an error number that indicates "retry time
7859 not reached", skip sending the warning message, because it won't contain the
7860 reason for the delay. It will get sent at the next real delivery attempt.
7861 However, if at least one address has tried, we'd better include all of them in
7864 If we can't make a process to send the message, don't worry.
7866 For mailing list expansions we want to send the warning message to the
7867 mailing list manager. We can't do a perfect job here, as some addresses may
7868 have different errors addresses, but if we take the errors address from
7869 each deferred address it will probably be right in most cases.
7871 If addr_defer == +1, it means there was a problem sending an error message
7872 for failed addresses, and there were no "real" deferred addresses. The value
7873 was set just to keep the message on the spool, so there is nothing to do here.
7876 else if (addr_defer != (address_item *)(+1))
7879 uschar *recipients = US"";
7880 BOOL delivery_attempted = FALSE;
7882 deliver_domain = testflag(addr_defer, af_pfr)
7883 ? addr_defer->parent->domain : addr_defer->domain;
7885 for (addr = addr_defer; addr; addr = addr->next)
7887 address_item *otaddr;
7889 if (addr->basic_errno > ERRNO_RETRY_BASE) delivery_attempted = TRUE;
7893 const uschar *d = testflag(addr, af_pfr)
7894 ? addr->parent->domain : addr->domain;
7896 /* The domain may be unset for an address that has never been routed
7897 because the system filter froze the message. */
7899 if (!d || Ustrcmp(d, deliver_domain) != 0)
7900 deliver_domain = NULL;
7903 if (addr->return_filename) Uunlink(addr->return_filename);
7905 /* Handle the case of one-time aliases. If any address in the ancestry
7906 of this one is flagged, ensure it is in the recipients list, suitably
7907 flagged, and that its parent is marked delivered. */
7909 for (otaddr = addr; otaddr; otaddr = otaddr->parent)
7910 if (otaddr->onetime_parent) break;
7915 int t = recipients_count;
7917 for (i = 0; i < recipients_count; i++)
7919 uschar *r = recipients_list[i].address;
7920 if (Ustrcmp(otaddr->onetime_parent, r) == 0) t = i;
7921 if (Ustrcmp(otaddr->address, r) == 0) break;
7924 /* Didn't find the address already in the list, and did find the
7925 ultimate parent's address in the list, and they really are different
7926 (i.e. not from an identity-redirect). After adding the recipient,
7927 update the errors address in the recipients list. */
7929 if ( i >= recipients_count && t < recipients_count
7930 && Ustrcmp(otaddr->address, otaddr->parent->address) != 0)
7932 DEBUG(D_deliver) debug_printf("one_time: adding %s in place of %s\n",
7933 otaddr->address, otaddr->parent->address);
7934 receive_add_recipient(otaddr->address, t);
7935 recipients_list[recipients_count-1].errors_to = otaddr->prop.errors_address;
7936 tree_add_nonrecipient(otaddr->parent->address);
7937 update_spool = TRUE;
7941 /* Except for error messages, ensure that either the errors address for
7942 this deferred address or, if there is none, the sender address, is on the
7943 list of recipients for a warning message. */
7945 if (sender_address[0])
7947 uschar * s = addr->prop.errors_address;
7948 if (!s) s = sender_address;
7949 if (Ustrstr(recipients, s) == NULL)
7950 recipients = string_sprintf("%s%s%s", recipients,
7951 recipients[0] ? "," : "", s);
7955 /* Send a warning message if the conditions are right. If the condition check
7956 fails because of a lookup defer, there is nothing we can do. The warning
7957 is not sent. Another attempt will be made at the next delivery attempt (if
7961 && delivery_attempted
7962 && ( ((addr_defer->dsn_flags & rf_dsnflags) == 0)
7963 || (addr_defer->dsn_flags & rf_notify_delay) == rf_notify_delay
7965 && delay_warning[1] > 0
7966 && sender_address[0] != 0
7967 && ( !delay_warning_condition
7968 || expand_check_condition(delay_warning_condition,
7969 US"delay_warning", US"option")
7975 int queue_time = time(NULL) - received_time;
7977 /* When running in the test harness, there's an option that allows us to
7978 fudge this time so as to get repeatability of the tests. Take the first
7979 time off the list. In queue runs, the list pointer gets updated in the
7982 if (running_in_test_harness && fudged_queue_times[0] != 0)
7984 int qt = readconf_readtime(fudged_queue_times, '/', FALSE);
7987 DEBUG(D_deliver) debug_printf("fudged queue_times = %s\n",
7988 fudged_queue_times);
7993 /* See how many warnings we should have sent by now */
7995 for (count = 0; count < delay_warning[1]; count++)
7996 if (queue_time < delay_warning[count+2]) break;
7998 show_time = delay_warning[count+1];
8000 if (count >= delay_warning[1])
8003 int last_gap = show_time;
8004 if (count > 1) last_gap -= delay_warning[count];
8005 extra = (queue_time - delay_warning[count+1])/last_gap;
8006 show_time += last_gap * extra;
8012 debug_printf("time on queue = %s\n", readconf_printtime(queue_time));
8013 debug_printf("warning counts: required %d done %d\n", count,
8017 /* We have computed the number of warnings there should have been by now.
8018 If there haven't been enough, send one, and up the count to what it should
8021 if (warning_count < count)
8025 pid_t pid = child_open_exim(&fd);
8031 FILE *f = fdopen(fd, "wb");
8033 transport_ctx tctx = {0};
8035 if (warn_message_file)
8036 if (!(wmf = Ufopen(warn_message_file, "rb")))
8037 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to open %s for warning "
8038 "message texts: %s", warn_message_file, strerror(errno));
8040 warnmsg_recipients = recipients;
8041 warnmsg_delay = queue_time < 120*60
8042 ? string_sprintf("%d minutes", show_time/60)
8043 : string_sprintf("%d hours", show_time/3600);
8045 if (errors_reply_to)
8046 fprintf(f, "Reply-To: %s\n", errors_reply_to);
8047 fprintf(f, "Auto-Submitted: auto-replied\n");
8049 fprintf(f, "To: %s\n", recipients);
8051 /* generated boundary string and output MIME-Headers */
8052 bound = string_sprintf(TIME_T_FMT "-eximdsn-%d", time(NULL), rand());
8054 fprintf(f, "Content-Type: multipart/report;"
8055 " report-type=delivery-status; boundary=%s\n"
8056 "MIME-Version: 1.0\n",
8059 if ((wmf_text = next_emf(wmf, US"header")))
8060 fprintf(f, "%s\n", wmf_text);
8062 fprintf(f, "Subject: Warning: message %s delayed %s\n\n",
8063 message_id, warnmsg_delay);
8065 /* output human readable part as text/plain section */
8067 "Content-type: text/plain; charset=us-ascii\n\n",
8070 if ((wmf_text = next_emf(wmf, US"intro")))
8071 fprintf(f, "%s", CS wmf_text);
8075 "This message was created automatically by mail delivery software.\n");
8077 if (Ustrcmp(recipients, sender_address) == 0)
8079 "A message that you sent has not yet been delivered to one or more of its\n"
8080 "recipients after more than ");
8084 "A message sent by\n\n <%s>\n\n"
8085 "has not yet been delivered to one or more of its recipients after more than \n",
8088 fprintf(f, "%s on the queue on %s.\n\n"
8089 "The message identifier is: %s\n",
8090 warnmsg_delay, primary_hostname, message_id);
8092 for (h = header_list; h; h = h->next)
8093 if (strncmpic(h->text, US"Subject:", 8) == 0)
8094 fprintf(f, "The subject of the message is: %s", h->text + 9);
8095 else if (strncmpic(h->text, US"Date:", 5) == 0)
8096 fprintf(f, "The date of the message is: %s", h->text + 6);
8099 fprintf(f, "The address%s to which the message has not yet been "
8101 !addr_defer->next ? "" : "es",
8102 !addr_defer->next ? "is": "are");
8105 /* List the addresses, with error information if allowed */
8107 /* store addr_defer for machine readable part */
8108 address_item *addr_dsndefer = addr_defer;
8112 address_item *addr = addr_defer;
8113 addr_defer = addr->next;
8114 if (print_address_information(addr, f, US" ", US"\n ", US""))
8115 print_address_error(addr, f, US"Delay reason: ");
8124 if ((wmf_text = next_emf(wmf, US"final")))
8125 fprintf(f, "%s", CS wmf_text);
8131 "No action is required on your part. Delivery attempts will continue for\n"
8132 "some time, and this warning may be repeated at intervals if the message\n"
8133 "remains undelivered. Eventually the mail delivery software will give up,\n"
8134 "and when that happens, the message will be returned to you.\n");
8137 /* output machine readable part */
8138 fprintf(f, "\n--%s\n"
8139 "Content-type: message/delivery-status\n\n"
8140 "Reporting-MTA: dns; %s\n",
8142 smtp_active_hostname);
8147 /* must be decoded from xtext: see RFC 3461:6.3a */
8149 if (auth_xtextdecode(dsn_envid, &xdec_envid) > 0)
8150 fprintf(f,"Original-Envelope-ID: %s\n", dsn_envid);
8152 fprintf(f,"X-Original-Envelope-ID: error decoding xtext formatted ENVID\n");
8156 for ( ; addr_dsndefer; addr_dsndefer = addr_dsndefer->next)
8158 if (addr_dsndefer->dsn_orcpt)
8159 fprintf(f, "Original-Recipient: %s\n", addr_dsndefer->dsn_orcpt);
8161 fprintf(f, "Action: delayed\n"
8162 "Final-Recipient: rfc822;%s\n"
8164 addr_dsndefer->address);
8165 if (addr_dsndefer->host_used && addr_dsndefer->host_used->name)
8167 fprintf(f, "Remote-MTA: dns; %s\n",
8168 addr_dsndefer->host_used->name);
8169 print_dsn_diagnostic_code(addr_dsndefer, f);
8175 "Content-type: text/rfc822-headers\n\n",
8179 /* header only as required by RFC. only failure DSN needs to honor RET=FULL */
8180 tctx.options = topt_add_return_path | topt_no_body;
8181 transport_filter_argv = NULL; /* Just in case */
8182 return_path = sender_address; /* In case not previously set */
8184 /* Write the original email out */
8185 transport_write_message(fileno(f), &tctx, 0);
8188 fprintf(f,"\n--%s--\n", bound);
8192 /* Close and wait for child process to complete, without a timeout.
8193 If there's an error, don't update the count. */
8196 if (child_close(pid, 0) == 0)
8198 warning_count = count;
8199 update_spool = TRUE; /* Ensure spool rewritten */
8205 /* Clear deliver_domain */
8207 deliver_domain = NULL;
8209 /* If this was a first delivery attempt, unset the first time flag, and
8210 ensure that the spool gets updated. */
8212 if (deliver_firsttime)
8214 deliver_firsttime = FALSE;
8215 update_spool = TRUE;
8218 /* If delivery was frozen and freeze_tell is set, generate an appropriate
8219 message, unless the message is a local error message (to avoid loops). Then
8220 log the freezing. If the text in "frozen_info" came from a system filter,
8221 it has been escaped into printing characters so as not to mess up log lines.
8222 For the "tell" message, we turn \n back into newline. Also, insert a newline
8223 near the start instead of the ": " string. */
8227 if (freeze_tell && freeze_tell[0] != 0 && !local_error_message)
8229 uschar *s = string_copy(frozen_info);
8230 uschar *ss = Ustrstr(s, " by the system filter: ");
8241 if (*ss == '\\' && ss[1] == 'n')
8248 moan_tell_someone(freeze_tell, addr_defer, US"Message frozen",
8249 "Message %s has been frozen%s.\nThe sender is <%s>.\n", message_id,
8253 /* Log freezing just before we update the -H file, to minimize the chance
8254 of a race problem. */
8256 deliver_msglog("*** Frozen%s\n", frozen_info);
8257 log_write(0, LOG_MAIN, "Frozen%s", frozen_info);
8260 /* If there have been any updates to the non-recipients list, or other things
8261 that get written to the spool, we must now update the spool header file so
8262 that it has the right information for the next delivery attempt. If there
8263 was more than one address being delivered, the header_change update is done
8264 earlier, in case one succeeds and then something crashes. */
8267 debug_printf("delivery deferred: update_spool=%d header_rewritten=%d\n",
8268 update_spool, header_rewritten);
8270 if (update_spool || header_rewritten)
8271 /* Panic-dies on error */
8272 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
8275 /* Finished with the message log. If the message is complete, it will have
8276 been unlinked or renamed above. */
8278 if (message_logs) (void)fclose(message_log);
8280 /* Now we can close and remove the journal file. Its only purpose is to record
8281 successfully completed deliveries asap so that this information doesn't get
8282 lost if Exim (or the machine) crashes. Forgetting about a failed delivery is
8283 not serious, as trying it again is not harmful. The journal might not be open
8284 if all addresses were deferred at routing or directing. Nevertheless, we must
8285 remove it if it exists (may have been lying around from a crash during the
8286 previous delivery attempt). We don't remove the journal if a delivery
8287 subprocess failed to pass back delivery information; this is controlled by
8288 the remove_journal flag. When the journal is left, we also don't move the
8289 message off the main spool if frozen and the option is set. It should get moved
8290 at the next attempt, after the journal has been inspected. */
8292 if (journal_fd >= 0) (void)close(journal_fd);
8296 uschar * fname = spool_fname(US"input", message_subdir, id, US"-J");
8298 if (Uunlink(fname) < 0 && errno != ENOENT)
8299 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s", fname,
8302 /* Move the message off the spool if requested */
8304 #ifdef SUPPORT_MOVE_FROZEN_MESSAGES
8305 if (deliver_freeze && move_frozen_messages)
8306 (void)spool_move_message(id, message_subdir, US"", US"F");
8310 /* Closing the data file frees the lock; if the file has been unlinked it
8311 will go away. Otherwise the message becomes available for another process
8314 (void)close(deliver_datafile);
8315 deliver_datafile = -1;
8316 DEBUG(D_deliver) debug_printf("end delivery of %s\n", id);
8318 /* It is unlikely that there will be any cached resources, since they are
8319 released after routing, and in the delivery subprocesses. However, it's
8320 possible for an expansion for something afterwards (for example,
8321 expand_check_condition) to do a lookup. We must therefore be sure everything is
8325 acl_where = ACL_WHERE_UNKNOWN;
8334 if (!regex_PIPELINING) regex_PIPELINING =
8335 regex_must_compile(US"\\n250[\\s\\-]PIPELINING(\\s|\\n|$)", FALSE, TRUE);
8337 if (!regex_SIZE) regex_SIZE =
8338 regex_must_compile(US"\\n250[\\s\\-]SIZE(\\s|\\n|$)", FALSE, TRUE);
8340 if (!regex_AUTH) regex_AUTH =
8341 regex_must_compile(US"\\n250[\\s\\-]AUTH\\s+([\\-\\w\\s]+)(?:\\n|$)",
8345 if (!regex_STARTTLS) regex_STARTTLS =
8346 regex_must_compile(US"\\n250[\\s\\-]STARTTLS(\\s|\\n|$)", FALSE, TRUE);
8349 if (!regex_CHUNKING) regex_CHUNKING =
8350 regex_must_compile(US"\\n250[\\s\\-]CHUNKING(\\s|\\n|$)", FALSE, TRUE);
8352 #ifndef DISABLE_PRDR
8353 if (!regex_PRDR) regex_PRDR =
8354 regex_must_compile(US"\\n250[\\s\\-]PRDR(\\s|\\n|$)", FALSE, TRUE);
8358 if (!regex_UTF8) regex_UTF8 =
8359 regex_must_compile(US"\\n250[\\s\\-]SMTPUTF8(\\s|\\n|$)", FALSE, TRUE);
8362 if (!regex_DSN) regex_DSN =
8363 regex_must_compile(US"\\n250[\\s\\-]DSN(\\s|\\n|$)", FALSE, TRUE);
8365 if (!regex_IGNOREQUOTA) regex_IGNOREQUOTA =
8366 regex_must_compile(US"\\n250[\\s\\-]IGNOREQUOTA(\\s|\\n|$)", FALSE, TRUE);
8371 deliver_get_sender_address (uschar * id)
8374 uschar * new_sender_address,
8375 * save_sender_address;
8376 BOOL save_qr = queue_running;
8379 /* make spool_open_datafile non-noisy on fail */
8381 queue_running = TRUE;
8383 /* Side effect: message_subdir is set for the (possibly split) spool directory */
8385 deliver_datafile = spool_open_datafile(id);
8386 queue_running = save_qr;
8387 if (deliver_datafile < 0)
8390 /* Save and restore the global sender_address. I'm not sure if we should
8391 not save/restore all the other global variables too, because
8392 spool_read_header() may change all of them. But OTOH, when this
8393 deliver_get_sender_address() gets called, the current message is done
8394 already and nobody needs the globals anymore. (HS12, 2015-08-21) */
8396 spoolname = string_sprintf("%s-H", id);
8397 save_sender_address = sender_address;
8399 rc = spool_read_header(spoolname, TRUE, TRUE);
8401 new_sender_address = sender_address;
8402 sender_address = save_sender_address;
8404 if (rc != spool_read_OK)
8407 assert(new_sender_address);
8409 (void)close(deliver_datafile);
8410 deliver_datafile = -1;
8412 return new_sender_address;
8417 /* End of deliver.c */