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 || tp->log_defer_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 /* Create the pipe for inter-process communication. */
1952 common_error(TRUE, addr, ERRNO_PIPEFAIL, US"Creation of pipe failed: %s",
1957 /* Now fork the process to do the real work in the subprocess, but first
1958 ensure that all cached resources are freed so that the subprocess starts with
1959 a clean slate and doesn't interfere with the parent process. */
1963 if ((pid = fork()) == 0)
1965 BOOL replicate = TRUE;
1967 /* Prevent core dumps, as we don't want them in users' home directories.
1968 HP-UX doesn't have RLIMIT_CORE; I don't know how to do this in that
1969 system. Some experimental/developing systems (e.g. GNU/Hurd) may define
1970 RLIMIT_CORE but not support it in setrlimit(). For such systems, do not
1971 complain if the error is "not supported".
1973 There are two scenarios where changing the max limit has an effect. In one,
1974 the user is using a .forward and invoking a command of their choice via pipe;
1975 for these, we do need the max limit to be 0 unless the admin chooses to
1976 permit an increased limit. In the other, the command is invoked directly by
1977 the transport and is under administrator control, thus being able to raise
1978 the limit aids in debugging. So there's no general always-right answer.
1980 Thus we inhibit core-dumps completely but let individual transports, while
1981 still root, re-raise the limits back up to aid debugging. We make the
1982 default be no core-dumps -- few enough people can use core dumps in
1983 diagnosis that it's reasonable to make them something that has to be explicitly requested.
1990 if (setrlimit(RLIMIT_CORE, &rl) < 0)
1992 # ifdef SETRLIMIT_NOT_SUPPORTED
1993 if (errno != ENOSYS && errno != ENOTSUP)
1995 log_write(0, LOG_MAIN|LOG_PANIC, "setrlimit(RLIMIT_CORE) failed: %s",
2000 /* Reset the random number generator, so different processes don't all
2001 have the same sequence. */
2005 /* If the transport has a setup entry, call this first, while still
2006 privileged. (Appendfile uses this to expand quota, for example, while
2007 able to read private files.) */
2009 if (addr->transport->setup)
2010 switch((addr->transport->setup)(addr->transport, addr, NULL, uid, gid,
2014 addr->transport_return = DEFER;
2018 addr->transport_return = PANIC;
2022 /* Ignore SIGINT and SIGTERM during delivery. Also ignore SIGUSR1, as
2023 when the process becomes unprivileged, it won't be able to write to the
2024 process log. SIGHUP is ignored throughout exim, except when it is being
2027 signal(SIGINT, SIG_IGN);
2028 signal(SIGTERM, SIG_IGN);
2029 signal(SIGUSR1, SIG_IGN);
2031 /* Close the unwanted half of the pipe, and set close-on-exec for the other
2032 half - for transports that exec things (e.g. pipe). Then set the required
2035 (void)close(pfd[pipe_read]);
2036 (void)fcntl(pfd[pipe_write], F_SETFD, fcntl(pfd[pipe_write], F_GETFD) |
2038 exim_setugid(uid, gid, use_initgroups,
2039 string_sprintf("local delivery to %s <%s> transport=%s", addr->local_part,
2040 addr->address, addr->transport->name));
2044 address_item *batched;
2045 debug_printf(" home=%s current=%s\n", deliver_home, working_directory);
2046 for (batched = addr->next; batched; batched = batched->next)
2047 debug_printf("additional batched address: %s\n", batched->address);
2050 /* Set an appropriate working directory. */
2052 if (Uchdir(working_directory) < 0)
2054 addr->transport_return = DEFER;
2055 addr->basic_errno = errno;
2056 addr->message = string_sprintf("failed to chdir to %s", working_directory);
2059 /* If successful, call the transport */
2064 set_process_info("delivering %s to %s using %s", message_id,
2065 addr->local_part, addr->transport->name);
2067 /* Setting this global in the subprocess means we need never clear it */
2068 transport_name = addr->transport->name;
2070 /* If a transport filter has been specified, set up its argument list.
2071 Any errors will get put into the address, and FALSE yielded. */
2073 if (addr->transport->filter_command)
2075 ok = transport_set_up_command(&transport_filter_argv,
2076 addr->transport->filter_command,
2077 TRUE, PANIC, addr, US"transport filter", NULL);
2078 transport_filter_timeout = addr->transport->filter_timeout;
2080 else transport_filter_argv = NULL;
2084 debug_print_string(addr->transport->debug_string);
2085 replicate = !(addr->transport->info->code)(addr->transport, addr);
2089 /* Pass the results back down the pipe. If necessary, first replicate the
2090 status in the top address to the others in the batch. The label is the
2091 subject of a goto when a call to the transport's setup function fails. We
2092 pass the pointer to the transport back in case it got changed as a result of
2093 file_format in appendfile. */
2097 if (replicate) replicate_status(addr);
2098 for (addr2 = addr; addr2; addr2 = addr2->next)
2101 int local_part_length = Ustrlen(addr2->local_part);
2105 if( (ret = write(pfd[pipe_write], &addr2->transport_return, sizeof(int))) != sizeof(int)
2106 || (ret = write(pfd[pipe_write], &transport_count, sizeof(transport_count))) != sizeof(transport_count)
2107 || (ret = write(pfd[pipe_write], &addr2->flags, sizeof(addr2->flags))) != sizeof(addr2->flags)
2108 || (ret = write(pfd[pipe_write], &addr2->basic_errno, sizeof(int))) != sizeof(int)
2109 || (ret = write(pfd[pipe_write], &addr2->more_errno, sizeof(int))) != sizeof(int)
2110 || (ret = write(pfd[pipe_write], &addr2->special_action, sizeof(int))) != sizeof(int)
2111 || (ret = write(pfd[pipe_write], &addr2->transport,
2112 sizeof(transport_instance *))) != sizeof(transport_instance *)
2114 /* For a file delivery, pass back the local part, in case the original
2115 was only part of the final delivery path. This gives more complete
2118 || (testflag(addr2, af_file)
2119 && ( (ret = write(pfd[pipe_write], &local_part_length, sizeof(int))) != sizeof(int)
2120 || (ret = write(pfd[pipe_write], addr2->local_part, local_part_length)) != local_part_length
2124 log_write(0, LOG_MAIN|LOG_PANIC, "Failed writing transport results to pipe: %s\n",
2125 ret == -1 ? strerror(errno) : "short write");
2127 /* Now any messages */
2129 for (i = 0, s = addr2->message; i < 2; i++, s = addr2->user_message)
2131 int message_length = s ? Ustrlen(s) + 1 : 0;
2132 if( (ret = write(pfd[pipe_write], &message_length, sizeof(int))) != sizeof(int)
2133 || message_length > 0 && (ret = write(pfd[pipe_write], s, message_length)) != message_length
2135 log_write(0, LOG_MAIN|LOG_PANIC, "Failed writing transport results to pipe: %s\n",
2136 ret == -1 ? strerror(errno) : "short write");
2140 /* OK, this process is now done. Free any cached resources that it opened,
2141 and close the pipe we were writing down before exiting. */
2143 (void)close(pfd[pipe_write]);
2148 /* Back in the main process: panic if the fork did not succeed. This seems
2149 better than returning an error - if forking is failing it is probably best
2150 not to try other deliveries for this message. */
2153 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Fork failed for local delivery to %s",
2156 /* Read the pipe to get the delivery status codes and error messages. Our copy
2157 of the writing end must be closed first, as otherwise read() won't return zero
2158 on an empty pipe. We check that a status exists for each address before
2159 overwriting the address structure. If data is missing, the default DEFER status
2160 will remain. Afterwards, close the reading end. */
2162 (void)close(pfd[pipe_write]);
2164 for (addr2 = addr; addr2; addr2 = addr2->next)
2166 len = read(pfd[pipe_read], &status, sizeof(int));
2172 addr2->transport_return = status;
2173 len = read(pfd[pipe_read], &transport_count,
2174 sizeof(transport_count));
2175 len = read(pfd[pipe_read], &addr2->flags, sizeof(addr2->flags));
2176 len = read(pfd[pipe_read], &addr2->basic_errno, sizeof(int));
2177 len = read(pfd[pipe_read], &addr2->more_errno, sizeof(int));
2178 len = read(pfd[pipe_read], &addr2->special_action, sizeof(int));
2179 len = read(pfd[pipe_read], &addr2->transport,
2180 sizeof(transport_instance *));
2182 if (testflag(addr2, af_file))
2184 int local_part_length;
2185 len = read(pfd[pipe_read], &local_part_length, sizeof(int));
2186 len = read(pfd[pipe_read], big_buffer, local_part_length);
2187 big_buffer[local_part_length] = 0;
2188 addr2->local_part = string_copy(big_buffer);
2191 for (i = 0, sptr = &addr2->message; i < 2; i++, sptr = &addr2->user_message)
2194 len = read(pfd[pipe_read], &message_length, sizeof(int));
2195 if (message_length > 0)
2197 len = read(pfd[pipe_read], big_buffer, message_length);
2198 if (len > 0) *sptr = string_copy(big_buffer);
2205 log_write(0, LOG_MAIN|LOG_PANIC, "failed to read delivery status for %s "
2206 "from delivery subprocess", addr2->unique);
2211 (void)close(pfd[pipe_read]);
2213 /* Unless shadowing, write all successful addresses immediately to the journal
2214 file, to ensure they are recorded asap. For homonymic addresses, use the base
2215 address plus the transport name. Failure to write the journal is panic-worthy,
2216 but don't stop, as it may prove possible subsequently to update the spool file
2217 in order to record the delivery. */
2221 for (addr2 = addr; addr2; addr2 = addr2->next)
2222 if (addr2->transport_return == OK)
2224 if (testflag(addr2, af_homonym))
2225 sprintf(CS big_buffer, "%.500s/%s\n", addr2->unique + 3, tp->name);
2227 sprintf(CS big_buffer, "%.500s\n", addr2->unique);
2229 /* In the test harness, wait just a bit to let the subprocess finish off
2230 any debug output etc first. */
2232 if (running_in_test_harness) millisleep(300);
2234 DEBUG(D_deliver) debug_printf("journalling %s", big_buffer);
2235 len = Ustrlen(big_buffer);
2236 if (write(journal_fd, big_buffer, len) != len)
2237 log_write(0, LOG_MAIN|LOG_PANIC, "failed to update journal for %s: %s",
2238 big_buffer, strerror(errno));
2241 /* Ensure the journal file is pushed out to disk. */
2243 if (EXIMfsync(journal_fd) < 0)
2244 log_write(0, LOG_MAIN|LOG_PANIC, "failed to fsync journal: %s",
2248 /* Wait for the process to finish. If it terminates with a non-zero code,
2249 freeze the message (except for SIGTERM, SIGKILL and SIGQUIT), but leave the
2250 status values of all the addresses as they are. Take care to handle the case
2251 when the subprocess doesn't seem to exist. This has been seen on one system
2252 when Exim was called from an MUA that set SIGCHLD to SIG_IGN. When that
2253 happens, wait() doesn't recognize the termination of child processes. Exim now
2254 resets SIGCHLD to SIG_DFL, but this code should still be robust. */
2256 while ((rc = wait(&status)) != pid)
2257 if (rc < 0 && errno == ECHILD) /* Process has vanished */
2259 log_write(0, LOG_MAIN, "%s transport process vanished unexpectedly",
2260 addr->transport->driver_name);
2265 if ((status & 0xffff) != 0)
2267 int msb = (status >> 8) & 255;
2268 int lsb = status & 255;
2269 int code = (msb == 0)? (lsb & 0x7f) : msb;
2270 if (msb != 0 || (code != SIGTERM && code != SIGKILL && code != SIGQUIT))
2271 addr->special_action = SPECIAL_FREEZE;
2272 log_write(0, LOG_MAIN|LOG_PANIC, "%s transport process returned non-zero "
2273 "status 0x%04x: %s %d",
2274 addr->transport->driver_name,
2276 msb == 0 ? "terminated by signal" : "exit code",
2280 /* If SPECIAL_WARN is set in the top address, send a warning message. */
2282 if (addr->special_action == SPECIAL_WARN && addr->transport->warn_message)
2285 uschar *warn_message;
2288 DEBUG(D_deliver) debug_printf("Warning message requested by transport\n");
2290 if (!(warn_message = expand_string(addr->transport->warn_message)))
2291 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand \"%s\" (warning "
2292 "message for %s transport): %s", addr->transport->warn_message,
2293 addr->transport->name, expand_string_message);
2295 else if ((pid = child_open_exim(&fd)) > 0)
2297 FILE *f = fdopen(fd, "wb");
2298 if (errors_reply_to && !contains_header(US"Reply-To", warn_message))
2299 fprintf(f, "Reply-To: %s\n", errors_reply_to);
2300 fprintf(f, "Auto-Submitted: auto-replied\n");
2301 if (!contains_header(US"From", warn_message))
2303 fprintf(f, "%s", CS warn_message);
2305 /* Close and wait for child process to complete, without a timeout. */
2308 (void)child_close(pid, 0);
2311 addr->special_action = SPECIAL_NONE;
2318 /* Check transport for the given concurrency limit. Return TRUE if over
2319 the limit (or an expansion failure), else FALSE and if there was a limit,
2320 the key for the hints database used for the concurrency count. */
2323 tpt_parallel_check(transport_instance * tp, address_item * addr, uschar ** key)
2325 unsigned max_parallel;
2327 if (!tp->max_parallel) return FALSE;
2329 max_parallel = (unsigned) expand_string_integer(tp->max_parallel, TRUE);
2330 if (expand_string_message)
2332 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand max_parallel option "
2333 "in %s transport (%s): %s", tp->name, addr->address,
2334 expand_string_message);
2338 if (max_parallel > 0)
2340 uschar * serialize_key = string_sprintf("tpt-serialize-%s", tp->name);
2341 if (!enq_start(serialize_key, max_parallel))
2343 address_item * next;
2345 debug_printf("skipping tpt %s because concurrency limit %u reached\n",
2346 tp->name, max_parallel);
2350 addr->message = US"concurrency limit reached for transport";
2351 addr->basic_errno = ERRNO_TRETRY;
2352 post_process_one(addr, DEFER, LOG_MAIN, DTYPE_TRANSPORT, 0);
2353 } while ((addr = next));
2356 *key = serialize_key;
2363 /*************************************************
2364 * Do local deliveries *
2365 *************************************************/
2367 /* This function processes the list of addresses in addr_local. True local
2368 deliveries are always done one address at a time. However, local deliveries can
2369 be batched up in some cases. Typically this is when writing batched SMTP output
2370 files for use by some external transport mechanism, or when running local
2371 deliveries over LMTP.
2378 do_local_deliveries(void)
2381 open_db *dbm_file = NULL;
2382 time_t now = time(NULL);
2384 /* Loop until we have exhausted the supply of local deliveries */
2388 time_t delivery_start;
2390 address_item *addr2, *addr3, *nextaddr;
2391 int logflags = LOG_MAIN;
2392 int logchar = dont_deliver? '*' : '=';
2393 transport_instance *tp;
2394 uschar * serialize_key = NULL;
2396 /* Pick the first undelivered address off the chain */
2398 address_item *addr = addr_local;
2399 addr_local = addr->next;
2402 DEBUG(D_deliver|D_transport)
2403 debug_printf("--------> %s <--------\n", addr->address);
2405 /* An internal disaster if there is no transport. Should not occur! */
2407 if (!(tp = addr->transport))
2409 logflags |= LOG_PANIC;
2410 disable_logging = FALSE; /* Jic */
2411 addr->message = addr->router
2412 ? string_sprintf("No transport set by %s router", addr->router->name)
2413 : string_sprintf("No transport set by system filter");
2414 post_process_one(addr, DEFER, logflags, DTYPE_TRANSPORT, 0);
2418 /* Check that this base address hasn't previously been delivered to this
2419 transport. The check is necessary at this point to handle homonymic addresses
2420 correctly in cases where the pattern of redirection changes between delivery
2421 attempts. Non-homonymic previous delivery is detected earlier, at routing
2424 if (previously_transported(addr, FALSE)) continue;
2426 /* There are weird cases where logging is disabled */
2428 disable_logging = tp->disable_logging;
2430 /* Check for batched addresses and possible amalgamation. Skip all the work
2431 if either batch_max <= 1 or there aren't any other addresses for local
2434 if (tp->batch_max > 1 && addr_local)
2436 int batch_count = 1;
2437 BOOL uses_dom = readconf_depends((driver_instance *)tp, US"domain");
2438 BOOL uses_lp = ( testflag(addr, af_pfr)
2439 && (testflag(addr, af_file) || addr->local_part[0] == '|')
2441 || readconf_depends((driver_instance *)tp, US"local_part");
2442 uschar *batch_id = NULL;
2443 address_item **anchor = &addr_local;
2444 address_item *last = addr;
2447 /* Expand the batch_id string for comparison with other addresses.
2448 Expansion failure suppresses batching. */
2452 deliver_set_expansions(addr);
2453 batch_id = expand_string(tp->batch_id);
2454 deliver_set_expansions(NULL);
2457 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand batch_id option "
2458 "in %s transport (%s): %s", tp->name, addr->address,
2459 expand_string_message);
2460 batch_count = tp->batch_max;
2464 /* Until we reach the batch_max limit, pick off addresses which have the
2465 same characteristics. These are:
2468 not previously delivered (see comment about 50 lines above)
2469 same local part if the transport's configuration contains $local_part
2470 or if this is a file or pipe delivery from a redirection
2471 same domain if the transport's configuration contains $domain
2473 same additional headers
2474 same headers to be removed
2475 same uid/gid for running the transport
2476 same first host if a host list is set
2479 while ((next = *anchor) && batch_count < tp->batch_max)
2482 tp == next->transport
2483 && !previously_transported(next, TRUE)
2484 && (addr->flags & (af_pfr|af_file)) == (next->flags & (af_pfr|af_file))
2485 && (!uses_lp || Ustrcmp(next->local_part, addr->local_part) == 0)
2486 && (!uses_dom || Ustrcmp(next->domain, addr->domain) == 0)
2487 && same_strings(next->prop.errors_address, addr->prop.errors_address)
2488 && same_headers(next->prop.extra_headers, addr->prop.extra_headers)
2489 && same_strings(next->prop.remove_headers, addr->prop.remove_headers)
2490 && same_ugid(tp, addr, next)
2491 && ( !addr->host_list && !next->host_list
2494 && Ustrcmp(addr->host_list->name, next->host_list->name) == 0
2497 /* If the transport has a batch_id setting, batch_id will be non-NULL
2498 from the expansion outside the loop. Expand for this address and compare.
2499 Expansion failure makes this address ineligible for batching. */
2504 address_item *save_nextnext = next->next;
2505 next->next = NULL; /* Expansion for a single address */
2506 deliver_set_expansions(next);
2507 next->next = save_nextnext;
2508 bid = expand_string(tp->batch_id);
2509 deliver_set_expansions(NULL);
2512 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand batch_id option "
2513 "in %s transport (%s): %s", tp->name, next->address,
2514 expand_string_message);
2517 else ok = (Ustrcmp(batch_id, bid) == 0);
2520 /* Take address into batch if OK. */
2524 *anchor = next->next; /* Include the address */
2530 else anchor = &next->next; /* Skip the address */
2534 /* We now have one or more addresses that can be delivered in a batch. Check
2535 whether the transport is prepared to accept a message of this size. If not,
2536 fail them all forthwith. If the expansion fails, or does not yield an
2537 integer, defer delivery. */
2539 if (tp->message_size_limit)
2541 int rc = check_message_size(tp, addr);
2544 replicate_status(addr);
2548 post_process_one(addr, rc, logflags, DTYPE_TRANSPORT, 0);
2551 continue; /* With next batch of addresses */
2555 /* If we are not running the queue, or if forcing, all deliveries will be
2556 attempted. Otherwise, we must respect the retry times for each address. Even
2557 when not doing this, we need to set up the retry key string, and determine
2558 whether a retry record exists, because after a successful delivery, a delete
2559 retry item must be set up. Keep the retry database open only for the duration
2560 of these checks, rather than for all local deliveries, because some local
2561 deliveries (e.g. to pipes) can take a substantial time. */
2563 if (!(dbm_file = dbfn_open(US"retry", O_RDONLY, &dbblock, FALSE)))
2565 DEBUG(D_deliver|D_retry|D_hints_lookup)
2566 debug_printf("no retry data available\n");
2573 BOOL ok = TRUE; /* to deliver this address */
2576 /* Set up the retry key to include the domain or not, and change its
2577 leading character from "R" to "T". Must make a copy before doing this,
2578 because the old key may be pointed to from a "delete" retry item after
2581 retry_key = string_copy(
2582 tp->retry_use_local_part ? addr2->address_retry_key :
2583 addr2->domain_retry_key);
2586 /* Inspect the retry data. If there is no hints file, delivery happens. */
2590 dbdata_retry *retry_record = dbfn_read(dbm_file, retry_key);
2592 /* If there is no retry record, delivery happens. If there is,
2593 remember it exists so it can be deleted after a successful delivery. */
2597 setflag(addr2, af_lt_retry_exists);
2599 /* A retry record exists for this address. If queue running and not
2600 forcing, inspect its contents. If the record is too old, or if its
2601 retry time has come, or if it has passed its cutoff time, delivery
2606 debug_printf("retry record exists: age=%s ",
2607 readconf_printtime(now - retry_record->time_stamp));
2608 debug_printf("(max %s)\n", readconf_printtime(retry_data_expire));
2609 debug_printf(" time to retry = %s expired = %d\n",
2610 readconf_printtime(retry_record->next_try - now),
2611 retry_record->expired);
2614 if (queue_running && !deliver_force)
2616 ok = (now - retry_record->time_stamp > retry_data_expire)
2617 || (now >= retry_record->next_try)
2618 || retry_record->expired;
2620 /* If we haven't reached the retry time, there is one more check
2621 to do, which is for the ultimate address timeout. */
2624 ok = retry_ultimate_address_timeout(retry_key, addr2->domain,
2628 else DEBUG(D_retry) debug_printf("no retry record exists\n");
2631 /* This address is to be delivered. Leave it on the chain. */
2636 addr2 = addr2->next;
2639 /* This address is to be deferred. Take it out of the chain, and
2640 post-process it as complete. Must take it out of the chain first,
2641 because post processing puts it on another chain. */
2645 address_item *this = addr2;
2646 this->message = US"Retry time not yet reached";
2647 this->basic_errno = ERRNO_LRETRY;
2648 addr2 = addr3 ? (addr3->next = addr2->next)
2649 : (addr = addr2->next);
2650 post_process_one(this, DEFER, logflags, DTYPE_TRANSPORT, 0);
2654 if (dbm_file) dbfn_close(dbm_file);
2656 /* If there are no addresses left on the chain, they all deferred. Loop
2657 for the next set of addresses. */
2659 if (!addr) continue;
2661 /* If the transport is limited for parallellism, enforce that here.
2662 We use a hints DB entry, incremented here and decremented after
2663 the transport (and any shadow transport) completes. */
2665 if (tpt_parallel_check(tp, addr, &serialize_key))
2667 if (expand_string_message)
2669 logflags |= LOG_PANIC;
2673 post_process_one(addr, DEFER, logflags, DTYPE_TRANSPORT, 0);
2674 } while ((addr = addr2));
2676 continue; /* Loop for the next set of addresses. */
2680 /* So, finally, we do have some addresses that can be passed to the
2681 transport. Before doing so, set up variables that are relevant to a
2684 deliver_set_expansions(addr);
2685 delivery_start = time(NULL);
2686 deliver_local(addr, FALSE);
2687 deliver_time = (int)(time(NULL) - delivery_start);
2689 /* If a shadow transport (which must perforce be another local transport), is
2690 defined, and its condition is met, we must pass the message to the shadow
2691 too, but only those addresses that succeeded. We do this by making a new
2692 chain of addresses - also to keep the original chain uncontaminated. We must
2693 use a chain rather than doing it one by one, because the shadow transport may
2696 NOTE: if the condition fails because of a lookup defer, there is nothing we
2700 && ( !tp->shadow_condition
2701 || expand_check_condition(tp->shadow_condition, tp->name, US"transport")
2704 transport_instance *stp;
2705 address_item *shadow_addr = NULL;
2706 address_item **last = &shadow_addr;
2708 for (stp = transports; stp; stp = stp->next)
2709 if (Ustrcmp(stp->name, tp->shadow) == 0) break;
2712 log_write(0, LOG_MAIN|LOG_PANIC, "shadow transport \"%s\" not found ",
2715 /* Pick off the addresses that have succeeded, and make clones. Put into
2716 the shadow_message field a pointer to the shadow_message field of the real
2719 else for (addr2 = addr; addr2; addr2 = addr2->next)
2720 if (addr2->transport_return == OK)
2722 addr3 = store_get(sizeof(address_item));
2725 addr3->shadow_message = (uschar *) &(addr2->shadow_message);
2726 addr3->transport = stp;
2727 addr3->transport_return = DEFER;
2728 addr3->return_filename = NULL;
2729 addr3->return_file = -1;
2731 last = &(addr3->next);
2734 /* If we found any addresses to shadow, run the delivery, and stick any
2735 message back into the shadow_message field in the original. */
2739 int save_count = transport_count;
2741 DEBUG(D_deliver|D_transport)
2742 debug_printf(">>>>>>>>>>>>>>>> Shadow delivery >>>>>>>>>>>>>>>>\n");
2743 deliver_local(shadow_addr, TRUE);
2745 for(; shadow_addr; shadow_addr = shadow_addr->next)
2747 int sresult = shadow_addr->transport_return;
2748 *(uschar **)shadow_addr->shadow_message =
2750 ? string_sprintf(" ST=%s", stp->name)
2751 : string_sprintf(" ST=%s (%s%s%s)", stp->name,
2752 shadow_addr->basic_errno <= 0
2754 : US strerror(shadow_addr->basic_errno),
2755 shadow_addr->basic_errno <= 0 || !shadow_addr->message
2758 shadow_addr->message
2759 ? shadow_addr->message
2760 : shadow_addr->basic_errno <= 0
2764 DEBUG(D_deliver|D_transport)
2765 debug_printf("%s shadow transport returned %s for %s\n",
2767 sresult == OK ? "OK" :
2768 sresult == DEFER ? "DEFER" :
2769 sresult == FAIL ? "FAIL" :
2770 sresult == PANIC ? "PANIC" : "?",
2771 shadow_addr->address);
2774 DEBUG(D_deliver|D_transport)
2775 debug_printf(">>>>>>>>>>>>>>>> End shadow delivery >>>>>>>>>>>>>>>>\n");
2777 transport_count = save_count; /* Restore original transport count */
2781 /* Cancel the expansions that were set up for the delivery. */
2783 deliver_set_expansions(NULL);
2785 /* If the transport was parallelism-limited, decrement the hints DB record. */
2787 if (serialize_key) enq_end(serialize_key);
2789 /* Now we can process the results of the real transport. We must take each
2790 address off the chain first, because post_process_one() puts it on another
2793 for (addr2 = addr; addr2; addr2 = nextaddr)
2795 int result = addr2->transport_return;
2796 nextaddr = addr2->next;
2798 DEBUG(D_deliver|D_transport)
2799 debug_printf("%s transport returned %s for %s\n",
2801 result == OK ? "OK" :
2802 result == DEFER ? "DEFER" :
2803 result == FAIL ? "FAIL" :
2804 result == PANIC ? "PANIC" : "?",
2807 /* If there is a retry_record, or if delivery is deferred, build a retry
2808 item for setting a new retry time or deleting the old retry record from
2809 the database. These items are handled all together after all addresses
2810 have been handled (so the database is open just for a short time for
2813 if (result == DEFER || testflag(addr2, af_lt_retry_exists))
2815 int flags = result == DEFER ? 0 : rf_delete;
2816 uschar *retry_key = string_copy(tp->retry_use_local_part
2817 ? addr2->address_retry_key : addr2->domain_retry_key);
2819 retry_add_item(addr2, retry_key, flags);
2822 /* Done with this address */
2824 if (result == OK) addr2->more_errno = deliver_time;
2825 post_process_one(addr2, result, logflags, DTYPE_TRANSPORT, logchar);
2827 /* If a pipe delivery generated text to be sent back, the result may be
2828 changed to FAIL, and we must copy this for subsequent addresses in the
2831 if (addr2->transport_return != result)
2833 for (addr3 = nextaddr; addr3; addr3 = addr3->next)
2835 addr3->transport_return = addr2->transport_return;
2836 addr3->basic_errno = addr2->basic_errno;
2837 addr3->message = addr2->message;
2839 result = addr2->transport_return;
2842 /* Whether or not the result was changed to FAIL, we need to copy the
2843 return_file value from the first address into all the addresses of the
2844 batch, so they are all listed in the error message. */
2846 addr2->return_file = addr->return_file;
2848 /* Change log character for recording successful deliveries. */
2850 if (result == OK) logchar = '-';
2852 } /* Loop back for next batch of addresses */
2858 /*************************************************
2859 * Sort remote deliveries *
2860 *************************************************/
2862 /* This function is called if remote_sort_domains is set. It arranges that the
2863 chain of addresses for remote deliveries is ordered according to the strings
2864 specified. Try to make this shuffling reasonably efficient by handling
2865 sequences of addresses rather than just single ones.
2872 sort_remote_deliveries(void)
2875 address_item **aptr = &addr_remote;
2876 const uschar *listptr = remote_sort_domains;
2881 && (pattern = string_nextinlist(&listptr, &sep, patbuf, sizeof(patbuf)))
2884 address_item *moved = NULL;
2885 address_item **bptr = &moved;
2889 address_item **next;
2890 deliver_domain = (*aptr)->domain; /* set $domain */
2891 if (match_isinlist(deliver_domain, (const uschar **)&pattern, UCHAR_MAX+1,
2892 &domainlist_anchor, NULL, MCL_DOMAIN, TRUE, NULL) == OK)
2894 aptr = &(*aptr)->next;
2898 next = &(*aptr)->next;
2900 && (deliver_domain = (*next)->domain, /* Set $domain */
2901 match_isinlist(deliver_domain, (const uschar **)&pattern, UCHAR_MAX+1,
2902 &domainlist_anchor, NULL, MCL_DOMAIN, TRUE, NULL)) != OK
2904 next = &(*next)->next;
2906 /* If the batch of non-matchers is at the end, add on any that were
2907 extracted further up the chain, and end this iteration. Otherwise,
2908 extract them from the chain and hang on the moved chain. */
2920 aptr = &(*aptr)->next;
2923 /* If the loop ended because the final address matched, *aptr will
2924 be NULL. Add on to the end any extracted non-matching addresses. If
2925 *aptr is not NULL, the loop ended via "break" when *next is null, that
2926 is, there was a string of non-matching addresses at the end. In this
2927 case the extracted addresses have already been added on the end. */
2929 if (!*aptr) *aptr = moved;
2935 debug_printf("remote addresses after sorting:\n");
2936 for (addr = addr_remote; addr; addr = addr->next)
2937 debug_printf(" %s\n", addr->address);
2943 /*************************************************
2944 * Read from pipe for remote delivery subprocess *
2945 *************************************************/
2947 /* This function is called when the subprocess is complete, but can also be
2948 called before it is complete, in order to empty a pipe that is full (to prevent
2949 deadlock). It must therefore keep track of its progress in the parlist data
2952 We read the pipe to get the delivery status codes and a possible error message
2953 for each address, optionally preceded by unusability data for the hosts and
2954 also by optional retry data.
2956 Read in large chunks into the big buffer and then scan through, interpreting
2957 the data therein. In most cases, only a single read will be necessary. No
2958 individual item will ever be anywhere near 2500 bytes in length, so by ensuring
2959 that we read the next chunk when there is less than 2500 bytes left in the
2960 non-final chunk, we can assume each item is complete in the buffer before
2961 handling it. Each item is written using a single write(), which is atomic for
2962 small items (less than PIPE_BUF, which seems to be at least 512 in any Unix and
2963 often bigger) so even if we are reading while the subprocess is still going, we
2964 should never have only a partial item in the buffer.
2967 poffset the offset of the parlist item
2968 eop TRUE if the process has completed
2970 Returns: TRUE if the terminating 'Z' item has been read,
2971 or there has been a disaster (i.e. no more data needed);
2976 par_read_pipe(int poffset, BOOL eop)
2979 pardata *p = parlist + poffset;
2980 address_item *addrlist = p->addrlist;
2981 address_item *addr = p->addr;
2984 uschar *endptr = big_buffer;
2985 uschar *ptr = endptr;
2986 uschar *msg = p->msg;
2987 BOOL done = p->done;
2988 BOOL unfinished = TRUE;
2989 /* minimum size to read is header size including id, subid and length */
2990 int required = PIPE_HEADER_SIZE;
2992 /* Loop through all items, reading from the pipe when necessary. The pipe
2993 is set up to be non-blocking, but there are two different Unix mechanisms in
2994 use. Exim uses O_NONBLOCK if it is defined. This returns 0 for end of file,
2995 and EAGAIN for no more data. If O_NONBLOCK is not defined, Exim uses O_NDELAY,
2996 which returns 0 for both end of file and no more data. We distinguish the
2997 two cases by taking 0 as end of file only when we know the process has
3000 Each separate item is written to the pipe in a single write(), and as they are
3001 all short items, the writes will all be atomic and we should never find
3002 ourselves in the position of having read an incomplete item. "Short" in this
3003 case can mean up to about 1K in the case when there is a long error message
3004 associated with an address. */
3006 DEBUG(D_deliver) debug_printf("reading pipe for subprocess %d (%s)\n",
3007 (int)p->pid, eop? "ended" : "not ended");
3011 retry_item *r, **rp;
3012 int remaining = endptr - ptr;
3013 uschar header[PIPE_HEADER_SIZE + 1];
3017 /* Read (first time) or top up the chars in the buffer if necessary.
3018 There will be only one read if we get all the available data (i.e. don't
3019 fill the buffer completely). */
3021 if (remaining < required && unfinished)
3024 int available = big_buffer_size - remaining;
3026 if (remaining > 0) memmove(big_buffer, ptr, remaining);
3029 endptr = big_buffer + remaining;
3030 len = read(fd, endptr, available);
3032 DEBUG(D_deliver) debug_printf("read() yielded %d\n", len);
3034 /* If the result is EAGAIN and the process is not complete, just
3035 stop reading any more and process what we have already. */
3039 if (!eop && errno == EAGAIN) len = 0; else
3041 msg = string_sprintf("failed to read pipe from transport process "
3042 "%d for transport %s: %s", pid, addr->transport->driver_name,
3048 /* If the length is zero (eof or no-more-data), just process what we
3049 already have. Note that if the process is still running and we have
3050 read all the data in the pipe (but less that "available") then we
3051 won't read any more, as "unfinished" will get set FALSE. */
3055 unfinished = len == available;
3058 /* If we are at the end of the available data, exit the loop. */
3059 if (ptr >= endptr) break;
3061 /* copy and read header */
3062 memcpy(header, ptr, PIPE_HEADER_SIZE);
3063 header[PIPE_HEADER_SIZE] = '\0';
3066 required = Ustrtol(header + 2, &endc, 10) + PIPE_HEADER_SIZE; /* header + data */
3069 msg = string_sprintf("failed to read pipe from transport process "
3070 "%d for transport %s: error reading size from header", pid, addr->transport->driver_name);
3076 debug_printf("header read id:%c,subid:%c,size:%s,required:%d,remaining:%d,unfinished:%d\n",
3077 id, subid, header+2, required, remaining, unfinished);
3079 /* is there room for the dataset we want to read ? */
3080 if (required > big_buffer_size - PIPE_HEADER_SIZE)
3082 msg = string_sprintf("failed to read pipe from transport process "
3083 "%d for transport %s: big_buffer too small! required size=%d buffer size=%d", pid, addr->transport->driver_name,
3084 required, big_buffer_size - PIPE_HEADER_SIZE);
3089 /* we wrote all datasets with atomic write() calls
3090 remaining < required only happens if big_buffer was too small
3091 to get all available data from pipe. unfinished has to be true
3093 if (remaining < required)
3097 msg = string_sprintf("failed to read pipe from transport process "
3098 "%d for transport %s: required size=%d > remaining size=%d and unfinished=false",
3099 pid, addr->transport->driver_name, required, remaining);
3104 /* step behind the header */
3105 ptr += PIPE_HEADER_SIZE;
3107 /* Handle each possible type of item, assuming the complete item is
3108 available in store. */
3112 /* Host items exist only if any hosts were marked unusable. Match
3113 up by checking the IP address. */
3116 for (h = addrlist->host_list; h; h = h->next)
3118 if (!h->address || Ustrcmp(h->address, ptr+2) != 0) continue;
3126 /* Retry items are sent in a preceding R item for each address. This is
3127 kept separate to keep each message short enough to guarantee it won't
3128 be split in the pipe. Hopefully, in the majority of cases, there won't in
3129 fact be any retry items at all.
3131 The complete set of retry items might include an item to delete a
3132 routing retry if there was a previous routing delay. However, routing
3133 retries are also used when a remote transport identifies an address error.
3134 In that case, there may also be an "add" item for the same key. Arrange
3135 that a "delete" item is dropped in favour of an "add" item. */
3138 if (!addr) goto ADDR_MISMATCH;
3140 DEBUG(D_deliver|D_retry)
3141 debug_printf("reading retry information for %s from subprocess\n",
3144 /* Cut out any "delete" items on the list. */
3146 for (rp = &(addr->retries); (r = *rp); rp = &r->next)
3147 if (Ustrcmp(r->key, ptr+1) == 0) /* Found item with same key */
3149 if ((r->flags & rf_delete) == 0) break; /* It was not "delete" */
3150 *rp = r->next; /* Excise a delete item */
3151 DEBUG(D_deliver|D_retry)
3152 debug_printf(" existing delete item dropped\n");
3155 /* We want to add a delete item only if there is no non-delete item;
3156 however we still have to step ptr through the data. */
3158 if (!r || (*ptr & rf_delete) == 0)
3160 r = store_get(sizeof(retry_item));
3161 r->next = addr->retries;
3164 r->key = string_copy(ptr);
3166 memcpy(&(r->basic_errno), ptr, sizeof(r->basic_errno));
3167 ptr += sizeof(r->basic_errno);
3168 memcpy(&(r->more_errno), ptr, sizeof(r->more_errno));
3169 ptr += sizeof(r->more_errno);
3170 r->message = (*ptr)? string_copy(ptr) : NULL;
3171 DEBUG(D_deliver|D_retry)
3172 debug_printf(" added %s item\n",
3173 ((r->flags & rf_delete) == 0)? "retry" : "delete");
3178 DEBUG(D_deliver|D_retry)
3179 debug_printf(" delete item not added: non-delete item exists\n");
3182 ptr += sizeof(r->basic_errno) + sizeof(r->more_errno);
3188 /* Put the amount of data written into the parlist block */
3191 memcpy(&(p->transport_count), ptr, sizeof(transport_count));
3192 ptr += sizeof(transport_count);
3195 /* Address items are in the order of items on the address chain. We
3196 remember the current address value in case this function is called
3197 several times to empty the pipe in stages. Information about delivery
3198 over TLS is sent in a preceding X item for each address. We don't put
3199 it in with the other info, in order to keep each message short enough to
3200 guarantee it won't be split in the pipe. */
3204 if (!addr) goto ADDR_MISMATCH; /* Below, in 'A' handler */
3208 addr->cipher = NULL;
3209 addr->peerdn = NULL;
3212 addr->cipher = string_copy(ptr);
3215 addr->peerdn = string_copy(ptr);
3220 (void) tls_import_cert(ptr, &addr->peercert);
3222 addr->peercert = NULL;
3227 (void) tls_import_cert(ptr, &addr->ourcert);
3229 addr->ourcert = NULL;
3232 # ifndef DISABLE_OCSP
3234 addr->ocsp = OCSP_NOT_REQ;
3236 addr->ocsp = *ptr - '0';
3242 #endif /*SUPPORT_TLS*/
3244 case 'C': /* client authenticator information */
3248 addr->authenticator = (*ptr)? string_copy(ptr) : NULL;
3251 addr->auth_id = (*ptr)? string_copy(ptr) : NULL;
3254 addr->auth_sndr = (*ptr)? string_copy(ptr) : NULL;
3260 #ifndef DISABLE_PRDR
3262 addr->flags |= af_prdr_used;
3267 if (!addr) goto ADDR_MISMATCH;
3268 memcpy(&(addr->dsn_aware), ptr, sizeof(addr->dsn_aware));
3269 ptr += sizeof(addr->dsn_aware);
3270 DEBUG(D_deliver) debug_printf("DSN read: addr->dsn_aware = %d\n", addr->dsn_aware);
3277 msg = string_sprintf("address count mismatch for data read from pipe "
3278 "for transport process %d for transport %s", pid,
3279 addrlist->transport->driver_name);
3286 #ifdef EXPERIMENTAL_DSN_INFO
3287 case '1': /* must arrive before A0, and applies to that addr */
3288 /* Two strings: smtp_greeting and helo_response */
3289 addr->smtp_greeting = string_copy(ptr);
3291 addr->helo_response = string_copy(ptr);
3297 addr->transport_return = *ptr++;
3298 addr->special_action = *ptr++;
3299 memcpy(&(addr->basic_errno), ptr, sizeof(addr->basic_errno));
3300 ptr += sizeof(addr->basic_errno);
3301 memcpy(&(addr->more_errno), ptr, sizeof(addr->more_errno));
3302 ptr += sizeof(addr->more_errno);
3303 memcpy(&(addr->flags), ptr, sizeof(addr->flags));
3304 ptr += sizeof(addr->flags);
3305 addr->message = (*ptr)? string_copy(ptr) : NULL;
3307 addr->user_message = (*ptr)? string_copy(ptr) : NULL;
3310 /* Always two strings for host information, followed by the port number and DNSSEC mark */
3314 h = store_get(sizeof(host_item));
3315 h->name = string_copy(ptr);
3317 h->address = string_copy(ptr);
3319 memcpy(&(h->port), ptr, sizeof(h->port));
3320 ptr += sizeof(h->port);
3321 h->dnssec = *ptr == '2' ? DS_YES
3322 : *ptr == '1' ? DS_NO
3325 addr->host_used = h;
3329 /* Finished with this address */
3336 /* Local interface address/port */
3338 if (*ptr) sending_ip_address = string_copy(ptr);
3340 if (*ptr) sending_port = atoi(CS ptr);
3344 /* Z marks the logical end of the data. It is followed by '0' if
3345 continue_transport was NULL at the end of transporting, otherwise '1'.
3346 We need to know when it becomes NULL during a delivery down a passed SMTP
3347 channel so that we don't try to pass anything more down it. Of course, for
3348 most normal messages it will remain NULL all the time. */
3353 continue_transport = NULL;
3354 continue_hostname = NULL;
3357 DEBUG(D_deliver) debug_printf("Z0%c item read\n", *ptr);
3360 /* Anything else is a disaster. */
3363 msg = string_sprintf("malformed data (%d) read from pipe for transport "
3364 "process %d for transport %s", ptr[-1], pid,
3365 addr->transport->driver_name);
3371 /* The done flag is inspected externally, to determine whether or not to
3372 call the function again when the process finishes. */
3376 /* If the process hadn't finished, and we haven't seen the end of the data
3377 or suffered a disaster, update the rest of the state, and return FALSE to
3378 indicate "not finished". */
3387 /* Close our end of the pipe, to prevent deadlock if the far end is still
3388 pushing stuff into it. */
3393 /* If we have finished without error, but haven't had data for every address,
3394 something is wrong. */
3397 msg = string_sprintf("insufficient address data read from pipe "
3398 "for transport process %d for transport %s", pid,
3399 addr->transport->driver_name);
3401 /* If an error message is set, something has gone wrong in getting back
3402 the delivery data. Put the message into each address and freeze it. */
3405 for (addr = addrlist; addr; addr = addr->next)
3407 addr->transport_return = DEFER;
3408 addr->special_action = SPECIAL_FREEZE;
3409 addr->message = msg;
3412 /* Return TRUE to indicate we have got all we need from this process, even
3413 if it hasn't actually finished yet. */
3420 /*************************************************
3421 * Post-process a set of remote addresses *
3422 *************************************************/
3424 /* Do what has to be done immediately after a remote delivery for each set of
3425 addresses, then re-write the spool if necessary. Note that post_process_one
3426 puts the address on an appropriate queue; hence we must fish off the next
3427 one first. This function is also called if there is a problem with setting
3428 up a subprocess to do a remote delivery in parallel. In this case, the final
3429 argument contains a message, and the action must be forced to DEFER.
3432 addr pointer to chain of address items
3433 logflags flags for logging
3434 msg NULL for normal cases; -> error message for unexpected problems
3435 fallback TRUE if processing fallback hosts
3441 remote_post_process(address_item *addr, int logflags, uschar *msg,
3446 /* If any host addresses were found to be unusable, add them to the unusable
3447 tree so that subsequent deliveries don't try them. */
3449 for (h = addr->host_list; h; h = h->next)
3451 if (h->status >= hstatus_unusable) tree_add_unusable(h);
3453 /* Now handle each address on the chain. The transport has placed '=' or '-'
3454 into the special_action field for each successful delivery. */
3458 address_item *next = addr->next;
3460 /* If msg == NULL (normal processing) and the result is DEFER and we are
3461 processing the main hosts and there are fallback hosts available, put the
3462 address on the list for fallback delivery. */
3464 if ( addr->transport_return == DEFER
3465 && addr->fallback_hosts
3470 addr->host_list = addr->fallback_hosts;
3471 addr->next = addr_fallback;
3472 addr_fallback = addr;
3473 DEBUG(D_deliver) debug_printf("%s queued for fallback host(s)\n", addr->address);
3476 /* If msg is set (=> unexpected problem), set it in the address before
3477 doing the ordinary post processing. */
3483 addr->message = msg;
3484 addr->transport_return = DEFER;
3486 (void)post_process_one(addr, addr->transport_return, logflags,
3487 DTYPE_TRANSPORT, addr->special_action);
3495 /* If we have just delivered down a passed SMTP channel, and that was
3496 the last address, the channel will have been closed down. Now that
3497 we have logged that delivery, set continue_sequence to 1 so that
3498 any subsequent deliveries don't get "*" incorrectly logged. */
3500 if (!continue_transport) continue_sequence = 1;
3505 /*************************************************
3506 * Wait for one remote delivery subprocess *
3507 *************************************************/
3509 /* This function is called while doing remote deliveries when either the
3510 maximum number of processes exist and we need one to complete so that another
3511 can be created, or when waiting for the last ones to complete. It must wait for
3512 the completion of one subprocess, empty the control block slot, and return a
3513 pointer to the address chain.
3516 Returns: pointer to the chain of addresses handled by the process;
3517 NULL if no subprocess found - this is an unexpected error
3520 static address_item *
3523 int poffset, status;
3524 address_item *addr, *addrlist;
3527 set_process_info("delivering %s: waiting for a remote delivery subprocess "
3528 "to finish", message_id);
3530 /* Loop until either a subprocess completes, or there are no subprocesses in
3531 existence - in which case give an error return. We cannot proceed just by
3532 waiting for a completion, because a subprocess may have filled up its pipe, and
3533 be waiting for it to be emptied. Therefore, if no processes have finished, we
3534 wait for one of the pipes to acquire some data by calling select(), with a
3535 timeout just in case.
3537 The simple approach is just to iterate after reading data from a ready pipe.
3538 This leads to non-ideal behaviour when the subprocess has written its final Z
3539 item, closed the pipe, and is in the process of exiting (the common case). A
3540 call to waitpid() yields nothing completed, but select() shows the pipe ready -
3541 reading it yields EOF, so you end up with busy-waiting until the subprocess has
3544 To avoid this, if all the data that is needed has been read from a subprocess
3545 after select(), an explicit wait() for it is done. We know that all it is doing
3546 is writing to the pipe and then exiting, so the wait should not be long.
3548 The non-blocking waitpid() is to some extent just insurance; if we could
3549 reliably detect end-of-file on the pipe, we could always know when to do a
3550 blocking wait() for a completed process. However, because some systems use
3551 NDELAY, which doesn't distinguish between EOF and pipe empty, it is easier to
3552 use code that functions without the need to recognize EOF.
3554 There's a double loop here just in case we end up with a process that is not in
3555 the list of remote delivery processes. Something has obviously gone wrong if
3556 this is the case. (For example, a process that is incorrectly left over from
3557 routing or local deliveries might be found.) The damage can be minimized by
3558 looping back and looking for another process. If there aren't any, the error
3559 return will happen. */
3561 for (;;) /* Normally we do not repeat this loop */
3563 while ((pid = waitpid(-1, &status, WNOHANG)) <= 0)
3566 fd_set select_pipes;
3567 int maxpipe, readycount;
3569 /* A return value of -1 can mean several things. If errno != ECHILD, it
3570 either means invalid options (which we discount), or that this process was
3571 interrupted by a signal. Just loop to try the waitpid() again.
3573 If errno == ECHILD, waitpid() is telling us that there are no subprocesses
3574 in existence. This should never happen, and is an unexpected error.
3575 However, there is a nasty complication when running under Linux. If "strace
3576 -f" is being used under Linux to trace this process and its children,
3577 subprocesses are "stolen" from their parents and become the children of the
3578 tracing process. A general wait such as the one we've just obeyed returns
3579 as if there are no children while subprocesses are running. Once a
3580 subprocess completes, it is restored to the parent, and waitpid(-1) finds
3581 it. Thanks to Joachim Wieland for finding all this out and suggesting a
3584 This does not happen using "truss" on Solaris, nor (I think) with other
3585 tracing facilities on other OS. It seems to be specific to Linux.
3587 What we do to get round this is to use kill() to see if any of our
3588 subprocesses are still in existence. If kill() gives an OK return, we know
3589 it must be for one of our processes - it can't be for a re-use of the pid,
3590 because if our process had finished, waitpid() would have found it. If any
3591 of our subprocesses are in existence, we proceed to use select() as if
3592 waitpid() had returned zero. I think this is safe. */
3596 if (errno != ECHILD) continue; /* Repeats the waitpid() */
3599 debug_printf("waitpid() returned -1/ECHILD: checking explicitly "
3600 "for process existence\n");
3602 for (poffset = 0; poffset < remote_max_parallel; poffset++)
3604 if ((pid = parlist[poffset].pid) != 0 && kill(pid, 0) == 0)
3606 DEBUG(D_deliver) debug_printf("process %d still exists: assume "
3607 "stolen by strace\n", (int)pid);
3608 break; /* With poffset set */
3612 if (poffset >= remote_max_parallel)
3614 DEBUG(D_deliver) debug_printf("*** no delivery children found\n");
3615 return NULL; /* This is the error return */
3619 /* A pid value greater than 0 breaks the "while" loop. A negative value has
3620 been handled above. A return value of zero means that there is at least one
3621 subprocess, but there are no completed subprocesses. See if any pipes are
3622 ready with any data for reading. */
3624 DEBUG(D_deliver) debug_printf("selecting on subprocess pipes\n");
3627 FD_ZERO(&select_pipes);
3628 for (poffset = 0; poffset < remote_max_parallel; poffset++)
3630 if (parlist[poffset].pid != 0)
3632 int fd = parlist[poffset].fd;
3633 FD_SET(fd, &select_pipes);
3634 if (fd > maxpipe) maxpipe = fd;
3638 /* Stick in a 60-second timeout, just in case. */
3643 readycount = select(maxpipe + 1, (SELECT_ARG2_TYPE *)&select_pipes,
3646 /* Scan through the pipes and read any that are ready; use the count
3647 returned by select() to stop when there are no more. Select() can return
3648 with no processes (e.g. if interrupted). This shouldn't matter.
3650 If par_read_pipe() returns TRUE, it means that either the terminating Z was
3651 read, or there was a disaster. In either case, we are finished with this
3652 process. Do an explicit wait() for the process and break the main loop if
3655 It turns out that we have to deal with the case of an interrupted system
3656 call, which can happen on some operating systems if the signal handling is
3657 set up to do that by default. */
3660 readycount > 0 && poffset < remote_max_parallel;
3663 if ( (pid = parlist[poffset].pid) != 0
3664 && FD_ISSET(parlist[poffset].fd, &select_pipes)
3668 if (par_read_pipe(poffset, FALSE)) /* Finished with this pipe */
3670 for (;;) /* Loop for signals */
3672 pid_t endedpid = waitpid(pid, &status, 0);
3673 if (endedpid == pid) goto PROCESS_DONE;
3674 if (endedpid != (pid_t)(-1) || errno != EINTR)
3675 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Unexpected error return "
3676 "%d (errno = %d) from waitpid() for process %d",
3677 (int)endedpid, errno, (int)pid);
3683 /* Now go back and look for a completed subprocess again. */
3686 /* A completed process was detected by the non-blocking waitpid(). Find the
3687 data block that corresponds to this subprocess. */
3689 for (poffset = 0; poffset < remote_max_parallel; poffset++)
3690 if (pid == parlist[poffset].pid) break;
3692 /* Found the data block; this is a known remote delivery process. We don't
3693 need to repeat the outer loop. This should be what normally happens. */
3695 if (poffset < remote_max_parallel) break;
3697 /* This situation is an error, but it's probably better to carry on looking
3698 for another process than to give up (as we used to do). */
3700 log_write(0, LOG_MAIN|LOG_PANIC, "Process %d finished: not found in remote "
3701 "transport process list", pid);
3702 } /* End of the "for" loop */
3704 /* Come here when all the data was completely read after a select(), and
3705 the process in pid has been wait()ed for. */
3712 debug_printf("remote delivery process %d ended\n", (int)pid);
3714 debug_printf("remote delivery process %d ended: status=%04x\n", (int)pid,
3718 set_process_info("delivering %s", message_id);
3720 /* Get the chain of processed addresses */
3722 addrlist = parlist[poffset].addrlist;
3724 /* If the process did not finish cleanly, record an error and freeze (except
3725 for SIGTERM, SIGKILL and SIGQUIT), and also ensure the journal is not removed,
3726 in case the delivery did actually happen. */
3728 if ((status & 0xffff) != 0)
3731 int msb = (status >> 8) & 255;
3732 int lsb = status & 255;
3733 int code = (msb == 0)? (lsb & 0x7f) : msb;
3735 msg = string_sprintf("%s transport process returned non-zero status 0x%04x: "
3737 addrlist->transport->driver_name,
3739 (msb == 0)? "terminated by signal" : "exit code",
3742 if (msb != 0 || (code != SIGTERM && code != SIGKILL && code != SIGQUIT))
3743 addrlist->special_action = SPECIAL_FREEZE;
3745 for (addr = addrlist; addr; addr = addr->next)
3747 addr->transport_return = DEFER;
3748 addr->message = msg;
3751 remove_journal = FALSE;
3754 /* Else complete reading the pipe to get the result of the delivery, if all
3755 the data has not yet been obtained. */
3757 else if (!parlist[poffset].done) (void)par_read_pipe(poffset, TRUE);
3759 /* Put the data count and return path into globals, mark the data slot unused,
3760 decrement the count of subprocesses, and return the address chain. */
3762 transport_count = parlist[poffset].transport_count;
3763 used_return_path = parlist[poffset].return_path;
3764 parlist[poffset].pid = 0;
3771 /*************************************************
3772 * Wait for subprocesses and post-process *
3773 *************************************************/
3775 /* This function waits for subprocesses until the number that are still running
3776 is below a given threshold. For each complete subprocess, the addresses are
3777 post-processed. If we can't find a running process, there is some shambles.
3778 Better not bomb out, as that might lead to multiple copies of the message. Just
3779 log and proceed as if all done.
3782 max maximum number of subprocesses to leave running
3783 fallback TRUE if processing fallback hosts
3789 par_reduce(int max, BOOL fallback)
3791 while (parcount > max)
3793 address_item *doneaddr = par_wait();
3796 log_write(0, LOG_MAIN|LOG_PANIC,
3797 "remote delivery process count got out of step");
3802 transport_instance * tp = doneaddr->transport;
3803 if (tp->max_parallel)
3804 enq_end(string_sprintf("tpt-serialize-%s", tp->name));
3806 remote_post_process(doneaddr, LOG_MAIN, NULL, fallback);
3815 rmt_dlv_checked_write(int fd, char id, char subid, void * buf, int size)
3817 uschar writebuffer[PIPE_HEADER_SIZE + BIG_BUFFER_SIZE];
3820 /* we assume that size can't get larger then BIG_BUFFER_SIZE which currently is set to 16k */
3821 /* complain to log if someone tries with buffer sizes we can't handle*/
3825 log_write(0, LOG_MAIN|LOG_PANIC_DIE,
3826 "Failed writing transport result to pipe: can't handle buffers > 99999 bytes. truncating!\n");
3830 /* to keep the write() atomic we build header in writebuffer and copy buf behind */
3831 /* two write() calls would increase the complexity of reading from pipe */
3833 /* convert size to human readable string prepended by id and subid */
3834 header_length = snprintf(CS writebuffer, PIPE_HEADER_SIZE+1, "%c%c%05d", id, subid, size);
3835 if (header_length != PIPE_HEADER_SIZE)
3837 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "header snprintf failed\n");
3838 writebuffer[0] = '\0';
3841 DEBUG(D_deliver) debug_printf("header write id:%c,subid:%c,size:%d,final:%s\n",
3842 id, subid, size, writebuffer);
3844 if (buf && size > 0)
3845 memcpy(writebuffer + PIPE_HEADER_SIZE, buf, size);
3847 size += PIPE_HEADER_SIZE;
3848 int ret = write(fd, writebuffer, size);
3850 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Failed writing transport result to pipe: %s\n",
3851 ret == -1 ? strerror(errno) : "short write");
3854 /*************************************************
3855 * Do remote deliveries *
3856 *************************************************/
3858 /* This function is called to process the addresses in addr_remote. We must
3859 pick off the queue all addresses that have the same transport, remote
3860 destination, and errors address, and hand them to the transport in one go,
3861 subject to some configured limitations. If this is a run to continue delivering
3862 to an existing delivery channel, skip all but those addresses that can go to
3863 that channel. The skipped addresses just get deferred.
3865 If mua_wrapper is set, all addresses must be able to be sent in a single
3866 transaction. If not, this function yields FALSE.
3868 In Exim 4, remote deliveries are always done in separate processes, even
3869 if remote_max_parallel = 1 or if there's only one delivery to do. The reason
3870 is so that the base process can retain privilege. This makes the
3871 implementation of fallback transports feasible (though not initially done.)
3873 We create up to the configured number of subprocesses, each of which passes
3874 back the delivery state via a pipe. (However, when sending down an existing
3875 connection, remote_max_parallel is forced to 1.)
3878 fallback TRUE if processing fallback hosts
3880 Returns: TRUE normally
3881 FALSE if mua_wrapper is set and the addresses cannot all be sent
3886 do_remote_deliveries(BOOL fallback)
3892 parcount = 0; /* Number of executing subprocesses */
3894 /* When sending down an existing channel, only do one delivery at a time.
3895 We use a local variable (parmax) to hold the maximum number of processes;
3896 this gets reduced from remote_max_parallel if we can't create enough pipes. */
3898 if (continue_transport) remote_max_parallel = 1;
3899 parmax = remote_max_parallel;
3901 /* If the data for keeping a list of processes hasn't yet been
3906 parlist = store_get(remote_max_parallel * sizeof(pardata));
3907 for (poffset = 0; poffset < remote_max_parallel; poffset++)
3908 parlist[poffset].pid = 0;
3911 /* Now loop for each remote delivery */
3913 for (delivery_count = 0; addr_remote; delivery_count++)
3919 int address_count = 1;
3920 int address_count_max;
3922 BOOL use_initgroups;
3923 BOOL pipe_done = FALSE;
3924 transport_instance *tp;
3925 address_item **anchor = &addr_remote;
3926 address_item *addr = addr_remote;
3927 address_item *last = addr;
3930 uschar * serialize_key = NULL;
3932 /* Pull the first address right off the list. */
3934 addr_remote = addr->next;
3937 DEBUG(D_deliver|D_transport)
3938 debug_printf("--------> %s <--------\n", addr->address);
3940 /* If no transport has been set, there has been a big screw-up somewhere. */
3942 if (!(tp = addr->transport))
3944 disable_logging = FALSE; /* Jic */
3945 panicmsg = US"No transport set by router";
3946 goto panic_continue;
3949 /* Check that this base address hasn't previously been delivered to this
3950 transport. The check is necessary at this point to handle homonymic addresses
3951 correctly in cases where the pattern of redirection changes between delivery
3952 attempts. Non-homonymic previous delivery is detected earlier, at routing
3955 if (previously_transported(addr, FALSE)) continue;
3957 /* Force failure if the message is too big. */
3959 if (tp->message_size_limit)
3961 int rc = check_message_size(tp, addr);
3964 addr->transport_return = rc;
3965 remote_post_process(addr, LOG_MAIN, NULL, fallback);
3970 /* Get the flag which specifies whether the transport can handle different
3971 domains that nevertheless resolve to the same set of hosts. If it needs
3972 expanding, get variables set: $address_data, $domain_data, $localpart_data,
3973 $host, $host_address, $host_port. */
3974 if (tp->expand_multi_domain)
3975 deliver_set_expansions(addr);
3977 if (exp_bool(addr, US"transport", tp->name, D_transport,
3978 US"multi_domain", tp->multi_domain, tp->expand_multi_domain,
3979 &multi_domain) != OK)
3981 deliver_set_expansions(NULL);
3982 panicmsg = addr->message;
3983 goto panic_continue;
3986 /* Get the maximum it can handle in one envelope, with zero meaning
3987 unlimited, which is forced for the MUA wrapper case. */
3989 address_count_max = tp->max_addresses;
3990 if (address_count_max == 0 || mua_wrapper) address_count_max = 999999;
3993 /************************************************************************/
3994 /***** This is slightly experimental code, but should be safe. *****/
3996 /* The address_count_max value is the maximum number of addresses that the
3997 transport can send in one envelope. However, the transport must be capable of
3998 dealing with any number of addresses. If the number it gets exceeds its
3999 envelope limitation, it must send multiple copies of the message. This can be
4000 done over a single connection for SMTP, so uses less resources than making
4001 multiple connections. On the other hand, if remote_max_parallel is greater
4002 than one, it is perhaps a good idea to use parallel processing to move the
4003 message faster, even if that results in multiple simultaneous connections to
4006 How can we come to some compromise between these two ideals? What we do is to
4007 limit the number of addresses passed to a single instance of a transport to
4008 the greater of (a) its address limit (rcpt_max for SMTP) and (b) the total
4009 number of addresses routed to remote transports divided by
4010 remote_max_parallel. For example, if the message has 100 remote recipients,
4011 remote max parallel is 2, and rcpt_max is 10, we'd never send more than 50 at
4012 once. But if rcpt_max is 100, we could send up to 100.
4014 Of course, not all the remotely addresses in a message are going to go to the
4015 same set of hosts (except in smarthost configurations), so this is just a
4016 heuristic way of dividing up the work.
4018 Furthermore (1), because this may not be wanted in some cases, and also to
4019 cope with really pathological cases, there is also a limit to the number of
4020 messages that are sent over one connection. This is the same limit that is
4021 used when sending several different messages over the same connection.
4022 Continue_sequence is set when in this situation, to the number sent so
4023 far, including this message.
4025 Furthermore (2), when somebody explicitly sets the maximum value to 1, it
4026 is probably because they are using VERP, in which case they want to pass only
4027 one address at a time to the transport, in order to be able to use
4028 $local_part and $domain in constructing a new return path. We could test for
4029 the use of these variables, but as it is so likely they will be used when the
4030 maximum is 1, we don't bother. Just leave the value alone. */
4032 if ( address_count_max != 1
4033 && address_count_max < remote_delivery_count/remote_max_parallel
4036 int new_max = remote_delivery_count/remote_max_parallel;
4037 int message_max = tp->connection_max_messages;
4038 if (connection_max_messages >= 0) message_max = connection_max_messages;
4039 message_max -= continue_sequence - 1;
4040 if (message_max > 0 && new_max > address_count_max * message_max)
4041 new_max = address_count_max * message_max;
4042 address_count_max = new_max;
4045 /************************************************************************/
4048 /* Pick off all addresses which have the same transport, errors address,
4049 destination, and extra headers. In some cases they point to the same host
4050 list, but we also need to check for identical host lists generated from
4051 entirely different domains. The host list pointers can be NULL in the case
4052 where the hosts are defined in the transport. There is also a configured
4053 maximum limit of addresses that can be handled at once (see comments above
4054 for how it is computed).
4055 If the transport does not handle multiple domains, enforce that also,
4056 and if it might need a per-address check for this, re-evaluate it.
4059 while ((next = *anchor) && address_count < address_count_max)
4062 if ( (multi_domain || Ustrcmp(next->domain, addr->domain) == 0)
4063 && tp == next->transport
4064 && same_hosts(next->host_list, addr->host_list)
4065 && same_strings(next->prop.errors_address, addr->prop.errors_address)
4066 && same_headers(next->prop.extra_headers, addr->prop.extra_headers)
4067 && same_ugid(tp, next, addr)
4068 && ( next->prop.remove_headers == addr->prop.remove_headers
4069 || ( next->prop.remove_headers
4070 && addr->prop.remove_headers
4071 && Ustrcmp(next->prop.remove_headers, addr->prop.remove_headers) == 0
4075 !tp->expand_multi_domain || (deliver_set_expansions(next), 1),
4077 US"transport", next->transport->name, D_transport,
4078 US"multi_domain", next->transport->multi_domain,
4079 next->transport->expand_multi_domain, &md) == OK
4084 *anchor = next->next;
4086 next->first = addr; /* remember top one (for retry processing) */
4091 else anchor = &(next->next);
4092 deliver_set_expansions(NULL);
4095 /* If we are acting as an MUA wrapper, all addresses must go in a single
4096 transaction. If not, put them back on the chain and yield FALSE. */
4098 if (mua_wrapper && addr_remote)
4100 last->next = addr_remote;
4105 /* If the transport is limited for parallellism, enforce that here.
4106 The hints DB entry is decremented in par_reduce(), when we reap the
4107 transport process. */
4109 if (tpt_parallel_check(tp, addr, &serialize_key))
4110 if ((panicmsg = expand_string_message))
4111 goto panic_continue;
4113 continue; /* Loop for the next set of addresses. */
4115 /* Set up the expansion variables for this set of addresses */
4117 deliver_set_expansions(addr);
4119 /* Ensure any transport-set auth info is fresh */
4120 addr->authenticator = addr->auth_id = addr->auth_sndr = NULL;
4122 /* Compute the return path, expanding a new one if required. The old one
4123 must be set first, as it might be referred to in the expansion. */
4125 if(addr->prop.errors_address)
4126 return_path = addr->prop.errors_address;
4127 #ifdef EXPERIMENTAL_SRS
4128 else if(addr->prop.srs_sender)
4129 return_path = addr->prop.srs_sender;
4132 return_path = sender_address;
4134 if (tp->return_path)
4136 uschar *new_return_path = expand_string(tp->return_path);
4137 if (new_return_path)
4138 return_path = new_return_path;
4139 else if (!expand_string_forcedfail)
4141 panicmsg = string_sprintf("Failed to expand return path \"%s\": %s",
4142 tp->return_path, expand_string_message);
4147 /* Find the uid, gid, and use_initgroups setting for this transport. Failure
4148 logs and sets up error messages, so we just post-process and continue with
4149 the next address. */
4151 if (!findugid(addr, tp, &uid, &gid, &use_initgroups))
4157 /* If this transport has a setup function, call it now so that it gets
4158 run in this process and not in any subprocess. That way, the results of
4159 any setup that are retained by the transport can be reusable. One of the
4160 things the setup does is to set the fallback host lists in the addresses.
4161 That is why it is called at this point, before the continue delivery
4162 processing, because that might use the fallback hosts. */
4165 (void)((tp->setup)(addr->transport, addr, NULL, uid, gid, NULL));
4167 /* If this is a run to continue delivery down an already-established
4168 channel, check that this set of addresses matches the transport and
4169 the channel. If it does not, defer the addresses. If a host list exists,
4170 we must check that the continue host is on the list. Otherwise, the
4171 host is set in the transport. */
4173 continue_more = FALSE; /* In case got set for the last lot */
4174 if (continue_transport)
4176 BOOL ok = Ustrcmp(continue_transport, tp->name) == 0;
4177 if (ok && addr->host_list)
4181 for (h = addr->host_list; h; h = h->next)
4182 if (Ustrcmp(h->name, continue_hostname) == 0)
4183 { ok = TRUE; break; }
4186 /* Addresses not suitable; defer or queue for fallback hosts (which
4187 might be the continue host) and skip to next address. */
4191 DEBUG(D_deliver) debug_printf("not suitable for continue_transport\n");
4192 if (serialize_key) enq_end(serialize_key);
4194 if (addr->fallback_hosts && !fallback)
4196 for (next = addr; ; next = next->next)
4198 next->host_list = next->fallback_hosts;
4199 DEBUG(D_deliver) debug_printf("%s queued for fallback host(s)\n", next->address);
4200 if (!next->next) break;
4202 next->next = addr_fallback;
4203 addr_fallback = addr;
4208 while (next->next) next = next->next;
4209 next->next = addr_defer;
4216 /* Set a flag indicating whether there are further addresses that list
4217 the continued host. This tells the transport to leave the channel open,
4218 but not to pass it to another delivery process. */
4220 for (next = addr_remote; next; next = next->next)
4223 for (h = next->host_list; h; h = h->next)
4224 if (Ustrcmp(h->name, continue_hostname) == 0)
4225 { continue_more = TRUE; break; }
4229 /* The transports set up the process info themselves as they may connect
4230 to more than one remote machine. They also have to set up the filter
4231 arguments, if required, so that the host name and address are available
4234 transport_filter_argv = NULL;
4236 /* Create the pipe for inter-process communication. If pipe creation
4237 fails, it is probably because the value of remote_max_parallel is so
4238 large that too many file descriptors for pipes have been created. Arrange
4239 to wait for a process to finish, and then try again. If we still can't
4240 create a pipe when all processes have finished, break the retry loop. */
4244 if (pipe(pfd) == 0) pipe_done = TRUE;
4245 else if (parcount > 0) parmax = parcount;
4248 /* We need to make the reading end of the pipe non-blocking. There are
4249 two different options for this. Exim is cunningly (I hope!) coded so
4250 that it can use either of them, though it prefers O_NONBLOCK, which
4251 distinguishes between EOF and no-more-data. */
4254 (void)fcntl(pfd[pipe_read], F_SETFL, O_NONBLOCK);
4256 (void)fcntl(pfd[pipe_read], F_SETFL, O_NDELAY);
4259 /* If the maximum number of subprocesses already exist, wait for a process
4260 to finish. If we ran out of file descriptors, parmax will have been reduced
4261 from its initial value of remote_max_parallel. */
4263 par_reduce(parmax - 1, fallback);
4266 /* If we failed to create a pipe and there were no processes to wait
4267 for, we have to give up on this one. Do this outside the above loop
4268 so that we can continue the main loop. */
4272 panicmsg = string_sprintf("unable to create pipe: %s", strerror(errno));
4276 /* Find a free slot in the pardata list. Must do this after the possible
4277 waiting for processes to finish, because a terminating process will free
4280 for (poffset = 0; poffset < remote_max_parallel; poffset++)
4281 if (parlist[poffset].pid == 0)
4284 /* If there isn't one, there has been a horrible disaster. */
4286 if (poffset >= remote_max_parallel)
4288 (void)close(pfd[pipe_write]);
4289 (void)close(pfd[pipe_read]);
4290 panicmsg = US"Unexpectedly no free subprocess slot";
4294 /* Now fork a subprocess to do the remote delivery, but before doing so,
4295 ensure that any cached resourses are released so as not to interfere with
4296 what happens in the subprocess. */
4300 if ((pid = fork()) == 0)
4302 int fd = pfd[pipe_write];
4305 /* Setting this global in the subprocess means we need never clear it */
4306 transport_name = tp->name;
4308 /* There are weird circumstances in which logging is disabled */
4309 disable_logging = tp->disable_logging;
4311 /* Show pids on debug output if parallelism possible */
4313 if (parmax > 1 && (parcount > 0 || addr_remote))
4315 DEBUG(D_any|D_v) debug_selector |= D_pid;
4316 DEBUG(D_deliver) debug_printf("Remote delivery process started\n");
4319 /* Reset the random number generator, so different processes don't all
4320 have the same sequence. In the test harness we want different, but
4321 predictable settings for each delivery process, so do something explicit
4322 here rather they rely on the fixed reset in the random number function. */
4324 random_seed = running_in_test_harness? 42 + 2*delivery_count : 0;
4326 /* Set close-on-exec on the pipe so that it doesn't get passed on to
4327 a new process that may be forked to do another delivery down the same
4330 (void)fcntl(fd, F_SETFD, fcntl(fd, F_GETFD) | FD_CLOEXEC);
4332 /* Close open file descriptors for the pipes of other processes
4333 that are running in parallel. */
4335 for (poffset = 0; poffset < remote_max_parallel; poffset++)
4336 if (parlist[poffset].pid != 0) (void)close(parlist[poffset].fd);
4338 /* This process has inherited a copy of the file descriptor
4339 for the data file, but its file pointer is shared with all the
4340 other processes running in parallel. Therefore, we have to re-open
4341 the file in order to get a new file descriptor with its own
4342 file pointer. We don't need to lock it, as the lock is held by
4343 the parent process. There doesn't seem to be any way of doing
4344 a dup-with-new-file-pointer. */
4346 (void)close(deliver_datafile);
4347 sprintf(CS spoolname, "%s/input/%s/%s-D", spool_directory, message_subdir,
4349 deliver_datafile = Uopen(spoolname, O_RDWR | O_APPEND, 0);
4351 if (deliver_datafile < 0)
4352 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Failed to reopen %s for remote "
4353 "parallel delivery: %s", spoolname, strerror(errno));
4355 /* Set the close-on-exec flag */
4357 (void)fcntl(deliver_datafile, F_SETFD, fcntl(deliver_datafile, F_GETFD) |
4360 /* Set the uid/gid of this process; bombs out on failure. */
4362 exim_setugid(uid, gid, use_initgroups,
4363 string_sprintf("remote delivery to %s with transport=%s",
4364 addr->address, tp->name));
4366 /* Close the unwanted half of this process' pipe, set the process state,
4367 and run the transport. Afterwards, transport_count will contain the number
4368 of bytes written. */
4370 (void)close(pfd[pipe_read]);
4371 set_process_info("delivering %s using %s", message_id, tp->name);
4372 debug_print_string(tp->debug_string);
4373 if (!(tp->info->code)(addr->transport, addr)) replicate_status(addr);
4375 set_process_info("delivering %s (just run %s for %s%s in subprocess)",
4376 message_id, tp->name, addr->address, addr->next ? ", ..." : "");
4378 /* Ensure any cached resources that we used are now released */
4382 /* Pass the result back down the pipe. This is a lot more information
4383 than is needed for a local delivery. We have to send back the error
4384 status for each address, the usability status for each host that is
4385 flagged as unusable, and all the retry items. When TLS is in use, we
4386 send also the cipher and peerdn information. Each type of information
4387 is flagged by an identifying byte, and is then in a fixed format (with
4388 strings terminated by zeros), and there is a final terminator at the
4389 end. The host information and retry information is all attached to
4390 the first address, so that gets sent at the start. */
4392 /* Host unusability information: for most success cases this will
4395 for (h = addr->host_list; h; h = h->next)
4397 if (!h->address || h->status < hstatus_unusable) continue;
4398 sprintf(CS big_buffer, "%c%c%s", h->status, h->why, h->address);
4399 rmt_dlv_checked_write(fd, 'H', '0', big_buffer, Ustrlen(big_buffer+2) + 3);
4402 /* The number of bytes written. This is the same for each address. Even
4403 if we sent several copies of the message down the same connection, the
4404 size of each one is the same, and it's that value we have got because
4405 transport_count gets reset before calling transport_write_message(). */
4407 memcpy(big_buffer, &transport_count, sizeof(transport_count));
4408 rmt_dlv_checked_write(fd, 'S', '0', big_buffer, sizeof(transport_count));
4410 /* Information about what happened to each address. Four item types are
4411 used: an optional 'X' item first, for TLS information, then an optional "C"
4412 item for any client-auth info followed by 'R' items for any retry settings,
4413 and finally an 'A' item for the remaining data. */
4415 for(; addr; addr = addr->next)
4420 /* The certificate verification status goes into the flags */
4421 if (tls_out.certificate_verified) setflag(addr, af_cert_verified);
4422 #ifdef EXPERIMENTAL_DANE
4423 if (tls_out.dane_verified) setflag(addr, af_dane_verified);
4426 /* Use an X item only if there's something to send */
4431 sprintf(CS ptr, "%.128s", addr->cipher);
4437 sprintf(CS ptr, "%.512s", addr->peerdn);
4441 rmt_dlv_checked_write(fd, 'X', '1', big_buffer, ptr - big_buffer);
4446 if (!tls_export_cert(ptr, big_buffer_size-2, addr->peercert))
4450 rmt_dlv_checked_write(fd, 'X', '2', big_buffer, ptr - big_buffer);
4455 if (!tls_export_cert(ptr, big_buffer_size-2, addr->ourcert))
4459 rmt_dlv_checked_write(fd, 'X', '3', big_buffer, ptr - big_buffer);
4461 # ifndef DISABLE_OCSP
4462 if (addr->ocsp > OCSP_NOT_REQ)
4465 sprintf(CS ptr, "%c", addr->ocsp + '0');
4467 rmt_dlv_checked_write(fd, 'X', '4', big_buffer, ptr - big_buffer);
4470 #endif /*SUPPORT_TLS*/
4472 if (client_authenticator)
4475 sprintf(CS big_buffer, "%.64s", client_authenticator);
4477 rmt_dlv_checked_write(fd, 'C', '1', big_buffer, ptr - big_buffer);
4479 if (client_authenticated_id)
4482 sprintf(CS big_buffer, "%.64s", client_authenticated_id);
4484 rmt_dlv_checked_write(fd, 'C', '2', big_buffer, ptr - big_buffer);
4486 if (client_authenticated_sender)
4489 sprintf(CS big_buffer, "%.64s", client_authenticated_sender);
4491 rmt_dlv_checked_write(fd, 'C', '3', big_buffer, ptr - big_buffer);
4494 #ifndef DISABLE_PRDR
4495 if (addr->flags & af_prdr_used)
4496 rmt_dlv_checked_write(fd, 'P', '0', NULL, 0);
4499 memcpy(big_buffer, &addr->dsn_aware, sizeof(addr->dsn_aware));
4500 rmt_dlv_checked_write(fd, 'D', '0', big_buffer, sizeof(addr->dsn_aware));
4501 DEBUG(D_deliver) debug_printf("DSN write: addr->dsn_aware = %d\n", addr->dsn_aware);
4503 /* Retry information: for most success cases this will be null. */
4505 for (r = addr->retries; r; r = r->next)
4507 sprintf(CS big_buffer, "%c%.500s", r->flags, r->key);
4508 ptr = big_buffer + Ustrlen(big_buffer+2) + 3;
4509 memcpy(ptr, &(r->basic_errno), sizeof(r->basic_errno));
4510 ptr += sizeof(r->basic_errno);
4511 memcpy(ptr, &(r->more_errno), sizeof(r->more_errno));
4512 ptr += sizeof(r->more_errno);
4513 if (!r->message) *ptr++ = 0; else
4515 sprintf(CS ptr, "%.512s", r->message);
4518 rmt_dlv_checked_write(fd, 'R', '0', big_buffer, ptr - big_buffer);
4521 #ifdef EXPERIMENTAL_DSN_INFO
4522 /*um, are they really per-addr? Other per-conn stuff is not (auth, tls). But host_used is! */
4523 if (addr->smtp_greeting)
4526 DEBUG(D_deliver) debug_printf("smtp_greeting '%s'\n", addr->smtp_greeting);
4527 sprintf(CS ptr, "%.128s", addr->smtp_greeting);
4529 if (addr->helo_response)
4531 DEBUG(D_deliver) debug_printf("helo_response '%s'\n", addr->helo_response);
4532 sprintf(CS ptr, "%.128s", addr->helo_response);
4537 rmt_dlv_checked_write(fd, 'A', '1', big_buffer, ptr - big_buffer);
4541 /* The rest of the information goes in an 'A0' item. */
4543 sprintf(CS big_buffer, "%c%c", addr->transport_return,
4544 addr->special_action);
4545 ptr = big_buffer + 2;
4546 memcpy(ptr, &(addr->basic_errno), sizeof(addr->basic_errno));
4547 ptr += sizeof(addr->basic_errno);
4548 memcpy(ptr, &(addr->more_errno), sizeof(addr->more_errno));
4549 ptr += sizeof(addr->more_errno);
4550 memcpy(ptr, &(addr->flags), sizeof(addr->flags));
4551 ptr += sizeof(addr->flags);
4553 if (!addr->message) *ptr++ = 0; else
4555 sprintf(CS ptr, "%.1024s", addr->message);
4559 if (!addr->user_message) *ptr++ = 0; else
4561 sprintf(CS ptr, "%.1024s", addr->user_message);
4565 if (!addr->host_used) *ptr++ = 0; else
4567 sprintf(CS ptr, "%.256s", addr->host_used->name);
4569 sprintf(CS ptr, "%.64s", addr->host_used->address);
4571 memcpy(ptr, &(addr->host_used->port), sizeof(addr->host_used->port));
4572 ptr += sizeof(addr->host_used->port);
4574 /* DNS lookup status */
4575 *ptr++ = addr->host_used->dnssec==DS_YES ? '2'
4576 : addr->host_used->dnssec==DS_NO ? '1' : '0';
4579 rmt_dlv_checked_write(fd, 'A', '0', big_buffer, ptr - big_buffer);
4582 /* Local interface address/port */
4583 #ifdef EXPERIMENTAL_DSN_INFO
4584 if (sending_ip_address)
4586 if (LOGGING(incoming_interface) && sending_ip_address)
4589 uschar * ptr = big_buffer;
4590 sprintf(CS ptr, "%.128s", sending_ip_address);
4592 sprintf(CS ptr, "%d", sending_port);
4595 rmt_dlv_checked_write(fd, 'I', '0', big_buffer, ptr - big_buffer);
4598 /* Add termination flag, close the pipe, and that's it. The character
4599 after 'Z' indicates whether continue_transport is now NULL or not.
4600 A change from non-NULL to NULL indicates a problem with a continuing
4603 big_buffer[0] = continue_transport ? '1' : '0';
4604 rmt_dlv_checked_write(fd, 'Z', '0', big_buffer, 1);
4609 /* Back in the mainline: close the unwanted half of the pipe. */
4611 (void)close(pfd[pipe_write]);
4613 /* Fork failed; defer with error message */
4617 (void)close(pfd[pipe_read]);
4618 panicmsg = string_sprintf("fork failed for remote delivery to %s: %s",
4619 addr->domain, strerror(errno));
4623 /* Fork succeeded; increment the count, and remember relevant data for
4624 when the process finishes. */
4627 parlist[poffset].addrlist = parlist[poffset].addr = addr;
4628 parlist[poffset].pid = pid;
4629 parlist[poffset].fd = pfd[pipe_read];
4630 parlist[poffset].done = FALSE;
4631 parlist[poffset].msg = NULL;
4632 parlist[poffset].return_path = return_path;
4634 /* If the process we've just started is sending a message down an existing
4635 channel, wait for it now. This ensures that only one such process runs at
4636 once, whatever the value of remote_max parallel. Otherwise, we might try to
4637 send two or more messages simultaneously down the same channel. This could
4638 happen if there are different domains that include the same host in otherwise
4639 different host lists.
4641 Also, if the transport closes down the channel, this information gets back
4642 (continue_transport gets set to NULL) before we consider any other addresses
4645 if (continue_transport) par_reduce(0, fallback);
4647 /* Otherwise, if we are running in the test harness, wait a bit, to let the
4648 newly created process get going before we create another process. This should
4649 ensure repeatability in the tests. We only need to wait a tad. */
4651 else if (running_in_test_harness) millisleep(500);
4656 if (serialize_key) enq_end(serialize_key);
4658 remote_post_process(addr, LOG_MAIN|LOG_PANIC, panicmsg, fallback);
4662 /* Reached the end of the list of addresses. Wait for all the subprocesses that
4663 are still running and post-process their addresses. */
4665 par_reduce(0, fallback);
4672 /*************************************************
4673 * Split an address into local part and domain *
4674 *************************************************/
4676 /* This function initializes an address for routing by splitting it up into a
4677 local part and a domain. The local part is set up twice - once in its original
4678 casing, and once in lower case, and it is dequoted. We also do the "percent
4679 hack" for configured domains. This may lead to a DEFER result if a lookup
4680 defers. When a percent-hacking takes place, we insert a copy of the original
4681 address as a new parent of this address, as if we have had a redirection.
4684 addr points to an addr_item block containing the address
4687 DEFER - could not determine if domain is %-hackable
4691 deliver_split_address(address_item *addr)
4693 uschar *address = addr->address;
4694 uschar *domain = Ustrrchr(address, '@');
4696 int len = domain - address;
4698 addr->domain = string_copylc(domain+1); /* Domains are always caseless */
4700 /* The implication in the RFCs (though I can't say I've seen it spelled out
4701 explicitly) is that quoting should be removed from local parts at the point
4702 where they are locally interpreted. [The new draft "821" is more explicit on
4703 this, Jan 1999.] We know the syntax is valid, so this can be done by simply
4704 removing quoting backslashes and any unquoted doublequotes. */
4706 t = addr->cc_local_part = store_get(len+1);
4709 register int c = *address++;
4710 if (c == '\"') continue;
4720 /* We do the percent hack only for those domains that are listed in
4721 percent_hack_domains. A loop is required, to copy with multiple %-hacks. */
4723 if (percent_hack_domains)
4726 uschar *new_address = NULL;
4727 uschar *local_part = addr->cc_local_part;
4729 deliver_domain = addr->domain; /* set $domain */
4731 while ( (rc = match_isinlist(deliver_domain, (const uschar **)&percent_hack_domains, 0,
4732 &domainlist_anchor, addr->domain_cache, MCL_DOMAIN, TRUE, NULL))
4734 && (t = Ustrrchr(local_part, '%')) != NULL
4737 new_address = string_copy(local_part);
4738 new_address[t - local_part] = '@';
4739 deliver_domain = string_copylc(t+1);
4740 local_part = string_copyn(local_part, t - local_part);
4743 if (rc == DEFER) return DEFER; /* lookup deferred */
4745 /* If hackery happened, set up new parent and alter the current address. */
4749 address_item *new_parent = store_get(sizeof(address_item));
4750 *new_parent = *addr;
4751 addr->parent = new_parent;
4752 addr->address = new_address;
4753 addr->unique = string_copy(new_address);
4754 addr->domain = deliver_domain;
4755 addr->cc_local_part = local_part;
4756 DEBUG(D_deliver) debug_printf("%%-hack changed address to: %s\n",
4761 /* Create the lowercased version of the final local part, and make that the
4762 default one to be used. */
4764 addr->local_part = addr->lc_local_part = string_copylc(addr->cc_local_part);
4771 /*************************************************
4772 * Get next error message text *
4773 *************************************************/
4775 /* If f is not NULL, read the next "paragraph", from a customized error message
4776 text file, terminated by a line containing ****, and expand it.
4779 f NULL or a file to read from
4780 which string indicating which string (for errors)
4782 Returns: NULL or an expanded string
4786 next_emf(FILE *f, uschar *which)
4790 uschar *para, *yield;
4793 if (!f) return NULL;
4795 if (!Ufgets(buffer, sizeof(buffer), f) || Ustrcmp(buffer, "****\n") == 0)
4798 para = store_get(size);
4801 para = string_cat(para, &size, &ptr, buffer, Ustrlen(buffer));
4802 if (!Ufgets(buffer, sizeof(buffer), f) || Ustrcmp(buffer, "****\n") == 0)
4807 if ((yield = expand_string(para)))
4810 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand string from "
4811 "bounce_message_file or warn_message_file (%s): %s", which,
4812 expand_string_message);
4819 /*************************************************
4820 * Close down a passed transport channel *
4821 *************************************************/
4823 /* This function is called when a passed transport channel cannot be used.
4824 It attempts to close it down tidily. The yield is always DELIVER_NOT_ATTEMPTED
4825 so that the function call can be the argument of a "return" statement.
4828 Returns: DELIVER_NOT_ATTEMPTED
4832 continue_closedown(void)
4834 if (continue_transport)
4836 transport_instance *t;
4837 for (t = transports; t; t = t->next)
4838 if (Ustrcmp(t->name, continue_transport) == 0)
4840 if (t->info->closedown) (t->info->closedown)(t);
4844 return DELIVER_NOT_ATTEMPTED;
4850 /*************************************************
4851 * Print address information *
4852 *************************************************/
4854 /* This function is called to output an address, or information about an
4855 address, for bounce or defer messages. If the hide_child flag is set, all we
4856 output is the original ancestor address.
4859 addr points to the address
4860 f the FILE to print to
4861 si an initial string
4862 sc a continuation string for before "generated"
4865 Returns: TRUE if the address is not hidden
4869 print_address_information(address_item *addr, FILE *f, uschar *si, uschar *sc,
4873 uschar *printed = US"";
4874 address_item *ancestor = addr;
4875 while (ancestor->parent) ancestor = ancestor->parent;
4877 fprintf(f, "%s", CS si);
4879 if (addr->parent && testflag(addr, af_hide_child))
4881 printed = US"an undisclosed address";
4884 else if (!testflag(addr, af_pfr) || !addr->parent)
4885 printed = addr->address;
4889 uschar *s = addr->address;
4892 if (addr->address[0] == '>') { ss = US"mail"; s++; }
4893 else if (addr->address[0] == '|') ss = US"pipe";
4896 fprintf(f, "%s to %s%sgenerated by ", ss, s, sc);
4897 printed = addr->parent->address;
4900 fprintf(f, "%s", CS string_printing(printed));
4902 if (ancestor != addr)
4904 uschar *original = ancestor->onetime_parent;
4905 if (!original) original= ancestor->address;
4906 if (strcmpic(original, printed) != 0)
4907 fprintf(f, "%s(%sgenerated from %s)", sc,
4908 ancestor != addr->parent ? "ultimately " : "",
4909 string_printing(original));
4912 if (addr->host_used)
4913 fprintf(f, "\n host %s [%s]",
4914 addr->host_used->name, addr->host_used->address);
4916 fprintf(f, "%s", CS se);
4924 /*************************************************
4925 * Print error for an address *
4926 *************************************************/
4928 /* This function is called to print the error information out of an address for
4929 a bounce or a warning message. It tries to format the message reasonably by
4930 introducing newlines. All lines are indented by 4; the initial printing
4931 position must be set before calling.
4933 This function used always to print the error. Nowadays we want to restrict it
4934 to cases such as LMTP/SMTP errors from a remote host, and errors from :fail:
4935 and filter "fail". We no longer pass other information willy-nilly in bounce
4936 and warning messages. Text in user_message is always output; text in message
4937 only if the af_pass_message flag is set.
4941 f the FILE to print on
4948 print_address_error(address_item *addr, FILE *f, uschar *t)
4950 int count = Ustrlen(t);
4951 uschar *s = testflag(addr, af_pass_message)? addr->message : NULL;
4953 if (!s && !(s = addr->user_message))
4956 fprintf(f, "\n %s", t);
4959 if (*s == '\\' && s[1] == 'n')
4969 if (*s++ == ':' && isspace(*s) && count > 45)
4971 fprintf(f, "\n "); /* sic (because space follows) */
4978 /***********************************************************
4979 * Print Diagnostic-Code for an address *
4980 ************************************************************/
4982 /* This function is called to print the error information out of an address for
4983 a bounce or a warning message. It tries to format the message reasonably as
4984 required by RFC 3461 by adding a space after each newline
4986 it uses the same logic as print_address_error() above. if af_pass_message is true
4987 and addr->message is set it uses the remote host answer. if not addr->user_message
4988 is used instead if available.
4992 f the FILE to print on
4998 print_dsn_diagnostic_code(const address_item *addr, FILE *f)
5000 uschar *s = testflag(addr, af_pass_message) ? addr->message : NULL;
5002 /* af_pass_message and addr->message set ? print remote host answer */
5006 debug_printf("DSN Diagnostic-Code: addr->message = %s\n", addr->message);
5008 /* search first ": ". we assume to find the remote-MTA answer there */
5009 if (!(s = Ustrstr(addr->message, ": ")))
5010 return; /* not found, bail out */
5011 s += 2; /* skip ": " */
5012 fprintf(f, "Diagnostic-Code: smtp; ");
5014 /* no message available. do nothing */
5018 if (*s == '\\' && s[1] == 'n')
5020 fputs("\n ", f); /* as defined in RFC 3461 */
5030 /*************************************************
5031 * Check list of addresses for duplication *
5032 *************************************************/
5034 /* This function was introduced when the test for duplicate addresses that are
5035 not pipes, files, or autoreplies was moved from the middle of routing to when
5036 routing was complete. That was to fix obscure cases when the routing history
5037 affects the subsequent routing of identical addresses. This function is called
5038 after routing, to check that the final routed addresses are not duplicates.
5040 If we detect a duplicate, we remember what it is a duplicate of. Note that
5041 pipe, file, and autoreply de-duplication is handled during routing, so we must
5042 leave such "addresses" alone here, as otherwise they will incorrectly be
5045 Argument: address of list anchor
5050 do_duplicate_check(address_item **anchor)
5053 while ((addr = *anchor))
5056 if (testflag(addr, af_pfr))
5058 anchor = &(addr->next);
5060 else if ((tnode = tree_search(tree_duplicates, addr->unique)))
5062 DEBUG(D_deliver|D_route)
5063 debug_printf("%s is a duplicate address: discarded\n", addr->unique);
5064 *anchor = addr->next;
5065 addr->dupof = tnode->data.ptr;
5066 addr->next = addr_duplicate;
5067 addr_duplicate = addr;
5071 tree_add_duplicate(addr->unique, addr);
5072 anchor = &(addr->next);
5080 /*************************************************
5081 * Deliver one message *
5082 *************************************************/
5084 /* This is the function which is called when a message is to be delivered. It
5085 is passed the id of the message. It is possible that the message no longer
5086 exists, if some other process has delivered it, and it is also possible that
5087 the message is being worked on by another process, in which case the data file
5090 If no delivery is attempted for any of the above reasons, the function returns
5091 DELIVER_NOT_ATTEMPTED.
5093 If the give_up flag is set true, do not attempt any deliveries, but instead
5094 fail all outstanding addresses and return the message to the sender (or
5097 A delivery operation has a process all to itself; we never deliver more than
5098 one message in the same process. Therefore we needn't worry too much about
5102 id the id of the message to be delivered
5103 forced TRUE if delivery was forced by an administrator; this overrides
5104 retry delays and causes a delivery to be tried regardless
5105 give_up TRUE if an administrator has requested that delivery attempts
5108 Returns: When the global variable mua_wrapper is FALSE:
5109 DELIVER_ATTEMPTED_NORMAL if a delivery attempt was made
5110 DELIVER_NOT_ATTEMPTED otherwise (see comment above)
5111 When the global variable mua_wrapper is TRUE:
5112 DELIVER_MUA_SUCCEEDED if delivery succeeded
5113 DELIVER_MUA_FAILED if delivery failed
5114 DELIVER_NOT_ATTEMPTED if not attempted (should not occur)
5118 deliver_message(uschar *id, BOOL forced, BOOL give_up)
5121 int final_yield = DELIVER_ATTEMPTED_NORMAL;
5122 time_t now = time(NULL);
5123 address_item *addr_last = NULL;
5124 uschar *filter_message = NULL;
5126 int process_recipients = RECIP_ACCEPT;
5129 extern int acl_where;
5131 uschar *info = queue_run_pid == (pid_t)0
5132 ? string_sprintf("delivering %s", id)
5133 : string_sprintf("delivering %s (queue run pid %d)", id, queue_run_pid);
5135 /* If the D_process_info bit is on, set_process_info() will output debugging
5136 information. If not, we want to show this initial information if D_deliver or
5137 D_queue_run is set or in verbose mode. */
5139 set_process_info("%s", info);
5141 if ( !(debug_selector & D_process_info)
5142 && (debug_selector & (D_deliver|D_queue_run|D_v))
5144 debug_printf("%s\n", info);
5146 /* Ensure that we catch any subprocesses that are created. Although Exim
5147 sets SIG_DFL as its initial default, some routes through the code end up
5148 here with it set to SIG_IGN - cases where a non-synchronous delivery process
5149 has been forked, but no re-exec has been done. We use sigaction rather than
5150 plain signal() on those OS where SA_NOCLDWAIT exists, because we want to be
5151 sure it is turned off. (There was a problem on AIX with this.) */
5155 struct sigaction act;
5156 act.sa_handler = SIG_DFL;
5157 sigemptyset(&(act.sa_mask));
5159 sigaction(SIGCHLD, &act, NULL);
5162 signal(SIGCHLD, SIG_DFL);
5165 /* Make the forcing flag available for routers and transports, set up the
5166 global message id field, and initialize the count for returned files and the
5167 message size. This use of strcpy() is OK because the length id is checked when
5168 it is obtained from a command line (the -M or -q options), and otherwise it is
5169 known to be a valid message id. */
5171 Ustrcpy(message_id, id);
5172 deliver_force = forced;
5176 /* Initialize some flags */
5178 update_spool = FALSE;
5179 remove_journal = TRUE;
5181 /* Set a known context for any ACLs we call via expansions */
5182 acl_where = ACL_WHERE_DELIVERY;
5184 /* Reset the random number generator, so that if several delivery processes are
5185 started from a queue runner that has already used random numbers (for sorting),
5186 they don't all get the same sequence. */
5190 /* Open and lock the message's data file. Exim locks on this one because the
5191 header file may get replaced as it is re-written during the delivery process.
5192 Any failures cause messages to be written to the log, except for missing files
5193 while queue running - another process probably completed delivery. As part of
5194 opening the data file, message_subdir gets set. */
5196 if (!spool_open_datafile(id))
5197 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5199 /* The value of message_size at this point has been set to the data length,
5200 plus one for the blank line that notionally precedes the data. */
5202 /* Now read the contents of the header file, which will set up the headers in
5203 store, and also the list of recipients and the tree of non-recipients and
5204 assorted flags. It updates message_size. If there is a reading or format error,
5205 give up; if the message has been around for sufficiently long, remove it. */
5207 sprintf(CS spoolname, "%s-H", id);
5208 if ((rc = spool_read_header(spoolname, TRUE, TRUE)) != spool_read_OK)
5210 if (errno == ERRNO_SPOOLFORMAT)
5212 struct stat statbuf;
5213 sprintf(CS big_buffer, "%s/input/%s/%s", spool_directory, message_subdir,
5215 if (Ustat(big_buffer, &statbuf) == 0)
5216 log_write(0, LOG_MAIN, "Format error in spool file %s: "
5217 "size=" OFF_T_FMT, spoolname, statbuf.st_size);
5218 else log_write(0, LOG_MAIN, "Format error in spool file %s", spoolname);
5221 log_write(0, LOG_MAIN, "Error reading spool file %s: %s", spoolname,
5224 /* If we managed to read the envelope data, received_time contains the
5225 time the message was received. Otherwise, we can calculate it from the
5228 if (rc != spool_read_hdrerror)
5231 for (i = 0; i < 6; i++)
5232 received_time = received_time * BASE_62 + tab62[id[i] - '0'];
5235 /* If we've had this malformed message too long, sling it. */
5237 if (now - received_time > keep_malformed)
5239 sprintf(CS spoolname, "%s/msglog/%s/%s", spool_directory, message_subdir, id);
5241 sprintf(CS spoolname, "%s/input/%s/%s-D", spool_directory, message_subdir, id);
5243 sprintf(CS spoolname, "%s/input/%s/%s-H", spool_directory, message_subdir, id);
5245 sprintf(CS spoolname, "%s/input/%s/%s-J", spool_directory, message_subdir, id);
5247 log_write(0, LOG_MAIN, "Message removed because older than %s",
5248 readconf_printtime(keep_malformed));
5251 (void)close(deliver_datafile);
5252 deliver_datafile = -1;
5253 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5256 /* The spool header file has been read. Look to see if there is an existing
5257 journal file for this message. If there is, it means that a previous delivery
5258 attempt crashed (program or host) before it could update the spool header file.
5259 Read the list of delivered addresses from the journal and add them to the
5260 nonrecipients tree. Then update the spool file. We can leave the journal in
5261 existence, as it will get further successful deliveries added to it in this
5262 run, and it will be deleted if this function gets to its end successfully.
5263 Otherwise it might be needed again. */
5265 sprintf(CS spoolname, "%s/input/%s/%s-J", spool_directory, message_subdir, id);
5266 jread = Ufopen(spoolname, "rb");
5269 while (Ufgets(big_buffer, big_buffer_size, jread))
5271 int n = Ustrlen(big_buffer);
5272 big_buffer[n-1] = 0;
5273 tree_add_nonrecipient(big_buffer);
5274 DEBUG(D_deliver) debug_printf("Previously delivered address %s taken from "
5275 "journal file\n", big_buffer);
5277 (void)fclose(jread);
5278 /* Panic-dies on error */
5279 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
5281 else if (errno != ENOENT)
5283 log_write(0, LOG_MAIN|LOG_PANIC, "attempt to open journal for reading gave: "
5284 "%s", strerror(errno));
5285 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5288 /* A null recipients list indicates some kind of disaster. */
5290 if (!recipients_list)
5292 (void)close(deliver_datafile);
5293 deliver_datafile = -1;
5294 log_write(0, LOG_MAIN, "Spool error: no recipients for %s", spoolname);
5295 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5299 /* Handle a message that is frozen. There are a number of different things that
5300 can happen, but in the default situation, unless forced, no delivery is
5305 #ifdef SUPPORT_MOVE_FROZEN_MESSAGES
5306 /* Moving to another directory removes the message from Exim's view. Other
5307 tools must be used to deal with it. Logging of this action happens in
5308 spool_move_message() and its subfunctions. */
5310 if ( move_frozen_messages
5311 && spool_move_message(id, message_subdir, US"", US"F")
5313 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5316 /* For all frozen messages (bounces or not), timeout_frozen_after sets the
5317 maximum time to keep messages that are frozen. Thaw if we reach it, with a
5318 flag causing all recipients to be failed. The time is the age of the
5319 message, not the time since freezing. */
5321 if (timeout_frozen_after > 0 && message_age >= timeout_frozen_after)
5323 log_write(0, LOG_MAIN, "cancelled by timeout_frozen_after");
5324 process_recipients = RECIP_FAIL_TIMEOUT;
5327 /* For bounce messages (and others with no sender), thaw if the error message
5328 ignore timer is exceeded. The message will be discarded if this delivery
5331 else if (sender_address[0] == 0 && message_age >= ignore_bounce_errors_after)
5333 log_write(0, LOG_MAIN, "Unfrozen by errmsg timer");
5336 /* If this is a bounce message, or there's no auto thaw, or we haven't
5337 reached the auto thaw time yet, and this delivery is not forced by an admin
5338 user, do not attempt delivery of this message. Note that forced is set for
5339 continuing messages down the same channel, in order to skip load checking and
5340 ignore hold domains, but we don't want unfreezing in that case. */
5344 if ( ( sender_address[0] == 0
5346 || now <= deliver_frozen_at + auto_thaw
5348 && ( !forced || !deliver_force_thaw
5349 || !admin_user || continue_hostname
5352 (void)close(deliver_datafile);
5353 deliver_datafile = -1;
5354 log_write(L_skip_delivery, LOG_MAIN, "Message is frozen");
5355 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5358 /* If delivery was forced (by an admin user), assume a manual thaw.
5359 Otherwise it's an auto thaw. */
5363 deliver_manual_thaw = TRUE;
5364 log_write(0, LOG_MAIN, "Unfrozen by forced delivery");
5366 else log_write(0, LOG_MAIN, "Unfrozen by auto-thaw");
5369 /* We get here if any of the rules for unfreezing have triggered. */
5371 deliver_freeze = FALSE;
5372 update_spool = TRUE;
5376 /* Open the message log file if we are using them. This records details of
5377 deliveries, deferments, and failures for the benefit of the mail administrator.
5378 The log is not used by exim itself to track the progress of a message; that is
5379 done by rewriting the header spool file. */
5386 sprintf(CS spoolname, "%s/msglog/%s/%s", spool_directory, message_subdir, id);
5387 fd = open_msglog_file(spoolname, SPOOL_MODE, &error);
5391 log_write(0, LOG_MAIN|LOG_PANIC, "Couldn't %s message log %s: %s", error,
5392 spoolname, strerror(errno));
5393 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5396 /* Make a C stream out of it. */
5398 if (!(message_log = fdopen(fd, "a")))
5400 log_write(0, LOG_MAIN|LOG_PANIC, "Couldn't fdopen message log %s: %s",
5401 spoolname, strerror(errno));
5402 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5407 /* If asked to give up on a message, log who did it, and set the action for all
5412 struct passwd *pw = getpwuid(real_uid);
5413 log_write(0, LOG_MAIN, "cancelled by %s",
5414 pw ? US pw->pw_name : string_sprintf("uid %ld", (long int)real_uid));
5415 process_recipients = RECIP_FAIL;
5418 /* Otherwise, if there are too many Received: headers, fail all recipients. */
5420 else if (received_count > received_headers_max)
5421 process_recipients = RECIP_FAIL_LOOP;
5423 /* Otherwise, if a system-wide, address-independent message filter is
5424 specified, run it now, except in the case when we are failing all recipients as
5425 a result of timeout_frozen_after. If the system filter yields "delivered", then
5426 ignore the true recipients of the message. Failure of the filter file is
5427 logged, and the delivery attempt fails. */
5429 else if (system_filter && process_recipients != RECIP_FAIL_TIMEOUT)
5434 redirect_block redirect;
5436 if (system_filter_uid_set)
5438 ugid.uid = system_filter_uid;
5439 ugid.gid = system_filter_gid;
5440 ugid.uid_set = ugid.gid_set = TRUE;
5444 ugid.uid_set = ugid.gid_set = FALSE;
5447 return_path = sender_address;
5448 enable_dollar_recipients = TRUE; /* Permit $recipients in system filter */
5449 system_filtering = TRUE;
5451 /* Any error in the filter file causes a delivery to be abandoned. */
5453 redirect.string = system_filter;
5454 redirect.isfile = TRUE;
5455 redirect.check_owner = redirect.check_group = FALSE;
5456 redirect.owners = NULL;
5457 redirect.owngroups = NULL;
5459 redirect.modemask = 0;
5461 DEBUG(D_deliver|D_filter) debug_printf("running system filter\n");
5464 &redirect, /* Where the data is */
5465 RDO_DEFER | /* Turn on all the enabling options */
5466 RDO_FAIL | /* Leave off all the disabling options */
5471 NULL, /* No :include: restriction (not used in filter) */
5472 NULL, /* No sieve vacation directory (not sieve!) */
5473 NULL, /* No sieve enotify mailto owner (not sieve!) */
5474 NULL, /* No sieve user address (not sieve!) */
5475 NULL, /* No sieve subaddress (not sieve!) */
5476 &ugid, /* uid/gid data */
5477 &addr_new, /* Where to hang generated addresses */
5478 &filter_message, /* Where to put error message */
5479 NULL, /* Don't skip syntax errors */
5480 &filtertype, /* Will always be set to FILTER_EXIM for this call */
5481 US"system filter"); /* For error messages */
5483 DEBUG(D_deliver|D_filter) debug_printf("system filter returned %d\n", rc);
5485 if (rc == FF_ERROR || rc == FF_NONEXIST)
5487 (void)close(deliver_datafile);
5488 deliver_datafile = -1;
5489 log_write(0, LOG_MAIN|LOG_PANIC, "Error in system filter: %s",
5490 string_printing(filter_message));
5491 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5494 /* Reset things. If the filter message is an empty string, which can happen
5495 for a filter "fail" or "freeze" command with no text, reset it to NULL. */
5497 system_filtering = FALSE;
5498 enable_dollar_recipients = FALSE;
5499 if (filter_message && filter_message[0] == 0) filter_message = NULL;
5501 /* Save the values of the system filter variables so that user filters
5504 memcpy(filter_sn, filter_n, sizeof(filter_sn));
5506 /* The filter can request that delivery of the original addresses be
5511 process_recipients = RECIP_DEFER;
5512 deliver_msglog("Delivery deferred by system filter\n");
5513 log_write(0, LOG_MAIN, "Delivery deferred by system filter");
5516 /* The filter can request that a message be frozen, but this does not
5517 take place if the message has been manually thawed. In that case, we must
5518 unset "delivered", which is forced by the "freeze" command to make -bF
5521 else if (rc == FF_FREEZE && !deliver_manual_thaw)
5523 deliver_freeze = TRUE;
5524 deliver_frozen_at = time(NULL);
5525 process_recipients = RECIP_DEFER;
5526 frozen_info = string_sprintf(" by the system filter%s%s",
5527 filter_message ? US": " : US"",
5528 filter_message ? filter_message : US"");
5531 /* The filter can request that a message be failed. The error message may be
5532 quite long - it is sent back to the sender in the bounce - but we don't want
5533 to fill up the log with repetitions of it. If it starts with << then the text
5534 between << and >> is written to the log, with the rest left for the bounce
5537 else if (rc == FF_FAIL)
5539 uschar *colon = US"";
5540 uschar *logmsg = US"";
5543 process_recipients = RECIP_FAIL_FILTER;
5549 if ( filter_message[0] == '<'
5550 && filter_message[1] == '<'
5551 && (logend = Ustrstr(filter_message, ">>"))
5554 logmsg = filter_message + 2;
5555 loglen = logend - logmsg;
5556 filter_message = logend + 2;
5557 if (filter_message[0] == 0) filter_message = NULL;
5561 logmsg = filter_message;
5562 loglen = Ustrlen(filter_message);
5566 log_write(0, LOG_MAIN, "cancelled by system filter%s%.*s", colon, loglen,
5570 /* Delivery can be restricted only to those recipients (if any) that the
5571 filter specified. */
5573 else if (rc == FF_DELIVERED)
5575 process_recipients = RECIP_IGNORE;
5577 log_write(0, LOG_MAIN, "original recipients ignored (system filter)");
5579 log_write(0, LOG_MAIN, "=> discarded (system filter)");
5582 /* If any new addresses were created by the filter, fake up a "parent"
5583 for them. This is necessary for pipes, etc., which are expected to have
5584 parents, and it also gives some sensible logging for others. Allow
5585 pipes, files, and autoreplies, and run them as the filter uid if set,
5586 otherwise as the current uid. */
5590 int uid = (system_filter_uid_set)? system_filter_uid : geteuid();
5591 int gid = (system_filter_gid_set)? system_filter_gid : getegid();
5593 /* The text "system-filter" is tested in transport_set_up_command() and in
5594 set_up_shell_command() in the pipe transport, to enable them to permit
5595 $recipients, so don't change it here without also changing it there. */
5597 address_item *p = addr_new;
5598 address_item *parent = deliver_make_addr(US"system-filter", FALSE);
5600 parent->domain = string_copylc(qualify_domain_recipient);
5601 parent->local_part = US"system-filter";
5603 /* As part of this loop, we arrange for addr_last to end up pointing
5604 at the final address. This is used if we go on to add addresses for the
5605 original recipients. */
5609 if (parent->child_count == SHRT_MAX)
5610 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "system filter generated more "
5611 "than %d delivery addresses", SHRT_MAX);
5612 parent->child_count++;
5615 if (testflag(p, af_pfr))
5621 setflag(p, af_uid_set |
5627 /* Find the name of the system filter's appropriate pfr transport */
5629 if (p->address[0] == '|')
5632 tpname = system_filter_pipe_transport;
5633 address_pipe = p->address;
5635 else if (p->address[0] == '>')
5638 tpname = system_filter_reply_transport;
5642 if (p->address[Ustrlen(p->address)-1] == '/')
5644 type = US"directory";
5645 tpname = system_filter_directory_transport;
5650 tpname = system_filter_file_transport;
5652 address_file = p->address;
5655 /* Now find the actual transport, first expanding the name. We have
5656 set address_file or address_pipe above. */
5660 uschar *tmp = expand_string(tpname);
5661 address_file = address_pipe = NULL;
5663 p->message = string_sprintf("failed to expand \"%s\" as a "
5664 "system filter transport name", tpname);
5669 p->message = string_sprintf("system_filter_%s_transport is unset",
5675 transport_instance *tp;
5676 for (tp = transports; tp; tp = tp->next)
5678 if (Ustrcmp(tp->name, tpname) == 0)
5685 p->message = string_sprintf("failed to find \"%s\" transport "
5686 "for system filter delivery", tpname);
5689 /* If we couldn't set up a transport, defer the delivery, putting the
5690 error on the panic log as well as the main log. */
5694 address_item *badp = p;
5696 if (!addr_last) addr_new = p; else addr_last->next = p;
5697 badp->local_part = badp->address; /* Needed for log line */
5698 post_process_one(badp, DEFER, LOG_MAIN|LOG_PANIC, DTYPE_ROUTER, 0);
5701 } /* End of pfr handling */
5703 /* Either a non-pfr delivery, or we found a transport */
5705 DEBUG(D_deliver|D_filter)
5706 debug_printf("system filter added %s\n", p->address);
5710 } /* Loop through all addr_new addresses */
5715 /* Scan the recipients list, and for every one that is not in the non-
5716 recipients tree, add an addr item to the chain of new addresses. If the pno
5717 value is non-negative, we must set the onetime parent from it. This which
5718 points to the relevant entry in the recipients list.
5720 This processing can be altered by the setting of the process_recipients
5721 variable, which is changed if recipients are to be ignored, failed, or
5722 deferred. This can happen as a result of system filter activity, or if the -Mg
5723 option is used to fail all of them.
5725 Duplicate addresses are handled later by a different tree structure; we can't
5726 just extend the non-recipients tree, because that will be re-written to the
5727 spool if the message is deferred, and in any case there are casing
5728 complications for local addresses. */
5730 if (process_recipients != RECIP_IGNORE)
5732 for (i = 0; i < recipients_count; i++)
5734 if (!tree_search(tree_nonrecipients, recipients_list[i].address))
5736 recipient_item *r = recipients_list + i;
5737 address_item *new = deliver_make_addr(r->address, FALSE);
5738 new->prop.errors_address = r->errors_to;
5739 #ifdef EXPERIMENTAL_INTERNATIONAL
5740 if ((new->prop.utf8_msg = message_smtputf8))
5742 new->prop.utf8_downcvt = message_utf8_downconvert == 1;
5743 new->prop.utf8_downcvt_maybe = message_utf8_downconvert == -1;
5744 DEBUG(D_deliver) debug_printf("utf8, downconvert %s\n",
5745 new->prop.utf8_downcvt ? "yes"
5746 : new->prop.utf8_downcvt_maybe ? "ifneeded"
5752 new->onetime_parent = recipients_list[r->pno].address;
5754 /* If DSN support is enabled, set the dsn flags and the original receipt
5755 to be passed on to other DSN enabled MTAs */
5756 new->dsn_flags = r->dsn_flags & rf_dsnflags;
5757 new->dsn_orcpt = r->orcpt;
5758 DEBUG(D_deliver) debug_printf("DSN: set orcpt: %s flags: %d\n",
5759 new->dsn_orcpt, new->dsn_flags);
5761 switch (process_recipients)
5763 /* RECIP_DEFER is set when a system filter freezes a message. */
5766 new->next = addr_defer;
5771 /* RECIP_FAIL_FILTER is set when a system filter has obeyed a "fail"
5774 case RECIP_FAIL_FILTER:
5776 filter_message ? filter_message : US"delivery cancelled";
5777 setflag(new, af_pass_message);
5778 goto RECIP_QUEUE_FAILED; /* below */
5781 /* RECIP_FAIL_TIMEOUT is set when a message is frozen, but is older
5782 than the value in timeout_frozen_after. Treat non-bounce messages
5783 similarly to -Mg; for bounce messages we just want to discard, so
5784 don't put the address on the failed list. The timeout has already
5787 case RECIP_FAIL_TIMEOUT:
5788 new->message = US"delivery cancelled; message timed out";
5789 goto RECIP_QUEUE_FAILED; /* below */
5792 /* RECIP_FAIL is set when -Mg has been used. */
5795 new->message = US"delivery cancelled by administrator";
5798 /* Common code for the failure cases above. If this is not a bounce
5799 message, put the address on the failed list so that it is used to
5800 create a bounce. Otherwise do nothing - this just discards the address.
5801 The incident has already been logged. */
5804 if (sender_address[0] != 0)
5806 new->next = addr_failed;
5812 /* RECIP_FAIL_LOOP is set when there are too many Received: headers
5813 in the message. Process each address as a routing failure; if this
5814 is a bounce message, it will get frozen. */
5816 case RECIP_FAIL_LOOP:
5817 new->message = US"Too many \"Received\" headers - suspected mail loop";
5818 post_process_one(new, FAIL, LOG_MAIN, DTYPE_ROUTER, 0);
5822 /* Value should be RECIP_ACCEPT; take this as the safe default. */
5825 if (!addr_new) addr_new = new; else addr_last->next = new;
5830 #ifdef EXPERIMENTAL_EVENT
5831 if (process_recipients != RECIP_ACCEPT)
5833 uschar * save_local = deliver_localpart;
5834 const uschar * save_domain = deliver_domain;
5836 deliver_localpart = expand_string(
5837 string_sprintf("${local_part:%s}", new->address));
5838 deliver_domain = expand_string(
5839 string_sprintf("${domain:%s}", new->address));
5841 (void) event_raise(event_action,
5842 US"msg:fail:internal", new->message);
5844 deliver_localpart = save_local;
5845 deliver_domain = save_domain;
5855 debug_printf("Delivery address list:\n");
5856 for (p = addr_new; p; p = p->next)
5857 debug_printf(" %s %s\n", p->address,
5858 p->onetime_parent ? p->onetime_parent : US"");
5861 /* Set up the buffers used for copying over the file when delivering. */
5863 deliver_in_buffer = store_malloc(DELIVER_IN_BUFFER_SIZE);
5864 deliver_out_buffer = store_malloc(DELIVER_OUT_BUFFER_SIZE);
5868 /* Until there are no more new addresses, handle each one as follows:
5870 . If this is a generated address (indicated by the presence of a parent
5871 pointer) then check to see whether it is a pipe, file, or autoreply, and
5872 if so, handle it directly here. The router that produced the address will
5873 have set the allow flags into the address, and also set the uid/gid required.
5874 Having the routers generate new addresses and then checking them here at
5875 the outer level is tidier than making each router do the checking, and
5876 means that routers don't need access to the failed address queue.
5878 . Break up the address into local part and domain, and make lowercased
5879 versions of these strings. We also make unquoted versions of the local part.
5881 . Handle the percent hack for those domains for which it is valid.
5883 . For child addresses, determine if any of the parents have the same address.
5884 If so, generate a different string for previous delivery checking. Without
5885 this code, if the address spqr generates spqr via a forward or alias file,
5886 delivery of the generated spqr stops further attempts at the top level spqr,
5887 which is not what is wanted - it may have generated other addresses.
5889 . Check on the retry database to see if routing was previously deferred, but
5890 only if in a queue run. Addresses that are to be routed are put on the
5891 addr_route chain. Addresses that are to be deferred are put on the
5892 addr_defer chain. We do all the checking first, so as not to keep the
5893 retry database open any longer than necessary.
5895 . Now we run the addresses through the routers. A router may put the address
5896 on either the addr_local or the addr_remote chain for local or remote
5897 delivery, respectively, or put it on the addr_failed chain if it is
5898 undeliveable, or it may generate child addresses and put them on the
5899 addr_new chain, or it may defer an address. All the chain anchors are
5900 passed as arguments so that the routers can be called for verification
5903 . If new addresses have been generated by the routers, da capo.
5906 header_rewritten = FALSE; /* No headers rewritten yet */
5907 while (addr_new) /* Loop until all addresses dealt with */
5909 address_item *addr, *parent;
5911 /* Failure to open the retry database is treated the same as if it does
5912 not exist. In both cases, dbm_file is NULL. */
5914 if (!(dbm_file = dbfn_open(US"retry", O_RDONLY, &dbblock, FALSE)))
5916 DEBUG(D_deliver|D_retry|D_route|D_hints_lookup)
5917 debug_printf("no retry data available\n");
5920 /* Scan the current batch of new addresses, to handle pipes, files and
5921 autoreplies, and determine which others are ready for routing. */
5928 dbdata_retry *domain_retry_record;
5929 dbdata_retry *address_retry_record;
5932 addr_new = addr->next;
5934 DEBUG(D_deliver|D_retry|D_route)
5936 debug_printf(">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>\n");
5937 debug_printf("Considering: %s\n", addr->address);
5940 /* Handle generated address that is a pipe or a file or an autoreply. */
5942 if (testflag(addr, af_pfr))
5944 /* If an autoreply in a filter could not generate a syntactically valid
5945 address, give up forthwith. Set af_ignore_error so that we don't try to
5946 generate a bounce. */
5948 if (testflag(addr, af_bad_reply))
5950 addr->basic_errno = ERRNO_BADADDRESS2;
5951 addr->local_part = addr->address;
5953 US"filter autoreply generated syntactically invalid recipient";
5954 setflag(addr, af_ignore_error);
5955 (void)post_process_one(addr, FAIL, LOG_MAIN, DTYPE_ROUTER, 0);
5956 continue; /* with the next new address */
5959 /* If two different users specify delivery to the same pipe or file or
5960 autoreply, there should be two different deliveries, so build a unique
5961 string that incorporates the original address, and use this for
5962 duplicate testing and recording delivery, and also for retrying. */
5965 string_sprintf("%s:%s", addr->address, addr->parent->unique +
5966 (testflag(addr->parent, af_homonym)? 3:0));
5968 addr->address_retry_key = addr->domain_retry_key =
5969 string_sprintf("T:%s", addr->unique);
5971 /* If a filter file specifies two deliveries to the same pipe or file,
5972 we want to de-duplicate, but this is probably not wanted for two mail
5973 commands to the same address, where probably both should be delivered.
5974 So, we have to invent a different unique string in that case. Just
5975 keep piling '>' characters on the front. */
5977 if (addr->address[0] == '>')
5979 while (tree_search(tree_duplicates, addr->unique))
5980 addr->unique = string_sprintf(">%s", addr->unique);
5983 else if ((tnode = tree_search(tree_duplicates, addr->unique)))
5985 DEBUG(D_deliver|D_route)
5986 debug_printf("%s is a duplicate address: discarded\n", addr->address);
5987 addr->dupof = tnode->data.ptr;
5988 addr->next = addr_duplicate;
5989 addr_duplicate = addr;
5993 DEBUG(D_deliver|D_route) debug_printf("unique = %s\n", addr->unique);
5995 /* Check for previous delivery */
5997 if (tree_search(tree_nonrecipients, addr->unique))
5999 DEBUG(D_deliver|D_route)
6000 debug_printf("%s was previously delivered: discarded\n", addr->address);
6001 child_done(addr, tod_stamp(tod_log));
6005 /* Save for checking future duplicates */
6007 tree_add_duplicate(addr->unique, addr);
6009 /* Set local part and domain */
6011 addr->local_part = addr->address;
6012 addr->domain = addr->parent->domain;
6014 /* Ensure that the delivery is permitted. */
6016 if (testflag(addr, af_file))
6018 if (!testflag(addr, af_allow_file))
6020 addr->basic_errno = ERRNO_FORBIDFILE;
6021 addr->message = US"delivery to file forbidden";
6022 (void)post_process_one(addr, FAIL, LOG_MAIN, DTYPE_ROUTER, 0);
6023 continue; /* with the next new address */
6026 else if (addr->address[0] == '|')
6028 if (!testflag(addr, af_allow_pipe))
6030 addr->basic_errno = ERRNO_FORBIDPIPE;
6031 addr->message = US"delivery to pipe forbidden";
6032 (void)post_process_one(addr, FAIL, LOG_MAIN, DTYPE_ROUTER, 0);
6033 continue; /* with the next new address */
6036 else if (!testflag(addr, af_allow_reply))
6038 addr->basic_errno = ERRNO_FORBIDREPLY;
6039 addr->message = US"autoreply forbidden";
6040 (void)post_process_one(addr, FAIL, LOG_MAIN, DTYPE_ROUTER, 0);
6041 continue; /* with the next new address */
6044 /* If the errno field is already set to BADTRANSPORT, it indicates
6045 failure to expand a transport string, or find the associated transport,
6046 or an unset transport when one is required. Leave this test till now so
6047 that the forbid errors are given in preference. */
6049 if (addr->basic_errno == ERRNO_BADTRANSPORT)
6051 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_ROUTER, 0);
6055 /* Treat /dev/null as a special case and abandon the delivery. This
6056 avoids having to specify a uid on the transport just for this case.
6057 Arrange for the transport name to be logged as "**bypassed**". */
6059 if (Ustrcmp(addr->address, "/dev/null") == 0)
6061 uschar *save = addr->transport->name;
6062 addr->transport->name = US"**bypassed**";
6063 (void)post_process_one(addr, OK, LOG_MAIN, DTYPE_TRANSPORT, '=');
6064 addr->transport->name = save;
6065 continue; /* with the next new address */
6068 /* Pipe, file, or autoreply delivery is to go ahead as a normal local
6071 DEBUG(D_deliver|D_route)
6072 debug_printf("queued for %s transport\n", addr->transport->name);
6073 addr->next = addr_local;
6075 continue; /* with the next new address */
6078 /* Handle normal addresses. First, split up into local part and domain,
6079 handling the %-hack if necessary. There is the possibility of a defer from
6080 a lookup in percent_hack_domains. */
6082 if ((rc = deliver_split_address(addr)) == DEFER)
6084 addr->message = US"cannot check percent_hack_domains";
6085 addr->basic_errno = ERRNO_LISTDEFER;
6086 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_NONE, 0);
6090 /* Check to see if the domain is held. If so, proceed only if the
6091 delivery was forced by hand. */
6093 deliver_domain = addr->domain; /* set $domain */
6094 if ( !forced && hold_domains
6095 && (rc = match_isinlist(addr->domain, (const uschar **)&hold_domains, 0,
6096 &domainlist_anchor, addr->domain_cache, MCL_DOMAIN, TRUE,
6102 addr->message = US"hold_domains lookup deferred";
6103 addr->basic_errno = ERRNO_LISTDEFER;
6107 addr->message = US"domain is held";
6108 addr->basic_errno = ERRNO_HELD;
6110 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_NONE, 0);
6114 /* Now we can check for duplicates and previously delivered addresses. In
6115 order to do this, we have to generate a "unique" value for each address,
6116 because there may be identical actual addresses in a line of descendents.
6117 The "unique" field is initialized to the same value as the "address" field,
6118 but gets changed here to cope with identically-named descendents. */
6120 for (parent = addr->parent; parent; parent = parent->parent)
6121 if (strcmpic(addr->address, parent->address) == 0) break;
6123 /* If there's an ancestor with the same name, set the homonym flag. This
6124 influences how deliveries are recorded. Then add a prefix on the front of
6125 the unique address. We use \n\ where n starts at 0 and increases each time.
6126 It is unlikely to pass 9, but if it does, it may look odd but will still
6127 work. This means that siblings or cousins with the same names are treated
6128 as duplicates, which is what we want. */
6132 setflag(addr, af_homonym);
6133 if (parent->unique[0] != '\\')
6134 addr->unique = string_sprintf("\\0\\%s", addr->address);
6136 addr->unique = string_sprintf("\\%c\\%s", parent->unique[1] + 1,
6140 /* Ensure that the domain in the unique field is lower cased, because
6141 domains are always handled caselessly. */
6143 p = Ustrrchr(addr->unique, '@');
6144 while (*p != 0) { *p = tolower(*p); p++; }
6146 DEBUG(D_deliver|D_route) debug_printf("unique = %s\n", addr->unique);
6148 if (tree_search(tree_nonrecipients, addr->unique))
6150 DEBUG(D_deliver|D_route)
6151 debug_printf("%s was previously delivered: discarded\n", addr->unique);
6152 child_done(addr, tod_stamp(tod_log));
6156 /* Get the routing retry status, saving the two retry keys (with and
6157 without the local part) for subsequent use. If there is no retry record for
6158 the standard address routing retry key, we look for the same key with the
6159 sender attached, because this form is used by the smtp transport after a
6160 4xx response to RCPT when address_retry_include_sender is true. */
6162 addr->domain_retry_key = string_sprintf("R:%s", addr->domain);
6163 addr->address_retry_key = string_sprintf("R:%s@%s", addr->local_part,
6168 domain_retry_record = dbfn_read(dbm_file, addr->domain_retry_key);
6169 if ( domain_retry_record
6170 && now - domain_retry_record->time_stamp > retry_data_expire
6172 domain_retry_record = NULL; /* Ignore if too old */
6174 address_retry_record = dbfn_read(dbm_file, addr->address_retry_key);
6175 if ( address_retry_record
6176 && now - address_retry_record->time_stamp > retry_data_expire
6178 address_retry_record = NULL; /* Ignore if too old */
6180 if (!address_retry_record)
6182 uschar *altkey = string_sprintf("%s:<%s>", addr->address_retry_key,
6184 address_retry_record = dbfn_read(dbm_file, altkey);
6185 if ( address_retry_record
6186 && now - address_retry_record->time_stamp > retry_data_expire)
6187 address_retry_record = NULL; /* Ignore if too old */
6191 domain_retry_record = address_retry_record = NULL;
6193 DEBUG(D_deliver|D_retry)
6195 if (!domain_retry_record)
6196 debug_printf("no domain retry record\n");
6197 if (!address_retry_record)
6198 debug_printf("no address retry record\n");
6201 /* If we are sending a message down an existing SMTP connection, we must
6202 assume that the message which created the connection managed to route
6203 an address to that connection. We do not want to run the risk of taking
6204 a long time over routing here, because if we do, the server at the other
6205 end of the connection may time it out. This is especially true for messages
6206 with lots of addresses. For this kind of delivery, queue_running is not
6207 set, so we would normally route all addresses. We take a pragmatic approach
6208 and defer routing any addresses that have any kind of domain retry record.
6209 That is, we don't even look at their retry times. It doesn't matter if this
6210 doesn't work occasionally. This is all just an optimization, after all.
6212 The reason for not doing the same for address retries is that they normally
6213 arise from 4xx responses, not DNS timeouts. */
6215 if (continue_hostname && domain_retry_record)
6217 addr->message = US"reusing SMTP connection skips previous routing defer";
6218 addr->basic_errno = ERRNO_RRETRY;
6219 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_ROUTER, 0);
6222 /* If we are in a queue run, defer routing unless there is no retry data or
6223 we've passed the next retry time, or this message is forced. In other
6224 words, ignore retry data when not in a queue run.
6226 However, if the domain retry time has expired, always allow the routing
6227 attempt. If it fails again, the address will be failed. This ensures that
6228 each address is routed at least once, even after long-term routing
6231 If there is an address retry, check that too; just wait for the next
6232 retry time. This helps with the case when the temporary error on the
6233 address was really message-specific rather than address specific, since
6234 it allows other messages through.
6236 We also wait for the next retry time if this is a message sent down an
6237 existing SMTP connection (even though that will be forced). Otherwise there
6238 will be far too many attempts for an address that gets a 4xx error. In
6239 fact, after such an error, we should not get here because, the host should
6240 not be remembered as one this message needs. However, there was a bug that
6241 used to cause this to happen, so it is best to be on the safe side.
6243 Even if we haven't reached the retry time in the hints, there is one more
6244 check to do, which is for the ultimate address timeout. We only do this
6245 check if there is an address retry record and there is not a domain retry
6246 record; this implies that previous attempts to handle the address had the
6247 retry_use_local_parts option turned on. We use this as an approximation
6248 for the destination being like a local delivery, for example delivery over
6249 LMTP to an IMAP message store. In this situation users are liable to bump
6250 into their quota and thereby have intermittently successful deliveries,
6251 which keep the retry record fresh, which can lead to us perpetually
6252 deferring messages. */
6254 else if ( ( queue_running && !deliver_force
6255 || continue_hostname
6257 && ( ( domain_retry_record
6258 && now < domain_retry_record->next_try
6259 && !domain_retry_record->expired
6261 || ( address_retry_record
6262 && now < address_retry_record->next_try
6264 && ( domain_retry_record
6265 || !address_retry_record
6266 || !retry_ultimate_address_timeout(addr->address_retry_key,
6267 addr->domain, address_retry_record, now)
6270 addr->message = US"retry time not reached";
6271 addr->basic_errno = ERRNO_RRETRY;
6272 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_ROUTER, 0);
6275 /* The domain is OK for routing. Remember if retry data exists so it
6276 can be cleaned up after a successful delivery. */
6280 if (domain_retry_record || address_retry_record)
6281 setflag(addr, af_dr_retry_exists);
6282 addr->next = addr_route;
6284 DEBUG(D_deliver|D_route)
6285 debug_printf("%s: queued for routing\n", addr->address);
6289 /* The database is closed while routing is actually happening. Requests to
6290 update it are put on a chain and all processed together at the end. */
6292 if (dbm_file) dbfn_close(dbm_file);
6294 /* If queue_domains is set, we don't even want to try routing addresses in
6295 those domains. During queue runs, queue_domains is forced to be unset.
6296 Optimize by skipping this pass through the addresses if nothing is set. */
6298 if (!deliver_force && queue_domains)
6300 address_item *okaddr = NULL;
6303 address_item *addr = addr_route;
6304 addr_route = addr->next;
6306 deliver_domain = addr->domain; /* set $domain */
6307 if ((rc = match_isinlist(addr->domain, (const uschar **)&queue_domains, 0,
6308 &domainlist_anchor, addr->domain_cache, MCL_DOMAIN, TRUE, NULL))
6313 addr->basic_errno = ERRNO_LISTDEFER;
6314 addr->message = US"queue_domains lookup deferred";
6315 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_ROUTER, 0);
6319 addr->next = okaddr;
6325 addr->basic_errno = ERRNO_QUEUE_DOMAIN;
6326 addr->message = US"domain is in queue_domains";
6327 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_ROUTER, 0);
6331 addr_route = okaddr;
6334 /* Now route those addresses that are not deferred. */
6339 address_item *addr = addr_route;
6340 const uschar *old_domain = addr->domain;
6341 uschar *old_unique = addr->unique;
6342 addr_route = addr->next;
6345 /* Just in case some router parameter refers to it. */
6347 if (!(return_path = addr->prop.errors_address))
6348 return_path = sender_address;
6350 /* If a router defers an address, add a retry item. Whether or not to
6351 use the local part in the key is a property of the router. */
6353 if ((rc = route_address(addr, &addr_local, &addr_remote, &addr_new,
6354 &addr_succeed, v_none)) == DEFER)
6355 retry_add_item(addr,
6356 addr->router->retry_use_local_part
6357 ? string_sprintf("R:%s@%s", addr->local_part, addr->domain)
6358 : string_sprintf("R:%s", addr->domain),
6361 /* Otherwise, if there is an existing retry record in the database, add
6362 retry items to delete both forms. We must also allow for the possibility
6363 of a routing retry that includes the sender address. Since the domain might
6364 have been rewritten (expanded to fully qualified) as a result of routing,
6365 ensure that the rewritten form is also deleted. */
6367 else if (testflag(addr, af_dr_retry_exists))
6369 uschar *altkey = string_sprintf("%s:<%s>", addr->address_retry_key,
6371 retry_add_item(addr, altkey, rf_delete);
6372 retry_add_item(addr, addr->address_retry_key, rf_delete);
6373 retry_add_item(addr, addr->domain_retry_key, rf_delete);
6374 if (Ustrcmp(addr->domain, old_domain) != 0)
6375 retry_add_item(addr, string_sprintf("R:%s", old_domain), rf_delete);
6378 /* DISCARD is given for :blackhole: and "seen finish". The event has been
6379 logged, but we need to ensure the address (and maybe parents) is marked
6384 address_done(addr, tod_stamp(tod_log));
6385 continue; /* route next address */
6388 /* The address is finished with (failed or deferred). */
6392 (void)post_process_one(addr, rc, LOG_MAIN, DTYPE_ROUTER, 0);
6393 continue; /* route next address */
6396 /* The address has been routed. If the router changed the domain, it will
6397 also have changed the unique address. We have to test whether this address
6398 has already been delivered, because it's the unique address that finally
6401 if ( addr->unique != old_unique
6402 && tree_search(tree_nonrecipients, addr->unique) != 0
6405 DEBUG(D_deliver|D_route) debug_printf("%s was previously delivered: "
6406 "discarded\n", addr->address);
6407 if (addr_remote == addr) addr_remote = addr->next;
6408 else if (addr_local == addr) addr_local = addr->next;
6411 /* If the router has same_domain_copy_routing set, we are permitted to copy
6412 the routing for any other addresses with the same domain. This is an
6413 optimisation to save repeated DNS lookups for "standard" remote domain
6414 routing. The option is settable only on routers that generate host lists.
6415 We play it very safe, and do the optimization only if the address is routed
6416 to a remote transport, there are no header changes, and the domain was not
6417 modified by the router. */
6419 if ( addr_remote == addr
6420 && addr->router->same_domain_copy_routing
6421 && !addr->prop.extra_headers
6422 && !addr->prop.remove_headers
6423 && old_domain == addr->domain
6426 address_item **chain = &addr_route;
6429 address_item *addr2 = *chain;
6430 if (Ustrcmp(addr2->domain, addr->domain) != 0)
6432 chain = &(addr2->next);
6436 /* Found a suitable address; take it off the routing list and add it to
6437 the remote delivery list. */
6439 *chain = addr2->next;
6440 addr2->next = addr_remote;
6441 addr_remote = addr2;
6443 /* Copy the routing data */
6445 addr2->domain = addr->domain;
6446 addr2->router = addr->router;
6447 addr2->transport = addr->transport;
6448 addr2->host_list = addr->host_list;
6449 addr2->fallback_hosts = addr->fallback_hosts;
6450 addr2->prop.errors_address = addr->prop.errors_address;
6451 copyflag(addr2, addr, af_hide_child | af_local_host_removed);
6453 DEBUG(D_deliver|D_route)
6455 debug_printf(">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>\n"
6457 "Routing for %s copied from %s\n",
6458 addr2->address, addr2->address, addr->address);
6462 } /* Continue with routing the next address. */
6463 } /* Loop to process any child addresses that the routers created, and
6464 any rerouted addresses that got put back on the new chain. */
6467 /* Debugging: show the results of the routing */
6469 DEBUG(D_deliver|D_retry|D_route)
6472 debug_printf(">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>\n");
6473 debug_printf("After routing:\n Local deliveries:\n");
6474 for (p = addr_local; p; p = p->next)
6475 debug_printf(" %s\n", p->address);
6477 debug_printf(" Remote deliveries:\n");
6478 for (p = addr_remote; p; p = p->next)
6479 debug_printf(" %s\n", p->address);
6481 debug_printf(" Failed addresses:\n");
6482 for (p = addr_failed; p; p = p->next)
6483 debug_printf(" %s\n", p->address);
6485 debug_printf(" Deferred addresses:\n");
6486 for (p = addr_defer; p; p = p->next)
6487 debug_printf(" %s\n", p->address);
6490 /* Free any resources that were cached during routing. */
6495 /* These two variables are set only during routing, after check_local_user.
6496 Ensure they are not set in transports. */
6498 local_user_gid = (gid_t)(-1);
6499 local_user_uid = (uid_t)(-1);
6501 /* Check for any duplicate addresses. This check is delayed until after
6502 routing, because the flexibility of the routing configuration means that
6503 identical addresses with different parentage may end up being redirected to
6504 different addresses. Checking for duplicates too early (as we previously used
6505 to) makes this kind of thing not work. */
6507 do_duplicate_check(&addr_local);
6508 do_duplicate_check(&addr_remote);
6510 /* When acting as an MUA wrapper, we proceed only if all addresses route to a
6511 remote transport. The check that they all end up in one transaction happens in
6512 the do_remote_deliveries() function. */
6515 && (addr_local || addr_failed || addr_defer)
6519 uschar *which, *colon, *msg;
6526 else if (addr_defer)
6529 which = US"deferred";
6537 while (addr->parent) addr = addr->parent;
6542 msg = addr->message;
6544 else colon = msg = US"";
6546 /* We don't need to log here for a forced failure as it will already
6547 have been logged. Defer will also have been logged, but as a defer, so we do
6548 need to do the failure logging. */
6550 if (addr != addr_failed)
6551 log_write(0, LOG_MAIN, "** %s routing yielded a %s delivery",
6552 addr->address, which);
6554 /* Always write an error to the caller */
6556 fprintf(stderr, "routing %s yielded a %s delivery%s%s\n", addr->address,
6559 final_yield = DELIVER_MUA_FAILED;
6560 addr_failed = addr_defer = NULL; /* So that we remove the message */
6561 goto DELIVERY_TIDYUP;
6565 /* If this is a run to continue deliveries to an external channel that is
6566 already set up, defer any local deliveries. */
6568 if (continue_transport)
6572 address_item *addr = addr_defer;
6573 while (addr->next) addr = addr->next;
6574 addr->next = addr_local;
6577 addr_defer = addr_local;
6582 /* Because address rewriting can happen in the routers, we should not really do
6583 ANY deliveries until all addresses have been routed, so that all recipients of
6584 the message get the same headers. However, this is in practice not always
6585 possible, since sometimes remote addresses give DNS timeouts for days on end.
6586 The pragmatic approach is to deliver what we can now, saving any rewritten
6587 headers so that at least the next lot of recipients benefit from the rewriting
6588 that has already been done.
6590 If any headers have been rewritten during routing, update the spool file to
6591 remember them for all subsequent deliveries. This can be delayed till later if
6592 there is only address to be delivered - if it succeeds the spool write need not
6595 if ( header_rewritten
6597 && (addr_local->next || addr_remote)
6599 || (addr_remote && addr_remote->next)
6602 /* Panic-dies on error */
6603 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
6604 header_rewritten = FALSE;
6608 /* If there are any deliveries to be done, open the journal file. This is used
6609 to record successful deliveries as soon as possible after each delivery is
6610 known to be complete. A file opened with O_APPEND is used so that several
6611 processes can run simultaneously.
6613 The journal is just insurance against crashes. When the spool file is
6614 ultimately updated at the end of processing, the journal is deleted. If a
6615 journal is found to exist at the start of delivery, the addresses listed
6616 therein are added to the non-recipients. */
6618 if (addr_local || addr_remote)
6620 sprintf(CS spoolname, "%s/input/%s/%s-J", spool_directory, message_subdir, id);
6621 journal_fd = Uopen(spoolname, O_WRONLY|O_APPEND|O_CREAT, SPOOL_MODE);
6625 log_write(0, LOG_MAIN|LOG_PANIC, "Couldn't open journal file %s: %s",
6626 spoolname, strerror(errno));
6627 return DELIVER_NOT_ATTEMPTED;
6630 /* Set the close-on-exec flag, make the file owned by Exim, and ensure
6631 that the mode is correct - the group setting doesn't always seem to get
6632 set automatically. */
6634 if( fcntl(journal_fd, F_SETFD, fcntl(journal_fd, F_GETFD) | FD_CLOEXEC)
6635 || fchown(journal_fd, exim_uid, exim_gid)
6636 || fchmod(journal_fd, SPOOL_MODE)
6639 int ret = Uunlink(spoolname);
6640 log_write(0, LOG_MAIN|LOG_PANIC, "Couldn't set perms on journal file %s: %s",
6641 spoolname, strerror(errno));
6642 if(ret && errno != ENOENT)
6643 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s",
6644 spoolname, strerror(errno));
6645 return DELIVER_NOT_ATTEMPTED;
6651 /* Now we can get down to the business of actually doing deliveries. Local
6652 deliveries are done first, then remote ones. If ever the problems of how to
6653 handle fallback transports are figured out, this section can be put into a loop
6654 for handling fallbacks, though the uid switching will have to be revised. */
6656 /* Precompile a regex that is used to recognize a parameter in response
6657 to an LHLO command, if is isn't already compiled. This may be used on both
6658 local and remote LMTP deliveries. */
6660 if (!regex_IGNOREQUOTA)
6662 regex_must_compile(US"\\n250[\\s\\-]IGNOREQUOTA(\\s|\\n|$)", FALSE, TRUE);
6664 /* Handle local deliveries */
6668 DEBUG(D_deliver|D_transport)
6669 debug_printf(">>>>>>>>>>>>>>>> Local deliveries >>>>>>>>>>>>>>>>\n");
6670 do_local_deliveries();
6671 disable_logging = FALSE;
6674 /* If queue_run_local is set, we do not want to attempt any remote deliveries,
6675 so just queue them all. */
6677 if (queue_run_local)
6680 address_item *addr = addr_remote;
6681 addr_remote = addr->next;
6683 addr->basic_errno = ERRNO_LOCAL_ONLY;
6684 addr->message = US"remote deliveries suppressed";
6685 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_TRANSPORT, 0);
6688 /* Handle remote deliveries */
6692 DEBUG(D_deliver|D_transport)
6693 debug_printf(">>>>>>>>>>>>>>>> Remote deliveries >>>>>>>>>>>>>>>>\n");
6695 /* Precompile some regex that are used to recognize parameters in response
6696 to an EHLO command, if they aren't already compiled. */
6700 /* Now sort the addresses if required, and do the deliveries. The yield of
6701 do_remote_deliveries is FALSE when mua_wrapper is set and all addresses
6702 cannot be delivered in one transaction. */
6704 if (remote_sort_domains) sort_remote_deliveries();
6705 if (!do_remote_deliveries(FALSE))
6707 log_write(0, LOG_MAIN, "** mua_wrapper is set but recipients cannot all "
6708 "be delivered in one transaction");
6709 fprintf(stderr, "delivery to smarthost failed (configuration problem)\n");
6711 final_yield = DELIVER_MUA_FAILED;
6712 addr_failed = addr_defer = NULL; /* So that we remove the message */
6713 goto DELIVERY_TIDYUP;
6716 /* See if any of the addresses that failed got put on the queue for delivery
6717 to their fallback hosts. We do it this way because often the same fallback
6718 host is used for many domains, so all can be sent in a single transaction
6719 (if appropriately configured). */
6721 if (addr_fallback && !mua_wrapper)
6723 DEBUG(D_deliver) debug_printf("Delivering to fallback hosts\n");
6724 addr_remote = addr_fallback;
6725 addr_fallback = NULL;
6726 if (remote_sort_domains) sort_remote_deliveries();
6727 do_remote_deliveries(TRUE);
6729 disable_logging = FALSE;
6733 /* All deliveries are now complete. Ignore SIGTERM during this tidying up
6734 phase, to minimize cases of half-done things. */
6737 debug_printf(">>>>>>>>>>>>>>>> deliveries are done >>>>>>>>>>>>>>>>\n");
6739 /* Root privilege is no longer needed */
6741 exim_setugid(exim_uid, exim_gid, FALSE, US"post-delivery tidying");
6743 set_process_info("tidying up after delivering %s", message_id);
6744 signal(SIGTERM, SIG_IGN);
6746 /* When we are acting as an MUA wrapper, the smtp transport will either have
6747 succeeded for all addresses, or failed them all in normal cases. However, there
6748 are some setup situations (e.g. when a named port does not exist) that cause an
6749 immediate exit with deferral of all addresses. Convert those into failures. We
6750 do not ever want to retry, nor do we want to send a bounce message. */
6756 address_item *addr, *nextaddr;
6757 for (addr = addr_defer; addr; addr = nextaddr)
6759 log_write(0, LOG_MAIN, "** %s mua_wrapper forced failure for deferred "
6760 "delivery", addr->address);
6761 nextaddr = addr->next;
6762 addr->next = addr_failed;
6768 /* Now all should either have succeeded or failed. */
6771 final_yield = DELIVER_MUA_SUCCEEDED;
6775 uschar *s = addr_failed->user_message;
6777 if (!s) s = addr_failed->message;
6779 fprintf(stderr, "Delivery failed: ");
6780 if (addr_failed->basic_errno > 0)
6782 fprintf(stderr, "%s", strerror(addr_failed->basic_errno));
6783 if (s) fprintf(stderr, ": ");
6785 if ((host = addr_failed->host_used))
6786 fprintf(stderr, "H=%s [%s]: ", host->name, host->address);
6788 fprintf(stderr, "%s", CS s);
6789 else if (addr_failed->basic_errno <= 0)
6790 fprintf(stderr, "unknown error");
6791 fprintf(stderr, "\n");
6793 final_yield = DELIVER_MUA_FAILED;
6798 /* In a normal configuration, we now update the retry database. This is done in
6799 one fell swoop at the end in order not to keep opening and closing (and
6800 locking) the database. The code for handling retries is hived off into a
6801 separate module for convenience. We pass it the addresses of the various
6802 chains, because deferred addresses can get moved onto the failed chain if the
6803 retry cutoff time has expired for all alternative destinations. Bypass the
6804 updating of the database if the -N flag is set, which is a debugging thing that
6805 prevents actual delivery. */
6807 else if (!dont_deliver)
6808 retry_update(&addr_defer, &addr_failed, &addr_succeed);
6810 /* Send DSN for successful messages */
6811 addr_dsntmp = addr_succeed;
6812 addr_senddsn = NULL;
6816 /* af_ignore_error not honored here. it's not an error */
6819 debug_printf("DSN: processing router : %s\n"
6820 "DSN: processing successful delivery address: %s\n"
6821 "DSN: Sender_address: %s\n"
6822 "DSN: orcpt: %s flags: %d\n"
6823 "DSN: envid: %s ret: %d\n"
6824 "DSN: Final recipient: %s\n"
6825 "DSN: Remote SMTP server supports DSN: %d\n",
6826 addr_dsntmp->router->name,
6827 addr_dsntmp->address,
6829 addr_dsntmp->dsn_orcpt, addr_dsntmp->dsn_flags,
6831 addr_dsntmp->address,
6832 addr_dsntmp->dsn_aware
6836 /* send report if next hop not DSN aware or a router flagged "last DSN hop"
6837 and a report was requested */
6838 if ( ( addr_dsntmp->dsn_aware != dsn_support_yes
6839 || addr_dsntmp->dsn_flags & rf_dsnlasthop
6841 && addr_dsntmp->dsn_flags & rf_dsnflags
6842 && addr_dsntmp->dsn_flags & rf_notify_success
6845 /* copy and relink address_item and send report with all of them at once later */
6846 address_item *addr_next;
6847 addr_next = addr_senddsn;
6848 addr_senddsn = store_get(sizeof(address_item));
6849 memcpy(addr_senddsn, addr_dsntmp, sizeof(address_item));
6850 addr_senddsn->next = addr_next;
6853 DEBUG(D_deliver) debug_printf("DSN: not sending DSN success message\n");
6855 addr_dsntmp = addr_dsntmp->next;
6863 /* create exim process to send message */
6864 pid = child_open_exim(&fd);
6866 DEBUG(D_deliver) debug_printf("DSN: child_open_exim returns: %d\n", pid);
6868 if (pid < 0) /* Creation of child failed */
6870 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Process %d (parent %d) failed to "
6871 "create child process to send failure message: %s", getpid(),
6872 getppid(), strerror(errno));
6874 DEBUG(D_deliver) debug_printf("DSN: child_open_exim failed\n");
6876 else /* Creation of child succeeded */
6878 FILE *f = fdopen(fd, "wb");
6879 /* header only as required by RFC. only failure DSN needs to honor RET=FULL */
6880 int topt = topt_add_return_path | topt_no_body;
6884 debug_printf("sending error message to: %s\n", sender_address);
6886 /* build unique id for MIME boundary */
6887 bound = string_sprintf(TIME_T_FMT "-eximdsn-%d", time(NULL), rand());
6888 DEBUG(D_deliver) debug_printf("DSN: MIME boundary: %s\n", bound);
6890 if (errors_reply_to)
6891 fprintf(f, "Reply-To: %s\n", errors_reply_to);
6893 fprintf(f, "Auto-Submitted: auto-generated\n"
6894 "From: Mail Delivery System <Mailer-Daemon@%s>\n"
6896 "Subject: Delivery Status Notification\n"
6897 "Content-Type: multipart/report; report-type=delivery-status; boundary=%s\n"
6898 "MIME-Version: 1.0\n\n"
6901 "Content-type: text/plain; charset=us-ascii\n\n"
6903 "This message was created automatically by mail delivery software.\n"
6904 " ----- The following addresses had successful delivery notifications -----\n",
6905 qualify_domain_sender, sender_address, bound, bound);
6907 for (addr_dsntmp = addr_senddsn; addr_dsntmp;
6908 addr_dsntmp = addr_dsntmp->next)
6909 fprintf(f, "<%s> (relayed %s)\n\n",
6910 addr_dsntmp->address,
6911 (addr_dsntmp->dsn_flags & rf_dsnlasthop) == 1
6912 ? "via non DSN router"
6913 : addr_dsntmp->dsn_aware == dsn_support_no
6914 ? "to non-DSN-aware mailer"
6915 : "via non \"Remote SMTP\" router"
6919 "Content-type: message/delivery-status\n\n"
6920 "Reporting-MTA: dns; %s\n",
6921 bound, smtp_active_hostname);
6924 { /* must be decoded from xtext: see RFC 3461:6.3a */
6926 if (auth_xtextdecode(dsn_envid, &xdec_envid) > 0)
6927 fprintf(f, "Original-Envelope-ID: %s\n", dsn_envid);
6929 fprintf(f, "X-Original-Envelope-ID: error decoding xtext formated ENVID\n");
6933 for (addr_dsntmp = addr_senddsn;
6935 addr_dsntmp = addr_dsntmp->next)
6937 if (addr_dsntmp->dsn_orcpt)
6938 fprintf(f,"Original-Recipient: %s\n", addr_dsntmp->dsn_orcpt);
6940 fprintf(f, "Action: delivered\n"
6941 "Final-Recipient: rfc822;%s\n"
6943 addr_dsntmp->address);
6945 if (addr_dsntmp->host_used && addr_dsntmp->host_used->name)
6946 fprintf(f, "Remote-MTA: dns; %s\nDiagnostic-Code: smtp; 250 Ok\n\n",
6947 addr_dsntmp->host_used->name);
6949 fprintf(f, "Diagnostic-Code: X-Exim; relayed via non %s router\n\n",
6950 (addr_dsntmp->dsn_flags & rf_dsnlasthop) == 1 ? "DSN" : "SMTP");
6953 fprintf(f, "--%s\nContent-type: text/rfc822-headers\n\n", bound);
6956 transport_filter_argv = NULL; /* Just in case */
6957 return_path = sender_address; /* In case not previously set */
6959 /* Write the original email out */
6960 transport_write_message(NULL, fileno(f), topt, 0, NULL, NULL, NULL, NULL, NULL, 0);
6963 fprintf(f,"\n--%s--\n", bound);
6967 rc = child_close(pid, 0); /* Waits for child to close, no timeout */
6971 /* If any addresses failed, we must send a message to somebody, unless
6972 af_ignore_error is set, in which case no action is taken. It is possible for
6973 several messages to get sent if there are addresses with different
6980 uschar *logtod = tod_stamp(tod_log);
6982 address_item *handled_addr = NULL;
6983 address_item **paddr;
6984 address_item *msgchain = NULL;
6985 address_item **pmsgchain = &msgchain;
6987 /* There are weird cases when logging is disabled in the transport. However,
6988 there may not be a transport (address failed by a router). */
6990 disable_logging = FALSE;
6991 if (addr_failed->transport)
6992 disable_logging = addr_failed->transport->disable_logging;
6995 debug_printf("processing failed address %s\n", addr_failed->address);
6997 /* There are only two ways an address in a bounce message can get here:
6999 (1) When delivery was initially deferred, but has now timed out (in the call
7000 to retry_update() above). We can detect this by testing for
7001 af_retry_timedout. If the address does not have its own errors address,
7002 we arrange to ignore the error.
7004 (2) If delivery failures for bounce messages are being ignored. We can detect
7005 this by testing for af_ignore_error. This will also be set if a bounce
7006 message has been autothawed and the ignore_bounce_errors_after time has
7007 passed. It might also be set if a router was explicitly configured to
7008 ignore errors (errors_to = "").
7010 If neither of these cases obtains, something has gone wrong. Log the
7011 incident, but then ignore the error. */
7013 if (sender_address[0] == 0 && !addr_failed->prop.errors_address)
7015 if ( !testflag(addr_failed, af_retry_timedout)
7016 && !testflag(addr_failed, af_ignore_error))
7018 log_write(0, LOG_MAIN|LOG_PANIC, "internal error: bounce message "
7019 "failure is neither frozen nor ignored (it's been ignored)");
7021 setflag(addr_failed, af_ignore_error);
7024 /* If the first address on the list has af_ignore_error set, just remove
7025 it from the list, throw away any saved message file, log it, and
7026 mark the recipient done. */
7028 if ( testflag(addr_failed, af_ignore_error)
7029 || ( addr_failed->dsn_flags & rf_dsnflags
7030 && (addr_failed->dsn_flags & rf_notify_failure) != rf_notify_failure
7034 addr_failed = addr->next;
7035 if (addr->return_filename) Uunlink(addr->return_filename);
7037 log_write(0, LOG_MAIN, "%s%s%s%s: error ignored",
7039 !addr->parent ? US"" : US" <",
7040 !addr->parent ? US"" : addr->parent->address,
7041 !addr->parent ? US"" : US">");
7043 address_done(addr, logtod);
7044 child_done(addr, logtod);
7045 /* Panic-dies on error */
7046 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
7049 /* Otherwise, handle the sending of a message. Find the error address for
7050 the first address, then send a message that includes all failed addresses
7051 that have the same error address. Note the bounce_recipient is a global so
7052 that it can be accesssed by $bounce_recipient while creating a customized
7057 if (!(bounce_recipient = addr_failed->prop.errors_address))
7058 bounce_recipient = sender_address;
7060 /* Make a subprocess to send a message */
7062 if ((pid = child_open_exim(&fd)) < 0)
7063 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Process %d (parent %d) failed to "
7064 "create child process to send failure message: %s", getpid(),
7065 getppid(), strerror(errno));
7067 /* Creation of child succeeded */
7074 uschar *bcc, *emf_text;
7075 FILE *f = fdopen(fd, "wb");
7077 BOOL to_sender = strcmpic(sender_address, bounce_recipient) == 0;
7078 int max = (bounce_return_size_limit/DELIVER_IN_BUFFER_SIZE + 1) *
7079 DELIVER_IN_BUFFER_SIZE;
7081 uschar *dsnlimitmsg;
7082 uschar *dsnnotifyhdr;
7086 debug_printf("sending error message to: %s\n", bounce_recipient);
7088 /* Scan the addresses for all that have the same errors address, removing
7089 them from the addr_failed chain, and putting them on msgchain. */
7091 paddr = &addr_failed;
7092 for (addr = addr_failed; addr; addr = *paddr)
7093 if (Ustrcmp(bounce_recipient, addr->prop.errors_address
7094 ? addr->prop.errors_address : sender_address) == 0)
7095 { /* The same - dechain */
7096 *paddr = addr->next;
7099 pmsgchain = &(addr->next);
7102 paddr = &addr->next; /* Not the same; skip */
7104 /* Include X-Failed-Recipients: for automatic interpretation, but do
7105 not let any one header line get too long. We do this by starting a
7106 new header every 50 recipients. Omit any addresses for which the
7107 "hide_child" flag is set. */
7109 for (addr = msgchain; addr; addr = addr->next)
7111 if (testflag(addr, af_hide_child)) continue;
7119 ? "X-Failed-Recipients: "
7121 testflag(addr, af_pfr) && addr->parent
7122 ? string_printing(addr->parent->address)
7123 : string_printing(addr->address));
7125 if (rcount > 0) fprintf(f, "\n");
7127 /* Output the standard headers */
7129 if (errors_reply_to)
7130 fprintf(f, "Reply-To: %s\n", errors_reply_to);
7131 fprintf(f, "Auto-Submitted: auto-replied\n");
7133 fprintf(f, "To: %s\n", bounce_recipient);
7135 /* generate boundary string and output MIME-Headers */
7136 bound = string_sprintf(TIME_T_FMT "-eximdsn-%d", time(NULL), rand());
7138 fprintf(f, "Content-Type: multipart/report;"
7139 " report-type=delivery-status; boundary=%s\n"
7140 "MIME-Version: 1.0\n",
7143 /* Open a template file if one is provided. Log failure to open, but
7144 carry on - default texts will be used. */
7146 if (bounce_message_file)
7147 if (!(emf = Ufopen(bounce_message_file, "rb")))
7148 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to open %s for error "
7149 "message texts: %s", bounce_message_file, strerror(errno));
7151 /* Quietly copy to configured additional addresses if required. */
7153 if ((bcc = moan_check_errorcopy(bounce_recipient)))
7154 fprintf(f, "Bcc: %s\n", bcc);
7156 /* The texts for the message can be read from a template file; if there
7157 isn't one, or if it is too short, built-in texts are used. The first
7158 emf text is a Subject: and any other headers. */
7160 if ((emf_text = next_emf(emf, US"header")))
7161 fprintf(f, "%s\n", emf_text);
7163 fprintf(f, "Subject: Mail delivery failed%s\n\n",
7164 to_sender? ": returning message to sender" : "");
7166 /* output human readable part as text/plain section */
7168 "Content-type: text/plain; charset=us-ascii\n\n",
7171 if ((emf_text = next_emf(emf, US"intro")))
7172 fprintf(f, "%s", CS emf_text);
7176 /* This message has been reworded several times. It seems to be confusing to
7177 somebody, however it is worded. I have retreated to the original, simple
7179 "This message was created automatically by mail delivery software.\n");
7181 if (bounce_message_text)
7182 fprintf(f, "%s", CS bounce_message_text);
7185 "\nA message that you sent could not be delivered to one or more of its\n"
7186 "recipients. This is a permanent error. The following address(es) failed:\n");
7189 "\nA message sent by\n\n <%s>\n\n"
7190 "could not be delivered to one or more of its recipients. The following\n"
7191 "address(es) failed:\n", sender_address);
7195 /* Process the addresses, leaving them on the msgchain if they have a
7196 file name for a return message. (There has already been a check in
7197 post_process_one() for the existence of data in the message file.) A TRUE
7198 return from print_address_information() means that the address is not
7202 for (addr = msgchain; addr; addr = *paddr)
7204 if (print_address_information(addr, f, US" ", US"\n ", US""))
7205 print_address_error(addr, f, US"");
7207 /* End the final line for the address */
7211 /* Leave on msgchain if there's a return file. */
7213 if (addr->return_file >= 0)
7215 paddr = &(addr->next);
7219 /* Else save so that we can tick off the recipient when the
7224 *paddr = addr->next;
7225 addr->next = handled_addr;
7226 handled_addr = addr;
7232 /* Get the next text, whether we need it or not, so as to be
7233 positioned for the one after. */
7235 emf_text = next_emf(emf, US"generated text");
7237 /* If there were any file messages passed by the local transports,
7238 include them in the message. Then put the address on the handled chain.
7239 In the case of a batch of addresses that were all sent to the same
7240 transport, the return_file field in all of them will contain the same
7241 fd, and the return_filename field in the *last* one will be set (to the
7242 name of the file). */
7246 address_item *nextaddr;
7249 fprintf(f, "%s", CS emf_text);
7252 "The following text was generated during the delivery "
7253 "attempt%s:\n", (filecount > 1)? "s" : "");
7255 for (addr = msgchain; addr; addr = nextaddr)
7258 address_item *topaddr = addr;
7260 /* List all the addresses that relate to this file */
7263 while(addr) /* Insurance */
7265 print_address_information(addr, f, US"------ ", US"\n ",
7267 if (addr->return_filename) break;
7272 /* Now copy the file */
7274 if (!(fm = Ufopen(addr->return_filename, "rb")))
7275 fprintf(f, " +++ Exim error... failed to open text file: %s\n",
7279 while ((ch = fgetc(fm)) != EOF) fputc(ch, f);
7282 Uunlink(addr->return_filename);
7284 /* Can now add to handled chain, first fishing off the next
7285 address on the msgchain. */
7287 nextaddr = addr->next;
7288 addr->next = handled_addr;
7289 handled_addr = topaddr;
7294 /* output machine readable part */
7295 #ifdef EXPERIMENTAL_INTERNATIONAL
7296 if (message_smtputf8)
7298 "Content-type: message/global-delivery-status\n\n"
7299 "Reporting-MTA: dns; %s\n",
7300 bound, smtp_active_hostname);
7304 "Content-type: message/delivery-status\n\n"
7305 "Reporting-MTA: dns; %s\n",
7306 bound, smtp_active_hostname);
7310 /* must be decoded from xtext: see RFC 3461:6.3a */
7312 if (auth_xtextdecode(dsn_envid, &xdec_envid) > 0)
7313 fprintf(f, "Original-Envelope-ID: %s\n", dsn_envid);
7315 fprintf(f, "X-Original-Envelope-ID: error decoding xtext formated ENVID\n");
7319 for (addr = handled_addr; addr; addr = addr->next)
7322 fprintf(f, "Action: failed\n"
7323 "Final-Recipient: rfc822;%s\n"
7326 if ((hu = addr->host_used) && hu->name)
7329 fprintf(f, "Remote-MTA: dns; %s\n",
7331 #ifdef EXPERIMENTAL_DSN_INFO
7334 uschar * p = hu->port == 25
7335 ? US"" : string_sprintf(":%d", hu->port);
7336 fprintf(f, "Remote-MTA: X-ip; [%s]%s\n", hu->address, p);
7338 if ((s = addr->smtp_greeting) && *s)
7339 fprintf(f, "X-Remote-MTA-smtp-greeting: X-str; %s\n", s);
7340 if ((s = addr->helo_response) && *s)
7341 fprintf(f, "X-Remote-MTA-helo-response: X-str; %s\n", s);
7342 if ((s = addr->message) && *s)
7343 fprintf(f, "X-Exim-Diagnostic: X-str; %s\n", s);
7345 print_dsn_diagnostic_code(addr, f);
7350 /* Now copy the message, trying to give an intelligible comment if
7351 it is too long for it all to be copied. The limit isn't strictly
7352 applied because of the buffering. There is, however, an option
7353 to suppress copying altogether. */
7355 emf_text = next_emf(emf, US"copy");
7358 we ignore the intro text from template and add
7359 the text for bounce_return_size_limit at the end.
7361 bounce_return_message is ignored
7362 in case RET= is defined we honor these values
7363 otherwise bounce_return_body is honored.
7365 bounce_return_size_limit is always honored.
7368 fprintf(f, "--%s\n", bound);
7370 dsnlimitmsg = US"X-Exim-DSN-Information: Due to administrative limits only headers are returned";
7371 dsnnotifyhdr = NULL;
7372 topt = topt_add_return_path;
7374 /* RET=HDRS? top priority */
7375 if (dsn_ret == dsn_ret_hdrs)
7376 topt |= topt_no_body;
7378 /* no full body return at all? */
7379 if (!bounce_return_body)
7381 topt |= topt_no_body;
7382 /* add header if we overrule RET=FULL */
7383 if (dsn_ret == dsn_ret_full)
7384 dsnnotifyhdr = dsnlimitmsg;
7386 /* size limited ... return headers only if limit reached */
7387 else if (bounce_return_size_limit > 0)
7389 struct stat statbuf;
7390 if (fstat(deliver_datafile, &statbuf) == 0 && statbuf.st_size > max)
7392 topt |= topt_no_body;
7393 dsnnotifyhdr = dsnlimitmsg;
7397 #ifdef EXPERIMENTAL_INTERNATIONAL
7398 if (message_smtputf8)
7399 fputs(topt & topt_no_body ? "Content-type: message/global-headers\n\n"
7400 : "Content-type: message/global\n\n",
7404 fputs(topt & topt_no_body ? "Content-type: text/rfc822-headers\n\n"
7405 : "Content-type: message/rfc822\n\n",
7409 transport_filter_argv = NULL; /* Just in case */
7410 return_path = sender_address; /* In case not previously set */
7411 transport_write_message(NULL, fileno(f), topt,
7412 0, dsnnotifyhdr, NULL, NULL, NULL, NULL, 0);
7415 /* we never add the final text. close the file */
7419 fprintf(f, "\n--%s--\n", bound);
7421 /* Close the file, which should send an EOF to the child process
7422 that is receiving the message. Wait for it to finish. */
7425 rc = child_close(pid, 0); /* Waits for child to close, no timeout */
7427 /* In the test harness, let the child do it's thing first. */
7429 if (running_in_test_harness) millisleep(500);
7431 /* If the process failed, there was some disaster in setting up the
7432 error message. Unless the message is very old, ensure that addr_defer
7433 is non-null, which will have the effect of leaving the message on the
7434 spool. The failed addresses will get tried again next time. However, we
7435 don't really want this to happen too often, so freeze the message unless
7436 there are some genuine deferred addresses to try. To do this we have
7437 to call spool_write_header() here, because with no genuine deferred
7438 addresses the normal code below doesn't get run. */
7443 if (now - received_time < retry_maximum_timeout && !addr_defer)
7445 addr_defer = (address_item *)(+1);
7446 deliver_freeze = TRUE;
7447 deliver_frozen_at = time(NULL);
7448 /* Panic-dies on error */
7449 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
7452 deliver_msglog("Process failed (%d) when writing error message "
7453 "to %s%s", rc, bounce_recipient, s);
7454 log_write(0, LOG_MAIN, "Process failed (%d) when writing error message "
7455 "to %s%s", rc, bounce_recipient, s);
7458 /* The message succeeded. Ensure that the recipients that failed are
7459 now marked finished with on the spool and their parents updated. */
7463 for (addr = handled_addr; addr; addr = addr->next)
7465 address_done(addr, logtod);
7466 child_done(addr, logtod);
7468 /* Panic-dies on error */
7469 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
7475 disable_logging = FALSE; /* In case left set */
7477 /* Come here from the mua_wrapper case if routing goes wrong */
7481 /* If there are now no deferred addresses, we are done. Preserve the
7482 message log if so configured, and we are using them. Otherwise, sling it.
7483 Then delete the message itself. */
7489 sprintf(CS spoolname, "%s/msglog/%s/%s", spool_directory, message_subdir,
7491 if (preserve_message_logs)
7494 sprintf(CS big_buffer, "%s/msglog.OLD/%s", spool_directory, id);
7495 if ((rc = Urename(spoolname, big_buffer)) < 0)
7497 (void)directory_make(spool_directory, US"msglog.OLD",
7498 MSGLOG_DIRECTORY_MODE, TRUE);
7499 rc = Urename(spoolname, big_buffer);
7502 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to move %s to the "
7503 "msglog.OLD directory", spoolname);
7506 if (Uunlink(spoolname) < 0)
7507 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s",
7508 spoolname, strerror(errno));
7511 /* Remove the two message files. */
7513 sprintf(CS spoolname, "%s/input/%s/%s-D", spool_directory, message_subdir, id);
7514 if (Uunlink(spoolname) < 0)
7515 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s",
7516 spoolname, strerror(errno));
7517 sprintf(CS spoolname, "%s/input/%s/%s-H", spool_directory, message_subdir, id);
7518 if (Uunlink(spoolname) < 0)
7519 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s",
7520 spoolname, strerror(errno));
7522 /* Log the end of this message, with queue time if requested. */
7524 if (LOGGING(queue_time_overall))
7525 log_write(0, LOG_MAIN, "Completed QT=%s",
7526 readconf_printtime( (int) ((long)time(NULL) - (long)received_time)) );
7528 log_write(0, LOG_MAIN, "Completed");
7530 /* Unset deliver_freeze so that we won't try to move the spool files further down */
7531 deliver_freeze = FALSE;
7533 #ifdef EXPERIMENTAL_EVENT
7534 (void) event_raise(event_action, US"msg:complete", NULL);
7538 /* If there are deferred addresses, we are keeping this message because it is
7539 not yet completed. Lose any temporary files that were catching output from
7540 pipes for any of the deferred addresses, handle one-time aliases, and see if
7541 the message has been on the queue for so long that it is time to send a warning
7542 message to the sender, unless it is a mailer-daemon. If all deferred addresses
7543 have the same domain, we can set deliver_domain for the expansion of
7544 delay_warning_ condition - if any of them are pipes, files, or autoreplies, use
7545 the parent's domain.
7547 If all the deferred addresses have an error number that indicates "retry time
7548 not reached", skip sending the warning message, because it won't contain the
7549 reason for the delay. It will get sent at the next real delivery attempt.
7550 However, if at least one address has tried, we'd better include all of them in
7553 If we can't make a process to send the message, don't worry.
7555 For mailing list expansions we want to send the warning message to the
7556 mailing list manager. We can't do a perfect job here, as some addresses may
7557 have different errors addresses, but if we take the errors address from
7558 each deferred address it will probably be right in most cases.
7560 If addr_defer == +1, it means there was a problem sending an error message
7561 for failed addresses, and there were no "real" deferred addresses. The value
7562 was set just to keep the message on the spool, so there is nothing to do here.
7565 else if (addr_defer != (address_item *)(+1))
7568 uschar *recipients = US"";
7569 BOOL delivery_attempted = FALSE;
7571 deliver_domain = testflag(addr_defer, af_pfr)
7572 ? addr_defer->parent->domain : addr_defer->domain;
7574 for (addr = addr_defer; addr; addr = addr->next)
7576 address_item *otaddr;
7578 if (addr->basic_errno > ERRNO_RETRY_BASE) delivery_attempted = TRUE;
7582 const uschar *d = testflag(addr, af_pfr)
7583 ? addr->parent->domain : addr->domain;
7585 /* The domain may be unset for an address that has never been routed
7586 because the system filter froze the message. */
7588 if (!d || Ustrcmp(d, deliver_domain) != 0)
7589 deliver_domain = NULL;
7592 if (addr->return_filename) Uunlink(addr->return_filename);
7594 /* Handle the case of one-time aliases. If any address in the ancestry
7595 of this one is flagged, ensure it is in the recipients list, suitably
7596 flagged, and that its parent is marked delivered. */
7598 for (otaddr = addr; otaddr; otaddr = otaddr->parent)
7599 if (otaddr->onetime_parent) break;
7604 int t = recipients_count;
7606 for (i = 0; i < recipients_count; i++)
7608 uschar *r = recipients_list[i].address;
7609 if (Ustrcmp(otaddr->onetime_parent, r) == 0) t = i;
7610 if (Ustrcmp(otaddr->address, r) == 0) break;
7613 /* Didn't find the address already in the list, and did find the
7614 ultimate parent's address in the list. After adding the recipient,
7615 update the errors address in the recipients list. */
7617 if (i >= recipients_count && t < recipients_count)
7619 DEBUG(D_deliver) debug_printf("one_time: adding %s in place of %s\n",
7620 otaddr->address, otaddr->parent->address);
7621 receive_add_recipient(otaddr->address, t);
7622 recipients_list[recipients_count-1].errors_to = otaddr->prop.errors_address;
7623 tree_add_nonrecipient(otaddr->parent->address);
7624 update_spool = TRUE;
7628 /* Except for error messages, ensure that either the errors address for
7629 this deferred address or, if there is none, the sender address, is on the
7630 list of recipients for a warning message. */
7632 if (sender_address[0] != 0)
7633 if (addr->prop.errors_address)
7635 if (Ustrstr(recipients, addr->prop.errors_address) == NULL)
7636 recipients = string_sprintf("%s%s%s", recipients,
7637 (recipients[0] == 0)? "" : ",", addr->prop.errors_address);
7641 if (Ustrstr(recipients, sender_address) == NULL)
7642 recipients = string_sprintf("%s%s%s", recipients,
7643 (recipients[0] == 0)? "" : ",", sender_address);
7647 /* Send a warning message if the conditions are right. If the condition check
7648 fails because of a lookup defer, there is nothing we can do. The warning
7649 is not sent. Another attempt will be made at the next delivery attempt (if
7653 && delivery_attempted
7654 && ( ((addr_defer->dsn_flags & rf_dsnflags) == 0)
7655 || (addr_defer->dsn_flags & rf_notify_delay) == rf_notify_delay
7657 && delay_warning[1] > 0
7658 && sender_address[0] != 0
7659 && ( !delay_warning_condition
7660 || expand_check_condition(delay_warning_condition,
7661 US"delay_warning", US"option")
7667 int queue_time = time(NULL) - received_time;
7669 /* When running in the test harness, there's an option that allows us to
7670 fudge this time so as to get repeatability of the tests. Take the first
7671 time off the list. In queue runs, the list pointer gets updated in the
7674 if (running_in_test_harness && fudged_queue_times[0] != 0)
7676 int qt = readconf_readtime(fudged_queue_times, '/', FALSE);
7679 DEBUG(D_deliver) debug_printf("fudged queue_times = %s\n",
7680 fudged_queue_times);
7685 /* See how many warnings we should have sent by now */
7687 for (count = 0; count < delay_warning[1]; count++)
7688 if (queue_time < delay_warning[count+2]) break;
7690 show_time = delay_warning[count+1];
7692 if (count >= delay_warning[1])
7695 int last_gap = show_time;
7696 if (count > 1) last_gap -= delay_warning[count];
7697 extra = (queue_time - delay_warning[count+1])/last_gap;
7698 show_time += last_gap * extra;
7704 debug_printf("time on queue = %s\n", readconf_printtime(queue_time));
7705 debug_printf("warning counts: required %d done %d\n", count,
7709 /* We have computed the number of warnings there should have been by now.
7710 If there haven't been enough, send one, and up the count to what it should
7713 if (warning_count < count)
7717 pid_t pid = child_open_exim(&fd);
7723 FILE *f = fdopen(fd, "wb");
7726 if (warn_message_file)
7727 if (!(wmf = Ufopen(warn_message_file, "rb")))
7728 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to open %s for warning "
7729 "message texts: %s", warn_message_file, strerror(errno));
7731 warnmsg_recipients = recipients;
7732 warnmsg_delay = queue_time < 120*60
7733 ? string_sprintf("%d minutes", show_time/60)
7734 : string_sprintf("%d hours", show_time/3600);
7736 if (errors_reply_to)
7737 fprintf(f, "Reply-To: %s\n", errors_reply_to);
7738 fprintf(f, "Auto-Submitted: auto-replied\n");
7740 fprintf(f, "To: %s\n", recipients);
7742 /* generated boundary string and output MIME-Headers */
7743 bound = string_sprintf(TIME_T_FMT "-eximdsn-%d", time(NULL), rand());
7745 fprintf(f, "Content-Type: multipart/report;"
7746 " report-type=delivery-status; boundary=%s\n"
7747 "MIME-Version: 1.0\n",
7750 if ((wmf_text = next_emf(wmf, US"header")))
7751 fprintf(f, "%s\n", wmf_text);
7753 fprintf(f, "Subject: Warning: message %s delayed %s\n\n",
7754 message_id, warnmsg_delay);
7756 /* output human readable part as text/plain section */
7758 "Content-type: text/plain; charset=us-ascii\n\n",
7761 if ((wmf_text = next_emf(wmf, US"intro")))
7762 fprintf(f, "%s", CS wmf_text);
7766 "This message was created automatically by mail delivery software.\n");
7768 if (Ustrcmp(recipients, sender_address) == 0)
7770 "A message that you sent has not yet been delivered to one or more of its\n"
7771 "recipients after more than ");
7775 "A message sent by\n\n <%s>\n\n"
7776 "has not yet been delivered to one or more of its recipients after more than \n",
7779 fprintf(f, "%s on the queue on %s.\n\n"
7780 "The message identifier is: %s\n",
7781 warnmsg_delay, primary_hostname, message_id);
7783 for (h = header_list; h; h = h->next)
7784 if (strncmpic(h->text, US"Subject:", 8) == 0)
7785 fprintf(f, "The subject of the message is: %s", h->text + 9);
7786 else if (strncmpic(h->text, US"Date:", 5) == 0)
7787 fprintf(f, "The date of the message is: %s", h->text + 6);
7790 fprintf(f, "The address%s to which the message has not yet been "
7792 !addr_defer->next ? "" : "es",
7793 !addr_defer->next ? "is": "are");
7796 /* List the addresses, with error information if allowed */
7798 /* store addr_defer for machine readable part */
7799 address_item *addr_dsndefer = addr_defer;
7803 address_item *addr = addr_defer;
7804 addr_defer = addr->next;
7805 if (print_address_information(addr, f, US" ", US"\n ", US""))
7806 print_address_error(addr, f, US"Delay reason: ");
7815 if ((wmf_text = next_emf(wmf, US"final")))
7816 fprintf(f, "%s", CS wmf_text);
7822 "No action is required on your part. Delivery attempts will continue for\n"
7823 "some time, and this warning may be repeated at intervals if the message\n"
7824 "remains undelivered. Eventually the mail delivery software will give up,\n"
7825 "and when that happens, the message will be returned to you.\n");
7828 /* output machine readable part */
7829 fprintf(f, "\n--%s\n"
7830 "Content-type: message/delivery-status\n\n"
7831 "Reporting-MTA: dns; %s\n",
7833 smtp_active_hostname);
7838 /* must be decoded from xtext: see RFC 3461:6.3a */
7840 if (auth_xtextdecode(dsn_envid, &xdec_envid) > 0)
7841 fprintf(f,"Original-Envelope-ID: %s\n", dsn_envid);
7843 fprintf(f,"X-Original-Envelope-ID: error decoding xtext formated ENVID\n");
7847 for ( ; addr_dsndefer; addr_dsndefer = addr_dsndefer->next)
7849 if (addr_dsndefer->dsn_orcpt)
7850 fprintf(f, "Original-Recipient: %s\n", addr_dsndefer->dsn_orcpt);
7852 fprintf(f, "Action: delayed\n"
7853 "Final-Recipient: rfc822;%s\n"
7855 addr_dsndefer->address);
7856 if (addr_dsndefer->host_used && addr_dsndefer->host_used->name)
7858 fprintf(f, "Remote-MTA: dns; %s\n",
7859 addr_dsndefer->host_used->name);
7860 print_dsn_diagnostic_code(addr_dsndefer, f);
7866 "Content-type: text/rfc822-headers\n\n",
7870 /* header only as required by RFC. only failure DSN needs to honor RET=FULL */
7871 int topt = topt_add_return_path | topt_no_body;
7872 transport_filter_argv = NULL; /* Just in case */
7873 return_path = sender_address; /* In case not previously set */
7874 /* Write the original email out */
7875 transport_write_message(NULL, fileno(f), topt, 0, NULL, NULL, NULL, NULL, NULL, 0);
7878 fprintf(f,"\n--%s--\n", bound);
7882 /* Close and wait for child process to complete, without a timeout.
7883 If there's an error, don't update the count. */
7886 if (child_close(pid, 0) == 0)
7888 warning_count = count;
7889 update_spool = TRUE; /* Ensure spool rewritten */
7895 /* Clear deliver_domain */
7897 deliver_domain = NULL;
7899 /* If this was a first delivery attempt, unset the first time flag, and
7900 ensure that the spool gets updated. */
7902 if (deliver_firsttime)
7904 deliver_firsttime = FALSE;
7905 update_spool = TRUE;
7908 /* If delivery was frozen and freeze_tell is set, generate an appropriate
7909 message, unless the message is a local error message (to avoid loops). Then
7910 log the freezing. If the text in "frozen_info" came from a system filter,
7911 it has been escaped into printing characters so as not to mess up log lines.
7912 For the "tell" message, we turn \n back into newline. Also, insert a newline
7913 near the start instead of the ": " string. */
7917 if (freeze_tell && freeze_tell[0] != 0 && !local_error_message)
7919 uschar *s = string_copy(frozen_info);
7920 uschar *ss = Ustrstr(s, " by the system filter: ");
7931 if (*ss == '\\' && ss[1] == 'n')
7938 moan_tell_someone(freeze_tell, addr_defer, US"Message frozen",
7939 "Message %s has been frozen%s.\nThe sender is <%s>.\n", message_id,
7943 /* Log freezing just before we update the -H file, to minimize the chance
7944 of a race problem. */
7946 deliver_msglog("*** Frozen%s\n", frozen_info);
7947 log_write(0, LOG_MAIN, "Frozen%s", frozen_info);
7950 /* If there have been any updates to the non-recipients list, or other things
7951 that get written to the spool, we must now update the spool header file so
7952 that it has the right information for the next delivery attempt. If there
7953 was more than one address being delivered, the header_change update is done
7954 earlier, in case one succeeds and then something crashes. */
7957 debug_printf("delivery deferred: update_spool=%d header_rewritten=%d\n",
7958 update_spool, header_rewritten);
7960 if (update_spool || header_rewritten)
7961 /* Panic-dies on error */
7962 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
7965 /* Finished with the message log. If the message is complete, it will have
7966 been unlinked or renamed above. */
7968 if (message_logs) (void)fclose(message_log);
7970 /* Now we can close and remove the journal file. Its only purpose is to record
7971 successfully completed deliveries asap so that this information doesn't get
7972 lost if Exim (or the machine) crashes. Forgetting about a failed delivery is
7973 not serious, as trying it again is not harmful. The journal might not be open
7974 if all addresses were deferred at routing or directing. Nevertheless, we must
7975 remove it if it exists (may have been lying around from a crash during the
7976 previous delivery attempt). We don't remove the journal if a delivery
7977 subprocess failed to pass back delivery information; this is controlled by
7978 the remove_journal flag. When the journal is left, we also don't move the
7979 message off the main spool if frozen and the option is set. It should get moved
7980 at the next attempt, after the journal has been inspected. */
7982 if (journal_fd >= 0) (void)close(journal_fd);
7986 sprintf(CS spoolname, "%s/input/%s/%s-J", spool_directory, message_subdir, id);
7987 if (Uunlink(spoolname) < 0 && errno != ENOENT)
7988 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s", spoolname,
7991 /* Move the message off the spool if reqested */
7993 #ifdef SUPPORT_MOVE_FROZEN_MESSAGES
7994 if (deliver_freeze && move_frozen_messages)
7995 (void)spool_move_message(id, message_subdir, US"", US"F");
7999 /* Closing the data file frees the lock; if the file has been unlinked it
8000 will go away. Otherwise the message becomes available for another process
8003 (void)close(deliver_datafile);
8004 deliver_datafile = -1;
8005 DEBUG(D_deliver) debug_printf("end delivery of %s\n", id);
8007 /* It is unlikely that there will be any cached resources, since they are
8008 released after routing, and in the delivery subprocesses. However, it's
8009 possible for an expansion for something afterwards (for example,
8010 expand_check_condition) to do a lookup. We must therefore be sure everything is
8014 acl_where = ACL_WHERE_UNKNOWN;
8023 if (!regex_PIPELINING) regex_PIPELINING =
8024 regex_must_compile(US"\\n250[\\s\\-]PIPELINING(\\s|\\n|$)", FALSE, TRUE);
8026 if (!regex_SIZE) regex_SIZE =
8027 regex_must_compile(US"\\n250[\\s\\-]SIZE(\\s|\\n|$)", FALSE, TRUE);
8029 if (!regex_AUTH) regex_AUTH =
8030 regex_must_compile(US"\\n250[\\s\\-]AUTH\\s+([\\-\\w\\s]+)(?:\\n|$)",
8034 if (!regex_STARTTLS) regex_STARTTLS =
8035 regex_must_compile(US"\\n250[\\s\\-]STARTTLS(\\s|\\n|$)", FALSE, TRUE);
8038 #ifndef DISABLE_PRDR
8039 if (!regex_PRDR) regex_PRDR =
8040 regex_must_compile(US"\\n250[\\s\\-]PRDR(\\s|\\n|$)", FALSE, TRUE);
8043 #ifdef EXPERIMENTAL_INTERNATIONAL
8044 if (!regex_UTF8) regex_UTF8 =
8045 regex_must_compile(US"\\n250[\\s\\-]SMTPUTF8(\\s|\\n|$)", FALSE, TRUE);
8048 if (!regex_DSN) regex_DSN =
8049 regex_must_compile(US"\\n250[\\s\\-]DSN(\\s|\\n|$)", FALSE, TRUE);
8051 if (!regex_IGNOREQUOTA) regex_IGNOREQUOTA =
8052 regex_must_compile(US"\\n250[\\s\\-]IGNOREQUOTA(\\s|\\n|$)", FALSE, TRUE);
8057 deliver_get_sender_address (uschar * id)
8060 uschar * new_sender_address,
8061 * save_sender_address;
8063 if (!spool_open_datafile(id))
8066 /* Save and restore the global sender_address. I'm not sure if we should
8067 not save/restore all the other global variables too, because
8068 spool_read_header() may change all of them. But OTOH, when this
8069 deliver_get_sender_address() gets called, the current message is done
8070 already and nobody needs the globals anymore. (HS12, 2015-08-21) */
8072 sprintf(CS spoolname, "%s-H", id);
8073 save_sender_address = sender_address;
8075 rc = spool_read_header(spoolname, TRUE, TRUE);
8077 new_sender_address = sender_address;
8078 sender_address = save_sender_address;
8080 if (rc != spool_read_OK)
8083 assert(new_sender_address);
8085 (void)close(deliver_datafile);
8086 deliver_datafile = -1;
8088 return new_sender_address;
8093 /* End of deliver.c */