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. */
14 /* Data block for keeping track of subprocesses for parallel remote
17 typedef struct pardata {
18 address_item *addrlist; /* chain of addresses */
19 address_item *addr; /* next address data expected for */
20 pid_t pid; /* subprocess pid */
21 int fd; /* pipe fd for getting result from subprocess */
22 int transport_count; /* returned transport count value */
23 BOOL done; /* no more data needed */
24 uschar *msg; /* error message */
25 uschar *return_path; /* return_path for these addresses */
28 /* Values for the process_recipients variable */
30 enum { RECIP_ACCEPT, RECIP_IGNORE, RECIP_DEFER,
31 RECIP_FAIL, RECIP_FAIL_FILTER, RECIP_FAIL_TIMEOUT,
34 /* Mutually recursive functions for marking addresses done. */
36 static void child_done(address_item *, uschar *);
37 static void address_done(address_item *, uschar *);
39 /* Table for turning base-62 numbers into binary */
41 static uschar tab62[] =
42 {0,1,2,3,4,5,6,7,8,9,0,0,0,0,0,0, /* 0-9 */
43 0,10,11,12,13,14,15,16,17,18,19,20, /* A-K */
44 21,22,23,24,25,26,27,28,29,30,31,32, /* L-W */
45 33,34,35, 0, 0, 0, 0, 0, /* X-Z */
46 0,36,37,38,39,40,41,42,43,44,45,46, /* a-k */
47 47,48,49,50,51,52,53,54,55,56,57,58, /* l-w */
51 /*************************************************
52 * Local static variables *
53 *************************************************/
55 /* addr_duplicate is global because it needs to be seen from the Envelope-To
58 static address_item *addr_defer = NULL;
59 static address_item *addr_failed = NULL;
60 static address_item *addr_fallback = NULL;
61 static address_item *addr_local = NULL;
62 static address_item *addr_new = NULL;
63 static address_item *addr_remote = NULL;
64 static address_item *addr_route = NULL;
65 static address_item *addr_succeed = NULL;
66 static address_item *addr_dsntmp = NULL;
67 static address_item *addr_senddsn = NULL;
69 static FILE *message_log = NULL;
70 static BOOL update_spool;
71 static BOOL remove_journal;
72 static int parcount = 0;
73 static pardata *parlist = NULL;
74 static int return_count;
75 static uschar *frozen_info = US"";
76 static uschar *used_return_path = NULL;
78 static uschar spoolname[PATH_MAX];
82 /*************************************************
83 * Make a new address item *
84 *************************************************/
86 /* This function gets the store and initializes with default values. The
87 transport_return value defaults to DEFER, so that any unexpected failure to
88 deliver does not wipe out the message. The default unique string is set to a
89 copy of the address, so that its domain can be lowercased.
92 address the RFC822 address string
93 copy force a copy of the address
95 Returns: a pointer to an initialized address_item
99 deliver_make_addr(uschar *address, BOOL copy)
101 address_item *addr = store_get(sizeof(address_item));
102 *addr = address_defaults;
103 if (copy) address = string_copy(address);
104 addr->address = address;
105 addr->unique = string_copy(address);
112 /*************************************************
113 * Set expansion values for an address *
114 *************************************************/
116 /* Certain expansion variables are valid only when handling an address or
117 address list. This function sets them up or clears the values, according to its
121 addr the address in question, or NULL to clear values
126 deliver_set_expansions(address_item *addr)
130 const uschar ***p = address_expansions;
131 while (*p != NULL) **p++ = NULL;
135 /* Exactly what gets set depends on whether there is one or more addresses, and
136 what they contain. These first ones are always set, taking their values from
137 the first address. */
139 if (addr->host_list == NULL)
141 deliver_host = deliver_host_address = US"";
142 deliver_host_port = 0;
146 deliver_host = addr->host_list->name;
147 deliver_host_address = addr->host_list->address;
148 deliver_host_port = addr->host_list->port;
151 deliver_recipients = addr;
152 deliver_address_data = addr->prop.address_data;
153 deliver_domain_data = addr->prop.domain_data;
154 deliver_localpart_data = addr->prop.localpart_data;
156 /* These may be unset for multiple addresses */
158 deliver_domain = addr->domain;
159 self_hostname = addr->self_hostname;
161 #ifdef EXPERIMENTAL_BRIGHTMAIL
162 bmi_deliver = 1; /* deliver by default */
163 bmi_alt_location = NULL;
164 bmi_base64_verdict = NULL;
165 bmi_base64_tracker_verdict = NULL;
168 /* If there's only one address we can set everything. */
170 if (addr->next == NULL)
172 address_item *addr_orig;
174 deliver_localpart = addr->local_part;
175 deliver_localpart_prefix = addr->prefix;
176 deliver_localpart_suffix = addr->suffix;
178 for (addr_orig = addr; addr_orig->parent != NULL;
179 addr_orig = addr_orig->parent);
180 deliver_domain_orig = addr_orig->domain;
182 /* Re-instate any prefix and suffix in the original local part. In all
183 normal cases, the address will have a router associated with it, and we can
184 choose the caseful or caseless version accordingly. However, when a system
185 filter sets up a pipe, file, or autoreply delivery, no router is involved.
186 In this case, though, there won't be any prefix or suffix to worry about. */
188 deliver_localpart_orig = (addr_orig->router == NULL)? addr_orig->local_part :
189 addr_orig->router->caseful_local_part?
190 addr_orig->cc_local_part : addr_orig->lc_local_part;
192 /* If there's a parent, make its domain and local part available, and if
193 delivering to a pipe or file, or sending an autoreply, get the local
194 part from the parent. For pipes and files, put the pipe or file string
195 into address_pipe and address_file. */
197 if (addr->parent != NULL)
199 deliver_domain_parent = addr->parent->domain;
200 deliver_localpart_parent = (addr->parent->router == NULL)?
201 addr->parent->local_part :
202 addr->parent->router->caseful_local_part?
203 addr->parent->cc_local_part : addr->parent->lc_local_part;
205 /* File deliveries have their own flag because they need to be picked out
206 as special more often. */
208 if (testflag(addr, af_pfr))
210 if (testflag(addr, af_file)) address_file = addr->local_part;
211 else if (deliver_localpart[0] == '|') address_pipe = addr->local_part;
212 deliver_localpart = addr->parent->local_part;
213 deliver_localpart_prefix = addr->parent->prefix;
214 deliver_localpart_suffix = addr->parent->suffix;
218 #ifdef EXPERIMENTAL_BRIGHTMAIL
219 /* Set expansion variables related to Brightmail AntiSpam */
220 bmi_base64_verdict = bmi_get_base64_verdict(deliver_localpart_orig, deliver_domain_orig);
221 bmi_base64_tracker_verdict = bmi_get_base64_tracker_verdict(bmi_base64_verdict);
222 /* get message delivery status (0 - don't deliver | 1 - deliver) */
223 bmi_deliver = bmi_get_delivery_status(bmi_base64_verdict);
224 /* if message is to be delivered, get eventual alternate location */
225 if (bmi_deliver == 1) {
226 bmi_alt_location = bmi_get_alt_location(bmi_base64_verdict);
232 /* For multiple addresses, don't set local part, and leave the domain and
233 self_hostname set only if it is the same for all of them. It is possible to
234 have multiple pipe and file addresses, but only when all addresses have routed
235 to the same pipe or file. */
240 if (testflag(addr, af_pfr))
242 if (testflag(addr, af_file)) address_file = addr->local_part;
243 else if (addr->local_part[0] == '|') address_pipe = addr->local_part;
245 for (addr2 = addr->next; addr2 != NULL; addr2 = addr2->next)
247 if (deliver_domain != NULL &&
248 Ustrcmp(deliver_domain, addr2->domain) != 0)
249 deliver_domain = NULL;
250 if (self_hostname != NULL && (addr2->self_hostname == NULL ||
251 Ustrcmp(self_hostname, addr2->self_hostname) != 0))
252 self_hostname = NULL;
253 if (deliver_domain == NULL && self_hostname == NULL) break;
261 /*************************************************
262 * Open a msglog file *
263 *************************************************/
265 /* This function is used both for normal message logs, and for files in the
266 msglog directory that are used to catch output from pipes. Try to create the
267 directory if it does not exist. From release 4.21, normal message logs should
268 be created when the message is received.
271 filename the file name
272 mode the mode required
273 error used for saying what failed
275 Returns: a file descriptor, or -1 (with errno set)
279 open_msglog_file(uschar *filename, int mode, uschar **error)
281 int fd = Uopen(filename, O_WRONLY|O_APPEND|O_CREAT, mode);
283 if (fd < 0 && errno == ENOENT)
286 sprintf(CS temp, "msglog/%s", message_subdir);
287 if (message_subdir[0] == 0) temp[6] = 0;
288 (void)directory_make(spool_directory, temp, MSGLOG_DIRECTORY_MODE, TRUE);
289 fd = Uopen(filename, O_WRONLY|O_APPEND|O_CREAT, mode);
292 /* Set the close-on-exec flag and change the owner to the exim uid/gid (this
293 function is called as root). Double check the mode, because the group setting
294 doesn't always get set automatically. */
298 (void)fcntl(fd, F_SETFD, fcntl(fd, F_GETFD) | FD_CLOEXEC);
299 if (fchown(fd, exim_uid, exim_gid) < 0)
304 if (fchmod(fd, mode) < 0)
310 else *error = US"create";
318 /*************************************************
319 * Write to msglog if required *
320 *************************************************/
322 /* Write to the message log, if configured. This function may also be called
326 format a string format
332 deliver_msglog(const char *format, ...)
335 if (!message_logs) return;
336 va_start(ap, format);
337 vfprintf(message_log, format, ap);
345 /*************************************************
346 * Replicate status for batch *
347 *************************************************/
349 /* When a transport handles a batch of addresses, it may treat them
350 individually, or it may just put the status in the first one, and return FALSE,
351 requesting that the status be copied to all the others externally. This is the
352 replication function. As well as the status, it copies the transport pointer,
353 which may have changed if appendfile passed the addresses on to a different
356 Argument: pointer to the first address in a chain
361 replicate_status(address_item *addr)
364 for (addr2 = addr->next; addr2 != NULL; addr2 = addr2->next)
366 addr2->transport = addr->transport;
367 addr2->transport_return = addr->transport_return;
368 addr2->basic_errno = addr->basic_errno;
369 addr2->more_errno = addr->more_errno;
370 addr2->special_action = addr->special_action;
371 addr2->message = addr->message;
372 addr2->user_message = addr->user_message;
378 /*************************************************
379 * Compare lists of hosts *
380 *************************************************/
382 /* This function is given two pointers to chains of host items, and it yields
383 TRUE if the lists refer to the same hosts in the same order, except that
385 (1) Multiple hosts with the same non-negative MX values are permitted to appear
386 in different orders. Round-robinning nameservers can cause this to happen.
388 (2) Multiple hosts with the same negative MX values less than MX_NONE are also
389 permitted to appear in different orders. This is caused by randomizing
392 This enables Exim to use a single SMTP transaction for sending to two entirely
393 different domains that happen to end up pointing at the same hosts.
396 one points to the first host list
397 two points to the second host list
399 Returns: TRUE if the lists refer to the same host set
403 same_hosts(host_item *one, host_item *two)
405 while (one != NULL && two != NULL)
407 if (Ustrcmp(one->name, two->name) != 0)
410 host_item *end_one = one;
411 host_item *end_two = two;
413 /* Batch up only if there was no MX and the list was not randomized */
415 if (mx == MX_NONE) return FALSE;
417 /* Find the ends of the shortest sequence of identical MX values */
419 while (end_one->next != NULL && end_one->next->mx == mx &&
420 end_two->next != NULL && end_two->next->mx == mx)
422 end_one = end_one->next;
423 end_two = end_two->next;
426 /* If there aren't any duplicates, there's no match. */
428 if (end_one == one) return FALSE;
430 /* For each host in the 'one' sequence, check that it appears in the 'two'
431 sequence, returning FALSE if not. */
436 for (hi = two; hi != end_two->next; hi = hi->next)
437 if (Ustrcmp(one->name, hi->name) == 0) break;
438 if (hi == end_two->next) return FALSE;
439 if (one == end_one) break;
443 /* All the hosts in the 'one' sequence were found in the 'two' sequence.
444 Ensure both are pointing at the last host, and carry on as for equality. */
455 /* True if both are NULL */
462 /*************************************************
463 * Compare header lines *
464 *************************************************/
466 /* This function is given two pointers to chains of header items, and it yields
467 TRUE if they are the same header texts in the same order.
470 one points to the first header list
471 two points to the second header list
473 Returns: TRUE if the lists refer to the same header set
477 same_headers(header_line *one, header_line *two)
481 if (one == two) return TRUE; /* Includes the case where both NULL */
482 if (one == NULL || two == NULL) return FALSE;
483 if (Ustrcmp(one->text, two->text) != 0) return FALSE;
491 /*************************************************
492 * Compare string settings *
493 *************************************************/
495 /* This function is given two pointers to strings, and it returns
496 TRUE if they are the same pointer, or if the two strings are the same.
499 one points to the first string
500 two points to the second string
502 Returns: TRUE or FALSE
506 same_strings(uschar *one, uschar *two)
508 if (one == two) return TRUE; /* Includes the case where both NULL */
509 if (one == NULL || two == NULL) return FALSE;
510 return (Ustrcmp(one, two) == 0);
515 /*************************************************
516 * Compare uid/gid for addresses *
517 *************************************************/
519 /* This function is given a transport and two addresses. It yields TRUE if the
520 uid/gid/initgroups settings for the two addresses are going to be the same when
525 addr1 the first address
526 addr2 the second address
528 Returns: TRUE or FALSE
532 same_ugid(transport_instance *tp, address_item *addr1, address_item *addr2)
534 if (!tp->uid_set && tp->expand_uid == NULL && !tp->deliver_as_creator)
536 if (testflag(addr1, af_uid_set) != testflag(addr2, af_gid_set) ||
537 (testflag(addr1, af_uid_set) &&
538 (addr1->uid != addr2->uid ||
539 testflag(addr1, af_initgroups) != testflag(addr2, af_initgroups))))
543 if (!tp->gid_set && tp->expand_gid == NULL)
545 if (testflag(addr1, af_gid_set) != testflag(addr2, af_gid_set) ||
546 (testflag(addr1, af_gid_set) && addr1->gid != addr2->gid))
556 /*************************************************
557 * Record that an address is complete *
558 *************************************************/
560 /* This function records that an address is complete. This is straightforward
561 for most addresses, where the unique address is just the full address with the
562 domain lower cased. For homonyms (addresses that are the same as one of their
563 ancestors) their are complications. Their unique addresses have \x\ prepended
564 (where x = 0, 1, 2...), so that de-duplication works correctly for siblings and
567 Exim used to record the unique addresses of homonyms as "complete". This,
568 however, fails when the pattern of redirection varies over time (e.g. if taking
569 unseen copies at only some times of day) because the prepended numbers may vary
570 from one delivery run to the next. This problem is solved by never recording
571 prepended unique addresses as complete. Instead, when a homonymic address has
572 actually been delivered via a transport, we record its basic unique address
573 followed by the name of the transport. This is checked in subsequent delivery
574 runs whenever an address is routed to a transport.
576 If the completed address is a top-level one (has no parent, which means it
577 cannot be homonymic) we also add the original address to the non-recipients
578 tree, so that it gets recorded in the spool file and therefore appears as
579 "done" in any spool listings. The original address may differ from the unique
580 address in the case of the domain.
582 Finally, this function scans the list of duplicates, marks as done any that
583 match this address, and calls child_done() for their ancestors.
586 addr address item that has been completed
587 now current time as a string
593 address_done(address_item *addr, uschar *now)
597 update_spool = TRUE; /* Ensure spool gets updated */
599 /* Top-level address */
601 if (addr->parent == NULL)
603 tree_add_nonrecipient(addr->unique);
604 tree_add_nonrecipient(addr->address);
607 /* Homonymous child address */
609 else if (testflag(addr, af_homonym))
611 if (addr->transport != NULL)
613 tree_add_nonrecipient(
614 string_sprintf("%s/%s", addr->unique + 3, addr->transport->name));
618 /* Non-homonymous child address */
620 else tree_add_nonrecipient(addr->unique);
622 /* Check the list of duplicate addresses and ensure they are now marked
625 for (dup = addr_duplicate; dup != NULL; dup = dup->next)
627 if (Ustrcmp(addr->unique, dup->unique) == 0)
629 tree_add_nonrecipient(dup->unique);
630 child_done(dup, now);
638 /*************************************************
639 * Decrease counts in parents and mark done *
640 *************************************************/
642 /* This function is called when an address is complete. If there is a parent
643 address, its count of children is decremented. If there are still other
644 children outstanding, the function exits. Otherwise, if the count has become
645 zero, address_done() is called to mark the parent and its duplicates complete.
646 Then loop for any earlier ancestors.
649 addr points to the completed address item
650 now the current time as a string, for writing to the message log
656 child_done(address_item *addr, uschar *now)
659 while (addr->parent != NULL)
662 if ((addr->child_count -= 1) > 0) return; /* Incomplete parent */
663 address_done(addr, now);
665 /* Log the completion of all descendents only when there is no ancestor with
666 the same original address. */
668 for (aa = addr->parent; aa != NULL; aa = aa->parent)
669 if (Ustrcmp(aa->address, addr->address) == 0) break;
670 if (aa != NULL) continue;
672 deliver_msglog("%s %s: children all complete\n", now, addr->address);
673 DEBUG(D_deliver) debug_printf("%s: children all complete\n", addr->address);
679 /*************************************************
680 * Delivery logging support functions *
681 *************************************************/
683 /* The LOGGING() checks in d_log_interface() are complicated for backwards
684 compatibility. When outgoing interface logging was originally added, it was
685 conditional on just incoming_interface (which is off by default). The
686 outgoing_interface option is on by default to preserve this behaviour, but
687 you can enable incoming_interface and disable outgoing_interface to get I=
688 fields on incoming lines only.
691 s The log line buffer
692 sizep Pointer to the buffer size
693 ptrp Pointer to current index into buffer
694 addr The address to be logged
696 Returns: New value for s
700 d_log_interface(uschar *s, int *sizep, int *ptrp)
702 if (LOGGING(incoming_interface) && LOGGING(outgoing_interface)
703 && sending_ip_address != NULL)
705 s = string_append(s, sizep, ptrp, 2, US" I=[", sending_ip_address);
706 if (LOGGING(outgoing_port))
707 s = string_append(s, sizep, ptrp, 2, US"]:",
708 string_sprintf("%d", sending_port));
710 s = string_cat(s, sizep, ptrp, "]", 1);
718 d_hostlog(uschar *s, int *sizep, int *ptrp, address_item *addr)
720 s = string_append(s, sizep, ptrp, 5, US" H=", addr->host_used->name,
721 US" [", addr->host_used->address, US"]");
722 if (LOGGING(outgoing_port))
723 s = string_append(s, sizep, ptrp, 2, US":", string_sprintf("%d",
724 addr->host_used->port));
725 return d_log_interface(s, sizep, ptrp);
732 d_tlslog(uschar * s, int * sizep, int * ptrp, address_item * addr)
734 if (LOGGING(tls_cipher) && addr->cipher != NULL)
735 s = string_append(s, sizep, ptrp, 2, US" X=", addr->cipher);
736 if (LOGGING(tls_certificate_verified) && addr->cipher != NULL)
737 s = string_append(s, sizep, ptrp, 2, US" CV=",
738 testflag(addr, af_cert_verified)
740 #ifdef EXPERIMENTAL_DANE
741 testflag(addr, af_dane_verified)
747 if (LOGGING(tls_peerdn) && addr->peerdn != NULL)
748 s = string_append(s, sizep, ptrp, 3, US" DN=\"",
749 string_printing(addr->peerdn), US"\"");
757 #ifdef EXPERIMENTAL_EVENT
759 event_raise(uschar * action, const uschar * event, uschar * ev_data)
765 debug_printf("Event(%s): event_action=|%s| delivery_IP=%s\n",
767 action, deliver_host_address);
770 event_data = ev_data;
772 if (!(s = expand_string(action)) && *expand_string_message)
773 log_write(0, LOG_MAIN|LOG_PANIC,
774 "failed to expand event_action %s in %s: %s\n",
775 event, transport_name, expand_string_message);
777 event_name = event_data = NULL;
779 /* If the expansion returns anything but an empty string, flag for
780 the caller to modify his normal processing
785 debug_printf("Event(%s): event_action returned \"%s\"\n", event, s);
793 msg_event_raise(const uschar * event, const address_item * addr)
795 const uschar * save_domain = deliver_domain;
796 uschar * save_local = deliver_localpart;
797 const uschar * save_host = deliver_host;
799 if (!addr->transport)
802 router_name = addr->router ? addr->router->name : NULL;
803 transport_name = addr->transport->name;
804 deliver_domain = addr->domain;
805 deliver_localpart = addr->local_part;
806 deliver_host = addr->host_used ? addr->host_used->name : NULL;
808 (void) event_raise(addr->transport->event_action, event,
809 addr->host_used || Ustrcmp(addr->transport->driver_name, "lmtp") == 0
810 ? addr->message : NULL);
812 deliver_host = save_host;
813 deliver_localpart = save_local;
814 deliver_domain = save_domain;
815 router_name = transport_name = NULL;
817 #endif /*EXPERIMENTAL_EVENT*/
821 /* If msg is NULL this is a delivery log and logchar is used. Otherwise
822 this is a nonstandard call; no two-character delivery flag is written
823 but sender-host and sender are prefixed and "msg" is inserted in the log line.
826 flags passed to log_write()
829 delivery_log(int flags, address_item * addr, int logchar, uschar * msg)
832 int size = 256; /* Used for a temporary, */
833 int ptr = 0; /* expanding buffer, for */
834 uschar *s; /* building log lines; */
835 void *reset_point; /* released afterwards. */
837 /* Log the delivery on the main log. We use an extensible string to build up
838 the log line, and reset the store afterwards. Remote deliveries should always
839 have a pointer to the host item that succeeded; local deliveries can have a
840 pointer to a single host item in their host list, for use by the transport. */
842 #ifdef EXPERIMENTAL_EVENT
843 /* presume no successful remote delivery */
844 lookup_dnssec_authenticated = NULL;
847 s = reset_point = store_get(size);
849 log_address = string_log_address(addr, LOGGING(all_parents), TRUE);
851 s = string_append(s, &size, &ptr, 3, host_and_ident(TRUE), US" ", log_address);
855 s = string_append(s, &size, &ptr, 2, US"> ", log_address);
858 if (LOGGING(sender_on_delivery) || msg)
859 s = string_append(s, &size, &ptr, 3, US" F=<",
860 #ifdef EXPERIMENTAL_INTERNATIONAL
861 testflag(addr, af_utf8_downcvt)
862 ? string_address_utf8_to_alabel(sender_address, NULL)
868 #ifdef EXPERIMENTAL_SRS
869 if(addr->prop.srs_sender)
870 s = string_append(s, &size, &ptr, 3, US" SRS=<", addr->prop.srs_sender, US">");
873 /* You might think that the return path must always be set for a successful
874 delivery; indeed, I did for some time, until this statement crashed. The case
875 when it is not set is for a delivery to /dev/null which is optimised by not
878 if (used_return_path != NULL && LOGGING(return_path_on_delivery))
879 s = string_append(s, &size, &ptr, 3, US" P=<", used_return_path, US">");
882 s = string_append(s, &size, &ptr, 2, US" ", msg);
884 /* For a delivery from a system filter, there may not be a router */
885 if (addr->router != NULL)
886 s = string_append(s, &size, &ptr, 2, US" R=", addr->router->name);
888 s = string_append(s, &size, &ptr, 2, US" T=", addr->transport->name);
890 if (LOGGING(delivery_size))
891 s = string_append(s, &size, &ptr, 2, US" S=",
892 string_sprintf("%d", transport_count));
896 if (addr->transport->info->local)
899 s = string_append(s, &size, &ptr, 2, US" H=", addr->host_list->name);
900 s = d_log_interface(s, &size, &ptr);
901 if (addr->shadow_message != NULL)
902 s = string_cat(s, &size, &ptr, addr->shadow_message,
903 Ustrlen(addr->shadow_message));
906 /* Remote delivery */
912 s = d_hostlog(s, &size, &ptr, addr);
913 if (continue_sequence > 1)
914 s = string_cat(s, &size, &ptr, US"*", 1);
916 #ifdef EXPERIMENTAL_EVENT
917 deliver_host_address = addr->host_used->address;
918 deliver_host_port = addr->host_used->port;
919 deliver_host = addr->host_used->name;
921 /* DNS lookup status */
922 lookup_dnssec_authenticated = addr->host_used->dnssec==DS_YES ? US"yes"
923 : addr->host_used->dnssec==DS_NO ? US"no"
929 s = d_tlslog(s, &size, &ptr, addr);
932 if (addr->authenticator)
934 s = string_append(s, &size, &ptr, 2, US" A=", addr->authenticator);
937 s = string_append(s, &size, &ptr, 2, US":", addr->auth_id);
938 if (LOGGING(smtp_mailauth) && addr->auth_sndr)
939 s = string_append(s, &size, &ptr, 2, US":", addr->auth_sndr);
944 if (addr->flags & af_prdr_used)
945 s = string_append(s, &size, &ptr, 1, US" PRDR");
949 /* confirmation message (SMTP (host_used) and LMTP (driver_name)) */
951 if (LOGGING(smtp_confirmation) && addr->message &&
952 (addr->host_used || Ustrcmp(addr->transport->driver_name, "lmtp") == 0))
955 unsigned lim = big_buffer_size < 1024 ? big_buffer_size : 1024;
956 uschar *p = big_buffer;
957 uschar *ss = addr->message;
959 for (i = 0; i < lim && ss[i] != 0; i++) /* limit logged amount */
961 if (ss[i] == '\"' || ss[i] == '\\') *p++ = '\\'; /* quote \ and " */
966 s = string_append(s, &size, &ptr, 2, US" C=", big_buffer);
969 /* Time on queue and actual time taken to deliver */
971 if (LOGGING(queue_time))
972 s = string_append(s, &size, &ptr, 2, US" QT=",
973 readconf_printtime( (int) ((long)time(NULL) - (long)received_time)) );
975 if (LOGGING(deliver_time))
976 s = string_append(s, &size, &ptr, 2, US" DT=",
977 readconf_printtime(addr->more_errno));
979 /* string_cat() always leaves room for the terminator. Release the
980 store we used to build the line after writing it. */
983 log_write(0, flags, "%s", s);
985 #ifdef EXPERIMENTAL_EVENT
986 if (!msg) msg_event_raise(US"msg:delivery", addr);
989 store_reset(reset_point);
995 /*************************************************
996 * Actions at the end of handling an address *
997 *************************************************/
999 /* This is a function for processing a single address when all that can be done
1000 with it has been done.
1003 addr points to the address block
1004 result the result of the delivery attempt
1005 logflags flags for log_write() (LOG_MAIN and/or LOG_PANIC)
1006 driver_type indicates which type of driver (transport, or router) was last
1007 to process the address
1008 logchar '=' or '-' for use when logging deliveries with => or ->
1014 post_process_one(address_item *addr, int result, int logflags, int driver_type,
1017 uschar *now = tod_stamp(tod_log);
1018 uschar *driver_kind = NULL;
1019 uschar *driver_name = NULL;
1020 uschar *log_address;
1022 int size = 256; /* Used for a temporary, */
1023 int ptr = 0; /* expanding buffer, for */
1024 uschar *s; /* building log lines; */
1025 void *reset_point; /* released afterwards. */
1027 DEBUG(D_deliver) debug_printf("post-process %s (%d)\n", addr->address, result);
1029 /* Set up driver kind and name for logging. Disable logging if the router or
1030 transport has disabled it. */
1032 if (driver_type == DTYPE_TRANSPORT)
1034 if (addr->transport != NULL)
1036 driver_name = addr->transport->name;
1037 driver_kind = US" transport";
1038 disable_logging = addr->transport->disable_logging;
1040 else driver_kind = US"transporting";
1042 else if (driver_type == DTYPE_ROUTER)
1044 if (addr->router != NULL)
1046 driver_name = addr->router->name;
1047 driver_kind = US" router";
1048 disable_logging = addr->router->disable_logging;
1050 else driver_kind = US"routing";
1053 /* If there's an error message set, ensure that it contains only printing
1054 characters - it should, but occasionally things slip in and this at least
1055 stops the log format from getting wrecked. We also scan the message for an LDAP
1056 expansion item that has a password setting, and flatten the password. This is a
1057 fudge, but I don't know a cleaner way of doing this. (If the item is badly
1058 malformed, it won't ever have gone near LDAP.) */
1060 if (addr->message != NULL)
1062 const uschar * s = string_printing(addr->message);
1063 if (s != addr->message)
1064 addr->message = US s;
1065 /* deconst cast ok as string_printing known to have alloc'n'copied */
1066 if (((Ustrstr(addr->message, "failed to expand") != NULL) || (Ustrstr(addr->message, "expansion of ") != NULL)) &&
1067 (Ustrstr(addr->message, "mysql") != NULL ||
1068 Ustrstr(addr->message, "pgsql") != NULL ||
1069 #ifdef EXPERIMENTAL_REDIS
1070 Ustrstr(addr->message, "redis") != NULL ||
1072 Ustrstr(addr->message, "sqlite") != NULL ||
1073 Ustrstr(addr->message, "ldap:") != NULL ||
1074 Ustrstr(addr->message, "ldapdn:") != NULL ||
1075 Ustrstr(addr->message, "ldapm:") != NULL))
1077 addr->message = string_sprintf("Temporary internal error");
1081 /* If we used a transport that has one of the "return_output" options set, and
1082 if it did in fact generate some output, then for return_output we treat the
1083 message as failed if it was not already set that way, so that the output gets
1084 returned to the sender, provided there is a sender to send it to. For
1085 return_fail_output, do this only if the delivery failed. Otherwise we just
1086 unlink the file, and remove the name so that if the delivery failed, we don't
1087 try to send back an empty or unwanted file. The log_output options operate only
1088 on a non-empty file.
1090 In any case, we close the message file, because we cannot afford to leave a
1091 file-descriptor for one address while processing (maybe very many) others. */
1093 if (addr->return_file >= 0 && addr->return_filename != NULL)
1095 BOOL return_output = FALSE;
1096 struct stat statbuf;
1097 (void)EXIMfsync(addr->return_file);
1099 /* If there is no output, do nothing. */
1101 if (fstat(addr->return_file, &statbuf) == 0 && statbuf.st_size > 0)
1103 transport_instance *tb = addr->transport;
1105 /* Handle logging options */
1107 if (tb->log_output || (result == FAIL && tb->log_fail_output) ||
1108 (result == DEFER && tb->log_defer_output))
1111 FILE *f = Ufopen(addr->return_filename, "rb");
1113 log_write(0, LOG_MAIN|LOG_PANIC, "failed to open %s to log output "
1114 "from %s transport: %s", addr->return_filename, tb->name,
1118 s = US Ufgets(big_buffer, big_buffer_size, f);
1121 uschar *p = big_buffer + Ustrlen(big_buffer);
1123 while (p > big_buffer && isspace(p[-1])) p--;
1125 sp = string_printing(big_buffer);
1126 log_write(0, LOG_MAIN, "<%s>: %s transport output: %s",
1127 addr->address, tb->name, sp);
1133 /* Handle returning options, but only if there is an address to return
1136 if (sender_address[0] != 0 || addr->prop.errors_address != NULL)
1138 if (tb->return_output)
1140 addr->transport_return = result = FAIL;
1141 if (addr->basic_errno == 0 && addr->message == NULL)
1142 addr->message = US"return message generated";
1143 return_output = TRUE;
1146 if (tb->return_fail_output && result == FAIL) return_output = TRUE;
1150 /* Get rid of the file unless it might be returned, but close it in
1155 Uunlink(addr->return_filename);
1156 addr->return_filename = NULL;
1157 addr->return_file = -1;
1160 (void)close(addr->return_file);
1163 /* The success case happens only after delivery by a transport. */
1167 addr->next = addr_succeed;
1168 addr_succeed = addr;
1170 /* Call address_done() to ensure that we don't deliver to this address again,
1171 and write appropriate things to the message log. If it is a child address, we
1172 call child_done() to scan the ancestors and mark them complete if this is the
1173 last child to complete. */
1175 address_done(addr, now);
1176 DEBUG(D_deliver) debug_printf("%s delivered\n", addr->address);
1178 if (addr->parent == NULL)
1179 deliver_msglog("%s %s: %s%s succeeded\n", now, addr->address,
1180 driver_name, driver_kind);
1183 deliver_msglog("%s %s <%s>: %s%s succeeded\n", now, addr->address,
1184 addr->parent->address, driver_name, driver_kind);
1185 child_done(addr, now);
1188 /* Certificates for logging (via events) */
1190 tls_out.ourcert = addr->ourcert;
1191 addr->ourcert = NULL;
1192 tls_out.peercert = addr->peercert;
1193 addr->peercert = NULL;
1195 tls_out.cipher = addr->cipher;
1196 tls_out.peerdn = addr->peerdn;
1197 tls_out.ocsp = addr->ocsp;
1198 # ifdef EXPERIMENTAL_DANE
1199 tls_out.dane_verified = testflag(addr, af_dane_verified);
1203 delivery_log(LOG_MAIN, addr, logchar, NULL);
1206 tls_free_cert(&tls_out.ourcert);
1207 tls_free_cert(&tls_out.peercert);
1208 tls_out.cipher = NULL;
1209 tls_out.peerdn = NULL;
1210 tls_out.ocsp = OCSP_NOT_REQ;
1211 # ifdef EXPERIMENTAL_DANE
1212 tls_out.dane_verified = FALSE;
1218 /* Soft failure, or local delivery process failed; freezing may be
1221 else if (result == DEFER || result == PANIC)
1223 if (result == PANIC) logflags |= LOG_PANIC;
1225 /* This puts them on the chain in reverse order. Do not change this, because
1226 the code for handling retries assumes that the one with the retry
1227 information is last. */
1229 addr->next = addr_defer;
1232 /* The only currently implemented special action is to freeze the
1233 message. Logging of this is done later, just before the -H file is
1236 if (addr->special_action == SPECIAL_FREEZE)
1238 deliver_freeze = TRUE;
1239 deliver_frozen_at = time(NULL);
1240 update_spool = TRUE;
1243 /* If doing a 2-stage queue run, we skip writing to either the message
1244 log or the main log for SMTP defers. */
1246 if (!queue_2stage || addr->basic_errno != 0)
1250 /* For errors of the type "retry time not reached" (also remotes skipped
1251 on queue run), logging is controlled by L_retry_defer. Note that this kind
1252 of error number is negative, and all the retry ones are less than any
1255 unsigned int use_log_selector = (addr->basic_errno <= ERRNO_RETRY_BASE)?
1258 /* Build up the line that is used for both the message log and the main
1261 s = reset_point = store_get(size);
1263 /* Create the address string for logging. Must not do this earlier, because
1264 an OK result may be changed to FAIL when a pipe returns text. */
1266 log_address = string_log_address(addr, LOGGING(all_parents), result == OK);
1268 s = string_cat(s, &size, &ptr, log_address, Ustrlen(log_address));
1270 /* Either driver_name contains something and driver_kind contains
1271 " router" or " transport" (note the leading space), or driver_name is
1272 a null string and driver_kind contains "routing" without the leading
1273 space, if all routing has been deferred. When a domain has been held,
1274 so nothing has been done at all, both variables contain null strings. */
1276 if (driver_name == NULL)
1278 if (driver_kind != NULL)
1279 s = string_append(s, &size, &ptr, 2, US" ", driver_kind);
1283 if (driver_kind[1] == 't' && addr->router != NULL)
1284 s = string_append(s, &size, &ptr, 2, US" R=", addr->router->name);
1286 ss[1] = toupper(driver_kind[1]);
1287 s = string_append(s, &size, &ptr, 2, ss, driver_name);
1290 sprintf(CS ss, " defer (%d)", addr->basic_errno);
1291 s = string_cat(s, &size, &ptr, ss, Ustrlen(ss));
1293 if (addr->basic_errno > 0)
1294 s = string_append(s, &size, &ptr, 2, US": ",
1295 US strerror(addr->basic_errno));
1297 if (addr->host_used)
1298 s = string_append(s, &size, &ptr, 5,
1299 US" H=", addr->host_used->name,
1300 US" [", addr->host_used->address, US"]");
1302 if (addr->message != NULL)
1303 s = string_append(s, &size, &ptr, 2, US": ", addr->message);
1307 /* Log the deferment in the message log, but don't clutter it
1308 up with retry-time defers after the first delivery attempt. */
1310 if (deliver_firsttime || addr->basic_errno > ERRNO_RETRY_BASE)
1311 deliver_msglog("%s %s\n", now, s);
1313 /* Write the main log and reset the store */
1315 log_write(use_log_selector, logflags, "== %s", s);
1316 store_reset(reset_point);
1321 /* Hard failure. If there is an address to which an error message can be sent,
1322 put this address on the failed list. If not, put it on the deferred list and
1323 freeze the mail message for human attention. The latter action can also be
1324 explicitly requested by a router or transport. */
1328 /* If this is a delivery error, or a message for which no replies are
1329 wanted, and the message's age is greater than ignore_bounce_errors_after,
1330 force the af_ignore_error flag. This will cause the address to be discarded
1331 later (with a log entry). */
1333 if (sender_address[0] == 0 && message_age >= ignore_bounce_errors_after)
1334 setflag(addr, af_ignore_error);
1336 /* Freeze the message if requested, or if this is a bounce message (or other
1337 message with null sender) and this address does not have its own errors
1338 address. However, don't freeze if errors are being ignored. The actual code
1339 to ignore occurs later, instead of sending a message. Logging of freezing
1340 occurs later, just before writing the -H file. */
1342 if (!testflag(addr, af_ignore_error) &&
1343 (addr->special_action == SPECIAL_FREEZE ||
1344 (sender_address[0] == 0 && addr->prop.errors_address == NULL)
1347 frozen_info = (addr->special_action == SPECIAL_FREEZE)? US"" :
1348 (sender_local && !local_error_message)?
1349 US" (message created with -f <>)" : US" (delivery error message)";
1350 deliver_freeze = TRUE;
1351 deliver_frozen_at = time(NULL);
1352 update_spool = TRUE;
1354 /* The address is put on the defer rather than the failed queue, because
1355 the message is being retained. */
1357 addr->next = addr_defer;
1361 /* Don't put the address on the nonrecipients tree yet; wait until an
1362 error message has been successfully sent. */
1366 addr->next = addr_failed;
1370 /* Build up the log line for the message and main logs */
1372 s = reset_point = store_get(size);
1374 /* Create the address string for logging. Must not do this earlier, because
1375 an OK result may be changed to FAIL when a pipe returns text. */
1377 log_address = string_log_address(addr, LOGGING(all_parents), result == OK);
1379 s = string_cat(s, &size, &ptr, log_address, Ustrlen(log_address));
1381 if (LOGGING(sender_on_delivery))
1382 s = string_append(s, &size, &ptr, 3, US" F=<", sender_address, US">");
1384 /* Return path may not be set if no delivery actually happened */
1386 if (used_return_path != NULL && LOGGING(return_path_on_delivery))
1387 s = string_append(s, &size, &ptr, 3, US" P=<", used_return_path, US">");
1389 if (addr->router != NULL)
1390 s = string_append(s, &size, &ptr, 2, US" R=", addr->router->name);
1391 if (addr->transport != NULL)
1392 s = string_append(s, &size, &ptr, 2, US" T=", addr->transport->name);
1394 if (addr->host_used != NULL)
1395 s = d_hostlog(s, &size, &ptr, addr);
1398 s = d_tlslog(s, &size, &ptr, addr);
1401 if (addr->basic_errno > 0)
1402 s = string_append(s, &size, &ptr, 2, US": ",
1403 US strerror(addr->basic_errno));
1405 if (addr->message != NULL)
1406 s = string_append(s, &size, &ptr, 2, US": ", addr->message);
1410 /* Do the logging. For the message log, "routing failed" for those cases,
1411 just to make it clearer. */
1413 if (driver_name == NULL)
1414 deliver_msglog("%s %s failed for %s\n", now, driver_kind, s);
1416 deliver_msglog("%s %s\n", now, s);
1418 log_write(0, LOG_MAIN, "** %s", s);
1420 #ifdef EXPERIMENTAL_EVENT
1421 msg_event_raise(US"msg:fail:delivery", addr);
1424 store_reset(reset_point);
1427 /* Ensure logging is turned on again in all cases */
1429 disable_logging = FALSE;
1435 /*************************************************
1436 * Address-independent error *
1437 *************************************************/
1439 /* This function is called when there's an error that is not dependent on a
1440 particular address, such as an expansion string failure. It puts the error into
1441 all the addresses in a batch, logs the incident on the main and panic logs, and
1442 clears the expansions. It is mostly called from local_deliver(), but can be
1443 called for a remote delivery via findugid().
1446 logit TRUE if (MAIN+PANIC) logging required
1447 addr the first of the chain of addresses
1449 format format string for error message, or NULL if already set in addr
1450 ... arguments for the format
1456 common_error(BOOL logit, address_item *addr, int code, uschar *format, ...)
1458 address_item *addr2;
1459 addr->basic_errno = code;
1465 va_start(ap, format);
1466 if (!string_vformat(buffer, sizeof(buffer), CS format, ap))
1467 log_write(0, LOG_MAIN|LOG_PANIC_DIE,
1468 "common_error expansion was longer than " SIZE_T_FMT, sizeof(buffer));
1470 addr->message = string_copy(buffer);
1473 for (addr2 = addr->next; addr2 != NULL; addr2 = addr2->next)
1475 addr2->basic_errno = code;
1476 addr2->message = addr->message;
1479 if (logit) log_write(0, LOG_MAIN|LOG_PANIC, "%s", addr->message);
1480 deliver_set_expansions(NULL);
1486 /*************************************************
1487 * Check a "never users" list *
1488 *************************************************/
1490 /* This function is called to check whether a uid is on one of the two "never
1494 uid the uid to be checked
1495 nusers the list to be scanned; the first item in the list is the count
1497 Returns: TRUE if the uid is on the list
1501 check_never_users(uid_t uid, uid_t *nusers)
1504 if (nusers == NULL) return FALSE;
1505 for (i = 1; i <= (int)(nusers[0]); i++) if (nusers[i] == uid) return TRUE;
1511 /*************************************************
1512 * Find uid and gid for a transport *
1513 *************************************************/
1515 /* This function is called for both local and remote deliveries, to find the
1516 uid/gid under which to run the delivery. The values are taken preferentially
1517 from the transport (either explicit or deliver_as_creator), then from the
1518 address (i.e. the router), and if nothing is set, the exim uid/gid are used. If
1519 the resulting uid is on the "never_users" or the "fixed_never_users" list, a
1520 panic error is logged, and the function fails (which normally leads to delivery
1524 addr the address (possibly a chain)
1526 uidp pointer to uid field
1527 gidp pointer to gid field
1528 igfp pointer to the use_initgroups field
1530 Returns: FALSE if failed - error has been set in address(es)
1534 findugid(address_item *addr, transport_instance *tp, uid_t *uidp, gid_t *gidp,
1537 uschar *nuname = NULL;
1538 BOOL gid_set = FALSE;
1540 /* Default initgroups flag comes from the transport */
1542 *igfp = tp->initgroups;
1544 /* First see if there's a gid on the transport, either fixed or expandable.
1545 The expanding function always logs failure itself. */
1552 else if (tp->expand_gid != NULL)
1554 if (route_find_expanded_group(tp->expand_gid, tp->name, US"transport", gidp,
1555 &(addr->message))) gid_set = TRUE;
1558 common_error(FALSE, addr, ERRNO_GIDFAIL, NULL);
1563 /* If the transport did not set a group, see if the router did. */
1565 if (!gid_set && testflag(addr, af_gid_set))
1571 /* Pick up a uid from the transport if one is set. */
1573 if (tp->uid_set) *uidp = tp->uid;
1575 /* Otherwise, try for an expandable uid field. If it ends up as a numeric id,
1576 it does not provide a passwd value from which a gid can be taken. */
1578 else if (tp->expand_uid != NULL)
1581 if (!route_find_expanded_user(tp->expand_uid, tp->name, US"transport", &pw,
1582 uidp, &(addr->message)))
1584 common_error(FALSE, addr, ERRNO_UIDFAIL, NULL);
1587 if (!gid_set && pw != NULL)
1594 /* If the transport doesn't set the uid, test the deliver_as_creator flag. */
1596 else if (tp->deliver_as_creator)
1598 *uidp = originator_uid;
1601 *gidp = originator_gid;
1606 /* Otherwise see if the address specifies the uid and if so, take it and its
1609 else if (testflag(addr, af_uid_set))
1612 *igfp = testflag(addr, af_initgroups);
1615 /* Nothing has specified the uid - default to the Exim user, and group if the
1628 /* If no gid is set, it is a disaster. We default to the Exim gid only if
1629 defaulting to the Exim uid. In other words, if the configuration has specified
1630 a uid, it must also provide a gid. */
1634 common_error(TRUE, addr, ERRNO_GIDFAIL, US"User set without group for "
1635 "%s transport", tp->name);
1639 /* Check that the uid is not on the lists of banned uids that may not be used
1640 for delivery processes. */
1642 if (check_never_users(*uidp, never_users))
1643 nuname = US"never_users";
1644 else if (check_never_users(*uidp, fixed_never_users))
1645 nuname = US"fixed_never_users";
1649 common_error(TRUE, addr, ERRNO_UIDFAIL, US"User %ld set for %s transport "
1650 "is on the %s list", (long int)(*uidp), tp->name, nuname);
1662 /*************************************************
1663 * Check the size of a message for a transport *
1664 *************************************************/
1666 /* Checks that the message isn't too big for the selected transport.
1667 This is called only when it is known that the limit is set.
1671 addr the (first) address being delivered
1674 DEFER expansion failed or did not yield an integer
1675 FAIL message too big
1679 check_message_size(transport_instance *tp, address_item *addr)
1684 deliver_set_expansions(addr);
1685 size_limit = expand_string_integer(tp->message_size_limit, TRUE);
1686 deliver_set_expansions(NULL);
1688 if (expand_string_message != NULL)
1691 if (size_limit == -1)
1692 addr->message = string_sprintf("failed to expand message_size_limit "
1693 "in %s transport: %s", tp->name, expand_string_message);
1695 addr->message = string_sprintf("invalid message_size_limit "
1696 "in %s transport: %s", tp->name, expand_string_message);
1698 else if (size_limit > 0 && message_size > size_limit)
1702 string_sprintf("message is too big (transport limit = %d)",
1711 /*************************************************
1712 * Transport-time check for a previous delivery *
1713 *************************************************/
1715 /* Check that this base address hasn't previously been delivered to its routed
1716 transport. If it has been delivered, mark it done. The check is necessary at
1717 delivery time in order to handle homonymic addresses correctly in cases where
1718 the pattern of redirection changes between delivery attempts (so the unique
1719 fields change). Non-homonymic previous delivery is detected earlier, at routing
1720 time (which saves unnecessary routing).
1723 addr the address item
1724 testing TRUE if testing wanted only, without side effects
1726 Returns: TRUE if previously delivered by the transport
1730 previously_transported(address_item *addr, BOOL testing)
1732 (void)string_format(big_buffer, big_buffer_size, "%s/%s",
1733 addr->unique + (testflag(addr, af_homonym)? 3:0), addr->transport->name);
1735 if (tree_search(tree_nonrecipients, big_buffer) != 0)
1737 DEBUG(D_deliver|D_route|D_transport)
1738 debug_printf("%s was previously delivered (%s transport): discarded\n",
1739 addr->address, addr->transport->name);
1740 if (!testing) child_done(addr, tod_stamp(tod_log));
1749 /******************************************************
1750 * Check for a given header in a header string *
1751 ******************************************************/
1753 /* This function is used when generating quota warnings. The configuration may
1754 specify any header lines it likes in quota_warn_message. If certain of them are
1755 missing, defaults are inserted, so we need to be able to test for the presence
1759 hdr the required header name
1760 hstring the header string
1762 Returns: TRUE the header is in the string
1763 FALSE the header is not in the string
1767 contains_header(uschar *hdr, uschar *hstring)
1769 int len = Ustrlen(hdr);
1770 uschar *p = hstring;
1773 if (strncmpic(p, hdr, len) == 0)
1776 while (*p == ' ' || *p == '\t') p++;
1777 if (*p == ':') return TRUE;
1779 while (*p != 0 && *p != '\n') p++;
1780 if (*p == '\n') p++;
1788 /*************************************************
1789 * Perform a local delivery *
1790 *************************************************/
1792 /* Each local delivery is performed in a separate process which sets its
1793 uid and gid as specified. This is a safer way than simply changing and
1794 restoring using seteuid(); there is a body of opinion that seteuid() cannot be
1795 used safely. From release 4, Exim no longer makes any use of it. Besides, not
1796 all systems have seteuid().
1798 If the uid/gid are specified in the transport_instance, they are used; the
1799 transport initialization must ensure that either both or neither are set.
1800 Otherwise, the values associated with the address are used. If neither are set,
1801 it is a configuration error.
1803 The transport or the address may specify a home directory (transport over-
1804 rides), and if they do, this is set as $home. If neither have set a working
1805 directory, this value is used for that as well. Otherwise $home is left unset
1806 and the cwd is set to "/" - a directory that should be accessible to all users.
1808 Using a separate process makes it more complicated to get error information
1809 back. We use a pipe to pass the return code and also an error code and error
1810 text string back to the parent process.
1813 addr points to an address block for this delivery; for "normal" local
1814 deliveries this is the only address to be delivered, but for
1815 pseudo-remote deliveries (e.g. by batch SMTP to a file or pipe)
1816 a number of addresses can be handled simultaneously, and in this
1817 case addr will point to a chain of addresses with the same
1820 shadowing TRUE if running a shadow transport; this causes output from pipes
1827 deliver_local(address_item *addr, BOOL shadowing)
1829 BOOL use_initgroups;
1832 int status, len, rc;
1835 uschar *working_directory;
1836 address_item *addr2;
1837 transport_instance *tp = addr->transport;
1839 /* Set up the return path from the errors or sender address. If the transport
1840 has its own return path setting, expand it and replace the existing value. */
1842 if(addr->prop.errors_address != NULL)
1843 return_path = addr->prop.errors_address;
1844 #ifdef EXPERIMENTAL_SRS
1845 else if(addr->prop.srs_sender != NULL)
1846 return_path = addr->prop.srs_sender;
1849 return_path = sender_address;
1851 if (tp->return_path != NULL)
1853 uschar *new_return_path = expand_string(tp->return_path);
1854 if (new_return_path == NULL)
1856 if (!expand_string_forcedfail)
1858 common_error(TRUE, addr, ERRNO_EXPANDFAIL,
1859 US"Failed to expand return path \"%s\" in %s transport: %s",
1860 tp->return_path, tp->name, expand_string_message);
1864 else return_path = new_return_path;
1867 /* For local deliveries, one at a time, the value used for logging can just be
1868 set directly, once and for all. */
1870 used_return_path = return_path;
1872 /* Sort out the uid, gid, and initgroups flag. If an error occurs, the message
1873 gets put into the address(es), and the expansions are unset, so we can just
1876 if (!findugid(addr, tp, &uid, &gid, &use_initgroups)) return;
1878 /* See if either the transport or the address specifies a home directory. A
1879 home directory set in the address may already be expanded; a flag is set to
1880 indicate that. In other cases we must expand it. */
1882 if ((deliver_home = tp->home_dir) != NULL || /* Set in transport, or */
1883 ((deliver_home = addr->home_dir) != NULL && /* Set in address and */
1884 !testflag(addr, af_home_expanded))) /* not expanded */
1886 uschar *rawhome = deliver_home;
1887 deliver_home = NULL; /* in case it contains $home */
1888 deliver_home = expand_string(rawhome);
1889 if (deliver_home == NULL)
1891 common_error(TRUE, addr, ERRNO_EXPANDFAIL, US"home directory \"%s\" failed "
1892 "to expand for %s transport: %s", rawhome, tp->name,
1893 expand_string_message);
1896 if (*deliver_home != '/')
1898 common_error(TRUE, addr, ERRNO_NOTABSOLUTE, US"home directory path \"%s\" "
1899 "is not absolute for %s transport", deliver_home, tp->name);
1904 /* See if either the transport or the address specifies a current directory,
1905 and if so, expand it. If nothing is set, use the home directory, unless it is
1906 also unset in which case use "/", which is assumed to be a directory to which
1907 all users have access. It is necessary to be in a visible directory for some
1908 operating systems when running pipes, as some commands (e.g. "rm" under Solaris
1909 2.5) require this. */
1911 working_directory = (tp->current_dir != NULL)?
1912 tp->current_dir : addr->current_dir;
1914 if (working_directory != NULL)
1916 uschar *raw = working_directory;
1917 working_directory = expand_string(raw);
1918 if (working_directory == NULL)
1920 common_error(TRUE, addr, ERRNO_EXPANDFAIL, US"current directory \"%s\" "
1921 "failed to expand for %s transport: %s", raw, tp->name,
1922 expand_string_message);
1925 if (*working_directory != '/')
1927 common_error(TRUE, addr, ERRNO_NOTABSOLUTE, US"current directory path "
1928 "\"%s\" is not absolute for %s transport", working_directory, tp->name);
1932 else working_directory = (deliver_home == NULL)? US"/" : deliver_home;
1934 /* If one of the return_output flags is set on the transport, create and open a
1935 file in the message log directory for the transport to write its output onto.
1936 This is mainly used by pipe transports. The file needs to be unique to the
1937 address. This feature is not available for shadow transports. */
1939 if (!shadowing && (tp->return_output || tp->return_fail_output ||
1940 tp->log_output || tp->log_fail_output))
1943 addr->return_filename =
1944 string_sprintf("%s/msglog/%s/%s-%d-%d", spool_directory, message_subdir,
1945 message_id, getpid(), return_count++);
1946 addr->return_file = open_msglog_file(addr->return_filename, 0400, &error);
1947 if (addr->return_file < 0)
1949 common_error(TRUE, addr, errno, US"Unable to %s file for %s transport "
1950 "to return message: %s", error, tp->name, strerror(errno));
1955 /* Create the pipe for inter-process communication. */
1959 common_error(TRUE, addr, ERRNO_PIPEFAIL, US"Creation of pipe failed: %s",
1964 /* Now fork the process to do the real work in the subprocess, but first
1965 ensure that all cached resources are freed so that the subprocess starts with
1966 a clean slate and doesn't interfere with the parent process. */
1970 if ((pid = fork()) == 0)
1972 BOOL replicate = TRUE;
1974 /* Prevent core dumps, as we don't want them in users' home directories.
1975 HP-UX doesn't have RLIMIT_CORE; I don't know how to do this in that
1976 system. Some experimental/developing systems (e.g. GNU/Hurd) may define
1977 RLIMIT_CORE but not support it in setrlimit(). For such systems, do not
1978 complain if the error is "not supported".
1980 There are two scenarios where changing the max limit has an effect. In one,
1981 the user is using a .forward and invoking a command of their choice via pipe;
1982 for these, we do need the max limit to be 0 unless the admin chooses to
1983 permit an increased limit. In the other, the command is invoked directly by
1984 the transport and is under administrator control, thus being able to raise
1985 the limit aids in debugging. So there's no general always-right answer.
1987 Thus we inhibit core-dumps completely but let individual transports, while
1988 still root, re-raise the limits back up to aid debugging. We make the
1989 default be no core-dumps -- few enough people can use core dumps in
1990 diagnosis that it's reasonable to make them something that has to be explicitly requested.
1997 if (setrlimit(RLIMIT_CORE, &rl) < 0)
1999 # ifdef SETRLIMIT_NOT_SUPPORTED
2000 if (errno != ENOSYS && errno != ENOTSUP)
2002 log_write(0, LOG_MAIN|LOG_PANIC, "setrlimit(RLIMIT_CORE) failed: %s",
2007 /* Reset the random number generator, so different processes don't all
2008 have the same sequence. */
2012 /* If the transport has a setup entry, call this first, while still
2013 privileged. (Appendfile uses this to expand quota, for example, while
2014 able to read private files.) */
2016 if (addr->transport->setup != NULL)
2018 switch((addr->transport->setup)(addr->transport, addr, NULL, uid, gid,
2022 addr->transport_return = DEFER;
2026 addr->transport_return = PANIC;
2031 /* Ignore SIGINT and SIGTERM during delivery. Also ignore SIGUSR1, as
2032 when the process becomes unprivileged, it won't be able to write to the
2033 process log. SIGHUP is ignored throughout exim, except when it is being
2036 signal(SIGINT, SIG_IGN);
2037 signal(SIGTERM, SIG_IGN);
2038 signal(SIGUSR1, SIG_IGN);
2040 /* Close the unwanted half of the pipe, and set close-on-exec for the other
2041 half - for transports that exec things (e.g. pipe). Then set the required
2044 (void)close(pfd[pipe_read]);
2045 (void)fcntl(pfd[pipe_write], F_SETFD, fcntl(pfd[pipe_write], F_GETFD) |
2047 exim_setugid(uid, gid, use_initgroups,
2048 string_sprintf("local delivery to %s <%s> transport=%s", addr->local_part,
2049 addr->address, addr->transport->name));
2053 address_item *batched;
2054 debug_printf(" home=%s current=%s\n", deliver_home, working_directory);
2055 for (batched = addr->next; batched != NULL; batched = batched->next)
2056 debug_printf("additional batched address: %s\n", batched->address);
2059 /* Set an appropriate working directory. */
2061 if (Uchdir(working_directory) < 0)
2063 addr->transport_return = DEFER;
2064 addr->basic_errno = errno;
2065 addr->message = string_sprintf("failed to chdir to %s", working_directory);
2068 /* If successful, call the transport */
2073 set_process_info("delivering %s to %s using %s", message_id,
2074 addr->local_part, addr->transport->name);
2076 /* Setting this global in the subprocess means we need never clear it */
2077 transport_name = addr->transport->name;
2079 /* If a transport filter has been specified, set up its argument list.
2080 Any errors will get put into the address, and FALSE yielded. */
2082 if (addr->transport->filter_command != NULL)
2084 ok = transport_set_up_command(&transport_filter_argv,
2085 addr->transport->filter_command,
2086 TRUE, PANIC, addr, US"transport filter", NULL);
2087 transport_filter_timeout = addr->transport->filter_timeout;
2089 else transport_filter_argv = NULL;
2093 debug_print_string(addr->transport->debug_string);
2094 replicate = !(addr->transport->info->code)(addr->transport, addr);
2098 /* Pass the results back down the pipe. If necessary, first replicate the
2099 status in the top address to the others in the batch. The label is the
2100 subject of a goto when a call to the transport's setup function fails. We
2101 pass the pointer to the transport back in case it got changed as a result of
2102 file_format in appendfile. */
2106 if (replicate) replicate_status(addr);
2107 for (addr2 = addr; addr2 != NULL; addr2 = addr2->next)
2110 int local_part_length = Ustrlen(addr2->local_part);
2114 if( (ret = write(pfd[pipe_write], (void *)&(addr2->transport_return), sizeof(int))) != sizeof(int)
2115 || (ret = write(pfd[pipe_write], (void *)&transport_count, sizeof(transport_count))) != sizeof(transport_count)
2116 || (ret = write(pfd[pipe_write], (void *)&(addr2->flags), sizeof(addr2->flags))) != sizeof(addr2->flags)
2117 || (ret = write(pfd[pipe_write], (void *)&(addr2->basic_errno), sizeof(int))) != sizeof(int)
2118 || (ret = write(pfd[pipe_write], (void *)&(addr2->more_errno), sizeof(int))) != sizeof(int)
2119 || (ret = write(pfd[pipe_write], (void *)&(addr2->special_action), sizeof(int))) != sizeof(int)
2120 || (ret = write(pfd[pipe_write], (void *)&(addr2->transport),
2121 sizeof(transport_instance *))) != sizeof(transport_instance *)
2123 /* For a file delivery, pass back the local part, in case the original
2124 was only part of the final delivery path. This gives more complete
2127 || (testflag(addr2, af_file)
2128 && ( (ret = write(pfd[pipe_write], (void *)&local_part_length, sizeof(int))) != sizeof(int)
2129 || (ret = write(pfd[pipe_write], addr2->local_part, local_part_length)) != local_part_length
2133 log_write(0, LOG_MAIN|LOG_PANIC, "Failed writing transport results to pipe: %s\n",
2134 ret == -1 ? strerror(errno) : "short write");
2136 /* Now any messages */
2138 for (i = 0, s = addr2->message; i < 2; i++, s = addr2->user_message)
2140 int message_length = (s == NULL)? 0 : Ustrlen(s) + 1;
2141 if( (ret = write(pfd[pipe_write], (void *)&message_length, sizeof(int))) != sizeof(int)
2142 || (message_length > 0 && (ret = write(pfd[pipe_write], s, message_length)) != message_length)
2144 log_write(0, LOG_MAIN|LOG_PANIC, "Failed writing transport results to pipe: %s\n",
2145 ret == -1 ? strerror(errno) : "short write");
2149 /* OK, this process is now done. Free any cached resources that it opened,
2150 and close the pipe we were writing down before exiting. */
2152 (void)close(pfd[pipe_write]);
2157 /* Back in the main process: panic if the fork did not succeed. This seems
2158 better than returning an error - if forking is failing it is probably best
2159 not to try other deliveries for this message. */
2162 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Fork failed for local delivery to %s",
2165 /* Read the pipe to get the delivery status codes and error messages. Our copy
2166 of the writing end must be closed first, as otherwise read() won't return zero
2167 on an empty pipe. We check that a status exists for each address before
2168 overwriting the address structure. If data is missing, the default DEFER status
2169 will remain. Afterwards, close the reading end. */
2171 (void)close(pfd[pipe_write]);
2173 for (addr2 = addr; addr2 != NULL; addr2 = addr2->next)
2175 len = read(pfd[pipe_read], (void *)&status, sizeof(int));
2181 addr2->transport_return = status;
2182 len = read(pfd[pipe_read], (void *)&transport_count,
2183 sizeof(transport_count));
2184 len = read(pfd[pipe_read], (void *)&(addr2->flags), sizeof(addr2->flags));
2185 len = read(pfd[pipe_read], (void *)&(addr2->basic_errno), sizeof(int));
2186 len = read(pfd[pipe_read], (void *)&(addr2->more_errno), sizeof(int));
2187 len = read(pfd[pipe_read], (void *)&(addr2->special_action), sizeof(int));
2188 len = read(pfd[pipe_read], (void *)&(addr2->transport),
2189 sizeof(transport_instance *));
2191 if (testflag(addr2, af_file))
2193 int local_part_length;
2194 len = read(pfd[pipe_read], (void *)&local_part_length, sizeof(int));
2195 len = read(pfd[pipe_read], (void *)big_buffer, local_part_length);
2196 big_buffer[local_part_length] = 0;
2197 addr2->local_part = string_copy(big_buffer);
2200 for (i = 0, sptr = &(addr2->message); i < 2;
2201 i++, sptr = &(addr2->user_message))
2204 len = read(pfd[pipe_read], (void *)&message_length, sizeof(int));
2205 if (message_length > 0)
2207 len = read(pfd[pipe_read], (void *)big_buffer, message_length);
2208 if (len > 0) *sptr = string_copy(big_buffer);
2215 log_write(0, LOG_MAIN|LOG_PANIC, "failed to read delivery status for %s "
2216 "from delivery subprocess", addr2->unique);
2221 (void)close(pfd[pipe_read]);
2223 /* Unless shadowing, write all successful addresses immediately to the journal
2224 file, to ensure they are recorded asap. For homonymic addresses, use the base
2225 address plus the transport name. Failure to write the journal is panic-worthy,
2226 but don't stop, as it may prove possible subsequently to update the spool file
2227 in order to record the delivery. */
2231 for (addr2 = addr; addr2 != NULL; addr2 = addr2->next)
2233 if (addr2->transport_return != OK) continue;
2235 if (testflag(addr2, af_homonym))
2236 sprintf(CS big_buffer, "%.500s/%s\n", addr2->unique + 3, tp->name);
2238 sprintf(CS big_buffer, "%.500s\n", addr2->unique);
2240 /* In the test harness, wait just a bit to let the subprocess finish off
2241 any debug output etc first. */
2243 if (running_in_test_harness) millisleep(300);
2245 DEBUG(D_deliver) debug_printf("journalling %s", big_buffer);
2246 len = Ustrlen(big_buffer);
2247 if (write(journal_fd, big_buffer, len) != len)
2248 log_write(0, LOG_MAIN|LOG_PANIC, "failed to update journal for %s: %s",
2249 big_buffer, strerror(errno));
2252 /* Ensure the journal file is pushed out to disk. */
2254 if (EXIMfsync(journal_fd) < 0)
2255 log_write(0, LOG_MAIN|LOG_PANIC, "failed to fsync journal: %s",
2259 /* Wait for the process to finish. If it terminates with a non-zero code,
2260 freeze the message (except for SIGTERM, SIGKILL and SIGQUIT), but leave the
2261 status values of all the addresses as they are. Take care to handle the case
2262 when the subprocess doesn't seem to exist. This has been seen on one system
2263 when Exim was called from an MUA that set SIGCHLD to SIG_IGN. When that
2264 happens, wait() doesn't recognize the termination of child processes. Exim now
2265 resets SIGCHLD to SIG_DFL, but this code should still be robust. */
2267 while ((rc = wait(&status)) != pid)
2269 if (rc < 0 && errno == ECHILD) /* Process has vanished */
2271 log_write(0, LOG_MAIN, "%s transport process vanished unexpectedly",
2272 addr->transport->driver_name);
2278 if ((status & 0xffff) != 0)
2280 int msb = (status >> 8) & 255;
2281 int lsb = status & 255;
2282 int code = (msb == 0)? (lsb & 0x7f) : msb;
2283 if (msb != 0 || (code != SIGTERM && code != SIGKILL && code != SIGQUIT))
2284 addr->special_action = SPECIAL_FREEZE;
2285 log_write(0, LOG_MAIN|LOG_PANIC, "%s transport process returned non-zero "
2286 "status 0x%04x: %s %d",
2287 addr->transport->driver_name,
2289 (msb == 0)? "terminated by signal" : "exit code",
2293 /* If SPECIAL_WARN is set in the top address, send a warning message. */
2295 if (addr->special_action == SPECIAL_WARN &&
2296 addr->transport->warn_message != NULL)
2299 uschar *warn_message;
2301 DEBUG(D_deliver) debug_printf("Warning message requested by transport\n");
2303 warn_message = expand_string(addr->transport->warn_message);
2304 if (warn_message == NULL)
2305 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand \"%s\" (warning "
2306 "message for %s transport): %s", addr->transport->warn_message,
2307 addr->transport->name, expand_string_message);
2310 pid_t pid = child_open_exim(&fd);
2313 FILE *f = fdopen(fd, "wb");
2314 if (errors_reply_to != NULL &&
2315 !contains_header(US"Reply-To", warn_message))
2316 fprintf(f, "Reply-To: %s\n", errors_reply_to);
2317 fprintf(f, "Auto-Submitted: auto-replied\n");
2318 if (!contains_header(US"From", warn_message)) moan_write_from(f);
2319 fprintf(f, "%s", CS warn_message);
2321 /* Close and wait for child process to complete, without a timeout. */
2324 (void)child_close(pid, 0);
2328 addr->special_action = SPECIAL_NONE;
2334 /*************************************************
2335 * Do local deliveries *
2336 *************************************************/
2338 /* This function processes the list of addresses in addr_local. True local
2339 deliveries are always done one address at a time. However, local deliveries can
2340 be batched up in some cases. Typically this is when writing batched SMTP output
2341 files for use by some external transport mechanism, or when running local
2342 deliveries over LMTP.
2349 do_local_deliveries(void)
2352 open_db *dbm_file = NULL;
2353 time_t now = time(NULL);
2355 /* Loop until we have exhausted the supply of local deliveries */
2357 while (addr_local != NULL)
2359 time_t delivery_start;
2361 address_item *addr2, *addr3, *nextaddr;
2362 int logflags = LOG_MAIN;
2363 int logchar = dont_deliver? '*' : '=';
2364 transport_instance *tp;
2366 /* Pick the first undelivered address off the chain */
2368 address_item *addr = addr_local;
2369 addr_local = addr->next;
2372 DEBUG(D_deliver|D_transport)
2373 debug_printf("--------> %s <--------\n", addr->address);
2375 /* An internal disaster if there is no transport. Should not occur! */
2377 if ((tp = addr->transport) == NULL)
2379 logflags |= LOG_PANIC;
2380 disable_logging = FALSE; /* Jic */
2382 (addr->router != NULL)?
2383 string_sprintf("No transport set by %s router", addr->router->name)
2385 string_sprintf("No transport set by system filter");
2386 post_process_one(addr, DEFER, logflags, DTYPE_TRANSPORT, 0);
2390 /* Check that this base address hasn't previously been delivered to this
2391 transport. The check is necessary at this point to handle homonymic addresses
2392 correctly in cases where the pattern of redirection changes between delivery
2393 attempts. Non-homonymic previous delivery is detected earlier, at routing
2396 if (previously_transported(addr, FALSE)) continue;
2398 /* There are weird cases where logging is disabled */
2400 disable_logging = tp->disable_logging;
2402 /* Check for batched addresses and possible amalgamation. Skip all the work
2403 if either batch_max <= 1 or there aren't any other addresses for local
2406 if (tp->batch_max > 1 && addr_local != NULL)
2408 int batch_count = 1;
2409 BOOL uses_dom = readconf_depends((driver_instance *)tp, US"domain");
2410 BOOL uses_lp = (testflag(addr, af_pfr) &&
2411 (testflag(addr, af_file) || addr->local_part[0] == '|')) ||
2412 readconf_depends((driver_instance *)tp, US"local_part");
2413 uschar *batch_id = NULL;
2414 address_item **anchor = &addr_local;
2415 address_item *last = addr;
2418 /* Expand the batch_id string for comparison with other addresses.
2419 Expansion failure suppresses batching. */
2421 if (tp->batch_id != NULL)
2423 deliver_set_expansions(addr);
2424 batch_id = expand_string(tp->batch_id);
2425 deliver_set_expansions(NULL);
2426 if (batch_id == NULL)
2428 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand batch_id option "
2429 "in %s transport (%s): %s", tp->name, addr->address,
2430 expand_string_message);
2431 batch_count = tp->batch_max;
2435 /* Until we reach the batch_max limit, pick off addresses which have the
2436 same characteristics. These are:
2439 not previously delivered (see comment about 50 lines above)
2440 same local part if the transport's configuration contains $local_part
2441 or if this is a file or pipe delivery from a redirection
2442 same domain if the transport's configuration contains $domain
2444 same additional headers
2445 same headers to be removed
2446 same uid/gid for running the transport
2447 same first host if a host list is set
2450 while ((next = *anchor) != NULL && batch_count < tp->batch_max)
2453 tp == next->transport &&
2454 !previously_transported(next, TRUE) &&
2455 (addr->flags & (af_pfr|af_file)) == (next->flags & (af_pfr|af_file)) &&
2456 (!uses_lp || Ustrcmp(next->local_part, addr->local_part) == 0) &&
2457 (!uses_dom || Ustrcmp(next->domain, addr->domain) == 0) &&
2458 same_strings(next->prop.errors_address, addr->prop.errors_address) &&
2459 same_headers(next->prop.extra_headers, addr->prop.extra_headers) &&
2460 same_strings(next->prop.remove_headers, addr->prop.remove_headers) &&
2461 same_ugid(tp, addr, next) &&
2462 ((addr->host_list == NULL && next->host_list == NULL) ||
2463 (addr->host_list != NULL && next->host_list != NULL &&
2464 Ustrcmp(addr->host_list->name, next->host_list->name) == 0));
2466 /* If the transport has a batch_id setting, batch_id will be non-NULL
2467 from the expansion outside the loop. Expand for this address and compare.
2468 Expansion failure makes this address ineligible for batching. */
2470 if (ok && batch_id != NULL)
2473 address_item *save_nextnext = next->next;
2474 next->next = NULL; /* Expansion for a single address */
2475 deliver_set_expansions(next);
2476 next->next = save_nextnext;
2477 bid = expand_string(tp->batch_id);
2478 deliver_set_expansions(NULL);
2481 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand batch_id option "
2482 "in %s transport (%s): %s", tp->name, next->address,
2483 expand_string_message);
2486 else ok = (Ustrcmp(batch_id, bid) == 0);
2489 /* Take address into batch if OK. */
2493 *anchor = next->next; /* Include the address */
2499 else anchor = &(next->next); /* Skip the address */
2503 /* We now have one or more addresses that can be delivered in a batch. Check
2504 whether the transport is prepared to accept a message of this size. If not,
2505 fail them all forthwith. If the expansion fails, or does not yield an
2506 integer, defer delivery. */
2508 if (tp->message_size_limit != NULL)
2510 int rc = check_message_size(tp, addr);
2513 replicate_status(addr);
2514 while (addr != NULL)
2517 post_process_one(addr, rc, logflags, DTYPE_TRANSPORT, 0);
2520 continue; /* With next batch of addresses */
2524 /* If we are not running the queue, or if forcing, all deliveries will be
2525 attempted. Otherwise, we must respect the retry times for each address. Even
2526 when not doing this, we need to set up the retry key string, and determine
2527 whether a retry record exists, because after a successful delivery, a delete
2528 retry item must be set up. Keep the retry database open only for the duration
2529 of these checks, rather than for all local deliveries, because some local
2530 deliveries (e.g. to pipes) can take a substantial time. */
2532 dbm_file = dbfn_open(US"retry", O_RDONLY, &dbblock, FALSE);
2533 if (dbm_file == NULL)
2535 DEBUG(D_deliver|D_retry|D_hints_lookup)
2536 debug_printf("no retry data available\n");
2541 while (addr2 != NULL)
2543 BOOL ok = TRUE; /* to deliver this address */
2546 /* Set up the retry key to include the domain or not, and change its
2547 leading character from "R" to "T". Must make a copy before doing this,
2548 because the old key may be pointed to from a "delete" retry item after
2551 retry_key = string_copy(
2552 (tp->retry_use_local_part)? addr2->address_retry_key :
2553 addr2->domain_retry_key);
2556 /* Inspect the retry data. If there is no hints file, delivery happens. */
2558 if (dbm_file != NULL)
2560 dbdata_retry *retry_record = dbfn_read(dbm_file, retry_key);
2562 /* If there is no retry record, delivery happens. If there is,
2563 remember it exists so it can be deleted after a successful delivery. */
2565 if (retry_record != NULL)
2567 setflag(addr2, af_lt_retry_exists);
2569 /* A retry record exists for this address. If queue running and not
2570 forcing, inspect its contents. If the record is too old, or if its
2571 retry time has come, or if it has passed its cutoff time, delivery
2576 debug_printf("retry record exists: age=%s ",
2577 readconf_printtime(now - retry_record->time_stamp));
2578 debug_printf("(max %s)\n", readconf_printtime(retry_data_expire));
2579 debug_printf(" time to retry = %s expired = %d\n",
2580 readconf_printtime(retry_record->next_try - now),
2581 retry_record->expired);
2584 if (queue_running && !deliver_force)
2586 ok = (now - retry_record->time_stamp > retry_data_expire) ||
2587 (now >= retry_record->next_try) ||
2588 retry_record->expired;
2590 /* If we haven't reached the retry time, there is one more check
2591 to do, which is for the ultimate address timeout. */
2594 ok = retry_ultimate_address_timeout(retry_key, addr2->domain,
2598 else DEBUG(D_retry) debug_printf("no retry record exists\n");
2601 /* This address is to be delivered. Leave it on the chain. */
2606 addr2 = addr2->next;
2609 /* This address is to be deferred. Take it out of the chain, and
2610 post-process it as complete. Must take it out of the chain first,
2611 because post processing puts it on another chain. */
2615 address_item *this = addr2;
2616 this->message = US"Retry time not yet reached";
2617 this->basic_errno = ERRNO_LRETRY;
2618 if (addr3 == NULL) addr2 = addr = addr2->next;
2619 else addr2 = addr3->next = addr2->next;
2620 post_process_one(this, DEFER, logflags, DTYPE_TRANSPORT, 0);
2624 if (dbm_file != NULL) dbfn_close(dbm_file);
2626 /* If there are no addresses left on the chain, they all deferred. Loop
2627 for the next set of addresses. */
2629 if (addr == NULL) continue;
2631 /* So, finally, we do have some addresses that can be passed to the
2632 transport. Before doing so, set up variables that are relevant to a
2635 deliver_set_expansions(addr);
2636 delivery_start = time(NULL);
2637 deliver_local(addr, FALSE);
2638 deliver_time = (int)(time(NULL) - delivery_start);
2640 /* If a shadow transport (which must perforce be another local transport), is
2641 defined, and its condition is met, we must pass the message to the shadow
2642 too, but only those addresses that succeeded. We do this by making a new
2643 chain of addresses - also to keep the original chain uncontaminated. We must
2644 use a chain rather than doing it one by one, because the shadow transport may
2647 NOTE: if the condition fails because of a lookup defer, there is nothing we
2650 if (tp->shadow != NULL &&
2651 (tp->shadow_condition == NULL ||
2652 expand_check_condition(tp->shadow_condition, tp->name, US"transport")))
2654 transport_instance *stp;
2655 address_item *shadow_addr = NULL;
2656 address_item **last = &shadow_addr;
2658 for (stp = transports; stp != NULL; stp = stp->next)
2659 if (Ustrcmp(stp->name, tp->shadow) == 0) break;
2662 log_write(0, LOG_MAIN|LOG_PANIC, "shadow transport \"%s\" not found ",
2665 /* Pick off the addresses that have succeeded, and make clones. Put into
2666 the shadow_message field a pointer to the shadow_message field of the real
2669 else for (addr2 = addr; addr2 != NULL; addr2 = addr2->next)
2671 if (addr2->transport_return != OK) continue;
2672 addr3 = store_get(sizeof(address_item));
2675 addr3->shadow_message = (uschar *)(&(addr2->shadow_message));
2676 addr3->transport = stp;
2677 addr3->transport_return = DEFER;
2678 addr3->return_filename = NULL;
2679 addr3->return_file = -1;
2681 last = &(addr3->next);
2684 /* If we found any addresses to shadow, run the delivery, and stick any
2685 message back into the shadow_message field in the original. */
2687 if (shadow_addr != NULL)
2689 int save_count = transport_count;
2691 DEBUG(D_deliver|D_transport)
2692 debug_printf(">>>>>>>>>>>>>>>> Shadow delivery >>>>>>>>>>>>>>>>\n");
2693 deliver_local(shadow_addr, TRUE);
2695 for(; shadow_addr != NULL; shadow_addr = shadow_addr->next)
2697 int sresult = shadow_addr->transport_return;
2698 *((uschar **)(shadow_addr->shadow_message)) = (sresult == OK)?
2699 string_sprintf(" ST=%s", stp->name) :
2700 string_sprintf(" ST=%s (%s%s%s)", stp->name,
2701 (shadow_addr->basic_errno <= 0)?
2702 US"" : US strerror(shadow_addr->basic_errno),
2703 (shadow_addr->basic_errno <= 0 || shadow_addr->message == NULL)?
2705 (shadow_addr->message != NULL)? shadow_addr->message :
2706 (shadow_addr->basic_errno <= 0)? US"unknown error" : US"");
2708 DEBUG(D_deliver|D_transport)
2709 debug_printf("%s shadow transport returned %s for %s\n",
2711 (sresult == OK)? "OK" :
2712 (sresult == DEFER)? "DEFER" :
2713 (sresult == FAIL)? "FAIL" :
2714 (sresult == PANIC)? "PANIC" : "?",
2715 shadow_addr->address);
2718 DEBUG(D_deliver|D_transport)
2719 debug_printf(">>>>>>>>>>>>>>>> End shadow delivery >>>>>>>>>>>>>>>>\n");
2721 transport_count = save_count; /* Restore original transport count */
2725 /* Cancel the expansions that were set up for the delivery. */
2727 deliver_set_expansions(NULL);
2729 /* Now we can process the results of the real transport. We must take each
2730 address off the chain first, because post_process_one() puts it on another
2733 for (addr2 = addr; addr2 != NULL; addr2 = nextaddr)
2735 int result = addr2->transport_return;
2736 nextaddr = addr2->next;
2738 DEBUG(D_deliver|D_transport)
2739 debug_printf("%s transport returned %s for %s\n",
2741 (result == OK)? "OK" :
2742 (result == DEFER)? "DEFER" :
2743 (result == FAIL)? "FAIL" :
2744 (result == PANIC)? "PANIC" : "?",
2747 /* If there is a retry_record, or if delivery is deferred, build a retry
2748 item for setting a new retry time or deleting the old retry record from
2749 the database. These items are handled all together after all addresses
2750 have been handled (so the database is open just for a short time for
2753 if (result == DEFER || testflag(addr2, af_lt_retry_exists))
2755 int flags = (result == DEFER)? 0 : rf_delete;
2756 uschar *retry_key = string_copy((tp->retry_use_local_part)?
2757 addr2->address_retry_key : addr2->domain_retry_key);
2759 retry_add_item(addr2, retry_key, flags);
2762 /* Done with this address */
2764 if (result == OK) addr2->more_errno = deliver_time;
2765 post_process_one(addr2, result, logflags, DTYPE_TRANSPORT, logchar);
2767 /* If a pipe delivery generated text to be sent back, the result may be
2768 changed to FAIL, and we must copy this for subsequent addresses in the
2771 if (addr2->transport_return != result)
2773 for (addr3 = nextaddr; addr3 != NULL; addr3 = addr3->next)
2775 addr3->transport_return = addr2->transport_return;
2776 addr3->basic_errno = addr2->basic_errno;
2777 addr3->message = addr2->message;
2779 result = addr2->transport_return;
2782 /* Whether or not the result was changed to FAIL, we need to copy the
2783 return_file value from the first address into all the addresses of the
2784 batch, so they are all listed in the error message. */
2786 addr2->return_file = addr->return_file;
2788 /* Change log character for recording successful deliveries. */
2790 if (result == OK) logchar = '-';
2792 } /* Loop back for next batch of addresses */
2798 /*************************************************
2799 * Sort remote deliveries *
2800 *************************************************/
2802 /* This function is called if remote_sort_domains is set. It arranges that the
2803 chain of addresses for remote deliveries is ordered according to the strings
2804 specified. Try to make this shuffling reasonably efficient by handling
2805 sequences of addresses rather than just single ones.
2812 sort_remote_deliveries(void)
2815 address_item **aptr = &addr_remote;
2816 const uschar *listptr = remote_sort_domains;
2820 while (*aptr != NULL &&
2821 (pattern = string_nextinlist(&listptr, &sep, patbuf, sizeof(patbuf)))
2824 address_item *moved = NULL;
2825 address_item **bptr = &moved;
2827 while (*aptr != NULL)
2829 address_item **next;
2830 deliver_domain = (*aptr)->domain; /* set $domain */
2831 if (match_isinlist(deliver_domain, (const uschar **)&pattern, UCHAR_MAX+1,
2832 &domainlist_anchor, NULL, MCL_DOMAIN, TRUE, NULL) == OK)
2834 aptr = &((*aptr)->next);
2838 next = &((*aptr)->next);
2839 while (*next != NULL &&
2840 (deliver_domain = (*next)->domain, /* Set $domain */
2841 match_isinlist(deliver_domain, (const uschar **)&pattern, UCHAR_MAX+1,
2842 &domainlist_anchor, NULL, MCL_DOMAIN, TRUE, NULL)) != OK)
2843 next = &((*next)->next);
2845 /* If the batch of non-matchers is at the end, add on any that were
2846 extracted further up the chain, and end this iteration. Otherwise,
2847 extract them from the chain and hang on the moved chain. */
2859 aptr = &((*aptr)->next);
2862 /* If the loop ended because the final address matched, *aptr will
2863 be NULL. Add on to the end any extracted non-matching addresses. If
2864 *aptr is not NULL, the loop ended via "break" when *next is null, that
2865 is, there was a string of non-matching addresses at the end. In this
2866 case the extracted addresses have already been added on the end. */
2868 if (*aptr == NULL) *aptr = moved;
2874 debug_printf("remote addresses after sorting:\n");
2875 for (addr = addr_remote; addr != NULL; addr = addr->next)
2876 debug_printf(" %s\n", addr->address);
2882 /*************************************************
2883 * Read from pipe for remote delivery subprocess *
2884 *************************************************/
2886 /* This function is called when the subprocess is complete, but can also be
2887 called before it is complete, in order to empty a pipe that is full (to prevent
2888 deadlock). It must therefore keep track of its progress in the parlist data
2891 We read the pipe to get the delivery status codes and a possible error message
2892 for each address, optionally preceded by unusability data for the hosts and
2893 also by optional retry data.
2895 Read in large chunks into the big buffer and then scan through, interpreting
2896 the data therein. In most cases, only a single read will be necessary. No
2897 individual item will ever be anywhere near 2500 bytes in length, so by ensuring
2898 that we read the next chunk when there is less than 2500 bytes left in the
2899 non-final chunk, we can assume each item is complete in the buffer before
2900 handling it. Each item is written using a single write(), which is atomic for
2901 small items (less than PIPE_BUF, which seems to be at least 512 in any Unix and
2902 often bigger) so even if we are reading while the subprocess is still going, we
2903 should never have only a partial item in the buffer.
2906 poffset the offset of the parlist item
2907 eop TRUE if the process has completed
2909 Returns: TRUE if the terminating 'Z' item has been read,
2910 or there has been a disaster (i.e. no more data needed);
2915 par_read_pipe(int poffset, BOOL eop)
2918 pardata *p = parlist + poffset;
2919 address_item *addrlist = p->addrlist;
2920 address_item *addr = p->addr;
2923 uschar *endptr = big_buffer;
2924 uschar *ptr = endptr;
2925 uschar *msg = p->msg;
2926 BOOL done = p->done;
2927 BOOL unfinished = TRUE;
2928 /* minimum size to read is header size including id, subid and length */
2929 int required = PIPE_HEADER_SIZE;
2931 /* Loop through all items, reading from the pipe when necessary. The pipe
2932 is set up to be non-blocking, but there are two different Unix mechanisms in
2933 use. Exim uses O_NONBLOCK if it is defined. This returns 0 for end of file,
2934 and EAGAIN for no more data. If O_NONBLOCK is not defined, Exim uses O_NDELAY,
2935 which returns 0 for both end of file and no more data. We distinguish the
2936 two cases by taking 0 as end of file only when we know the process has
2939 Each separate item is written to the pipe in a single write(), and as they are
2940 all short items, the writes will all be atomic and we should never find
2941 ourselves in the position of having read an incomplete item. "Short" in this
2942 case can mean up to about 1K in the case when there is a long error message
2943 associated with an address. */
2945 DEBUG(D_deliver) debug_printf("reading pipe for subprocess %d (%s)\n",
2946 (int)p->pid, eop? "ended" : "not ended");
2950 retry_item *r, **rp;
2951 int remaining = endptr - ptr;
2952 uschar header[PIPE_HEADER_SIZE + 1];
2956 /* Read (first time) or top up the chars in the buffer if necessary.
2957 There will be only one read if we get all the available data (i.e. don't
2958 fill the buffer completely). */
2960 if (remaining < required && unfinished)
2963 int available = big_buffer_size - remaining;
2965 if (remaining > 0) memmove(big_buffer, ptr, remaining);
2968 endptr = big_buffer + remaining;
2969 len = read(fd, endptr, available);
2971 DEBUG(D_deliver) debug_printf("read() yielded %d\n", len);
2973 /* If the result is EAGAIN and the process is not complete, just
2974 stop reading any more and process what we have already. */
2978 if (!eop && errno == EAGAIN) len = 0; else
2980 msg = string_sprintf("failed to read pipe from transport process "
2981 "%d for transport %s: %s", pid, addr->transport->driver_name,
2987 /* If the length is zero (eof or no-more-data), just process what we
2988 already have. Note that if the process is still running and we have
2989 read all the data in the pipe (but less that "available") then we
2990 won't read any more, as "unfinished" will get set FALSE. */
2994 unfinished = len == available;
2997 /* If we are at the end of the available data, exit the loop. */
2998 if (ptr >= endptr) break;
3000 /* copy and read header */
3001 memcpy(header, ptr, PIPE_HEADER_SIZE);
3002 header[PIPE_HEADER_SIZE] = '\0';
3005 required = Ustrtol(header + 2, &endc, 10) + PIPE_HEADER_SIZE; /* header + data */
3008 msg = string_sprintf("failed to read pipe from transport process "
3009 "%d for transport %s: error reading size from header", pid, addr->transport->driver_name);
3015 debug_printf("header read id:%c,subid:%c,size:%s,required:%d,remaining:%d,unfinished:%d\n",
3016 id, subid, header+2, required, remaining, unfinished);
3018 /* is there room for the dataset we want to read ? */
3019 if (required > big_buffer_size - PIPE_HEADER_SIZE)
3021 msg = string_sprintf("failed to read pipe from transport process "
3022 "%d for transport %s: big_buffer too small! required size=%d buffer size=%d", pid, addr->transport->driver_name,
3023 required, big_buffer_size - PIPE_HEADER_SIZE);
3028 /* we wrote all datasets with atomic write() calls
3029 remaining < required only happens if big_buffer was too small
3030 to get all available data from pipe. unfinished has to be true
3032 if (remaining < required)
3036 msg = string_sprintf("failed to read pipe from transport process "
3037 "%d for transport %s: required size=%d > remaining size=%d and unfinished=false",
3038 pid, addr->transport->driver_name, required, remaining);
3043 /* step behind the header */
3044 ptr += PIPE_HEADER_SIZE;
3046 /* Handle each possible type of item, assuming the complete item is
3047 available in store. */
3051 /* Host items exist only if any hosts were marked unusable. Match
3052 up by checking the IP address. */
3055 for (h = addrlist->host_list; h != NULL; h = h->next)
3057 if (h->address == NULL || Ustrcmp(h->address, ptr+2) != 0) continue;
3065 /* Retry items are sent in a preceding R item for each address. This is
3066 kept separate to keep each message short enough to guarantee it won't
3067 be split in the pipe. Hopefully, in the majority of cases, there won't in
3068 fact be any retry items at all.
3070 The complete set of retry items might include an item to delete a
3071 routing retry if there was a previous routing delay. However, routing
3072 retries are also used when a remote transport identifies an address error.
3073 In that case, there may also be an "add" item for the same key. Arrange
3074 that a "delete" item is dropped in favour of an "add" item. */
3077 if (addr == NULL) goto ADDR_MISMATCH;
3079 DEBUG(D_deliver|D_retry)
3080 debug_printf("reading retry information for %s from subprocess\n",
3083 /* Cut out any "delete" items on the list. */
3085 for (rp = &(addr->retries); (r = *rp) != NULL; rp = &(r->next))
3087 if (Ustrcmp(r->key, ptr+1) == 0) /* Found item with same key */
3089 if ((r->flags & rf_delete) == 0) break; /* It was not "delete" */
3090 *rp = r->next; /* Excise a delete item */
3091 DEBUG(D_deliver|D_retry)
3092 debug_printf(" existing delete item dropped\n");
3096 /* We want to add a delete item only if there is no non-delete item;
3097 however we still have to step ptr through the data. */
3099 if (r == NULL || (*ptr & rf_delete) == 0)
3101 r = store_get(sizeof(retry_item));
3102 r->next = addr->retries;
3105 r->key = string_copy(ptr);
3107 memcpy(&(r->basic_errno), ptr, sizeof(r->basic_errno));
3108 ptr += sizeof(r->basic_errno);
3109 memcpy(&(r->more_errno), ptr, sizeof(r->more_errno));
3110 ptr += sizeof(r->more_errno);
3111 r->message = (*ptr)? string_copy(ptr) : NULL;
3112 DEBUG(D_deliver|D_retry)
3113 debug_printf(" added %s item\n",
3114 ((r->flags & rf_delete) == 0)? "retry" : "delete");
3119 DEBUG(D_deliver|D_retry)
3120 debug_printf(" delete item not added: non-delete item exists\n");
3123 ptr += sizeof(r->basic_errno) + sizeof(r->more_errno);
3129 /* Put the amount of data written into the parlist block */
3132 memcpy(&(p->transport_count), ptr, sizeof(transport_count));
3133 ptr += sizeof(transport_count);
3136 /* Address items are in the order of items on the address chain. We
3137 remember the current address value in case this function is called
3138 several times to empty the pipe in stages. Information about delivery
3139 over TLS is sent in a preceding X item for each address. We don't put
3140 it in with the other info, in order to keep each message short enough to
3141 guarantee it won't be split in the pipe. */
3145 if (addr == NULL) goto ADDR_MISMATCH; /* Below, in 'A' handler */
3149 addr->cipher = NULL;
3150 addr->peerdn = NULL;
3153 addr->cipher = string_copy(ptr);
3156 addr->peerdn = string_copy(ptr);
3161 (void) tls_import_cert(ptr, &addr->peercert);
3163 addr->peercert = NULL;
3168 (void) tls_import_cert(ptr, &addr->ourcert);
3170 addr->ourcert = NULL;
3173 # ifndef DISABLE_OCSP
3175 addr->ocsp = OCSP_NOT_REQ;
3177 addr->ocsp = *ptr - '0';
3183 #endif /*SUPPORT_TLS*/
3185 case 'C': /* client authenticator information */
3189 addr->authenticator = (*ptr)? string_copy(ptr) : NULL;
3192 addr->auth_id = (*ptr)? string_copy(ptr) : NULL;
3195 addr->auth_sndr = (*ptr)? string_copy(ptr) : NULL;
3201 #ifndef DISABLE_PRDR
3203 addr->flags |= af_prdr_used;
3208 if (addr == NULL) goto ADDR_MISMATCH;
3209 memcpy(&(addr->dsn_aware), ptr, sizeof(addr->dsn_aware));
3210 ptr += sizeof(addr->dsn_aware);
3211 DEBUG(D_deliver) debug_printf("DSN read: addr->dsn_aware = %d\n", addr->dsn_aware);
3218 msg = string_sprintf("address count mismatch for data read from pipe "
3219 "for transport process %d for transport %s", pid,
3220 addrlist->transport->driver_name);
3225 addr->transport_return = *ptr++;
3226 addr->special_action = *ptr++;
3227 memcpy(&(addr->basic_errno), ptr, sizeof(addr->basic_errno));
3228 ptr += sizeof(addr->basic_errno);
3229 memcpy(&(addr->more_errno), ptr, sizeof(addr->more_errno));
3230 ptr += sizeof(addr->more_errno);
3231 memcpy(&(addr->flags), ptr, sizeof(addr->flags));
3232 ptr += sizeof(addr->flags);
3233 addr->message = (*ptr)? string_copy(ptr) : NULL;
3235 addr->user_message = (*ptr)? string_copy(ptr) : NULL;
3238 /* Always two strings for host information, followed by the port number and DNSSEC mark */
3242 h = store_get(sizeof(host_item));
3243 h->name = string_copy(ptr);
3245 h->address = string_copy(ptr);
3247 memcpy(&(h->port), ptr, sizeof(h->port));
3248 ptr += sizeof(h->port);
3249 h->dnssec = *ptr == '2' ? DS_YES
3250 : *ptr == '1' ? DS_NO
3253 addr->host_used = h;
3257 /* Finished with this address */
3262 /* Local interface address/port */
3264 if (*ptr) sending_ip_address = string_copy(ptr);
3266 if (*ptr) sending_port = atoi(CS ptr);
3270 /* Z marks the logical end of the data. It is followed by '0' if
3271 continue_transport was NULL at the end of transporting, otherwise '1'.
3272 We need to know when it becomes NULL during a delivery down a passed SMTP
3273 channel so that we don't try to pass anything more down it. Of course, for
3274 most normal messages it will remain NULL all the time. */
3279 continue_transport = NULL;
3280 continue_hostname = NULL;
3283 DEBUG(D_deliver) debug_printf("Z0%c item read\n", *ptr);
3286 /* Anything else is a disaster. */
3289 msg = string_sprintf("malformed data (%d) read from pipe for transport "
3290 "process %d for transport %s", ptr[-1], pid,
3291 addr->transport->driver_name);
3297 /* The done flag is inspected externally, to determine whether or not to
3298 call the function again when the process finishes. */
3302 /* If the process hadn't finished, and we haven't seen the end of the data
3303 or suffered a disaster, update the rest of the state, and return FALSE to
3304 indicate "not finished". */
3313 /* Close our end of the pipe, to prevent deadlock if the far end is still
3314 pushing stuff into it. */
3319 /* If we have finished without error, but haven't had data for every address,
3320 something is wrong. */
3322 if (msg == NULL && addr != NULL)
3323 msg = string_sprintf("insufficient address data read from pipe "
3324 "for transport process %d for transport %s", pid,
3325 addr->transport->driver_name);
3327 /* If an error message is set, something has gone wrong in getting back
3328 the delivery data. Put the message into each address and freeze it. */
3332 for (addr = addrlist; addr != NULL; addr = addr->next)
3334 addr->transport_return = DEFER;
3335 addr->special_action = SPECIAL_FREEZE;
3336 addr->message = msg;
3340 /* Return TRUE to indicate we have got all we need from this process, even
3341 if it hasn't actually finished yet. */
3348 /*************************************************
3349 * Post-process a set of remote addresses *
3350 *************************************************/
3352 /* Do what has to be done immediately after a remote delivery for each set of
3353 addresses, then re-write the spool if necessary. Note that post_process_one
3354 puts the address on an appropriate queue; hence we must fish off the next
3355 one first. This function is also called if there is a problem with setting
3356 up a subprocess to do a remote delivery in parallel. In this case, the final
3357 argument contains a message, and the action must be forced to DEFER.
3360 addr pointer to chain of address items
3361 logflags flags for logging
3362 msg NULL for normal cases; -> error message for unexpected problems
3363 fallback TRUE if processing fallback hosts
3369 remote_post_process(address_item *addr, int logflags, uschar *msg,
3374 /* If any host addresses were found to be unusable, add them to the unusable
3375 tree so that subsequent deliveries don't try them. */
3377 for (h = addr->host_list; h != NULL; h = h->next)
3379 if (h->address == NULL) continue;
3380 if (h->status >= hstatus_unusable) tree_add_unusable(h);
3383 /* Now handle each address on the chain. The transport has placed '=' or '-'
3384 into the special_action field for each successful delivery. */
3386 while (addr != NULL)
3388 address_item *next = addr->next;
3390 /* If msg == NULL (normal processing) and the result is DEFER and we are
3391 processing the main hosts and there are fallback hosts available, put the
3392 address on the list for fallback delivery. */
3394 if (addr->transport_return == DEFER &&
3395 addr->fallback_hosts != NULL &&
3399 addr->host_list = addr->fallback_hosts;
3400 addr->next = addr_fallback;
3401 addr_fallback = addr;
3402 DEBUG(D_deliver) debug_printf("%s queued for fallback host(s)\n", addr->address);
3405 /* If msg is set (=> unexpected problem), set it in the address before
3406 doing the ordinary post processing. */
3412 addr->message = msg;
3413 addr->transport_return = DEFER;
3415 (void)post_process_one(addr, addr->transport_return, logflags,
3416 DTYPE_TRANSPORT, addr->special_action);
3424 /* If we have just delivered down a passed SMTP channel, and that was
3425 the last address, the channel will have been closed down. Now that
3426 we have logged that delivery, set continue_sequence to 1 so that
3427 any subsequent deliveries don't get "*" incorrectly logged. */
3429 if (continue_transport == NULL) continue_sequence = 1;
3434 /*************************************************
3435 * Wait for one remote delivery subprocess *
3436 *************************************************/
3438 /* This function is called while doing remote deliveries when either the
3439 maximum number of processes exist and we need one to complete so that another
3440 can be created, or when waiting for the last ones to complete. It must wait for
3441 the completion of one subprocess, empty the control block slot, and return a
3442 pointer to the address chain.
3445 Returns: pointer to the chain of addresses handled by the process;
3446 NULL if no subprocess found - this is an unexpected error
3449 static address_item *
3452 int poffset, status;
3453 address_item *addr, *addrlist;
3456 set_process_info("delivering %s: waiting for a remote delivery subprocess "
3457 "to finish", message_id);
3459 /* Loop until either a subprocess completes, or there are no subprocesses in
3460 existence - in which case give an error return. We cannot proceed just by
3461 waiting for a completion, because a subprocess may have filled up its pipe, and
3462 be waiting for it to be emptied. Therefore, if no processes have finished, we
3463 wait for one of the pipes to acquire some data by calling select(), with a
3464 timeout just in case.
3466 The simple approach is just to iterate after reading data from a ready pipe.
3467 This leads to non-ideal behaviour when the subprocess has written its final Z
3468 item, closed the pipe, and is in the process of exiting (the common case). A
3469 call to waitpid() yields nothing completed, but select() shows the pipe ready -
3470 reading it yields EOF, so you end up with busy-waiting until the subprocess has
3473 To avoid this, if all the data that is needed has been read from a subprocess
3474 after select(), an explicit wait() for it is done. We know that all it is doing
3475 is writing to the pipe and then exiting, so the wait should not be long.
3477 The non-blocking waitpid() is to some extent just insurance; if we could
3478 reliably detect end-of-file on the pipe, we could always know when to do a
3479 blocking wait() for a completed process. However, because some systems use
3480 NDELAY, which doesn't distinguish between EOF and pipe empty, it is easier to
3481 use code that functions without the need to recognize EOF.
3483 There's a double loop here just in case we end up with a process that is not in
3484 the list of remote delivery processes. Something has obviously gone wrong if
3485 this is the case. (For example, a process that is incorrectly left over from
3486 routing or local deliveries might be found.) The damage can be minimized by
3487 looping back and looking for another process. If there aren't any, the error
3488 return will happen. */
3490 for (;;) /* Normally we do not repeat this loop */
3492 while ((pid = waitpid(-1, &status, WNOHANG)) <= 0)
3495 fd_set select_pipes;
3496 int maxpipe, readycount;
3498 /* A return value of -1 can mean several things. If errno != ECHILD, it
3499 either means invalid options (which we discount), or that this process was
3500 interrupted by a signal. Just loop to try the waitpid() again.
3502 If errno == ECHILD, waitpid() is telling us that there are no subprocesses
3503 in existence. This should never happen, and is an unexpected error.
3504 However, there is a nasty complication when running under Linux. If "strace
3505 -f" is being used under Linux to trace this process and its children,
3506 subprocesses are "stolen" from their parents and become the children of the
3507 tracing process. A general wait such as the one we've just obeyed returns
3508 as if there are no children while subprocesses are running. Once a
3509 subprocess completes, it is restored to the parent, and waitpid(-1) finds
3510 it. Thanks to Joachim Wieland for finding all this out and suggesting a
3513 This does not happen using "truss" on Solaris, nor (I think) with other
3514 tracing facilities on other OS. It seems to be specific to Linux.
3516 What we do to get round this is to use kill() to see if any of our
3517 subprocesses are still in existence. If kill() gives an OK return, we know
3518 it must be for one of our processes - it can't be for a re-use of the pid,
3519 because if our process had finished, waitpid() would have found it. If any
3520 of our subprocesses are in existence, we proceed to use select() as if
3521 waitpid() had returned zero. I think this is safe. */
3525 if (errno != ECHILD) continue; /* Repeats the waitpid() */
3528 debug_printf("waitpid() returned -1/ECHILD: checking explicitly "
3529 "for process existence\n");
3531 for (poffset = 0; poffset < remote_max_parallel; poffset++)
3533 if ((pid = parlist[poffset].pid) != 0 && kill(pid, 0) == 0)
3535 DEBUG(D_deliver) debug_printf("process %d still exists: assume "
3536 "stolen by strace\n", (int)pid);
3537 break; /* With poffset set */
3541 if (poffset >= remote_max_parallel)
3543 DEBUG(D_deliver) debug_printf("*** no delivery children found\n");
3544 return NULL; /* This is the error return */
3548 /* A pid value greater than 0 breaks the "while" loop. A negative value has
3549 been handled above. A return value of zero means that there is at least one
3550 subprocess, but there are no completed subprocesses. See if any pipes are
3551 ready with any data for reading. */
3553 DEBUG(D_deliver) debug_printf("selecting on subprocess pipes\n");
3556 FD_ZERO(&select_pipes);
3557 for (poffset = 0; poffset < remote_max_parallel; poffset++)
3559 if (parlist[poffset].pid != 0)
3561 int fd = parlist[poffset].fd;
3562 FD_SET(fd, &select_pipes);
3563 if (fd > maxpipe) maxpipe = fd;
3567 /* Stick in a 60-second timeout, just in case. */
3572 readycount = select(maxpipe + 1, (SELECT_ARG2_TYPE *)&select_pipes,
3575 /* Scan through the pipes and read any that are ready; use the count
3576 returned by select() to stop when there are no more. Select() can return
3577 with no processes (e.g. if interrupted). This shouldn't matter.
3579 If par_read_pipe() returns TRUE, it means that either the terminating Z was
3580 read, or there was a disaster. In either case, we are finished with this
3581 process. Do an explicit wait() for the process and break the main loop if
3584 It turns out that we have to deal with the case of an interrupted system
3585 call, which can happen on some operating systems if the signal handling is
3586 set up to do that by default. */
3589 readycount > 0 && poffset < remote_max_parallel;
3592 if ((pid = parlist[poffset].pid) != 0 &&
3593 FD_ISSET(parlist[poffset].fd, &select_pipes))
3596 if (par_read_pipe(poffset, FALSE)) /* Finished with this pipe */
3598 for (;;) /* Loop for signals */
3600 pid_t endedpid = waitpid(pid, &status, 0);
3601 if (endedpid == pid) goto PROCESS_DONE;
3602 if (endedpid != (pid_t)(-1) || errno != EINTR)
3603 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Unexpected error return "
3604 "%d (errno = %d) from waitpid() for process %d",
3605 (int)endedpid, errno, (int)pid);
3611 /* Now go back and look for a completed subprocess again. */
3614 /* A completed process was detected by the non-blocking waitpid(). Find the
3615 data block that corresponds to this subprocess. */
3617 for (poffset = 0; poffset < remote_max_parallel; poffset++)
3618 if (pid == parlist[poffset].pid) break;
3620 /* Found the data block; this is a known remote delivery process. We don't
3621 need to repeat the outer loop. This should be what normally happens. */
3623 if (poffset < remote_max_parallel) break;
3625 /* This situation is an error, but it's probably better to carry on looking
3626 for another process than to give up (as we used to do). */
3628 log_write(0, LOG_MAIN|LOG_PANIC, "Process %d finished: not found in remote "
3629 "transport process list", pid);
3630 } /* End of the "for" loop */
3632 /* Come here when all the data was completely read after a select(), and
3633 the process in pid has been wait()ed for. */
3640 debug_printf("remote delivery process %d ended\n", (int)pid);
3642 debug_printf("remote delivery process %d ended: status=%04x\n", (int)pid,
3646 set_process_info("delivering %s", message_id);
3648 /* Get the chain of processed addresses */
3650 addrlist = parlist[poffset].addrlist;
3652 /* If the process did not finish cleanly, record an error and freeze (except
3653 for SIGTERM, SIGKILL and SIGQUIT), and also ensure the journal is not removed,
3654 in case the delivery did actually happen. */
3656 if ((status & 0xffff) != 0)
3659 int msb = (status >> 8) & 255;
3660 int lsb = status & 255;
3661 int code = (msb == 0)? (lsb & 0x7f) : msb;
3663 msg = string_sprintf("%s transport process returned non-zero status 0x%04x: "
3665 addrlist->transport->driver_name,
3667 (msb == 0)? "terminated by signal" : "exit code",
3670 if (msb != 0 || (code != SIGTERM && code != SIGKILL && code != SIGQUIT))
3671 addrlist->special_action = SPECIAL_FREEZE;
3673 for (addr = addrlist; addr != NULL; addr = addr->next)
3675 addr->transport_return = DEFER;
3676 addr->message = msg;
3679 remove_journal = FALSE;
3682 /* Else complete reading the pipe to get the result of the delivery, if all
3683 the data has not yet been obtained. */
3685 else if (!parlist[poffset].done) (void)par_read_pipe(poffset, TRUE);
3687 /* Put the data count and return path into globals, mark the data slot unused,
3688 decrement the count of subprocesses, and return the address chain. */
3690 transport_count = parlist[poffset].transport_count;
3691 used_return_path = parlist[poffset].return_path;
3692 parlist[poffset].pid = 0;
3699 /*************************************************
3700 * Wait for subprocesses and post-process *
3701 *************************************************/
3703 /* This function waits for subprocesses until the number that are still running
3704 is below a given threshold. For each complete subprocess, the addresses are
3705 post-processed. If we can't find a running process, there is some shambles.
3706 Better not bomb out, as that might lead to multiple copies of the message. Just
3707 log and proceed as if all done.
3710 max maximum number of subprocesses to leave running
3711 fallback TRUE if processing fallback hosts
3717 par_reduce(int max, BOOL fallback)
3719 while (parcount > max)
3721 address_item *doneaddr = par_wait();
3722 if (doneaddr == NULL)
3724 log_write(0, LOG_MAIN|LOG_PANIC,
3725 "remote delivery process count got out of step");
3728 else remote_post_process(doneaddr, LOG_MAIN, NULL, fallback);
3736 rmt_dlv_checked_write(int fd, char id, char subid, void * buf, int size)
3738 uschar writebuffer[PIPE_HEADER_SIZE + BIG_BUFFER_SIZE];
3741 /* we assume that size can't get larger then BIG_BUFFER_SIZE which currently is set to 16k */
3742 /* complain to log if someone tries with buffer sizes we can't handle*/
3746 log_write(0, LOG_MAIN|LOG_PANIC_DIE,
3747 "Failed writing transport result to pipe: can't handle buffers > 99999 bytes. truncating!\n");
3751 /* to keep the write() atomic we build header in writebuffer and copy buf behind */
3752 /* two write() calls would increase the complexity of reading from pipe */
3754 /* convert size to human readable string prepended by id and subid */
3755 header_length = snprintf(CS writebuffer, PIPE_HEADER_SIZE+1, "%c%c%05d", id, subid, size);
3756 if (header_length != PIPE_HEADER_SIZE)
3758 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "header snprintf failed\n");
3759 writebuffer[0] = '\0';
3762 DEBUG(D_deliver) debug_printf("header write id:%c,subid:%c,size:%d,final:%s\n",
3763 id, subid, size, writebuffer);
3765 if (buf && size > 0)
3766 memcpy(writebuffer + PIPE_HEADER_SIZE, buf, size);
3768 size += PIPE_HEADER_SIZE;
3769 int ret = write(fd, writebuffer, size);
3771 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Failed writing transport result to pipe: %s\n",
3772 ret == -1 ? strerror(errno) : "short write");
3775 /*************************************************
3776 * Do remote deliveries *
3777 *************************************************/
3779 /* This function is called to process the addresses in addr_remote. We must
3780 pick off the queue all addresses that have the same transport, remote
3781 destination, and errors address, and hand them to the transport in one go,
3782 subject to some configured limitations. If this is a run to continue delivering
3783 to an existing delivery channel, skip all but those addresses that can go to
3784 that channel. The skipped addresses just get deferred.
3786 If mua_wrapper is set, all addresses must be able to be sent in a single
3787 transaction. If not, this function yields FALSE.
3789 In Exim 4, remote deliveries are always done in separate processes, even
3790 if remote_max_parallel = 1 or if there's only one delivery to do. The reason
3791 is so that the base process can retain privilege. This makes the
3792 implementation of fallback transports feasible (though not initially done.)
3794 We create up to the configured number of subprocesses, each of which passes
3795 back the delivery state via a pipe. (However, when sending down an existing
3796 connection, remote_max_parallel is forced to 1.)
3799 fallback TRUE if processing fallback hosts
3801 Returns: TRUE normally
3802 FALSE if mua_wrapper is set and the addresses cannot all be sent
3807 do_remote_deliveries(BOOL fallback)
3813 parcount = 0; /* Number of executing subprocesses */
3815 /* When sending down an existing channel, only do one delivery at a time.
3816 We use a local variable (parmax) to hold the maximum number of processes;
3817 this gets reduced from remote_max_parallel if we can't create enough pipes. */
3819 if (continue_transport != NULL) remote_max_parallel = 1;
3820 parmax = remote_max_parallel;
3822 /* If the data for keeping a list of processes hasn't yet been
3825 if (parlist == NULL)
3827 parlist = store_get(remote_max_parallel * sizeof(pardata));
3828 for (poffset = 0; poffset < remote_max_parallel; poffset++)
3829 parlist[poffset].pid = 0;
3832 /* Now loop for each remote delivery */
3834 for (delivery_count = 0; addr_remote != NULL; delivery_count++)
3840 int address_count = 1;
3841 int address_count_max;
3843 BOOL use_initgroups;
3844 BOOL pipe_done = FALSE;
3845 transport_instance *tp;
3846 address_item **anchor = &addr_remote;
3847 address_item *addr = addr_remote;
3848 address_item *last = addr;
3851 /* Pull the first address right off the list. */
3853 addr_remote = addr->next;
3856 DEBUG(D_deliver|D_transport)
3857 debug_printf("--------> %s <--------\n", addr->address);
3859 /* If no transport has been set, there has been a big screw-up somewhere. */
3861 if ((tp = addr->transport) == NULL)
3863 disable_logging = FALSE; /* Jic */
3864 remote_post_process(addr, LOG_MAIN|LOG_PANIC,
3865 US"No transport set by router", fallback);
3869 /* Check that this base address hasn't previously been delivered to this
3870 transport. The check is necessary at this point to handle homonymic addresses
3871 correctly in cases where the pattern of redirection changes between delivery
3872 attempts. Non-homonymic previous delivery is detected earlier, at routing
3875 if (previously_transported(addr, FALSE)) continue;
3877 /* Force failure if the message is too big. */
3879 if (tp->message_size_limit != NULL)
3881 int rc = check_message_size(tp, addr);
3884 addr->transport_return = rc;
3885 remote_post_process(addr, LOG_MAIN, NULL, fallback);
3890 /* Get the flag which specifies whether the transport can handle different
3891 domains that nevertheless resolve to the same set of hosts. If it needs
3892 expanding, get variables set: $address_data, $domain_data, $localpart_data,
3893 $host, $host_address, $host_port. */
3894 if (tp->expand_multi_domain)
3895 deliver_set_expansions(addr);
3897 if (exp_bool(addr, US"transport", tp->name, D_transport,
3898 US"multi_domain", tp->multi_domain, tp->expand_multi_domain,
3899 &multi_domain) != OK)
3901 deliver_set_expansions(NULL);
3902 remote_post_process(addr, LOG_MAIN|LOG_PANIC, addr->message, fallback);
3906 /* Get the maximum it can handle in one envelope, with zero meaning
3907 unlimited, which is forced for the MUA wrapper case. */
3909 address_count_max = tp->max_addresses;
3910 if (address_count_max == 0 || mua_wrapper) address_count_max = 999999;
3913 /************************************************************************/
3914 /***** This is slightly experimental code, but should be safe. *****/
3916 /* The address_count_max value is the maximum number of addresses that the
3917 transport can send in one envelope. However, the transport must be capable of
3918 dealing with any number of addresses. If the number it gets exceeds its
3919 envelope limitation, it must send multiple copies of the message. This can be
3920 done over a single connection for SMTP, so uses less resources than making
3921 multiple connections. On the other hand, if remote_max_parallel is greater
3922 than one, it is perhaps a good idea to use parallel processing to move the
3923 message faster, even if that results in multiple simultaneous connections to
3926 How can we come to some compromise between these two ideals? What we do is to
3927 limit the number of addresses passed to a single instance of a transport to
3928 the greater of (a) its address limit (rcpt_max for SMTP) and (b) the total
3929 number of addresses routed to remote transports divided by
3930 remote_max_parallel. For example, if the message has 100 remote recipients,
3931 remote max parallel is 2, and rcpt_max is 10, we'd never send more than 50 at
3932 once. But if rcpt_max is 100, we could send up to 100.
3934 Of course, not all the remotely addresses in a message are going to go to the
3935 same set of hosts (except in smarthost configurations), so this is just a
3936 heuristic way of dividing up the work.
3938 Furthermore (1), because this may not be wanted in some cases, and also to
3939 cope with really pathological cases, there is also a limit to the number of
3940 messages that are sent over one connection. This is the same limit that is
3941 used when sending several different messages over the same connection.
3942 Continue_sequence is set when in this situation, to the number sent so
3943 far, including this message.
3945 Furthermore (2), when somebody explicitly sets the maximum value to 1, it
3946 is probably because they are using VERP, in which case they want to pass only
3947 one address at a time to the transport, in order to be able to use
3948 $local_part and $domain in constructing a new return path. We could test for
3949 the use of these variables, but as it is so likely they will be used when the
3950 maximum is 1, we don't bother. Just leave the value alone. */
3952 if (address_count_max != 1 &&
3953 address_count_max < remote_delivery_count/remote_max_parallel)
3955 int new_max = remote_delivery_count/remote_max_parallel;
3956 int message_max = tp->connection_max_messages;
3957 if (connection_max_messages >= 0) message_max = connection_max_messages;
3958 message_max -= continue_sequence - 1;
3959 if (message_max > 0 && new_max > address_count_max * message_max)
3960 new_max = address_count_max * message_max;
3961 address_count_max = new_max;
3964 /************************************************************************/
3967 /* Pick off all addresses which have the same transport, errors address,
3968 destination, and extra headers. In some cases they point to the same host
3969 list, but we also need to check for identical host lists generated from
3970 entirely different domains. The host list pointers can be NULL in the case
3971 where the hosts are defined in the transport. There is also a configured
3972 maximum limit of addresses that can be handled at once (see comments above
3973 for how it is computed).
3974 If the transport does not handle multiple domains, enforce that also,
3975 and if it might need a per-address check for this, re-evaluate it.
3978 while ((next = *anchor) != NULL && address_count < address_count_max)
3981 if ( (multi_domain || Ustrcmp(next->domain, addr->domain) == 0)
3982 && tp == next->transport
3983 && same_hosts(next->host_list, addr->host_list)
3984 && same_strings(next->prop.errors_address, addr->prop.errors_address)
3985 && same_headers(next->prop.extra_headers, addr->prop.extra_headers)
3986 && same_ugid(tp, next, addr)
3987 && ( next->prop.remove_headers == addr->prop.remove_headers
3988 || ( next->prop.remove_headers
3989 && addr->prop.remove_headers
3990 && Ustrcmp(next->prop.remove_headers, addr->prop.remove_headers) == 0
3994 !tp->expand_multi_domain || (deliver_set_expansions(next), 1),
3996 US"transport", next->transport->name, D_transport,
3997 US"multi_domain", next->transport->multi_domain,
3998 next->transport->expand_multi_domain, &md) == OK
4003 *anchor = next->next;
4005 next->first = addr; /* remember top one (for retry processing) */
4010 else anchor = &(next->next);
4011 deliver_set_expansions(NULL);
4014 /* If we are acting as an MUA wrapper, all addresses must go in a single
4015 transaction. If not, put them back on the chain and yield FALSE. */
4017 if (mua_wrapper && addr_remote != NULL)
4019 last->next = addr_remote;
4024 /* Set up the expansion variables for this set of addresses */
4026 deliver_set_expansions(addr);
4028 /* Ensure any transport-set auth info is fresh */
4029 addr->authenticator = addr->auth_id = addr->auth_sndr = NULL;
4031 /* Compute the return path, expanding a new one if required. The old one
4032 must be set first, as it might be referred to in the expansion. */
4034 if(addr->prop.errors_address != NULL)
4035 return_path = addr->prop.errors_address;
4036 #ifdef EXPERIMENTAL_SRS
4037 else if(addr->prop.srs_sender != NULL)
4038 return_path = addr->prop.srs_sender;
4041 return_path = sender_address;
4043 if (tp->return_path != NULL)
4045 uschar *new_return_path = expand_string(tp->return_path);
4046 if (new_return_path == NULL)
4048 if (!expand_string_forcedfail)
4050 remote_post_process(addr, LOG_MAIN|LOG_PANIC,
4051 string_sprintf("Failed to expand return path \"%s\": %s",
4052 tp->return_path, expand_string_message), fallback);
4056 else return_path = new_return_path;
4059 /* Find the uid, gid, and use_initgroups setting for this transport. Failure
4060 logs and sets up error messages, so we just post-process and continue with
4061 the next address. */
4063 if (!findugid(addr, tp, &uid, &gid, &use_initgroups))
4065 remote_post_process(addr, LOG_MAIN|LOG_PANIC, NULL, fallback);
4069 /* If this transport has a setup function, call it now so that it gets
4070 run in this process and not in any subprocess. That way, the results of
4071 any setup that are retained by the transport can be reusable. One of the
4072 things the setup does is to set the fallback host lists in the addresses.
4073 That is why it is called at this point, before the continue delivery
4074 processing, because that might use the fallback hosts. */
4076 if (tp->setup != NULL)
4077 (void)((tp->setup)(addr->transport, addr, NULL, uid, gid, NULL));
4079 /* If this is a run to continue delivery down an already-established
4080 channel, check that this set of addresses matches the transport and
4081 the channel. If it does not, defer the addresses. If a host list exists,
4082 we must check that the continue host is on the list. Otherwise, the
4083 host is set in the transport. */
4085 continue_more = FALSE; /* In case got set for the last lot */
4086 if (continue_transport != NULL)
4088 BOOL ok = Ustrcmp(continue_transport, tp->name) == 0;
4089 if (ok && addr->host_list != NULL)
4093 for (h = addr->host_list; h != NULL; h = h->next)
4095 if (Ustrcmp(h->name, continue_hostname) == 0)
4096 { ok = TRUE; break; }
4100 /* Addresses not suitable; defer or queue for fallback hosts (which
4101 might be the continue host) and skip to next address. */
4105 DEBUG(D_deliver) debug_printf("not suitable for continue_transport\n");
4108 if (addr->fallback_hosts != NULL && !fallback)
4112 next->host_list = next->fallback_hosts;
4113 DEBUG(D_deliver) debug_printf("%s queued for fallback host(s)\n", next->address);
4114 if (next->next == NULL) break;
4117 next->next = addr_fallback;
4118 addr_fallback = addr;
4123 while (next->next != NULL) next = next->next;
4124 next->next = addr_defer;
4131 /* Set a flag indicating whether there are further addresses that list
4132 the continued host. This tells the transport to leave the channel open,
4133 but not to pass it to another delivery process. */
4135 for (next = addr_remote; next != NULL; next = next->next)
4138 for (h = next->host_list; h != NULL; h = h->next)
4140 if (Ustrcmp(h->name, continue_hostname) == 0)
4141 { continue_more = TRUE; break; }
4146 /* The transports set up the process info themselves as they may connect
4147 to more than one remote machine. They also have to set up the filter
4148 arguments, if required, so that the host name and address are available
4151 transport_filter_argv = NULL;
4153 /* Create the pipe for inter-process communication. If pipe creation
4154 fails, it is probably because the value of remote_max_parallel is so
4155 large that too many file descriptors for pipes have been created. Arrange
4156 to wait for a process to finish, and then try again. If we still can't
4157 create a pipe when all processes have finished, break the retry loop. */
4161 if (pipe(pfd) == 0) pipe_done = TRUE;
4162 else if (parcount > 0) parmax = parcount;
4165 /* We need to make the reading end of the pipe non-blocking. There are
4166 two different options for this. Exim is cunningly (I hope!) coded so
4167 that it can use either of them, though it prefers O_NONBLOCK, which
4168 distinguishes between EOF and no-more-data. */
4171 (void)fcntl(pfd[pipe_read], F_SETFL, O_NONBLOCK);
4173 (void)fcntl(pfd[pipe_read], F_SETFL, O_NDELAY);
4176 /* If the maximum number of subprocesses already exist, wait for a process
4177 to finish. If we ran out of file descriptors, parmax will have been reduced
4178 from its initial value of remote_max_parallel. */
4180 par_reduce(parmax - 1, fallback);
4183 /* If we failed to create a pipe and there were no processes to wait
4184 for, we have to give up on this one. Do this outside the above loop
4185 so that we can continue the main loop. */
4189 remote_post_process(addr, LOG_MAIN|LOG_PANIC,
4190 string_sprintf("unable to create pipe: %s", strerror(errno)), fallback);
4194 /* Find a free slot in the pardata list. Must do this after the possible
4195 waiting for processes to finish, because a terminating process will free
4198 for (poffset = 0; poffset < remote_max_parallel; poffset++)
4199 if (parlist[poffset].pid == 0) break;
4201 /* If there isn't one, there has been a horrible disaster. */
4203 if (poffset >= remote_max_parallel)
4205 (void)close(pfd[pipe_write]);
4206 (void)close(pfd[pipe_read]);
4207 remote_post_process(addr, LOG_MAIN|LOG_PANIC,
4208 US"Unexpectedly no free subprocess slot", fallback);
4212 /* Now fork a subprocess to do the remote delivery, but before doing so,
4213 ensure that any cached resourses are released so as not to interfere with
4214 what happens in the subprocess. */
4218 if ((pid = fork()) == 0)
4220 int fd = pfd[pipe_write];
4223 /* Setting this global in the subprocess means we need never clear it */
4224 transport_name = tp->name;
4226 /* There are weird circumstances in which logging is disabled */
4227 disable_logging = tp->disable_logging;
4229 /* Show pids on debug output if parallelism possible */
4231 if (parmax > 1 && (parcount > 0 || addr_remote != NULL))
4233 DEBUG(D_any|D_v) debug_selector |= D_pid;
4234 DEBUG(D_deliver) debug_printf("Remote delivery process started\n");
4237 /* Reset the random number generator, so different processes don't all
4238 have the same sequence. In the test harness we want different, but
4239 predictable settings for each delivery process, so do something explicit
4240 here rather they rely on the fixed reset in the random number function. */
4242 random_seed = running_in_test_harness? 42 + 2*delivery_count : 0;
4244 /* Set close-on-exec on the pipe so that it doesn't get passed on to
4245 a new process that may be forked to do another delivery down the same
4248 (void)fcntl(fd, F_SETFD, fcntl(fd, F_GETFD) | FD_CLOEXEC);
4250 /* Close open file descriptors for the pipes of other processes
4251 that are running in parallel. */
4253 for (poffset = 0; poffset < remote_max_parallel; poffset++)
4254 if (parlist[poffset].pid != 0) (void)close(parlist[poffset].fd);
4256 /* This process has inherited a copy of the file descriptor
4257 for the data file, but its file pointer is shared with all the
4258 other processes running in parallel. Therefore, we have to re-open
4259 the file in order to get a new file descriptor with its own
4260 file pointer. We don't need to lock it, as the lock is held by
4261 the parent process. There doesn't seem to be any way of doing
4262 a dup-with-new-file-pointer. */
4264 (void)close(deliver_datafile);
4265 sprintf(CS spoolname, "%s/input/%s/%s-D", spool_directory, message_subdir,
4267 deliver_datafile = Uopen(spoolname, O_RDWR | O_APPEND, 0);
4269 if (deliver_datafile < 0)
4270 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Failed to reopen %s for remote "
4271 "parallel delivery: %s", spoolname, strerror(errno));
4273 /* Set the close-on-exec flag */
4275 (void)fcntl(deliver_datafile, F_SETFD, fcntl(deliver_datafile, F_GETFD) |
4278 /* Set the uid/gid of this process; bombs out on failure. */
4280 exim_setugid(uid, gid, use_initgroups,
4281 string_sprintf("remote delivery to %s with transport=%s",
4282 addr->address, tp->name));
4284 /* Close the unwanted half of this process' pipe, set the process state,
4285 and run the transport. Afterwards, transport_count will contain the number
4286 of bytes written. */
4288 (void)close(pfd[pipe_read]);
4289 set_process_info("delivering %s using %s", message_id, tp->name);
4290 debug_print_string(tp->debug_string);
4291 if (!(tp->info->code)(addr->transport, addr)) replicate_status(addr);
4293 set_process_info("delivering %s (just run %s for %s%s in subprocess)",
4294 message_id, tp->name, addr->address, (addr->next == NULL)? "" : ", ...");
4296 /* Ensure any cached resources that we used are now released */
4300 /* Pass the result back down the pipe. This is a lot more information
4301 than is needed for a local delivery. We have to send back the error
4302 status for each address, the usability status for each host that is
4303 flagged as unusable, and all the retry items. When TLS is in use, we
4304 send also the cipher and peerdn information. Each type of information
4305 is flagged by an identifying byte, and is then in a fixed format (with
4306 strings terminated by zeros), and there is a final terminator at the
4307 end. The host information and retry information is all attached to
4308 the first address, so that gets sent at the start. */
4310 /* Host unusability information: for most success cases this will
4313 for (h = addr->host_list; h != NULL; h = h->next)
4315 if (h->address == NULL || h->status < hstatus_unusable) continue;
4316 sprintf(CS big_buffer, "%c%c%s", h->status, h->why, h->address);
4317 rmt_dlv_checked_write(fd, 'H', '0', big_buffer, Ustrlen(big_buffer+2) + 3);
4320 /* The number of bytes written. This is the same for each address. Even
4321 if we sent several copies of the message down the same connection, the
4322 size of each one is the same, and it's that value we have got because
4323 transport_count gets reset before calling transport_write_message(). */
4325 memcpy(big_buffer, &transport_count, sizeof(transport_count));
4326 rmt_dlv_checked_write(fd, 'S', '0', big_buffer, sizeof(transport_count));
4328 /* Information about what happened to each address. Four item types are
4329 used: an optional 'X' item first, for TLS information, then an optional "C"
4330 item for any client-auth info followed by 'R' items for any retry settings,
4331 and finally an 'A' item for the remaining data. */
4333 for(; addr != NULL; addr = addr->next)
4338 /* The certificate verification status goes into the flags */
4339 if (tls_out.certificate_verified) setflag(addr, af_cert_verified);
4340 #ifdef EXPERIMENTAL_DANE
4341 if (tls_out.dane_verified) setflag(addr, af_dane_verified);
4344 /* Use an X item only if there's something to send */
4349 sprintf(CS ptr, "%.128s", addr->cipher);
4355 sprintf(CS ptr, "%.512s", addr->peerdn);
4359 rmt_dlv_checked_write(fd, 'X', '1', big_buffer, ptr - big_buffer);
4364 if (!tls_export_cert(ptr, big_buffer_size-2, addr->peercert))
4368 rmt_dlv_checked_write(fd, 'X', '2', big_buffer, ptr - big_buffer);
4373 if (!tls_export_cert(ptr, big_buffer_size-2, addr->ourcert))
4377 rmt_dlv_checked_write(fd, 'X', '3', big_buffer, ptr - big_buffer);
4379 # ifndef DISABLE_OCSP
4380 if (addr->ocsp > OCSP_NOT_REQ)
4383 sprintf(CS ptr, "%c", addr->ocsp + '0');
4385 rmt_dlv_checked_write(fd, 'X', '4', big_buffer, ptr - big_buffer);
4388 #endif /*SUPPORT_TLS*/
4390 if (client_authenticator)
4393 sprintf(CS big_buffer, "%.64s", client_authenticator);
4395 rmt_dlv_checked_write(fd, 'C', '1', big_buffer, ptr - big_buffer);
4397 if (client_authenticated_id)
4400 sprintf(CS big_buffer, "%.64s", client_authenticated_id);
4402 rmt_dlv_checked_write(fd, 'C', '2', big_buffer, ptr - big_buffer);
4404 if (client_authenticated_sender)
4407 sprintf(CS big_buffer, "%.64s", client_authenticated_sender);
4409 rmt_dlv_checked_write(fd, 'C', '3', big_buffer, ptr - big_buffer);
4412 #ifndef DISABLE_PRDR
4413 if (addr->flags & af_prdr_used)
4414 rmt_dlv_checked_write(fd, 'P', '0', NULL, 0);
4417 memcpy(big_buffer, &addr->dsn_aware, sizeof(addr->dsn_aware));
4418 rmt_dlv_checked_write(fd, 'D', '0', big_buffer, sizeof(addr->dsn_aware));
4419 DEBUG(D_deliver) debug_printf("DSN write: addr->dsn_aware = %d\n", addr->dsn_aware);
4421 /* Retry information: for most success cases this will be null. */
4423 for (r = addr->retries; r != NULL; r = r->next)
4426 sprintf(CS big_buffer, "%c%.500s", r->flags, r->key);
4427 ptr = big_buffer + Ustrlen(big_buffer+2) + 3;
4428 memcpy(ptr, &(r->basic_errno), sizeof(r->basic_errno));
4429 ptr += sizeof(r->basic_errno);
4430 memcpy(ptr, &(r->more_errno), sizeof(r->more_errno));
4431 ptr += sizeof(r->more_errno);
4432 if (r->message == NULL) *ptr++ = 0; else
4434 sprintf(CS ptr, "%.512s", r->message);
4437 rmt_dlv_checked_write(fd, 'R', '0', big_buffer, ptr - big_buffer);
4440 /* The rest of the information goes in an 'A' item. */
4442 ptr = big_buffer + 2;
4443 sprintf(CS big_buffer, "%c%c", addr->transport_return,
4444 addr->special_action);
4445 memcpy(ptr, &(addr->basic_errno), sizeof(addr->basic_errno));
4446 ptr += sizeof(addr->basic_errno);
4447 memcpy(ptr, &(addr->more_errno), sizeof(addr->more_errno));
4448 ptr += sizeof(addr->more_errno);
4449 memcpy(ptr, &(addr->flags), sizeof(addr->flags));
4450 ptr += sizeof(addr->flags);
4452 if (addr->message == NULL) *ptr++ = 0; else
4454 sprintf(CS ptr, "%.1024s", addr->message);
4458 if (addr->user_message == NULL) *ptr++ = 0; else
4460 sprintf(CS ptr, "%.1024s", addr->user_message);
4464 if (addr->host_used == NULL) *ptr++ = 0; else
4466 sprintf(CS ptr, "%.256s", addr->host_used->name);
4468 sprintf(CS ptr, "%.64s", addr->host_used->address);
4470 memcpy(ptr, &(addr->host_used->port), sizeof(addr->host_used->port));
4471 ptr += sizeof(addr->host_used->port);
4473 /* DNS lookup status */
4474 *ptr++ = addr->host_used->dnssec==DS_YES ? '2'
4475 : addr->host_used->dnssec==DS_NO ? '1' : '0';
4478 rmt_dlv_checked_write(fd, 'A', '0', big_buffer, ptr - big_buffer);
4481 /* Local interface address/port */
4482 if (LOGGING(incoming_interface) && sending_ip_address)
4484 uschar * ptr = big_buffer;
4485 sprintf(CS ptr, "%.128s", sending_ip_address);
4487 sprintf(CS ptr, "%d", sending_port);
4490 rmt_dlv_checked_write(fd, 'I', '0', big_buffer, ptr - big_buffer);
4493 /* Add termination flag, close the pipe, and that's it. The character
4494 after 'Z' indicates whether continue_transport is now NULL or not.
4495 A change from non-NULL to NULL indicates a problem with a continuing
4498 big_buffer[0] = (continue_transport == NULL)? '0' : '1';
4499 rmt_dlv_checked_write(fd, 'Z', '0', big_buffer, 1);
4504 /* Back in the mainline: close the unwanted half of the pipe. */
4506 (void)close(pfd[pipe_write]);
4508 /* Fork failed; defer with error message */
4512 (void)close(pfd[pipe_read]);
4513 remote_post_process(addr, LOG_MAIN|LOG_PANIC,
4514 string_sprintf("fork failed for remote delivery to %s: %s",
4515 addr->domain, strerror(errno)), fallback);
4519 /* Fork succeeded; increment the count, and remember relevant data for
4520 when the process finishes. */
4523 parlist[poffset].addrlist = parlist[poffset].addr = addr;
4524 parlist[poffset].pid = pid;
4525 parlist[poffset].fd = pfd[pipe_read];
4526 parlist[poffset].done = FALSE;
4527 parlist[poffset].msg = NULL;
4528 parlist[poffset].return_path = return_path;
4530 /* If the process we've just started is sending a message down an existing
4531 channel, wait for it now. This ensures that only one such process runs at
4532 once, whatever the value of remote_max parallel. Otherwise, we might try to
4533 send two or more messages simultaneously down the same channel. This could
4534 happen if there are different domains that include the same host in otherwise
4535 different host lists.
4537 Also, if the transport closes down the channel, this information gets back
4538 (continue_transport gets set to NULL) before we consider any other addresses
4541 if (continue_transport != NULL) par_reduce(0, fallback);
4543 /* Otherwise, if we are running in the test harness, wait a bit, to let the
4544 newly created process get going before we create another process. This should
4545 ensure repeatability in the tests. We only need to wait a tad. */
4547 else if (running_in_test_harness) millisleep(500);
4550 /* Reached the end of the list of addresses. Wait for all the subprocesses that
4551 are still running and post-process their addresses. */
4553 par_reduce(0, fallback);
4560 /*************************************************
4561 * Split an address into local part and domain *
4562 *************************************************/
4564 /* This function initializes an address for routing by splitting it up into a
4565 local part and a domain. The local part is set up twice - once in its original
4566 casing, and once in lower case, and it is dequoted. We also do the "percent
4567 hack" for configured domains. This may lead to a DEFER result if a lookup
4568 defers. When a percent-hacking takes place, we insert a copy of the original
4569 address as a new parent of this address, as if we have had a redirection.
4572 addr points to an addr_item block containing the address
4575 DEFER - could not determine if domain is %-hackable
4579 deliver_split_address(address_item *addr)
4581 uschar *address = addr->address;
4582 uschar *domain = Ustrrchr(address, '@');
4584 int len = domain - address;
4586 addr->domain = string_copylc(domain+1); /* Domains are always caseless */
4588 /* The implication in the RFCs (though I can't say I've seen it spelled out
4589 explicitly) is that quoting should be removed from local parts at the point
4590 where they are locally interpreted. [The new draft "821" is more explicit on
4591 this, Jan 1999.] We know the syntax is valid, so this can be done by simply
4592 removing quoting backslashes and any unquoted doublequotes. */
4594 t = addr->cc_local_part = store_get(len+1);
4597 register int c = *address++;
4598 if (c == '\"') continue;
4608 /* We do the percent hack only for those domains that are listed in
4609 percent_hack_domains. A loop is required, to copy with multiple %-hacks. */
4611 if (percent_hack_domains != NULL)
4614 uschar *new_address = NULL;
4615 uschar *local_part = addr->cc_local_part;
4617 deliver_domain = addr->domain; /* set $domain */
4619 while ((rc = match_isinlist(deliver_domain, (const uschar **)&percent_hack_domains, 0,
4620 &domainlist_anchor, addr->domain_cache, MCL_DOMAIN, TRUE, NULL))
4622 (t = Ustrrchr(local_part, '%')) != NULL)
4624 new_address = string_copy(local_part);
4625 new_address[t - local_part] = '@';
4626 deliver_domain = string_copylc(t+1);
4627 local_part = string_copyn(local_part, t - local_part);
4630 if (rc == DEFER) return DEFER; /* lookup deferred */
4632 /* If hackery happened, set up new parent and alter the current address. */
4634 if (new_address != NULL)
4636 address_item *new_parent = store_get(sizeof(address_item));
4637 *new_parent = *addr;
4638 addr->parent = new_parent;
4639 addr->address = new_address;
4640 addr->unique = string_copy(new_address);
4641 addr->domain = deliver_domain;
4642 addr->cc_local_part = local_part;
4643 DEBUG(D_deliver) debug_printf("%%-hack changed address to: %s\n",
4648 /* Create the lowercased version of the final local part, and make that the
4649 default one to be used. */
4651 addr->local_part = addr->lc_local_part = string_copylc(addr->cc_local_part);
4658 /*************************************************
4659 * Get next error message text *
4660 *************************************************/
4662 /* If f is not NULL, read the next "paragraph", from a customized error message
4663 text file, terminated by a line containing ****, and expand it.
4666 f NULL or a file to read from
4667 which string indicating which string (for errors)
4669 Returns: NULL or an expanded string
4673 next_emf(FILE *f, uschar *which)
4677 uschar *para, *yield;
4680 if (f == NULL) return NULL;
4682 if (Ufgets(buffer, sizeof(buffer), f) == NULL ||
4683 Ustrcmp(buffer, "****\n") == 0) return NULL;
4685 para = store_get(size);
4688 para = string_cat(para, &size, &ptr, buffer, Ustrlen(buffer));
4689 if (Ufgets(buffer, sizeof(buffer), f) == NULL ||
4690 Ustrcmp(buffer, "****\n") == 0) break;
4694 yield = expand_string(para);
4695 if (yield != NULL) return yield;
4697 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand string from "
4698 "bounce_message_file or warn_message_file (%s): %s", which,
4699 expand_string_message);
4706 /*************************************************
4707 * Close down a passed transport channel *
4708 *************************************************/
4710 /* This function is called when a passed transport channel cannot be used.
4711 It attempts to close it down tidily. The yield is always DELIVER_NOT_ATTEMPTED
4712 so that the function call can be the argument of a "return" statement.
4715 Returns: DELIVER_NOT_ATTEMPTED
4719 continue_closedown(void)
4721 if (continue_transport != NULL)
4723 transport_instance *t;
4724 for (t = transports; t != NULL; t = t->next)
4726 if (Ustrcmp(t->name, continue_transport) == 0)
4728 if (t->info->closedown != NULL) (t->info->closedown)(t);
4733 return DELIVER_NOT_ATTEMPTED;
4739 /*************************************************
4740 * Print address information *
4741 *************************************************/
4743 /* This function is called to output an address, or information about an
4744 address, for bounce or defer messages. If the hide_child flag is set, all we
4745 output is the original ancestor address.
4748 addr points to the address
4749 f the FILE to print to
4750 si an initial string
4751 sc a continuation string for before "generated"
4754 Returns: TRUE if the address is not hidden
4758 print_address_information(address_item *addr, FILE *f, uschar *si, uschar *sc,
4762 uschar *printed = US"";
4763 address_item *ancestor = addr;
4764 while (ancestor->parent != NULL) ancestor = ancestor->parent;
4766 fprintf(f, "%s", CS si);
4768 if (addr->parent != NULL && testflag(addr, af_hide_child))
4770 printed = US"an undisclosed address";
4773 else if (!testflag(addr, af_pfr) || addr->parent == NULL)
4774 printed = addr->address;
4778 uschar *s = addr->address;
4781 if (addr->address[0] == '>') { ss = US"mail"; s++; }
4782 else if (addr->address[0] == '|') ss = US"pipe";
4785 fprintf(f, "%s to %s%sgenerated by ", ss, s, sc);
4786 printed = addr->parent->address;
4789 fprintf(f, "%s", CS string_printing(printed));
4791 if (ancestor != addr)
4793 uschar *original = (ancestor->onetime_parent == NULL)?
4794 ancestor->address : ancestor->onetime_parent;
4795 if (strcmpic(original, printed) != 0)
4796 fprintf(f, "%s(%sgenerated from %s)", sc,
4797 (ancestor != addr->parent)? "ultimately " : "",
4798 string_printing(original));
4801 if (addr->host_used)
4802 fprintf(f, "\n host %s [%s]",
4803 addr->host_used->name, addr->host_used->address);
4805 fprintf(f, "%s", CS se);
4813 /*************************************************
4814 * Print error for an address *
4815 *************************************************/
4817 /* This function is called to print the error information out of an address for
4818 a bounce or a warning message. It tries to format the message reasonably by
4819 introducing newlines. All lines are indented by 4; the initial printing
4820 position must be set before calling.
4822 This function used always to print the error. Nowadays we want to restrict it
4823 to cases such as LMTP/SMTP errors from a remote host, and errors from :fail:
4824 and filter "fail". We no longer pass other information willy-nilly in bounce
4825 and warning messages. Text in user_message is always output; text in message
4826 only if the af_pass_message flag is set.
4830 f the FILE to print on
4837 print_address_error(address_item *addr, FILE *f, uschar *t)
4839 int count = Ustrlen(t);
4840 uschar *s = testflag(addr, af_pass_message)? addr->message : NULL;
4842 if (!s && !(s = addr->user_message))
4845 fprintf(f, "\n %s", t);
4848 if (*s == '\\' && s[1] == 'n')
4858 if (*s++ == ':' && isspace(*s) && count > 45)
4860 fprintf(f, "\n "); /* sic (because space follows) */
4867 /***********************************************************
4868 * Print Diagnostic-Code for an address *
4869 ************************************************************/
4871 /* This function is called to print the error information out of an address for
4872 a bounce or a warning message. It tries to format the message reasonably as
4873 required by RFC 3461 by adding a space after each newline
4875 it uses the same logic as print_address_error() above. if af_pass_message is true
4876 and addr->message is set it uses the remote host answer. if not addr->user_message
4877 is used instead if available.
4881 f the FILE to print on
4887 print_dsn_diagnostic_code(const address_item *addr, FILE *f)
4889 uschar *s = testflag(addr, af_pass_message) ? addr->message : NULL;
4891 /* af_pass_message and addr->message set ? print remote host answer */
4895 debug_printf("DSN Diagnostic-Code: addr->message = %s\n", addr->message);
4897 /* search first ": ". we assume to find the remote-MTA answer there */
4898 if (!(s = Ustrstr(addr->message, ": ")))
4899 return; /* not found, bail out */
4900 s += 2; /* skip ": " */
4901 fprintf(f, "Diagnostic-Code: smtp; ");
4903 /* no message available. do nothing */
4907 if (*s == '\\' && s[1] == 'n')
4909 fputs("\n ", f); /* as defined in RFC 3461 */
4919 /*************************************************
4920 * Check list of addresses for duplication *
4921 *************************************************/
4923 /* This function was introduced when the test for duplicate addresses that are
4924 not pipes, files, or autoreplies was moved from the middle of routing to when
4925 routing was complete. That was to fix obscure cases when the routing history
4926 affects the subsequent routing of identical addresses. This function is called
4927 after routing, to check that the final routed addresses are not duplicates.
4929 If we detect a duplicate, we remember what it is a duplicate of. Note that
4930 pipe, file, and autoreply de-duplication is handled during routing, so we must
4931 leave such "addresses" alone here, as otherwise they will incorrectly be
4934 Argument: address of list anchor
4939 do_duplicate_check(address_item **anchor)
4942 while ((addr = *anchor) != NULL)
4945 if (testflag(addr, af_pfr))
4947 anchor = &(addr->next);
4949 else if ((tnode = tree_search(tree_duplicates, addr->unique)) != NULL)
4951 DEBUG(D_deliver|D_route)
4952 debug_printf("%s is a duplicate address: discarded\n", addr->unique);
4953 *anchor = addr->next;
4954 addr->dupof = tnode->data.ptr;
4955 addr->next = addr_duplicate;
4956 addr_duplicate = addr;
4960 tree_add_duplicate(addr->unique, addr);
4961 anchor = &(addr->next);
4969 /*************************************************
4970 * Deliver one message *
4971 *************************************************/
4973 /* This is the function which is called when a message is to be delivered. It
4974 is passed the id of the message. It is possible that the message no longer
4975 exists, if some other process has delivered it, and it is also possible that
4976 the message is being worked on by another process, in which case the data file
4979 If no delivery is attempted for any of the above reasons, the function returns
4980 DELIVER_NOT_ATTEMPTED.
4982 If the give_up flag is set true, do not attempt any deliveries, but instead
4983 fail all outstanding addresses and return the message to the sender (or
4986 A delivery operation has a process all to itself; we never deliver more than
4987 one message in the same process. Therefore we needn't worry too much about
4991 id the id of the message to be delivered
4992 forced TRUE if delivery was forced by an administrator; this overrides
4993 retry delays and causes a delivery to be tried regardless
4994 give_up TRUE if an administrator has requested that delivery attempts
4997 Returns: When the global variable mua_wrapper is FALSE:
4998 DELIVER_ATTEMPTED_NORMAL if a delivery attempt was made
4999 DELIVER_NOT_ATTEMPTED otherwise (see comment above)
5000 When the global variable mua_wrapper is TRUE:
5001 DELIVER_MUA_SUCCEEDED if delivery succeeded
5002 DELIVER_MUA_FAILED if delivery failed
5003 DELIVER_NOT_ATTEMPTED if not attempted (should not occur)
5007 deliver_message(uschar *id, BOOL forced, BOOL give_up)
5010 int final_yield = DELIVER_ATTEMPTED_NORMAL;
5011 time_t now = time(NULL);
5012 address_item *addr_last = NULL;
5013 uschar *filter_message = NULL;
5015 int process_recipients = RECIP_ACCEPT;
5018 extern int acl_where;
5020 uschar *info = (queue_run_pid == (pid_t)0)?
5021 string_sprintf("delivering %s", id) :
5022 string_sprintf("delivering %s (queue run pid %d)", id, queue_run_pid);
5024 /* If the D_process_info bit is on, set_process_info() will output debugging
5025 information. If not, we want to show this initial information if D_deliver or
5026 D_queue_run is set or in verbose mode. */
5028 set_process_info("%s", info);
5030 if ((debug_selector & D_process_info) == 0 &&
5031 (debug_selector & (D_deliver|D_queue_run|D_v)) != 0)
5032 debug_printf("%s\n", info);
5034 /* Ensure that we catch any subprocesses that are created. Although Exim
5035 sets SIG_DFL as its initial default, some routes through the code end up
5036 here with it set to SIG_IGN - cases where a non-synchronous delivery process
5037 has been forked, but no re-exec has been done. We use sigaction rather than
5038 plain signal() on those OS where SA_NOCLDWAIT exists, because we want to be
5039 sure it is turned off. (There was a problem on AIX with this.) */
5043 struct sigaction act;
5044 act.sa_handler = SIG_DFL;
5045 sigemptyset(&(act.sa_mask));
5047 sigaction(SIGCHLD, &act, NULL);
5050 signal(SIGCHLD, SIG_DFL);
5053 /* Make the forcing flag available for routers and transports, set up the
5054 global message id field, and initialize the count for returned files and the
5055 message size. This use of strcpy() is OK because the length id is checked when
5056 it is obtained from a command line (the -M or -q options), and otherwise it is
5057 known to be a valid message id. */
5059 Ustrcpy(message_id, id);
5060 deliver_force = forced;
5064 /* Initialize some flags */
5066 update_spool = FALSE;
5067 remove_journal = TRUE;
5069 /* Set a known context for any ACLs we call via expansions */
5070 acl_where = ACL_WHERE_DELIVERY;
5072 /* Reset the random number generator, so that if several delivery processes are
5073 started from a queue runner that has already used random numbers (for sorting),
5074 they don't all get the same sequence. */
5078 /* Open and lock the message's data file. Exim locks on this one because the
5079 header file may get replaced as it is re-written during the delivery process.
5080 Any failures cause messages to be written to the log, except for missing files
5081 while queue running - another process probably completed delivery. As part of
5082 opening the data file, message_subdir gets set. */
5084 if (!spool_open_datafile(id))
5085 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5087 /* The value of message_size at this point has been set to the data length,
5088 plus one for the blank line that notionally precedes the data. */
5090 /* Now read the contents of the header file, which will set up the headers in
5091 store, and also the list of recipients and the tree of non-recipients and
5092 assorted flags. It updates message_size. If there is a reading or format error,
5093 give up; if the message has been around for sufficiently long, remove it. */
5095 sprintf(CS spoolname, "%s-H", id);
5096 if ((rc = spool_read_header(spoolname, TRUE, TRUE)) != spool_read_OK)
5098 if (errno == ERRNO_SPOOLFORMAT)
5100 struct stat statbuf;
5101 sprintf(CS big_buffer, "%s/input/%s/%s", spool_directory, message_subdir,
5103 if (Ustat(big_buffer, &statbuf) == 0)
5104 log_write(0, LOG_MAIN, "Format error in spool file %s: "
5105 "size=" OFF_T_FMT, spoolname, statbuf.st_size);
5106 else log_write(0, LOG_MAIN, "Format error in spool file %s", spoolname);
5109 log_write(0, LOG_MAIN, "Error reading spool file %s: %s", spoolname,
5112 /* If we managed to read the envelope data, received_time contains the
5113 time the message was received. Otherwise, we can calculate it from the
5116 if (rc != spool_read_hdrerror)
5119 for (i = 0; i < 6; i++)
5120 received_time = received_time * BASE_62 + tab62[id[i] - '0'];
5123 /* If we've had this malformed message too long, sling it. */
5125 if (now - received_time > keep_malformed)
5127 sprintf(CS spoolname, "%s/msglog/%s/%s", spool_directory, message_subdir, id);
5129 sprintf(CS spoolname, "%s/input/%s/%s-D", spool_directory, message_subdir, id);
5131 sprintf(CS spoolname, "%s/input/%s/%s-H", spool_directory, message_subdir, id);
5133 sprintf(CS spoolname, "%s/input/%s/%s-J", spool_directory, message_subdir, id);
5135 log_write(0, LOG_MAIN, "Message removed because older than %s",
5136 readconf_printtime(keep_malformed));
5139 (void)close(deliver_datafile);
5140 deliver_datafile = -1;
5141 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5144 /* The spool header file has been read. Look to see if there is an existing
5145 journal file for this message. If there is, it means that a previous delivery
5146 attempt crashed (program or host) before it could update the spool header file.
5147 Read the list of delivered addresses from the journal and add them to the
5148 nonrecipients tree. Then update the spool file. We can leave the journal in
5149 existence, as it will get further successful deliveries added to it in this
5150 run, and it will be deleted if this function gets to its end successfully.
5151 Otherwise it might be needed again. */
5153 sprintf(CS spoolname, "%s/input/%s/%s-J", spool_directory, message_subdir, id);
5154 jread = Ufopen(spoolname, "rb");
5157 while (Ufgets(big_buffer, big_buffer_size, jread) != NULL)
5159 int n = Ustrlen(big_buffer);
5160 big_buffer[n-1] = 0;
5161 tree_add_nonrecipient(big_buffer);
5162 DEBUG(D_deliver) debug_printf("Previously delivered address %s taken from "
5163 "journal file\n", big_buffer);
5165 (void)fclose(jread);
5166 /* Panic-dies on error */
5167 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
5169 else if (errno != ENOENT)
5171 log_write(0, LOG_MAIN|LOG_PANIC, "attempt to open journal for reading gave: "
5172 "%s", strerror(errno));
5173 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5176 /* A null recipients list indicates some kind of disaster. */
5178 if (recipients_list == NULL)
5180 (void)close(deliver_datafile);
5181 deliver_datafile = -1;
5182 log_write(0, LOG_MAIN, "Spool error: no recipients for %s", spoolname);
5183 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5187 /* Handle a message that is frozen. There are a number of different things that
5188 can happen, but in the default situation, unless forced, no delivery is
5193 #ifdef SUPPORT_MOVE_FROZEN_MESSAGES
5194 /* Moving to another directory removes the message from Exim's view. Other
5195 tools must be used to deal with it. Logging of this action happens in
5196 spool_move_message() and its subfunctions. */
5198 if (move_frozen_messages &&
5199 spool_move_message(id, message_subdir, US"", US"F"))
5200 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5203 /* For all frozen messages (bounces or not), timeout_frozen_after sets the
5204 maximum time to keep messages that are frozen. Thaw if we reach it, with a
5205 flag causing all recipients to be failed. The time is the age of the
5206 message, not the time since freezing. */
5208 if (timeout_frozen_after > 0 && message_age >= timeout_frozen_after)
5210 log_write(0, LOG_MAIN, "cancelled by timeout_frozen_after");
5211 process_recipients = RECIP_FAIL_TIMEOUT;
5214 /* For bounce messages (and others with no sender), thaw if the error message
5215 ignore timer is exceeded. The message will be discarded if this delivery
5218 else if (sender_address[0] == 0 && message_age >= ignore_bounce_errors_after)
5220 log_write(0, LOG_MAIN, "Unfrozen by errmsg timer");
5223 /* If this is a bounce message, or there's no auto thaw, or we haven't
5224 reached the auto thaw time yet, and this delivery is not forced by an admin
5225 user, do not attempt delivery of this message. Note that forced is set for
5226 continuing messages down the same channel, in order to skip load checking and
5227 ignore hold domains, but we don't want unfreezing in that case. */
5231 if ((sender_address[0] == 0 ||
5233 now <= deliver_frozen_at + auto_thaw
5236 (!forced || !deliver_force_thaw || !admin_user ||
5237 continue_hostname != NULL
5240 (void)close(deliver_datafile);
5241 deliver_datafile = -1;
5242 log_write(L_skip_delivery, LOG_MAIN, "Message is frozen");
5243 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5246 /* If delivery was forced (by an admin user), assume a manual thaw.
5247 Otherwise it's an auto thaw. */
5251 deliver_manual_thaw = TRUE;
5252 log_write(0, LOG_MAIN, "Unfrozen by forced delivery");
5254 else log_write(0, LOG_MAIN, "Unfrozen by auto-thaw");
5257 /* We get here if any of the rules for unfreezing have triggered. */
5259 deliver_freeze = FALSE;
5260 update_spool = TRUE;
5264 /* Open the message log file if we are using them. This records details of
5265 deliveries, deferments, and failures for the benefit of the mail administrator.
5266 The log is not used by exim itself to track the progress of a message; that is
5267 done by rewriting the header spool file. */
5274 sprintf(CS spoolname, "%s/msglog/%s/%s", spool_directory, message_subdir, id);
5275 fd = open_msglog_file(spoolname, SPOOL_MODE, &error);
5279 log_write(0, LOG_MAIN|LOG_PANIC, "Couldn't %s message log %s: %s", error,
5280 spoolname, strerror(errno));
5281 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5284 /* Make a C stream out of it. */
5286 message_log = fdopen(fd, "a");
5287 if (message_log == NULL)
5289 log_write(0, LOG_MAIN|LOG_PANIC, "Couldn't fdopen message log %s: %s",
5290 spoolname, strerror(errno));
5291 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5296 /* If asked to give up on a message, log who did it, and set the action for all
5301 struct passwd *pw = getpwuid(real_uid);
5302 log_write(0, LOG_MAIN, "cancelled by %s", (pw != NULL)?
5303 US pw->pw_name : string_sprintf("uid %ld", (long int)real_uid));
5304 process_recipients = RECIP_FAIL;
5307 /* Otherwise, if there are too many Received: headers, fail all recipients. */
5309 else if (received_count > received_headers_max)
5310 process_recipients = RECIP_FAIL_LOOP;
5312 /* Otherwise, if a system-wide, address-independent message filter is
5313 specified, run it now, except in the case when we are failing all recipients as
5314 a result of timeout_frozen_after. If the system filter yields "delivered", then
5315 ignore the true recipients of the message. Failure of the filter file is
5316 logged, and the delivery attempt fails. */
5318 else if (system_filter != NULL && process_recipients != RECIP_FAIL_TIMEOUT)
5323 redirect_block redirect;
5325 if (system_filter_uid_set)
5327 ugid.uid = system_filter_uid;
5328 ugid.gid = system_filter_gid;
5329 ugid.uid_set = ugid.gid_set = TRUE;
5333 ugid.uid_set = ugid.gid_set = FALSE;
5336 return_path = sender_address;
5337 enable_dollar_recipients = TRUE; /* Permit $recipients in system filter */
5338 system_filtering = TRUE;
5340 /* Any error in the filter file causes a delivery to be abandoned. */
5342 redirect.string = system_filter;
5343 redirect.isfile = TRUE;
5344 redirect.check_owner = redirect.check_group = FALSE;
5345 redirect.owners = NULL;
5346 redirect.owngroups = NULL;
5348 redirect.modemask = 0;
5350 DEBUG(D_deliver|D_filter) debug_printf("running system filter\n");
5353 &redirect, /* Where the data is */
5354 RDO_DEFER | /* Turn on all the enabling options */
5355 RDO_FAIL | /* Leave off all the disabling options */
5360 NULL, /* No :include: restriction (not used in filter) */
5361 NULL, /* No sieve vacation directory (not sieve!) */
5362 NULL, /* No sieve enotify mailto owner (not sieve!) */
5363 NULL, /* No sieve user address (not sieve!) */
5364 NULL, /* No sieve subaddress (not sieve!) */
5365 &ugid, /* uid/gid data */
5366 &addr_new, /* Where to hang generated addresses */
5367 &filter_message, /* Where to put error message */
5368 NULL, /* Don't skip syntax errors */
5369 &filtertype, /* Will always be set to FILTER_EXIM for this call */
5370 US"system filter"); /* For error messages */
5372 DEBUG(D_deliver|D_filter) debug_printf("system filter returned %d\n", rc);
5374 if (rc == FF_ERROR || rc == FF_NONEXIST)
5376 (void)close(deliver_datafile);
5377 deliver_datafile = -1;
5378 log_write(0, LOG_MAIN|LOG_PANIC, "Error in system filter: %s",
5379 string_printing(filter_message));
5380 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5383 /* Reset things. If the filter message is an empty string, which can happen
5384 for a filter "fail" or "freeze" command with no text, reset it to NULL. */
5386 system_filtering = FALSE;
5387 enable_dollar_recipients = FALSE;
5388 if (filter_message != NULL && filter_message[0] == 0) filter_message = NULL;
5390 /* Save the values of the system filter variables so that user filters
5393 memcpy(filter_sn, filter_n, sizeof(filter_sn));
5395 /* The filter can request that delivery of the original addresses be
5400 process_recipients = RECIP_DEFER;
5401 deliver_msglog("Delivery deferred by system filter\n");
5402 log_write(0, LOG_MAIN, "Delivery deferred by system filter");
5405 /* The filter can request that a message be frozen, but this does not
5406 take place if the message has been manually thawed. In that case, we must
5407 unset "delivered", which is forced by the "freeze" command to make -bF
5410 else if (rc == FF_FREEZE && !deliver_manual_thaw)
5412 deliver_freeze = TRUE;
5413 deliver_frozen_at = time(NULL);
5414 process_recipients = RECIP_DEFER;
5415 frozen_info = string_sprintf(" by the system filter%s%s",
5416 (filter_message == NULL)? US"" : US": ",
5417 (filter_message == NULL)? US"" : filter_message);
5420 /* The filter can request that a message be failed. The error message may be
5421 quite long - it is sent back to the sender in the bounce - but we don't want
5422 to fill up the log with repetitions of it. If it starts with << then the text
5423 between << and >> is written to the log, with the rest left for the bounce
5426 else if (rc == FF_FAIL)
5428 uschar *colon = US"";
5429 uschar *logmsg = US"";
5432 process_recipients = RECIP_FAIL_FILTER;
5434 if (filter_message != NULL)
5438 if (filter_message[0] == '<' && filter_message[1] == '<' &&
5439 (logend = Ustrstr(filter_message, ">>")) != NULL)
5441 logmsg = filter_message + 2;
5442 loglen = logend - logmsg;
5443 filter_message = logend + 2;
5444 if (filter_message[0] == 0) filter_message = NULL;
5448 logmsg = filter_message;
5449 loglen = Ustrlen(filter_message);
5453 log_write(0, LOG_MAIN, "cancelled by system filter%s%.*s", colon, loglen,
5457 /* Delivery can be restricted only to those recipients (if any) that the
5458 filter specified. */
5460 else if (rc == FF_DELIVERED)
5462 process_recipients = RECIP_IGNORE;
5463 if (addr_new == NULL)
5464 log_write(0, LOG_MAIN, "=> discarded (system filter)");
5466 log_write(0, LOG_MAIN, "original recipients ignored (system filter)");
5469 /* If any new addresses were created by the filter, fake up a "parent"
5470 for them. This is necessary for pipes, etc., which are expected to have
5471 parents, and it also gives some sensible logging for others. Allow
5472 pipes, files, and autoreplies, and run them as the filter uid if set,
5473 otherwise as the current uid. */
5475 if (addr_new != NULL)
5477 int uid = (system_filter_uid_set)? system_filter_uid : geteuid();
5478 int gid = (system_filter_gid_set)? system_filter_gid : getegid();
5480 /* The text "system-filter" is tested in transport_set_up_command() and in
5481 set_up_shell_command() in the pipe transport, to enable them to permit
5482 $recipients, so don't change it here without also changing it there. */
5484 address_item *p = addr_new;
5485 address_item *parent = deliver_make_addr(US"system-filter", FALSE);
5487 parent->domain = string_copylc(qualify_domain_recipient);
5488 parent->local_part = US"system-filter";
5490 /* As part of this loop, we arrange for addr_last to end up pointing
5491 at the final address. This is used if we go on to add addresses for the
5492 original recipients. */
5496 if (parent->child_count == SHRT_MAX)
5497 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "system filter generated more "
5498 "than %d delivery addresses", SHRT_MAX);
5499 parent->child_count++;
5502 if (testflag(p, af_pfr))
5508 setflag(p, af_uid_set |
5514 /* Find the name of the system filter's appropriate pfr transport */
5516 if (p->address[0] == '|')
5519 tpname = system_filter_pipe_transport;
5520 address_pipe = p->address;
5522 else if (p->address[0] == '>')
5525 tpname = system_filter_reply_transport;
5529 if (p->address[Ustrlen(p->address)-1] == '/')
5531 type = US"directory";
5532 tpname = system_filter_directory_transport;
5537 tpname = system_filter_file_transport;
5539 address_file = p->address;
5542 /* Now find the actual transport, first expanding the name. We have
5543 set address_file or address_pipe above. */
5547 uschar *tmp = expand_string(tpname);
5548 address_file = address_pipe = NULL;
5550 p->message = string_sprintf("failed to expand \"%s\" as a "
5551 "system filter transport name", tpname);
5556 p->message = string_sprintf("system_filter_%s_transport is unset",
5562 transport_instance *tp;
5563 for (tp = transports; tp != NULL; tp = tp->next)
5565 if (Ustrcmp(tp->name, tpname) == 0)
5572 p->message = string_sprintf("failed to find \"%s\" transport "
5573 "for system filter delivery", tpname);
5576 /* If we couldn't set up a transport, defer the delivery, putting the
5577 error on the panic log as well as the main log. */
5579 if (p->transport == NULL)
5581 address_item *badp = p;
5583 if (addr_last == NULL) addr_new = p; else addr_last->next = p;
5584 badp->local_part = badp->address; /* Needed for log line */
5585 post_process_one(badp, DEFER, LOG_MAIN|LOG_PANIC, DTYPE_ROUTER, 0);
5588 } /* End of pfr handling */
5590 /* Either a non-pfr delivery, or we found a transport */
5592 DEBUG(D_deliver|D_filter)
5593 debug_printf("system filter added %s\n", p->address);
5597 } /* Loop through all addr_new addresses */
5602 /* Scan the recipients list, and for every one that is not in the non-
5603 recipients tree, add an addr item to the chain of new addresses. If the pno
5604 value is non-negative, we must set the onetime parent from it. This which
5605 points to the relevant entry in the recipients list.
5607 This processing can be altered by the setting of the process_recipients
5608 variable, which is changed if recipients are to be ignored, failed, or
5609 deferred. This can happen as a result of system filter activity, or if the -Mg
5610 option is used to fail all of them.
5612 Duplicate addresses are handled later by a different tree structure; we can't
5613 just extend the non-recipients tree, because that will be re-written to the
5614 spool if the message is deferred, and in any case there are casing
5615 complications for local addresses. */
5617 if (process_recipients != RECIP_IGNORE)
5619 for (i = 0; i < recipients_count; i++)
5621 if (tree_search(tree_nonrecipients, recipients_list[i].address) == NULL)
5623 recipient_item *r = recipients_list + i;
5624 address_item *new = deliver_make_addr(r->address, FALSE);
5625 new->prop.errors_address = r->errors_to;
5626 #ifdef EXPERIMENTAL_INTERNATIONAL
5627 if ((new->prop.utf8_msg = message_smtputf8))
5629 new->prop.utf8_downcvt = message_utf8_downconvert == 1;
5630 new->prop.utf8_downcvt_maybe = message_utf8_downconvert == -1;
5631 DEBUG(D_deliver) debug_printf("utf8, downconvert %s\n",
5632 new->prop.utf8_downcvt ? "yes"
5633 : new->prop.utf8_downcvt_maybe ? "ifneeded"
5639 new->onetime_parent = recipients_list[r->pno].address;
5641 /* If DSN support is enabled, set the dsn flags and the original receipt
5642 to be passed on to other DSN enabled MTAs */
5643 new->dsn_flags = r->dsn_flags & rf_dsnflags;
5644 new->dsn_orcpt = r->orcpt;
5645 DEBUG(D_deliver) debug_printf("DSN: set orcpt: %s flags: %d\n",
5646 new->dsn_orcpt, new->dsn_flags);
5648 switch (process_recipients)
5650 /* RECIP_DEFER is set when a system filter freezes a message. */
5653 new->next = addr_defer;
5658 /* RECIP_FAIL_FILTER is set when a system filter has obeyed a "fail"
5661 case RECIP_FAIL_FILTER:
5663 (filter_message == NULL)? US"delivery cancelled" : filter_message;
5664 setflag(new, af_pass_message);
5665 goto RECIP_QUEUE_FAILED; /* below */
5668 /* RECIP_FAIL_TIMEOUT is set when a message is frozen, but is older
5669 than the value in timeout_frozen_after. Treat non-bounce messages
5670 similarly to -Mg; for bounce messages we just want to discard, so
5671 don't put the address on the failed list. The timeout has already
5674 case RECIP_FAIL_TIMEOUT:
5675 new->message = US"delivery cancelled; message timed out";
5676 goto RECIP_QUEUE_FAILED; /* below */
5679 /* RECIP_FAIL is set when -Mg has been used. */
5682 new->message = US"delivery cancelled by administrator";
5685 /* Common code for the failure cases above. If this is not a bounce
5686 message, put the address on the failed list so that it is used to
5687 create a bounce. Otherwise do nothing - this just discards the address.
5688 The incident has already been logged. */
5691 if (sender_address[0] != 0)
5693 new->next = addr_failed;
5699 /* RECIP_FAIL_LOOP is set when there are too many Received: headers
5700 in the message. Process each address as a routing failure; if this
5701 is a bounce message, it will get frozen. */
5703 case RECIP_FAIL_LOOP:
5704 new->message = US"Too many \"Received\" headers - suspected mail loop";
5705 post_process_one(new, FAIL, LOG_MAIN, DTYPE_ROUTER, 0);
5709 /* Value should be RECIP_ACCEPT; take this as the safe default. */
5712 if (addr_new == NULL) addr_new = new; else addr_last->next = new;
5717 #ifdef EXPERIMENTAL_EVENT
5718 if (process_recipients != RECIP_ACCEPT)
5720 uschar * save_local = deliver_localpart;
5721 const uschar * save_domain = deliver_domain;
5723 deliver_localpart = expand_string(
5724 string_sprintf("${local_part:%s}", new->address));
5725 deliver_domain = expand_string(
5726 string_sprintf("${domain:%s}", new->address));
5728 (void) event_raise(event_action,
5729 US"msg:fail:internal", new->message);
5731 deliver_localpart = save_local;
5732 deliver_domain = save_domain;
5741 address_item *p = addr_new;
5742 debug_printf("Delivery address list:\n");
5745 debug_printf(" %s %s\n", p->address, (p->onetime_parent == NULL)? US"" :
5751 /* Set up the buffers used for copying over the file when delivering. */
5753 deliver_in_buffer = store_malloc(DELIVER_IN_BUFFER_SIZE);
5754 deliver_out_buffer = store_malloc(DELIVER_OUT_BUFFER_SIZE);
5758 /* Until there are no more new addresses, handle each one as follows:
5760 . If this is a generated address (indicated by the presence of a parent
5761 pointer) then check to see whether it is a pipe, file, or autoreply, and
5762 if so, handle it directly here. The router that produced the address will
5763 have set the allow flags into the address, and also set the uid/gid required.
5764 Having the routers generate new addresses and then checking them here at
5765 the outer level is tidier than making each router do the checking, and
5766 means that routers don't need access to the failed address queue.
5768 . Break up the address into local part and domain, and make lowercased
5769 versions of these strings. We also make unquoted versions of the local part.
5771 . Handle the percent hack for those domains for which it is valid.
5773 . For child addresses, determine if any of the parents have the same address.
5774 If so, generate a different string for previous delivery checking. Without
5775 this code, if the address spqr generates spqr via a forward or alias file,
5776 delivery of the generated spqr stops further attempts at the top level spqr,
5777 which is not what is wanted - it may have generated other addresses.
5779 . Check on the retry database to see if routing was previously deferred, but
5780 only if in a queue run. Addresses that are to be routed are put on the
5781 addr_route chain. Addresses that are to be deferred are put on the
5782 addr_defer chain. We do all the checking first, so as not to keep the
5783 retry database open any longer than necessary.
5785 . Now we run the addresses through the routers. A router may put the address
5786 on either the addr_local or the addr_remote chain for local or remote
5787 delivery, respectively, or put it on the addr_failed chain if it is
5788 undeliveable, or it may generate child addresses and put them on the
5789 addr_new chain, or it may defer an address. All the chain anchors are
5790 passed as arguments so that the routers can be called for verification
5793 . If new addresses have been generated by the routers, da capo.
5796 header_rewritten = FALSE; /* No headers rewritten yet */
5797 while (addr_new != NULL) /* Loop until all addresses dealt with */
5799 address_item *addr, *parent;
5800 dbm_file = dbfn_open(US"retry", O_RDONLY, &dbblock, FALSE);
5802 /* Failure to open the retry database is treated the same as if it does
5803 not exist. In both cases, dbm_file is NULL. */
5805 if (dbm_file == NULL)
5807 DEBUG(D_deliver|D_retry|D_route|D_hints_lookup)
5808 debug_printf("no retry data available\n");
5811 /* Scan the current batch of new addresses, to handle pipes, files and
5812 autoreplies, and determine which others are ready for routing. */
5814 while (addr_new != NULL)
5819 dbdata_retry *domain_retry_record;
5820 dbdata_retry *address_retry_record;
5823 addr_new = addr->next;
5825 DEBUG(D_deliver|D_retry|D_route)
5827 debug_printf(">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>\n");
5828 debug_printf("Considering: %s\n", addr->address);
5831 /* Handle generated address that is a pipe or a file or an autoreply. */
5833 if (testflag(addr, af_pfr))
5835 /* If an autoreply in a filter could not generate a syntactically valid
5836 address, give up forthwith. Set af_ignore_error so that we don't try to
5837 generate a bounce. */
5839 if (testflag(addr, af_bad_reply))
5841 addr->basic_errno = ERRNO_BADADDRESS2;
5842 addr->local_part = addr->address;
5844 US"filter autoreply generated syntactically invalid recipient";
5845 setflag(addr, af_ignore_error);
5846 (void)post_process_one(addr, FAIL, LOG_MAIN, DTYPE_ROUTER, 0);
5847 continue; /* with the next new address */
5850 /* If two different users specify delivery to the same pipe or file or
5851 autoreply, there should be two different deliveries, so build a unique
5852 string that incorporates the original address, and use this for
5853 duplicate testing and recording delivery, and also for retrying. */
5856 string_sprintf("%s:%s", addr->address, addr->parent->unique +
5857 (testflag(addr->parent, af_homonym)? 3:0));
5859 addr->address_retry_key = addr->domain_retry_key =
5860 string_sprintf("T:%s", addr->unique);
5862 /* If a filter file specifies two deliveries to the same pipe or file,
5863 we want to de-duplicate, but this is probably not wanted for two mail
5864 commands to the same address, where probably both should be delivered.
5865 So, we have to invent a different unique string in that case. Just
5866 keep piling '>' characters on the front. */
5868 if (addr->address[0] == '>')
5870 while (tree_search(tree_duplicates, addr->unique) != NULL)
5871 addr->unique = string_sprintf(">%s", addr->unique);
5874 else if ((tnode = tree_search(tree_duplicates, addr->unique)) != NULL)
5876 DEBUG(D_deliver|D_route)
5877 debug_printf("%s is a duplicate address: discarded\n", addr->address);
5878 addr->dupof = tnode->data.ptr;
5879 addr->next = addr_duplicate;
5880 addr_duplicate = addr;
5884 DEBUG(D_deliver|D_route) debug_printf("unique = %s\n", addr->unique);
5886 /* Check for previous delivery */
5888 if (tree_search(tree_nonrecipients, addr->unique) != NULL)
5890 DEBUG(D_deliver|D_route)
5891 debug_printf("%s was previously delivered: discarded\n", addr->address);
5892 child_done(addr, tod_stamp(tod_log));
5896 /* Save for checking future duplicates */
5898 tree_add_duplicate(addr->unique, addr);
5900 /* Set local part and domain */
5902 addr->local_part = addr->address;
5903 addr->domain = addr->parent->domain;
5905 /* Ensure that the delivery is permitted. */
5907 if (testflag(addr, af_file))
5909 if (!testflag(addr, af_allow_file))
5911 addr->basic_errno = ERRNO_FORBIDFILE;
5912 addr->message = US"delivery to file forbidden";
5913 (void)post_process_one(addr, FAIL, LOG_MAIN, DTYPE_ROUTER, 0);
5914 continue; /* with the next new address */
5917 else if (addr->address[0] == '|')
5919 if (!testflag(addr, af_allow_pipe))
5921 addr->basic_errno = ERRNO_FORBIDPIPE;
5922 addr->message = US"delivery to pipe forbidden";
5923 (void)post_process_one(addr, FAIL, LOG_MAIN, DTYPE_ROUTER, 0);
5924 continue; /* with the next new address */
5927 else if (!testflag(addr, af_allow_reply))
5929 addr->basic_errno = ERRNO_FORBIDREPLY;
5930 addr->message = US"autoreply forbidden";
5931 (void)post_process_one(addr, FAIL, LOG_MAIN, DTYPE_ROUTER, 0);
5932 continue; /* with the next new address */
5935 /* If the errno field is already set to BADTRANSPORT, it indicates
5936 failure to expand a transport string, or find the associated transport,
5937 or an unset transport when one is required. Leave this test till now so
5938 that the forbid errors are given in preference. */
5940 if (addr->basic_errno == ERRNO_BADTRANSPORT)
5942 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_ROUTER, 0);
5946 /* Treat /dev/null as a special case and abandon the delivery. This
5947 avoids having to specify a uid on the transport just for this case.
5948 Arrange for the transport name to be logged as "**bypassed**". */
5950 if (Ustrcmp(addr->address, "/dev/null") == 0)
5952 uschar *save = addr->transport->name;
5953 addr->transport->name = US"**bypassed**";
5954 (void)post_process_one(addr, OK, LOG_MAIN, DTYPE_TRANSPORT, '=');
5955 addr->transport->name = save;
5956 continue; /* with the next new address */
5959 /* Pipe, file, or autoreply delivery is to go ahead as a normal local
5962 DEBUG(D_deliver|D_route)
5963 debug_printf("queued for %s transport\n", addr->transport->name);
5964 addr->next = addr_local;
5966 continue; /* with the next new address */
5969 /* Handle normal addresses. First, split up into local part and domain,
5970 handling the %-hack if necessary. There is the possibility of a defer from
5971 a lookup in percent_hack_domains. */
5973 if ((rc = deliver_split_address(addr)) == DEFER)
5975 addr->message = US"cannot check percent_hack_domains";
5976 addr->basic_errno = ERRNO_LISTDEFER;
5977 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_NONE, 0);
5981 /* Check to see if the domain is held. If so, proceed only if the
5982 delivery was forced by hand. */
5984 deliver_domain = addr->domain; /* set $domain */
5985 if (!forced && hold_domains != NULL &&
5986 (rc = match_isinlist(addr->domain, (const uschar **)&hold_domains, 0,
5987 &domainlist_anchor, addr->domain_cache, MCL_DOMAIN, TRUE,
5992 addr->message = US"hold_domains lookup deferred";
5993 addr->basic_errno = ERRNO_LISTDEFER;
5997 addr->message = US"domain is held";
5998 addr->basic_errno = ERRNO_HELD;
6000 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_NONE, 0);
6004 /* Now we can check for duplicates and previously delivered addresses. In
6005 order to do this, we have to generate a "unique" value for each address,
6006 because there may be identical actual addresses in a line of descendents.
6007 The "unique" field is initialized to the same value as the "address" field,
6008 but gets changed here to cope with identically-named descendents. */
6010 for (parent = addr->parent; parent != NULL; parent = parent->parent)
6011 if (strcmpic(addr->address, parent->address) == 0) break;
6013 /* If there's an ancestor with the same name, set the homonym flag. This
6014 influences how deliveries are recorded. Then add a prefix on the front of
6015 the unique address. We use \n\ where n starts at 0 and increases each time.
6016 It is unlikely to pass 9, but if it does, it may look odd but will still
6017 work. This means that siblings or cousins with the same names are treated
6018 as duplicates, which is what we want. */
6022 setflag(addr, af_homonym);
6023 if (parent->unique[0] != '\\')
6024 addr->unique = string_sprintf("\\0\\%s", addr->address);
6026 addr->unique = string_sprintf("\\%c\\%s", parent->unique[1] + 1,
6030 /* Ensure that the domain in the unique field is lower cased, because
6031 domains are always handled caselessly. */
6033 p = Ustrrchr(addr->unique, '@');
6034 while (*p != 0) { *p = tolower(*p); p++; }
6036 DEBUG(D_deliver|D_route) debug_printf("unique = %s\n", addr->unique);
6038 if (tree_search(tree_nonrecipients, addr->unique) != NULL)
6040 DEBUG(D_deliver|D_route)
6041 debug_printf("%s was previously delivered: discarded\n", addr->unique);
6042 child_done(addr, tod_stamp(tod_log));
6046 /* Get the routing retry status, saving the two retry keys (with and
6047 without the local part) for subsequent use. If there is no retry record for
6048 the standard address routing retry key, we look for the same key with the
6049 sender attached, because this form is used by the smtp transport after a
6050 4xx response to RCPT when address_retry_include_sender is true. */
6052 addr->domain_retry_key = string_sprintf("R:%s", addr->domain);
6053 addr->address_retry_key = string_sprintf("R:%s@%s", addr->local_part,
6056 if (dbm_file == NULL)
6057 domain_retry_record = address_retry_record = NULL;
6060 domain_retry_record = dbfn_read(dbm_file, addr->domain_retry_key);
6061 if (domain_retry_record != NULL &&
6062 now - domain_retry_record->time_stamp > retry_data_expire)
6063 domain_retry_record = NULL; /* Ignore if too old */
6065 address_retry_record = dbfn_read(dbm_file, addr->address_retry_key);
6066 if (address_retry_record != NULL &&
6067 now - address_retry_record->time_stamp > retry_data_expire)
6068 address_retry_record = NULL; /* Ignore if too old */
6070 if (address_retry_record == NULL)
6072 uschar *altkey = string_sprintf("%s:<%s>", addr->address_retry_key,
6074 address_retry_record = dbfn_read(dbm_file, altkey);
6075 if (address_retry_record != NULL &&
6076 now - address_retry_record->time_stamp > retry_data_expire)
6077 address_retry_record = NULL; /* Ignore if too old */
6081 DEBUG(D_deliver|D_retry)
6083 if (domain_retry_record == NULL)
6084 debug_printf("no domain retry record\n");
6085 if (address_retry_record == NULL)
6086 debug_printf("no address retry record\n");
6089 /* If we are sending a message down an existing SMTP connection, we must
6090 assume that the message which created the connection managed to route
6091 an address to that connection. We do not want to run the risk of taking
6092 a long time over routing here, because if we do, the server at the other
6093 end of the connection may time it out. This is especially true for messages
6094 with lots of addresses. For this kind of delivery, queue_running is not
6095 set, so we would normally route all addresses. We take a pragmatic approach
6096 and defer routing any addresses that have any kind of domain retry record.
6097 That is, we don't even look at their retry times. It doesn't matter if this
6098 doesn't work occasionally. This is all just an optimization, after all.
6100 The reason for not doing the same for address retries is that they normally
6101 arise from 4xx responses, not DNS timeouts. */
6103 if (continue_hostname != NULL && domain_retry_record != NULL)
6105 addr->message = US"reusing SMTP connection skips previous routing defer";
6106 addr->basic_errno = ERRNO_RRETRY;
6107 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_ROUTER, 0);
6110 /* If we are in a queue run, defer routing unless there is no retry data or
6111 we've passed the next retry time, or this message is forced. In other
6112 words, ignore retry data when not in a queue run.
6114 However, if the domain retry time has expired, always allow the routing
6115 attempt. If it fails again, the address will be failed. This ensures that
6116 each address is routed at least once, even after long-term routing
6119 If there is an address retry, check that too; just wait for the next
6120 retry time. This helps with the case when the temporary error on the
6121 address was really message-specific rather than address specific, since
6122 it allows other messages through.
6124 We also wait for the next retry time if this is a message sent down an
6125 existing SMTP connection (even though that will be forced). Otherwise there
6126 will be far too many attempts for an address that gets a 4xx error. In
6127 fact, after such an error, we should not get here because, the host should
6128 not be remembered as one this message needs. However, there was a bug that
6129 used to cause this to happen, so it is best to be on the safe side.
6131 Even if we haven't reached the retry time in the hints, there is one more
6132 check to do, which is for the ultimate address timeout. We only do this
6133 check if there is an address retry record and there is not a domain retry
6134 record; this implies that previous attempts to handle the address had the
6135 retry_use_local_parts option turned on. We use this as an approximation
6136 for the destination being like a local delivery, for example delivery over
6137 LMTP to an IMAP message store. In this situation users are liable to bump
6138 into their quota and thereby have intermittently successful deliveries,
6139 which keep the retry record fresh, which can lead to us perpetually
6140 deferring messages. */
6142 else if (((queue_running && !deliver_force) || continue_hostname != NULL)
6144 ((domain_retry_record != NULL &&
6145 now < domain_retry_record->next_try &&
6146 !domain_retry_record->expired)
6148 (address_retry_record != NULL &&
6149 now < address_retry_record->next_try))
6151 (domain_retry_record != NULL ||
6152 address_retry_record == NULL ||
6153 !retry_ultimate_address_timeout(addr->address_retry_key,
6154 addr->domain, address_retry_record, now)))
6156 addr->message = US"retry time not reached";
6157 addr->basic_errno = ERRNO_RRETRY;
6158 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_ROUTER, 0);
6161 /* The domain is OK for routing. Remember if retry data exists so it
6162 can be cleaned up after a successful delivery. */
6166 if (domain_retry_record != NULL || address_retry_record != NULL)
6167 setflag(addr, af_dr_retry_exists);
6168 addr->next = addr_route;
6170 DEBUG(D_deliver|D_route)
6171 debug_printf("%s: queued for routing\n", addr->address);
6175 /* The database is closed while routing is actually happening. Requests to
6176 update it are put on a chain and all processed together at the end. */
6178 if (dbm_file != NULL) dbfn_close(dbm_file);
6180 /* If queue_domains is set, we don't even want to try routing addresses in
6181 those domains. During queue runs, queue_domains is forced to be unset.
6182 Optimize by skipping this pass through the addresses if nothing is set. */
6184 if (!deliver_force && queue_domains != NULL)
6186 address_item *okaddr = NULL;
6187 while (addr_route != NULL)
6189 address_item *addr = addr_route;
6190 addr_route = addr->next;
6192 deliver_domain = addr->domain; /* set $domain */
6193 if ((rc = match_isinlist(addr->domain, (const uschar **)&queue_domains, 0,
6194 &domainlist_anchor, addr->domain_cache, MCL_DOMAIN, TRUE, NULL))
6199 addr->basic_errno = ERRNO_LISTDEFER;
6200 addr->message = US"queue_domains lookup deferred";
6201 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_ROUTER, 0);
6205 addr->next = okaddr;
6211 addr->basic_errno = ERRNO_QUEUE_DOMAIN;
6212 addr->message = US"domain is in queue_domains";
6213 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_ROUTER, 0);
6217 addr_route = okaddr;
6220 /* Now route those addresses that are not deferred. */
6222 while (addr_route != NULL)
6225 address_item *addr = addr_route;
6226 const uschar *old_domain = addr->domain;
6227 uschar *old_unique = addr->unique;
6228 addr_route = addr->next;
6231 /* Just in case some router parameter refers to it. */
6233 return_path = (addr->prop.errors_address != NULL)?
6234 addr->prop.errors_address : sender_address;
6236 /* If a router defers an address, add a retry item. Whether or not to
6237 use the local part in the key is a property of the router. */
6239 if ((rc = route_address(addr, &addr_local, &addr_remote, &addr_new,
6240 &addr_succeed, v_none)) == DEFER)
6241 retry_add_item(addr, (addr->router->retry_use_local_part)?
6242 string_sprintf("R:%s@%s", addr->local_part, addr->domain) :
6243 string_sprintf("R:%s", addr->domain), 0);
6245 /* Otherwise, if there is an existing retry record in the database, add
6246 retry items to delete both forms. We must also allow for the possibility
6247 of a routing retry that includes the sender address. Since the domain might
6248 have been rewritten (expanded to fully qualified) as a result of routing,
6249 ensure that the rewritten form is also deleted. */
6251 else if (testflag(addr, af_dr_retry_exists))
6253 uschar *altkey = string_sprintf("%s:<%s>", addr->address_retry_key,
6255 retry_add_item(addr, altkey, rf_delete);
6256 retry_add_item(addr, addr->address_retry_key, rf_delete);
6257 retry_add_item(addr, addr->domain_retry_key, rf_delete);
6258 if (Ustrcmp(addr->domain, old_domain) != 0)
6259 retry_add_item(addr, string_sprintf("R:%s", old_domain), rf_delete);
6262 /* DISCARD is given for :blackhole: and "seen finish". The event has been
6263 logged, but we need to ensure the address (and maybe parents) is marked
6268 address_done(addr, tod_stamp(tod_log));
6269 continue; /* route next address */
6272 /* The address is finished with (failed or deferred). */
6276 (void)post_process_one(addr, rc, LOG_MAIN, DTYPE_ROUTER, 0);
6277 continue; /* route next address */
6280 /* The address has been routed. If the router changed the domain, it will
6281 also have changed the unique address. We have to test whether this address
6282 has already been delivered, because it's the unique address that finally
6285 if (addr->unique != old_unique &&
6286 tree_search(tree_nonrecipients, addr->unique) != 0)
6288 DEBUG(D_deliver|D_route) debug_printf("%s was previously delivered: "
6289 "discarded\n", addr->address);
6290 if (addr_remote == addr) addr_remote = addr->next;
6291 else if (addr_local == addr) addr_local = addr->next;
6294 /* If the router has same_domain_copy_routing set, we are permitted to copy
6295 the routing for any other addresses with the same domain. This is an
6296 optimisation to save repeated DNS lookups for "standard" remote domain
6297 routing. The option is settable only on routers that generate host lists.
6298 We play it very safe, and do the optimization only if the address is routed
6299 to a remote transport, there are no header changes, and the domain was not
6300 modified by the router. */
6302 if (addr_remote == addr &&
6303 addr->router->same_domain_copy_routing &&
6304 addr->prop.extra_headers == NULL &&
6305 addr->prop.remove_headers == NULL &&
6306 old_domain == addr->domain)
6308 address_item **chain = &addr_route;
6309 while (*chain != NULL)
6311 address_item *addr2 = *chain;
6312 if (Ustrcmp(addr2->domain, addr->domain) != 0)
6314 chain = &(addr2->next);
6318 /* Found a suitable address; take it off the routing list and add it to
6319 the remote delivery list. */
6321 *chain = addr2->next;
6322 addr2->next = addr_remote;
6323 addr_remote = addr2;
6325 /* Copy the routing data */
6327 addr2->domain = addr->domain;
6328 addr2->router = addr->router;
6329 addr2->transport = addr->transport;
6330 addr2->host_list = addr->host_list;
6331 addr2->fallback_hosts = addr->fallback_hosts;
6332 addr2->prop.errors_address = addr->prop.errors_address;
6333 copyflag(addr2, addr, af_hide_child | af_local_host_removed);
6335 DEBUG(D_deliver|D_route)
6337 debug_printf(">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>\n"
6339 "Routing for %s copied from %s\n",
6340 addr2->address, addr2->address, addr->address);
6344 } /* Continue with routing the next address. */
6345 } /* Loop to process any child addresses that the routers created, and
6346 any rerouted addresses that got put back on the new chain. */
6349 /* Debugging: show the results of the routing */
6351 DEBUG(D_deliver|D_retry|D_route)
6353 address_item *p = addr_local;
6354 debug_printf(">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>\n");
6355 debug_printf("After routing:\n Local deliveries:\n");
6358 debug_printf(" %s\n", p->address);
6363 debug_printf(" Remote deliveries:\n");
6366 debug_printf(" %s\n", p->address);
6371 debug_printf(" Failed addresses:\n");
6374 debug_printf(" %s\n", p->address);
6379 debug_printf(" Deferred addresses:\n");
6382 debug_printf(" %s\n", p->address);
6387 /* Free any resources that were cached during routing. */
6392 /* These two variables are set only during routing, after check_local_user.
6393 Ensure they are not set in transports. */
6395 local_user_gid = (gid_t)(-1);
6396 local_user_uid = (uid_t)(-1);
6398 /* Check for any duplicate addresses. This check is delayed until after
6399 routing, because the flexibility of the routing configuration means that
6400 identical addresses with different parentage may end up being redirected to
6401 different addresses. Checking for duplicates too early (as we previously used
6402 to) makes this kind of thing not work. */
6404 do_duplicate_check(&addr_local);
6405 do_duplicate_check(&addr_remote);
6407 /* When acting as an MUA wrapper, we proceed only if all addresses route to a
6408 remote transport. The check that they all end up in one transaction happens in
6409 the do_remote_deliveries() function. */
6411 if (mua_wrapper && (addr_local != NULL || addr_failed != NULL ||
6412 addr_defer != NULL))
6415 uschar *which, *colon, *msg;
6417 if (addr_local != NULL)
6422 else if (addr_defer != NULL)
6425 which = US"deferred";
6433 while (addr->parent != NULL) addr = addr->parent;
6435 if (addr->message != NULL)
6438 msg = addr->message;
6440 else colon = msg = US"";
6442 /* We don't need to log here for a forced failure as it will already
6443 have been logged. Defer will also have been logged, but as a defer, so we do
6444 need to do the failure logging. */
6446 if (addr != addr_failed)
6447 log_write(0, LOG_MAIN, "** %s routing yielded a %s delivery",
6448 addr->address, which);
6450 /* Always write an error to the caller */
6452 fprintf(stderr, "routing %s yielded a %s delivery%s%s\n", addr->address,
6455 final_yield = DELIVER_MUA_FAILED;
6456 addr_failed = addr_defer = NULL; /* So that we remove the message */
6457 goto DELIVERY_TIDYUP;
6461 /* If this is a run to continue deliveries to an external channel that is
6462 already set up, defer any local deliveries. */
6464 if (continue_transport != NULL)
6466 if (addr_defer == NULL) addr_defer = addr_local; else
6468 address_item *addr = addr_defer;
6469 while (addr->next != NULL) addr = addr->next;
6470 addr->next = addr_local;
6476 /* Because address rewriting can happen in the routers, we should not really do
6477 ANY deliveries until all addresses have been routed, so that all recipients of
6478 the message get the same headers. However, this is in practice not always
6479 possible, since sometimes remote addresses give DNS timeouts for days on end.
6480 The pragmatic approach is to deliver what we can now, saving any rewritten
6481 headers so that at least the next lot of recipients benefit from the rewriting
6482 that has already been done.
6484 If any headers have been rewritten during routing, update the spool file to
6485 remember them for all subsequent deliveries. This can be delayed till later if
6486 there is only address to be delivered - if it succeeds the spool write need not
6489 if (header_rewritten &&
6490 ((addr_local != NULL &&
6491 (addr_local->next != NULL || addr_remote != NULL)) ||
6492 (addr_remote != NULL && addr_remote->next != NULL)))
6494 /* Panic-dies on error */
6495 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
6496 header_rewritten = FALSE;
6500 /* If there are any deliveries to be done, open the journal file. This is used
6501 to record successful deliveries as soon as possible after each delivery is
6502 known to be complete. A file opened with O_APPEND is used so that several
6503 processes can run simultaneously.
6505 The journal is just insurance against crashes. When the spool file is
6506 ultimately updated at the end of processing, the journal is deleted. If a
6507 journal is found to exist at the start of delivery, the addresses listed
6508 therein are added to the non-recipients. */
6510 if (addr_local != NULL || addr_remote != NULL)
6512 sprintf(CS spoolname, "%s/input/%s/%s-J", spool_directory, message_subdir, id);
6513 journal_fd = Uopen(spoolname, O_WRONLY|O_APPEND|O_CREAT, SPOOL_MODE);
6517 log_write(0, LOG_MAIN|LOG_PANIC, "Couldn't open journal file %s: %s",
6518 spoolname, strerror(errno));
6519 return DELIVER_NOT_ATTEMPTED;
6522 /* Set the close-on-exec flag, make the file owned by Exim, and ensure
6523 that the mode is correct - the group setting doesn't always seem to get
6524 set automatically. */
6526 if( fcntl(journal_fd, F_SETFD, fcntl(journal_fd, F_GETFD) | FD_CLOEXEC)
6527 || fchown(journal_fd, exim_uid, exim_gid)
6528 || fchmod(journal_fd, SPOOL_MODE)
6531 int ret = Uunlink(spoolname);
6532 log_write(0, LOG_MAIN|LOG_PANIC, "Couldn't set perms on journal file %s: %s",
6533 spoolname, strerror(errno));
6534 if(ret && errno != ENOENT)
6535 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s",
6536 spoolname, strerror(errno));
6537 return DELIVER_NOT_ATTEMPTED;
6543 /* Now we can get down to the business of actually doing deliveries. Local
6544 deliveries are done first, then remote ones. If ever the problems of how to
6545 handle fallback transports are figured out, this section can be put into a loop
6546 for handling fallbacks, though the uid switching will have to be revised. */
6548 /* Precompile a regex that is used to recognize a parameter in response
6549 to an LHLO command, if is isn't already compiled. This may be used on both
6550 local and remote LMTP deliveries. */
6552 if (regex_IGNOREQUOTA == NULL) regex_IGNOREQUOTA =
6553 regex_must_compile(US"\\n250[\\s\\-]IGNOREQUOTA(\\s|\\n|$)", FALSE, TRUE);
6555 /* Handle local deliveries */
6557 if (addr_local != NULL)
6559 DEBUG(D_deliver|D_transport)
6560 debug_printf(">>>>>>>>>>>>>>>> Local deliveries >>>>>>>>>>>>>>>>\n");
6561 do_local_deliveries();
6562 disable_logging = FALSE;
6565 /* If queue_run_local is set, we do not want to attempt any remote deliveries,
6566 so just queue them all. */
6568 if (queue_run_local)
6570 while (addr_remote != NULL)
6572 address_item *addr = addr_remote;
6573 addr_remote = addr->next;
6575 addr->basic_errno = ERRNO_LOCAL_ONLY;
6576 addr->message = US"remote deliveries suppressed";
6577 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_TRANSPORT, 0);
6581 /* Handle remote deliveries */
6583 if (addr_remote != NULL)
6585 DEBUG(D_deliver|D_transport)
6586 debug_printf(">>>>>>>>>>>>>>>> Remote deliveries >>>>>>>>>>>>>>>>\n");
6588 /* Precompile some regex that are used to recognize parameters in response
6589 to an EHLO command, if they aren't already compiled. */
6593 /* Now sort the addresses if required, and do the deliveries. The yield of
6594 do_remote_deliveries is FALSE when mua_wrapper is set and all addresses
6595 cannot be delivered in one transaction. */
6597 if (remote_sort_domains != NULL) sort_remote_deliveries();
6598 if (!do_remote_deliveries(FALSE))
6600 log_write(0, LOG_MAIN, "** mua_wrapper is set but recipients cannot all "
6601 "be delivered in one transaction");
6602 fprintf(stderr, "delivery to smarthost failed (configuration problem)\n");
6604 final_yield = DELIVER_MUA_FAILED;
6605 addr_failed = addr_defer = NULL; /* So that we remove the message */
6606 goto DELIVERY_TIDYUP;
6609 /* See if any of the addresses that failed got put on the queue for delivery
6610 to their fallback hosts. We do it this way because often the same fallback
6611 host is used for many domains, so all can be sent in a single transaction
6612 (if appropriately configured). */
6614 if (addr_fallback != NULL && !mua_wrapper)
6616 DEBUG(D_deliver) debug_printf("Delivering to fallback hosts\n");
6617 addr_remote = addr_fallback;
6618 addr_fallback = NULL;
6619 if (remote_sort_domains != NULL) sort_remote_deliveries();
6620 do_remote_deliveries(TRUE);
6622 disable_logging = FALSE;
6626 /* All deliveries are now complete. Ignore SIGTERM during this tidying up
6627 phase, to minimize cases of half-done things. */
6630 debug_printf(">>>>>>>>>>>>>>>> deliveries are done >>>>>>>>>>>>>>>>\n");
6632 /* Root privilege is no longer needed */
6634 exim_setugid(exim_uid, exim_gid, FALSE, US"post-delivery tidying");
6636 set_process_info("tidying up after delivering %s", message_id);
6637 signal(SIGTERM, SIG_IGN);
6639 /* When we are acting as an MUA wrapper, the smtp transport will either have
6640 succeeded for all addresses, or failed them all in normal cases. However, there
6641 are some setup situations (e.g. when a named port does not exist) that cause an
6642 immediate exit with deferral of all addresses. Convert those into failures. We
6643 do not ever want to retry, nor do we want to send a bounce message. */
6647 if (addr_defer != NULL)
6649 address_item *addr, *nextaddr;
6650 for (addr = addr_defer; addr != NULL; addr = nextaddr)
6652 log_write(0, LOG_MAIN, "** %s mua_wrapper forced failure for deferred "
6653 "delivery", addr->address);
6654 nextaddr = addr->next;
6655 addr->next = addr_failed;
6661 /* Now all should either have succeeded or failed. */
6663 if (addr_failed == NULL) final_yield = DELIVER_MUA_SUCCEEDED; else
6665 uschar *s = (addr_failed->user_message != NULL)?
6666 addr_failed->user_message : addr_failed->message;
6669 fprintf(stderr, "Delivery failed: ");
6670 if (addr_failed->basic_errno > 0)
6672 fprintf(stderr, "%s", strerror(addr_failed->basic_errno));
6673 if (s != NULL) fprintf(stderr, ": ");
6675 if ((host = addr_failed->host_used))
6676 fprintf(stderr, "H=%s [%s]: ", host->name, host->address);
6679 if (addr_failed->basic_errno <= 0) fprintf(stderr, "unknown error");
6681 else fprintf(stderr, "%s", CS s);
6682 fprintf(stderr, "\n");
6684 final_yield = DELIVER_MUA_FAILED;
6689 /* In a normal configuration, we now update the retry database. This is done in
6690 one fell swoop at the end in order not to keep opening and closing (and
6691 locking) the database. The code for handling retries is hived off into a
6692 separate module for convenience. We pass it the addresses of the various
6693 chains, because deferred addresses can get moved onto the failed chain if the
6694 retry cutoff time has expired for all alternative destinations. Bypass the
6695 updating of the database if the -N flag is set, which is a debugging thing that
6696 prevents actual delivery. */
6698 else if (!dont_deliver) retry_update(&addr_defer, &addr_failed, &addr_succeed);
6700 /* Send DSN for successful messages */
6701 addr_dsntmp = addr_succeed;
6702 addr_senddsn = NULL;
6706 /* af_ignore_error not honored here. it's not an error */
6709 debug_printf("DSN: processing router : %s\n"
6710 "DSN: processing successful delivery address: %s\n"
6711 "DSN: Sender_address: %s\n"
6712 "DSN: orcpt: %s flags: %d\n"
6713 "DSN: envid: %s ret: %d\n"
6714 "DSN: Final recipient: %s\n"
6715 "DSN: Remote SMTP server supports DSN: %d\n",
6716 addr_dsntmp->router->name,
6717 addr_dsntmp->address,
6719 addr_dsntmp->dsn_orcpt, addr_dsntmp->dsn_flags,
6721 addr_dsntmp->address,
6722 addr_dsntmp->dsn_aware
6726 /* send report if next hop not DSN aware or a router flagged "last DSN hop"
6727 and a report was requested */
6728 if ( ( addr_dsntmp->dsn_aware != dsn_support_yes
6729 || addr_dsntmp->dsn_flags & rf_dsnlasthop
6731 && addr_dsntmp->dsn_flags & rf_dsnflags
6732 && addr_dsntmp->dsn_flags & rf_notify_success
6735 /* copy and relink address_item and send report with all of them at once later */
6736 address_item *addr_next;
6737 addr_next = addr_senddsn;
6738 addr_senddsn = store_get(sizeof(address_item));
6739 memcpy(addr_senddsn, addr_dsntmp, sizeof(address_item));
6740 addr_senddsn->next = addr_next;
6743 DEBUG(D_deliver) debug_printf("DSN: not sending DSN success message\n");
6745 addr_dsntmp = addr_dsntmp->next;
6753 /* create exim process to send message */
6754 pid = child_open_exim(&fd);
6756 DEBUG(D_deliver) debug_printf("DSN: child_open_exim returns: %d\n", pid);
6758 if (pid < 0) /* Creation of child failed */
6760 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Process %d (parent %d) failed to "
6761 "create child process to send failure message: %s", getpid(),
6762 getppid(), strerror(errno));
6764 DEBUG(D_deliver) debug_printf("DSN: child_open_exim failed\n");
6766 else /* Creation of child succeeded */
6768 FILE *f = fdopen(fd, "wb");
6769 /* header only as required by RFC. only failure DSN needs to honor RET=FULL */
6770 int topt = topt_add_return_path | topt_no_body;
6774 debug_printf("sending error message to: %s\n", sender_address);
6776 /* build unique id for MIME boundary */
6777 bound = string_sprintf(TIME_T_FMT "-eximdsn-%d", time(NULL), rand());
6778 DEBUG(D_deliver) debug_printf("DSN: MIME boundary: %s\n", bound);
6780 if (errors_reply_to)
6781 fprintf(f, "Reply-To: %s\n", errors_reply_to);
6783 fprintf(f, "Auto-Submitted: auto-generated\n"
6784 "From: Mail Delivery System <Mailer-Daemon@%s>\n"
6786 "Subject: Delivery Status Notification\n"
6787 "Content-Type: multipart/report; report-type=delivery-status; boundary=%s\n"
6788 "MIME-Version: 1.0\n\n"
6791 "Content-type: text/plain; charset=us-ascii\n\n"
6793 "This message was created automatically by mail delivery software.\n"
6794 " ----- The following addresses had successful delivery notifications -----\n",
6795 qualify_domain_sender, sender_address, bound, bound);
6797 for (addr_dsntmp = addr_senddsn; addr_dsntmp;
6798 addr_dsntmp = addr_dsntmp->next)
6799 fprintf(f, "<%s> (relayed %s)\n\n",
6800 addr_dsntmp->address,
6801 (addr_dsntmp->dsn_flags & rf_dsnlasthop) == 1
6802 ? "via non DSN router"
6803 : addr_dsntmp->dsn_aware == dsn_support_no
6804 ? "to non-DSN-aware mailer"
6805 : "via non \"Remote SMTP\" router"
6809 "Content-type: message/delivery-status\n\n"
6810 "Reporting-MTA: dns; %s\n",
6811 bound, smtp_active_hostname);
6814 { /* must be decoded from xtext: see RFC 3461:6.3a */
6816 if (auth_xtextdecode(dsn_envid, &xdec_envid) > 0)
6817 fprintf(f, "Original-Envelope-ID: %s\n", dsn_envid);
6819 fprintf(f, "X-Original-Envelope-ID: error decoding xtext formated ENVID\n");
6823 for (addr_dsntmp = addr_senddsn;
6825 addr_dsntmp = addr_dsntmp->next)
6827 if (addr_dsntmp->dsn_orcpt)
6828 fprintf(f,"Original-Recipient: %s\n", addr_dsntmp->dsn_orcpt);
6830 fprintf(f, "Action: delivered\n"
6831 "Final-Recipient: rfc822;%s\n"
6833 addr_dsntmp->address);
6835 if (addr_dsntmp->host_used && addr_dsntmp->host_used->name)
6836 fprintf(f, "Remote-MTA: dns; %s\nDiagnostic-Code: smtp; 250 Ok\n\n",
6837 addr_dsntmp->host_used->name);
6839 fprintf(f, "Diagnostic-Code: X-Exim; relayed via non %s router\n\n",
6840 (addr_dsntmp->dsn_flags & rf_dsnlasthop) == 1 ? "DSN" : "SMTP");
6843 fprintf(f, "--%s\nContent-type: text/rfc822-headers\n\n", bound);
6846 transport_filter_argv = NULL; /* Just in case */
6847 return_path = sender_address; /* In case not previously set */
6849 /* Write the original email out */
6850 transport_write_message(NULL, fileno(f), topt, 0, NULL, NULL, NULL, NULL, NULL, 0);
6853 fprintf(f,"\n--%s--\n", bound);
6857 rc = child_close(pid, 0); /* Waits for child to close, no timeout */
6861 /* If any addresses failed, we must send a message to somebody, unless
6862 af_ignore_error is set, in which case no action is taken. It is possible for
6863 several messages to get sent if there are addresses with different
6866 while (addr_failed != NULL)
6870 uschar *logtod = tod_stamp(tod_log);
6872 address_item *handled_addr = NULL;
6873 address_item **paddr;
6874 address_item *msgchain = NULL;
6875 address_item **pmsgchain = &msgchain;
6877 /* There are weird cases when logging is disabled in the transport. However,
6878 there may not be a transport (address failed by a router). */
6880 disable_logging = FALSE;
6881 if (addr_failed->transport != NULL)
6882 disable_logging = addr_failed->transport->disable_logging;
6885 debug_printf("processing failed address %s\n", addr_failed->address);
6887 /* There are only two ways an address in a bounce message can get here:
6889 (1) When delivery was initially deferred, but has now timed out (in the call
6890 to retry_update() above). We can detect this by testing for
6891 af_retry_timedout. If the address does not have its own errors address,
6892 we arrange to ignore the error.
6894 (2) If delivery failures for bounce messages are being ignored. We can detect
6895 this by testing for af_ignore_error. This will also be set if a bounce
6896 message has been autothawed and the ignore_bounce_errors_after time has
6897 passed. It might also be set if a router was explicitly configured to
6898 ignore errors (errors_to = "").
6900 If neither of these cases obtains, something has gone wrong. Log the
6901 incident, but then ignore the error. */
6903 if (sender_address[0] == 0 && addr_failed->prop.errors_address == NULL)
6905 if ( !testflag(addr_failed, af_retry_timedout)
6906 && !testflag(addr_failed, af_ignore_error))
6908 log_write(0, LOG_MAIN|LOG_PANIC, "internal error: bounce message "
6909 "failure is neither frozen nor ignored (it's been ignored)");
6911 setflag(addr_failed, af_ignore_error);
6914 /* If the first address on the list has af_ignore_error set, just remove
6915 it from the list, throw away any saved message file, log it, and
6916 mark the recipient done. */
6918 if ( testflag(addr_failed, af_ignore_error)
6919 || ( addr_failed->dsn_flags & rf_dsnflags
6920 && (addr_failed->dsn_flags & rf_notify_failure) != rf_notify_failure)
6924 addr_failed = addr->next;
6925 if (addr->return_filename != NULL) Uunlink(addr->return_filename);
6927 log_write(0, LOG_MAIN, "%s%s%s%s: error ignored",
6929 !addr->parent ? US"" : US" <",
6930 !addr->parent ? US"" : addr->parent->address,
6931 !addr->parent ? US"" : US">");
6933 address_done(addr, logtod);
6934 child_done(addr, logtod);
6935 /* Panic-dies on error */
6936 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
6939 /* Otherwise, handle the sending of a message. Find the error address for
6940 the first address, then send a message that includes all failed addresses
6941 that have the same error address. Note the bounce_recipient is a global so
6942 that it can be accesssed by $bounce_recipient while creating a customized
6947 bounce_recipient = addr_failed->prop.errors_address
6948 ? addr_failed->prop.errors_address : sender_address;
6950 /* Make a subprocess to send a message */
6952 if ((pid = child_open_exim(&fd)) < 0)
6953 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Process %d (parent %d) failed to "
6954 "create child process to send failure message: %s", getpid(),
6955 getppid(), strerror(errno));
6957 /* Creation of child succeeded */
6964 uschar *bcc, *emf_text;
6965 FILE *f = fdopen(fd, "wb");
6967 BOOL to_sender = strcmpic(sender_address, bounce_recipient) == 0;
6968 int max = (bounce_return_size_limit/DELIVER_IN_BUFFER_SIZE + 1) *
6969 DELIVER_IN_BUFFER_SIZE;
6971 uschar *dsnlimitmsg;
6972 uschar *dsnnotifyhdr;
6976 debug_printf("sending error message to: %s\n", bounce_recipient);
6978 /* Scan the addresses for all that have the same errors address, removing
6979 them from the addr_failed chain, and putting them on msgchain. */
6981 paddr = &addr_failed;
6982 for (addr = addr_failed; addr != NULL; addr = *paddr)
6983 if (Ustrcmp(bounce_recipient, addr->prop.errors_address
6984 ? addr->prop.errors_address : sender_address) == 0)
6985 { /* The same - dechain */
6986 *paddr = addr->next;
6989 pmsgchain = &(addr->next);
6992 paddr = &addr->next; /* Not the same; skip */
6994 /* Include X-Failed-Recipients: for automatic interpretation, but do
6995 not let any one header line get too long. We do this by starting a
6996 new header every 50 recipients. Omit any addresses for which the
6997 "hide_child" flag is set. */
6999 for (addr = msgchain; addr != NULL; addr = addr->next)
7001 if (testflag(addr, af_hide_child)) continue;
7008 (rcount++ == 0)? "X-Failed-Recipients: " : ",\n ",
7009 (testflag(addr, af_pfr) && addr->parent != NULL)?
7010 string_printing(addr->parent->address) :
7011 string_printing(addr->address));
7013 if (rcount > 0) fprintf(f, "\n");
7015 /* Output the standard headers */
7017 if (errors_reply_to)
7018 fprintf(f, "Reply-To: %s\n", errors_reply_to);
7019 fprintf(f, "Auto-Submitted: auto-replied\n");
7021 fprintf(f, "To: %s\n", bounce_recipient);
7023 /* generate boundary string and output MIME-Headers */
7024 bound = string_sprintf(TIME_T_FMT "-eximdsn-%d", time(NULL), rand());
7026 fprintf(f, "Content-Type: multipart/report;"
7027 " report-type=delivery-status; boundary=%s\n"
7028 "MIME-Version: 1.0\n",
7031 /* Open a template file if one is provided. Log failure to open, but
7032 carry on - default texts will be used. */
7034 if (bounce_message_file)
7035 if (!(emf = Ufopen(bounce_message_file, "rb")))
7036 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to open %s for error "
7037 "message texts: %s", bounce_message_file, strerror(errno));
7039 /* Quietly copy to configured additional addresses if required. */
7041 if ((bcc = moan_check_errorcopy(bounce_recipient)))
7042 fprintf(f, "Bcc: %s\n", bcc);
7044 /* The texts for the message can be read from a template file; if there
7045 isn't one, or if it is too short, built-in texts are used. The first
7046 emf text is a Subject: and any other headers. */
7048 if ((emf_text = next_emf(emf, US"header")))
7049 fprintf(f, "%s\n", emf_text);
7051 fprintf(f, "Subject: Mail delivery failed%s\n\n",
7052 to_sender? ": returning message to sender" : "");
7054 /* output human readable part as text/plain section */
7056 "Content-type: text/plain; charset=us-ascii\n\n",
7059 if ((emf_text = next_emf(emf, US"intro")))
7060 fprintf(f, "%s", CS emf_text);
7064 /* This message has been reworded several times. It seems to be confusing to
7065 somebody, however it is worded. I have retreated to the original, simple
7067 "This message was created automatically by mail delivery software.\n");
7069 if (bounce_message_text)
7070 fprintf(f, "%s", CS bounce_message_text);
7073 "\nA message that you sent could not be delivered to one or more of its\n"
7074 "recipients. This is a permanent error. The following address(es) failed:\n");
7077 "\nA message sent by\n\n <%s>\n\n"
7078 "could not be delivered to one or more of its recipients. The following\n"
7079 "address(es) failed:\n", sender_address);
7083 /* Process the addresses, leaving them on the msgchain if they have a
7084 file name for a return message. (There has already been a check in
7085 post_process_one() for the existence of data in the message file.) A TRUE
7086 return from print_address_information() means that the address is not
7090 for (addr = msgchain; addr != NULL; addr = *paddr)
7092 if (print_address_information(addr, f, US" ", US"\n ", US""))
7093 print_address_error(addr, f, US"");
7095 /* End the final line for the address */
7099 /* Leave on msgchain if there's a return file. */
7101 if (addr->return_file >= 0)
7103 paddr = &(addr->next);
7107 /* Else save so that we can tick off the recipient when the
7112 *paddr = addr->next;
7113 addr->next = handled_addr;
7114 handled_addr = addr;
7120 /* Get the next text, whether we need it or not, so as to be
7121 positioned for the one after. */
7123 emf_text = next_emf(emf, US"generated text");
7125 /* If there were any file messages passed by the local transports,
7126 include them in the message. Then put the address on the handled chain.
7127 In the case of a batch of addresses that were all sent to the same
7128 transport, the return_file field in all of them will contain the same
7129 fd, and the return_filename field in the *last* one will be set (to the
7130 name of the file). */
7134 address_item *nextaddr;
7137 fprintf(f, "%s", CS emf_text);
7140 "The following text was generated during the delivery "
7141 "attempt%s:\n", (filecount > 1)? "s" : "");
7143 for (addr = msgchain; addr != NULL; addr = nextaddr)
7146 address_item *topaddr = addr;
7148 /* List all the addresses that relate to this file */
7151 while(addr) /* Insurance */
7153 print_address_information(addr, f, US"------ ", US"\n ",
7155 if (addr->return_filename) break;
7160 /* Now copy the file */
7162 fm = Ufopen(addr->return_filename, "rb");
7165 fprintf(f, " +++ Exim error... failed to open text file: %s\n",
7169 while ((ch = fgetc(fm)) != EOF) fputc(ch, f);
7172 Uunlink(addr->return_filename);
7174 /* Can now add to handled chain, first fishing off the next
7175 address on the msgchain. */
7177 nextaddr = addr->next;
7178 addr->next = handled_addr;
7179 handled_addr = topaddr;
7184 /* output machine readable part */
7185 #ifdef EXPERIMENTAL_INTERNATIONAL
7186 if (message_smtputf8)
7188 "Content-type: message/global-delivery-status\n\n"
7189 "Reporting-MTA: dns; %s\n",
7190 bound, smtp_active_hostname);
7194 "Content-type: message/delivery-status\n\n"
7195 "Reporting-MTA: dns; %s\n",
7196 bound, smtp_active_hostname);
7200 /* must be decoded from xtext: see RFC 3461:6.3a */
7202 if (auth_xtextdecode(dsn_envid, &xdec_envid) > 0)
7203 fprintf(f, "Original-Envelope-ID: %s\n", dsn_envid);
7205 fprintf(f, "X-Original-Envelope-ID: error decoding xtext formated ENVID\n");
7209 for (addr = handled_addr; addr; addr = addr->next)
7211 fprintf(f, "Action: failed\n"
7212 "Final-Recipient: rfc822;%s\n"
7215 if (addr->host_used && addr->host_used->name)
7217 fprintf(f, "Remote-MTA: dns; %s\n",
7218 addr->host_used->name);
7219 print_dsn_diagnostic_code(addr, f);
7224 /* Now copy the message, trying to give an intelligible comment if
7225 it is too long for it all to be copied. The limit isn't strictly
7226 applied because of the buffering. There is, however, an option
7227 to suppress copying altogether. */
7229 emf_text = next_emf(emf, US"copy");
7232 we ignore the intro text from template and add
7233 the text for bounce_return_size_limit at the end.
7235 bounce_return_message is ignored
7236 in case RET= is defined we honor these values
7237 otherwise bounce_return_body is honored.
7239 bounce_return_size_limit is always honored.
7242 fprintf(f, "--%s\n", bound);
7244 dsnlimitmsg = US"X-Exim-DSN-Information: Due to administrative limits only headers are returned";
7245 dsnnotifyhdr = NULL;
7246 topt = topt_add_return_path;
7248 /* RET=HDRS? top priority */
7249 if (dsn_ret == dsn_ret_hdrs)
7250 topt |= topt_no_body;
7252 /* no full body return at all? */
7253 if (!bounce_return_body)
7255 topt |= topt_no_body;
7256 /* add header if we overrule RET=FULL */
7257 if (dsn_ret == dsn_ret_full)
7258 dsnnotifyhdr = dsnlimitmsg;
7260 /* size limited ... return headers only if limit reached */
7261 else if (bounce_return_size_limit > 0)
7263 struct stat statbuf;
7264 if (fstat(deliver_datafile, &statbuf) == 0 && statbuf.st_size > max)
7266 topt |= topt_no_body;
7267 dsnnotifyhdr = dsnlimitmsg;
7271 #ifdef EXPERIMENTAL_INTERNATIONAL
7272 if (message_smtputf8)
7273 fputs(topt & topt_no_body ? "Content-type: message/global-headers\n\n"
7274 : "Content-type: message/global\n\n",
7278 fputs(topt & topt_no_body ? "Content-type: text/rfc822-headers\n\n"
7279 : "Content-type: message/rfc822\n\n",
7283 transport_filter_argv = NULL; /* Just in case */
7284 return_path = sender_address; /* In case not previously set */
7285 transport_write_message(NULL, fileno(f), topt,
7286 0, dsnnotifyhdr, NULL, NULL, NULL, NULL, 0);
7289 /* we never add the final text. close the file */
7293 fprintf(f, "\n--%s--\n", bound);
7295 /* Close the file, which should send an EOF to the child process
7296 that is receiving the message. Wait for it to finish. */
7299 rc = child_close(pid, 0); /* Waits for child to close, no timeout */
7301 /* In the test harness, let the child do it's thing first. */
7303 if (running_in_test_harness) millisleep(500);
7305 /* If the process failed, there was some disaster in setting up the
7306 error message. Unless the message is very old, ensure that addr_defer
7307 is non-null, which will have the effect of leaving the message on the
7308 spool. The failed addresses will get tried again next time. However, we
7309 don't really want this to happen too often, so freeze the message unless
7310 there are some genuine deferred addresses to try. To do this we have
7311 to call spool_write_header() here, because with no genuine deferred
7312 addresses the normal code below doesn't get run. */
7317 if (now - received_time < retry_maximum_timeout && addr_defer == NULL)
7319 addr_defer = (address_item *)(+1);
7320 deliver_freeze = TRUE;
7321 deliver_frozen_at = time(NULL);
7322 /* Panic-dies on error */
7323 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
7326 deliver_msglog("Process failed (%d) when writing error message "
7327 "to %s%s", rc, bounce_recipient, s);
7328 log_write(0, LOG_MAIN, "Process failed (%d) when writing error message "
7329 "to %s%s", rc, bounce_recipient, s);
7332 /* The message succeeded. Ensure that the recipients that failed are
7333 now marked finished with on the spool and their parents updated. */
7337 for (addr = handled_addr; addr != NULL; addr = addr->next)
7339 address_done(addr, logtod);
7340 child_done(addr, logtod);
7342 /* Panic-dies on error */
7343 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
7349 disable_logging = FALSE; /* In case left set */
7351 /* Come here from the mua_wrapper case if routing goes wrong */
7355 /* If there are now no deferred addresses, we are done. Preserve the
7356 message log if so configured, and we are using them. Otherwise, sling it.
7357 Then delete the message itself. */
7359 if (addr_defer == NULL)
7363 sprintf(CS spoolname, "%s/msglog/%s/%s", spool_directory, message_subdir,
7365 if (preserve_message_logs)
7368 sprintf(CS big_buffer, "%s/msglog.OLD/%s", spool_directory, id);
7369 if ((rc = Urename(spoolname, big_buffer)) < 0)
7371 (void)directory_make(spool_directory, US"msglog.OLD",
7372 MSGLOG_DIRECTORY_MODE, TRUE);
7373 rc = Urename(spoolname, big_buffer);
7376 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to move %s to the "
7377 "msglog.OLD directory", spoolname);
7380 if (Uunlink(spoolname) < 0)
7381 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s",
7382 spoolname, strerror(errno));
7385 /* Remove the two message files. */
7387 sprintf(CS spoolname, "%s/input/%s/%s-D", spool_directory, message_subdir, id);
7388 if (Uunlink(spoolname) < 0)
7389 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s",
7390 spoolname, strerror(errno));
7391 sprintf(CS spoolname, "%s/input/%s/%s-H", spool_directory, message_subdir, id);
7392 if (Uunlink(spoolname) < 0)
7393 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s",
7394 spoolname, strerror(errno));
7396 /* Log the end of this message, with queue time if requested. */
7398 if (LOGGING(queue_time_overall))
7399 log_write(0, LOG_MAIN, "Completed QT=%s",
7400 readconf_printtime( (int) ((long)time(NULL) - (long)received_time)) );
7402 log_write(0, LOG_MAIN, "Completed");
7404 /* Unset deliver_freeze so that we won't try to move the spool files further down */
7405 deliver_freeze = FALSE;
7407 #ifdef EXPERIMENTAL_EVENT
7408 (void) event_raise(event_action, US"msg:complete", NULL);
7412 /* If there are deferred addresses, we are keeping this message because it is
7413 not yet completed. Lose any temporary files that were catching output from
7414 pipes for any of the deferred addresses, handle one-time aliases, and see if
7415 the message has been on the queue for so long that it is time to send a warning
7416 message to the sender, unless it is a mailer-daemon. If all deferred addresses
7417 have the same domain, we can set deliver_domain for the expansion of
7418 delay_warning_ condition - if any of them are pipes, files, or autoreplies, use
7419 the parent's domain.
7421 If all the deferred addresses have an error number that indicates "retry time
7422 not reached", skip sending the warning message, because it won't contain the
7423 reason for the delay. It will get sent at the next real delivery attempt.
7424 However, if at least one address has tried, we'd better include all of them in
7427 If we can't make a process to send the message, don't worry.
7429 For mailing list expansions we want to send the warning message to the
7430 mailing list manager. We can't do a perfect job here, as some addresses may
7431 have different errors addresses, but if we take the errors address from
7432 each deferred address it will probably be right in most cases.
7434 If addr_defer == +1, it means there was a problem sending an error message
7435 for failed addresses, and there were no "real" deferred addresses. The value
7436 was set just to keep the message on the spool, so there is nothing to do here.
7439 else if (addr_defer != (address_item *)(+1))
7442 uschar *recipients = US"";
7443 BOOL delivery_attempted = FALSE;
7445 deliver_domain = testflag(addr_defer, af_pfr)?
7446 addr_defer->parent->domain : addr_defer->domain;
7448 for (addr = addr_defer; addr != NULL; addr = addr->next)
7450 address_item *otaddr;
7452 if (addr->basic_errno > ERRNO_RETRY_BASE) delivery_attempted = TRUE;
7454 if (deliver_domain != NULL)
7456 const uschar *d = testflag(addr, af_pfr)
7457 ? addr->parent->domain : addr->domain;
7459 /* The domain may be unset for an address that has never been routed
7460 because the system filter froze the message. */
7462 if (d == NULL || Ustrcmp(d, deliver_domain) != 0) deliver_domain = NULL;
7465 if (addr->return_filename != NULL) Uunlink(addr->return_filename);
7467 /* Handle the case of one-time aliases. If any address in the ancestry
7468 of this one is flagged, ensure it is in the recipients list, suitably
7469 flagged, and that its parent is marked delivered. */
7471 for (otaddr = addr; otaddr != NULL; otaddr = otaddr->parent)
7472 if (otaddr->onetime_parent != NULL) break;
7477 int t = recipients_count;
7479 for (i = 0; i < recipients_count; i++)
7481 uschar *r = recipients_list[i].address;
7482 if (Ustrcmp(otaddr->onetime_parent, r) == 0) t = i;
7483 if (Ustrcmp(otaddr->address, r) == 0) break;
7486 /* Didn't find the address already in the list, and did find the
7487 ultimate parent's address in the list. After adding the recipient,
7488 update the errors address in the recipients list. */
7490 if (i >= recipients_count && t < recipients_count)
7492 DEBUG(D_deliver) debug_printf("one_time: adding %s in place of %s\n",
7493 otaddr->address, otaddr->parent->address);
7494 receive_add_recipient(otaddr->address, t);
7495 recipients_list[recipients_count-1].errors_to = otaddr->prop.errors_address;
7496 tree_add_nonrecipient(otaddr->parent->address);
7497 update_spool = TRUE;
7501 /* Except for error messages, ensure that either the errors address for
7502 this deferred address or, if there is none, the sender address, is on the
7503 list of recipients for a warning message. */
7505 if (sender_address[0] != 0)
7507 if (addr->prop.errors_address == NULL)
7509 if (Ustrstr(recipients, sender_address) == NULL)
7510 recipients = string_sprintf("%s%s%s", recipients,
7511 (recipients[0] == 0)? "" : ",", sender_address);
7515 if (Ustrstr(recipients, addr->prop.errors_address) == NULL)
7516 recipients = string_sprintf("%s%s%s", recipients,
7517 (recipients[0] == 0)? "" : ",", addr->prop.errors_address);
7522 /* Send a warning message if the conditions are right. If the condition check
7523 fails because of a lookup defer, there is nothing we can do. The warning
7524 is not sent. Another attempt will be made at the next delivery attempt (if
7528 && delivery_attempted
7529 && ( ((addr_defer->dsn_flags & rf_dsnflags) == 0)
7530 || (addr_defer->dsn_flags & rf_notify_delay) == rf_notify_delay
7532 && delay_warning[1] > 0
7533 && sender_address[0] != 0
7534 && ( delay_warning_condition == NULL
7535 || expand_check_condition(delay_warning_condition,
7536 US"delay_warning", US"option")
7542 int queue_time = time(NULL) - received_time;
7544 /* When running in the test harness, there's an option that allows us to
7545 fudge this time so as to get repeatability of the tests. Take the first
7546 time off the list. In queue runs, the list pointer gets updated in the
7549 if (running_in_test_harness && fudged_queue_times[0] != 0)
7551 int qt = readconf_readtime(fudged_queue_times, '/', FALSE);
7554 DEBUG(D_deliver) debug_printf("fudged queue_times = %s\n",
7555 fudged_queue_times);
7560 /* See how many warnings we should have sent by now */
7562 for (count = 0; count < delay_warning[1]; count++)
7563 if (queue_time < delay_warning[count+2]) break;
7565 show_time = delay_warning[count+1];
7567 if (count >= delay_warning[1])
7570 int last_gap = show_time;
7571 if (count > 1) last_gap -= delay_warning[count];
7572 extra = (queue_time - delay_warning[count+1])/last_gap;
7573 show_time += last_gap * extra;
7579 debug_printf("time on queue = %s\n", readconf_printtime(queue_time));
7580 debug_printf("warning counts: required %d done %d\n", count,
7584 /* We have computed the number of warnings there should have been by now.
7585 If there haven't been enough, send one, and up the count to what it should
7588 if (warning_count < count)
7592 pid_t pid = child_open_exim(&fd);
7598 FILE *f = fdopen(fd, "wb");
7601 if (warn_message_file)
7603 wmf = Ufopen(warn_message_file, "rb");
7605 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to open %s for warning "
7606 "message texts: %s", warn_message_file, strerror(errno));
7609 warnmsg_recipients = recipients;
7610 warnmsg_delay = (queue_time < 120*60)?
7611 string_sprintf("%d minutes", show_time/60):
7612 string_sprintf("%d hours", show_time/3600);
7614 if (errors_reply_to)
7615 fprintf(f, "Reply-To: %s\n", errors_reply_to);
7616 fprintf(f, "Auto-Submitted: auto-replied\n");
7618 fprintf(f, "To: %s\n", recipients);
7620 /* generated boundary string and output MIME-Headers */
7621 bound = string_sprintf(TIME_T_FMT "-eximdsn-%d", time(NULL), rand());
7623 fprintf(f, "Content-Type: multipart/report;"
7624 " report-type=delivery-status; boundary=%s\n"
7625 "MIME-Version: 1.0\n",
7628 if ((wmf_text = next_emf(wmf, US"header")))
7629 fprintf(f, "%s\n", wmf_text);
7631 fprintf(f, "Subject: Warning: message %s delayed %s\n\n",
7632 message_id, warnmsg_delay);
7634 /* output human readable part as text/plain section */
7636 "Content-type: text/plain; charset=us-ascii\n\n",
7639 if ((wmf_text = next_emf(wmf, US"intro")))
7640 fprintf(f, "%s", CS wmf_text);
7644 "This message was created automatically by mail delivery software.\n");
7646 if (Ustrcmp(recipients, sender_address) == 0)
7648 "A message that you sent has not yet been delivered to one or more of its\n"
7649 "recipients after more than ");
7653 "A message sent by\n\n <%s>\n\n"
7654 "has not yet been delivered to one or more of its recipients after more than \n",
7657 fprintf(f, "%s on the queue on %s.\n\n"
7658 "The message identifier is: %s\n",
7659 warnmsg_delay, primary_hostname, message_id);
7661 for (h = header_list; h != NULL; h = h->next)
7662 if (strncmpic(h->text, US"Subject:", 8) == 0)
7663 fprintf(f, "The subject of the message is: %s", h->text + 9);
7664 else if (strncmpic(h->text, US"Date:", 5) == 0)
7665 fprintf(f, "The date of the message is: %s", h->text + 6);
7668 fprintf(f, "The address%s to which the message has not yet been "
7670 !addr_defer->next ? "" : "es",
7671 !addr_defer->next ? "is": "are");
7674 /* List the addresses, with error information if allowed */
7676 /* store addr_defer for machine readable part */
7677 address_item *addr_dsndefer = addr_defer;
7681 address_item *addr = addr_defer;
7682 addr_defer = addr->next;
7683 if (print_address_information(addr, f, US" ", US"\n ", US""))
7684 print_address_error(addr, f, US"Delay reason: ");
7693 if ((wmf_text = next_emf(wmf, US"final")))
7694 fprintf(f, "%s", CS wmf_text);
7700 "No action is required on your part. Delivery attempts will continue for\n"
7701 "some time, and this warning may be repeated at intervals if the message\n"
7702 "remains undelivered. Eventually the mail delivery software will give up,\n"
7703 "and when that happens, the message will be returned to you.\n");
7706 /* output machine readable part */
7707 fprintf(f, "\n--%s\n"
7708 "Content-type: message/delivery-status\n\n"
7709 "Reporting-MTA: dns; %s\n",
7711 smtp_active_hostname);
7716 /* must be decoded from xtext: see RFC 3461:6.3a */
7718 if (auth_xtextdecode(dsn_envid, &xdec_envid) > 0)
7719 fprintf(f,"Original-Envelope-ID: %s\n", dsn_envid);
7721 fprintf(f,"X-Original-Envelope-ID: error decoding xtext formated ENVID\n");
7725 for ( ; addr_dsndefer; addr_dsndefer = addr_dsndefer->next)
7727 if (addr_dsndefer->dsn_orcpt)
7728 fprintf(f, "Original-Recipient: %s\n", addr_dsndefer->dsn_orcpt);
7730 fprintf(f, "Action: delayed\n"
7731 "Final-Recipient: rfc822;%s\n"
7733 addr_dsndefer->address);
7734 if (addr_dsndefer->host_used && addr_dsndefer->host_used->name)
7736 fprintf(f, "Remote-MTA: dns; %s\n",
7737 addr_dsndefer->host_used->name);
7738 print_dsn_diagnostic_code(addr_dsndefer, f);
7744 "Content-type: text/rfc822-headers\n\n",
7748 /* header only as required by RFC. only failure DSN needs to honor RET=FULL */
7749 int topt = topt_add_return_path | topt_no_body;
7750 transport_filter_argv = NULL; /* Just in case */
7751 return_path = sender_address; /* In case not previously set */
7752 /* Write the original email out */
7753 transport_write_message(NULL, fileno(f), topt, 0, NULL, NULL, NULL, NULL, NULL, 0);
7756 fprintf(f,"\n--%s--\n", bound);
7760 /* Close and wait for child process to complete, without a timeout.
7761 If there's an error, don't update the count. */
7764 if (child_close(pid, 0) == 0)
7766 warning_count = count;
7767 update_spool = TRUE; /* Ensure spool rewritten */
7773 /* Clear deliver_domain */
7775 deliver_domain = NULL;
7777 /* If this was a first delivery attempt, unset the first time flag, and
7778 ensure that the spool gets updated. */
7780 if (deliver_firsttime)
7782 deliver_firsttime = FALSE;
7783 update_spool = TRUE;
7786 /* If delivery was frozen and freeze_tell is set, generate an appropriate
7787 message, unless the message is a local error message (to avoid loops). Then
7788 log the freezing. If the text in "frozen_info" came from a system filter,
7789 it has been escaped into printing characters so as not to mess up log lines.
7790 For the "tell" message, we turn \n back into newline. Also, insert a newline
7791 near the start instead of the ": " string. */
7795 if (freeze_tell != NULL && freeze_tell[0] != 0 && !local_error_message)
7797 uschar *s = string_copy(frozen_info);
7798 uschar *ss = Ustrstr(s, " by the system filter: ");
7809 if (*ss == '\\' && ss[1] == 'n')
7816 moan_tell_someone(freeze_tell, addr_defer, US"Message frozen",
7817 "Message %s has been frozen%s.\nThe sender is <%s>.\n", message_id,
7821 /* Log freezing just before we update the -H file, to minimize the chance
7822 of a race problem. */
7824 deliver_msglog("*** Frozen%s\n", frozen_info);
7825 log_write(0, LOG_MAIN, "Frozen%s", frozen_info);
7828 /* If there have been any updates to the non-recipients list, or other things
7829 that get written to the spool, we must now update the spool header file so
7830 that it has the right information for the next delivery attempt. If there
7831 was more than one address being delivered, the header_change update is done
7832 earlier, in case one succeeds and then something crashes. */
7835 debug_printf("delivery deferred: update_spool=%d header_rewritten=%d\n",
7836 update_spool, header_rewritten);
7838 if (update_spool || header_rewritten)
7839 /* Panic-dies on error */
7840 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
7843 /* Finished with the message log. If the message is complete, it will have
7844 been unlinked or renamed above. */
7846 if (message_logs) (void)fclose(message_log);
7848 /* Now we can close and remove the journal file. Its only purpose is to record
7849 successfully completed deliveries asap so that this information doesn't get
7850 lost if Exim (or the machine) crashes. Forgetting about a failed delivery is
7851 not serious, as trying it again is not harmful. The journal might not be open
7852 if all addresses were deferred at routing or directing. Nevertheless, we must
7853 remove it if it exists (may have been lying around from a crash during the
7854 previous delivery attempt). We don't remove the journal if a delivery
7855 subprocess failed to pass back delivery information; this is controlled by
7856 the remove_journal flag. When the journal is left, we also don't move the
7857 message off the main spool if frozen and the option is set. It should get moved
7858 at the next attempt, after the journal has been inspected. */
7860 if (journal_fd >= 0) (void)close(journal_fd);
7864 sprintf(CS spoolname, "%s/input/%s/%s-J", spool_directory, message_subdir, id);
7865 if (Uunlink(spoolname) < 0 && errno != ENOENT)
7866 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s", spoolname,
7869 /* Move the message off the spool if reqested */
7871 #ifdef SUPPORT_MOVE_FROZEN_MESSAGES
7872 if (deliver_freeze && move_frozen_messages)
7873 (void)spool_move_message(id, message_subdir, US"", US"F");
7877 /* Closing the data file frees the lock; if the file has been unlinked it
7878 will go away. Otherwise the message becomes available for another process
7881 (void)close(deliver_datafile);
7882 deliver_datafile = -1;
7883 DEBUG(D_deliver) debug_printf("end delivery of %s\n", id);
7885 /* It is unlikely that there will be any cached resources, since they are
7886 released after routing, and in the delivery subprocesses. However, it's
7887 possible for an expansion for something afterwards (for example,
7888 expand_check_condition) to do a lookup. We must therefore be sure everything is
7892 acl_where = ACL_WHERE_UNKNOWN;
7901 if (!regex_PIPELINING) regex_PIPELINING =
7902 regex_must_compile(US"\\n250[\\s\\-]PIPELINING(\\s|\\n|$)", FALSE, TRUE);
7904 if (!regex_SIZE) regex_SIZE =
7905 regex_must_compile(US"\\n250[\\s\\-]SIZE(\\s|\\n|$)", FALSE, TRUE);
7907 if (!regex_AUTH) regex_AUTH =
7908 regex_must_compile(US"\\n250[\\s\\-]AUTH\\s+([\\-\\w\\s]+)(?:\\n|$)",
7912 if (!regex_STARTTLS) regex_STARTTLS =
7913 regex_must_compile(US"\\n250[\\s\\-]STARTTLS(\\s|\\n|$)", FALSE, TRUE);
7916 #ifndef DISABLE_PRDR
7917 if (!regex_PRDR) regex_PRDR =
7918 regex_must_compile(US"\\n250[\\s\\-]PRDR(\\s|\\n|$)", FALSE, TRUE);
7921 #ifdef EXPERIMENTAL_INTERNATIONAL
7922 if (!regex_UTF8) regex_UTF8 =
7923 regex_must_compile(US"\\n250[\\s\\-]SMTPUTF8(\\s|\\n|$)", FALSE, TRUE);
7926 if (!regex_DSN) regex_DSN =
7927 regex_must_compile(US"\\n250[\\s\\-]DSN(\\s|\\n|$)", FALSE, TRUE);
7929 if (!regex_IGNOREQUOTA) regex_IGNOREQUOTA =
7930 regex_must_compile(US"\\n250[\\s\\-]IGNOREQUOTA(\\s|\\n|$)", FALSE, TRUE);
7935 deliver_get_sender_address (uschar * id)
7937 if (!spool_open_datafile(id))
7940 sprintf(CS spoolname, "%s-H", id);
7941 if (spool_read_header(spoolname, TRUE, TRUE) != spool_read_OK)
7944 (void)close(deliver_datafile);
7945 deliver_datafile = -1;
7947 return sender_address;
7952 /* End of deliver.c */