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 != NULL) **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 == NULL)
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. */
171 if (addr->next == NULL)
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 != NULL;
180 addr_orig = addr_orig->parent);
181 deliver_domain_orig = addr_orig->domain;
183 /* Re-instate any prefix and suffix in the original local part. In all
184 normal cases, the address will have a router associated with it, and we can
185 choose the caseful or caseless version accordingly. However, when a system
186 filter sets up a pipe, file, or autoreply delivery, no router is involved.
187 In this case, though, there won't be any prefix or suffix to worry about. */
189 deliver_localpart_orig = (addr_orig->router == NULL)? addr_orig->local_part :
190 addr_orig->router->caseful_local_part?
191 addr_orig->cc_local_part : addr_orig->lc_local_part;
193 /* If there's a parent, make its domain and local part available, and if
194 delivering to a pipe or file, or sending an autoreply, get the local
195 part from the parent. For pipes and files, put the pipe or file string
196 into address_pipe and address_file. */
198 if (addr->parent != NULL)
200 deliver_domain_parent = addr->parent->domain;
201 deliver_localpart_parent = (addr->parent->router == NULL)?
202 addr->parent->local_part :
203 addr->parent->router->caseful_local_part?
204 addr->parent->cc_local_part : addr->parent->lc_local_part;
206 /* File deliveries have their own flag because they need to be picked out
207 as special more often. */
209 if (testflag(addr, af_pfr))
211 if (testflag(addr, af_file)) address_file = addr->local_part;
212 else if (deliver_localpart[0] == '|') address_pipe = addr->local_part;
213 deliver_localpart = addr->parent->local_part;
214 deliver_localpart_prefix = addr->parent->prefix;
215 deliver_localpart_suffix = addr->parent->suffix;
219 #ifdef EXPERIMENTAL_BRIGHTMAIL
220 /* Set expansion variables related to Brightmail AntiSpam */
221 bmi_base64_verdict = bmi_get_base64_verdict(deliver_localpart_orig, deliver_domain_orig);
222 bmi_base64_tracker_verdict = bmi_get_base64_tracker_verdict(bmi_base64_verdict);
223 /* get message delivery status (0 - don't deliver | 1 - deliver) */
224 bmi_deliver = bmi_get_delivery_status(bmi_base64_verdict);
225 /* if message is to be delivered, get eventual alternate location */
226 if (bmi_deliver == 1) {
227 bmi_alt_location = bmi_get_alt_location(bmi_base64_verdict);
233 /* For multiple addresses, don't set local part, and leave the domain and
234 self_hostname set only if it is the same for all of them. It is possible to
235 have multiple pipe and file addresses, but only when all addresses have routed
236 to the same pipe or file. */
241 if (testflag(addr, af_pfr))
243 if (testflag(addr, af_file)) address_file = addr->local_part;
244 else if (addr->local_part[0] == '|') address_pipe = addr->local_part;
246 for (addr2 = addr->next; addr2 != NULL; addr2 = addr2->next)
248 if (deliver_domain != NULL &&
249 Ustrcmp(deliver_domain, addr2->domain) != 0)
250 deliver_domain = NULL;
251 if (self_hostname != NULL && (addr2->self_hostname == NULL ||
252 Ustrcmp(self_hostname, addr2->self_hostname) != 0))
253 self_hostname = NULL;
254 if (deliver_domain == NULL && self_hostname == NULL) break;
262 /*************************************************
263 * Open a msglog file *
264 *************************************************/
266 /* This function is used both for normal message logs, and for files in the
267 msglog directory that are used to catch output from pipes. Try to create the
268 directory if it does not exist. From release 4.21, normal message logs should
269 be created when the message is received.
272 filename the file name
273 mode the mode required
274 error used for saying what failed
276 Returns: a file descriptor, or -1 (with errno set)
280 open_msglog_file(uschar *filename, int mode, uschar **error)
282 int fd = Uopen(filename, O_WRONLY|O_APPEND|O_CREAT, mode);
284 if (fd < 0 && errno == ENOENT)
287 sprintf(CS temp, "msglog/%s", message_subdir);
288 if (message_subdir[0] == 0) temp[6] = 0;
289 (void)directory_make(spool_directory, temp, MSGLOG_DIRECTORY_MODE, TRUE);
290 fd = Uopen(filename, O_WRONLY|O_APPEND|O_CREAT, mode);
293 /* Set the close-on-exec flag and change the owner to the exim uid/gid (this
294 function is called as root). Double check the mode, because the group setting
295 doesn't always get set automatically. */
299 (void)fcntl(fd, F_SETFD, fcntl(fd, F_GETFD) | FD_CLOEXEC);
300 if (fchown(fd, exim_uid, exim_gid) < 0)
305 if (fchmod(fd, mode) < 0)
311 else *error = US"create";
319 /*************************************************
320 * Write to msglog if required *
321 *************************************************/
323 /* Write to the message log, if configured. This function may also be called
327 format a string format
333 deliver_msglog(const char *format, ...)
336 if (!message_logs) return;
337 va_start(ap, format);
338 vfprintf(message_log, format, ap);
346 /*************************************************
347 * Replicate status for batch *
348 *************************************************/
350 /* When a transport handles a batch of addresses, it may treat them
351 individually, or it may just put the status in the first one, and return FALSE,
352 requesting that the status be copied to all the others externally. This is the
353 replication function. As well as the status, it copies the transport pointer,
354 which may have changed if appendfile passed the addresses on to a different
357 Argument: pointer to the first address in a chain
362 replicate_status(address_item *addr)
365 for (addr2 = addr->next; addr2 != NULL; addr2 = addr2->next)
367 addr2->transport = addr->transport;
368 addr2->transport_return = addr->transport_return;
369 addr2->basic_errno = addr->basic_errno;
370 addr2->more_errno = addr->more_errno;
371 addr2->special_action = addr->special_action;
372 addr2->message = addr->message;
373 addr2->user_message = addr->user_message;
379 /*************************************************
380 * Compare lists of hosts *
381 *************************************************/
383 /* This function is given two pointers to chains of host items, and it yields
384 TRUE if the lists refer to the same hosts in the same order, except that
386 (1) Multiple hosts with the same non-negative MX values are permitted to appear
387 in different orders. Round-robinning nameservers can cause this to happen.
389 (2) Multiple hosts with the same negative MX values less than MX_NONE are also
390 permitted to appear in different orders. This is caused by randomizing
393 This enables Exim to use a single SMTP transaction for sending to two entirely
394 different domains that happen to end up pointing at the same hosts.
397 one points to the first host list
398 two points to the second host list
400 Returns: TRUE if the lists refer to the same host set
404 same_hosts(host_item *one, host_item *two)
406 while (one != NULL && two != NULL)
408 if (Ustrcmp(one->name, two->name) != 0)
411 host_item *end_one = one;
412 host_item *end_two = two;
414 /* Batch up only if there was no MX and the list was not randomized */
416 if (mx == MX_NONE) return FALSE;
418 /* Find the ends of the shortest sequence of identical MX values */
420 while (end_one->next != NULL && end_one->next->mx == mx &&
421 end_two->next != NULL && end_two->next->mx == mx)
423 end_one = end_one->next;
424 end_two = end_two->next;
427 /* If there aren't any duplicates, there's no match. */
429 if (end_one == one) return FALSE;
431 /* For each host in the 'one' sequence, check that it appears in the 'two'
432 sequence, returning FALSE if not. */
437 for (hi = two; hi != end_two->next; hi = hi->next)
438 if (Ustrcmp(one->name, hi->name) == 0) break;
439 if (hi == end_two->next) return FALSE;
440 if (one == end_one) break;
444 /* All the hosts in the 'one' sequence were found in the 'two' sequence.
445 Ensure both are pointing at the last host, and carry on as for equality. */
456 /* True if both are NULL */
463 /*************************************************
464 * Compare header lines *
465 *************************************************/
467 /* This function is given two pointers to chains of header items, and it yields
468 TRUE if they are the same header texts in the same order.
471 one points to the first header list
472 two points to the second header list
474 Returns: TRUE if the lists refer to the same header set
478 same_headers(header_line *one, header_line *two)
482 if (one == two) return TRUE; /* Includes the case where both NULL */
483 if (one == NULL || two == NULL) return FALSE;
484 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 == NULL || two == NULL) 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 == NULL && !tp->deliver_as_creator)
537 if (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 == NULL)
546 if (testflag(addr1, af_gid_set) != testflag(addr2, af_gid_set) ||
547 (testflag(addr1, af_gid_set) && 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 */
602 if (addr->parent == NULL)
604 tree_add_nonrecipient(addr->unique);
605 tree_add_nonrecipient(addr->address);
608 /* Homonymous child address */
610 else if (testflag(addr, af_homonym))
612 if (addr->transport != NULL)
614 tree_add_nonrecipient(
615 string_sprintf("%s/%s", addr->unique + 3, addr->transport->name));
619 /* Non-homonymous child address */
621 else tree_add_nonrecipient(addr->unique);
623 /* Check the list of duplicate addresses and ensure they are now marked
626 for (dup = addr_duplicate; dup != NULL; dup = dup->next)
628 if (Ustrcmp(addr->unique, dup->unique) == 0)
630 tree_add_nonrecipient(dup->unique);
631 child_done(dup, now);
639 /*************************************************
640 * Decrease counts in parents and mark done *
641 *************************************************/
643 /* This function is called when an address is complete. If there is a parent
644 address, its count of children is decremented. If there are still other
645 children outstanding, the function exits. Otherwise, if the count has become
646 zero, address_done() is called to mark the parent and its duplicates complete.
647 Then loop for any earlier ancestors.
650 addr points to the completed address item
651 now the current time as a string, for writing to the message log
657 child_done(address_item *addr, uschar *now)
660 while (addr->parent != NULL)
663 if ((addr->child_count -= 1) > 0) return; /* Incomplete parent */
664 address_done(addr, now);
666 /* Log the completion of all descendents only when there is no ancestor with
667 the same original address. */
669 for (aa = addr->parent; aa != NULL; aa = aa->parent)
670 if (Ustrcmp(aa->address, addr->address) == 0) break;
671 if (aa != NULL) continue;
673 deliver_msglog("%s %s: children all complete\n", now, addr->address);
674 DEBUG(D_deliver) debug_printf("%s: children all complete\n", addr->address);
680 /*************************************************
681 * Delivery logging support functions *
682 *************************************************/
684 /* The LOGGING() checks in d_log_interface() are complicated for backwards
685 compatibility. When outgoing interface logging was originally added, it was
686 conditional on just incoming_interface (which is off by default). The
687 outgoing_interface option is on by default to preserve this behaviour, but
688 you can enable incoming_interface and disable outgoing_interface to get I=
689 fields on incoming lines only.
692 s The log line buffer
693 sizep Pointer to the buffer size
694 ptrp Pointer to current index into buffer
695 addr The address to be logged
697 Returns: New value for s
701 d_log_interface(uschar *s, int *sizep, int *ptrp)
703 if (LOGGING(incoming_interface) && LOGGING(outgoing_interface)
704 && sending_ip_address != NULL)
706 s = string_append(s, sizep, ptrp, 2, US" I=[", sending_ip_address);
707 if (LOGGING(outgoing_port))
708 s = string_append(s, sizep, ptrp, 2, US"]:",
709 string_sprintf("%d", sending_port));
711 s = string_cat(s, sizep, ptrp, "]", 1);
719 d_hostlog(uschar *s, int *sizep, int *ptrp, address_item *addr)
721 s = string_append(s, sizep, ptrp, 5, US" H=", addr->host_used->name,
722 US" [", addr->host_used->address, US"]");
723 if (LOGGING(outgoing_port))
724 s = string_append(s, sizep, ptrp, 2, US":", string_sprintf("%d",
725 addr->host_used->port));
726 return d_log_interface(s, sizep, ptrp);
733 d_tlslog(uschar * s, int * sizep, int * ptrp, address_item * addr)
735 if (LOGGING(tls_cipher) && addr->cipher != NULL)
736 s = string_append(s, sizep, ptrp, 2, US" X=", addr->cipher);
737 if (LOGGING(tls_certificate_verified) && addr->cipher != NULL)
738 s = string_append(s, sizep, ptrp, 2, US" CV=",
739 testflag(addr, af_cert_verified)
741 #ifdef EXPERIMENTAL_DANE
742 testflag(addr, af_dane_verified)
748 if (LOGGING(tls_peerdn) && addr->peerdn != NULL)
749 s = string_append(s, sizep, ptrp, 3, US" DN=\"",
750 string_printing(addr->peerdn), US"\"");
758 #ifdef EXPERIMENTAL_EVENT
760 event_raise(uschar * action, const uschar * event, uschar * ev_data)
766 debug_printf("Event(%s): event_action=|%s| delivery_IP=%s\n",
768 action, deliver_host_address);
771 event_data = ev_data;
773 if (!(s = expand_string(action)) && *expand_string_message)
774 log_write(0, LOG_MAIN|LOG_PANIC,
775 "failed to expand event_action %s in %s: %s\n",
776 event, transport_name, expand_string_message);
778 event_name = event_data = NULL;
780 /* If the expansion returns anything but an empty string, flag for
781 the caller to modify his normal processing
786 debug_printf("Event(%s): event_action returned \"%s\"\n", event, s);
794 msg_event_raise(const uschar * event, const address_item * addr)
796 const uschar * save_domain = deliver_domain;
797 uschar * save_local = deliver_localpart;
798 const uschar * save_host = deliver_host;
800 if (!addr->transport)
803 router_name = addr->router ? addr->router->name : NULL;
804 transport_name = addr->transport->name;
805 deliver_domain = addr->domain;
806 deliver_localpart = addr->local_part;
807 deliver_host = addr->host_used ? addr->host_used->name : NULL;
809 (void) event_raise(addr->transport->event_action, event,
810 addr->host_used || Ustrcmp(addr->transport->driver_name, "lmtp") == 0
811 ? addr->message : NULL);
813 deliver_host = save_host;
814 deliver_localpart = save_local;
815 deliver_domain = save_domain;
816 router_name = transport_name = NULL;
818 #endif /*EXPERIMENTAL_EVENT*/
822 /* If msg is NULL this is a delivery log and logchar is used. Otherwise
823 this is a nonstandard call; no two-character delivery flag is written
824 but sender-host and sender are prefixed and "msg" is inserted in the log line.
827 flags passed to log_write()
830 delivery_log(int flags, address_item * addr, int logchar, uschar * msg)
833 int size = 256; /* Used for a temporary, */
834 int ptr = 0; /* expanding buffer, for */
835 uschar *s; /* building log lines; */
836 void *reset_point; /* released afterwards. */
838 /* Log the delivery on the main log. We use an extensible string to build up
839 the log line, and reset the store afterwards. Remote deliveries should always
840 have a pointer to the host item that succeeded; local deliveries can have a
841 pointer to a single host item in their host list, for use by the transport. */
843 #ifdef EXPERIMENTAL_EVENT
844 /* presume no successful remote delivery */
845 lookup_dnssec_authenticated = NULL;
848 s = reset_point = store_get(size);
850 log_address = string_log_address(addr, LOGGING(all_parents), TRUE);
852 s = string_append(s, &size, &ptr, 3, host_and_ident(TRUE), US" ", log_address);
856 s = string_append(s, &size, &ptr, 2, US"> ", log_address);
859 if (LOGGING(sender_on_delivery) || msg)
860 s = string_append(s, &size, &ptr, 3, US" F=<",
861 #ifdef EXPERIMENTAL_INTERNATIONAL
862 testflag(addr, af_utf8_downcvt)
863 ? string_address_utf8_to_alabel(sender_address, NULL)
869 #ifdef EXPERIMENTAL_SRS
870 if(addr->prop.srs_sender)
871 s = string_append(s, &size, &ptr, 3, US" SRS=<", addr->prop.srs_sender, US">");
874 /* You might think that the return path must always be set for a successful
875 delivery; indeed, I did for some time, until this statement crashed. The case
876 when it is not set is for a delivery to /dev/null which is optimised by not
879 if (used_return_path != NULL && LOGGING(return_path_on_delivery))
880 s = string_append(s, &size, &ptr, 3, US" P=<", used_return_path, US">");
883 s = string_append(s, &size, &ptr, 2, US" ", msg);
885 /* For a delivery from a system filter, there may not be a router */
886 if (addr->router != NULL)
887 s = string_append(s, &size, &ptr, 2, US" R=", addr->router->name);
889 s = string_append(s, &size, &ptr, 2, US" T=", addr->transport->name);
891 if (LOGGING(delivery_size))
892 s = string_append(s, &size, &ptr, 2, US" S=",
893 string_sprintf("%d", transport_count));
897 if (addr->transport->info->local)
900 s = string_append(s, &size, &ptr, 2, US" H=", addr->host_list->name);
901 s = d_log_interface(s, &size, &ptr);
902 if (addr->shadow_message != NULL)
903 s = string_cat(s, &size, &ptr, addr->shadow_message,
904 Ustrlen(addr->shadow_message));
907 /* Remote delivery */
913 s = d_hostlog(s, &size, &ptr, addr);
914 if (continue_sequence > 1)
915 s = string_cat(s, &size, &ptr, US"*", 1);
917 #ifdef EXPERIMENTAL_EVENT
918 deliver_host_address = addr->host_used->address;
919 deliver_host_port = addr->host_used->port;
920 deliver_host = addr->host_used->name;
922 /* DNS lookup status */
923 lookup_dnssec_authenticated = addr->host_used->dnssec==DS_YES ? US"yes"
924 : addr->host_used->dnssec==DS_NO ? US"no"
930 s = d_tlslog(s, &size, &ptr, addr);
933 if (addr->authenticator)
935 s = string_append(s, &size, &ptr, 2, US" A=", addr->authenticator);
938 s = string_append(s, &size, &ptr, 2, US":", addr->auth_id);
939 if (LOGGING(smtp_mailauth) && addr->auth_sndr)
940 s = string_append(s, &size, &ptr, 2, US":", addr->auth_sndr);
945 if (addr->flags & af_prdr_used)
946 s = string_append(s, &size, &ptr, 1, US" PRDR");
950 /* confirmation message (SMTP (host_used) and LMTP (driver_name)) */
952 if (LOGGING(smtp_confirmation) && addr->message &&
953 (addr->host_used || Ustrcmp(addr->transport->driver_name, "lmtp") == 0))
956 unsigned lim = big_buffer_size < 1024 ? big_buffer_size : 1024;
957 uschar *p = big_buffer;
958 uschar *ss = addr->message;
960 for (i = 0; i < lim && ss[i] != 0; i++) /* limit logged amount */
962 if (ss[i] == '\"' || ss[i] == '\\') *p++ = '\\'; /* quote \ and " */
967 s = string_append(s, &size, &ptr, 2, US" C=", big_buffer);
970 /* Time on queue and actual time taken to deliver */
972 if (LOGGING(queue_time))
973 s = string_append(s, &size, &ptr, 2, US" QT=",
974 readconf_printtime( (int) ((long)time(NULL) - (long)received_time)) );
976 if (LOGGING(deliver_time))
977 s = string_append(s, &size, &ptr, 2, US" DT=",
978 readconf_printtime(addr->more_errno));
980 /* string_cat() always leaves room for the terminator. Release the
981 store we used to build the line after writing it. */
984 log_write(0, flags, "%s", s);
986 #ifdef EXPERIMENTAL_EVENT
987 if (!msg) msg_event_raise(US"msg:delivery", addr);
990 store_reset(reset_point);
996 /*************************************************
997 * Actions at the end of handling an address *
998 *************************************************/
1000 /* This is a function for processing a single address when all that can be done
1001 with it has been done.
1004 addr points to the address block
1005 result the result of the delivery attempt
1006 logflags flags for log_write() (LOG_MAIN and/or LOG_PANIC)
1007 driver_type indicates which type of driver (transport, or router) was last
1008 to process the address
1009 logchar '=' or '-' for use when logging deliveries with => or ->
1015 post_process_one(address_item *addr, int result, int logflags, int driver_type,
1018 uschar *now = tod_stamp(tod_log);
1019 uschar *driver_kind = NULL;
1020 uschar *driver_name = NULL;
1021 uschar *log_address;
1023 int size = 256; /* Used for a temporary, */
1024 int ptr = 0; /* expanding buffer, for */
1025 uschar *s; /* building log lines; */
1026 void *reset_point; /* released afterwards. */
1028 DEBUG(D_deliver) debug_printf("post-process %s (%d)\n", addr->address, result);
1030 /* Set up driver kind and name for logging. Disable logging if the router or
1031 transport has disabled it. */
1033 if (driver_type == DTYPE_TRANSPORT)
1035 if (addr->transport != NULL)
1037 driver_name = addr->transport->name;
1038 driver_kind = US" transport";
1039 disable_logging = addr->transport->disable_logging;
1041 else driver_kind = US"transporting";
1043 else if (driver_type == DTYPE_ROUTER)
1045 if (addr->router != NULL)
1047 driver_name = addr->router->name;
1048 driver_kind = US" router";
1049 disable_logging = addr->router->disable_logging;
1051 else driver_kind = US"routing";
1054 /* If there's an error message set, ensure that it contains only printing
1055 characters - it should, but occasionally things slip in and this at least
1056 stops the log format from getting wrecked. We also scan the message for an LDAP
1057 expansion item that has a password setting, and flatten the password. This is a
1058 fudge, but I don't know a cleaner way of doing this. (If the item is badly
1059 malformed, it won't ever have gone near LDAP.) */
1061 if (addr->message != NULL)
1063 const uschar * s = string_printing(addr->message);
1064 if (s != addr->message)
1065 addr->message = US s;
1066 /* deconst cast ok as string_printing known to have alloc'n'copied */
1067 if (((Ustrstr(addr->message, "failed to expand") != NULL) || (Ustrstr(addr->message, "expansion of ") != NULL)) &&
1068 (Ustrstr(addr->message, "mysql") != NULL ||
1069 Ustrstr(addr->message, "pgsql") != NULL ||
1070 #ifdef EXPERIMENTAL_REDIS
1071 Ustrstr(addr->message, "redis") != NULL ||
1073 Ustrstr(addr->message, "sqlite") != NULL ||
1074 Ustrstr(addr->message, "ldap:") != NULL ||
1075 Ustrstr(addr->message, "ldapdn:") != NULL ||
1076 Ustrstr(addr->message, "ldapm:") != NULL))
1078 addr->message = string_sprintf("Temporary internal error");
1082 /* If we used a transport that has one of the "return_output" options set, and
1083 if it did in fact generate some output, then for return_output we treat the
1084 message as failed if it was not already set that way, so that the output gets
1085 returned to the sender, provided there is a sender to send it to. For
1086 return_fail_output, do this only if the delivery failed. Otherwise we just
1087 unlink the file, and remove the name so that if the delivery failed, we don't
1088 try to send back an empty or unwanted file. The log_output options operate only
1089 on a non-empty file.
1091 In any case, we close the message file, because we cannot afford to leave a
1092 file-descriptor for one address while processing (maybe very many) others. */
1094 if (addr->return_file >= 0 && addr->return_filename != NULL)
1096 BOOL return_output = FALSE;
1097 struct stat statbuf;
1098 (void)EXIMfsync(addr->return_file);
1100 /* If there is no output, do nothing. */
1102 if (fstat(addr->return_file, &statbuf) == 0 && statbuf.st_size > 0)
1104 transport_instance *tb = addr->transport;
1106 /* Handle logging options */
1108 if (tb->log_output || (result == FAIL && tb->log_fail_output) ||
1109 (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,
1119 s = US Ufgets(big_buffer, big_buffer_size, f);
1122 uschar *p = big_buffer + Ustrlen(big_buffer);
1124 while (p > big_buffer && isspace(p[-1])) p--;
1126 sp = string_printing(big_buffer);
1127 log_write(0, LOG_MAIN, "<%s>: %s transport output: %s",
1128 addr->address, tb->name, sp);
1134 /* Handle returning options, but only if there is an address to return
1137 if (sender_address[0] != 0 || addr->prop.errors_address != NULL)
1139 if (tb->return_output)
1141 addr->transport_return = result = FAIL;
1142 if (addr->basic_errno == 0 && addr->message == NULL)
1143 addr->message = US"return message generated";
1144 return_output = TRUE;
1147 if (tb->return_fail_output && result == FAIL) return_output = TRUE;
1151 /* Get rid of the file unless it might be returned, but close it in
1156 Uunlink(addr->return_filename);
1157 addr->return_filename = NULL;
1158 addr->return_file = -1;
1161 (void)close(addr->return_file);
1164 /* The success case happens only after delivery by a transport. */
1168 addr->next = addr_succeed;
1169 addr_succeed = addr;
1171 /* Call address_done() to ensure that we don't deliver to this address again,
1172 and write appropriate things to the message log. If it is a child address, we
1173 call child_done() to scan the ancestors and mark them complete if this is the
1174 last child to complete. */
1176 address_done(addr, now);
1177 DEBUG(D_deliver) debug_printf("%s delivered\n", addr->address);
1179 if (addr->parent == NULL)
1180 deliver_msglog("%s %s: %s%s succeeded\n", now, addr->address,
1181 driver_name, driver_kind);
1184 deliver_msglog("%s %s <%s>: %s%s succeeded\n", now, addr->address,
1185 addr->parent->address, driver_name, driver_kind);
1186 child_done(addr, now);
1189 /* Certificates for logging (via events) */
1191 tls_out.ourcert = addr->ourcert;
1192 addr->ourcert = NULL;
1193 tls_out.peercert = addr->peercert;
1194 addr->peercert = NULL;
1196 tls_out.cipher = addr->cipher;
1197 tls_out.peerdn = addr->peerdn;
1198 tls_out.ocsp = addr->ocsp;
1199 # ifdef EXPERIMENTAL_DANE
1200 tls_out.dane_verified = testflag(addr, af_dane_verified);
1204 delivery_log(LOG_MAIN, addr, logchar, NULL);
1207 tls_free_cert(&tls_out.ourcert);
1208 tls_free_cert(&tls_out.peercert);
1209 tls_out.cipher = NULL;
1210 tls_out.peerdn = NULL;
1211 tls_out.ocsp = OCSP_NOT_REQ;
1212 # ifdef EXPERIMENTAL_DANE
1213 tls_out.dane_verified = FALSE;
1219 /* Soft failure, or local delivery process failed; freezing may be
1222 else if (result == DEFER || result == PANIC)
1224 if (result == PANIC) logflags |= LOG_PANIC;
1226 /* This puts them on the chain in reverse order. Do not change this, because
1227 the code for handling retries assumes that the one with the retry
1228 information is last. */
1230 addr->next = addr_defer;
1233 /* The only currently implemented special action is to freeze the
1234 message. Logging of this is done later, just before the -H file is
1237 if (addr->special_action == SPECIAL_FREEZE)
1239 deliver_freeze = TRUE;
1240 deliver_frozen_at = time(NULL);
1241 update_spool = TRUE;
1244 /* If doing a 2-stage queue run, we skip writing to either the message
1245 log or the main log for SMTP defers. */
1247 if (!queue_2stage || addr->basic_errno != 0)
1251 /* For errors of the type "retry time not reached" (also remotes skipped
1252 on queue run), logging is controlled by L_retry_defer. Note that this kind
1253 of error number is negative, and all the retry ones are less than any
1256 unsigned int use_log_selector = (addr->basic_errno <= ERRNO_RETRY_BASE)?
1259 /* Build up the line that is used for both the message log and the main
1262 s = reset_point = store_get(size);
1264 /* Create the address string for logging. Must not do this earlier, because
1265 an OK result may be changed to FAIL when a pipe returns text. */
1267 log_address = string_log_address(addr, LOGGING(all_parents), result == OK);
1269 s = string_cat(s, &size, &ptr, log_address, Ustrlen(log_address));
1271 /* Either driver_name contains something and driver_kind contains
1272 " router" or " transport" (note the leading space), or driver_name is
1273 a null string and driver_kind contains "routing" without the leading
1274 space, if all routing has been deferred. When a domain has been held,
1275 so nothing has been done at all, both variables contain null strings. */
1277 if (driver_name == NULL)
1279 if (driver_kind != NULL)
1280 s = string_append(s, &size, &ptr, 2, US" ", driver_kind);
1284 if (driver_kind[1] == 't' && addr->router != NULL)
1285 s = string_append(s, &size, &ptr, 2, US" R=", addr->router->name);
1287 ss[1] = toupper(driver_kind[1]);
1288 s = string_append(s, &size, &ptr, 2, ss, driver_name);
1291 sprintf(CS ss, " defer (%d)", addr->basic_errno);
1292 s = string_cat(s, &size, &ptr, ss, Ustrlen(ss));
1294 if (addr->basic_errno > 0)
1295 s = string_append(s, &size, &ptr, 2, US": ",
1296 US strerror(addr->basic_errno));
1298 if (addr->host_used)
1299 s = string_append(s, &size, &ptr, 5,
1300 US" H=", addr->host_used->name,
1301 US" [", addr->host_used->address, US"]");
1303 if (addr->message != NULL)
1304 s = string_append(s, &size, &ptr, 2, US": ", addr->message);
1308 /* Log the deferment in the message log, but don't clutter it
1309 up with retry-time defers after the first delivery attempt. */
1311 if (deliver_firsttime || addr->basic_errno > ERRNO_RETRY_BASE)
1312 deliver_msglog("%s %s\n", now, s);
1314 /* Write the main log and reset the store */
1316 log_write(use_log_selector, logflags, "== %s", s);
1317 store_reset(reset_point);
1322 /* Hard failure. If there is an address to which an error message can be sent,
1323 put this address on the failed list. If not, put it on the deferred list and
1324 freeze the mail message for human attention. The latter action can also be
1325 explicitly requested by a router or transport. */
1329 /* If this is a delivery error, or a message for which no replies are
1330 wanted, and the message's age is greater than ignore_bounce_errors_after,
1331 force the af_ignore_error flag. This will cause the address to be discarded
1332 later (with a log entry). */
1334 if (sender_address[0] == 0 && message_age >= ignore_bounce_errors_after)
1335 setflag(addr, af_ignore_error);
1337 /* Freeze the message if requested, or if this is a bounce message (or other
1338 message with null sender) and this address does not have its own errors
1339 address. However, don't freeze if errors are being ignored. The actual code
1340 to ignore occurs later, instead of sending a message. Logging of freezing
1341 occurs later, just before writing the -H file. */
1343 if (!testflag(addr, af_ignore_error) &&
1344 (addr->special_action == SPECIAL_FREEZE ||
1345 (sender_address[0] == 0 && addr->prop.errors_address == NULL)
1348 frozen_info = (addr->special_action == SPECIAL_FREEZE)? US"" :
1349 (sender_local && !local_error_message)?
1350 US" (message created with -f <>)" : US" (delivery error message)";
1351 deliver_freeze = TRUE;
1352 deliver_frozen_at = time(NULL);
1353 update_spool = TRUE;
1355 /* The address is put on the defer rather than the failed queue, because
1356 the message is being retained. */
1358 addr->next = addr_defer;
1362 /* Don't put the address on the nonrecipients tree yet; wait until an
1363 error message has been successfully sent. */
1367 addr->next = addr_failed;
1371 /* Build up the log line for the message and main logs */
1373 s = reset_point = store_get(size);
1375 /* Create the address string for logging. Must not do this earlier, because
1376 an OK result may be changed to FAIL when a pipe returns text. */
1378 log_address = string_log_address(addr, LOGGING(all_parents), result == OK);
1380 s = string_cat(s, &size, &ptr, log_address, Ustrlen(log_address));
1382 if (LOGGING(sender_on_delivery))
1383 s = string_append(s, &size, &ptr, 3, US" F=<", sender_address, US">");
1385 /* Return path may not be set if no delivery actually happened */
1387 if (used_return_path != NULL && LOGGING(return_path_on_delivery))
1388 s = string_append(s, &size, &ptr, 3, US" P=<", used_return_path, US">");
1390 if (addr->router != NULL)
1391 s = string_append(s, &size, &ptr, 2, US" R=", addr->router->name);
1392 if (addr->transport != NULL)
1393 s = string_append(s, &size, &ptr, 2, US" T=", addr->transport->name);
1395 if (addr->host_used != NULL)
1396 s = d_hostlog(s, &size, &ptr, addr);
1399 s = d_tlslog(s, &size, &ptr, addr);
1402 if (addr->basic_errno > 0)
1403 s = string_append(s, &size, &ptr, 2, US": ",
1404 US strerror(addr->basic_errno));
1406 if (addr->message != NULL)
1407 s = string_append(s, &size, &ptr, 2, US": ", addr->message);
1411 /* Do the logging. For the message log, "routing failed" for those cases,
1412 just to make it clearer. */
1414 if (driver_name == NULL)
1415 deliver_msglog("%s %s failed for %s\n", now, driver_kind, s);
1417 deliver_msglog("%s %s\n", now, s);
1419 log_write(0, LOG_MAIN, "** %s", s);
1421 #ifdef EXPERIMENTAL_EVENT
1422 msg_event_raise(US"msg:fail:delivery", addr);
1425 store_reset(reset_point);
1428 /* Ensure logging is turned on again in all cases */
1430 disable_logging = FALSE;
1436 /*************************************************
1437 * Address-independent error *
1438 *************************************************/
1440 /* This function is called when there's an error that is not dependent on a
1441 particular address, such as an expansion string failure. It puts the error into
1442 all the addresses in a batch, logs the incident on the main and panic logs, and
1443 clears the expansions. It is mostly called from local_deliver(), but can be
1444 called for a remote delivery via findugid().
1447 logit TRUE if (MAIN+PANIC) logging required
1448 addr the first of the chain of addresses
1450 format format string for error message, or NULL if already set in addr
1451 ... arguments for the format
1457 common_error(BOOL logit, address_item *addr, int code, uschar *format, ...)
1459 address_item *addr2;
1460 addr->basic_errno = code;
1466 va_start(ap, format);
1467 if (!string_vformat(buffer, sizeof(buffer), CS format, ap))
1468 log_write(0, LOG_MAIN|LOG_PANIC_DIE,
1469 "common_error expansion was longer than " SIZE_T_FMT, sizeof(buffer));
1471 addr->message = string_copy(buffer);
1474 for (addr2 = addr->next; addr2 != NULL; addr2 = addr2->next)
1476 addr2->basic_errno = code;
1477 addr2->message = addr->message;
1480 if (logit) log_write(0, LOG_MAIN|LOG_PANIC, "%s", addr->message);
1481 deliver_set_expansions(NULL);
1487 /*************************************************
1488 * Check a "never users" list *
1489 *************************************************/
1491 /* This function is called to check whether a uid is on one of the two "never
1495 uid the uid to be checked
1496 nusers the list to be scanned; the first item in the list is the count
1498 Returns: TRUE if the uid is on the list
1502 check_never_users(uid_t uid, uid_t *nusers)
1505 if (nusers == NULL) return FALSE;
1506 for (i = 1; i <= (int)(nusers[0]); i++) if (nusers[i] == uid) return TRUE;
1512 /*************************************************
1513 * Find uid and gid for a transport *
1514 *************************************************/
1516 /* This function is called for both local and remote deliveries, to find the
1517 uid/gid under which to run the delivery. The values are taken preferentially
1518 from the transport (either explicit or deliver_as_creator), then from the
1519 address (i.e. the router), and if nothing is set, the exim uid/gid are used. If
1520 the resulting uid is on the "never_users" or the "fixed_never_users" list, a
1521 panic error is logged, and the function fails (which normally leads to delivery
1525 addr the address (possibly a chain)
1527 uidp pointer to uid field
1528 gidp pointer to gid field
1529 igfp pointer to the use_initgroups field
1531 Returns: FALSE if failed - error has been set in address(es)
1535 findugid(address_item *addr, transport_instance *tp, uid_t *uidp, gid_t *gidp,
1538 uschar *nuname = NULL;
1539 BOOL gid_set = FALSE;
1541 /* Default initgroups flag comes from the transport */
1543 *igfp = tp->initgroups;
1545 /* First see if there's a gid on the transport, either fixed or expandable.
1546 The expanding function always logs failure itself. */
1553 else if (tp->expand_gid != NULL)
1555 if (route_find_expanded_group(tp->expand_gid, tp->name, US"transport", gidp,
1556 &(addr->message))) gid_set = TRUE;
1559 common_error(FALSE, addr, ERRNO_GIDFAIL, NULL);
1564 /* If the transport did not set a group, see if the router did. */
1566 if (!gid_set && testflag(addr, af_gid_set))
1572 /* Pick up a uid from the transport if one is set. */
1574 if (tp->uid_set) *uidp = tp->uid;
1576 /* Otherwise, try for an expandable uid field. If it ends up as a numeric id,
1577 it does not provide a passwd value from which a gid can be taken. */
1579 else if (tp->expand_uid != NULL)
1582 if (!route_find_expanded_user(tp->expand_uid, tp->name, US"transport", &pw,
1583 uidp, &(addr->message)))
1585 common_error(FALSE, addr, ERRNO_UIDFAIL, NULL);
1588 if (!gid_set && pw != NULL)
1595 /* If the transport doesn't set the uid, test the deliver_as_creator flag. */
1597 else if (tp->deliver_as_creator)
1599 *uidp = originator_uid;
1602 *gidp = originator_gid;
1607 /* Otherwise see if the address specifies the uid and if so, take it and its
1610 else if (testflag(addr, af_uid_set))
1613 *igfp = testflag(addr, af_initgroups);
1616 /* Nothing has specified the uid - default to the Exim user, and group if the
1629 /* If no gid is set, it is a disaster. We default to the Exim gid only if
1630 defaulting to the Exim uid. In other words, if the configuration has specified
1631 a uid, it must also provide a gid. */
1635 common_error(TRUE, addr, ERRNO_GIDFAIL, US"User set without group for "
1636 "%s transport", tp->name);
1640 /* Check that the uid is not on the lists of banned uids that may not be used
1641 for delivery processes. */
1643 if (check_never_users(*uidp, never_users))
1644 nuname = US"never_users";
1645 else if (check_never_users(*uidp, fixed_never_users))
1646 nuname = US"fixed_never_users";
1650 common_error(TRUE, addr, ERRNO_UIDFAIL, US"User %ld set for %s transport "
1651 "is on the %s list", (long int)(*uidp), tp->name, nuname);
1663 /*************************************************
1664 * Check the size of a message for a transport *
1665 *************************************************/
1667 /* Checks that the message isn't too big for the selected transport.
1668 This is called only when it is known that the limit is set.
1672 addr the (first) address being delivered
1675 DEFER expansion failed or did not yield an integer
1676 FAIL message too big
1680 check_message_size(transport_instance *tp, address_item *addr)
1685 deliver_set_expansions(addr);
1686 size_limit = expand_string_integer(tp->message_size_limit, TRUE);
1687 deliver_set_expansions(NULL);
1689 if (expand_string_message != NULL)
1692 if (size_limit == -1)
1693 addr->message = string_sprintf("failed to expand message_size_limit "
1694 "in %s transport: %s", tp->name, expand_string_message);
1696 addr->message = string_sprintf("invalid message_size_limit "
1697 "in %s transport: %s", tp->name, expand_string_message);
1699 else if (size_limit > 0 && message_size > size_limit)
1703 string_sprintf("message is too big (transport limit = %d)",
1712 /*************************************************
1713 * Transport-time check for a previous delivery *
1714 *************************************************/
1716 /* Check that this base address hasn't previously been delivered to its routed
1717 transport. If it has been delivered, mark it done. The check is necessary at
1718 delivery time in order to handle homonymic addresses correctly in cases where
1719 the pattern of redirection changes between delivery attempts (so the unique
1720 fields change). Non-homonymic previous delivery is detected earlier, at routing
1721 time (which saves unnecessary routing).
1724 addr the address item
1725 testing TRUE if testing wanted only, without side effects
1727 Returns: TRUE if previously delivered by the transport
1731 previously_transported(address_item *addr, BOOL testing)
1733 (void)string_format(big_buffer, big_buffer_size, "%s/%s",
1734 addr->unique + (testflag(addr, af_homonym)? 3:0), addr->transport->name);
1736 if (tree_search(tree_nonrecipients, big_buffer) != 0)
1738 DEBUG(D_deliver|D_route|D_transport)
1739 debug_printf("%s was previously delivered (%s transport): discarded\n",
1740 addr->address, addr->transport->name);
1741 if (!testing) child_done(addr, tod_stamp(tod_log));
1750 /******************************************************
1751 * Check for a given header in a header string *
1752 ******************************************************/
1754 /* This function is used when generating quota warnings. The configuration may
1755 specify any header lines it likes in quota_warn_message. If certain of them are
1756 missing, defaults are inserted, so we need to be able to test for the presence
1760 hdr the required header name
1761 hstring the header string
1763 Returns: TRUE the header is in the string
1764 FALSE the header is not in the string
1768 contains_header(uschar *hdr, uschar *hstring)
1770 int len = Ustrlen(hdr);
1771 uschar *p = hstring;
1774 if (strncmpic(p, hdr, len) == 0)
1777 while (*p == ' ' || *p == '\t') p++;
1778 if (*p == ':') return TRUE;
1780 while (*p != 0 && *p != '\n') p++;
1781 if (*p == '\n') p++;
1789 /*************************************************
1790 * Perform a local delivery *
1791 *************************************************/
1793 /* Each local delivery is performed in a separate process which sets its
1794 uid and gid as specified. This is a safer way than simply changing and
1795 restoring using seteuid(); there is a body of opinion that seteuid() cannot be
1796 used safely. From release 4, Exim no longer makes any use of it. Besides, not
1797 all systems have seteuid().
1799 If the uid/gid are specified in the transport_instance, they are used; the
1800 transport initialization must ensure that either both or neither are set.
1801 Otherwise, the values associated with the address are used. If neither are set,
1802 it is a configuration error.
1804 The transport or the address may specify a home directory (transport over-
1805 rides), and if they do, this is set as $home. If neither have set a working
1806 directory, this value is used for that as well. Otherwise $home is left unset
1807 and the cwd is set to "/" - a directory that should be accessible to all users.
1809 Using a separate process makes it more complicated to get error information
1810 back. We use a pipe to pass the return code and also an error code and error
1811 text string back to the parent process.
1814 addr points to an address block for this delivery; for "normal" local
1815 deliveries this is the only address to be delivered, but for
1816 pseudo-remote deliveries (e.g. by batch SMTP to a file or pipe)
1817 a number of addresses can be handled simultaneously, and in this
1818 case addr will point to a chain of addresses with the same
1821 shadowing TRUE if running a shadow transport; this causes output from pipes
1828 deliver_local(address_item *addr, BOOL shadowing)
1830 BOOL use_initgroups;
1833 int status, len, rc;
1836 uschar *working_directory;
1837 address_item *addr2;
1838 transport_instance *tp = addr->transport;
1840 /* Set up the return path from the errors or sender address. If the transport
1841 has its own return path setting, expand it and replace the existing value. */
1843 if(addr->prop.errors_address != NULL)
1844 return_path = addr->prop.errors_address;
1845 #ifdef EXPERIMENTAL_SRS
1846 else if(addr->prop.srs_sender != NULL)
1847 return_path = addr->prop.srs_sender;
1850 return_path = sender_address;
1852 if (tp->return_path != NULL)
1854 uschar *new_return_path = expand_string(tp->return_path);
1855 if (new_return_path == NULL)
1857 if (!expand_string_forcedfail)
1859 common_error(TRUE, addr, ERRNO_EXPANDFAIL,
1860 US"Failed to expand return path \"%s\" in %s transport: %s",
1861 tp->return_path, tp->name, expand_string_message);
1865 else return_path = new_return_path;
1868 /* For local deliveries, one at a time, the value used for logging can just be
1869 set directly, once and for all. */
1871 used_return_path = return_path;
1873 /* Sort out the uid, gid, and initgroups flag. If an error occurs, the message
1874 gets put into the address(es), and the expansions are unset, so we can just
1877 if (!findugid(addr, tp, &uid, &gid, &use_initgroups)) return;
1879 /* See if either the transport or the address specifies a home directory. A
1880 home directory set in the address may already be expanded; a flag is set to
1881 indicate that. In other cases we must expand it. */
1883 if ((deliver_home = tp->home_dir) != NULL || /* Set in transport, or */
1884 ((deliver_home = addr->home_dir) != NULL && /* Set in address and */
1885 !testflag(addr, af_home_expanded))) /* not expanded */
1887 uschar *rawhome = deliver_home;
1888 deliver_home = NULL; /* in case it contains $home */
1889 deliver_home = expand_string(rawhome);
1890 if (deliver_home == NULL)
1892 common_error(TRUE, addr, ERRNO_EXPANDFAIL, US"home directory \"%s\" failed "
1893 "to expand for %s transport: %s", rawhome, tp->name,
1894 expand_string_message);
1897 if (*deliver_home != '/')
1899 common_error(TRUE, addr, ERRNO_NOTABSOLUTE, US"home directory path \"%s\" "
1900 "is not absolute for %s transport", deliver_home, tp->name);
1905 /* See if either the transport or the address specifies a current directory,
1906 and if so, expand it. If nothing is set, use the home directory, unless it is
1907 also unset in which case use "/", which is assumed to be a directory to which
1908 all users have access. It is necessary to be in a visible directory for some
1909 operating systems when running pipes, as some commands (e.g. "rm" under Solaris
1910 2.5) require this. */
1912 working_directory = (tp->current_dir != NULL)?
1913 tp->current_dir : addr->current_dir;
1915 if (working_directory != NULL)
1917 uschar *raw = working_directory;
1918 working_directory = expand_string(raw);
1919 if (working_directory == NULL)
1921 common_error(TRUE, addr, ERRNO_EXPANDFAIL, US"current directory \"%s\" "
1922 "failed to expand for %s transport: %s", raw, tp->name,
1923 expand_string_message);
1926 if (*working_directory != '/')
1928 common_error(TRUE, addr, ERRNO_NOTABSOLUTE, US"current directory path "
1929 "\"%s\" is not absolute for %s transport", working_directory, tp->name);
1933 else working_directory = (deliver_home == NULL)? US"/" : deliver_home;
1935 /* If one of the return_output flags is set on the transport, create and open a
1936 file in the message log directory for the transport to write its output onto.
1937 This is mainly used by pipe transports. The file needs to be unique to the
1938 address. This feature is not available for shadow transports. */
1940 if (!shadowing && (tp->return_output || tp->return_fail_output ||
1941 tp->log_output || tp->log_fail_output))
1944 addr->return_filename =
1945 string_sprintf("%s/msglog/%s/%s-%d-%d", spool_directory, message_subdir,
1946 message_id, getpid(), return_count++);
1947 addr->return_file = open_msglog_file(addr->return_filename, 0400, &error);
1948 if (addr->return_file < 0)
1950 common_error(TRUE, addr, errno, US"Unable to %s file for %s transport "
1951 "to return message: %s", error, tp->name, strerror(errno));
1956 /* Create the pipe for inter-process communication. */
1960 common_error(TRUE, addr, ERRNO_PIPEFAIL, US"Creation of pipe failed: %s",
1965 /* Now fork the process to do the real work in the subprocess, but first
1966 ensure that all cached resources are freed so that the subprocess starts with
1967 a clean slate and doesn't interfere with the parent process. */
1971 if ((pid = fork()) == 0)
1973 BOOL replicate = TRUE;
1975 /* Prevent core dumps, as we don't want them in users' home directories.
1976 HP-UX doesn't have RLIMIT_CORE; I don't know how to do this in that
1977 system. Some experimental/developing systems (e.g. GNU/Hurd) may define
1978 RLIMIT_CORE but not support it in setrlimit(). For such systems, do not
1979 complain if the error is "not supported".
1981 There are two scenarios where changing the max limit has an effect. In one,
1982 the user is using a .forward and invoking a command of their choice via pipe;
1983 for these, we do need the max limit to be 0 unless the admin chooses to
1984 permit an increased limit. In the other, the command is invoked directly by
1985 the transport and is under administrator control, thus being able to raise
1986 the limit aids in debugging. So there's no general always-right answer.
1988 Thus we inhibit core-dumps completely but let individual transports, while
1989 still root, re-raise the limits back up to aid debugging. We make the
1990 default be no core-dumps -- few enough people can use core dumps in
1991 diagnosis that it's reasonable to make them something that has to be explicitly requested.
1998 if (setrlimit(RLIMIT_CORE, &rl) < 0)
2000 # ifdef SETRLIMIT_NOT_SUPPORTED
2001 if (errno != ENOSYS && errno != ENOTSUP)
2003 log_write(0, LOG_MAIN|LOG_PANIC, "setrlimit(RLIMIT_CORE) failed: %s",
2008 /* Reset the random number generator, so different processes don't all
2009 have the same sequence. */
2013 /* If the transport has a setup entry, call this first, while still
2014 privileged. (Appendfile uses this to expand quota, for example, while
2015 able to read private files.) */
2017 if (addr->transport->setup != NULL)
2019 switch((addr->transport->setup)(addr->transport, addr, NULL, uid, gid,
2023 addr->transport_return = DEFER;
2027 addr->transport_return = PANIC;
2032 /* Ignore SIGINT and SIGTERM during delivery. Also ignore SIGUSR1, as
2033 when the process becomes unprivileged, it won't be able to write to the
2034 process log. SIGHUP is ignored throughout exim, except when it is being
2037 signal(SIGINT, SIG_IGN);
2038 signal(SIGTERM, SIG_IGN);
2039 signal(SIGUSR1, SIG_IGN);
2041 /* Close the unwanted half of the pipe, and set close-on-exec for the other
2042 half - for transports that exec things (e.g. pipe). Then set the required
2045 (void)close(pfd[pipe_read]);
2046 (void)fcntl(pfd[pipe_write], F_SETFD, fcntl(pfd[pipe_write], F_GETFD) |
2048 exim_setugid(uid, gid, use_initgroups,
2049 string_sprintf("local delivery to %s <%s> transport=%s", addr->local_part,
2050 addr->address, addr->transport->name));
2054 address_item *batched;
2055 debug_printf(" home=%s current=%s\n", deliver_home, working_directory);
2056 for (batched = addr->next; batched != NULL; batched = batched->next)
2057 debug_printf("additional batched address: %s\n", batched->address);
2060 /* Set an appropriate working directory. */
2062 if (Uchdir(working_directory) < 0)
2064 addr->transport_return = DEFER;
2065 addr->basic_errno = errno;
2066 addr->message = string_sprintf("failed to chdir to %s", working_directory);
2069 /* If successful, call the transport */
2074 set_process_info("delivering %s to %s using %s", message_id,
2075 addr->local_part, addr->transport->name);
2077 /* Setting this global in the subprocess means we need never clear it */
2078 transport_name = addr->transport->name;
2080 /* If a transport filter has been specified, set up its argument list.
2081 Any errors will get put into the address, and FALSE yielded. */
2083 if (addr->transport->filter_command != NULL)
2085 ok = transport_set_up_command(&transport_filter_argv,
2086 addr->transport->filter_command,
2087 TRUE, PANIC, addr, US"transport filter", NULL);
2088 transport_filter_timeout = addr->transport->filter_timeout;
2090 else transport_filter_argv = NULL;
2094 debug_print_string(addr->transport->debug_string);
2095 replicate = !(addr->transport->info->code)(addr->transport, addr);
2099 /* Pass the results back down the pipe. If necessary, first replicate the
2100 status in the top address to the others in the batch. The label is the
2101 subject of a goto when a call to the transport's setup function fails. We
2102 pass the pointer to the transport back in case it got changed as a result of
2103 file_format in appendfile. */
2107 if (replicate) replicate_status(addr);
2108 for (addr2 = addr; addr2 != NULL; addr2 = addr2->next)
2111 int local_part_length = Ustrlen(addr2->local_part);
2115 if( (ret = write(pfd[pipe_write], (void *)&(addr2->transport_return), sizeof(int))) != sizeof(int)
2116 || (ret = write(pfd[pipe_write], (void *)&transport_count, sizeof(transport_count))) != sizeof(transport_count)
2117 || (ret = write(pfd[pipe_write], (void *)&(addr2->flags), sizeof(addr2->flags))) != sizeof(addr2->flags)
2118 || (ret = write(pfd[pipe_write], (void *)&(addr2->basic_errno), sizeof(int))) != sizeof(int)
2119 || (ret = write(pfd[pipe_write], (void *)&(addr2->more_errno), sizeof(int))) != sizeof(int)
2120 || (ret = write(pfd[pipe_write], (void *)&(addr2->special_action), sizeof(int))) != sizeof(int)
2121 || (ret = write(pfd[pipe_write], (void *)&(addr2->transport),
2122 sizeof(transport_instance *))) != sizeof(transport_instance *)
2124 /* For a file delivery, pass back the local part, in case the original
2125 was only part of the final delivery path. This gives more complete
2128 || (testflag(addr2, af_file)
2129 && ( (ret = write(pfd[pipe_write], (void *)&local_part_length, sizeof(int))) != sizeof(int)
2130 || (ret = write(pfd[pipe_write], addr2->local_part, local_part_length)) != local_part_length
2134 log_write(0, LOG_MAIN|LOG_PANIC, "Failed writing transport results to pipe: %s\n",
2135 ret == -1 ? strerror(errno) : "short write");
2137 /* Now any messages */
2139 for (i = 0, s = addr2->message; i < 2; i++, s = addr2->user_message)
2141 int message_length = (s == NULL)? 0 : Ustrlen(s) + 1;
2142 if( (ret = write(pfd[pipe_write], (void *)&message_length, sizeof(int))) != sizeof(int)
2143 || (message_length > 0 && (ret = write(pfd[pipe_write], s, message_length)) != message_length)
2145 log_write(0, LOG_MAIN|LOG_PANIC, "Failed writing transport results to pipe: %s\n",
2146 ret == -1 ? strerror(errno) : "short write");
2150 /* OK, this process is now done. Free any cached resources that it opened,
2151 and close the pipe we were writing down before exiting. */
2153 (void)close(pfd[pipe_write]);
2158 /* Back in the main process: panic if the fork did not succeed. This seems
2159 better than returning an error - if forking is failing it is probably best
2160 not to try other deliveries for this message. */
2163 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Fork failed for local delivery to %s",
2166 /* Read the pipe to get the delivery status codes and error messages. Our copy
2167 of the writing end must be closed first, as otherwise read() won't return zero
2168 on an empty pipe. We check that a status exists for each address before
2169 overwriting the address structure. If data is missing, the default DEFER status
2170 will remain. Afterwards, close the reading end. */
2172 (void)close(pfd[pipe_write]);
2174 for (addr2 = addr; addr2 != NULL; addr2 = addr2->next)
2176 len = read(pfd[pipe_read], (void *)&status, sizeof(int));
2182 addr2->transport_return = status;
2183 len = read(pfd[pipe_read], (void *)&transport_count,
2184 sizeof(transport_count));
2185 len = read(pfd[pipe_read], (void *)&(addr2->flags), sizeof(addr2->flags));
2186 len = read(pfd[pipe_read], (void *)&(addr2->basic_errno), sizeof(int));
2187 len = read(pfd[pipe_read], (void *)&(addr2->more_errno), sizeof(int));
2188 len = read(pfd[pipe_read], (void *)&(addr2->special_action), sizeof(int));
2189 len = read(pfd[pipe_read], (void *)&(addr2->transport),
2190 sizeof(transport_instance *));
2192 if (testflag(addr2, af_file))
2194 int local_part_length;
2195 len = read(pfd[pipe_read], (void *)&local_part_length, sizeof(int));
2196 len = read(pfd[pipe_read], (void *)big_buffer, local_part_length);
2197 big_buffer[local_part_length] = 0;
2198 addr2->local_part = string_copy(big_buffer);
2201 for (i = 0, sptr = &(addr2->message); i < 2;
2202 i++, sptr = &(addr2->user_message))
2205 len = read(pfd[pipe_read], (void *)&message_length, sizeof(int));
2206 if (message_length > 0)
2208 len = read(pfd[pipe_read], (void *)big_buffer, message_length);
2209 if (len > 0) *sptr = string_copy(big_buffer);
2216 log_write(0, LOG_MAIN|LOG_PANIC, "failed to read delivery status for %s "
2217 "from delivery subprocess", addr2->unique);
2222 (void)close(pfd[pipe_read]);
2224 /* Unless shadowing, write all successful addresses immediately to the journal
2225 file, to ensure they are recorded asap. For homonymic addresses, use the base
2226 address plus the transport name. Failure to write the journal is panic-worthy,
2227 but don't stop, as it may prove possible subsequently to update the spool file
2228 in order to record the delivery. */
2232 for (addr2 = addr; addr2 != NULL; addr2 = addr2->next)
2234 if (addr2->transport_return != OK) continue;
2236 if (testflag(addr2, af_homonym))
2237 sprintf(CS big_buffer, "%.500s/%s\n", addr2->unique + 3, tp->name);
2239 sprintf(CS big_buffer, "%.500s\n", addr2->unique);
2241 /* In the test harness, wait just a bit to let the subprocess finish off
2242 any debug output etc first. */
2244 if (running_in_test_harness) millisleep(300);
2246 DEBUG(D_deliver) debug_printf("journalling %s", big_buffer);
2247 len = Ustrlen(big_buffer);
2248 if (write(journal_fd, big_buffer, len) != len)
2249 log_write(0, LOG_MAIN|LOG_PANIC, "failed to update journal for %s: %s",
2250 big_buffer, strerror(errno));
2253 /* Ensure the journal file is pushed out to disk. */
2255 if (EXIMfsync(journal_fd) < 0)
2256 log_write(0, LOG_MAIN|LOG_PANIC, "failed to fsync journal: %s",
2260 /* Wait for the process to finish. If it terminates with a non-zero code,
2261 freeze the message (except for SIGTERM, SIGKILL and SIGQUIT), but leave the
2262 status values of all the addresses as they are. Take care to handle the case
2263 when the subprocess doesn't seem to exist. This has been seen on one system
2264 when Exim was called from an MUA that set SIGCHLD to SIG_IGN. When that
2265 happens, wait() doesn't recognize the termination of child processes. Exim now
2266 resets SIGCHLD to SIG_DFL, but this code should still be robust. */
2268 while ((rc = wait(&status)) != pid)
2270 if (rc < 0 && errno == ECHILD) /* Process has vanished */
2272 log_write(0, LOG_MAIN, "%s transport process vanished unexpectedly",
2273 addr->transport->driver_name);
2279 if ((status & 0xffff) != 0)
2281 int msb = (status >> 8) & 255;
2282 int lsb = status & 255;
2283 int code = (msb == 0)? (lsb & 0x7f) : msb;
2284 if (msb != 0 || (code != SIGTERM && code != SIGKILL && code != SIGQUIT))
2285 addr->special_action = SPECIAL_FREEZE;
2286 log_write(0, LOG_MAIN|LOG_PANIC, "%s transport process returned non-zero "
2287 "status 0x%04x: %s %d",
2288 addr->transport->driver_name,
2290 (msb == 0)? "terminated by signal" : "exit code",
2294 /* If SPECIAL_WARN is set in the top address, send a warning message. */
2296 if (addr->special_action == SPECIAL_WARN &&
2297 addr->transport->warn_message != NULL)
2300 uschar *warn_message;
2302 DEBUG(D_deliver) debug_printf("Warning message requested by transport\n");
2304 warn_message = expand_string(addr->transport->warn_message);
2305 if (warn_message == NULL)
2306 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand \"%s\" (warning "
2307 "message for %s transport): %s", addr->transport->warn_message,
2308 addr->transport->name, expand_string_message);
2311 pid_t pid = child_open_exim(&fd);
2314 FILE *f = fdopen(fd, "wb");
2315 if (errors_reply_to != NULL &&
2316 !contains_header(US"Reply-To", warn_message))
2317 fprintf(f, "Reply-To: %s\n", errors_reply_to);
2318 fprintf(f, "Auto-Submitted: auto-replied\n");
2319 if (!contains_header(US"From", warn_message)) moan_write_from(f);
2320 fprintf(f, "%s", CS warn_message);
2322 /* Close and wait for child process to complete, without a timeout. */
2325 (void)child_close(pid, 0);
2329 addr->special_action = SPECIAL_NONE;
2335 /*************************************************
2336 * Do local deliveries *
2337 *************************************************/
2339 /* This function processes the list of addresses in addr_local. True local
2340 deliveries are always done one address at a time. However, local deliveries can
2341 be batched up in some cases. Typically this is when writing batched SMTP output
2342 files for use by some external transport mechanism, or when running local
2343 deliveries over LMTP.
2350 do_local_deliveries(void)
2353 open_db *dbm_file = NULL;
2354 time_t now = time(NULL);
2356 /* Loop until we have exhausted the supply of local deliveries */
2358 while (addr_local != NULL)
2360 time_t delivery_start;
2362 address_item *addr2, *addr3, *nextaddr;
2363 int logflags = LOG_MAIN;
2364 int logchar = dont_deliver? '*' : '=';
2365 transport_instance *tp;
2367 /* Pick the first undelivered address off the chain */
2369 address_item *addr = addr_local;
2370 addr_local = addr->next;
2373 DEBUG(D_deliver|D_transport)
2374 debug_printf("--------> %s <--------\n", addr->address);
2376 /* An internal disaster if there is no transport. Should not occur! */
2378 if ((tp = addr->transport) == NULL)
2380 logflags |= LOG_PANIC;
2381 disable_logging = FALSE; /* Jic */
2383 (addr->router != NULL)?
2384 string_sprintf("No transport set by %s router", addr->router->name)
2386 string_sprintf("No transport set by system filter");
2387 post_process_one(addr, DEFER, logflags, DTYPE_TRANSPORT, 0);
2391 /* Check that this base address hasn't previously been delivered to this
2392 transport. The check is necessary at this point to handle homonymic addresses
2393 correctly in cases where the pattern of redirection changes between delivery
2394 attempts. Non-homonymic previous delivery is detected earlier, at routing
2397 if (previously_transported(addr, FALSE)) continue;
2399 /* There are weird cases where logging is disabled */
2401 disable_logging = tp->disable_logging;
2403 /* Check for batched addresses and possible amalgamation. Skip all the work
2404 if either batch_max <= 1 or there aren't any other addresses for local
2407 if (tp->batch_max > 1 && addr_local != NULL)
2409 int batch_count = 1;
2410 BOOL uses_dom = readconf_depends((driver_instance *)tp, US"domain");
2411 BOOL uses_lp = (testflag(addr, af_pfr) &&
2412 (testflag(addr, af_file) || addr->local_part[0] == '|')) ||
2413 readconf_depends((driver_instance *)tp, US"local_part");
2414 uschar *batch_id = NULL;
2415 address_item **anchor = &addr_local;
2416 address_item *last = addr;
2419 /* Expand the batch_id string for comparison with other addresses.
2420 Expansion failure suppresses batching. */
2422 if (tp->batch_id != NULL)
2424 deliver_set_expansions(addr);
2425 batch_id = expand_string(tp->batch_id);
2426 deliver_set_expansions(NULL);
2427 if (batch_id == NULL)
2429 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand batch_id option "
2430 "in %s transport (%s): %s", tp->name, addr->address,
2431 expand_string_message);
2432 batch_count = tp->batch_max;
2436 /* Until we reach the batch_max limit, pick off addresses which have the
2437 same characteristics. These are:
2440 not previously delivered (see comment about 50 lines above)
2441 same local part if the transport's configuration contains $local_part
2442 or if this is a file or pipe delivery from a redirection
2443 same domain if the transport's configuration contains $domain
2445 same additional headers
2446 same headers to be removed
2447 same uid/gid for running the transport
2448 same first host if a host list is set
2451 while ((next = *anchor) != NULL && batch_count < tp->batch_max)
2454 tp == next->transport &&
2455 !previously_transported(next, TRUE) &&
2456 (addr->flags & (af_pfr|af_file)) == (next->flags & (af_pfr|af_file)) &&
2457 (!uses_lp || Ustrcmp(next->local_part, addr->local_part) == 0) &&
2458 (!uses_dom || Ustrcmp(next->domain, addr->domain) == 0) &&
2459 same_strings(next->prop.errors_address, addr->prop.errors_address) &&
2460 same_headers(next->prop.extra_headers, addr->prop.extra_headers) &&
2461 same_strings(next->prop.remove_headers, addr->prop.remove_headers) &&
2462 same_ugid(tp, addr, next) &&
2463 ((addr->host_list == NULL && next->host_list == NULL) ||
2464 (addr->host_list != NULL && next->host_list != NULL &&
2465 Ustrcmp(addr->host_list->name, next->host_list->name) == 0));
2467 /* If the transport has a batch_id setting, batch_id will be non-NULL
2468 from the expansion outside the loop. Expand for this address and compare.
2469 Expansion failure makes this address ineligible for batching. */
2471 if (ok && batch_id != NULL)
2474 address_item *save_nextnext = next->next;
2475 next->next = NULL; /* Expansion for a single address */
2476 deliver_set_expansions(next);
2477 next->next = save_nextnext;
2478 bid = expand_string(tp->batch_id);
2479 deliver_set_expansions(NULL);
2482 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand batch_id option "
2483 "in %s transport (%s): %s", tp->name, next->address,
2484 expand_string_message);
2487 else ok = (Ustrcmp(batch_id, bid) == 0);
2490 /* Take address into batch if OK. */
2494 *anchor = next->next; /* Include the address */
2500 else anchor = &(next->next); /* Skip the address */
2504 /* We now have one or more addresses that can be delivered in a batch. Check
2505 whether the transport is prepared to accept a message of this size. If not,
2506 fail them all forthwith. If the expansion fails, or does not yield an
2507 integer, defer delivery. */
2509 if (tp->message_size_limit != NULL)
2511 int rc = check_message_size(tp, addr);
2514 replicate_status(addr);
2515 while (addr != NULL)
2518 post_process_one(addr, rc, logflags, DTYPE_TRANSPORT, 0);
2521 continue; /* With next batch of addresses */
2525 /* If we are not running the queue, or if forcing, all deliveries will be
2526 attempted. Otherwise, we must respect the retry times for each address. Even
2527 when not doing this, we need to set up the retry key string, and determine
2528 whether a retry record exists, because after a successful delivery, a delete
2529 retry item must be set up. Keep the retry database open only for the duration
2530 of these checks, rather than for all local deliveries, because some local
2531 deliveries (e.g. to pipes) can take a substantial time. */
2533 dbm_file = dbfn_open(US"retry", O_RDONLY, &dbblock, FALSE);
2534 if (dbm_file == NULL)
2536 DEBUG(D_deliver|D_retry|D_hints_lookup)
2537 debug_printf("no retry data available\n");
2542 while (addr2 != NULL)
2544 BOOL ok = TRUE; /* to deliver this address */
2547 /* Set up the retry key to include the domain or not, and change its
2548 leading character from "R" to "T". Must make a copy before doing this,
2549 because the old key may be pointed to from a "delete" retry item after
2552 retry_key = string_copy(
2553 (tp->retry_use_local_part)? addr2->address_retry_key :
2554 addr2->domain_retry_key);
2557 /* Inspect the retry data. If there is no hints file, delivery happens. */
2559 if (dbm_file != NULL)
2561 dbdata_retry *retry_record = dbfn_read(dbm_file, retry_key);
2563 /* If there is no retry record, delivery happens. If there is,
2564 remember it exists so it can be deleted after a successful delivery. */
2566 if (retry_record != NULL)
2568 setflag(addr2, af_lt_retry_exists);
2570 /* A retry record exists for this address. If queue running and not
2571 forcing, inspect its contents. If the record is too old, or if its
2572 retry time has come, or if it has passed its cutoff time, delivery
2577 debug_printf("retry record exists: age=%s ",
2578 readconf_printtime(now - retry_record->time_stamp));
2579 debug_printf("(max %s)\n", readconf_printtime(retry_data_expire));
2580 debug_printf(" time to retry = %s expired = %d\n",
2581 readconf_printtime(retry_record->next_try - now),
2582 retry_record->expired);
2585 if (queue_running && !deliver_force)
2587 ok = (now - retry_record->time_stamp > retry_data_expire) ||
2588 (now >= retry_record->next_try) ||
2589 retry_record->expired;
2591 /* If we haven't reached the retry time, there is one more check
2592 to do, which is for the ultimate address timeout. */
2595 ok = retry_ultimate_address_timeout(retry_key, addr2->domain,
2599 else DEBUG(D_retry) debug_printf("no retry record exists\n");
2602 /* This address is to be delivered. Leave it on the chain. */
2607 addr2 = addr2->next;
2610 /* This address is to be deferred. Take it out of the chain, and
2611 post-process it as complete. Must take it out of the chain first,
2612 because post processing puts it on another chain. */
2616 address_item *this = addr2;
2617 this->message = US"Retry time not yet reached";
2618 this->basic_errno = ERRNO_LRETRY;
2619 if (addr3 == NULL) addr2 = addr = addr2->next;
2620 else addr2 = addr3->next = addr2->next;
2621 post_process_one(this, DEFER, logflags, DTYPE_TRANSPORT, 0);
2625 if (dbm_file != NULL) dbfn_close(dbm_file);
2627 /* If there are no addresses left on the chain, they all deferred. Loop
2628 for the next set of addresses. */
2630 if (addr == NULL) continue;
2632 /* So, finally, we do have some addresses that can be passed to the
2633 transport. Before doing so, set up variables that are relevant to a
2636 deliver_set_expansions(addr);
2637 delivery_start = time(NULL);
2638 deliver_local(addr, FALSE);
2639 deliver_time = (int)(time(NULL) - delivery_start);
2641 /* If a shadow transport (which must perforce be another local transport), is
2642 defined, and its condition is met, we must pass the message to the shadow
2643 too, but only those addresses that succeeded. We do this by making a new
2644 chain of addresses - also to keep the original chain uncontaminated. We must
2645 use a chain rather than doing it one by one, because the shadow transport may
2648 NOTE: if the condition fails because of a lookup defer, there is nothing we
2651 if (tp->shadow != NULL &&
2652 (tp->shadow_condition == NULL ||
2653 expand_check_condition(tp->shadow_condition, tp->name, US"transport")))
2655 transport_instance *stp;
2656 address_item *shadow_addr = NULL;
2657 address_item **last = &shadow_addr;
2659 for (stp = transports; stp != NULL; stp = stp->next)
2660 if (Ustrcmp(stp->name, tp->shadow) == 0) break;
2663 log_write(0, LOG_MAIN|LOG_PANIC, "shadow transport \"%s\" not found ",
2666 /* Pick off the addresses that have succeeded, and make clones. Put into
2667 the shadow_message field a pointer to the shadow_message field of the real
2670 else for (addr2 = addr; addr2 != NULL; addr2 = addr2->next)
2672 if (addr2->transport_return != OK) continue;
2673 addr3 = store_get(sizeof(address_item));
2676 addr3->shadow_message = (uschar *)(&(addr2->shadow_message));
2677 addr3->transport = stp;
2678 addr3->transport_return = DEFER;
2679 addr3->return_filename = NULL;
2680 addr3->return_file = -1;
2682 last = &(addr3->next);
2685 /* If we found any addresses to shadow, run the delivery, and stick any
2686 message back into the shadow_message field in the original. */
2688 if (shadow_addr != NULL)
2690 int save_count = transport_count;
2692 DEBUG(D_deliver|D_transport)
2693 debug_printf(">>>>>>>>>>>>>>>> Shadow delivery >>>>>>>>>>>>>>>>\n");
2694 deliver_local(shadow_addr, TRUE);
2696 for(; shadow_addr != NULL; shadow_addr = shadow_addr->next)
2698 int sresult = shadow_addr->transport_return;
2699 *((uschar **)(shadow_addr->shadow_message)) = (sresult == OK)?
2700 string_sprintf(" ST=%s", stp->name) :
2701 string_sprintf(" ST=%s (%s%s%s)", stp->name,
2702 (shadow_addr->basic_errno <= 0)?
2703 US"" : US strerror(shadow_addr->basic_errno),
2704 (shadow_addr->basic_errno <= 0 || shadow_addr->message == NULL)?
2706 (shadow_addr->message != NULL)? shadow_addr->message :
2707 (shadow_addr->basic_errno <= 0)? US"unknown error" : US"");
2709 DEBUG(D_deliver|D_transport)
2710 debug_printf("%s shadow transport returned %s for %s\n",
2712 (sresult == OK)? "OK" :
2713 (sresult == DEFER)? "DEFER" :
2714 (sresult == FAIL)? "FAIL" :
2715 (sresult == PANIC)? "PANIC" : "?",
2716 shadow_addr->address);
2719 DEBUG(D_deliver|D_transport)
2720 debug_printf(">>>>>>>>>>>>>>>> End shadow delivery >>>>>>>>>>>>>>>>\n");
2722 transport_count = save_count; /* Restore original transport count */
2726 /* Cancel the expansions that were set up for the delivery. */
2728 deliver_set_expansions(NULL);
2730 /* Now we can process the results of the real transport. We must take each
2731 address off the chain first, because post_process_one() puts it on another
2734 for (addr2 = addr; addr2 != NULL; addr2 = nextaddr)
2736 int result = addr2->transport_return;
2737 nextaddr = addr2->next;
2739 DEBUG(D_deliver|D_transport)
2740 debug_printf("%s transport returned %s for %s\n",
2742 (result == OK)? "OK" :
2743 (result == DEFER)? "DEFER" :
2744 (result == FAIL)? "FAIL" :
2745 (result == PANIC)? "PANIC" : "?",
2748 /* If there is a retry_record, or if delivery is deferred, build a retry
2749 item for setting a new retry time or deleting the old retry record from
2750 the database. These items are handled all together after all addresses
2751 have been handled (so the database is open just for a short time for
2754 if (result == DEFER || testflag(addr2, af_lt_retry_exists))
2756 int flags = (result == DEFER)? 0 : rf_delete;
2757 uschar *retry_key = string_copy((tp->retry_use_local_part)?
2758 addr2->address_retry_key : addr2->domain_retry_key);
2760 retry_add_item(addr2, retry_key, flags);
2763 /* Done with this address */
2765 if (result == OK) addr2->more_errno = deliver_time;
2766 post_process_one(addr2, result, logflags, DTYPE_TRANSPORT, logchar);
2768 /* If a pipe delivery generated text to be sent back, the result may be
2769 changed to FAIL, and we must copy this for subsequent addresses in the
2772 if (addr2->transport_return != result)
2774 for (addr3 = nextaddr; addr3 != NULL; addr3 = addr3->next)
2776 addr3->transport_return = addr2->transport_return;
2777 addr3->basic_errno = addr2->basic_errno;
2778 addr3->message = addr2->message;
2780 result = addr2->transport_return;
2783 /* Whether or not the result was changed to FAIL, we need to copy the
2784 return_file value from the first address into all the addresses of the
2785 batch, so they are all listed in the error message. */
2787 addr2->return_file = addr->return_file;
2789 /* Change log character for recording successful deliveries. */
2791 if (result == OK) logchar = '-';
2793 } /* Loop back for next batch of addresses */
2799 /*************************************************
2800 * Sort remote deliveries *
2801 *************************************************/
2803 /* This function is called if remote_sort_domains is set. It arranges that the
2804 chain of addresses for remote deliveries is ordered according to the strings
2805 specified. Try to make this shuffling reasonably efficient by handling
2806 sequences of addresses rather than just single ones.
2813 sort_remote_deliveries(void)
2816 address_item **aptr = &addr_remote;
2817 const uschar *listptr = remote_sort_domains;
2821 while (*aptr != NULL &&
2822 (pattern = string_nextinlist(&listptr, &sep, patbuf, sizeof(patbuf)))
2825 address_item *moved = NULL;
2826 address_item **bptr = &moved;
2828 while (*aptr != NULL)
2830 address_item **next;
2831 deliver_domain = (*aptr)->domain; /* set $domain */
2832 if (match_isinlist(deliver_domain, (const uschar **)&pattern, UCHAR_MAX+1,
2833 &domainlist_anchor, NULL, MCL_DOMAIN, TRUE, NULL) == OK)
2835 aptr = &((*aptr)->next);
2839 next = &((*aptr)->next);
2840 while (*next != NULL &&
2841 (deliver_domain = (*next)->domain, /* Set $domain */
2842 match_isinlist(deliver_domain, (const uschar **)&pattern, UCHAR_MAX+1,
2843 &domainlist_anchor, NULL, MCL_DOMAIN, TRUE, NULL)) != OK)
2844 next = &((*next)->next);
2846 /* If the batch of non-matchers is at the end, add on any that were
2847 extracted further up the chain, and end this iteration. Otherwise,
2848 extract them from the chain and hang on the moved chain. */
2860 aptr = &((*aptr)->next);
2863 /* If the loop ended because the final address matched, *aptr will
2864 be NULL. Add on to the end any extracted non-matching addresses. If
2865 *aptr is not NULL, the loop ended via "break" when *next is null, that
2866 is, there was a string of non-matching addresses at the end. In this
2867 case the extracted addresses have already been added on the end. */
2869 if (*aptr == NULL) *aptr = moved;
2875 debug_printf("remote addresses after sorting:\n");
2876 for (addr = addr_remote; addr != NULL; addr = addr->next)
2877 debug_printf(" %s\n", addr->address);
2883 /*************************************************
2884 * Read from pipe for remote delivery subprocess *
2885 *************************************************/
2887 /* This function is called when the subprocess is complete, but can also be
2888 called before it is complete, in order to empty a pipe that is full (to prevent
2889 deadlock). It must therefore keep track of its progress in the parlist data
2892 We read the pipe to get the delivery status codes and a possible error message
2893 for each address, optionally preceded by unusability data for the hosts and
2894 also by optional retry data.
2896 Read in large chunks into the big buffer and then scan through, interpreting
2897 the data therein. In most cases, only a single read will be necessary. No
2898 individual item will ever be anywhere near 2500 bytes in length, so by ensuring
2899 that we read the next chunk when there is less than 2500 bytes left in the
2900 non-final chunk, we can assume each item is complete in the buffer before
2901 handling it. Each item is written using a single write(), which is atomic for
2902 small items (less than PIPE_BUF, which seems to be at least 512 in any Unix and
2903 often bigger) so even if we are reading while the subprocess is still going, we
2904 should never have only a partial item in the buffer.
2907 poffset the offset of the parlist item
2908 eop TRUE if the process has completed
2910 Returns: TRUE if the terminating 'Z' item has been read,
2911 or there has been a disaster (i.e. no more data needed);
2916 par_read_pipe(int poffset, BOOL eop)
2919 pardata *p = parlist + poffset;
2920 address_item *addrlist = p->addrlist;
2921 address_item *addr = p->addr;
2924 uschar *endptr = big_buffer;
2925 uschar *ptr = endptr;
2926 uschar *msg = p->msg;
2927 BOOL done = p->done;
2928 BOOL unfinished = TRUE;
2929 /* minimum size to read is header size including id, subid and length */
2930 int required = PIPE_HEADER_SIZE;
2932 /* Loop through all items, reading from the pipe when necessary. The pipe
2933 is set up to be non-blocking, but there are two different Unix mechanisms in
2934 use. Exim uses O_NONBLOCK if it is defined. This returns 0 for end of file,
2935 and EAGAIN for no more data. If O_NONBLOCK is not defined, Exim uses O_NDELAY,
2936 which returns 0 for both end of file and no more data. We distinguish the
2937 two cases by taking 0 as end of file only when we know the process has
2940 Each separate item is written to the pipe in a single write(), and as they are
2941 all short items, the writes will all be atomic and we should never find
2942 ourselves in the position of having read an incomplete item. "Short" in this
2943 case can mean up to about 1K in the case when there is a long error message
2944 associated with an address. */
2946 DEBUG(D_deliver) debug_printf("reading pipe for subprocess %d (%s)\n",
2947 (int)p->pid, eop? "ended" : "not ended");
2951 retry_item *r, **rp;
2952 int remaining = endptr - ptr;
2953 uschar header[PIPE_HEADER_SIZE + 1];
2957 /* Read (first time) or top up the chars in the buffer if necessary.
2958 There will be only one read if we get all the available data (i.e. don't
2959 fill the buffer completely). */
2961 if (remaining < required && unfinished)
2964 int available = big_buffer_size - remaining;
2966 if (remaining > 0) memmove(big_buffer, ptr, remaining);
2969 endptr = big_buffer + remaining;
2970 len = read(fd, endptr, available);
2972 DEBUG(D_deliver) debug_printf("read() yielded %d\n", len);
2974 /* If the result is EAGAIN and the process is not complete, just
2975 stop reading any more and process what we have already. */
2979 if (!eop && errno == EAGAIN) len = 0; else
2981 msg = string_sprintf("failed to read pipe from transport process "
2982 "%d for transport %s: %s", pid, addr->transport->driver_name,
2988 /* If the length is zero (eof or no-more-data), just process what we
2989 already have. Note that if the process is still running and we have
2990 read all the data in the pipe (but less that "available") then we
2991 won't read any more, as "unfinished" will get set FALSE. */
2995 unfinished = len == available;
2998 /* If we are at the end of the available data, exit the loop. */
2999 if (ptr >= endptr) break;
3001 /* copy and read header */
3002 memcpy(header, ptr, PIPE_HEADER_SIZE);
3003 header[PIPE_HEADER_SIZE] = '\0';
3006 required = Ustrtol(header + 2, &endc, 10) + PIPE_HEADER_SIZE; /* header + data */
3009 msg = string_sprintf("failed to read pipe from transport process "
3010 "%d for transport %s: error reading size from header", pid, addr->transport->driver_name);
3016 debug_printf("header read id:%c,subid:%c,size:%s,required:%d,remaining:%d,unfinished:%d\n",
3017 id, subid, header+2, required, remaining, unfinished);
3019 /* is there room for the dataset we want to read ? */
3020 if (required > big_buffer_size - PIPE_HEADER_SIZE)
3022 msg = string_sprintf("failed to read pipe from transport process "
3023 "%d for transport %s: big_buffer too small! required size=%d buffer size=%d", pid, addr->transport->driver_name,
3024 required, big_buffer_size - PIPE_HEADER_SIZE);
3029 /* we wrote all datasets with atomic write() calls
3030 remaining < required only happens if big_buffer was too small
3031 to get all available data from pipe. unfinished has to be true
3033 if (remaining < required)
3037 msg = string_sprintf("failed to read pipe from transport process "
3038 "%d for transport %s: required size=%d > remaining size=%d and unfinished=false",
3039 pid, addr->transport->driver_name, required, remaining);
3044 /* step behind the header */
3045 ptr += PIPE_HEADER_SIZE;
3047 /* Handle each possible type of item, assuming the complete item is
3048 available in store. */
3052 /* Host items exist only if any hosts were marked unusable. Match
3053 up by checking the IP address. */
3056 for (h = addrlist->host_list; h != NULL; h = h->next)
3058 if (h->address == NULL || Ustrcmp(h->address, ptr+2) != 0) continue;
3066 /* Retry items are sent in a preceding R item for each address. This is
3067 kept separate to keep each message short enough to guarantee it won't
3068 be split in the pipe. Hopefully, in the majority of cases, there won't in
3069 fact be any retry items at all.
3071 The complete set of retry items might include an item to delete a
3072 routing retry if there was a previous routing delay. However, routing
3073 retries are also used when a remote transport identifies an address error.
3074 In that case, there may also be an "add" item for the same key. Arrange
3075 that a "delete" item is dropped in favour of an "add" item. */
3078 if (addr == NULL) goto ADDR_MISMATCH;
3080 DEBUG(D_deliver|D_retry)
3081 debug_printf("reading retry information for %s from subprocess\n",
3084 /* Cut out any "delete" items on the list. */
3086 for (rp = &(addr->retries); (r = *rp) != NULL; rp = &(r->next))
3088 if (Ustrcmp(r->key, ptr+1) == 0) /* Found item with same key */
3090 if ((r->flags & rf_delete) == 0) break; /* It was not "delete" */
3091 *rp = r->next; /* Excise a delete item */
3092 DEBUG(D_deliver|D_retry)
3093 debug_printf(" existing delete item dropped\n");
3097 /* We want to add a delete item only if there is no non-delete item;
3098 however we still have to step ptr through the data. */
3100 if (r == NULL || (*ptr & rf_delete) == 0)
3102 r = store_get(sizeof(retry_item));
3103 r->next = addr->retries;
3106 r->key = string_copy(ptr);
3108 memcpy(&(r->basic_errno), ptr, sizeof(r->basic_errno));
3109 ptr += sizeof(r->basic_errno);
3110 memcpy(&(r->more_errno), ptr, sizeof(r->more_errno));
3111 ptr += sizeof(r->more_errno);
3112 r->message = (*ptr)? string_copy(ptr) : NULL;
3113 DEBUG(D_deliver|D_retry)
3114 debug_printf(" added %s item\n",
3115 ((r->flags & rf_delete) == 0)? "retry" : "delete");
3120 DEBUG(D_deliver|D_retry)
3121 debug_printf(" delete item not added: non-delete item exists\n");
3124 ptr += sizeof(r->basic_errno) + sizeof(r->more_errno);
3130 /* Put the amount of data written into the parlist block */
3133 memcpy(&(p->transport_count), ptr, sizeof(transport_count));
3134 ptr += sizeof(transport_count);
3137 /* Address items are in the order of items on the address chain. We
3138 remember the current address value in case this function is called
3139 several times to empty the pipe in stages. Information about delivery
3140 over TLS is sent in a preceding X item for each address. We don't put
3141 it in with the other info, in order to keep each message short enough to
3142 guarantee it won't be split in the pipe. */
3146 if (addr == NULL) goto ADDR_MISMATCH; /* Below, in 'A' handler */
3150 addr->cipher = NULL;
3151 addr->peerdn = NULL;
3154 addr->cipher = string_copy(ptr);
3157 addr->peerdn = string_copy(ptr);
3162 (void) tls_import_cert(ptr, &addr->peercert);
3164 addr->peercert = NULL;
3169 (void) tls_import_cert(ptr, &addr->ourcert);
3171 addr->ourcert = NULL;
3174 # ifndef DISABLE_OCSP
3176 addr->ocsp = OCSP_NOT_REQ;
3178 addr->ocsp = *ptr - '0';
3184 #endif /*SUPPORT_TLS*/
3186 case 'C': /* client authenticator information */
3190 addr->authenticator = (*ptr)? string_copy(ptr) : NULL;
3193 addr->auth_id = (*ptr)? string_copy(ptr) : NULL;
3196 addr->auth_sndr = (*ptr)? string_copy(ptr) : NULL;
3202 #ifndef DISABLE_PRDR
3204 addr->flags |= af_prdr_used;
3209 if (addr == NULL) goto ADDR_MISMATCH;
3210 memcpy(&(addr->dsn_aware), ptr, sizeof(addr->dsn_aware));
3211 ptr += sizeof(addr->dsn_aware);
3212 DEBUG(D_deliver) debug_printf("DSN read: addr->dsn_aware = %d\n", addr->dsn_aware);
3219 msg = string_sprintf("address count mismatch for data read from pipe "
3220 "for transport process %d for transport %s", pid,
3221 addrlist->transport->driver_name);
3226 addr->transport_return = *ptr++;
3227 addr->special_action = *ptr++;
3228 memcpy(&(addr->basic_errno), ptr, sizeof(addr->basic_errno));
3229 ptr += sizeof(addr->basic_errno);
3230 memcpy(&(addr->more_errno), ptr, sizeof(addr->more_errno));
3231 ptr += sizeof(addr->more_errno);
3232 memcpy(&(addr->flags), ptr, sizeof(addr->flags));
3233 ptr += sizeof(addr->flags);
3234 addr->message = (*ptr)? string_copy(ptr) : NULL;
3236 addr->user_message = (*ptr)? string_copy(ptr) : NULL;
3239 /* Always two strings for host information, followed by the port number and DNSSEC mark */
3243 h = store_get(sizeof(host_item));
3244 h->name = string_copy(ptr);
3246 h->address = string_copy(ptr);
3248 memcpy(&(h->port), ptr, sizeof(h->port));
3249 ptr += sizeof(h->port);
3250 h->dnssec = *ptr == '2' ? DS_YES
3251 : *ptr == '1' ? DS_NO
3254 addr->host_used = h;
3258 /* Finished with this address */
3263 /* Local interface address/port */
3265 if (*ptr) sending_ip_address = string_copy(ptr);
3267 if (*ptr) sending_port = atoi(CS ptr);
3271 /* Z marks the logical end of the data. It is followed by '0' if
3272 continue_transport was NULL at the end of transporting, otherwise '1'.
3273 We need to know when it becomes NULL during a delivery down a passed SMTP
3274 channel so that we don't try to pass anything more down it. Of course, for
3275 most normal messages it will remain NULL all the time. */
3280 continue_transport = NULL;
3281 continue_hostname = NULL;
3284 DEBUG(D_deliver) debug_printf("Z0%c item read\n", *ptr);
3287 /* Anything else is a disaster. */
3290 msg = string_sprintf("malformed data (%d) read from pipe for transport "
3291 "process %d for transport %s", ptr[-1], pid,
3292 addr->transport->driver_name);
3298 /* The done flag is inspected externally, to determine whether or not to
3299 call the function again when the process finishes. */
3303 /* If the process hadn't finished, and we haven't seen the end of the data
3304 or suffered a disaster, update the rest of the state, and return FALSE to
3305 indicate "not finished". */
3314 /* Close our end of the pipe, to prevent deadlock if the far end is still
3315 pushing stuff into it. */
3320 /* If we have finished without error, but haven't had data for every address,
3321 something is wrong. */
3323 if (msg == NULL && addr != NULL)
3324 msg = string_sprintf("insufficient address data read from pipe "
3325 "for transport process %d for transport %s", pid,
3326 addr->transport->driver_name);
3328 /* If an error message is set, something has gone wrong in getting back
3329 the delivery data. Put the message into each address and freeze it. */
3333 for (addr = addrlist; addr != NULL; addr = addr->next)
3335 addr->transport_return = DEFER;
3336 addr->special_action = SPECIAL_FREEZE;
3337 addr->message = msg;
3341 /* Return TRUE to indicate we have got all we need from this process, even
3342 if it hasn't actually finished yet. */
3349 /*************************************************
3350 * Post-process a set of remote addresses *
3351 *************************************************/
3353 /* Do what has to be done immediately after a remote delivery for each set of
3354 addresses, then re-write the spool if necessary. Note that post_process_one
3355 puts the address on an appropriate queue; hence we must fish off the next
3356 one first. This function is also called if there is a problem with setting
3357 up a subprocess to do a remote delivery in parallel. In this case, the final
3358 argument contains a message, and the action must be forced to DEFER.
3361 addr pointer to chain of address items
3362 logflags flags for logging
3363 msg NULL for normal cases; -> error message for unexpected problems
3364 fallback TRUE if processing fallback hosts
3370 remote_post_process(address_item *addr, int logflags, uschar *msg,
3375 /* If any host addresses were found to be unusable, add them to the unusable
3376 tree so that subsequent deliveries don't try them. */
3378 for (h = addr->host_list; h != NULL; h = h->next)
3380 if (h->address == NULL) continue;
3381 if (h->status >= hstatus_unusable) tree_add_unusable(h);
3384 /* Now handle each address on the chain. The transport has placed '=' or '-'
3385 into the special_action field for each successful delivery. */
3387 while (addr != NULL)
3389 address_item *next = addr->next;
3391 /* If msg == NULL (normal processing) and the result is DEFER and we are
3392 processing the main hosts and there are fallback hosts available, put the
3393 address on the list for fallback delivery. */
3395 if (addr->transport_return == DEFER &&
3396 addr->fallback_hosts != NULL &&
3400 addr->host_list = addr->fallback_hosts;
3401 addr->next = addr_fallback;
3402 addr_fallback = addr;
3403 DEBUG(D_deliver) debug_printf("%s queued for fallback host(s)\n", addr->address);
3406 /* If msg is set (=> unexpected problem), set it in the address before
3407 doing the ordinary post processing. */
3413 addr->message = msg;
3414 addr->transport_return = DEFER;
3416 (void)post_process_one(addr, addr->transport_return, logflags,
3417 DTYPE_TRANSPORT, addr->special_action);
3425 /* If we have just delivered down a passed SMTP channel, and that was
3426 the last address, the channel will have been closed down. Now that
3427 we have logged that delivery, set continue_sequence to 1 so that
3428 any subsequent deliveries don't get "*" incorrectly logged. */
3430 if (continue_transport == NULL) continue_sequence = 1;
3435 /*************************************************
3436 * Wait for one remote delivery subprocess *
3437 *************************************************/
3439 /* This function is called while doing remote deliveries when either the
3440 maximum number of processes exist and we need one to complete so that another
3441 can be created, or when waiting for the last ones to complete. It must wait for
3442 the completion of one subprocess, empty the control block slot, and return a
3443 pointer to the address chain.
3446 Returns: pointer to the chain of addresses handled by the process;
3447 NULL if no subprocess found - this is an unexpected error
3450 static address_item *
3453 int poffset, status;
3454 address_item *addr, *addrlist;
3457 set_process_info("delivering %s: waiting for a remote delivery subprocess "
3458 "to finish", message_id);
3460 /* Loop until either a subprocess completes, or there are no subprocesses in
3461 existence - in which case give an error return. We cannot proceed just by
3462 waiting for a completion, because a subprocess may have filled up its pipe, and
3463 be waiting for it to be emptied. Therefore, if no processes have finished, we
3464 wait for one of the pipes to acquire some data by calling select(), with a
3465 timeout just in case.
3467 The simple approach is just to iterate after reading data from a ready pipe.
3468 This leads to non-ideal behaviour when the subprocess has written its final Z
3469 item, closed the pipe, and is in the process of exiting (the common case). A
3470 call to waitpid() yields nothing completed, but select() shows the pipe ready -
3471 reading it yields EOF, so you end up with busy-waiting until the subprocess has
3474 To avoid this, if all the data that is needed has been read from a subprocess
3475 after select(), an explicit wait() for it is done. We know that all it is doing
3476 is writing to the pipe and then exiting, so the wait should not be long.
3478 The non-blocking waitpid() is to some extent just insurance; if we could
3479 reliably detect end-of-file on the pipe, we could always know when to do a
3480 blocking wait() for a completed process. However, because some systems use
3481 NDELAY, which doesn't distinguish between EOF and pipe empty, it is easier to
3482 use code that functions without the need to recognize EOF.
3484 There's a double loop here just in case we end up with a process that is not in
3485 the list of remote delivery processes. Something has obviously gone wrong if
3486 this is the case. (For example, a process that is incorrectly left over from
3487 routing or local deliveries might be found.) The damage can be minimized by
3488 looping back and looking for another process. If there aren't any, the error
3489 return will happen. */
3491 for (;;) /* Normally we do not repeat this loop */
3493 while ((pid = waitpid(-1, &status, WNOHANG)) <= 0)
3496 fd_set select_pipes;
3497 int maxpipe, readycount;
3499 /* A return value of -1 can mean several things. If errno != ECHILD, it
3500 either means invalid options (which we discount), or that this process was
3501 interrupted by a signal. Just loop to try the waitpid() again.
3503 If errno == ECHILD, waitpid() is telling us that there are no subprocesses
3504 in existence. This should never happen, and is an unexpected error.
3505 However, there is a nasty complication when running under Linux. If "strace
3506 -f" is being used under Linux to trace this process and its children,
3507 subprocesses are "stolen" from their parents and become the children of the
3508 tracing process. A general wait such as the one we've just obeyed returns
3509 as if there are no children while subprocesses are running. Once a
3510 subprocess completes, it is restored to the parent, and waitpid(-1) finds
3511 it. Thanks to Joachim Wieland for finding all this out and suggesting a
3514 This does not happen using "truss" on Solaris, nor (I think) with other
3515 tracing facilities on other OS. It seems to be specific to Linux.
3517 What we do to get round this is to use kill() to see if any of our
3518 subprocesses are still in existence. If kill() gives an OK return, we know
3519 it must be for one of our processes - it can't be for a re-use of the pid,
3520 because if our process had finished, waitpid() would have found it. If any
3521 of our subprocesses are in existence, we proceed to use select() as if
3522 waitpid() had returned zero. I think this is safe. */
3526 if (errno != ECHILD) continue; /* Repeats the waitpid() */
3529 debug_printf("waitpid() returned -1/ECHILD: checking explicitly "
3530 "for process existence\n");
3532 for (poffset = 0; poffset < remote_max_parallel; poffset++)
3534 if ((pid = parlist[poffset].pid) != 0 && kill(pid, 0) == 0)
3536 DEBUG(D_deliver) debug_printf("process %d still exists: assume "
3537 "stolen by strace\n", (int)pid);
3538 break; /* With poffset set */
3542 if (poffset >= remote_max_parallel)
3544 DEBUG(D_deliver) debug_printf("*** no delivery children found\n");
3545 return NULL; /* This is the error return */
3549 /* A pid value greater than 0 breaks the "while" loop. A negative value has
3550 been handled above. A return value of zero means that there is at least one
3551 subprocess, but there are no completed subprocesses. See if any pipes are
3552 ready with any data for reading. */
3554 DEBUG(D_deliver) debug_printf("selecting on subprocess pipes\n");
3557 FD_ZERO(&select_pipes);
3558 for (poffset = 0; poffset < remote_max_parallel; poffset++)
3560 if (parlist[poffset].pid != 0)
3562 int fd = parlist[poffset].fd;
3563 FD_SET(fd, &select_pipes);
3564 if (fd > maxpipe) maxpipe = fd;
3568 /* Stick in a 60-second timeout, just in case. */
3573 readycount = select(maxpipe + 1, (SELECT_ARG2_TYPE *)&select_pipes,
3576 /* Scan through the pipes and read any that are ready; use the count
3577 returned by select() to stop when there are no more. Select() can return
3578 with no processes (e.g. if interrupted). This shouldn't matter.
3580 If par_read_pipe() returns TRUE, it means that either the terminating Z was
3581 read, or there was a disaster. In either case, we are finished with this
3582 process. Do an explicit wait() for the process and break the main loop if
3585 It turns out that we have to deal with the case of an interrupted system
3586 call, which can happen on some operating systems if the signal handling is
3587 set up to do that by default. */
3590 readycount > 0 && poffset < remote_max_parallel;
3593 if ((pid = parlist[poffset].pid) != 0 &&
3594 FD_ISSET(parlist[poffset].fd, &select_pipes))
3597 if (par_read_pipe(poffset, FALSE)) /* Finished with this pipe */
3599 for (;;) /* Loop for signals */
3601 pid_t endedpid = waitpid(pid, &status, 0);
3602 if (endedpid == pid) goto PROCESS_DONE;
3603 if (endedpid != (pid_t)(-1) || errno != EINTR)
3604 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Unexpected error return "
3605 "%d (errno = %d) from waitpid() for process %d",
3606 (int)endedpid, errno, (int)pid);
3612 /* Now go back and look for a completed subprocess again. */
3615 /* A completed process was detected by the non-blocking waitpid(). Find the
3616 data block that corresponds to this subprocess. */
3618 for (poffset = 0; poffset < remote_max_parallel; poffset++)
3619 if (pid == parlist[poffset].pid) break;
3621 /* Found the data block; this is a known remote delivery process. We don't
3622 need to repeat the outer loop. This should be what normally happens. */
3624 if (poffset < remote_max_parallel) break;
3626 /* This situation is an error, but it's probably better to carry on looking
3627 for another process than to give up (as we used to do). */
3629 log_write(0, LOG_MAIN|LOG_PANIC, "Process %d finished: not found in remote "
3630 "transport process list", pid);
3631 } /* End of the "for" loop */
3633 /* Come here when all the data was completely read after a select(), and
3634 the process in pid has been wait()ed for. */
3641 debug_printf("remote delivery process %d ended\n", (int)pid);
3643 debug_printf("remote delivery process %d ended: status=%04x\n", (int)pid,
3647 set_process_info("delivering %s", message_id);
3649 /* Get the chain of processed addresses */
3651 addrlist = parlist[poffset].addrlist;
3653 /* If the process did not finish cleanly, record an error and freeze (except
3654 for SIGTERM, SIGKILL and SIGQUIT), and also ensure the journal is not removed,
3655 in case the delivery did actually happen. */
3657 if ((status & 0xffff) != 0)
3660 int msb = (status >> 8) & 255;
3661 int lsb = status & 255;
3662 int code = (msb == 0)? (lsb & 0x7f) : msb;
3664 msg = string_sprintf("%s transport process returned non-zero status 0x%04x: "
3666 addrlist->transport->driver_name,
3668 (msb == 0)? "terminated by signal" : "exit code",
3671 if (msb != 0 || (code != SIGTERM && code != SIGKILL && code != SIGQUIT))
3672 addrlist->special_action = SPECIAL_FREEZE;
3674 for (addr = addrlist; addr != NULL; addr = addr->next)
3676 addr->transport_return = DEFER;
3677 addr->message = msg;
3680 remove_journal = FALSE;
3683 /* Else complete reading the pipe to get the result of the delivery, if all
3684 the data has not yet been obtained. */
3686 else if (!parlist[poffset].done) (void)par_read_pipe(poffset, TRUE);
3688 /* Put the data count and return path into globals, mark the data slot unused,
3689 decrement the count of subprocesses, and return the address chain. */
3691 transport_count = parlist[poffset].transport_count;
3692 used_return_path = parlist[poffset].return_path;
3693 parlist[poffset].pid = 0;
3700 /*************************************************
3701 * Wait for subprocesses and post-process *
3702 *************************************************/
3704 /* This function waits for subprocesses until the number that are still running
3705 is below a given threshold. For each complete subprocess, the addresses are
3706 post-processed. If we can't find a running process, there is some shambles.
3707 Better not bomb out, as that might lead to multiple copies of the message. Just
3708 log and proceed as if all done.
3711 max maximum number of subprocesses to leave running
3712 fallback TRUE if processing fallback hosts
3718 par_reduce(int max, BOOL fallback)
3720 while (parcount > max)
3722 address_item *doneaddr = par_wait();
3723 if (doneaddr == NULL)
3725 log_write(0, LOG_MAIN|LOG_PANIC,
3726 "remote delivery process count got out of step");
3729 else remote_post_process(doneaddr, LOG_MAIN, NULL, fallback);
3737 rmt_dlv_checked_write(int fd, char id, char subid, void * buf, int size)
3739 uschar writebuffer[PIPE_HEADER_SIZE + BIG_BUFFER_SIZE];
3742 /* we assume that size can't get larger then BIG_BUFFER_SIZE which currently is set to 16k */
3743 /* complain to log if someone tries with buffer sizes we can't handle*/
3747 log_write(0, LOG_MAIN|LOG_PANIC_DIE,
3748 "Failed writing transport result to pipe: can't handle buffers > 99999 bytes. truncating!\n");
3752 /* to keep the write() atomic we build header in writebuffer and copy buf behind */
3753 /* two write() calls would increase the complexity of reading from pipe */
3755 /* convert size to human readable string prepended by id and subid */
3756 header_length = snprintf(CS writebuffer, PIPE_HEADER_SIZE+1, "%c%c%05d", id, subid, size);
3757 if (header_length != PIPE_HEADER_SIZE)
3759 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "header snprintf failed\n");
3760 writebuffer[0] = '\0';
3763 DEBUG(D_deliver) debug_printf("header write id:%c,subid:%c,size:%d,final:%s\n",
3764 id, subid, size, writebuffer);
3766 if (buf && size > 0)
3767 memcpy(writebuffer + PIPE_HEADER_SIZE, buf, size);
3769 size += PIPE_HEADER_SIZE;
3770 int ret = write(fd, writebuffer, size);
3772 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Failed writing transport result to pipe: %s\n",
3773 ret == -1 ? strerror(errno) : "short write");
3776 /*************************************************
3777 * Do remote deliveries *
3778 *************************************************/
3780 /* This function is called to process the addresses in addr_remote. We must
3781 pick off the queue all addresses that have the same transport, remote
3782 destination, and errors address, and hand them to the transport in one go,
3783 subject to some configured limitations. If this is a run to continue delivering
3784 to an existing delivery channel, skip all but those addresses that can go to
3785 that channel. The skipped addresses just get deferred.
3787 If mua_wrapper is set, all addresses must be able to be sent in a single
3788 transaction. If not, this function yields FALSE.
3790 In Exim 4, remote deliveries are always done in separate processes, even
3791 if remote_max_parallel = 1 or if there's only one delivery to do. The reason
3792 is so that the base process can retain privilege. This makes the
3793 implementation of fallback transports feasible (though not initially done.)
3795 We create up to the configured number of subprocesses, each of which passes
3796 back the delivery state via a pipe. (However, when sending down an existing
3797 connection, remote_max_parallel is forced to 1.)
3800 fallback TRUE if processing fallback hosts
3802 Returns: TRUE normally
3803 FALSE if mua_wrapper is set and the addresses cannot all be sent
3808 do_remote_deliveries(BOOL fallback)
3814 parcount = 0; /* Number of executing subprocesses */
3816 /* When sending down an existing channel, only do one delivery at a time.
3817 We use a local variable (parmax) to hold the maximum number of processes;
3818 this gets reduced from remote_max_parallel if we can't create enough pipes. */
3820 if (continue_transport != NULL) remote_max_parallel = 1;
3821 parmax = remote_max_parallel;
3823 /* If the data for keeping a list of processes hasn't yet been
3826 if (parlist == NULL)
3828 parlist = store_get(remote_max_parallel * sizeof(pardata));
3829 for (poffset = 0; poffset < remote_max_parallel; poffset++)
3830 parlist[poffset].pid = 0;
3833 /* Now loop for each remote delivery */
3835 for (delivery_count = 0; addr_remote != NULL; delivery_count++)
3841 int address_count = 1;
3842 int address_count_max;
3844 BOOL use_initgroups;
3845 BOOL pipe_done = FALSE;
3846 transport_instance *tp;
3847 address_item **anchor = &addr_remote;
3848 address_item *addr = addr_remote;
3849 address_item *last = addr;
3852 /* Pull the first address right off the list. */
3854 addr_remote = addr->next;
3857 DEBUG(D_deliver|D_transport)
3858 debug_printf("--------> %s <--------\n", addr->address);
3860 /* If no transport has been set, there has been a big screw-up somewhere. */
3862 if ((tp = addr->transport) == NULL)
3864 disable_logging = FALSE; /* Jic */
3865 remote_post_process(addr, LOG_MAIN|LOG_PANIC,
3866 US"No transport set by router", fallback);
3870 /* Check that this base address hasn't previously been delivered to this
3871 transport. The check is necessary at this point to handle homonymic addresses
3872 correctly in cases where the pattern of redirection changes between delivery
3873 attempts. Non-homonymic previous delivery is detected earlier, at routing
3876 if (previously_transported(addr, FALSE)) continue;
3878 /* Force failure if the message is too big. */
3880 if (tp->message_size_limit != NULL)
3882 int rc = check_message_size(tp, addr);
3885 addr->transport_return = rc;
3886 remote_post_process(addr, LOG_MAIN, NULL, fallback);
3891 /* Get the flag which specifies whether the transport can handle different
3892 domains that nevertheless resolve to the same set of hosts. If it needs
3893 expanding, get variables set: $address_data, $domain_data, $localpart_data,
3894 $host, $host_address, $host_port. */
3895 if (tp->expand_multi_domain)
3896 deliver_set_expansions(addr);
3898 if (exp_bool(addr, US"transport", tp->name, D_transport,
3899 US"multi_domain", tp->multi_domain, tp->expand_multi_domain,
3900 &multi_domain) != OK)
3902 deliver_set_expansions(NULL);
3903 remote_post_process(addr, LOG_MAIN|LOG_PANIC, addr->message, fallback);
3907 /* Get the maximum it can handle in one envelope, with zero meaning
3908 unlimited, which is forced for the MUA wrapper case. */
3910 address_count_max = tp->max_addresses;
3911 if (address_count_max == 0 || mua_wrapper) address_count_max = 999999;
3914 /************************************************************************/
3915 /***** This is slightly experimental code, but should be safe. *****/
3917 /* The address_count_max value is the maximum number of addresses that the
3918 transport can send in one envelope. However, the transport must be capable of
3919 dealing with any number of addresses. If the number it gets exceeds its
3920 envelope limitation, it must send multiple copies of the message. This can be
3921 done over a single connection for SMTP, so uses less resources than making
3922 multiple connections. On the other hand, if remote_max_parallel is greater
3923 than one, it is perhaps a good idea to use parallel processing to move the
3924 message faster, even if that results in multiple simultaneous connections to
3927 How can we come to some compromise between these two ideals? What we do is to
3928 limit the number of addresses passed to a single instance of a transport to
3929 the greater of (a) its address limit (rcpt_max for SMTP) and (b) the total
3930 number of addresses routed to remote transports divided by
3931 remote_max_parallel. For example, if the message has 100 remote recipients,
3932 remote max parallel is 2, and rcpt_max is 10, we'd never send more than 50 at
3933 once. But if rcpt_max is 100, we could send up to 100.
3935 Of course, not all the remotely addresses in a message are going to go to the
3936 same set of hosts (except in smarthost configurations), so this is just a
3937 heuristic way of dividing up the work.
3939 Furthermore (1), because this may not be wanted in some cases, and also to
3940 cope with really pathological cases, there is also a limit to the number of
3941 messages that are sent over one connection. This is the same limit that is
3942 used when sending several different messages over the same connection.
3943 Continue_sequence is set when in this situation, to the number sent so
3944 far, including this message.
3946 Furthermore (2), when somebody explicitly sets the maximum value to 1, it
3947 is probably because they are using VERP, in which case they want to pass only
3948 one address at a time to the transport, in order to be able to use
3949 $local_part and $domain in constructing a new return path. We could test for
3950 the use of these variables, but as it is so likely they will be used when the
3951 maximum is 1, we don't bother. Just leave the value alone. */
3953 if (address_count_max != 1 &&
3954 address_count_max < remote_delivery_count/remote_max_parallel)
3956 int new_max = remote_delivery_count/remote_max_parallel;
3957 int message_max = tp->connection_max_messages;
3958 if (connection_max_messages >= 0) message_max = connection_max_messages;
3959 message_max -= continue_sequence - 1;
3960 if (message_max > 0 && new_max > address_count_max * message_max)
3961 new_max = address_count_max * message_max;
3962 address_count_max = new_max;
3965 /************************************************************************/
3968 /* Pick off all addresses which have the same transport, errors address,
3969 destination, and extra headers. In some cases they point to the same host
3970 list, but we also need to check for identical host lists generated from
3971 entirely different domains. The host list pointers can be NULL in the case
3972 where the hosts are defined in the transport. There is also a configured
3973 maximum limit of addresses that can be handled at once (see comments above
3974 for how it is computed).
3975 If the transport does not handle multiple domains, enforce that also,
3976 and if it might need a per-address check for this, re-evaluate it.
3979 while ((next = *anchor) != NULL && address_count < address_count_max)
3982 if ( (multi_domain || Ustrcmp(next->domain, addr->domain) == 0)
3983 && tp == next->transport
3984 && same_hosts(next->host_list, addr->host_list)
3985 && same_strings(next->prop.errors_address, addr->prop.errors_address)
3986 && same_headers(next->prop.extra_headers, addr->prop.extra_headers)
3987 && same_ugid(tp, next, addr)
3988 && ( next->prop.remove_headers == addr->prop.remove_headers
3989 || ( next->prop.remove_headers
3990 && addr->prop.remove_headers
3991 && Ustrcmp(next->prop.remove_headers, addr->prop.remove_headers) == 0
3995 !tp->expand_multi_domain || (deliver_set_expansions(next), 1),
3997 US"transport", next->transport->name, D_transport,
3998 US"multi_domain", next->transport->multi_domain,
3999 next->transport->expand_multi_domain, &md) == OK
4004 *anchor = next->next;
4006 next->first = addr; /* remember top one (for retry processing) */
4011 else anchor = &(next->next);
4012 deliver_set_expansions(NULL);
4015 /* If we are acting as an MUA wrapper, all addresses must go in a single
4016 transaction. If not, put them back on the chain and yield FALSE. */
4018 if (mua_wrapper && addr_remote != NULL)
4020 last->next = addr_remote;
4025 /* Set up the expansion variables for this set of addresses */
4027 deliver_set_expansions(addr);
4029 /* Ensure any transport-set auth info is fresh */
4030 addr->authenticator = addr->auth_id = addr->auth_sndr = NULL;
4032 /* Compute the return path, expanding a new one if required. The old one
4033 must be set first, as it might be referred to in the expansion. */
4035 if(addr->prop.errors_address != NULL)
4036 return_path = addr->prop.errors_address;
4037 #ifdef EXPERIMENTAL_SRS
4038 else if(addr->prop.srs_sender != NULL)
4039 return_path = addr->prop.srs_sender;
4042 return_path = sender_address;
4044 if (tp->return_path != NULL)
4046 uschar *new_return_path = expand_string(tp->return_path);
4047 if (new_return_path == NULL)
4049 if (!expand_string_forcedfail)
4051 remote_post_process(addr, LOG_MAIN|LOG_PANIC,
4052 string_sprintf("Failed to expand return path \"%s\": %s",
4053 tp->return_path, expand_string_message), fallback);
4057 else return_path = new_return_path;
4060 /* Find the uid, gid, and use_initgroups setting for this transport. Failure
4061 logs and sets up error messages, so we just post-process and continue with
4062 the next address. */
4064 if (!findugid(addr, tp, &uid, &gid, &use_initgroups))
4066 remote_post_process(addr, LOG_MAIN|LOG_PANIC, NULL, fallback);
4070 /* If this transport has a setup function, call it now so that it gets
4071 run in this process and not in any subprocess. That way, the results of
4072 any setup that are retained by the transport can be reusable. One of the
4073 things the setup does is to set the fallback host lists in the addresses.
4074 That is why it is called at this point, before the continue delivery
4075 processing, because that might use the fallback hosts. */
4077 if (tp->setup != NULL)
4078 (void)((tp->setup)(addr->transport, addr, NULL, uid, gid, NULL));
4080 /* If this is a run to continue delivery down an already-established
4081 channel, check that this set of addresses matches the transport and
4082 the channel. If it does not, defer the addresses. If a host list exists,
4083 we must check that the continue host is on the list. Otherwise, the
4084 host is set in the transport. */
4086 continue_more = FALSE; /* In case got set for the last lot */
4087 if (continue_transport != NULL)
4089 BOOL ok = Ustrcmp(continue_transport, tp->name) == 0;
4090 if (ok && addr->host_list != NULL)
4094 for (h = addr->host_list; h != NULL; h = h->next)
4096 if (Ustrcmp(h->name, continue_hostname) == 0)
4097 { ok = TRUE; break; }
4101 /* Addresses not suitable; defer or queue for fallback hosts (which
4102 might be the continue host) and skip to next address. */
4106 DEBUG(D_deliver) debug_printf("not suitable for continue_transport\n");
4109 if (addr->fallback_hosts != NULL && !fallback)
4113 next->host_list = next->fallback_hosts;
4114 DEBUG(D_deliver) debug_printf("%s queued for fallback host(s)\n", next->address);
4115 if (next->next == NULL) break;
4118 next->next = addr_fallback;
4119 addr_fallback = addr;
4124 while (next->next != NULL) next = next->next;
4125 next->next = addr_defer;
4132 /* Set a flag indicating whether there are further addresses that list
4133 the continued host. This tells the transport to leave the channel open,
4134 but not to pass it to another delivery process. */
4136 for (next = addr_remote; next != NULL; next = next->next)
4139 for (h = next->host_list; h != NULL; h = h->next)
4141 if (Ustrcmp(h->name, continue_hostname) == 0)
4142 { continue_more = TRUE; break; }
4147 /* The transports set up the process info themselves as they may connect
4148 to more than one remote machine. They also have to set up the filter
4149 arguments, if required, so that the host name and address are available
4152 transport_filter_argv = NULL;
4154 /* Create the pipe for inter-process communication. If pipe creation
4155 fails, it is probably because the value of remote_max_parallel is so
4156 large that too many file descriptors for pipes have been created. Arrange
4157 to wait for a process to finish, and then try again. If we still can't
4158 create a pipe when all processes have finished, break the retry loop. */
4162 if (pipe(pfd) == 0) pipe_done = TRUE;
4163 else if (parcount > 0) parmax = parcount;
4166 /* We need to make the reading end of the pipe non-blocking. There are
4167 two different options for this. Exim is cunningly (I hope!) coded so
4168 that it can use either of them, though it prefers O_NONBLOCK, which
4169 distinguishes between EOF and no-more-data. */
4172 (void)fcntl(pfd[pipe_read], F_SETFL, O_NONBLOCK);
4174 (void)fcntl(pfd[pipe_read], F_SETFL, O_NDELAY);
4177 /* If the maximum number of subprocesses already exist, wait for a process
4178 to finish. If we ran out of file descriptors, parmax will have been reduced
4179 from its initial value of remote_max_parallel. */
4181 par_reduce(parmax - 1, fallback);
4184 /* If we failed to create a pipe and there were no processes to wait
4185 for, we have to give up on this one. Do this outside the above loop
4186 so that we can continue the main loop. */
4190 remote_post_process(addr, LOG_MAIN|LOG_PANIC,
4191 string_sprintf("unable to create pipe: %s", strerror(errno)), fallback);
4195 /* Find a free slot in the pardata list. Must do this after the possible
4196 waiting for processes to finish, because a terminating process will free
4199 for (poffset = 0; poffset < remote_max_parallel; poffset++)
4200 if (parlist[poffset].pid == 0) break;
4202 /* If there isn't one, there has been a horrible disaster. */
4204 if (poffset >= remote_max_parallel)
4206 (void)close(pfd[pipe_write]);
4207 (void)close(pfd[pipe_read]);
4208 remote_post_process(addr, LOG_MAIN|LOG_PANIC,
4209 US"Unexpectedly no free subprocess slot", fallback);
4213 /* Now fork a subprocess to do the remote delivery, but before doing so,
4214 ensure that any cached resourses are released so as not to interfere with
4215 what happens in the subprocess. */
4219 if ((pid = fork()) == 0)
4221 int fd = pfd[pipe_write];
4224 /* Setting this global in the subprocess means we need never clear it */
4225 transport_name = tp->name;
4227 /* There are weird circumstances in which logging is disabled */
4228 disable_logging = tp->disable_logging;
4230 /* Show pids on debug output if parallelism possible */
4232 if (parmax > 1 && (parcount > 0 || addr_remote != NULL))
4234 DEBUG(D_any|D_v) debug_selector |= D_pid;
4235 DEBUG(D_deliver) debug_printf("Remote delivery process started\n");
4238 /* Reset the random number generator, so different processes don't all
4239 have the same sequence. In the test harness we want different, but
4240 predictable settings for each delivery process, so do something explicit
4241 here rather they rely on the fixed reset in the random number function. */
4243 random_seed = running_in_test_harness? 42 + 2*delivery_count : 0;
4245 /* Set close-on-exec on the pipe so that it doesn't get passed on to
4246 a new process that may be forked to do another delivery down the same
4249 (void)fcntl(fd, F_SETFD, fcntl(fd, F_GETFD) | FD_CLOEXEC);
4251 /* Close open file descriptors for the pipes of other processes
4252 that are running in parallel. */
4254 for (poffset = 0; poffset < remote_max_parallel; poffset++)
4255 if (parlist[poffset].pid != 0) (void)close(parlist[poffset].fd);
4257 /* This process has inherited a copy of the file descriptor
4258 for the data file, but its file pointer is shared with all the
4259 other processes running in parallel. Therefore, we have to re-open
4260 the file in order to get a new file descriptor with its own
4261 file pointer. We don't need to lock it, as the lock is held by
4262 the parent process. There doesn't seem to be any way of doing
4263 a dup-with-new-file-pointer. */
4265 (void)close(deliver_datafile);
4266 sprintf(CS spoolname, "%s/input/%s/%s-D", spool_directory, message_subdir,
4268 deliver_datafile = Uopen(spoolname, O_RDWR | O_APPEND, 0);
4270 if (deliver_datafile < 0)
4271 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Failed to reopen %s for remote "
4272 "parallel delivery: %s", spoolname, strerror(errno));
4274 /* Set the close-on-exec flag */
4276 (void)fcntl(deliver_datafile, F_SETFD, fcntl(deliver_datafile, F_GETFD) |
4279 /* Set the uid/gid of this process; bombs out on failure. */
4281 exim_setugid(uid, gid, use_initgroups,
4282 string_sprintf("remote delivery to %s with transport=%s",
4283 addr->address, tp->name));
4285 /* Close the unwanted half of this process' pipe, set the process state,
4286 and run the transport. Afterwards, transport_count will contain the number
4287 of bytes written. */
4289 (void)close(pfd[pipe_read]);
4290 set_process_info("delivering %s using %s", message_id, tp->name);
4291 debug_print_string(tp->debug_string);
4292 if (!(tp->info->code)(addr->transport, addr)) replicate_status(addr);
4294 set_process_info("delivering %s (just run %s for %s%s in subprocess)",
4295 message_id, tp->name, addr->address, (addr->next == NULL)? "" : ", ...");
4297 /* Ensure any cached resources that we used are now released */
4301 /* Pass the result back down the pipe. This is a lot more information
4302 than is needed for a local delivery. We have to send back the error
4303 status for each address, the usability status for each host that is
4304 flagged as unusable, and all the retry items. When TLS is in use, we
4305 send also the cipher and peerdn information. Each type of information
4306 is flagged by an identifying byte, and is then in a fixed format (with
4307 strings terminated by zeros), and there is a final terminator at the
4308 end. The host information and retry information is all attached to
4309 the first address, so that gets sent at the start. */
4311 /* Host unusability information: for most success cases this will
4314 for (h = addr->host_list; h != NULL; h = h->next)
4316 if (h->address == NULL || h->status < hstatus_unusable) continue;
4317 sprintf(CS big_buffer, "%c%c%s", h->status, h->why, h->address);
4318 rmt_dlv_checked_write(fd, 'H', '0', big_buffer, Ustrlen(big_buffer+2) + 3);
4321 /* The number of bytes written. This is the same for each address. Even
4322 if we sent several copies of the message down the same connection, the
4323 size of each one is the same, and it's that value we have got because
4324 transport_count gets reset before calling transport_write_message(). */
4326 memcpy(big_buffer, &transport_count, sizeof(transport_count));
4327 rmt_dlv_checked_write(fd, 'S', '0', big_buffer, sizeof(transport_count));
4329 /* Information about what happened to each address. Four item types are
4330 used: an optional 'X' item first, for TLS information, then an optional "C"
4331 item for any client-auth info followed by 'R' items for any retry settings,
4332 and finally an 'A' item for the remaining data. */
4334 for(; addr != NULL; addr = addr->next)
4339 /* The certificate verification status goes into the flags */
4340 if (tls_out.certificate_verified) setflag(addr, af_cert_verified);
4341 #ifdef EXPERIMENTAL_DANE
4342 if (tls_out.dane_verified) setflag(addr, af_dane_verified);
4345 /* Use an X item only if there's something to send */
4350 sprintf(CS ptr, "%.128s", addr->cipher);
4356 sprintf(CS ptr, "%.512s", addr->peerdn);
4360 rmt_dlv_checked_write(fd, 'X', '1', big_buffer, ptr - big_buffer);
4365 if (!tls_export_cert(ptr, big_buffer_size-2, addr->peercert))
4369 rmt_dlv_checked_write(fd, 'X', '2', big_buffer, ptr - big_buffer);
4374 if (!tls_export_cert(ptr, big_buffer_size-2, addr->ourcert))
4378 rmt_dlv_checked_write(fd, 'X', '3', big_buffer, ptr - big_buffer);
4380 # ifndef DISABLE_OCSP
4381 if (addr->ocsp > OCSP_NOT_REQ)
4384 sprintf(CS ptr, "%c", addr->ocsp + '0');
4386 rmt_dlv_checked_write(fd, 'X', '4', big_buffer, ptr - big_buffer);
4389 #endif /*SUPPORT_TLS*/
4391 if (client_authenticator)
4394 sprintf(CS big_buffer, "%.64s", client_authenticator);
4396 rmt_dlv_checked_write(fd, 'C', '1', big_buffer, ptr - big_buffer);
4398 if (client_authenticated_id)
4401 sprintf(CS big_buffer, "%.64s", client_authenticated_id);
4403 rmt_dlv_checked_write(fd, 'C', '2', big_buffer, ptr - big_buffer);
4405 if (client_authenticated_sender)
4408 sprintf(CS big_buffer, "%.64s", client_authenticated_sender);
4410 rmt_dlv_checked_write(fd, 'C', '3', big_buffer, ptr - big_buffer);
4413 #ifndef DISABLE_PRDR
4414 if (addr->flags & af_prdr_used)
4415 rmt_dlv_checked_write(fd, 'P', '0', NULL, 0);
4418 memcpy(big_buffer, &addr->dsn_aware, sizeof(addr->dsn_aware));
4419 rmt_dlv_checked_write(fd, 'D', '0', big_buffer, sizeof(addr->dsn_aware));
4420 DEBUG(D_deliver) debug_printf("DSN write: addr->dsn_aware = %d\n", addr->dsn_aware);
4422 /* Retry information: for most success cases this will be null. */
4424 for (r = addr->retries; r != NULL; r = r->next)
4427 sprintf(CS big_buffer, "%c%.500s", r->flags, r->key);
4428 ptr = big_buffer + Ustrlen(big_buffer+2) + 3;
4429 memcpy(ptr, &(r->basic_errno), sizeof(r->basic_errno));
4430 ptr += sizeof(r->basic_errno);
4431 memcpy(ptr, &(r->more_errno), sizeof(r->more_errno));
4432 ptr += sizeof(r->more_errno);
4433 if (r->message == NULL) *ptr++ = 0; else
4435 sprintf(CS ptr, "%.512s", r->message);
4438 rmt_dlv_checked_write(fd, 'R', '0', big_buffer, ptr - big_buffer);
4441 /* The rest of the information goes in an 'A' item. */
4443 ptr = big_buffer + 2;
4444 sprintf(CS big_buffer, "%c%c", addr->transport_return,
4445 addr->special_action);
4446 memcpy(ptr, &(addr->basic_errno), sizeof(addr->basic_errno));
4447 ptr += sizeof(addr->basic_errno);
4448 memcpy(ptr, &(addr->more_errno), sizeof(addr->more_errno));
4449 ptr += sizeof(addr->more_errno);
4450 memcpy(ptr, &(addr->flags), sizeof(addr->flags));
4451 ptr += sizeof(addr->flags);
4453 if (addr->message == NULL) *ptr++ = 0; else
4455 sprintf(CS ptr, "%.1024s", addr->message);
4459 if (addr->user_message == NULL) *ptr++ = 0; else
4461 sprintf(CS ptr, "%.1024s", addr->user_message);
4465 if (addr->host_used == NULL) *ptr++ = 0; else
4467 sprintf(CS ptr, "%.256s", addr->host_used->name);
4469 sprintf(CS ptr, "%.64s", addr->host_used->address);
4471 memcpy(ptr, &(addr->host_used->port), sizeof(addr->host_used->port));
4472 ptr += sizeof(addr->host_used->port);
4474 /* DNS lookup status */
4475 *ptr++ = addr->host_used->dnssec==DS_YES ? '2'
4476 : addr->host_used->dnssec==DS_NO ? '1' : '0';
4479 rmt_dlv_checked_write(fd, 'A', '0', big_buffer, ptr - big_buffer);
4482 /* Local interface address/port */
4483 if (LOGGING(incoming_interface) && sending_ip_address)
4485 uschar * ptr = big_buffer;
4486 sprintf(CS ptr, "%.128s", sending_ip_address);
4488 sprintf(CS ptr, "%d", sending_port);
4491 rmt_dlv_checked_write(fd, 'I', '0', big_buffer, ptr - big_buffer);
4494 /* Add termination flag, close the pipe, and that's it. The character
4495 after 'Z' indicates whether continue_transport is now NULL or not.
4496 A change from non-NULL to NULL indicates a problem with a continuing
4499 big_buffer[0] = (continue_transport == NULL)? '0' : '1';
4500 rmt_dlv_checked_write(fd, 'Z', '0', big_buffer, 1);
4505 /* Back in the mainline: close the unwanted half of the pipe. */
4507 (void)close(pfd[pipe_write]);
4509 /* Fork failed; defer with error message */
4513 (void)close(pfd[pipe_read]);
4514 remote_post_process(addr, LOG_MAIN|LOG_PANIC,
4515 string_sprintf("fork failed for remote delivery to %s: %s",
4516 addr->domain, strerror(errno)), fallback);
4520 /* Fork succeeded; increment the count, and remember relevant data for
4521 when the process finishes. */
4524 parlist[poffset].addrlist = parlist[poffset].addr = addr;
4525 parlist[poffset].pid = pid;
4526 parlist[poffset].fd = pfd[pipe_read];
4527 parlist[poffset].done = FALSE;
4528 parlist[poffset].msg = NULL;
4529 parlist[poffset].return_path = return_path;
4531 /* If the process we've just started is sending a message down an existing
4532 channel, wait for it now. This ensures that only one such process runs at
4533 once, whatever the value of remote_max parallel. Otherwise, we might try to
4534 send two or more messages simultaneously down the same channel. This could
4535 happen if there are different domains that include the same host in otherwise
4536 different host lists.
4538 Also, if the transport closes down the channel, this information gets back
4539 (continue_transport gets set to NULL) before we consider any other addresses
4542 if (continue_transport != NULL) par_reduce(0, fallback);
4544 /* Otherwise, if we are running in the test harness, wait a bit, to let the
4545 newly created process get going before we create another process. This should
4546 ensure repeatability in the tests. We only need to wait a tad. */
4548 else if (running_in_test_harness) millisleep(500);
4551 /* Reached the end of the list of addresses. Wait for all the subprocesses that
4552 are still running and post-process their addresses. */
4554 par_reduce(0, fallback);
4561 /*************************************************
4562 * Split an address into local part and domain *
4563 *************************************************/
4565 /* This function initializes an address for routing by splitting it up into a
4566 local part and a domain. The local part is set up twice - once in its original
4567 casing, and once in lower case, and it is dequoted. We also do the "percent
4568 hack" for configured domains. This may lead to a DEFER result if a lookup
4569 defers. When a percent-hacking takes place, we insert a copy of the original
4570 address as a new parent of this address, as if we have had a redirection.
4573 addr points to an addr_item block containing the address
4576 DEFER - could not determine if domain is %-hackable
4580 deliver_split_address(address_item *addr)
4582 uschar *address = addr->address;
4583 uschar *domain = Ustrrchr(address, '@');
4585 int len = domain - address;
4587 addr->domain = string_copylc(domain+1); /* Domains are always caseless */
4589 /* The implication in the RFCs (though I can't say I've seen it spelled out
4590 explicitly) is that quoting should be removed from local parts at the point
4591 where they are locally interpreted. [The new draft "821" is more explicit on
4592 this, Jan 1999.] We know the syntax is valid, so this can be done by simply
4593 removing quoting backslashes and any unquoted doublequotes. */
4595 t = addr->cc_local_part = store_get(len+1);
4598 register int c = *address++;
4599 if (c == '\"') continue;
4609 /* We do the percent hack only for those domains that are listed in
4610 percent_hack_domains. A loop is required, to copy with multiple %-hacks. */
4612 if (percent_hack_domains != NULL)
4615 uschar *new_address = NULL;
4616 uschar *local_part = addr->cc_local_part;
4618 deliver_domain = addr->domain; /* set $domain */
4620 while ((rc = match_isinlist(deliver_domain, (const uschar **)&percent_hack_domains, 0,
4621 &domainlist_anchor, addr->domain_cache, MCL_DOMAIN, TRUE, NULL))
4623 (t = Ustrrchr(local_part, '%')) != NULL)
4625 new_address = string_copy(local_part);
4626 new_address[t - local_part] = '@';
4627 deliver_domain = string_copylc(t+1);
4628 local_part = string_copyn(local_part, t - local_part);
4631 if (rc == DEFER) return DEFER; /* lookup deferred */
4633 /* If hackery happened, set up new parent and alter the current address. */
4635 if (new_address != NULL)
4637 address_item *new_parent = store_get(sizeof(address_item));
4638 *new_parent = *addr;
4639 addr->parent = new_parent;
4640 addr->address = new_address;
4641 addr->unique = string_copy(new_address);
4642 addr->domain = deliver_domain;
4643 addr->cc_local_part = local_part;
4644 DEBUG(D_deliver) debug_printf("%%-hack changed address to: %s\n",
4649 /* Create the lowercased version of the final local part, and make that the
4650 default one to be used. */
4652 addr->local_part = addr->lc_local_part = string_copylc(addr->cc_local_part);
4659 /*************************************************
4660 * Get next error message text *
4661 *************************************************/
4663 /* If f is not NULL, read the next "paragraph", from a customized error message
4664 text file, terminated by a line containing ****, and expand it.
4667 f NULL or a file to read from
4668 which string indicating which string (for errors)
4670 Returns: NULL or an expanded string
4674 next_emf(FILE *f, uschar *which)
4678 uschar *para, *yield;
4681 if (f == NULL) return NULL;
4683 if (Ufgets(buffer, sizeof(buffer), f) == NULL ||
4684 Ustrcmp(buffer, "****\n") == 0) return NULL;
4686 para = store_get(size);
4689 para = string_cat(para, &size, &ptr, buffer, Ustrlen(buffer));
4690 if (Ufgets(buffer, sizeof(buffer), f) == NULL ||
4691 Ustrcmp(buffer, "****\n") == 0) break;
4695 yield = expand_string(para);
4696 if (yield != NULL) return yield;
4698 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand string from "
4699 "bounce_message_file or warn_message_file (%s): %s", which,
4700 expand_string_message);
4707 /*************************************************
4708 * Close down a passed transport channel *
4709 *************************************************/
4711 /* This function is called when a passed transport channel cannot be used.
4712 It attempts to close it down tidily. The yield is always DELIVER_NOT_ATTEMPTED
4713 so that the function call can be the argument of a "return" statement.
4716 Returns: DELIVER_NOT_ATTEMPTED
4720 continue_closedown(void)
4722 if (continue_transport != NULL)
4724 transport_instance *t;
4725 for (t = transports; t != NULL; t = t->next)
4727 if (Ustrcmp(t->name, continue_transport) == 0)
4729 if (t->info->closedown != NULL) (t->info->closedown)(t);
4734 return DELIVER_NOT_ATTEMPTED;
4740 /*************************************************
4741 * Print address information *
4742 *************************************************/
4744 /* This function is called to output an address, or information about an
4745 address, for bounce or defer messages. If the hide_child flag is set, all we
4746 output is the original ancestor address.
4749 addr points to the address
4750 f the FILE to print to
4751 si an initial string
4752 sc a continuation string for before "generated"
4755 Returns: TRUE if the address is not hidden
4759 print_address_information(address_item *addr, FILE *f, uschar *si, uschar *sc,
4763 uschar *printed = US"";
4764 address_item *ancestor = addr;
4765 while (ancestor->parent != NULL) ancestor = ancestor->parent;
4767 fprintf(f, "%s", CS si);
4769 if (addr->parent != NULL && testflag(addr, af_hide_child))
4771 printed = US"an undisclosed address";
4774 else if (!testflag(addr, af_pfr) || addr->parent == NULL)
4775 printed = addr->address;
4779 uschar *s = addr->address;
4782 if (addr->address[0] == '>') { ss = US"mail"; s++; }
4783 else if (addr->address[0] == '|') ss = US"pipe";
4786 fprintf(f, "%s to %s%sgenerated by ", ss, s, sc);
4787 printed = addr->parent->address;
4790 fprintf(f, "%s", CS string_printing(printed));
4792 if (ancestor != addr)
4794 uschar *original = (ancestor->onetime_parent == NULL)?
4795 ancestor->address : ancestor->onetime_parent;
4796 if (strcmpic(original, printed) != 0)
4797 fprintf(f, "%s(%sgenerated from %s)", sc,
4798 (ancestor != addr->parent)? "ultimately " : "",
4799 string_printing(original));
4802 if (addr->host_used)
4803 fprintf(f, "\n host %s [%s]",
4804 addr->host_used->name, addr->host_used->address);
4806 fprintf(f, "%s", CS se);
4814 /*************************************************
4815 * Print error for an address *
4816 *************************************************/
4818 /* This function is called to print the error information out of an address for
4819 a bounce or a warning message. It tries to format the message reasonably by
4820 introducing newlines. All lines are indented by 4; the initial printing
4821 position must be set before calling.
4823 This function used always to print the error. Nowadays we want to restrict it
4824 to cases such as LMTP/SMTP errors from a remote host, and errors from :fail:
4825 and filter "fail". We no longer pass other information willy-nilly in bounce
4826 and warning messages. Text in user_message is always output; text in message
4827 only if the af_pass_message flag is set.
4831 f the FILE to print on
4838 print_address_error(address_item *addr, FILE *f, uschar *t)
4840 int count = Ustrlen(t);
4841 uschar *s = testflag(addr, af_pass_message)? addr->message : NULL;
4843 if (!s && !(s = addr->user_message))
4846 fprintf(f, "\n %s", t);
4849 if (*s == '\\' && s[1] == 'n')
4859 if (*s++ == ':' && isspace(*s) && count > 45)
4861 fprintf(f, "\n "); /* sic (because space follows) */
4868 /***********************************************************
4869 * Print Diagnostic-Code for an address *
4870 ************************************************************/
4872 /* This function is called to print the error information out of an address for
4873 a bounce or a warning message. It tries to format the message reasonably as
4874 required by RFC 3461 by adding a space after each newline
4876 it uses the same logic as print_address_error() above. if af_pass_message is true
4877 and addr->message is set it uses the remote host answer. if not addr->user_message
4878 is used instead if available.
4882 f the FILE to print on
4888 print_dsn_diagnostic_code(const address_item *addr, FILE *f)
4890 uschar *s = testflag(addr, af_pass_message) ? addr->message : NULL;
4892 /* af_pass_message and addr->message set ? print remote host answer */
4896 debug_printf("DSN Diagnostic-Code: addr->message = %s\n", addr->message);
4898 /* search first ": ". we assume to find the remote-MTA answer there */
4899 if (!(s = Ustrstr(addr->message, ": ")))
4900 return; /* not found, bail out */
4901 s += 2; /* skip ": " */
4902 fprintf(f, "Diagnostic-Code: smtp; ");
4904 /* no message available. do nothing */
4908 if (*s == '\\' && s[1] == 'n')
4910 fputs("\n ", f); /* as defined in RFC 3461 */
4920 /*************************************************
4921 * Check list of addresses for duplication *
4922 *************************************************/
4924 /* This function was introduced when the test for duplicate addresses that are
4925 not pipes, files, or autoreplies was moved from the middle of routing to when
4926 routing was complete. That was to fix obscure cases when the routing history
4927 affects the subsequent routing of identical addresses. This function is called
4928 after routing, to check that the final routed addresses are not duplicates.
4930 If we detect a duplicate, we remember what it is a duplicate of. Note that
4931 pipe, file, and autoreply de-duplication is handled during routing, so we must
4932 leave such "addresses" alone here, as otherwise they will incorrectly be
4935 Argument: address of list anchor
4940 do_duplicate_check(address_item **anchor)
4943 while ((addr = *anchor) != NULL)
4946 if (testflag(addr, af_pfr))
4948 anchor = &(addr->next);
4950 else if ((tnode = tree_search(tree_duplicates, addr->unique)) != NULL)
4952 DEBUG(D_deliver|D_route)
4953 debug_printf("%s is a duplicate address: discarded\n", addr->unique);
4954 *anchor = addr->next;
4955 addr->dupof = tnode->data.ptr;
4956 addr->next = addr_duplicate;
4957 addr_duplicate = addr;
4961 tree_add_duplicate(addr->unique, addr);
4962 anchor = &(addr->next);
4970 /*************************************************
4971 * Deliver one message *
4972 *************************************************/
4974 /* This is the function which is called when a message is to be delivered. It
4975 is passed the id of the message. It is possible that the message no longer
4976 exists, if some other process has delivered it, and it is also possible that
4977 the message is being worked on by another process, in which case the data file
4980 If no delivery is attempted for any of the above reasons, the function returns
4981 DELIVER_NOT_ATTEMPTED.
4983 If the give_up flag is set true, do not attempt any deliveries, but instead
4984 fail all outstanding addresses and return the message to the sender (or
4987 A delivery operation has a process all to itself; we never deliver more than
4988 one message in the same process. Therefore we needn't worry too much about
4992 id the id of the message to be delivered
4993 forced TRUE if delivery was forced by an administrator; this overrides
4994 retry delays and causes a delivery to be tried regardless
4995 give_up TRUE if an administrator has requested that delivery attempts
4998 Returns: When the global variable mua_wrapper is FALSE:
4999 DELIVER_ATTEMPTED_NORMAL if a delivery attempt was made
5000 DELIVER_NOT_ATTEMPTED otherwise (see comment above)
5001 When the global variable mua_wrapper is TRUE:
5002 DELIVER_MUA_SUCCEEDED if delivery succeeded
5003 DELIVER_MUA_FAILED if delivery failed
5004 DELIVER_NOT_ATTEMPTED if not attempted (should not occur)
5008 deliver_message(uschar *id, BOOL forced, BOOL give_up)
5011 int final_yield = DELIVER_ATTEMPTED_NORMAL;
5012 time_t now = time(NULL);
5013 address_item *addr_last = NULL;
5014 uschar *filter_message = NULL;
5016 int process_recipients = RECIP_ACCEPT;
5019 extern int acl_where;
5021 uschar *info = (queue_run_pid == (pid_t)0)?
5022 string_sprintf("delivering %s", id) :
5023 string_sprintf("delivering %s (queue run pid %d)", id, queue_run_pid);
5025 /* If the D_process_info bit is on, set_process_info() will output debugging
5026 information. If not, we want to show this initial information if D_deliver or
5027 D_queue_run is set or in verbose mode. */
5029 set_process_info("%s", info);
5031 if ((debug_selector & D_process_info) == 0 &&
5032 (debug_selector & (D_deliver|D_queue_run|D_v)) != 0)
5033 debug_printf("%s\n", info);
5035 /* Ensure that we catch any subprocesses that are created. Although Exim
5036 sets SIG_DFL as its initial default, some routes through the code end up
5037 here with it set to SIG_IGN - cases where a non-synchronous delivery process
5038 has been forked, but no re-exec has been done. We use sigaction rather than
5039 plain signal() on those OS where SA_NOCLDWAIT exists, because we want to be
5040 sure it is turned off. (There was a problem on AIX with this.) */
5044 struct sigaction act;
5045 act.sa_handler = SIG_DFL;
5046 sigemptyset(&(act.sa_mask));
5048 sigaction(SIGCHLD, &act, NULL);
5051 signal(SIGCHLD, SIG_DFL);
5054 /* Make the forcing flag available for routers and transports, set up the
5055 global message id field, and initialize the count for returned files and the
5056 message size. This use of strcpy() is OK because the length id is checked when
5057 it is obtained from a command line (the -M or -q options), and otherwise it is
5058 known to be a valid message id. */
5060 Ustrcpy(message_id, id);
5061 deliver_force = forced;
5065 /* Initialize some flags */
5067 update_spool = FALSE;
5068 remove_journal = TRUE;
5070 /* Set a known context for any ACLs we call via expansions */
5071 acl_where = ACL_WHERE_DELIVERY;
5073 /* Reset the random number generator, so that if several delivery processes are
5074 started from a queue runner that has already used random numbers (for sorting),
5075 they don't all get the same sequence. */
5079 /* Open and lock the message's data file. Exim locks on this one because the
5080 header file may get replaced as it is re-written during the delivery process.
5081 Any failures cause messages to be written to the log, except for missing files
5082 while queue running - another process probably completed delivery. As part of
5083 opening the data file, message_subdir gets set. */
5085 if (!spool_open_datafile(id))
5086 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5088 /* The value of message_size at this point has been set to the data length,
5089 plus one for the blank line that notionally precedes the data. */
5091 /* Now read the contents of the header file, which will set up the headers in
5092 store, and also the list of recipients and the tree of non-recipients and
5093 assorted flags. It updates message_size. If there is a reading or format error,
5094 give up; if the message has been around for sufficiently long, remove it. */
5096 sprintf(CS spoolname, "%s-H", id);
5097 if ((rc = spool_read_header(spoolname, TRUE, TRUE)) != spool_read_OK)
5099 if (errno == ERRNO_SPOOLFORMAT)
5101 struct stat statbuf;
5102 sprintf(CS big_buffer, "%s/input/%s/%s", spool_directory, message_subdir,
5104 if (Ustat(big_buffer, &statbuf) == 0)
5105 log_write(0, LOG_MAIN, "Format error in spool file %s: "
5106 "size=" OFF_T_FMT, spoolname, statbuf.st_size);
5107 else log_write(0, LOG_MAIN, "Format error in spool file %s", spoolname);
5110 log_write(0, LOG_MAIN, "Error reading spool file %s: %s", spoolname,
5113 /* If we managed to read the envelope data, received_time contains the
5114 time the message was received. Otherwise, we can calculate it from the
5117 if (rc != spool_read_hdrerror)
5120 for (i = 0; i < 6; i++)
5121 received_time = received_time * BASE_62 + tab62[id[i] - '0'];
5124 /* If we've had this malformed message too long, sling it. */
5126 if (now - received_time > keep_malformed)
5128 sprintf(CS spoolname, "%s/msglog/%s/%s", spool_directory, message_subdir, id);
5130 sprintf(CS spoolname, "%s/input/%s/%s-D", spool_directory, message_subdir, id);
5132 sprintf(CS spoolname, "%s/input/%s/%s-H", spool_directory, message_subdir, id);
5134 sprintf(CS spoolname, "%s/input/%s/%s-J", spool_directory, message_subdir, id);
5136 log_write(0, LOG_MAIN, "Message removed because older than %s",
5137 readconf_printtime(keep_malformed));
5140 (void)close(deliver_datafile);
5141 deliver_datafile = -1;
5142 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5145 /* The spool header file has been read. Look to see if there is an existing
5146 journal file for this message. If there is, it means that a previous delivery
5147 attempt crashed (program or host) before it could update the spool header file.
5148 Read the list of delivered addresses from the journal and add them to the
5149 nonrecipients tree. Then update the spool file. We can leave the journal in
5150 existence, as it will get further successful deliveries added to it in this
5151 run, and it will be deleted if this function gets to its end successfully.
5152 Otherwise it might be needed again. */
5154 sprintf(CS spoolname, "%s/input/%s/%s-J", spool_directory, message_subdir, id);
5155 jread = Ufopen(spoolname, "rb");
5158 while (Ufgets(big_buffer, big_buffer_size, jread) != NULL)
5160 int n = Ustrlen(big_buffer);
5161 big_buffer[n-1] = 0;
5162 tree_add_nonrecipient(big_buffer);
5163 DEBUG(D_deliver) debug_printf("Previously delivered address %s taken from "
5164 "journal file\n", big_buffer);
5166 (void)fclose(jread);
5167 /* Panic-dies on error */
5168 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
5170 else if (errno != ENOENT)
5172 log_write(0, LOG_MAIN|LOG_PANIC, "attempt to open journal for reading gave: "
5173 "%s", strerror(errno));
5174 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5177 /* A null recipients list indicates some kind of disaster. */
5179 if (recipients_list == NULL)
5181 (void)close(deliver_datafile);
5182 deliver_datafile = -1;
5183 log_write(0, LOG_MAIN, "Spool error: no recipients for %s", spoolname);
5184 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5188 /* Handle a message that is frozen. There are a number of different things that
5189 can happen, but in the default situation, unless forced, no delivery is
5194 #ifdef SUPPORT_MOVE_FROZEN_MESSAGES
5195 /* Moving to another directory removes the message from Exim's view. Other
5196 tools must be used to deal with it. Logging of this action happens in
5197 spool_move_message() and its subfunctions. */
5199 if (move_frozen_messages &&
5200 spool_move_message(id, message_subdir, US"", US"F"))
5201 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5204 /* For all frozen messages (bounces or not), timeout_frozen_after sets the
5205 maximum time to keep messages that are frozen. Thaw if we reach it, with a
5206 flag causing all recipients to be failed. The time is the age of the
5207 message, not the time since freezing. */
5209 if (timeout_frozen_after > 0 && message_age >= timeout_frozen_after)
5211 log_write(0, LOG_MAIN, "cancelled by timeout_frozen_after");
5212 process_recipients = RECIP_FAIL_TIMEOUT;
5215 /* For bounce messages (and others with no sender), thaw if the error message
5216 ignore timer is exceeded. The message will be discarded if this delivery
5219 else if (sender_address[0] == 0 && message_age >= ignore_bounce_errors_after)
5221 log_write(0, LOG_MAIN, "Unfrozen by errmsg timer");
5224 /* If this is a bounce message, or there's no auto thaw, or we haven't
5225 reached the auto thaw time yet, and this delivery is not forced by an admin
5226 user, do not attempt delivery of this message. Note that forced is set for
5227 continuing messages down the same channel, in order to skip load checking and
5228 ignore hold domains, but we don't want unfreezing in that case. */
5232 if ((sender_address[0] == 0 ||
5234 now <= deliver_frozen_at + auto_thaw
5237 (!forced || !deliver_force_thaw || !admin_user ||
5238 continue_hostname != NULL
5241 (void)close(deliver_datafile);
5242 deliver_datafile = -1;
5243 log_write(L_skip_delivery, LOG_MAIN, "Message is frozen");
5244 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5247 /* If delivery was forced (by an admin user), assume a manual thaw.
5248 Otherwise it's an auto thaw. */
5252 deliver_manual_thaw = TRUE;
5253 log_write(0, LOG_MAIN, "Unfrozen by forced delivery");
5255 else log_write(0, LOG_MAIN, "Unfrozen by auto-thaw");
5258 /* We get here if any of the rules for unfreezing have triggered. */
5260 deliver_freeze = FALSE;
5261 update_spool = TRUE;
5265 /* Open the message log file if we are using them. This records details of
5266 deliveries, deferments, and failures for the benefit of the mail administrator.
5267 The log is not used by exim itself to track the progress of a message; that is
5268 done by rewriting the header spool file. */
5275 sprintf(CS spoolname, "%s/msglog/%s/%s", spool_directory, message_subdir, id);
5276 fd = open_msglog_file(spoolname, SPOOL_MODE, &error);
5280 log_write(0, LOG_MAIN|LOG_PANIC, "Couldn't %s message log %s: %s", error,
5281 spoolname, strerror(errno));
5282 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5285 /* Make a C stream out of it. */
5287 message_log = fdopen(fd, "a");
5288 if (message_log == NULL)
5290 log_write(0, LOG_MAIN|LOG_PANIC, "Couldn't fdopen message log %s: %s",
5291 spoolname, strerror(errno));
5292 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5297 /* If asked to give up on a message, log who did it, and set the action for all
5302 struct passwd *pw = getpwuid(real_uid);
5303 log_write(0, LOG_MAIN, "cancelled by %s", (pw != NULL)?
5304 US pw->pw_name : string_sprintf("uid %ld", (long int)real_uid));
5305 process_recipients = RECIP_FAIL;
5308 /* Otherwise, if there are too many Received: headers, fail all recipients. */
5310 else if (received_count > received_headers_max)
5311 process_recipients = RECIP_FAIL_LOOP;
5313 /* Otherwise, if a system-wide, address-independent message filter is
5314 specified, run it now, except in the case when we are failing all recipients as
5315 a result of timeout_frozen_after. If the system filter yields "delivered", then
5316 ignore the true recipients of the message. Failure of the filter file is
5317 logged, and the delivery attempt fails. */
5319 else if (system_filter != NULL && process_recipients != RECIP_FAIL_TIMEOUT)
5324 redirect_block redirect;
5326 if (system_filter_uid_set)
5328 ugid.uid = system_filter_uid;
5329 ugid.gid = system_filter_gid;
5330 ugid.uid_set = ugid.gid_set = TRUE;
5334 ugid.uid_set = ugid.gid_set = FALSE;
5337 return_path = sender_address;
5338 enable_dollar_recipients = TRUE; /* Permit $recipients in system filter */
5339 system_filtering = TRUE;
5341 /* Any error in the filter file causes a delivery to be abandoned. */
5343 redirect.string = system_filter;
5344 redirect.isfile = TRUE;
5345 redirect.check_owner = redirect.check_group = FALSE;
5346 redirect.owners = NULL;
5347 redirect.owngroups = NULL;
5349 redirect.modemask = 0;
5351 DEBUG(D_deliver|D_filter) debug_printf("running system filter\n");
5354 &redirect, /* Where the data is */
5355 RDO_DEFER | /* Turn on all the enabling options */
5356 RDO_FAIL | /* Leave off all the disabling options */
5361 NULL, /* No :include: restriction (not used in filter) */
5362 NULL, /* No sieve vacation directory (not sieve!) */
5363 NULL, /* No sieve enotify mailto owner (not sieve!) */
5364 NULL, /* No sieve user address (not sieve!) */
5365 NULL, /* No sieve subaddress (not sieve!) */
5366 &ugid, /* uid/gid data */
5367 &addr_new, /* Where to hang generated addresses */
5368 &filter_message, /* Where to put error message */
5369 NULL, /* Don't skip syntax errors */
5370 &filtertype, /* Will always be set to FILTER_EXIM for this call */
5371 US"system filter"); /* For error messages */
5373 DEBUG(D_deliver|D_filter) debug_printf("system filter returned %d\n", rc);
5375 if (rc == FF_ERROR || rc == FF_NONEXIST)
5377 (void)close(deliver_datafile);
5378 deliver_datafile = -1;
5379 log_write(0, LOG_MAIN|LOG_PANIC, "Error in system filter: %s",
5380 string_printing(filter_message));
5381 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5384 /* Reset things. If the filter message is an empty string, which can happen
5385 for a filter "fail" or "freeze" command with no text, reset it to NULL. */
5387 system_filtering = FALSE;
5388 enable_dollar_recipients = FALSE;
5389 if (filter_message != NULL && filter_message[0] == 0) filter_message = NULL;
5391 /* Save the values of the system filter variables so that user filters
5394 memcpy(filter_sn, filter_n, sizeof(filter_sn));
5396 /* The filter can request that delivery of the original addresses be
5401 process_recipients = RECIP_DEFER;
5402 deliver_msglog("Delivery deferred by system filter\n");
5403 log_write(0, LOG_MAIN, "Delivery deferred by system filter");
5406 /* The filter can request that a message be frozen, but this does not
5407 take place if the message has been manually thawed. In that case, we must
5408 unset "delivered", which is forced by the "freeze" command to make -bF
5411 else if (rc == FF_FREEZE && !deliver_manual_thaw)
5413 deliver_freeze = TRUE;
5414 deliver_frozen_at = time(NULL);
5415 process_recipients = RECIP_DEFER;
5416 frozen_info = string_sprintf(" by the system filter%s%s",
5417 (filter_message == NULL)? US"" : US": ",
5418 (filter_message == NULL)? US"" : filter_message);
5421 /* The filter can request that a message be failed. The error message may be
5422 quite long - it is sent back to the sender in the bounce - but we don't want
5423 to fill up the log with repetitions of it. If it starts with << then the text
5424 between << and >> is written to the log, with the rest left for the bounce
5427 else if (rc == FF_FAIL)
5429 uschar *colon = US"";
5430 uschar *logmsg = US"";
5433 process_recipients = RECIP_FAIL_FILTER;
5435 if (filter_message != NULL)
5439 if (filter_message[0] == '<' && filter_message[1] == '<' &&
5440 (logend = Ustrstr(filter_message, ">>")) != NULL)
5442 logmsg = filter_message + 2;
5443 loglen = logend - logmsg;
5444 filter_message = logend + 2;
5445 if (filter_message[0] == 0) filter_message = NULL;
5449 logmsg = filter_message;
5450 loglen = Ustrlen(filter_message);
5454 log_write(0, LOG_MAIN, "cancelled by system filter%s%.*s", colon, loglen,
5458 /* Delivery can be restricted only to those recipients (if any) that the
5459 filter specified. */
5461 else if (rc == FF_DELIVERED)
5463 process_recipients = RECIP_IGNORE;
5464 if (addr_new == NULL)
5465 log_write(0, LOG_MAIN, "=> discarded (system filter)");
5467 log_write(0, LOG_MAIN, "original recipients ignored (system filter)");
5470 /* If any new addresses were created by the filter, fake up a "parent"
5471 for them. This is necessary for pipes, etc., which are expected to have
5472 parents, and it also gives some sensible logging for others. Allow
5473 pipes, files, and autoreplies, and run them as the filter uid if set,
5474 otherwise as the current uid. */
5476 if (addr_new != NULL)
5478 int uid = (system_filter_uid_set)? system_filter_uid : geteuid();
5479 int gid = (system_filter_gid_set)? system_filter_gid : getegid();
5481 /* The text "system-filter" is tested in transport_set_up_command() and in
5482 set_up_shell_command() in the pipe transport, to enable them to permit
5483 $recipients, so don't change it here without also changing it there. */
5485 address_item *p = addr_new;
5486 address_item *parent = deliver_make_addr(US"system-filter", FALSE);
5488 parent->domain = string_copylc(qualify_domain_recipient);
5489 parent->local_part = US"system-filter";
5491 /* As part of this loop, we arrange for addr_last to end up pointing
5492 at the final address. This is used if we go on to add addresses for the
5493 original recipients. */
5497 if (parent->child_count == SHRT_MAX)
5498 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "system filter generated more "
5499 "than %d delivery addresses", SHRT_MAX);
5500 parent->child_count++;
5503 if (testflag(p, af_pfr))
5509 setflag(p, af_uid_set |
5515 /* Find the name of the system filter's appropriate pfr transport */
5517 if (p->address[0] == '|')
5520 tpname = system_filter_pipe_transport;
5521 address_pipe = p->address;
5523 else if (p->address[0] == '>')
5526 tpname = system_filter_reply_transport;
5530 if (p->address[Ustrlen(p->address)-1] == '/')
5532 type = US"directory";
5533 tpname = system_filter_directory_transport;
5538 tpname = system_filter_file_transport;
5540 address_file = p->address;
5543 /* Now find the actual transport, first expanding the name. We have
5544 set address_file or address_pipe above. */
5548 uschar *tmp = expand_string(tpname);
5549 address_file = address_pipe = NULL;
5551 p->message = string_sprintf("failed to expand \"%s\" as a "
5552 "system filter transport name", tpname);
5557 p->message = string_sprintf("system_filter_%s_transport is unset",
5563 transport_instance *tp;
5564 for (tp = transports; tp != NULL; tp = tp->next)
5566 if (Ustrcmp(tp->name, tpname) == 0)
5573 p->message = string_sprintf("failed to find \"%s\" transport "
5574 "for system filter delivery", tpname);
5577 /* If we couldn't set up a transport, defer the delivery, putting the
5578 error on the panic log as well as the main log. */
5580 if (p->transport == NULL)
5582 address_item *badp = p;
5584 if (addr_last == NULL) addr_new = p; else addr_last->next = p;
5585 badp->local_part = badp->address; /* Needed for log line */
5586 post_process_one(badp, DEFER, LOG_MAIN|LOG_PANIC, DTYPE_ROUTER, 0);
5589 } /* End of pfr handling */
5591 /* Either a non-pfr delivery, or we found a transport */
5593 DEBUG(D_deliver|D_filter)
5594 debug_printf("system filter added %s\n", p->address);
5598 } /* Loop through all addr_new addresses */
5603 /* Scan the recipients list, and for every one that is not in the non-
5604 recipients tree, add an addr item to the chain of new addresses. If the pno
5605 value is non-negative, we must set the onetime parent from it. This which
5606 points to the relevant entry in the recipients list.
5608 This processing can be altered by the setting of the process_recipients
5609 variable, which is changed if recipients are to be ignored, failed, or
5610 deferred. This can happen as a result of system filter activity, or if the -Mg
5611 option is used to fail all of them.
5613 Duplicate addresses are handled later by a different tree structure; we can't
5614 just extend the non-recipients tree, because that will be re-written to the
5615 spool if the message is deferred, and in any case there are casing
5616 complications for local addresses. */
5618 if (process_recipients != RECIP_IGNORE)
5620 for (i = 0; i < recipients_count; i++)
5622 if (tree_search(tree_nonrecipients, recipients_list[i].address) == NULL)
5624 recipient_item *r = recipients_list + i;
5625 address_item *new = deliver_make_addr(r->address, FALSE);
5626 new->prop.errors_address = r->errors_to;
5627 #ifdef EXPERIMENTAL_INTERNATIONAL
5628 if ((new->prop.utf8_msg = message_smtputf8))
5630 new->prop.utf8_downcvt = message_utf8_downconvert == 1;
5631 new->prop.utf8_downcvt_maybe = message_utf8_downconvert == -1;
5632 DEBUG(D_deliver) debug_printf("utf8, downconvert %s\n",
5633 new->prop.utf8_downcvt ? "yes"
5634 : new->prop.utf8_downcvt_maybe ? "ifneeded"
5640 new->onetime_parent = recipients_list[r->pno].address;
5642 /* If DSN support is enabled, set the dsn flags and the original receipt
5643 to be passed on to other DSN enabled MTAs */
5644 new->dsn_flags = r->dsn_flags & rf_dsnflags;
5645 new->dsn_orcpt = r->orcpt;
5646 DEBUG(D_deliver) debug_printf("DSN: set orcpt: %s flags: %d\n",
5647 new->dsn_orcpt, new->dsn_flags);
5649 switch (process_recipients)
5651 /* RECIP_DEFER is set when a system filter freezes a message. */
5654 new->next = addr_defer;
5659 /* RECIP_FAIL_FILTER is set when a system filter has obeyed a "fail"
5662 case RECIP_FAIL_FILTER:
5664 (filter_message == NULL)? US"delivery cancelled" : filter_message;
5665 setflag(new, af_pass_message);
5666 goto RECIP_QUEUE_FAILED; /* below */
5669 /* RECIP_FAIL_TIMEOUT is set when a message is frozen, but is older
5670 than the value in timeout_frozen_after. Treat non-bounce messages
5671 similarly to -Mg; for bounce messages we just want to discard, so
5672 don't put the address on the failed list. The timeout has already
5675 case RECIP_FAIL_TIMEOUT:
5676 new->message = US"delivery cancelled; message timed out";
5677 goto RECIP_QUEUE_FAILED; /* below */
5680 /* RECIP_FAIL is set when -Mg has been used. */
5683 new->message = US"delivery cancelled by administrator";
5686 /* Common code for the failure cases above. If this is not a bounce
5687 message, put the address on the failed list so that it is used to
5688 create a bounce. Otherwise do nothing - this just discards the address.
5689 The incident has already been logged. */
5692 if (sender_address[0] != 0)
5694 new->next = addr_failed;
5700 /* RECIP_FAIL_LOOP is set when there are too many Received: headers
5701 in the message. Process each address as a routing failure; if this
5702 is a bounce message, it will get frozen. */
5704 case RECIP_FAIL_LOOP:
5705 new->message = US"Too many \"Received\" headers - suspected mail loop";
5706 post_process_one(new, FAIL, LOG_MAIN, DTYPE_ROUTER, 0);
5710 /* Value should be RECIP_ACCEPT; take this as the safe default. */
5713 if (addr_new == NULL) addr_new = new; else addr_last->next = new;
5718 #ifdef EXPERIMENTAL_EVENT
5719 if (process_recipients != RECIP_ACCEPT)
5721 uschar * save_local = deliver_localpart;
5722 const uschar * save_domain = deliver_domain;
5724 deliver_localpart = expand_string(
5725 string_sprintf("${local_part:%s}", new->address));
5726 deliver_domain = expand_string(
5727 string_sprintf("${domain:%s}", new->address));
5729 (void) event_raise(event_action,
5730 US"msg:fail:internal", new->message);
5732 deliver_localpart = save_local;
5733 deliver_domain = save_domain;
5742 address_item *p = addr_new;
5743 debug_printf("Delivery address list:\n");
5746 debug_printf(" %s %s\n", p->address, (p->onetime_parent == NULL)? US"" :
5752 /* Set up the buffers used for copying over the file when delivering. */
5754 deliver_in_buffer = store_malloc(DELIVER_IN_BUFFER_SIZE);
5755 deliver_out_buffer = store_malloc(DELIVER_OUT_BUFFER_SIZE);
5759 /* Until there are no more new addresses, handle each one as follows:
5761 . If this is a generated address (indicated by the presence of a parent
5762 pointer) then check to see whether it is a pipe, file, or autoreply, and
5763 if so, handle it directly here. The router that produced the address will
5764 have set the allow flags into the address, and also set the uid/gid required.
5765 Having the routers generate new addresses and then checking them here at
5766 the outer level is tidier than making each router do the checking, and
5767 means that routers don't need access to the failed address queue.
5769 . Break up the address into local part and domain, and make lowercased
5770 versions of these strings. We also make unquoted versions of the local part.
5772 . Handle the percent hack for those domains for which it is valid.
5774 . For child addresses, determine if any of the parents have the same address.
5775 If so, generate a different string for previous delivery checking. Without
5776 this code, if the address spqr generates spqr via a forward or alias file,
5777 delivery of the generated spqr stops further attempts at the top level spqr,
5778 which is not what is wanted - it may have generated other addresses.
5780 . Check on the retry database to see if routing was previously deferred, but
5781 only if in a queue run. Addresses that are to be routed are put on the
5782 addr_route chain. Addresses that are to be deferred are put on the
5783 addr_defer chain. We do all the checking first, so as not to keep the
5784 retry database open any longer than necessary.
5786 . Now we run the addresses through the routers. A router may put the address
5787 on either the addr_local or the addr_remote chain for local or remote
5788 delivery, respectively, or put it on the addr_failed chain if it is
5789 undeliveable, or it may generate child addresses and put them on the
5790 addr_new chain, or it may defer an address. All the chain anchors are
5791 passed as arguments so that the routers can be called for verification
5794 . If new addresses have been generated by the routers, da capo.
5797 header_rewritten = FALSE; /* No headers rewritten yet */
5798 while (addr_new != NULL) /* Loop until all addresses dealt with */
5800 address_item *addr, *parent;
5801 dbm_file = dbfn_open(US"retry", O_RDONLY, &dbblock, FALSE);
5803 /* Failure to open the retry database is treated the same as if it does
5804 not exist. In both cases, dbm_file is NULL. */
5806 if (dbm_file == NULL)
5808 DEBUG(D_deliver|D_retry|D_route|D_hints_lookup)
5809 debug_printf("no retry data available\n");
5812 /* Scan the current batch of new addresses, to handle pipes, files and
5813 autoreplies, and determine which others are ready for routing. */
5815 while (addr_new != NULL)
5820 dbdata_retry *domain_retry_record;
5821 dbdata_retry *address_retry_record;
5824 addr_new = addr->next;
5826 DEBUG(D_deliver|D_retry|D_route)
5828 debug_printf(">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>\n");
5829 debug_printf("Considering: %s\n", addr->address);
5832 /* Handle generated address that is a pipe or a file or an autoreply. */
5834 if (testflag(addr, af_pfr))
5836 /* If an autoreply in a filter could not generate a syntactically valid
5837 address, give up forthwith. Set af_ignore_error so that we don't try to
5838 generate a bounce. */
5840 if (testflag(addr, af_bad_reply))
5842 addr->basic_errno = ERRNO_BADADDRESS2;
5843 addr->local_part = addr->address;
5845 US"filter autoreply generated syntactically invalid recipient";
5846 setflag(addr, af_ignore_error);
5847 (void)post_process_one(addr, FAIL, LOG_MAIN, DTYPE_ROUTER, 0);
5848 continue; /* with the next new address */
5851 /* If two different users specify delivery to the same pipe or file or
5852 autoreply, there should be two different deliveries, so build a unique
5853 string that incorporates the original address, and use this for
5854 duplicate testing and recording delivery, and also for retrying. */
5857 string_sprintf("%s:%s", addr->address, addr->parent->unique +
5858 (testflag(addr->parent, af_homonym)? 3:0));
5860 addr->address_retry_key = addr->domain_retry_key =
5861 string_sprintf("T:%s", addr->unique);
5863 /* If a filter file specifies two deliveries to the same pipe or file,
5864 we want to de-duplicate, but this is probably not wanted for two mail
5865 commands to the same address, where probably both should be delivered.
5866 So, we have to invent a different unique string in that case. Just
5867 keep piling '>' characters on the front. */
5869 if (addr->address[0] == '>')
5871 while (tree_search(tree_duplicates, addr->unique) != NULL)
5872 addr->unique = string_sprintf(">%s", addr->unique);
5875 else if ((tnode = tree_search(tree_duplicates, addr->unique)) != NULL)
5877 DEBUG(D_deliver|D_route)
5878 debug_printf("%s is a duplicate address: discarded\n", addr->address);
5879 addr->dupof = tnode->data.ptr;
5880 addr->next = addr_duplicate;
5881 addr_duplicate = addr;
5885 DEBUG(D_deliver|D_route) debug_printf("unique = %s\n", addr->unique);
5887 /* Check for previous delivery */
5889 if (tree_search(tree_nonrecipients, addr->unique) != NULL)
5891 DEBUG(D_deliver|D_route)
5892 debug_printf("%s was previously delivered: discarded\n", addr->address);
5893 child_done(addr, tod_stamp(tod_log));
5897 /* Save for checking future duplicates */
5899 tree_add_duplicate(addr->unique, addr);
5901 /* Set local part and domain */
5903 addr->local_part = addr->address;
5904 addr->domain = addr->parent->domain;
5906 /* Ensure that the delivery is permitted. */
5908 if (testflag(addr, af_file))
5910 if (!testflag(addr, af_allow_file))
5912 addr->basic_errno = ERRNO_FORBIDFILE;
5913 addr->message = US"delivery to file forbidden";
5914 (void)post_process_one(addr, FAIL, LOG_MAIN, DTYPE_ROUTER, 0);
5915 continue; /* with the next new address */
5918 else if (addr->address[0] == '|')
5920 if (!testflag(addr, af_allow_pipe))
5922 addr->basic_errno = ERRNO_FORBIDPIPE;
5923 addr->message = US"delivery to pipe forbidden";
5924 (void)post_process_one(addr, FAIL, LOG_MAIN, DTYPE_ROUTER, 0);
5925 continue; /* with the next new address */
5928 else if (!testflag(addr, af_allow_reply))
5930 addr->basic_errno = ERRNO_FORBIDREPLY;
5931 addr->message = US"autoreply forbidden";
5932 (void)post_process_one(addr, FAIL, LOG_MAIN, DTYPE_ROUTER, 0);
5933 continue; /* with the next new address */
5936 /* If the errno field is already set to BADTRANSPORT, it indicates
5937 failure to expand a transport string, or find the associated transport,
5938 or an unset transport when one is required. Leave this test till now so
5939 that the forbid errors are given in preference. */
5941 if (addr->basic_errno == ERRNO_BADTRANSPORT)
5943 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_ROUTER, 0);
5947 /* Treat /dev/null as a special case and abandon the delivery. This
5948 avoids having to specify a uid on the transport just for this case.
5949 Arrange for the transport name to be logged as "**bypassed**". */
5951 if (Ustrcmp(addr->address, "/dev/null") == 0)
5953 uschar *save = addr->transport->name;
5954 addr->transport->name = US"**bypassed**";
5955 (void)post_process_one(addr, OK, LOG_MAIN, DTYPE_TRANSPORT, '=');
5956 addr->transport->name = save;
5957 continue; /* with the next new address */
5960 /* Pipe, file, or autoreply delivery is to go ahead as a normal local
5963 DEBUG(D_deliver|D_route)
5964 debug_printf("queued for %s transport\n", addr->transport->name);
5965 addr->next = addr_local;
5967 continue; /* with the next new address */
5970 /* Handle normal addresses. First, split up into local part and domain,
5971 handling the %-hack if necessary. There is the possibility of a defer from
5972 a lookup in percent_hack_domains. */
5974 if ((rc = deliver_split_address(addr)) == DEFER)
5976 addr->message = US"cannot check percent_hack_domains";
5977 addr->basic_errno = ERRNO_LISTDEFER;
5978 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_NONE, 0);
5982 /* Check to see if the domain is held. If so, proceed only if the
5983 delivery was forced by hand. */
5985 deliver_domain = addr->domain; /* set $domain */
5986 if (!forced && hold_domains != NULL &&
5987 (rc = match_isinlist(addr->domain, (const uschar **)&hold_domains, 0,
5988 &domainlist_anchor, addr->domain_cache, MCL_DOMAIN, TRUE,
5993 addr->message = US"hold_domains lookup deferred";
5994 addr->basic_errno = ERRNO_LISTDEFER;
5998 addr->message = US"domain is held";
5999 addr->basic_errno = ERRNO_HELD;
6001 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_NONE, 0);
6005 /* Now we can check for duplicates and previously delivered addresses. In
6006 order to do this, we have to generate a "unique" value for each address,
6007 because there may be identical actual addresses in a line of descendents.
6008 The "unique" field is initialized to the same value as the "address" field,
6009 but gets changed here to cope with identically-named descendents. */
6011 for (parent = addr->parent; parent != NULL; parent = parent->parent)
6012 if (strcmpic(addr->address, parent->address) == 0) break;
6014 /* If there's an ancestor with the same name, set the homonym flag. This
6015 influences how deliveries are recorded. Then add a prefix on the front of
6016 the unique address. We use \n\ where n starts at 0 and increases each time.
6017 It is unlikely to pass 9, but if it does, it may look odd but will still
6018 work. This means that siblings or cousins with the same names are treated
6019 as duplicates, which is what we want. */
6023 setflag(addr, af_homonym);
6024 if (parent->unique[0] != '\\')
6025 addr->unique = string_sprintf("\\0\\%s", addr->address);
6027 addr->unique = string_sprintf("\\%c\\%s", parent->unique[1] + 1,
6031 /* Ensure that the domain in the unique field is lower cased, because
6032 domains are always handled caselessly. */
6034 p = Ustrrchr(addr->unique, '@');
6035 while (*p != 0) { *p = tolower(*p); p++; }
6037 DEBUG(D_deliver|D_route) debug_printf("unique = %s\n", addr->unique);
6039 if (tree_search(tree_nonrecipients, addr->unique) != NULL)
6041 DEBUG(D_deliver|D_route)
6042 debug_printf("%s was previously delivered: discarded\n", addr->unique);
6043 child_done(addr, tod_stamp(tod_log));
6047 /* Get the routing retry status, saving the two retry keys (with and
6048 without the local part) for subsequent use. If there is no retry record for
6049 the standard address routing retry key, we look for the same key with the
6050 sender attached, because this form is used by the smtp transport after a
6051 4xx response to RCPT when address_retry_include_sender is true. */
6053 addr->domain_retry_key = string_sprintf("R:%s", addr->domain);
6054 addr->address_retry_key = string_sprintf("R:%s@%s", addr->local_part,
6057 if (dbm_file == NULL)
6058 domain_retry_record = address_retry_record = NULL;
6061 domain_retry_record = dbfn_read(dbm_file, addr->domain_retry_key);
6062 if (domain_retry_record != NULL &&
6063 now - domain_retry_record->time_stamp > retry_data_expire)
6064 domain_retry_record = NULL; /* Ignore if too old */
6066 address_retry_record = dbfn_read(dbm_file, addr->address_retry_key);
6067 if (address_retry_record != NULL &&
6068 now - address_retry_record->time_stamp > retry_data_expire)
6069 address_retry_record = NULL; /* Ignore if too old */
6071 if (address_retry_record == NULL)
6073 uschar *altkey = string_sprintf("%s:<%s>", addr->address_retry_key,
6075 address_retry_record = dbfn_read(dbm_file, altkey);
6076 if (address_retry_record != NULL &&
6077 now - address_retry_record->time_stamp > retry_data_expire)
6078 address_retry_record = NULL; /* Ignore if too old */
6082 DEBUG(D_deliver|D_retry)
6084 if (domain_retry_record == NULL)
6085 debug_printf("no domain retry record\n");
6086 if (address_retry_record == NULL)
6087 debug_printf("no address retry record\n");
6090 /* If we are sending a message down an existing SMTP connection, we must
6091 assume that the message which created the connection managed to route
6092 an address to that connection. We do not want to run the risk of taking
6093 a long time over routing here, because if we do, the server at the other
6094 end of the connection may time it out. This is especially true for messages
6095 with lots of addresses. For this kind of delivery, queue_running is not
6096 set, so we would normally route all addresses. We take a pragmatic approach
6097 and defer routing any addresses that have any kind of domain retry record.
6098 That is, we don't even look at their retry times. It doesn't matter if this
6099 doesn't work occasionally. This is all just an optimization, after all.
6101 The reason for not doing the same for address retries is that they normally
6102 arise from 4xx responses, not DNS timeouts. */
6104 if (continue_hostname != NULL && domain_retry_record != NULL)
6106 addr->message = US"reusing SMTP connection skips previous routing defer";
6107 addr->basic_errno = ERRNO_RRETRY;
6108 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_ROUTER, 0);
6111 /* If we are in a queue run, defer routing unless there is no retry data or
6112 we've passed the next retry time, or this message is forced. In other
6113 words, ignore retry data when not in a queue run.
6115 However, if the domain retry time has expired, always allow the routing
6116 attempt. If it fails again, the address will be failed. This ensures that
6117 each address is routed at least once, even after long-term routing
6120 If there is an address retry, check that too; just wait for the next
6121 retry time. This helps with the case when the temporary error on the
6122 address was really message-specific rather than address specific, since
6123 it allows other messages through.
6125 We also wait for the next retry time if this is a message sent down an
6126 existing SMTP connection (even though that will be forced). Otherwise there
6127 will be far too many attempts for an address that gets a 4xx error. In
6128 fact, after such an error, we should not get here because, the host should
6129 not be remembered as one this message needs. However, there was a bug that
6130 used to cause this to happen, so it is best to be on the safe side.
6132 Even if we haven't reached the retry time in the hints, there is one more
6133 check to do, which is for the ultimate address timeout. We only do this
6134 check if there is an address retry record and there is not a domain retry
6135 record; this implies that previous attempts to handle the address had the
6136 retry_use_local_parts option turned on. We use this as an approximation
6137 for the destination being like a local delivery, for example delivery over
6138 LMTP to an IMAP message store. In this situation users are liable to bump
6139 into their quota and thereby have intermittently successful deliveries,
6140 which keep the retry record fresh, which can lead to us perpetually
6141 deferring messages. */
6143 else if (((queue_running && !deliver_force) || continue_hostname != NULL)
6145 ((domain_retry_record != NULL &&
6146 now < domain_retry_record->next_try &&
6147 !domain_retry_record->expired)
6149 (address_retry_record != NULL &&
6150 now < address_retry_record->next_try))
6152 (domain_retry_record != NULL ||
6153 address_retry_record == NULL ||
6154 !retry_ultimate_address_timeout(addr->address_retry_key,
6155 addr->domain, address_retry_record, now)))
6157 addr->message = US"retry time not reached";
6158 addr->basic_errno = ERRNO_RRETRY;
6159 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_ROUTER, 0);
6162 /* The domain is OK for routing. Remember if retry data exists so it
6163 can be cleaned up after a successful delivery. */
6167 if (domain_retry_record != NULL || address_retry_record != NULL)
6168 setflag(addr, af_dr_retry_exists);
6169 addr->next = addr_route;
6171 DEBUG(D_deliver|D_route)
6172 debug_printf("%s: queued for routing\n", addr->address);
6176 /* The database is closed while routing is actually happening. Requests to
6177 update it are put on a chain and all processed together at the end. */
6179 if (dbm_file != NULL) dbfn_close(dbm_file);
6181 /* If queue_domains is set, we don't even want to try routing addresses in
6182 those domains. During queue runs, queue_domains is forced to be unset.
6183 Optimize by skipping this pass through the addresses if nothing is set. */
6185 if (!deliver_force && queue_domains != NULL)
6187 address_item *okaddr = NULL;
6188 while (addr_route != NULL)
6190 address_item *addr = addr_route;
6191 addr_route = addr->next;
6193 deliver_domain = addr->domain; /* set $domain */
6194 if ((rc = match_isinlist(addr->domain, (const uschar **)&queue_domains, 0,
6195 &domainlist_anchor, addr->domain_cache, MCL_DOMAIN, TRUE, NULL))
6200 addr->basic_errno = ERRNO_LISTDEFER;
6201 addr->message = US"queue_domains lookup deferred";
6202 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_ROUTER, 0);
6206 addr->next = okaddr;
6212 addr->basic_errno = ERRNO_QUEUE_DOMAIN;
6213 addr->message = US"domain is in queue_domains";
6214 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_ROUTER, 0);
6218 addr_route = okaddr;
6221 /* Now route those addresses that are not deferred. */
6223 while (addr_route != NULL)
6226 address_item *addr = addr_route;
6227 const uschar *old_domain = addr->domain;
6228 uschar *old_unique = addr->unique;
6229 addr_route = addr->next;
6232 /* Just in case some router parameter refers to it. */
6234 return_path = (addr->prop.errors_address != NULL)?
6235 addr->prop.errors_address : sender_address;
6237 /* If a router defers an address, add a retry item. Whether or not to
6238 use the local part in the key is a property of the router. */
6240 if ((rc = route_address(addr, &addr_local, &addr_remote, &addr_new,
6241 &addr_succeed, v_none)) == DEFER)
6242 retry_add_item(addr, (addr->router->retry_use_local_part)?
6243 string_sprintf("R:%s@%s", addr->local_part, addr->domain) :
6244 string_sprintf("R:%s", addr->domain), 0);
6246 /* Otherwise, if there is an existing retry record in the database, add
6247 retry items to delete both forms. We must also allow for the possibility
6248 of a routing retry that includes the sender address. Since the domain might
6249 have been rewritten (expanded to fully qualified) as a result of routing,
6250 ensure that the rewritten form is also deleted. */
6252 else if (testflag(addr, af_dr_retry_exists))
6254 uschar *altkey = string_sprintf("%s:<%s>", addr->address_retry_key,
6256 retry_add_item(addr, altkey, rf_delete);
6257 retry_add_item(addr, addr->address_retry_key, rf_delete);
6258 retry_add_item(addr, addr->domain_retry_key, rf_delete);
6259 if (Ustrcmp(addr->domain, old_domain) != 0)
6260 retry_add_item(addr, string_sprintf("R:%s", old_domain), rf_delete);
6263 /* DISCARD is given for :blackhole: and "seen finish". The event has been
6264 logged, but we need to ensure the address (and maybe parents) is marked
6269 address_done(addr, tod_stamp(tod_log));
6270 continue; /* route next address */
6273 /* The address is finished with (failed or deferred). */
6277 (void)post_process_one(addr, rc, LOG_MAIN, DTYPE_ROUTER, 0);
6278 continue; /* route next address */
6281 /* The address has been routed. If the router changed the domain, it will
6282 also have changed the unique address. We have to test whether this address
6283 has already been delivered, because it's the unique address that finally
6286 if (addr->unique != old_unique &&
6287 tree_search(tree_nonrecipients, addr->unique) != 0)
6289 DEBUG(D_deliver|D_route) debug_printf("%s was previously delivered: "
6290 "discarded\n", addr->address);
6291 if (addr_remote == addr) addr_remote = addr->next;
6292 else if (addr_local == addr) addr_local = addr->next;
6295 /* If the router has same_domain_copy_routing set, we are permitted to copy
6296 the routing for any other addresses with the same domain. This is an
6297 optimisation to save repeated DNS lookups for "standard" remote domain
6298 routing. The option is settable only on routers that generate host lists.
6299 We play it very safe, and do the optimization only if the address is routed
6300 to a remote transport, there are no header changes, and the domain was not
6301 modified by the router. */
6303 if (addr_remote == addr &&
6304 addr->router->same_domain_copy_routing &&
6305 addr->prop.extra_headers == NULL &&
6306 addr->prop.remove_headers == NULL &&
6307 old_domain == addr->domain)
6309 address_item **chain = &addr_route;
6310 while (*chain != NULL)
6312 address_item *addr2 = *chain;
6313 if (Ustrcmp(addr2->domain, addr->domain) != 0)
6315 chain = &(addr2->next);
6319 /* Found a suitable address; take it off the routing list and add it to
6320 the remote delivery list. */
6322 *chain = addr2->next;
6323 addr2->next = addr_remote;
6324 addr_remote = addr2;
6326 /* Copy the routing data */
6328 addr2->domain = addr->domain;
6329 addr2->router = addr->router;
6330 addr2->transport = addr->transport;
6331 addr2->host_list = addr->host_list;
6332 addr2->fallback_hosts = addr->fallback_hosts;
6333 addr2->prop.errors_address = addr->prop.errors_address;
6334 copyflag(addr2, addr, af_hide_child | af_local_host_removed);
6336 DEBUG(D_deliver|D_route)
6338 debug_printf(">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>\n"
6340 "Routing for %s copied from %s\n",
6341 addr2->address, addr2->address, addr->address);
6345 } /* Continue with routing the next address. */
6346 } /* Loop to process any child addresses that the routers created, and
6347 any rerouted addresses that got put back on the new chain. */
6350 /* Debugging: show the results of the routing */
6352 DEBUG(D_deliver|D_retry|D_route)
6354 address_item *p = addr_local;
6355 debug_printf(">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>\n");
6356 debug_printf("After routing:\n Local deliveries:\n");
6359 debug_printf(" %s\n", p->address);
6364 debug_printf(" Remote deliveries:\n");
6367 debug_printf(" %s\n", p->address);
6372 debug_printf(" Failed addresses:\n");
6375 debug_printf(" %s\n", p->address);
6380 debug_printf(" Deferred addresses:\n");
6383 debug_printf(" %s\n", p->address);
6388 /* Free any resources that were cached during routing. */
6393 /* These two variables are set only during routing, after check_local_user.
6394 Ensure they are not set in transports. */
6396 local_user_gid = (gid_t)(-1);
6397 local_user_uid = (uid_t)(-1);
6399 /* Check for any duplicate addresses. This check is delayed until after
6400 routing, because the flexibility of the routing configuration means that
6401 identical addresses with different parentage may end up being redirected to
6402 different addresses. Checking for duplicates too early (as we previously used
6403 to) makes this kind of thing not work. */
6405 do_duplicate_check(&addr_local);
6406 do_duplicate_check(&addr_remote);
6408 /* When acting as an MUA wrapper, we proceed only if all addresses route to a
6409 remote transport. The check that they all end up in one transaction happens in
6410 the do_remote_deliveries() function. */
6412 if (mua_wrapper && (addr_local != NULL || addr_failed != NULL ||
6413 addr_defer != NULL))
6416 uschar *which, *colon, *msg;
6418 if (addr_local != NULL)
6423 else if (addr_defer != NULL)
6426 which = US"deferred";
6434 while (addr->parent != NULL) addr = addr->parent;
6436 if (addr->message != NULL)
6439 msg = addr->message;
6441 else colon = msg = US"";
6443 /* We don't need to log here for a forced failure as it will already
6444 have been logged. Defer will also have been logged, but as a defer, so we do
6445 need to do the failure logging. */
6447 if (addr != addr_failed)
6448 log_write(0, LOG_MAIN, "** %s routing yielded a %s delivery",
6449 addr->address, which);
6451 /* Always write an error to the caller */
6453 fprintf(stderr, "routing %s yielded a %s delivery%s%s\n", addr->address,
6456 final_yield = DELIVER_MUA_FAILED;
6457 addr_failed = addr_defer = NULL; /* So that we remove the message */
6458 goto DELIVERY_TIDYUP;
6462 /* If this is a run to continue deliveries to an external channel that is
6463 already set up, defer any local deliveries. */
6465 if (continue_transport != NULL)
6467 if (addr_defer == NULL) addr_defer = addr_local; else
6469 address_item *addr = addr_defer;
6470 while (addr->next != NULL) addr = addr->next;
6471 addr->next = addr_local;
6477 /* Because address rewriting can happen in the routers, we should not really do
6478 ANY deliveries until all addresses have been routed, so that all recipients of
6479 the message get the same headers. However, this is in practice not always
6480 possible, since sometimes remote addresses give DNS timeouts for days on end.
6481 The pragmatic approach is to deliver what we can now, saving any rewritten
6482 headers so that at least the next lot of recipients benefit from the rewriting
6483 that has already been done.
6485 If any headers have been rewritten during routing, update the spool file to
6486 remember them for all subsequent deliveries. This can be delayed till later if
6487 there is only address to be delivered - if it succeeds the spool write need not
6490 if (header_rewritten &&
6491 ((addr_local != NULL &&
6492 (addr_local->next != NULL || addr_remote != NULL)) ||
6493 (addr_remote != NULL && addr_remote->next != NULL)))
6495 /* Panic-dies on error */
6496 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
6497 header_rewritten = FALSE;
6501 /* If there are any deliveries to be done, open the journal file. This is used
6502 to record successful deliveries as soon as possible after each delivery is
6503 known to be complete. A file opened with O_APPEND is used so that several
6504 processes can run simultaneously.
6506 The journal is just insurance against crashes. When the spool file is
6507 ultimately updated at the end of processing, the journal is deleted. If a
6508 journal is found to exist at the start of delivery, the addresses listed
6509 therein are added to the non-recipients. */
6511 if (addr_local != NULL || addr_remote != NULL)
6513 sprintf(CS spoolname, "%s/input/%s/%s-J", spool_directory, message_subdir, id);
6514 journal_fd = Uopen(spoolname, O_WRONLY|O_APPEND|O_CREAT, SPOOL_MODE);
6518 log_write(0, LOG_MAIN|LOG_PANIC, "Couldn't open journal file %s: %s",
6519 spoolname, strerror(errno));
6520 return DELIVER_NOT_ATTEMPTED;
6523 /* Set the close-on-exec flag, make the file owned by Exim, and ensure
6524 that the mode is correct - the group setting doesn't always seem to get
6525 set automatically. */
6527 if( fcntl(journal_fd, F_SETFD, fcntl(journal_fd, F_GETFD) | FD_CLOEXEC)
6528 || fchown(journal_fd, exim_uid, exim_gid)
6529 || fchmod(journal_fd, SPOOL_MODE)
6532 int ret = Uunlink(spoolname);
6533 log_write(0, LOG_MAIN|LOG_PANIC, "Couldn't set perms on journal file %s: %s",
6534 spoolname, strerror(errno));
6535 if(ret && errno != ENOENT)
6536 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s",
6537 spoolname, strerror(errno));
6538 return DELIVER_NOT_ATTEMPTED;
6544 /* Now we can get down to the business of actually doing deliveries. Local
6545 deliveries are done first, then remote ones. If ever the problems of how to
6546 handle fallback transports are figured out, this section can be put into a loop
6547 for handling fallbacks, though the uid switching will have to be revised. */
6549 /* Precompile a regex that is used to recognize a parameter in response
6550 to an LHLO command, if is isn't already compiled. This may be used on both
6551 local and remote LMTP deliveries. */
6553 if (regex_IGNOREQUOTA == NULL) regex_IGNOREQUOTA =
6554 regex_must_compile(US"\\n250[\\s\\-]IGNOREQUOTA(\\s|\\n|$)", FALSE, TRUE);
6556 /* Handle local deliveries */
6558 if (addr_local != NULL)
6560 DEBUG(D_deliver|D_transport)
6561 debug_printf(">>>>>>>>>>>>>>>> Local deliveries >>>>>>>>>>>>>>>>\n");
6562 do_local_deliveries();
6563 disable_logging = FALSE;
6566 /* If queue_run_local is set, we do not want to attempt any remote deliveries,
6567 so just queue them all. */
6569 if (queue_run_local)
6571 while (addr_remote != NULL)
6573 address_item *addr = addr_remote;
6574 addr_remote = addr->next;
6576 addr->basic_errno = ERRNO_LOCAL_ONLY;
6577 addr->message = US"remote deliveries suppressed";
6578 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_TRANSPORT, 0);
6582 /* Handle remote deliveries */
6584 if (addr_remote != NULL)
6586 DEBUG(D_deliver|D_transport)
6587 debug_printf(">>>>>>>>>>>>>>>> Remote deliveries >>>>>>>>>>>>>>>>\n");
6589 /* Precompile some regex that are used to recognize parameters in response
6590 to an EHLO command, if they aren't already compiled. */
6594 /* Now sort the addresses if required, and do the deliveries. The yield of
6595 do_remote_deliveries is FALSE when mua_wrapper is set and all addresses
6596 cannot be delivered in one transaction. */
6598 if (remote_sort_domains != NULL) sort_remote_deliveries();
6599 if (!do_remote_deliveries(FALSE))
6601 log_write(0, LOG_MAIN, "** mua_wrapper is set but recipients cannot all "
6602 "be delivered in one transaction");
6603 fprintf(stderr, "delivery to smarthost failed (configuration problem)\n");
6605 final_yield = DELIVER_MUA_FAILED;
6606 addr_failed = addr_defer = NULL; /* So that we remove the message */
6607 goto DELIVERY_TIDYUP;
6610 /* See if any of the addresses that failed got put on the queue for delivery
6611 to their fallback hosts. We do it this way because often the same fallback
6612 host is used for many domains, so all can be sent in a single transaction
6613 (if appropriately configured). */
6615 if (addr_fallback != NULL && !mua_wrapper)
6617 DEBUG(D_deliver) debug_printf("Delivering to fallback hosts\n");
6618 addr_remote = addr_fallback;
6619 addr_fallback = NULL;
6620 if (remote_sort_domains != NULL) sort_remote_deliveries();
6621 do_remote_deliveries(TRUE);
6623 disable_logging = FALSE;
6627 /* All deliveries are now complete. Ignore SIGTERM during this tidying up
6628 phase, to minimize cases of half-done things. */
6631 debug_printf(">>>>>>>>>>>>>>>> deliveries are done >>>>>>>>>>>>>>>>\n");
6633 /* Root privilege is no longer needed */
6635 exim_setugid(exim_uid, exim_gid, FALSE, US"post-delivery tidying");
6637 set_process_info("tidying up after delivering %s", message_id);
6638 signal(SIGTERM, SIG_IGN);
6640 /* When we are acting as an MUA wrapper, the smtp transport will either have
6641 succeeded for all addresses, or failed them all in normal cases. However, there
6642 are some setup situations (e.g. when a named port does not exist) that cause an
6643 immediate exit with deferral of all addresses. Convert those into failures. We
6644 do not ever want to retry, nor do we want to send a bounce message. */
6648 if (addr_defer != NULL)
6650 address_item *addr, *nextaddr;
6651 for (addr = addr_defer; addr != NULL; addr = nextaddr)
6653 log_write(0, LOG_MAIN, "** %s mua_wrapper forced failure for deferred "
6654 "delivery", addr->address);
6655 nextaddr = addr->next;
6656 addr->next = addr_failed;
6662 /* Now all should either have succeeded or failed. */
6664 if (addr_failed == NULL) final_yield = DELIVER_MUA_SUCCEEDED; else
6666 uschar *s = (addr_failed->user_message != NULL)?
6667 addr_failed->user_message : addr_failed->message;
6670 fprintf(stderr, "Delivery failed: ");
6671 if (addr_failed->basic_errno > 0)
6673 fprintf(stderr, "%s", strerror(addr_failed->basic_errno));
6674 if (s != NULL) fprintf(stderr, ": ");
6676 if ((host = addr_failed->host_used))
6677 fprintf(stderr, "H=%s [%s]: ", host->name, host->address);
6680 if (addr_failed->basic_errno <= 0) fprintf(stderr, "unknown error");
6682 else fprintf(stderr, "%s", CS s);
6683 fprintf(stderr, "\n");
6685 final_yield = DELIVER_MUA_FAILED;
6690 /* In a normal configuration, we now update the retry database. This is done in
6691 one fell swoop at the end in order not to keep opening and closing (and
6692 locking) the database. The code for handling retries is hived off into a
6693 separate module for convenience. We pass it the addresses of the various
6694 chains, because deferred addresses can get moved onto the failed chain if the
6695 retry cutoff time has expired for all alternative destinations. Bypass the
6696 updating of the database if the -N flag is set, which is a debugging thing that
6697 prevents actual delivery. */
6699 else if (!dont_deliver) retry_update(&addr_defer, &addr_failed, &addr_succeed);
6701 /* Send DSN for successful messages */
6702 addr_dsntmp = addr_succeed;
6703 addr_senddsn = NULL;
6707 /* af_ignore_error not honored here. it's not an error */
6710 debug_printf("DSN: processing router : %s\n"
6711 "DSN: processing successful delivery address: %s\n"
6712 "DSN: Sender_address: %s\n"
6713 "DSN: orcpt: %s flags: %d\n"
6714 "DSN: envid: %s ret: %d\n"
6715 "DSN: Final recipient: %s\n"
6716 "DSN: Remote SMTP server supports DSN: %d\n",
6717 addr_dsntmp->router->name,
6718 addr_dsntmp->address,
6720 addr_dsntmp->dsn_orcpt, addr_dsntmp->dsn_flags,
6722 addr_dsntmp->address,
6723 addr_dsntmp->dsn_aware
6727 /* send report if next hop not DSN aware or a router flagged "last DSN hop"
6728 and a report was requested */
6729 if ( ( addr_dsntmp->dsn_aware != dsn_support_yes
6730 || addr_dsntmp->dsn_flags & rf_dsnlasthop
6732 && addr_dsntmp->dsn_flags & rf_dsnflags
6733 && addr_dsntmp->dsn_flags & rf_notify_success
6736 /* copy and relink address_item and send report with all of them at once later */
6737 address_item *addr_next;
6738 addr_next = addr_senddsn;
6739 addr_senddsn = store_get(sizeof(address_item));
6740 memcpy(addr_senddsn, addr_dsntmp, sizeof(address_item));
6741 addr_senddsn->next = addr_next;
6744 DEBUG(D_deliver) debug_printf("DSN: not sending DSN success message\n");
6746 addr_dsntmp = addr_dsntmp->next;
6754 /* create exim process to send message */
6755 pid = child_open_exim(&fd);
6757 DEBUG(D_deliver) debug_printf("DSN: child_open_exim returns: %d\n", pid);
6759 if (pid < 0) /* Creation of child failed */
6761 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Process %d (parent %d) failed to "
6762 "create child process to send failure message: %s", getpid(),
6763 getppid(), strerror(errno));
6765 DEBUG(D_deliver) debug_printf("DSN: child_open_exim failed\n");
6767 else /* Creation of child succeeded */
6769 FILE *f = fdopen(fd, "wb");
6770 /* header only as required by RFC. only failure DSN needs to honor RET=FULL */
6771 int topt = topt_add_return_path | topt_no_body;
6775 debug_printf("sending error message to: %s\n", sender_address);
6777 /* build unique id for MIME boundary */
6778 bound = string_sprintf(TIME_T_FMT "-eximdsn-%d", time(NULL), rand());
6779 DEBUG(D_deliver) debug_printf("DSN: MIME boundary: %s\n", bound);
6781 if (errors_reply_to)
6782 fprintf(f, "Reply-To: %s\n", errors_reply_to);
6784 fprintf(f, "Auto-Submitted: auto-generated\n"
6785 "From: Mail Delivery System <Mailer-Daemon@%s>\n"
6787 "Subject: Delivery Status Notification\n"
6788 "Content-Type: multipart/report; report-type=delivery-status; boundary=%s\n"
6789 "MIME-Version: 1.0\n\n"
6792 "Content-type: text/plain; charset=us-ascii\n\n"
6794 "This message was created automatically by mail delivery software.\n"
6795 " ----- The following addresses had successful delivery notifications -----\n",
6796 qualify_domain_sender, sender_address, bound, bound);
6798 for (addr_dsntmp = addr_senddsn; addr_dsntmp;
6799 addr_dsntmp = addr_dsntmp->next)
6800 fprintf(f, "<%s> (relayed %s)\n\n",
6801 addr_dsntmp->address,
6802 (addr_dsntmp->dsn_flags & rf_dsnlasthop) == 1
6803 ? "via non DSN router"
6804 : addr_dsntmp->dsn_aware == dsn_support_no
6805 ? "to non-DSN-aware mailer"
6806 : "via non \"Remote SMTP\" router"
6810 "Content-type: message/delivery-status\n\n"
6811 "Reporting-MTA: dns; %s\n",
6812 bound, smtp_active_hostname);
6815 { /* must be decoded from xtext: see RFC 3461:6.3a */
6817 if (auth_xtextdecode(dsn_envid, &xdec_envid) > 0)
6818 fprintf(f, "Original-Envelope-ID: %s\n", dsn_envid);
6820 fprintf(f, "X-Original-Envelope-ID: error decoding xtext formated ENVID\n");
6824 for (addr_dsntmp = addr_senddsn;
6826 addr_dsntmp = addr_dsntmp->next)
6828 if (addr_dsntmp->dsn_orcpt)
6829 fprintf(f,"Original-Recipient: %s\n", addr_dsntmp->dsn_orcpt);
6831 fprintf(f, "Action: delivered\n"
6832 "Final-Recipient: rfc822;%s\n"
6834 addr_dsntmp->address);
6836 if (addr_dsntmp->host_used && addr_dsntmp->host_used->name)
6837 fprintf(f, "Remote-MTA: dns; %s\nDiagnostic-Code: smtp; 250 Ok\n\n",
6838 addr_dsntmp->host_used->name);
6840 fprintf(f, "Diagnostic-Code: X-Exim; relayed via non %s router\n\n",
6841 (addr_dsntmp->dsn_flags & rf_dsnlasthop) == 1 ? "DSN" : "SMTP");
6844 fprintf(f, "--%s\nContent-type: text/rfc822-headers\n\n", bound);
6847 transport_filter_argv = NULL; /* Just in case */
6848 return_path = sender_address; /* In case not previously set */
6850 /* Write the original email out */
6851 transport_write_message(NULL, fileno(f), topt, 0, NULL, NULL, NULL, NULL, NULL, 0);
6854 fprintf(f,"\n--%s--\n", bound);
6858 rc = child_close(pid, 0); /* Waits for child to close, no timeout */
6862 /* If any addresses failed, we must send a message to somebody, unless
6863 af_ignore_error is set, in which case no action is taken. It is possible for
6864 several messages to get sent if there are addresses with different
6867 while (addr_failed != NULL)
6871 uschar *logtod = tod_stamp(tod_log);
6873 address_item *handled_addr = NULL;
6874 address_item **paddr;
6875 address_item *msgchain = NULL;
6876 address_item **pmsgchain = &msgchain;
6878 /* There are weird cases when logging is disabled in the transport. However,
6879 there may not be a transport (address failed by a router). */
6881 disable_logging = FALSE;
6882 if (addr_failed->transport != NULL)
6883 disable_logging = addr_failed->transport->disable_logging;
6886 debug_printf("processing failed address %s\n", addr_failed->address);
6888 /* There are only two ways an address in a bounce message can get here:
6890 (1) When delivery was initially deferred, but has now timed out (in the call
6891 to retry_update() above). We can detect this by testing for
6892 af_retry_timedout. If the address does not have its own errors address,
6893 we arrange to ignore the error.
6895 (2) If delivery failures for bounce messages are being ignored. We can detect
6896 this by testing for af_ignore_error. This will also be set if a bounce
6897 message has been autothawed and the ignore_bounce_errors_after time has
6898 passed. It might also be set if a router was explicitly configured to
6899 ignore errors (errors_to = "").
6901 If neither of these cases obtains, something has gone wrong. Log the
6902 incident, but then ignore the error. */
6904 if (sender_address[0] == 0 && addr_failed->prop.errors_address == NULL)
6906 if ( !testflag(addr_failed, af_retry_timedout)
6907 && !testflag(addr_failed, af_ignore_error))
6909 log_write(0, LOG_MAIN|LOG_PANIC, "internal error: bounce message "
6910 "failure is neither frozen nor ignored (it's been ignored)");
6912 setflag(addr_failed, af_ignore_error);
6915 /* If the first address on the list has af_ignore_error set, just remove
6916 it from the list, throw away any saved message file, log it, and
6917 mark the recipient done. */
6919 if ( testflag(addr_failed, af_ignore_error)
6920 || ( addr_failed->dsn_flags & rf_dsnflags
6921 && (addr_failed->dsn_flags & rf_notify_failure) != rf_notify_failure)
6925 addr_failed = addr->next;
6926 if (addr->return_filename != NULL) Uunlink(addr->return_filename);
6928 log_write(0, LOG_MAIN, "%s%s%s%s: error ignored",
6930 !addr->parent ? US"" : US" <",
6931 !addr->parent ? US"" : addr->parent->address,
6932 !addr->parent ? US"" : US">");
6934 address_done(addr, logtod);
6935 child_done(addr, logtod);
6936 /* Panic-dies on error */
6937 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
6940 /* Otherwise, handle the sending of a message. Find the error address for
6941 the first address, then send a message that includes all failed addresses
6942 that have the same error address. Note the bounce_recipient is a global so
6943 that it can be accesssed by $bounce_recipient while creating a customized
6948 bounce_recipient = addr_failed->prop.errors_address
6949 ? addr_failed->prop.errors_address : sender_address;
6951 /* Make a subprocess to send a message */
6953 if ((pid = child_open_exim(&fd)) < 0)
6954 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Process %d (parent %d) failed to "
6955 "create child process to send failure message: %s", getpid(),
6956 getppid(), strerror(errno));
6958 /* Creation of child succeeded */
6965 uschar *bcc, *emf_text;
6966 FILE *f = fdopen(fd, "wb");
6968 BOOL to_sender = strcmpic(sender_address, bounce_recipient) == 0;
6969 int max = (bounce_return_size_limit/DELIVER_IN_BUFFER_SIZE + 1) *
6970 DELIVER_IN_BUFFER_SIZE;
6972 uschar *dsnlimitmsg;
6973 uschar *dsnnotifyhdr;
6977 debug_printf("sending error message to: %s\n", bounce_recipient);
6979 /* Scan the addresses for all that have the same errors address, removing
6980 them from the addr_failed chain, and putting them on msgchain. */
6982 paddr = &addr_failed;
6983 for (addr = addr_failed; addr != NULL; addr = *paddr)
6984 if (Ustrcmp(bounce_recipient, addr->prop.errors_address
6985 ? addr->prop.errors_address : sender_address) == 0)
6986 { /* The same - dechain */
6987 *paddr = addr->next;
6990 pmsgchain = &(addr->next);
6993 paddr = &addr->next; /* Not the same; skip */
6995 /* Include X-Failed-Recipients: for automatic interpretation, but do
6996 not let any one header line get too long. We do this by starting a
6997 new header every 50 recipients. Omit any addresses for which the
6998 "hide_child" flag is set. */
7000 for (addr = msgchain; addr != NULL; addr = addr->next)
7002 if (testflag(addr, af_hide_child)) continue;
7009 (rcount++ == 0)? "X-Failed-Recipients: " : ",\n ",
7010 (testflag(addr, af_pfr) && addr->parent != NULL)?
7011 string_printing(addr->parent->address) :
7012 string_printing(addr->address));
7014 if (rcount > 0) fprintf(f, "\n");
7016 /* Output the standard headers */
7018 if (errors_reply_to)
7019 fprintf(f, "Reply-To: %s\n", errors_reply_to);
7020 fprintf(f, "Auto-Submitted: auto-replied\n");
7022 fprintf(f, "To: %s\n", bounce_recipient);
7024 /* generate boundary string and output MIME-Headers */
7025 bound = string_sprintf(TIME_T_FMT "-eximdsn-%d", time(NULL), rand());
7027 fprintf(f, "Content-Type: multipart/report;"
7028 " report-type=delivery-status; boundary=%s\n"
7029 "MIME-Version: 1.0\n",
7032 /* Open a template file if one is provided. Log failure to open, but
7033 carry on - default texts will be used. */
7035 if (bounce_message_file)
7036 if (!(emf = Ufopen(bounce_message_file, "rb")))
7037 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to open %s for error "
7038 "message texts: %s", bounce_message_file, strerror(errno));
7040 /* Quietly copy to configured additional addresses if required. */
7042 if ((bcc = moan_check_errorcopy(bounce_recipient)))
7043 fprintf(f, "Bcc: %s\n", bcc);
7045 /* The texts for the message can be read from a template file; if there
7046 isn't one, or if it is too short, built-in texts are used. The first
7047 emf text is a Subject: and any other headers. */
7049 if ((emf_text = next_emf(emf, US"header")))
7050 fprintf(f, "%s\n", emf_text);
7052 fprintf(f, "Subject: Mail delivery failed%s\n\n",
7053 to_sender? ": returning message to sender" : "");
7055 /* output human readable part as text/plain section */
7057 "Content-type: text/plain; charset=us-ascii\n\n",
7060 if ((emf_text = next_emf(emf, US"intro")))
7061 fprintf(f, "%s", CS emf_text);
7065 /* This message has been reworded several times. It seems to be confusing to
7066 somebody, however it is worded. I have retreated to the original, simple
7068 "This message was created automatically by mail delivery software.\n");
7070 if (bounce_message_text)
7071 fprintf(f, "%s", CS bounce_message_text);
7074 "\nA message that you sent could not be delivered to one or more of its\n"
7075 "recipients. This is a permanent error. The following address(es) failed:\n");
7078 "\nA message sent by\n\n <%s>\n\n"
7079 "could not be delivered to one or more of its recipients. The following\n"
7080 "address(es) failed:\n", sender_address);
7084 /* Process the addresses, leaving them on the msgchain if they have a
7085 file name for a return message. (There has already been a check in
7086 post_process_one() for the existence of data in the message file.) A TRUE
7087 return from print_address_information() means that the address is not
7091 for (addr = msgchain; addr != NULL; addr = *paddr)
7093 if (print_address_information(addr, f, US" ", US"\n ", US""))
7094 print_address_error(addr, f, US"");
7096 /* End the final line for the address */
7100 /* Leave on msgchain if there's a return file. */
7102 if (addr->return_file >= 0)
7104 paddr = &(addr->next);
7108 /* Else save so that we can tick off the recipient when the
7113 *paddr = addr->next;
7114 addr->next = handled_addr;
7115 handled_addr = addr;
7121 /* Get the next text, whether we need it or not, so as to be
7122 positioned for the one after. */
7124 emf_text = next_emf(emf, US"generated text");
7126 /* If there were any file messages passed by the local transports,
7127 include them in the message. Then put the address on the handled chain.
7128 In the case of a batch of addresses that were all sent to the same
7129 transport, the return_file field in all of them will contain the same
7130 fd, and the return_filename field in the *last* one will be set (to the
7131 name of the file). */
7135 address_item *nextaddr;
7138 fprintf(f, "%s", CS emf_text);
7141 "The following text was generated during the delivery "
7142 "attempt%s:\n", (filecount > 1)? "s" : "");
7144 for (addr = msgchain; addr != NULL; addr = nextaddr)
7147 address_item *topaddr = addr;
7149 /* List all the addresses that relate to this file */
7152 while(addr) /* Insurance */
7154 print_address_information(addr, f, US"------ ", US"\n ",
7156 if (addr->return_filename) break;
7161 /* Now copy the file */
7163 fm = Ufopen(addr->return_filename, "rb");
7166 fprintf(f, " +++ Exim error... failed to open text file: %s\n",
7170 while ((ch = fgetc(fm)) != EOF) fputc(ch, f);
7173 Uunlink(addr->return_filename);
7175 /* Can now add to handled chain, first fishing off the next
7176 address on the msgchain. */
7178 nextaddr = addr->next;
7179 addr->next = handled_addr;
7180 handled_addr = topaddr;
7185 /* output machine readable part */
7186 #ifdef EXPERIMENTAL_INTERNATIONAL
7187 if (message_smtputf8)
7189 "Content-type: message/global-delivery-status\n\n"
7190 "Reporting-MTA: dns; %s\n",
7191 bound, smtp_active_hostname);
7195 "Content-type: message/delivery-status\n\n"
7196 "Reporting-MTA: dns; %s\n",
7197 bound, smtp_active_hostname);
7201 /* must be decoded from xtext: see RFC 3461:6.3a */
7203 if (auth_xtextdecode(dsn_envid, &xdec_envid) > 0)
7204 fprintf(f, "Original-Envelope-ID: %s\n", dsn_envid);
7206 fprintf(f, "X-Original-Envelope-ID: error decoding xtext formated ENVID\n");
7210 for (addr = handled_addr; addr; addr = addr->next)
7212 fprintf(f, "Action: failed\n"
7213 "Final-Recipient: rfc822;%s\n"
7216 if (addr->host_used && addr->host_used->name)
7218 fprintf(f, "Remote-MTA: dns; %s\n",
7219 addr->host_used->name);
7220 print_dsn_diagnostic_code(addr, f);
7225 /* Now copy the message, trying to give an intelligible comment if
7226 it is too long for it all to be copied. The limit isn't strictly
7227 applied because of the buffering. There is, however, an option
7228 to suppress copying altogether. */
7230 emf_text = next_emf(emf, US"copy");
7233 we ignore the intro text from template and add
7234 the text for bounce_return_size_limit at the end.
7236 bounce_return_message is ignored
7237 in case RET= is defined we honor these values
7238 otherwise bounce_return_body is honored.
7240 bounce_return_size_limit is always honored.
7243 fprintf(f, "--%s\n", bound);
7245 dsnlimitmsg = US"X-Exim-DSN-Information: Due to administrative limits only headers are returned";
7246 dsnnotifyhdr = NULL;
7247 topt = topt_add_return_path;
7249 /* RET=HDRS? top priority */
7250 if (dsn_ret == dsn_ret_hdrs)
7251 topt |= topt_no_body;
7253 /* no full body return at all? */
7254 if (!bounce_return_body)
7256 topt |= topt_no_body;
7257 /* add header if we overrule RET=FULL */
7258 if (dsn_ret == dsn_ret_full)
7259 dsnnotifyhdr = dsnlimitmsg;
7261 /* size limited ... return headers only if limit reached */
7262 else if (bounce_return_size_limit > 0)
7264 struct stat statbuf;
7265 if (fstat(deliver_datafile, &statbuf) == 0 && statbuf.st_size > max)
7267 topt |= topt_no_body;
7268 dsnnotifyhdr = dsnlimitmsg;
7272 #ifdef EXPERIMENTAL_INTERNATIONAL
7273 if (message_smtputf8)
7274 fputs(topt & topt_no_body ? "Content-type: message/global-headers\n\n"
7275 : "Content-type: message/global\n\n",
7279 fputs(topt & topt_no_body ? "Content-type: text/rfc822-headers\n\n"
7280 : "Content-type: message/rfc822\n\n",
7284 transport_filter_argv = NULL; /* Just in case */
7285 return_path = sender_address; /* In case not previously set */
7286 transport_write_message(NULL, fileno(f), topt,
7287 0, dsnnotifyhdr, NULL, NULL, NULL, NULL, 0);
7290 /* we never add the final text. close the file */
7294 fprintf(f, "\n--%s--\n", bound);
7296 /* Close the file, which should send an EOF to the child process
7297 that is receiving the message. Wait for it to finish. */
7300 rc = child_close(pid, 0); /* Waits for child to close, no timeout */
7302 /* In the test harness, let the child do it's thing first. */
7304 if (running_in_test_harness) millisleep(500);
7306 /* If the process failed, there was some disaster in setting up the
7307 error message. Unless the message is very old, ensure that addr_defer
7308 is non-null, which will have the effect of leaving the message on the
7309 spool. The failed addresses will get tried again next time. However, we
7310 don't really want this to happen too often, so freeze the message unless
7311 there are some genuine deferred addresses to try. To do this we have
7312 to call spool_write_header() here, because with no genuine deferred
7313 addresses the normal code below doesn't get run. */
7318 if (now - received_time < retry_maximum_timeout && addr_defer == NULL)
7320 addr_defer = (address_item *)(+1);
7321 deliver_freeze = TRUE;
7322 deliver_frozen_at = time(NULL);
7323 /* Panic-dies on error */
7324 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
7327 deliver_msglog("Process failed (%d) when writing error message "
7328 "to %s%s", rc, bounce_recipient, s);
7329 log_write(0, LOG_MAIN, "Process failed (%d) when writing error message "
7330 "to %s%s", rc, bounce_recipient, s);
7333 /* The message succeeded. Ensure that the recipients that failed are
7334 now marked finished with on the spool and their parents updated. */
7338 for (addr = handled_addr; addr != NULL; addr = addr->next)
7340 address_done(addr, logtod);
7341 child_done(addr, logtod);
7343 /* Panic-dies on error */
7344 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
7350 disable_logging = FALSE; /* In case left set */
7352 /* Come here from the mua_wrapper case if routing goes wrong */
7356 /* If there are now no deferred addresses, we are done. Preserve the
7357 message log if so configured, and we are using them. Otherwise, sling it.
7358 Then delete the message itself. */
7360 if (addr_defer == NULL)
7364 sprintf(CS spoolname, "%s/msglog/%s/%s", spool_directory, message_subdir,
7366 if (preserve_message_logs)
7369 sprintf(CS big_buffer, "%s/msglog.OLD/%s", spool_directory, id);
7370 if ((rc = Urename(spoolname, big_buffer)) < 0)
7372 (void)directory_make(spool_directory, US"msglog.OLD",
7373 MSGLOG_DIRECTORY_MODE, TRUE);
7374 rc = Urename(spoolname, big_buffer);
7377 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to move %s to the "
7378 "msglog.OLD directory", spoolname);
7381 if (Uunlink(spoolname) < 0)
7382 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s",
7383 spoolname, strerror(errno));
7386 /* Remove the two message files. */
7388 sprintf(CS spoolname, "%s/input/%s/%s-D", spool_directory, message_subdir, id);
7389 if (Uunlink(spoolname) < 0)
7390 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s",
7391 spoolname, strerror(errno));
7392 sprintf(CS spoolname, "%s/input/%s/%s-H", spool_directory, message_subdir, id);
7393 if (Uunlink(spoolname) < 0)
7394 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s",
7395 spoolname, strerror(errno));
7397 /* Log the end of this message, with queue time if requested. */
7399 if (LOGGING(queue_time_overall))
7400 log_write(0, LOG_MAIN, "Completed QT=%s",
7401 readconf_printtime( (int) ((long)time(NULL) - (long)received_time)) );
7403 log_write(0, LOG_MAIN, "Completed");
7405 /* Unset deliver_freeze so that we won't try to move the spool files further down */
7406 deliver_freeze = FALSE;
7408 #ifdef EXPERIMENTAL_EVENT
7409 (void) event_raise(event_action, US"msg:complete", NULL);
7413 /* If there are deferred addresses, we are keeping this message because it is
7414 not yet completed. Lose any temporary files that were catching output from
7415 pipes for any of the deferred addresses, handle one-time aliases, and see if
7416 the message has been on the queue for so long that it is time to send a warning
7417 message to the sender, unless it is a mailer-daemon. If all deferred addresses
7418 have the same domain, we can set deliver_domain for the expansion of
7419 delay_warning_ condition - if any of them are pipes, files, or autoreplies, use
7420 the parent's domain.
7422 If all the deferred addresses have an error number that indicates "retry time
7423 not reached", skip sending the warning message, because it won't contain the
7424 reason for the delay. It will get sent at the next real delivery attempt.
7425 However, if at least one address has tried, we'd better include all of them in
7428 If we can't make a process to send the message, don't worry.
7430 For mailing list expansions we want to send the warning message to the
7431 mailing list manager. We can't do a perfect job here, as some addresses may
7432 have different errors addresses, but if we take the errors address from
7433 each deferred address it will probably be right in most cases.
7435 If addr_defer == +1, it means there was a problem sending an error message
7436 for failed addresses, and there were no "real" deferred addresses. The value
7437 was set just to keep the message on the spool, so there is nothing to do here.
7440 else if (addr_defer != (address_item *)(+1))
7443 uschar *recipients = US"";
7444 BOOL delivery_attempted = FALSE;
7446 deliver_domain = testflag(addr_defer, af_pfr)?
7447 addr_defer->parent->domain : addr_defer->domain;
7449 for (addr = addr_defer; addr != NULL; addr = addr->next)
7451 address_item *otaddr;
7453 if (addr->basic_errno > ERRNO_RETRY_BASE) delivery_attempted = TRUE;
7455 if (deliver_domain != NULL)
7457 const uschar *d = testflag(addr, af_pfr)
7458 ? addr->parent->domain : addr->domain;
7460 /* The domain may be unset for an address that has never been routed
7461 because the system filter froze the message. */
7463 if (d == NULL || Ustrcmp(d, deliver_domain) != 0) deliver_domain = NULL;
7466 if (addr->return_filename != NULL) Uunlink(addr->return_filename);
7468 /* Handle the case of one-time aliases. If any address in the ancestry
7469 of this one is flagged, ensure it is in the recipients list, suitably
7470 flagged, and that its parent is marked delivered. */
7472 for (otaddr = addr; otaddr != NULL; otaddr = otaddr->parent)
7473 if (otaddr->onetime_parent != NULL) break;
7478 int t = recipients_count;
7480 for (i = 0; i < recipients_count; i++)
7482 uschar *r = recipients_list[i].address;
7483 if (Ustrcmp(otaddr->onetime_parent, r) == 0) t = i;
7484 if (Ustrcmp(otaddr->address, r) == 0) break;
7487 /* Didn't find the address already in the list, and did find the
7488 ultimate parent's address in the list. After adding the recipient,
7489 update the errors address in the recipients list. */
7491 if (i >= recipients_count && t < recipients_count)
7493 DEBUG(D_deliver) debug_printf("one_time: adding %s in place of %s\n",
7494 otaddr->address, otaddr->parent->address);
7495 receive_add_recipient(otaddr->address, t);
7496 recipients_list[recipients_count-1].errors_to = otaddr->prop.errors_address;
7497 tree_add_nonrecipient(otaddr->parent->address);
7498 update_spool = TRUE;
7502 /* Except for error messages, ensure that either the errors address for
7503 this deferred address or, if there is none, the sender address, is on the
7504 list of recipients for a warning message. */
7506 if (sender_address[0] != 0)
7508 if (addr->prop.errors_address == NULL)
7510 if (Ustrstr(recipients, sender_address) == NULL)
7511 recipients = string_sprintf("%s%s%s", recipients,
7512 (recipients[0] == 0)? "" : ",", sender_address);
7516 if (Ustrstr(recipients, addr->prop.errors_address) == NULL)
7517 recipients = string_sprintf("%s%s%s", recipients,
7518 (recipients[0] == 0)? "" : ",", addr->prop.errors_address);
7523 /* Send a warning message if the conditions are right. If the condition check
7524 fails because of a lookup defer, there is nothing we can do. The warning
7525 is not sent. Another attempt will be made at the next delivery attempt (if
7529 && delivery_attempted
7530 && ( ((addr_defer->dsn_flags & rf_dsnflags) == 0)
7531 || (addr_defer->dsn_flags & rf_notify_delay) == rf_notify_delay
7533 && delay_warning[1] > 0
7534 && sender_address[0] != 0
7535 && ( delay_warning_condition == NULL
7536 || expand_check_condition(delay_warning_condition,
7537 US"delay_warning", US"option")
7543 int queue_time = time(NULL) - received_time;
7545 /* When running in the test harness, there's an option that allows us to
7546 fudge this time so as to get repeatability of the tests. Take the first
7547 time off the list. In queue runs, the list pointer gets updated in the
7550 if (running_in_test_harness && fudged_queue_times[0] != 0)
7552 int qt = readconf_readtime(fudged_queue_times, '/', FALSE);
7555 DEBUG(D_deliver) debug_printf("fudged queue_times = %s\n",
7556 fudged_queue_times);
7561 /* See how many warnings we should have sent by now */
7563 for (count = 0; count < delay_warning[1]; count++)
7564 if (queue_time < delay_warning[count+2]) break;
7566 show_time = delay_warning[count+1];
7568 if (count >= delay_warning[1])
7571 int last_gap = show_time;
7572 if (count > 1) last_gap -= delay_warning[count];
7573 extra = (queue_time - delay_warning[count+1])/last_gap;
7574 show_time += last_gap * extra;
7580 debug_printf("time on queue = %s\n", readconf_printtime(queue_time));
7581 debug_printf("warning counts: required %d done %d\n", count,
7585 /* We have computed the number of warnings there should have been by now.
7586 If there haven't been enough, send one, and up the count to what it should
7589 if (warning_count < count)
7593 pid_t pid = child_open_exim(&fd);
7599 FILE *f = fdopen(fd, "wb");
7602 if (warn_message_file)
7604 wmf = Ufopen(warn_message_file, "rb");
7606 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to open %s for warning "
7607 "message texts: %s", warn_message_file, strerror(errno));
7610 warnmsg_recipients = recipients;
7611 warnmsg_delay = (queue_time < 120*60)?
7612 string_sprintf("%d minutes", show_time/60):
7613 string_sprintf("%d hours", show_time/3600);
7615 if (errors_reply_to)
7616 fprintf(f, "Reply-To: %s\n", errors_reply_to);
7617 fprintf(f, "Auto-Submitted: auto-replied\n");
7619 fprintf(f, "To: %s\n", recipients);
7621 /* generated boundary string and output MIME-Headers */
7622 bound = string_sprintf(TIME_T_FMT "-eximdsn-%d", time(NULL), rand());
7624 fprintf(f, "Content-Type: multipart/report;"
7625 " report-type=delivery-status; boundary=%s\n"
7626 "MIME-Version: 1.0\n",
7629 if ((wmf_text = next_emf(wmf, US"header")))
7630 fprintf(f, "%s\n", wmf_text);
7632 fprintf(f, "Subject: Warning: message %s delayed %s\n\n",
7633 message_id, warnmsg_delay);
7635 /* output human readable part as text/plain section */
7637 "Content-type: text/plain; charset=us-ascii\n\n",
7640 if ((wmf_text = next_emf(wmf, US"intro")))
7641 fprintf(f, "%s", CS wmf_text);
7645 "This message was created automatically by mail delivery software.\n");
7647 if (Ustrcmp(recipients, sender_address) == 0)
7649 "A message that you sent has not yet been delivered to one or more of its\n"
7650 "recipients after more than ");
7654 "A message sent by\n\n <%s>\n\n"
7655 "has not yet been delivered to one or more of its recipients after more than \n",
7658 fprintf(f, "%s on the queue on %s.\n\n"
7659 "The message identifier is: %s\n",
7660 warnmsg_delay, primary_hostname, message_id);
7662 for (h = header_list; h != NULL; h = h->next)
7663 if (strncmpic(h->text, US"Subject:", 8) == 0)
7664 fprintf(f, "The subject of the message is: %s", h->text + 9);
7665 else if (strncmpic(h->text, US"Date:", 5) == 0)
7666 fprintf(f, "The date of the message is: %s", h->text + 6);
7669 fprintf(f, "The address%s to which the message has not yet been "
7671 !addr_defer->next ? "" : "es",
7672 !addr_defer->next ? "is": "are");
7675 /* List the addresses, with error information if allowed */
7677 /* store addr_defer for machine readable part */
7678 address_item *addr_dsndefer = addr_defer;
7682 address_item *addr = addr_defer;
7683 addr_defer = addr->next;
7684 if (print_address_information(addr, f, US" ", US"\n ", US""))
7685 print_address_error(addr, f, US"Delay reason: ");
7694 if ((wmf_text = next_emf(wmf, US"final")))
7695 fprintf(f, "%s", CS wmf_text);
7701 "No action is required on your part. Delivery attempts will continue for\n"
7702 "some time, and this warning may be repeated at intervals if the message\n"
7703 "remains undelivered. Eventually the mail delivery software will give up,\n"
7704 "and when that happens, the message will be returned to you.\n");
7707 /* output machine readable part */
7708 fprintf(f, "\n--%s\n"
7709 "Content-type: message/delivery-status\n\n"
7710 "Reporting-MTA: dns; %s\n",
7712 smtp_active_hostname);
7717 /* must be decoded from xtext: see RFC 3461:6.3a */
7719 if (auth_xtextdecode(dsn_envid, &xdec_envid) > 0)
7720 fprintf(f,"Original-Envelope-ID: %s\n", dsn_envid);
7722 fprintf(f,"X-Original-Envelope-ID: error decoding xtext formated ENVID\n");
7726 for ( ; addr_dsndefer; addr_dsndefer = addr_dsndefer->next)
7728 if (addr_dsndefer->dsn_orcpt)
7729 fprintf(f, "Original-Recipient: %s\n", addr_dsndefer->dsn_orcpt);
7731 fprintf(f, "Action: delayed\n"
7732 "Final-Recipient: rfc822;%s\n"
7734 addr_dsndefer->address);
7735 if (addr_dsndefer->host_used && addr_dsndefer->host_used->name)
7737 fprintf(f, "Remote-MTA: dns; %s\n",
7738 addr_dsndefer->host_used->name);
7739 print_dsn_diagnostic_code(addr_dsndefer, f);
7745 "Content-type: text/rfc822-headers\n\n",
7749 /* header only as required by RFC. only failure DSN needs to honor RET=FULL */
7750 int topt = topt_add_return_path | topt_no_body;
7751 transport_filter_argv = NULL; /* Just in case */
7752 return_path = sender_address; /* In case not previously set */
7753 /* Write the original email out */
7754 transport_write_message(NULL, fileno(f), topt, 0, NULL, NULL, NULL, NULL, NULL, 0);
7757 fprintf(f,"\n--%s--\n", bound);
7761 /* Close and wait for child process to complete, without a timeout.
7762 If there's an error, don't update the count. */
7765 if (child_close(pid, 0) == 0)
7767 warning_count = count;
7768 update_spool = TRUE; /* Ensure spool rewritten */
7774 /* Clear deliver_domain */
7776 deliver_domain = NULL;
7778 /* If this was a first delivery attempt, unset the first time flag, and
7779 ensure that the spool gets updated. */
7781 if (deliver_firsttime)
7783 deliver_firsttime = FALSE;
7784 update_spool = TRUE;
7787 /* If delivery was frozen and freeze_tell is set, generate an appropriate
7788 message, unless the message is a local error message (to avoid loops). Then
7789 log the freezing. If the text in "frozen_info" came from a system filter,
7790 it has been escaped into printing characters so as not to mess up log lines.
7791 For the "tell" message, we turn \n back into newline. Also, insert a newline
7792 near the start instead of the ": " string. */
7796 if (freeze_tell != NULL && freeze_tell[0] != 0 && !local_error_message)
7798 uschar *s = string_copy(frozen_info);
7799 uschar *ss = Ustrstr(s, " by the system filter: ");
7810 if (*ss == '\\' && ss[1] == 'n')
7817 moan_tell_someone(freeze_tell, addr_defer, US"Message frozen",
7818 "Message %s has been frozen%s.\nThe sender is <%s>.\n", message_id,
7822 /* Log freezing just before we update the -H file, to minimize the chance
7823 of a race problem. */
7825 deliver_msglog("*** Frozen%s\n", frozen_info);
7826 log_write(0, LOG_MAIN, "Frozen%s", frozen_info);
7829 /* If there have been any updates to the non-recipients list, or other things
7830 that get written to the spool, we must now update the spool header file so
7831 that it has the right information for the next delivery attempt. If there
7832 was more than one address being delivered, the header_change update is done
7833 earlier, in case one succeeds and then something crashes. */
7836 debug_printf("delivery deferred: update_spool=%d header_rewritten=%d\n",
7837 update_spool, header_rewritten);
7839 if (update_spool || header_rewritten)
7840 /* Panic-dies on error */
7841 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
7844 /* Finished with the message log. If the message is complete, it will have
7845 been unlinked or renamed above. */
7847 if (message_logs) (void)fclose(message_log);
7849 /* Now we can close and remove the journal file. Its only purpose is to record
7850 successfully completed deliveries asap so that this information doesn't get
7851 lost if Exim (or the machine) crashes. Forgetting about a failed delivery is
7852 not serious, as trying it again is not harmful. The journal might not be open
7853 if all addresses were deferred at routing or directing. Nevertheless, we must
7854 remove it if it exists (may have been lying around from a crash during the
7855 previous delivery attempt). We don't remove the journal if a delivery
7856 subprocess failed to pass back delivery information; this is controlled by
7857 the remove_journal flag. When the journal is left, we also don't move the
7858 message off the main spool if frozen and the option is set. It should get moved
7859 at the next attempt, after the journal has been inspected. */
7861 if (journal_fd >= 0) (void)close(journal_fd);
7865 sprintf(CS spoolname, "%s/input/%s/%s-J", spool_directory, message_subdir, id);
7866 if (Uunlink(spoolname) < 0 && errno != ENOENT)
7867 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s", spoolname,
7870 /* Move the message off the spool if reqested */
7872 #ifdef SUPPORT_MOVE_FROZEN_MESSAGES
7873 if (deliver_freeze && move_frozen_messages)
7874 (void)spool_move_message(id, message_subdir, US"", US"F");
7878 /* Closing the data file frees the lock; if the file has been unlinked it
7879 will go away. Otherwise the message becomes available for another process
7882 (void)close(deliver_datafile);
7883 deliver_datafile = -1;
7884 DEBUG(D_deliver) debug_printf("end delivery of %s\n", id);
7886 /* It is unlikely that there will be any cached resources, since they are
7887 released after routing, and in the delivery subprocesses. However, it's
7888 possible for an expansion for something afterwards (for example,
7889 expand_check_condition) to do a lookup. We must therefore be sure everything is
7893 acl_where = ACL_WHERE_UNKNOWN;
7902 if (!regex_PIPELINING) regex_PIPELINING =
7903 regex_must_compile(US"\\n250[\\s\\-]PIPELINING(\\s|\\n|$)", FALSE, TRUE);
7905 if (!regex_SIZE) regex_SIZE =
7906 regex_must_compile(US"\\n250[\\s\\-]SIZE(\\s|\\n|$)", FALSE, TRUE);
7908 if (!regex_AUTH) regex_AUTH =
7909 regex_must_compile(US"\\n250[\\s\\-]AUTH\\s+([\\-\\w\\s]+)(?:\\n|$)",
7913 if (!regex_STARTTLS) regex_STARTTLS =
7914 regex_must_compile(US"\\n250[\\s\\-]STARTTLS(\\s|\\n|$)", FALSE, TRUE);
7917 #ifndef DISABLE_PRDR
7918 if (!regex_PRDR) regex_PRDR =
7919 regex_must_compile(US"\\n250[\\s\\-]PRDR(\\s|\\n|$)", FALSE, TRUE);
7922 #ifdef EXPERIMENTAL_INTERNATIONAL
7923 if (!regex_UTF8) regex_UTF8 =
7924 regex_must_compile(US"\\n250[\\s\\-]SMTPUTF8(\\s|\\n|$)", FALSE, TRUE);
7927 if (!regex_DSN) regex_DSN =
7928 regex_must_compile(US"\\n250[\\s\\-]DSN(\\s|\\n|$)", FALSE, TRUE);
7930 if (!regex_IGNOREQUOTA) regex_IGNOREQUOTA =
7931 regex_must_compile(US"\\n250[\\s\\-]IGNOREQUOTA(\\s|\\n|$)", FALSE, TRUE);
7936 deliver_get_sender_address (uschar * id)
7939 uschar * new_sender_address,
7940 * save_sender_address;
7942 if (!spool_open_datafile(id))
7945 /* Save and restore the global sender_address. I'm not sure if we should
7946 not save/restore all the other global variables too, because
7947 spool_read_header() may change all of them. But OTOH, when this
7948 deliver_get_sender_address() gets called, the current message is done
7949 already and nobody needs the globals anymore. (HS12, 2015-08-21) */
7951 sprintf(CS spoolname, "%s-H", id);
7952 save_sender_address = sender_address;
7954 rc = spool_read_header(spoolname, TRUE, TRUE);
7956 new_sender_address = sender_address;
7957 sender_address = save_sender_address;
7959 if (rc != spool_read_OK)
7962 assert(new_sender_address);
7964 (void)close(deliver_datafile);
7965 deliver_datafile = -1;
7967 return new_sender_address;
7972 /* End of deliver.c */