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)
1291 s = string_append(s, &size, &ptr, 5,
1292 US" H=", addr->host_used->name,
1293 US" [", addr->host_used->address, US"]");
1296 s = string_append(s, &size, &ptr, 2, US": ", addr->message);
1300 /* Log the deferment in the message log, but don't clutter it
1301 up with retry-time defers after the first delivery attempt. */
1303 if (deliver_firsttime || addr->basic_errno > ERRNO_RETRY_BASE)
1304 deliver_msglog("%s %s\n", now, s);
1306 /* Write the main log and reset the store */
1308 log_write(use_log_selector, logflags, "== %s", s);
1309 store_reset(reset_point);
1314 /* Hard failure. If there is an address to which an error message can be sent,
1315 put this address on the failed list. If not, put it on the deferred list and
1316 freeze the mail message for human attention. The latter action can also be
1317 explicitly requested by a router or transport. */
1321 /* If this is a delivery error, or a message for which no replies are
1322 wanted, and the message's age is greater than ignore_bounce_errors_after,
1323 force the af_ignore_error flag. This will cause the address to be discarded
1324 later (with a log entry). */
1326 if (sender_address[0] == 0 && message_age >= ignore_bounce_errors_after)
1327 setflag(addr, af_ignore_error);
1329 /* Freeze the message if requested, or if this is a bounce message (or other
1330 message with null sender) and this address does not have its own errors
1331 address. However, don't freeze if errors are being ignored. The actual code
1332 to ignore occurs later, instead of sending a message. Logging of freezing
1333 occurs later, just before writing the -H file. */
1335 if ( !testflag(addr, af_ignore_error)
1336 && ( addr->special_action == SPECIAL_FREEZE
1337 || (sender_address[0] == 0 && !addr->prop.errors_address)
1340 frozen_info = addr->special_action == SPECIAL_FREEZE
1342 : sender_local && !local_error_message
1343 ? US" (message created with -f <>)"
1344 : US" (delivery error message)";
1345 deliver_freeze = TRUE;
1346 deliver_frozen_at = time(NULL);
1347 update_spool = TRUE;
1349 /* The address is put on the defer rather than the failed queue, because
1350 the message is being retained. */
1352 addr->next = addr_defer;
1356 /* Don't put the address on the nonrecipients tree yet; wait until an
1357 error message has been successfully sent. */
1361 addr->next = addr_failed;
1365 /* Build up the log line for the message and main logs */
1367 s = reset_point = store_get(size);
1369 /* Create the address string for logging. Must not do this earlier, because
1370 an OK result may be changed to FAIL when a pipe returns text. */
1372 log_address = string_log_address(addr, LOGGING(all_parents), result == OK);
1374 s = string_cat(s, &size, &ptr, log_address, Ustrlen(log_address));
1376 if (LOGGING(sender_on_delivery))
1377 s = string_append(s, &size, &ptr, 3, US" F=<", sender_address, US">");
1379 /* Return path may not be set if no delivery actually happened */
1381 if (used_return_path && LOGGING(return_path_on_delivery))
1382 s = string_append(s, &size, &ptr, 3, US" P=<", used_return_path, US">");
1385 s = string_append(s, &size, &ptr, 2, US" R=", addr->router->name);
1386 if (addr->transport)
1387 s = string_append(s, &size, &ptr, 2, US" T=", addr->transport->name);
1389 if (addr->host_used)
1390 s = d_hostlog(s, &size, &ptr, addr);
1393 s = d_tlslog(s, &size, &ptr, addr);
1396 if (addr->basic_errno > 0)
1397 s = string_append(s, &size, &ptr, 2, US": ",
1398 US strerror(addr->basic_errno));
1401 s = string_append(s, &size, &ptr, 2, US": ", addr->message);
1405 /* Do the logging. For the message log, "routing failed" for those cases,
1406 just to make it clearer. */
1409 deliver_msglog("%s %s\n", now, s);
1411 deliver_msglog("%s %s failed for %s\n", now, driver_kind, s);
1413 log_write(0, LOG_MAIN, "** %s", s);
1415 #ifdef EXPERIMENTAL_EVENT
1416 msg_event_raise(US"msg:fail:delivery", addr);
1419 store_reset(reset_point);
1422 /* Ensure logging is turned on again in all cases */
1424 disable_logging = FALSE;
1430 /*************************************************
1431 * Address-independent error *
1432 *************************************************/
1434 /* This function is called when there's an error that is not dependent on a
1435 particular address, such as an expansion string failure. It puts the error into
1436 all the addresses in a batch, logs the incident on the main and panic logs, and
1437 clears the expansions. It is mostly called from local_deliver(), but can be
1438 called for a remote delivery via findugid().
1441 logit TRUE if (MAIN+PANIC) logging required
1442 addr the first of the chain of addresses
1444 format format string for error message, or NULL if already set in addr
1445 ... arguments for the format
1451 common_error(BOOL logit, address_item *addr, int code, uschar *format, ...)
1453 address_item *addr2;
1454 addr->basic_errno = code;
1460 va_start(ap, format);
1461 if (!string_vformat(buffer, sizeof(buffer), CS format, ap))
1462 log_write(0, LOG_MAIN|LOG_PANIC_DIE,
1463 "common_error expansion was longer than " SIZE_T_FMT, sizeof(buffer));
1465 addr->message = string_copy(buffer);
1468 for (addr2 = addr->next; addr2; addr2 = addr2->next)
1470 addr2->basic_errno = code;
1471 addr2->message = addr->message;
1474 if (logit) log_write(0, LOG_MAIN|LOG_PANIC, "%s", addr->message);
1475 deliver_set_expansions(NULL);
1481 /*************************************************
1482 * Check a "never users" list *
1483 *************************************************/
1485 /* This function is called to check whether a uid is on one of the two "never
1489 uid the uid to be checked
1490 nusers the list to be scanned; the first item in the list is the count
1492 Returns: TRUE if the uid is on the list
1496 check_never_users(uid_t uid, uid_t *nusers)
1499 if (!nusers) return FALSE;
1500 for (i = 1; i <= (int)(nusers[0]); i++) if (nusers[i] == uid) return TRUE;
1506 /*************************************************
1507 * Find uid and gid for a transport *
1508 *************************************************/
1510 /* This function is called for both local and remote deliveries, to find the
1511 uid/gid under which to run the delivery. The values are taken preferentially
1512 from the transport (either explicit or deliver_as_creator), then from the
1513 address (i.e. the router), and if nothing is set, the exim uid/gid are used. If
1514 the resulting uid is on the "never_users" or the "fixed_never_users" list, a
1515 panic error is logged, and the function fails (which normally leads to delivery
1519 addr the address (possibly a chain)
1521 uidp pointer to uid field
1522 gidp pointer to gid field
1523 igfp pointer to the use_initgroups field
1525 Returns: FALSE if failed - error has been set in address(es)
1529 findugid(address_item *addr, transport_instance *tp, uid_t *uidp, gid_t *gidp,
1533 BOOL gid_set = FALSE;
1535 /* Default initgroups flag comes from the transport */
1537 *igfp = tp->initgroups;
1539 /* First see if there's a gid on the transport, either fixed or expandable.
1540 The expanding function always logs failure itself. */
1547 else if (tp->expand_gid)
1549 if (!route_find_expanded_group(tp->expand_gid, tp->name, US"transport", gidp,
1552 common_error(FALSE, addr, ERRNO_GIDFAIL, NULL);
1558 /* If the transport did not set a group, see if the router did. */
1560 if (!gid_set && testflag(addr, af_gid_set))
1566 /* Pick up a uid from the transport if one is set. */
1568 if (tp->uid_set) *uidp = tp->uid;
1570 /* Otherwise, try for an expandable uid field. If it ends up as a numeric id,
1571 it does not provide a passwd value from which a gid can be taken. */
1573 else if (tp->expand_uid)
1576 if (!route_find_expanded_user(tp->expand_uid, tp->name, US"transport", &pw,
1577 uidp, &(addr->message)))
1579 common_error(FALSE, addr, ERRNO_UIDFAIL, NULL);
1589 /* If the transport doesn't set the uid, test the deliver_as_creator flag. */
1591 else if (tp->deliver_as_creator)
1593 *uidp = originator_uid;
1596 *gidp = originator_gid;
1601 /* Otherwise see if the address specifies the uid and if so, take it and its
1604 else if (testflag(addr, af_uid_set))
1607 *igfp = testflag(addr, af_initgroups);
1610 /* Nothing has specified the uid - default to the Exim user, and group if the
1623 /* If no gid is set, it is a disaster. We default to the Exim gid only if
1624 defaulting to the Exim uid. In other words, if the configuration has specified
1625 a uid, it must also provide a gid. */
1629 common_error(TRUE, addr, ERRNO_GIDFAIL, US"User set without group for "
1630 "%s transport", tp->name);
1634 /* Check that the uid is not on the lists of banned uids that may not be used
1635 for delivery processes. */
1637 nuname = check_never_users(*uidp, never_users)
1639 : check_never_users(*uidp, fixed_never_users)
1640 ? US"fixed_never_users"
1644 common_error(TRUE, addr, ERRNO_UIDFAIL, US"User %ld set for %s transport "
1645 "is on the %s list", (long int)(*uidp), tp->name, nuname);
1657 /*************************************************
1658 * Check the size of a message for a transport *
1659 *************************************************/
1661 /* Checks that the message isn't too big for the selected transport.
1662 This is called only when it is known that the limit is set.
1666 addr the (first) address being delivered
1669 DEFER expansion failed or did not yield an integer
1670 FAIL message too big
1674 check_message_size(transport_instance *tp, address_item *addr)
1679 deliver_set_expansions(addr);
1680 size_limit = expand_string_integer(tp->message_size_limit, TRUE);
1681 deliver_set_expansions(NULL);
1683 if (expand_string_message)
1686 addr->message = size_limit == -1
1687 ? string_sprintf("failed to expand message_size_limit "
1688 "in %s transport: %s", tp->name, expand_string_message)
1689 : string_sprintf("invalid message_size_limit "
1690 "in %s transport: %s", tp->name, expand_string_message);
1692 else if (size_limit > 0 && message_size > size_limit)
1696 string_sprintf("message is too big (transport limit = %d)",
1705 /*************************************************
1706 * Transport-time check for a previous delivery *
1707 *************************************************/
1709 /* Check that this base address hasn't previously been delivered to its routed
1710 transport. If it has been delivered, mark it done. The check is necessary at
1711 delivery time in order to handle homonymic addresses correctly in cases where
1712 the pattern of redirection changes between delivery attempts (so the unique
1713 fields change). Non-homonymic previous delivery is detected earlier, at routing
1714 time (which saves unnecessary routing).
1717 addr the address item
1718 testing TRUE if testing wanted only, without side effects
1720 Returns: TRUE if previously delivered by the transport
1724 previously_transported(address_item *addr, BOOL testing)
1726 (void)string_format(big_buffer, big_buffer_size, "%s/%s",
1727 addr->unique + (testflag(addr, af_homonym)? 3:0), addr->transport->name);
1729 if (tree_search(tree_nonrecipients, big_buffer) != 0)
1731 DEBUG(D_deliver|D_route|D_transport)
1732 debug_printf("%s was previously delivered (%s transport): discarded\n",
1733 addr->address, addr->transport->name);
1734 if (!testing) child_done(addr, tod_stamp(tod_log));
1743 /******************************************************
1744 * Check for a given header in a header string *
1745 ******************************************************/
1747 /* This function is used when generating quota warnings. The configuration may
1748 specify any header lines it likes in quota_warn_message. If certain of them are
1749 missing, defaults are inserted, so we need to be able to test for the presence
1753 hdr the required header name
1754 hstring the header string
1756 Returns: TRUE the header is in the string
1757 FALSE the header is not in the string
1761 contains_header(uschar *hdr, uschar *hstring)
1763 int len = Ustrlen(hdr);
1764 uschar *p = hstring;
1767 if (strncmpic(p, hdr, len) == 0)
1770 while (*p == ' ' || *p == '\t') p++;
1771 if (*p == ':') return TRUE;
1773 while (*p != 0 && *p != '\n') p++;
1774 if (*p == '\n') p++;
1782 /*************************************************
1783 * Perform a local delivery *
1784 *************************************************/
1786 /* Each local delivery is performed in a separate process which sets its
1787 uid and gid as specified. This is a safer way than simply changing and
1788 restoring using seteuid(); there is a body of opinion that seteuid() cannot be
1789 used safely. From release 4, Exim no longer makes any use of it. Besides, not
1790 all systems have seteuid().
1792 If the uid/gid are specified in the transport_instance, they are used; the
1793 transport initialization must ensure that either both or neither are set.
1794 Otherwise, the values associated with the address are used. If neither are set,
1795 it is a configuration error.
1797 The transport or the address may specify a home directory (transport over-
1798 rides), and if they do, this is set as $home. If neither have set a working
1799 directory, this value is used for that as well. Otherwise $home is left unset
1800 and the cwd is set to "/" - a directory that should be accessible to all users.
1802 Using a separate process makes it more complicated to get error information
1803 back. We use a pipe to pass the return code and also an error code and error
1804 text string back to the parent process.
1807 addr points to an address block for this delivery; for "normal" local
1808 deliveries this is the only address to be delivered, but for
1809 pseudo-remote deliveries (e.g. by batch SMTP to a file or pipe)
1810 a number of addresses can be handled simultaneously, and in this
1811 case addr will point to a chain of addresses with the same
1814 shadowing TRUE if running a shadow transport; this causes output from pipes
1821 deliver_local(address_item *addr, BOOL shadowing)
1823 BOOL use_initgroups;
1826 int status, len, rc;
1829 uschar *working_directory;
1830 address_item *addr2;
1831 transport_instance *tp = addr->transport;
1833 /* Set up the return path from the errors or sender address. If the transport
1834 has its own return path setting, expand it and replace the existing value. */
1836 if(addr->prop.errors_address)
1837 return_path = addr->prop.errors_address;
1838 #ifdef EXPERIMENTAL_SRS
1839 else if (addr->prop.srs_sender)
1840 return_path = addr->prop.srs_sender;
1843 return_path = sender_address;
1845 if (tp->return_path)
1847 uschar *new_return_path = expand_string(tp->return_path);
1848 if (!new_return_path)
1850 if (!expand_string_forcedfail)
1852 common_error(TRUE, addr, ERRNO_EXPANDFAIL,
1853 US"Failed to expand return path \"%s\" in %s transport: %s",
1854 tp->return_path, tp->name, expand_string_message);
1858 else return_path = new_return_path;
1861 /* For local deliveries, one at a time, the value used for logging can just be
1862 set directly, once and for all. */
1864 used_return_path = return_path;
1866 /* Sort out the uid, gid, and initgroups flag. If an error occurs, the message
1867 gets put into the address(es), and the expansions are unset, so we can just
1870 if (!findugid(addr, tp, &uid, &gid, &use_initgroups)) return;
1872 /* See if either the transport or the address specifies a home directory. A
1873 home directory set in the address may already be expanded; a flag is set to
1874 indicate that. In other cases we must expand it. */
1876 if ( (deliver_home = tp->home_dir) /* Set in transport, or */
1877 || ( (deliver_home = addr->home_dir) /* Set in address and */
1878 && !testflag(addr, af_home_expanded) /* not expanded */
1881 uschar *rawhome = deliver_home;
1882 deliver_home = NULL; /* in case it contains $home */
1883 if (!(deliver_home = expand_string(rawhome)))
1885 common_error(TRUE, addr, ERRNO_EXPANDFAIL, US"home directory \"%s\" failed "
1886 "to expand for %s transport: %s", rawhome, tp->name,
1887 expand_string_message);
1890 if (*deliver_home != '/')
1892 common_error(TRUE, addr, ERRNO_NOTABSOLUTE, US"home directory path \"%s\" "
1893 "is not absolute for %s transport", deliver_home, tp->name);
1898 /* See if either the transport or the address specifies a current directory,
1899 and if so, expand it. If nothing is set, use the home directory, unless it is
1900 also unset in which case use "/", which is assumed to be a directory to which
1901 all users have access. It is necessary to be in a visible directory for some
1902 operating systems when running pipes, as some commands (e.g. "rm" under Solaris
1903 2.5) require this. */
1905 working_directory = tp->current_dir ? tp->current_dir : addr->current_dir;
1906 if (working_directory)
1908 uschar *raw = working_directory;
1909 if (!(working_directory = expand_string(raw)))
1911 common_error(TRUE, addr, ERRNO_EXPANDFAIL, US"current directory \"%s\" "
1912 "failed to expand for %s transport: %s", raw, tp->name,
1913 expand_string_message);
1916 if (*working_directory != '/')
1918 common_error(TRUE, addr, ERRNO_NOTABSOLUTE, US"current directory path "
1919 "\"%s\" is not absolute for %s transport", working_directory, tp->name);
1923 else working_directory = deliver_home ? deliver_home : US"/";
1925 /* If one of the return_output flags is set on the transport, create and open a
1926 file in the message log directory for the transport to write its output onto.
1927 This is mainly used by pipe transports. The file needs to be unique to the
1928 address. This feature is not available for shadow transports. */
1931 && ( tp->return_output || tp->return_fail_output
1932 || tp->log_output || tp->log_fail_output
1936 addr->return_filename =
1937 string_sprintf("%s/msglog/%s/%s-%d-%d", spool_directory, message_subdir,
1938 message_id, getpid(), return_count++);
1939 addr->return_file = open_msglog_file(addr->return_filename, 0400, &error);
1940 if (addr->return_file < 0)
1942 common_error(TRUE, addr, errno, US"Unable to %s file for %s transport "
1943 "to return message: %s", error, tp->name, strerror(errno));
1948 /*XXX prefer to do max_parallel check before we fork. Are we allowed to defer
1949 this late (we could be a shadow tpt)? */
1951 /* Create the pipe for inter-process communication. */
1955 common_error(TRUE, addr, ERRNO_PIPEFAIL, US"Creation of pipe failed: %s",
1960 /* Now fork the process to do the real work in the subprocess, but first
1961 ensure that all cached resources are freed so that the subprocess starts with
1962 a clean slate and doesn't interfere with the parent process. */
1966 if ((pid = fork()) == 0)
1968 BOOL replicate = TRUE;
1970 /* Prevent core dumps, as we don't want them in users' home directories.
1971 HP-UX doesn't have RLIMIT_CORE; I don't know how to do this in that
1972 system. Some experimental/developing systems (e.g. GNU/Hurd) may define
1973 RLIMIT_CORE but not support it in setrlimit(). For such systems, do not
1974 complain if the error is "not supported".
1976 There are two scenarios where changing the max limit has an effect. In one,
1977 the user is using a .forward and invoking a command of their choice via pipe;
1978 for these, we do need the max limit to be 0 unless the admin chooses to
1979 permit an increased limit. In the other, the command is invoked directly by
1980 the transport and is under administrator control, thus being able to raise
1981 the limit aids in debugging. So there's no general always-right answer.
1983 Thus we inhibit core-dumps completely but let individual transports, while
1984 still root, re-raise the limits back up to aid debugging. We make the
1985 default be no core-dumps -- few enough people can use core dumps in
1986 diagnosis that it's reasonable to make them something that has to be explicitly requested.
1993 if (setrlimit(RLIMIT_CORE, &rl) < 0)
1995 # ifdef SETRLIMIT_NOT_SUPPORTED
1996 if (errno != ENOSYS && errno != ENOTSUP)
1998 log_write(0, LOG_MAIN|LOG_PANIC, "setrlimit(RLIMIT_CORE) failed: %s",
2003 /* Reset the random number generator, so different processes don't all
2004 have the same sequence. */
2008 /* If the transport has a setup entry, call this first, while still
2009 privileged. (Appendfile uses this to expand quota, for example, while
2010 able to read private files.) */
2012 if (addr->transport->setup)
2013 switch((addr->transport->setup)(addr->transport, addr, NULL, uid, gid,
2017 addr->transport_return = DEFER;
2021 addr->transport_return = PANIC;
2025 /* Ignore SIGINT and SIGTERM during delivery. Also ignore SIGUSR1, as
2026 when the process becomes unprivileged, it won't be able to write to the
2027 process log. SIGHUP is ignored throughout exim, except when it is being
2030 signal(SIGINT, SIG_IGN);
2031 signal(SIGTERM, SIG_IGN);
2032 signal(SIGUSR1, SIG_IGN);
2034 /* Close the unwanted half of the pipe, and set close-on-exec for the other
2035 half - for transports that exec things (e.g. pipe). Then set the required
2038 (void)close(pfd[pipe_read]);
2039 (void)fcntl(pfd[pipe_write], F_SETFD, fcntl(pfd[pipe_write], F_GETFD) |
2041 exim_setugid(uid, gid, use_initgroups,
2042 string_sprintf("local delivery to %s <%s> transport=%s", addr->local_part,
2043 addr->address, addr->transport->name));
2047 address_item *batched;
2048 debug_printf(" home=%s current=%s\n", deliver_home, working_directory);
2049 for (batched = addr->next; batched; batched = batched->next)
2050 debug_printf("additional batched address: %s\n", batched->address);
2053 /* Set an appropriate working directory. */
2055 if (Uchdir(working_directory) < 0)
2057 addr->transport_return = DEFER;
2058 addr->basic_errno = errno;
2059 addr->message = string_sprintf("failed to chdir to %s", working_directory);
2062 /* If successful, call the transport */
2067 set_process_info("delivering %s to %s using %s", message_id,
2068 addr->local_part, addr->transport->name);
2070 /* Setting this global in the subprocess means we need never clear it */
2071 transport_name = addr->transport->name;
2073 /* If a transport filter has been specified, set up its argument list.
2074 Any errors will get put into the address, and FALSE yielded. */
2076 if (addr->transport->filter_command)
2078 ok = transport_set_up_command(&transport_filter_argv,
2079 addr->transport->filter_command,
2080 TRUE, PANIC, addr, US"transport filter", NULL);
2081 transport_filter_timeout = addr->transport->filter_timeout;
2083 else transport_filter_argv = NULL;
2087 debug_print_string(addr->transport->debug_string);
2088 replicate = !(addr->transport->info->code)(addr->transport, addr);
2092 /* Pass the results back down the pipe. If necessary, first replicate the
2093 status in the top address to the others in the batch. The label is the
2094 subject of a goto when a call to the transport's setup function fails. We
2095 pass the pointer to the transport back in case it got changed as a result of
2096 file_format in appendfile. */
2100 if (replicate) replicate_status(addr);
2101 for (addr2 = addr; addr2; addr2 = addr2->next)
2104 int local_part_length = Ustrlen(addr2->local_part);
2108 if( (ret = write(pfd[pipe_write], &addr2->transport_return, sizeof(int))) != sizeof(int)
2109 || (ret = write(pfd[pipe_write], &transport_count, sizeof(transport_count))) != sizeof(transport_count)
2110 || (ret = write(pfd[pipe_write], &addr2->flags, sizeof(addr2->flags))) != sizeof(addr2->flags)
2111 || (ret = write(pfd[pipe_write], &addr2->basic_errno, sizeof(int))) != sizeof(int)
2112 || (ret = write(pfd[pipe_write], &addr2->more_errno, sizeof(int))) != sizeof(int)
2113 || (ret = write(pfd[pipe_write], &addr2->special_action, sizeof(int))) != sizeof(int)
2114 || (ret = write(pfd[pipe_write], &addr2->transport,
2115 sizeof(transport_instance *))) != sizeof(transport_instance *)
2117 /* For a file delivery, pass back the local part, in case the original
2118 was only part of the final delivery path. This gives more complete
2121 || (testflag(addr2, af_file)
2122 && ( (ret = write(pfd[pipe_write], &local_part_length, sizeof(int))) != sizeof(int)
2123 || (ret = write(pfd[pipe_write], addr2->local_part, local_part_length)) != local_part_length
2127 log_write(0, LOG_MAIN|LOG_PANIC, "Failed writing transport results to pipe: %s\n",
2128 ret == -1 ? strerror(errno) : "short write");
2130 /* Now any messages */
2132 for (i = 0, s = addr2->message; i < 2; i++, s = addr2->user_message)
2134 int message_length = s ? Ustrlen(s) + 1 : 0;
2135 if( (ret = write(pfd[pipe_write], &message_length, sizeof(int))) != sizeof(int)
2136 || message_length > 0 && (ret = write(pfd[pipe_write], s, message_length)) != message_length
2138 log_write(0, LOG_MAIN|LOG_PANIC, "Failed writing transport results to pipe: %s\n",
2139 ret == -1 ? strerror(errno) : "short write");
2143 /* OK, this process is now done. Free any cached resources that it opened,
2144 and close the pipe we were writing down before exiting. */
2146 (void)close(pfd[pipe_write]);
2151 /* Back in the main process: panic if the fork did not succeed. This seems
2152 better than returning an error - if forking is failing it is probably best
2153 not to try other deliveries for this message. */
2156 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Fork failed for local delivery to %s",
2159 /* Read the pipe to get the delivery status codes and error messages. Our copy
2160 of the writing end must be closed first, as otherwise read() won't return zero
2161 on an empty pipe. We check that a status exists for each address before
2162 overwriting the address structure. If data is missing, the default DEFER status
2163 will remain. Afterwards, close the reading end. */
2165 (void)close(pfd[pipe_write]);
2167 for (addr2 = addr; addr2; addr2 = addr2->next)
2169 len = read(pfd[pipe_read], &status, sizeof(int));
2175 addr2->transport_return = status;
2176 len = read(pfd[pipe_read], &transport_count,
2177 sizeof(transport_count));
2178 len = read(pfd[pipe_read], &addr2->flags, sizeof(addr2->flags));
2179 len = read(pfd[pipe_read], &addr2->basic_errno, sizeof(int));
2180 len = read(pfd[pipe_read], &addr2->more_errno, sizeof(int));
2181 len = read(pfd[pipe_read], &addr2->special_action, sizeof(int));
2182 len = read(pfd[pipe_read], &addr2->transport,
2183 sizeof(transport_instance *));
2185 if (testflag(addr2, af_file))
2187 int local_part_length;
2188 len = read(pfd[pipe_read], &local_part_length, sizeof(int));
2189 len = read(pfd[pipe_read], big_buffer, local_part_length);
2190 big_buffer[local_part_length] = 0;
2191 addr2->local_part = string_copy(big_buffer);
2194 for (i = 0, sptr = &addr2->message; i < 2; i++, sptr = &addr2->user_message)
2197 len = read(pfd[pipe_read], &message_length, sizeof(int));
2198 if (message_length > 0)
2200 len = read(pfd[pipe_read], big_buffer, message_length);
2201 if (len > 0) *sptr = string_copy(big_buffer);
2208 log_write(0, LOG_MAIN|LOG_PANIC, "failed to read delivery status for %s "
2209 "from delivery subprocess", addr2->unique);
2214 (void)close(pfd[pipe_read]);
2216 /* Unless shadowing, write all successful addresses immediately to the journal
2217 file, to ensure they are recorded asap. For homonymic addresses, use the base
2218 address plus the transport name. Failure to write the journal is panic-worthy,
2219 but don't stop, as it may prove possible subsequently to update the spool file
2220 in order to record the delivery. */
2224 for (addr2 = addr; addr2; addr2 = addr2->next)
2225 if (addr2->transport_return == OK)
2227 if (testflag(addr2, af_homonym))
2228 sprintf(CS big_buffer, "%.500s/%s\n", addr2->unique + 3, tp->name);
2230 sprintf(CS big_buffer, "%.500s\n", addr2->unique);
2232 /* In the test harness, wait just a bit to let the subprocess finish off
2233 any debug output etc first. */
2235 if (running_in_test_harness) millisleep(300);
2237 DEBUG(D_deliver) debug_printf("journalling %s", big_buffer);
2238 len = Ustrlen(big_buffer);
2239 if (write(journal_fd, big_buffer, len) != len)
2240 log_write(0, LOG_MAIN|LOG_PANIC, "failed to update journal for %s: %s",
2241 big_buffer, strerror(errno));
2244 /* Ensure the journal file is pushed out to disk. */
2246 if (EXIMfsync(journal_fd) < 0)
2247 log_write(0, LOG_MAIN|LOG_PANIC, "failed to fsync journal: %s",
2251 /* Wait for the process to finish. If it terminates with a non-zero code,
2252 freeze the message (except for SIGTERM, SIGKILL and SIGQUIT), but leave the
2253 status values of all the addresses as they are. Take care to handle the case
2254 when the subprocess doesn't seem to exist. This has been seen on one system
2255 when Exim was called from an MUA that set SIGCHLD to SIG_IGN. When that
2256 happens, wait() doesn't recognize the termination of child processes. Exim now
2257 resets SIGCHLD to SIG_DFL, but this code should still be robust. */
2259 while ((rc = wait(&status)) != pid)
2260 if (rc < 0 && errno == ECHILD) /* Process has vanished */
2262 log_write(0, LOG_MAIN, "%s transport process vanished unexpectedly",
2263 addr->transport->driver_name);
2268 if ((status & 0xffff) != 0)
2270 int msb = (status >> 8) & 255;
2271 int lsb = status & 255;
2272 int code = (msb == 0)? (lsb & 0x7f) : msb;
2273 if (msb != 0 || (code != SIGTERM && code != SIGKILL && code != SIGQUIT))
2274 addr->special_action = SPECIAL_FREEZE;
2275 log_write(0, LOG_MAIN|LOG_PANIC, "%s transport process returned non-zero "
2276 "status 0x%04x: %s %d",
2277 addr->transport->driver_name,
2279 msb == 0 ? "terminated by signal" : "exit code",
2283 /* If SPECIAL_WARN is set in the top address, send a warning message. */
2285 if (addr->special_action == SPECIAL_WARN && addr->transport->warn_message)
2288 uschar *warn_message;
2291 DEBUG(D_deliver) debug_printf("Warning message requested by transport\n");
2293 if (!(warn_message = expand_string(addr->transport->warn_message)))
2294 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand \"%s\" (warning "
2295 "message for %s transport): %s", addr->transport->warn_message,
2296 addr->transport->name, expand_string_message);
2298 else if ((pid = child_open_exim(&fd)) > 0)
2300 FILE *f = fdopen(fd, "wb");
2301 if (errors_reply_to && !contains_header(US"Reply-To", warn_message))
2302 fprintf(f, "Reply-To: %s\n", errors_reply_to);
2303 fprintf(f, "Auto-Submitted: auto-replied\n");
2304 if (!contains_header(US"From", warn_message))
2306 fprintf(f, "%s", CS warn_message);
2308 /* Close and wait for child process to complete, without a timeout. */
2311 (void)child_close(pid, 0);
2314 addr->special_action = SPECIAL_NONE;
2320 /*************************************************
2321 * Do local deliveries *
2322 *************************************************/
2324 /* This function processes the list of addresses in addr_local. True local
2325 deliveries are always done one address at a time. However, local deliveries can
2326 be batched up in some cases. Typically this is when writing batched SMTP output
2327 files for use by some external transport mechanism, or when running local
2328 deliveries over LMTP.
2335 do_local_deliveries(void)
2338 open_db *dbm_file = NULL;
2339 time_t now = time(NULL);
2341 /* Loop until we have exhausted the supply of local deliveries */
2345 time_t delivery_start;
2347 address_item *addr2, *addr3, *nextaddr;
2348 int logflags = LOG_MAIN;
2349 int logchar = dont_deliver? '*' : '=';
2350 transport_instance *tp;
2352 /* Pick the first undelivered address off the chain */
2354 address_item *addr = addr_local;
2355 addr_local = addr->next;
2358 DEBUG(D_deliver|D_transport)
2359 debug_printf("--------> %s <--------\n", addr->address);
2361 /* An internal disaster if there is no transport. Should not occur! */
2363 if (!(tp = addr->transport))
2365 logflags |= LOG_PANIC;
2366 disable_logging = FALSE; /* Jic */
2367 addr->message = addr->router
2368 ? string_sprintf("No transport set by %s router", addr->router->name)
2369 : string_sprintf("No transport set by system filter");
2370 post_process_one(addr, DEFER, logflags, DTYPE_TRANSPORT, 0);
2374 /* Check that this base address hasn't previously been delivered to this
2375 transport. The check is necessary at this point to handle homonymic addresses
2376 correctly in cases where the pattern of redirection changes between delivery
2377 attempts. Non-homonymic previous delivery is detected earlier, at routing
2380 if (previously_transported(addr, FALSE)) continue;
2382 /* There are weird cases where logging is disabled */
2384 disable_logging = tp->disable_logging;
2386 /* Check for batched addresses and possible amalgamation. Skip all the work
2387 if either batch_max <= 1 or there aren't any other addresses for local
2390 if (tp->batch_max > 1 && addr_local)
2392 int batch_count = 1;
2393 BOOL uses_dom = readconf_depends((driver_instance *)tp, US"domain");
2394 BOOL uses_lp = ( testflag(addr, af_pfr)
2395 && (testflag(addr, af_file) || addr->local_part[0] == '|')
2397 || readconf_depends((driver_instance *)tp, US"local_part");
2398 uschar *batch_id = NULL;
2399 address_item **anchor = &addr_local;
2400 address_item *last = addr;
2403 /* Expand the batch_id string for comparison with other addresses.
2404 Expansion failure suppresses batching. */
2408 deliver_set_expansions(addr);
2409 batch_id = expand_string(tp->batch_id);
2410 deliver_set_expansions(NULL);
2413 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand batch_id option "
2414 "in %s transport (%s): %s", tp->name, addr->address,
2415 expand_string_message);
2416 batch_count = tp->batch_max;
2420 /* Until we reach the batch_max limit, pick off addresses which have the
2421 same characteristics. These are:
2424 not previously delivered (see comment about 50 lines above)
2425 same local part if the transport's configuration contains $local_part
2426 or if this is a file or pipe delivery from a redirection
2427 same domain if the transport's configuration contains $domain
2429 same additional headers
2430 same headers to be removed
2431 same uid/gid for running the transport
2432 same first host if a host list is set
2435 while ((next = *anchor) && batch_count < tp->batch_max)
2438 tp == next->transport
2439 && !previously_transported(next, TRUE)
2440 && (addr->flags & (af_pfr|af_file)) == (next->flags & (af_pfr|af_file))
2441 && (!uses_lp || Ustrcmp(next->local_part, addr->local_part) == 0)
2442 && (!uses_dom || Ustrcmp(next->domain, addr->domain) == 0)
2443 && same_strings(next->prop.errors_address, addr->prop.errors_address)
2444 && same_headers(next->prop.extra_headers, addr->prop.extra_headers)
2445 && same_strings(next->prop.remove_headers, addr->prop.remove_headers)
2446 && same_ugid(tp, addr, next)
2447 && ( !addr->host_list && !next->host_list
2450 && Ustrcmp(addr->host_list->name, next->host_list->name) == 0
2453 /* If the transport has a batch_id setting, batch_id will be non-NULL
2454 from the expansion outside the loop. Expand for this address and compare.
2455 Expansion failure makes this address ineligible for batching. */
2460 address_item *save_nextnext = next->next;
2461 next->next = NULL; /* Expansion for a single address */
2462 deliver_set_expansions(next);
2463 next->next = save_nextnext;
2464 bid = expand_string(tp->batch_id);
2465 deliver_set_expansions(NULL);
2468 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand batch_id option "
2469 "in %s transport (%s): %s", tp->name, next->address,
2470 expand_string_message);
2473 else ok = (Ustrcmp(batch_id, bid) == 0);
2476 /* Take address into batch if OK. */
2480 *anchor = next->next; /* Include the address */
2486 else anchor = &(next->next); /* Skip the address */
2490 /* We now have one or more addresses that can be delivered in a batch. Check
2491 whether the transport is prepared to accept a message of this size. If not,
2492 fail them all forthwith. If the expansion fails, or does not yield an
2493 integer, defer delivery. */
2495 if (tp->message_size_limit)
2497 int rc = check_message_size(tp, addr);
2500 replicate_status(addr);
2504 post_process_one(addr, rc, logflags, DTYPE_TRANSPORT, 0);
2507 continue; /* With next batch of addresses */
2511 /* If we are not running the queue, or if forcing, all deliveries will be
2512 attempted. Otherwise, we must respect the retry times for each address. Even
2513 when not doing this, we need to set up the retry key string, and determine
2514 whether a retry record exists, because after a successful delivery, a delete
2515 retry item must be set up. Keep the retry database open only for the duration
2516 of these checks, rather than for all local deliveries, because some local
2517 deliveries (e.g. to pipes) can take a substantial time. */
2519 if (!(dbm_file = dbfn_open(US"retry", O_RDONLY, &dbblock, FALSE)))
2521 DEBUG(D_deliver|D_retry|D_hints_lookup)
2522 debug_printf("no retry data available\n");
2529 BOOL ok = TRUE; /* to deliver this address */
2532 /* Set up the retry key to include the domain or not, and change its
2533 leading character from "R" to "T". Must make a copy before doing this,
2534 because the old key may be pointed to from a "delete" retry item after
2537 retry_key = string_copy(
2538 tp->retry_use_local_part ? addr2->address_retry_key :
2539 addr2->domain_retry_key);
2542 /* Inspect the retry data. If there is no hints file, delivery happens. */
2546 dbdata_retry *retry_record = dbfn_read(dbm_file, retry_key);
2548 /* If there is no retry record, delivery happens. If there is,
2549 remember it exists so it can be deleted after a successful delivery. */
2553 setflag(addr2, af_lt_retry_exists);
2555 /* A retry record exists for this address. If queue running and not
2556 forcing, inspect its contents. If the record is too old, or if its
2557 retry time has come, or if it has passed its cutoff time, delivery
2562 debug_printf("retry record exists: age=%s ",
2563 readconf_printtime(now - retry_record->time_stamp));
2564 debug_printf("(max %s)\n", readconf_printtime(retry_data_expire));
2565 debug_printf(" time to retry = %s expired = %d\n",
2566 readconf_printtime(retry_record->next_try - now),
2567 retry_record->expired);
2570 if (queue_running && !deliver_force)
2572 ok = (now - retry_record->time_stamp > retry_data_expire)
2573 || (now >= retry_record->next_try)
2574 || retry_record->expired;
2576 /* If we haven't reached the retry time, there is one more check
2577 to do, which is for the ultimate address timeout. */
2580 ok = retry_ultimate_address_timeout(retry_key, addr2->domain,
2584 else DEBUG(D_retry) debug_printf("no retry record exists\n");
2587 /* This address is to be delivered. Leave it on the chain. */
2592 addr2 = addr2->next;
2595 /* This address is to be deferred. Take it out of the chain, and
2596 post-process it as complete. Must take it out of the chain first,
2597 because post processing puts it on another chain. */
2601 address_item *this = addr2;
2602 this->message = US"Retry time not yet reached";
2603 this->basic_errno = ERRNO_LRETRY;
2604 addr2 = addr3 ? (addr3->next = addr2->next)
2605 : (addr = addr2->next);
2606 post_process_one(this, DEFER, logflags, DTYPE_TRANSPORT, 0);
2610 if (dbm_file) dbfn_close(dbm_file);
2612 /* If there are no addresses left on the chain, they all deferred. Loop
2613 for the next set of addresses. */
2615 if (!addr) continue;
2617 /* So, finally, we do have some addresses that can be passed to the
2618 transport. Before doing so, set up variables that are relevant to a
2621 deliver_set_expansions(addr);
2622 delivery_start = time(NULL);
2623 deliver_local(addr, FALSE);
2624 deliver_time = (int)(time(NULL) - delivery_start);
2626 /* If a shadow transport (which must perforce be another local transport), is
2627 defined, and its condition is met, we must pass the message to the shadow
2628 too, but only those addresses that succeeded. We do this by making a new
2629 chain of addresses - also to keep the original chain uncontaminated. We must
2630 use a chain rather than doing it one by one, because the shadow transport may
2633 NOTE: if the condition fails because of a lookup defer, there is nothing we
2637 && ( !tp->shadow_condition
2638 || expand_check_condition(tp->shadow_condition, tp->name, US"transport")
2641 transport_instance *stp;
2642 address_item *shadow_addr = NULL;
2643 address_item **last = &shadow_addr;
2645 for (stp = transports; stp; stp = stp->next)
2646 if (Ustrcmp(stp->name, tp->shadow) == 0) break;
2649 log_write(0, LOG_MAIN|LOG_PANIC, "shadow transport \"%s\" not found ",
2652 /* Pick off the addresses that have succeeded, and make clones. Put into
2653 the shadow_message field a pointer to the shadow_message field of the real
2656 else for (addr2 = addr; addr2; addr2 = addr2->next)
2657 if (addr2->transport_return == OK)
2659 addr3 = store_get(sizeof(address_item));
2662 addr3->shadow_message = (uschar *) &(addr2->shadow_message);
2663 addr3->transport = stp;
2664 addr3->transport_return = DEFER;
2665 addr3->return_filename = NULL;
2666 addr3->return_file = -1;
2668 last = &(addr3->next);
2671 /* If we found any addresses to shadow, run the delivery, and stick any
2672 message back into the shadow_message field in the original. */
2676 int save_count = transport_count;
2678 DEBUG(D_deliver|D_transport)
2679 debug_printf(">>>>>>>>>>>>>>>> Shadow delivery >>>>>>>>>>>>>>>>\n");
2680 deliver_local(shadow_addr, TRUE);
2682 for(; shadow_addr; shadow_addr = shadow_addr->next)
2684 int sresult = shadow_addr->transport_return;
2685 *(uschar **)shadow_addr->shadow_message =
2687 ? string_sprintf(" ST=%s", stp->name)
2688 : string_sprintf(" ST=%s (%s%s%s)", stp->name,
2689 shadow_addr->basic_errno <= 0
2691 : US strerror(shadow_addr->basic_errno),
2692 shadow_addr->basic_errno <= 0 || !shadow_addr->message
2695 shadow_addr->message
2696 ? shadow_addr->message
2697 : shadow_addr->basic_errno <= 0
2701 DEBUG(D_deliver|D_transport)
2702 debug_printf("%s shadow transport returned %s for %s\n",
2704 sresult == OK ? "OK" :
2705 sresult == DEFER ? "DEFER" :
2706 sresult == FAIL ? "FAIL" :
2707 sresult == PANIC ? "PANIC" : "?",
2708 shadow_addr->address);
2711 DEBUG(D_deliver|D_transport)
2712 debug_printf(">>>>>>>>>>>>>>>> End shadow delivery >>>>>>>>>>>>>>>>\n");
2714 transport_count = save_count; /* Restore original transport count */
2718 /* Cancel the expansions that were set up for the delivery. */
2720 deliver_set_expansions(NULL);
2722 /* Now we can process the results of the real transport. We must take each
2723 address off the chain first, because post_process_one() puts it on another
2726 for (addr2 = addr; addr2; addr2 = nextaddr)
2728 int result = addr2->transport_return;
2729 nextaddr = addr2->next;
2731 DEBUG(D_deliver|D_transport)
2732 debug_printf("%s transport returned %s for %s\n",
2734 result == OK ? "OK" :
2735 result == DEFER ? "DEFER" :
2736 result == FAIL ? "FAIL" :
2737 result == PANIC ? "PANIC" : "?",
2740 /* If there is a retry_record, or if delivery is deferred, build a retry
2741 item for setting a new retry time or deleting the old retry record from
2742 the database. These items are handled all together after all addresses
2743 have been handled (so the database is open just for a short time for
2746 if (result == DEFER || testflag(addr2, af_lt_retry_exists))
2748 int flags = result == DEFER ? 0 : rf_delete;
2749 uschar *retry_key = string_copy(tp->retry_use_local_part
2750 ? addr2->address_retry_key : addr2->domain_retry_key);
2752 retry_add_item(addr2, retry_key, flags);
2755 /* Done with this address */
2757 if (result == OK) addr2->more_errno = deliver_time;
2758 post_process_one(addr2, result, logflags, DTYPE_TRANSPORT, logchar);
2760 /* If a pipe delivery generated text to be sent back, the result may be
2761 changed to FAIL, and we must copy this for subsequent addresses in the
2764 if (addr2->transport_return != result)
2766 for (addr3 = nextaddr; addr3; addr3 = addr3->next)
2768 addr3->transport_return = addr2->transport_return;
2769 addr3->basic_errno = addr2->basic_errno;
2770 addr3->message = addr2->message;
2772 result = addr2->transport_return;
2775 /* Whether or not the result was changed to FAIL, we need to copy the
2776 return_file value from the first address into all the addresses of the
2777 batch, so they are all listed in the error message. */
2779 addr2->return_file = addr->return_file;
2781 /* Change log character for recording successful deliveries. */
2783 if (result == OK) logchar = '-';
2785 } /* Loop back for next batch of addresses */
2791 /*************************************************
2792 * Sort remote deliveries *
2793 *************************************************/
2795 /* This function is called if remote_sort_domains is set. It arranges that the
2796 chain of addresses for remote deliveries is ordered according to the strings
2797 specified. Try to make this shuffling reasonably efficient by handling
2798 sequences of addresses rather than just single ones.
2805 sort_remote_deliveries(void)
2808 address_item **aptr = &addr_remote;
2809 const uschar *listptr = remote_sort_domains;
2814 && (pattern = string_nextinlist(&listptr, &sep, patbuf, sizeof(patbuf)))
2817 address_item *moved = NULL;
2818 address_item **bptr = &moved;
2822 address_item **next;
2823 deliver_domain = (*aptr)->domain; /* set $domain */
2824 if (match_isinlist(deliver_domain, (const uschar **)&pattern, UCHAR_MAX+1,
2825 &domainlist_anchor, NULL, MCL_DOMAIN, TRUE, NULL) == OK)
2827 aptr = &(*aptr)->next;
2831 next = &(*aptr)->next;
2833 && (deliver_domain = (*next)->domain, /* Set $domain */
2834 match_isinlist(deliver_domain, (const uschar **)&pattern, UCHAR_MAX+1,
2835 &domainlist_anchor, NULL, MCL_DOMAIN, TRUE, NULL)) != OK
2837 next = &(*next)->next;
2839 /* If the batch of non-matchers is at the end, add on any that were
2840 extracted further up the chain, and end this iteration. Otherwise,
2841 extract them from the chain and hang on the moved chain. */
2853 aptr = &(*aptr)->next;
2856 /* If the loop ended because the final address matched, *aptr will
2857 be NULL. Add on to the end any extracted non-matching addresses. If
2858 *aptr is not NULL, the loop ended via "break" when *next is null, that
2859 is, there was a string of non-matching addresses at the end. In this
2860 case the extracted addresses have already been added on the end. */
2862 if (!*aptr) *aptr = moved;
2868 debug_printf("remote addresses after sorting:\n");
2869 for (addr = addr_remote; addr; addr = addr->next)
2870 debug_printf(" %s\n", addr->address);
2876 /*************************************************
2877 * Read from pipe for remote delivery subprocess *
2878 *************************************************/
2880 /* This function is called when the subprocess is complete, but can also be
2881 called before it is complete, in order to empty a pipe that is full (to prevent
2882 deadlock). It must therefore keep track of its progress in the parlist data
2885 We read the pipe to get the delivery status codes and a possible error message
2886 for each address, optionally preceded by unusability data for the hosts and
2887 also by optional retry data.
2889 Read in large chunks into the big buffer and then scan through, interpreting
2890 the data therein. In most cases, only a single read will be necessary. No
2891 individual item will ever be anywhere near 2500 bytes in length, so by ensuring
2892 that we read the next chunk when there is less than 2500 bytes left in the
2893 non-final chunk, we can assume each item is complete in the buffer before
2894 handling it. Each item is written using a single write(), which is atomic for
2895 small items (less than PIPE_BUF, which seems to be at least 512 in any Unix and
2896 often bigger) so even if we are reading while the subprocess is still going, we
2897 should never have only a partial item in the buffer.
2900 poffset the offset of the parlist item
2901 eop TRUE if the process has completed
2903 Returns: TRUE if the terminating 'Z' item has been read,
2904 or there has been a disaster (i.e. no more data needed);
2909 par_read_pipe(int poffset, BOOL eop)
2912 pardata *p = parlist + poffset;
2913 address_item *addrlist = p->addrlist;
2914 address_item *addr = p->addr;
2917 uschar *endptr = big_buffer;
2918 uschar *ptr = endptr;
2919 uschar *msg = p->msg;
2920 BOOL done = p->done;
2921 BOOL unfinished = TRUE;
2922 /* minimum size to read is header size including id, subid and length */
2923 int required = PIPE_HEADER_SIZE;
2925 /* Loop through all items, reading from the pipe when necessary. The pipe
2926 is set up to be non-blocking, but there are two different Unix mechanisms in
2927 use. Exim uses O_NONBLOCK if it is defined. This returns 0 for end of file,
2928 and EAGAIN for no more data. If O_NONBLOCK is not defined, Exim uses O_NDELAY,
2929 which returns 0 for both end of file and no more data. We distinguish the
2930 two cases by taking 0 as end of file only when we know the process has
2933 Each separate item is written to the pipe in a single write(), and as they are
2934 all short items, the writes will all be atomic and we should never find
2935 ourselves in the position of having read an incomplete item. "Short" in this
2936 case can mean up to about 1K in the case when there is a long error message
2937 associated with an address. */
2939 DEBUG(D_deliver) debug_printf("reading pipe for subprocess %d (%s)\n",
2940 (int)p->pid, eop? "ended" : "not ended");
2944 retry_item *r, **rp;
2945 int remaining = endptr - ptr;
2946 uschar header[PIPE_HEADER_SIZE + 1];
2950 /* Read (first time) or top up the chars in the buffer if necessary.
2951 There will be only one read if we get all the available data (i.e. don't
2952 fill the buffer completely). */
2954 if (remaining < required && unfinished)
2957 int available = big_buffer_size - remaining;
2959 if (remaining > 0) memmove(big_buffer, ptr, remaining);
2962 endptr = big_buffer + remaining;
2963 len = read(fd, endptr, available);
2965 DEBUG(D_deliver) debug_printf("read() yielded %d\n", len);
2967 /* If the result is EAGAIN and the process is not complete, just
2968 stop reading any more and process what we have already. */
2972 if (!eop && errno == EAGAIN) len = 0; else
2974 msg = string_sprintf("failed to read pipe from transport process "
2975 "%d for transport %s: %s", pid, addr->transport->driver_name,
2981 /* If the length is zero (eof or no-more-data), just process what we
2982 already have. Note that if the process is still running and we have
2983 read all the data in the pipe (but less that "available") then we
2984 won't read any more, as "unfinished" will get set FALSE. */
2988 unfinished = len == available;
2991 /* If we are at the end of the available data, exit the loop. */
2992 if (ptr >= endptr) break;
2994 /* copy and read header */
2995 memcpy(header, ptr, PIPE_HEADER_SIZE);
2996 header[PIPE_HEADER_SIZE] = '\0';
2999 required = Ustrtol(header + 2, &endc, 10) + PIPE_HEADER_SIZE; /* header + data */
3002 msg = string_sprintf("failed to read pipe from transport process "
3003 "%d for transport %s: error reading size from header", pid, addr->transport->driver_name);
3009 debug_printf("header read id:%c,subid:%c,size:%s,required:%d,remaining:%d,unfinished:%d\n",
3010 id, subid, header+2, required, remaining, unfinished);
3012 /* is there room for the dataset we want to read ? */
3013 if (required > big_buffer_size - PIPE_HEADER_SIZE)
3015 msg = string_sprintf("failed to read pipe from transport process "
3016 "%d for transport %s: big_buffer too small! required size=%d buffer size=%d", pid, addr->transport->driver_name,
3017 required, big_buffer_size - PIPE_HEADER_SIZE);
3022 /* we wrote all datasets with atomic write() calls
3023 remaining < required only happens if big_buffer was too small
3024 to get all available data from pipe. unfinished has to be true
3026 if (remaining < required)
3030 msg = string_sprintf("failed to read pipe from transport process "
3031 "%d for transport %s: required size=%d > remaining size=%d and unfinished=false",
3032 pid, addr->transport->driver_name, required, remaining);
3037 /* step behind the header */
3038 ptr += PIPE_HEADER_SIZE;
3040 /* Handle each possible type of item, assuming the complete item is
3041 available in store. */
3045 /* Host items exist only if any hosts were marked unusable. Match
3046 up by checking the IP address. */
3049 for (h = addrlist->host_list; h; h = h->next)
3051 if (!h->address || Ustrcmp(h->address, ptr+2) != 0) continue;
3059 /* Retry items are sent in a preceding R item for each address. This is
3060 kept separate to keep each message short enough to guarantee it won't
3061 be split in the pipe. Hopefully, in the majority of cases, there won't in
3062 fact be any retry items at all.
3064 The complete set of retry items might include an item to delete a
3065 routing retry if there was a previous routing delay. However, routing
3066 retries are also used when a remote transport identifies an address error.
3067 In that case, there may also be an "add" item for the same key. Arrange
3068 that a "delete" item is dropped in favour of an "add" item. */
3071 if (!addr) goto ADDR_MISMATCH;
3073 DEBUG(D_deliver|D_retry)
3074 debug_printf("reading retry information for %s from subprocess\n",
3077 /* Cut out any "delete" items on the list. */
3079 for (rp = &(addr->retries); (r = *rp); rp = &r->next)
3080 if (Ustrcmp(r->key, ptr+1) == 0) /* Found item with same key */
3082 if ((r->flags & rf_delete) == 0) break; /* It was not "delete" */
3083 *rp = r->next; /* Excise a delete item */
3084 DEBUG(D_deliver|D_retry)
3085 debug_printf(" existing delete item dropped\n");
3088 /* We want to add a delete item only if there is no non-delete item;
3089 however we still have to step ptr through the data. */
3091 if (!r || (*ptr & rf_delete) == 0)
3093 r = store_get(sizeof(retry_item));
3094 r->next = addr->retries;
3097 r->key = string_copy(ptr);
3099 memcpy(&(r->basic_errno), ptr, sizeof(r->basic_errno));
3100 ptr += sizeof(r->basic_errno);
3101 memcpy(&(r->more_errno), ptr, sizeof(r->more_errno));
3102 ptr += sizeof(r->more_errno);
3103 r->message = (*ptr)? string_copy(ptr) : NULL;
3104 DEBUG(D_deliver|D_retry)
3105 debug_printf(" added %s item\n",
3106 ((r->flags & rf_delete) == 0)? "retry" : "delete");
3111 DEBUG(D_deliver|D_retry)
3112 debug_printf(" delete item not added: non-delete item exists\n");
3115 ptr += sizeof(r->basic_errno) + sizeof(r->more_errno);
3121 /* Put the amount of data written into the parlist block */
3124 memcpy(&(p->transport_count), ptr, sizeof(transport_count));
3125 ptr += sizeof(transport_count);
3128 /* Address items are in the order of items on the address chain. We
3129 remember the current address value in case this function is called
3130 several times to empty the pipe in stages. Information about delivery
3131 over TLS is sent in a preceding X item for each address. We don't put
3132 it in with the other info, in order to keep each message short enough to
3133 guarantee it won't be split in the pipe. */
3137 if (!addr) goto ADDR_MISMATCH; /* Below, in 'A' handler */
3141 addr->cipher = NULL;
3142 addr->peerdn = NULL;
3145 addr->cipher = string_copy(ptr);
3148 addr->peerdn = string_copy(ptr);
3153 (void) tls_import_cert(ptr, &addr->peercert);
3155 addr->peercert = NULL;
3160 (void) tls_import_cert(ptr, &addr->ourcert);
3162 addr->ourcert = NULL;
3165 # ifndef DISABLE_OCSP
3167 addr->ocsp = OCSP_NOT_REQ;
3169 addr->ocsp = *ptr - '0';
3175 #endif /*SUPPORT_TLS*/
3177 case 'C': /* client authenticator information */
3181 addr->authenticator = (*ptr)? string_copy(ptr) : NULL;
3184 addr->auth_id = (*ptr)? string_copy(ptr) : NULL;
3187 addr->auth_sndr = (*ptr)? string_copy(ptr) : NULL;
3193 #ifndef DISABLE_PRDR
3195 addr->flags |= af_prdr_used;
3200 if (!addr) goto ADDR_MISMATCH;
3201 memcpy(&(addr->dsn_aware), ptr, sizeof(addr->dsn_aware));
3202 ptr += sizeof(addr->dsn_aware);
3203 DEBUG(D_deliver) debug_printf("DSN read: addr->dsn_aware = %d\n", addr->dsn_aware);
3210 msg = string_sprintf("address count mismatch for data read from pipe "
3211 "for transport process %d for transport %s", pid,
3212 addrlist->transport->driver_name);
3219 #ifdef EXPERIMENTAL_DSN_INFO
3220 case '1': /* must arrive before A0, and applies to that addr */
3221 /* Two strings: smtp_greeting and helo_response */
3222 addr->smtp_greeting = string_copy(ptr);
3224 addr->helo_response = string_copy(ptr);
3230 addr->transport_return = *ptr++;
3231 addr->special_action = *ptr++;
3232 memcpy(&(addr->basic_errno), ptr, sizeof(addr->basic_errno));
3233 ptr += sizeof(addr->basic_errno);
3234 memcpy(&(addr->more_errno), ptr, sizeof(addr->more_errno));
3235 ptr += sizeof(addr->more_errno);
3236 memcpy(&(addr->flags), ptr, sizeof(addr->flags));
3237 ptr += sizeof(addr->flags);
3238 addr->message = (*ptr)? string_copy(ptr) : NULL;
3240 addr->user_message = (*ptr)? string_copy(ptr) : NULL;
3243 /* Always two strings for host information, followed by the port number and DNSSEC mark */
3247 h = store_get(sizeof(host_item));
3248 h->name = string_copy(ptr);
3250 h->address = string_copy(ptr);
3252 memcpy(&(h->port), ptr, sizeof(h->port));
3253 ptr += sizeof(h->port);
3254 h->dnssec = *ptr == '2' ? DS_YES
3255 : *ptr == '1' ? DS_NO
3258 addr->host_used = h;
3262 /* Finished with this address */
3269 /* Local interface address/port */
3271 if (*ptr) sending_ip_address = string_copy(ptr);
3273 if (*ptr) sending_port = atoi(CS ptr);
3277 /* Z marks the logical end of the data. It is followed by '0' if
3278 continue_transport was NULL at the end of transporting, otherwise '1'.
3279 We need to know when it becomes NULL during a delivery down a passed SMTP
3280 channel so that we don't try to pass anything more down it. Of course, for
3281 most normal messages it will remain NULL all the time. */
3286 continue_transport = NULL;
3287 continue_hostname = NULL;
3290 DEBUG(D_deliver) debug_printf("Z0%c item read\n", *ptr);
3293 /* Anything else is a disaster. */
3296 msg = string_sprintf("malformed data (%d) read from pipe for transport "
3297 "process %d for transport %s", ptr[-1], pid,
3298 addr->transport->driver_name);
3304 /* The done flag is inspected externally, to determine whether or not to
3305 call the function again when the process finishes. */
3309 /* If the process hadn't finished, and we haven't seen the end of the data
3310 or suffered a disaster, update the rest of the state, and return FALSE to
3311 indicate "not finished". */
3320 /* Close our end of the pipe, to prevent deadlock if the far end is still
3321 pushing stuff into it. */
3326 /* If we have finished without error, but haven't had data for every address,
3327 something is wrong. */
3330 msg = string_sprintf("insufficient address data read from pipe "
3331 "for transport process %d for transport %s", pid,
3332 addr->transport->driver_name);
3334 /* If an error message is set, something has gone wrong in getting back
3335 the delivery data. Put the message into each address and freeze it. */
3338 for (addr = addrlist; addr; addr = addr->next)
3340 addr->transport_return = DEFER;
3341 addr->special_action = SPECIAL_FREEZE;
3342 addr->message = msg;
3345 /* Return TRUE to indicate we have got all we need from this process, even
3346 if it hasn't actually finished yet. */
3353 /*************************************************
3354 * Post-process a set of remote addresses *
3355 *************************************************/
3357 /* Do what has to be done immediately after a remote delivery for each set of
3358 addresses, then re-write the spool if necessary. Note that post_process_one
3359 puts the address on an appropriate queue; hence we must fish off the next
3360 one first. This function is also called if there is a problem with setting
3361 up a subprocess to do a remote delivery in parallel. In this case, the final
3362 argument contains a message, and the action must be forced to DEFER.
3365 addr pointer to chain of address items
3366 logflags flags for logging
3367 msg NULL for normal cases; -> error message for unexpected problems
3368 fallback TRUE if processing fallback hosts
3374 remote_post_process(address_item *addr, int logflags, uschar *msg,
3379 /* If any host addresses were found to be unusable, add them to the unusable
3380 tree so that subsequent deliveries don't try them. */
3382 for (h = addr->host_list; h; h = h->next)
3384 if (h->status >= hstatus_unusable) tree_add_unusable(h);
3386 /* Now handle each address on the chain. The transport has placed '=' or '-'
3387 into the special_action field for each successful delivery. */
3391 address_item *next = addr->next;
3393 /* If msg == NULL (normal processing) and the result is DEFER and we are
3394 processing the main hosts and there are fallback hosts available, put the
3395 address on the list for fallback delivery. */
3397 if ( addr->transport_return == DEFER
3398 && addr->fallback_hosts
3403 addr->host_list = addr->fallback_hosts;
3404 addr->next = addr_fallback;
3405 addr_fallback = addr;
3406 DEBUG(D_deliver) debug_printf("%s queued for fallback host(s)\n", addr->address);
3409 /* If msg is set (=> unexpected problem), set it in the address before
3410 doing the ordinary post processing. */
3416 addr->message = msg;
3417 addr->transport_return = DEFER;
3419 (void)post_process_one(addr, addr->transport_return, logflags,
3420 DTYPE_TRANSPORT, addr->special_action);
3428 /* If we have just delivered down a passed SMTP channel, and that was
3429 the last address, the channel will have been closed down. Now that
3430 we have logged that delivery, set continue_sequence to 1 so that
3431 any subsequent deliveries don't get "*" incorrectly logged. */
3433 if (!continue_transport) continue_sequence = 1;
3438 /*************************************************
3439 * Wait for one remote delivery subprocess *
3440 *************************************************/
3442 /* This function is called while doing remote deliveries when either the
3443 maximum number of processes exist and we need one to complete so that another
3444 can be created, or when waiting for the last ones to complete. It must wait for
3445 the completion of one subprocess, empty the control block slot, and return a
3446 pointer to the address chain.
3449 Returns: pointer to the chain of addresses handled by the process;
3450 NULL if no subprocess found - this is an unexpected error
3453 static address_item *
3456 int poffset, status;
3457 address_item *addr, *addrlist;
3460 set_process_info("delivering %s: waiting for a remote delivery subprocess "
3461 "to finish", message_id);
3463 /* Loop until either a subprocess completes, or there are no subprocesses in
3464 existence - in which case give an error return. We cannot proceed just by
3465 waiting for a completion, because a subprocess may have filled up its pipe, and
3466 be waiting for it to be emptied. Therefore, if no processes have finished, we
3467 wait for one of the pipes to acquire some data by calling select(), with a
3468 timeout just in case.
3470 The simple approach is just to iterate after reading data from a ready pipe.
3471 This leads to non-ideal behaviour when the subprocess has written its final Z
3472 item, closed the pipe, and is in the process of exiting (the common case). A
3473 call to waitpid() yields nothing completed, but select() shows the pipe ready -
3474 reading it yields EOF, so you end up with busy-waiting until the subprocess has
3477 To avoid this, if all the data that is needed has been read from a subprocess
3478 after select(), an explicit wait() for it is done. We know that all it is doing
3479 is writing to the pipe and then exiting, so the wait should not be long.
3481 The non-blocking waitpid() is to some extent just insurance; if we could
3482 reliably detect end-of-file on the pipe, we could always know when to do a
3483 blocking wait() for a completed process. However, because some systems use
3484 NDELAY, which doesn't distinguish between EOF and pipe empty, it is easier to
3485 use code that functions without the need to recognize EOF.
3487 There's a double loop here just in case we end up with a process that is not in
3488 the list of remote delivery processes. Something has obviously gone wrong if
3489 this is the case. (For example, a process that is incorrectly left over from
3490 routing or local deliveries might be found.) The damage can be minimized by
3491 looping back and looking for another process. If there aren't any, the error
3492 return will happen. */
3494 for (;;) /* Normally we do not repeat this loop */
3496 while ((pid = waitpid(-1, &status, WNOHANG)) <= 0)
3499 fd_set select_pipes;
3500 int maxpipe, readycount;
3502 /* A return value of -1 can mean several things. If errno != ECHILD, it
3503 either means invalid options (which we discount), or that this process was
3504 interrupted by a signal. Just loop to try the waitpid() again.
3506 If errno == ECHILD, waitpid() is telling us that there are no subprocesses
3507 in existence. This should never happen, and is an unexpected error.
3508 However, there is a nasty complication when running under Linux. If "strace
3509 -f" is being used under Linux to trace this process and its children,
3510 subprocesses are "stolen" from their parents and become the children of the
3511 tracing process. A general wait such as the one we've just obeyed returns
3512 as if there are no children while subprocesses are running. Once a
3513 subprocess completes, it is restored to the parent, and waitpid(-1) finds
3514 it. Thanks to Joachim Wieland for finding all this out and suggesting a
3517 This does not happen using "truss" on Solaris, nor (I think) with other
3518 tracing facilities on other OS. It seems to be specific to Linux.
3520 What we do to get round this is to use kill() to see if any of our
3521 subprocesses are still in existence. If kill() gives an OK return, we know
3522 it must be for one of our processes - it can't be for a re-use of the pid,
3523 because if our process had finished, waitpid() would have found it. If any
3524 of our subprocesses are in existence, we proceed to use select() as if
3525 waitpid() had returned zero. I think this is safe. */
3529 if (errno != ECHILD) continue; /* Repeats the waitpid() */
3532 debug_printf("waitpid() returned -1/ECHILD: checking explicitly "
3533 "for process existence\n");
3535 for (poffset = 0; poffset < remote_max_parallel; poffset++)
3537 if ((pid = parlist[poffset].pid) != 0 && kill(pid, 0) == 0)
3539 DEBUG(D_deliver) debug_printf("process %d still exists: assume "
3540 "stolen by strace\n", (int)pid);
3541 break; /* With poffset set */
3545 if (poffset >= remote_max_parallel)
3547 DEBUG(D_deliver) debug_printf("*** no delivery children found\n");
3548 return NULL; /* This is the error return */
3552 /* A pid value greater than 0 breaks the "while" loop. A negative value has
3553 been handled above. A return value of zero means that there is at least one
3554 subprocess, but there are no completed subprocesses. See if any pipes are
3555 ready with any data for reading. */
3557 DEBUG(D_deliver) debug_printf("selecting on subprocess pipes\n");
3560 FD_ZERO(&select_pipes);
3561 for (poffset = 0; poffset < remote_max_parallel; poffset++)
3563 if (parlist[poffset].pid != 0)
3565 int fd = parlist[poffset].fd;
3566 FD_SET(fd, &select_pipes);
3567 if (fd > maxpipe) maxpipe = fd;
3571 /* Stick in a 60-second timeout, just in case. */
3576 readycount = select(maxpipe + 1, (SELECT_ARG2_TYPE *)&select_pipes,
3579 /* Scan through the pipes and read any that are ready; use the count
3580 returned by select() to stop when there are no more. Select() can return
3581 with no processes (e.g. if interrupted). This shouldn't matter.
3583 If par_read_pipe() returns TRUE, it means that either the terminating Z was
3584 read, or there was a disaster. In either case, we are finished with this
3585 process. Do an explicit wait() for the process and break the main loop if
3588 It turns out that we have to deal with the case of an interrupted system
3589 call, which can happen on some operating systems if the signal handling is
3590 set up to do that by default. */
3593 readycount > 0 && poffset < remote_max_parallel;
3596 if ( (pid = parlist[poffset].pid) != 0
3597 && FD_ISSET(parlist[poffset].fd, &select_pipes)
3601 if (par_read_pipe(poffset, FALSE)) /* Finished with this pipe */
3603 for (;;) /* Loop for signals */
3605 pid_t endedpid = waitpid(pid, &status, 0);
3606 if (endedpid == pid) goto PROCESS_DONE;
3607 if (endedpid != (pid_t)(-1) || errno != EINTR)
3608 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Unexpected error return "
3609 "%d (errno = %d) from waitpid() for process %d",
3610 (int)endedpid, errno, (int)pid);
3616 /* Now go back and look for a completed subprocess again. */
3619 /* A completed process was detected by the non-blocking waitpid(). Find the
3620 data block that corresponds to this subprocess. */
3622 for (poffset = 0; poffset < remote_max_parallel; poffset++)
3623 if (pid == parlist[poffset].pid) break;
3625 /* Found the data block; this is a known remote delivery process. We don't
3626 need to repeat the outer loop. This should be what normally happens. */
3628 if (poffset < remote_max_parallel) break;
3630 /* This situation is an error, but it's probably better to carry on looking
3631 for another process than to give up (as we used to do). */
3633 log_write(0, LOG_MAIN|LOG_PANIC, "Process %d finished: not found in remote "
3634 "transport process list", pid);
3635 } /* End of the "for" loop */
3637 /* Come here when all the data was completely read after a select(), and
3638 the process in pid has been wait()ed for. */
3645 debug_printf("remote delivery process %d ended\n", (int)pid);
3647 debug_printf("remote delivery process %d ended: status=%04x\n", (int)pid,
3651 set_process_info("delivering %s", message_id);
3653 /* Get the chain of processed addresses */
3655 addrlist = parlist[poffset].addrlist;
3657 /* If the process did not finish cleanly, record an error and freeze (except
3658 for SIGTERM, SIGKILL and SIGQUIT), and also ensure the journal is not removed,
3659 in case the delivery did actually happen. */
3661 if ((status & 0xffff) != 0)
3664 int msb = (status >> 8) & 255;
3665 int lsb = status & 255;
3666 int code = (msb == 0)? (lsb & 0x7f) : msb;
3668 msg = string_sprintf("%s transport process returned non-zero status 0x%04x: "
3670 addrlist->transport->driver_name,
3672 (msb == 0)? "terminated by signal" : "exit code",
3675 if (msb != 0 || (code != SIGTERM && code != SIGKILL && code != SIGQUIT))
3676 addrlist->special_action = SPECIAL_FREEZE;
3678 for (addr = addrlist; addr; addr = addr->next)
3680 addr->transport_return = DEFER;
3681 addr->message = msg;
3684 remove_journal = FALSE;
3687 /* Else complete reading the pipe to get the result of the delivery, if all
3688 the data has not yet been obtained. */
3690 else if (!parlist[poffset].done) (void)par_read_pipe(poffset, TRUE);
3692 /* Put the data count and return path into globals, mark the data slot unused,
3693 decrement the count of subprocesses, and return the address chain. */
3695 transport_count = parlist[poffset].transport_count;
3696 used_return_path = parlist[poffset].return_path;
3697 parlist[poffset].pid = 0;
3704 /*************************************************
3705 * Wait for subprocesses and post-process *
3706 *************************************************/
3708 /* This function waits for subprocesses until the number that are still running
3709 is below a given threshold. For each complete subprocess, the addresses are
3710 post-processed. If we can't find a running process, there is some shambles.
3711 Better not bomb out, as that might lead to multiple copies of the message. Just
3712 log and proceed as if all done.
3715 max maximum number of subprocesses to leave running
3716 fallback TRUE if processing fallback hosts
3722 par_reduce(int max, BOOL fallback)
3724 while (parcount > max)
3726 address_item *doneaddr = par_wait();
3729 log_write(0, LOG_MAIN|LOG_PANIC,
3730 "remote delivery process count got out of step");
3733 else remote_post_process(doneaddr, LOG_MAIN, NULL, fallback);
3741 rmt_dlv_checked_write(int fd, char id, char subid, void * buf, int size)
3743 uschar writebuffer[PIPE_HEADER_SIZE + BIG_BUFFER_SIZE];
3746 /* we assume that size can't get larger then BIG_BUFFER_SIZE which currently is set to 16k */
3747 /* complain to log if someone tries with buffer sizes we can't handle*/
3751 log_write(0, LOG_MAIN|LOG_PANIC_DIE,
3752 "Failed writing transport result to pipe: can't handle buffers > 99999 bytes. truncating!\n");
3756 /* to keep the write() atomic we build header in writebuffer and copy buf behind */
3757 /* two write() calls would increase the complexity of reading from pipe */
3759 /* convert size to human readable string prepended by id and subid */
3760 header_length = snprintf(CS writebuffer, PIPE_HEADER_SIZE+1, "%c%c%05d", id, subid, size);
3761 if (header_length != PIPE_HEADER_SIZE)
3763 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "header snprintf failed\n");
3764 writebuffer[0] = '\0';
3767 DEBUG(D_deliver) debug_printf("header write id:%c,subid:%c,size:%d,final:%s\n",
3768 id, subid, size, writebuffer);
3770 if (buf && size > 0)
3771 memcpy(writebuffer + PIPE_HEADER_SIZE, buf, size);
3773 size += PIPE_HEADER_SIZE;
3774 int ret = write(fd, writebuffer, size);
3776 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Failed writing transport result to pipe: %s\n",
3777 ret == -1 ? strerror(errno) : "short write");
3780 /*************************************************
3781 * Do remote deliveries *
3782 *************************************************/
3784 /* This function is called to process the addresses in addr_remote. We must
3785 pick off the queue all addresses that have the same transport, remote
3786 destination, and errors address, and hand them to the transport in one go,
3787 subject to some configured limitations. If this is a run to continue delivering
3788 to an existing delivery channel, skip all but those addresses that can go to
3789 that channel. The skipped addresses just get deferred.
3791 If mua_wrapper is set, all addresses must be able to be sent in a single
3792 transaction. If not, this function yields FALSE.
3794 In Exim 4, remote deliveries are always done in separate processes, even
3795 if remote_max_parallel = 1 or if there's only one delivery to do. The reason
3796 is so that the base process can retain privilege. This makes the
3797 implementation of fallback transports feasible (though not initially done.)
3799 We create up to the configured number of subprocesses, each of which passes
3800 back the delivery state via a pipe. (However, when sending down an existing
3801 connection, remote_max_parallel is forced to 1.)
3804 fallback TRUE if processing fallback hosts
3806 Returns: TRUE normally
3807 FALSE if mua_wrapper is set and the addresses cannot all be sent
3812 do_remote_deliveries(BOOL fallback)
3818 parcount = 0; /* Number of executing subprocesses */
3820 /* When sending down an existing channel, only do one delivery at a time.
3821 We use a local variable (parmax) to hold the maximum number of processes;
3822 this gets reduced from remote_max_parallel if we can't create enough pipes. */
3824 if (continue_transport) remote_max_parallel = 1;
3825 parmax = remote_max_parallel;
3827 /* If the data for keeping a list of processes hasn't yet been
3832 parlist = store_get(remote_max_parallel * sizeof(pardata));
3833 for (poffset = 0; poffset < remote_max_parallel; poffset++)
3834 parlist[poffset].pid = 0;
3837 /* Now loop for each remote delivery */
3839 for (delivery_count = 0; addr_remote; delivery_count++)
3845 int address_count = 1;
3846 int address_count_max;
3848 BOOL use_initgroups;
3849 BOOL pipe_done = FALSE;
3850 transport_instance *tp;
3851 address_item **anchor = &addr_remote;
3852 address_item *addr = addr_remote;
3853 address_item *last = addr;
3857 /* Pull the first address right off the list. */
3859 addr_remote = addr->next;
3862 DEBUG(D_deliver|D_transport)
3863 debug_printf("--------> %s <--------\n", addr->address);
3865 /* If no transport has been set, there has been a big screw-up somewhere. */
3867 if (!(tp = addr->transport))
3869 disable_logging = FALSE; /* Jic */
3870 panicmsg = US"No transport set by router";
3871 goto panic_continue;
3874 /* Check that this base address hasn't previously been delivered to this
3875 transport. The check is necessary at this point to handle homonymic addresses
3876 correctly in cases where the pattern of redirection changes between delivery
3877 attempts. Non-homonymic previous delivery is detected earlier, at routing
3880 if (previously_transported(addr, FALSE)) continue;
3882 /* Force failure if the message is too big. */
3884 if (tp->message_size_limit)
3886 int rc = check_message_size(tp, addr);
3889 addr->transport_return = rc;
3890 remote_post_process(addr, LOG_MAIN, NULL, fallback);
3895 /* Get the flag which specifies whether the transport can handle different
3896 domains that nevertheless resolve to the same set of hosts. If it needs
3897 expanding, get variables set: $address_data, $domain_data, $localpart_data,
3898 $host, $host_address, $host_port. */
3899 if (tp->expand_multi_domain)
3900 deliver_set_expansions(addr);
3902 if (exp_bool(addr, US"transport", tp->name, D_transport,
3903 US"multi_domain", tp->multi_domain, tp->expand_multi_domain,
3904 &multi_domain) != OK)
3906 deliver_set_expansions(NULL);
3907 panicmsg = addr->message;
3908 goto panic_continue;
3911 /* Get the maximum it can handle in one envelope, with zero meaning
3912 unlimited, which is forced for the MUA wrapper case. */
3914 address_count_max = tp->max_addresses;
3915 if (address_count_max == 0 || mua_wrapper) address_count_max = 999999;
3918 /************************************************************************/
3919 /***** This is slightly experimental code, but should be safe. *****/
3921 /* The address_count_max value is the maximum number of addresses that the
3922 transport can send in one envelope. However, the transport must be capable of
3923 dealing with any number of addresses. If the number it gets exceeds its
3924 envelope limitation, it must send multiple copies of the message. This can be
3925 done over a single connection for SMTP, so uses less resources than making
3926 multiple connections. On the other hand, if remote_max_parallel is greater
3927 than one, it is perhaps a good idea to use parallel processing to move the
3928 message faster, even if that results in multiple simultaneous connections to
3931 How can we come to some compromise between these two ideals? What we do is to
3932 limit the number of addresses passed to a single instance of a transport to
3933 the greater of (a) its address limit (rcpt_max for SMTP) and (b) the total
3934 number of addresses routed to remote transports divided by
3935 remote_max_parallel. For example, if the message has 100 remote recipients,
3936 remote max parallel is 2, and rcpt_max is 10, we'd never send more than 50 at
3937 once. But if rcpt_max is 100, we could send up to 100.
3939 Of course, not all the remotely addresses in a message are going to go to the
3940 same set of hosts (except in smarthost configurations), so this is just a
3941 heuristic way of dividing up the work.
3943 Furthermore (1), because this may not be wanted in some cases, and also to
3944 cope with really pathological cases, there is also a limit to the number of
3945 messages that are sent over one connection. This is the same limit that is
3946 used when sending several different messages over the same connection.
3947 Continue_sequence is set when in this situation, to the number sent so
3948 far, including this message.
3950 Furthermore (2), when somebody explicitly sets the maximum value to 1, it
3951 is probably because they are using VERP, in which case they want to pass only
3952 one address at a time to the transport, in order to be able to use
3953 $local_part and $domain in constructing a new return path. We could test for
3954 the use of these variables, but as it is so likely they will be used when the
3955 maximum is 1, we don't bother. Just leave the value alone. */
3957 if ( address_count_max != 1
3958 && address_count_max < remote_delivery_count/remote_max_parallel
3961 int new_max = remote_delivery_count/remote_max_parallel;
3962 int message_max = tp->connection_max_messages;
3963 if (connection_max_messages >= 0) message_max = connection_max_messages;
3964 message_max -= continue_sequence - 1;
3965 if (message_max > 0 && new_max > address_count_max * message_max)
3966 new_max = address_count_max * message_max;
3967 address_count_max = new_max;
3970 /************************************************************************/
3973 /* Pick off all addresses which have the same transport, errors address,
3974 destination, and extra headers. In some cases they point to the same host
3975 list, but we also need to check for identical host lists generated from
3976 entirely different domains. The host list pointers can be NULL in the case
3977 where the hosts are defined in the transport. There is also a configured
3978 maximum limit of addresses that can be handled at once (see comments above
3979 for how it is computed).
3980 If the transport does not handle multiple domains, enforce that also,
3981 and if it might need a per-address check for this, re-evaluate it.
3984 while ((next = *anchor) && address_count < address_count_max)
3987 if ( (multi_domain || Ustrcmp(next->domain, addr->domain) == 0)
3988 && tp == next->transport
3989 && same_hosts(next->host_list, addr->host_list)
3990 && same_strings(next->prop.errors_address, addr->prop.errors_address)
3991 && same_headers(next->prop.extra_headers, addr->prop.extra_headers)
3992 && same_ugid(tp, next, addr)
3993 && ( next->prop.remove_headers == addr->prop.remove_headers
3994 || ( next->prop.remove_headers
3995 && addr->prop.remove_headers
3996 && Ustrcmp(next->prop.remove_headers, addr->prop.remove_headers) == 0
4000 !tp->expand_multi_domain || (deliver_set_expansions(next), 1),
4002 US"transport", next->transport->name, D_transport,
4003 US"multi_domain", next->transport->multi_domain,
4004 next->transport->expand_multi_domain, &md) == OK
4009 *anchor = next->next;
4011 next->first = addr; /* remember top one (for retry processing) */
4016 else anchor = &(next->next);
4017 deliver_set_expansions(NULL);
4020 /* If we are acting as an MUA wrapper, all addresses must go in a single
4021 transaction. If not, put them back on the chain and yield FALSE. */
4023 if (mua_wrapper && addr_remote)
4025 last->next = addr_remote;
4030 /* Set up the expansion variables for this set of addresses */
4032 deliver_set_expansions(addr);
4034 /* Ensure any transport-set auth info is fresh */
4035 addr->authenticator = addr->auth_id = addr->auth_sndr = NULL;
4037 /* Compute the return path, expanding a new one if required. The old one
4038 must be set first, as it might be referred to in the expansion. */
4040 if(addr->prop.errors_address)
4041 return_path = addr->prop.errors_address;
4042 #ifdef EXPERIMENTAL_SRS
4043 else if(addr->prop.srs_sender)
4044 return_path = addr->prop.srs_sender;
4047 return_path = sender_address;
4049 if (tp->return_path)
4051 uschar *new_return_path = expand_string(tp->return_path);
4052 if (new_return_path)
4053 return_path = new_return_path;
4054 else if (!expand_string_forcedfail)
4056 panicmsg = string_sprintf("Failed to expand return path \"%s\": %s",
4057 tp->return_path, expand_string_message);
4058 goto panic_continue;
4062 /* Find the uid, gid, and use_initgroups setting for this transport. Failure
4063 logs and sets up error messages, so we just post-process and continue with
4064 the next address. */
4066 if (!findugid(addr, tp, &uid, &gid, &use_initgroups))
4069 goto panic_continue;
4072 /* If this transport has a setup function, call it now so that it gets
4073 run in this process and not in any subprocess. That way, the results of
4074 any setup that are retained by the transport can be reusable. One of the
4075 things the setup does is to set the fallback host lists in the addresses.
4076 That is why it is called at this point, before the continue delivery
4077 processing, because that might use the fallback hosts. */
4080 (void)((tp->setup)(addr->transport, addr, NULL, uid, gid, NULL));
4082 /* If this is a run to continue delivery down an already-established
4083 channel, check that this set of addresses matches the transport and
4084 the channel. If it does not, defer the addresses. If a host list exists,
4085 we must check that the continue host is on the list. Otherwise, the
4086 host is set in the transport. */
4088 continue_more = FALSE; /* In case got set for the last lot */
4089 if (continue_transport)
4091 BOOL ok = Ustrcmp(continue_transport, tp->name) == 0;
4092 if (ok && addr->host_list)
4096 for (h = addr->host_list; h; h = h->next)
4097 if (Ustrcmp(h->name, continue_hostname) == 0)
4098 { ok = TRUE; break; }
4101 /* Addresses not suitable; defer or queue for fallback hosts (which
4102 might be the continue host) and skip to next address. */
4106 DEBUG(D_deliver) debug_printf("not suitable for continue_transport\n");
4109 if (addr->fallback_hosts && !fallback)
4111 for (;; next = next->next)
4113 next->host_list = next->fallback_hosts;
4114 DEBUG(D_deliver) debug_printf("%s queued for fallback host(s)\n", next->address);
4115 if (!next->next) break;
4117 next->next = addr_fallback;
4118 addr_fallback = addr;
4123 while (next->next) next = next->next;
4124 next->next = addr_defer;
4131 /* Set a flag indicating whether there are further addresses that list
4132 the continued host. This tells the transport to leave the channel open,
4133 but not to pass it to another delivery process. */
4135 for (next = addr_remote; next; next = next->next)
4138 for (h = next->host_list; h; h = h->next)
4139 if (Ustrcmp(h->name, continue_hostname) == 0)
4140 { continue_more = TRUE; break; }
4144 /* The transports set up the process info themselves as they may connect
4145 to more than one remote machine. They also have to set up the filter
4146 arguments, if required, so that the host name and address are available
4149 transport_filter_argv = NULL;
4151 /* Create the pipe for inter-process communication. If pipe creation
4152 fails, it is probably because the value of remote_max_parallel is so
4153 large that too many file descriptors for pipes have been created. Arrange
4154 to wait for a process to finish, and then try again. If we still can't
4155 create a pipe when all processes have finished, break the retry loop. */
4159 if (pipe(pfd) == 0) pipe_done = TRUE;
4160 else if (parcount > 0) parmax = parcount;
4163 /* We need to make the reading end of the pipe non-blocking. There are
4164 two different options for this. Exim is cunningly (I hope!) coded so
4165 that it can use either of them, though it prefers O_NONBLOCK, which
4166 distinguishes between EOF and no-more-data. */
4169 (void)fcntl(pfd[pipe_read], F_SETFL, O_NONBLOCK);
4171 (void)fcntl(pfd[pipe_read], F_SETFL, O_NDELAY);
4174 /* If the maximum number of subprocesses already exist, wait for a process
4175 to finish. If we ran out of file descriptors, parmax will have been reduced
4176 from its initial value of remote_max_parallel. */
4178 par_reduce(parmax - 1, fallback);
4181 /* If we failed to create a pipe and there were no processes to wait
4182 for, we have to give up on this one. Do this outside the above loop
4183 so that we can continue the main loop. */
4187 panicmsg = string_sprintf("unable to create pipe: %s", strerror(errno));
4188 goto panic_continue;
4191 /* Find a free slot in the pardata list. Must do this after the possible
4192 waiting for processes to finish, because a terminating process will free
4195 for (poffset = 0; poffset < remote_max_parallel; poffset++)
4196 if (parlist[poffset].pid == 0)
4199 /* If there isn't one, there has been a horrible disaster. */
4201 if (poffset >= remote_max_parallel)
4203 (void)close(pfd[pipe_write]);
4204 (void)close(pfd[pipe_read]);
4205 panicmsg = US"Unexpectedly no free subprocess slot";
4206 goto panic_continue;
4209 /* Now fork a subprocess to do the remote delivery, but before doing so,
4210 ensure that any cached resourses are released so as not to interfere with
4211 what happens in the subprocess. */
4215 if ((pid = fork()) == 0)
4217 int fd = pfd[pipe_write];
4220 /* Setting this global in the subprocess means we need never clear it */
4221 transport_name = tp->name;
4223 /* There are weird circumstances in which logging is disabled */
4224 disable_logging = tp->disable_logging;
4226 /* Show pids on debug output if parallelism possible */
4228 if (parmax > 1 && (parcount > 0 || addr_remote))
4230 DEBUG(D_any|D_v) debug_selector |= D_pid;
4231 DEBUG(D_deliver) debug_printf("Remote delivery process started\n");
4234 /* Reset the random number generator, so different processes don't all
4235 have the same sequence. In the test harness we want different, but
4236 predictable settings for each delivery process, so do something explicit
4237 here rather they rely on the fixed reset in the random number function. */
4239 random_seed = running_in_test_harness? 42 + 2*delivery_count : 0;
4241 /* Set close-on-exec on the pipe so that it doesn't get passed on to
4242 a new process that may be forked to do another delivery down the same
4245 (void)fcntl(fd, F_SETFD, fcntl(fd, F_GETFD) | FD_CLOEXEC);
4247 /* Close open file descriptors for the pipes of other processes
4248 that are running in parallel. */
4250 for (poffset = 0; poffset < remote_max_parallel; poffset++)
4251 if (parlist[poffset].pid != 0) (void)close(parlist[poffset].fd);
4253 /* This process has inherited a copy of the file descriptor
4254 for the data file, but its file pointer is shared with all the
4255 other processes running in parallel. Therefore, we have to re-open
4256 the file in order to get a new file descriptor with its own
4257 file pointer. We don't need to lock it, as the lock is held by
4258 the parent process. There doesn't seem to be any way of doing
4259 a dup-with-new-file-pointer. */
4261 (void)close(deliver_datafile);
4262 sprintf(CS spoolname, "%s/input/%s/%s-D", spool_directory, message_subdir,
4264 deliver_datafile = Uopen(spoolname, O_RDWR | O_APPEND, 0);
4266 if (deliver_datafile < 0)
4267 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Failed to reopen %s for remote "
4268 "parallel delivery: %s", spoolname, strerror(errno));
4270 /* Set the close-on-exec flag */
4272 (void)fcntl(deliver_datafile, F_SETFD, fcntl(deliver_datafile, F_GETFD) |
4275 /* Set the uid/gid of this process; bombs out on failure. */
4277 exim_setugid(uid, gid, use_initgroups,
4278 string_sprintf("remote delivery to %s with transport=%s",
4279 addr->address, tp->name));
4281 /* Close the unwanted half of this process' pipe, set the process state,
4282 and run the transport. Afterwards, transport_count will contain the number
4283 of bytes written. */
4285 (void)close(pfd[pipe_read]);
4286 set_process_info("delivering %s using %s", message_id, tp->name);
4287 debug_print_string(tp->debug_string);
4288 if (!(tp->info->code)(addr->transport, addr)) replicate_status(addr);
4290 set_process_info("delivering %s (just run %s for %s%s in subprocess)",
4291 message_id, tp->name, addr->address, addr->next ? ", ..." : "");
4293 /* Ensure any cached resources that we used are now released */
4297 /* Pass the result back down the pipe. This is a lot more information
4298 than is needed for a local delivery. We have to send back the error
4299 status for each address, the usability status for each host that is
4300 flagged as unusable, and all the retry items. When TLS is in use, we
4301 send also the cipher and peerdn information. Each type of information
4302 is flagged by an identifying byte, and is then in a fixed format (with
4303 strings terminated by zeros), and there is a final terminator at the
4304 end. The host information and retry information is all attached to
4305 the first address, so that gets sent at the start. */
4307 /* Host unusability information: for most success cases this will
4310 for (h = addr->host_list; h; h = h->next)
4312 if (!h->address || h->status < hstatus_unusable) continue;
4313 sprintf(CS big_buffer, "%c%c%s", h->status, h->why, h->address);
4314 rmt_dlv_checked_write(fd, 'H', '0', big_buffer, Ustrlen(big_buffer+2) + 3);
4317 /* The number of bytes written. This is the same for each address. Even
4318 if we sent several copies of the message down the same connection, the
4319 size of each one is the same, and it's that value we have got because
4320 transport_count gets reset before calling transport_write_message(). */
4322 memcpy(big_buffer, &transport_count, sizeof(transport_count));
4323 rmt_dlv_checked_write(fd, 'S', '0', big_buffer, sizeof(transport_count));
4325 /* Information about what happened to each address. Four item types are
4326 used: an optional 'X' item first, for TLS information, then an optional "C"
4327 item for any client-auth info followed by 'R' items for any retry settings,
4328 and finally an 'A' item for the remaining data. */
4330 for(; addr; addr = addr->next)
4335 /* The certificate verification status goes into the flags */
4336 if (tls_out.certificate_verified) setflag(addr, af_cert_verified);
4337 #ifdef EXPERIMENTAL_DANE
4338 if (tls_out.dane_verified) setflag(addr, af_dane_verified);
4341 /* Use an X item only if there's something to send */
4346 sprintf(CS ptr, "%.128s", addr->cipher);
4352 sprintf(CS ptr, "%.512s", addr->peerdn);
4356 rmt_dlv_checked_write(fd, 'X', '1', big_buffer, ptr - big_buffer);
4361 if (!tls_export_cert(ptr, big_buffer_size-2, addr->peercert))
4365 rmt_dlv_checked_write(fd, 'X', '2', big_buffer, ptr - big_buffer);
4370 if (!tls_export_cert(ptr, big_buffer_size-2, addr->ourcert))
4374 rmt_dlv_checked_write(fd, 'X', '3', big_buffer, ptr - big_buffer);
4376 # ifndef DISABLE_OCSP
4377 if (addr->ocsp > OCSP_NOT_REQ)
4380 sprintf(CS ptr, "%c", addr->ocsp + '0');
4382 rmt_dlv_checked_write(fd, 'X', '4', big_buffer, ptr - big_buffer);
4385 #endif /*SUPPORT_TLS*/
4387 if (client_authenticator)
4390 sprintf(CS big_buffer, "%.64s", client_authenticator);
4392 rmt_dlv_checked_write(fd, 'C', '1', big_buffer, ptr - big_buffer);
4394 if (client_authenticated_id)
4397 sprintf(CS big_buffer, "%.64s", client_authenticated_id);
4399 rmt_dlv_checked_write(fd, 'C', '2', big_buffer, ptr - big_buffer);
4401 if (client_authenticated_sender)
4404 sprintf(CS big_buffer, "%.64s", client_authenticated_sender);
4406 rmt_dlv_checked_write(fd, 'C', '3', big_buffer, ptr - big_buffer);
4409 #ifndef DISABLE_PRDR
4410 if (addr->flags & af_prdr_used)
4411 rmt_dlv_checked_write(fd, 'P', '0', NULL, 0);
4414 memcpy(big_buffer, &addr->dsn_aware, sizeof(addr->dsn_aware));
4415 rmt_dlv_checked_write(fd, 'D', '0', big_buffer, sizeof(addr->dsn_aware));
4416 DEBUG(D_deliver) debug_printf("DSN write: addr->dsn_aware = %d\n", addr->dsn_aware);
4418 /* Retry information: for most success cases this will be null. */
4420 for (r = addr->retries; r; r = r->next)
4422 sprintf(CS big_buffer, "%c%.500s", r->flags, r->key);
4423 ptr = big_buffer + Ustrlen(big_buffer+2) + 3;
4424 memcpy(ptr, &(r->basic_errno), sizeof(r->basic_errno));
4425 ptr += sizeof(r->basic_errno);
4426 memcpy(ptr, &(r->more_errno), sizeof(r->more_errno));
4427 ptr += sizeof(r->more_errno);
4428 if (!r->message) *ptr++ = 0; else
4430 sprintf(CS ptr, "%.512s", r->message);
4433 rmt_dlv_checked_write(fd, 'R', '0', big_buffer, ptr - big_buffer);
4436 #ifdef EXPERIMENTAL_DSN_INFO
4437 /*um, are they really per-addr? Other per-conn stuff is not (auth, tls). But host_used is! */
4438 if (addr->smtp_greeting)
4441 DEBUG(D_deliver) debug_printf("smtp_greeting '%s'\n", addr->smtp_greeting);
4442 sprintf(CS ptr, "%.128s", addr->smtp_greeting);
4444 if (addr->helo_response)
4446 DEBUG(D_deliver) debug_printf("helo_response '%s'\n", addr->helo_response);
4447 sprintf(CS ptr, "%.128s", addr->helo_response);
4452 rmt_dlv_checked_write(fd, 'A', '1', big_buffer, ptr - big_buffer);
4456 /* The rest of the information goes in an 'A0' item. */
4458 sprintf(CS big_buffer, "%c%c", addr->transport_return,
4459 addr->special_action);
4460 ptr = big_buffer + 2;
4461 memcpy(ptr, &(addr->basic_errno), sizeof(addr->basic_errno));
4462 ptr += sizeof(addr->basic_errno);
4463 memcpy(ptr, &(addr->more_errno), sizeof(addr->more_errno));
4464 ptr += sizeof(addr->more_errno);
4465 memcpy(ptr, &(addr->flags), sizeof(addr->flags));
4466 ptr += sizeof(addr->flags);
4468 if (!addr->message) *ptr++ = 0; else
4470 sprintf(CS ptr, "%.1024s", addr->message);
4474 if (!addr->user_message) *ptr++ = 0; else
4476 sprintf(CS ptr, "%.1024s", addr->user_message);
4480 if (!addr->host_used) *ptr++ = 0; else
4482 sprintf(CS ptr, "%.256s", addr->host_used->name);
4484 sprintf(CS ptr, "%.64s", addr->host_used->address);
4486 memcpy(ptr, &(addr->host_used->port), sizeof(addr->host_used->port));
4487 ptr += sizeof(addr->host_used->port);
4489 /* DNS lookup status */
4490 *ptr++ = addr->host_used->dnssec==DS_YES ? '2'
4491 : addr->host_used->dnssec==DS_NO ? '1' : '0';
4494 rmt_dlv_checked_write(fd, 'A', '0', big_buffer, ptr - big_buffer);
4497 /* Local interface address/port */
4498 #ifdef EXPERIMENTAL_DSN_INFO
4499 if (sending_ip_address)
4501 if (LOGGING(incoming_interface) && sending_ip_address)
4504 uschar * ptr = big_buffer;
4505 sprintf(CS ptr, "%.128s", sending_ip_address);
4507 sprintf(CS ptr, "%d", sending_port);
4510 rmt_dlv_checked_write(fd, 'I', '0', big_buffer, ptr - big_buffer);
4513 /* Add termination flag, close the pipe, and that's it. The character
4514 after 'Z' indicates whether continue_transport is now NULL or not.
4515 A change from non-NULL to NULL indicates a problem with a continuing
4518 big_buffer[0] = continue_transport ? '1' : '0';
4519 rmt_dlv_checked_write(fd, 'Z', '0', big_buffer, 1);
4524 /* Back in the mainline: close the unwanted half of the pipe. */
4526 (void)close(pfd[pipe_write]);
4528 /* Fork failed; defer with error message */
4532 (void)close(pfd[pipe_read]);
4533 panicmsg = string_sprintf("fork failed for remote delivery to %s: %s",
4534 addr->domain, strerror(errno));
4535 goto panic_continue;
4538 /* Fork succeeded; increment the count, and remember relevant data for
4539 when the process finishes. */
4542 parlist[poffset].addrlist = parlist[poffset].addr = addr;
4543 parlist[poffset].pid = pid;
4544 parlist[poffset].fd = pfd[pipe_read];
4545 parlist[poffset].done = FALSE;
4546 parlist[poffset].msg = NULL;
4547 parlist[poffset].return_path = return_path;
4549 /* If the process we've just started is sending a message down an existing
4550 channel, wait for it now. This ensures that only one such process runs at
4551 once, whatever the value of remote_max parallel. Otherwise, we might try to
4552 send two or more messages simultaneously down the same channel. This could
4553 happen if there are different domains that include the same host in otherwise
4554 different host lists.
4556 Also, if the transport closes down the channel, this information gets back
4557 (continue_transport gets set to NULL) before we consider any other addresses
4560 if (continue_transport) par_reduce(0, fallback);
4562 /* Otherwise, if we are running in the test harness, wait a bit, to let the
4563 newly created process get going before we create another process. This should
4564 ensure repeatability in the tests. We only need to wait a tad. */
4566 else if (running_in_test_harness) millisleep(500);
4571 remote_post_process(addr, LOG_MAIN|LOG_PANIC, panicmsg, fallback);
4575 /* Reached the end of the list of addresses. Wait for all the subprocesses that
4576 are still running and post-process their addresses. */
4578 par_reduce(0, fallback);
4585 /*************************************************
4586 * Split an address into local part and domain *
4587 *************************************************/
4589 /* This function initializes an address for routing by splitting it up into a
4590 local part and a domain. The local part is set up twice - once in its original
4591 casing, and once in lower case, and it is dequoted. We also do the "percent
4592 hack" for configured domains. This may lead to a DEFER result if a lookup
4593 defers. When a percent-hacking takes place, we insert a copy of the original
4594 address as a new parent of this address, as if we have had a redirection.
4597 addr points to an addr_item block containing the address
4600 DEFER - could not determine if domain is %-hackable
4604 deliver_split_address(address_item *addr)
4606 uschar *address = addr->address;
4607 uschar *domain = Ustrrchr(address, '@');
4609 int len = domain - address;
4611 addr->domain = string_copylc(domain+1); /* Domains are always caseless */
4613 /* The implication in the RFCs (though I can't say I've seen it spelled out
4614 explicitly) is that quoting should be removed from local parts at the point
4615 where they are locally interpreted. [The new draft "821" is more explicit on
4616 this, Jan 1999.] We know the syntax is valid, so this can be done by simply
4617 removing quoting backslashes and any unquoted doublequotes. */
4619 t = addr->cc_local_part = store_get(len+1);
4622 register int c = *address++;
4623 if (c == '\"') continue;
4633 /* We do the percent hack only for those domains that are listed in
4634 percent_hack_domains. A loop is required, to copy with multiple %-hacks. */
4636 if (percent_hack_domains)
4639 uschar *new_address = NULL;
4640 uschar *local_part = addr->cc_local_part;
4642 deliver_domain = addr->domain; /* set $domain */
4644 while ( (rc = match_isinlist(deliver_domain, (const uschar **)&percent_hack_domains, 0,
4645 &domainlist_anchor, addr->domain_cache, MCL_DOMAIN, TRUE, NULL))
4647 && (t = Ustrrchr(local_part, '%')) != NULL
4650 new_address = string_copy(local_part);
4651 new_address[t - local_part] = '@';
4652 deliver_domain = string_copylc(t+1);
4653 local_part = string_copyn(local_part, t - local_part);
4656 if (rc == DEFER) return DEFER; /* lookup deferred */
4658 /* If hackery happened, set up new parent and alter the current address. */
4662 address_item *new_parent = store_get(sizeof(address_item));
4663 *new_parent = *addr;
4664 addr->parent = new_parent;
4665 addr->address = new_address;
4666 addr->unique = string_copy(new_address);
4667 addr->domain = deliver_domain;
4668 addr->cc_local_part = local_part;
4669 DEBUG(D_deliver) debug_printf("%%-hack changed address to: %s\n",
4674 /* Create the lowercased version of the final local part, and make that the
4675 default one to be used. */
4677 addr->local_part = addr->lc_local_part = string_copylc(addr->cc_local_part);
4684 /*************************************************
4685 * Get next error message text *
4686 *************************************************/
4688 /* If f is not NULL, read the next "paragraph", from a customized error message
4689 text file, terminated by a line containing ****, and expand it.
4692 f NULL or a file to read from
4693 which string indicating which string (for errors)
4695 Returns: NULL or an expanded string
4699 next_emf(FILE *f, uschar *which)
4703 uschar *para, *yield;
4706 if (!f) return NULL;
4708 if (!Ufgets(buffer, sizeof(buffer), f) || Ustrcmp(buffer, "****\n") == 0)
4711 para = store_get(size);
4714 para = string_cat(para, &size, &ptr, buffer, Ustrlen(buffer));
4715 if (!Ufgets(buffer, sizeof(buffer), f) || Ustrcmp(buffer, "****\n") == 0)
4720 if ((yield = expand_string(para)))
4723 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand string from "
4724 "bounce_message_file or warn_message_file (%s): %s", which,
4725 expand_string_message);
4732 /*************************************************
4733 * Close down a passed transport channel *
4734 *************************************************/
4736 /* This function is called when a passed transport channel cannot be used.
4737 It attempts to close it down tidily. The yield is always DELIVER_NOT_ATTEMPTED
4738 so that the function call can be the argument of a "return" statement.
4741 Returns: DELIVER_NOT_ATTEMPTED
4745 continue_closedown(void)
4747 if (continue_transport)
4749 transport_instance *t;
4750 for (t = transports; t; t = t->next)
4751 if (Ustrcmp(t->name, continue_transport) == 0)
4753 if (t->info->closedown) (t->info->closedown)(t);
4757 return DELIVER_NOT_ATTEMPTED;
4763 /*************************************************
4764 * Print address information *
4765 *************************************************/
4767 /* This function is called to output an address, or information about an
4768 address, for bounce or defer messages. If the hide_child flag is set, all we
4769 output is the original ancestor address.
4772 addr points to the address
4773 f the FILE to print to
4774 si an initial string
4775 sc a continuation string for before "generated"
4778 Returns: TRUE if the address is not hidden
4782 print_address_information(address_item *addr, FILE *f, uschar *si, uschar *sc,
4786 uschar *printed = US"";
4787 address_item *ancestor = addr;
4788 while (ancestor->parent) ancestor = ancestor->parent;
4790 fprintf(f, "%s", CS si);
4792 if (addr->parent && testflag(addr, af_hide_child))
4794 printed = US"an undisclosed address";
4797 else if (!testflag(addr, af_pfr) || !addr->parent)
4798 printed = addr->address;
4802 uschar *s = addr->address;
4805 if (addr->address[0] == '>') { ss = US"mail"; s++; }
4806 else if (addr->address[0] == '|') ss = US"pipe";
4809 fprintf(f, "%s to %s%sgenerated by ", ss, s, sc);
4810 printed = addr->parent->address;
4813 fprintf(f, "%s", CS string_printing(printed));
4815 if (ancestor != addr)
4817 uschar *original = ancestor->onetime_parent;
4818 if (!original) original= ancestor->address;
4819 if (strcmpic(original, printed) != 0)
4820 fprintf(f, "%s(%sgenerated from %s)", sc,
4821 ancestor != addr->parent ? "ultimately " : "",
4822 string_printing(original));
4825 if (addr->host_used)
4826 fprintf(f, "\n host %s [%s]",
4827 addr->host_used->name, addr->host_used->address);
4829 fprintf(f, "%s", CS se);
4837 /*************************************************
4838 * Print error for an address *
4839 *************************************************/
4841 /* This function is called to print the error information out of an address for
4842 a bounce or a warning message. It tries to format the message reasonably by
4843 introducing newlines. All lines are indented by 4; the initial printing
4844 position must be set before calling.
4846 This function used always to print the error. Nowadays we want to restrict it
4847 to cases such as LMTP/SMTP errors from a remote host, and errors from :fail:
4848 and filter "fail". We no longer pass other information willy-nilly in bounce
4849 and warning messages. Text in user_message is always output; text in message
4850 only if the af_pass_message flag is set.
4854 f the FILE to print on
4861 print_address_error(address_item *addr, FILE *f, uschar *t)
4863 int count = Ustrlen(t);
4864 uschar *s = testflag(addr, af_pass_message)? addr->message : NULL;
4866 if (!s && !(s = addr->user_message))
4869 fprintf(f, "\n %s", t);
4872 if (*s == '\\' && s[1] == 'n')
4882 if (*s++ == ':' && isspace(*s) && count > 45)
4884 fprintf(f, "\n "); /* sic (because space follows) */
4891 /***********************************************************
4892 * Print Diagnostic-Code for an address *
4893 ************************************************************/
4895 /* This function is called to print the error information out of an address for
4896 a bounce or a warning message. It tries to format the message reasonably as
4897 required by RFC 3461 by adding a space after each newline
4899 it uses the same logic as print_address_error() above. if af_pass_message is true
4900 and addr->message is set it uses the remote host answer. if not addr->user_message
4901 is used instead if available.
4905 f the FILE to print on
4911 print_dsn_diagnostic_code(const address_item *addr, FILE *f)
4913 uschar *s = testflag(addr, af_pass_message) ? addr->message : NULL;
4915 /* af_pass_message and addr->message set ? print remote host answer */
4919 debug_printf("DSN Diagnostic-Code: addr->message = %s\n", addr->message);
4921 /* search first ": ". we assume to find the remote-MTA answer there */
4922 if (!(s = Ustrstr(addr->message, ": ")))
4923 return; /* not found, bail out */
4924 s += 2; /* skip ": " */
4925 fprintf(f, "Diagnostic-Code: smtp; ");
4927 /* no message available. do nothing */
4931 if (*s == '\\' && s[1] == 'n')
4933 fputs("\n ", f); /* as defined in RFC 3461 */
4943 /*************************************************
4944 * Check list of addresses for duplication *
4945 *************************************************/
4947 /* This function was introduced when the test for duplicate addresses that are
4948 not pipes, files, or autoreplies was moved from the middle of routing to when
4949 routing was complete. That was to fix obscure cases when the routing history
4950 affects the subsequent routing of identical addresses. This function is called
4951 after routing, to check that the final routed addresses are not duplicates.
4953 If we detect a duplicate, we remember what it is a duplicate of. Note that
4954 pipe, file, and autoreply de-duplication is handled during routing, so we must
4955 leave such "addresses" alone here, as otherwise they will incorrectly be
4958 Argument: address of list anchor
4963 do_duplicate_check(address_item **anchor)
4966 while ((addr = *anchor))
4969 if (testflag(addr, af_pfr))
4971 anchor = &(addr->next);
4973 else if ((tnode = tree_search(tree_duplicates, addr->unique)))
4975 DEBUG(D_deliver|D_route)
4976 debug_printf("%s is a duplicate address: discarded\n", addr->unique);
4977 *anchor = addr->next;
4978 addr->dupof = tnode->data.ptr;
4979 addr->next = addr_duplicate;
4980 addr_duplicate = addr;
4984 tree_add_duplicate(addr->unique, addr);
4985 anchor = &(addr->next);
4993 /*************************************************
4994 * Deliver one message *
4995 *************************************************/
4997 /* This is the function which is called when a message is to be delivered. It
4998 is passed the id of the message. It is possible that the message no longer
4999 exists, if some other process has delivered it, and it is also possible that
5000 the message is being worked on by another process, in which case the data file
5003 If no delivery is attempted for any of the above reasons, the function returns
5004 DELIVER_NOT_ATTEMPTED.
5006 If the give_up flag is set true, do not attempt any deliveries, but instead
5007 fail all outstanding addresses and return the message to the sender (or
5010 A delivery operation has a process all to itself; we never deliver more than
5011 one message in the same process. Therefore we needn't worry too much about
5015 id the id of the message to be delivered
5016 forced TRUE if delivery was forced by an administrator; this overrides
5017 retry delays and causes a delivery to be tried regardless
5018 give_up TRUE if an administrator has requested that delivery attempts
5021 Returns: When the global variable mua_wrapper is FALSE:
5022 DELIVER_ATTEMPTED_NORMAL if a delivery attempt was made
5023 DELIVER_NOT_ATTEMPTED otherwise (see comment above)
5024 When the global variable mua_wrapper is TRUE:
5025 DELIVER_MUA_SUCCEEDED if delivery succeeded
5026 DELIVER_MUA_FAILED if delivery failed
5027 DELIVER_NOT_ATTEMPTED if not attempted (should not occur)
5031 deliver_message(uschar *id, BOOL forced, BOOL give_up)
5034 int final_yield = DELIVER_ATTEMPTED_NORMAL;
5035 time_t now = time(NULL);
5036 address_item *addr_last = NULL;
5037 uschar *filter_message = NULL;
5039 int process_recipients = RECIP_ACCEPT;
5042 extern int acl_where;
5044 uschar *info = queue_run_pid == (pid_t)0
5045 ? string_sprintf("delivering %s", id)
5046 : string_sprintf("delivering %s (queue run pid %d)", id, queue_run_pid);
5048 /* If the D_process_info bit is on, set_process_info() will output debugging
5049 information. If not, we want to show this initial information if D_deliver or
5050 D_queue_run is set or in verbose mode. */
5052 set_process_info("%s", info);
5054 if ( !(debug_selector & D_process_info)
5055 && (debug_selector & (D_deliver|D_queue_run|D_v))
5057 debug_printf("%s\n", info);
5059 /* Ensure that we catch any subprocesses that are created. Although Exim
5060 sets SIG_DFL as its initial default, some routes through the code end up
5061 here with it set to SIG_IGN - cases where a non-synchronous delivery process
5062 has been forked, but no re-exec has been done. We use sigaction rather than
5063 plain signal() on those OS where SA_NOCLDWAIT exists, because we want to be
5064 sure it is turned off. (There was a problem on AIX with this.) */
5068 struct sigaction act;
5069 act.sa_handler = SIG_DFL;
5070 sigemptyset(&(act.sa_mask));
5072 sigaction(SIGCHLD, &act, NULL);
5075 signal(SIGCHLD, SIG_DFL);
5078 /* Make the forcing flag available for routers and transports, set up the
5079 global message id field, and initialize the count for returned files and the
5080 message size. This use of strcpy() is OK because the length id is checked when
5081 it is obtained from a command line (the -M or -q options), and otherwise it is
5082 known to be a valid message id. */
5084 Ustrcpy(message_id, id);
5085 deliver_force = forced;
5089 /* Initialize some flags */
5091 update_spool = FALSE;
5092 remove_journal = TRUE;
5094 /* Set a known context for any ACLs we call via expansions */
5095 acl_where = ACL_WHERE_DELIVERY;
5097 /* Reset the random number generator, so that if several delivery processes are
5098 started from a queue runner that has already used random numbers (for sorting),
5099 they don't all get the same sequence. */
5103 /* Open and lock the message's data file. Exim locks on this one because the
5104 header file may get replaced as it is re-written during the delivery process.
5105 Any failures cause messages to be written to the log, except for missing files
5106 while queue running - another process probably completed delivery. As part of
5107 opening the data file, message_subdir gets set. */
5109 if (!spool_open_datafile(id))
5110 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5112 /* The value of message_size at this point has been set to the data length,
5113 plus one for the blank line that notionally precedes the data. */
5115 /* Now read the contents of the header file, which will set up the headers in
5116 store, and also the list of recipients and the tree of non-recipients and
5117 assorted flags. It updates message_size. If there is a reading or format error,
5118 give up; if the message has been around for sufficiently long, remove it. */
5120 sprintf(CS spoolname, "%s-H", id);
5121 if ((rc = spool_read_header(spoolname, TRUE, TRUE)) != spool_read_OK)
5123 if (errno == ERRNO_SPOOLFORMAT)
5125 struct stat statbuf;
5126 sprintf(CS big_buffer, "%s/input/%s/%s", spool_directory, message_subdir,
5128 if (Ustat(big_buffer, &statbuf) == 0)
5129 log_write(0, LOG_MAIN, "Format error in spool file %s: "
5130 "size=" OFF_T_FMT, spoolname, statbuf.st_size);
5131 else log_write(0, LOG_MAIN, "Format error in spool file %s", spoolname);
5134 log_write(0, LOG_MAIN, "Error reading spool file %s: %s", spoolname,
5137 /* If we managed to read the envelope data, received_time contains the
5138 time the message was received. Otherwise, we can calculate it from the
5141 if (rc != spool_read_hdrerror)
5144 for (i = 0; i < 6; i++)
5145 received_time = received_time * BASE_62 + tab62[id[i] - '0'];
5148 /* If we've had this malformed message too long, sling it. */
5150 if (now - received_time > keep_malformed)
5152 sprintf(CS spoolname, "%s/msglog/%s/%s", spool_directory, message_subdir, id);
5154 sprintf(CS spoolname, "%s/input/%s/%s-D", spool_directory, message_subdir, id);
5156 sprintf(CS spoolname, "%s/input/%s/%s-H", spool_directory, message_subdir, id);
5158 sprintf(CS spoolname, "%s/input/%s/%s-J", spool_directory, message_subdir, id);
5160 log_write(0, LOG_MAIN, "Message removed because older than %s",
5161 readconf_printtime(keep_malformed));
5164 (void)close(deliver_datafile);
5165 deliver_datafile = -1;
5166 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5169 /* The spool header file has been read. Look to see if there is an existing
5170 journal file for this message. If there is, it means that a previous delivery
5171 attempt crashed (program or host) before it could update the spool header file.
5172 Read the list of delivered addresses from the journal and add them to the
5173 nonrecipients tree. Then update the spool file. We can leave the journal in
5174 existence, as it will get further successful deliveries added to it in this
5175 run, and it will be deleted if this function gets to its end successfully.
5176 Otherwise it might be needed again. */
5178 sprintf(CS spoolname, "%s/input/%s/%s-J", spool_directory, message_subdir, id);
5179 jread = Ufopen(spoolname, "rb");
5182 while (Ufgets(big_buffer, big_buffer_size, jread))
5184 int n = Ustrlen(big_buffer);
5185 big_buffer[n-1] = 0;
5186 tree_add_nonrecipient(big_buffer);
5187 DEBUG(D_deliver) debug_printf("Previously delivered address %s taken from "
5188 "journal file\n", big_buffer);
5190 (void)fclose(jread);
5191 /* Panic-dies on error */
5192 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
5194 else if (errno != ENOENT)
5196 log_write(0, LOG_MAIN|LOG_PANIC, "attempt to open journal for reading gave: "
5197 "%s", strerror(errno));
5198 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5201 /* A null recipients list indicates some kind of disaster. */
5203 if (!recipients_list)
5205 (void)close(deliver_datafile);
5206 deliver_datafile = -1;
5207 log_write(0, LOG_MAIN, "Spool error: no recipients for %s", spoolname);
5208 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5212 /* Handle a message that is frozen. There are a number of different things that
5213 can happen, but in the default situation, unless forced, no delivery is
5218 #ifdef SUPPORT_MOVE_FROZEN_MESSAGES
5219 /* Moving to another directory removes the message from Exim's view. Other
5220 tools must be used to deal with it. Logging of this action happens in
5221 spool_move_message() and its subfunctions. */
5223 if ( move_frozen_messages
5224 && spool_move_message(id, message_subdir, US"", US"F")
5226 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5229 /* For all frozen messages (bounces or not), timeout_frozen_after sets the
5230 maximum time to keep messages that are frozen. Thaw if we reach it, with a
5231 flag causing all recipients to be failed. The time is the age of the
5232 message, not the time since freezing. */
5234 if (timeout_frozen_after > 0 && message_age >= timeout_frozen_after)
5236 log_write(0, LOG_MAIN, "cancelled by timeout_frozen_after");
5237 process_recipients = RECIP_FAIL_TIMEOUT;
5240 /* For bounce messages (and others with no sender), thaw if the error message
5241 ignore timer is exceeded. The message will be discarded if this delivery
5244 else if (sender_address[0] == 0 && message_age >= ignore_bounce_errors_after)
5246 log_write(0, LOG_MAIN, "Unfrozen by errmsg timer");
5249 /* If this is a bounce message, or there's no auto thaw, or we haven't
5250 reached the auto thaw time yet, and this delivery is not forced by an admin
5251 user, do not attempt delivery of this message. Note that forced is set for
5252 continuing messages down the same channel, in order to skip load checking and
5253 ignore hold domains, but we don't want unfreezing in that case. */
5257 if ( ( sender_address[0] == 0
5259 || now <= deliver_frozen_at + auto_thaw
5261 && ( !forced || !deliver_force_thaw
5262 || !admin_user || continue_hostname
5265 (void)close(deliver_datafile);
5266 deliver_datafile = -1;
5267 log_write(L_skip_delivery, LOG_MAIN, "Message is frozen");
5268 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5271 /* If delivery was forced (by an admin user), assume a manual thaw.
5272 Otherwise it's an auto thaw. */
5276 deliver_manual_thaw = TRUE;
5277 log_write(0, LOG_MAIN, "Unfrozen by forced delivery");
5279 else log_write(0, LOG_MAIN, "Unfrozen by auto-thaw");
5282 /* We get here if any of the rules for unfreezing have triggered. */
5284 deliver_freeze = FALSE;
5285 update_spool = TRUE;
5289 /* Open the message log file if we are using them. This records details of
5290 deliveries, deferments, and failures for the benefit of the mail administrator.
5291 The log is not used by exim itself to track the progress of a message; that is
5292 done by rewriting the header spool file. */
5299 sprintf(CS spoolname, "%s/msglog/%s/%s", spool_directory, message_subdir, id);
5300 fd = open_msglog_file(spoolname, SPOOL_MODE, &error);
5304 log_write(0, LOG_MAIN|LOG_PANIC, "Couldn't %s message log %s: %s", error,
5305 spoolname, strerror(errno));
5306 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5309 /* Make a C stream out of it. */
5311 if (!(message_log = fdopen(fd, "a")))
5313 log_write(0, LOG_MAIN|LOG_PANIC, "Couldn't fdopen message log %s: %s",
5314 spoolname, strerror(errno));
5315 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5320 /* If asked to give up on a message, log who did it, and set the action for all
5325 struct passwd *pw = getpwuid(real_uid);
5326 log_write(0, LOG_MAIN, "cancelled by %s",
5327 pw ? US pw->pw_name : string_sprintf("uid %ld", (long int)real_uid));
5328 process_recipients = RECIP_FAIL;
5331 /* Otherwise, if there are too many Received: headers, fail all recipients. */
5333 else if (received_count > received_headers_max)
5334 process_recipients = RECIP_FAIL_LOOP;
5336 /* Otherwise, if a system-wide, address-independent message filter is
5337 specified, run it now, except in the case when we are failing all recipients as
5338 a result of timeout_frozen_after. If the system filter yields "delivered", then
5339 ignore the true recipients of the message. Failure of the filter file is
5340 logged, and the delivery attempt fails. */
5342 else if (system_filter && process_recipients != RECIP_FAIL_TIMEOUT)
5347 redirect_block redirect;
5349 if (system_filter_uid_set)
5351 ugid.uid = system_filter_uid;
5352 ugid.gid = system_filter_gid;
5353 ugid.uid_set = ugid.gid_set = TRUE;
5357 ugid.uid_set = ugid.gid_set = FALSE;
5360 return_path = sender_address;
5361 enable_dollar_recipients = TRUE; /* Permit $recipients in system filter */
5362 system_filtering = TRUE;
5364 /* Any error in the filter file causes a delivery to be abandoned. */
5366 redirect.string = system_filter;
5367 redirect.isfile = TRUE;
5368 redirect.check_owner = redirect.check_group = FALSE;
5369 redirect.owners = NULL;
5370 redirect.owngroups = NULL;
5372 redirect.modemask = 0;
5374 DEBUG(D_deliver|D_filter) debug_printf("running system filter\n");
5377 &redirect, /* Where the data is */
5378 RDO_DEFER | /* Turn on all the enabling options */
5379 RDO_FAIL | /* Leave off all the disabling options */
5384 NULL, /* No :include: restriction (not used in filter) */
5385 NULL, /* No sieve vacation directory (not sieve!) */
5386 NULL, /* No sieve enotify mailto owner (not sieve!) */
5387 NULL, /* No sieve user address (not sieve!) */
5388 NULL, /* No sieve subaddress (not sieve!) */
5389 &ugid, /* uid/gid data */
5390 &addr_new, /* Where to hang generated addresses */
5391 &filter_message, /* Where to put error message */
5392 NULL, /* Don't skip syntax errors */
5393 &filtertype, /* Will always be set to FILTER_EXIM for this call */
5394 US"system filter"); /* For error messages */
5396 DEBUG(D_deliver|D_filter) debug_printf("system filter returned %d\n", rc);
5398 if (rc == FF_ERROR || rc == FF_NONEXIST)
5400 (void)close(deliver_datafile);
5401 deliver_datafile = -1;
5402 log_write(0, LOG_MAIN|LOG_PANIC, "Error in system filter: %s",
5403 string_printing(filter_message));
5404 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5407 /* Reset things. If the filter message is an empty string, which can happen
5408 for a filter "fail" or "freeze" command with no text, reset it to NULL. */
5410 system_filtering = FALSE;
5411 enable_dollar_recipients = FALSE;
5412 if (filter_message && filter_message[0] == 0) filter_message = NULL;
5414 /* Save the values of the system filter variables so that user filters
5417 memcpy(filter_sn, filter_n, sizeof(filter_sn));
5419 /* The filter can request that delivery of the original addresses be
5424 process_recipients = RECIP_DEFER;
5425 deliver_msglog("Delivery deferred by system filter\n");
5426 log_write(0, LOG_MAIN, "Delivery deferred by system filter");
5429 /* The filter can request that a message be frozen, but this does not
5430 take place if the message has been manually thawed. In that case, we must
5431 unset "delivered", which is forced by the "freeze" command to make -bF
5434 else if (rc == FF_FREEZE && !deliver_manual_thaw)
5436 deliver_freeze = TRUE;
5437 deliver_frozen_at = time(NULL);
5438 process_recipients = RECIP_DEFER;
5439 frozen_info = string_sprintf(" by the system filter%s%s",
5440 filter_message ? US": " : US"",
5441 filter_message ? filter_message : US"");
5444 /* The filter can request that a message be failed. The error message may be
5445 quite long - it is sent back to the sender in the bounce - but we don't want
5446 to fill up the log with repetitions of it. If it starts with << then the text
5447 between << and >> is written to the log, with the rest left for the bounce
5450 else if (rc == FF_FAIL)
5452 uschar *colon = US"";
5453 uschar *logmsg = US"";
5456 process_recipients = RECIP_FAIL_FILTER;
5462 if ( filter_message[0] == '<'
5463 && filter_message[1] == '<'
5464 && (logend = Ustrstr(filter_message, ">>"))
5467 logmsg = filter_message + 2;
5468 loglen = logend - logmsg;
5469 filter_message = logend + 2;
5470 if (filter_message[0] == 0) filter_message = NULL;
5474 logmsg = filter_message;
5475 loglen = Ustrlen(filter_message);
5479 log_write(0, LOG_MAIN, "cancelled by system filter%s%.*s", colon, loglen,
5483 /* Delivery can be restricted only to those recipients (if any) that the
5484 filter specified. */
5486 else if (rc == FF_DELIVERED)
5488 process_recipients = RECIP_IGNORE;
5490 log_write(0, LOG_MAIN, "original recipients ignored (system filter)");
5492 log_write(0, LOG_MAIN, "=> discarded (system filter)");
5495 /* If any new addresses were created by the filter, fake up a "parent"
5496 for them. This is necessary for pipes, etc., which are expected to have
5497 parents, and it also gives some sensible logging for others. Allow
5498 pipes, files, and autoreplies, and run them as the filter uid if set,
5499 otherwise as the current uid. */
5503 int uid = (system_filter_uid_set)? system_filter_uid : geteuid();
5504 int gid = (system_filter_gid_set)? system_filter_gid : getegid();
5506 /* The text "system-filter" is tested in transport_set_up_command() and in
5507 set_up_shell_command() in the pipe transport, to enable them to permit
5508 $recipients, so don't change it here without also changing it there. */
5510 address_item *p = addr_new;
5511 address_item *parent = deliver_make_addr(US"system-filter", FALSE);
5513 parent->domain = string_copylc(qualify_domain_recipient);
5514 parent->local_part = US"system-filter";
5516 /* As part of this loop, we arrange for addr_last to end up pointing
5517 at the final address. This is used if we go on to add addresses for the
5518 original recipients. */
5522 if (parent->child_count == SHRT_MAX)
5523 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "system filter generated more "
5524 "than %d delivery addresses", SHRT_MAX);
5525 parent->child_count++;
5528 if (testflag(p, af_pfr))
5534 setflag(p, af_uid_set |
5540 /* Find the name of the system filter's appropriate pfr transport */
5542 if (p->address[0] == '|')
5545 tpname = system_filter_pipe_transport;
5546 address_pipe = p->address;
5548 else if (p->address[0] == '>')
5551 tpname = system_filter_reply_transport;
5555 if (p->address[Ustrlen(p->address)-1] == '/')
5557 type = US"directory";
5558 tpname = system_filter_directory_transport;
5563 tpname = system_filter_file_transport;
5565 address_file = p->address;
5568 /* Now find the actual transport, first expanding the name. We have
5569 set address_file or address_pipe above. */
5573 uschar *tmp = expand_string(tpname);
5574 address_file = address_pipe = NULL;
5576 p->message = string_sprintf("failed to expand \"%s\" as a "
5577 "system filter transport name", tpname);
5582 p->message = string_sprintf("system_filter_%s_transport is unset",
5588 transport_instance *tp;
5589 for (tp = transports; tp; tp = tp->next)
5591 if (Ustrcmp(tp->name, tpname) == 0)
5598 p->message = string_sprintf("failed to find \"%s\" transport "
5599 "for system filter delivery", tpname);
5602 /* If we couldn't set up a transport, defer the delivery, putting the
5603 error on the panic log as well as the main log. */
5607 address_item *badp = p;
5609 if (!addr_last) addr_new = p; else addr_last->next = p;
5610 badp->local_part = badp->address; /* Needed for log line */
5611 post_process_one(badp, DEFER, LOG_MAIN|LOG_PANIC, DTYPE_ROUTER, 0);
5614 } /* End of pfr handling */
5616 /* Either a non-pfr delivery, or we found a transport */
5618 DEBUG(D_deliver|D_filter)
5619 debug_printf("system filter added %s\n", p->address);
5623 } /* Loop through all addr_new addresses */
5628 /* Scan the recipients list, and for every one that is not in the non-
5629 recipients tree, add an addr item to the chain of new addresses. If the pno
5630 value is non-negative, we must set the onetime parent from it. This which
5631 points to the relevant entry in the recipients list.
5633 This processing can be altered by the setting of the process_recipients
5634 variable, which is changed if recipients are to be ignored, failed, or
5635 deferred. This can happen as a result of system filter activity, or if the -Mg
5636 option is used to fail all of them.
5638 Duplicate addresses are handled later by a different tree structure; we can't
5639 just extend the non-recipients tree, because that will be re-written to the
5640 spool if the message is deferred, and in any case there are casing
5641 complications for local addresses. */
5643 if (process_recipients != RECIP_IGNORE)
5645 for (i = 0; i < recipients_count; i++)
5647 if (!tree_search(tree_nonrecipients, recipients_list[i].address))
5649 recipient_item *r = recipients_list + i;
5650 address_item *new = deliver_make_addr(r->address, FALSE);
5651 new->prop.errors_address = r->errors_to;
5652 #ifdef EXPERIMENTAL_INTERNATIONAL
5653 if ((new->prop.utf8_msg = message_smtputf8))
5655 new->prop.utf8_downcvt = message_utf8_downconvert == 1;
5656 new->prop.utf8_downcvt_maybe = message_utf8_downconvert == -1;
5657 DEBUG(D_deliver) debug_printf("utf8, downconvert %s\n",
5658 new->prop.utf8_downcvt ? "yes"
5659 : new->prop.utf8_downcvt_maybe ? "ifneeded"
5665 new->onetime_parent = recipients_list[r->pno].address;
5667 /* If DSN support is enabled, set the dsn flags and the original receipt
5668 to be passed on to other DSN enabled MTAs */
5669 new->dsn_flags = r->dsn_flags & rf_dsnflags;
5670 new->dsn_orcpt = r->orcpt;
5671 DEBUG(D_deliver) debug_printf("DSN: set orcpt: %s flags: %d\n",
5672 new->dsn_orcpt, new->dsn_flags);
5674 switch (process_recipients)
5676 /* RECIP_DEFER is set when a system filter freezes a message. */
5679 new->next = addr_defer;
5684 /* RECIP_FAIL_FILTER is set when a system filter has obeyed a "fail"
5687 case RECIP_FAIL_FILTER:
5689 filter_message ? filter_message : US"delivery cancelled";
5690 setflag(new, af_pass_message);
5691 goto RECIP_QUEUE_FAILED; /* below */
5694 /* RECIP_FAIL_TIMEOUT is set when a message is frozen, but is older
5695 than the value in timeout_frozen_after. Treat non-bounce messages
5696 similarly to -Mg; for bounce messages we just want to discard, so
5697 don't put the address on the failed list. The timeout has already
5700 case RECIP_FAIL_TIMEOUT:
5701 new->message = US"delivery cancelled; message timed out";
5702 goto RECIP_QUEUE_FAILED; /* below */
5705 /* RECIP_FAIL is set when -Mg has been used. */
5708 new->message = US"delivery cancelled by administrator";
5711 /* Common code for the failure cases above. If this is not a bounce
5712 message, put the address on the failed list so that it is used to
5713 create a bounce. Otherwise do nothing - this just discards the address.
5714 The incident has already been logged. */
5717 if (sender_address[0] != 0)
5719 new->next = addr_failed;
5725 /* RECIP_FAIL_LOOP is set when there are too many Received: headers
5726 in the message. Process each address as a routing failure; if this
5727 is a bounce message, it will get frozen. */
5729 case RECIP_FAIL_LOOP:
5730 new->message = US"Too many \"Received\" headers - suspected mail loop";
5731 post_process_one(new, FAIL, LOG_MAIN, DTYPE_ROUTER, 0);
5735 /* Value should be RECIP_ACCEPT; take this as the safe default. */
5738 if (!addr_new) addr_new = new; else addr_last->next = new;
5743 #ifdef EXPERIMENTAL_EVENT
5744 if (process_recipients != RECIP_ACCEPT)
5746 uschar * save_local = deliver_localpart;
5747 const uschar * save_domain = deliver_domain;
5749 deliver_localpart = expand_string(
5750 string_sprintf("${local_part:%s}", new->address));
5751 deliver_domain = expand_string(
5752 string_sprintf("${domain:%s}", new->address));
5754 (void) event_raise(event_action,
5755 US"msg:fail:internal", new->message);
5757 deliver_localpart = save_local;
5758 deliver_domain = save_domain;
5768 debug_printf("Delivery address list:\n");
5769 for (p = addr_new; p; p = p->next)
5770 debug_printf(" %s %s\n", p->address,
5771 p->onetime_parent ? p->onetime_parent : US"");
5774 /* Set up the buffers used for copying over the file when delivering. */
5776 deliver_in_buffer = store_malloc(DELIVER_IN_BUFFER_SIZE);
5777 deliver_out_buffer = store_malloc(DELIVER_OUT_BUFFER_SIZE);
5781 /* Until there are no more new addresses, handle each one as follows:
5783 . If this is a generated address (indicated by the presence of a parent
5784 pointer) then check to see whether it is a pipe, file, or autoreply, and
5785 if so, handle it directly here. The router that produced the address will
5786 have set the allow flags into the address, and also set the uid/gid required.
5787 Having the routers generate new addresses and then checking them here at
5788 the outer level is tidier than making each router do the checking, and
5789 means that routers don't need access to the failed address queue.
5791 . Break up the address into local part and domain, and make lowercased
5792 versions of these strings. We also make unquoted versions of the local part.
5794 . Handle the percent hack for those domains for which it is valid.
5796 . For child addresses, determine if any of the parents have the same address.
5797 If so, generate a different string for previous delivery checking. Without
5798 this code, if the address spqr generates spqr via a forward or alias file,
5799 delivery of the generated spqr stops further attempts at the top level spqr,
5800 which is not what is wanted - it may have generated other addresses.
5802 . Check on the retry database to see if routing was previously deferred, but
5803 only if in a queue run. Addresses that are to be routed are put on the
5804 addr_route chain. Addresses that are to be deferred are put on the
5805 addr_defer chain. We do all the checking first, so as not to keep the
5806 retry database open any longer than necessary.
5808 . Now we run the addresses through the routers. A router may put the address
5809 on either the addr_local or the addr_remote chain for local or remote
5810 delivery, respectively, or put it on the addr_failed chain if it is
5811 undeliveable, or it may generate child addresses and put them on the
5812 addr_new chain, or it may defer an address. All the chain anchors are
5813 passed as arguments so that the routers can be called for verification
5816 . If new addresses have been generated by the routers, da capo.
5819 header_rewritten = FALSE; /* No headers rewritten yet */
5820 while (addr_new) /* Loop until all addresses dealt with */
5822 address_item *addr, *parent;
5824 /* Failure to open the retry database is treated the same as if it does
5825 not exist. In both cases, dbm_file is NULL. */
5827 if (!(dbm_file = dbfn_open(US"retry", O_RDONLY, &dbblock, FALSE)))
5829 DEBUG(D_deliver|D_retry|D_route|D_hints_lookup)
5830 debug_printf("no retry data available\n");
5833 /* Scan the current batch of new addresses, to handle pipes, files and
5834 autoreplies, and determine which others are ready for routing. */
5841 dbdata_retry *domain_retry_record;
5842 dbdata_retry *address_retry_record;
5845 addr_new = addr->next;
5847 DEBUG(D_deliver|D_retry|D_route)
5849 debug_printf(">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>\n");
5850 debug_printf("Considering: %s\n", addr->address);
5853 /* Handle generated address that is a pipe or a file or an autoreply. */
5855 if (testflag(addr, af_pfr))
5857 /* If an autoreply in a filter could not generate a syntactically valid
5858 address, give up forthwith. Set af_ignore_error so that we don't try to
5859 generate a bounce. */
5861 if (testflag(addr, af_bad_reply))
5863 addr->basic_errno = ERRNO_BADADDRESS2;
5864 addr->local_part = addr->address;
5866 US"filter autoreply generated syntactically invalid recipient";
5867 setflag(addr, af_ignore_error);
5868 (void)post_process_one(addr, FAIL, LOG_MAIN, DTYPE_ROUTER, 0);
5869 continue; /* with the next new address */
5872 /* If two different users specify delivery to the same pipe or file or
5873 autoreply, there should be two different deliveries, so build a unique
5874 string that incorporates the original address, and use this for
5875 duplicate testing and recording delivery, and also for retrying. */
5878 string_sprintf("%s:%s", addr->address, addr->parent->unique +
5879 (testflag(addr->parent, af_homonym)? 3:0));
5881 addr->address_retry_key = addr->domain_retry_key =
5882 string_sprintf("T:%s", addr->unique);
5884 /* If a filter file specifies two deliveries to the same pipe or file,
5885 we want to de-duplicate, but this is probably not wanted for two mail
5886 commands to the same address, where probably both should be delivered.
5887 So, we have to invent a different unique string in that case. Just
5888 keep piling '>' characters on the front. */
5890 if (addr->address[0] == '>')
5892 while (tree_search(tree_duplicates, addr->unique))
5893 addr->unique = string_sprintf(">%s", addr->unique);
5896 else if ((tnode = tree_search(tree_duplicates, addr->unique)))
5898 DEBUG(D_deliver|D_route)
5899 debug_printf("%s is a duplicate address: discarded\n", addr->address);
5900 addr->dupof = tnode->data.ptr;
5901 addr->next = addr_duplicate;
5902 addr_duplicate = addr;
5906 DEBUG(D_deliver|D_route) debug_printf("unique = %s\n", addr->unique);
5908 /* Check for previous delivery */
5910 if (tree_search(tree_nonrecipients, addr->unique))
5912 DEBUG(D_deliver|D_route)
5913 debug_printf("%s was previously delivered: discarded\n", addr->address);
5914 child_done(addr, tod_stamp(tod_log));
5918 /* Save for checking future duplicates */
5920 tree_add_duplicate(addr->unique, addr);
5922 /* Set local part and domain */
5924 addr->local_part = addr->address;
5925 addr->domain = addr->parent->domain;
5927 /* Ensure that the delivery is permitted. */
5929 if (testflag(addr, af_file))
5931 if (!testflag(addr, af_allow_file))
5933 addr->basic_errno = ERRNO_FORBIDFILE;
5934 addr->message = US"delivery to file forbidden";
5935 (void)post_process_one(addr, FAIL, LOG_MAIN, DTYPE_ROUTER, 0);
5936 continue; /* with the next new address */
5939 else if (addr->address[0] == '|')
5941 if (!testflag(addr, af_allow_pipe))
5943 addr->basic_errno = ERRNO_FORBIDPIPE;
5944 addr->message = US"delivery to pipe forbidden";
5945 (void)post_process_one(addr, FAIL, LOG_MAIN, DTYPE_ROUTER, 0);
5946 continue; /* with the next new address */
5949 else if (!testflag(addr, af_allow_reply))
5951 addr->basic_errno = ERRNO_FORBIDREPLY;
5952 addr->message = US"autoreply forbidden";
5953 (void)post_process_one(addr, FAIL, LOG_MAIN, DTYPE_ROUTER, 0);
5954 continue; /* with the next new address */
5957 /* If the errno field is already set to BADTRANSPORT, it indicates
5958 failure to expand a transport string, or find the associated transport,
5959 or an unset transport when one is required. Leave this test till now so
5960 that the forbid errors are given in preference. */
5962 if (addr->basic_errno == ERRNO_BADTRANSPORT)
5964 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_ROUTER, 0);
5968 /* Treat /dev/null as a special case and abandon the delivery. This
5969 avoids having to specify a uid on the transport just for this case.
5970 Arrange for the transport name to be logged as "**bypassed**". */
5972 if (Ustrcmp(addr->address, "/dev/null") == 0)
5974 uschar *save = addr->transport->name;
5975 addr->transport->name = US"**bypassed**";
5976 (void)post_process_one(addr, OK, LOG_MAIN, DTYPE_TRANSPORT, '=');
5977 addr->transport->name = save;
5978 continue; /* with the next new address */
5981 /* Pipe, file, or autoreply delivery is to go ahead as a normal local
5984 DEBUG(D_deliver|D_route)
5985 debug_printf("queued for %s transport\n", addr->transport->name);
5986 addr->next = addr_local;
5988 continue; /* with the next new address */
5991 /* Handle normal addresses. First, split up into local part and domain,
5992 handling the %-hack if necessary. There is the possibility of a defer from
5993 a lookup in percent_hack_domains. */
5995 if ((rc = deliver_split_address(addr)) == DEFER)
5997 addr->message = US"cannot check percent_hack_domains";
5998 addr->basic_errno = ERRNO_LISTDEFER;
5999 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_NONE, 0);
6003 /* Check to see if the domain is held. If so, proceed only if the
6004 delivery was forced by hand. */
6006 deliver_domain = addr->domain; /* set $domain */
6007 if ( !forced && hold_domains
6008 && (rc = match_isinlist(addr->domain, (const uschar **)&hold_domains, 0,
6009 &domainlist_anchor, addr->domain_cache, MCL_DOMAIN, TRUE,
6015 addr->message = US"hold_domains lookup deferred";
6016 addr->basic_errno = ERRNO_LISTDEFER;
6020 addr->message = US"domain is held";
6021 addr->basic_errno = ERRNO_HELD;
6023 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_NONE, 0);
6027 /* Now we can check for duplicates and previously delivered addresses. In
6028 order to do this, we have to generate a "unique" value for each address,
6029 because there may be identical actual addresses in a line of descendents.
6030 The "unique" field is initialized to the same value as the "address" field,
6031 but gets changed here to cope with identically-named descendents. */
6033 for (parent = addr->parent; parent; parent = parent->parent)
6034 if (strcmpic(addr->address, parent->address) == 0) break;
6036 /* If there's an ancestor with the same name, set the homonym flag. This
6037 influences how deliveries are recorded. Then add a prefix on the front of
6038 the unique address. We use \n\ where n starts at 0 and increases each time.
6039 It is unlikely to pass 9, but if it does, it may look odd but will still
6040 work. This means that siblings or cousins with the same names are treated
6041 as duplicates, which is what we want. */
6045 setflag(addr, af_homonym);
6046 if (parent->unique[0] != '\\')
6047 addr->unique = string_sprintf("\\0\\%s", addr->address);
6049 addr->unique = string_sprintf("\\%c\\%s", parent->unique[1] + 1,
6053 /* Ensure that the domain in the unique field is lower cased, because
6054 domains are always handled caselessly. */
6056 p = Ustrrchr(addr->unique, '@');
6057 while (*p != 0) { *p = tolower(*p); p++; }
6059 DEBUG(D_deliver|D_route) debug_printf("unique = %s\n", addr->unique);
6061 if (tree_search(tree_nonrecipients, addr->unique))
6063 DEBUG(D_deliver|D_route)
6064 debug_printf("%s was previously delivered: discarded\n", addr->unique);
6065 child_done(addr, tod_stamp(tod_log));
6069 /* Get the routing retry status, saving the two retry keys (with and
6070 without the local part) for subsequent use. If there is no retry record for
6071 the standard address routing retry key, we look for the same key with the
6072 sender attached, because this form is used by the smtp transport after a
6073 4xx response to RCPT when address_retry_include_sender is true. */
6075 addr->domain_retry_key = string_sprintf("R:%s", addr->domain);
6076 addr->address_retry_key = string_sprintf("R:%s@%s", addr->local_part,
6081 domain_retry_record = dbfn_read(dbm_file, addr->domain_retry_key);
6082 if ( domain_retry_record
6083 && now - domain_retry_record->time_stamp > retry_data_expire
6085 domain_retry_record = NULL; /* Ignore if too old */
6087 address_retry_record = dbfn_read(dbm_file, addr->address_retry_key);
6088 if ( address_retry_record
6089 && now - address_retry_record->time_stamp > retry_data_expire
6091 address_retry_record = NULL; /* Ignore if too old */
6093 if (!address_retry_record)
6095 uschar *altkey = string_sprintf("%s:<%s>", addr->address_retry_key,
6097 address_retry_record = dbfn_read(dbm_file, altkey);
6098 if ( address_retry_record
6099 && now - address_retry_record->time_stamp > retry_data_expire)
6100 address_retry_record = NULL; /* Ignore if too old */
6104 domain_retry_record = address_retry_record = NULL;
6106 DEBUG(D_deliver|D_retry)
6108 if (!domain_retry_record)
6109 debug_printf("no domain retry record\n");
6110 if (!address_retry_record)
6111 debug_printf("no address retry record\n");
6114 /* If we are sending a message down an existing SMTP connection, we must
6115 assume that the message which created the connection managed to route
6116 an address to that connection. We do not want to run the risk of taking
6117 a long time over routing here, because if we do, the server at the other
6118 end of the connection may time it out. This is especially true for messages
6119 with lots of addresses. For this kind of delivery, queue_running is not
6120 set, so we would normally route all addresses. We take a pragmatic approach
6121 and defer routing any addresses that have any kind of domain retry record.
6122 That is, we don't even look at their retry times. It doesn't matter if this
6123 doesn't work occasionally. This is all just an optimization, after all.
6125 The reason for not doing the same for address retries is that they normally
6126 arise from 4xx responses, not DNS timeouts. */
6128 if (continue_hostname && domain_retry_record)
6130 addr->message = US"reusing SMTP connection skips previous routing defer";
6131 addr->basic_errno = ERRNO_RRETRY;
6132 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_ROUTER, 0);
6135 /* If we are in a queue run, defer routing unless there is no retry data or
6136 we've passed the next retry time, or this message is forced. In other
6137 words, ignore retry data when not in a queue run.
6139 However, if the domain retry time has expired, always allow the routing
6140 attempt. If it fails again, the address will be failed. This ensures that
6141 each address is routed at least once, even after long-term routing
6144 If there is an address retry, check that too; just wait for the next
6145 retry time. This helps with the case when the temporary error on the
6146 address was really message-specific rather than address specific, since
6147 it allows other messages through.
6149 We also wait for the next retry time if this is a message sent down an
6150 existing SMTP connection (even though that will be forced). Otherwise there
6151 will be far too many attempts for an address that gets a 4xx error. In
6152 fact, after such an error, we should not get here because, the host should
6153 not be remembered as one this message needs. However, there was a bug that
6154 used to cause this to happen, so it is best to be on the safe side.
6156 Even if we haven't reached the retry time in the hints, there is one more
6157 check to do, which is for the ultimate address timeout. We only do this
6158 check if there is an address retry record and there is not a domain retry
6159 record; this implies that previous attempts to handle the address had the
6160 retry_use_local_parts option turned on. We use this as an approximation
6161 for the destination being like a local delivery, for example delivery over
6162 LMTP to an IMAP message store. In this situation users are liable to bump
6163 into their quota and thereby have intermittently successful deliveries,
6164 which keep the retry record fresh, which can lead to us perpetually
6165 deferring messages. */
6167 else if ( ( queue_running && !deliver_force
6168 || continue_hostname
6170 && ( ( domain_retry_record
6171 && now < domain_retry_record->next_try
6172 && !domain_retry_record->expired
6174 || ( address_retry_record
6175 && now < address_retry_record->next_try
6177 && ( domain_retry_record
6178 || !address_retry_record
6179 || !retry_ultimate_address_timeout(addr->address_retry_key,
6180 addr->domain, address_retry_record, now)
6183 addr->message = US"retry time not reached";
6184 addr->basic_errno = ERRNO_RRETRY;
6185 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_ROUTER, 0);
6188 /* The domain is OK for routing. Remember if retry data exists so it
6189 can be cleaned up after a successful delivery. */
6193 if (domain_retry_record || address_retry_record)
6194 setflag(addr, af_dr_retry_exists);
6195 addr->next = addr_route;
6197 DEBUG(D_deliver|D_route)
6198 debug_printf("%s: queued for routing\n", addr->address);
6202 /* The database is closed while routing is actually happening. Requests to
6203 update it are put on a chain and all processed together at the end. */
6205 if (dbm_file) dbfn_close(dbm_file);
6207 /* If queue_domains is set, we don't even want to try routing addresses in
6208 those domains. During queue runs, queue_domains is forced to be unset.
6209 Optimize by skipping this pass through the addresses if nothing is set. */
6211 if (!deliver_force && queue_domains)
6213 address_item *okaddr = NULL;
6216 address_item *addr = addr_route;
6217 addr_route = addr->next;
6219 deliver_domain = addr->domain; /* set $domain */
6220 if ((rc = match_isinlist(addr->domain, (const uschar **)&queue_domains, 0,
6221 &domainlist_anchor, addr->domain_cache, MCL_DOMAIN, TRUE, NULL))
6226 addr->basic_errno = ERRNO_LISTDEFER;
6227 addr->message = US"queue_domains lookup deferred";
6228 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_ROUTER, 0);
6232 addr->next = okaddr;
6238 addr->basic_errno = ERRNO_QUEUE_DOMAIN;
6239 addr->message = US"domain is in queue_domains";
6240 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_ROUTER, 0);
6244 addr_route = okaddr;
6247 /* Now route those addresses that are not deferred. */
6252 address_item *addr = addr_route;
6253 const uschar *old_domain = addr->domain;
6254 uschar *old_unique = addr->unique;
6255 addr_route = addr->next;
6258 /* Just in case some router parameter refers to it. */
6260 if (!(return_path = addr->prop.errors_address))
6261 return_path = sender_address;
6263 /* If a router defers an address, add a retry item. Whether or not to
6264 use the local part in the key is a property of the router. */
6266 if ((rc = route_address(addr, &addr_local, &addr_remote, &addr_new,
6267 &addr_succeed, v_none)) == DEFER)
6268 retry_add_item(addr,
6269 addr->router->retry_use_local_part
6270 ? string_sprintf("R:%s@%s", addr->local_part, addr->domain)
6271 : string_sprintf("R:%s", addr->domain),
6274 /* Otherwise, if there is an existing retry record in the database, add
6275 retry items to delete both forms. We must also allow for the possibility
6276 of a routing retry that includes the sender address. Since the domain might
6277 have been rewritten (expanded to fully qualified) as a result of routing,
6278 ensure that the rewritten form is also deleted. */
6280 else if (testflag(addr, af_dr_retry_exists))
6282 uschar *altkey = string_sprintf("%s:<%s>", addr->address_retry_key,
6284 retry_add_item(addr, altkey, rf_delete);
6285 retry_add_item(addr, addr->address_retry_key, rf_delete);
6286 retry_add_item(addr, addr->domain_retry_key, rf_delete);
6287 if (Ustrcmp(addr->domain, old_domain) != 0)
6288 retry_add_item(addr, string_sprintf("R:%s", old_domain), rf_delete);
6291 /* DISCARD is given for :blackhole: and "seen finish". The event has been
6292 logged, but we need to ensure the address (and maybe parents) is marked
6297 address_done(addr, tod_stamp(tod_log));
6298 continue; /* route next address */
6301 /* The address is finished with (failed or deferred). */
6305 (void)post_process_one(addr, rc, LOG_MAIN, DTYPE_ROUTER, 0);
6306 continue; /* route next address */
6309 /* The address has been routed. If the router changed the domain, it will
6310 also have changed the unique address. We have to test whether this address
6311 has already been delivered, because it's the unique address that finally
6314 if ( addr->unique != old_unique
6315 && tree_search(tree_nonrecipients, addr->unique) != 0
6318 DEBUG(D_deliver|D_route) debug_printf("%s was previously delivered: "
6319 "discarded\n", addr->address);
6320 if (addr_remote == addr) addr_remote = addr->next;
6321 else if (addr_local == addr) addr_local = addr->next;
6324 /* If the router has same_domain_copy_routing set, we are permitted to copy
6325 the routing for any other addresses with the same domain. This is an
6326 optimisation to save repeated DNS lookups for "standard" remote domain
6327 routing. The option is settable only on routers that generate host lists.
6328 We play it very safe, and do the optimization only if the address is routed
6329 to a remote transport, there are no header changes, and the domain was not
6330 modified by the router. */
6332 if ( addr_remote == addr
6333 && addr->router->same_domain_copy_routing
6334 && !addr->prop.extra_headers
6335 && !addr->prop.remove_headers
6336 && old_domain == addr->domain
6339 address_item **chain = &addr_route;
6342 address_item *addr2 = *chain;
6343 if (Ustrcmp(addr2->domain, addr->domain) != 0)
6345 chain = &(addr2->next);
6349 /* Found a suitable address; take it off the routing list and add it to
6350 the remote delivery list. */
6352 *chain = addr2->next;
6353 addr2->next = addr_remote;
6354 addr_remote = addr2;
6356 /* Copy the routing data */
6358 addr2->domain = addr->domain;
6359 addr2->router = addr->router;
6360 addr2->transport = addr->transport;
6361 addr2->host_list = addr->host_list;
6362 addr2->fallback_hosts = addr->fallback_hosts;
6363 addr2->prop.errors_address = addr->prop.errors_address;
6364 copyflag(addr2, addr, af_hide_child | af_local_host_removed);
6366 DEBUG(D_deliver|D_route)
6368 debug_printf(">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>\n"
6370 "Routing for %s copied from %s\n",
6371 addr2->address, addr2->address, addr->address);
6375 } /* Continue with routing the next address. */
6376 } /* Loop to process any child addresses that the routers created, and
6377 any rerouted addresses that got put back on the new chain. */
6380 /* Debugging: show the results of the routing */
6382 DEBUG(D_deliver|D_retry|D_route)
6385 debug_printf(">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>\n");
6386 debug_printf("After routing:\n Local deliveries:\n");
6387 for (p = addr_local; p; p = p->next)
6388 debug_printf(" %s\n", p->address);
6390 debug_printf(" Remote deliveries:\n");
6391 for (p = addr_remote; p; p = p->next)
6392 debug_printf(" %s\n", p->address);
6394 debug_printf(" Failed addresses:\n");
6395 for (p = addr_failed; p; p = p->next)
6396 debug_printf(" %s\n", p->address);
6398 debug_printf(" Deferred addresses:\n");
6399 for (p = addr_defer; p; p = p->next)
6400 debug_printf(" %s\n", p->address);
6403 /* Free any resources that were cached during routing. */
6408 /* These two variables are set only during routing, after check_local_user.
6409 Ensure they are not set in transports. */
6411 local_user_gid = (gid_t)(-1);
6412 local_user_uid = (uid_t)(-1);
6414 /* Check for any duplicate addresses. This check is delayed until after
6415 routing, because the flexibility of the routing configuration means that
6416 identical addresses with different parentage may end up being redirected to
6417 different addresses. Checking for duplicates too early (as we previously used
6418 to) makes this kind of thing not work. */
6420 do_duplicate_check(&addr_local);
6421 do_duplicate_check(&addr_remote);
6423 /* When acting as an MUA wrapper, we proceed only if all addresses route to a
6424 remote transport. The check that they all end up in one transaction happens in
6425 the do_remote_deliveries() function. */
6428 && (addr_local || addr_failed || addr_defer)
6432 uschar *which, *colon, *msg;
6439 else if (addr_defer)
6442 which = US"deferred";
6450 while (addr->parent) addr = addr->parent;
6455 msg = addr->message;
6457 else colon = msg = US"";
6459 /* We don't need to log here for a forced failure as it will already
6460 have been logged. Defer will also have been logged, but as a defer, so we do
6461 need to do the failure logging. */
6463 if (addr != addr_failed)
6464 log_write(0, LOG_MAIN, "** %s routing yielded a %s delivery",
6465 addr->address, which);
6467 /* Always write an error to the caller */
6469 fprintf(stderr, "routing %s yielded a %s delivery%s%s\n", addr->address,
6472 final_yield = DELIVER_MUA_FAILED;
6473 addr_failed = addr_defer = NULL; /* So that we remove the message */
6474 goto DELIVERY_TIDYUP;
6478 /* If this is a run to continue deliveries to an external channel that is
6479 already set up, defer any local deliveries. */
6481 if (continue_transport)
6485 address_item *addr = addr_defer;
6486 while (addr->next) addr = addr->next;
6487 addr->next = addr_local;
6490 addr_defer = addr_local;
6495 /* Because address rewriting can happen in the routers, we should not really do
6496 ANY deliveries until all addresses have been routed, so that all recipients of
6497 the message get the same headers. However, this is in practice not always
6498 possible, since sometimes remote addresses give DNS timeouts for days on end.
6499 The pragmatic approach is to deliver what we can now, saving any rewritten
6500 headers so that at least the next lot of recipients benefit from the rewriting
6501 that has already been done.
6503 If any headers have been rewritten during routing, update the spool file to
6504 remember them for all subsequent deliveries. This can be delayed till later if
6505 there is only address to be delivered - if it succeeds the spool write need not
6508 if ( header_rewritten
6510 && (addr_local->next || addr_remote)
6512 || (addr_remote && addr_remote->next)
6515 /* Panic-dies on error */
6516 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
6517 header_rewritten = FALSE;
6521 /* If there are any deliveries to be done, open the journal file. This is used
6522 to record successful deliveries as soon as possible after each delivery is
6523 known to be complete. A file opened with O_APPEND is used so that several
6524 processes can run simultaneously.
6526 The journal is just insurance against crashes. When the spool file is
6527 ultimately updated at the end of processing, the journal is deleted. If a
6528 journal is found to exist at the start of delivery, the addresses listed
6529 therein are added to the non-recipients. */
6531 if (addr_local || addr_remote)
6533 sprintf(CS spoolname, "%s/input/%s/%s-J", spool_directory, message_subdir, id);
6534 journal_fd = Uopen(spoolname, O_WRONLY|O_APPEND|O_CREAT, SPOOL_MODE);
6538 log_write(0, LOG_MAIN|LOG_PANIC, "Couldn't open journal file %s: %s",
6539 spoolname, strerror(errno));
6540 return DELIVER_NOT_ATTEMPTED;
6543 /* Set the close-on-exec flag, make the file owned by Exim, and ensure
6544 that the mode is correct - the group setting doesn't always seem to get
6545 set automatically. */
6547 if( fcntl(journal_fd, F_SETFD, fcntl(journal_fd, F_GETFD) | FD_CLOEXEC)
6548 || fchown(journal_fd, exim_uid, exim_gid)
6549 || fchmod(journal_fd, SPOOL_MODE)
6552 int ret = Uunlink(spoolname);
6553 log_write(0, LOG_MAIN|LOG_PANIC, "Couldn't set perms on journal file %s: %s",
6554 spoolname, strerror(errno));
6555 if(ret && errno != ENOENT)
6556 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s",
6557 spoolname, strerror(errno));
6558 return DELIVER_NOT_ATTEMPTED;
6564 /* Now we can get down to the business of actually doing deliveries. Local
6565 deliveries are done first, then remote ones. If ever the problems of how to
6566 handle fallback transports are figured out, this section can be put into a loop
6567 for handling fallbacks, though the uid switching will have to be revised. */
6569 /* Precompile a regex that is used to recognize a parameter in response
6570 to an LHLO command, if is isn't already compiled. This may be used on both
6571 local and remote LMTP deliveries. */
6573 if (!regex_IGNOREQUOTA)
6575 regex_must_compile(US"\\n250[\\s\\-]IGNOREQUOTA(\\s|\\n|$)", FALSE, TRUE);
6577 /* Handle local deliveries */
6581 DEBUG(D_deliver|D_transport)
6582 debug_printf(">>>>>>>>>>>>>>>> Local deliveries >>>>>>>>>>>>>>>>\n");
6583 do_local_deliveries();
6584 disable_logging = FALSE;
6587 /* If queue_run_local is set, we do not want to attempt any remote deliveries,
6588 so just queue them all. */
6590 if (queue_run_local)
6594 address_item *addr = addr_remote;
6595 addr_remote = addr->next;
6597 addr->basic_errno = ERRNO_LOCAL_ONLY;
6598 addr->message = US"remote deliveries suppressed";
6599 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_TRANSPORT, 0);
6603 /* Handle remote deliveries */
6607 DEBUG(D_deliver|D_transport)
6608 debug_printf(">>>>>>>>>>>>>>>> Remote deliveries >>>>>>>>>>>>>>>>\n");
6610 /* Precompile some regex that are used to recognize parameters in response
6611 to an EHLO command, if they aren't already compiled. */
6615 /* Now sort the addresses if required, and do the deliveries. The yield of
6616 do_remote_deliveries is FALSE when mua_wrapper is set and all addresses
6617 cannot be delivered in one transaction. */
6619 if (remote_sort_domains) sort_remote_deliveries();
6620 if (!do_remote_deliveries(FALSE))
6622 log_write(0, LOG_MAIN, "** mua_wrapper is set but recipients cannot all "
6623 "be delivered in one transaction");
6624 fprintf(stderr, "delivery to smarthost failed (configuration problem)\n");
6626 final_yield = DELIVER_MUA_FAILED;
6627 addr_failed = addr_defer = NULL; /* So that we remove the message */
6628 goto DELIVERY_TIDYUP;
6631 /* See if any of the addresses that failed got put on the queue for delivery
6632 to their fallback hosts. We do it this way because often the same fallback
6633 host is used for many domains, so all can be sent in a single transaction
6634 (if appropriately configured). */
6636 if (addr_fallback && !mua_wrapper)
6638 DEBUG(D_deliver) debug_printf("Delivering to fallback hosts\n");
6639 addr_remote = addr_fallback;
6640 addr_fallback = NULL;
6641 if (remote_sort_domains) sort_remote_deliveries();
6642 do_remote_deliveries(TRUE);
6644 disable_logging = FALSE;
6648 /* All deliveries are now complete. Ignore SIGTERM during this tidying up
6649 phase, to minimize cases of half-done things. */
6652 debug_printf(">>>>>>>>>>>>>>>> deliveries are done >>>>>>>>>>>>>>>>\n");
6654 /* Root privilege is no longer needed */
6656 exim_setugid(exim_uid, exim_gid, FALSE, US"post-delivery tidying");
6658 set_process_info("tidying up after delivering %s", message_id);
6659 signal(SIGTERM, SIG_IGN);
6661 /* When we are acting as an MUA wrapper, the smtp transport will either have
6662 succeeded for all addresses, or failed them all in normal cases. However, there
6663 are some setup situations (e.g. when a named port does not exist) that cause an
6664 immediate exit with deferral of all addresses. Convert those into failures. We
6665 do not ever want to retry, nor do we want to send a bounce message. */
6671 address_item *addr, *nextaddr;
6672 for (addr = addr_defer; addr; addr = nextaddr)
6674 log_write(0, LOG_MAIN, "** %s mua_wrapper forced failure for deferred "
6675 "delivery", addr->address);
6676 nextaddr = addr->next;
6677 addr->next = addr_failed;
6683 /* Now all should either have succeeded or failed. */
6686 final_yield = DELIVER_MUA_SUCCEEDED;
6690 uschar *s = addr_failed->user_message;
6692 if (!s) s = addr_failed->message;
6694 fprintf(stderr, "Delivery failed: ");
6695 if (addr_failed->basic_errno > 0)
6697 fprintf(stderr, "%s", strerror(addr_failed->basic_errno));
6698 if (s) fprintf(stderr, ": ");
6700 if ((host = addr_failed->host_used))
6701 fprintf(stderr, "H=%s [%s]: ", host->name, host->address);
6703 fprintf(stderr, "%s", CS s);
6704 else if (addr_failed->basic_errno <= 0)
6705 fprintf(stderr, "unknown error");
6706 fprintf(stderr, "\n");
6708 final_yield = DELIVER_MUA_FAILED;
6713 /* In a normal configuration, we now update the retry database. This is done in
6714 one fell swoop at the end in order not to keep opening and closing (and
6715 locking) the database. The code for handling retries is hived off into a
6716 separate module for convenience. We pass it the addresses of the various
6717 chains, because deferred addresses can get moved onto the failed chain if the
6718 retry cutoff time has expired for all alternative destinations. Bypass the
6719 updating of the database if the -N flag is set, which is a debugging thing that
6720 prevents actual delivery. */
6722 else if (!dont_deliver)
6723 retry_update(&addr_defer, &addr_failed, &addr_succeed);
6725 /* Send DSN for successful messages */
6726 addr_dsntmp = addr_succeed;
6727 addr_senddsn = NULL;
6731 /* af_ignore_error not honored here. it's not an error */
6734 debug_printf("DSN: processing router : %s\n"
6735 "DSN: processing successful delivery address: %s\n"
6736 "DSN: Sender_address: %s\n"
6737 "DSN: orcpt: %s flags: %d\n"
6738 "DSN: envid: %s ret: %d\n"
6739 "DSN: Final recipient: %s\n"
6740 "DSN: Remote SMTP server supports DSN: %d\n",
6741 addr_dsntmp->router->name,
6742 addr_dsntmp->address,
6744 addr_dsntmp->dsn_orcpt, addr_dsntmp->dsn_flags,
6746 addr_dsntmp->address,
6747 addr_dsntmp->dsn_aware
6751 /* send report if next hop not DSN aware or a router flagged "last DSN hop"
6752 and a report was requested */
6753 if ( ( addr_dsntmp->dsn_aware != dsn_support_yes
6754 || addr_dsntmp->dsn_flags & rf_dsnlasthop
6756 && addr_dsntmp->dsn_flags & rf_dsnflags
6757 && addr_dsntmp->dsn_flags & rf_notify_success
6760 /* copy and relink address_item and send report with all of them at once later */
6761 address_item *addr_next;
6762 addr_next = addr_senddsn;
6763 addr_senddsn = store_get(sizeof(address_item));
6764 memcpy(addr_senddsn, addr_dsntmp, sizeof(address_item));
6765 addr_senddsn->next = addr_next;
6768 DEBUG(D_deliver) debug_printf("DSN: not sending DSN success message\n");
6770 addr_dsntmp = addr_dsntmp->next;
6778 /* create exim process to send message */
6779 pid = child_open_exim(&fd);
6781 DEBUG(D_deliver) debug_printf("DSN: child_open_exim returns: %d\n", pid);
6783 if (pid < 0) /* Creation of child failed */
6785 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Process %d (parent %d) failed to "
6786 "create child process to send failure message: %s", getpid(),
6787 getppid(), strerror(errno));
6789 DEBUG(D_deliver) debug_printf("DSN: child_open_exim failed\n");
6791 else /* Creation of child succeeded */
6793 FILE *f = fdopen(fd, "wb");
6794 /* header only as required by RFC. only failure DSN needs to honor RET=FULL */
6795 int topt = topt_add_return_path | topt_no_body;
6799 debug_printf("sending error message to: %s\n", sender_address);
6801 /* build unique id for MIME boundary */
6802 bound = string_sprintf(TIME_T_FMT "-eximdsn-%d", time(NULL), rand());
6803 DEBUG(D_deliver) debug_printf("DSN: MIME boundary: %s\n", bound);
6805 if (errors_reply_to)
6806 fprintf(f, "Reply-To: %s\n", errors_reply_to);
6808 fprintf(f, "Auto-Submitted: auto-generated\n"
6809 "From: Mail Delivery System <Mailer-Daemon@%s>\n"
6811 "Subject: Delivery Status Notification\n"
6812 "Content-Type: multipart/report; report-type=delivery-status; boundary=%s\n"
6813 "MIME-Version: 1.0\n\n"
6816 "Content-type: text/plain; charset=us-ascii\n\n"
6818 "This message was created automatically by mail delivery software.\n"
6819 " ----- The following addresses had successful delivery notifications -----\n",
6820 qualify_domain_sender, sender_address, bound, bound);
6822 for (addr_dsntmp = addr_senddsn; addr_dsntmp;
6823 addr_dsntmp = addr_dsntmp->next)
6824 fprintf(f, "<%s> (relayed %s)\n\n",
6825 addr_dsntmp->address,
6826 (addr_dsntmp->dsn_flags & rf_dsnlasthop) == 1
6827 ? "via non DSN router"
6828 : addr_dsntmp->dsn_aware == dsn_support_no
6829 ? "to non-DSN-aware mailer"
6830 : "via non \"Remote SMTP\" router"
6834 "Content-type: message/delivery-status\n\n"
6835 "Reporting-MTA: dns; %s\n",
6836 bound, smtp_active_hostname);
6839 { /* must be decoded from xtext: see RFC 3461:6.3a */
6841 if (auth_xtextdecode(dsn_envid, &xdec_envid) > 0)
6842 fprintf(f, "Original-Envelope-ID: %s\n", dsn_envid);
6844 fprintf(f, "X-Original-Envelope-ID: error decoding xtext formated ENVID\n");
6848 for (addr_dsntmp = addr_senddsn;
6850 addr_dsntmp = addr_dsntmp->next)
6852 if (addr_dsntmp->dsn_orcpt)
6853 fprintf(f,"Original-Recipient: %s\n", addr_dsntmp->dsn_orcpt);
6855 fprintf(f, "Action: delivered\n"
6856 "Final-Recipient: rfc822;%s\n"
6858 addr_dsntmp->address);
6860 if (addr_dsntmp->host_used && addr_dsntmp->host_used->name)
6861 fprintf(f, "Remote-MTA: dns; %s\nDiagnostic-Code: smtp; 250 Ok\n\n",
6862 addr_dsntmp->host_used->name);
6864 fprintf(f, "Diagnostic-Code: X-Exim; relayed via non %s router\n\n",
6865 (addr_dsntmp->dsn_flags & rf_dsnlasthop) == 1 ? "DSN" : "SMTP");
6868 fprintf(f, "--%s\nContent-type: text/rfc822-headers\n\n", bound);
6871 transport_filter_argv = NULL; /* Just in case */
6872 return_path = sender_address; /* In case not previously set */
6874 /* Write the original email out */
6875 transport_write_message(NULL, fileno(f), topt, 0, NULL, NULL, NULL, NULL, NULL, 0);
6878 fprintf(f,"\n--%s--\n", bound);
6882 rc = child_close(pid, 0); /* Waits for child to close, no timeout */
6886 /* If any addresses failed, we must send a message to somebody, unless
6887 af_ignore_error is set, in which case no action is taken. It is possible for
6888 several messages to get sent if there are addresses with different
6895 uschar *logtod = tod_stamp(tod_log);
6897 address_item *handled_addr = NULL;
6898 address_item **paddr;
6899 address_item *msgchain = NULL;
6900 address_item **pmsgchain = &msgchain;
6902 /* There are weird cases when logging is disabled in the transport. However,
6903 there may not be a transport (address failed by a router). */
6905 disable_logging = FALSE;
6906 if (addr_failed->transport)
6907 disable_logging = addr_failed->transport->disable_logging;
6910 debug_printf("processing failed address %s\n", addr_failed->address);
6912 /* There are only two ways an address in a bounce message can get here:
6914 (1) When delivery was initially deferred, but has now timed out (in the call
6915 to retry_update() above). We can detect this by testing for
6916 af_retry_timedout. If the address does not have its own errors address,
6917 we arrange to ignore the error.
6919 (2) If delivery failures for bounce messages are being ignored. We can detect
6920 this by testing for af_ignore_error. This will also be set if a bounce
6921 message has been autothawed and the ignore_bounce_errors_after time has
6922 passed. It might also be set if a router was explicitly configured to
6923 ignore errors (errors_to = "").
6925 If neither of these cases obtains, something has gone wrong. Log the
6926 incident, but then ignore the error. */
6928 if (sender_address[0] == 0 && !addr_failed->prop.errors_address)
6930 if ( !testflag(addr_failed, af_retry_timedout)
6931 && !testflag(addr_failed, af_ignore_error))
6933 log_write(0, LOG_MAIN|LOG_PANIC, "internal error: bounce message "
6934 "failure is neither frozen nor ignored (it's been ignored)");
6936 setflag(addr_failed, af_ignore_error);
6939 /* If the first address on the list has af_ignore_error set, just remove
6940 it from the list, throw away any saved message file, log it, and
6941 mark the recipient done. */
6943 if ( testflag(addr_failed, af_ignore_error)
6944 || ( addr_failed->dsn_flags & rf_dsnflags
6945 && (addr_failed->dsn_flags & rf_notify_failure) != rf_notify_failure
6949 addr_failed = addr->next;
6950 if (addr->return_filename) Uunlink(addr->return_filename);
6952 log_write(0, LOG_MAIN, "%s%s%s%s: error ignored",
6954 !addr->parent ? US"" : US" <",
6955 !addr->parent ? US"" : addr->parent->address,
6956 !addr->parent ? US"" : US">");
6958 address_done(addr, logtod);
6959 child_done(addr, logtod);
6960 /* Panic-dies on error */
6961 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
6964 /* Otherwise, handle the sending of a message. Find the error address for
6965 the first address, then send a message that includes all failed addresses
6966 that have the same error address. Note the bounce_recipient is a global so
6967 that it can be accesssed by $bounce_recipient while creating a customized
6972 if (!(bounce_recipient = addr_failed->prop.errors_address))
6973 bounce_recipient = sender_address;
6975 /* Make a subprocess to send a message */
6977 if ((pid = child_open_exim(&fd)) < 0)
6978 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Process %d (parent %d) failed to "
6979 "create child process to send failure message: %s", getpid(),
6980 getppid(), strerror(errno));
6982 /* Creation of child succeeded */
6989 uschar *bcc, *emf_text;
6990 FILE *f = fdopen(fd, "wb");
6992 BOOL to_sender = strcmpic(sender_address, bounce_recipient) == 0;
6993 int max = (bounce_return_size_limit/DELIVER_IN_BUFFER_SIZE + 1) *
6994 DELIVER_IN_BUFFER_SIZE;
6996 uschar *dsnlimitmsg;
6997 uschar *dsnnotifyhdr;
7001 debug_printf("sending error message to: %s\n", bounce_recipient);
7003 /* Scan the addresses for all that have the same errors address, removing
7004 them from the addr_failed chain, and putting them on msgchain. */
7006 paddr = &addr_failed;
7007 for (addr = addr_failed; addr; addr = *paddr)
7008 if (Ustrcmp(bounce_recipient, addr->prop.errors_address
7009 ? addr->prop.errors_address : sender_address) == 0)
7010 { /* The same - dechain */
7011 *paddr = addr->next;
7014 pmsgchain = &(addr->next);
7017 paddr = &addr->next; /* Not the same; skip */
7019 /* Include X-Failed-Recipients: for automatic interpretation, but do
7020 not let any one header line get too long. We do this by starting a
7021 new header every 50 recipients. Omit any addresses for which the
7022 "hide_child" flag is set. */
7024 for (addr = msgchain; addr; addr = addr->next)
7026 if (testflag(addr, af_hide_child)) continue;
7034 ? "X-Failed-Recipients: "
7036 testflag(addr, af_pfr) && addr->parent
7037 ? string_printing(addr->parent->address)
7038 : string_printing(addr->address));
7040 if (rcount > 0) fprintf(f, "\n");
7042 /* Output the standard headers */
7044 if (errors_reply_to)
7045 fprintf(f, "Reply-To: %s\n", errors_reply_to);
7046 fprintf(f, "Auto-Submitted: auto-replied\n");
7048 fprintf(f, "To: %s\n", bounce_recipient);
7050 /* generate boundary string and output MIME-Headers */
7051 bound = string_sprintf(TIME_T_FMT "-eximdsn-%d", time(NULL), rand());
7053 fprintf(f, "Content-Type: multipart/report;"
7054 " report-type=delivery-status; boundary=%s\n"
7055 "MIME-Version: 1.0\n",
7058 /* Open a template file if one is provided. Log failure to open, but
7059 carry on - default texts will be used. */
7061 if (bounce_message_file)
7062 if (!(emf = Ufopen(bounce_message_file, "rb")))
7063 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to open %s for error "
7064 "message texts: %s", bounce_message_file, strerror(errno));
7066 /* Quietly copy to configured additional addresses if required. */
7068 if ((bcc = moan_check_errorcopy(bounce_recipient)))
7069 fprintf(f, "Bcc: %s\n", bcc);
7071 /* The texts for the message can be read from a template file; if there
7072 isn't one, or if it is too short, built-in texts are used. The first
7073 emf text is a Subject: and any other headers. */
7075 if ((emf_text = next_emf(emf, US"header")))
7076 fprintf(f, "%s\n", emf_text);
7078 fprintf(f, "Subject: Mail delivery failed%s\n\n",
7079 to_sender? ": returning message to sender" : "");
7081 /* output human readable part as text/plain section */
7083 "Content-type: text/plain; charset=us-ascii\n\n",
7086 if ((emf_text = next_emf(emf, US"intro")))
7087 fprintf(f, "%s", CS emf_text);
7091 /* This message has been reworded several times. It seems to be confusing to
7092 somebody, however it is worded. I have retreated to the original, simple
7094 "This message was created automatically by mail delivery software.\n");
7096 if (bounce_message_text)
7097 fprintf(f, "%s", CS bounce_message_text);
7100 "\nA message that you sent could not be delivered to one or more of its\n"
7101 "recipients. This is a permanent error. The following address(es) failed:\n");
7104 "\nA message sent by\n\n <%s>\n\n"
7105 "could not be delivered to one or more of its recipients. The following\n"
7106 "address(es) failed:\n", sender_address);
7110 /* Process the addresses, leaving them on the msgchain if they have a
7111 file name for a return message. (There has already been a check in
7112 post_process_one() for the existence of data in the message file.) A TRUE
7113 return from print_address_information() means that the address is not
7117 for (addr = msgchain; addr; addr = *paddr)
7119 if (print_address_information(addr, f, US" ", US"\n ", US""))
7120 print_address_error(addr, f, US"");
7122 /* End the final line for the address */
7126 /* Leave on msgchain if there's a return file. */
7128 if (addr->return_file >= 0)
7130 paddr = &(addr->next);
7134 /* Else save so that we can tick off the recipient when the
7139 *paddr = addr->next;
7140 addr->next = handled_addr;
7141 handled_addr = addr;
7147 /* Get the next text, whether we need it or not, so as to be
7148 positioned for the one after. */
7150 emf_text = next_emf(emf, US"generated text");
7152 /* If there were any file messages passed by the local transports,
7153 include them in the message. Then put the address on the handled chain.
7154 In the case of a batch of addresses that were all sent to the same
7155 transport, the return_file field in all of them will contain the same
7156 fd, and the return_filename field in the *last* one will be set (to the
7157 name of the file). */
7161 address_item *nextaddr;
7164 fprintf(f, "%s", CS emf_text);
7167 "The following text was generated during the delivery "
7168 "attempt%s:\n", (filecount > 1)? "s" : "");
7170 for (addr = msgchain; addr; addr = nextaddr)
7173 address_item *topaddr = addr;
7175 /* List all the addresses that relate to this file */
7178 while(addr) /* Insurance */
7180 print_address_information(addr, f, US"------ ", US"\n ",
7182 if (addr->return_filename) break;
7187 /* Now copy the file */
7189 if (!(fm = Ufopen(addr->return_filename, "rb")))
7190 fprintf(f, " +++ Exim error... failed to open text file: %s\n",
7194 while ((ch = fgetc(fm)) != EOF) fputc(ch, f);
7197 Uunlink(addr->return_filename);
7199 /* Can now add to handled chain, first fishing off the next
7200 address on the msgchain. */
7202 nextaddr = addr->next;
7203 addr->next = handled_addr;
7204 handled_addr = topaddr;
7209 /* output machine readable part */
7210 #ifdef EXPERIMENTAL_INTERNATIONAL
7211 if (message_smtputf8)
7213 "Content-type: message/global-delivery-status\n\n"
7214 "Reporting-MTA: dns; %s\n",
7215 bound, smtp_active_hostname);
7219 "Content-type: message/delivery-status\n\n"
7220 "Reporting-MTA: dns; %s\n",
7221 bound, smtp_active_hostname);
7225 /* must be decoded from xtext: see RFC 3461:6.3a */
7227 if (auth_xtextdecode(dsn_envid, &xdec_envid) > 0)
7228 fprintf(f, "Original-Envelope-ID: %s\n", dsn_envid);
7230 fprintf(f, "X-Original-Envelope-ID: error decoding xtext formated ENVID\n");
7234 for (addr = handled_addr; addr; addr = addr->next)
7237 fprintf(f, "Action: failed\n"
7238 "Final-Recipient: rfc822;%s\n"
7241 if ((hu = addr->host_used) && hu->name)
7244 fprintf(f, "Remote-MTA: dns; %s\n",
7246 #ifdef EXPERIMENTAL_DSN_INFO
7249 uschar * p = hu->port == 25
7250 ? US"" : string_sprintf(":%d", hu->port);
7251 fprintf(f, "Remote-MTA: X-ip; [%s]%s\n", hu->address, p);
7253 if ((s = addr->smtp_greeting) && *s)
7254 fprintf(f, "X-Remote-MTA-smtp-greeting: X-str; %s\n", s);
7255 if ((s = addr->helo_response) && *s)
7256 fprintf(f, "X-Remote-MTA-helo-response: X-str; %s\n", s);
7257 if ((s = addr->message) && *s)
7258 fprintf(f, "X-Exim-Diagnostic: X-str; %s\n", s);
7260 print_dsn_diagnostic_code(addr, f);
7265 /* Now copy the message, trying to give an intelligible comment if
7266 it is too long for it all to be copied. The limit isn't strictly
7267 applied because of the buffering. There is, however, an option
7268 to suppress copying altogether. */
7270 emf_text = next_emf(emf, US"copy");
7273 we ignore the intro text from template and add
7274 the text for bounce_return_size_limit at the end.
7276 bounce_return_message is ignored
7277 in case RET= is defined we honor these values
7278 otherwise bounce_return_body is honored.
7280 bounce_return_size_limit is always honored.
7283 fprintf(f, "--%s\n", bound);
7285 dsnlimitmsg = US"X-Exim-DSN-Information: Due to administrative limits only headers are returned";
7286 dsnnotifyhdr = NULL;
7287 topt = topt_add_return_path;
7289 /* RET=HDRS? top priority */
7290 if (dsn_ret == dsn_ret_hdrs)
7291 topt |= topt_no_body;
7293 /* no full body return at all? */
7294 if (!bounce_return_body)
7296 topt |= topt_no_body;
7297 /* add header if we overrule RET=FULL */
7298 if (dsn_ret == dsn_ret_full)
7299 dsnnotifyhdr = dsnlimitmsg;
7301 /* size limited ... return headers only if limit reached */
7302 else if (bounce_return_size_limit > 0)
7304 struct stat statbuf;
7305 if (fstat(deliver_datafile, &statbuf) == 0 && statbuf.st_size > max)
7307 topt |= topt_no_body;
7308 dsnnotifyhdr = dsnlimitmsg;
7312 #ifdef EXPERIMENTAL_INTERNATIONAL
7313 if (message_smtputf8)
7314 fputs(topt & topt_no_body ? "Content-type: message/global-headers\n\n"
7315 : "Content-type: message/global\n\n",
7319 fputs(topt & topt_no_body ? "Content-type: text/rfc822-headers\n\n"
7320 : "Content-type: message/rfc822\n\n",
7324 transport_filter_argv = NULL; /* Just in case */
7325 return_path = sender_address; /* In case not previously set */
7326 transport_write_message(NULL, fileno(f), topt,
7327 0, dsnnotifyhdr, NULL, NULL, NULL, NULL, 0);
7330 /* we never add the final text. close the file */
7334 fprintf(f, "\n--%s--\n", bound);
7336 /* Close the file, which should send an EOF to the child process
7337 that is receiving the message. Wait for it to finish. */
7340 rc = child_close(pid, 0); /* Waits for child to close, no timeout */
7342 /* In the test harness, let the child do it's thing first. */
7344 if (running_in_test_harness) millisleep(500);
7346 /* If the process failed, there was some disaster in setting up the
7347 error message. Unless the message is very old, ensure that addr_defer
7348 is non-null, which will have the effect of leaving the message on the
7349 spool. The failed addresses will get tried again next time. However, we
7350 don't really want this to happen too often, so freeze the message unless
7351 there are some genuine deferred addresses to try. To do this we have
7352 to call spool_write_header() here, because with no genuine deferred
7353 addresses the normal code below doesn't get run. */
7358 if (now - received_time < retry_maximum_timeout && !addr_defer)
7360 addr_defer = (address_item *)(+1);
7361 deliver_freeze = TRUE;
7362 deliver_frozen_at = time(NULL);
7363 /* Panic-dies on error */
7364 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
7367 deliver_msglog("Process failed (%d) when writing error message "
7368 "to %s%s", rc, bounce_recipient, s);
7369 log_write(0, LOG_MAIN, "Process failed (%d) when writing error message "
7370 "to %s%s", rc, bounce_recipient, s);
7373 /* The message succeeded. Ensure that the recipients that failed are
7374 now marked finished with on the spool and their parents updated. */
7378 for (addr = handled_addr; addr; addr = addr->next)
7380 address_done(addr, logtod);
7381 child_done(addr, logtod);
7383 /* Panic-dies on error */
7384 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
7390 disable_logging = FALSE; /* In case left set */
7392 /* Come here from the mua_wrapper case if routing goes wrong */
7396 /* If there are now no deferred addresses, we are done. Preserve the
7397 message log if so configured, and we are using them. Otherwise, sling it.
7398 Then delete the message itself. */
7404 sprintf(CS spoolname, "%s/msglog/%s/%s", spool_directory, message_subdir,
7406 if (preserve_message_logs)
7409 sprintf(CS big_buffer, "%s/msglog.OLD/%s", spool_directory, id);
7410 if ((rc = Urename(spoolname, big_buffer)) < 0)
7412 (void)directory_make(spool_directory, US"msglog.OLD",
7413 MSGLOG_DIRECTORY_MODE, TRUE);
7414 rc = Urename(spoolname, big_buffer);
7417 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to move %s to the "
7418 "msglog.OLD directory", spoolname);
7421 if (Uunlink(spoolname) < 0)
7422 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s",
7423 spoolname, strerror(errno));
7426 /* Remove the two message files. */
7428 sprintf(CS spoolname, "%s/input/%s/%s-D", spool_directory, message_subdir, id);
7429 if (Uunlink(spoolname) < 0)
7430 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s",
7431 spoolname, strerror(errno));
7432 sprintf(CS spoolname, "%s/input/%s/%s-H", spool_directory, message_subdir, id);
7433 if (Uunlink(spoolname) < 0)
7434 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s",
7435 spoolname, strerror(errno));
7437 /* Log the end of this message, with queue time if requested. */
7439 if (LOGGING(queue_time_overall))
7440 log_write(0, LOG_MAIN, "Completed QT=%s",
7441 readconf_printtime( (int) ((long)time(NULL) - (long)received_time)) );
7443 log_write(0, LOG_MAIN, "Completed");
7445 /* Unset deliver_freeze so that we won't try to move the spool files further down */
7446 deliver_freeze = FALSE;
7448 #ifdef EXPERIMENTAL_EVENT
7449 (void) event_raise(event_action, US"msg:complete", NULL);
7453 /* If there are deferred addresses, we are keeping this message because it is
7454 not yet completed. Lose any temporary files that were catching output from
7455 pipes for any of the deferred addresses, handle one-time aliases, and see if
7456 the message has been on the queue for so long that it is time to send a warning
7457 message to the sender, unless it is a mailer-daemon. If all deferred addresses
7458 have the same domain, we can set deliver_domain for the expansion of
7459 delay_warning_ condition - if any of them are pipes, files, or autoreplies, use
7460 the parent's domain.
7462 If all the deferred addresses have an error number that indicates "retry time
7463 not reached", skip sending the warning message, because it won't contain the
7464 reason for the delay. It will get sent at the next real delivery attempt.
7465 However, if at least one address has tried, we'd better include all of them in
7468 If we can't make a process to send the message, don't worry.
7470 For mailing list expansions we want to send the warning message to the
7471 mailing list manager. We can't do a perfect job here, as some addresses may
7472 have different errors addresses, but if we take the errors address from
7473 each deferred address it will probably be right in most cases.
7475 If addr_defer == +1, it means there was a problem sending an error message
7476 for failed addresses, and there were no "real" deferred addresses. The value
7477 was set just to keep the message on the spool, so there is nothing to do here.
7480 else if (addr_defer != (address_item *)(+1))
7483 uschar *recipients = US"";
7484 BOOL delivery_attempted = FALSE;
7486 deliver_domain = testflag(addr_defer, af_pfr)
7487 ? addr_defer->parent->domain : addr_defer->domain;
7489 for (addr = addr_defer; addr; addr = addr->next)
7491 address_item *otaddr;
7493 if (addr->basic_errno > ERRNO_RETRY_BASE) delivery_attempted = TRUE;
7497 const uschar *d = testflag(addr, af_pfr)
7498 ? addr->parent->domain : addr->domain;
7500 /* The domain may be unset for an address that has never been routed
7501 because the system filter froze the message. */
7503 if (!d || Ustrcmp(d, deliver_domain) != 0)
7504 deliver_domain = NULL;
7507 if (addr->return_filename) Uunlink(addr->return_filename);
7509 /* Handle the case of one-time aliases. If any address in the ancestry
7510 of this one is flagged, ensure it is in the recipients list, suitably
7511 flagged, and that its parent is marked delivered. */
7513 for (otaddr = addr; otaddr; otaddr = otaddr->parent)
7514 if (otaddr->onetime_parent) break;
7519 int t = recipients_count;
7521 for (i = 0; i < recipients_count; i++)
7523 uschar *r = recipients_list[i].address;
7524 if (Ustrcmp(otaddr->onetime_parent, r) == 0) t = i;
7525 if (Ustrcmp(otaddr->address, r) == 0) break;
7528 /* Didn't find the address already in the list, and did find the
7529 ultimate parent's address in the list. After adding the recipient,
7530 update the errors address in the recipients list. */
7532 if (i >= recipients_count && t < recipients_count)
7534 DEBUG(D_deliver) debug_printf("one_time: adding %s in place of %s\n",
7535 otaddr->address, otaddr->parent->address);
7536 receive_add_recipient(otaddr->address, t);
7537 recipients_list[recipients_count-1].errors_to = otaddr->prop.errors_address;
7538 tree_add_nonrecipient(otaddr->parent->address);
7539 update_spool = TRUE;
7543 /* Except for error messages, ensure that either the errors address for
7544 this deferred address or, if there is none, the sender address, is on the
7545 list of recipients for a warning message. */
7547 if (sender_address[0] != 0)
7548 if (addr->prop.errors_address)
7550 if (Ustrstr(recipients, addr->prop.errors_address) == NULL)
7551 recipients = string_sprintf("%s%s%s", recipients,
7552 (recipients[0] == 0)? "" : ",", addr->prop.errors_address);
7556 if (Ustrstr(recipients, sender_address) == NULL)
7557 recipients = string_sprintf("%s%s%s", recipients,
7558 (recipients[0] == 0)? "" : ",", sender_address);
7562 /* Send a warning message if the conditions are right. If the condition check
7563 fails because of a lookup defer, there is nothing we can do. The warning
7564 is not sent. Another attempt will be made at the next delivery attempt (if
7568 && delivery_attempted
7569 && ( ((addr_defer->dsn_flags & rf_dsnflags) == 0)
7570 || (addr_defer->dsn_flags & rf_notify_delay) == rf_notify_delay
7572 && delay_warning[1] > 0
7573 && sender_address[0] != 0
7574 && ( !delay_warning_condition
7575 || expand_check_condition(delay_warning_condition,
7576 US"delay_warning", US"option")
7582 int queue_time = time(NULL) - received_time;
7584 /* When running in the test harness, there's an option that allows us to
7585 fudge this time so as to get repeatability of the tests. Take the first
7586 time off the list. In queue runs, the list pointer gets updated in the
7589 if (running_in_test_harness && fudged_queue_times[0] != 0)
7591 int qt = readconf_readtime(fudged_queue_times, '/', FALSE);
7594 DEBUG(D_deliver) debug_printf("fudged queue_times = %s\n",
7595 fudged_queue_times);
7600 /* See how many warnings we should have sent by now */
7602 for (count = 0; count < delay_warning[1]; count++)
7603 if (queue_time < delay_warning[count+2]) break;
7605 show_time = delay_warning[count+1];
7607 if (count >= delay_warning[1])
7610 int last_gap = show_time;
7611 if (count > 1) last_gap -= delay_warning[count];
7612 extra = (queue_time - delay_warning[count+1])/last_gap;
7613 show_time += last_gap * extra;
7619 debug_printf("time on queue = %s\n", readconf_printtime(queue_time));
7620 debug_printf("warning counts: required %d done %d\n", count,
7624 /* We have computed the number of warnings there should have been by now.
7625 If there haven't been enough, send one, and up the count to what it should
7628 if (warning_count < count)
7632 pid_t pid = child_open_exim(&fd);
7638 FILE *f = fdopen(fd, "wb");
7641 if (warn_message_file)
7642 if (!(wmf = Ufopen(warn_message_file, "rb")))
7643 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to open %s for warning "
7644 "message texts: %s", warn_message_file, strerror(errno));
7646 warnmsg_recipients = recipients;
7647 warnmsg_delay = queue_time < 120*60
7648 ? string_sprintf("%d minutes", show_time/60)
7649 : string_sprintf("%d hours", show_time/3600);
7651 if (errors_reply_to)
7652 fprintf(f, "Reply-To: %s\n", errors_reply_to);
7653 fprintf(f, "Auto-Submitted: auto-replied\n");
7655 fprintf(f, "To: %s\n", recipients);
7657 /* generated boundary string and output MIME-Headers */
7658 bound = string_sprintf(TIME_T_FMT "-eximdsn-%d", time(NULL), rand());
7660 fprintf(f, "Content-Type: multipart/report;"
7661 " report-type=delivery-status; boundary=%s\n"
7662 "MIME-Version: 1.0\n",
7665 if ((wmf_text = next_emf(wmf, US"header")))
7666 fprintf(f, "%s\n", wmf_text);
7668 fprintf(f, "Subject: Warning: message %s delayed %s\n\n",
7669 message_id, warnmsg_delay);
7671 /* output human readable part as text/plain section */
7673 "Content-type: text/plain; charset=us-ascii\n\n",
7676 if ((wmf_text = next_emf(wmf, US"intro")))
7677 fprintf(f, "%s", CS wmf_text);
7681 "This message was created automatically by mail delivery software.\n");
7683 if (Ustrcmp(recipients, sender_address) == 0)
7685 "A message that you sent has not yet been delivered to one or more of its\n"
7686 "recipients after more than ");
7690 "A message sent by\n\n <%s>\n\n"
7691 "has not yet been delivered to one or more of its recipients after more than \n",
7694 fprintf(f, "%s on the queue on %s.\n\n"
7695 "The message identifier is: %s\n",
7696 warnmsg_delay, primary_hostname, message_id);
7698 for (h = header_list; h; h = h->next)
7699 if (strncmpic(h->text, US"Subject:", 8) == 0)
7700 fprintf(f, "The subject of the message is: %s", h->text + 9);
7701 else if (strncmpic(h->text, US"Date:", 5) == 0)
7702 fprintf(f, "The date of the message is: %s", h->text + 6);
7705 fprintf(f, "The address%s to which the message has not yet been "
7707 !addr_defer->next ? "" : "es",
7708 !addr_defer->next ? "is": "are");
7711 /* List the addresses, with error information if allowed */
7713 /* store addr_defer for machine readable part */
7714 address_item *addr_dsndefer = addr_defer;
7718 address_item *addr = addr_defer;
7719 addr_defer = addr->next;
7720 if (print_address_information(addr, f, US" ", US"\n ", US""))
7721 print_address_error(addr, f, US"Delay reason: ");
7730 if ((wmf_text = next_emf(wmf, US"final")))
7731 fprintf(f, "%s", CS wmf_text);
7737 "No action is required on your part. Delivery attempts will continue for\n"
7738 "some time, and this warning may be repeated at intervals if the message\n"
7739 "remains undelivered. Eventually the mail delivery software will give up,\n"
7740 "and when that happens, the message will be returned to you.\n");
7743 /* output machine readable part */
7744 fprintf(f, "\n--%s\n"
7745 "Content-type: message/delivery-status\n\n"
7746 "Reporting-MTA: dns; %s\n",
7748 smtp_active_hostname);
7753 /* must be decoded from xtext: see RFC 3461:6.3a */
7755 if (auth_xtextdecode(dsn_envid, &xdec_envid) > 0)
7756 fprintf(f,"Original-Envelope-ID: %s\n", dsn_envid);
7758 fprintf(f,"X-Original-Envelope-ID: error decoding xtext formated ENVID\n");
7762 for ( ; addr_dsndefer; addr_dsndefer = addr_dsndefer->next)
7764 if (addr_dsndefer->dsn_orcpt)
7765 fprintf(f, "Original-Recipient: %s\n", addr_dsndefer->dsn_orcpt);
7767 fprintf(f, "Action: delayed\n"
7768 "Final-Recipient: rfc822;%s\n"
7770 addr_dsndefer->address);
7771 if (addr_dsndefer->host_used && addr_dsndefer->host_used->name)
7773 fprintf(f, "Remote-MTA: dns; %s\n",
7774 addr_dsndefer->host_used->name);
7775 print_dsn_diagnostic_code(addr_dsndefer, f);
7781 "Content-type: text/rfc822-headers\n\n",
7785 /* header only as required by RFC. only failure DSN needs to honor RET=FULL */
7786 int topt = topt_add_return_path | topt_no_body;
7787 transport_filter_argv = NULL; /* Just in case */
7788 return_path = sender_address; /* In case not previously set */
7789 /* Write the original email out */
7790 transport_write_message(NULL, fileno(f), topt, 0, NULL, NULL, NULL, NULL, NULL, 0);
7793 fprintf(f,"\n--%s--\n", bound);
7797 /* Close and wait for child process to complete, without a timeout.
7798 If there's an error, don't update the count. */
7801 if (child_close(pid, 0) == 0)
7803 warning_count = count;
7804 update_spool = TRUE; /* Ensure spool rewritten */
7810 /* Clear deliver_domain */
7812 deliver_domain = NULL;
7814 /* If this was a first delivery attempt, unset the first time flag, and
7815 ensure that the spool gets updated. */
7817 if (deliver_firsttime)
7819 deliver_firsttime = FALSE;
7820 update_spool = TRUE;
7823 /* If delivery was frozen and freeze_tell is set, generate an appropriate
7824 message, unless the message is a local error message (to avoid loops). Then
7825 log the freezing. If the text in "frozen_info" came from a system filter,
7826 it has been escaped into printing characters so as not to mess up log lines.
7827 For the "tell" message, we turn \n back into newline. Also, insert a newline
7828 near the start instead of the ": " string. */
7832 if (freeze_tell && freeze_tell[0] != 0 && !local_error_message)
7834 uschar *s = string_copy(frozen_info);
7835 uschar *ss = Ustrstr(s, " by the system filter: ");
7846 if (*ss == '\\' && ss[1] == 'n')
7853 moan_tell_someone(freeze_tell, addr_defer, US"Message frozen",
7854 "Message %s has been frozen%s.\nThe sender is <%s>.\n", message_id,
7858 /* Log freezing just before we update the -H file, to minimize the chance
7859 of a race problem. */
7861 deliver_msglog("*** Frozen%s\n", frozen_info);
7862 log_write(0, LOG_MAIN, "Frozen%s", frozen_info);
7865 /* If there have been any updates to the non-recipients list, or other things
7866 that get written to the spool, we must now update the spool header file so
7867 that it has the right information for the next delivery attempt. If there
7868 was more than one address being delivered, the header_change update is done
7869 earlier, in case one succeeds and then something crashes. */
7872 debug_printf("delivery deferred: update_spool=%d header_rewritten=%d\n",
7873 update_spool, header_rewritten);
7875 if (update_spool || header_rewritten)
7876 /* Panic-dies on error */
7877 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
7880 /* Finished with the message log. If the message is complete, it will have
7881 been unlinked or renamed above. */
7883 if (message_logs) (void)fclose(message_log);
7885 /* Now we can close and remove the journal file. Its only purpose is to record
7886 successfully completed deliveries asap so that this information doesn't get
7887 lost if Exim (or the machine) crashes. Forgetting about a failed delivery is
7888 not serious, as trying it again is not harmful. The journal might not be open
7889 if all addresses were deferred at routing or directing. Nevertheless, we must
7890 remove it if it exists (may have been lying around from a crash during the
7891 previous delivery attempt). We don't remove the journal if a delivery
7892 subprocess failed to pass back delivery information; this is controlled by
7893 the remove_journal flag. When the journal is left, we also don't move the
7894 message off the main spool if frozen and the option is set. It should get moved
7895 at the next attempt, after the journal has been inspected. */
7897 if (journal_fd >= 0) (void)close(journal_fd);
7901 sprintf(CS spoolname, "%s/input/%s/%s-J", spool_directory, message_subdir, id);
7902 if (Uunlink(spoolname) < 0 && errno != ENOENT)
7903 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s", spoolname,
7906 /* Move the message off the spool if reqested */
7908 #ifdef SUPPORT_MOVE_FROZEN_MESSAGES
7909 if (deliver_freeze && move_frozen_messages)
7910 (void)spool_move_message(id, message_subdir, US"", US"F");
7914 /* Closing the data file frees the lock; if the file has been unlinked it
7915 will go away. Otherwise the message becomes available for another process
7918 (void)close(deliver_datafile);
7919 deliver_datafile = -1;
7920 DEBUG(D_deliver) debug_printf("end delivery of %s\n", id);
7922 /* It is unlikely that there will be any cached resources, since they are
7923 released after routing, and in the delivery subprocesses. However, it's
7924 possible for an expansion for something afterwards (for example,
7925 expand_check_condition) to do a lookup. We must therefore be sure everything is
7929 acl_where = ACL_WHERE_UNKNOWN;
7938 if (!regex_PIPELINING) regex_PIPELINING =
7939 regex_must_compile(US"\\n250[\\s\\-]PIPELINING(\\s|\\n|$)", FALSE, TRUE);
7941 if (!regex_SIZE) regex_SIZE =
7942 regex_must_compile(US"\\n250[\\s\\-]SIZE(\\s|\\n|$)", FALSE, TRUE);
7944 if (!regex_AUTH) regex_AUTH =
7945 regex_must_compile(US"\\n250[\\s\\-]AUTH\\s+([\\-\\w\\s]+)(?:\\n|$)",
7949 if (!regex_STARTTLS) regex_STARTTLS =
7950 regex_must_compile(US"\\n250[\\s\\-]STARTTLS(\\s|\\n|$)", FALSE, TRUE);
7953 #ifndef DISABLE_PRDR
7954 if (!regex_PRDR) regex_PRDR =
7955 regex_must_compile(US"\\n250[\\s\\-]PRDR(\\s|\\n|$)", FALSE, TRUE);
7958 #ifdef EXPERIMENTAL_INTERNATIONAL
7959 if (!regex_UTF8) regex_UTF8 =
7960 regex_must_compile(US"\\n250[\\s\\-]SMTPUTF8(\\s|\\n|$)", FALSE, TRUE);
7963 if (!regex_DSN) regex_DSN =
7964 regex_must_compile(US"\\n250[\\s\\-]DSN(\\s|\\n|$)", FALSE, TRUE);
7966 if (!regex_IGNOREQUOTA) regex_IGNOREQUOTA =
7967 regex_must_compile(US"\\n250[\\s\\-]IGNOREQUOTA(\\s|\\n|$)", FALSE, TRUE);
7972 deliver_get_sender_address (uschar * id)
7975 uschar * new_sender_address,
7976 * save_sender_address;
7978 if (!spool_open_datafile(id))
7981 /* Save and restore the global sender_address. I'm not sure if we should
7982 not save/restore all the other global variables too, because
7983 spool_read_header() may change all of them. But OTOH, when this
7984 deliver_get_sender_address() gets called, the current message is done
7985 already and nobody needs the globals anymore. (HS12, 2015-08-21) */
7987 sprintf(CS spoolname, "%s-H", id);
7988 save_sender_address = sender_address;
7990 rc = spool_read_header(spoolname, TRUE, TRUE);
7992 new_sender_address = sender_address;
7993 sender_address = save_sender_address;
7995 if (rc != spool_read_OK)
7998 assert(new_sender_address);
8000 (void)close(deliver_datafile);
8001 deliver_datafile = -1;
8003 return new_sender_address;
8008 /* End of deliver.c */