1 /*************************************************
2 * Exim - an Internet mail transport agent *
3 *************************************************/
5 /* Copyright (c) University of Cambridge 1995 - 2015 */
6 /* See the file NOTICE for conditions of use and distribution. */
8 /* The main code for delivering a message. */
15 /* Data block for keeping track of subprocesses for parallel remote
18 typedef struct pardata {
19 address_item *addrlist; /* chain of addresses */
20 address_item *addr; /* next address data expected for */
21 pid_t pid; /* subprocess pid */
22 int fd; /* pipe fd for getting result from subprocess */
23 int transport_count; /* returned transport count value */
24 BOOL done; /* no more data needed */
25 uschar *msg; /* error message */
26 uschar *return_path; /* return_path for these addresses */
29 /* Values for the process_recipients variable */
31 enum { RECIP_ACCEPT, RECIP_IGNORE, RECIP_DEFER,
32 RECIP_FAIL, RECIP_FAIL_FILTER, RECIP_FAIL_TIMEOUT,
35 /* Mutually recursive functions for marking addresses done. */
37 static void child_done(address_item *, uschar *);
38 static void address_done(address_item *, uschar *);
40 /* Table for turning base-62 numbers into binary */
42 static uschar tab62[] =
43 {0,1,2,3,4,5,6,7,8,9,0,0,0,0,0,0, /* 0-9 */
44 0,10,11,12,13,14,15,16,17,18,19,20, /* A-K */
45 21,22,23,24,25,26,27,28,29,30,31,32, /* L-W */
46 33,34,35, 0, 0, 0, 0, 0, /* X-Z */
47 0,36,37,38,39,40,41,42,43,44,45,46, /* a-k */
48 47,48,49,50,51,52,53,54,55,56,57,58, /* l-w */
52 /*************************************************
53 * Local static variables *
54 *************************************************/
56 /* addr_duplicate is global because it needs to be seen from the Envelope-To
59 static address_item *addr_defer = NULL;
60 static address_item *addr_failed = NULL;
61 static address_item *addr_fallback = NULL;
62 static address_item *addr_local = NULL;
63 static address_item *addr_new = NULL;
64 static address_item *addr_remote = NULL;
65 static address_item *addr_route = NULL;
66 static address_item *addr_succeed = NULL;
67 static address_item *addr_dsntmp = NULL;
68 static address_item *addr_senddsn = NULL;
70 static FILE *message_log = NULL;
71 static BOOL update_spool;
72 static BOOL remove_journal;
73 static int parcount = 0;
74 static pardata *parlist = NULL;
75 static int return_count;
76 static uschar *frozen_info = US"";
77 static uschar *used_return_path = NULL;
79 static uschar spoolname[PATH_MAX];
83 /*************************************************
84 * Make a new address item *
85 *************************************************/
87 /* This function gets the store and initializes with default values. The
88 transport_return value defaults to DEFER, so that any unexpected failure to
89 deliver does not wipe out the message. The default unique string is set to a
90 copy of the address, so that its domain can be lowercased.
93 address the RFC822 address string
94 copy force a copy of the address
96 Returns: a pointer to an initialized address_item
100 deliver_make_addr(uschar *address, BOOL copy)
102 address_item *addr = store_get(sizeof(address_item));
103 *addr = address_defaults;
104 if (copy) address = string_copy(address);
105 addr->address = address;
106 addr->unique = string_copy(address);
113 /*************************************************
114 * Set expansion values for an address *
115 *************************************************/
117 /* Certain expansion variables are valid only when handling an address or
118 address list. This function sets them up or clears the values, according to its
122 addr the address in question, or NULL to clear values
127 deliver_set_expansions(address_item *addr)
131 const uschar ***p = address_expansions;
132 while (*p) **p++ = NULL;
136 /* Exactly what gets set depends on whether there is one or more addresses, and
137 what they contain. These first ones are always set, taking their values from
138 the first address. */
140 if (!addr->host_list)
142 deliver_host = deliver_host_address = US"";
143 deliver_host_port = 0;
147 deliver_host = addr->host_list->name;
148 deliver_host_address = addr->host_list->address;
149 deliver_host_port = addr->host_list->port;
152 deliver_recipients = addr;
153 deliver_address_data = addr->prop.address_data;
154 deliver_domain_data = addr->prop.domain_data;
155 deliver_localpart_data = addr->prop.localpart_data;
157 /* These may be unset for multiple addresses */
159 deliver_domain = addr->domain;
160 self_hostname = addr->self_hostname;
162 #ifdef EXPERIMENTAL_BRIGHTMAIL
163 bmi_deliver = 1; /* deliver by default */
164 bmi_alt_location = NULL;
165 bmi_base64_verdict = NULL;
166 bmi_base64_tracker_verdict = NULL;
169 /* If there's only one address we can set everything. */
173 address_item *addr_orig;
175 deliver_localpart = addr->local_part;
176 deliver_localpart_prefix = addr->prefix;
177 deliver_localpart_suffix = addr->suffix;
179 for (addr_orig = addr; addr_orig->parent; addr_orig = addr_orig->parent) ;
180 deliver_domain_orig = addr_orig->domain;
182 /* Re-instate any prefix and suffix in the original local part. In all
183 normal cases, the address will have a router associated with it, and we can
184 choose the caseful or caseless version accordingly. However, when a system
185 filter sets up a pipe, file, or autoreply delivery, no router is involved.
186 In this case, though, there won't be any prefix or suffix to worry about. */
188 deliver_localpart_orig = !addr_orig->router
189 ? addr_orig->local_part
190 : addr_orig->router->caseful_local_part
191 ? addr_orig->cc_local_part
192 : addr_orig->lc_local_part;
194 /* If there's a parent, make its domain and local part available, and if
195 delivering to a pipe or file, or sending an autoreply, get the local
196 part from the parent. For pipes and files, put the pipe or file string
197 into address_pipe and address_file. */
201 deliver_domain_parent = addr->parent->domain;
202 deliver_localpart_parent = !addr->parent->router
203 ? addr->parent->local_part
204 : addr->parent->router->caseful_local_part
205 ? addr->parent->cc_local_part
206 : addr->parent->lc_local_part;
208 /* File deliveries have their own flag because they need to be picked out
209 as special more often. */
211 if (testflag(addr, af_pfr))
213 if (testflag(addr, af_file)) address_file = addr->local_part;
214 else if (deliver_localpart[0] == '|') address_pipe = addr->local_part;
215 deliver_localpart = addr->parent->local_part;
216 deliver_localpart_prefix = addr->parent->prefix;
217 deliver_localpart_suffix = addr->parent->suffix;
221 #ifdef EXPERIMENTAL_BRIGHTMAIL
222 /* Set expansion variables related to Brightmail AntiSpam */
223 bmi_base64_verdict = bmi_get_base64_verdict(deliver_localpart_orig, deliver_domain_orig);
224 bmi_base64_tracker_verdict = bmi_get_base64_tracker_verdict(bmi_base64_verdict);
225 /* get message delivery status (0 - don't deliver | 1 - deliver) */
226 bmi_deliver = bmi_get_delivery_status(bmi_base64_verdict);
227 /* if message is to be delivered, get eventual alternate location */
228 if (bmi_deliver == 1)
229 bmi_alt_location = bmi_get_alt_location(bmi_base64_verdict);
234 /* For multiple addresses, don't set local part, and leave the domain and
235 self_hostname set only if it is the same for all of them. It is possible to
236 have multiple pipe and file addresses, but only when all addresses have routed
237 to the same pipe or file. */
242 if (testflag(addr, af_pfr))
244 if (testflag(addr, af_file)) address_file = addr->local_part;
245 else if (addr->local_part[0] == '|') address_pipe = addr->local_part;
247 for (addr2 = addr->next; addr2; addr2 = addr2->next)
249 if (deliver_domain && Ustrcmp(deliver_domain, addr2->domain) != 0)
250 deliver_domain = NULL;
252 && ( !addr2->self_hostname
253 || Ustrcmp(self_hostname, addr2->self_hostname) != 0
255 self_hostname = NULL;
256 if (!deliver_domain && !self_hostname) break;
264 /*************************************************
265 * Open a msglog file *
266 *************************************************/
268 /* This function is used both for normal message logs, and for files in the
269 msglog directory that are used to catch output from pipes. Try to create the
270 directory if it does not exist. From release 4.21, normal message logs should
271 be created when the message is received.
274 filename the file name
275 mode the mode required
276 error used for saying what failed
278 Returns: a file descriptor, or -1 (with errno set)
282 open_msglog_file(uschar *filename, int mode, uschar **error)
284 int fd = Uopen(filename, O_WRONLY|O_APPEND|O_CREAT, mode);
286 if (fd < 0 && errno == ENOENT)
289 sprintf(CS temp, "msglog/%s", message_subdir);
290 if (message_subdir[0] == 0) temp[6] = 0;
291 (void)directory_make(spool_directory, temp, MSGLOG_DIRECTORY_MODE, TRUE);
292 fd = Uopen(filename, O_WRONLY|O_APPEND|O_CREAT, mode);
295 /* Set the close-on-exec flag and change the owner to the exim uid/gid (this
296 function is called as root). Double check the mode, because the group setting
297 doesn't always get set automatically. */
301 (void)fcntl(fd, F_SETFD, fcntl(fd, F_GETFD) | FD_CLOEXEC);
302 if (fchown(fd, exim_uid, exim_gid) < 0)
307 if (fchmod(fd, mode) < 0)
313 else *error = US"create";
321 /*************************************************
322 * Write to msglog if required *
323 *************************************************/
325 /* Write to the message log, if configured. This function may also be called
329 format a string format
335 deliver_msglog(const char *format, ...)
338 if (!message_logs) return;
339 va_start(ap, format);
340 vfprintf(message_log, format, ap);
348 /*************************************************
349 * Replicate status for batch *
350 *************************************************/
352 /* When a transport handles a batch of addresses, it may treat them
353 individually, or it may just put the status in the first one, and return FALSE,
354 requesting that the status be copied to all the others externally. This is the
355 replication function. As well as the status, it copies the transport pointer,
356 which may have changed if appendfile passed the addresses on to a different
359 Argument: pointer to the first address in a chain
364 replicate_status(address_item *addr)
367 for (addr2 = addr->next; addr2; addr2 = addr2->next)
369 addr2->transport = addr->transport;
370 addr2->transport_return = addr->transport_return;
371 addr2->basic_errno = addr->basic_errno;
372 addr2->more_errno = addr->more_errno;
373 addr2->special_action = addr->special_action;
374 addr2->message = addr->message;
375 addr2->user_message = addr->user_message;
381 /*************************************************
382 * Compare lists of hosts *
383 *************************************************/
385 /* This function is given two pointers to chains of host items, and it yields
386 TRUE if the lists refer to the same hosts in the same order, except that
388 (1) Multiple hosts with the same non-negative MX values are permitted to appear
389 in different orders. Round-robinning nameservers can cause this to happen.
391 (2) Multiple hosts with the same negative MX values less than MX_NONE are also
392 permitted to appear in different orders. This is caused by randomizing
395 This enables Exim to use a single SMTP transaction for sending to two entirely
396 different domains that happen to end up pointing at the same hosts.
399 one points to the first host list
400 two points to the second host list
402 Returns: TRUE if the lists refer to the same host set
406 same_hosts(host_item *one, host_item *two)
410 if (Ustrcmp(one->name, two->name) != 0)
413 host_item *end_one = one;
414 host_item *end_two = two;
416 /* Batch up only if there was no MX and the list was not randomized */
418 if (mx == MX_NONE) return FALSE;
420 /* Find the ends of the shortest sequence of identical MX values */
422 while ( end_one->next && end_one->next->mx == mx
423 && end_two->next && end_two->next->mx == mx)
425 end_one = end_one->next;
426 end_two = end_two->next;
429 /* If there aren't any duplicates, there's no match. */
431 if (end_one == one) return FALSE;
433 /* For each host in the 'one' sequence, check that it appears in the 'two'
434 sequence, returning FALSE if not. */
439 for (hi = two; hi != end_two->next; hi = hi->next)
440 if (Ustrcmp(one->name, hi->name) == 0) break;
441 if (hi == end_two->next) return FALSE;
442 if (one == end_one) break;
446 /* All the hosts in the 'one' sequence were found in the 'two' sequence.
447 Ensure both are pointing at the last host, and carry on as for equality. */
458 /* True if both are NULL */
465 /*************************************************
466 * Compare header lines *
467 *************************************************/
469 /* This function is given two pointers to chains of header items, and it yields
470 TRUE if they are the same header texts in the same order.
473 one points to the first header list
474 two points to the second header list
476 Returns: TRUE if the lists refer to the same header set
480 same_headers(header_line *one, header_line *two)
482 for (;; one = one->next, two = two->next)
484 if (one == two) return TRUE; /* Includes the case where both NULL */
485 if (!one || !two) return FALSE;
486 if (Ustrcmp(one->text, two->text) != 0) return FALSE;
492 /*************************************************
493 * Compare string settings *
494 *************************************************/
496 /* This function is given two pointers to strings, and it returns
497 TRUE if they are the same pointer, or if the two strings are the same.
500 one points to the first string
501 two points to the second string
503 Returns: TRUE or FALSE
507 same_strings(uschar *one, uschar *two)
509 if (one == two) return TRUE; /* Includes the case where both NULL */
510 if (!one || !two) return FALSE;
511 return (Ustrcmp(one, two) == 0);
516 /*************************************************
517 * Compare uid/gid for addresses *
518 *************************************************/
520 /* This function is given a transport and two addresses. It yields TRUE if the
521 uid/gid/initgroups settings for the two addresses are going to be the same when
526 addr1 the first address
527 addr2 the second address
529 Returns: TRUE or FALSE
533 same_ugid(transport_instance *tp, address_item *addr1, address_item *addr2)
535 if ( !tp->uid_set && !tp->expand_uid
536 && !tp->deliver_as_creator
537 && ( testflag(addr1, af_uid_set) != testflag(addr2, af_gid_set)
538 || ( testflag(addr1, af_uid_set)
539 && ( addr1->uid != addr2->uid
540 || testflag(addr1, af_initgroups) != testflag(addr2, af_initgroups)
544 if ( !tp->gid_set && !tp->expand_gid
545 && ( testflag(addr1, af_gid_set) != testflag(addr2, af_gid_set)
546 || ( testflag(addr1, af_gid_set)
547 && addr1->gid != addr2->gid
557 /*************************************************
558 * Record that an address is complete *
559 *************************************************/
561 /* This function records that an address is complete. This is straightforward
562 for most addresses, where the unique address is just the full address with the
563 domain lower cased. For homonyms (addresses that are the same as one of their
564 ancestors) their are complications. Their unique addresses have \x\ prepended
565 (where x = 0, 1, 2...), so that de-duplication works correctly for siblings and
568 Exim used to record the unique addresses of homonyms as "complete". This,
569 however, fails when the pattern of redirection varies over time (e.g. if taking
570 unseen copies at only some times of day) because the prepended numbers may vary
571 from one delivery run to the next. This problem is solved by never recording
572 prepended unique addresses as complete. Instead, when a homonymic address has
573 actually been delivered via a transport, we record its basic unique address
574 followed by the name of the transport. This is checked in subsequent delivery
575 runs whenever an address is routed to a transport.
577 If the completed address is a top-level one (has no parent, which means it
578 cannot be homonymic) we also add the original address to the non-recipients
579 tree, so that it gets recorded in the spool file and therefore appears as
580 "done" in any spool listings. The original address may differ from the unique
581 address in the case of the domain.
583 Finally, this function scans the list of duplicates, marks as done any that
584 match this address, and calls child_done() for their ancestors.
587 addr address item that has been completed
588 now current time as a string
594 address_done(address_item *addr, uschar *now)
598 update_spool = TRUE; /* Ensure spool gets updated */
600 /* Top-level address */
604 tree_add_nonrecipient(addr->unique);
605 tree_add_nonrecipient(addr->address);
608 /* Homonymous child address */
610 else if (testflag(addr, af_homonym))
613 tree_add_nonrecipient(
614 string_sprintf("%s/%s", addr->unique + 3, addr->transport->name));
617 /* Non-homonymous child address */
619 else tree_add_nonrecipient(addr->unique);
621 /* Check the list of duplicate addresses and ensure they are now marked
624 for (dup = addr_duplicate; dup; dup = dup->next)
625 if (Ustrcmp(addr->unique, dup->unique) == 0)
627 tree_add_nonrecipient(dup->unique);
628 child_done(dup, now);
635 /*************************************************
636 * Decrease counts in parents and mark done *
637 *************************************************/
639 /* This function is called when an address is complete. If there is a parent
640 address, its count of children is decremented. If there are still other
641 children outstanding, the function exits. Otherwise, if the count has become
642 zero, address_done() is called to mark the parent and its duplicates complete.
643 Then loop for any earlier ancestors.
646 addr points to the completed address item
647 now the current time as a string, for writing to the message log
653 child_done(address_item *addr, uschar *now)
659 if ((addr->child_count -= 1) > 0) return; /* Incomplete parent */
660 address_done(addr, now);
662 /* Log the completion of all descendents only when there is no ancestor with
663 the same original address. */
665 for (aa = addr->parent; aa; aa = aa->parent)
666 if (Ustrcmp(aa->address, addr->address) == 0) break;
669 deliver_msglog("%s %s: children all complete\n", now, addr->address);
670 DEBUG(D_deliver) debug_printf("%s: children all complete\n", addr->address);
676 /*************************************************
677 * Delivery logging support functions *
678 *************************************************/
680 /* The LOGGING() checks in d_log_interface() are complicated for backwards
681 compatibility. When outgoing interface logging was originally added, it was
682 conditional on just incoming_interface (which is off by default). The
683 outgoing_interface option is on by default to preserve this behaviour, but
684 you can enable incoming_interface and disable outgoing_interface to get I=
685 fields on incoming lines only.
688 s The log line buffer
689 sizep Pointer to the buffer size
690 ptrp Pointer to current index into buffer
691 addr The address to be logged
693 Returns: New value for s
697 d_log_interface(uschar *s, int *sizep, int *ptrp)
699 if (LOGGING(incoming_interface) && LOGGING(outgoing_interface)
700 && sending_ip_address)
702 s = string_append(s, sizep, ptrp, 2, US" I=[", sending_ip_address);
703 s = LOGGING(outgoing_port)
704 ? string_append(s, sizep, ptrp, 2, US"]:",
705 string_sprintf("%d", sending_port))
706 : string_cat(s, sizep, ptrp, "]", 1);
714 d_hostlog(uschar *s, int *sizep, int *ptrp, address_item *addr)
716 s = string_append(s, sizep, ptrp, 5, US" H=", addr->host_used->name,
717 US" [", addr->host_used->address, US"]");
718 if (LOGGING(outgoing_port))
719 s = string_append(s, sizep, ptrp, 2, US":", string_sprintf("%d",
720 addr->host_used->port));
721 return d_log_interface(s, sizep, ptrp);
728 d_tlslog(uschar * s, int * sizep, int * ptrp, address_item * addr)
730 if (LOGGING(tls_cipher) && addr->cipher)
731 s = string_append(s, sizep, ptrp, 2, US" X=", addr->cipher);
732 if (LOGGING(tls_certificate_verified) && addr->cipher)
733 s = string_append(s, sizep, ptrp, 2, US" CV=",
734 testflag(addr, af_cert_verified)
736 #ifdef EXPERIMENTAL_DANE
737 testflag(addr, af_dane_verified)
743 if (LOGGING(tls_peerdn) && addr->peerdn)
744 s = string_append(s, sizep, ptrp, 3, US" DN=\"",
745 string_printing(addr->peerdn), US"\"");
753 #ifdef EXPERIMENTAL_EVENT
755 event_raise(uschar * action, const uschar * event, uschar * ev_data)
761 debug_printf("Event(%s): event_action=|%s| delivery_IP=%s\n",
763 action, deliver_host_address);
766 event_data = ev_data;
768 if (!(s = expand_string(action)) && *expand_string_message)
769 log_write(0, LOG_MAIN|LOG_PANIC,
770 "failed to expand event_action %s in %s: %s\n",
771 event, transport_name, expand_string_message);
773 event_name = event_data = NULL;
775 /* If the expansion returns anything but an empty string, flag for
776 the caller to modify his normal processing
781 debug_printf("Event(%s): event_action returned \"%s\"\n", event, s);
789 msg_event_raise(const uschar * event, const address_item * addr)
791 const uschar * save_domain = deliver_domain;
792 uschar * save_local = deliver_localpart;
793 const uschar * save_host = deliver_host;
795 if (!addr->transport)
798 router_name = addr->router ? addr->router->name : NULL;
799 transport_name = addr->transport->name;
800 deliver_domain = addr->domain;
801 deliver_localpart = addr->local_part;
802 deliver_host = addr->host_used ? addr->host_used->name : NULL;
804 (void) event_raise(addr->transport->event_action, event,
805 addr->host_used || Ustrcmp(addr->transport->driver_name, "lmtp") == 0
806 ? addr->message : NULL);
808 deliver_host = save_host;
809 deliver_localpart = save_local;
810 deliver_domain = save_domain;
811 router_name = transport_name = NULL;
813 #endif /*EXPERIMENTAL_EVENT*/
817 /* If msg is NULL this is a delivery log and logchar is used. Otherwise
818 this is a nonstandard call; no two-character delivery flag is written
819 but sender-host and sender are prefixed and "msg" is inserted in the log line.
822 flags passed to log_write()
825 delivery_log(int flags, address_item * addr, int logchar, uschar * msg)
828 int size = 256; /* Used for a temporary, */
829 int ptr = 0; /* expanding buffer, for */
830 uschar *s; /* building log lines; */
831 void *reset_point; /* released afterwards. */
833 /* Log the delivery on the main log. We use an extensible string to build up
834 the log line, and reset the store afterwards. Remote deliveries should always
835 have a pointer to the host item that succeeded; local deliveries can have a
836 pointer to a single host item in their host list, for use by the transport. */
838 #ifdef EXPERIMENTAL_EVENT
839 /* presume no successful remote delivery */
840 lookup_dnssec_authenticated = NULL;
843 s = reset_point = store_get(size);
845 log_address = string_log_address(addr, LOGGING(all_parents), TRUE);
847 s = string_append(s, &size, &ptr, 3, host_and_ident(TRUE), US" ", log_address);
851 s = string_append(s, &size, &ptr, 2, US"> ", log_address);
854 if (LOGGING(sender_on_delivery) || msg)
855 s = string_append(s, &size, &ptr, 3, US" F=<",
856 #ifdef EXPERIMENTAL_INTERNATIONAL
857 testflag(addr, af_utf8_downcvt)
858 ? string_address_utf8_to_alabel(sender_address, NULL)
864 #ifdef EXPERIMENTAL_SRS
865 if(addr->prop.srs_sender)
866 s = string_append(s, &size, &ptr, 3, US" SRS=<", addr->prop.srs_sender, US">");
869 /* You might think that the return path must always be set for a successful
870 delivery; indeed, I did for some time, until this statement crashed. The case
871 when it is not set is for a delivery to /dev/null which is optimised by not
874 if (used_return_path && LOGGING(return_path_on_delivery))
875 s = string_append(s, &size, &ptr, 3, US" P=<", used_return_path, US">");
878 s = string_append(s, &size, &ptr, 2, US" ", msg);
880 /* For a delivery from a system filter, there may not be a router */
882 s = string_append(s, &size, &ptr, 2, US" R=", addr->router->name);
884 s = string_append(s, &size, &ptr, 2, US" T=", addr->transport->name);
886 if (LOGGING(delivery_size))
887 s = string_append(s, &size, &ptr, 2, US" S=",
888 string_sprintf("%d", transport_count));
892 if (addr->transport->info->local)
895 s = string_append(s, &size, &ptr, 2, US" H=", addr->host_list->name);
896 s = d_log_interface(s, &size, &ptr);
897 if (addr->shadow_message)
898 s = string_cat(s, &size, &ptr, addr->shadow_message,
899 Ustrlen(addr->shadow_message));
902 /* Remote delivery */
908 s = d_hostlog(s, &size, &ptr, addr);
909 if (continue_sequence > 1)
910 s = string_cat(s, &size, &ptr, US"*", 1);
912 #ifdef EXPERIMENTAL_EVENT
913 deliver_host_address = addr->host_used->address;
914 deliver_host_port = addr->host_used->port;
915 deliver_host = addr->host_used->name;
917 /* DNS lookup status */
918 lookup_dnssec_authenticated = addr->host_used->dnssec==DS_YES ? US"yes"
919 : addr->host_used->dnssec==DS_NO ? US"no"
925 s = d_tlslog(s, &size, &ptr, addr);
928 if (addr->authenticator)
930 s = string_append(s, &size, &ptr, 2, US" A=", addr->authenticator);
933 s = string_append(s, &size, &ptr, 2, US":", addr->auth_id);
934 if (LOGGING(smtp_mailauth) && addr->auth_sndr)
935 s = string_append(s, &size, &ptr, 2, US":", addr->auth_sndr);
940 if (addr->flags & af_prdr_used)
941 s = string_append(s, &size, &ptr, 1, US" PRDR");
945 /* confirmation message (SMTP (host_used) and LMTP (driver_name)) */
947 if ( LOGGING(smtp_confirmation)
949 && (addr->host_used || Ustrcmp(addr->transport->driver_name, "lmtp") == 0)
953 unsigned lim = big_buffer_size < 1024 ? big_buffer_size : 1024;
954 uschar *p = big_buffer;
955 uschar *ss = addr->message;
957 for (i = 0; i < lim && ss[i] != 0; i++) /* limit logged amount */
959 if (ss[i] == '\"' || ss[i] == '\\') *p++ = '\\'; /* quote \ and " */
964 s = string_append(s, &size, &ptr, 2, US" C=", big_buffer);
967 /* Time on queue and actual time taken to deliver */
969 if (LOGGING(queue_time))
970 s = string_append(s, &size, &ptr, 2, US" QT=",
971 readconf_printtime( (int) ((long)time(NULL) - (long)received_time)) );
973 if (LOGGING(deliver_time))
974 s = string_append(s, &size, &ptr, 2, US" DT=",
975 readconf_printtime(addr->more_errno));
977 /* string_cat() always leaves room for the terminator. Release the
978 store we used to build the line after writing it. */
981 log_write(0, flags, "%s", s);
983 #ifdef EXPERIMENTAL_EVENT
984 if (!msg) msg_event_raise(US"msg:delivery", addr);
987 store_reset(reset_point);
993 /*************************************************
994 * Actions at the end of handling an address *
995 *************************************************/
997 /* This is a function for processing a single address when all that can be done
998 with it has been done.
1001 addr points to the address block
1002 result the result of the delivery attempt
1003 logflags flags for log_write() (LOG_MAIN and/or LOG_PANIC)
1004 driver_type indicates which type of driver (transport, or router) was last
1005 to process the address
1006 logchar '=' or '-' for use when logging deliveries with => or ->
1012 post_process_one(address_item *addr, int result, int logflags, int driver_type,
1015 uschar *now = tod_stamp(tod_log);
1016 uschar *driver_kind = NULL;
1017 uschar *driver_name = NULL;
1018 uschar *log_address;
1020 int size = 256; /* Used for a temporary, */
1021 int ptr = 0; /* expanding buffer, for */
1022 uschar *s; /* building log lines; */
1023 void *reset_point; /* released afterwards. */
1025 DEBUG(D_deliver) debug_printf("post-process %s (%d)\n", addr->address, result);
1027 /* Set up driver kind and name for logging. Disable logging if the router or
1028 transport has disabled it. */
1030 if (driver_type == DTYPE_TRANSPORT)
1032 if (addr->transport)
1034 driver_name = addr->transport->name;
1035 driver_kind = US" transport";
1036 disable_logging = addr->transport->disable_logging;
1038 else driver_kind = US"transporting";
1040 else if (driver_type == DTYPE_ROUTER)
1044 driver_name = addr->router->name;
1045 driver_kind = US" router";
1046 disable_logging = addr->router->disable_logging;
1048 else driver_kind = US"routing";
1051 /* If there's an error message set, ensure that it contains only printing
1052 characters - it should, but occasionally things slip in and this at least
1053 stops the log format from getting wrecked. We also scan the message for an LDAP
1054 expansion item that has a password setting, and flatten the password. This is a
1055 fudge, but I don't know a cleaner way of doing this. (If the item is badly
1056 malformed, it won't ever have gone near LDAP.) */
1060 const uschar * s = string_printing(addr->message);
1061 if (s != addr->message)
1062 addr->message = US s;
1063 /* deconst cast ok as string_printing known to have alloc'n'copied */
1064 if ( ( Ustrstr(s, "failed to expand") != NULL
1065 || Ustrstr(s, "expansion of ") != NULL
1067 && ( Ustrstr(s, "mysql") != NULL
1068 || Ustrstr(s, "pgsql") != NULL
1069 #ifdef EXPERIMENTAL_REDIS
1070 || Ustrstr(s, "redis") != NULL
1072 || Ustrstr(s, "sqlite") != NULL
1073 || Ustrstr(s, "ldap:") != NULL
1074 || Ustrstr(s, "ldapdn:") != NULL
1075 || Ustrstr(s, "ldapm:") != NULL
1077 addr->message = string_sprintf("Temporary internal error");
1080 /* If we used a transport that has one of the "return_output" options set, and
1081 if it did in fact generate some output, then for return_output we treat the
1082 message as failed if it was not already set that way, so that the output gets
1083 returned to the sender, provided there is a sender to send it to. For
1084 return_fail_output, do this only if the delivery failed. Otherwise we just
1085 unlink the file, and remove the name so that if the delivery failed, we don't
1086 try to send back an empty or unwanted file. The log_output options operate only
1087 on a non-empty file.
1089 In any case, we close the message file, because we cannot afford to leave a
1090 file-descriptor for one address while processing (maybe very many) others. */
1092 if (addr->return_file >= 0 && addr->return_filename)
1094 BOOL return_output = FALSE;
1095 struct stat statbuf;
1096 (void)EXIMfsync(addr->return_file);
1098 /* If there is no output, do nothing. */
1100 if (fstat(addr->return_file, &statbuf) == 0 && statbuf.st_size > 0)
1102 transport_instance *tb = addr->transport;
1104 /* Handle logging options */
1107 || result == FAIL && tb->log_fail_output
1108 || result == DEFER && tb->log_defer_output
1112 FILE *f = Ufopen(addr->return_filename, "rb");
1114 log_write(0, LOG_MAIN|LOG_PANIC, "failed to open %s to log output "
1115 "from %s transport: %s", addr->return_filename, tb->name,
1118 if ((s = US Ufgets(big_buffer, big_buffer_size, f)))
1120 uschar *p = big_buffer + Ustrlen(big_buffer);
1122 while (p > big_buffer && isspace(p[-1])) p--;
1124 sp = string_printing(big_buffer);
1125 log_write(0, LOG_MAIN, "<%s>: %s transport output: %s",
1126 addr->address, tb->name, sp);
1131 /* Handle returning options, but only if there is an address to return
1134 if (sender_address[0] != 0 || addr->prop.errors_address)
1135 if (tb->return_output)
1137 addr->transport_return = result = FAIL;
1138 if (addr->basic_errno == 0 && !addr->message)
1139 addr->message = US"return message generated";
1140 return_output = TRUE;
1143 if (tb->return_fail_output && result == FAIL) return_output = TRUE;
1146 /* Get rid of the file unless it might be returned, but close it in
1151 Uunlink(addr->return_filename);
1152 addr->return_filename = NULL;
1153 addr->return_file = -1;
1156 (void)close(addr->return_file);
1159 /* The success case happens only after delivery by a transport. */
1163 addr->next = addr_succeed;
1164 addr_succeed = addr;
1166 /* Call address_done() to ensure that we don't deliver to this address again,
1167 and write appropriate things to the message log. If it is a child address, we
1168 call child_done() to scan the ancestors and mark them complete if this is the
1169 last child to complete. */
1171 address_done(addr, now);
1172 DEBUG(D_deliver) debug_printf("%s delivered\n", addr->address);
1175 deliver_msglog("%s %s: %s%s succeeded\n", now, addr->address,
1176 driver_name, driver_kind);
1179 deliver_msglog("%s %s <%s>: %s%s succeeded\n", now, addr->address,
1180 addr->parent->address, driver_name, driver_kind);
1181 child_done(addr, now);
1184 /* Certificates for logging (via events) */
1186 tls_out.ourcert = addr->ourcert;
1187 addr->ourcert = NULL;
1188 tls_out.peercert = addr->peercert;
1189 addr->peercert = NULL;
1191 tls_out.cipher = addr->cipher;
1192 tls_out.peerdn = addr->peerdn;
1193 tls_out.ocsp = addr->ocsp;
1194 # ifdef EXPERIMENTAL_DANE
1195 tls_out.dane_verified = testflag(addr, af_dane_verified);
1199 delivery_log(LOG_MAIN, addr, logchar, NULL);
1202 tls_free_cert(&tls_out.ourcert);
1203 tls_free_cert(&tls_out.peercert);
1204 tls_out.cipher = NULL;
1205 tls_out.peerdn = NULL;
1206 tls_out.ocsp = OCSP_NOT_REQ;
1207 # ifdef EXPERIMENTAL_DANE
1208 tls_out.dane_verified = FALSE;
1214 /* Soft failure, or local delivery process failed; freezing may be
1217 else if (result == DEFER || result == PANIC)
1219 if (result == PANIC) logflags |= LOG_PANIC;
1221 /* This puts them on the chain in reverse order. Do not change this, because
1222 the code for handling retries assumes that the one with the retry
1223 information is last. */
1225 addr->next = addr_defer;
1228 /* The only currently implemented special action is to freeze the
1229 message. Logging of this is done later, just before the -H file is
1232 if (addr->special_action == SPECIAL_FREEZE)
1234 deliver_freeze = TRUE;
1235 deliver_frozen_at = time(NULL);
1236 update_spool = TRUE;
1239 /* If doing a 2-stage queue run, we skip writing to either the message
1240 log or the main log for SMTP defers. */
1242 if (!queue_2stage || addr->basic_errno != 0)
1246 /* For errors of the type "retry time not reached" (also remotes skipped
1247 on queue run), logging is controlled by L_retry_defer. Note that this kind
1248 of error number is negative, and all the retry ones are less than any
1251 unsigned int use_log_selector = addr->basic_errno <= ERRNO_RETRY_BASE
1252 ? L_retry_defer : 0;
1254 /* Build up the line that is used for both the message log and the main
1257 s = reset_point = store_get(size);
1259 /* Create the address string for logging. Must not do this earlier, because
1260 an OK result may be changed to FAIL when a pipe returns text. */
1262 log_address = string_log_address(addr, LOGGING(all_parents), result == OK);
1264 s = string_cat(s, &size, &ptr, log_address, Ustrlen(log_address));
1266 /* Either driver_name contains something and driver_kind contains
1267 " router" or " transport" (note the leading space), or driver_name is
1268 a null string and driver_kind contains "routing" without the leading
1269 space, if all routing has been deferred. When a domain has been held,
1270 so nothing has been done at all, both variables contain null strings. */
1274 if (driver_kind[1] == 't' && addr->router)
1275 s = string_append(s, &size, &ptr, 2, US" R=", addr->router->name);
1277 ss[1] = toupper(driver_kind[1]);
1278 s = string_append(s, &size, &ptr, 2, ss, driver_name);
1280 else if (driver_kind)
1281 s = string_append(s, &size, &ptr, 2, US" ", driver_kind);
1283 sprintf(CS ss, " defer (%d)", addr->basic_errno);
1284 s = string_cat(s, &size, &ptr, ss, Ustrlen(ss));
1286 if (addr->basic_errno > 0)
1287 s = string_append(s, &size, &ptr, 2, US": ",
1288 US strerror(addr->basic_errno));
1290 if (addr->host_used)
1292 s = string_append(s, &size, &ptr, 5,
1293 US" H=", addr->host_used->name,
1294 US" [", addr->host_used->address, US"]");
1295 if (LOGGING(outgoing_port))
1297 int port = addr->host_used->port;
1298 s = string_append(s, &size, &ptr, 2,
1299 US":", port == PORT_NONE ? US"25" : string_sprintf("%d", port));
1304 s = string_append(s, &size, &ptr, 2, US": ", addr->message);
1308 /* Log the deferment in the message log, but don't clutter it
1309 up with retry-time defers after the first delivery attempt. */
1311 if (deliver_firsttime || addr->basic_errno > ERRNO_RETRY_BASE)
1312 deliver_msglog("%s %s\n", now, s);
1314 /* Write the main log and reset the store */
1316 log_write(use_log_selector, logflags, "== %s", s);
1317 store_reset(reset_point);
1322 /* Hard failure. If there is an address to which an error message can be sent,
1323 put this address on the failed list. If not, put it on the deferred list and
1324 freeze the mail message for human attention. The latter action can also be
1325 explicitly requested by a router or transport. */
1329 /* If this is a delivery error, or a message for which no replies are
1330 wanted, and the message's age is greater than ignore_bounce_errors_after,
1331 force the af_ignore_error flag. This will cause the address to be discarded
1332 later (with a log entry). */
1334 if (sender_address[0] == 0 && message_age >= ignore_bounce_errors_after)
1335 setflag(addr, af_ignore_error);
1337 /* Freeze the message if requested, or if this is a bounce message (or other
1338 message with null sender) and this address does not have its own errors
1339 address. However, don't freeze if errors are being ignored. The actual code
1340 to ignore occurs later, instead of sending a message. Logging of freezing
1341 occurs later, just before writing the -H file. */
1343 if ( !testflag(addr, af_ignore_error)
1344 && ( addr->special_action == SPECIAL_FREEZE
1345 || (sender_address[0] == 0 && !addr->prop.errors_address)
1348 frozen_info = addr->special_action == SPECIAL_FREEZE
1350 : sender_local && !local_error_message
1351 ? US" (message created with -f <>)"
1352 : US" (delivery error message)";
1353 deliver_freeze = TRUE;
1354 deliver_frozen_at = time(NULL);
1355 update_spool = TRUE;
1357 /* The address is put on the defer rather than the failed queue, because
1358 the message is being retained. */
1360 addr->next = addr_defer;
1364 /* Don't put the address on the nonrecipients tree yet; wait until an
1365 error message has been successfully sent. */
1369 addr->next = addr_failed;
1373 /* Build up the log line for the message and main logs */
1375 s = reset_point = store_get(size);
1377 /* Create the address string for logging. Must not do this earlier, because
1378 an OK result may be changed to FAIL when a pipe returns text. */
1380 log_address = string_log_address(addr, LOGGING(all_parents), result == OK);
1382 s = string_cat(s, &size, &ptr, log_address, Ustrlen(log_address));
1384 if (LOGGING(sender_on_delivery))
1385 s = string_append(s, &size, &ptr, 3, US" F=<", sender_address, US">");
1387 /* Return path may not be set if no delivery actually happened */
1389 if (used_return_path && LOGGING(return_path_on_delivery))
1390 s = string_append(s, &size, &ptr, 3, US" P=<", used_return_path, US">");
1393 s = string_append(s, &size, &ptr, 2, US" R=", addr->router->name);
1394 if (addr->transport)
1395 s = string_append(s, &size, &ptr, 2, US" T=", addr->transport->name);
1397 if (addr->host_used)
1398 s = d_hostlog(s, &size, &ptr, addr);
1401 s = d_tlslog(s, &size, &ptr, addr);
1404 if (addr->basic_errno > 0)
1405 s = string_append(s, &size, &ptr, 2, US": ",
1406 US strerror(addr->basic_errno));
1409 s = string_append(s, &size, &ptr, 2, US": ", addr->message);
1413 /* Do the logging. For the message log, "routing failed" for those cases,
1414 just to make it clearer. */
1417 deliver_msglog("%s %s\n", now, s);
1419 deliver_msglog("%s %s failed for %s\n", now, driver_kind, s);
1421 log_write(0, LOG_MAIN, "** %s", s);
1423 #ifdef EXPERIMENTAL_EVENT
1424 msg_event_raise(US"msg:fail:delivery", addr);
1427 store_reset(reset_point);
1430 /* Ensure logging is turned on again in all cases */
1432 disable_logging = FALSE;
1438 /*************************************************
1439 * Address-independent error *
1440 *************************************************/
1442 /* This function is called when there's an error that is not dependent on a
1443 particular address, such as an expansion string failure. It puts the error into
1444 all the addresses in a batch, logs the incident on the main and panic logs, and
1445 clears the expansions. It is mostly called from local_deliver(), but can be
1446 called for a remote delivery via findugid().
1449 logit TRUE if (MAIN+PANIC) logging required
1450 addr the first of the chain of addresses
1452 format format string for error message, or NULL if already set in addr
1453 ... arguments for the format
1459 common_error(BOOL logit, address_item *addr, int code, uschar *format, ...)
1461 address_item *addr2;
1462 addr->basic_errno = code;
1468 va_start(ap, format);
1469 if (!string_vformat(buffer, sizeof(buffer), CS format, ap))
1470 log_write(0, LOG_MAIN|LOG_PANIC_DIE,
1471 "common_error expansion was longer than " SIZE_T_FMT, sizeof(buffer));
1473 addr->message = string_copy(buffer);
1476 for (addr2 = addr->next; addr2; addr2 = addr2->next)
1478 addr2->basic_errno = code;
1479 addr2->message = addr->message;
1482 if (logit) log_write(0, LOG_MAIN|LOG_PANIC, "%s", addr->message);
1483 deliver_set_expansions(NULL);
1489 /*************************************************
1490 * Check a "never users" list *
1491 *************************************************/
1493 /* This function is called to check whether a uid is on one of the two "never
1497 uid the uid to be checked
1498 nusers the list to be scanned; the first item in the list is the count
1500 Returns: TRUE if the uid is on the list
1504 check_never_users(uid_t uid, uid_t *nusers)
1507 if (!nusers) return FALSE;
1508 for (i = 1; i <= (int)(nusers[0]); i++) if (nusers[i] == uid) return TRUE;
1514 /*************************************************
1515 * Find uid and gid for a transport *
1516 *************************************************/
1518 /* This function is called for both local and remote deliveries, to find the
1519 uid/gid under which to run the delivery. The values are taken preferentially
1520 from the transport (either explicit or deliver_as_creator), then from the
1521 address (i.e. the router), and if nothing is set, the exim uid/gid are used. If
1522 the resulting uid is on the "never_users" or the "fixed_never_users" list, a
1523 panic error is logged, and the function fails (which normally leads to delivery
1527 addr the address (possibly a chain)
1529 uidp pointer to uid field
1530 gidp pointer to gid field
1531 igfp pointer to the use_initgroups field
1533 Returns: FALSE if failed - error has been set in address(es)
1537 findugid(address_item *addr, transport_instance *tp, uid_t *uidp, gid_t *gidp,
1541 BOOL gid_set = FALSE;
1543 /* Default initgroups flag comes from the transport */
1545 *igfp = tp->initgroups;
1547 /* First see if there's a gid on the transport, either fixed or expandable.
1548 The expanding function always logs failure itself. */
1555 else if (tp->expand_gid)
1557 if (!route_find_expanded_group(tp->expand_gid, tp->name, US"transport", gidp,
1560 common_error(FALSE, addr, ERRNO_GIDFAIL, NULL);
1566 /* If the transport did not set a group, see if the router did. */
1568 if (!gid_set && testflag(addr, af_gid_set))
1574 /* Pick up a uid from the transport if one is set. */
1576 if (tp->uid_set) *uidp = tp->uid;
1578 /* Otherwise, try for an expandable uid field. If it ends up as a numeric id,
1579 it does not provide a passwd value from which a gid can be taken. */
1581 else if (tp->expand_uid)
1584 if (!route_find_expanded_user(tp->expand_uid, tp->name, US"transport", &pw,
1585 uidp, &(addr->message)))
1587 common_error(FALSE, addr, ERRNO_UIDFAIL, NULL);
1597 /* If the transport doesn't set the uid, test the deliver_as_creator flag. */
1599 else if (tp->deliver_as_creator)
1601 *uidp = originator_uid;
1604 *gidp = originator_gid;
1609 /* Otherwise see if the address specifies the uid and if so, take it and its
1612 else if (testflag(addr, af_uid_set))
1615 *igfp = testflag(addr, af_initgroups);
1618 /* Nothing has specified the uid - default to the Exim user, and group if the
1631 /* If no gid is set, it is a disaster. We default to the Exim gid only if
1632 defaulting to the Exim uid. In other words, if the configuration has specified
1633 a uid, it must also provide a gid. */
1637 common_error(TRUE, addr, ERRNO_GIDFAIL, US"User set without group for "
1638 "%s transport", tp->name);
1642 /* Check that the uid is not on the lists of banned uids that may not be used
1643 for delivery processes. */
1645 nuname = check_never_users(*uidp, never_users)
1647 : check_never_users(*uidp, fixed_never_users)
1648 ? US"fixed_never_users"
1652 common_error(TRUE, addr, ERRNO_UIDFAIL, US"User %ld set for %s transport "
1653 "is on the %s list", (long int)(*uidp), tp->name, nuname);
1665 /*************************************************
1666 * Check the size of a message for a transport *
1667 *************************************************/
1669 /* Checks that the message isn't too big for the selected transport.
1670 This is called only when it is known that the limit is set.
1674 addr the (first) address being delivered
1677 DEFER expansion failed or did not yield an integer
1678 FAIL message too big
1682 check_message_size(transport_instance *tp, address_item *addr)
1687 deliver_set_expansions(addr);
1688 size_limit = expand_string_integer(tp->message_size_limit, TRUE);
1689 deliver_set_expansions(NULL);
1691 if (expand_string_message)
1694 addr->message = size_limit == -1
1695 ? string_sprintf("failed to expand message_size_limit "
1696 "in %s transport: %s", tp->name, expand_string_message)
1697 : string_sprintf("invalid message_size_limit "
1698 "in %s transport: %s", tp->name, expand_string_message);
1700 else if (size_limit > 0 && message_size > size_limit)
1704 string_sprintf("message is too big (transport limit = %d)",
1713 /*************************************************
1714 * Transport-time check for a previous delivery *
1715 *************************************************/
1717 /* Check that this base address hasn't previously been delivered to its routed
1718 transport. If it has been delivered, mark it done. The check is necessary at
1719 delivery time in order to handle homonymic addresses correctly in cases where
1720 the pattern of redirection changes between delivery attempts (so the unique
1721 fields change). Non-homonymic previous delivery is detected earlier, at routing
1722 time (which saves unnecessary routing).
1725 addr the address item
1726 testing TRUE if testing wanted only, without side effects
1728 Returns: TRUE if previously delivered by the transport
1732 previously_transported(address_item *addr, BOOL testing)
1734 (void)string_format(big_buffer, big_buffer_size, "%s/%s",
1735 addr->unique + (testflag(addr, af_homonym)? 3:0), addr->transport->name);
1737 if (tree_search(tree_nonrecipients, big_buffer) != 0)
1739 DEBUG(D_deliver|D_route|D_transport)
1740 debug_printf("%s was previously delivered (%s transport): discarded\n",
1741 addr->address, addr->transport->name);
1742 if (!testing) child_done(addr, tod_stamp(tod_log));
1751 /******************************************************
1752 * Check for a given header in a header string *
1753 ******************************************************/
1755 /* This function is used when generating quota warnings. The configuration may
1756 specify any header lines it likes in quota_warn_message. If certain of them are
1757 missing, defaults are inserted, so we need to be able to test for the presence
1761 hdr the required header name
1762 hstring the header string
1764 Returns: TRUE the header is in the string
1765 FALSE the header is not in the string
1769 contains_header(uschar *hdr, uschar *hstring)
1771 int len = Ustrlen(hdr);
1772 uschar *p = hstring;
1775 if (strncmpic(p, hdr, len) == 0)
1778 while (*p == ' ' || *p == '\t') p++;
1779 if (*p == ':') return TRUE;
1781 while (*p != 0 && *p != '\n') p++;
1782 if (*p == '\n') p++;
1790 /*************************************************
1791 * Perform a local delivery *
1792 *************************************************/
1794 /* Each local delivery is performed in a separate process which sets its
1795 uid and gid as specified. This is a safer way than simply changing and
1796 restoring using seteuid(); there is a body of opinion that seteuid() cannot be
1797 used safely. From release 4, Exim no longer makes any use of it. Besides, not
1798 all systems have seteuid().
1800 If the uid/gid are specified in the transport_instance, they are used; the
1801 transport initialization must ensure that either both or neither are set.
1802 Otherwise, the values associated with the address are used. If neither are set,
1803 it is a configuration error.
1805 The transport or the address may specify a home directory (transport over-
1806 rides), and if they do, this is set as $home. If neither have set a working
1807 directory, this value is used for that as well. Otherwise $home is left unset
1808 and the cwd is set to "/" - a directory that should be accessible to all users.
1810 Using a separate process makes it more complicated to get error information
1811 back. We use a pipe to pass the return code and also an error code and error
1812 text string back to the parent process.
1815 addr points to an address block for this delivery; for "normal" local
1816 deliveries this is the only address to be delivered, but for
1817 pseudo-remote deliveries (e.g. by batch SMTP to a file or pipe)
1818 a number of addresses can be handled simultaneously, and in this
1819 case addr will point to a chain of addresses with the same
1822 shadowing TRUE if running a shadow transport; this causes output from pipes
1829 deliver_local(address_item *addr, BOOL shadowing)
1831 BOOL use_initgroups;
1834 int status, len, rc;
1837 uschar *working_directory;
1838 address_item *addr2;
1839 transport_instance *tp = addr->transport;
1841 /* Set up the return path from the errors or sender address. If the transport
1842 has its own return path setting, expand it and replace the existing value. */
1844 if(addr->prop.errors_address)
1845 return_path = addr->prop.errors_address;
1846 #ifdef EXPERIMENTAL_SRS
1847 else if (addr->prop.srs_sender)
1848 return_path = addr->prop.srs_sender;
1851 return_path = sender_address;
1853 if (tp->return_path)
1855 uschar *new_return_path = expand_string(tp->return_path);
1856 if (!new_return_path)
1858 if (!expand_string_forcedfail)
1860 common_error(TRUE, addr, ERRNO_EXPANDFAIL,
1861 US"Failed to expand return path \"%s\" in %s transport: %s",
1862 tp->return_path, tp->name, expand_string_message);
1866 else return_path = new_return_path;
1869 /* For local deliveries, one at a time, the value used for logging can just be
1870 set directly, once and for all. */
1872 used_return_path = return_path;
1874 /* Sort out the uid, gid, and initgroups flag. If an error occurs, the message
1875 gets put into the address(es), and the expansions are unset, so we can just
1878 if (!findugid(addr, tp, &uid, &gid, &use_initgroups)) return;
1880 /* See if either the transport or the address specifies a home directory. A
1881 home directory set in the address may already be expanded; a flag is set to
1882 indicate that. In other cases we must expand it. */
1884 if ( (deliver_home = tp->home_dir) /* Set in transport, or */
1885 || ( (deliver_home = addr->home_dir) /* Set in address and */
1886 && !testflag(addr, af_home_expanded) /* not expanded */
1889 uschar *rawhome = deliver_home;
1890 deliver_home = NULL; /* in case it contains $home */
1891 if (!(deliver_home = expand_string(rawhome)))
1893 common_error(TRUE, addr, ERRNO_EXPANDFAIL, US"home directory \"%s\" failed "
1894 "to expand for %s transport: %s", rawhome, tp->name,
1895 expand_string_message);
1898 if (*deliver_home != '/')
1900 common_error(TRUE, addr, ERRNO_NOTABSOLUTE, US"home directory path \"%s\" "
1901 "is not absolute for %s transport", deliver_home, tp->name);
1906 /* See if either the transport or the address specifies a current directory,
1907 and if so, expand it. If nothing is set, use the home directory, unless it is
1908 also unset in which case use "/", which is assumed to be a directory to which
1909 all users have access. It is necessary to be in a visible directory for some
1910 operating systems when running pipes, as some commands (e.g. "rm" under Solaris
1911 2.5) require this. */
1913 working_directory = tp->current_dir ? tp->current_dir : addr->current_dir;
1914 if (working_directory)
1916 uschar *raw = working_directory;
1917 if (!(working_directory = expand_string(raw)))
1919 common_error(TRUE, addr, ERRNO_EXPANDFAIL, US"current directory \"%s\" "
1920 "failed to expand for %s transport: %s", raw, tp->name,
1921 expand_string_message);
1924 if (*working_directory != '/')
1926 common_error(TRUE, addr, ERRNO_NOTABSOLUTE, US"current directory path "
1927 "\"%s\" is not absolute for %s transport", working_directory, tp->name);
1931 else working_directory = deliver_home ? deliver_home : US"/";
1933 /* If one of the return_output flags is set on the transport, create and open a
1934 file in the message log directory for the transport to write its output onto.
1935 This is mainly used by pipe transports. The file needs to be unique to the
1936 address. This feature is not available for shadow transports. */
1939 && ( tp->return_output || tp->return_fail_output
1940 || tp->log_output || tp->log_fail_output || tp->log_defer_output
1944 addr->return_filename =
1945 string_sprintf("%s/msglog/%s/%s-%d-%d", spool_directory, message_subdir,
1946 message_id, getpid(), return_count++);
1947 addr->return_file = open_msglog_file(addr->return_filename, 0400, &error);
1948 if (addr->return_file < 0)
1950 common_error(TRUE, addr, errno, US"Unable to %s file for %s transport "
1951 "to return message: %s", error, tp->name, strerror(errno));
1956 /* Create the pipe for inter-process communication. */
1960 common_error(TRUE, addr, ERRNO_PIPEFAIL, US"Creation of pipe failed: %s",
1965 /* Now fork the process to do the real work in the subprocess, but first
1966 ensure that all cached resources are freed so that the subprocess starts with
1967 a clean slate and doesn't interfere with the parent process. */
1971 if ((pid = fork()) == 0)
1973 BOOL replicate = TRUE;
1975 /* Prevent core dumps, as we don't want them in users' home directories.
1976 HP-UX doesn't have RLIMIT_CORE; I don't know how to do this in that
1977 system. Some experimental/developing systems (e.g. GNU/Hurd) may define
1978 RLIMIT_CORE but not support it in setrlimit(). For such systems, do not
1979 complain if the error is "not supported".
1981 There are two scenarios where changing the max limit has an effect. In one,
1982 the user is using a .forward and invoking a command of their choice via pipe;
1983 for these, we do need the max limit to be 0 unless the admin chooses to
1984 permit an increased limit. In the other, the command is invoked directly by
1985 the transport and is under administrator control, thus being able to raise
1986 the limit aids in debugging. So there's no general always-right answer.
1988 Thus we inhibit core-dumps completely but let individual transports, while
1989 still root, re-raise the limits back up to aid debugging. We make the
1990 default be no core-dumps -- few enough people can use core dumps in
1991 diagnosis that it's reasonable to make them something that has to be explicitly requested.
1998 if (setrlimit(RLIMIT_CORE, &rl) < 0)
2000 # ifdef SETRLIMIT_NOT_SUPPORTED
2001 if (errno != ENOSYS && errno != ENOTSUP)
2003 log_write(0, LOG_MAIN|LOG_PANIC, "setrlimit(RLIMIT_CORE) failed: %s",
2008 /* Reset the random number generator, so different processes don't all
2009 have the same sequence. */
2013 /* If the transport has a setup entry, call this first, while still
2014 privileged. (Appendfile uses this to expand quota, for example, while
2015 able to read private files.) */
2017 if (addr->transport->setup)
2018 switch((addr->transport->setup)(addr->transport, addr, NULL, uid, gid,
2022 addr->transport_return = DEFER;
2026 addr->transport_return = PANIC;
2030 /* Ignore SIGINT and SIGTERM during delivery. Also ignore SIGUSR1, as
2031 when the process becomes unprivileged, it won't be able to write to the
2032 process log. SIGHUP is ignored throughout exim, except when it is being
2035 signal(SIGINT, SIG_IGN);
2036 signal(SIGTERM, SIG_IGN);
2037 signal(SIGUSR1, SIG_IGN);
2039 /* Close the unwanted half of the pipe, and set close-on-exec for the other
2040 half - for transports that exec things (e.g. pipe). Then set the required
2043 (void)close(pfd[pipe_read]);
2044 (void)fcntl(pfd[pipe_write], F_SETFD, fcntl(pfd[pipe_write], F_GETFD) |
2046 exim_setugid(uid, gid, use_initgroups,
2047 string_sprintf("local delivery to %s <%s> transport=%s", addr->local_part,
2048 addr->address, addr->transport->name));
2052 address_item *batched;
2053 debug_printf(" home=%s current=%s\n", deliver_home, working_directory);
2054 for (batched = addr->next; batched; batched = batched->next)
2055 debug_printf("additional batched address: %s\n", batched->address);
2058 /* Set an appropriate working directory. */
2060 if (Uchdir(working_directory) < 0)
2062 addr->transport_return = DEFER;
2063 addr->basic_errno = errno;
2064 addr->message = string_sprintf("failed to chdir to %s", working_directory);
2067 /* If successful, call the transport */
2072 set_process_info("delivering %s to %s using %s", message_id,
2073 addr->local_part, addr->transport->name);
2075 /* Setting this global in the subprocess means we need never clear it */
2076 transport_name = addr->transport->name;
2078 /* If a transport filter has been specified, set up its argument list.
2079 Any errors will get put into the address, and FALSE yielded. */
2081 if (addr->transport->filter_command)
2083 ok = transport_set_up_command(&transport_filter_argv,
2084 addr->transport->filter_command,
2085 TRUE, PANIC, addr, US"transport filter", NULL);
2086 transport_filter_timeout = addr->transport->filter_timeout;
2088 else transport_filter_argv = NULL;
2092 debug_print_string(addr->transport->debug_string);
2093 replicate = !(addr->transport->info->code)(addr->transport, addr);
2097 /* Pass the results back down the pipe. If necessary, first replicate the
2098 status in the top address to the others in the batch. The label is the
2099 subject of a goto when a call to the transport's setup function fails. We
2100 pass the pointer to the transport back in case it got changed as a result of
2101 file_format in appendfile. */
2105 if (replicate) replicate_status(addr);
2106 for (addr2 = addr; addr2; addr2 = addr2->next)
2109 int local_part_length = Ustrlen(addr2->local_part);
2113 if( (ret = write(pfd[pipe_write], &addr2->transport_return, sizeof(int))) != sizeof(int)
2114 || (ret = write(pfd[pipe_write], &transport_count, sizeof(transport_count))) != sizeof(transport_count)
2115 || (ret = write(pfd[pipe_write], &addr2->flags, sizeof(addr2->flags))) != sizeof(addr2->flags)
2116 || (ret = write(pfd[pipe_write], &addr2->basic_errno, sizeof(int))) != sizeof(int)
2117 || (ret = write(pfd[pipe_write], &addr2->more_errno, sizeof(int))) != sizeof(int)
2118 || (ret = write(pfd[pipe_write], &addr2->special_action, sizeof(int))) != sizeof(int)
2119 || (ret = write(pfd[pipe_write], &addr2->transport,
2120 sizeof(transport_instance *))) != sizeof(transport_instance *)
2122 /* For a file delivery, pass back the local part, in case the original
2123 was only part of the final delivery path. This gives more complete
2126 || (testflag(addr2, af_file)
2127 && ( (ret = write(pfd[pipe_write], &local_part_length, sizeof(int))) != sizeof(int)
2128 || (ret = write(pfd[pipe_write], addr2->local_part, local_part_length)) != local_part_length
2132 log_write(0, LOG_MAIN|LOG_PANIC, "Failed writing transport results to pipe: %s\n",
2133 ret == -1 ? strerror(errno) : "short write");
2135 /* Now any messages */
2137 for (i = 0, s = addr2->message; i < 2; i++, s = addr2->user_message)
2139 int message_length = s ? Ustrlen(s) + 1 : 0;
2140 if( (ret = write(pfd[pipe_write], &message_length, sizeof(int))) != sizeof(int)
2141 || message_length > 0 && (ret = write(pfd[pipe_write], s, message_length)) != message_length
2143 log_write(0, LOG_MAIN|LOG_PANIC, "Failed writing transport results to pipe: %s\n",
2144 ret == -1 ? strerror(errno) : "short write");
2148 /* OK, this process is now done. Free any cached resources that it opened,
2149 and close the pipe we were writing down before exiting. */
2151 (void)close(pfd[pipe_write]);
2156 /* Back in the main process: panic if the fork did not succeed. This seems
2157 better than returning an error - if forking is failing it is probably best
2158 not to try other deliveries for this message. */
2161 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Fork failed for local delivery to %s",
2164 /* Read the pipe to get the delivery status codes and error messages. Our copy
2165 of the writing end must be closed first, as otherwise read() won't return zero
2166 on an empty pipe. We check that a status exists for each address before
2167 overwriting the address structure. If data is missing, the default DEFER status
2168 will remain. Afterwards, close the reading end. */
2170 (void)close(pfd[pipe_write]);
2172 for (addr2 = addr; addr2; addr2 = addr2->next)
2174 len = read(pfd[pipe_read], &status, sizeof(int));
2180 addr2->transport_return = status;
2181 len = read(pfd[pipe_read], &transport_count,
2182 sizeof(transport_count));
2183 len = read(pfd[pipe_read], &addr2->flags, sizeof(addr2->flags));
2184 len = read(pfd[pipe_read], &addr2->basic_errno, sizeof(int));
2185 len = read(pfd[pipe_read], &addr2->more_errno, sizeof(int));
2186 len = read(pfd[pipe_read], &addr2->special_action, sizeof(int));
2187 len = read(pfd[pipe_read], &addr2->transport,
2188 sizeof(transport_instance *));
2190 if (testflag(addr2, af_file))
2192 int local_part_length;
2193 len = read(pfd[pipe_read], &local_part_length, sizeof(int));
2194 len = read(pfd[pipe_read], big_buffer, local_part_length);
2195 big_buffer[local_part_length] = 0;
2196 addr2->local_part = string_copy(big_buffer);
2199 for (i = 0, sptr = &addr2->message; i < 2; i++, sptr = &addr2->user_message)
2202 len = read(pfd[pipe_read], &message_length, sizeof(int));
2203 if (message_length > 0)
2205 len = read(pfd[pipe_read], big_buffer, message_length);
2206 if (len > 0) *sptr = string_copy(big_buffer);
2213 log_write(0, LOG_MAIN|LOG_PANIC, "failed to read delivery status for %s "
2214 "from delivery subprocess", addr2->unique);
2219 (void)close(pfd[pipe_read]);
2221 /* Unless shadowing, write all successful addresses immediately to the journal
2222 file, to ensure they are recorded asap. For homonymic addresses, use the base
2223 address plus the transport name. Failure to write the journal is panic-worthy,
2224 but don't stop, as it may prove possible subsequently to update the spool file
2225 in order to record the delivery. */
2229 for (addr2 = addr; addr2; addr2 = addr2->next)
2230 if (addr2->transport_return == OK)
2232 if (testflag(addr2, af_homonym))
2233 sprintf(CS big_buffer, "%.500s/%s\n", addr2->unique + 3, tp->name);
2235 sprintf(CS big_buffer, "%.500s\n", addr2->unique);
2237 /* In the test harness, wait just a bit to let the subprocess finish off
2238 any debug output etc first. */
2240 if (running_in_test_harness) millisleep(300);
2242 DEBUG(D_deliver) debug_printf("journalling %s", big_buffer);
2243 len = Ustrlen(big_buffer);
2244 if (write(journal_fd, big_buffer, len) != len)
2245 log_write(0, LOG_MAIN|LOG_PANIC, "failed to update journal for %s: %s",
2246 big_buffer, strerror(errno));
2249 /* Ensure the journal file is pushed out to disk. */
2251 if (EXIMfsync(journal_fd) < 0)
2252 log_write(0, LOG_MAIN|LOG_PANIC, "failed to fsync journal: %s",
2256 /* Wait for the process to finish. If it terminates with a non-zero code,
2257 freeze the message (except for SIGTERM, SIGKILL and SIGQUIT), but leave the
2258 status values of all the addresses as they are. Take care to handle the case
2259 when the subprocess doesn't seem to exist. This has been seen on one system
2260 when Exim was called from an MUA that set SIGCHLD to SIG_IGN. When that
2261 happens, wait() doesn't recognize the termination of child processes. Exim now
2262 resets SIGCHLD to SIG_DFL, but this code should still be robust. */
2264 while ((rc = wait(&status)) != pid)
2265 if (rc < 0 && errno == ECHILD) /* Process has vanished */
2267 log_write(0, LOG_MAIN, "%s transport process vanished unexpectedly",
2268 addr->transport->driver_name);
2273 if ((status & 0xffff) != 0)
2275 int msb = (status >> 8) & 255;
2276 int lsb = status & 255;
2277 int code = (msb == 0)? (lsb & 0x7f) : msb;
2278 if (msb != 0 || (code != SIGTERM && code != SIGKILL && code != SIGQUIT))
2279 addr->special_action = SPECIAL_FREEZE;
2280 log_write(0, LOG_MAIN|LOG_PANIC, "%s transport process returned non-zero "
2281 "status 0x%04x: %s %d",
2282 addr->transport->driver_name,
2284 msb == 0 ? "terminated by signal" : "exit code",
2288 /* If SPECIAL_WARN is set in the top address, send a warning message. */
2290 if (addr->special_action == SPECIAL_WARN && addr->transport->warn_message)
2293 uschar *warn_message;
2296 DEBUG(D_deliver) debug_printf("Warning message requested by transport\n");
2298 if (!(warn_message = expand_string(addr->transport->warn_message)))
2299 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand \"%s\" (warning "
2300 "message for %s transport): %s", addr->transport->warn_message,
2301 addr->transport->name, expand_string_message);
2303 else if ((pid = child_open_exim(&fd)) > 0)
2305 FILE *f = fdopen(fd, "wb");
2306 if (errors_reply_to && !contains_header(US"Reply-To", warn_message))
2307 fprintf(f, "Reply-To: %s\n", errors_reply_to);
2308 fprintf(f, "Auto-Submitted: auto-replied\n");
2309 if (!contains_header(US"From", warn_message))
2311 fprintf(f, "%s", CS warn_message);
2313 /* Close and wait for child process to complete, without a timeout. */
2316 (void)child_close(pid, 0);
2319 addr->special_action = SPECIAL_NONE;
2326 /* Check transport for the given concurrency limit. Return TRUE if over
2327 the limit (or an expansion failure), else FALSE and if there was a limit,
2328 the key for the hints database used for the concurrency count. */
2331 tpt_parallel_check(transport_instance * tp, address_item * addr, uschar ** key)
2333 unsigned max_parallel;
2335 if (!tp->max_parallel) return FALSE;
2337 max_parallel = (unsigned) expand_string_integer(tp->max_parallel, TRUE);
2338 if (expand_string_message)
2340 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand max_parallel option "
2341 "in %s transport (%s): %s", tp->name, addr->address,
2342 expand_string_message);
2346 if (max_parallel > 0)
2348 uschar * serialize_key = string_sprintf("tpt-serialize-%s", tp->name);
2349 if (!enq_start(serialize_key, max_parallel))
2351 address_item * next;
2353 debug_printf("skipping tpt %s because concurrency limit %u reached\n",
2354 tp->name, max_parallel);
2358 addr->message = US"concurrency limit reached for transport";
2359 addr->basic_errno = ERRNO_TRETRY;
2360 post_process_one(addr, DEFER, LOG_MAIN, DTYPE_TRANSPORT, 0);
2361 } while ((addr = next));
2364 *key = serialize_key;
2371 /*************************************************
2372 * Do local deliveries *
2373 *************************************************/
2375 /* This function processes the list of addresses in addr_local. True local
2376 deliveries are always done one address at a time. However, local deliveries can
2377 be batched up in some cases. Typically this is when writing batched SMTP output
2378 files for use by some external transport mechanism, or when running local
2379 deliveries over LMTP.
2386 do_local_deliveries(void)
2389 open_db *dbm_file = NULL;
2390 time_t now = time(NULL);
2392 /* Loop until we have exhausted the supply of local deliveries */
2396 time_t delivery_start;
2398 address_item *addr2, *addr3, *nextaddr;
2399 int logflags = LOG_MAIN;
2400 int logchar = dont_deliver? '*' : '=';
2401 transport_instance *tp;
2402 uschar * serialize_key = NULL;
2404 /* Pick the first undelivered address off the chain */
2406 address_item *addr = addr_local;
2407 addr_local = addr->next;
2410 DEBUG(D_deliver|D_transport)
2411 debug_printf("--------> %s <--------\n", addr->address);
2413 /* An internal disaster if there is no transport. Should not occur! */
2415 if (!(tp = addr->transport))
2417 logflags |= LOG_PANIC;
2418 disable_logging = FALSE; /* Jic */
2419 addr->message = addr->router
2420 ? string_sprintf("No transport set by %s router", addr->router->name)
2421 : string_sprintf("No transport set by system filter");
2422 post_process_one(addr, DEFER, logflags, DTYPE_TRANSPORT, 0);
2426 /* Check that this base address hasn't previously been delivered to this
2427 transport. The check is necessary at this point to handle homonymic addresses
2428 correctly in cases where the pattern of redirection changes between delivery
2429 attempts. Non-homonymic previous delivery is detected earlier, at routing
2432 if (previously_transported(addr, FALSE)) continue;
2434 /* There are weird cases where logging is disabled */
2436 disable_logging = tp->disable_logging;
2438 /* Check for batched addresses and possible amalgamation. Skip all the work
2439 if either batch_max <= 1 or there aren't any other addresses for local
2442 if (tp->batch_max > 1 && addr_local)
2444 int batch_count = 1;
2445 BOOL uses_dom = readconf_depends((driver_instance *)tp, US"domain");
2446 BOOL uses_lp = ( testflag(addr, af_pfr)
2447 && (testflag(addr, af_file) || addr->local_part[0] == '|')
2449 || readconf_depends((driver_instance *)tp, US"local_part");
2450 uschar *batch_id = NULL;
2451 address_item **anchor = &addr_local;
2452 address_item *last = addr;
2455 /* Expand the batch_id string for comparison with other addresses.
2456 Expansion failure suppresses batching. */
2460 deliver_set_expansions(addr);
2461 batch_id = expand_string(tp->batch_id);
2462 deliver_set_expansions(NULL);
2465 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand batch_id option "
2466 "in %s transport (%s): %s", tp->name, addr->address,
2467 expand_string_message);
2468 batch_count = tp->batch_max;
2472 /* Until we reach the batch_max limit, pick off addresses which have the
2473 same characteristics. These are:
2476 not previously delivered (see comment about 50 lines above)
2477 same local part if the transport's configuration contains $local_part
2478 or if this is a file or pipe delivery from a redirection
2479 same domain if the transport's configuration contains $domain
2481 same additional headers
2482 same headers to be removed
2483 same uid/gid for running the transport
2484 same first host if a host list is set
2487 while ((next = *anchor) && batch_count < tp->batch_max)
2490 tp == next->transport
2491 && !previously_transported(next, TRUE)
2492 && (addr->flags & (af_pfr|af_file)) == (next->flags & (af_pfr|af_file))
2493 && (!uses_lp || Ustrcmp(next->local_part, addr->local_part) == 0)
2494 && (!uses_dom || Ustrcmp(next->domain, addr->domain) == 0)
2495 && same_strings(next->prop.errors_address, addr->prop.errors_address)
2496 && same_headers(next->prop.extra_headers, addr->prop.extra_headers)
2497 && same_strings(next->prop.remove_headers, addr->prop.remove_headers)
2498 && same_ugid(tp, addr, next)
2499 && ( !addr->host_list && !next->host_list
2502 && Ustrcmp(addr->host_list->name, next->host_list->name) == 0
2505 /* If the transport has a batch_id setting, batch_id will be non-NULL
2506 from the expansion outside the loop. Expand for this address and compare.
2507 Expansion failure makes this address ineligible for batching. */
2512 address_item *save_nextnext = next->next;
2513 next->next = NULL; /* Expansion for a single address */
2514 deliver_set_expansions(next);
2515 next->next = save_nextnext;
2516 bid = expand_string(tp->batch_id);
2517 deliver_set_expansions(NULL);
2520 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand batch_id option "
2521 "in %s transport (%s): %s", tp->name, next->address,
2522 expand_string_message);
2525 else ok = (Ustrcmp(batch_id, bid) == 0);
2528 /* Take address into batch if OK. */
2532 *anchor = next->next; /* Include the address */
2538 else anchor = &next->next; /* Skip the address */
2542 /* We now have one or more addresses that can be delivered in a batch. Check
2543 whether the transport is prepared to accept a message of this size. If not,
2544 fail them all forthwith. If the expansion fails, or does not yield an
2545 integer, defer delivery. */
2547 if (tp->message_size_limit)
2549 int rc = check_message_size(tp, addr);
2552 replicate_status(addr);
2556 post_process_one(addr, rc, logflags, DTYPE_TRANSPORT, 0);
2559 continue; /* With next batch of addresses */
2563 /* If we are not running the queue, or if forcing, all deliveries will be
2564 attempted. Otherwise, we must respect the retry times for each address. Even
2565 when not doing this, we need to set up the retry key string, and determine
2566 whether a retry record exists, because after a successful delivery, a delete
2567 retry item must be set up. Keep the retry database open only for the duration
2568 of these checks, rather than for all local deliveries, because some local
2569 deliveries (e.g. to pipes) can take a substantial time. */
2571 if (!(dbm_file = dbfn_open(US"retry", O_RDONLY, &dbblock, FALSE)))
2573 DEBUG(D_deliver|D_retry|D_hints_lookup)
2574 debug_printf("no retry data available\n");
2581 BOOL ok = TRUE; /* to deliver this address */
2584 /* Set up the retry key to include the domain or not, and change its
2585 leading character from "R" to "T". Must make a copy before doing this,
2586 because the old key may be pointed to from a "delete" retry item after
2589 retry_key = string_copy(
2590 tp->retry_use_local_part ? addr2->address_retry_key :
2591 addr2->domain_retry_key);
2594 /* Inspect the retry data. If there is no hints file, delivery happens. */
2598 dbdata_retry *retry_record = dbfn_read(dbm_file, retry_key);
2600 /* If there is no retry record, delivery happens. If there is,
2601 remember it exists so it can be deleted after a successful delivery. */
2605 setflag(addr2, af_lt_retry_exists);
2607 /* A retry record exists for this address. If queue running and not
2608 forcing, inspect its contents. If the record is too old, or if its
2609 retry time has come, or if it has passed its cutoff time, delivery
2614 debug_printf("retry record exists: age=%s ",
2615 readconf_printtime(now - retry_record->time_stamp));
2616 debug_printf("(max %s)\n", readconf_printtime(retry_data_expire));
2617 debug_printf(" time to retry = %s expired = %d\n",
2618 readconf_printtime(retry_record->next_try - now),
2619 retry_record->expired);
2622 if (queue_running && !deliver_force)
2624 ok = (now - retry_record->time_stamp > retry_data_expire)
2625 || (now >= retry_record->next_try)
2626 || retry_record->expired;
2628 /* If we haven't reached the retry time, there is one more check
2629 to do, which is for the ultimate address timeout. */
2632 ok = retry_ultimate_address_timeout(retry_key, addr2->domain,
2636 else DEBUG(D_retry) debug_printf("no retry record exists\n");
2639 /* This address is to be delivered. Leave it on the chain. */
2644 addr2 = addr2->next;
2647 /* This address is to be deferred. Take it out of the chain, and
2648 post-process it as complete. Must take it out of the chain first,
2649 because post processing puts it on another chain. */
2653 address_item *this = addr2;
2654 this->message = US"Retry time not yet reached";
2655 this->basic_errno = ERRNO_LRETRY;
2656 addr2 = addr3 ? (addr3->next = addr2->next)
2657 : (addr = addr2->next);
2658 post_process_one(this, DEFER, logflags, DTYPE_TRANSPORT, 0);
2662 if (dbm_file) dbfn_close(dbm_file);
2664 /* If there are no addresses left on the chain, they all deferred. Loop
2665 for the next set of addresses. */
2667 if (!addr) continue;
2669 /* If the transport is limited for parallellism, enforce that here.
2670 We use a hints DB entry, incremented here and decremented after
2671 the transport (and any shadow transport) completes. */
2673 if (tpt_parallel_check(tp, addr, &serialize_key))
2675 if (expand_string_message)
2677 logflags |= LOG_PANIC;
2681 post_process_one(addr, DEFER, logflags, DTYPE_TRANSPORT, 0);
2682 } while ((addr = addr2));
2684 continue; /* Loop for the next set of addresses. */
2688 /* So, finally, we do have some addresses that can be passed to the
2689 transport. Before doing so, set up variables that are relevant to a
2692 deliver_set_expansions(addr);
2693 delivery_start = time(NULL);
2694 deliver_local(addr, FALSE);
2695 deliver_time = (int)(time(NULL) - delivery_start);
2697 /* If a shadow transport (which must perforce be another local transport), is
2698 defined, and its condition is met, we must pass the message to the shadow
2699 too, but only those addresses that succeeded. We do this by making a new
2700 chain of addresses - also to keep the original chain uncontaminated. We must
2701 use a chain rather than doing it one by one, because the shadow transport may
2704 NOTE: if the condition fails because of a lookup defer, there is nothing we
2708 && ( !tp->shadow_condition
2709 || expand_check_condition(tp->shadow_condition, tp->name, US"transport")
2712 transport_instance *stp;
2713 address_item *shadow_addr = NULL;
2714 address_item **last = &shadow_addr;
2716 for (stp = transports; stp; stp = stp->next)
2717 if (Ustrcmp(stp->name, tp->shadow) == 0) break;
2720 log_write(0, LOG_MAIN|LOG_PANIC, "shadow transport \"%s\" not found ",
2723 /* Pick off the addresses that have succeeded, and make clones. Put into
2724 the shadow_message field a pointer to the shadow_message field of the real
2727 else for (addr2 = addr; addr2; addr2 = addr2->next)
2728 if (addr2->transport_return == OK)
2730 addr3 = store_get(sizeof(address_item));
2733 addr3->shadow_message = (uschar *) &(addr2->shadow_message);
2734 addr3->transport = stp;
2735 addr3->transport_return = DEFER;
2736 addr3->return_filename = NULL;
2737 addr3->return_file = -1;
2739 last = &(addr3->next);
2742 /* If we found any addresses to shadow, run the delivery, and stick any
2743 message back into the shadow_message field in the original. */
2747 int save_count = transport_count;
2749 DEBUG(D_deliver|D_transport)
2750 debug_printf(">>>>>>>>>>>>>>>> Shadow delivery >>>>>>>>>>>>>>>>\n");
2751 deliver_local(shadow_addr, TRUE);
2753 for(; shadow_addr; shadow_addr = shadow_addr->next)
2755 int sresult = shadow_addr->transport_return;
2756 *(uschar **)shadow_addr->shadow_message =
2758 ? string_sprintf(" ST=%s", stp->name)
2759 : string_sprintf(" ST=%s (%s%s%s)", stp->name,
2760 shadow_addr->basic_errno <= 0
2762 : US strerror(shadow_addr->basic_errno),
2763 shadow_addr->basic_errno <= 0 || !shadow_addr->message
2766 shadow_addr->message
2767 ? shadow_addr->message
2768 : shadow_addr->basic_errno <= 0
2772 DEBUG(D_deliver|D_transport)
2773 debug_printf("%s shadow transport returned %s for %s\n",
2775 sresult == OK ? "OK" :
2776 sresult == DEFER ? "DEFER" :
2777 sresult == FAIL ? "FAIL" :
2778 sresult == PANIC ? "PANIC" : "?",
2779 shadow_addr->address);
2782 DEBUG(D_deliver|D_transport)
2783 debug_printf(">>>>>>>>>>>>>>>> End shadow delivery >>>>>>>>>>>>>>>>\n");
2785 transport_count = save_count; /* Restore original transport count */
2789 /* Cancel the expansions that were set up for the delivery. */
2791 deliver_set_expansions(NULL);
2793 /* If the transport was parallelism-limited, decrement the hints DB record. */
2795 if (serialize_key) enq_end(serialize_key);
2797 /* Now we can process the results of the real transport. We must take each
2798 address off the chain first, because post_process_one() puts it on another
2801 for (addr2 = addr; addr2; addr2 = nextaddr)
2803 int result = addr2->transport_return;
2804 nextaddr = addr2->next;
2806 DEBUG(D_deliver|D_transport)
2807 debug_printf("%s transport returned %s for %s\n",
2809 result == OK ? "OK" :
2810 result == DEFER ? "DEFER" :
2811 result == FAIL ? "FAIL" :
2812 result == PANIC ? "PANIC" : "?",
2815 /* If there is a retry_record, or if delivery is deferred, build a retry
2816 item for setting a new retry time or deleting the old retry record from
2817 the database. These items are handled all together after all addresses
2818 have been handled (so the database is open just for a short time for
2821 if (result == DEFER || testflag(addr2, af_lt_retry_exists))
2823 int flags = result == DEFER ? 0 : rf_delete;
2824 uschar *retry_key = string_copy(tp->retry_use_local_part
2825 ? addr2->address_retry_key : addr2->domain_retry_key);
2827 retry_add_item(addr2, retry_key, flags);
2830 /* Done with this address */
2832 if (result == OK) addr2->more_errno = deliver_time;
2833 post_process_one(addr2, result, logflags, DTYPE_TRANSPORT, logchar);
2835 /* If a pipe delivery generated text to be sent back, the result may be
2836 changed to FAIL, and we must copy this for subsequent addresses in the
2839 if (addr2->transport_return != result)
2841 for (addr3 = nextaddr; addr3; addr3 = addr3->next)
2843 addr3->transport_return = addr2->transport_return;
2844 addr3->basic_errno = addr2->basic_errno;
2845 addr3->message = addr2->message;
2847 result = addr2->transport_return;
2850 /* Whether or not the result was changed to FAIL, we need to copy the
2851 return_file value from the first address into all the addresses of the
2852 batch, so they are all listed in the error message. */
2854 addr2->return_file = addr->return_file;
2856 /* Change log character for recording successful deliveries. */
2858 if (result == OK) logchar = '-';
2860 } /* Loop back for next batch of addresses */
2866 /*************************************************
2867 * Sort remote deliveries *
2868 *************************************************/
2870 /* This function is called if remote_sort_domains is set. It arranges that the
2871 chain of addresses for remote deliveries is ordered according to the strings
2872 specified. Try to make this shuffling reasonably efficient by handling
2873 sequences of addresses rather than just single ones.
2880 sort_remote_deliveries(void)
2883 address_item **aptr = &addr_remote;
2884 const uschar *listptr = remote_sort_domains;
2889 && (pattern = string_nextinlist(&listptr, &sep, patbuf, sizeof(patbuf)))
2892 address_item *moved = NULL;
2893 address_item **bptr = &moved;
2897 address_item **next;
2898 deliver_domain = (*aptr)->domain; /* set $domain */
2899 if (match_isinlist(deliver_domain, (const uschar **)&pattern, UCHAR_MAX+1,
2900 &domainlist_anchor, NULL, MCL_DOMAIN, TRUE, NULL) == OK)
2902 aptr = &(*aptr)->next;
2906 next = &(*aptr)->next;
2908 && (deliver_domain = (*next)->domain, /* Set $domain */
2909 match_isinlist(deliver_domain, (const uschar **)&pattern, UCHAR_MAX+1,
2910 &domainlist_anchor, NULL, MCL_DOMAIN, TRUE, NULL)) != OK
2912 next = &(*next)->next;
2914 /* If the batch of non-matchers is at the end, add on any that were
2915 extracted further up the chain, and end this iteration. Otherwise,
2916 extract them from the chain and hang on the moved chain. */
2928 aptr = &(*aptr)->next;
2931 /* If the loop ended because the final address matched, *aptr will
2932 be NULL. Add on to the end any extracted non-matching addresses. If
2933 *aptr is not NULL, the loop ended via "break" when *next is null, that
2934 is, there was a string of non-matching addresses at the end. In this
2935 case the extracted addresses have already been added on the end. */
2937 if (!*aptr) *aptr = moved;
2943 debug_printf("remote addresses after sorting:\n");
2944 for (addr = addr_remote; addr; addr = addr->next)
2945 debug_printf(" %s\n", addr->address);
2951 /*************************************************
2952 * Read from pipe for remote delivery subprocess *
2953 *************************************************/
2955 /* This function is called when the subprocess is complete, but can also be
2956 called before it is complete, in order to empty a pipe that is full (to prevent
2957 deadlock). It must therefore keep track of its progress in the parlist data
2960 We read the pipe to get the delivery status codes and a possible error message
2961 for each address, optionally preceded by unusability data for the hosts and
2962 also by optional retry data.
2964 Read in large chunks into the big buffer and then scan through, interpreting
2965 the data therein. In most cases, only a single read will be necessary. No
2966 individual item will ever be anywhere near 2500 bytes in length, so by ensuring
2967 that we read the next chunk when there is less than 2500 bytes left in the
2968 non-final chunk, we can assume each item is complete in the buffer before
2969 handling it. Each item is written using a single write(), which is atomic for
2970 small items (less than PIPE_BUF, which seems to be at least 512 in any Unix and
2971 often bigger) so even if we are reading while the subprocess is still going, we
2972 should never have only a partial item in the buffer.
2975 poffset the offset of the parlist item
2976 eop TRUE if the process has completed
2978 Returns: TRUE if the terminating 'Z' item has been read,
2979 or there has been a disaster (i.e. no more data needed);
2984 par_read_pipe(int poffset, BOOL eop)
2987 pardata *p = parlist + poffset;
2988 address_item *addrlist = p->addrlist;
2989 address_item *addr = p->addr;
2992 uschar *endptr = big_buffer;
2993 uschar *ptr = endptr;
2994 uschar *msg = p->msg;
2995 BOOL done = p->done;
2996 BOOL unfinished = TRUE;
2997 /* minimum size to read is header size including id, subid and length */
2998 int required = PIPE_HEADER_SIZE;
3000 /* Loop through all items, reading from the pipe when necessary. The pipe
3001 is set up to be non-blocking, but there are two different Unix mechanisms in
3002 use. Exim uses O_NONBLOCK if it is defined. This returns 0 for end of file,
3003 and EAGAIN for no more data. If O_NONBLOCK is not defined, Exim uses O_NDELAY,
3004 which returns 0 for both end of file and no more data. We distinguish the
3005 two cases by taking 0 as end of file only when we know the process has
3008 Each separate item is written to the pipe in a single write(), and as they are
3009 all short items, the writes will all be atomic and we should never find
3010 ourselves in the position of having read an incomplete item. "Short" in this
3011 case can mean up to about 1K in the case when there is a long error message
3012 associated with an address. */
3014 DEBUG(D_deliver) debug_printf("reading pipe for subprocess %d (%s)\n",
3015 (int)p->pid, eop? "ended" : "not ended");
3019 retry_item *r, **rp;
3020 int remaining = endptr - ptr;
3021 uschar header[PIPE_HEADER_SIZE + 1];
3025 /* Read (first time) or top up the chars in the buffer if necessary.
3026 There will be only one read if we get all the available data (i.e. don't
3027 fill the buffer completely). */
3029 if (remaining < required && unfinished)
3032 int available = big_buffer_size - remaining;
3034 if (remaining > 0) memmove(big_buffer, ptr, remaining);
3037 endptr = big_buffer + remaining;
3038 len = read(fd, endptr, available);
3040 DEBUG(D_deliver) debug_printf("read() yielded %d\n", len);
3042 /* If the result is EAGAIN and the process is not complete, just
3043 stop reading any more and process what we have already. */
3047 if (!eop && errno == EAGAIN) len = 0; else
3049 msg = string_sprintf("failed to read pipe from transport process "
3050 "%d for transport %s: %s", pid, addr->transport->driver_name,
3056 /* If the length is zero (eof or no-more-data), just process what we
3057 already have. Note that if the process is still running and we have
3058 read all the data in the pipe (but less that "available") then we
3059 won't read any more, as "unfinished" will get set FALSE. */
3063 unfinished = len == available;
3066 /* If we are at the end of the available data, exit the loop. */
3067 if (ptr >= endptr) break;
3069 /* copy and read header */
3070 memcpy(header, ptr, PIPE_HEADER_SIZE);
3071 header[PIPE_HEADER_SIZE] = '\0';
3074 required = Ustrtol(header + 2, &endc, 10) + PIPE_HEADER_SIZE; /* header + data */
3077 msg = string_sprintf("failed to read pipe from transport process "
3078 "%d for transport %s: error reading size from header", pid, addr->transport->driver_name);
3084 debug_printf("header read id:%c,subid:%c,size:%s,required:%d,remaining:%d,unfinished:%d\n",
3085 id, subid, header+2, required, remaining, unfinished);
3087 /* is there room for the dataset we want to read ? */
3088 if (required > big_buffer_size - PIPE_HEADER_SIZE)
3090 msg = string_sprintf("failed to read pipe from transport process "
3091 "%d for transport %s: big_buffer too small! required size=%d buffer size=%d", pid, addr->transport->driver_name,
3092 required, big_buffer_size - PIPE_HEADER_SIZE);
3097 /* we wrote all datasets with atomic write() calls
3098 remaining < required only happens if big_buffer was too small
3099 to get all available data from pipe. unfinished has to be true
3101 if (remaining < required)
3105 msg = string_sprintf("failed to read pipe from transport process "
3106 "%d for transport %s: required size=%d > remaining size=%d and unfinished=false",
3107 pid, addr->transport->driver_name, required, remaining);
3112 /* step behind the header */
3113 ptr += PIPE_HEADER_SIZE;
3115 /* Handle each possible type of item, assuming the complete item is
3116 available in store. */
3120 /* Host items exist only if any hosts were marked unusable. Match
3121 up by checking the IP address. */
3124 for (h = addrlist->host_list; h; h = h->next)
3126 if (!h->address || Ustrcmp(h->address, ptr+2) != 0) continue;
3134 /* Retry items are sent in a preceding R item for each address. This is
3135 kept separate to keep each message short enough to guarantee it won't
3136 be split in the pipe. Hopefully, in the majority of cases, there won't in
3137 fact be any retry items at all.
3139 The complete set of retry items might include an item to delete a
3140 routing retry if there was a previous routing delay. However, routing
3141 retries are also used when a remote transport identifies an address error.
3142 In that case, there may also be an "add" item for the same key. Arrange
3143 that a "delete" item is dropped in favour of an "add" item. */
3146 if (!addr) goto ADDR_MISMATCH;
3148 DEBUG(D_deliver|D_retry)
3149 debug_printf("reading retry information for %s from subprocess\n",
3152 /* Cut out any "delete" items on the list. */
3154 for (rp = &(addr->retries); (r = *rp); rp = &r->next)
3155 if (Ustrcmp(r->key, ptr+1) == 0) /* Found item with same key */
3157 if ((r->flags & rf_delete) == 0) break; /* It was not "delete" */
3158 *rp = r->next; /* Excise a delete item */
3159 DEBUG(D_deliver|D_retry)
3160 debug_printf(" existing delete item dropped\n");
3163 /* We want to add a delete item only if there is no non-delete item;
3164 however we still have to step ptr through the data. */
3166 if (!r || (*ptr & rf_delete) == 0)
3168 r = store_get(sizeof(retry_item));
3169 r->next = addr->retries;
3172 r->key = string_copy(ptr);
3174 memcpy(&(r->basic_errno), ptr, sizeof(r->basic_errno));
3175 ptr += sizeof(r->basic_errno);
3176 memcpy(&(r->more_errno), ptr, sizeof(r->more_errno));
3177 ptr += sizeof(r->more_errno);
3178 r->message = (*ptr)? string_copy(ptr) : NULL;
3179 DEBUG(D_deliver|D_retry)
3180 debug_printf(" added %s item\n",
3181 ((r->flags & rf_delete) == 0)? "retry" : "delete");
3186 DEBUG(D_deliver|D_retry)
3187 debug_printf(" delete item not added: non-delete item exists\n");
3190 ptr += sizeof(r->basic_errno) + sizeof(r->more_errno);
3196 /* Put the amount of data written into the parlist block */
3199 memcpy(&(p->transport_count), ptr, sizeof(transport_count));
3200 ptr += sizeof(transport_count);
3203 /* Address items are in the order of items on the address chain. We
3204 remember the current address value in case this function is called
3205 several times to empty the pipe in stages. Information about delivery
3206 over TLS is sent in a preceding X item for each address. We don't put
3207 it in with the other info, in order to keep each message short enough to
3208 guarantee it won't be split in the pipe. */
3212 if (!addr) goto ADDR_MISMATCH; /* Below, in 'A' handler */
3216 addr->cipher = NULL;
3217 addr->peerdn = NULL;
3220 addr->cipher = string_copy(ptr);
3223 addr->peerdn = string_copy(ptr);
3228 (void) tls_import_cert(ptr, &addr->peercert);
3230 addr->peercert = NULL;
3235 (void) tls_import_cert(ptr, &addr->ourcert);
3237 addr->ourcert = NULL;
3240 # ifndef DISABLE_OCSP
3242 addr->ocsp = OCSP_NOT_REQ;
3244 addr->ocsp = *ptr - '0';
3250 #endif /*SUPPORT_TLS*/
3252 case 'C': /* client authenticator information */
3256 addr->authenticator = (*ptr)? string_copy(ptr) : NULL;
3259 addr->auth_id = (*ptr)? string_copy(ptr) : NULL;
3262 addr->auth_sndr = (*ptr)? string_copy(ptr) : NULL;
3268 #ifndef DISABLE_PRDR
3270 addr->flags |= af_prdr_used;
3275 if (!addr) goto ADDR_MISMATCH;
3276 memcpy(&(addr->dsn_aware), ptr, sizeof(addr->dsn_aware));
3277 ptr += sizeof(addr->dsn_aware);
3278 DEBUG(D_deliver) debug_printf("DSN read: addr->dsn_aware = %d\n", addr->dsn_aware);
3285 msg = string_sprintf("address count mismatch for data read from pipe "
3286 "for transport process %d for transport %s", pid,
3287 addrlist->transport->driver_name);
3294 #ifdef EXPERIMENTAL_DSN_INFO
3295 case '1': /* must arrive before A0, and applies to that addr */
3296 /* Two strings: smtp_greeting and helo_response */
3297 addr->smtp_greeting = string_copy(ptr);
3299 addr->helo_response = string_copy(ptr);
3305 addr->transport_return = *ptr++;
3306 addr->special_action = *ptr++;
3307 memcpy(&(addr->basic_errno), ptr, sizeof(addr->basic_errno));
3308 ptr += sizeof(addr->basic_errno);
3309 memcpy(&(addr->more_errno), ptr, sizeof(addr->more_errno));
3310 ptr += sizeof(addr->more_errno);
3311 memcpy(&(addr->flags), ptr, sizeof(addr->flags));
3312 ptr += sizeof(addr->flags);
3313 addr->message = (*ptr)? string_copy(ptr) : NULL;
3315 addr->user_message = (*ptr)? string_copy(ptr) : NULL;
3318 /* Always two strings for host information, followed by the port number and DNSSEC mark */
3322 h = store_get(sizeof(host_item));
3323 h->name = string_copy(ptr);
3325 h->address = string_copy(ptr);
3327 memcpy(&(h->port), ptr, sizeof(h->port));
3328 ptr += sizeof(h->port);
3329 h->dnssec = *ptr == '2' ? DS_YES
3330 : *ptr == '1' ? DS_NO
3333 addr->host_used = h;
3337 /* Finished with this address */
3344 /* Local interface address/port */
3346 if (*ptr) sending_ip_address = string_copy(ptr);
3348 if (*ptr) sending_port = atoi(CS ptr);
3352 /* Z marks the logical end of the data. It is followed by '0' if
3353 continue_transport was NULL at the end of transporting, otherwise '1'.
3354 We need to know when it becomes NULL during a delivery down a passed SMTP
3355 channel so that we don't try to pass anything more down it. Of course, for
3356 most normal messages it will remain NULL all the time. */
3361 continue_transport = NULL;
3362 continue_hostname = NULL;
3365 DEBUG(D_deliver) debug_printf("Z0%c item read\n", *ptr);
3368 /* Anything else is a disaster. */
3371 msg = string_sprintf("malformed data (%d) read from pipe for transport "
3372 "process %d for transport %s", ptr[-1], pid,
3373 addr->transport->driver_name);
3379 /* The done flag is inspected externally, to determine whether or not to
3380 call the function again when the process finishes. */
3384 /* If the process hadn't finished, and we haven't seen the end of the data
3385 or suffered a disaster, update the rest of the state, and return FALSE to
3386 indicate "not finished". */
3395 /* Close our end of the pipe, to prevent deadlock if the far end is still
3396 pushing stuff into it. */
3401 /* If we have finished without error, but haven't had data for every address,
3402 something is wrong. */
3405 msg = string_sprintf("insufficient address data read from pipe "
3406 "for transport process %d for transport %s", pid,
3407 addr->transport->driver_name);
3409 /* If an error message is set, something has gone wrong in getting back
3410 the delivery data. Put the message into each address and freeze it. */
3413 for (addr = addrlist; addr; addr = addr->next)
3415 addr->transport_return = DEFER;
3416 addr->special_action = SPECIAL_FREEZE;
3417 addr->message = msg;
3420 /* Return TRUE to indicate we have got all we need from this process, even
3421 if it hasn't actually finished yet. */
3428 /*************************************************
3429 * Post-process a set of remote addresses *
3430 *************************************************/
3432 /* Do what has to be done immediately after a remote delivery for each set of
3433 addresses, then re-write the spool if necessary. Note that post_process_one
3434 puts the address on an appropriate queue; hence we must fish off the next
3435 one first. This function is also called if there is a problem with setting
3436 up a subprocess to do a remote delivery in parallel. In this case, the final
3437 argument contains a message, and the action must be forced to DEFER.
3440 addr pointer to chain of address items
3441 logflags flags for logging
3442 msg NULL for normal cases; -> error message for unexpected problems
3443 fallback TRUE if processing fallback hosts
3449 remote_post_process(address_item *addr, int logflags, uschar *msg,
3454 /* If any host addresses were found to be unusable, add them to the unusable
3455 tree so that subsequent deliveries don't try them. */
3457 for (h = addr->host_list; h; h = h->next)
3459 if (h->status >= hstatus_unusable) tree_add_unusable(h);
3461 /* Now handle each address on the chain. The transport has placed '=' or '-'
3462 into the special_action field for each successful delivery. */
3466 address_item *next = addr->next;
3468 /* If msg == NULL (normal processing) and the result is DEFER and we are
3469 processing the main hosts and there are fallback hosts available, put the
3470 address on the list for fallback delivery. */
3472 if ( addr->transport_return == DEFER
3473 && addr->fallback_hosts
3478 addr->host_list = addr->fallback_hosts;
3479 addr->next = addr_fallback;
3480 addr_fallback = addr;
3481 DEBUG(D_deliver) debug_printf("%s queued for fallback host(s)\n", addr->address);
3484 /* If msg is set (=> unexpected problem), set it in the address before
3485 doing the ordinary post processing. */
3491 addr->message = msg;
3492 addr->transport_return = DEFER;
3494 (void)post_process_one(addr, addr->transport_return, logflags,
3495 DTYPE_TRANSPORT, addr->special_action);
3503 /* If we have just delivered down a passed SMTP channel, and that was
3504 the last address, the channel will have been closed down. Now that
3505 we have logged that delivery, set continue_sequence to 1 so that
3506 any subsequent deliveries don't get "*" incorrectly logged. */
3508 if (!continue_transport) continue_sequence = 1;
3513 /*************************************************
3514 * Wait for one remote delivery subprocess *
3515 *************************************************/
3517 /* This function is called while doing remote deliveries when either the
3518 maximum number of processes exist and we need one to complete so that another
3519 can be created, or when waiting for the last ones to complete. It must wait for
3520 the completion of one subprocess, empty the control block slot, and return a
3521 pointer to the address chain.
3524 Returns: pointer to the chain of addresses handled by the process;
3525 NULL if no subprocess found - this is an unexpected error
3528 static address_item *
3531 int poffset, status;
3532 address_item *addr, *addrlist;
3535 set_process_info("delivering %s: waiting for a remote delivery subprocess "
3536 "to finish", message_id);
3538 /* Loop until either a subprocess completes, or there are no subprocesses in
3539 existence - in which case give an error return. We cannot proceed just by
3540 waiting for a completion, because a subprocess may have filled up its pipe, and
3541 be waiting for it to be emptied. Therefore, if no processes have finished, we
3542 wait for one of the pipes to acquire some data by calling select(), with a
3543 timeout just in case.
3545 The simple approach is just to iterate after reading data from a ready pipe.
3546 This leads to non-ideal behaviour when the subprocess has written its final Z
3547 item, closed the pipe, and is in the process of exiting (the common case). A
3548 call to waitpid() yields nothing completed, but select() shows the pipe ready -
3549 reading it yields EOF, so you end up with busy-waiting until the subprocess has
3552 To avoid this, if all the data that is needed has been read from a subprocess
3553 after select(), an explicit wait() for it is done. We know that all it is doing
3554 is writing to the pipe and then exiting, so the wait should not be long.
3556 The non-blocking waitpid() is to some extent just insurance; if we could
3557 reliably detect end-of-file on the pipe, we could always know when to do a
3558 blocking wait() for a completed process. However, because some systems use
3559 NDELAY, which doesn't distinguish between EOF and pipe empty, it is easier to
3560 use code that functions without the need to recognize EOF.
3562 There's a double loop here just in case we end up with a process that is not in
3563 the list of remote delivery processes. Something has obviously gone wrong if
3564 this is the case. (For example, a process that is incorrectly left over from
3565 routing or local deliveries might be found.) The damage can be minimized by
3566 looping back and looking for another process. If there aren't any, the error
3567 return will happen. */
3569 for (;;) /* Normally we do not repeat this loop */
3571 while ((pid = waitpid(-1, &status, WNOHANG)) <= 0)
3574 fd_set select_pipes;
3575 int maxpipe, readycount;
3577 /* A return value of -1 can mean several things. If errno != ECHILD, it
3578 either means invalid options (which we discount), or that this process was
3579 interrupted by a signal. Just loop to try the waitpid() again.
3581 If errno == ECHILD, waitpid() is telling us that there are no subprocesses
3582 in existence. This should never happen, and is an unexpected error.
3583 However, there is a nasty complication when running under Linux. If "strace
3584 -f" is being used under Linux to trace this process and its children,
3585 subprocesses are "stolen" from their parents and become the children of the
3586 tracing process. A general wait such as the one we've just obeyed returns
3587 as if there are no children while subprocesses are running. Once a
3588 subprocess completes, it is restored to the parent, and waitpid(-1) finds
3589 it. Thanks to Joachim Wieland for finding all this out and suggesting a
3592 This does not happen using "truss" on Solaris, nor (I think) with other
3593 tracing facilities on other OS. It seems to be specific to Linux.
3595 What we do to get round this is to use kill() to see if any of our
3596 subprocesses are still in existence. If kill() gives an OK return, we know
3597 it must be for one of our processes - it can't be for a re-use of the pid,
3598 because if our process had finished, waitpid() would have found it. If any
3599 of our subprocesses are in existence, we proceed to use select() as if
3600 waitpid() had returned zero. I think this is safe. */
3604 if (errno != ECHILD) continue; /* Repeats the waitpid() */
3607 debug_printf("waitpid() returned -1/ECHILD: checking explicitly "
3608 "for process existence\n");
3610 for (poffset = 0; poffset < remote_max_parallel; poffset++)
3612 if ((pid = parlist[poffset].pid) != 0 && kill(pid, 0) == 0)
3614 DEBUG(D_deliver) debug_printf("process %d still exists: assume "
3615 "stolen by strace\n", (int)pid);
3616 break; /* With poffset set */
3620 if (poffset >= remote_max_parallel)
3622 DEBUG(D_deliver) debug_printf("*** no delivery children found\n");
3623 return NULL; /* This is the error return */
3627 /* A pid value greater than 0 breaks the "while" loop. A negative value has
3628 been handled above. A return value of zero means that there is at least one
3629 subprocess, but there are no completed subprocesses. See if any pipes are
3630 ready with any data for reading. */
3632 DEBUG(D_deliver) debug_printf("selecting on subprocess pipes\n");
3635 FD_ZERO(&select_pipes);
3636 for (poffset = 0; poffset < remote_max_parallel; poffset++)
3638 if (parlist[poffset].pid != 0)
3640 int fd = parlist[poffset].fd;
3641 FD_SET(fd, &select_pipes);
3642 if (fd > maxpipe) maxpipe = fd;
3646 /* Stick in a 60-second timeout, just in case. */
3651 readycount = select(maxpipe + 1, (SELECT_ARG2_TYPE *)&select_pipes,
3654 /* Scan through the pipes and read any that are ready; use the count
3655 returned by select() to stop when there are no more. Select() can return
3656 with no processes (e.g. if interrupted). This shouldn't matter.
3658 If par_read_pipe() returns TRUE, it means that either the terminating Z was
3659 read, or there was a disaster. In either case, we are finished with this
3660 process. Do an explicit wait() for the process and break the main loop if
3663 It turns out that we have to deal with the case of an interrupted system
3664 call, which can happen on some operating systems if the signal handling is
3665 set up to do that by default. */
3668 readycount > 0 && poffset < remote_max_parallel;
3671 if ( (pid = parlist[poffset].pid) != 0
3672 && FD_ISSET(parlist[poffset].fd, &select_pipes)
3676 if (par_read_pipe(poffset, FALSE)) /* Finished with this pipe */
3678 for (;;) /* Loop for signals */
3680 pid_t endedpid = waitpid(pid, &status, 0);
3681 if (endedpid == pid) goto PROCESS_DONE;
3682 if (endedpid != (pid_t)(-1) || errno != EINTR)
3683 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Unexpected error return "
3684 "%d (errno = %d) from waitpid() for process %d",
3685 (int)endedpid, errno, (int)pid);
3691 /* Now go back and look for a completed subprocess again. */
3694 /* A completed process was detected by the non-blocking waitpid(). Find the
3695 data block that corresponds to this subprocess. */
3697 for (poffset = 0; poffset < remote_max_parallel; poffset++)
3698 if (pid == parlist[poffset].pid) break;
3700 /* Found the data block; this is a known remote delivery process. We don't
3701 need to repeat the outer loop. This should be what normally happens. */
3703 if (poffset < remote_max_parallel) break;
3705 /* This situation is an error, but it's probably better to carry on looking
3706 for another process than to give up (as we used to do). */
3708 log_write(0, LOG_MAIN|LOG_PANIC, "Process %d finished: not found in remote "
3709 "transport process list", pid);
3710 } /* End of the "for" loop */
3712 /* Come here when all the data was completely read after a select(), and
3713 the process in pid has been wait()ed for. */
3720 debug_printf("remote delivery process %d ended\n", (int)pid);
3722 debug_printf("remote delivery process %d ended: status=%04x\n", (int)pid,
3726 set_process_info("delivering %s", message_id);
3728 /* Get the chain of processed addresses */
3730 addrlist = parlist[poffset].addrlist;
3732 /* If the process did not finish cleanly, record an error and freeze (except
3733 for SIGTERM, SIGKILL and SIGQUIT), and also ensure the journal is not removed,
3734 in case the delivery did actually happen. */
3736 if ((status & 0xffff) != 0)
3739 int msb = (status >> 8) & 255;
3740 int lsb = status & 255;
3741 int code = (msb == 0)? (lsb & 0x7f) : msb;
3743 msg = string_sprintf("%s transport process returned non-zero status 0x%04x: "
3745 addrlist->transport->driver_name,
3747 (msb == 0)? "terminated by signal" : "exit code",
3750 if (msb != 0 || (code != SIGTERM && code != SIGKILL && code != SIGQUIT))
3751 addrlist->special_action = SPECIAL_FREEZE;
3753 for (addr = addrlist; addr; addr = addr->next)
3755 addr->transport_return = DEFER;
3756 addr->message = msg;
3759 remove_journal = FALSE;
3762 /* Else complete reading the pipe to get the result of the delivery, if all
3763 the data has not yet been obtained. */
3765 else if (!parlist[poffset].done) (void)par_read_pipe(poffset, TRUE);
3767 /* Put the data count and return path into globals, mark the data slot unused,
3768 decrement the count of subprocesses, and return the address chain. */
3770 transport_count = parlist[poffset].transport_count;
3771 used_return_path = parlist[poffset].return_path;
3772 parlist[poffset].pid = 0;
3779 /*************************************************
3780 * Wait for subprocesses and post-process *
3781 *************************************************/
3783 /* This function waits for subprocesses until the number that are still running
3784 is below a given threshold. For each complete subprocess, the addresses are
3785 post-processed. If we can't find a running process, there is some shambles.
3786 Better not bomb out, as that might lead to multiple copies of the message. Just
3787 log and proceed as if all done.
3790 max maximum number of subprocesses to leave running
3791 fallback TRUE if processing fallback hosts
3797 par_reduce(int max, BOOL fallback)
3799 while (parcount > max)
3801 address_item *doneaddr = par_wait();
3804 log_write(0, LOG_MAIN|LOG_PANIC,
3805 "remote delivery process count got out of step");
3810 transport_instance * tp = doneaddr->transport;
3811 if (tp->max_parallel)
3812 enq_end(string_sprintf("tpt-serialize-%s", tp->name));
3814 remote_post_process(doneaddr, LOG_MAIN, NULL, fallback);
3823 rmt_dlv_checked_write(int fd, char id, char subid, void * buf, int size)
3825 uschar writebuffer[PIPE_HEADER_SIZE + BIG_BUFFER_SIZE];
3828 /* we assume that size can't get larger then BIG_BUFFER_SIZE which currently is set to 16k */
3829 /* complain to log if someone tries with buffer sizes we can't handle*/
3833 log_write(0, LOG_MAIN|LOG_PANIC_DIE,
3834 "Failed writing transport result to pipe: can't handle buffers > 99999 bytes. truncating!\n");
3838 /* to keep the write() atomic we build header in writebuffer and copy buf behind */
3839 /* two write() calls would increase the complexity of reading from pipe */
3841 /* convert size to human readable string prepended by id and subid */
3842 header_length = snprintf(CS writebuffer, PIPE_HEADER_SIZE+1, "%c%c%05d", id, subid, size);
3843 if (header_length != PIPE_HEADER_SIZE)
3845 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "header snprintf failed\n");
3846 writebuffer[0] = '\0';
3849 DEBUG(D_deliver) debug_printf("header write id:%c,subid:%c,size:%d,final:%s\n",
3850 id, subid, size, writebuffer);
3852 if (buf && size > 0)
3853 memcpy(writebuffer + PIPE_HEADER_SIZE, buf, size);
3855 size += PIPE_HEADER_SIZE;
3856 int ret = write(fd, writebuffer, size);
3858 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Failed writing transport result to pipe: %s\n",
3859 ret == -1 ? strerror(errno) : "short write");
3862 /*************************************************
3863 * Do remote deliveries *
3864 *************************************************/
3866 /* This function is called to process the addresses in addr_remote. We must
3867 pick off the queue all addresses that have the same transport, remote
3868 destination, and errors address, and hand them to the transport in one go,
3869 subject to some configured limitations. If this is a run to continue delivering
3870 to an existing delivery channel, skip all but those addresses that can go to
3871 that channel. The skipped addresses just get deferred.
3873 If mua_wrapper is set, all addresses must be able to be sent in a single
3874 transaction. If not, this function yields FALSE.
3876 In Exim 4, remote deliveries are always done in separate processes, even
3877 if remote_max_parallel = 1 or if there's only one delivery to do. The reason
3878 is so that the base process can retain privilege. This makes the
3879 implementation of fallback transports feasible (though not initially done.)
3881 We create up to the configured number of subprocesses, each of which passes
3882 back the delivery state via a pipe. (However, when sending down an existing
3883 connection, remote_max_parallel is forced to 1.)
3886 fallback TRUE if processing fallback hosts
3888 Returns: TRUE normally
3889 FALSE if mua_wrapper is set and the addresses cannot all be sent
3894 do_remote_deliveries(BOOL fallback)
3900 parcount = 0; /* Number of executing subprocesses */
3902 /* When sending down an existing channel, only do one delivery at a time.
3903 We use a local variable (parmax) to hold the maximum number of processes;
3904 this gets reduced from remote_max_parallel if we can't create enough pipes. */
3906 if (continue_transport) remote_max_parallel = 1;
3907 parmax = remote_max_parallel;
3909 /* If the data for keeping a list of processes hasn't yet been
3914 parlist = store_get(remote_max_parallel * sizeof(pardata));
3915 for (poffset = 0; poffset < remote_max_parallel; poffset++)
3916 parlist[poffset].pid = 0;
3919 /* Now loop for each remote delivery */
3921 for (delivery_count = 0; addr_remote; delivery_count++)
3927 int address_count = 1;
3928 int address_count_max;
3930 BOOL use_initgroups;
3931 BOOL pipe_done = FALSE;
3932 transport_instance *tp;
3933 address_item **anchor = &addr_remote;
3934 address_item *addr = addr_remote;
3935 address_item *last = addr;
3938 uschar * serialize_key = NULL;
3940 /* Pull the first address right off the list. */
3942 addr_remote = addr->next;
3945 DEBUG(D_deliver|D_transport)
3946 debug_printf("--------> %s <--------\n", addr->address);
3948 /* If no transport has been set, there has been a big screw-up somewhere. */
3950 if (!(tp = addr->transport))
3952 disable_logging = FALSE; /* Jic */
3953 panicmsg = US"No transport set by router";
3954 goto panic_continue;
3957 /* Check that this base address hasn't previously been delivered to this
3958 transport. The check is necessary at this point to handle homonymic addresses
3959 correctly in cases where the pattern of redirection changes between delivery
3960 attempts. Non-homonymic previous delivery is detected earlier, at routing
3963 if (previously_transported(addr, FALSE)) continue;
3965 /* Force failure if the message is too big. */
3967 if (tp->message_size_limit)
3969 int rc = check_message_size(tp, addr);
3972 addr->transport_return = rc;
3973 remote_post_process(addr, LOG_MAIN, NULL, fallback);
3978 /* Get the flag which specifies whether the transport can handle different
3979 domains that nevertheless resolve to the same set of hosts. If it needs
3980 expanding, get variables set: $address_data, $domain_data, $localpart_data,
3981 $host, $host_address, $host_port. */
3982 if (tp->expand_multi_domain)
3983 deliver_set_expansions(addr);
3985 if (exp_bool(addr, US"transport", tp->name, D_transport,
3986 US"multi_domain", tp->multi_domain, tp->expand_multi_domain,
3987 &multi_domain) != OK)
3989 deliver_set_expansions(NULL);
3990 panicmsg = addr->message;
3991 goto panic_continue;
3994 /* Get the maximum it can handle in one envelope, with zero meaning
3995 unlimited, which is forced for the MUA wrapper case. */
3997 address_count_max = tp->max_addresses;
3998 if (address_count_max == 0 || mua_wrapper) address_count_max = 999999;
4001 /************************************************************************/
4002 /***** This is slightly experimental code, but should be safe. *****/
4004 /* The address_count_max value is the maximum number of addresses that the
4005 transport can send in one envelope. However, the transport must be capable of
4006 dealing with any number of addresses. If the number it gets exceeds its
4007 envelope limitation, it must send multiple copies of the message. This can be
4008 done over a single connection for SMTP, so uses less resources than making
4009 multiple connections. On the other hand, if remote_max_parallel is greater
4010 than one, it is perhaps a good idea to use parallel processing to move the
4011 message faster, even if that results in multiple simultaneous connections to
4014 How can we come to some compromise between these two ideals? What we do is to
4015 limit the number of addresses passed to a single instance of a transport to
4016 the greater of (a) its address limit (rcpt_max for SMTP) and (b) the total
4017 number of addresses routed to remote transports divided by
4018 remote_max_parallel. For example, if the message has 100 remote recipients,
4019 remote max parallel is 2, and rcpt_max is 10, we'd never send more than 50 at
4020 once. But if rcpt_max is 100, we could send up to 100.
4022 Of course, not all the remotely addresses in a message are going to go to the
4023 same set of hosts (except in smarthost configurations), so this is just a
4024 heuristic way of dividing up the work.
4026 Furthermore (1), because this may not be wanted in some cases, and also to
4027 cope with really pathological cases, there is also a limit to the number of
4028 messages that are sent over one connection. This is the same limit that is
4029 used when sending several different messages over the same connection.
4030 Continue_sequence is set when in this situation, to the number sent so
4031 far, including this message.
4033 Furthermore (2), when somebody explicitly sets the maximum value to 1, it
4034 is probably because they are using VERP, in which case they want to pass only
4035 one address at a time to the transport, in order to be able to use
4036 $local_part and $domain in constructing a new return path. We could test for
4037 the use of these variables, but as it is so likely they will be used when the
4038 maximum is 1, we don't bother. Just leave the value alone. */
4040 if ( address_count_max != 1
4041 && address_count_max < remote_delivery_count/remote_max_parallel
4044 int new_max = remote_delivery_count/remote_max_parallel;
4045 int message_max = tp->connection_max_messages;
4046 if (connection_max_messages >= 0) message_max = connection_max_messages;
4047 message_max -= continue_sequence - 1;
4048 if (message_max > 0 && new_max > address_count_max * message_max)
4049 new_max = address_count_max * message_max;
4050 address_count_max = new_max;
4053 /************************************************************************/
4056 /* Pick off all addresses which have the same transport, errors address,
4057 destination, and extra headers. In some cases they point to the same host
4058 list, but we also need to check for identical host lists generated from
4059 entirely different domains. The host list pointers can be NULL in the case
4060 where the hosts are defined in the transport. There is also a configured
4061 maximum limit of addresses that can be handled at once (see comments above
4062 for how it is computed).
4063 If the transport does not handle multiple domains, enforce that also,
4064 and if it might need a per-address check for this, re-evaluate it.
4067 while ((next = *anchor) && address_count < address_count_max)
4070 if ( (multi_domain || Ustrcmp(next->domain, addr->domain) == 0)
4071 && tp == next->transport
4072 && same_hosts(next->host_list, addr->host_list)
4073 && same_strings(next->prop.errors_address, addr->prop.errors_address)
4074 && same_headers(next->prop.extra_headers, addr->prop.extra_headers)
4075 && same_ugid(tp, next, addr)
4076 && ( next->prop.remove_headers == addr->prop.remove_headers
4077 || ( next->prop.remove_headers
4078 && addr->prop.remove_headers
4079 && Ustrcmp(next->prop.remove_headers, addr->prop.remove_headers) == 0
4083 !tp->expand_multi_domain || (deliver_set_expansions(next), 1),
4085 US"transport", next->transport->name, D_transport,
4086 US"multi_domain", next->transport->multi_domain,
4087 next->transport->expand_multi_domain, &md) == OK
4092 *anchor = next->next;
4094 next->first = addr; /* remember top one (for retry processing) */
4099 else anchor = &(next->next);
4100 deliver_set_expansions(NULL);
4103 /* If we are acting as an MUA wrapper, all addresses must go in a single
4104 transaction. If not, put them back on the chain and yield FALSE. */
4106 if (mua_wrapper && addr_remote)
4108 last->next = addr_remote;
4113 /* If the transport is limited for parallellism, enforce that here.
4114 The hints DB entry is decremented in par_reduce(), when we reap the
4115 transport process. */
4117 if (tpt_parallel_check(tp, addr, &serialize_key))
4118 if ((panicmsg = expand_string_message))
4119 goto panic_continue;
4121 continue; /* Loop for the next set of addresses. */
4123 /* Set up the expansion variables for this set of addresses */
4125 deliver_set_expansions(addr);
4127 /* Ensure any transport-set auth info is fresh */
4128 addr->authenticator = addr->auth_id = addr->auth_sndr = NULL;
4130 /* Compute the return path, expanding a new one if required. The old one
4131 must be set first, as it might be referred to in the expansion. */
4133 if(addr->prop.errors_address)
4134 return_path = addr->prop.errors_address;
4135 #ifdef EXPERIMENTAL_SRS
4136 else if(addr->prop.srs_sender)
4137 return_path = addr->prop.srs_sender;
4140 return_path = sender_address;
4142 if (tp->return_path)
4144 uschar *new_return_path = expand_string(tp->return_path);
4145 if (new_return_path)
4146 return_path = new_return_path;
4147 else if (!expand_string_forcedfail)
4149 panicmsg = string_sprintf("Failed to expand return path \"%s\": %s",
4150 tp->return_path, expand_string_message);
4155 /* Find the uid, gid, and use_initgroups setting for this transport. Failure
4156 logs and sets up error messages, so we just post-process and continue with
4157 the next address. */
4159 if (!findugid(addr, tp, &uid, &gid, &use_initgroups))
4165 /* If this transport has a setup function, call it now so that it gets
4166 run in this process and not in any subprocess. That way, the results of
4167 any setup that are retained by the transport can be reusable. One of the
4168 things the setup does is to set the fallback host lists in the addresses.
4169 That is why it is called at this point, before the continue delivery
4170 processing, because that might use the fallback hosts. */
4173 (void)((tp->setup)(addr->transport, addr, NULL, uid, gid, NULL));
4175 /* If this is a run to continue delivery down an already-established
4176 channel, check that this set of addresses matches the transport and
4177 the channel. If it does not, defer the addresses. If a host list exists,
4178 we must check that the continue host is on the list. Otherwise, the
4179 host is set in the transport. */
4181 continue_more = FALSE; /* In case got set for the last lot */
4182 if (continue_transport)
4184 BOOL ok = Ustrcmp(continue_transport, tp->name) == 0;
4185 if (ok && addr->host_list)
4189 for (h = addr->host_list; h; h = h->next)
4190 if (Ustrcmp(h->name, continue_hostname) == 0)
4191 { ok = TRUE; break; }
4194 /* Addresses not suitable; defer or queue for fallback hosts (which
4195 might be the continue host) and skip to next address. */
4199 DEBUG(D_deliver) debug_printf("not suitable for continue_transport\n");
4200 if (serialize_key) enq_end(serialize_key);
4202 if (addr->fallback_hosts && !fallback)
4204 for (next = addr; ; next = next->next)
4206 next->host_list = next->fallback_hosts;
4207 DEBUG(D_deliver) debug_printf("%s queued for fallback host(s)\n", next->address);
4208 if (!next->next) break;
4210 next->next = addr_fallback;
4211 addr_fallback = addr;
4216 while (next->next) next = next->next;
4217 next->next = addr_defer;
4224 /* Set a flag indicating whether there are further addresses that list
4225 the continued host. This tells the transport to leave the channel open,
4226 but not to pass it to another delivery process. */
4228 for (next = addr_remote; next; next = next->next)
4231 for (h = next->host_list; h; h = h->next)
4232 if (Ustrcmp(h->name, continue_hostname) == 0)
4233 { continue_more = TRUE; break; }
4237 /* The transports set up the process info themselves as they may connect
4238 to more than one remote machine. They also have to set up the filter
4239 arguments, if required, so that the host name and address are available
4242 transport_filter_argv = NULL;
4244 /* Create the pipe for inter-process communication. If pipe creation
4245 fails, it is probably because the value of remote_max_parallel is so
4246 large that too many file descriptors for pipes have been created. Arrange
4247 to wait for a process to finish, and then try again. If we still can't
4248 create a pipe when all processes have finished, break the retry loop. */
4252 if (pipe(pfd) == 0) pipe_done = TRUE;
4253 else if (parcount > 0) parmax = parcount;
4256 /* We need to make the reading end of the pipe non-blocking. There are
4257 two different options for this. Exim is cunningly (I hope!) coded so
4258 that it can use either of them, though it prefers O_NONBLOCK, which
4259 distinguishes between EOF and no-more-data. */
4262 (void)fcntl(pfd[pipe_read], F_SETFL, O_NONBLOCK);
4264 (void)fcntl(pfd[pipe_read], F_SETFL, O_NDELAY);
4267 /* If the maximum number of subprocesses already exist, wait for a process
4268 to finish. If we ran out of file descriptors, parmax will have been reduced
4269 from its initial value of remote_max_parallel. */
4271 par_reduce(parmax - 1, fallback);
4274 /* If we failed to create a pipe and there were no processes to wait
4275 for, we have to give up on this one. Do this outside the above loop
4276 so that we can continue the main loop. */
4280 panicmsg = string_sprintf("unable to create pipe: %s", strerror(errno));
4284 /* Find a free slot in the pardata list. Must do this after the possible
4285 waiting for processes to finish, because a terminating process will free
4288 for (poffset = 0; poffset < remote_max_parallel; poffset++)
4289 if (parlist[poffset].pid == 0)
4292 /* If there isn't one, there has been a horrible disaster. */
4294 if (poffset >= remote_max_parallel)
4296 (void)close(pfd[pipe_write]);
4297 (void)close(pfd[pipe_read]);
4298 panicmsg = US"Unexpectedly no free subprocess slot";
4302 /* Now fork a subprocess to do the remote delivery, but before doing so,
4303 ensure that any cached resourses are released so as not to interfere with
4304 what happens in the subprocess. */
4308 if ((pid = fork()) == 0)
4310 int fd = pfd[pipe_write];
4313 /* Setting this global in the subprocess means we need never clear it */
4314 transport_name = tp->name;
4316 /* There are weird circumstances in which logging is disabled */
4317 disable_logging = tp->disable_logging;
4319 /* Show pids on debug output if parallelism possible */
4321 if (parmax > 1 && (parcount > 0 || addr_remote))
4323 DEBUG(D_any|D_v) debug_selector |= D_pid;
4324 DEBUG(D_deliver) debug_printf("Remote delivery process started\n");
4327 /* Reset the random number generator, so different processes don't all
4328 have the same sequence. In the test harness we want different, but
4329 predictable settings for each delivery process, so do something explicit
4330 here rather they rely on the fixed reset in the random number function. */
4332 random_seed = running_in_test_harness? 42 + 2*delivery_count : 0;
4334 /* Set close-on-exec on the pipe so that it doesn't get passed on to
4335 a new process that may be forked to do another delivery down the same
4338 (void)fcntl(fd, F_SETFD, fcntl(fd, F_GETFD) | FD_CLOEXEC);
4340 /* Close open file descriptors for the pipes of other processes
4341 that are running in parallel. */
4343 for (poffset = 0; poffset < remote_max_parallel; poffset++)
4344 if (parlist[poffset].pid != 0) (void)close(parlist[poffset].fd);
4346 /* This process has inherited a copy of the file descriptor
4347 for the data file, but its file pointer is shared with all the
4348 other processes running in parallel. Therefore, we have to re-open
4349 the file in order to get a new file descriptor with its own
4350 file pointer. We don't need to lock it, as the lock is held by
4351 the parent process. There doesn't seem to be any way of doing
4352 a dup-with-new-file-pointer. */
4354 (void)close(deliver_datafile);
4355 sprintf(CS spoolname, "%s/input/%s/%s-D", spool_directory, message_subdir,
4357 deliver_datafile = Uopen(spoolname, O_RDWR | O_APPEND, 0);
4359 if (deliver_datafile < 0)
4360 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Failed to reopen %s for remote "
4361 "parallel delivery: %s", spoolname, strerror(errno));
4363 /* Set the close-on-exec flag */
4365 (void)fcntl(deliver_datafile, F_SETFD, fcntl(deliver_datafile, F_GETFD) |
4368 /* Set the uid/gid of this process; bombs out on failure. */
4370 exim_setugid(uid, gid, use_initgroups,
4371 string_sprintf("remote delivery to %s with transport=%s",
4372 addr->address, tp->name));
4374 /* Close the unwanted half of this process' pipe, set the process state,
4375 and run the transport. Afterwards, transport_count will contain the number
4376 of bytes written. */
4378 (void)close(pfd[pipe_read]);
4379 set_process_info("delivering %s using %s", message_id, tp->name);
4380 debug_print_string(tp->debug_string);
4381 if (!(tp->info->code)(addr->transport, addr)) replicate_status(addr);
4383 set_process_info("delivering %s (just run %s for %s%s in subprocess)",
4384 message_id, tp->name, addr->address, addr->next ? ", ..." : "");
4386 /* Ensure any cached resources that we used are now released */
4390 /* Pass the result back down the pipe. This is a lot more information
4391 than is needed for a local delivery. We have to send back the error
4392 status for each address, the usability status for each host that is
4393 flagged as unusable, and all the retry items. When TLS is in use, we
4394 send also the cipher and peerdn information. Each type of information
4395 is flagged by an identifying byte, and is then in a fixed format (with
4396 strings terminated by zeros), and there is a final terminator at the
4397 end. The host information and retry information is all attached to
4398 the first address, so that gets sent at the start. */
4400 /* Host unusability information: for most success cases this will
4403 for (h = addr->host_list; h; h = h->next)
4405 if (!h->address || h->status < hstatus_unusable) continue;
4406 sprintf(CS big_buffer, "%c%c%s", h->status, h->why, h->address);
4407 rmt_dlv_checked_write(fd, 'H', '0', big_buffer, Ustrlen(big_buffer+2) + 3);
4410 /* The number of bytes written. This is the same for each address. Even
4411 if we sent several copies of the message down the same connection, the
4412 size of each one is the same, and it's that value we have got because
4413 transport_count gets reset before calling transport_write_message(). */
4415 memcpy(big_buffer, &transport_count, sizeof(transport_count));
4416 rmt_dlv_checked_write(fd, 'S', '0', big_buffer, sizeof(transport_count));
4418 /* Information about what happened to each address. Four item types are
4419 used: an optional 'X' item first, for TLS information, then an optional "C"
4420 item for any client-auth info followed by 'R' items for any retry settings,
4421 and finally an 'A' item for the remaining data. */
4423 for(; addr; addr = addr->next)
4428 /* The certificate verification status goes into the flags */
4429 if (tls_out.certificate_verified) setflag(addr, af_cert_verified);
4430 #ifdef EXPERIMENTAL_DANE
4431 if (tls_out.dane_verified) setflag(addr, af_dane_verified);
4434 /* Use an X item only if there's something to send */
4439 sprintf(CS ptr, "%.128s", addr->cipher);
4445 sprintf(CS ptr, "%.512s", addr->peerdn);
4449 rmt_dlv_checked_write(fd, 'X', '1', big_buffer, ptr - big_buffer);
4454 if (!tls_export_cert(ptr, big_buffer_size-2, addr->peercert))
4458 rmt_dlv_checked_write(fd, 'X', '2', big_buffer, ptr - big_buffer);
4463 if (!tls_export_cert(ptr, big_buffer_size-2, addr->ourcert))
4467 rmt_dlv_checked_write(fd, 'X', '3', big_buffer, ptr - big_buffer);
4469 # ifndef DISABLE_OCSP
4470 if (addr->ocsp > OCSP_NOT_REQ)
4473 sprintf(CS ptr, "%c", addr->ocsp + '0');
4475 rmt_dlv_checked_write(fd, 'X', '4', big_buffer, ptr - big_buffer);
4478 #endif /*SUPPORT_TLS*/
4480 if (client_authenticator)
4483 sprintf(CS big_buffer, "%.64s", client_authenticator);
4485 rmt_dlv_checked_write(fd, 'C', '1', big_buffer, ptr - big_buffer);
4487 if (client_authenticated_id)
4490 sprintf(CS big_buffer, "%.64s", client_authenticated_id);
4492 rmt_dlv_checked_write(fd, 'C', '2', big_buffer, ptr - big_buffer);
4494 if (client_authenticated_sender)
4497 sprintf(CS big_buffer, "%.64s", client_authenticated_sender);
4499 rmt_dlv_checked_write(fd, 'C', '3', big_buffer, ptr - big_buffer);
4502 #ifndef DISABLE_PRDR
4503 if (addr->flags & af_prdr_used)
4504 rmt_dlv_checked_write(fd, 'P', '0', NULL, 0);
4507 memcpy(big_buffer, &addr->dsn_aware, sizeof(addr->dsn_aware));
4508 rmt_dlv_checked_write(fd, 'D', '0', big_buffer, sizeof(addr->dsn_aware));
4509 DEBUG(D_deliver) debug_printf("DSN write: addr->dsn_aware = %d\n", addr->dsn_aware);
4511 /* Retry information: for most success cases this will be null. */
4513 for (r = addr->retries; r; r = r->next)
4515 sprintf(CS big_buffer, "%c%.500s", r->flags, r->key);
4516 ptr = big_buffer + Ustrlen(big_buffer+2) + 3;
4517 memcpy(ptr, &(r->basic_errno), sizeof(r->basic_errno));
4518 ptr += sizeof(r->basic_errno);
4519 memcpy(ptr, &(r->more_errno), sizeof(r->more_errno));
4520 ptr += sizeof(r->more_errno);
4521 if (!r->message) *ptr++ = 0; else
4523 sprintf(CS ptr, "%.512s", r->message);
4526 rmt_dlv_checked_write(fd, 'R', '0', big_buffer, ptr - big_buffer);
4529 #ifdef EXPERIMENTAL_DSN_INFO
4530 /*um, are they really per-addr? Other per-conn stuff is not (auth, tls). But host_used is! */
4531 if (addr->smtp_greeting)
4534 DEBUG(D_deliver) debug_printf("smtp_greeting '%s'\n", addr->smtp_greeting);
4535 sprintf(CS ptr, "%.128s", addr->smtp_greeting);
4537 if (addr->helo_response)
4539 DEBUG(D_deliver) debug_printf("helo_response '%s'\n", addr->helo_response);
4540 sprintf(CS ptr, "%.128s", addr->helo_response);
4545 rmt_dlv_checked_write(fd, 'A', '1', big_buffer, ptr - big_buffer);
4549 /* The rest of the information goes in an 'A0' item. */
4551 sprintf(CS big_buffer, "%c%c", addr->transport_return,
4552 addr->special_action);
4553 ptr = big_buffer + 2;
4554 memcpy(ptr, &(addr->basic_errno), sizeof(addr->basic_errno));
4555 ptr += sizeof(addr->basic_errno);
4556 memcpy(ptr, &(addr->more_errno), sizeof(addr->more_errno));
4557 ptr += sizeof(addr->more_errno);
4558 memcpy(ptr, &(addr->flags), sizeof(addr->flags));
4559 ptr += sizeof(addr->flags);
4561 if (!addr->message) *ptr++ = 0; else
4563 sprintf(CS ptr, "%.1024s", addr->message);
4567 if (!addr->user_message) *ptr++ = 0; else
4569 sprintf(CS ptr, "%.1024s", addr->user_message);
4573 if (!addr->host_used) *ptr++ = 0; else
4575 sprintf(CS ptr, "%.256s", addr->host_used->name);
4577 sprintf(CS ptr, "%.64s", addr->host_used->address);
4579 memcpy(ptr, &(addr->host_used->port), sizeof(addr->host_used->port));
4580 ptr += sizeof(addr->host_used->port);
4582 /* DNS lookup status */
4583 *ptr++ = addr->host_used->dnssec==DS_YES ? '2'
4584 : addr->host_used->dnssec==DS_NO ? '1' : '0';
4587 rmt_dlv_checked_write(fd, 'A', '0', big_buffer, ptr - big_buffer);
4590 /* Local interface address/port */
4591 #ifdef EXPERIMENTAL_DSN_INFO
4592 if (sending_ip_address)
4594 if (LOGGING(incoming_interface) && sending_ip_address)
4597 uschar * ptr = big_buffer;
4598 sprintf(CS ptr, "%.128s", sending_ip_address);
4600 sprintf(CS ptr, "%d", sending_port);
4603 rmt_dlv_checked_write(fd, 'I', '0', big_buffer, ptr - big_buffer);
4606 /* Add termination flag, close the pipe, and that's it. The character
4607 after 'Z' indicates whether continue_transport is now NULL or not.
4608 A change from non-NULL to NULL indicates a problem with a continuing
4611 big_buffer[0] = continue_transport ? '1' : '0';
4612 rmt_dlv_checked_write(fd, 'Z', '0', big_buffer, 1);
4617 /* Back in the mainline: close the unwanted half of the pipe. */
4619 (void)close(pfd[pipe_write]);
4621 /* Fork failed; defer with error message */
4625 (void)close(pfd[pipe_read]);
4626 panicmsg = string_sprintf("fork failed for remote delivery to %s: %s",
4627 addr->domain, strerror(errno));
4631 /* Fork succeeded; increment the count, and remember relevant data for
4632 when the process finishes. */
4635 parlist[poffset].addrlist = parlist[poffset].addr = addr;
4636 parlist[poffset].pid = pid;
4637 parlist[poffset].fd = pfd[pipe_read];
4638 parlist[poffset].done = FALSE;
4639 parlist[poffset].msg = NULL;
4640 parlist[poffset].return_path = return_path;
4642 /* If the process we've just started is sending a message down an existing
4643 channel, wait for it now. This ensures that only one such process runs at
4644 once, whatever the value of remote_max parallel. Otherwise, we might try to
4645 send two or more messages simultaneously down the same channel. This could
4646 happen if there are different domains that include the same host in otherwise
4647 different host lists.
4649 Also, if the transport closes down the channel, this information gets back
4650 (continue_transport gets set to NULL) before we consider any other addresses
4653 if (continue_transport) par_reduce(0, fallback);
4655 /* Otherwise, if we are running in the test harness, wait a bit, to let the
4656 newly created process get going before we create another process. This should
4657 ensure repeatability in the tests. We only need to wait a tad. */
4659 else if (running_in_test_harness) millisleep(500);
4664 if (serialize_key) enq_end(serialize_key);
4666 remote_post_process(addr, LOG_MAIN|LOG_PANIC, panicmsg, fallback);
4670 /* Reached the end of the list of addresses. Wait for all the subprocesses that
4671 are still running and post-process their addresses. */
4673 par_reduce(0, fallback);
4680 /*************************************************
4681 * Split an address into local part and domain *
4682 *************************************************/
4684 /* This function initializes an address for routing by splitting it up into a
4685 local part and a domain. The local part is set up twice - once in its original
4686 casing, and once in lower case, and it is dequoted. We also do the "percent
4687 hack" for configured domains. This may lead to a DEFER result if a lookup
4688 defers. When a percent-hacking takes place, we insert a copy of the original
4689 address as a new parent of this address, as if we have had a redirection.
4692 addr points to an addr_item block containing the address
4695 DEFER - could not determine if domain is %-hackable
4699 deliver_split_address(address_item *addr)
4701 uschar *address = addr->address;
4702 uschar *domain = Ustrrchr(address, '@');
4704 int len = domain - address;
4706 addr->domain = string_copylc(domain+1); /* Domains are always caseless */
4708 /* The implication in the RFCs (though I can't say I've seen it spelled out
4709 explicitly) is that quoting should be removed from local parts at the point
4710 where they are locally interpreted. [The new draft "821" is more explicit on
4711 this, Jan 1999.] We know the syntax is valid, so this can be done by simply
4712 removing quoting backslashes and any unquoted doublequotes. */
4714 t = addr->cc_local_part = store_get(len+1);
4717 register int c = *address++;
4718 if (c == '\"') continue;
4728 /* We do the percent hack only for those domains that are listed in
4729 percent_hack_domains. A loop is required, to copy with multiple %-hacks. */
4731 if (percent_hack_domains)
4734 uschar *new_address = NULL;
4735 uschar *local_part = addr->cc_local_part;
4737 deliver_domain = addr->domain; /* set $domain */
4739 while ( (rc = match_isinlist(deliver_domain, (const uschar **)&percent_hack_domains, 0,
4740 &domainlist_anchor, addr->domain_cache, MCL_DOMAIN, TRUE, NULL))
4742 && (t = Ustrrchr(local_part, '%')) != NULL
4745 new_address = string_copy(local_part);
4746 new_address[t - local_part] = '@';
4747 deliver_domain = string_copylc(t+1);
4748 local_part = string_copyn(local_part, t - local_part);
4751 if (rc == DEFER) return DEFER; /* lookup deferred */
4753 /* If hackery happened, set up new parent and alter the current address. */
4757 address_item *new_parent = store_get(sizeof(address_item));
4758 *new_parent = *addr;
4759 addr->parent = new_parent;
4760 addr->address = new_address;
4761 addr->unique = string_copy(new_address);
4762 addr->domain = deliver_domain;
4763 addr->cc_local_part = local_part;
4764 DEBUG(D_deliver) debug_printf("%%-hack changed address to: %s\n",
4769 /* Create the lowercased version of the final local part, and make that the
4770 default one to be used. */
4772 addr->local_part = addr->lc_local_part = string_copylc(addr->cc_local_part);
4779 /*************************************************
4780 * Get next error message text *
4781 *************************************************/
4783 /* If f is not NULL, read the next "paragraph", from a customized error message
4784 text file, terminated by a line containing ****, and expand it.
4787 f NULL or a file to read from
4788 which string indicating which string (for errors)
4790 Returns: NULL or an expanded string
4794 next_emf(FILE *f, uschar *which)
4798 uschar *para, *yield;
4801 if (!f) return NULL;
4803 if (!Ufgets(buffer, sizeof(buffer), f) || Ustrcmp(buffer, "****\n") == 0)
4806 para = store_get(size);
4809 para = string_cat(para, &size, &ptr, buffer, Ustrlen(buffer));
4810 if (!Ufgets(buffer, sizeof(buffer), f) || Ustrcmp(buffer, "****\n") == 0)
4815 if ((yield = expand_string(para)))
4818 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand string from "
4819 "bounce_message_file or warn_message_file (%s): %s", which,
4820 expand_string_message);
4827 /*************************************************
4828 * Close down a passed transport channel *
4829 *************************************************/
4831 /* This function is called when a passed transport channel cannot be used.
4832 It attempts to close it down tidily. The yield is always DELIVER_NOT_ATTEMPTED
4833 so that the function call can be the argument of a "return" statement.
4836 Returns: DELIVER_NOT_ATTEMPTED
4840 continue_closedown(void)
4842 if (continue_transport)
4844 transport_instance *t;
4845 for (t = transports; t; t = t->next)
4846 if (Ustrcmp(t->name, continue_transport) == 0)
4848 if (t->info->closedown) (t->info->closedown)(t);
4852 return DELIVER_NOT_ATTEMPTED;
4858 /*************************************************
4859 * Print address information *
4860 *************************************************/
4862 /* This function is called to output an address, or information about an
4863 address, for bounce or defer messages. If the hide_child flag is set, all we
4864 output is the original ancestor address.
4867 addr points to the address
4868 f the FILE to print to
4869 si an initial string
4870 sc a continuation string for before "generated"
4873 Returns: TRUE if the address is not hidden
4877 print_address_information(address_item *addr, FILE *f, uschar *si, uschar *sc,
4881 uschar *printed = US"";
4882 address_item *ancestor = addr;
4883 while (ancestor->parent) ancestor = ancestor->parent;
4885 fprintf(f, "%s", CS si);
4887 if (addr->parent && testflag(addr, af_hide_child))
4889 printed = US"an undisclosed address";
4892 else if (!testflag(addr, af_pfr) || !addr->parent)
4893 printed = addr->address;
4897 uschar *s = addr->address;
4900 if (addr->address[0] == '>') { ss = US"mail"; s++; }
4901 else if (addr->address[0] == '|') ss = US"pipe";
4904 fprintf(f, "%s to %s%sgenerated by ", ss, s, sc);
4905 printed = addr->parent->address;
4908 fprintf(f, "%s", CS string_printing(printed));
4910 if (ancestor != addr)
4912 uschar *original = ancestor->onetime_parent;
4913 if (!original) original= ancestor->address;
4914 if (strcmpic(original, printed) != 0)
4915 fprintf(f, "%s(%sgenerated from %s)", sc,
4916 ancestor != addr->parent ? "ultimately " : "",
4917 string_printing(original));
4920 if (addr->host_used)
4921 fprintf(f, "\n host %s [%s]",
4922 addr->host_used->name, addr->host_used->address);
4924 fprintf(f, "%s", CS se);
4932 /*************************************************
4933 * Print error for an address *
4934 *************************************************/
4936 /* This function is called to print the error information out of an address for
4937 a bounce or a warning message. It tries to format the message reasonably by
4938 introducing newlines. All lines are indented by 4; the initial printing
4939 position must be set before calling.
4941 This function used always to print the error. Nowadays we want to restrict it
4942 to cases such as LMTP/SMTP errors from a remote host, and errors from :fail:
4943 and filter "fail". We no longer pass other information willy-nilly in bounce
4944 and warning messages. Text in user_message is always output; text in message
4945 only if the af_pass_message flag is set.
4949 f the FILE to print on
4956 print_address_error(address_item *addr, FILE *f, uschar *t)
4958 int count = Ustrlen(t);
4959 uschar *s = testflag(addr, af_pass_message)? addr->message : NULL;
4961 if (!s && !(s = addr->user_message))
4964 fprintf(f, "\n %s", t);
4967 if (*s == '\\' && s[1] == 'n')
4977 if (*s++ == ':' && isspace(*s) && count > 45)
4979 fprintf(f, "\n "); /* sic (because space follows) */
4986 /***********************************************************
4987 * Print Diagnostic-Code for an address *
4988 ************************************************************/
4990 /* This function is called to print the error information out of an address for
4991 a bounce or a warning message. It tries to format the message reasonably as
4992 required by RFC 3461 by adding a space after each newline
4994 it uses the same logic as print_address_error() above. if af_pass_message is true
4995 and addr->message is set it uses the remote host answer. if not addr->user_message
4996 is used instead if available.
5000 f the FILE to print on
5006 print_dsn_diagnostic_code(const address_item *addr, FILE *f)
5008 uschar *s = testflag(addr, af_pass_message) ? addr->message : NULL;
5010 /* af_pass_message and addr->message set ? print remote host answer */
5014 debug_printf("DSN Diagnostic-Code: addr->message = %s\n", addr->message);
5016 /* search first ": ". we assume to find the remote-MTA answer there */
5017 if (!(s = Ustrstr(addr->message, ": ")))
5018 return; /* not found, bail out */
5019 s += 2; /* skip ": " */
5020 fprintf(f, "Diagnostic-Code: smtp; ");
5022 /* no message available. do nothing */
5026 if (*s == '\\' && s[1] == 'n')
5028 fputs("\n ", f); /* as defined in RFC 3461 */
5038 /*************************************************
5039 * Check list of addresses for duplication *
5040 *************************************************/
5042 /* This function was introduced when the test for duplicate addresses that are
5043 not pipes, files, or autoreplies was moved from the middle of routing to when
5044 routing was complete. That was to fix obscure cases when the routing history
5045 affects the subsequent routing of identical addresses. This function is called
5046 after routing, to check that the final routed addresses are not duplicates.
5048 If we detect a duplicate, we remember what it is a duplicate of. Note that
5049 pipe, file, and autoreply de-duplication is handled during routing, so we must
5050 leave such "addresses" alone here, as otherwise they will incorrectly be
5053 Argument: address of list anchor
5058 do_duplicate_check(address_item **anchor)
5061 while ((addr = *anchor))
5064 if (testflag(addr, af_pfr))
5066 anchor = &(addr->next);
5068 else if ((tnode = tree_search(tree_duplicates, addr->unique)))
5070 DEBUG(D_deliver|D_route)
5071 debug_printf("%s is a duplicate address: discarded\n", addr->unique);
5072 *anchor = addr->next;
5073 addr->dupof = tnode->data.ptr;
5074 addr->next = addr_duplicate;
5075 addr_duplicate = addr;
5079 tree_add_duplicate(addr->unique, addr);
5080 anchor = &(addr->next);
5088 /*************************************************
5089 * Deliver one message *
5090 *************************************************/
5092 /* This is the function which is called when a message is to be delivered. It
5093 is passed the id of the message. It is possible that the message no longer
5094 exists, if some other process has delivered it, and it is also possible that
5095 the message is being worked on by another process, in which case the data file
5098 If no delivery is attempted for any of the above reasons, the function returns
5099 DELIVER_NOT_ATTEMPTED.
5101 If the give_up flag is set true, do not attempt any deliveries, but instead
5102 fail all outstanding addresses and return the message to the sender (or
5105 A delivery operation has a process all to itself; we never deliver more than
5106 one message in the same process. Therefore we needn't worry too much about
5110 id the id of the message to be delivered
5111 forced TRUE if delivery was forced by an administrator; this overrides
5112 retry delays and causes a delivery to be tried regardless
5113 give_up TRUE if an administrator has requested that delivery attempts
5116 Returns: When the global variable mua_wrapper is FALSE:
5117 DELIVER_ATTEMPTED_NORMAL if a delivery attempt was made
5118 DELIVER_NOT_ATTEMPTED otherwise (see comment above)
5119 When the global variable mua_wrapper is TRUE:
5120 DELIVER_MUA_SUCCEEDED if delivery succeeded
5121 DELIVER_MUA_FAILED if delivery failed
5122 DELIVER_NOT_ATTEMPTED if not attempted (should not occur)
5126 deliver_message(uschar *id, BOOL forced, BOOL give_up)
5129 int final_yield = DELIVER_ATTEMPTED_NORMAL;
5130 time_t now = time(NULL);
5131 address_item *addr_last = NULL;
5132 uschar *filter_message = NULL;
5134 int process_recipients = RECIP_ACCEPT;
5137 extern int acl_where;
5139 uschar *info = queue_run_pid == (pid_t)0
5140 ? string_sprintf("delivering %s", id)
5141 : string_sprintf("delivering %s (queue run pid %d)", id, queue_run_pid);
5143 /* If the D_process_info bit is on, set_process_info() will output debugging
5144 information. If not, we want to show this initial information if D_deliver or
5145 D_queue_run is set or in verbose mode. */
5147 set_process_info("%s", info);
5149 if ( !(debug_selector & D_process_info)
5150 && (debug_selector & (D_deliver|D_queue_run|D_v))
5152 debug_printf("%s\n", info);
5154 /* Ensure that we catch any subprocesses that are created. Although Exim
5155 sets SIG_DFL as its initial default, some routes through the code end up
5156 here with it set to SIG_IGN - cases where a non-synchronous delivery process
5157 has been forked, but no re-exec has been done. We use sigaction rather than
5158 plain signal() on those OS where SA_NOCLDWAIT exists, because we want to be
5159 sure it is turned off. (There was a problem on AIX with this.) */
5163 struct sigaction act;
5164 act.sa_handler = SIG_DFL;
5165 sigemptyset(&(act.sa_mask));
5167 sigaction(SIGCHLD, &act, NULL);
5170 signal(SIGCHLD, SIG_DFL);
5173 /* Make the forcing flag available for routers and transports, set up the
5174 global message id field, and initialize the count for returned files and the
5175 message size. This use of strcpy() is OK because the length id is checked when
5176 it is obtained from a command line (the -M or -q options), and otherwise it is
5177 known to be a valid message id. */
5179 Ustrcpy(message_id, id);
5180 deliver_force = forced;
5184 /* Initialize some flags */
5186 update_spool = FALSE;
5187 remove_journal = TRUE;
5189 /* Set a known context for any ACLs we call via expansions */
5190 acl_where = ACL_WHERE_DELIVERY;
5192 /* Reset the random number generator, so that if several delivery processes are
5193 started from a queue runner that has already used random numbers (for sorting),
5194 they don't all get the same sequence. */
5198 /* Open and lock the message's data file. Exim locks on this one because the
5199 header file may get replaced as it is re-written during the delivery process.
5200 Any failures cause messages to be written to the log, except for missing files
5201 while queue running - another process probably completed delivery. As part of
5202 opening the data file, message_subdir gets set. */
5204 if (!spool_open_datafile(id))
5205 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5207 /* The value of message_size at this point has been set to the data length,
5208 plus one for the blank line that notionally precedes the data. */
5210 /* Now read the contents of the header file, which will set up the headers in
5211 store, and also the list of recipients and the tree of non-recipients and
5212 assorted flags. It updates message_size. If there is a reading or format error,
5213 give up; if the message has been around for sufficiently long, remove it. */
5215 sprintf(CS spoolname, "%s-H", id);
5216 if ((rc = spool_read_header(spoolname, TRUE, TRUE)) != spool_read_OK)
5218 if (errno == ERRNO_SPOOLFORMAT)
5220 struct stat statbuf;
5221 sprintf(CS big_buffer, "%s/input/%s/%s", spool_directory, message_subdir,
5223 if (Ustat(big_buffer, &statbuf) == 0)
5224 log_write(0, LOG_MAIN, "Format error in spool file %s: "
5225 "size=" OFF_T_FMT, spoolname, statbuf.st_size);
5226 else log_write(0, LOG_MAIN, "Format error in spool file %s", spoolname);
5229 log_write(0, LOG_MAIN, "Error reading spool file %s: %s", spoolname,
5232 /* If we managed to read the envelope data, received_time contains the
5233 time the message was received. Otherwise, we can calculate it from the
5236 if (rc != spool_read_hdrerror)
5239 for (i = 0; i < 6; i++)
5240 received_time = received_time * BASE_62 + tab62[id[i] - '0'];
5243 /* If we've had this malformed message too long, sling it. */
5245 if (now - received_time > keep_malformed)
5247 sprintf(CS spoolname, "%s/msglog/%s/%s", spool_directory, message_subdir, id);
5249 sprintf(CS spoolname, "%s/input/%s/%s-D", spool_directory, message_subdir, id);
5251 sprintf(CS spoolname, "%s/input/%s/%s-H", spool_directory, message_subdir, id);
5253 sprintf(CS spoolname, "%s/input/%s/%s-J", spool_directory, message_subdir, id);
5255 log_write(0, LOG_MAIN, "Message removed because older than %s",
5256 readconf_printtime(keep_malformed));
5259 (void)close(deliver_datafile);
5260 deliver_datafile = -1;
5261 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5264 /* The spool header file has been read. Look to see if there is an existing
5265 journal file for this message. If there is, it means that a previous delivery
5266 attempt crashed (program or host) before it could update the spool header file.
5267 Read the list of delivered addresses from the journal and add them to the
5268 nonrecipients tree. Then update the spool file. We can leave the journal in
5269 existence, as it will get further successful deliveries added to it in this
5270 run, and it will be deleted if this function gets to its end successfully.
5271 Otherwise it might be needed again. */
5273 sprintf(CS spoolname, "%s/input/%s/%s-J", spool_directory, message_subdir, id);
5274 jread = Ufopen(spoolname, "rb");
5277 while (Ufgets(big_buffer, big_buffer_size, jread))
5279 int n = Ustrlen(big_buffer);
5280 big_buffer[n-1] = 0;
5281 tree_add_nonrecipient(big_buffer);
5282 DEBUG(D_deliver) debug_printf("Previously delivered address %s taken from "
5283 "journal file\n", big_buffer);
5285 (void)fclose(jread);
5286 /* Panic-dies on error */
5287 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
5289 else if (errno != ENOENT)
5291 log_write(0, LOG_MAIN|LOG_PANIC, "attempt to open journal for reading gave: "
5292 "%s", strerror(errno));
5293 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5296 /* A null recipients list indicates some kind of disaster. */
5298 if (!recipients_list)
5300 (void)close(deliver_datafile);
5301 deliver_datafile = -1;
5302 log_write(0, LOG_MAIN, "Spool error: no recipients for %s", spoolname);
5303 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5307 /* Handle a message that is frozen. There are a number of different things that
5308 can happen, but in the default situation, unless forced, no delivery is
5313 #ifdef SUPPORT_MOVE_FROZEN_MESSAGES
5314 /* Moving to another directory removes the message from Exim's view. Other
5315 tools must be used to deal with it. Logging of this action happens in
5316 spool_move_message() and its subfunctions. */
5318 if ( move_frozen_messages
5319 && spool_move_message(id, message_subdir, US"", US"F")
5321 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5324 /* For all frozen messages (bounces or not), timeout_frozen_after sets the
5325 maximum time to keep messages that are frozen. Thaw if we reach it, with a
5326 flag causing all recipients to be failed. The time is the age of the
5327 message, not the time since freezing. */
5329 if (timeout_frozen_after > 0 && message_age >= timeout_frozen_after)
5331 log_write(0, LOG_MAIN, "cancelled by timeout_frozen_after");
5332 process_recipients = RECIP_FAIL_TIMEOUT;
5335 /* For bounce messages (and others with no sender), thaw if the error message
5336 ignore timer is exceeded. The message will be discarded if this delivery
5339 else if (sender_address[0] == 0 && message_age >= ignore_bounce_errors_after)
5341 log_write(0, LOG_MAIN, "Unfrozen by errmsg timer");
5344 /* If this is a bounce message, or there's no auto thaw, or we haven't
5345 reached the auto thaw time yet, and this delivery is not forced by an admin
5346 user, do not attempt delivery of this message. Note that forced is set for
5347 continuing messages down the same channel, in order to skip load checking and
5348 ignore hold domains, but we don't want unfreezing in that case. */
5352 if ( ( sender_address[0] == 0
5354 || now <= deliver_frozen_at + auto_thaw
5356 && ( !forced || !deliver_force_thaw
5357 || !admin_user || continue_hostname
5360 (void)close(deliver_datafile);
5361 deliver_datafile = -1;
5362 log_write(L_skip_delivery, LOG_MAIN, "Message is frozen");
5363 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5366 /* If delivery was forced (by an admin user), assume a manual thaw.
5367 Otherwise it's an auto thaw. */
5371 deliver_manual_thaw = TRUE;
5372 log_write(0, LOG_MAIN, "Unfrozen by forced delivery");
5374 else log_write(0, LOG_MAIN, "Unfrozen by auto-thaw");
5377 /* We get here if any of the rules for unfreezing have triggered. */
5379 deliver_freeze = FALSE;
5380 update_spool = TRUE;
5384 /* Open the message log file if we are using them. This records details of
5385 deliveries, deferments, and failures for the benefit of the mail administrator.
5386 The log is not used by exim itself to track the progress of a message; that is
5387 done by rewriting the header spool file. */
5394 sprintf(CS spoolname, "%s/msglog/%s/%s", spool_directory, message_subdir, id);
5395 fd = open_msglog_file(spoolname, SPOOL_MODE, &error);
5399 log_write(0, LOG_MAIN|LOG_PANIC, "Couldn't %s message log %s: %s", error,
5400 spoolname, strerror(errno));
5401 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5404 /* Make a C stream out of it. */
5406 if (!(message_log = fdopen(fd, "a")))
5408 log_write(0, LOG_MAIN|LOG_PANIC, "Couldn't fdopen message log %s: %s",
5409 spoolname, strerror(errno));
5410 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5415 /* If asked to give up on a message, log who did it, and set the action for all
5420 struct passwd *pw = getpwuid(real_uid);
5421 log_write(0, LOG_MAIN, "cancelled by %s",
5422 pw ? US pw->pw_name : string_sprintf("uid %ld", (long int)real_uid));
5423 process_recipients = RECIP_FAIL;
5426 /* Otherwise, if there are too many Received: headers, fail all recipients. */
5428 else if (received_count > received_headers_max)
5429 process_recipients = RECIP_FAIL_LOOP;
5431 /* Otherwise, if a system-wide, address-independent message filter is
5432 specified, run it now, except in the case when we are failing all recipients as
5433 a result of timeout_frozen_after. If the system filter yields "delivered", then
5434 ignore the true recipients of the message. Failure of the filter file is
5435 logged, and the delivery attempt fails. */
5437 else if (system_filter && process_recipients != RECIP_FAIL_TIMEOUT)
5442 redirect_block redirect;
5444 if (system_filter_uid_set)
5446 ugid.uid = system_filter_uid;
5447 ugid.gid = system_filter_gid;
5448 ugid.uid_set = ugid.gid_set = TRUE;
5452 ugid.uid_set = ugid.gid_set = FALSE;
5455 return_path = sender_address;
5456 enable_dollar_recipients = TRUE; /* Permit $recipients in system filter */
5457 system_filtering = TRUE;
5459 /* Any error in the filter file causes a delivery to be abandoned. */
5461 redirect.string = system_filter;
5462 redirect.isfile = TRUE;
5463 redirect.check_owner = redirect.check_group = FALSE;
5464 redirect.owners = NULL;
5465 redirect.owngroups = NULL;
5467 redirect.modemask = 0;
5469 DEBUG(D_deliver|D_filter) debug_printf("running system filter\n");
5472 &redirect, /* Where the data is */
5473 RDO_DEFER | /* Turn on all the enabling options */
5474 RDO_FAIL | /* Leave off all the disabling options */
5479 NULL, /* No :include: restriction (not used in filter) */
5480 NULL, /* No sieve vacation directory (not sieve!) */
5481 NULL, /* No sieve enotify mailto owner (not sieve!) */
5482 NULL, /* No sieve user address (not sieve!) */
5483 NULL, /* No sieve subaddress (not sieve!) */
5484 &ugid, /* uid/gid data */
5485 &addr_new, /* Where to hang generated addresses */
5486 &filter_message, /* Where to put error message */
5487 NULL, /* Don't skip syntax errors */
5488 &filtertype, /* Will always be set to FILTER_EXIM for this call */
5489 US"system filter"); /* For error messages */
5491 DEBUG(D_deliver|D_filter) debug_printf("system filter returned %d\n", rc);
5493 if (rc == FF_ERROR || rc == FF_NONEXIST)
5495 (void)close(deliver_datafile);
5496 deliver_datafile = -1;
5497 log_write(0, LOG_MAIN|LOG_PANIC, "Error in system filter: %s",
5498 string_printing(filter_message));
5499 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5502 /* Reset things. If the filter message is an empty string, which can happen
5503 for a filter "fail" or "freeze" command with no text, reset it to NULL. */
5505 system_filtering = FALSE;
5506 enable_dollar_recipients = FALSE;
5507 if (filter_message && filter_message[0] == 0) filter_message = NULL;
5509 /* Save the values of the system filter variables so that user filters
5512 memcpy(filter_sn, filter_n, sizeof(filter_sn));
5514 /* The filter can request that delivery of the original addresses be
5519 process_recipients = RECIP_DEFER;
5520 deliver_msglog("Delivery deferred by system filter\n");
5521 log_write(0, LOG_MAIN, "Delivery deferred by system filter");
5524 /* The filter can request that a message be frozen, but this does not
5525 take place if the message has been manually thawed. In that case, we must
5526 unset "delivered", which is forced by the "freeze" command to make -bF
5529 else if (rc == FF_FREEZE && !deliver_manual_thaw)
5531 deliver_freeze = TRUE;
5532 deliver_frozen_at = time(NULL);
5533 process_recipients = RECIP_DEFER;
5534 frozen_info = string_sprintf(" by the system filter%s%s",
5535 filter_message ? US": " : US"",
5536 filter_message ? filter_message : US"");
5539 /* The filter can request that a message be failed. The error message may be
5540 quite long - it is sent back to the sender in the bounce - but we don't want
5541 to fill up the log with repetitions of it. If it starts with << then the text
5542 between << and >> is written to the log, with the rest left for the bounce
5545 else if (rc == FF_FAIL)
5547 uschar *colon = US"";
5548 uschar *logmsg = US"";
5551 process_recipients = RECIP_FAIL_FILTER;
5557 if ( filter_message[0] == '<'
5558 && filter_message[1] == '<'
5559 && (logend = Ustrstr(filter_message, ">>"))
5562 logmsg = filter_message + 2;
5563 loglen = logend - logmsg;
5564 filter_message = logend + 2;
5565 if (filter_message[0] == 0) filter_message = NULL;
5569 logmsg = filter_message;
5570 loglen = Ustrlen(filter_message);
5574 log_write(0, LOG_MAIN, "cancelled by system filter%s%.*s", colon, loglen,
5578 /* Delivery can be restricted only to those recipients (if any) that the
5579 filter specified. */
5581 else if (rc == FF_DELIVERED)
5583 process_recipients = RECIP_IGNORE;
5585 log_write(0, LOG_MAIN, "original recipients ignored (system filter)");
5587 log_write(0, LOG_MAIN, "=> discarded (system filter)");
5590 /* If any new addresses were created by the filter, fake up a "parent"
5591 for them. This is necessary for pipes, etc., which are expected to have
5592 parents, and it also gives some sensible logging for others. Allow
5593 pipes, files, and autoreplies, and run them as the filter uid if set,
5594 otherwise as the current uid. */
5598 int uid = (system_filter_uid_set)? system_filter_uid : geteuid();
5599 int gid = (system_filter_gid_set)? system_filter_gid : getegid();
5601 /* The text "system-filter" is tested in transport_set_up_command() and in
5602 set_up_shell_command() in the pipe transport, to enable them to permit
5603 $recipients, so don't change it here without also changing it there. */
5605 address_item *p = addr_new;
5606 address_item *parent = deliver_make_addr(US"system-filter", FALSE);
5608 parent->domain = string_copylc(qualify_domain_recipient);
5609 parent->local_part = US"system-filter";
5611 /* As part of this loop, we arrange for addr_last to end up pointing
5612 at the final address. This is used if we go on to add addresses for the
5613 original recipients. */
5617 if (parent->child_count == SHRT_MAX)
5618 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "system filter generated more "
5619 "than %d delivery addresses", SHRT_MAX);
5620 parent->child_count++;
5623 if (testflag(p, af_pfr))
5629 setflag(p, af_uid_set |
5635 /* Find the name of the system filter's appropriate pfr transport */
5637 if (p->address[0] == '|')
5640 tpname = system_filter_pipe_transport;
5641 address_pipe = p->address;
5643 else if (p->address[0] == '>')
5646 tpname = system_filter_reply_transport;
5650 if (p->address[Ustrlen(p->address)-1] == '/')
5652 type = US"directory";
5653 tpname = system_filter_directory_transport;
5658 tpname = system_filter_file_transport;
5660 address_file = p->address;
5663 /* Now find the actual transport, first expanding the name. We have
5664 set address_file or address_pipe above. */
5668 uschar *tmp = expand_string(tpname);
5669 address_file = address_pipe = NULL;
5671 p->message = string_sprintf("failed to expand \"%s\" as a "
5672 "system filter transport name", tpname);
5677 p->message = string_sprintf("system_filter_%s_transport is unset",
5683 transport_instance *tp;
5684 for (tp = transports; tp; tp = tp->next)
5686 if (Ustrcmp(tp->name, tpname) == 0)
5693 p->message = string_sprintf("failed to find \"%s\" transport "
5694 "for system filter delivery", tpname);
5697 /* If we couldn't set up a transport, defer the delivery, putting the
5698 error on the panic log as well as the main log. */
5702 address_item *badp = p;
5704 if (!addr_last) addr_new = p; else addr_last->next = p;
5705 badp->local_part = badp->address; /* Needed for log line */
5706 post_process_one(badp, DEFER, LOG_MAIN|LOG_PANIC, DTYPE_ROUTER, 0);
5709 } /* End of pfr handling */
5711 /* Either a non-pfr delivery, or we found a transport */
5713 DEBUG(D_deliver|D_filter)
5714 debug_printf("system filter added %s\n", p->address);
5718 } /* Loop through all addr_new addresses */
5723 /* Scan the recipients list, and for every one that is not in the non-
5724 recipients tree, add an addr item to the chain of new addresses. If the pno
5725 value is non-negative, we must set the onetime parent from it. This which
5726 points to the relevant entry in the recipients list.
5728 This processing can be altered by the setting of the process_recipients
5729 variable, which is changed if recipients are to be ignored, failed, or
5730 deferred. This can happen as a result of system filter activity, or if the -Mg
5731 option is used to fail all of them.
5733 Duplicate addresses are handled later by a different tree structure; we can't
5734 just extend the non-recipients tree, because that will be re-written to the
5735 spool if the message is deferred, and in any case there are casing
5736 complications for local addresses. */
5738 if (process_recipients != RECIP_IGNORE)
5740 for (i = 0; i < recipients_count; i++)
5742 if (!tree_search(tree_nonrecipients, recipients_list[i].address))
5744 recipient_item *r = recipients_list + i;
5745 address_item *new = deliver_make_addr(r->address, FALSE);
5746 new->prop.errors_address = r->errors_to;
5747 #ifdef EXPERIMENTAL_INTERNATIONAL
5748 if ((new->prop.utf8_msg = message_smtputf8))
5750 new->prop.utf8_downcvt = message_utf8_downconvert == 1;
5751 new->prop.utf8_downcvt_maybe = message_utf8_downconvert == -1;
5752 DEBUG(D_deliver) debug_printf("utf8, downconvert %s\n",
5753 new->prop.utf8_downcvt ? "yes"
5754 : new->prop.utf8_downcvt_maybe ? "ifneeded"
5760 new->onetime_parent = recipients_list[r->pno].address;
5762 /* If DSN support is enabled, set the dsn flags and the original receipt
5763 to be passed on to other DSN enabled MTAs */
5764 new->dsn_flags = r->dsn_flags & rf_dsnflags;
5765 new->dsn_orcpt = r->orcpt;
5766 DEBUG(D_deliver) debug_printf("DSN: set orcpt: %s flags: %d\n",
5767 new->dsn_orcpt, new->dsn_flags);
5769 switch (process_recipients)
5771 /* RECIP_DEFER is set when a system filter freezes a message. */
5774 new->next = addr_defer;
5779 /* RECIP_FAIL_FILTER is set when a system filter has obeyed a "fail"
5782 case RECIP_FAIL_FILTER:
5784 filter_message ? filter_message : US"delivery cancelled";
5785 setflag(new, af_pass_message);
5786 goto RECIP_QUEUE_FAILED; /* below */
5789 /* RECIP_FAIL_TIMEOUT is set when a message is frozen, but is older
5790 than the value in timeout_frozen_after. Treat non-bounce messages
5791 similarly to -Mg; for bounce messages we just want to discard, so
5792 don't put the address on the failed list. The timeout has already
5795 case RECIP_FAIL_TIMEOUT:
5796 new->message = US"delivery cancelled; message timed out";
5797 goto RECIP_QUEUE_FAILED; /* below */
5800 /* RECIP_FAIL is set when -Mg has been used. */
5803 new->message = US"delivery cancelled by administrator";
5806 /* Common code for the failure cases above. If this is not a bounce
5807 message, put the address on the failed list so that it is used to
5808 create a bounce. Otherwise do nothing - this just discards the address.
5809 The incident has already been logged. */
5812 if (sender_address[0] != 0)
5814 new->next = addr_failed;
5820 /* RECIP_FAIL_LOOP is set when there are too many Received: headers
5821 in the message. Process each address as a routing failure; if this
5822 is a bounce message, it will get frozen. */
5824 case RECIP_FAIL_LOOP:
5825 new->message = US"Too many \"Received\" headers - suspected mail loop";
5826 post_process_one(new, FAIL, LOG_MAIN, DTYPE_ROUTER, 0);
5830 /* Value should be RECIP_ACCEPT; take this as the safe default. */
5833 if (!addr_new) addr_new = new; else addr_last->next = new;
5838 #ifdef EXPERIMENTAL_EVENT
5839 if (process_recipients != RECIP_ACCEPT)
5841 uschar * save_local = deliver_localpart;
5842 const uschar * save_domain = deliver_domain;
5844 deliver_localpart = expand_string(
5845 string_sprintf("${local_part:%s}", new->address));
5846 deliver_domain = expand_string(
5847 string_sprintf("${domain:%s}", new->address));
5849 (void) event_raise(event_action,
5850 US"msg:fail:internal", new->message);
5852 deliver_localpart = save_local;
5853 deliver_domain = save_domain;
5863 debug_printf("Delivery address list:\n");
5864 for (p = addr_new; p; p = p->next)
5865 debug_printf(" %s %s\n", p->address,
5866 p->onetime_parent ? p->onetime_parent : US"");
5869 /* Set up the buffers used for copying over the file when delivering. */
5871 deliver_in_buffer = store_malloc(DELIVER_IN_BUFFER_SIZE);
5872 deliver_out_buffer = store_malloc(DELIVER_OUT_BUFFER_SIZE);
5876 /* Until there are no more new addresses, handle each one as follows:
5878 . If this is a generated address (indicated by the presence of a parent
5879 pointer) then check to see whether it is a pipe, file, or autoreply, and
5880 if so, handle it directly here. The router that produced the address will
5881 have set the allow flags into the address, and also set the uid/gid required.
5882 Having the routers generate new addresses and then checking them here at
5883 the outer level is tidier than making each router do the checking, and
5884 means that routers don't need access to the failed address queue.
5886 . Break up the address into local part and domain, and make lowercased
5887 versions of these strings. We also make unquoted versions of the local part.
5889 . Handle the percent hack for those domains for which it is valid.
5891 . For child addresses, determine if any of the parents have the same address.
5892 If so, generate a different string for previous delivery checking. Without
5893 this code, if the address spqr generates spqr via a forward or alias file,
5894 delivery of the generated spqr stops further attempts at the top level spqr,
5895 which is not what is wanted - it may have generated other addresses.
5897 . Check on the retry database to see if routing was previously deferred, but
5898 only if in a queue run. Addresses that are to be routed are put on the
5899 addr_route chain. Addresses that are to be deferred are put on the
5900 addr_defer chain. We do all the checking first, so as not to keep the
5901 retry database open any longer than necessary.
5903 . Now we run the addresses through the routers. A router may put the address
5904 on either the addr_local or the addr_remote chain for local or remote
5905 delivery, respectively, or put it on the addr_failed chain if it is
5906 undeliveable, or it may generate child addresses and put them on the
5907 addr_new chain, or it may defer an address. All the chain anchors are
5908 passed as arguments so that the routers can be called for verification
5911 . If new addresses have been generated by the routers, da capo.
5914 header_rewritten = FALSE; /* No headers rewritten yet */
5915 while (addr_new) /* Loop until all addresses dealt with */
5917 address_item *addr, *parent;
5919 /* Failure to open the retry database is treated the same as if it does
5920 not exist. In both cases, dbm_file is NULL. */
5922 if (!(dbm_file = dbfn_open(US"retry", O_RDONLY, &dbblock, FALSE)))
5924 DEBUG(D_deliver|D_retry|D_route|D_hints_lookup)
5925 debug_printf("no retry data available\n");
5928 /* Scan the current batch of new addresses, to handle pipes, files and
5929 autoreplies, and determine which others are ready for routing. */
5936 dbdata_retry *domain_retry_record;
5937 dbdata_retry *address_retry_record;
5940 addr_new = addr->next;
5942 DEBUG(D_deliver|D_retry|D_route)
5944 debug_printf(">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>\n");
5945 debug_printf("Considering: %s\n", addr->address);
5948 /* Handle generated address that is a pipe or a file or an autoreply. */
5950 if (testflag(addr, af_pfr))
5952 /* If an autoreply in a filter could not generate a syntactically valid
5953 address, give up forthwith. Set af_ignore_error so that we don't try to
5954 generate a bounce. */
5956 if (testflag(addr, af_bad_reply))
5958 addr->basic_errno = ERRNO_BADADDRESS2;
5959 addr->local_part = addr->address;
5961 US"filter autoreply generated syntactically invalid recipient";
5962 setflag(addr, af_ignore_error);
5963 (void)post_process_one(addr, FAIL, LOG_MAIN, DTYPE_ROUTER, 0);
5964 continue; /* with the next new address */
5967 /* If two different users specify delivery to the same pipe or file or
5968 autoreply, there should be two different deliveries, so build a unique
5969 string that incorporates the original address, and use this for
5970 duplicate testing and recording delivery, and also for retrying. */
5973 string_sprintf("%s:%s", addr->address, addr->parent->unique +
5974 (testflag(addr->parent, af_homonym)? 3:0));
5976 addr->address_retry_key = addr->domain_retry_key =
5977 string_sprintf("T:%s", addr->unique);
5979 /* If a filter file specifies two deliveries to the same pipe or file,
5980 we want to de-duplicate, but this is probably not wanted for two mail
5981 commands to the same address, where probably both should be delivered.
5982 So, we have to invent a different unique string in that case. Just
5983 keep piling '>' characters on the front. */
5985 if (addr->address[0] == '>')
5987 while (tree_search(tree_duplicates, addr->unique))
5988 addr->unique = string_sprintf(">%s", addr->unique);
5991 else if ((tnode = tree_search(tree_duplicates, addr->unique)))
5993 DEBUG(D_deliver|D_route)
5994 debug_printf("%s is a duplicate address: discarded\n", addr->address);
5995 addr->dupof = tnode->data.ptr;
5996 addr->next = addr_duplicate;
5997 addr_duplicate = addr;
6001 DEBUG(D_deliver|D_route) debug_printf("unique = %s\n", addr->unique);
6003 /* Check for previous delivery */
6005 if (tree_search(tree_nonrecipients, addr->unique))
6007 DEBUG(D_deliver|D_route)
6008 debug_printf("%s was previously delivered: discarded\n", addr->address);
6009 child_done(addr, tod_stamp(tod_log));
6013 /* Save for checking future duplicates */
6015 tree_add_duplicate(addr->unique, addr);
6017 /* Set local part and domain */
6019 addr->local_part = addr->address;
6020 addr->domain = addr->parent->domain;
6022 /* Ensure that the delivery is permitted. */
6024 if (testflag(addr, af_file))
6026 if (!testflag(addr, af_allow_file))
6028 addr->basic_errno = ERRNO_FORBIDFILE;
6029 addr->message = US"delivery to file forbidden";
6030 (void)post_process_one(addr, FAIL, LOG_MAIN, DTYPE_ROUTER, 0);
6031 continue; /* with the next new address */
6034 else if (addr->address[0] == '|')
6036 if (!testflag(addr, af_allow_pipe))
6038 addr->basic_errno = ERRNO_FORBIDPIPE;
6039 addr->message = US"delivery to pipe forbidden";
6040 (void)post_process_one(addr, FAIL, LOG_MAIN, DTYPE_ROUTER, 0);
6041 continue; /* with the next new address */
6044 else if (!testflag(addr, af_allow_reply))
6046 addr->basic_errno = ERRNO_FORBIDREPLY;
6047 addr->message = US"autoreply forbidden";
6048 (void)post_process_one(addr, FAIL, LOG_MAIN, DTYPE_ROUTER, 0);
6049 continue; /* with the next new address */
6052 /* If the errno field is already set to BADTRANSPORT, it indicates
6053 failure to expand a transport string, or find the associated transport,
6054 or an unset transport when one is required. Leave this test till now so
6055 that the forbid errors are given in preference. */
6057 if (addr->basic_errno == ERRNO_BADTRANSPORT)
6059 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_ROUTER, 0);
6063 /* Treat /dev/null as a special case and abandon the delivery. This
6064 avoids having to specify a uid on the transport just for this case.
6065 Arrange for the transport name to be logged as "**bypassed**". */
6067 if (Ustrcmp(addr->address, "/dev/null") == 0)
6069 uschar *save = addr->transport->name;
6070 addr->transport->name = US"**bypassed**";
6071 (void)post_process_one(addr, OK, LOG_MAIN, DTYPE_TRANSPORT, '=');
6072 addr->transport->name = save;
6073 continue; /* with the next new address */
6076 /* Pipe, file, or autoreply delivery is to go ahead as a normal local
6079 DEBUG(D_deliver|D_route)
6080 debug_printf("queued for %s transport\n", addr->transport->name);
6081 addr->next = addr_local;
6083 continue; /* with the next new address */
6086 /* Handle normal addresses. First, split up into local part and domain,
6087 handling the %-hack if necessary. There is the possibility of a defer from
6088 a lookup in percent_hack_domains. */
6090 if ((rc = deliver_split_address(addr)) == DEFER)
6092 addr->message = US"cannot check percent_hack_domains";
6093 addr->basic_errno = ERRNO_LISTDEFER;
6094 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_NONE, 0);
6098 /* Check to see if the domain is held. If so, proceed only if the
6099 delivery was forced by hand. */
6101 deliver_domain = addr->domain; /* set $domain */
6102 if ( !forced && hold_domains
6103 && (rc = match_isinlist(addr->domain, (const uschar **)&hold_domains, 0,
6104 &domainlist_anchor, addr->domain_cache, MCL_DOMAIN, TRUE,
6110 addr->message = US"hold_domains lookup deferred";
6111 addr->basic_errno = ERRNO_LISTDEFER;
6115 addr->message = US"domain is held";
6116 addr->basic_errno = ERRNO_HELD;
6118 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_NONE, 0);
6122 /* Now we can check for duplicates and previously delivered addresses. In
6123 order to do this, we have to generate a "unique" value for each address,
6124 because there may be identical actual addresses in a line of descendents.
6125 The "unique" field is initialized to the same value as the "address" field,
6126 but gets changed here to cope with identically-named descendents. */
6128 for (parent = addr->parent; parent; parent = parent->parent)
6129 if (strcmpic(addr->address, parent->address) == 0) break;
6131 /* If there's an ancestor with the same name, set the homonym flag. This
6132 influences how deliveries are recorded. Then add a prefix on the front of
6133 the unique address. We use \n\ where n starts at 0 and increases each time.
6134 It is unlikely to pass 9, but if it does, it may look odd but will still
6135 work. This means that siblings or cousins with the same names are treated
6136 as duplicates, which is what we want. */
6140 setflag(addr, af_homonym);
6141 if (parent->unique[0] != '\\')
6142 addr->unique = string_sprintf("\\0\\%s", addr->address);
6144 addr->unique = string_sprintf("\\%c\\%s", parent->unique[1] + 1,
6148 /* Ensure that the domain in the unique field is lower cased, because
6149 domains are always handled caselessly. */
6151 p = Ustrrchr(addr->unique, '@');
6152 while (*p != 0) { *p = tolower(*p); p++; }
6154 DEBUG(D_deliver|D_route) debug_printf("unique = %s\n", addr->unique);
6156 if (tree_search(tree_nonrecipients, addr->unique))
6158 DEBUG(D_deliver|D_route)
6159 debug_printf("%s was previously delivered: discarded\n", addr->unique);
6160 child_done(addr, tod_stamp(tod_log));
6164 /* Get the routing retry status, saving the two retry keys (with and
6165 without the local part) for subsequent use. If there is no retry record for
6166 the standard address routing retry key, we look for the same key with the
6167 sender attached, because this form is used by the smtp transport after a
6168 4xx response to RCPT when address_retry_include_sender is true. */
6170 addr->domain_retry_key = string_sprintf("R:%s", addr->domain);
6171 addr->address_retry_key = string_sprintf("R:%s@%s", addr->local_part,
6176 domain_retry_record = dbfn_read(dbm_file, addr->domain_retry_key);
6177 if ( domain_retry_record
6178 && now - domain_retry_record->time_stamp > retry_data_expire
6180 domain_retry_record = NULL; /* Ignore if too old */
6182 address_retry_record = dbfn_read(dbm_file, addr->address_retry_key);
6183 if ( address_retry_record
6184 && now - address_retry_record->time_stamp > retry_data_expire
6186 address_retry_record = NULL; /* Ignore if too old */
6188 if (!address_retry_record)
6190 uschar *altkey = string_sprintf("%s:<%s>", addr->address_retry_key,
6192 address_retry_record = dbfn_read(dbm_file, altkey);
6193 if ( address_retry_record
6194 && now - address_retry_record->time_stamp > retry_data_expire)
6195 address_retry_record = NULL; /* Ignore if too old */
6199 domain_retry_record = address_retry_record = NULL;
6201 DEBUG(D_deliver|D_retry)
6203 if (!domain_retry_record)
6204 debug_printf("no domain retry record\n");
6205 if (!address_retry_record)
6206 debug_printf("no address retry record\n");
6209 /* If we are sending a message down an existing SMTP connection, we must
6210 assume that the message which created the connection managed to route
6211 an address to that connection. We do not want to run the risk of taking
6212 a long time over routing here, because if we do, the server at the other
6213 end of the connection may time it out. This is especially true for messages
6214 with lots of addresses. For this kind of delivery, queue_running is not
6215 set, so we would normally route all addresses. We take a pragmatic approach
6216 and defer routing any addresses that have any kind of domain retry record.
6217 That is, we don't even look at their retry times. It doesn't matter if this
6218 doesn't work occasionally. This is all just an optimization, after all.
6220 The reason for not doing the same for address retries is that they normally
6221 arise from 4xx responses, not DNS timeouts. */
6223 if (continue_hostname && domain_retry_record)
6225 addr->message = US"reusing SMTP connection skips previous routing defer";
6226 addr->basic_errno = ERRNO_RRETRY;
6227 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_ROUTER, 0);
6230 /* If we are in a queue run, defer routing unless there is no retry data or
6231 we've passed the next retry time, or this message is forced. In other
6232 words, ignore retry data when not in a queue run.
6234 However, if the domain retry time has expired, always allow the routing
6235 attempt. If it fails again, the address will be failed. This ensures that
6236 each address is routed at least once, even after long-term routing
6239 If there is an address retry, check that too; just wait for the next
6240 retry time. This helps with the case when the temporary error on the
6241 address was really message-specific rather than address specific, since
6242 it allows other messages through.
6244 We also wait for the next retry time if this is a message sent down an
6245 existing SMTP connection (even though that will be forced). Otherwise there
6246 will be far too many attempts for an address that gets a 4xx error. In
6247 fact, after such an error, we should not get here because, the host should
6248 not be remembered as one this message needs. However, there was a bug that
6249 used to cause this to happen, so it is best to be on the safe side.
6251 Even if we haven't reached the retry time in the hints, there is one more
6252 check to do, which is for the ultimate address timeout. We only do this
6253 check if there is an address retry record and there is not a domain retry
6254 record; this implies that previous attempts to handle the address had the
6255 retry_use_local_parts option turned on. We use this as an approximation
6256 for the destination being like a local delivery, for example delivery over
6257 LMTP to an IMAP message store. In this situation users are liable to bump
6258 into their quota and thereby have intermittently successful deliveries,
6259 which keep the retry record fresh, which can lead to us perpetually
6260 deferring messages. */
6262 else if ( ( queue_running && !deliver_force
6263 || continue_hostname
6265 && ( ( domain_retry_record
6266 && now < domain_retry_record->next_try
6267 && !domain_retry_record->expired
6269 || ( address_retry_record
6270 && now < address_retry_record->next_try
6272 && ( domain_retry_record
6273 || !address_retry_record
6274 || !retry_ultimate_address_timeout(addr->address_retry_key,
6275 addr->domain, address_retry_record, now)
6278 addr->message = US"retry time not reached";
6279 addr->basic_errno = ERRNO_RRETRY;
6280 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_ROUTER, 0);
6283 /* The domain is OK for routing. Remember if retry data exists so it
6284 can be cleaned up after a successful delivery. */
6288 if (domain_retry_record || address_retry_record)
6289 setflag(addr, af_dr_retry_exists);
6290 addr->next = addr_route;
6292 DEBUG(D_deliver|D_route)
6293 debug_printf("%s: queued for routing\n", addr->address);
6297 /* The database is closed while routing is actually happening. Requests to
6298 update it are put on a chain and all processed together at the end. */
6300 if (dbm_file) dbfn_close(dbm_file);
6302 /* If queue_domains is set, we don't even want to try routing addresses in
6303 those domains. During queue runs, queue_domains is forced to be unset.
6304 Optimize by skipping this pass through the addresses if nothing is set. */
6306 if (!deliver_force && queue_domains)
6308 address_item *okaddr = NULL;
6311 address_item *addr = addr_route;
6312 addr_route = addr->next;
6314 deliver_domain = addr->domain; /* set $domain */
6315 if ((rc = match_isinlist(addr->domain, (const uschar **)&queue_domains, 0,
6316 &domainlist_anchor, addr->domain_cache, MCL_DOMAIN, TRUE, NULL))
6321 addr->basic_errno = ERRNO_LISTDEFER;
6322 addr->message = US"queue_domains lookup deferred";
6323 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_ROUTER, 0);
6327 addr->next = okaddr;
6333 addr->basic_errno = ERRNO_QUEUE_DOMAIN;
6334 addr->message = US"domain is in queue_domains";
6335 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_ROUTER, 0);
6339 addr_route = okaddr;
6342 /* Now route those addresses that are not deferred. */
6347 address_item *addr = addr_route;
6348 const uschar *old_domain = addr->domain;
6349 uschar *old_unique = addr->unique;
6350 addr_route = addr->next;
6353 /* Just in case some router parameter refers to it. */
6355 if (!(return_path = addr->prop.errors_address))
6356 return_path = sender_address;
6358 /* If a router defers an address, add a retry item. Whether or not to
6359 use the local part in the key is a property of the router. */
6361 if ((rc = route_address(addr, &addr_local, &addr_remote, &addr_new,
6362 &addr_succeed, v_none)) == DEFER)
6363 retry_add_item(addr,
6364 addr->router->retry_use_local_part
6365 ? string_sprintf("R:%s@%s", addr->local_part, addr->domain)
6366 : string_sprintf("R:%s", addr->domain),
6369 /* Otherwise, if there is an existing retry record in the database, add
6370 retry items to delete both forms. We must also allow for the possibility
6371 of a routing retry that includes the sender address. Since the domain might
6372 have been rewritten (expanded to fully qualified) as a result of routing,
6373 ensure that the rewritten form is also deleted. */
6375 else if (testflag(addr, af_dr_retry_exists))
6377 uschar *altkey = string_sprintf("%s:<%s>", addr->address_retry_key,
6379 retry_add_item(addr, altkey, rf_delete);
6380 retry_add_item(addr, addr->address_retry_key, rf_delete);
6381 retry_add_item(addr, addr->domain_retry_key, rf_delete);
6382 if (Ustrcmp(addr->domain, old_domain) != 0)
6383 retry_add_item(addr, string_sprintf("R:%s", old_domain), rf_delete);
6386 /* DISCARD is given for :blackhole: and "seen finish". The event has been
6387 logged, but we need to ensure the address (and maybe parents) is marked
6392 address_done(addr, tod_stamp(tod_log));
6393 continue; /* route next address */
6396 /* The address is finished with (failed or deferred). */
6400 (void)post_process_one(addr, rc, LOG_MAIN, DTYPE_ROUTER, 0);
6401 continue; /* route next address */
6404 /* The address has been routed. If the router changed the domain, it will
6405 also have changed the unique address. We have to test whether this address
6406 has already been delivered, because it's the unique address that finally
6409 if ( addr->unique != old_unique
6410 && tree_search(tree_nonrecipients, addr->unique) != 0
6413 DEBUG(D_deliver|D_route) debug_printf("%s was previously delivered: "
6414 "discarded\n", addr->address);
6415 if (addr_remote == addr) addr_remote = addr->next;
6416 else if (addr_local == addr) addr_local = addr->next;
6419 /* If the router has same_domain_copy_routing set, we are permitted to copy
6420 the routing for any other addresses with the same domain. This is an
6421 optimisation to save repeated DNS lookups for "standard" remote domain
6422 routing. The option is settable only on routers that generate host lists.
6423 We play it very safe, and do the optimization only if the address is routed
6424 to a remote transport, there are no header changes, and the domain was not
6425 modified by the router. */
6427 if ( addr_remote == addr
6428 && addr->router->same_domain_copy_routing
6429 && !addr->prop.extra_headers
6430 && !addr->prop.remove_headers
6431 && old_domain == addr->domain
6434 address_item **chain = &addr_route;
6437 address_item *addr2 = *chain;
6438 if (Ustrcmp(addr2->domain, addr->domain) != 0)
6440 chain = &(addr2->next);
6444 /* Found a suitable address; take it off the routing list and add it to
6445 the remote delivery list. */
6447 *chain = addr2->next;
6448 addr2->next = addr_remote;
6449 addr_remote = addr2;
6451 /* Copy the routing data */
6453 addr2->domain = addr->domain;
6454 addr2->router = addr->router;
6455 addr2->transport = addr->transport;
6456 addr2->host_list = addr->host_list;
6457 addr2->fallback_hosts = addr->fallback_hosts;
6458 addr2->prop.errors_address = addr->prop.errors_address;
6459 copyflag(addr2, addr, af_hide_child | af_local_host_removed);
6461 DEBUG(D_deliver|D_route)
6463 debug_printf(">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>\n"
6465 "Routing for %s copied from %s\n",
6466 addr2->address, addr2->address, addr->address);
6470 } /* Continue with routing the next address. */
6471 } /* Loop to process any child addresses that the routers created, and
6472 any rerouted addresses that got put back on the new chain. */
6475 /* Debugging: show the results of the routing */
6477 DEBUG(D_deliver|D_retry|D_route)
6480 debug_printf(">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>\n");
6481 debug_printf("After routing:\n Local deliveries:\n");
6482 for (p = addr_local; p; p = p->next)
6483 debug_printf(" %s\n", p->address);
6485 debug_printf(" Remote deliveries:\n");
6486 for (p = addr_remote; p; p = p->next)
6487 debug_printf(" %s\n", p->address);
6489 debug_printf(" Failed addresses:\n");
6490 for (p = addr_failed; p; p = p->next)
6491 debug_printf(" %s\n", p->address);
6493 debug_printf(" Deferred addresses:\n");
6494 for (p = addr_defer; p; p = p->next)
6495 debug_printf(" %s\n", p->address);
6498 /* Free any resources that were cached during routing. */
6503 /* These two variables are set only during routing, after check_local_user.
6504 Ensure they are not set in transports. */
6506 local_user_gid = (gid_t)(-1);
6507 local_user_uid = (uid_t)(-1);
6509 /* Check for any duplicate addresses. This check is delayed until after
6510 routing, because the flexibility of the routing configuration means that
6511 identical addresses with different parentage may end up being redirected to
6512 different addresses. Checking for duplicates too early (as we previously used
6513 to) makes this kind of thing not work. */
6515 do_duplicate_check(&addr_local);
6516 do_duplicate_check(&addr_remote);
6518 /* When acting as an MUA wrapper, we proceed only if all addresses route to a
6519 remote transport. The check that they all end up in one transaction happens in
6520 the do_remote_deliveries() function. */
6523 && (addr_local || addr_failed || addr_defer)
6527 uschar *which, *colon, *msg;
6534 else if (addr_defer)
6537 which = US"deferred";
6545 while (addr->parent) addr = addr->parent;
6550 msg = addr->message;
6552 else colon = msg = US"";
6554 /* We don't need to log here for a forced failure as it will already
6555 have been logged. Defer will also have been logged, but as a defer, so we do
6556 need to do the failure logging. */
6558 if (addr != addr_failed)
6559 log_write(0, LOG_MAIN, "** %s routing yielded a %s delivery",
6560 addr->address, which);
6562 /* Always write an error to the caller */
6564 fprintf(stderr, "routing %s yielded a %s delivery%s%s\n", addr->address,
6567 final_yield = DELIVER_MUA_FAILED;
6568 addr_failed = addr_defer = NULL; /* So that we remove the message */
6569 goto DELIVERY_TIDYUP;
6573 /* If this is a run to continue deliveries to an external channel that is
6574 already set up, defer any local deliveries. */
6576 if (continue_transport)
6580 address_item *addr = addr_defer;
6581 while (addr->next) addr = addr->next;
6582 addr->next = addr_local;
6585 addr_defer = addr_local;
6590 /* Because address rewriting can happen in the routers, we should not really do
6591 ANY deliveries until all addresses have been routed, so that all recipients of
6592 the message get the same headers. However, this is in practice not always
6593 possible, since sometimes remote addresses give DNS timeouts for days on end.
6594 The pragmatic approach is to deliver what we can now, saving any rewritten
6595 headers so that at least the next lot of recipients benefit from the rewriting
6596 that has already been done.
6598 If any headers have been rewritten during routing, update the spool file to
6599 remember them for all subsequent deliveries. This can be delayed till later if
6600 there is only address to be delivered - if it succeeds the spool write need not
6603 if ( header_rewritten
6605 && (addr_local->next || addr_remote)
6607 || (addr_remote && addr_remote->next)
6610 /* Panic-dies on error */
6611 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
6612 header_rewritten = FALSE;
6616 /* If there are any deliveries to be done, open the journal file. This is used
6617 to record successful deliveries as soon as possible after each delivery is
6618 known to be complete. A file opened with O_APPEND is used so that several
6619 processes can run simultaneously.
6621 The journal is just insurance against crashes. When the spool file is
6622 ultimately updated at the end of processing, the journal is deleted. If a
6623 journal is found to exist at the start of delivery, the addresses listed
6624 therein are added to the non-recipients. */
6626 if (addr_local || addr_remote)
6628 sprintf(CS spoolname, "%s/input/%s/%s-J", spool_directory, message_subdir, id);
6629 journal_fd = Uopen(spoolname, O_WRONLY|O_APPEND|O_CREAT, SPOOL_MODE);
6633 log_write(0, LOG_MAIN|LOG_PANIC, "Couldn't open journal file %s: %s",
6634 spoolname, strerror(errno));
6635 return DELIVER_NOT_ATTEMPTED;
6638 /* Set the close-on-exec flag, make the file owned by Exim, and ensure
6639 that the mode is correct - the group setting doesn't always seem to get
6640 set automatically. */
6642 if( fcntl(journal_fd, F_SETFD, fcntl(journal_fd, F_GETFD) | FD_CLOEXEC)
6643 || fchown(journal_fd, exim_uid, exim_gid)
6644 || fchmod(journal_fd, SPOOL_MODE)
6647 int ret = Uunlink(spoolname);
6648 log_write(0, LOG_MAIN|LOG_PANIC, "Couldn't set perms on journal file %s: %s",
6649 spoolname, strerror(errno));
6650 if(ret && errno != ENOENT)
6651 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s",
6652 spoolname, strerror(errno));
6653 return DELIVER_NOT_ATTEMPTED;
6659 /* Now we can get down to the business of actually doing deliveries. Local
6660 deliveries are done first, then remote ones. If ever the problems of how to
6661 handle fallback transports are figured out, this section can be put into a loop
6662 for handling fallbacks, though the uid switching will have to be revised. */
6664 /* Precompile a regex that is used to recognize a parameter in response
6665 to an LHLO command, if is isn't already compiled. This may be used on both
6666 local and remote LMTP deliveries. */
6668 if (!regex_IGNOREQUOTA)
6670 regex_must_compile(US"\\n250[\\s\\-]IGNOREQUOTA(\\s|\\n|$)", FALSE, TRUE);
6672 /* Handle local deliveries */
6676 DEBUG(D_deliver|D_transport)
6677 debug_printf(">>>>>>>>>>>>>>>> Local deliveries >>>>>>>>>>>>>>>>\n");
6678 do_local_deliveries();
6679 disable_logging = FALSE;
6682 /* If queue_run_local is set, we do not want to attempt any remote deliveries,
6683 so just queue them all. */
6685 if (queue_run_local)
6688 address_item *addr = addr_remote;
6689 addr_remote = addr->next;
6691 addr->basic_errno = ERRNO_LOCAL_ONLY;
6692 addr->message = US"remote deliveries suppressed";
6693 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_TRANSPORT, 0);
6696 /* Handle remote deliveries */
6700 DEBUG(D_deliver|D_transport)
6701 debug_printf(">>>>>>>>>>>>>>>> Remote deliveries >>>>>>>>>>>>>>>>\n");
6703 /* Precompile some regex that are used to recognize parameters in response
6704 to an EHLO command, if they aren't already compiled. */
6708 /* Now sort the addresses if required, and do the deliveries. The yield of
6709 do_remote_deliveries is FALSE when mua_wrapper is set and all addresses
6710 cannot be delivered in one transaction. */
6712 if (remote_sort_domains) sort_remote_deliveries();
6713 if (!do_remote_deliveries(FALSE))
6715 log_write(0, LOG_MAIN, "** mua_wrapper is set but recipients cannot all "
6716 "be delivered in one transaction");
6717 fprintf(stderr, "delivery to smarthost failed (configuration problem)\n");
6719 final_yield = DELIVER_MUA_FAILED;
6720 addr_failed = addr_defer = NULL; /* So that we remove the message */
6721 goto DELIVERY_TIDYUP;
6724 /* See if any of the addresses that failed got put on the queue for delivery
6725 to their fallback hosts. We do it this way because often the same fallback
6726 host is used for many domains, so all can be sent in a single transaction
6727 (if appropriately configured). */
6729 if (addr_fallback && !mua_wrapper)
6731 DEBUG(D_deliver) debug_printf("Delivering to fallback hosts\n");
6732 addr_remote = addr_fallback;
6733 addr_fallback = NULL;
6734 if (remote_sort_domains) sort_remote_deliveries();
6735 do_remote_deliveries(TRUE);
6737 disable_logging = FALSE;
6741 /* All deliveries are now complete. Ignore SIGTERM during this tidying up
6742 phase, to minimize cases of half-done things. */
6745 debug_printf(">>>>>>>>>>>>>>>> deliveries are done >>>>>>>>>>>>>>>>\n");
6747 /* Root privilege is no longer needed */
6749 exim_setugid(exim_uid, exim_gid, FALSE, US"post-delivery tidying");
6751 set_process_info("tidying up after delivering %s", message_id);
6752 signal(SIGTERM, SIG_IGN);
6754 /* When we are acting as an MUA wrapper, the smtp transport will either have
6755 succeeded for all addresses, or failed them all in normal cases. However, there
6756 are some setup situations (e.g. when a named port does not exist) that cause an
6757 immediate exit with deferral of all addresses. Convert those into failures. We
6758 do not ever want to retry, nor do we want to send a bounce message. */
6764 address_item *addr, *nextaddr;
6765 for (addr = addr_defer; addr; addr = nextaddr)
6767 log_write(0, LOG_MAIN, "** %s mua_wrapper forced failure for deferred "
6768 "delivery", addr->address);
6769 nextaddr = addr->next;
6770 addr->next = addr_failed;
6776 /* Now all should either have succeeded or failed. */
6779 final_yield = DELIVER_MUA_SUCCEEDED;
6783 uschar *s = addr_failed->user_message;
6785 if (!s) s = addr_failed->message;
6787 fprintf(stderr, "Delivery failed: ");
6788 if (addr_failed->basic_errno > 0)
6790 fprintf(stderr, "%s", strerror(addr_failed->basic_errno));
6791 if (s) fprintf(stderr, ": ");
6793 if ((host = addr_failed->host_used))
6794 fprintf(stderr, "H=%s [%s]: ", host->name, host->address);
6796 fprintf(stderr, "%s", CS s);
6797 else if (addr_failed->basic_errno <= 0)
6798 fprintf(stderr, "unknown error");
6799 fprintf(stderr, "\n");
6801 final_yield = DELIVER_MUA_FAILED;
6806 /* In a normal configuration, we now update the retry database. This is done in
6807 one fell swoop at the end in order not to keep opening and closing (and
6808 locking) the database. The code for handling retries is hived off into a
6809 separate module for convenience. We pass it the addresses of the various
6810 chains, because deferred addresses can get moved onto the failed chain if the
6811 retry cutoff time has expired for all alternative destinations. Bypass the
6812 updating of the database if the -N flag is set, which is a debugging thing that
6813 prevents actual delivery. */
6815 else if (!dont_deliver)
6816 retry_update(&addr_defer, &addr_failed, &addr_succeed);
6818 /* Send DSN for successful messages */
6819 addr_dsntmp = addr_succeed;
6820 addr_senddsn = NULL;
6824 /* af_ignore_error not honored here. it's not an error */
6827 debug_printf("DSN: processing router : %s\n"
6828 "DSN: processing successful delivery address: %s\n"
6829 "DSN: Sender_address: %s\n"
6830 "DSN: orcpt: %s flags: %d\n"
6831 "DSN: envid: %s ret: %d\n"
6832 "DSN: Final recipient: %s\n"
6833 "DSN: Remote SMTP server supports DSN: %d\n",
6834 addr_dsntmp->router->name,
6835 addr_dsntmp->address,
6837 addr_dsntmp->dsn_orcpt, addr_dsntmp->dsn_flags,
6839 addr_dsntmp->address,
6840 addr_dsntmp->dsn_aware
6844 /* send report if next hop not DSN aware or a router flagged "last DSN hop"
6845 and a report was requested */
6846 if ( ( addr_dsntmp->dsn_aware != dsn_support_yes
6847 || addr_dsntmp->dsn_flags & rf_dsnlasthop
6849 && addr_dsntmp->dsn_flags & rf_dsnflags
6850 && addr_dsntmp->dsn_flags & rf_notify_success
6853 /* copy and relink address_item and send report with all of them at once later */
6854 address_item *addr_next;
6855 addr_next = addr_senddsn;
6856 addr_senddsn = store_get(sizeof(address_item));
6857 memcpy(addr_senddsn, addr_dsntmp, sizeof(address_item));
6858 addr_senddsn->next = addr_next;
6861 DEBUG(D_deliver) debug_printf("DSN: not sending DSN success message\n");
6863 addr_dsntmp = addr_dsntmp->next;
6871 /* create exim process to send message */
6872 pid = child_open_exim(&fd);
6874 DEBUG(D_deliver) debug_printf("DSN: child_open_exim returns: %d\n", pid);
6876 if (pid < 0) /* Creation of child failed */
6878 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Process %d (parent %d) failed to "
6879 "create child process to send failure message: %s", getpid(),
6880 getppid(), strerror(errno));
6882 DEBUG(D_deliver) debug_printf("DSN: child_open_exim failed\n");
6884 else /* Creation of child succeeded */
6886 FILE *f = fdopen(fd, "wb");
6887 /* header only as required by RFC. only failure DSN needs to honor RET=FULL */
6888 int topt = topt_add_return_path | topt_no_body;
6892 debug_printf("sending error message to: %s\n", sender_address);
6894 /* build unique id for MIME boundary */
6895 bound = string_sprintf(TIME_T_FMT "-eximdsn-%d", time(NULL), rand());
6896 DEBUG(D_deliver) debug_printf("DSN: MIME boundary: %s\n", bound);
6898 if (errors_reply_to)
6899 fprintf(f, "Reply-To: %s\n", errors_reply_to);
6901 fprintf(f, "Auto-Submitted: auto-generated\n"
6902 "From: Mail Delivery System <Mailer-Daemon@%s>\n"
6904 "Subject: Delivery Status Notification\n"
6905 "Content-Type: multipart/report; report-type=delivery-status; boundary=%s\n"
6906 "MIME-Version: 1.0\n\n"
6909 "Content-type: text/plain; charset=us-ascii\n\n"
6911 "This message was created automatically by mail delivery software.\n"
6912 " ----- The following addresses had successful delivery notifications -----\n",
6913 qualify_domain_sender, sender_address, bound, bound);
6915 for (addr_dsntmp = addr_senddsn; addr_dsntmp;
6916 addr_dsntmp = addr_dsntmp->next)
6917 fprintf(f, "<%s> (relayed %s)\n\n",
6918 addr_dsntmp->address,
6919 (addr_dsntmp->dsn_flags & rf_dsnlasthop) == 1
6920 ? "via non DSN router"
6921 : addr_dsntmp->dsn_aware == dsn_support_no
6922 ? "to non-DSN-aware mailer"
6923 : "via non \"Remote SMTP\" router"
6927 "Content-type: message/delivery-status\n\n"
6928 "Reporting-MTA: dns; %s\n",
6929 bound, smtp_active_hostname);
6932 { /* must be decoded from xtext: see RFC 3461:6.3a */
6934 if (auth_xtextdecode(dsn_envid, &xdec_envid) > 0)
6935 fprintf(f, "Original-Envelope-ID: %s\n", dsn_envid);
6937 fprintf(f, "X-Original-Envelope-ID: error decoding xtext formated ENVID\n");
6941 for (addr_dsntmp = addr_senddsn;
6943 addr_dsntmp = addr_dsntmp->next)
6945 if (addr_dsntmp->dsn_orcpt)
6946 fprintf(f,"Original-Recipient: %s\n", addr_dsntmp->dsn_orcpt);
6948 fprintf(f, "Action: delivered\n"
6949 "Final-Recipient: rfc822;%s\n"
6951 addr_dsntmp->address);
6953 if (addr_dsntmp->host_used && addr_dsntmp->host_used->name)
6954 fprintf(f, "Remote-MTA: dns; %s\nDiagnostic-Code: smtp; 250 Ok\n\n",
6955 addr_dsntmp->host_used->name);
6957 fprintf(f, "Diagnostic-Code: X-Exim; relayed via non %s router\n\n",
6958 (addr_dsntmp->dsn_flags & rf_dsnlasthop) == 1 ? "DSN" : "SMTP");
6961 fprintf(f, "--%s\nContent-type: text/rfc822-headers\n\n", bound);
6964 transport_filter_argv = NULL; /* Just in case */
6965 return_path = sender_address; /* In case not previously set */
6967 /* Write the original email out */
6968 transport_write_message(NULL, fileno(f), topt, 0, NULL, NULL, NULL, NULL, NULL, 0);
6971 fprintf(f,"\n--%s--\n", bound);
6975 rc = child_close(pid, 0); /* Waits for child to close, no timeout */
6979 /* If any addresses failed, we must send a message to somebody, unless
6980 af_ignore_error is set, in which case no action is taken. It is possible for
6981 several messages to get sent if there are addresses with different
6988 uschar *logtod = tod_stamp(tod_log);
6990 address_item *handled_addr = NULL;
6991 address_item **paddr;
6992 address_item *msgchain = NULL;
6993 address_item **pmsgchain = &msgchain;
6995 /* There are weird cases when logging is disabled in the transport. However,
6996 there may not be a transport (address failed by a router). */
6998 disable_logging = FALSE;
6999 if (addr_failed->transport)
7000 disable_logging = addr_failed->transport->disable_logging;
7003 debug_printf("processing failed address %s\n", addr_failed->address);
7005 /* There are only two ways an address in a bounce message can get here:
7007 (1) When delivery was initially deferred, but has now timed out (in the call
7008 to retry_update() above). We can detect this by testing for
7009 af_retry_timedout. If the address does not have its own errors address,
7010 we arrange to ignore the error.
7012 (2) If delivery failures for bounce messages are being ignored. We can detect
7013 this by testing for af_ignore_error. This will also be set if a bounce
7014 message has been autothawed and the ignore_bounce_errors_after time has
7015 passed. It might also be set if a router was explicitly configured to
7016 ignore errors (errors_to = "").
7018 If neither of these cases obtains, something has gone wrong. Log the
7019 incident, but then ignore the error. */
7021 if (sender_address[0] == 0 && !addr_failed->prop.errors_address)
7023 if ( !testflag(addr_failed, af_retry_timedout)
7024 && !testflag(addr_failed, af_ignore_error))
7026 log_write(0, LOG_MAIN|LOG_PANIC, "internal error: bounce message "
7027 "failure is neither frozen nor ignored (it's been ignored)");
7029 setflag(addr_failed, af_ignore_error);
7032 /* If the first address on the list has af_ignore_error set, just remove
7033 it from the list, throw away any saved message file, log it, and
7034 mark the recipient done. */
7036 if ( testflag(addr_failed, af_ignore_error)
7037 || ( addr_failed->dsn_flags & rf_dsnflags
7038 && (addr_failed->dsn_flags & rf_notify_failure) != rf_notify_failure
7042 addr_failed = addr->next;
7043 if (addr->return_filename) Uunlink(addr->return_filename);
7045 log_write(0, LOG_MAIN, "%s%s%s%s: error ignored",
7047 !addr->parent ? US"" : US" <",
7048 !addr->parent ? US"" : addr->parent->address,
7049 !addr->parent ? US"" : US">");
7051 address_done(addr, logtod);
7052 child_done(addr, logtod);
7053 /* Panic-dies on error */
7054 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
7057 /* Otherwise, handle the sending of a message. Find the error address for
7058 the first address, then send a message that includes all failed addresses
7059 that have the same error address. Note the bounce_recipient is a global so
7060 that it can be accesssed by $bounce_recipient while creating a customized
7065 if (!(bounce_recipient = addr_failed->prop.errors_address))
7066 bounce_recipient = sender_address;
7068 /* Make a subprocess to send a message */
7070 if ((pid = child_open_exim(&fd)) < 0)
7071 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Process %d (parent %d) failed to "
7072 "create child process to send failure message: %s", getpid(),
7073 getppid(), strerror(errno));
7075 /* Creation of child succeeded */
7082 uschar *bcc, *emf_text;
7083 FILE *f = fdopen(fd, "wb");
7085 BOOL to_sender = strcmpic(sender_address, bounce_recipient) == 0;
7086 int max = (bounce_return_size_limit/DELIVER_IN_BUFFER_SIZE + 1) *
7087 DELIVER_IN_BUFFER_SIZE;
7089 uschar *dsnlimitmsg;
7090 uschar *dsnnotifyhdr;
7094 debug_printf("sending error message to: %s\n", bounce_recipient);
7096 /* Scan the addresses for all that have the same errors address, removing
7097 them from the addr_failed chain, and putting them on msgchain. */
7099 paddr = &addr_failed;
7100 for (addr = addr_failed; addr; addr = *paddr)
7101 if (Ustrcmp(bounce_recipient, addr->prop.errors_address
7102 ? addr->prop.errors_address : sender_address) == 0)
7103 { /* The same - dechain */
7104 *paddr = addr->next;
7107 pmsgchain = &(addr->next);
7110 paddr = &addr->next; /* Not the same; skip */
7112 /* Include X-Failed-Recipients: for automatic interpretation, but do
7113 not let any one header line get too long. We do this by starting a
7114 new header every 50 recipients. Omit any addresses for which the
7115 "hide_child" flag is set. */
7117 for (addr = msgchain; addr; addr = addr->next)
7119 if (testflag(addr, af_hide_child)) continue;
7127 ? "X-Failed-Recipients: "
7129 testflag(addr, af_pfr) && addr->parent
7130 ? string_printing(addr->parent->address)
7131 : string_printing(addr->address));
7133 if (rcount > 0) fprintf(f, "\n");
7135 /* Output the standard headers */
7137 if (errors_reply_to)
7138 fprintf(f, "Reply-To: %s\n", errors_reply_to);
7139 fprintf(f, "Auto-Submitted: auto-replied\n");
7141 fprintf(f, "To: %s\n", bounce_recipient);
7143 /* generate boundary string and output MIME-Headers */
7144 bound = string_sprintf(TIME_T_FMT "-eximdsn-%d", time(NULL), rand());
7146 fprintf(f, "Content-Type: multipart/report;"
7147 " report-type=delivery-status; boundary=%s\n"
7148 "MIME-Version: 1.0\n",
7151 /* Open a template file if one is provided. Log failure to open, but
7152 carry on - default texts will be used. */
7154 if (bounce_message_file)
7155 if (!(emf = Ufopen(bounce_message_file, "rb")))
7156 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to open %s for error "
7157 "message texts: %s", bounce_message_file, strerror(errno));
7159 /* Quietly copy to configured additional addresses if required. */
7161 if ((bcc = moan_check_errorcopy(bounce_recipient)))
7162 fprintf(f, "Bcc: %s\n", bcc);
7164 /* The texts for the message can be read from a template file; if there
7165 isn't one, or if it is too short, built-in texts are used. The first
7166 emf text is a Subject: and any other headers. */
7168 if ((emf_text = next_emf(emf, US"header")))
7169 fprintf(f, "%s\n", emf_text);
7171 fprintf(f, "Subject: Mail delivery failed%s\n\n",
7172 to_sender? ": returning message to sender" : "");
7174 /* output human readable part as text/plain section */
7176 "Content-type: text/plain; charset=us-ascii\n\n",
7179 if ((emf_text = next_emf(emf, US"intro")))
7180 fprintf(f, "%s", CS emf_text);
7184 /* This message has been reworded several times. It seems to be confusing to
7185 somebody, however it is worded. I have retreated to the original, simple
7187 "This message was created automatically by mail delivery software.\n");
7189 if (bounce_message_text)
7190 fprintf(f, "%s", CS bounce_message_text);
7193 "\nA message that you sent could not be delivered to one or more of its\n"
7194 "recipients. This is a permanent error. The following address(es) failed:\n");
7197 "\nA message sent by\n\n <%s>\n\n"
7198 "could not be delivered to one or more of its recipients. The following\n"
7199 "address(es) failed:\n", sender_address);
7203 /* Process the addresses, leaving them on the msgchain if they have a
7204 file name for a return message. (There has already been a check in
7205 post_process_one() for the existence of data in the message file.) A TRUE
7206 return from print_address_information() means that the address is not
7210 for (addr = msgchain; addr; addr = *paddr)
7212 if (print_address_information(addr, f, US" ", US"\n ", US""))
7213 print_address_error(addr, f, US"");
7215 /* End the final line for the address */
7219 /* Leave on msgchain if there's a return file. */
7221 if (addr->return_file >= 0)
7223 paddr = &(addr->next);
7227 /* Else save so that we can tick off the recipient when the
7232 *paddr = addr->next;
7233 addr->next = handled_addr;
7234 handled_addr = addr;
7240 /* Get the next text, whether we need it or not, so as to be
7241 positioned for the one after. */
7243 emf_text = next_emf(emf, US"generated text");
7245 /* If there were any file messages passed by the local transports,
7246 include them in the message. Then put the address on the handled chain.
7247 In the case of a batch of addresses that were all sent to the same
7248 transport, the return_file field in all of them will contain the same
7249 fd, and the return_filename field in the *last* one will be set (to the
7250 name of the file). */
7254 address_item *nextaddr;
7257 fprintf(f, "%s", CS emf_text);
7260 "The following text was generated during the delivery "
7261 "attempt%s:\n", (filecount > 1)? "s" : "");
7263 for (addr = msgchain; addr; addr = nextaddr)
7266 address_item *topaddr = addr;
7268 /* List all the addresses that relate to this file */
7271 while(addr) /* Insurance */
7273 print_address_information(addr, f, US"------ ", US"\n ",
7275 if (addr->return_filename) break;
7280 /* Now copy the file */
7282 if (!(fm = Ufopen(addr->return_filename, "rb")))
7283 fprintf(f, " +++ Exim error... failed to open text file: %s\n",
7287 while ((ch = fgetc(fm)) != EOF) fputc(ch, f);
7290 Uunlink(addr->return_filename);
7292 /* Can now add to handled chain, first fishing off the next
7293 address on the msgchain. */
7295 nextaddr = addr->next;
7296 addr->next = handled_addr;
7297 handled_addr = topaddr;
7302 /* output machine readable part */
7303 #ifdef EXPERIMENTAL_INTERNATIONAL
7304 if (message_smtputf8)
7306 "Content-type: message/global-delivery-status\n\n"
7307 "Reporting-MTA: dns; %s\n",
7308 bound, smtp_active_hostname);
7312 "Content-type: message/delivery-status\n\n"
7313 "Reporting-MTA: dns; %s\n",
7314 bound, smtp_active_hostname);
7318 /* must be decoded from xtext: see RFC 3461:6.3a */
7320 if (auth_xtextdecode(dsn_envid, &xdec_envid) > 0)
7321 fprintf(f, "Original-Envelope-ID: %s\n", dsn_envid);
7323 fprintf(f, "X-Original-Envelope-ID: error decoding xtext formated ENVID\n");
7327 for (addr = handled_addr; addr; addr = addr->next)
7330 fprintf(f, "Action: failed\n"
7331 "Final-Recipient: rfc822;%s\n"
7334 if ((hu = addr->host_used) && hu->name)
7337 fprintf(f, "Remote-MTA: dns; %s\n", hu->name);
7338 #ifdef EXPERIMENTAL_DSN_INFO
7341 uschar * p = hu->port == 25
7342 ? US"" : string_sprintf(":%d", hu->port);
7343 fprintf(f, "Remote-MTA: X-ip; [%s]%s\n", hu->address, p);
7345 if ((s = addr->smtp_greeting) && *s)
7346 fprintf(f, "X-Remote-MTA-smtp-greeting: X-str; %s\n", s);
7347 if ((s = addr->helo_response) && *s)
7348 fprintf(f, "X-Remote-MTA-helo-response: X-str; %s\n", s);
7349 if ((s = addr->message) && *s)
7350 fprintf(f, "X-Exim-Diagnostic: X-str; %s\n", s);
7352 print_dsn_diagnostic_code(addr, f);
7357 /* Now copy the message, trying to give an intelligible comment if
7358 it is too long for it all to be copied. The limit isn't strictly
7359 applied because of the buffering. There is, however, an option
7360 to suppress copying altogether. */
7362 emf_text = next_emf(emf, US"copy");
7365 we ignore the intro text from template and add
7366 the text for bounce_return_size_limit at the end.
7368 bounce_return_message is ignored
7369 in case RET= is defined we honor these values
7370 otherwise bounce_return_body is honored.
7372 bounce_return_size_limit is always honored.
7375 fprintf(f, "--%s\n", bound);
7377 dsnlimitmsg = US"X-Exim-DSN-Information: Due to administrative limits only headers are returned";
7378 dsnnotifyhdr = NULL;
7379 topt = topt_add_return_path;
7381 /* RET=HDRS? top priority */
7382 if (dsn_ret == dsn_ret_hdrs)
7383 topt |= topt_no_body;
7385 /* no full body return at all? */
7386 if (!bounce_return_body)
7388 topt |= topt_no_body;
7389 /* add header if we overrule RET=FULL */
7390 if (dsn_ret == dsn_ret_full)
7391 dsnnotifyhdr = dsnlimitmsg;
7393 /* size limited ... return headers only if limit reached */
7394 else if (bounce_return_size_limit > 0)
7396 struct stat statbuf;
7397 if (fstat(deliver_datafile, &statbuf) == 0 && statbuf.st_size > max)
7399 topt |= topt_no_body;
7400 dsnnotifyhdr = dsnlimitmsg;
7404 #ifdef EXPERIMENTAL_INTERNATIONAL
7405 if (message_smtputf8)
7406 fputs(topt & topt_no_body ? "Content-type: message/global-headers\n\n"
7407 : "Content-type: message/global\n\n",
7411 fputs(topt & topt_no_body ? "Content-type: text/rfc822-headers\n\n"
7412 : "Content-type: message/rfc822\n\n",
7416 transport_filter_argv = NULL; /* Just in case */
7417 return_path = sender_address; /* In case not previously set */
7418 transport_write_message(NULL, fileno(f), topt,
7419 0, dsnnotifyhdr, NULL, NULL, NULL, NULL, 0);
7422 /* we never add the final text. close the file */
7426 fprintf(f, "\n--%s--\n", bound);
7428 /* Close the file, which should send an EOF to the child process
7429 that is receiving the message. Wait for it to finish. */
7432 rc = child_close(pid, 0); /* Waits for child to close, no timeout */
7434 /* In the test harness, let the child do it's thing first. */
7436 if (running_in_test_harness) millisleep(500);
7438 /* If the process failed, there was some disaster in setting up the
7439 error message. Unless the message is very old, ensure that addr_defer
7440 is non-null, which will have the effect of leaving the message on the
7441 spool. The failed addresses will get tried again next time. However, we
7442 don't really want this to happen too often, so freeze the message unless
7443 there are some genuine deferred addresses to try. To do this we have
7444 to call spool_write_header() here, because with no genuine deferred
7445 addresses the normal code below doesn't get run. */
7450 if (now - received_time < retry_maximum_timeout && !addr_defer)
7452 addr_defer = (address_item *)(+1);
7453 deliver_freeze = TRUE;
7454 deliver_frozen_at = time(NULL);
7455 /* Panic-dies on error */
7456 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
7459 deliver_msglog("Process failed (%d) when writing error message "
7460 "to %s%s", rc, bounce_recipient, s);
7461 log_write(0, LOG_MAIN, "Process failed (%d) when writing error message "
7462 "to %s%s", rc, bounce_recipient, s);
7465 /* The message succeeded. Ensure that the recipients that failed are
7466 now marked finished with on the spool and their parents updated. */
7470 for (addr = handled_addr; addr; addr = addr->next)
7472 address_done(addr, logtod);
7473 child_done(addr, logtod);
7475 /* Panic-dies on error */
7476 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
7482 disable_logging = FALSE; /* In case left set */
7484 /* Come here from the mua_wrapper case if routing goes wrong */
7488 /* If there are now no deferred addresses, we are done. Preserve the
7489 message log if so configured, and we are using them. Otherwise, sling it.
7490 Then delete the message itself. */
7496 sprintf(CS spoolname, "%s/msglog/%s/%s", spool_directory, message_subdir,
7498 if (preserve_message_logs)
7501 sprintf(CS big_buffer, "%s/msglog.OLD/%s", spool_directory, id);
7502 if ((rc = Urename(spoolname, big_buffer)) < 0)
7504 (void)directory_make(spool_directory, US"msglog.OLD",
7505 MSGLOG_DIRECTORY_MODE, TRUE);
7506 rc = Urename(spoolname, big_buffer);
7509 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to move %s to the "
7510 "msglog.OLD directory", spoolname);
7513 if (Uunlink(spoolname) < 0)
7514 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s",
7515 spoolname, strerror(errno));
7518 /* Remove the two message files. */
7520 sprintf(CS spoolname, "%s/input/%s/%s-D", spool_directory, message_subdir, id);
7521 if (Uunlink(spoolname) < 0)
7522 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s",
7523 spoolname, strerror(errno));
7524 sprintf(CS spoolname, "%s/input/%s/%s-H", spool_directory, message_subdir, id);
7525 if (Uunlink(spoolname) < 0)
7526 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s",
7527 spoolname, strerror(errno));
7529 /* Log the end of this message, with queue time if requested. */
7531 if (LOGGING(queue_time_overall))
7532 log_write(0, LOG_MAIN, "Completed QT=%s",
7533 readconf_printtime( (int) ((long)time(NULL) - (long)received_time)) );
7535 log_write(0, LOG_MAIN, "Completed");
7537 /* Unset deliver_freeze so that we won't try to move the spool files further down */
7538 deliver_freeze = FALSE;
7540 #ifdef EXPERIMENTAL_EVENT
7541 (void) event_raise(event_action, US"msg:complete", NULL);
7545 /* If there are deferred addresses, we are keeping this message because it is
7546 not yet completed. Lose any temporary files that were catching output from
7547 pipes for any of the deferred addresses, handle one-time aliases, and see if
7548 the message has been on the queue for so long that it is time to send a warning
7549 message to the sender, unless it is a mailer-daemon. If all deferred addresses
7550 have the same domain, we can set deliver_domain for the expansion of
7551 delay_warning_ condition - if any of them are pipes, files, or autoreplies, use
7552 the parent's domain.
7554 If all the deferred addresses have an error number that indicates "retry time
7555 not reached", skip sending the warning message, because it won't contain the
7556 reason for the delay. It will get sent at the next real delivery attempt.
7557 However, if at least one address has tried, we'd better include all of them in
7560 If we can't make a process to send the message, don't worry.
7562 For mailing list expansions we want to send the warning message to the
7563 mailing list manager. We can't do a perfect job here, as some addresses may
7564 have different errors addresses, but if we take the errors address from
7565 each deferred address it will probably be right in most cases.
7567 If addr_defer == +1, it means there was a problem sending an error message
7568 for failed addresses, and there were no "real" deferred addresses. The value
7569 was set just to keep the message on the spool, so there is nothing to do here.
7572 else if (addr_defer != (address_item *)(+1))
7575 uschar *recipients = US"";
7576 BOOL delivery_attempted = FALSE;
7578 deliver_domain = testflag(addr_defer, af_pfr)
7579 ? addr_defer->parent->domain : addr_defer->domain;
7581 for (addr = addr_defer; addr; addr = addr->next)
7583 address_item *otaddr;
7585 if (addr->basic_errno > ERRNO_RETRY_BASE) delivery_attempted = TRUE;
7589 const uschar *d = testflag(addr, af_pfr)
7590 ? addr->parent->domain : addr->domain;
7592 /* The domain may be unset for an address that has never been routed
7593 because the system filter froze the message. */
7595 if (!d || Ustrcmp(d, deliver_domain) != 0)
7596 deliver_domain = NULL;
7599 if (addr->return_filename) Uunlink(addr->return_filename);
7601 /* Handle the case of one-time aliases. If any address in the ancestry
7602 of this one is flagged, ensure it is in the recipients list, suitably
7603 flagged, and that its parent is marked delivered. */
7605 for (otaddr = addr; otaddr; otaddr = otaddr->parent)
7606 if (otaddr->onetime_parent) break;
7611 int t = recipients_count;
7613 for (i = 0; i < recipients_count; i++)
7615 uschar *r = recipients_list[i].address;
7616 if (Ustrcmp(otaddr->onetime_parent, r) == 0) t = i;
7617 if (Ustrcmp(otaddr->address, r) == 0) break;
7620 /* Didn't find the address already in the list, and did find the
7621 ultimate parent's address in the list. After adding the recipient,
7622 update the errors address in the recipients list. */
7624 if (i >= recipients_count && t < recipients_count)
7626 DEBUG(D_deliver) debug_printf("one_time: adding %s in place of %s\n",
7627 otaddr->address, otaddr->parent->address);
7628 receive_add_recipient(otaddr->address, t);
7629 recipients_list[recipients_count-1].errors_to = otaddr->prop.errors_address;
7630 tree_add_nonrecipient(otaddr->parent->address);
7631 update_spool = TRUE;
7635 /* Except for error messages, ensure that either the errors address for
7636 this deferred address or, if there is none, the sender address, is on the
7637 list of recipients for a warning message. */
7639 if (sender_address[0] != 0)
7640 if (addr->prop.errors_address)
7642 if (Ustrstr(recipients, addr->prop.errors_address) == NULL)
7643 recipients = string_sprintf("%s%s%s", recipients,
7644 (recipients[0] == 0)? "" : ",", addr->prop.errors_address);
7648 if (Ustrstr(recipients, sender_address) == NULL)
7649 recipients = string_sprintf("%s%s%s", recipients,
7650 (recipients[0] == 0)? "" : ",", sender_address);
7654 /* Send a warning message if the conditions are right. If the condition check
7655 fails because of a lookup defer, there is nothing we can do. The warning
7656 is not sent. Another attempt will be made at the next delivery attempt (if
7660 && delivery_attempted
7661 && ( ((addr_defer->dsn_flags & rf_dsnflags) == 0)
7662 || (addr_defer->dsn_flags & rf_notify_delay) == rf_notify_delay
7664 && delay_warning[1] > 0
7665 && sender_address[0] != 0
7666 && ( !delay_warning_condition
7667 || expand_check_condition(delay_warning_condition,
7668 US"delay_warning", US"option")
7674 int queue_time = time(NULL) - received_time;
7676 /* When running in the test harness, there's an option that allows us to
7677 fudge this time so as to get repeatability of the tests. Take the first
7678 time off the list. In queue runs, the list pointer gets updated in the
7681 if (running_in_test_harness && fudged_queue_times[0] != 0)
7683 int qt = readconf_readtime(fudged_queue_times, '/', FALSE);
7686 DEBUG(D_deliver) debug_printf("fudged queue_times = %s\n",
7687 fudged_queue_times);
7692 /* See how many warnings we should have sent by now */
7694 for (count = 0; count < delay_warning[1]; count++)
7695 if (queue_time < delay_warning[count+2]) break;
7697 show_time = delay_warning[count+1];
7699 if (count >= delay_warning[1])
7702 int last_gap = show_time;
7703 if (count > 1) last_gap -= delay_warning[count];
7704 extra = (queue_time - delay_warning[count+1])/last_gap;
7705 show_time += last_gap * extra;
7711 debug_printf("time on queue = %s\n", readconf_printtime(queue_time));
7712 debug_printf("warning counts: required %d done %d\n", count,
7716 /* We have computed the number of warnings there should have been by now.
7717 If there haven't been enough, send one, and up the count to what it should
7720 if (warning_count < count)
7724 pid_t pid = child_open_exim(&fd);
7730 FILE *f = fdopen(fd, "wb");
7733 if (warn_message_file)
7734 if (!(wmf = Ufopen(warn_message_file, "rb")))
7735 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to open %s for warning "
7736 "message texts: %s", warn_message_file, strerror(errno));
7738 warnmsg_recipients = recipients;
7739 warnmsg_delay = queue_time < 120*60
7740 ? string_sprintf("%d minutes", show_time/60)
7741 : string_sprintf("%d hours", show_time/3600);
7743 if (errors_reply_to)
7744 fprintf(f, "Reply-To: %s\n", errors_reply_to);
7745 fprintf(f, "Auto-Submitted: auto-replied\n");
7747 fprintf(f, "To: %s\n", recipients);
7749 /* generated boundary string and output MIME-Headers */
7750 bound = string_sprintf(TIME_T_FMT "-eximdsn-%d", time(NULL), rand());
7752 fprintf(f, "Content-Type: multipart/report;"
7753 " report-type=delivery-status; boundary=%s\n"
7754 "MIME-Version: 1.0\n",
7757 if ((wmf_text = next_emf(wmf, US"header")))
7758 fprintf(f, "%s\n", wmf_text);
7760 fprintf(f, "Subject: Warning: message %s delayed %s\n\n",
7761 message_id, warnmsg_delay);
7763 /* output human readable part as text/plain section */
7765 "Content-type: text/plain; charset=us-ascii\n\n",
7768 if ((wmf_text = next_emf(wmf, US"intro")))
7769 fprintf(f, "%s", CS wmf_text);
7773 "This message was created automatically by mail delivery software.\n");
7775 if (Ustrcmp(recipients, sender_address) == 0)
7777 "A message that you sent has not yet been delivered to one or more of its\n"
7778 "recipients after more than ");
7782 "A message sent by\n\n <%s>\n\n"
7783 "has not yet been delivered to one or more of its recipients after more than \n",
7786 fprintf(f, "%s on the queue on %s.\n\n"
7787 "The message identifier is: %s\n",
7788 warnmsg_delay, primary_hostname, message_id);
7790 for (h = header_list; h; h = h->next)
7791 if (strncmpic(h->text, US"Subject:", 8) == 0)
7792 fprintf(f, "The subject of the message is: %s", h->text + 9);
7793 else if (strncmpic(h->text, US"Date:", 5) == 0)
7794 fprintf(f, "The date of the message is: %s", h->text + 6);
7797 fprintf(f, "The address%s to which the message has not yet been "
7799 !addr_defer->next ? "" : "es",
7800 !addr_defer->next ? "is": "are");
7803 /* List the addresses, with error information if allowed */
7805 /* store addr_defer for machine readable part */
7806 address_item *addr_dsndefer = addr_defer;
7810 address_item *addr = addr_defer;
7811 addr_defer = addr->next;
7812 if (print_address_information(addr, f, US" ", US"\n ", US""))
7813 print_address_error(addr, f, US"Delay reason: ");
7822 if ((wmf_text = next_emf(wmf, US"final")))
7823 fprintf(f, "%s", CS wmf_text);
7829 "No action is required on your part. Delivery attempts will continue for\n"
7830 "some time, and this warning may be repeated at intervals if the message\n"
7831 "remains undelivered. Eventually the mail delivery software will give up,\n"
7832 "and when that happens, the message will be returned to you.\n");
7835 /* output machine readable part */
7836 fprintf(f, "\n--%s\n"
7837 "Content-type: message/delivery-status\n\n"
7838 "Reporting-MTA: dns; %s\n",
7840 smtp_active_hostname);
7845 /* must be decoded from xtext: see RFC 3461:6.3a */
7847 if (auth_xtextdecode(dsn_envid, &xdec_envid) > 0)
7848 fprintf(f,"Original-Envelope-ID: %s\n", dsn_envid);
7850 fprintf(f,"X-Original-Envelope-ID: error decoding xtext formated ENVID\n");
7854 for ( ; addr_dsndefer; addr_dsndefer = addr_dsndefer->next)
7856 if (addr_dsndefer->dsn_orcpt)
7857 fprintf(f, "Original-Recipient: %s\n", addr_dsndefer->dsn_orcpt);
7859 fprintf(f, "Action: delayed\n"
7860 "Final-Recipient: rfc822;%s\n"
7862 addr_dsndefer->address);
7863 if (addr_dsndefer->host_used && addr_dsndefer->host_used->name)
7865 fprintf(f, "Remote-MTA: dns; %s\n",
7866 addr_dsndefer->host_used->name);
7867 print_dsn_diagnostic_code(addr_dsndefer, f);
7873 "Content-type: text/rfc822-headers\n\n",
7877 /* header only as required by RFC. only failure DSN needs to honor RET=FULL */
7878 int topt = topt_add_return_path | topt_no_body;
7879 transport_filter_argv = NULL; /* Just in case */
7880 return_path = sender_address; /* In case not previously set */
7881 /* Write the original email out */
7882 transport_write_message(NULL, fileno(f), topt, 0, NULL, NULL, NULL, NULL, NULL, 0);
7885 fprintf(f,"\n--%s--\n", bound);
7889 /* Close and wait for child process to complete, without a timeout.
7890 If there's an error, don't update the count. */
7893 if (child_close(pid, 0) == 0)
7895 warning_count = count;
7896 update_spool = TRUE; /* Ensure spool rewritten */
7902 /* Clear deliver_domain */
7904 deliver_domain = NULL;
7906 /* If this was a first delivery attempt, unset the first time flag, and
7907 ensure that the spool gets updated. */
7909 if (deliver_firsttime)
7911 deliver_firsttime = FALSE;
7912 update_spool = TRUE;
7915 /* If delivery was frozen and freeze_tell is set, generate an appropriate
7916 message, unless the message is a local error message (to avoid loops). Then
7917 log the freezing. If the text in "frozen_info" came from a system filter,
7918 it has been escaped into printing characters so as not to mess up log lines.
7919 For the "tell" message, we turn \n back into newline. Also, insert a newline
7920 near the start instead of the ": " string. */
7924 if (freeze_tell && freeze_tell[0] != 0 && !local_error_message)
7926 uschar *s = string_copy(frozen_info);
7927 uschar *ss = Ustrstr(s, " by the system filter: ");
7938 if (*ss == '\\' && ss[1] == 'n')
7945 moan_tell_someone(freeze_tell, addr_defer, US"Message frozen",
7946 "Message %s has been frozen%s.\nThe sender is <%s>.\n", message_id,
7950 /* Log freezing just before we update the -H file, to minimize the chance
7951 of a race problem. */
7953 deliver_msglog("*** Frozen%s\n", frozen_info);
7954 log_write(0, LOG_MAIN, "Frozen%s", frozen_info);
7957 /* If there have been any updates to the non-recipients list, or other things
7958 that get written to the spool, we must now update the spool header file so
7959 that it has the right information for the next delivery attempt. If there
7960 was more than one address being delivered, the header_change update is done
7961 earlier, in case one succeeds and then something crashes. */
7964 debug_printf("delivery deferred: update_spool=%d header_rewritten=%d\n",
7965 update_spool, header_rewritten);
7967 if (update_spool || header_rewritten)
7968 /* Panic-dies on error */
7969 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
7972 /* Finished with the message log. If the message is complete, it will have
7973 been unlinked or renamed above. */
7975 if (message_logs) (void)fclose(message_log);
7977 /* Now we can close and remove the journal file. Its only purpose is to record
7978 successfully completed deliveries asap so that this information doesn't get
7979 lost if Exim (or the machine) crashes. Forgetting about a failed delivery is
7980 not serious, as trying it again is not harmful. The journal might not be open
7981 if all addresses were deferred at routing or directing. Nevertheless, we must
7982 remove it if it exists (may have been lying around from a crash during the
7983 previous delivery attempt). We don't remove the journal if a delivery
7984 subprocess failed to pass back delivery information; this is controlled by
7985 the remove_journal flag. When the journal is left, we also don't move the
7986 message off the main spool if frozen and the option is set. It should get moved
7987 at the next attempt, after the journal has been inspected. */
7989 if (journal_fd >= 0) (void)close(journal_fd);
7993 sprintf(CS spoolname, "%s/input/%s/%s-J", spool_directory, message_subdir, id);
7994 if (Uunlink(spoolname) < 0 && errno != ENOENT)
7995 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s", spoolname,
7998 /* Move the message off the spool if reqested */
8000 #ifdef SUPPORT_MOVE_FROZEN_MESSAGES
8001 if (deliver_freeze && move_frozen_messages)
8002 (void)spool_move_message(id, message_subdir, US"", US"F");
8006 /* Closing the data file frees the lock; if the file has been unlinked it
8007 will go away. Otherwise the message becomes available for another process
8010 (void)close(deliver_datafile);
8011 deliver_datafile = -1;
8012 DEBUG(D_deliver) debug_printf("end delivery of %s\n", id);
8014 /* It is unlikely that there will be any cached resources, since they are
8015 released after routing, and in the delivery subprocesses. However, it's
8016 possible for an expansion for something afterwards (for example,
8017 expand_check_condition) to do a lookup. We must therefore be sure everything is
8021 acl_where = ACL_WHERE_UNKNOWN;
8030 if (!regex_PIPELINING) regex_PIPELINING =
8031 regex_must_compile(US"\\n250[\\s\\-]PIPELINING(\\s|\\n|$)", FALSE, TRUE);
8033 if (!regex_SIZE) regex_SIZE =
8034 regex_must_compile(US"\\n250[\\s\\-]SIZE(\\s|\\n|$)", FALSE, TRUE);
8036 if (!regex_AUTH) regex_AUTH =
8037 regex_must_compile(US"\\n250[\\s\\-]AUTH\\s+([\\-\\w\\s]+)(?:\\n|$)",
8041 if (!regex_STARTTLS) regex_STARTTLS =
8042 regex_must_compile(US"\\n250[\\s\\-]STARTTLS(\\s|\\n|$)", FALSE, TRUE);
8045 #ifndef DISABLE_PRDR
8046 if (!regex_PRDR) regex_PRDR =
8047 regex_must_compile(US"\\n250[\\s\\-]PRDR(\\s|\\n|$)", FALSE, TRUE);
8050 #ifdef EXPERIMENTAL_INTERNATIONAL
8051 if (!regex_UTF8) regex_UTF8 =
8052 regex_must_compile(US"\\n250[\\s\\-]SMTPUTF8(\\s|\\n|$)", FALSE, TRUE);
8055 if (!regex_DSN) regex_DSN =
8056 regex_must_compile(US"\\n250[\\s\\-]DSN(\\s|\\n|$)", FALSE, TRUE);
8058 if (!regex_IGNOREQUOTA) regex_IGNOREQUOTA =
8059 regex_must_compile(US"\\n250[\\s\\-]IGNOREQUOTA(\\s|\\n|$)", FALSE, TRUE);
8064 deliver_get_sender_address (uschar * id)
8067 uschar * new_sender_address,
8068 * save_sender_address;
8070 if (!spool_open_datafile(id))
8073 /* Save and restore the global sender_address. I'm not sure if we should
8074 not save/restore all the other global variables too, because
8075 spool_read_header() may change all of them. But OTOH, when this
8076 deliver_get_sender_address() gets called, the current message is done
8077 already and nobody needs the globals anymore. (HS12, 2015-08-21) */
8079 sprintf(CS spoolname, "%s-H", id);
8080 save_sender_address = sender_address;
8082 rc = spool_read_header(spoolname, TRUE, TRUE);
8084 new_sender_address = sender_address;
8085 sender_address = save_sender_address;
8087 if (rc != spool_read_OK)
8090 assert(new_sender_address);
8092 (void)close(deliver_datafile);
8093 deliver_datafile = -1;
8095 return new_sender_address;
8100 /* End of deliver.c */