1 /*************************************************
2 * Exim - an Internet mail transport agent *
3 *************************************************/
5 /* Copyright (c) University of Cambridge 1995 - 2018 */
6 /* See the file NOTICE for conditions of use and distribution. */
8 /* The main code for delivering a message. */
12 #include "transports/smtp.h"
17 /* Data block for keeping track of subprocesses for parallel remote
20 typedef struct pardata {
21 address_item *addrlist; /* chain of addresses */
22 address_item *addr; /* next address data expected for */
23 pid_t pid; /* subprocess pid */
24 int fd; /* pipe fd for getting result from subprocess */
25 int transport_count; /* returned transport count value */
26 BOOL done; /* no more data needed */
27 uschar *msg; /* error message */
28 uschar *return_path; /* return_path for these addresses */
31 /* Values for the process_recipients variable */
33 enum { RECIP_ACCEPT, RECIP_IGNORE, RECIP_DEFER,
34 RECIP_FAIL, RECIP_FAIL_FILTER, RECIP_FAIL_TIMEOUT,
37 /* Mutually recursive functions for marking addresses done. */
39 static void child_done(address_item *, uschar *);
40 static void address_done(address_item *, uschar *);
42 /* Table for turning base-62 numbers into binary */
44 static uschar tab62[] =
45 {0,1,2,3,4,5,6,7,8,9,0,0,0,0,0,0, /* 0-9 */
46 0,10,11,12,13,14,15,16,17,18,19,20, /* A-K */
47 21,22,23,24,25,26,27,28,29,30,31,32, /* L-W */
48 33,34,35, 0, 0, 0, 0, 0, /* X-Z */
49 0,36,37,38,39,40,41,42,43,44,45,46, /* a-k */
50 47,48,49,50,51,52,53,54,55,56,57,58, /* l-w */
54 /*************************************************
55 * Local static variables *
56 *************************************************/
58 /* addr_duplicate is global because it needs to be seen from the Envelope-To
61 static address_item *addr_defer = NULL;
62 static address_item *addr_failed = NULL;
63 static address_item *addr_fallback = NULL;
64 static address_item *addr_local = NULL;
65 static address_item *addr_new = NULL;
66 static address_item *addr_remote = NULL;
67 static address_item *addr_route = NULL;
68 static address_item *addr_succeed = NULL;
69 static address_item *addr_dsntmp = NULL;
70 static address_item *addr_senddsn = NULL;
72 static FILE *message_log = NULL;
73 static BOOL update_spool;
74 static BOOL remove_journal;
75 static int parcount = 0;
76 static pardata *parlist = NULL;
77 static int return_count;
78 static uschar *frozen_info = US"";
79 static uschar *used_return_path = NULL;
83 /*************************************************
84 * read as much as requested *
85 *************************************************/
87 /* The syscall read(2) doesn't always returns as much as we want. For
88 several reasons it might get less. (Not talking about signals, as syscalls
89 are restartable). When reading from a network or pipe connection the sender
90 might send in smaller chunks, with delays between these chunks. The read(2)
91 may return such a chunk.
93 The more the writer writes and the smaller the pipe between write and read is,
94 the more we get the chance of reading leass than requested. (See bug 2130)
96 This function read(2)s until we got all the data we *requested*.
98 Note: This function may block. Use it only if you're sure about the
99 amount of data you will get.
102 fd the file descriptor to read from
103 buffer pointer to a buffer of size len
104 len the requested(!) amount of bytes
106 Returns: the amount of bytes read
109 readn(int fd, void * buffer, size_t len)
111 void * next = buffer;
112 void * end = buffer + len;
116 ssize_t got = read(fd, next, end - next);
118 /* I'm not sure if there are signals that can interrupt us,
119 for now I assume the worst */
120 if (got == -1 && errno == EINTR) continue;
121 if (got <= 0) return next - buffer;
129 /*************************************************
130 * Make a new address item *
131 *************************************************/
133 /* This function gets the store and initializes with default values. The
134 transport_return value defaults to DEFER, so that any unexpected failure to
135 deliver does not wipe out the message. The default unique string is set to a
136 copy of the address, so that its domain can be lowercased.
139 address the RFC822 address string
140 copy force a copy of the address
142 Returns: a pointer to an initialized address_item
146 deliver_make_addr(uschar *address, BOOL copy)
148 address_item *addr = store_get(sizeof(address_item));
149 *addr = address_defaults;
150 if (copy) address = string_copy(address);
151 addr->address = address;
152 addr->unique = string_copy(address);
159 /*************************************************
160 * Set expansion values for an address *
161 *************************************************/
163 /* Certain expansion variables are valid only when handling an address or
164 address list. This function sets them up or clears the values, according to its
168 addr the address in question, or NULL to clear values
173 deliver_set_expansions(address_item *addr)
177 const uschar ***p = address_expansions;
178 while (*p) **p++ = NULL;
182 /* Exactly what gets set depends on whether there is one or more addresses, and
183 what they contain. These first ones are always set, taking their values from
184 the first address. */
186 if (!addr->host_list)
188 deliver_host = deliver_host_address = US"";
189 deliver_host_port = 0;
193 deliver_host = addr->host_list->name;
194 deliver_host_address = addr->host_list->address;
195 deliver_host_port = addr->host_list->port;
198 deliver_recipients = addr;
199 deliver_address_data = addr->prop.address_data;
200 deliver_domain_data = addr->prop.domain_data;
201 deliver_localpart_data = addr->prop.localpart_data;
203 /* These may be unset for multiple addresses */
205 deliver_domain = addr->domain;
206 self_hostname = addr->self_hostname;
208 #ifdef EXPERIMENTAL_BRIGHTMAIL
209 bmi_deliver = 1; /* deliver by default */
210 bmi_alt_location = NULL;
211 bmi_base64_verdict = NULL;
212 bmi_base64_tracker_verdict = NULL;
215 /* If there's only one address we can set everything. */
219 address_item *addr_orig;
221 deliver_localpart = addr->local_part;
222 deliver_localpart_prefix = addr->prefix;
223 deliver_localpart_suffix = addr->suffix;
225 for (addr_orig = addr; addr_orig->parent; addr_orig = addr_orig->parent) ;
226 deliver_domain_orig = addr_orig->domain;
228 /* Re-instate any prefix and suffix in the original local part. In all
229 normal cases, the address will have a router associated with it, and we can
230 choose the caseful or caseless version accordingly. However, when a system
231 filter sets up a pipe, file, or autoreply delivery, no router is involved.
232 In this case, though, there won't be any prefix or suffix to worry about. */
234 deliver_localpart_orig = !addr_orig->router
235 ? addr_orig->local_part
236 : addr_orig->router->caseful_local_part
237 ? addr_orig->cc_local_part
238 : addr_orig->lc_local_part;
240 /* If there's a parent, make its domain and local part available, and if
241 delivering to a pipe or file, or sending an autoreply, get the local
242 part from the parent. For pipes and files, put the pipe or file string
243 into address_pipe and address_file. */
247 deliver_domain_parent = addr->parent->domain;
248 deliver_localpart_parent = !addr->parent->router
249 ? addr->parent->local_part
250 : addr->parent->router->caseful_local_part
251 ? addr->parent->cc_local_part
252 : addr->parent->lc_local_part;
254 /* File deliveries have their own flag because they need to be picked out
255 as special more often. */
257 if (testflag(addr, af_pfr))
259 if (testflag(addr, af_file)) address_file = addr->local_part;
260 else if (deliver_localpart[0] == '|') address_pipe = addr->local_part;
261 deliver_localpart = addr->parent->local_part;
262 deliver_localpart_prefix = addr->parent->prefix;
263 deliver_localpart_suffix = addr->parent->suffix;
267 #ifdef EXPERIMENTAL_BRIGHTMAIL
268 /* Set expansion variables related to Brightmail AntiSpam */
269 bmi_base64_verdict = bmi_get_base64_verdict(deliver_localpart_orig, deliver_domain_orig);
270 bmi_base64_tracker_verdict = bmi_get_base64_tracker_verdict(bmi_base64_verdict);
271 /* get message delivery status (0 - don't deliver | 1 - deliver) */
272 bmi_deliver = bmi_get_delivery_status(bmi_base64_verdict);
273 /* if message is to be delivered, get eventual alternate location */
274 if (bmi_deliver == 1)
275 bmi_alt_location = bmi_get_alt_location(bmi_base64_verdict);
280 /* For multiple addresses, don't set local part, and leave the domain and
281 self_hostname set only if it is the same for all of them. It is possible to
282 have multiple pipe and file addresses, but only when all addresses have routed
283 to the same pipe or file. */
288 if (testflag(addr, af_pfr))
290 if (testflag(addr, af_file)) address_file = addr->local_part;
291 else if (addr->local_part[0] == '|') address_pipe = addr->local_part;
293 for (addr2 = addr->next; addr2; addr2 = addr2->next)
295 if (deliver_domain && Ustrcmp(deliver_domain, addr2->domain) != 0)
296 deliver_domain = NULL;
298 && ( !addr2->self_hostname
299 || Ustrcmp(self_hostname, addr2->self_hostname) != 0
301 self_hostname = NULL;
302 if (!deliver_domain && !self_hostname) break;
310 /*************************************************
311 * Open a msglog file *
312 *************************************************/
314 /* This function is used both for normal message logs, and for files in the
315 msglog directory that are used to catch output from pipes. Try to create the
316 directory if it does not exist. From release 4.21, normal message logs should
317 be created when the message is received.
319 Called from deliver_message(), can be operating as root.
322 filename the file name
323 mode the mode required
324 error used for saying what failed
326 Returns: a file descriptor, or -1 (with errno set)
330 open_msglog_file(uschar *filename, int mode, uschar **error)
334 for (i = 2; i > 0; i--)
343 O_WRONLY|O_APPEND|O_CREAT, mode);
346 /* Set the close-on-exec flag and change the owner to the exim uid/gid (this
347 function is called as root). Double check the mode, because the group setting
348 doesn't always get set automatically. */
351 (void)fcntl(fd, F_SETFD, fcntl(fd, F_GETFD) | FD_CLOEXEC);
353 if (fchown(fd, exim_uid, exim_gid) < 0)
358 if (fchmod(fd, mode) < 0)
368 (void)directory_make(spool_directory,
369 spool_sname(US"msglog", message_subdir),
370 MSGLOG_DIRECTORY_MODE, TRUE);
380 /*************************************************
381 * Write to msglog if required *
382 *************************************************/
384 /* Write to the message log, if configured. This function may also be called
388 format a string format
394 deliver_msglog(const char *format, ...)
397 if (!message_logs) return;
398 va_start(ap, format);
399 vfprintf(message_log, format, ap);
407 /*************************************************
408 * Replicate status for batch *
409 *************************************************/
411 /* When a transport handles a batch of addresses, it may treat them
412 individually, or it may just put the status in the first one, and return FALSE,
413 requesting that the status be copied to all the others externally. This is the
414 replication function. As well as the status, it copies the transport pointer,
415 which may have changed if appendfile passed the addresses on to a different
418 Argument: pointer to the first address in a chain
423 replicate_status(address_item *addr)
426 for (addr2 = addr->next; addr2; addr2 = addr2->next)
428 addr2->transport = addr->transport;
429 addr2->transport_return = addr->transport_return;
430 addr2->basic_errno = addr->basic_errno;
431 addr2->more_errno = addr->more_errno;
432 addr2->delivery_usec = addr->delivery_usec;
433 addr2->special_action = addr->special_action;
434 addr2->message = addr->message;
435 addr2->user_message = addr->user_message;
441 /*************************************************
442 * Compare lists of hosts *
443 *************************************************/
445 /* This function is given two pointers to chains of host items, and it yields
446 TRUE if the lists refer to the same hosts in the same order, except that
448 (1) Multiple hosts with the same non-negative MX values are permitted to appear
449 in different orders. Round-robinning nameservers can cause this to happen.
451 (2) Multiple hosts with the same negative MX values less than MX_NONE are also
452 permitted to appear in different orders. This is caused by randomizing
455 This enables Exim to use a single SMTP transaction for sending to two entirely
456 different domains that happen to end up pointing at the same hosts.
459 one points to the first host list
460 two points to the second host list
462 Returns: TRUE if the lists refer to the same host set
466 same_hosts(host_item *one, host_item *two)
470 if (Ustrcmp(one->name, two->name) != 0)
473 host_item *end_one = one;
474 host_item *end_two = two;
476 /* Batch up only if there was no MX and the list was not randomized */
478 if (mx == MX_NONE) return FALSE;
480 /* Find the ends of the shortest sequence of identical MX values */
482 while ( end_one->next && end_one->next->mx == mx
483 && end_two->next && end_two->next->mx == mx)
485 end_one = end_one->next;
486 end_two = end_two->next;
489 /* If there aren't any duplicates, there's no match. */
491 if (end_one == one) return FALSE;
493 /* For each host in the 'one' sequence, check that it appears in the 'two'
494 sequence, returning FALSE if not. */
499 for (hi = two; hi != end_two->next; hi = hi->next)
500 if (Ustrcmp(one->name, hi->name) == 0) break;
501 if (hi == end_two->next) return FALSE;
502 if (one == end_one) break;
506 /* All the hosts in the 'one' sequence were found in the 'two' sequence.
507 Ensure both are pointing at the last host, and carry on as for equality. */
512 /* if the names matched but ports do not, mismatch */
513 else if (one->port != two->port)
522 /* True if both are NULL */
529 /*************************************************
530 * Compare header lines *
531 *************************************************/
533 /* This function is given two pointers to chains of header items, and it yields
534 TRUE if they are the same header texts in the same order.
537 one points to the first header list
538 two points to the second header list
540 Returns: TRUE if the lists refer to the same header set
544 same_headers(header_line *one, header_line *two)
546 for (;; one = one->next, two = two->next)
548 if (one == two) return TRUE; /* Includes the case where both NULL */
549 if (!one || !two) return FALSE;
550 if (Ustrcmp(one->text, two->text) != 0) return FALSE;
556 /*************************************************
557 * Compare string settings *
558 *************************************************/
560 /* This function is given two pointers to strings, and it returns
561 TRUE if they are the same pointer, or if the two strings are the same.
564 one points to the first string
565 two points to the second string
567 Returns: TRUE or FALSE
571 same_strings(uschar *one, uschar *two)
573 if (one == two) return TRUE; /* Includes the case where both NULL */
574 if (!one || !two) return FALSE;
575 return (Ustrcmp(one, two) == 0);
580 /*************************************************
581 * Compare uid/gid for addresses *
582 *************************************************/
584 /* This function is given a transport and two addresses. It yields TRUE if the
585 uid/gid/initgroups settings for the two addresses are going to be the same when
590 addr1 the first address
591 addr2 the second address
593 Returns: TRUE or FALSE
597 same_ugid(transport_instance *tp, address_item *addr1, address_item *addr2)
599 if ( !tp->uid_set && !tp->expand_uid
600 && !tp->deliver_as_creator
601 && ( testflag(addr1, af_uid_set) != testflag(addr2, af_gid_set)
602 || ( testflag(addr1, af_uid_set)
603 && ( addr1->uid != addr2->uid
604 || testflag(addr1, af_initgroups) != testflag(addr2, af_initgroups)
608 if ( !tp->gid_set && !tp->expand_gid
609 && ( testflag(addr1, af_gid_set) != testflag(addr2, af_gid_set)
610 || ( testflag(addr1, af_gid_set)
611 && addr1->gid != addr2->gid
621 /*************************************************
622 * Record that an address is complete *
623 *************************************************/
625 /* This function records that an address is complete. This is straightforward
626 for most addresses, where the unique address is just the full address with the
627 domain lower cased. For homonyms (addresses that are the same as one of their
628 ancestors) their are complications. Their unique addresses have \x\ prepended
629 (where x = 0, 1, 2...), so that de-duplication works correctly for siblings and
632 Exim used to record the unique addresses of homonyms as "complete". This,
633 however, fails when the pattern of redirection varies over time (e.g. if taking
634 unseen copies at only some times of day) because the prepended numbers may vary
635 from one delivery run to the next. This problem is solved by never recording
636 prepended unique addresses as complete. Instead, when a homonymic address has
637 actually been delivered via a transport, we record its basic unique address
638 followed by the name of the transport. This is checked in subsequent delivery
639 runs whenever an address is routed to a transport.
641 If the completed address is a top-level one (has no parent, which means it
642 cannot be homonymic) we also add the original address to the non-recipients
643 tree, so that it gets recorded in the spool file and therefore appears as
644 "done" in any spool listings. The original address may differ from the unique
645 address in the case of the domain.
647 Finally, this function scans the list of duplicates, marks as done any that
648 match this address, and calls child_done() for their ancestors.
651 addr address item that has been completed
652 now current time as a string
658 address_done(address_item *addr, uschar *now)
662 update_spool = TRUE; /* Ensure spool gets updated */
664 /* Top-level address */
668 tree_add_nonrecipient(addr->unique);
669 tree_add_nonrecipient(addr->address);
672 /* Homonymous child address */
674 else if (testflag(addr, af_homonym))
677 tree_add_nonrecipient(
678 string_sprintf("%s/%s", addr->unique + 3, addr->transport->name));
681 /* Non-homonymous child address */
683 else tree_add_nonrecipient(addr->unique);
685 /* Check the list of duplicate addresses and ensure they are now marked
688 for (dup = addr_duplicate; dup; dup = dup->next)
689 if (Ustrcmp(addr->unique, dup->unique) == 0)
691 tree_add_nonrecipient(dup->unique);
692 child_done(dup, now);
699 /*************************************************
700 * Decrease counts in parents and mark done *
701 *************************************************/
703 /* This function is called when an address is complete. If there is a parent
704 address, its count of children is decremented. If there are still other
705 children outstanding, the function exits. Otherwise, if the count has become
706 zero, address_done() is called to mark the parent and its duplicates complete.
707 Then loop for any earlier ancestors.
710 addr points to the completed address item
711 now the current time as a string, for writing to the message log
717 child_done(address_item *addr, uschar *now)
723 if (--addr->child_count > 0) return; /* Incomplete parent */
724 address_done(addr, now);
726 /* Log the completion of all descendents only when there is no ancestor with
727 the same original address. */
729 for (aa = addr->parent; aa; aa = aa->parent)
730 if (Ustrcmp(aa->address, addr->address) == 0) break;
733 deliver_msglog("%s %s: children all complete\n", now, addr->address);
734 DEBUG(D_deliver) debug_printf("%s: children all complete\n", addr->address);
740 /*************************************************
741 * Delivery logging support functions *
742 *************************************************/
744 /* The LOGGING() checks in d_log_interface() are complicated for backwards
745 compatibility. When outgoing interface logging was originally added, it was
746 conditional on just incoming_interface (which is off by default). The
747 outgoing_interface option is on by default to preserve this behaviour, but
748 you can enable incoming_interface and disable outgoing_interface to get I=
749 fields on incoming lines only.
753 addr The address to be logged
755 Returns: New value for s
759 d_log_interface(gstring * g)
761 if (LOGGING(incoming_interface) && LOGGING(outgoing_interface)
762 && sending_ip_address)
764 g = string_fmt_append(g, " I=[%s]", sending_ip_address);
765 if (LOGGING(outgoing_port))
766 g = string_fmt_append(g, "%d", sending_port);
774 d_hostlog(gstring * g, address_item * addr)
776 host_item * h = addr->host_used;
778 g = string_append(g, 2, US" H=", h->name);
780 if (LOGGING(dnssec) && h->dnssec == DS_YES)
781 g = string_catn(g, US" DS", 3);
783 g = string_append(g, 3, US" [", h->address, US"]");
785 if (LOGGING(outgoing_port))
786 g = string_fmt_append(g, ":%d", h->port);
789 if (LOGGING(proxy) && proxy_local_address)
791 g = string_append(g, 3, US" PRX=[", proxy_local_address, US"]");
792 if (LOGGING(outgoing_port))
793 g = string_fmt_append(g, ":%d", proxy_local_port);
797 g = d_log_interface(g);
799 if (testflag(addr, af_tcp_fastopen))
800 g = string_catn(g, US" TFO*", testflag(addr, af_tcp_fastopen_data) ? 5 : 4);
811 d_tlslog(gstring * s, address_item * addr)
813 if (LOGGING(tls_cipher) && addr->cipher)
814 s = string_append(s, 2, US" X=", addr->cipher);
815 if (LOGGING(tls_certificate_verified) && addr->cipher)
816 s = string_append(s, 2, US" CV=",
817 testflag(addr, af_cert_verified)
820 testflag(addr, af_dane_verified)
826 if (LOGGING(tls_peerdn) && addr->peerdn)
827 s = string_append(s, 3, US" DN=\"", string_printing(addr->peerdn), US"\"");
835 #ifndef DISABLE_EVENT
837 event_raise(uschar * action, const uschar * event, uschar * ev_data)
843 debug_printf("Event(%s): event_action=|%s| delivery_IP=%s\n",
845 action, deliver_host_address);
848 event_data = ev_data;
850 if (!(s = expand_string(action)) && *expand_string_message)
851 log_write(0, LOG_MAIN|LOG_PANIC,
852 "failed to expand event_action %s in %s: %s\n",
853 event, transport_name ? transport_name : US"main", expand_string_message);
855 event_name = event_data = NULL;
857 /* If the expansion returns anything but an empty string, flag for
858 the caller to modify his normal processing
863 debug_printf("Event(%s): event_action returned \"%s\"\n", event, s);
871 msg_event_raise(const uschar * event, const address_item * addr)
873 const uschar * save_domain = deliver_domain;
874 uschar * save_local = deliver_localpart;
875 const uschar * save_host = deliver_host;
876 const uschar * save_address = deliver_host_address;
877 const int save_port = deliver_host_port;
879 router_name = addr->router ? addr->router->name : NULL;
880 deliver_domain = addr->domain;
881 deliver_localpart = addr->local_part;
882 deliver_host = addr->host_used ? addr->host_used->name : NULL;
884 if (!addr->transport)
886 if (Ustrcmp(event, "msg:fail:delivery") == 0)
888 /* An address failed with no transport involved. This happens when
889 a filter was used which triggered a fail command (in such a case
890 a transport isn't needed). Convert it to an internal fail event. */
892 (void) event_raise(event_action, US"msg:fail:internal", addr->message);
897 transport_name = addr->transport->name;
899 (void) event_raise(addr->transport->event_action, event,
901 || Ustrcmp(addr->transport->driver_name, "smtp") == 0
902 || Ustrcmp(addr->transport->driver_name, "lmtp") == 0
903 || Ustrcmp(addr->transport->driver_name, "autoreply") == 0
904 ? addr->message : NULL);
907 deliver_host_port = save_port;
908 deliver_host_address = save_address;
909 deliver_host = save_host;
910 deliver_localpart = save_local;
911 deliver_domain = save_domain;
912 router_name = transport_name = NULL;
914 #endif /*DISABLE_EVENT*/
918 /******************************************************************************/
921 /*************************************************
922 * Generate local prt for logging *
923 *************************************************/
925 /* This function is a subroutine for use in string_log_address() below.
928 addr the address being logged
929 yield the current dynamic buffer pointer
931 Returns: the new value of the buffer pointer
935 string_get_localpart(address_item * addr, gstring * yield)
940 if (testflag(addr, af_include_affixes) && s)
943 if (testflag(addr, af_utf8_downcvt))
944 s = string_localpart_utf8_to_alabel(s, NULL);
946 yield = string_cat(yield, s);
949 s = addr->local_part;
951 if (testflag(addr, af_utf8_downcvt))
952 s = string_localpart_utf8_to_alabel(s, NULL);
954 yield = string_cat(yield, s);
957 if (testflag(addr, af_include_affixes) && s)
960 if (testflag(addr, af_utf8_downcvt))
961 s = string_localpart_utf8_to_alabel(s, NULL);
963 yield = string_cat(yield, s);
970 /*************************************************
971 * Generate log address list *
972 *************************************************/
974 /* This function generates a list consisting of an address and its parents, for
975 use in logging lines. For saved onetime aliased addresses, the onetime parent
976 field is used. If the address was delivered by a transport with rcpt_include_
977 affixes set, the af_include_affixes bit will be set in the address. In that
978 case, we include the affixes here too.
981 g points to growing-string struct
982 addr bottom (ultimate) address
983 all_parents if TRUE, include all parents
984 success TRUE for successful delivery
986 Returns: a growable string in dynamic store
990 string_log_address(gstring * g,
991 address_item *addr, BOOL all_parents, BOOL success)
993 BOOL add_topaddr = TRUE;
994 address_item *topaddr;
996 /* Find the ultimate parent */
998 for (topaddr = addr; topaddr->parent; topaddr = topaddr->parent) ;
1000 /* We start with just the local part for pipe, file, and reply deliveries, and
1001 for successful local deliveries from routers that have the log_as_local flag
1002 set. File deliveries from filters can be specified as non-absolute paths in
1003 cases where the transport is going to complete the path. If there is an error
1004 before this happens (expansion failure) the local part will not be updated, and
1005 so won't necessarily look like a path. Add extra text for this case. */
1007 if ( testflag(addr, af_pfr)
1009 && addr->router && addr->router->log_as_local
1010 && addr->transport && addr->transport->info->local
1013 if (testflag(addr, af_file) && addr->local_part[0] != '/')
1014 g = string_catn(g, CUS"save ", 5);
1015 g = string_get_localpart(addr, g);
1018 /* Other deliveries start with the full address. It we have split it into local
1019 part and domain, use those fields. Some early failures can happen before the
1020 splitting is done; in those cases use the original field. */
1024 uschar * cmp = g->s + g->ptr;
1026 if (addr->local_part)
1029 g = string_get_localpart(addr, g);
1030 g = string_catn(g, US"@", 1);
1033 if (testflag(addr, af_utf8_downcvt))
1034 s = string_localpart_utf8_to_alabel(s, NULL);
1036 g = string_cat(g, s);
1039 g = string_cat(g, addr->address);
1041 /* If the address we are going to print is the same as the top address,
1042 and all parents are not being included, don't add on the top address. First
1043 of all, do a caseless comparison; if this succeeds, do a caseful comparison
1044 on the local parts. */
1046 string_from_gstring(g); /* ensure nul-terminated */
1047 if ( strcmpic(cmp, topaddr->address) == 0
1048 && Ustrncmp(cmp, topaddr->address, Ustrchr(cmp, '@') - cmp) == 0
1049 && !addr->onetime_parent
1050 && (!all_parents || !addr->parent || addr->parent == topaddr)
1052 add_topaddr = FALSE;
1055 /* If all parents are requested, or this is a local pipe/file/reply, and
1056 there is at least one intermediate parent, show it in brackets, and continue
1057 with all of them if all are wanted. */
1059 if ( (all_parents || testflag(addr, af_pfr))
1061 && addr->parent != topaddr)
1064 address_item *addr2;
1065 for (addr2 = addr->parent; addr2 != topaddr; addr2 = addr2->parent)
1067 g = string_catn(g, s, 2);
1068 g = string_cat (g, addr2->address);
1069 if (!all_parents) break;
1072 g = string_catn(g, US")", 1);
1075 /* Add the top address if it is required */
1078 g = string_append(g, 3,
1080 addr->onetime_parent ? addr->onetime_parent : topaddr->address,
1089 timesince(struct timeval * diff, struct timeval * then)
1091 gettimeofday(diff, NULL);
1092 diff->tv_sec -= then->tv_sec;
1093 if ((diff->tv_usec -= then->tv_usec) < 0)
1096 diff->tv_usec += 1000*1000;
1103 string_timediff(struct timeval * diff)
1105 static uschar buf[sizeof("0.000s")];
1107 if (diff->tv_sec >= 5 || !LOGGING(millisec))
1108 return readconf_printtime((int)diff->tv_sec);
1110 sprintf(CS buf, "%u.%03us", (uint)diff->tv_sec, (uint)diff->tv_usec/1000);
1116 string_timesince(struct timeval * then)
1118 struct timeval diff;
1120 timesince(&diff, then);
1121 return string_timediff(&diff);
1124 /******************************************************************************/
1128 /* If msg is NULL this is a delivery log and logchar is used. Otherwise
1129 this is a nonstandard call; no two-character delivery flag is written
1130 but sender-host and sender are prefixed and "msg" is inserted in the log line.
1133 flags passed to log_write()
1136 delivery_log(int flags, address_item * addr, int logchar, uschar * msg)
1138 gstring * g; /* Used for a temporary, expanding buffer, for building log lines */
1139 void * reset_point; /* released afterwards. */
1141 /* Log the delivery on the main log. We use an extensible string to build up
1142 the log line, and reset the store afterwards. Remote deliveries should always
1143 have a pointer to the host item that succeeded; local deliveries can have a
1144 pointer to a single host item in their host list, for use by the transport. */
1146 #ifndef DISABLE_EVENT
1147 /* presume no successful remote delivery */
1148 lookup_dnssec_authenticated = NULL;
1151 g = reset_point = string_get(256);
1154 g = string_append(g, 2, host_and_ident(TRUE), US" ");
1157 g->s[0] = logchar; g->ptr = 1;
1158 g = string_catn(g, US"> ", 2);
1160 g = string_log_address(g, addr, LOGGING(all_parents), TRUE);
1162 if (LOGGING(sender_on_delivery) || msg)
1163 g = string_append(g, 3, US" F=<",
1165 testflag(addr, af_utf8_downcvt)
1166 ? string_address_utf8_to_alabel(sender_address, NULL)
1173 g = string_append(g, 2, US" Q=", queue_name);
1175 #ifdef EXPERIMENTAL_SRS
1176 if(addr->prop.srs_sender)
1177 g = string_append(g, 3, US" SRS=<", addr->prop.srs_sender, US">");
1180 /* You might think that the return path must always be set for a successful
1181 delivery; indeed, I did for some time, until this statement crashed. The case
1182 when it is not set is for a delivery to /dev/null which is optimised by not
1183 being run at all. */
1185 if (used_return_path && LOGGING(return_path_on_delivery))
1186 g = string_append(g, 3, US" P=<", used_return_path, US">");
1189 g = string_append(g, 2, US" ", msg);
1191 /* For a delivery from a system filter, there may not be a router */
1193 g = string_append(g, 2, US" R=", addr->router->name);
1195 g = string_append(g, 2, US" T=", addr->transport->name);
1197 if (LOGGING(delivery_size))
1198 g = string_fmt_append(g, " S=%d", transport_count);
1200 /* Local delivery */
1202 if (addr->transport->info->local)
1204 if (addr->host_list)
1205 g = string_append(g, 2, US" H=", addr->host_list->name);
1206 g = d_log_interface(g);
1207 if (addr->shadow_message)
1208 g = string_cat(g, addr->shadow_message);
1211 /* Remote delivery */
1215 if (addr->host_used)
1217 g = d_hostlog(g, addr);
1218 if (continue_sequence > 1)
1219 g = string_catn(g, US"*", 1);
1221 #ifndef DISABLE_EVENT
1222 deliver_host_address = addr->host_used->address;
1223 deliver_host_port = addr->host_used->port;
1224 deliver_host = addr->host_used->name;
1226 /* DNS lookup status */
1227 lookup_dnssec_authenticated = addr->host_used->dnssec==DS_YES ? US"yes"
1228 : addr->host_used->dnssec==DS_NO ? US"no"
1234 g = d_tlslog(g, addr);
1237 if (addr->authenticator)
1239 g = string_append(g, 2, US" A=", addr->authenticator);
1242 g = string_append(g, 2, US":", addr->auth_id);
1243 if (LOGGING(smtp_mailauth) && addr->auth_sndr)
1244 g = string_append(g, 2, US":", addr->auth_sndr);
1248 if (LOGGING(pipelining))
1250 if (testflag(addr, af_pipelining))
1251 g = string_catn(g, US" L", 2);
1252 #ifdef EXPERIMENTAL_PIPE_CONNECT
1253 if (testflag(addr, af_early_pipe))
1254 g = string_catn(g, US"*", 1);
1258 #ifndef DISABLE_PRDR
1259 if (testflag(addr, af_prdr_used))
1260 g = string_catn(g, US" PRDR", 5);
1263 if (testflag(addr, af_chunking_used))
1264 g = string_catn(g, US" K", 2);
1267 /* confirmation message (SMTP (host_used) and LMTP (driver_name)) */
1269 if ( LOGGING(smtp_confirmation)
1271 && (addr->host_used || Ustrcmp(addr->transport->driver_name, "lmtp") == 0)
1275 unsigned lim = big_buffer_size < 1024 ? big_buffer_size : 1024;
1276 uschar *p = big_buffer;
1277 uschar *ss = addr->message;
1279 for (i = 0; i < lim && ss[i] != 0; i++) /* limit logged amount */
1281 if (ss[i] == '\"' || ss[i] == '\\') *p++ = '\\'; /* quote \ and " */
1286 g = string_append(g, 2, US" C=", big_buffer);
1289 /* Time on queue and actual time taken to deliver */
1291 if (LOGGING(queue_time))
1292 g = string_append(g, 2, US" QT=",
1293 string_timesince(&received_time));
1295 if (LOGGING(deliver_time))
1297 struct timeval diff = {.tv_sec = addr->more_errno, .tv_usec = addr->delivery_usec};
1298 g = string_append(g, 2, US" DT=", string_timediff(&diff));
1301 /* string_cat() always leaves room for the terminator. Release the
1302 store we used to build the line after writing it. */
1304 log_write(0, flags, "%s", string_from_gstring(g));
1306 #ifndef DISABLE_EVENT
1307 if (!msg) msg_event_raise(US"msg:delivery", addr);
1310 store_reset(reset_point);
1317 deferral_log(address_item * addr, uschar * now,
1318 int logflags, uschar * driver_name, uschar * driver_kind)
1323 /* Build up the line that is used for both the message log and the main
1326 g = reset_point = string_get(256);
1328 /* Create the address string for logging. Must not do this earlier, because
1329 an OK result may be changed to FAIL when a pipe returns text. */
1331 g = string_log_address(g, addr, LOGGING(all_parents), FALSE);
1334 g = string_append(g, 2, US" Q=", queue_name);
1336 /* Either driver_name contains something and driver_kind contains
1337 " router" or " transport" (note the leading space), or driver_name is
1338 a null string and driver_kind contains "routing" without the leading
1339 space, if all routing has been deferred. When a domain has been held,
1340 so nothing has been done at all, both variables contain null strings. */
1344 if (driver_kind[1] == 't' && addr->router)
1345 g = string_append(g, 2, US" R=", addr->router->name);
1346 g = string_fmt_append(g, " %c=%s", toupper(driver_kind[1]), driver_name);
1348 else if (driver_kind)
1349 g = string_append(g, 2, US" ", driver_kind);
1351 g = string_fmt_append(g, " defer (%d)", addr->basic_errno);
1353 if (addr->basic_errno > 0)
1354 g = string_append(g, 2, US": ",
1355 US strerror(addr->basic_errno));
1357 if (addr->host_used)
1359 g = string_append(g, 5,
1360 US" H=", addr->host_used->name,
1361 US" [", addr->host_used->address, US"]");
1362 if (LOGGING(outgoing_port))
1364 int port = addr->host_used->port;
1365 g = string_fmt_append(g, ":%d", port == PORT_NONE ? 25 : port);
1370 g = string_append(g, 2, US": ", addr->message);
1372 (void) string_from_gstring(g);
1374 /* Log the deferment in the message log, but don't clutter it
1375 up with retry-time defers after the first delivery attempt. */
1377 if (f.deliver_firsttime || addr->basic_errno > ERRNO_RETRY_BASE)
1378 deliver_msglog("%s %s\n", now, g->s);
1380 /* Write the main log and reset the store.
1381 For errors of the type "retry time not reached" (also remotes skipped
1382 on queue run), logging is controlled by L_retry_defer. Note that this kind
1383 of error number is negative, and all the retry ones are less than any
1387 log_write(addr->basic_errno <= ERRNO_RETRY_BASE ? L_retry_defer : 0, logflags,
1390 store_reset(reset_point);
1397 failure_log(address_item * addr, uschar * driver_kind, uschar * now)
1400 gstring * g = reset_point = string_get(256);
1402 #ifndef DISABLE_EVENT
1403 /* Message failures for which we will send a DSN get their event raised
1404 later so avoid doing it here. */
1406 if ( !addr->prop.ignore_error
1407 && !(addr->dsn_flags & (rf_dsnflags & ~rf_notify_failure))
1409 msg_event_raise(US"msg:fail:delivery", addr);
1412 /* Build up the log line for the message and main logs */
1414 /* Create the address string for logging. Must not do this earlier, because
1415 an OK result may be changed to FAIL when a pipe returns text. */
1417 g = string_log_address(g, addr, LOGGING(all_parents), FALSE);
1419 if (LOGGING(sender_on_delivery))
1420 g = string_append(g, 3, US" F=<", sender_address, US">");
1423 g = string_append(g, 2, US" Q=", queue_name);
1425 /* Return path may not be set if no delivery actually happened */
1427 if (used_return_path && LOGGING(return_path_on_delivery))
1428 g = string_append(g, 3, US" P=<", used_return_path, US">");
1431 g = string_append(g, 2, US" R=", addr->router->name);
1432 if (addr->transport)
1433 g = string_append(g, 2, US" T=", addr->transport->name);
1435 if (addr->host_used)
1436 g = d_hostlog(g, addr);
1439 g = d_tlslog(g, addr);
1442 if (addr->basic_errno > 0)
1443 g = string_append(g, 2, US": ", US strerror(addr->basic_errno));
1446 g = string_append(g, 2, US": ", addr->message);
1448 (void) string_from_gstring(g);
1450 /* Do the logging. For the message log, "routing failed" for those cases,
1451 just to make it clearer. */
1454 deliver_msglog("%s %s failed for %s\n", now, driver_kind, g->s);
1456 deliver_msglog("%s %s\n", now, g->s);
1458 log_write(0, LOG_MAIN, "** %s", g->s);
1460 store_reset(reset_point);
1466 /*************************************************
1467 * Actions at the end of handling an address *
1468 *************************************************/
1470 /* This is a function for processing a single address when all that can be done
1471 with it has been done.
1474 addr points to the address block
1475 result the result of the delivery attempt
1476 logflags flags for log_write() (LOG_MAIN and/or LOG_PANIC)
1477 driver_type indicates which type of driver (transport, or router) was last
1478 to process the address
1479 logchar '=' or '-' for use when logging deliveries with => or ->
1485 post_process_one(address_item *addr, int result, int logflags, int driver_type,
1488 uschar *now = tod_stamp(tod_log);
1489 uschar *driver_kind = NULL;
1490 uschar *driver_name = NULL;
1492 DEBUG(D_deliver) debug_printf("post-process %s (%d)\n", addr->address, result);
1494 /* Set up driver kind and name for logging. Disable logging if the router or
1495 transport has disabled it. */
1497 if (driver_type == EXIM_DTYPE_TRANSPORT)
1499 if (addr->transport)
1501 driver_name = addr->transport->name;
1502 driver_kind = US" transport";
1503 f.disable_logging = addr->transport->disable_logging;
1505 else driver_kind = US"transporting";
1507 else if (driver_type == EXIM_DTYPE_ROUTER)
1511 driver_name = addr->router->name;
1512 driver_kind = US" router";
1513 f.disable_logging = addr->router->disable_logging;
1515 else driver_kind = US"routing";
1518 /* If there's an error message set, ensure that it contains only printing
1519 characters - it should, but occasionally things slip in and this at least
1520 stops the log format from getting wrecked. We also scan the message for an LDAP
1521 expansion item that has a password setting, and flatten the password. This is a
1522 fudge, but I don't know a cleaner way of doing this. (If the item is badly
1523 malformed, it won't ever have gone near LDAP.) */
1527 const uschar * s = string_printing(addr->message);
1529 /* deconst cast ok as string_printing known to have alloc'n'copied */
1530 addr->message = expand_hide_passwords(US s);
1533 /* If we used a transport that has one of the "return_output" options set, and
1534 if it did in fact generate some output, then for return_output we treat the
1535 message as failed if it was not already set that way, so that the output gets
1536 returned to the sender, provided there is a sender to send it to. For
1537 return_fail_output, do this only if the delivery failed. Otherwise we just
1538 unlink the file, and remove the name so that if the delivery failed, we don't
1539 try to send back an empty or unwanted file. The log_output options operate only
1540 on a non-empty file.
1542 In any case, we close the message file, because we cannot afford to leave a
1543 file-descriptor for one address while processing (maybe very many) others. */
1545 if (addr->return_file >= 0 && addr->return_filename)
1547 BOOL return_output = FALSE;
1548 struct stat statbuf;
1549 (void)EXIMfsync(addr->return_file);
1551 /* If there is no output, do nothing. */
1553 if (fstat(addr->return_file, &statbuf) == 0 && statbuf.st_size > 0)
1555 transport_instance *tb = addr->transport;
1557 /* Handle logging options */
1560 || result == FAIL && tb->log_fail_output
1561 || result == DEFER && tb->log_defer_output
1565 FILE *f = Ufopen(addr->return_filename, "rb");
1567 log_write(0, LOG_MAIN|LOG_PANIC, "failed to open %s to log output "
1568 "from %s transport: %s", addr->return_filename, tb->name,
1571 if ((s = US Ufgets(big_buffer, big_buffer_size, f)))
1573 uschar *p = big_buffer + Ustrlen(big_buffer);
1575 while (p > big_buffer && isspace(p[-1])) p--;
1577 sp = string_printing(big_buffer);
1578 log_write(0, LOG_MAIN, "<%s>: %s transport output: %s",
1579 addr->address, tb->name, sp);
1584 /* Handle returning options, but only if there is an address to return
1587 if (sender_address[0] != 0 || addr->prop.errors_address)
1588 if (tb->return_output)
1590 addr->transport_return = result = FAIL;
1591 if (addr->basic_errno == 0 && !addr->message)
1592 addr->message = US"return message generated";
1593 return_output = TRUE;
1596 if (tb->return_fail_output && result == FAIL) return_output = TRUE;
1599 /* Get rid of the file unless it might be returned, but close it in
1604 Uunlink(addr->return_filename);
1605 addr->return_filename = NULL;
1606 addr->return_file = -1;
1609 (void)close(addr->return_file);
1612 /* The success case happens only after delivery by a transport. */
1616 addr->next = addr_succeed;
1617 addr_succeed = addr;
1619 /* Call address_done() to ensure that we don't deliver to this address again,
1620 and write appropriate things to the message log. If it is a child address, we
1621 call child_done() to scan the ancestors and mark them complete if this is the
1622 last child to complete. */
1624 address_done(addr, now);
1625 DEBUG(D_deliver) debug_printf("%s delivered\n", addr->address);
1628 deliver_msglog("%s %s: %s%s succeeded\n", now, addr->address,
1629 driver_name, driver_kind);
1632 deliver_msglog("%s %s <%s>: %s%s succeeded\n", now, addr->address,
1633 addr->parent->address, driver_name, driver_kind);
1634 child_done(addr, now);
1637 /* Certificates for logging (via events) */
1639 tls_out.ourcert = addr->ourcert;
1640 addr->ourcert = NULL;
1641 tls_out.peercert = addr->peercert;
1642 addr->peercert = NULL;
1644 tls_out.cipher = addr->cipher;
1645 tls_out.peerdn = addr->peerdn;
1646 tls_out.ocsp = addr->ocsp;
1647 # ifdef SUPPORT_DANE
1648 tls_out.dane_verified = testflag(addr, af_dane_verified);
1652 delivery_log(LOG_MAIN, addr, logchar, NULL);
1655 tls_free_cert(&tls_out.ourcert);
1656 tls_free_cert(&tls_out.peercert);
1657 tls_out.cipher = NULL;
1658 tls_out.peerdn = NULL;
1659 tls_out.ocsp = OCSP_NOT_REQ;
1660 # ifdef SUPPORT_DANE
1661 tls_out.dane_verified = FALSE;
1667 /* Soft failure, or local delivery process failed; freezing may be
1670 else if (result == DEFER || result == PANIC)
1672 if (result == PANIC) logflags |= LOG_PANIC;
1674 /* This puts them on the chain in reverse order. Do not change this, because
1675 the code for handling retries assumes that the one with the retry
1676 information is last. */
1678 addr->next = addr_defer;
1681 /* The only currently implemented special action is to freeze the
1682 message. Logging of this is done later, just before the -H file is
1685 if (addr->special_action == SPECIAL_FREEZE)
1687 f.deliver_freeze = TRUE;
1688 deliver_frozen_at = time(NULL);
1689 update_spool = TRUE;
1692 /* If doing a 2-stage queue run, we skip writing to either the message
1693 log or the main log for SMTP defers. */
1695 if (!f.queue_2stage || addr->basic_errno != 0)
1696 deferral_log(addr, now, logflags, driver_name, driver_kind);
1700 /* Hard failure. If there is an address to which an error message can be sent,
1701 put this address on the failed list. If not, put it on the deferred list and
1702 freeze the mail message for human attention. The latter action can also be
1703 explicitly requested by a router or transport. */
1707 /* If this is a delivery error, or a message for which no replies are
1708 wanted, and the message's age is greater than ignore_bounce_errors_after,
1709 force the af_ignore_error flag. This will cause the address to be discarded
1710 later (with a log entry). */
1712 if (!*sender_address && message_age >= ignore_bounce_errors_after)
1713 addr->prop.ignore_error = TRUE;
1715 /* Freeze the message if requested, or if this is a bounce message (or other
1716 message with null sender) and this address does not have its own errors
1717 address. However, don't freeze if errors are being ignored. The actual code
1718 to ignore occurs later, instead of sending a message. Logging of freezing
1719 occurs later, just before writing the -H file. */
1721 if ( !addr->prop.ignore_error
1722 && ( addr->special_action == SPECIAL_FREEZE
1723 || (sender_address[0] == 0 && !addr->prop.errors_address)
1726 frozen_info = addr->special_action == SPECIAL_FREEZE
1728 : f.sender_local && !f.local_error_message
1729 ? US" (message created with -f <>)"
1730 : US" (delivery error message)";
1731 f.deliver_freeze = TRUE;
1732 deliver_frozen_at = time(NULL);
1733 update_spool = TRUE;
1735 /* The address is put on the defer rather than the failed queue, because
1736 the message is being retained. */
1738 addr->next = addr_defer;
1742 /* Don't put the address on the nonrecipients tree yet; wait until an
1743 error message has been successfully sent. */
1747 addr->next = addr_failed;
1751 failure_log(addr, driver_name ? NULL : driver_kind, now);
1754 /* Ensure logging is turned on again in all cases */
1756 f.disable_logging = FALSE;
1762 /*************************************************
1763 * Address-independent error *
1764 *************************************************/
1766 /* This function is called when there's an error that is not dependent on a
1767 particular address, such as an expansion string failure. It puts the error into
1768 all the addresses in a batch, logs the incident on the main and panic logs, and
1769 clears the expansions. It is mostly called from local_deliver(), but can be
1770 called for a remote delivery via findugid().
1773 logit TRUE if (MAIN+PANIC) logging required
1774 addr the first of the chain of addresses
1776 format format string for error message, or NULL if already set in addr
1777 ... arguments for the format
1783 common_error(BOOL logit, address_item *addr, int code, uschar *format, ...)
1785 address_item *addr2;
1786 addr->basic_errno = code;
1793 va_start(ap, format);
1794 g = string_vformat(NULL, TRUE, CS format, ap);
1796 addr->message = string_from_gstring(g);
1799 for (addr2 = addr->next; addr2; addr2 = addr2->next)
1801 addr2->basic_errno = code;
1802 addr2->message = addr->message;
1805 if (logit) log_write(0, LOG_MAIN|LOG_PANIC, "%s", addr->message);
1806 deliver_set_expansions(NULL);
1812 /*************************************************
1813 * Check a "never users" list *
1814 *************************************************/
1816 /* This function is called to check whether a uid is on one of the two "never
1820 uid the uid to be checked
1821 nusers the list to be scanned; the first item in the list is the count
1823 Returns: TRUE if the uid is on the list
1827 check_never_users(uid_t uid, uid_t *nusers)
1830 if (!nusers) return FALSE;
1831 for (i = 1; i <= (int)(nusers[0]); i++) if (nusers[i] == uid) return TRUE;
1837 /*************************************************
1838 * Find uid and gid for a transport *
1839 *************************************************/
1841 /* This function is called for both local and remote deliveries, to find the
1842 uid/gid under which to run the delivery. The values are taken preferentially
1843 from the transport (either explicit or deliver_as_creator), then from the
1844 address (i.e. the router), and if nothing is set, the exim uid/gid are used. If
1845 the resulting uid is on the "never_users" or the "fixed_never_users" list, a
1846 panic error is logged, and the function fails (which normally leads to delivery
1850 addr the address (possibly a chain)
1852 uidp pointer to uid field
1853 gidp pointer to gid field
1854 igfp pointer to the use_initgroups field
1856 Returns: FALSE if failed - error has been set in address(es)
1860 findugid(address_item *addr, transport_instance *tp, uid_t *uidp, gid_t *gidp,
1864 BOOL gid_set = FALSE;
1866 /* Default initgroups flag comes from the transport */
1868 *igfp = tp->initgroups;
1870 /* First see if there's a gid on the transport, either fixed or expandable.
1871 The expanding function always logs failure itself. */
1878 else if (tp->expand_gid)
1880 if (!route_find_expanded_group(tp->expand_gid, tp->name, US"transport", gidp,
1883 common_error(FALSE, addr, ERRNO_GIDFAIL, NULL);
1889 /* If the transport did not set a group, see if the router did. */
1891 if (!gid_set && testflag(addr, af_gid_set))
1897 /* Pick up a uid from the transport if one is set. */
1899 if (tp->uid_set) *uidp = tp->uid;
1901 /* Otherwise, try for an expandable uid field. If it ends up as a numeric id,
1902 it does not provide a passwd value from which a gid can be taken. */
1904 else if (tp->expand_uid)
1907 if (!route_find_expanded_user(tp->expand_uid, tp->name, US"transport", &pw,
1908 uidp, &(addr->message)))
1910 common_error(FALSE, addr, ERRNO_UIDFAIL, NULL);
1920 /* If the transport doesn't set the uid, test the deliver_as_creator flag. */
1922 else if (tp->deliver_as_creator)
1924 *uidp = originator_uid;
1927 *gidp = originator_gid;
1932 /* Otherwise see if the address specifies the uid and if so, take it and its
1935 else if (testflag(addr, af_uid_set))
1938 *igfp = testflag(addr, af_initgroups);
1941 /* Nothing has specified the uid - default to the Exim user, and group if the
1954 /* If no gid is set, it is a disaster. We default to the Exim gid only if
1955 defaulting to the Exim uid. In other words, if the configuration has specified
1956 a uid, it must also provide a gid. */
1960 common_error(TRUE, addr, ERRNO_GIDFAIL, US"User set without group for "
1961 "%s transport", tp->name);
1965 /* Check that the uid is not on the lists of banned uids that may not be used
1966 for delivery processes. */
1968 nuname = check_never_users(*uidp, never_users)
1970 : check_never_users(*uidp, fixed_never_users)
1971 ? US"fixed_never_users"
1975 common_error(TRUE, addr, ERRNO_UIDFAIL, US"User %ld set for %s transport "
1976 "is on the %s list", (long int)(*uidp), tp->name, nuname);
1988 /*************************************************
1989 * Check the size of a message for a transport *
1990 *************************************************/
1992 /* Checks that the message isn't too big for the selected transport.
1993 This is called only when it is known that the limit is set.
1997 addr the (first) address being delivered
2000 DEFER expansion failed or did not yield an integer
2001 FAIL message too big
2005 check_message_size(transport_instance *tp, address_item *addr)
2010 deliver_set_expansions(addr);
2011 size_limit = expand_string_integer(tp->message_size_limit, TRUE);
2012 deliver_set_expansions(NULL);
2014 if (expand_string_message)
2017 addr->message = size_limit == -1
2018 ? string_sprintf("failed to expand message_size_limit "
2019 "in %s transport: %s", tp->name, expand_string_message)
2020 : string_sprintf("invalid message_size_limit "
2021 "in %s transport: %s", tp->name, expand_string_message);
2023 else if (size_limit > 0 && message_size > size_limit)
2027 string_sprintf("message is too big (transport limit = %d)",
2036 /*************************************************
2037 * Transport-time check for a previous delivery *
2038 *************************************************/
2040 /* Check that this base address hasn't previously been delivered to its routed
2041 transport. If it has been delivered, mark it done. The check is necessary at
2042 delivery time in order to handle homonymic addresses correctly in cases where
2043 the pattern of redirection changes between delivery attempts (so the unique
2044 fields change). Non-homonymic previous delivery is detected earlier, at routing
2045 time (which saves unnecessary routing).
2048 addr the address item
2049 testing TRUE if testing wanted only, without side effects
2051 Returns: TRUE if previously delivered by the transport
2055 previously_transported(address_item *addr, BOOL testing)
2057 (void)string_format(big_buffer, big_buffer_size, "%s/%s",
2058 addr->unique + (testflag(addr, af_homonym)? 3:0), addr->transport->name);
2060 if (tree_search(tree_nonrecipients, big_buffer) != 0)
2062 DEBUG(D_deliver|D_route|D_transport)
2063 debug_printf("%s was previously delivered (%s transport): discarded\n",
2064 addr->address, addr->transport->name);
2065 if (!testing) child_done(addr, tod_stamp(tod_log));
2074 /******************************************************
2075 * Check for a given header in a header string *
2076 ******************************************************/
2078 /* This function is used when generating quota warnings. The configuration may
2079 specify any header lines it likes in quota_warn_message. If certain of them are
2080 missing, defaults are inserted, so we need to be able to test for the presence
2084 hdr the required header name
2085 hstring the header string
2087 Returns: TRUE the header is in the string
2088 FALSE the header is not in the string
2092 contains_header(uschar *hdr, uschar *hstring)
2094 int len = Ustrlen(hdr);
2095 uschar *p = hstring;
2098 if (strncmpic(p, hdr, len) == 0)
2101 while (*p == ' ' || *p == '\t') p++;
2102 if (*p == ':') return TRUE;
2104 while (*p != 0 && *p != '\n') p++;
2105 if (*p == '\n') p++;
2113 /*************************************************
2114 * Perform a local delivery *
2115 *************************************************/
2117 /* Each local delivery is performed in a separate process which sets its
2118 uid and gid as specified. This is a safer way than simply changing and
2119 restoring using seteuid(); there is a body of opinion that seteuid() cannot be
2120 used safely. From release 4, Exim no longer makes any use of it. Besides, not
2121 all systems have seteuid().
2123 If the uid/gid are specified in the transport_instance, they are used; the
2124 transport initialization must ensure that either both or neither are set.
2125 Otherwise, the values associated with the address are used. If neither are set,
2126 it is a configuration error.
2128 The transport or the address may specify a home directory (transport over-
2129 rides), and if they do, this is set as $home. If neither have set a working
2130 directory, this value is used for that as well. Otherwise $home is left unset
2131 and the cwd is set to "/" - a directory that should be accessible to all users.
2133 Using a separate process makes it more complicated to get error information
2134 back. We use a pipe to pass the return code and also an error code and error
2135 text string back to the parent process.
2138 addr points to an address block for this delivery; for "normal" local
2139 deliveries this is the only address to be delivered, but for
2140 pseudo-remote deliveries (e.g. by batch SMTP to a file or pipe)
2141 a number of addresses can be handled simultaneously, and in this
2142 case addr will point to a chain of addresses with the same
2145 shadowing TRUE if running a shadow transport; this causes output from pipes
2152 deliver_local(address_item *addr, BOOL shadowing)
2154 BOOL use_initgroups;
2157 int status, len, rc;
2160 uschar *working_directory;
2161 address_item *addr2;
2162 transport_instance *tp = addr->transport;
2164 /* Set up the return path from the errors or sender address. If the transport
2165 has its own return path setting, expand it and replace the existing value. */
2167 if(addr->prop.errors_address)
2168 return_path = addr->prop.errors_address;
2169 #ifdef EXPERIMENTAL_SRS
2170 else if (addr->prop.srs_sender)
2171 return_path = addr->prop.srs_sender;
2174 return_path = sender_address;
2176 if (tp->return_path)
2178 uschar *new_return_path = expand_string(tp->return_path);
2179 if (!new_return_path)
2181 if (!f.expand_string_forcedfail)
2183 common_error(TRUE, addr, ERRNO_EXPANDFAIL,
2184 US"Failed to expand return path \"%s\" in %s transport: %s",
2185 tp->return_path, tp->name, expand_string_message);
2189 else return_path = new_return_path;
2192 /* For local deliveries, one at a time, the value used for logging can just be
2193 set directly, once and for all. */
2195 used_return_path = return_path;
2197 /* Sort out the uid, gid, and initgroups flag. If an error occurs, the message
2198 gets put into the address(es), and the expansions are unset, so we can just
2201 if (!findugid(addr, tp, &uid, &gid, &use_initgroups)) return;
2203 /* See if either the transport or the address specifies a home directory. A
2204 home directory set in the address may already be expanded; a flag is set to
2205 indicate that. In other cases we must expand it. */
2207 if ( (deliver_home = tp->home_dir) /* Set in transport, or */
2208 || ( (deliver_home = addr->home_dir) /* Set in address and */
2209 && !testflag(addr, af_home_expanded) /* not expanded */
2212 uschar *rawhome = deliver_home;
2213 deliver_home = NULL; /* in case it contains $home */
2214 if (!(deliver_home = expand_string(rawhome)))
2216 common_error(TRUE, addr, ERRNO_EXPANDFAIL, US"home directory \"%s\" failed "
2217 "to expand for %s transport: %s", rawhome, tp->name,
2218 expand_string_message);
2221 if (*deliver_home != '/')
2223 common_error(TRUE, addr, ERRNO_NOTABSOLUTE, US"home directory path \"%s\" "
2224 "is not absolute for %s transport", deliver_home, tp->name);
2229 /* See if either the transport or the address specifies a current directory,
2230 and if so, expand it. If nothing is set, use the home directory, unless it is
2231 also unset in which case use "/", which is assumed to be a directory to which
2232 all users have access. It is necessary to be in a visible directory for some
2233 operating systems when running pipes, as some commands (e.g. "rm" under Solaris
2234 2.5) require this. */
2236 working_directory = tp->current_dir ? tp->current_dir : addr->current_dir;
2237 if (working_directory)
2239 uschar *raw = working_directory;
2240 if (!(working_directory = expand_string(raw)))
2242 common_error(TRUE, addr, ERRNO_EXPANDFAIL, US"current directory \"%s\" "
2243 "failed to expand for %s transport: %s", raw, tp->name,
2244 expand_string_message);
2247 if (*working_directory != '/')
2249 common_error(TRUE, addr, ERRNO_NOTABSOLUTE, US"current directory path "
2250 "\"%s\" is not absolute for %s transport", working_directory, tp->name);
2254 else working_directory = deliver_home ? deliver_home : US"/";
2256 /* If one of the return_output flags is set on the transport, create and open a
2257 file in the message log directory for the transport to write its output onto.
2258 This is mainly used by pipe transports. The file needs to be unique to the
2259 address. This feature is not available for shadow transports. */
2262 && ( tp->return_output || tp->return_fail_output
2263 || tp->log_output || tp->log_fail_output || tp->log_defer_output
2268 addr->return_filename =
2269 spool_fname(US"msglog", message_subdir, message_id,
2270 string_sprintf("-%d-%d", getpid(), return_count++));
2272 if ((addr->return_file = open_msglog_file(addr->return_filename, 0400, &error)) < 0)
2274 common_error(TRUE, addr, errno, US"Unable to %s file for %s transport "
2275 "to return message: %s", error, tp->name, strerror(errno));
2280 /* Create the pipe for inter-process communication. */
2284 common_error(TRUE, addr, ERRNO_PIPEFAIL, US"Creation of pipe failed: %s",
2289 /* Now fork the process to do the real work in the subprocess, but first
2290 ensure that all cached resources are freed so that the subprocess starts with
2291 a clean slate and doesn't interfere with the parent process. */
2295 if ((pid = fork()) == 0)
2297 BOOL replicate = TRUE;
2299 /* Prevent core dumps, as we don't want them in users' home directories.
2300 HP-UX doesn't have RLIMIT_CORE; I don't know how to do this in that
2301 system. Some experimental/developing systems (e.g. GNU/Hurd) may define
2302 RLIMIT_CORE but not support it in setrlimit(). For such systems, do not
2303 complain if the error is "not supported".
2305 There are two scenarios where changing the max limit has an effect. In one,
2306 the user is using a .forward and invoking a command of their choice via pipe;
2307 for these, we do need the max limit to be 0 unless the admin chooses to
2308 permit an increased limit. In the other, the command is invoked directly by
2309 the transport and is under administrator control, thus being able to raise
2310 the limit aids in debugging. So there's no general always-right answer.
2312 Thus we inhibit core-dumps completely but let individual transports, while
2313 still root, re-raise the limits back up to aid debugging. We make the
2314 default be no core-dumps -- few enough people can use core dumps in
2315 diagnosis that it's reasonable to make them something that has to be explicitly requested.
2322 if (setrlimit(RLIMIT_CORE, &rl) < 0)
2324 # ifdef SETRLIMIT_NOT_SUPPORTED
2325 if (errno != ENOSYS && errno != ENOTSUP)
2327 log_write(0, LOG_MAIN|LOG_PANIC, "setrlimit(RLIMIT_CORE) failed: %s",
2332 /* Reset the random number generator, so different processes don't all
2333 have the same sequence. */
2337 /* If the transport has a setup entry, call this first, while still
2338 privileged. (Appendfile uses this to expand quota, for example, while
2339 able to read private files.) */
2341 if (addr->transport->setup)
2342 switch((addr->transport->setup)(addr->transport, addr, NULL, uid, gid,
2346 addr->transport_return = DEFER;
2350 addr->transport_return = PANIC;
2354 /* Ignore SIGINT and SIGTERM during delivery. Also ignore SIGUSR1, as
2355 when the process becomes unprivileged, it won't be able to write to the
2356 process log. SIGHUP is ignored throughout exim, except when it is being
2359 signal(SIGINT, SIG_IGN);
2360 signal(SIGTERM, SIG_IGN);
2361 signal(SIGUSR1, SIG_IGN);
2363 /* Close the unwanted half of the pipe, and set close-on-exec for the other
2364 half - for transports that exec things (e.g. pipe). Then set the required
2367 (void)close(pfd[pipe_read]);
2368 (void)fcntl(pfd[pipe_write], F_SETFD, fcntl(pfd[pipe_write], F_GETFD) |
2370 exim_setugid(uid, gid, use_initgroups,
2371 string_sprintf("local delivery to %s <%s> transport=%s", addr->local_part,
2372 addr->address, addr->transport->name));
2376 address_item *batched;
2377 debug_printf(" home=%s current=%s\n", deliver_home, working_directory);
2378 for (batched = addr->next; batched; batched = batched->next)
2379 debug_printf("additional batched address: %s\n", batched->address);
2382 /* Set an appropriate working directory. */
2384 if (Uchdir(working_directory) < 0)
2386 addr->transport_return = DEFER;
2387 addr->basic_errno = errno;
2388 addr->message = string_sprintf("failed to chdir to %s", working_directory);
2391 /* If successful, call the transport */
2396 set_process_info("delivering %s to %s using %s", message_id,
2397 addr->local_part, addr->transport->name);
2399 /* Setting this global in the subprocess means we need never clear it */
2400 transport_name = addr->transport->name;
2402 /* If a transport filter has been specified, set up its argument list.
2403 Any errors will get put into the address, and FALSE yielded. */
2405 if (addr->transport->filter_command)
2407 ok = transport_set_up_command(&transport_filter_argv,
2408 addr->transport->filter_command,
2409 TRUE, PANIC, addr, US"transport filter", NULL);
2410 transport_filter_timeout = addr->transport->filter_timeout;
2412 else transport_filter_argv = NULL;
2416 debug_print_string(addr->transport->debug_string);
2417 replicate = !(addr->transport->info->code)(addr->transport, addr);
2421 /* Pass the results back down the pipe. If necessary, first replicate the
2422 status in the top address to the others in the batch. The label is the
2423 subject of a goto when a call to the transport's setup function fails. We
2424 pass the pointer to the transport back in case it got changed as a result of
2425 file_format in appendfile. */
2429 if (replicate) replicate_status(addr);
2430 for (addr2 = addr; addr2; addr2 = addr2->next)
2433 int local_part_length = Ustrlen(addr2->local_part);
2437 if( (ret = write(pfd[pipe_write], &addr2->transport_return, sizeof(int))) != sizeof(int)
2438 || (ret = write(pfd[pipe_write], &transport_count, sizeof(transport_count))) != sizeof(transport_count)
2439 || (ret = write(pfd[pipe_write], &addr2->flags, sizeof(addr2->flags))) != sizeof(addr2->flags)
2440 || (ret = write(pfd[pipe_write], &addr2->basic_errno, sizeof(int))) != sizeof(int)
2441 || (ret = write(pfd[pipe_write], &addr2->more_errno, sizeof(int))) != sizeof(int)
2442 || (ret = write(pfd[pipe_write], &addr2->delivery_usec, sizeof(int))) != sizeof(int)
2443 || (ret = write(pfd[pipe_write], &addr2->special_action, sizeof(int))) != sizeof(int)
2444 || (ret = write(pfd[pipe_write], &addr2->transport,
2445 sizeof(transport_instance *))) != sizeof(transport_instance *)
2447 /* For a file delivery, pass back the local part, in case the original
2448 was only part of the final delivery path. This gives more complete
2451 || (testflag(addr2, af_file)
2452 && ( (ret = write(pfd[pipe_write], &local_part_length, sizeof(int))) != sizeof(int)
2453 || (ret = write(pfd[pipe_write], addr2->local_part, local_part_length)) != local_part_length
2457 log_write(0, LOG_MAIN|LOG_PANIC, "Failed writing transport results to pipe: %s",
2458 ret == -1 ? strerror(errno) : "short write");
2460 /* Now any messages */
2462 for (i = 0, s = addr2->message; i < 2; i++, s = addr2->user_message)
2464 int message_length = s ? Ustrlen(s) + 1 : 0;
2465 if( (ret = write(pfd[pipe_write], &message_length, sizeof(int))) != sizeof(int)
2466 || message_length > 0 && (ret = write(pfd[pipe_write], s, message_length)) != message_length
2468 log_write(0, LOG_MAIN|LOG_PANIC, "Failed writing transport results to pipe: %s",
2469 ret == -1 ? strerror(errno) : "short write");
2473 /* OK, this process is now done. Free any cached resources that it opened,
2474 and close the pipe we were writing down before exiting. */
2476 (void)close(pfd[pipe_write]);
2481 /* Back in the main process: panic if the fork did not succeed. This seems
2482 better than returning an error - if forking is failing it is probably best
2483 not to try other deliveries for this message. */
2486 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Fork failed for local delivery to %s",
2489 /* Read the pipe to get the delivery status codes and error messages. Our copy
2490 of the writing end must be closed first, as otherwise read() won't return zero
2491 on an empty pipe. We check that a status exists for each address before
2492 overwriting the address structure. If data is missing, the default DEFER status
2493 will remain. Afterwards, close the reading end. */
2495 (void)close(pfd[pipe_write]);
2497 for (addr2 = addr; addr2; addr2 = addr2->next)
2499 if ((len = read(pfd[pipe_read], &status, sizeof(int))) > 0)
2504 addr2->transport_return = status;
2505 len = read(pfd[pipe_read], &transport_count,
2506 sizeof(transport_count));
2507 len = read(pfd[pipe_read], &addr2->flags, sizeof(addr2->flags));
2508 len = read(pfd[pipe_read], &addr2->basic_errno, sizeof(int));
2509 len = read(pfd[pipe_read], &addr2->more_errno, sizeof(int));
2510 len = read(pfd[pipe_read], &addr2->delivery_usec, sizeof(int));
2511 len = read(pfd[pipe_read], &addr2->special_action, sizeof(int));
2512 len = read(pfd[pipe_read], &addr2->transport,
2513 sizeof(transport_instance *));
2515 if (testflag(addr2, af_file))
2518 if ( read(pfd[pipe_read], &llen, sizeof(int)) != sizeof(int)
2519 || llen > 64*4 /* limit from rfc 5821, times I18N factor */
2522 log_write(0, LOG_MAIN|LOG_PANIC, "bad local_part length read"
2523 " from delivery subprocess");
2526 /* sanity-checked llen so disable the Coverity error */
2527 /* coverity[tainted_data] */
2528 if (read(pfd[pipe_read], big_buffer, llen) != llen)
2530 log_write(0, LOG_MAIN|LOG_PANIC, "bad local_part read"
2531 " from delivery subprocess");
2534 big_buffer[llen] = 0;
2535 addr2->local_part = string_copy(big_buffer);
2538 for (i = 0, sptr = &addr2->message; i < 2; i++, sptr = &addr2->user_message)
2541 len = read(pfd[pipe_read], &message_length, sizeof(int));
2542 if (message_length > 0)
2544 len = read(pfd[pipe_read], big_buffer, message_length);
2545 big_buffer[big_buffer_size-1] = '\0'; /* guard byte */
2546 if (len > 0) *sptr = string_copy(big_buffer);
2553 log_write(0, LOG_MAIN|LOG_PANIC, "failed to read delivery status for %s "
2554 "from delivery subprocess", addr2->unique);
2559 (void)close(pfd[pipe_read]);
2561 /* Unless shadowing, write all successful addresses immediately to the journal
2562 file, to ensure they are recorded asap. For homonymic addresses, use the base
2563 address plus the transport name. Failure to write the journal is panic-worthy,
2564 but don't stop, as it may prove possible subsequently to update the spool file
2565 in order to record the delivery. */
2569 for (addr2 = addr; addr2; addr2 = addr2->next)
2570 if (addr2->transport_return == OK)
2572 if (testflag(addr2, af_homonym))
2573 sprintf(CS big_buffer, "%.500s/%s\n", addr2->unique + 3, tp->name);
2575 sprintf(CS big_buffer, "%.500s\n", addr2->unique);
2577 /* In the test harness, wait just a bit to let the subprocess finish off
2578 any debug output etc first. */
2580 if (f.running_in_test_harness) millisleep(300);
2582 DEBUG(D_deliver) debug_printf("journalling %s", big_buffer);
2583 len = Ustrlen(big_buffer);
2584 if (write(journal_fd, big_buffer, len) != len)
2585 log_write(0, LOG_MAIN|LOG_PANIC, "failed to update journal for %s: %s",
2586 big_buffer, strerror(errno));
2589 /* Ensure the journal file is pushed out to disk. */
2591 if (EXIMfsync(journal_fd) < 0)
2592 log_write(0, LOG_MAIN|LOG_PANIC, "failed to fsync journal: %s",
2596 /* Wait for the process to finish. If it terminates with a non-zero code,
2597 freeze the message (except for SIGTERM, SIGKILL and SIGQUIT), but leave the
2598 status values of all the addresses as they are. Take care to handle the case
2599 when the subprocess doesn't seem to exist. This has been seen on one system
2600 when Exim was called from an MUA that set SIGCHLD to SIG_IGN. When that
2601 happens, wait() doesn't recognize the termination of child processes. Exim now
2602 resets SIGCHLD to SIG_DFL, but this code should still be robust. */
2604 while ((rc = wait(&status)) != pid)
2605 if (rc < 0 && errno == ECHILD) /* Process has vanished */
2607 log_write(0, LOG_MAIN, "%s transport process vanished unexpectedly",
2608 addr->transport->driver_name);
2613 if ((status & 0xffff) != 0)
2615 int msb = (status >> 8) & 255;
2616 int lsb = status & 255;
2617 int code = (msb == 0)? (lsb & 0x7f) : msb;
2618 if (msb != 0 || (code != SIGTERM && code != SIGKILL && code != SIGQUIT))
2619 addr->special_action = SPECIAL_FREEZE;
2620 log_write(0, LOG_MAIN|LOG_PANIC, "%s transport process returned non-zero "
2621 "status 0x%04x: %s %d",
2622 addr->transport->driver_name,
2624 msb == 0 ? "terminated by signal" : "exit code",
2628 /* If SPECIAL_WARN is set in the top address, send a warning message. */
2630 if (addr->special_action == SPECIAL_WARN && addr->transport->warn_message)
2633 uschar *warn_message;
2636 DEBUG(D_deliver) debug_printf("Warning message requested by transport\n");
2638 if (!(warn_message = expand_string(addr->transport->warn_message)))
2639 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand \"%s\" (warning "
2640 "message for %s transport): %s", addr->transport->warn_message,
2641 addr->transport->name, expand_string_message);
2643 else if ((pid = child_open_exim(&fd)) > 0)
2645 FILE *f = fdopen(fd, "wb");
2646 if (errors_reply_to && !contains_header(US"Reply-To", warn_message))
2647 fprintf(f, "Reply-To: %s\n", errors_reply_to);
2648 fprintf(f, "Auto-Submitted: auto-replied\n");
2649 if (!contains_header(US"From", warn_message))
2651 fprintf(f, "%s", CS warn_message);
2653 /* Close and wait for child process to complete, without a timeout. */
2656 (void)child_close(pid, 0);
2659 addr->special_action = SPECIAL_NONE;
2666 /* Check transport for the given concurrency limit. Return TRUE if over
2667 the limit (or an expansion failure), else FALSE and if there was a limit,
2668 the key for the hints database used for the concurrency count. */
2671 tpt_parallel_check(transport_instance * tp, address_item * addr, uschar ** key)
2673 unsigned max_parallel;
2675 if (!tp->max_parallel) return FALSE;
2677 max_parallel = (unsigned) expand_string_integer(tp->max_parallel, TRUE);
2678 if (expand_string_message)
2680 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand max_parallel option "
2681 "in %s transport (%s): %s", tp->name, addr->address,
2682 expand_string_message);
2686 if (max_parallel > 0)
2688 uschar * serialize_key = string_sprintf("tpt-serialize-%s", tp->name);
2689 if (!enq_start(serialize_key, max_parallel))
2691 address_item * next;
2693 debug_printf("skipping tpt %s because concurrency limit %u reached\n",
2694 tp->name, max_parallel);
2698 addr->message = US"concurrency limit reached for transport";
2699 addr->basic_errno = ERRNO_TRETRY;
2700 post_process_one(addr, DEFER, LOG_MAIN, EXIM_DTYPE_TRANSPORT, 0);
2701 } while ((addr = next));
2704 *key = serialize_key;
2711 /*************************************************
2712 * Do local deliveries *
2713 *************************************************/
2715 /* This function processes the list of addresses in addr_local. True local
2716 deliveries are always done one address at a time. However, local deliveries can
2717 be batched up in some cases. Typically this is when writing batched SMTP output
2718 files for use by some external transport mechanism, or when running local
2719 deliveries over LMTP.
2726 do_local_deliveries(void)
2729 open_db *dbm_file = NULL;
2730 time_t now = time(NULL);
2732 /* Loop until we have exhausted the supply of local deliveries */
2736 struct timeval delivery_start;
2737 struct timeval deliver_time;
2738 address_item *addr2, *addr3, *nextaddr;
2739 int logflags = LOG_MAIN;
2740 int logchar = f.dont_deliver? '*' : '=';
2741 transport_instance *tp;
2742 uschar * serialize_key = NULL;
2744 /* Pick the first undelivered address off the chain */
2746 address_item *addr = addr_local;
2747 addr_local = addr->next;
2750 DEBUG(D_deliver|D_transport)
2751 debug_printf("--------> %s <--------\n", addr->address);
2753 /* An internal disaster if there is no transport. Should not occur! */
2755 if (!(tp = addr->transport))
2757 logflags |= LOG_PANIC;
2758 f.disable_logging = FALSE; /* Jic */
2759 addr->message = addr->router
2760 ? string_sprintf("No transport set by %s router", addr->router->name)
2761 : string_sprintf("No transport set by system filter");
2762 post_process_one(addr, DEFER, logflags, EXIM_DTYPE_TRANSPORT, 0);
2766 /* Check that this base address hasn't previously been delivered to this
2767 transport. The check is necessary at this point to handle homonymic addresses
2768 correctly in cases where the pattern of redirection changes between delivery
2769 attempts. Non-homonymic previous delivery is detected earlier, at routing
2772 if (previously_transported(addr, FALSE)) continue;
2774 /* There are weird cases where logging is disabled */
2776 f.disable_logging = tp->disable_logging;
2778 /* Check for batched addresses and possible amalgamation. Skip all the work
2779 if either batch_max <= 1 or there aren't any other addresses for local
2782 if (tp->batch_max > 1 && addr_local)
2784 int batch_count = 1;
2785 BOOL uses_dom = readconf_depends((driver_instance *)tp, US"domain");
2786 BOOL uses_lp = ( testflag(addr, af_pfr)
2787 && (testflag(addr, af_file) || addr->local_part[0] == '|')
2789 || readconf_depends((driver_instance *)tp, US"local_part");
2790 uschar *batch_id = NULL;
2791 address_item **anchor = &addr_local;
2792 address_item *last = addr;
2795 /* Expand the batch_id string for comparison with other addresses.
2796 Expansion failure suppresses batching. */
2800 deliver_set_expansions(addr);
2801 batch_id = expand_string(tp->batch_id);
2802 deliver_set_expansions(NULL);
2805 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand batch_id option "
2806 "in %s transport (%s): %s", tp->name, addr->address,
2807 expand_string_message);
2808 batch_count = tp->batch_max;
2812 /* Until we reach the batch_max limit, pick off addresses which have the
2813 same characteristics. These are:
2816 not previously delivered (see comment about 50 lines above)
2817 same local part if the transport's configuration contains $local_part
2818 or if this is a file or pipe delivery from a redirection
2819 same domain if the transport's configuration contains $domain
2821 same additional headers
2822 same headers to be removed
2823 same uid/gid for running the transport
2824 same first host if a host list is set
2827 while ((next = *anchor) && batch_count < tp->batch_max)
2830 tp == next->transport
2831 && !previously_transported(next, TRUE)
2832 && testflag(addr, af_pfr) == testflag(next, af_pfr)
2833 && testflag(addr, af_file) == testflag(next, af_file)
2834 && (!uses_lp || Ustrcmp(next->local_part, addr->local_part) == 0)
2835 && (!uses_dom || Ustrcmp(next->domain, addr->domain) == 0)
2836 && same_strings(next->prop.errors_address, addr->prop.errors_address)
2837 && same_headers(next->prop.extra_headers, addr->prop.extra_headers)
2838 && same_strings(next->prop.remove_headers, addr->prop.remove_headers)
2839 && same_ugid(tp, addr, next)
2840 && ( !addr->host_list && !next->host_list
2843 && Ustrcmp(addr->host_list->name, next->host_list->name) == 0
2846 /* If the transport has a batch_id setting, batch_id will be non-NULL
2847 from the expansion outside the loop. Expand for this address and compare.
2848 Expansion failure makes this address ineligible for batching. */
2853 address_item *save_nextnext = next->next;
2854 next->next = NULL; /* Expansion for a single address */
2855 deliver_set_expansions(next);
2856 next->next = save_nextnext;
2857 bid = expand_string(tp->batch_id);
2858 deliver_set_expansions(NULL);
2861 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand batch_id option "
2862 "in %s transport (%s): %s", tp->name, next->address,
2863 expand_string_message);
2866 else ok = (Ustrcmp(batch_id, bid) == 0);
2869 /* Take address into batch if OK. */
2873 *anchor = next->next; /* Include the address */
2879 else anchor = &next->next; /* Skip the address */
2883 /* We now have one or more addresses that can be delivered in a batch. Check
2884 whether the transport is prepared to accept a message of this size. If not,
2885 fail them all forthwith. If the expansion fails, or does not yield an
2886 integer, defer delivery. */
2888 if (tp->message_size_limit)
2890 int rc = check_message_size(tp, addr);
2893 replicate_status(addr);
2897 post_process_one(addr, rc, logflags, EXIM_DTYPE_TRANSPORT, 0);
2900 continue; /* With next batch of addresses */
2904 /* If we are not running the queue, or if forcing, all deliveries will be
2905 attempted. Otherwise, we must respect the retry times for each address. Even
2906 when not doing this, we need to set up the retry key string, and determine
2907 whether a retry record exists, because after a successful delivery, a delete
2908 retry item must be set up. Keep the retry database open only for the duration
2909 of these checks, rather than for all local deliveries, because some local
2910 deliveries (e.g. to pipes) can take a substantial time. */
2912 if (!(dbm_file = dbfn_open(US"retry", O_RDONLY, &dbblock, FALSE)))
2914 DEBUG(D_deliver|D_retry|D_hints_lookup)
2915 debug_printf("no retry data available\n");
2922 BOOL ok = TRUE; /* to deliver this address */
2925 /* Set up the retry key to include the domain or not, and change its
2926 leading character from "R" to "T". Must make a copy before doing this,
2927 because the old key may be pointed to from a "delete" retry item after
2930 retry_key = string_copy(
2931 tp->retry_use_local_part ? addr2->address_retry_key :
2932 addr2->domain_retry_key);
2935 /* Inspect the retry data. If there is no hints file, delivery happens. */
2939 dbdata_retry *retry_record = dbfn_read(dbm_file, retry_key);
2941 /* If there is no retry record, delivery happens. If there is,
2942 remember it exists so it can be deleted after a successful delivery. */
2946 setflag(addr2, af_lt_retry_exists);
2948 /* A retry record exists for this address. If queue running and not
2949 forcing, inspect its contents. If the record is too old, or if its
2950 retry time has come, or if it has passed its cutoff time, delivery
2955 debug_printf("retry record exists: age=%s ",
2956 readconf_printtime(now - retry_record->time_stamp));
2957 debug_printf("(max %s)\n", readconf_printtime(retry_data_expire));
2958 debug_printf(" time to retry = %s expired = %d\n",
2959 readconf_printtime(retry_record->next_try - now),
2960 retry_record->expired);
2963 if (f.queue_running && !f.deliver_force)
2965 ok = (now - retry_record->time_stamp > retry_data_expire)
2966 || (now >= retry_record->next_try)
2967 || retry_record->expired;
2969 /* If we haven't reached the retry time, there is one more check
2970 to do, which is for the ultimate address timeout. */
2973 ok = retry_ultimate_address_timeout(retry_key, addr2->domain,
2977 else DEBUG(D_retry) debug_printf("no retry record exists\n");
2980 /* This address is to be delivered. Leave it on the chain. */
2985 addr2 = addr2->next;
2988 /* This address is to be deferred. Take it out of the chain, and
2989 post-process it as complete. Must take it out of the chain first,
2990 because post processing puts it on another chain. */
2994 address_item *this = addr2;
2995 this->message = US"Retry time not yet reached";
2996 this->basic_errno = ERRNO_LRETRY;
2997 addr2 = addr3 ? (addr3->next = addr2->next)
2998 : (addr = addr2->next);
2999 post_process_one(this, DEFER, logflags, EXIM_DTYPE_TRANSPORT, 0);
3003 if (dbm_file) dbfn_close(dbm_file);
3005 /* If there are no addresses left on the chain, they all deferred. Loop
3006 for the next set of addresses. */
3008 if (!addr) continue;
3010 /* If the transport is limited for parallellism, enforce that here.
3011 We use a hints DB entry, incremented here and decremented after
3012 the transport (and any shadow transport) completes. */
3014 if (tpt_parallel_check(tp, addr, &serialize_key))
3016 if (expand_string_message)
3018 logflags |= LOG_PANIC;
3022 post_process_one(addr, DEFER, logflags, EXIM_DTYPE_TRANSPORT, 0);
3023 } while ((addr = addr2));
3025 continue; /* Loop for the next set of addresses. */
3029 /* So, finally, we do have some addresses that can be passed to the
3030 transport. Before doing so, set up variables that are relevant to a
3033 deliver_set_expansions(addr);
3035 gettimeofday(&delivery_start, NULL);
3036 deliver_local(addr, FALSE);
3037 timesince(&deliver_time, &delivery_start);
3039 /* If a shadow transport (which must perforce be another local transport), is
3040 defined, and its condition is met, we must pass the message to the shadow
3041 too, but only those addresses that succeeded. We do this by making a new
3042 chain of addresses - also to keep the original chain uncontaminated. We must
3043 use a chain rather than doing it one by one, because the shadow transport may
3046 NOTE: if the condition fails because of a lookup defer, there is nothing we
3050 && ( !tp->shadow_condition
3051 || expand_check_condition(tp->shadow_condition, tp->name, US"transport")
3054 transport_instance *stp;
3055 address_item *shadow_addr = NULL;
3056 address_item **last = &shadow_addr;
3058 for (stp = transports; stp; stp = stp->next)
3059 if (Ustrcmp(stp->name, tp->shadow) == 0) break;
3062 log_write(0, LOG_MAIN|LOG_PANIC, "shadow transport \"%s\" not found ",
3065 /* Pick off the addresses that have succeeded, and make clones. Put into
3066 the shadow_message field a pointer to the shadow_message field of the real
3069 else for (addr2 = addr; addr2; addr2 = addr2->next)
3070 if (addr2->transport_return == OK)
3072 addr3 = store_get(sizeof(address_item));
3075 addr3->shadow_message = US &addr2->shadow_message;
3076 addr3->transport = stp;
3077 addr3->transport_return = DEFER;
3078 addr3->return_filename = NULL;
3079 addr3->return_file = -1;
3081 last = &addr3->next;
3084 /* If we found any addresses to shadow, run the delivery, and stick any
3085 message back into the shadow_message field in the original. */
3089 int save_count = transport_count;
3091 DEBUG(D_deliver|D_transport)
3092 debug_printf(">>>>>>>>>>>>>>>> Shadow delivery >>>>>>>>>>>>>>>>\n");
3093 deliver_local(shadow_addr, TRUE);
3095 for(; shadow_addr; shadow_addr = shadow_addr->next)
3097 int sresult = shadow_addr->transport_return;
3098 *(uschar **)shadow_addr->shadow_message =
3100 ? string_sprintf(" ST=%s", stp->name)
3101 : string_sprintf(" ST=%s (%s%s%s)", stp->name,
3102 shadow_addr->basic_errno <= 0
3104 : US strerror(shadow_addr->basic_errno),
3105 shadow_addr->basic_errno <= 0 || !shadow_addr->message
3108 shadow_addr->message
3109 ? shadow_addr->message
3110 : shadow_addr->basic_errno <= 0
3114 DEBUG(D_deliver|D_transport)
3115 debug_printf("%s shadow transport returned %s for %s\n",
3117 sresult == OK ? "OK" :
3118 sresult == DEFER ? "DEFER" :
3119 sresult == FAIL ? "FAIL" :
3120 sresult == PANIC ? "PANIC" : "?",
3121 shadow_addr->address);
3124 DEBUG(D_deliver|D_transport)
3125 debug_printf(">>>>>>>>>>>>>>>> End shadow delivery >>>>>>>>>>>>>>>>\n");
3127 transport_count = save_count; /* Restore original transport count */
3131 /* Cancel the expansions that were set up for the delivery. */
3133 deliver_set_expansions(NULL);
3135 /* If the transport was parallelism-limited, decrement the hints DB record. */
3137 if (serialize_key) enq_end(serialize_key);
3139 /* Now we can process the results of the real transport. We must take each
3140 address off the chain first, because post_process_one() puts it on another
3143 for (addr2 = addr; addr2; addr2 = nextaddr)
3145 int result = addr2->transport_return;
3146 nextaddr = addr2->next;
3148 DEBUG(D_deliver|D_transport)
3149 debug_printf("%s transport returned %s for %s\n",
3151 result == OK ? "OK" :
3152 result == DEFER ? "DEFER" :
3153 result == FAIL ? "FAIL" :
3154 result == PANIC ? "PANIC" : "?",
3157 /* If there is a retry_record, or if delivery is deferred, build a retry
3158 item for setting a new retry time or deleting the old retry record from
3159 the database. These items are handled all together after all addresses
3160 have been handled (so the database is open just for a short time for
3163 if (result == DEFER || testflag(addr2, af_lt_retry_exists))
3165 int flags = result == DEFER ? 0 : rf_delete;
3166 uschar *retry_key = string_copy(tp->retry_use_local_part
3167 ? addr2->address_retry_key : addr2->domain_retry_key);
3169 retry_add_item(addr2, retry_key, flags);
3172 /* Done with this address */
3176 addr2->more_errno = deliver_time.tv_sec;
3177 addr2->delivery_usec = deliver_time.tv_usec;
3179 post_process_one(addr2, result, logflags, EXIM_DTYPE_TRANSPORT, logchar);
3181 /* If a pipe delivery generated text to be sent back, the result may be
3182 changed to FAIL, and we must copy this for subsequent addresses in the
3185 if (addr2->transport_return != result)
3187 for (addr3 = nextaddr; addr3; addr3 = addr3->next)
3189 addr3->transport_return = addr2->transport_return;
3190 addr3->basic_errno = addr2->basic_errno;
3191 addr3->message = addr2->message;
3193 result = addr2->transport_return;
3196 /* Whether or not the result was changed to FAIL, we need to copy the
3197 return_file value from the first address into all the addresses of the
3198 batch, so they are all listed in the error message. */
3200 addr2->return_file = addr->return_file;
3202 /* Change log character for recording successful deliveries. */
3204 if (result == OK) logchar = '-';
3206 } /* Loop back for next batch of addresses */
3212 /*************************************************
3213 * Sort remote deliveries *
3214 *************************************************/
3216 /* This function is called if remote_sort_domains is set. It arranges that the
3217 chain of addresses for remote deliveries is ordered according to the strings
3218 specified. Try to make this shuffling reasonably efficient by handling
3219 sequences of addresses rather than just single ones.
3226 sort_remote_deliveries(void)
3229 address_item **aptr = &addr_remote;
3230 const uschar *listptr = remote_sort_domains;
3235 && (pattern = string_nextinlist(&listptr, &sep, patbuf, sizeof(patbuf)))
3238 address_item *moved = NULL;
3239 address_item **bptr = &moved;
3243 address_item **next;
3244 deliver_domain = (*aptr)->domain; /* set $domain */
3245 if (match_isinlist(deliver_domain, (const uschar **)&pattern, UCHAR_MAX+1,
3246 &domainlist_anchor, NULL, MCL_DOMAIN, TRUE, NULL) == OK)
3248 aptr = &(*aptr)->next;
3252 next = &(*aptr)->next;
3254 && (deliver_domain = (*next)->domain, /* Set $domain */
3255 match_isinlist(deliver_domain, (const uschar **)&pattern, UCHAR_MAX+1,
3256 &domainlist_anchor, NULL, MCL_DOMAIN, TRUE, NULL)) != OK
3258 next = &(*next)->next;
3260 /* If the batch of non-matchers is at the end, add on any that were
3261 extracted further up the chain, and end this iteration. Otherwise,
3262 extract them from the chain and hang on the moved chain. */
3274 aptr = &(*aptr)->next;
3277 /* If the loop ended because the final address matched, *aptr will
3278 be NULL. Add on to the end any extracted non-matching addresses. If
3279 *aptr is not NULL, the loop ended via "break" when *next is null, that
3280 is, there was a string of non-matching addresses at the end. In this
3281 case the extracted addresses have already been added on the end. */
3283 if (!*aptr) *aptr = moved;
3289 debug_printf("remote addresses after sorting:\n");
3290 for (addr = addr_remote; addr; addr = addr->next)
3291 debug_printf(" %s\n", addr->address);
3297 /*************************************************
3298 * Read from pipe for remote delivery subprocess *
3299 *************************************************/
3301 /* This function is called when the subprocess is complete, but can also be
3302 called before it is complete, in order to empty a pipe that is full (to prevent
3303 deadlock). It must therefore keep track of its progress in the parlist data
3306 We read the pipe to get the delivery status codes and a possible error message
3307 for each address, optionally preceded by unusability data for the hosts and
3308 also by optional retry data.
3310 Read in large chunks into the big buffer and then scan through, interpreting
3311 the data therein. In most cases, only a single read will be necessary. No
3312 individual item will ever be anywhere near 2500 bytes in length, so by ensuring
3313 that we read the next chunk when there is less than 2500 bytes left in the
3314 non-final chunk, we can assume each item is complete in the buffer before
3315 handling it. Each item is written using a single write(), which is atomic for
3316 small items (less than PIPE_BUF, which seems to be at least 512 in any Unix and
3317 often bigger) so even if we are reading while the subprocess is still going, we
3318 should never have only a partial item in the buffer.
3320 hs12: This assumption is not true anymore, since we get quite large items (certificate
3321 information and such).
3324 poffset the offset of the parlist item
3325 eop TRUE if the process has completed
3327 Returns: TRUE if the terminating 'Z' item has been read,
3328 or there has been a disaster (i.e. no more data needed);
3333 par_read_pipe(int poffset, BOOL eop)
3336 pardata *p = parlist + poffset;
3337 address_item *addrlist = p->addrlist;
3338 address_item *addr = p->addr;
3342 uschar *msg = p->msg;
3343 BOOL done = p->done;
3345 /* Loop through all items, reading from the pipe when necessary. The pipe
3346 used to be non-blocking. But I do not see a reason for using non-blocking I/O
3347 here, as the preceding select() tells us, if data is available for reading.
3349 A read() on a "selected" handle should never block, but(!) it may return
3350 less data then we expected. (The buffer size we pass to read() shouldn't be
3351 understood as a "request", but as a "limit".)
3353 Each separate item is written to the pipe in a timely manner. But, especially for
3354 larger items, the read(2) may already return partial data from the write(2).
3356 The write is atomic mostly (depending on the amount written), but atomic does
3357 not imply "all or noting", it just is "not intermixed" with other writes on the
3358 same channel (pipe).
3362 DEBUG(D_deliver) debug_printf("reading pipe for subprocess %d (%s)\n",
3363 (int)p->pid, eop? "ended" : "not ended yet");
3367 retry_item *r, **rp;
3368 uschar pipeheader[PIPE_HEADER_SIZE+1];
3369 uschar *id = &pipeheader[0];
3370 uschar *subid = &pipeheader[1];
3371 uschar *ptr = big_buffer;
3372 size_t required = PIPE_HEADER_SIZE; /* first the pipehaeder, later the data */
3375 DEBUG(D_deliver) debug_printf(
3376 "expect %lu bytes (pipeheader) from tpt process %d\n", (u_long)required, pid);
3378 /* We require(!) all the PIPE_HEADER_SIZE bytes here, as we know,
3379 they're written in a timely manner, so waiting for the write shouldn't hurt a lot.
3380 If we get less, we can assume the subprocess do be done and do not expect any further
3381 information from it. */
3383 if ((got = readn(fd, pipeheader, required)) != required)
3385 msg = string_sprintf("got " SSIZE_T_FMT " of %d bytes (pipeheader) "
3386 "from transport process %d for transport %s",
3387 got, PIPE_HEADER_SIZE, pid, addr->transport->driver_name);
3392 pipeheader[PIPE_HEADER_SIZE] = '\0';
3394 debug_printf("got %ld bytes (pipeheader) from transport process %d\n",
3398 /* If we can't decode the pipeheader, the subprocess seems to have a
3399 problem, we do not expect any furher information from it. */
3401 required = Ustrtol(pipeheader+2, &endc, 10);
3404 msg = string_sprintf("failed to read pipe "
3405 "from transport process %d for transport %s: error decoding size from header",
3406 pid, addr->transport->driver_name);
3413 debug_printf("expect %lu bytes (pipedata) from transport process %d\n",
3414 (u_long)required, pid);
3416 /* Same as above, the transport process will write the bytes announced
3417 in a timely manner, so we can just wait for the bytes, getting less than expected
3418 is considered a problem of the subprocess, we do not expect anything else from it. */
3419 if ((got = readn(fd, big_buffer, required)) != required)
3421 msg = string_sprintf("got only " SSIZE_T_FMT " of " SIZE_T_FMT
3422 " bytes (pipedata) from transport process %d for transport %s",
3423 got, required, pid, addr->transport->driver_name);
3428 /* Handle each possible type of item, assuming the complete item is
3429 available in store. */
3433 /* Host items exist only if any hosts were marked unusable. Match
3434 up by checking the IP address. */
3437 for (h = addrlist->host_list; h; h = h->next)
3439 if (!h->address || Ustrcmp(h->address, ptr+2) != 0) continue;
3447 /* Retry items are sent in a preceding R item for each address. This is
3448 kept separate to keep each message short enough to guarantee it won't
3449 be split in the pipe. Hopefully, in the majority of cases, there won't in
3450 fact be any retry items at all.
3452 The complete set of retry items might include an item to delete a
3453 routing retry if there was a previous routing delay. However, routing
3454 retries are also used when a remote transport identifies an address error.
3455 In that case, there may also be an "add" item for the same key. Arrange
3456 that a "delete" item is dropped in favour of an "add" item. */
3459 if (!addr) goto ADDR_MISMATCH;
3461 DEBUG(D_deliver|D_retry)
3462 debug_printf("reading retry information for %s from subprocess\n",
3465 /* Cut out any "delete" items on the list. */
3467 for (rp = &addr->retries; (r = *rp); rp = &r->next)
3468 if (Ustrcmp(r->key, ptr+1) == 0) /* Found item with same key */
3470 if (!(r->flags & rf_delete)) break; /* It was not "delete" */
3471 *rp = r->next; /* Excise a delete item */
3472 DEBUG(D_deliver|D_retry)
3473 debug_printf(" existing delete item dropped\n");
3476 /* We want to add a delete item only if there is no non-delete item;
3477 however we still have to step ptr through the data. */
3479 if (!r || !(*ptr & rf_delete))
3481 r = store_get(sizeof(retry_item));
3482 r->next = addr->retries;
3485 r->key = string_copy(ptr);
3487 memcpy(&r->basic_errno, ptr, sizeof(r->basic_errno));
3488 ptr += sizeof(r->basic_errno);
3489 memcpy(&r->more_errno, ptr, sizeof(r->more_errno));
3490 ptr += sizeof(r->more_errno);
3491 r->message = *ptr ? string_copy(ptr) : NULL;
3492 DEBUG(D_deliver|D_retry) debug_printf(" added %s item\n",
3493 r->flags & rf_delete ? "delete" : "retry");
3498 DEBUG(D_deliver|D_retry)
3499 debug_printf(" delete item not added: non-delete item exists\n");
3502 ptr += sizeof(r->basic_errno) + sizeof(r->more_errno);
3508 /* Put the amount of data written into the parlist block */
3511 memcpy(&(p->transport_count), ptr, sizeof(transport_count));
3512 ptr += sizeof(transport_count);
3515 /* Address items are in the order of items on the address chain. We
3516 remember the current address value in case this function is called
3517 several times to empty the pipe in stages. Information about delivery
3518 over TLS is sent in a preceding X item for each address. We don't put
3519 it in with the other info, in order to keep each message short enough to
3520 guarantee it won't be split in the pipe. */
3524 if (!addr) goto ADDR_MISMATCH; /* Below, in 'A' handler */
3528 addr->cipher = NULL;
3529 addr->peerdn = NULL;
3532 addr->cipher = string_copy(ptr);
3535 addr->peerdn = string_copy(ptr);
3540 (void) tls_import_cert(ptr, &addr->peercert);
3542 addr->peercert = NULL;
3547 (void) tls_import_cert(ptr, &addr->ourcert);
3549 addr->ourcert = NULL;
3552 # ifndef DISABLE_OCSP
3554 addr->ocsp = *ptr ? *ptr - '0' : OCSP_NOT_REQ;
3560 #endif /*SUPPORT_TLS*/
3562 case 'C': /* client authenticator information */
3565 case '1': addr->authenticator = *ptr ? string_copy(ptr) : NULL; break;
3566 case '2': addr->auth_id = *ptr ? string_copy(ptr) : NULL; break;
3567 case '3': addr->auth_sndr = *ptr ? string_copy(ptr) : NULL; break;
3572 #ifndef DISABLE_PRDR
3574 setflag(addr, af_prdr_used);
3581 #ifdef EXPERIMENTAL_PIPE_CONNECT
3582 case 2: setflag(addr, af_early_pipe); /*FALLTHROUGH*/
3584 case 1: setflag(addr, af_pipelining); break;
3589 setflag(addr, af_chunking_used);
3593 setflag(addr, af_tcp_fastopen_conn);
3594 if (*subid > '0') setflag(addr, af_tcp_fastopen);
3595 if (*subid > '1') setflag(addr, af_tcp_fastopen_data);
3599 if (!addr) goto ADDR_MISMATCH;
3600 memcpy(&(addr->dsn_aware), ptr, sizeof(addr->dsn_aware));
3601 ptr += sizeof(addr->dsn_aware);
3602 DEBUG(D_deliver) debug_printf("DSN read: addr->dsn_aware = %d\n", addr->dsn_aware);
3609 msg = string_sprintf("address count mismatch for data read from pipe "
3610 "for transport process %d for transport %s", pid,
3611 addrlist->transport->driver_name);
3618 #ifdef SUPPORT_SOCKS
3619 case '2': /* proxy information; must arrive before A0 and applies to that addr XXX oops*/
3620 proxy_session = TRUE; /*XXX should this be cleared somewhere? */
3625 proxy_local_address = string_copy(ptr);
3627 memcpy(&proxy_local_port, ptr, sizeof(proxy_local_port));
3628 ptr += sizeof(proxy_local_port);
3633 #ifdef EXPERIMENTAL_DSN_INFO
3634 case '1': /* must arrive before A0, and applies to that addr */
3635 /* Two strings: smtp_greeting and helo_response */
3636 addr->smtp_greeting = string_copy(ptr);
3638 addr->helo_response = string_copy(ptr);
3644 DEBUG(D_deliver) debug_printf("A0 %s tret %d\n", addr->address, *ptr);
3645 addr->transport_return = *ptr++;
3646 addr->special_action = *ptr++;
3647 memcpy(&addr->basic_errno, ptr, sizeof(addr->basic_errno));
3648 ptr += sizeof(addr->basic_errno);
3649 memcpy(&addr->more_errno, ptr, sizeof(addr->more_errno));
3650 ptr += sizeof(addr->more_errno);
3651 memcpy(&addr->delivery_usec, ptr, sizeof(addr->delivery_usec));
3652 ptr += sizeof(addr->delivery_usec);
3653 memcpy(&addr->flags, ptr, sizeof(addr->flags));
3654 ptr += sizeof(addr->flags);
3655 addr->message = *ptr ? string_copy(ptr) : NULL;
3657 addr->user_message = *ptr ? string_copy(ptr) : NULL;
3660 /* Always two strings for host information, followed by the port number and DNSSEC mark */
3664 h = store_get(sizeof(host_item));
3665 h->name = string_copy(ptr);
3667 h->address = string_copy(ptr);
3669 memcpy(&h->port, ptr, sizeof(h->port));
3670 ptr += sizeof(h->port);
3671 h->dnssec = *ptr == '2' ? DS_YES
3672 : *ptr == '1' ? DS_NO
3675 addr->host_used = h;
3679 /* Finished with this address */
3686 /* Local interface address/port */
3688 if (*ptr) sending_ip_address = string_copy(ptr);
3690 if (*ptr) sending_port = atoi(CS ptr);
3694 /* Z marks the logical end of the data. It is followed by '0' if
3695 continue_transport was NULL at the end of transporting, otherwise '1'.
3696 We need to know when it becomes NULL during a delivery down a passed SMTP
3697 channel so that we don't try to pass anything more down it. Of course, for
3698 most normal messages it will remain NULL all the time. */
3703 continue_transport = NULL;
3704 continue_hostname = NULL;
3707 DEBUG(D_deliver) debug_printf("Z0%c item read\n", *ptr);
3710 /* Anything else is a disaster. */
3713 msg = string_sprintf("malformed data (%d) read from pipe for transport "
3714 "process %d for transport %s", ptr[-1], pid,
3715 addr->transport->driver_name);
3721 /* The done flag is inspected externally, to determine whether or not to
3722 call the function again when the process finishes. */
3726 /* If the process hadn't finished, and we haven't seen the end of the data
3727 or if we suffered a disaster, update the rest of the state, and return FALSE to
3728 indicate "not finished". */
3737 /* Close our end of the pipe, to prevent deadlock if the far end is still
3738 pushing stuff into it. */
3743 /* If we have finished without error, but haven't had data for every address,
3744 something is wrong. */
3747 msg = string_sprintf("insufficient address data read from pipe "
3748 "for transport process %d for transport %s", pid,
3749 addr->transport->driver_name);
3751 /* If an error message is set, something has gone wrong in getting back
3752 the delivery data. Put the message into each address and freeze it. */
3755 for (addr = addrlist; addr; addr = addr->next)
3757 addr->transport_return = DEFER;
3758 addr->special_action = SPECIAL_FREEZE;
3759 addr->message = msg;
3760 log_write(0, LOG_MAIN|LOG_PANIC, "Delivery status for %s: %s\n", addr->address, addr->message);
3763 /* Return TRUE to indicate we have got all we need from this process, even
3764 if it hasn't actually finished yet. */
3771 /*************************************************
3772 * Post-process a set of remote addresses *
3773 *************************************************/
3775 /* Do what has to be done immediately after a remote delivery for each set of
3776 addresses, then re-write the spool if necessary. Note that post_process_one
3777 puts the address on an appropriate queue; hence we must fish off the next
3778 one first. This function is also called if there is a problem with setting
3779 up a subprocess to do a remote delivery in parallel. In this case, the final
3780 argument contains a message, and the action must be forced to DEFER.
3783 addr pointer to chain of address items
3784 logflags flags for logging
3785 msg NULL for normal cases; -> error message for unexpected problems
3786 fallback TRUE if processing fallback hosts
3792 remote_post_process(address_item *addr, int logflags, uschar *msg,
3797 /* If any host addresses were found to be unusable, add them to the unusable
3798 tree so that subsequent deliveries don't try them. */
3800 for (h = addr->host_list; h; h = h->next)
3802 if (h->status >= hstatus_unusable) tree_add_unusable(h);
3804 /* Now handle each address on the chain. The transport has placed '=' or '-'
3805 into the special_action field for each successful delivery. */
3809 address_item *next = addr->next;
3811 /* If msg == NULL (normal processing) and the result is DEFER and we are
3812 processing the main hosts and there are fallback hosts available, put the
3813 address on the list for fallback delivery. */
3815 if ( addr->transport_return == DEFER
3816 && addr->fallback_hosts
3821 addr->host_list = addr->fallback_hosts;
3822 addr->next = addr_fallback;
3823 addr_fallback = addr;
3824 DEBUG(D_deliver) debug_printf("%s queued for fallback host(s)\n", addr->address);
3827 /* If msg is set (=> unexpected problem), set it in the address before
3828 doing the ordinary post processing. */
3834 addr->message = msg;
3835 addr->transport_return = DEFER;
3837 (void)post_process_one(addr, addr->transport_return, logflags,
3838 EXIM_DTYPE_TRANSPORT, addr->special_action);
3846 /* If we have just delivered down a passed SMTP channel, and that was
3847 the last address, the channel will have been closed down. Now that
3848 we have logged that delivery, set continue_sequence to 1 so that
3849 any subsequent deliveries don't get "*" incorrectly logged. */
3851 if (!continue_transport) continue_sequence = 1;
3856 /*************************************************
3857 * Wait for one remote delivery subprocess *
3858 *************************************************/
3860 /* This function is called while doing remote deliveries when either the
3861 maximum number of processes exist and we need one to complete so that another
3862 can be created, or when waiting for the last ones to complete. It must wait for
3863 the completion of one subprocess, empty the control block slot, and return a
3864 pointer to the address chain.
3867 Returns: pointer to the chain of addresses handled by the process;
3868 NULL if no subprocess found - this is an unexpected error
3871 static address_item *
3874 int poffset, status;
3875 address_item *addr, *addrlist;
3878 set_process_info("delivering %s: waiting for a remote delivery subprocess "
3879 "to finish", message_id);
3881 /* Loop until either a subprocess completes, or there are no subprocesses in
3882 existence - in which case give an error return. We cannot proceed just by
3883 waiting for a completion, because a subprocess may have filled up its pipe, and
3884 be waiting for it to be emptied. Therefore, if no processes have finished, we
3885 wait for one of the pipes to acquire some data by calling select(), with a
3886 timeout just in case.
3888 The simple approach is just to iterate after reading data from a ready pipe.
3889 This leads to non-ideal behaviour when the subprocess has written its final Z
3890 item, closed the pipe, and is in the process of exiting (the common case). A
3891 call to waitpid() yields nothing completed, but select() shows the pipe ready -
3892 reading it yields EOF, so you end up with busy-waiting until the subprocess has
3895 To avoid this, if all the data that is needed has been read from a subprocess
3896 after select(), an explicit wait() for it is done. We know that all it is doing
3897 is writing to the pipe and then exiting, so the wait should not be long.
3899 The non-blocking waitpid() is to some extent just insurance; if we could
3900 reliably detect end-of-file on the pipe, we could always know when to do a
3901 blocking wait() for a completed process. However, because some systems use
3902 NDELAY, which doesn't distinguish between EOF and pipe empty, it is easier to
3903 use code that functions without the need to recognize EOF.
3905 There's a double loop here just in case we end up with a process that is not in
3906 the list of remote delivery processes. Something has obviously gone wrong if
3907 this is the case. (For example, a process that is incorrectly left over from
3908 routing or local deliveries might be found.) The damage can be minimized by
3909 looping back and looking for another process. If there aren't any, the error
3910 return will happen. */
3912 for (;;) /* Normally we do not repeat this loop */
3914 while ((pid = waitpid(-1, &status, WNOHANG)) <= 0)
3917 fd_set select_pipes;
3918 int maxpipe, readycount;
3920 /* A return value of -1 can mean several things. If errno != ECHILD, it
3921 either means invalid options (which we discount), or that this process was
3922 interrupted by a signal. Just loop to try the waitpid() again.
3924 If errno == ECHILD, waitpid() is telling us that there are no subprocesses
3925 in existence. This should never happen, and is an unexpected error.
3926 However, there is a nasty complication when running under Linux. If "strace
3927 -f" is being used under Linux to trace this process and its children,
3928 subprocesses are "stolen" from their parents and become the children of the
3929 tracing process. A general wait such as the one we've just obeyed returns
3930 as if there are no children while subprocesses are running. Once a
3931 subprocess completes, it is restored to the parent, and waitpid(-1) finds
3932 it. Thanks to Joachim Wieland for finding all this out and suggesting a
3935 This does not happen using "truss" on Solaris, nor (I think) with other
3936 tracing facilities on other OS. It seems to be specific to Linux.
3938 What we do to get round this is to use kill() to see if any of our
3939 subprocesses are still in existence. If kill() gives an OK return, we know
3940 it must be for one of our processes - it can't be for a re-use of the pid,
3941 because if our process had finished, waitpid() would have found it. If any
3942 of our subprocesses are in existence, we proceed to use select() as if
3943 waitpid() had returned zero. I think this is safe. */
3947 if (errno != ECHILD) continue; /* Repeats the waitpid() */
3950 debug_printf("waitpid() returned -1/ECHILD: checking explicitly "
3951 "for process existence\n");
3953 for (poffset = 0; poffset < remote_max_parallel; poffset++)
3955 if ((pid = parlist[poffset].pid) != 0 && kill(pid, 0) == 0)
3957 DEBUG(D_deliver) debug_printf("process %d still exists: assume "
3958 "stolen by strace\n", (int)pid);
3959 break; /* With poffset set */
3963 if (poffset >= remote_max_parallel)
3965 DEBUG(D_deliver) debug_printf("*** no delivery children found\n");
3966 return NULL; /* This is the error return */
3970 /* A pid value greater than 0 breaks the "while" loop. A negative value has
3971 been handled above. A return value of zero means that there is at least one
3972 subprocess, but there are no completed subprocesses. See if any pipes are
3973 ready with any data for reading. */
3975 DEBUG(D_deliver) debug_printf("selecting on subprocess pipes\n");
3978 FD_ZERO(&select_pipes);
3979 for (poffset = 0; poffset < remote_max_parallel; poffset++)
3980 if (parlist[poffset].pid != 0)
3982 int fd = parlist[poffset].fd;
3983 FD_SET(fd, &select_pipes);
3984 if (fd > maxpipe) maxpipe = fd;
3987 /* Stick in a 60-second timeout, just in case. */
3992 readycount = select(maxpipe + 1, (SELECT_ARG2_TYPE *)&select_pipes,
3995 /* Scan through the pipes and read any that are ready; use the count
3996 returned by select() to stop when there are no more. Select() can return
3997 with no processes (e.g. if interrupted). This shouldn't matter.
3999 If par_read_pipe() returns TRUE, it means that either the terminating Z was
4000 read, or there was a disaster. In either case, we are finished with this
4001 process. Do an explicit wait() for the process and break the main loop if
4004 It turns out that we have to deal with the case of an interrupted system
4005 call, which can happen on some operating systems if the signal handling is
4006 set up to do that by default. */
4009 readycount > 0 && poffset < remote_max_parallel;
4012 if ( (pid = parlist[poffset].pid) != 0
4013 && FD_ISSET(parlist[poffset].fd, &select_pipes)
4017 if (par_read_pipe(poffset, FALSE)) /* Finished with this pipe */
4018 for (;;) /* Loop for signals */
4020 pid_t endedpid = waitpid(pid, &status, 0);
4021 if (endedpid == pid) goto PROCESS_DONE;
4022 if (endedpid != (pid_t)(-1) || errno != EINTR)
4023 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Unexpected error return "
4024 "%d (errno = %d) from waitpid() for process %d",
4025 (int)endedpid, errno, (int)pid);
4030 /* Now go back and look for a completed subprocess again. */
4033 /* A completed process was detected by the non-blocking waitpid(). Find the
4034 data block that corresponds to this subprocess. */
4036 for (poffset = 0; poffset < remote_max_parallel; poffset++)
4037 if (pid == parlist[poffset].pid) break;
4039 /* Found the data block; this is a known remote delivery process. We don't
4040 need to repeat the outer loop. This should be what normally happens. */
4042 if (poffset < remote_max_parallel) break;
4044 /* This situation is an error, but it's probably better to carry on looking
4045 for another process than to give up (as we used to do). */
4047 log_write(0, LOG_MAIN|LOG_PANIC, "Process %d finished: not found in remote "
4048 "transport process list", pid);
4049 } /* End of the "for" loop */
4051 /* Come here when all the data was completely read after a select(), and
4052 the process in pid has been wait()ed for. */
4059 debug_printf("remote delivery process %d ended\n", (int)pid);
4061 debug_printf("remote delivery process %d ended: status=%04x\n", (int)pid,
4065 set_process_info("delivering %s", message_id);
4067 /* Get the chain of processed addresses */
4069 addrlist = parlist[poffset].addrlist;
4071 /* If the process did not finish cleanly, record an error and freeze (except
4072 for SIGTERM, SIGKILL and SIGQUIT), and also ensure the journal is not removed,
4073 in case the delivery did actually happen. */
4075 if ((status & 0xffff) != 0)
4078 int msb = (status >> 8) & 255;
4079 int lsb = status & 255;
4080 int code = (msb == 0)? (lsb & 0x7f) : msb;
4082 msg = string_sprintf("%s transport process returned non-zero status 0x%04x: "
4084 addrlist->transport->driver_name,
4086 (msb == 0)? "terminated by signal" : "exit code",
4089 if (msb != 0 || (code != SIGTERM && code != SIGKILL && code != SIGQUIT))
4090 addrlist->special_action = SPECIAL_FREEZE;
4092 for (addr = addrlist; addr; addr = addr->next)
4094 addr->transport_return = DEFER;
4095 addr->message = msg;
4098 remove_journal = FALSE;
4101 /* Else complete reading the pipe to get the result of the delivery, if all
4102 the data has not yet been obtained. */
4104 else if (!parlist[poffset].done) (void)par_read_pipe(poffset, TRUE);
4106 /* Put the data count and return path into globals, mark the data slot unused,
4107 decrement the count of subprocesses, and return the address chain. */
4109 transport_count = parlist[poffset].transport_count;
4110 used_return_path = parlist[poffset].return_path;
4111 parlist[poffset].pid = 0;
4118 /*************************************************
4119 * Wait for subprocesses and post-process *
4120 *************************************************/
4122 /* This function waits for subprocesses until the number that are still running
4123 is below a given threshold. For each complete subprocess, the addresses are
4124 post-processed. If we can't find a running process, there is some shambles.
4125 Better not bomb out, as that might lead to multiple copies of the message. Just
4126 log and proceed as if all done.
4129 max maximum number of subprocesses to leave running
4130 fallback TRUE if processing fallback hosts
4136 par_reduce(int max, BOOL fallback)
4138 while (parcount > max)
4140 address_item *doneaddr = par_wait();
4143 log_write(0, LOG_MAIN|LOG_PANIC,
4144 "remote delivery process count got out of step");
4149 transport_instance * tp = doneaddr->transport;
4150 if (tp->max_parallel)
4151 enq_end(string_sprintf("tpt-serialize-%s", tp->name));
4153 remote_post_process(doneaddr, LOG_MAIN, NULL, fallback);
4159 rmt_dlv_checked_write(int fd, char id, char subid, void * buf, ssize_t size)
4161 uschar pipe_header[PIPE_HEADER_SIZE+1];
4162 size_t total_len = PIPE_HEADER_SIZE + size;
4164 struct iovec iov[2] = {
4165 { pipe_header, PIPE_HEADER_SIZE }, /* indication about the data to expect */
4166 { buf, size } /* *the* data */
4171 /* we assume that size can't get larger then BIG_BUFFER_SIZE which currently is set to 16k */
4172 /* complain to log if someone tries with buffer sizes we can't handle*/
4174 if (size > BIG_BUFFER_SIZE-1)
4176 log_write(0, LOG_MAIN|LOG_PANIC_DIE,
4177 "Failed writing transport result to pipe: can't handle buffers > %d bytes. truncating!\n",
4179 size = BIG_BUFFER_SIZE;
4182 /* Should we check that we do not write more than PIPE_BUF? What would
4185 /* convert size to human readable string prepended by id and subid */
4186 if (PIPE_HEADER_SIZE != snprintf(CS pipe_header, PIPE_HEADER_SIZE+1, "%c%c%05ld",
4187 id, subid, (long)size))
4188 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "header snprintf failed\n");
4190 DEBUG(D_deliver) debug_printf("header write id:%c,subid:%c,size:%ld,final:%s\n",
4191 id, subid, (long)size, pipe_header);
4193 if ((ret = writev(fd, iov, 2)) != total_len)
4194 log_write(0, LOG_MAIN|LOG_PANIC_DIE,
4195 "Failed writing transport result to pipe (%ld of %ld bytes): %s",
4196 (long)ret, (long)total_len, ret == -1 ? strerror(errno) : "short write");
4199 /*************************************************
4200 * Do remote deliveries *
4201 *************************************************/
4203 /* This function is called to process the addresses in addr_remote. We must
4204 pick off the queue all addresses that have the same transport, remote
4205 destination, and errors address, and hand them to the transport in one go,
4206 subject to some configured limitations. If this is a run to continue delivering
4207 to an existing delivery channel, skip all but those addresses that can go to
4208 that channel. The skipped addresses just get deferred.
4210 If mua_wrapper is set, all addresses must be able to be sent in a single
4211 transaction. If not, this function yields FALSE.
4213 In Exim 4, remote deliveries are always done in separate processes, even
4214 if remote_max_parallel = 1 or if there's only one delivery to do. The reason
4215 is so that the base process can retain privilege. This makes the
4216 implementation of fallback transports feasible (though not initially done.)
4218 We create up to the configured number of subprocesses, each of which passes
4219 back the delivery state via a pipe. (However, when sending down an existing
4220 connection, remote_max_parallel is forced to 1.)
4223 fallback TRUE if processing fallback hosts
4225 Returns: TRUE normally
4226 FALSE if mua_wrapper is set and the addresses cannot all be sent
4231 do_remote_deliveries(BOOL fallback)
4237 parcount = 0; /* Number of executing subprocesses */
4239 /* When sending down an existing channel, only do one delivery at a time.
4240 We use a local variable (parmax) to hold the maximum number of processes;
4241 this gets reduced from remote_max_parallel if we can't create enough pipes. */
4243 if (continue_transport) remote_max_parallel = 1;
4244 parmax = remote_max_parallel;
4246 /* If the data for keeping a list of processes hasn't yet been
4251 parlist = store_get(remote_max_parallel * sizeof(pardata));
4252 for (poffset = 0; poffset < remote_max_parallel; poffset++)
4253 parlist[poffset].pid = 0;
4256 /* Now loop for each remote delivery */
4258 for (delivery_count = 0; addr_remote; delivery_count++)
4264 int address_count = 1;
4265 int address_count_max;
4267 BOOL use_initgroups;
4268 BOOL pipe_done = FALSE;
4269 transport_instance *tp;
4270 address_item **anchor = &addr_remote;
4271 address_item *addr = addr_remote;
4272 address_item *last = addr;
4275 uschar * serialize_key = NULL;
4277 /* Pull the first address right off the list. */
4279 addr_remote = addr->next;
4282 DEBUG(D_deliver|D_transport)
4283 debug_printf("--------> %s <--------\n", addr->address);
4285 /* If no transport has been set, there has been a big screw-up somewhere. */
4287 if (!(tp = addr->transport))
4289 f.disable_logging = FALSE; /* Jic */
4290 panicmsg = US"No transport set by router";
4291 goto panic_continue;
4294 /* Check that this base address hasn't previously been delivered to this
4295 transport. The check is necessary at this point to handle homonymic addresses
4296 correctly in cases where the pattern of redirection changes between delivery
4297 attempts. Non-homonymic previous delivery is detected earlier, at routing
4300 if (previously_transported(addr, FALSE)) continue;
4302 /* Force failure if the message is too big. */
4304 if (tp->message_size_limit)
4306 int rc = check_message_size(tp, addr);
4309 addr->transport_return = rc;
4310 remote_post_process(addr, LOG_MAIN, NULL, fallback);
4315 /* Get the flag which specifies whether the transport can handle different
4316 domains that nevertheless resolve to the same set of hosts. If it needs
4317 expanding, get variables set: $address_data, $domain_data, $localpart_data,
4318 $host, $host_address, $host_port. */
4319 if (tp->expand_multi_domain)
4320 deliver_set_expansions(addr);
4322 if (exp_bool(addr, US"transport", tp->name, D_transport,
4323 US"multi_domain", tp->multi_domain, tp->expand_multi_domain,
4324 &multi_domain) != OK)
4326 deliver_set_expansions(NULL);
4327 panicmsg = addr->message;
4328 goto panic_continue;
4331 /* Get the maximum it can handle in one envelope, with zero meaning
4332 unlimited, which is forced for the MUA wrapper case. */
4334 address_count_max = tp->max_addresses;
4335 if (address_count_max == 0 || mua_wrapper) address_count_max = 999999;
4338 /************************************************************************/
4339 /***** This is slightly experimental code, but should be safe. *****/
4341 /* The address_count_max value is the maximum number of addresses that the
4342 transport can send in one envelope. However, the transport must be capable of
4343 dealing with any number of addresses. If the number it gets exceeds its
4344 envelope limitation, it must send multiple copies of the message. This can be
4345 done over a single connection for SMTP, so uses less resources than making
4346 multiple connections. On the other hand, if remote_max_parallel is greater
4347 than one, it is perhaps a good idea to use parallel processing to move the
4348 message faster, even if that results in multiple simultaneous connections to
4351 How can we come to some compromise between these two ideals? What we do is to
4352 limit the number of addresses passed to a single instance of a transport to
4353 the greater of (a) its address limit (rcpt_max for SMTP) and (b) the total
4354 number of addresses routed to remote transports divided by
4355 remote_max_parallel. For example, if the message has 100 remote recipients,
4356 remote max parallel is 2, and rcpt_max is 10, we'd never send more than 50 at
4357 once. But if rcpt_max is 100, we could send up to 100.
4359 Of course, not all the remotely addresses in a message are going to go to the
4360 same set of hosts (except in smarthost configurations), so this is just a
4361 heuristic way of dividing up the work.
4363 Furthermore (1), because this may not be wanted in some cases, and also to
4364 cope with really pathological cases, there is also a limit to the number of
4365 messages that are sent over one connection. This is the same limit that is
4366 used when sending several different messages over the same connection.
4367 Continue_sequence is set when in this situation, to the number sent so
4368 far, including this message.
4370 Furthermore (2), when somebody explicitly sets the maximum value to 1, it
4371 is probably because they are using VERP, in which case they want to pass only
4372 one address at a time to the transport, in order to be able to use
4373 $local_part and $domain in constructing a new return path. We could test for
4374 the use of these variables, but as it is so likely they will be used when the
4375 maximum is 1, we don't bother. Just leave the value alone. */
4377 if ( address_count_max != 1
4378 && address_count_max < remote_delivery_count/remote_max_parallel
4381 int new_max = remote_delivery_count/remote_max_parallel;
4382 int message_max = tp->connection_max_messages;
4383 if (connection_max_messages >= 0) message_max = connection_max_messages;
4384 message_max -= continue_sequence - 1;
4385 if (message_max > 0 && new_max > address_count_max * message_max)
4386 new_max = address_count_max * message_max;
4387 address_count_max = new_max;
4390 /************************************************************************/
4393 /* Pick off all addresses which have the same transport, errors address,
4394 destination, and extra headers. In some cases they point to the same host
4395 list, but we also need to check for identical host lists generated from
4396 entirely different domains. The host list pointers can be NULL in the case
4397 where the hosts are defined in the transport. There is also a configured
4398 maximum limit of addresses that can be handled at once (see comments above
4399 for how it is computed).
4400 If the transport does not handle multiple domains, enforce that also,
4401 and if it might need a per-address check for this, re-evaluate it.
4404 while ((next = *anchor) && address_count < address_count_max)
4407 if ( (multi_domain || Ustrcmp(next->domain, addr->domain) == 0)
4408 && tp == next->transport
4409 && same_hosts(next->host_list, addr->host_list)
4410 && same_strings(next->prop.errors_address, addr->prop.errors_address)
4411 && same_headers(next->prop.extra_headers, addr->prop.extra_headers)
4412 && same_ugid(tp, next, addr)
4413 && ( next->prop.remove_headers == addr->prop.remove_headers
4414 || ( next->prop.remove_headers
4415 && addr->prop.remove_headers
4416 && Ustrcmp(next->prop.remove_headers, addr->prop.remove_headers) == 0
4420 (void)(!tp->expand_multi_domain || ((void)deliver_set_expansions(next), 1)),
4422 US"transport", next->transport->name, D_transport,
4423 US"multi_domain", next->transport->multi_domain,
4424 next->transport->expand_multi_domain, &md) == OK
4429 *anchor = next->next;
4431 next->first = addr; /* remember top one (for retry processing) */
4436 else anchor = &(next->next);
4437 deliver_set_expansions(NULL);
4440 /* If we are acting as an MUA wrapper, all addresses must go in a single
4441 transaction. If not, put them back on the chain and yield FALSE. */
4443 if (mua_wrapper && addr_remote)
4445 last->next = addr_remote;
4450 /* If the transport is limited for parallellism, enforce that here.
4451 The hints DB entry is decremented in par_reduce(), when we reap the
4452 transport process. */
4454 if (tpt_parallel_check(tp, addr, &serialize_key))
4455 if ((panicmsg = expand_string_message))
4456 goto panic_continue;
4458 continue; /* Loop for the next set of addresses. */
4460 /* Set up the expansion variables for this set of addresses */
4462 deliver_set_expansions(addr);
4464 /* Ensure any transport-set auth info is fresh */
4465 addr->authenticator = addr->auth_id = addr->auth_sndr = NULL;
4467 /* Compute the return path, expanding a new one if required. The old one
4468 must be set first, as it might be referred to in the expansion. */
4470 if(addr->prop.errors_address)
4471 return_path = addr->prop.errors_address;
4472 #ifdef EXPERIMENTAL_SRS
4473 else if(addr->prop.srs_sender)
4474 return_path = addr->prop.srs_sender;
4477 return_path = sender_address;
4479 if (tp->return_path)
4481 uschar *new_return_path = expand_string(tp->return_path);
4482 if (new_return_path)
4483 return_path = new_return_path;
4484 else if (!f.expand_string_forcedfail)
4486 panicmsg = string_sprintf("Failed to expand return path \"%s\": %s",
4487 tp->return_path, expand_string_message);
4492 /* Find the uid, gid, and use_initgroups setting for this transport. Failure
4493 logs and sets up error messages, so we just post-process and continue with
4494 the next address. */
4496 if (!findugid(addr, tp, &uid, &gid, &use_initgroups))
4502 /* If this transport has a setup function, call it now so that it gets
4503 run in this process and not in any subprocess. That way, the results of
4504 any setup that are retained by the transport can be reusable. One of the
4505 things the setup does is to set the fallback host lists in the addresses.
4506 That is why it is called at this point, before the continue delivery
4507 processing, because that might use the fallback hosts. */
4510 (void)((tp->setup)(addr->transport, addr, NULL, uid, gid, NULL));
4512 /* If we have a connection still open from a verify stage (lazy-close)
4513 treat it as if it is a continued connection (apart from the counter used
4514 for the log line mark). */
4516 if (cutthrough.cctx.sock >= 0 && cutthrough.callout_hold_only)
4519 debug_printf("lazy-callout-close: have conn still open from verification\n");
4520 continue_transport = cutthrough.transport;
4521 continue_hostname = string_copy(cutthrough.host.name);
4522 continue_host_address = string_copy(cutthrough.host.address);
4523 continue_sequence = 1;
4524 sending_ip_address = cutthrough.snd_ip;
4525 sending_port = cutthrough.snd_port;
4526 smtp_peer_options = cutthrough.peer_options;
4529 /* If this is a run to continue delivery down an already-established
4530 channel, check that this set of addresses matches the transport and
4531 the channel. If it does not, defer the addresses. If a host list exists,
4532 we must check that the continue host is on the list. Otherwise, the
4533 host is set in the transport. */
4535 f.continue_more = FALSE; /* In case got set for the last lot */
4536 if (continue_transport)
4538 BOOL ok = Ustrcmp(continue_transport, tp->name) == 0;
4540 /* If the transport is about to override the host list do not check
4541 it here but take the cost of running the transport process to discover
4542 if the continued_hostname connection is suitable. This is a layering
4543 violation which is unfortunate as it requires we haul in the smtp
4548 smtp_transport_options_block * ob;
4550 if ( !( Ustrcmp(tp->info->driver_name, "smtp") == 0
4551 && (ob = (smtp_transport_options_block *)tp->options_block)
4552 && ob->hosts_override && ob->hosts
4559 for (h = addr->host_list; h; h = h->next)
4560 if (Ustrcmp(h->name, continue_hostname) == 0)
4561 /*XXX should also check port here */
4562 { ok = TRUE; break; }
4566 /* Addresses not suitable; defer or queue for fallback hosts (which
4567 might be the continue host) and skip to next address. */
4571 DEBUG(D_deliver) debug_printf("not suitable for continue_transport (%s)\n",
4572 Ustrcmp(continue_transport, tp->name) != 0
4573 ? string_sprintf("tpt %s vs %s", continue_transport, tp->name)
4574 : string_sprintf("no host matching %s", continue_hostname));
4575 if (serialize_key) enq_end(serialize_key);
4577 if (addr->fallback_hosts && !fallback)
4579 for (next = addr; ; next = next->next)
4581 next->host_list = next->fallback_hosts;
4582 DEBUG(D_deliver) debug_printf("%s queued for fallback host(s)\n", next->address);
4583 if (!next->next) break;
4585 next->next = addr_fallback;
4586 addr_fallback = addr;
4591 for (next = addr; ; next = next->next)
4593 DEBUG(D_deliver) debug_printf(" %s to def list\n", next->address);
4594 if (!next->next) break;
4596 next->next = addr_defer;
4603 /* Set a flag indicating whether there are further addresses that list
4604 the continued host. This tells the transport to leave the channel open,
4605 but not to pass it to another delivery process. We'd like to do that
4606 for non-continue_transport cases too but the knowlege of which host is
4607 connected to is too hard to manage. Perhaps we need a finer-grain
4608 interface to the transport. */
4610 for (next = addr_remote; next && !f.continue_more; next = next->next)
4613 for (h = next->host_list; h; h = h->next)
4614 if (Ustrcmp(h->name, continue_hostname) == 0)
4615 { f.continue_more = TRUE; break; }
4619 /* The transports set up the process info themselves as they may connect
4620 to more than one remote machine. They also have to set up the filter
4621 arguments, if required, so that the host name and address are available
4624 transport_filter_argv = NULL;
4626 /* Create the pipe for inter-process communication. If pipe creation
4627 fails, it is probably because the value of remote_max_parallel is so
4628 large that too many file descriptors for pipes have been created. Arrange
4629 to wait for a process to finish, and then try again. If we still can't
4630 create a pipe when all processes have finished, break the retry loop. */
4634 if (pipe(pfd) == 0) pipe_done = TRUE;
4635 else if (parcount > 0) parmax = parcount;
4638 /* We need to make the reading end of the pipe non-blocking. There are
4639 two different options for this. Exim is cunningly (I hope!) coded so
4640 that it can use either of them, though it prefers O_NONBLOCK, which
4641 distinguishes between EOF and no-more-data. */
4643 /* The data appears in a timely manner and we already did a select on
4644 all pipes, so I do not see a reason to use non-blocking IO here
4647 (void)fcntl(pfd[pipe_read], F_SETFL, O_NONBLOCK);
4649 (void)fcntl(pfd[pipe_read], F_SETFL, O_NDELAY);
4653 /* If the maximum number of subprocesses already exist, wait for a process
4654 to finish. If we ran out of file descriptors, parmax will have been reduced
4655 from its initial value of remote_max_parallel. */
4657 par_reduce(parmax - 1, fallback);
4660 /* If we failed to create a pipe and there were no processes to wait
4661 for, we have to give up on this one. Do this outside the above loop
4662 so that we can continue the main loop. */
4666 panicmsg = string_sprintf("unable to create pipe: %s", strerror(errno));
4670 /* Find a free slot in the pardata list. Must do this after the possible
4671 waiting for processes to finish, because a terminating process will free
4674 for (poffset = 0; poffset < remote_max_parallel; poffset++)
4675 if (parlist[poffset].pid == 0)
4678 /* If there isn't one, there has been a horrible disaster. */
4680 if (poffset >= remote_max_parallel)
4682 (void)close(pfd[pipe_write]);
4683 (void)close(pfd[pipe_read]);
4684 panicmsg = US"Unexpectedly no free subprocess slot";
4688 /* Now fork a subprocess to do the remote delivery, but before doing so,
4689 ensure that any cached resources are released so as not to interfere with
4690 what happens in the subprocess. */
4694 if ((pid = fork()) == 0)
4696 int fd = pfd[pipe_write];
4699 /* Setting this global in the subprocess means we need never clear it */
4700 transport_name = tp->name;
4702 /* There are weird circumstances in which logging is disabled */
4703 f.disable_logging = tp->disable_logging;
4705 /* Show pids on debug output if parallelism possible */
4707 if (parmax > 1 && (parcount > 0 || addr_remote))
4709 DEBUG(D_any|D_v) debug_selector |= D_pid;
4710 DEBUG(D_deliver) debug_printf("Remote delivery process started\n");
4713 /* Reset the random number generator, so different processes don't all
4714 have the same sequence. In the test harness we want different, but
4715 predictable settings for each delivery process, so do something explicit
4716 here rather they rely on the fixed reset in the random number function. */
4718 random_seed = f.running_in_test_harness ? 42 + 2*delivery_count : 0;
4720 /* Set close-on-exec on the pipe so that it doesn't get passed on to
4721 a new process that may be forked to do another delivery down the same
4724 (void)fcntl(fd, F_SETFD, fcntl(fd, F_GETFD) | FD_CLOEXEC);
4726 /* Close open file descriptors for the pipes of other processes
4727 that are running in parallel. */
4729 for (poffset = 0; poffset < remote_max_parallel; poffset++)
4730 if (parlist[poffset].pid != 0) (void)close(parlist[poffset].fd);
4732 /* This process has inherited a copy of the file descriptor
4733 for the data file, but its file pointer is shared with all the
4734 other processes running in parallel. Therefore, we have to re-open
4735 the file in order to get a new file descriptor with its own
4736 file pointer. We don't need to lock it, as the lock is held by
4737 the parent process. There doesn't seem to be any way of doing
4738 a dup-with-new-file-pointer. */
4740 (void)close(deliver_datafile);
4742 uschar * fname = spool_fname(US"input", message_subdir, message_id, US"-D");
4744 if ((deliver_datafile = Uopen(fname,
4748 O_RDWR | O_APPEND, 0)) < 0)
4749 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Failed to reopen %s for remote "
4750 "parallel delivery: %s", fname, strerror(errno));
4753 /* Set the close-on-exec flag */
4755 (void)fcntl(deliver_datafile, F_SETFD, fcntl(deliver_datafile, F_GETFD) |
4759 /* Set the uid/gid of this process; bombs out on failure. */
4761 exim_setugid(uid, gid, use_initgroups,
4762 string_sprintf("remote delivery to %s with transport=%s",
4763 addr->address, tp->name));
4765 /* Close the unwanted half of this process' pipe, set the process state,
4766 and run the transport. Afterwards, transport_count will contain the number
4767 of bytes written. */
4769 (void)close(pfd[pipe_read]);
4770 set_process_info("delivering %s using %s", message_id, tp->name);
4771 debug_print_string(tp->debug_string);
4772 if (!(tp->info->code)(addr->transport, addr)) replicate_status(addr);
4774 set_process_info("delivering %s (just run %s for %s%s in subprocess)",
4775 message_id, tp->name, addr->address, addr->next ? ", ..." : "");
4777 /* Ensure any cached resources that we used are now released */
4781 /* Pass the result back down the pipe. This is a lot more information
4782 than is needed for a local delivery. We have to send back the error
4783 status for each address, the usability status for each host that is
4784 flagged as unusable, and all the retry items. When TLS is in use, we
4785 send also the cipher and peerdn information. Each type of information
4786 is flagged by an identifying byte, and is then in a fixed format (with
4787 strings terminated by zeros), and there is a final terminator at the
4788 end. The host information and retry information is all attached to
4789 the first address, so that gets sent at the start. */
4791 /* Host unusability information: for most success cases this will
4794 for (h = addr->host_list; h; h = h->next)
4796 if (!h->address || h->status < hstatus_unusable) continue;
4797 sprintf(CS big_buffer, "%c%c%s", h->status, h->why, h->address);
4798 rmt_dlv_checked_write(fd, 'H', '0', big_buffer, Ustrlen(big_buffer+2) + 3);
4801 /* The number of bytes written. This is the same for each address. Even
4802 if we sent several copies of the message down the same connection, the
4803 size of each one is the same, and it's that value we have got because
4804 transport_count gets reset before calling transport_write_message(). */
4806 memcpy(big_buffer, &transport_count, sizeof(transport_count));
4807 rmt_dlv_checked_write(fd, 'S', '0', big_buffer, sizeof(transport_count));
4809 /* Information about what happened to each address. Four item types are
4810 used: an optional 'X' item first, for TLS information, then an optional "C"
4811 item for any client-auth info followed by 'R' items for any retry settings,
4812 and finally an 'A' item for the remaining data. */
4814 for(; addr; addr = addr->next)
4819 /* The certificate verification status goes into the flags */
4820 if (tls_out.certificate_verified) setflag(addr, af_cert_verified);
4822 if (tls_out.dane_verified) setflag(addr, af_dane_verified);
4825 /* Use an X item only if there's something to send */
4829 ptr = big_buffer + sprintf(CS big_buffer, "%.128s", addr->cipher) + 1;
4833 ptr += sprintf(CS ptr, "%.512s", addr->peerdn) + 1;
4835 rmt_dlv_checked_write(fd, 'X', '1', big_buffer, ptr - big_buffer);
4837 else if (continue_proxy_cipher)
4839 ptr = big_buffer + sprintf(CS big_buffer, "%.128s", continue_proxy_cipher) + 1;
4841 rmt_dlv_checked_write(fd, 'X', '1', big_buffer, ptr - big_buffer);
4847 if (!tls_export_cert(ptr, big_buffer_size-2, addr->peercert))
4851 rmt_dlv_checked_write(fd, 'X', '2', big_buffer, ptr - big_buffer);
4856 if (!tls_export_cert(ptr, big_buffer_size-2, addr->ourcert))
4860 rmt_dlv_checked_write(fd, 'X', '3', big_buffer, ptr - big_buffer);
4862 # ifndef DISABLE_OCSP
4863 if (addr->ocsp > OCSP_NOT_REQ)
4865 ptr = big_buffer + sprintf(CS big_buffer, "%c", addr->ocsp + '0') + 1;
4866 rmt_dlv_checked_write(fd, 'X', '4', big_buffer, ptr - big_buffer);
4869 #endif /*SUPPORT_TLS*/
4871 if (client_authenticator)
4873 ptr = big_buffer + sprintf(CS big_buffer, "%.64s", client_authenticator) + 1;
4874 rmt_dlv_checked_write(fd, 'C', '1', big_buffer, ptr - big_buffer);
4876 if (client_authenticated_id)
4878 ptr = big_buffer + sprintf(CS big_buffer, "%.64s", client_authenticated_id) + 1;
4879 rmt_dlv_checked_write(fd, 'C', '2', big_buffer, ptr - big_buffer);
4881 if (client_authenticated_sender)
4883 ptr = big_buffer + sprintf(CS big_buffer, "%.64s", client_authenticated_sender) + 1;
4884 rmt_dlv_checked_write(fd, 'C', '3', big_buffer, ptr - big_buffer);
4887 #ifndef DISABLE_PRDR
4888 if (testflag(addr, af_prdr_used))
4889 rmt_dlv_checked_write(fd, 'P', '0', NULL, 0);
4892 if (testflag(addr, af_pipelining))
4893 #ifdef EXPERIMENTAL_PIPE_CONNECT
4894 if (testflag(addr, af_early_pipe))
4895 rmt_dlv_checked_write(fd, 'L', '2', NULL, 0);
4898 rmt_dlv_checked_write(fd, 'L', '1', NULL, 0);
4900 if (testflag(addr, af_chunking_used))
4901 rmt_dlv_checked_write(fd, 'K', '0', NULL, 0);
4903 if (testflag(addr, af_tcp_fastopen_conn))
4904 rmt_dlv_checked_write(fd, 'T',
4905 testflag(addr, af_tcp_fastopen) ? testflag(addr, af_tcp_fastopen_data)
4909 memcpy(big_buffer, &addr->dsn_aware, sizeof(addr->dsn_aware));
4910 rmt_dlv_checked_write(fd, 'D', '0', big_buffer, sizeof(addr->dsn_aware));
4912 /* Retry information: for most success cases this will be null. */
4914 for (r = addr->retries; r; r = r->next)
4916 sprintf(CS big_buffer, "%c%.500s", r->flags, r->key);
4917 ptr = big_buffer + Ustrlen(big_buffer+2) + 3;
4918 memcpy(ptr, &r->basic_errno, sizeof(r->basic_errno));
4919 ptr += sizeof(r->basic_errno);
4920 memcpy(ptr, &r->more_errno, sizeof(r->more_errno));
4921 ptr += sizeof(r->more_errno);
4922 if (!r->message) *ptr++ = 0; else
4924 sprintf(CS ptr, "%.512s", r->message);
4927 rmt_dlv_checked_write(fd, 'R', '0', big_buffer, ptr - big_buffer);
4930 #ifdef SUPPORT_SOCKS
4931 if (LOGGING(proxy) && proxy_session)
4934 if (proxy_local_address)
4936 DEBUG(D_deliver) debug_printf("proxy_local_address '%s'\n", proxy_local_address);
4937 ptr = big_buffer + sprintf(CS ptr, "%.128s", proxy_local_address) + 1;
4938 DEBUG(D_deliver) debug_printf("proxy_local_port %d\n", proxy_local_port);
4939 memcpy(ptr, &proxy_local_port, sizeof(proxy_local_port));
4940 ptr += sizeof(proxy_local_port);
4944 rmt_dlv_checked_write(fd, 'A', '2', big_buffer, ptr - big_buffer);
4948 #ifdef EXPERIMENTAL_DSN_INFO
4949 /*um, are they really per-addr? Other per-conn stuff is not (auth, tls). But host_used is! */
4950 if (addr->smtp_greeting)
4952 DEBUG(D_deliver) debug_printf("smtp_greeting '%s'\n", addr->smtp_greeting);
4953 ptr = big_buffer + sprintf(CS big_buffer, "%.128s", addr->smtp_greeting) + 1;
4954 if (addr->helo_response)
4956 DEBUG(D_deliver) debug_printf("helo_response '%s'\n", addr->helo_response);
4957 ptr += sprintf(CS ptr, "%.128s", addr->helo_response) + 1;
4961 rmt_dlv_checked_write(fd, 'A', '1', big_buffer, ptr - big_buffer);
4965 /* The rest of the information goes in an 'A0' item. */
4967 sprintf(CS big_buffer, "%c%c", addr->transport_return, addr->special_action);
4968 ptr = big_buffer + 2;
4969 memcpy(ptr, &addr->basic_errno, sizeof(addr->basic_errno));
4970 ptr += sizeof(addr->basic_errno);
4971 memcpy(ptr, &addr->more_errno, sizeof(addr->more_errno));
4972 ptr += sizeof(addr->more_errno);
4973 memcpy(ptr, &addr->delivery_usec, sizeof(addr->delivery_usec));
4974 ptr += sizeof(addr->delivery_usec);
4975 memcpy(ptr, &addr->flags, sizeof(addr->flags));
4976 ptr += sizeof(addr->flags);
4978 if (!addr->message) *ptr++ = 0; else
4979 ptr += sprintf(CS ptr, "%.1024s", addr->message) + 1;
4981 if (!addr->user_message) *ptr++ = 0; else
4982 ptr += sprintf(CS ptr, "%.1024s", addr->user_message) + 1;
4984 if (!addr->host_used) *ptr++ = 0; else
4986 ptr += sprintf(CS ptr, "%.256s", addr->host_used->name) + 1;
4987 ptr += sprintf(CS ptr, "%.64s", addr->host_used->address) + 1;
4988 memcpy(ptr, &addr->host_used->port, sizeof(addr->host_used->port));
4989 ptr += sizeof(addr->host_used->port);
4991 /* DNS lookup status */
4992 *ptr++ = addr->host_used->dnssec==DS_YES ? '2'
4993 : addr->host_used->dnssec==DS_NO ? '1' : '0';
4996 rmt_dlv_checked_write(fd, 'A', '0', big_buffer, ptr - big_buffer);
4999 /* Local interface address/port */
5000 #ifdef EXPERIMENTAL_DSN_INFO
5001 if (sending_ip_address)
5003 if (LOGGING(incoming_interface) && sending_ip_address)
5007 ptr = big_buffer + sprintf(CS big_buffer, "%.128s", sending_ip_address) + 1;
5008 ptr += sprintf(CS ptr, "%d", sending_port) + 1;
5009 rmt_dlv_checked_write(fd, 'I', '0', big_buffer, ptr - big_buffer);
5012 /* Add termination flag, close the pipe, and that's it. The character
5013 after 'Z' indicates whether continue_transport is now NULL or not.
5014 A change from non-NULL to NULL indicates a problem with a continuing
5017 big_buffer[0] = continue_transport ? '1' : '0';
5018 rmt_dlv_checked_write(fd, 'Z', '0', big_buffer, 1);
5023 /* Back in the mainline: close the unwanted half of the pipe. */
5025 (void)close(pfd[pipe_write]);
5027 /* If we have a connection still open from a verify stage (lazy-close)
5028 release its TLS library context (if any) as responsibility was passed to
5029 the delivery child process. */
5031 if (cutthrough.cctx.sock >= 0 && cutthrough.callout_hold_only)
5034 if (cutthrough.is_tls)
5035 tls_close(cutthrough.cctx.tls_ctx, TLS_NO_SHUTDOWN);
5037 (void) close(cutthrough.cctx.sock);
5038 release_cutthrough_connection(US"passed to transport proc");
5041 /* Fork failed; defer with error message */
5045 (void)close(pfd[pipe_read]);
5046 panicmsg = string_sprintf("fork failed for remote delivery to %s: %s",
5047 addr->domain, strerror(errno));
5051 /* Fork succeeded; increment the count, and remember relevant data for
5052 when the process finishes. */
5055 parlist[poffset].addrlist = parlist[poffset].addr = addr;
5056 parlist[poffset].pid = pid;
5057 parlist[poffset].fd = pfd[pipe_read];
5058 parlist[poffset].done = FALSE;
5059 parlist[poffset].msg = NULL;
5060 parlist[poffset].return_path = return_path;
5062 /* If the process we've just started is sending a message down an existing
5063 channel, wait for it now. This ensures that only one such process runs at
5064 once, whatever the value of remote_max parallel. Otherwise, we might try to
5065 send two or more messages simultaneously down the same channel. This could
5066 happen if there are different domains that include the same host in otherwise
5067 different host lists.
5069 Also, if the transport closes down the channel, this information gets back
5070 (continue_transport gets set to NULL) before we consider any other addresses
5073 if (continue_transport) par_reduce(0, fallback);
5075 /* Otherwise, if we are running in the test harness, wait a bit, to let the
5076 newly created process get going before we create another process. This should
5077 ensure repeatability in the tests. We only need to wait a tad. */
5079 else if (f.running_in_test_harness) millisleep(500);
5084 if (serialize_key) enq_end(serialize_key);
5086 remote_post_process(addr, LOG_MAIN|LOG_PANIC, panicmsg, fallback);
5090 /* Reached the end of the list of addresses. Wait for all the subprocesses that
5091 are still running and post-process their addresses. */
5093 par_reduce(0, fallback);
5100 /*************************************************
5101 * Split an address into local part and domain *
5102 *************************************************/
5104 /* This function initializes an address for routing by splitting it up into a
5105 local part and a domain. The local part is set up twice - once in its original
5106 casing, and once in lower case, and it is dequoted. We also do the "percent
5107 hack" for configured domains. This may lead to a DEFER result if a lookup
5108 defers. When a percent-hacking takes place, we insert a copy of the original
5109 address as a new parent of this address, as if we have had a redirection.
5112 addr points to an addr_item block containing the address
5115 DEFER - could not determine if domain is %-hackable
5119 deliver_split_address(address_item * addr)
5121 uschar * address = addr->address;
5126 if (!(domain = Ustrrchr(address, '@')))
5127 return DEFER; /* should always have a domain, but just in case... */
5129 len = domain - address;
5130 addr->domain = string_copylc(domain+1); /* Domains are always caseless */
5132 /* The implication in the RFCs (though I can't say I've seen it spelled out
5133 explicitly) is that quoting should be removed from local parts at the point
5134 where they are locally interpreted. [The new draft "821" is more explicit on
5135 this, Jan 1999.] We know the syntax is valid, so this can be done by simply
5136 removing quoting backslashes and any unquoted doublequotes. */
5138 t = addr->cc_local_part = store_get(len+1);
5142 if (c == '\"') continue;
5152 /* We do the percent hack only for those domains that are listed in
5153 percent_hack_domains. A loop is required, to copy with multiple %-hacks. */
5155 if (percent_hack_domains)
5158 uschar *new_address = NULL;
5159 uschar *local_part = addr->cc_local_part;
5161 deliver_domain = addr->domain; /* set $domain */
5163 while ( (rc = match_isinlist(deliver_domain, (const uschar **)&percent_hack_domains, 0,
5164 &domainlist_anchor, addr->domain_cache, MCL_DOMAIN, TRUE, NULL))
5166 && (t = Ustrrchr(local_part, '%')) != NULL
5169 new_address = string_copy(local_part);
5170 new_address[t - local_part] = '@';
5171 deliver_domain = string_copylc(t+1);
5172 local_part = string_copyn(local_part, t - local_part);
5175 if (rc == DEFER) return DEFER; /* lookup deferred */
5177 /* If hackery happened, set up new parent and alter the current address. */
5181 address_item *new_parent = store_get(sizeof(address_item));
5182 *new_parent = *addr;
5183 addr->parent = new_parent;
5184 new_parent->child_count = 1;
5185 addr->address = new_address;
5186 addr->unique = string_copy(new_address);
5187 addr->domain = deliver_domain;
5188 addr->cc_local_part = local_part;
5189 DEBUG(D_deliver) debug_printf("%%-hack changed address to: %s\n",
5194 /* Create the lowercased version of the final local part, and make that the
5195 default one to be used. */
5197 addr->local_part = addr->lc_local_part = string_copylc(addr->cc_local_part);
5204 /*************************************************
5205 * Get next error message text *
5206 *************************************************/
5208 /* If f is not NULL, read the next "paragraph", from a customized error message
5209 text file, terminated by a line containing ****, and expand it.
5212 f NULL or a file to read from
5213 which string indicating which string (for errors)
5215 Returns: NULL or an expanded string
5219 next_emf(FILE *f, uschar *which)
5225 if (!f) return NULL;
5227 if (!Ufgets(buffer, sizeof(buffer), f) || Ustrcmp(buffer, "****\n") == 0)
5230 para = string_get(256);
5233 para = string_cat(para, buffer);
5234 if (!Ufgets(buffer, sizeof(buffer), f) || Ustrcmp(buffer, "****\n") == 0)
5237 if ((yield = expand_string(string_from_gstring(para))))
5240 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand string from "
5241 "bounce_message_file or warn_message_file (%s): %s", which,
5242 expand_string_message);
5249 /*************************************************
5250 * Close down a passed transport channel *
5251 *************************************************/
5253 /* This function is called when a passed transport channel cannot be used.
5254 It attempts to close it down tidily. The yield is always DELIVER_NOT_ATTEMPTED
5255 so that the function call can be the argument of a "return" statement.
5258 Returns: DELIVER_NOT_ATTEMPTED
5262 continue_closedown(void)
5264 if (continue_transport)
5266 transport_instance *t;
5267 for (t = transports; t; t = t->next)
5268 if (Ustrcmp(t->name, continue_transport) == 0)
5270 if (t->info->closedown) (t->info->closedown)(t);
5274 return DELIVER_NOT_ATTEMPTED;
5280 /*************************************************
5281 * Print address information *
5282 *************************************************/
5284 /* This function is called to output an address, or information about an
5285 address, for bounce or defer messages. If the hide_child flag is set, all we
5286 output is the original ancestor address.
5289 addr points to the address
5290 f the FILE to print to
5291 si an initial string
5292 sc a continuation string for before "generated"
5295 Returns: TRUE if the address is not hidden
5299 print_address_information(address_item *addr, FILE *f, uschar *si, uschar *sc,
5303 uschar *printed = US"";
5304 address_item *ancestor = addr;
5305 while (ancestor->parent) ancestor = ancestor->parent;
5307 fprintf(f, "%s", CS si);
5309 if (addr->parent && testflag(addr, af_hide_child))
5311 printed = US"an undisclosed address";
5314 else if (!testflag(addr, af_pfr) || !addr->parent)
5315 printed = addr->address;
5319 uschar *s = addr->address;
5322 if (addr->address[0] == '>') { ss = US"mail"; s++; }
5323 else if (addr->address[0] == '|') ss = US"pipe";
5326 fprintf(f, "%s to %s%sgenerated by ", ss, s, sc);
5327 printed = addr->parent->address;
5330 fprintf(f, "%s", CS string_printing(printed));
5332 if (ancestor != addr)
5334 uschar *original = ancestor->onetime_parent;
5335 if (!original) original= ancestor->address;
5336 if (strcmpic(original, printed) != 0)
5337 fprintf(f, "%s(%sgenerated from %s)", sc,
5338 ancestor != addr->parent ? "ultimately " : "",
5339 string_printing(original));
5342 if (addr->host_used)
5343 fprintf(f, "\n host %s [%s]",
5344 addr->host_used->name, addr->host_used->address);
5346 fprintf(f, "%s", CS se);
5354 /*************************************************
5355 * Print error for an address *
5356 *************************************************/
5358 /* This function is called to print the error information out of an address for
5359 a bounce or a warning message. It tries to format the message reasonably by
5360 introducing newlines. All lines are indented by 4; the initial printing
5361 position must be set before calling.
5363 This function used always to print the error. Nowadays we want to restrict it
5364 to cases such as LMTP/SMTP errors from a remote host, and errors from :fail:
5365 and filter "fail". We no longer pass other information willy-nilly in bounce
5366 and warning messages. Text in user_message is always output; text in message
5367 only if the af_pass_message flag is set.
5371 f the FILE to print on
5378 print_address_error(address_item *addr, FILE *f, uschar *t)
5380 int count = Ustrlen(t);
5381 uschar *s = testflag(addr, af_pass_message) ? addr->message : NULL;
5383 if (!s && !(s = addr->user_message))
5386 fprintf(f, "\n %s", t);
5389 if (*s == '\\' && s[1] == 'n')
5399 if (*s++ == ':' && isspace(*s) && count > 45)
5401 fprintf(f, "\n "); /* sic (because space follows) */
5408 /***********************************************************
5409 * Print Diagnostic-Code for an address *
5410 ************************************************************/
5412 /* This function is called to print the error information out of an address for
5413 a bounce or a warning message. It tries to format the message reasonably as
5414 required by RFC 3461 by adding a space after each newline
5416 it uses the same logic as print_address_error() above. if af_pass_message is true
5417 and addr->message is set it uses the remote host answer. if not addr->user_message
5418 is used instead if available.
5422 f the FILE to print on
5428 print_dsn_diagnostic_code(const address_item *addr, FILE *f)
5430 uschar *s = testflag(addr, af_pass_message) ? addr->message : NULL;
5432 /* af_pass_message and addr->message set ? print remote host answer */
5436 debug_printf("DSN Diagnostic-Code: addr->message = %s\n", addr->message);
5438 /* search first ": ". we assume to find the remote-MTA answer there */
5439 if (!(s = Ustrstr(addr->message, ": ")))
5440 return; /* not found, bail out */
5441 s += 2; /* skip ": " */
5442 fprintf(f, "Diagnostic-Code: smtp; ");
5444 /* no message available. do nothing */
5448 if (*s == '\\' && s[1] == 'n')
5450 fputs("\n ", f); /* as defined in RFC 3461 */
5460 /*************************************************
5461 * Check list of addresses for duplication *
5462 *************************************************/
5464 /* This function was introduced when the test for duplicate addresses that are
5465 not pipes, files, or autoreplies was moved from the middle of routing to when
5466 routing was complete. That was to fix obscure cases when the routing history
5467 affects the subsequent routing of identical addresses. This function is called
5468 after routing, to check that the final routed addresses are not duplicates.
5470 If we detect a duplicate, we remember what it is a duplicate of. Note that
5471 pipe, file, and autoreply de-duplication is handled during routing, so we must
5472 leave such "addresses" alone here, as otherwise they will incorrectly be
5475 Argument: address of list anchor
5480 do_duplicate_check(address_item **anchor)
5483 while ((addr = *anchor))
5486 if (testflag(addr, af_pfr))
5488 anchor = &(addr->next);
5490 else if ((tnode = tree_search(tree_duplicates, addr->unique)))
5492 DEBUG(D_deliver|D_route)
5493 debug_printf("%s is a duplicate address: discarded\n", addr->unique);
5494 *anchor = addr->next;
5495 addr->dupof = tnode->data.ptr;
5496 addr->next = addr_duplicate;
5497 addr_duplicate = addr;
5501 tree_add_duplicate(addr->unique, addr);
5502 anchor = &(addr->next);
5510 /*************************************************
5511 * Deliver one message *
5512 *************************************************/
5514 /* This is the function which is called when a message is to be delivered. It
5515 is passed the id of the message. It is possible that the message no longer
5516 exists, if some other process has delivered it, and it is also possible that
5517 the message is being worked on by another process, in which case the data file
5520 If no delivery is attempted for any of the above reasons, the function returns
5521 DELIVER_NOT_ATTEMPTED.
5523 If the give_up flag is set true, do not attempt any deliveries, but instead
5524 fail all outstanding addresses and return the message to the sender (or
5527 A delivery operation has a process all to itself; we never deliver more than
5528 one message in the same process. Therefore we needn't worry too much about
5531 Liable to be called as root.
5534 id the id of the message to be delivered
5535 forced TRUE if delivery was forced by an administrator; this overrides
5536 retry delays and causes a delivery to be tried regardless
5537 give_up TRUE if an administrator has requested that delivery attempts
5540 Returns: When the global variable mua_wrapper is FALSE:
5541 DELIVER_ATTEMPTED_NORMAL if a delivery attempt was made
5542 DELIVER_NOT_ATTEMPTED otherwise (see comment above)
5543 When the global variable mua_wrapper is TRUE:
5544 DELIVER_MUA_SUCCEEDED if delivery succeeded
5545 DELIVER_MUA_FAILED if delivery failed
5546 DELIVER_NOT_ATTEMPTED if not attempted (should not occur)
5550 deliver_message(uschar *id, BOOL forced, BOOL give_up)
5553 int final_yield = DELIVER_ATTEMPTED_NORMAL;
5554 time_t now = time(NULL);
5555 address_item *addr_last = NULL;
5556 uschar *filter_message = NULL;
5557 int process_recipients = RECIP_ACCEPT;
5560 extern int acl_where;
5562 uschar *info = queue_run_pid == (pid_t)0
5563 ? string_sprintf("delivering %s", id)
5564 : string_sprintf("delivering %s (queue run pid %d)", id, queue_run_pid);
5566 /* If the D_process_info bit is on, set_process_info() will output debugging
5567 information. If not, we want to show this initial information if D_deliver or
5568 D_queue_run is set or in verbose mode. */
5570 set_process_info("%s", info);
5572 if ( !(debug_selector & D_process_info)
5573 && (debug_selector & (D_deliver|D_queue_run|D_v))
5575 debug_printf("%s\n", info);
5577 /* Ensure that we catch any subprocesses that are created. Although Exim
5578 sets SIG_DFL as its initial default, some routes through the code end up
5579 here with it set to SIG_IGN - cases where a non-synchronous delivery process
5580 has been forked, but no re-exec has been done. We use sigaction rather than
5581 plain signal() on those OS where SA_NOCLDWAIT exists, because we want to be
5582 sure it is turned off. (There was a problem on AIX with this.) */
5586 struct sigaction act;
5587 act.sa_handler = SIG_DFL;
5588 sigemptyset(&(act.sa_mask));
5590 sigaction(SIGCHLD, &act, NULL);
5593 signal(SIGCHLD, SIG_DFL);
5596 /* Make the forcing flag available for routers and transports, set up the
5597 global message id field, and initialize the count for returned files and the
5598 message size. This use of strcpy() is OK because the length id is checked when
5599 it is obtained from a command line (the -M or -q options), and otherwise it is
5600 known to be a valid message id. */
5602 if (id != message_id)
5603 Ustrcpy(message_id, id);
5604 f.deliver_force = forced;
5608 /* Initialize some flags */
5610 update_spool = FALSE;
5611 remove_journal = TRUE;
5613 /* Set a known context for any ACLs we call via expansions */
5614 acl_where = ACL_WHERE_DELIVERY;
5616 /* Reset the random number generator, so that if several delivery processes are
5617 started from a queue runner that has already used random numbers (for sorting),
5618 they don't all get the same sequence. */
5622 /* Open and lock the message's data file. Exim locks on this one because the
5623 header file may get replaced as it is re-written during the delivery process.
5624 Any failures cause messages to be written to the log, except for missing files
5625 while queue running - another process probably completed delivery. As part of
5626 opening the data file, message_subdir gets set. */
5628 if ((deliver_datafile = spool_open_datafile(id)) < 0)
5629 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5631 /* The value of message_size at this point has been set to the data length,
5632 plus one for the blank line that notionally precedes the data. */
5634 /* Now read the contents of the header file, which will set up the headers in
5635 store, and also the list of recipients and the tree of non-recipients and
5636 assorted flags. It updates message_size. If there is a reading or format error,
5637 give up; if the message has been around for sufficiently long, remove it. */
5640 uschar * spoolname = string_sprintf("%s-H", id);
5641 if ((rc = spool_read_header(spoolname, TRUE, TRUE)) != spool_read_OK)
5643 if (errno == ERRNO_SPOOLFORMAT)
5645 struct stat statbuf;
5646 if (Ustat(spool_fname(US"input", message_subdir, spoolname, US""),
5648 log_write(0, LOG_MAIN, "Format error in spool file %s: "
5649 "size=" OFF_T_FMT, spoolname, statbuf.st_size);
5651 log_write(0, LOG_MAIN, "Format error in spool file %s", spoolname);
5654 log_write(0, LOG_MAIN, "Error reading spool file %s: %s", spoolname,
5657 /* If we managed to read the envelope data, received_time contains the
5658 time the message was received. Otherwise, we can calculate it from the
5661 if (rc != spool_read_hdrerror)
5663 received_time.tv_sec = received_time.tv_usec = 0;
5664 /*XXX subsec precision?*/
5665 for (i = 0; i < 6; i++)
5666 received_time.tv_sec = received_time.tv_sec * BASE_62 + tab62[id[i] - '0'];
5669 /* If we've had this malformed message too long, sling it. */
5671 if (now - received_time.tv_sec > keep_malformed)
5673 Uunlink(spool_fname(US"msglog", message_subdir, id, US""));
5674 Uunlink(spool_fname(US"input", message_subdir, id, US"-D"));
5675 Uunlink(spool_fname(US"input", message_subdir, id, US"-H"));
5676 Uunlink(spool_fname(US"input", message_subdir, id, US"-J"));
5677 log_write(0, LOG_MAIN, "Message removed because older than %s",
5678 readconf_printtime(keep_malformed));
5681 (void)close(deliver_datafile);
5682 deliver_datafile = -1;
5683 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5687 /* The spool header file has been read. Look to see if there is an existing
5688 journal file for this message. If there is, it means that a previous delivery
5689 attempt crashed (program or host) before it could update the spool header file.
5690 Read the list of delivered addresses from the journal and add them to the
5691 nonrecipients tree. Then update the spool file. We can leave the journal in
5692 existence, as it will get further successful deliveries added to it in this
5693 run, and it will be deleted if this function gets to its end successfully.
5694 Otherwise it might be needed again. */
5697 uschar * fname = spool_fname(US"input", message_subdir, id, US"-J");
5700 if ( (journal_fd = Uopen(fname, O_RDWR|O_APPEND
5708 && lseek(journal_fd, 0, SEEK_SET) == 0
5709 && (jread = fdopen(journal_fd, "rb"))
5712 while (Ufgets(big_buffer, big_buffer_size, jread))
5714 int n = Ustrlen(big_buffer);
5715 big_buffer[n-1] = 0;
5716 tree_add_nonrecipient(big_buffer);
5717 DEBUG(D_deliver) debug_printf("Previously delivered address %s taken from "
5718 "journal file\n", big_buffer);
5721 if ((journal_fd = dup(fileno(jread))) < 0)
5722 journal_fd = fileno(jread);
5724 (void) fclose(jread); /* Try to not leak the FILE resource */
5726 /* Panic-dies on error */
5727 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
5729 else if (errno != ENOENT)
5731 log_write(0, LOG_MAIN|LOG_PANIC, "attempt to open journal for reading gave: "
5732 "%s", strerror(errno));
5733 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5736 /* A null recipients list indicates some kind of disaster. */
5738 if (!recipients_list)
5740 (void)close(deliver_datafile);
5741 deliver_datafile = -1;
5742 log_write(0, LOG_MAIN, "Spool error: no recipients for %s", fname);
5743 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5748 /* Handle a message that is frozen. There are a number of different things that
5749 can happen, but in the default situation, unless forced, no delivery is
5752 if (f.deliver_freeze)
5754 #ifdef SUPPORT_MOVE_FROZEN_MESSAGES
5755 /* Moving to another directory removes the message from Exim's view. Other
5756 tools must be used to deal with it. Logging of this action happens in
5757 spool_move_message() and its subfunctions. */
5759 if ( move_frozen_messages
5760 && spool_move_message(id, message_subdir, US"", US"F")
5762 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5765 /* For all frozen messages (bounces or not), timeout_frozen_after sets the
5766 maximum time to keep messages that are frozen. Thaw if we reach it, with a
5767 flag causing all recipients to be failed. The time is the age of the
5768 message, not the time since freezing. */
5770 if (timeout_frozen_after > 0 && message_age >= timeout_frozen_after)
5772 log_write(0, LOG_MAIN, "cancelled by timeout_frozen_after");
5773 process_recipients = RECIP_FAIL_TIMEOUT;
5776 /* For bounce messages (and others with no sender), thaw if the error message
5777 ignore timer is exceeded. The message will be discarded if this delivery
5780 else if (!*sender_address && message_age >= ignore_bounce_errors_after)
5781 log_write(0, LOG_MAIN, "Unfrozen by errmsg timer");
5783 /* If this is a bounce message, or there's no auto thaw, or we haven't
5784 reached the auto thaw time yet, and this delivery is not forced by an admin
5785 user, do not attempt delivery of this message. Note that forced is set for
5786 continuing messages down the same channel, in order to skip load checking and
5787 ignore hold domains, but we don't want unfreezing in that case. */
5791 if ( ( sender_address[0] == 0
5793 || now <= deliver_frozen_at + auto_thaw
5795 && ( !forced || !f.deliver_force_thaw
5796 || !f.admin_user || continue_hostname
5799 (void)close(deliver_datafile);
5800 deliver_datafile = -1;
5801 log_write(L_skip_delivery, LOG_MAIN, "Message is frozen");
5802 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5805 /* If delivery was forced (by an admin user), assume a manual thaw.
5806 Otherwise it's an auto thaw. */
5810 f.deliver_manual_thaw = TRUE;
5811 log_write(0, LOG_MAIN, "Unfrozen by forced delivery");
5813 else log_write(0, LOG_MAIN, "Unfrozen by auto-thaw");
5816 /* We get here if any of the rules for unfreezing have triggered. */
5818 f.deliver_freeze = FALSE;
5819 update_spool = TRUE;
5823 /* Open the message log file if we are using them. This records details of
5824 deliveries, deferments, and failures for the benefit of the mail administrator.
5825 The log is not used by exim itself to track the progress of a message; that is
5826 done by rewriting the header spool file. */
5830 uschar * fname = spool_fname(US"msglog", message_subdir, id, US"");
5834 if ((fd = open_msglog_file(fname, SPOOL_MODE, &error)) < 0)
5836 log_write(0, LOG_MAIN|LOG_PANIC, "Couldn't %s message log %s: %s", error,
5837 fname, strerror(errno));
5838 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5841 /* Make a C stream out of it. */
5843 if (!(message_log = fdopen(fd, "a")))
5845 log_write(0, LOG_MAIN|LOG_PANIC, "Couldn't fdopen message log %s: %s",
5846 fname, strerror(errno));
5847 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5852 /* If asked to give up on a message, log who did it, and set the action for all
5857 struct passwd *pw = getpwuid(real_uid);
5858 log_write(0, LOG_MAIN, "cancelled by %s",
5859 pw ? US pw->pw_name : string_sprintf("uid %ld", (long int)real_uid));
5860 process_recipients = RECIP_FAIL;
5863 /* Otherwise, if there are too many Received: headers, fail all recipients. */
5865 else if (received_count > received_headers_max)
5866 process_recipients = RECIP_FAIL_LOOP;
5868 /* Otherwise, if a system-wide, address-independent message filter is
5869 specified, run it now, except in the case when we are failing all recipients as
5870 a result of timeout_frozen_after. If the system filter yields "delivered", then
5871 ignore the true recipients of the message. Failure of the filter file is
5872 logged, and the delivery attempt fails. */
5874 else if (system_filter && process_recipients != RECIP_FAIL_TIMEOUT)
5879 redirect_block redirect;
5881 if (system_filter_uid_set)
5883 ugid.uid = system_filter_uid;
5884 ugid.gid = system_filter_gid;
5885 ugid.uid_set = ugid.gid_set = TRUE;
5888 ugid.uid_set = ugid.gid_set = FALSE;
5890 return_path = sender_address;
5891 f.enable_dollar_recipients = TRUE; /* Permit $recipients in system filter */
5892 f.system_filtering = TRUE;
5894 /* Any error in the filter file causes a delivery to be abandoned. */
5896 redirect.string = system_filter;
5897 redirect.isfile = TRUE;
5898 redirect.check_owner = redirect.check_group = FALSE;
5899 redirect.owners = NULL;
5900 redirect.owngroups = NULL;
5902 redirect.modemask = 0;
5904 DEBUG(D_deliver|D_filter) debug_printf("running system filter\n");
5907 &redirect, /* Where the data is */
5908 RDO_DEFER | /* Turn on all the enabling options */
5909 RDO_FAIL | /* Leave off all the disabling options */
5914 NULL, /* No :include: restriction (not used in filter) */
5915 NULL, /* No sieve vacation directory (not sieve!) */
5916 NULL, /* No sieve enotify mailto owner (not sieve!) */
5917 NULL, /* No sieve user address (not sieve!) */
5918 NULL, /* No sieve subaddress (not sieve!) */
5919 &ugid, /* uid/gid data */
5920 &addr_new, /* Where to hang generated addresses */
5921 &filter_message, /* Where to put error message */
5922 NULL, /* Don't skip syntax errors */
5923 &filtertype, /* Will always be set to FILTER_EXIM for this call */
5924 US"system filter"); /* For error messages */
5926 DEBUG(D_deliver|D_filter) debug_printf("system filter returned %d\n", rc);
5928 if (rc == FF_ERROR || rc == FF_NONEXIST)
5930 (void)close(deliver_datafile);
5931 deliver_datafile = -1;
5932 log_write(0, LOG_MAIN|LOG_PANIC, "Error in system filter: %s",
5933 string_printing(filter_message));
5934 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5937 /* Reset things. If the filter message is an empty string, which can happen
5938 for a filter "fail" or "freeze" command with no text, reset it to NULL. */
5940 f.system_filtering = FALSE;
5941 f.enable_dollar_recipients = FALSE;
5942 if (filter_message && filter_message[0] == 0) filter_message = NULL;
5944 /* Save the values of the system filter variables so that user filters
5947 memcpy(filter_sn, filter_n, sizeof(filter_sn));
5949 /* The filter can request that delivery of the original addresses be
5954 process_recipients = RECIP_DEFER;
5955 deliver_msglog("Delivery deferred by system filter\n");
5956 log_write(0, LOG_MAIN, "Delivery deferred by system filter");
5959 /* The filter can request that a message be frozen, but this does not
5960 take place if the message has been manually thawed. In that case, we must
5961 unset "delivered", which is forced by the "freeze" command to make -bF
5964 else if (rc == FF_FREEZE && !f.deliver_manual_thaw)
5966 f.deliver_freeze = TRUE;
5967 deliver_frozen_at = time(NULL);
5968 process_recipients = RECIP_DEFER;
5969 frozen_info = string_sprintf(" by the system filter%s%s",
5970 filter_message ? US": " : US"",
5971 filter_message ? filter_message : US"");
5974 /* The filter can request that a message be failed. The error message may be
5975 quite long - it is sent back to the sender in the bounce - but we don't want
5976 to fill up the log with repetitions of it. If it starts with << then the text
5977 between << and >> is written to the log, with the rest left for the bounce
5980 else if (rc == FF_FAIL)
5982 uschar *colon = US"";
5983 uschar *logmsg = US"";
5986 process_recipients = RECIP_FAIL_FILTER;
5992 if ( filter_message[0] == '<'
5993 && filter_message[1] == '<'
5994 && (logend = Ustrstr(filter_message, ">>"))
5997 logmsg = filter_message + 2;
5998 loglen = logend - logmsg;
5999 filter_message = logend + 2;
6000 if (filter_message[0] == 0) filter_message = NULL;
6004 logmsg = filter_message;
6005 loglen = Ustrlen(filter_message);
6009 log_write(0, LOG_MAIN, "cancelled by system filter%s%.*s", colon, loglen,
6013 /* Delivery can be restricted only to those recipients (if any) that the
6014 filter specified. */
6016 else if (rc == FF_DELIVERED)
6018 process_recipients = RECIP_IGNORE;
6020 log_write(0, LOG_MAIN, "original recipients ignored (system filter)");
6022 log_write(0, LOG_MAIN, "=> discarded (system filter)");
6025 /* If any new addresses were created by the filter, fake up a "parent"
6026 for them. This is necessary for pipes, etc., which are expected to have
6027 parents, and it also gives some sensible logging for others. Allow
6028 pipes, files, and autoreplies, and run them as the filter uid if set,
6029 otherwise as the current uid. */
6033 int uid = (system_filter_uid_set)? system_filter_uid : geteuid();
6034 int gid = (system_filter_gid_set)? system_filter_gid : getegid();
6036 /* The text "system-filter" is tested in transport_set_up_command() and in
6037 set_up_shell_command() in the pipe transport, to enable them to permit
6038 $recipients, so don't change it here without also changing it there. */
6040 address_item *p = addr_new;
6041 address_item *parent = deliver_make_addr(US"system-filter", FALSE);
6043 parent->domain = string_copylc(qualify_domain_recipient);
6044 parent->local_part = US"system-filter";
6046 /* As part of this loop, we arrange for addr_last to end up pointing
6047 at the final address. This is used if we go on to add addresses for the
6048 original recipients. */
6052 if (parent->child_count == USHRT_MAX)
6053 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "system filter generated more "
6054 "than %d delivery addresses", USHRT_MAX);
6055 parent->child_count++;
6058 if (testflag(p, af_pfr))
6064 setflag(p, af_uid_set);
6065 setflag(p, af_gid_set);
6066 setflag(p, af_allow_file);
6067 setflag(p, af_allow_pipe);
6068 setflag(p, af_allow_reply);
6070 /* Find the name of the system filter's appropriate pfr transport */
6072 if (p->address[0] == '|')
6075 tpname = system_filter_pipe_transport;
6076 address_pipe = p->address;
6078 else if (p->address[0] == '>')
6081 tpname = system_filter_reply_transport;
6085 if (p->address[Ustrlen(p->address)-1] == '/')
6087 type = US"directory";
6088 tpname = system_filter_directory_transport;
6093 tpname = system_filter_file_transport;
6095 address_file = p->address;
6098 /* Now find the actual transport, first expanding the name. We have
6099 set address_file or address_pipe above. */
6103 uschar *tmp = expand_string(tpname);
6104 address_file = address_pipe = NULL;
6106 p->message = string_sprintf("failed to expand \"%s\" as a "
6107 "system filter transport name", tpname);
6111 p->message = string_sprintf("system_filter_%s_transport is unset",
6116 transport_instance *tp;
6117 for (tp = transports; tp; tp = tp->next)
6118 if (Ustrcmp(tp->name, tpname) == 0)
6124 p->message = string_sprintf("failed to find \"%s\" transport "
6125 "for system filter delivery", tpname);
6128 /* If we couldn't set up a transport, defer the delivery, putting the
6129 error on the panic log as well as the main log. */
6133 address_item *badp = p;
6135 if (!addr_last) addr_new = p; else addr_last->next = p;
6136 badp->local_part = badp->address; /* Needed for log line */
6137 post_process_one(badp, DEFER, LOG_MAIN|LOG_PANIC, EXIM_DTYPE_ROUTER, 0);
6140 } /* End of pfr handling */
6142 /* Either a non-pfr delivery, or we found a transport */
6144 DEBUG(D_deliver|D_filter)
6145 debug_printf("system filter added %s\n", p->address);
6149 } /* Loop through all addr_new addresses */
6154 /* Scan the recipients list, and for every one that is not in the non-
6155 recipients tree, add an addr item to the chain of new addresses. If the pno
6156 value is non-negative, we must set the onetime parent from it. This which
6157 points to the relevant entry in the recipients list.
6159 This processing can be altered by the setting of the process_recipients
6160 variable, which is changed if recipients are to be ignored, failed, or
6161 deferred. This can happen as a result of system filter activity, or if the -Mg
6162 option is used to fail all of them.
6164 Duplicate addresses are handled later by a different tree structure; we can't
6165 just extend the non-recipients tree, because that will be re-written to the
6166 spool if the message is deferred, and in any case there are casing
6167 complications for local addresses. */
6169 if (process_recipients != RECIP_IGNORE)
6170 for (i = 0; i < recipients_count; i++)
6171 if (!tree_search(tree_nonrecipients, recipients_list[i].address))
6173 recipient_item *r = recipients_list + i;
6174 address_item *new = deliver_make_addr(r->address, FALSE);
6175 new->prop.errors_address = r->errors_to;
6177 if ((new->prop.utf8_msg = message_smtputf8))
6179 new->prop.utf8_downcvt = message_utf8_downconvert == 1;
6180 new->prop.utf8_downcvt_maybe = message_utf8_downconvert == -1;
6181 DEBUG(D_deliver) debug_printf("utf8, downconvert %s\n",
6182 new->prop.utf8_downcvt ? "yes"
6183 : new->prop.utf8_downcvt_maybe ? "ifneeded"
6189 new->onetime_parent = recipients_list[r->pno].address;
6191 /* If DSN support is enabled, set the dsn flags and the original receipt
6192 to be passed on to other DSN enabled MTAs */
6193 new->dsn_flags = r->dsn_flags & rf_dsnflags;
6194 new->dsn_orcpt = r->orcpt;
6195 DEBUG(D_deliver) debug_printf("DSN: set orcpt: %s flags: %d\n",
6196 new->dsn_orcpt ? new->dsn_orcpt : US"", new->dsn_flags);
6198 switch (process_recipients)
6200 /* RECIP_DEFER is set when a system filter freezes a message. */
6203 new->next = addr_defer;
6208 /* RECIP_FAIL_FILTER is set when a system filter has obeyed a "fail"
6211 case RECIP_FAIL_FILTER:
6213 filter_message ? filter_message : US"delivery cancelled";
6214 setflag(new, af_pass_message);
6215 goto RECIP_QUEUE_FAILED; /* below */
6218 /* RECIP_FAIL_TIMEOUT is set when a message is frozen, but is older
6219 than the value in timeout_frozen_after. Treat non-bounce messages
6220 similarly to -Mg; for bounce messages we just want to discard, so
6221 don't put the address on the failed list. The timeout has already
6224 case RECIP_FAIL_TIMEOUT:
6225 new->message = US"delivery cancelled; message timed out";
6226 goto RECIP_QUEUE_FAILED; /* below */
6229 /* RECIP_FAIL is set when -Mg has been used. */
6232 new->message = US"delivery cancelled by administrator";
6235 /* Common code for the failure cases above. If this is not a bounce
6236 message, put the address on the failed list so that it is used to
6237 create a bounce. Otherwise do nothing - this just discards the address.
6238 The incident has already been logged. */
6241 if (sender_address[0])
6243 new->next = addr_failed;
6249 /* RECIP_FAIL_LOOP is set when there are too many Received: headers
6250 in the message. Process each address as a routing failure; if this
6251 is a bounce message, it will get frozen. */
6253 case RECIP_FAIL_LOOP:
6254 new->message = US"Too many \"Received\" headers - suspected mail loop";
6255 post_process_one(new, FAIL, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
6259 /* Value should be RECIP_ACCEPT; take this as the safe default. */
6262 if (!addr_new) addr_new = new; else addr_last->next = new;
6267 #ifndef DISABLE_EVENT
6268 if (process_recipients != RECIP_ACCEPT)
6270 uschar * save_local = deliver_localpart;
6271 const uschar * save_domain = deliver_domain;
6272 uschar * addr = new->address, * errmsg = NULL;
6273 int start, end, dom;
6275 if (!parse_extract_address(addr, &errmsg, &start, &end, &dom, TRUE))
6276 log_write(0, LOG_MAIN|LOG_PANIC,
6277 "failed to parse address '%.100s': %s\n", addr, errmsg);
6281 string_copyn(addr+start, dom ? (dom-1) - start : end - start);
6282 deliver_domain = dom ? CUS string_copyn(addr+dom, end - dom) : CUS"";
6284 event_raise(event_action, US"msg:fail:internal", new->message);
6286 deliver_localpart = save_local;
6287 deliver_domain = save_domain;
6296 debug_printf("Delivery address list:\n");
6297 for (p = addr_new; p; p = p->next)
6298 debug_printf(" %s %s\n", p->address,
6299 p->onetime_parent ? p->onetime_parent : US"");
6302 /* Set up the buffers used for copying over the file when delivering. */
6304 deliver_in_buffer = store_malloc(DELIVER_IN_BUFFER_SIZE);
6305 deliver_out_buffer = store_malloc(DELIVER_OUT_BUFFER_SIZE);
6309 /* Until there are no more new addresses, handle each one as follows:
6311 . If this is a generated address (indicated by the presence of a parent
6312 pointer) then check to see whether it is a pipe, file, or autoreply, and
6313 if so, handle it directly here. The router that produced the address will
6314 have set the allow flags into the address, and also set the uid/gid required.
6315 Having the routers generate new addresses and then checking them here at
6316 the outer level is tidier than making each router do the checking, and
6317 means that routers don't need access to the failed address queue.
6319 . Break up the address into local part and domain, and make lowercased
6320 versions of these strings. We also make unquoted versions of the local part.
6322 . Handle the percent hack for those domains for which it is valid.
6324 . For child addresses, determine if any of the parents have the same address.
6325 If so, generate a different string for previous delivery checking. Without
6326 this code, if the address spqr generates spqr via a forward or alias file,
6327 delivery of the generated spqr stops further attempts at the top level spqr,
6328 which is not what is wanted - it may have generated other addresses.
6330 . Check on the retry database to see if routing was previously deferred, but
6331 only if in a queue run. Addresses that are to be routed are put on the
6332 addr_route chain. Addresses that are to be deferred are put on the
6333 addr_defer chain. We do all the checking first, so as not to keep the
6334 retry database open any longer than necessary.
6336 . Now we run the addresses through the routers. A router may put the address
6337 on either the addr_local or the addr_remote chain for local or remote
6338 delivery, respectively, or put it on the addr_failed chain if it is
6339 undeliveable, or it may generate child addresses and put them on the
6340 addr_new chain, or it may defer an address. All the chain anchors are
6341 passed as arguments so that the routers can be called for verification
6344 . If new addresses have been generated by the routers, da capo.
6347 f.header_rewritten = FALSE; /* No headers rewritten yet */
6348 while (addr_new) /* Loop until all addresses dealt with */
6350 address_item *addr, *parent;
6352 /* Failure to open the retry database is treated the same as if it does
6353 not exist. In both cases, dbm_file is NULL. */
6355 if (!(dbm_file = dbfn_open(US"retry", O_RDONLY, &dbblock, FALSE)))
6356 DEBUG(D_deliver|D_retry|D_route|D_hints_lookup)
6357 debug_printf("no retry data available\n");
6359 /* Scan the current batch of new addresses, to handle pipes, files and
6360 autoreplies, and determine which others are ready for routing. */
6367 dbdata_retry *domain_retry_record;
6368 dbdata_retry *address_retry_record;
6371 addr_new = addr->next;
6373 DEBUG(D_deliver|D_retry|D_route)
6375 debug_printf(">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>\n");
6376 debug_printf("Considering: %s\n", addr->address);
6379 /* Handle generated address that is a pipe or a file or an autoreply. */
6381 if (testflag(addr, af_pfr))
6383 /* If an autoreply in a filter could not generate a syntactically valid
6384 address, give up forthwith. Set af_ignore_error so that we don't try to
6385 generate a bounce. */
6387 if (testflag(addr, af_bad_reply))
6389 addr->basic_errno = ERRNO_BADADDRESS2;
6390 addr->local_part = addr->address;
6392 US"filter autoreply generated syntactically invalid recipient";
6393 addr->prop.ignore_error = TRUE;
6394 (void) post_process_one(addr, FAIL, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
6395 continue; /* with the next new address */
6398 /* If two different users specify delivery to the same pipe or file or
6399 autoreply, there should be two different deliveries, so build a unique
6400 string that incorporates the original address, and use this for
6401 duplicate testing and recording delivery, and also for retrying. */
6404 string_sprintf("%s:%s", addr->address, addr->parent->unique +
6405 (testflag(addr->parent, af_homonym)? 3:0));
6407 addr->address_retry_key = addr->domain_retry_key =
6408 string_sprintf("T:%s", addr->unique);
6410 /* If a filter file specifies two deliveries to the same pipe or file,
6411 we want to de-duplicate, but this is probably not wanted for two mail
6412 commands to the same address, where probably both should be delivered.
6413 So, we have to invent a different unique string in that case. Just
6414 keep piling '>' characters on the front. */
6416 if (addr->address[0] == '>')
6418 while (tree_search(tree_duplicates, addr->unique))
6419 addr->unique = string_sprintf(">%s", addr->unique);
6422 else if ((tnode = tree_search(tree_duplicates, addr->unique)))
6424 DEBUG(D_deliver|D_route)
6425 debug_printf("%s is a duplicate address: discarded\n", addr->address);
6426 addr->dupof = tnode->data.ptr;
6427 addr->next = addr_duplicate;
6428 addr_duplicate = addr;
6432 DEBUG(D_deliver|D_route) debug_printf("unique = %s\n", addr->unique);
6434 /* Check for previous delivery */
6436 if (tree_search(tree_nonrecipients, addr->unique))
6438 DEBUG(D_deliver|D_route)
6439 debug_printf("%s was previously delivered: discarded\n", addr->address);
6440 child_done(addr, tod_stamp(tod_log));
6444 /* Save for checking future duplicates */
6446 tree_add_duplicate(addr->unique, addr);
6448 /* Set local part and domain */
6450 addr->local_part = addr->address;
6451 addr->domain = addr->parent->domain;
6453 /* Ensure that the delivery is permitted. */
6455 if (testflag(addr, af_file))
6457 if (!testflag(addr, af_allow_file))
6459 addr->basic_errno = ERRNO_FORBIDFILE;
6460 addr->message = US"delivery to file forbidden";
6461 (void)post_process_one(addr, FAIL, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
6462 continue; /* with the next new address */
6465 else if (addr->address[0] == '|')
6467 if (!testflag(addr, af_allow_pipe))
6469 addr->basic_errno = ERRNO_FORBIDPIPE;
6470 addr->message = US"delivery to pipe forbidden";
6471 (void)post_process_one(addr, FAIL, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
6472 continue; /* with the next new address */
6475 else if (!testflag(addr, af_allow_reply))
6477 addr->basic_errno = ERRNO_FORBIDREPLY;
6478 addr->message = US"autoreply forbidden";
6479 (void)post_process_one(addr, FAIL, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
6480 continue; /* with the next new address */
6483 /* If the errno field is already set to BADTRANSPORT, it indicates
6484 failure to expand a transport string, or find the associated transport,
6485 or an unset transport when one is required. Leave this test till now so
6486 that the forbid errors are given in preference. */
6488 if (addr->basic_errno == ERRNO_BADTRANSPORT)
6490 (void)post_process_one(addr, DEFER, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
6494 /* Treat /dev/null as a special case and abandon the delivery. This
6495 avoids having to specify a uid on the transport just for this case.
6496 Arrange for the transport name to be logged as "**bypassed**". */
6498 if (Ustrcmp(addr->address, "/dev/null") == 0)
6500 uschar *save = addr->transport->name;
6501 addr->transport->name = US"**bypassed**";
6502 (void)post_process_one(addr, OK, LOG_MAIN, EXIM_DTYPE_TRANSPORT, '=');
6503 addr->transport->name = save;
6504 continue; /* with the next new address */
6507 /* Pipe, file, or autoreply delivery is to go ahead as a normal local
6510 DEBUG(D_deliver|D_route)
6511 debug_printf("queued for %s transport\n", addr->transport->name);
6512 addr->next = addr_local;
6514 continue; /* with the next new address */
6517 /* Handle normal addresses. First, split up into local part and domain,
6518 handling the %-hack if necessary. There is the possibility of a defer from
6519 a lookup in percent_hack_domains. */
6521 if ((rc = deliver_split_address(addr)) == DEFER)
6523 addr->message = US"cannot check percent_hack_domains";
6524 addr->basic_errno = ERRNO_LISTDEFER;
6525 (void)post_process_one(addr, DEFER, LOG_MAIN, EXIM_DTYPE_NONE, 0);
6529 /* Check to see if the domain is held. If so, proceed only if the
6530 delivery was forced by hand. */
6532 deliver_domain = addr->domain; /* set $domain */
6533 if ( !forced && hold_domains
6534 && (rc = match_isinlist(addr->domain, (const uschar **)&hold_domains, 0,
6535 &domainlist_anchor, addr->domain_cache, MCL_DOMAIN, TRUE,
6541 addr->message = US"hold_domains lookup deferred";
6542 addr->basic_errno = ERRNO_LISTDEFER;
6546 addr->message = US"domain is held";
6547 addr->basic_errno = ERRNO_HELD;
6549 (void)post_process_one(addr, DEFER, LOG_MAIN, EXIM_DTYPE_NONE, 0);
6553 /* Now we can check for duplicates and previously delivered addresses. In
6554 order to do this, we have to generate a "unique" value for each address,
6555 because there may be identical actual addresses in a line of descendents.
6556 The "unique" field is initialized to the same value as the "address" field,
6557 but gets changed here to cope with identically-named descendents. */
6559 for (parent = addr->parent; parent; parent = parent->parent)
6560 if (strcmpic(addr->address, parent->address) == 0) break;
6562 /* If there's an ancestor with the same name, set the homonym flag. This
6563 influences how deliveries are recorded. Then add a prefix on the front of
6564 the unique address. We use \n\ where n starts at 0 and increases each time.
6565 It is unlikely to pass 9, but if it does, it may look odd but will still
6566 work. This means that siblings or cousins with the same names are treated
6567 as duplicates, which is what we want. */
6571 setflag(addr, af_homonym);
6572 if (parent->unique[0] != '\\')
6573 addr->unique = string_sprintf("\\0\\%s", addr->address);
6575 addr->unique = string_sprintf("\\%c\\%s", parent->unique[1] + 1,
6579 /* Ensure that the domain in the unique field is lower cased, because
6580 domains are always handled caselessly. */
6582 p = Ustrrchr(addr->unique, '@');
6583 while (*p != 0) { *p = tolower(*p); p++; }
6585 DEBUG(D_deliver|D_route) debug_printf("unique = %s\n", addr->unique);
6587 if (tree_search(tree_nonrecipients, addr->unique))
6589 DEBUG(D_deliver|D_route)
6590 debug_printf("%s was previously delivered: discarded\n", addr->unique);
6591 child_done(addr, tod_stamp(tod_log));
6595 /* Get the routing retry status, saving the two retry keys (with and
6596 without the local part) for subsequent use. If there is no retry record for
6597 the standard address routing retry key, we look for the same key with the
6598 sender attached, because this form is used by the smtp transport after a
6599 4xx response to RCPT when address_retry_include_sender is true. */
6601 addr->domain_retry_key = string_sprintf("R:%s", addr->domain);
6602 addr->address_retry_key = string_sprintf("R:%s@%s", addr->local_part,
6607 domain_retry_record = dbfn_read(dbm_file, addr->domain_retry_key);
6608 if ( domain_retry_record
6609 && now - domain_retry_record->time_stamp > retry_data_expire
6612 DEBUG(D_deliver|D_retry)
6613 debug_printf("domain retry record present but expired\n");
6614 domain_retry_record = NULL; /* Ignore if too old */
6617 address_retry_record = dbfn_read(dbm_file, addr->address_retry_key);
6618 if ( address_retry_record
6619 && now - address_retry_record->time_stamp > retry_data_expire
6622 DEBUG(D_deliver|D_retry)
6623 debug_printf("address retry record present but expired\n");
6624 address_retry_record = NULL; /* Ignore if too old */
6627 if (!address_retry_record)
6629 uschar *altkey = string_sprintf("%s:<%s>", addr->address_retry_key,
6631 address_retry_record = dbfn_read(dbm_file, altkey);
6632 if ( address_retry_record
6633 && now - address_retry_record->time_stamp > retry_data_expire)
6635 DEBUG(D_deliver|D_retry)
6636 debug_printf("address<sender> retry record present but expired\n");
6637 address_retry_record = NULL; /* Ignore if too old */
6642 domain_retry_record = address_retry_record = NULL;
6644 DEBUG(D_deliver|D_retry)
6646 if (!domain_retry_record)
6647 debug_printf("no domain retry record\n");
6649 debug_printf("have domain retry record; next_try = now%+d\n",
6650 f.running_in_test_harness ? 0 :
6651 (int)(domain_retry_record->next_try - now));
6653 if (!address_retry_record)
6654 debug_printf("no address retry record\n");
6656 debug_printf("have address retry record; next_try = now%+d\n",
6657 f.running_in_test_harness ? 0 :
6658 (int)(address_retry_record->next_try - now));
6661 /* If we are sending a message down an existing SMTP connection, we must
6662 assume that the message which created the connection managed to route
6663 an address to that connection. We do not want to run the risk of taking
6664 a long time over routing here, because if we do, the server at the other
6665 end of the connection may time it out. This is especially true for messages
6666 with lots of addresses. For this kind of delivery, queue_running is not
6667 set, so we would normally route all addresses. We take a pragmatic approach
6668 and defer routing any addresses that have any kind of domain retry record.
6669 That is, we don't even look at their retry times. It doesn't matter if this
6670 doesn't work occasionally. This is all just an optimization, after all.
6672 The reason for not doing the same for address retries is that they normally
6673 arise from 4xx responses, not DNS timeouts. */
6675 if (continue_hostname && domain_retry_record)
6677 addr->message = US"reusing SMTP connection skips previous routing defer";
6678 addr->basic_errno = ERRNO_RRETRY;
6679 (void)post_process_one(addr, DEFER, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
6681 addr->message = domain_retry_record->text;
6682 setflag(addr, af_pass_message);
6685 /* If we are in a queue run, defer routing unless there is no retry data or
6686 we've passed the next retry time, or this message is forced. In other
6687 words, ignore retry data when not in a queue run.
6689 However, if the domain retry time has expired, always allow the routing
6690 attempt. If it fails again, the address will be failed. This ensures that
6691 each address is routed at least once, even after long-term routing
6694 If there is an address retry, check that too; just wait for the next
6695 retry time. This helps with the case when the temporary error on the
6696 address was really message-specific rather than address specific, since
6697 it allows other messages through.
6699 We also wait for the next retry time if this is a message sent down an
6700 existing SMTP connection (even though that will be forced). Otherwise there
6701 will be far too many attempts for an address that gets a 4xx error. In
6702 fact, after such an error, we should not get here because, the host should
6703 not be remembered as one this message needs. However, there was a bug that
6704 used to cause this to happen, so it is best to be on the safe side.
6706 Even if we haven't reached the retry time in the hints, there is one more
6707 check to do, which is for the ultimate address timeout. We only do this
6708 check if there is an address retry record and there is not a domain retry
6709 record; this implies that previous attempts to handle the address had the
6710 retry_use_local_parts option turned on. We use this as an approximation
6711 for the destination being like a local delivery, for example delivery over
6712 LMTP to an IMAP message store. In this situation users are liable to bump
6713 into their quota and thereby have intermittently successful deliveries,
6714 which keep the retry record fresh, which can lead to us perpetually
6715 deferring messages. */
6717 else if ( ( f.queue_running && !f.deliver_force
6718 || continue_hostname
6720 && ( ( domain_retry_record
6721 && now < domain_retry_record->next_try
6722 && !domain_retry_record->expired
6724 || ( address_retry_record
6725 && now < address_retry_record->next_try
6727 && ( domain_retry_record
6728 || !address_retry_record
6729 || !retry_ultimate_address_timeout(addr->address_retry_key,
6730 addr->domain, address_retry_record, now)
6733 addr->message = US"retry time not reached";
6734 addr->basic_errno = ERRNO_RRETRY;
6735 (void)post_process_one(addr, DEFER, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
6737 /* For remote-retry errors (here and just above) that we've not yet
6738 hit the rery time, use the error recorded in the retry database
6739 as info in the warning message. This lets us send a message even
6740 when we're not failing on a fresh attempt. We assume that this
6741 info is not sensitive. */
6743 addr->message = domain_retry_record
6744 ? domain_retry_record->text : address_retry_record->text;
6745 setflag(addr, af_pass_message);
6748 /* The domain is OK for routing. Remember if retry data exists so it
6749 can be cleaned up after a successful delivery. */
6753 if (domain_retry_record || address_retry_record)
6754 setflag(addr, af_dr_retry_exists);
6755 addr->next = addr_route;
6757 DEBUG(D_deliver|D_route)
6758 debug_printf("%s: queued for routing\n", addr->address);
6762 /* The database is closed while routing is actually happening. Requests to
6763 update it are put on a chain and all processed together at the end. */
6765 if (dbm_file) dbfn_close(dbm_file);
6767 /* If queue_domains is set, we don't even want to try routing addresses in
6768 those domains. During queue runs, queue_domains is forced to be unset.
6769 Optimize by skipping this pass through the addresses if nothing is set. */
6771 if (!f.deliver_force && queue_domains)
6773 address_item *okaddr = NULL;
6776 address_item *addr = addr_route;
6777 addr_route = addr->next;
6779 deliver_domain = addr->domain; /* set $domain */
6780 if ((rc = match_isinlist(addr->domain, (const uschar **)&queue_domains, 0,
6781 &domainlist_anchor, addr->domain_cache, MCL_DOMAIN, TRUE, NULL))
6785 addr->basic_errno = ERRNO_LISTDEFER;
6786 addr->message = US"queue_domains lookup deferred";
6787 (void)post_process_one(addr, DEFER, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
6791 addr->next = okaddr;
6796 addr->basic_errno = ERRNO_QUEUE_DOMAIN;
6797 addr->message = US"domain is in queue_domains";
6798 (void)post_process_one(addr, DEFER, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
6802 addr_route = okaddr;
6805 /* Now route those addresses that are not deferred. */
6810 address_item *addr = addr_route;
6811 const uschar *old_domain = addr->domain;
6812 uschar *old_unique = addr->unique;
6813 addr_route = addr->next;
6816 /* Just in case some router parameter refers to it. */
6818 if (!(return_path = addr->prop.errors_address))
6819 return_path = sender_address;
6821 /* If a router defers an address, add a retry item. Whether or not to
6822 use the local part in the key is a property of the router. */
6824 if ((rc = route_address(addr, &addr_local, &addr_remote, &addr_new,
6825 &addr_succeed, v_none)) == DEFER)
6826 retry_add_item(addr,
6827 addr->router->retry_use_local_part
6828 ? string_sprintf("R:%s@%s", addr->local_part, addr->domain)
6829 : string_sprintf("R:%s", addr->domain),
6832 /* Otherwise, if there is an existing retry record in the database, add
6833 retry items to delete both forms. We must also allow for the possibility
6834 of a routing retry that includes the sender address. Since the domain might
6835 have been rewritten (expanded to fully qualified) as a result of routing,
6836 ensure that the rewritten form is also deleted. */
6838 else if (testflag(addr, af_dr_retry_exists))
6840 uschar *altkey = string_sprintf("%s:<%s>", addr->address_retry_key,
6842 retry_add_item(addr, altkey, rf_delete);
6843 retry_add_item(addr, addr->address_retry_key, rf_delete);
6844 retry_add_item(addr, addr->domain_retry_key, rf_delete);
6845 if (Ustrcmp(addr->domain, old_domain) != 0)
6846 retry_add_item(addr, string_sprintf("R:%s", old_domain), rf_delete);
6849 /* DISCARD is given for :blackhole: and "seen finish". The event has been
6850 logged, but we need to ensure the address (and maybe parents) is marked
6855 address_done(addr, tod_stamp(tod_log));
6856 continue; /* route next address */
6859 /* The address is finished with (failed or deferred). */
6863 (void)post_process_one(addr, rc, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
6864 continue; /* route next address */
6867 /* The address has been routed. If the router changed the domain, it will
6868 also have changed the unique address. We have to test whether this address
6869 has already been delivered, because it's the unique address that finally
6872 if ( addr->unique != old_unique
6873 && tree_search(tree_nonrecipients, addr->unique) != 0
6876 DEBUG(D_deliver|D_route) debug_printf("%s was previously delivered: "
6877 "discarded\n", addr->address);
6878 if (addr_remote == addr) addr_remote = addr->next;
6879 else if (addr_local == addr) addr_local = addr->next;
6882 /* If the router has same_domain_copy_routing set, we are permitted to copy
6883 the routing for any other addresses with the same domain. This is an
6884 optimisation to save repeated DNS lookups for "standard" remote domain
6885 routing. The option is settable only on routers that generate host lists.
6886 We play it very safe, and do the optimization only if the address is routed
6887 to a remote transport, there are no header changes, and the domain was not
6888 modified by the router. */
6890 if ( addr_remote == addr
6891 && addr->router->same_domain_copy_routing
6892 && !addr->prop.extra_headers
6893 && !addr->prop.remove_headers
6894 && old_domain == addr->domain
6897 address_item **chain = &addr_route;
6900 address_item *addr2 = *chain;
6901 if (Ustrcmp(addr2->domain, addr->domain) != 0)
6903 chain = &(addr2->next);
6907 /* Found a suitable address; take it off the routing list and add it to
6908 the remote delivery list. */
6910 *chain = addr2->next;
6911 addr2->next = addr_remote;
6912 addr_remote = addr2;
6914 /* Copy the routing data */
6916 addr2->domain = addr->domain;
6917 addr2->router = addr->router;
6918 addr2->transport = addr->transport;
6919 addr2->host_list = addr->host_list;
6920 addr2->fallback_hosts = addr->fallback_hosts;
6921 addr2->prop.errors_address = addr->prop.errors_address;
6922 copyflag(addr2, addr, af_hide_child);
6923 copyflag(addr2, addr, af_local_host_removed);
6925 DEBUG(D_deliver|D_route)
6926 debug_printf(">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>\n"
6928 "Routing for %s copied from %s\n",
6929 addr2->address, addr2->address, addr->address);
6932 } /* Continue with routing the next address. */
6933 } /* Loop to process any child addresses that the routers created, and
6934 any rerouted addresses that got put back on the new chain. */
6937 /* Debugging: show the results of the routing */
6939 DEBUG(D_deliver|D_retry|D_route)
6942 debug_printf(">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>\n");
6943 debug_printf("After routing:\n Local deliveries:\n");
6944 for (p = addr_local; p; p = p->next)
6945 debug_printf(" %s\n", p->address);
6947 debug_printf(" Remote deliveries:\n");
6948 for (p = addr_remote; p; p = p->next)
6949 debug_printf(" %s\n", p->address);
6951 debug_printf(" Failed addresses:\n");
6952 for (p = addr_failed; p; p = p->next)
6953 debug_printf(" %s\n", p->address);
6955 debug_printf(" Deferred addresses:\n");
6956 for (p = addr_defer; p; p = p->next)
6957 debug_printf(" %s\n", p->address);
6960 /* Free any resources that were cached during routing. */
6965 /* These two variables are set only during routing, after check_local_user.
6966 Ensure they are not set in transports. */
6968 local_user_gid = (gid_t)(-1);
6969 local_user_uid = (uid_t)(-1);
6971 /* Check for any duplicate addresses. This check is delayed until after
6972 routing, because the flexibility of the routing configuration means that
6973 identical addresses with different parentage may end up being redirected to
6974 different addresses. Checking for duplicates too early (as we previously used
6975 to) makes this kind of thing not work. */
6977 do_duplicate_check(&addr_local);
6978 do_duplicate_check(&addr_remote);
6980 /* When acting as an MUA wrapper, we proceed only if all addresses route to a
6981 remote transport. The check that they all end up in one transaction happens in
6982 the do_remote_deliveries() function. */
6985 && (addr_local || addr_failed || addr_defer)
6989 uschar *which, *colon, *msg;
6996 else if (addr_defer)
6999 which = US"deferred";
7007 while (addr->parent) addr = addr->parent;
7012 msg = addr->message;
7014 else colon = msg = US"";
7016 /* We don't need to log here for a forced failure as it will already
7017 have been logged. Defer will also have been logged, but as a defer, so we do
7018 need to do the failure logging. */
7020 if (addr != addr_failed)
7021 log_write(0, LOG_MAIN, "** %s routing yielded a %s delivery",
7022 addr->address, which);
7024 /* Always write an error to the caller */
7026 fprintf(stderr, "routing %s yielded a %s delivery%s%s\n", addr->address,
7029 final_yield = DELIVER_MUA_FAILED;
7030 addr_failed = addr_defer = NULL; /* So that we remove the message */
7031 goto DELIVERY_TIDYUP;
7035 /* If this is a run to continue deliveries to an external channel that is
7036 already set up, defer any local deliveries. */
7038 if (continue_transport)
7042 address_item *addr = addr_defer;
7043 while (addr->next) addr = addr->next;
7044 addr->next = addr_local;
7047 addr_defer = addr_local;
7052 /* Because address rewriting can happen in the routers, we should not really do
7053 ANY deliveries until all addresses have been routed, so that all recipients of
7054 the message get the same headers. However, this is in practice not always
7055 possible, since sometimes remote addresses give DNS timeouts for days on end.
7056 The pragmatic approach is to deliver what we can now, saving any rewritten
7057 headers so that at least the next lot of recipients benefit from the rewriting
7058 that has already been done.
7060 If any headers have been rewritten during routing, update the spool file to
7061 remember them for all subsequent deliveries. This can be delayed till later if
7062 there is only address to be delivered - if it succeeds the spool write need not
7065 if ( f.header_rewritten
7066 && ( addr_local && (addr_local->next || addr_remote)
7067 || addr_remote && addr_remote->next
7070 /* Panic-dies on error */
7071 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
7072 f.header_rewritten = FALSE;
7076 /* If there are any deliveries to do and we do not already have the journal
7077 file, create it. This is used to record successful deliveries as soon as
7078 possible after each delivery is known to be complete. A file opened with
7079 O_APPEND is used so that several processes can run simultaneously.
7081 The journal is just insurance against crashes. When the spool file is
7082 ultimately updated at the end of processing, the journal is deleted. If a
7083 journal is found to exist at the start of delivery, the addresses listed
7084 therein are added to the non-recipients. */
7086 if (addr_local || addr_remote)
7090 uschar * fname = spool_fname(US"input", message_subdir, id, US"-J");
7092 if ((journal_fd = Uopen(fname,
7096 O_WRONLY|O_APPEND|O_CREAT|O_EXCL, SPOOL_MODE)) < 0)
7098 log_write(0, LOG_MAIN|LOG_PANIC, "Couldn't open journal file %s: %s",
7099 fname, strerror(errno));
7100 return DELIVER_NOT_ATTEMPTED;
7103 /* Set the close-on-exec flag, make the file owned by Exim, and ensure
7104 that the mode is correct - the group setting doesn't always seem to get
7105 set automatically. */
7107 if( fchown(journal_fd, exim_uid, exim_gid)
7108 || fchmod(journal_fd, SPOOL_MODE)
7110 || fcntl(journal_fd, F_SETFD, fcntl(journal_fd, F_GETFD) | FD_CLOEXEC)
7114 int ret = Uunlink(fname);
7115 log_write(0, LOG_MAIN|LOG_PANIC, "Couldn't set perms on journal file %s: %s",
7116 fname, strerror(errno));
7117 if(ret && errno != ENOENT)
7118 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s",
7119 fname, strerror(errno));
7120 return DELIVER_NOT_ATTEMPTED;
7124 else if (journal_fd >= 0)
7132 /* Now we can get down to the business of actually doing deliveries. Local
7133 deliveries are done first, then remote ones. If ever the problems of how to
7134 handle fallback transports are figured out, this section can be put into a loop
7135 for handling fallbacks, though the uid switching will have to be revised. */
7137 /* Precompile a regex that is used to recognize a parameter in response
7138 to an LHLO command, if is isn't already compiled. This may be used on both
7139 local and remote LMTP deliveries. */
7141 if (!regex_IGNOREQUOTA)
7143 regex_must_compile(US"\\n250[\\s\\-]IGNOREQUOTA(\\s|\\n|$)", FALSE, TRUE);
7145 /* Handle local deliveries */
7149 DEBUG(D_deliver|D_transport)
7150 debug_printf(">>>>>>>>>>>>>>>> Local deliveries >>>>>>>>>>>>>>>>\n");
7151 do_local_deliveries();
7152 f.disable_logging = FALSE;
7155 /* If queue_run_local is set, we do not want to attempt any remote deliveries,
7156 so just queue them all. */
7158 if (f.queue_run_local)
7161 address_item *addr = addr_remote;
7162 addr_remote = addr->next;
7164 addr->basic_errno = ERRNO_LOCAL_ONLY;
7165 addr->message = US"remote deliveries suppressed";
7166 (void)post_process_one(addr, DEFER, LOG_MAIN, EXIM_DTYPE_TRANSPORT, 0);
7169 /* Handle remote deliveries */
7173 DEBUG(D_deliver|D_transport)
7174 debug_printf(">>>>>>>>>>>>>>>> Remote deliveries >>>>>>>>>>>>>>>>\n");
7176 /* Precompile some regex that are used to recognize parameters in response
7177 to an EHLO command, if they aren't already compiled. */
7181 /* Now sort the addresses if required, and do the deliveries. The yield of
7182 do_remote_deliveries is FALSE when mua_wrapper is set and all addresses
7183 cannot be delivered in one transaction. */
7185 if (remote_sort_domains) sort_remote_deliveries();
7186 if (!do_remote_deliveries(FALSE))
7188 log_write(0, LOG_MAIN, "** mua_wrapper is set but recipients cannot all "
7189 "be delivered in one transaction");
7190 fprintf(stderr, "delivery to smarthost failed (configuration problem)\n");
7192 final_yield = DELIVER_MUA_FAILED;
7193 addr_failed = addr_defer = NULL; /* So that we remove the message */
7194 goto DELIVERY_TIDYUP;
7197 /* See if any of the addresses that failed got put on the queue for delivery
7198 to their fallback hosts. We do it this way because often the same fallback
7199 host is used for many domains, so all can be sent in a single transaction
7200 (if appropriately configured). */
7202 if (addr_fallback && !mua_wrapper)
7204 DEBUG(D_deliver) debug_printf("Delivering to fallback hosts\n");
7205 addr_remote = addr_fallback;
7206 addr_fallback = NULL;
7207 if (remote_sort_domains) sort_remote_deliveries();
7208 do_remote_deliveries(TRUE);
7210 f.disable_logging = FALSE;
7214 /* All deliveries are now complete. Ignore SIGTERM during this tidying up
7215 phase, to minimize cases of half-done things. */
7218 debug_printf(">>>>>>>>>>>>>>>> deliveries are done >>>>>>>>>>>>>>>>\n");
7219 cancel_cutthrough_connection(TRUE, US"deliveries are done");
7221 /* Root privilege is no longer needed */
7223 exim_setugid(exim_uid, exim_gid, FALSE, US"post-delivery tidying");
7225 set_process_info("tidying up after delivering %s", message_id);
7226 signal(SIGTERM, SIG_IGN);
7228 /* When we are acting as an MUA wrapper, the smtp transport will either have
7229 succeeded for all addresses, or failed them all in normal cases. However, there
7230 are some setup situations (e.g. when a named port does not exist) that cause an
7231 immediate exit with deferral of all addresses. Convert those into failures. We
7232 do not ever want to retry, nor do we want to send a bounce message. */
7238 address_item *addr, *nextaddr;
7239 for (addr = addr_defer; addr; addr = nextaddr)
7241 log_write(0, LOG_MAIN, "** %s mua_wrapper forced failure for deferred "
7242 "delivery", addr->address);
7243 nextaddr = addr->next;
7244 addr->next = addr_failed;
7250 /* Now all should either have succeeded or failed. */
7253 final_yield = DELIVER_MUA_SUCCEEDED;
7257 uschar *s = addr_failed->user_message;
7259 if (!s) s = addr_failed->message;
7261 fprintf(stderr, "Delivery failed: ");
7262 if (addr_failed->basic_errno > 0)
7264 fprintf(stderr, "%s", strerror(addr_failed->basic_errno));
7265 if (s) fprintf(stderr, ": ");
7267 if ((host = addr_failed->host_used))
7268 fprintf(stderr, "H=%s [%s]: ", host->name, host->address);
7270 fprintf(stderr, "%s", CS s);
7271 else if (addr_failed->basic_errno <= 0)
7272 fprintf(stderr, "unknown error");
7273 fprintf(stderr, "\n");
7275 final_yield = DELIVER_MUA_FAILED;
7280 /* In a normal configuration, we now update the retry database. This is done in
7281 one fell swoop at the end in order not to keep opening and closing (and
7282 locking) the database. The code for handling retries is hived off into a
7283 separate module for convenience. We pass it the addresses of the various
7284 chains, because deferred addresses can get moved onto the failed chain if the
7285 retry cutoff time has expired for all alternative destinations. Bypass the
7286 updating of the database if the -N flag is set, which is a debugging thing that
7287 prevents actual delivery. */
7289 else if (!f.dont_deliver)
7290 retry_update(&addr_defer, &addr_failed, &addr_succeed);
7292 /* Send DSN for successful messages if requested */
7293 addr_senddsn = NULL;
7295 for (addr_dsntmp = addr_succeed; addr_dsntmp; addr_dsntmp = addr_dsntmp->next)
7297 /* af_ignore_error not honored here. it's not an error */
7298 DEBUG(D_deliver) debug_printf("DSN: processing router : %s\n"
7299 "DSN: processing successful delivery address: %s\n"
7300 "DSN: Sender_address: %s\n"
7301 "DSN: orcpt: %s flags: %d\n"
7302 "DSN: envid: %s ret: %d\n"
7303 "DSN: Final recipient: %s\n"
7304 "DSN: Remote SMTP server supports DSN: %d\n",
7305 addr_dsntmp->router ? addr_dsntmp->router->name : US"(unknown)",
7306 addr_dsntmp->address,
7308 addr_dsntmp->dsn_orcpt ? addr_dsntmp->dsn_orcpt : US"NULL",
7309 addr_dsntmp->dsn_flags,
7310 dsn_envid ? dsn_envid : US"NULL", dsn_ret,
7311 addr_dsntmp->address,
7312 addr_dsntmp->dsn_aware
7315 /* send report if next hop not DSN aware or a router flagged "last DSN hop"
7316 and a report was requested */
7317 if ( ( addr_dsntmp->dsn_aware != dsn_support_yes
7318 || addr_dsntmp->dsn_flags & rf_dsnlasthop
7320 && addr_dsntmp->dsn_flags & rf_notify_success
7323 /* copy and relink address_item and send report with all of them at once later */
7324 address_item * addr_next = addr_senddsn;
7325 addr_senddsn = store_get(sizeof(address_item));
7326 *addr_senddsn = *addr_dsntmp;
7327 addr_senddsn->next = addr_next;
7330 DEBUG(D_deliver) debug_printf("DSN: not sending DSN success message\n");
7338 /* create exim process to send message */
7339 pid = child_open_exim(&fd);
7341 DEBUG(D_deliver) debug_printf("DSN: child_open_exim returns: %d\n", pid);
7343 if (pid < 0) /* Creation of child failed */
7345 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Process %d (parent %d) failed to "
7346 "create child process to send failure message: %s", getpid(),
7347 getppid(), strerror(errno));
7349 DEBUG(D_deliver) debug_printf("DSN: child_open_exim failed\n");
7351 else /* Creation of child succeeded */
7353 FILE * f = fdopen(fd, "wb");
7354 /* header only as required by RFC. only failure DSN needs to honor RET=FULL */
7356 transport_ctx tctx = {{0}};
7359 debug_printf("sending error message to: %s\n", sender_address);
7361 /* build unique id for MIME boundary */
7362 bound = string_sprintf(TIME_T_FMT "-eximdsn-%d", time(NULL), rand());
7363 DEBUG(D_deliver) debug_printf("DSN: MIME boundary: %s\n", bound);
7365 if (errors_reply_to)
7366 fprintf(f, "Reply-To: %s\n", errors_reply_to);
7368 fprintf(f, "Auto-Submitted: auto-generated\n"
7369 "From: Mail Delivery System <Mailer-Daemon@%s>\n"
7371 "Subject: Delivery Status Notification\n"
7372 "Content-Type: multipart/report; report-type=delivery-status; boundary=%s\n"
7373 "MIME-Version: 1.0\n\n"
7376 "Content-type: text/plain; charset=us-ascii\n\n"
7378 "This message was created automatically by mail delivery software.\n"
7379 " ----- The following addresses had successful delivery notifications -----\n",
7380 qualify_domain_sender, sender_address, bound, bound);
7382 for (addr_dsntmp = addr_senddsn; addr_dsntmp;
7383 addr_dsntmp = addr_dsntmp->next)
7384 fprintf(f, "<%s> (relayed %s)\n\n",
7385 addr_dsntmp->address,
7386 addr_dsntmp->dsn_flags & rf_dsnlasthop ? "via non DSN router"
7387 : addr_dsntmp->dsn_aware == dsn_support_no ? "to non-DSN-aware mailer"
7388 : "via non \"Remote SMTP\" router"
7392 "Content-type: message/delivery-status\n\n"
7393 "Reporting-MTA: dns; %s\n",
7394 bound, smtp_active_hostname);
7397 { /* must be decoded from xtext: see RFC 3461:6.3a */
7399 if (auth_xtextdecode(dsn_envid, &xdec_envid) > 0)
7400 fprintf(f, "Original-Envelope-ID: %s\n", dsn_envid);
7402 fprintf(f, "X-Original-Envelope-ID: error decoding xtext formatted ENVID\n");
7406 for (addr_dsntmp = addr_senddsn;
7408 addr_dsntmp = addr_dsntmp->next)
7410 if (addr_dsntmp->dsn_orcpt)
7411 fprintf(f,"Original-Recipient: %s\n", addr_dsntmp->dsn_orcpt);
7413 fprintf(f, "Action: delivered\n"
7414 "Final-Recipient: rfc822;%s\n"
7416 addr_dsntmp->address);
7418 if (addr_dsntmp->host_used && addr_dsntmp->host_used->name)
7419 fprintf(f, "Remote-MTA: dns; %s\nDiagnostic-Code: smtp; 250 Ok\n\n",
7420 addr_dsntmp->host_used->name);
7422 fprintf(f, "Diagnostic-Code: X-Exim; relayed via non %s router\n\n",
7423 addr_dsntmp->dsn_flags & rf_dsnlasthop ? "DSN" : "SMTP");
7426 fprintf(f, "--%s\nContent-type: text/rfc822-headers\n\n", bound);
7429 transport_filter_argv = NULL; /* Just in case */
7430 return_path = sender_address; /* In case not previously set */
7432 /* Write the original email out */
7435 tctx.options = topt_add_return_path | topt_no_body;
7436 /*XXX hmm, FALSE(fail) retval ignored.
7437 Could error for any number of reasons, and they are not handled. */
7438 transport_write_message(&tctx, 0);
7441 fprintf(f,"\n--%s--\n", bound);
7445 rc = child_close(pid, 0); /* Waits for child to close, no timeout */
7449 /* If any addresses failed, we must send a message to somebody, unless
7450 af_ignore_error is set, in which case no action is taken. It is possible for
7451 several messages to get sent if there are addresses with different
7458 uschar *logtod = tod_stamp(tod_log);
7460 address_item *handled_addr = NULL;
7461 address_item **paddr;
7462 address_item *msgchain = NULL;
7463 address_item **pmsgchain = &msgchain;
7465 /* There are weird cases when logging is disabled in the transport. However,
7466 there may not be a transport (address failed by a router). */
7468 f.disable_logging = FALSE;
7469 if (addr_failed->transport)
7470 f.disable_logging = addr_failed->transport->disable_logging;
7473 debug_printf("processing failed address %s\n", addr_failed->address);
7475 /* There are only two ways an address in a bounce message can get here:
7477 (1) When delivery was initially deferred, but has now timed out (in the call
7478 to retry_update() above). We can detect this by testing for
7479 af_retry_timedout. If the address does not have its own errors address,
7480 we arrange to ignore the error.
7482 (2) If delivery failures for bounce messages are being ignored. We can detect
7483 this by testing for af_ignore_error. This will also be set if a bounce
7484 message has been autothawed and the ignore_bounce_errors_after time has
7485 passed. It might also be set if a router was explicitly configured to
7486 ignore errors (errors_to = "").
7488 If neither of these cases obtains, something has gone wrong. Log the
7489 incident, but then ignore the error. */
7491 if (sender_address[0] == 0 && !addr_failed->prop.errors_address)
7493 if ( !testflag(addr_failed, af_retry_timedout)
7494 && !addr_failed->prop.ignore_error)
7495 log_write(0, LOG_MAIN|LOG_PANIC, "internal error: bounce message "
7496 "failure is neither frozen nor ignored (it's been ignored)");
7498 addr_failed->prop.ignore_error = TRUE;
7501 /* If the first address on the list has af_ignore_error set, just remove
7502 it from the list, throw away any saved message file, log it, and
7503 mark the recipient done. */
7505 if ( addr_failed->prop.ignore_error
7506 || addr_failed->dsn_flags & (rf_dsnflags & ~rf_notify_failure)
7510 addr_failed = addr->next;
7511 if (addr->return_filename) Uunlink(addr->return_filename);
7513 #ifndef DISABLE_EVENT
7514 msg_event_raise(US"msg:fail:delivery", addr);
7516 log_write(0, LOG_MAIN, "%s%s%s%s: error ignored",
7518 !addr->parent ? US"" : US" <",
7519 !addr->parent ? US"" : addr->parent->address,
7520 !addr->parent ? US"" : US">");
7522 address_done(addr, logtod);
7523 child_done(addr, logtod);
7524 /* Panic-dies on error */
7525 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
7528 /* Otherwise, handle the sending of a message. Find the error address for
7529 the first address, then send a message that includes all failed addresses
7530 that have the same error address. Note the bounce_recipient is a global so
7531 that it can be accessed by $bounce_recipient while creating a customized
7536 if (!(bounce_recipient = addr_failed->prop.errors_address))
7537 bounce_recipient = sender_address;
7539 /* Make a subprocess to send a message */
7541 if ((pid = child_open_exim(&fd)) < 0)
7542 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Process %d (parent %d) failed to "
7543 "create child process to send failure message: %s", getpid(),
7544 getppid(), strerror(errno));
7546 /* Creation of child succeeded */
7553 uschar *bcc, *emf_text;
7554 FILE * fp = fdopen(fd, "wb");
7556 BOOL to_sender = strcmpic(sender_address, bounce_recipient) == 0;
7557 int max = (bounce_return_size_limit/DELIVER_IN_BUFFER_SIZE + 1) *
7558 DELIVER_IN_BUFFER_SIZE;
7560 uschar *dsnlimitmsg;
7561 uschar *dsnnotifyhdr;
7565 debug_printf("sending error message to: %s\n", bounce_recipient);
7567 /* Scan the addresses for all that have the same errors address, removing
7568 them from the addr_failed chain, and putting them on msgchain. */
7570 paddr = &addr_failed;
7571 for (addr = addr_failed; addr; addr = *paddr)
7572 if (Ustrcmp(bounce_recipient, addr->prop.errors_address
7573 ? addr->prop.errors_address : sender_address) == 0)
7574 { /* The same - dechain */
7575 *paddr = addr->next;
7578 pmsgchain = &(addr->next);
7581 paddr = &addr->next; /* Not the same; skip */
7583 /* Include X-Failed-Recipients: for automatic interpretation, but do
7584 not let any one header line get too long. We do this by starting a
7585 new header every 50 recipients. Omit any addresses for which the
7586 "hide_child" flag is set. */
7588 for (addr = msgchain; addr; addr = addr->next)
7590 if (testflag(addr, af_hide_child)) continue;
7598 ? "X-Failed-Recipients: "
7600 testflag(addr, af_pfr) && addr->parent
7601 ? string_printing(addr->parent->address)
7602 : string_printing(addr->address));
7604 if (rcount > 0) fprintf(fp, "\n");
7606 /* Output the standard headers */
7608 if (errors_reply_to)
7609 fprintf(fp, "Reply-To: %s\n", errors_reply_to);
7610 fprintf(fp, "Auto-Submitted: auto-replied\n");
7611 moan_write_from(fp);
7612 fprintf(fp, "To: %s\n", bounce_recipient);
7614 /* generate boundary string and output MIME-Headers */
7615 bound = string_sprintf(TIME_T_FMT "-eximdsn-%d", time(NULL), rand());
7617 fprintf(fp, "Content-Type: multipart/report;"
7618 " report-type=delivery-status; boundary=%s\n"
7619 "MIME-Version: 1.0\n",
7622 /* Open a template file if one is provided. Log failure to open, but
7623 carry on - default texts will be used. */
7625 if (bounce_message_file)
7626 if (!(emf = Ufopen(bounce_message_file, "rb")))
7627 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to open %s for error "
7628 "message texts: %s", bounce_message_file, strerror(errno));
7630 /* Quietly copy to configured additional addresses if required. */
7632 if ((bcc = moan_check_errorcopy(bounce_recipient)))
7633 fprintf(fp, "Bcc: %s\n", bcc);
7635 /* The texts for the message can be read from a template file; if there
7636 isn't one, or if it is too short, built-in texts are used. The first
7637 emf text is a Subject: and any other headers. */
7639 if ((emf_text = next_emf(emf, US"header")))
7640 fprintf(fp, "%s\n", emf_text);
7642 fprintf(fp, "Subject: Mail delivery failed%s\n\n",
7643 to_sender? ": returning message to sender" : "");
7645 /* output human readable part as text/plain section */
7646 fprintf(fp, "--%s\n"
7647 "Content-type: text/plain; charset=us-ascii\n\n",
7650 if ((emf_text = next_emf(emf, US"intro")))
7651 fprintf(fp, "%s", CS emf_text);
7655 /* This message has been reworded several times. It seems to be confusing to
7656 somebody, however it is worded. I have retreated to the original, simple
7658 "This message was created automatically by mail delivery software.\n");
7660 if (bounce_message_text)
7661 fprintf(fp, "%s", CS bounce_message_text);
7664 "\nA message that you sent could not be delivered to one or more of its\n"
7665 "recipients. This is a permanent error. The following address(es) failed:\n");
7668 "\nA message sent by\n\n <%s>\n\n"
7669 "could not be delivered to one or more of its recipients. The following\n"
7670 "address(es) failed:\n", sender_address);
7674 /* Process the addresses, leaving them on the msgchain if they have a
7675 file name for a return message. (There has already been a check in
7676 post_process_one() for the existence of data in the message file.) A TRUE
7677 return from print_address_information() means that the address is not
7681 for (addr = msgchain; addr; addr = *paddr)
7683 if (print_address_information(addr, fp, US" ", US"\n ", US""))
7684 print_address_error(addr, fp, US"");
7686 /* End the final line for the address */
7690 /* Leave on msgchain if there's a return file. */
7692 if (addr->return_file >= 0)
7694 paddr = &(addr->next);
7698 /* Else save so that we can tick off the recipient when the
7703 *paddr = addr->next;
7704 addr->next = handled_addr;
7705 handled_addr = addr;
7711 /* Get the next text, whether we need it or not, so as to be
7712 positioned for the one after. */
7714 emf_text = next_emf(emf, US"generated text");
7716 /* If there were any file messages passed by the local transports,
7717 include them in the message. Then put the address on the handled chain.
7718 In the case of a batch of addresses that were all sent to the same
7719 transport, the return_file field in all of them will contain the same
7720 fd, and the return_filename field in the *last* one will be set (to the
7721 name of the file). */
7725 address_item *nextaddr;
7728 fprintf(fp, "%s", CS emf_text);
7731 "The following text was generated during the delivery "
7732 "attempt%s:\n", (filecount > 1)? "s" : "");
7734 for (addr = msgchain; addr; addr = nextaddr)
7737 address_item *topaddr = addr;
7739 /* List all the addresses that relate to this file */
7742 while(addr) /* Insurance */
7744 print_address_information(addr, fp, US"------ ", US"\n ",
7746 if (addr->return_filename) break;
7751 /* Now copy the file */
7753 if (!(fm = Ufopen(addr->return_filename, "rb")))
7754 fprintf(fp, " +++ Exim error... failed to open text file: %s\n",
7758 while ((ch = fgetc(fm)) != EOF) fputc(ch, fp);
7761 Uunlink(addr->return_filename);
7763 /* Can now add to handled chain, first fishing off the next
7764 address on the msgchain. */
7766 nextaddr = addr->next;
7767 addr->next = handled_addr;
7768 handled_addr = topaddr;
7773 /* output machine readable part */
7775 if (message_smtputf8)
7776 fprintf(fp, "--%s\n"
7777 "Content-type: message/global-delivery-status\n\n"
7778 "Reporting-MTA: dns; %s\n",
7779 bound, smtp_active_hostname);
7782 fprintf(fp, "--%s\n"
7783 "Content-type: message/delivery-status\n\n"
7784 "Reporting-MTA: dns; %s\n",
7785 bound, smtp_active_hostname);
7789 /* must be decoded from xtext: see RFC 3461:6.3a */
7791 if (auth_xtextdecode(dsn_envid, &xdec_envid) > 0)
7792 fprintf(fp, "Original-Envelope-ID: %s\n", dsn_envid);
7794 fprintf(fp, "X-Original-Envelope-ID: error decoding xtext formatted ENVID\n");
7798 for (addr = handled_addr; addr; addr = addr->next)
7801 fprintf(fp, "Action: failed\n"
7802 "Final-Recipient: rfc822;%s\n"
7805 if ((hu = addr->host_used) && hu->name)
7807 fprintf(fp, "Remote-MTA: dns; %s\n", hu->name);
7808 #ifdef EXPERIMENTAL_DSN_INFO
7813 uschar * p = hu->port == 25
7814 ? US"" : string_sprintf(":%d", hu->port);
7815 fprintf(fp, "Remote-MTA: X-ip; [%s]%s\n", hu->address, p);
7817 if ((s = addr->smtp_greeting) && *s)
7818 fprintf(fp, "X-Remote-MTA-smtp-greeting: X-str; %s\n", s);
7819 if ((s = addr->helo_response) && *s)
7820 fprintf(fp, "X-Remote-MTA-helo-response: X-str; %s\n", s);
7821 if ((s = addr->message) && *s)
7822 fprintf(fp, "X-Exim-Diagnostic: X-str; %s\n", s);
7825 print_dsn_diagnostic_code(addr, fp);
7830 /* Now copy the message, trying to give an intelligible comment if
7831 it is too long for it all to be copied. The limit isn't strictly
7832 applied because of the buffering. There is, however, an option
7833 to suppress copying altogether. */
7835 emf_text = next_emf(emf, US"copy");
7838 we ignore the intro text from template and add
7839 the text for bounce_return_size_limit at the end.
7841 bounce_return_message is ignored
7842 in case RET= is defined we honor these values
7843 otherwise bounce_return_body is honored.
7845 bounce_return_size_limit is always honored.
7848 fprintf(fp, "--%s\n", bound);
7850 dsnlimitmsg = US"X-Exim-DSN-Information: Due to administrative limits only headers are returned";
7851 dsnnotifyhdr = NULL;
7852 topt = topt_add_return_path;
7854 /* RET=HDRS? top priority */
7855 if (dsn_ret == dsn_ret_hdrs)
7856 topt |= topt_no_body;
7859 struct stat statbuf;
7861 /* no full body return at all? */
7862 if (!bounce_return_body)
7864 topt |= topt_no_body;
7865 /* add header if we overrule RET=FULL */
7866 if (dsn_ret == dsn_ret_full)
7867 dsnnotifyhdr = dsnlimitmsg;
7869 /* line length limited... return headers only if oversize */
7870 /* size limited ... return headers only if limit reached */
7871 else if ( max_received_linelength > bounce_return_linesize_limit
7872 || ( bounce_return_size_limit > 0
7873 && fstat(deliver_datafile, &statbuf) == 0
7874 && statbuf.st_size > max
7877 topt |= topt_no_body;
7878 dsnnotifyhdr = dsnlimitmsg;
7883 if (message_smtputf8)
7884 fputs(topt & topt_no_body ? "Content-type: message/global-headers\n\n"
7885 : "Content-type: message/global\n\n",
7889 fputs(topt & topt_no_body ? "Content-type: text/rfc822-headers\n\n"
7890 : "Content-type: message/rfc822\n\n",
7894 transport_filter_argv = NULL; /* Just in case */
7895 return_path = sender_address; /* In case not previously set */
7896 { /* Dummy transport for headers add */
7897 transport_ctx tctx = {{0}};
7898 transport_instance tb = {0};
7900 tctx.u.fd = fileno(fp);
7902 tctx.options = topt;
7903 tb.add_headers = dsnnotifyhdr;
7905 /*XXX no checking for failure! buggy! */
7906 transport_write_message(&tctx, 0);
7910 /* we never add the final text. close the file */
7914 fprintf(fp, "\n--%s--\n", bound);
7916 /* Close the file, which should send an EOF to the child process
7917 that is receiving the message. Wait for it to finish. */
7920 rc = child_close(pid, 0); /* Waits for child to close, no timeout */
7922 /* In the test harness, let the child do it's thing first. */
7924 if (f.running_in_test_harness) millisleep(500);
7926 /* If the process failed, there was some disaster in setting up the
7927 error message. Unless the message is very old, ensure that addr_defer
7928 is non-null, which will have the effect of leaving the message on the
7929 spool. The failed addresses will get tried again next time. However, we
7930 don't really want this to happen too often, so freeze the message unless
7931 there are some genuine deferred addresses to try. To do this we have
7932 to call spool_write_header() here, because with no genuine deferred
7933 addresses the normal code below doesn't get run. */
7938 if (now - received_time.tv_sec < retry_maximum_timeout && !addr_defer)
7940 addr_defer = (address_item *)(+1);
7941 f.deliver_freeze = TRUE;
7942 deliver_frozen_at = time(NULL);
7943 /* Panic-dies on error */
7944 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
7947 deliver_msglog("Process failed (%d) when writing error message "
7948 "to %s%s", rc, bounce_recipient, s);
7949 log_write(0, LOG_MAIN, "Process failed (%d) when writing error message "
7950 "to %s%s", rc, bounce_recipient, s);
7953 /* The message succeeded. Ensure that the recipients that failed are
7954 now marked finished with on the spool and their parents updated. */
7958 for (addr = handled_addr; addr; addr = addr->next)
7960 address_done(addr, logtod);
7961 child_done(addr, logtod);
7963 /* Panic-dies on error */
7964 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
7970 f.disable_logging = FALSE; /* In case left set */
7972 /* Come here from the mua_wrapper case if routing goes wrong */
7976 /* If there are now no deferred addresses, we are done. Preserve the
7977 message log if so configured, and we are using them. Otherwise, sling it.
7978 Then delete the message itself. */
7986 fname = spool_fname(US"msglog", message_subdir, id, US"");
7987 if (preserve_message_logs)
7990 uschar * moname = spool_fname(US"msglog.OLD", US"", id, US"");
7992 if ((rc = Urename(fname, moname)) < 0)
7994 (void)directory_make(spool_directory,
7995 spool_sname(US"msglog.OLD", US""),
7996 MSGLOG_DIRECTORY_MODE, TRUE);
7997 rc = Urename(fname, moname);
8000 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to move %s to the "
8001 "msglog.OLD directory", fname);
8004 if (Uunlink(fname) < 0)
8005 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s",
8006 fname, strerror(errno));
8009 /* Remove the two message files. */
8011 fname = spool_fname(US"input", message_subdir, id, US"-D");
8012 if (Uunlink(fname) < 0)
8013 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s",
8014 fname, strerror(errno));
8015 fname = spool_fname(US"input", message_subdir, id, US"-H");
8016 if (Uunlink(fname) < 0)
8017 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s",
8018 fname, strerror(errno));
8020 /* Log the end of this message, with queue time if requested. */
8022 if (LOGGING(queue_time_overall))
8023 log_write(0, LOG_MAIN, "Completed QT=%s", string_timesince(&received_time));
8025 log_write(0, LOG_MAIN, "Completed");
8027 /* Unset deliver_freeze so that we won't try to move the spool files further down */
8028 f.deliver_freeze = FALSE;
8030 #ifndef DISABLE_EVENT
8031 (void) event_raise(event_action, US"msg:complete", NULL);
8035 /* If there are deferred addresses, we are keeping this message because it is
8036 not yet completed. Lose any temporary files that were catching output from
8037 pipes for any of the deferred addresses, handle one-time aliases, and see if
8038 the message has been on the queue for so long that it is time to send a warning
8039 message to the sender, unless it is a mailer-daemon. If all deferred addresses
8040 have the same domain, we can set deliver_domain for the expansion of
8041 delay_warning_ condition - if any of them are pipes, files, or autoreplies, use
8042 the parent's domain.
8044 If all the deferred addresses have an error number that indicates "retry time
8045 not reached", skip sending the warning message, because it won't contain the
8046 reason for the delay. It will get sent at the next real delivery attempt.
8047 Exception: for retries caused by a remote peer we use the error message
8048 store in the retry DB as the reason.
8049 However, if at least one address has tried, we'd better include all of them in
8052 If we can't make a process to send the message, don't worry.
8054 For mailing list expansions we want to send the warning message to the
8055 mailing list manager. We can't do a perfect job here, as some addresses may
8056 have different errors addresses, but if we take the errors address from
8057 each deferred address it will probably be right in most cases.
8059 If addr_defer == +1, it means there was a problem sending an error message
8060 for failed addresses, and there were no "real" deferred addresses. The value
8061 was set just to keep the message on the spool, so there is nothing to do here.
8064 else if (addr_defer != (address_item *)(+1))
8067 uschar *recipients = US"";
8068 BOOL want_warning_msg = FALSE;
8070 deliver_domain = testflag(addr_defer, af_pfr)
8071 ? addr_defer->parent->domain : addr_defer->domain;
8073 for (addr = addr_defer; addr; addr = addr->next)
8075 address_item *otaddr;
8077 if (addr->basic_errno > ERRNO_WARN_BASE) want_warning_msg = TRUE;
8081 const uschar *d = testflag(addr, af_pfr)
8082 ? addr->parent->domain : addr->domain;
8084 /* The domain may be unset for an address that has never been routed
8085 because the system filter froze the message. */
8087 if (!d || Ustrcmp(d, deliver_domain) != 0)
8088 deliver_domain = NULL;
8091 if (addr->return_filename) Uunlink(addr->return_filename);
8093 /* Handle the case of one-time aliases. If any address in the ancestry
8094 of this one is flagged, ensure it is in the recipients list, suitably
8095 flagged, and that its parent is marked delivered. */
8097 for (otaddr = addr; otaddr; otaddr = otaddr->parent)
8098 if (otaddr->onetime_parent) break;
8103 int t = recipients_count;
8105 for (i = 0; i < recipients_count; i++)
8107 uschar *r = recipients_list[i].address;
8108 if (Ustrcmp(otaddr->onetime_parent, r) == 0) t = i;
8109 if (Ustrcmp(otaddr->address, r) == 0) break;
8112 /* Didn't find the address already in the list, and did find the
8113 ultimate parent's address in the list, and they really are different
8114 (i.e. not from an identity-redirect). After adding the recipient,
8115 update the errors address in the recipients list. */
8117 if ( i >= recipients_count && t < recipients_count
8118 && Ustrcmp(otaddr->address, otaddr->parent->address) != 0)
8120 DEBUG(D_deliver) debug_printf("one_time: adding %s in place of %s\n",
8121 otaddr->address, otaddr->parent->address);
8122 receive_add_recipient(otaddr->address, t);
8123 recipients_list[recipients_count-1].errors_to = otaddr->prop.errors_address;
8124 tree_add_nonrecipient(otaddr->parent->address);
8125 update_spool = TRUE;
8129 /* Except for error messages, ensure that either the errors address for
8130 this deferred address or, if there is none, the sender address, is on the
8131 list of recipients for a warning message. */
8133 if (sender_address[0])
8135 uschar * s = addr->prop.errors_address;
8136 if (!s) s = sender_address;
8137 if (Ustrstr(recipients, s) == NULL)
8138 recipients = string_sprintf("%s%s%s", recipients,
8139 recipients[0] ? "," : "", s);
8143 /* Send a warning message if the conditions are right. If the condition check
8144 fails because of a lookup defer, there is nothing we can do. The warning
8145 is not sent. Another attempt will be made at the next delivery attempt (if
8148 if ( !f.queue_2stage
8150 && ( !(addr_defer->dsn_flags & rf_dsnflags)
8151 || addr_defer->dsn_flags & rf_notify_delay
8153 && delay_warning[1] > 0
8154 && sender_address[0] != 0
8155 && ( !delay_warning_condition
8156 || expand_check_condition(delay_warning_condition,
8157 US"delay_warning", US"option")
8163 int queue_time = time(NULL) - received_time.tv_sec;
8165 /* When running in the test harness, there's an option that allows us to
8166 fudge this time so as to get repeatability of the tests. Take the first
8167 time off the list. In queue runs, the list pointer gets updated in the
8170 if (f.running_in_test_harness && fudged_queue_times[0] != 0)
8172 int qt = readconf_readtime(fudged_queue_times, '/', FALSE);
8175 DEBUG(D_deliver) debug_printf("fudged queue_times = %s\n",
8176 fudged_queue_times);
8181 /* See how many warnings we should have sent by now */
8183 for (count = 0; count < delay_warning[1]; count++)
8184 if (queue_time < delay_warning[count+2]) break;
8186 show_time = delay_warning[count+1];
8188 if (count >= delay_warning[1])
8191 int last_gap = show_time;
8192 if (count > 1) last_gap -= delay_warning[count];
8193 extra = (queue_time - delay_warning[count+1])/last_gap;
8194 show_time += last_gap * extra;
8200 debug_printf("time on queue = %s id %s addr %s\n", readconf_printtime(queue_time), message_id, addr_defer->address);
8201 debug_printf("warning counts: required %d done %d\n", count,
8205 /* We have computed the number of warnings there should have been by now.
8206 If there haven't been enough, send one, and up the count to what it should
8209 if (warning_count < count)
8213 pid_t pid = child_open_exim(&fd);
8219 FILE *f = fdopen(fd, "wb");
8221 transport_ctx tctx = {{0}};
8223 if (warn_message_file)
8224 if (!(wmf = Ufopen(warn_message_file, "rb")))
8225 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to open %s for warning "
8226 "message texts: %s", warn_message_file, strerror(errno));
8228 warnmsg_recipients = recipients;
8229 warnmsg_delay = queue_time < 120*60
8230 ? string_sprintf("%d minutes", show_time/60)
8231 : string_sprintf("%d hours", show_time/3600);
8233 if (errors_reply_to)
8234 fprintf(f, "Reply-To: %s\n", errors_reply_to);
8235 fprintf(f, "Auto-Submitted: auto-replied\n");
8237 fprintf(f, "To: %s\n", recipients);
8239 /* generated boundary string and output MIME-Headers */
8240 bound = string_sprintf(TIME_T_FMT "-eximdsn-%d", time(NULL), rand());
8242 fprintf(f, "Content-Type: multipart/report;"
8243 " report-type=delivery-status; boundary=%s\n"
8244 "MIME-Version: 1.0\n",
8247 if ((wmf_text = next_emf(wmf, US"header")))
8248 fprintf(f, "%s\n", wmf_text);
8250 fprintf(f, "Subject: Warning: message %s delayed %s\n\n",
8251 message_id, warnmsg_delay);
8253 /* output human readable part as text/plain section */
8255 "Content-type: text/plain; charset=us-ascii\n\n",
8258 if ((wmf_text = next_emf(wmf, US"intro")))
8259 fprintf(f, "%s", CS wmf_text);
8263 "This message was created automatically by mail delivery software.\n");
8265 if (Ustrcmp(recipients, sender_address) == 0)
8267 "A message that you sent has not yet been delivered to one or more of its\n"
8268 "recipients after more than ");
8272 "A message sent by\n\n <%s>\n\n"
8273 "has not yet been delivered to one or more of its recipients after more than \n",
8276 fprintf(f, "%s on the queue on %s.\n\n"
8277 "The message identifier is: %s\n",
8278 warnmsg_delay, primary_hostname, message_id);
8280 for (h = header_list; h; h = h->next)
8281 if (strncmpic(h->text, US"Subject:", 8) == 0)
8282 fprintf(f, "The subject of the message is: %s", h->text + 9);
8283 else if (strncmpic(h->text, US"Date:", 5) == 0)
8284 fprintf(f, "The date of the message is: %s", h->text + 6);
8287 fprintf(f, "The address%s to which the message has not yet been "
8289 !addr_defer->next ? "" : "es",
8290 !addr_defer->next ? "is": "are");
8293 /* List the addresses, with error information if allowed */
8295 /* store addr_defer for machine readable part */
8296 address_item *addr_dsndefer = addr_defer;
8300 address_item *addr = addr_defer;
8301 addr_defer = addr->next;
8302 if (print_address_information(addr, f, US" ", US"\n ", US""))
8303 print_address_error(addr, f, US"Delay reason: ");
8312 if ((wmf_text = next_emf(wmf, US"final")))
8313 fprintf(f, "%s", CS wmf_text);
8319 "No action is required on your part. Delivery attempts will continue for\n"
8320 "some time, and this warning may be repeated at intervals if the message\n"
8321 "remains undelivered. Eventually the mail delivery software will give up,\n"
8322 "and when that happens, the message will be returned to you.\n");
8325 /* output machine readable part */
8326 fprintf(f, "\n--%s\n"
8327 "Content-type: message/delivery-status\n\n"
8328 "Reporting-MTA: dns; %s\n",
8330 smtp_active_hostname);
8335 /* must be decoded from xtext: see RFC 3461:6.3a */
8337 if (auth_xtextdecode(dsn_envid, &xdec_envid) > 0)
8338 fprintf(f,"Original-Envelope-ID: %s\n", dsn_envid);
8340 fprintf(f,"X-Original-Envelope-ID: error decoding xtext formatted ENVID\n");
8344 for ( ; addr_dsndefer; addr_dsndefer = addr_dsndefer->next)
8346 if (addr_dsndefer->dsn_orcpt)
8347 fprintf(f, "Original-Recipient: %s\n", addr_dsndefer->dsn_orcpt);
8349 fprintf(f, "Action: delayed\n"
8350 "Final-Recipient: rfc822;%s\n"
8352 addr_dsndefer->address);
8353 if (addr_dsndefer->host_used && addr_dsndefer->host_used->name)
8355 fprintf(f, "Remote-MTA: dns; %s\n",
8356 addr_dsndefer->host_used->name);
8357 print_dsn_diagnostic_code(addr_dsndefer, f);
8363 "Content-type: text/rfc822-headers\n\n",
8367 /* header only as required by RFC. only failure DSN needs to honor RET=FULL */
8368 tctx.u.fd = fileno(f);
8369 tctx.options = topt_add_return_path | topt_no_body;
8370 transport_filter_argv = NULL; /* Just in case */
8371 return_path = sender_address; /* In case not previously set */
8373 /* Write the original email out */
8374 /*XXX no checking for failure! buggy! */
8375 transport_write_message(&tctx, 0);
8378 fprintf(f,"\n--%s--\n", bound);
8382 /* Close and wait for child process to complete, without a timeout.
8383 If there's an error, don't update the count. */
8386 if (child_close(pid, 0) == 0)
8388 warning_count = count;
8389 update_spool = TRUE; /* Ensure spool rewritten */
8395 /* Clear deliver_domain */
8397 deliver_domain = NULL;
8399 /* If this was a first delivery attempt, unset the first time flag, and
8400 ensure that the spool gets updated. */
8402 if (f.deliver_firsttime)
8404 f.deliver_firsttime = FALSE;
8405 update_spool = TRUE;
8408 /* If delivery was frozen and freeze_tell is set, generate an appropriate
8409 message, unless the message is a local error message (to avoid loops). Then
8410 log the freezing. If the text in "frozen_info" came from a system filter,
8411 it has been escaped into printing characters so as not to mess up log lines.
8412 For the "tell" message, we turn \n back into newline. Also, insert a newline
8413 near the start instead of the ": " string. */
8415 if (f.deliver_freeze)
8417 if (freeze_tell && freeze_tell[0] != 0 && !f.local_error_message)
8419 uschar *s = string_copy(frozen_info);
8420 uschar *ss = Ustrstr(s, " by the system filter: ");
8431 if (*ss == '\\' && ss[1] == 'n')
8438 moan_tell_someone(freeze_tell, addr_defer, US"Message frozen",
8439 "Message %s has been frozen%s.\nThe sender is <%s>.\n", message_id,
8443 /* Log freezing just before we update the -H file, to minimize the chance
8444 of a race problem. */
8446 deliver_msglog("*** Frozen%s\n", frozen_info);
8447 log_write(0, LOG_MAIN, "Frozen%s", frozen_info);
8450 /* If there have been any updates to the non-recipients list, or other things
8451 that get written to the spool, we must now update the spool header file so
8452 that it has the right information for the next delivery attempt. If there
8453 was more than one address being delivered, the header_change update is done
8454 earlier, in case one succeeds and then something crashes. */
8457 debug_printf("delivery deferred: update_spool=%d header_rewritten=%d\n",
8458 update_spool, f.header_rewritten);
8460 if (update_spool || f.header_rewritten)
8461 /* Panic-dies on error */
8462 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
8465 /* Finished with the message log. If the message is complete, it will have
8466 been unlinked or renamed above. */
8468 if (message_logs) (void)fclose(message_log);
8470 /* Now we can close and remove the journal file. Its only purpose is to record
8471 successfully completed deliveries asap so that this information doesn't get
8472 lost if Exim (or the machine) crashes. Forgetting about a failed delivery is
8473 not serious, as trying it again is not harmful. The journal might not be open
8474 if all addresses were deferred at routing or directing. Nevertheless, we must
8475 remove it if it exists (may have been lying around from a crash during the
8476 previous delivery attempt). We don't remove the journal if a delivery
8477 subprocess failed to pass back delivery information; this is controlled by
8478 the remove_journal flag. When the journal is left, we also don't move the
8479 message off the main spool if frozen and the option is set. It should get moved
8480 at the next attempt, after the journal has been inspected. */
8482 if (journal_fd >= 0) (void)close(journal_fd);
8486 uschar * fname = spool_fname(US"input", message_subdir, id, US"-J");
8488 if (Uunlink(fname) < 0 && errno != ENOENT)
8489 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s", fname,
8492 /* Move the message off the spool if requested */
8494 #ifdef SUPPORT_MOVE_FROZEN_MESSAGES
8495 if (f.deliver_freeze && move_frozen_messages)
8496 (void)spool_move_message(id, message_subdir, US"", US"F");
8500 /* Closing the data file frees the lock; if the file has been unlinked it
8501 will go away. Otherwise the message becomes available for another process
8504 (void)close(deliver_datafile);
8505 deliver_datafile = -1;
8506 DEBUG(D_deliver) debug_printf("end delivery of %s\n", id);
8508 /* It is unlikely that there will be any cached resources, since they are
8509 released after routing, and in the delivery subprocesses. However, it's
8510 possible for an expansion for something afterwards (for example,
8511 expand_check_condition) to do a lookup. We must therefore be sure everything is
8515 acl_where = ACL_WHERE_UNKNOWN;
8524 #ifdef EXIM_TFO_PROBE
8527 f.tcp_fastopen_ok = TRUE;
8531 if (!regex_PIPELINING) regex_PIPELINING =
8532 regex_must_compile(US"\\n250[\\s\\-]PIPELINING(\\s|\\n|$)", FALSE, TRUE);
8534 if (!regex_SIZE) regex_SIZE =
8535 regex_must_compile(US"\\n250[\\s\\-]SIZE(\\s|\\n|$)", FALSE, TRUE);
8537 if (!regex_AUTH) regex_AUTH =
8538 regex_must_compile(AUTHS_REGEX, FALSE, TRUE);
8541 if (!regex_STARTTLS) regex_STARTTLS =
8542 regex_must_compile(US"\\n250[\\s\\-]STARTTLS(\\s|\\n|$)", FALSE, TRUE);
8544 # ifdef EXPERIMENTAL_REQUIRETLS
8545 if (!regex_REQUIRETLS) regex_REQUIRETLS =
8546 regex_must_compile(US"\\n250[\\s\\-]REQUIRETLS(\\s|\\n|$)", FALSE, TRUE);
8550 if (!regex_CHUNKING) regex_CHUNKING =
8551 regex_must_compile(US"\\n250[\\s\\-]CHUNKING(\\s|\\n|$)", FALSE, TRUE);
8553 #ifndef DISABLE_PRDR
8554 if (!regex_PRDR) regex_PRDR =
8555 regex_must_compile(US"\\n250[\\s\\-]PRDR(\\s|\\n|$)", FALSE, TRUE);
8559 if (!regex_UTF8) regex_UTF8 =
8560 regex_must_compile(US"\\n250[\\s\\-]SMTPUTF8(\\s|\\n|$)", FALSE, TRUE);
8563 if (!regex_DSN) regex_DSN =
8564 regex_must_compile(US"\\n250[\\s\\-]DSN(\\s|\\n|$)", FALSE, TRUE);
8566 if (!regex_IGNOREQUOTA) regex_IGNOREQUOTA =
8567 regex_must_compile(US"\\n250[\\s\\-]IGNOREQUOTA(\\s|\\n|$)", FALSE, TRUE);
8569 #ifdef EXPERIMENTAL_PIPE_CONNECT
8570 if (!regex_EARLY_PIPE) regex_EARLY_PIPE =
8571 regex_must_compile(US"\\n250[\\s\\-]" EARLY_PIPE_FEATURE_NAME "(\\s|\\n|$)", FALSE, TRUE);
8577 deliver_get_sender_address (uschar * id)
8580 uschar * new_sender_address,
8581 * save_sender_address;
8582 BOOL save_qr = f.queue_running;
8585 /* make spool_open_datafile non-noisy on fail */
8587 f.queue_running = TRUE;
8589 /* Side effect: message_subdir is set for the (possibly split) spool directory */
8591 deliver_datafile = spool_open_datafile(id);
8592 f.queue_running = save_qr;
8593 if (deliver_datafile < 0)
8596 /* Save and restore the global sender_address. I'm not sure if we should
8597 not save/restore all the other global variables too, because
8598 spool_read_header() may change all of them. But OTOH, when this
8599 deliver_get_sender_address() gets called, the current message is done
8600 already and nobody needs the globals anymore. (HS12, 2015-08-21) */
8602 spoolname = string_sprintf("%s-H", id);
8603 save_sender_address = sender_address;
8605 rc = spool_read_header(spoolname, TRUE, TRUE);
8607 new_sender_address = sender_address;
8608 sender_address = save_sender_address;
8610 if (rc != spool_read_OK)
8613 assert(new_sender_address);
8615 (void)close(deliver_datafile);
8616 deliver_datafile = -1;
8618 return new_sender_address;
8624 delivery_re_exec(int exec_type)
8628 if (cutthrough.cctx.sock >= 0 && cutthrough.callout_hold_only)
8630 int channel_fd = cutthrough.cctx.sock;
8632 smtp_peer_options = cutthrough.peer_options;
8633 continue_sequence = 0;
8636 if (cutthrough.is_tls)
8640 smtp_peer_options |= OPTION_TLS;
8641 sending_ip_address = cutthrough.snd_ip;
8642 sending_port = cutthrough.snd_port;
8644 where = US"socketpair";
8645 if (socketpair(AF_UNIX, SOCK_STREAM, 0, pfd) != 0)
8649 if ((pid = fork()) < 0)
8652 else if (pid == 0) /* child: fork again to totally disconnect */
8654 if (f.running_in_test_harness) millisleep(100); /* let parent debug out */
8655 /* does not return */
8656 smtp_proxy_tls(cutthrough.cctx.tls_ctx, big_buffer, big_buffer_size,
8660 DEBUG(D_transport) debug_printf("proxy-proc inter-pid %d\n", pid);
8662 waitpid(pid, NULL, 0);
8663 (void) close(channel_fd); /* release the client socket */
8664 channel_fd = pfd[1];
8668 transport_do_pass_socket(cutthrough.transport, cutthrough.host.name,
8669 cutthrough.host.address, message_id, channel_fd);
8673 cancel_cutthrough_connection(TRUE, US"non-continued delivery");
8674 (void) child_exec_exim(exec_type, FALSE, NULL, FALSE, 2, US"-Mc", message_id);
8676 return; /* compiler quietening; control does not reach here. */
8681 LOG_MAIN | (exec_type == CEE_EXEC_EXIT ? LOG_PANIC : LOG_PANIC_DIE),
8682 "delivery re-exec %s failed: %s", where, strerror(errno));
8684 /* Get here if exec_type == CEE_EXEC_EXIT.
8685 Note: this must be _exit(), not exit(). */
8687 _exit(EX_EXECFAILED);
8693 /* End of deliver.c */