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);
681 d_hostlog(uschar * s, int * sizep, int * ptrp, address_item * addr)
683 s = string_append(s, sizep, ptrp, 5, US" H=", addr->host_used->name,
684 US" [", addr->host_used->address, US"]");
685 if ((log_extra_selector & LX_outgoing_port) != 0)
686 s = string_append(s, sizep, ptrp, 2, US":", string_sprintf("%d",
687 addr->host_used->port));
693 d_tlslog(uschar * s, int * sizep, int * ptrp, address_item * addr)
695 if ((log_extra_selector & LX_tls_cipher) != 0 && addr->cipher != NULL)
696 s = string_append(s, sizep, ptrp, 2, US" X=", addr->cipher);
697 if ((log_extra_selector & LX_tls_certificate_verified) != 0 &&
698 addr->cipher != NULL)
699 s = string_append(s, sizep, ptrp, 2, US" CV=",
700 testflag(addr, af_cert_verified)
702 #ifdef EXPERIMENTAL_DANE
703 testflag(addr, af_dane_verified)
709 if ((log_extra_selector & LX_tls_peerdn) != 0 && addr->peerdn != NULL)
710 s = string_append(s, sizep, ptrp, 3, US" DN=\"",
711 string_printing(addr->peerdn), US"\"");
719 #ifdef EXPERIMENTAL_EVENT
721 event_raise(uschar * action, const uschar * event, uschar * ev_data)
727 debug_printf("Event(%s): event_action=|%s| delivery_IP=%s\n",
729 action, deliver_host_address);
732 event_data = ev_data;
734 if (!(s = expand_string(action)) && *expand_string_message)
735 log_write(0, LOG_MAIN|LOG_PANIC,
736 "failed to expand event_action %s in %s: %s\n",
737 event, transport_name, expand_string_message);
739 event_name = event_data = NULL;
741 /* If the expansion returns anything but an empty string, flag for
742 the caller to modify his normal processing
747 debug_printf("Event(%s): event_action returned \"%s\"\n", event, s);
755 msg_event_raise(const uschar * event, const address_item * addr)
757 const uschar * save_domain = deliver_domain;
758 uschar * save_local = deliver_localpart;
759 const uschar * save_host = deliver_host;
761 if (!addr->transport)
764 router_name = addr->router ? addr->router->name : NULL;
765 transport_name = addr->transport->name;
766 deliver_domain = addr->domain;
767 deliver_localpart = addr->local_part;
768 deliver_host = addr->host_used ? addr->host_used->name : NULL;
770 (void) event_raise(addr->transport->event_action, event,
771 addr->host_used || Ustrcmp(addr->transport->driver_name, "lmtp") == 0
772 ? addr->message : NULL);
774 deliver_host = save_host;
775 deliver_localpart = save_local;
776 deliver_domain = save_domain;
777 router_name = transport_name = NULL;
779 #endif /*EXPERIMENTAL_EVENT*/
783 /* If msg is NULL this is a delivery log and logchar is used. Otherwise
784 this is a nonstandard call; no two-character delivery flag is written
785 but sender-host and sender are prefixed and "msg" is inserted in the log line.
788 flags passed to log_write()
791 delivery_log(int flags, address_item * addr, int logchar, uschar * msg)
794 int size = 256; /* Used for a temporary, */
795 int ptr = 0; /* expanding buffer, for */
796 uschar *s; /* building log lines; */
797 void *reset_point; /* released afterwards. */
799 /* Log the delivery on the main log. We use an extensible string to build up
800 the log line, and reset the store afterwards. Remote deliveries should always
801 have a pointer to the host item that succeeded; local deliveries can have a
802 pointer to a single host item in their host list, for use by the transport. */
804 #ifdef EXPERIMENTAL_EVENT
805 /* presume no successful remote delivery */
806 lookup_dnssec_authenticated = NULL;
809 s = reset_point = store_get(size);
811 log_address = string_log_address(addr, (log_write_selector & L_all_parents) != 0, TRUE);
813 s = string_append(s, &size, &ptr, 3, host_and_ident(TRUE), US" ", log_address);
817 s = string_append(s, &size, &ptr, 2, US"> ", log_address);
820 if (log_extra_selector & LX_incoming_interface && sending_ip_address)
821 s = string_append(s, &size, &ptr, 3, US" I=[", sending_ip_address, US"]");
822 /* for the port: string_sprintf("%d", sending_port) */
824 if ((log_extra_selector & LX_sender_on_delivery) != 0 || msg)
825 s = string_append(s, &size, &ptr, 3, US" F=<",
826 #ifdef EXPERIMENTAL_INTERNATIONAL
827 testflag(addr, af_utf8_downcvt)
828 ? string_address_utf8_to_alabel(sender_address, NULL)
834 #ifdef EXPERIMENTAL_SRS
835 if(addr->prop.srs_sender)
836 s = string_append(s, &size, &ptr, 3, US" SRS=<", addr->prop.srs_sender, US">");
839 /* You might think that the return path must always be set for a successful
840 delivery; indeed, I did for some time, until this statement crashed. The case
841 when it is not set is for a delivery to /dev/null which is optimised by not
844 if (used_return_path != NULL &&
845 (log_extra_selector & LX_return_path_on_delivery) != 0)
846 s = string_append(s, &size, &ptr, 3, US" P=<", used_return_path, US">");
849 s = string_append(s, &size, &ptr, 2, US" ", msg);
851 /* For a delivery from a system filter, there may not be a router */
852 if (addr->router != NULL)
853 s = string_append(s, &size, &ptr, 2, US" R=", addr->router->name);
855 s = string_append(s, &size, &ptr, 2, US" T=", addr->transport->name);
857 if ((log_extra_selector & LX_delivery_size) != 0)
858 s = string_append(s, &size, &ptr, 2, US" S=",
859 string_sprintf("%d", transport_count));
863 if (addr->transport->info->local)
866 s = string_append(s, &size, &ptr, 2, US" H=", addr->host_list->name);
867 if (addr->shadow_message != NULL)
868 s = string_cat(s, &size, &ptr, addr->shadow_message,
869 Ustrlen(addr->shadow_message));
872 /* Remote delivery */
878 s = d_hostlog(s, &size, &ptr, addr);
879 if (continue_sequence > 1)
880 s = string_cat(s, &size, &ptr, US"*", 1);
882 #ifdef EXPERIMENTAL_EVENT
883 deliver_host_address = addr->host_used->address;
884 deliver_host_port = addr->host_used->port;
885 deliver_host = addr->host_used->name;
887 /* DNS lookup status */
888 lookup_dnssec_authenticated = addr->host_used->dnssec==DS_YES ? US"yes"
889 : addr->host_used->dnssec==DS_NO ? US"no"
895 s = d_tlslog(s, &size, &ptr, addr);
898 if (addr->authenticator)
900 s = string_append(s, &size, &ptr, 2, US" A=", addr->authenticator);
903 s = string_append(s, &size, &ptr, 2, US":", addr->auth_id);
904 if (log_extra_selector & LX_smtp_mailauth && addr->auth_sndr)
905 s = string_append(s, &size, &ptr, 2, US":", addr->auth_sndr);
910 if (addr->flags & af_prdr_used)
911 s = string_append(s, &size, &ptr, 1, US" PRDR");
915 /* confirmation message (SMTP (host_used) and LMTP (driver_name)) */
917 if (log_extra_selector & LX_smtp_confirmation &&
919 (addr->host_used || Ustrcmp(addr->transport->driver_name, "lmtp") == 0))
922 unsigned lim = big_buffer_size < 1024 ? big_buffer_size : 1024;
923 uschar *p = big_buffer;
924 uschar *ss = addr->message;
926 for (i = 0; i < lim && ss[i] != 0; i++) /* limit logged amount */
928 if (ss[i] == '\"' || ss[i] == '\\') *p++ = '\\'; /* quote \ and " */
933 s = string_append(s, &size, &ptr, 2, US" C=", big_buffer);
936 /* Time on queue and actual time taken to deliver */
938 if ((log_extra_selector & LX_queue_time) != 0)
939 s = string_append(s, &size, &ptr, 2, US" QT=",
940 readconf_printtime( (int) ((long)time(NULL) - (long)received_time)) );
942 if ((log_extra_selector & LX_deliver_time) != 0)
943 s = string_append(s, &size, &ptr, 2, US" DT=",
944 readconf_printtime(addr->more_errno));
946 /* string_cat() always leaves room for the terminator. Release the
947 store we used to build the line after writing it. */
950 log_write(0, flags, "%s", s);
952 #ifdef EXPERIMENTAL_EVENT
953 if (!msg) msg_event_raise(US"msg:delivery", addr);
956 store_reset(reset_point);
962 /*************************************************
963 * Actions at the end of handling an address *
964 *************************************************/
966 /* This is a function for processing a single address when all that can be done
967 with it has been done.
970 addr points to the address block
971 result the result of the delivery attempt
972 logflags flags for log_write() (LOG_MAIN and/or LOG_PANIC)
973 driver_type indicates which type of driver (transport, or router) was last
974 to process the address
975 logchar '=' or '-' for use when logging deliveries with => or ->
981 post_process_one(address_item *addr, int result, int logflags, int driver_type,
984 uschar *now = tod_stamp(tod_log);
985 uschar *driver_kind = NULL;
986 uschar *driver_name = NULL;
989 int size = 256; /* Used for a temporary, */
990 int ptr = 0; /* expanding buffer, for */
991 uschar *s; /* building log lines; */
992 void *reset_point; /* released afterwards. */
994 DEBUG(D_deliver) debug_printf("post-process %s (%d)\n", addr->address, result);
996 /* Set up driver kind and name for logging. Disable logging if the router or
997 transport has disabled it. */
999 if (driver_type == DTYPE_TRANSPORT)
1001 if (addr->transport != NULL)
1003 driver_name = addr->transport->name;
1004 driver_kind = US" transport";
1005 disable_logging = addr->transport->disable_logging;
1007 else driver_kind = US"transporting";
1009 else if (driver_type == DTYPE_ROUTER)
1011 if (addr->router != NULL)
1013 driver_name = addr->router->name;
1014 driver_kind = US" router";
1015 disable_logging = addr->router->disable_logging;
1017 else driver_kind = US"routing";
1020 /* If there's an error message set, ensure that it contains only printing
1021 characters - it should, but occasionally things slip in and this at least
1022 stops the log format from getting wrecked. We also scan the message for an LDAP
1023 expansion item that has a password setting, and flatten the password. This is a
1024 fudge, but I don't know a cleaner way of doing this. (If the item is badly
1025 malformed, it won't ever have gone near LDAP.) */
1027 if (addr->message != NULL)
1029 const uschar * s = string_printing(addr->message);
1030 if (s != addr->message)
1031 addr->message = US s;
1032 /* deconst cast ok as string_printing known to have alloc'n'copied */
1033 if (((Ustrstr(addr->message, "failed to expand") != NULL) || (Ustrstr(addr->message, "expansion of ") != NULL)) &&
1034 (Ustrstr(addr->message, "mysql") != NULL ||
1035 Ustrstr(addr->message, "pgsql") != NULL ||
1036 #ifdef EXPERIMENTAL_REDIS
1037 Ustrstr(addr->message, "redis") != NULL ||
1039 Ustrstr(addr->message, "sqlite") != NULL ||
1040 Ustrstr(addr->message, "ldap:") != NULL ||
1041 Ustrstr(addr->message, "ldapdn:") != NULL ||
1042 Ustrstr(addr->message, "ldapm:") != NULL))
1044 addr->message = string_sprintf("Temporary internal error");
1048 /* If we used a transport that has one of the "return_output" options set, and
1049 if it did in fact generate some output, then for return_output we treat the
1050 message as failed if it was not already set that way, so that the output gets
1051 returned to the sender, provided there is a sender to send it to. For
1052 return_fail_output, do this only if the delivery failed. Otherwise we just
1053 unlink the file, and remove the name so that if the delivery failed, we don't
1054 try to send back an empty or unwanted file. The log_output options operate only
1055 on a non-empty file.
1057 In any case, we close the message file, because we cannot afford to leave a
1058 file-descriptor for one address while processing (maybe very many) others. */
1060 if (addr->return_file >= 0 && addr->return_filename != NULL)
1062 BOOL return_output = FALSE;
1063 struct stat statbuf;
1064 (void)EXIMfsync(addr->return_file);
1066 /* If there is no output, do nothing. */
1068 if (fstat(addr->return_file, &statbuf) == 0 && statbuf.st_size > 0)
1070 transport_instance *tb = addr->transport;
1072 /* Handle logging options */
1074 if (tb->log_output || (result == FAIL && tb->log_fail_output) ||
1075 (result == DEFER && tb->log_defer_output))
1078 FILE *f = Ufopen(addr->return_filename, "rb");
1080 log_write(0, LOG_MAIN|LOG_PANIC, "failed to open %s to log output "
1081 "from %s transport: %s", addr->return_filename, tb->name,
1085 s = US Ufgets(big_buffer, big_buffer_size, f);
1088 uschar *p = big_buffer + Ustrlen(big_buffer);
1090 while (p > big_buffer && isspace(p[-1])) p--;
1092 sp = string_printing(big_buffer);
1093 log_write(0, LOG_MAIN, "<%s>: %s transport output: %s",
1094 addr->address, tb->name, sp);
1100 /* Handle returning options, but only if there is an address to return
1103 if (sender_address[0] != 0 || addr->prop.errors_address != NULL)
1105 if (tb->return_output)
1107 addr->transport_return = result = FAIL;
1108 if (addr->basic_errno == 0 && addr->message == NULL)
1109 addr->message = US"return message generated";
1110 return_output = TRUE;
1113 if (tb->return_fail_output && result == FAIL) return_output = TRUE;
1117 /* Get rid of the file unless it might be returned, but close it in
1122 Uunlink(addr->return_filename);
1123 addr->return_filename = NULL;
1124 addr->return_file = -1;
1127 (void)close(addr->return_file);
1130 /* The success case happens only after delivery by a transport. */
1134 addr->next = addr_succeed;
1135 addr_succeed = addr;
1137 /* Call address_done() to ensure that we don't deliver to this address again,
1138 and write appropriate things to the message log. If it is a child address, we
1139 call child_done() to scan the ancestors and mark them complete if this is the
1140 last child to complete. */
1142 address_done(addr, now);
1143 DEBUG(D_deliver) debug_printf("%s delivered\n", addr->address);
1145 if (addr->parent == NULL)
1146 deliver_msglog("%s %s: %s%s succeeded\n", now, addr->address,
1147 driver_name, driver_kind);
1150 deliver_msglog("%s %s <%s>: %s%s succeeded\n", now, addr->address,
1151 addr->parent->address, driver_name, driver_kind);
1152 child_done(addr, now);
1155 /* Certificates for logging (via events) */
1157 tls_out.ourcert = addr->ourcert;
1158 addr->ourcert = NULL;
1159 tls_out.peercert = addr->peercert;
1160 addr->peercert = NULL;
1162 tls_out.cipher = addr->cipher;
1163 tls_out.peerdn = addr->peerdn;
1164 tls_out.ocsp = addr->ocsp;
1165 # ifdef EXPERIMENTAL_DANE
1166 tls_out.dane_verified = testflag(addr, af_dane_verified);
1170 delivery_log(LOG_MAIN, addr, logchar, NULL);
1173 if (tls_out.ourcert)
1175 tls_free_cert(tls_out.ourcert);
1176 tls_out.ourcert = NULL;
1178 if (tls_out.peercert)
1180 tls_free_cert(tls_out.peercert);
1181 tls_out.peercert = NULL;
1183 tls_out.cipher = NULL;
1184 tls_out.peerdn = NULL;
1185 tls_out.ocsp = OCSP_NOT_REQ;
1186 # ifdef EXPERIMENTAL_DANE
1187 tls_out.dane_verified = FALSE;
1193 /* Soft failure, or local delivery process failed; freezing may be
1196 else if (result == DEFER || result == PANIC)
1198 if (result == PANIC) logflags |= LOG_PANIC;
1200 /* This puts them on the chain in reverse order. Do not change this, because
1201 the code for handling retries assumes that the one with the retry
1202 information is last. */
1204 addr->next = addr_defer;
1207 /* The only currently implemented special action is to freeze the
1208 message. Logging of this is done later, just before the -H file is
1211 if (addr->special_action == SPECIAL_FREEZE)
1213 deliver_freeze = TRUE;
1214 deliver_frozen_at = time(NULL);
1215 update_spool = TRUE;
1218 /* If doing a 2-stage queue run, we skip writing to either the message
1219 log or the main log for SMTP defers. */
1221 if (!queue_2stage || addr->basic_errno != 0)
1225 /* For errors of the type "retry time not reached" (also remotes skipped
1226 on queue run), logging is controlled by L_retry_defer. Note that this kind
1227 of error number is negative, and all the retry ones are less than any
1230 unsigned int use_log_selector = (addr->basic_errno <= ERRNO_RETRY_BASE)?
1233 /* Build up the line that is used for both the message log and the main
1236 s = reset_point = store_get(size);
1238 /* Create the address string for logging. Must not do this earlier, because
1239 an OK result may be changed to FAIL when a pipe returns text. */
1241 log_address = string_log_address(addr,
1242 (log_write_selector & L_all_parents) != 0, result == OK);
1244 s = string_cat(s, &size, &ptr, log_address, Ustrlen(log_address));
1246 /* Either driver_name contains something and driver_kind contains
1247 " router" or " transport" (note the leading space), or driver_name is
1248 a null string and driver_kind contains "routing" without the leading
1249 space, if all routing has been deferred. When a domain has been held,
1250 so nothing has been done at all, both variables contain null strings. */
1252 if (driver_name == NULL)
1254 if (driver_kind != NULL)
1255 s = string_append(s, &size, &ptr, 2, US" ", driver_kind);
1259 if (driver_kind[1] == 't' && addr->router != NULL)
1260 s = string_append(s, &size, &ptr, 2, US" R=", addr->router->name);
1262 ss[1] = toupper(driver_kind[1]);
1263 s = string_append(s, &size, &ptr, 2, ss, driver_name);
1266 sprintf(CS ss, " defer (%d)", addr->basic_errno);
1267 s = string_cat(s, &size, &ptr, ss, Ustrlen(ss));
1269 if (addr->basic_errno > 0)
1270 s = string_append(s, &size, &ptr, 2, US": ",
1271 US strerror(addr->basic_errno));
1273 if (addr->host_used)
1274 s = string_append(s, &size, &ptr, 5,
1275 US" H=", addr->host_used->name,
1276 US" [", addr->host_used->address, US"]");
1278 if (addr->message != NULL)
1279 s = string_append(s, &size, &ptr, 2, US": ", addr->message);
1283 /* Log the deferment in the message log, but don't clutter it
1284 up with retry-time defers after the first delivery attempt. */
1286 if (deliver_firsttime || addr->basic_errno > ERRNO_RETRY_BASE)
1287 deliver_msglog("%s %s\n", now, s);
1289 /* Write the main log and reset the store */
1291 log_write(use_log_selector, logflags, "== %s", s);
1292 store_reset(reset_point);
1297 /* Hard failure. If there is an address to which an error message can be sent,
1298 put this address on the failed list. If not, put it on the deferred list and
1299 freeze the mail message for human attention. The latter action can also be
1300 explicitly requested by a router or transport. */
1304 /* If this is a delivery error, or a message for which no replies are
1305 wanted, and the message's age is greater than ignore_bounce_errors_after,
1306 force the af_ignore_error flag. This will cause the address to be discarded
1307 later (with a log entry). */
1309 if (sender_address[0] == 0 && message_age >= ignore_bounce_errors_after)
1310 setflag(addr, af_ignore_error);
1312 /* Freeze the message if requested, or if this is a bounce message (or other
1313 message with null sender) and this address does not have its own errors
1314 address. However, don't freeze if errors are being ignored. The actual code
1315 to ignore occurs later, instead of sending a message. Logging of freezing
1316 occurs later, just before writing the -H file. */
1318 if (!testflag(addr, af_ignore_error) &&
1319 (addr->special_action == SPECIAL_FREEZE ||
1320 (sender_address[0] == 0 && addr->prop.errors_address == NULL)
1323 frozen_info = (addr->special_action == SPECIAL_FREEZE)? US"" :
1324 (sender_local && !local_error_message)?
1325 US" (message created with -f <>)" : US" (delivery error message)";
1326 deliver_freeze = TRUE;
1327 deliver_frozen_at = time(NULL);
1328 update_spool = TRUE;
1330 /* The address is put on the defer rather than the failed queue, because
1331 the message is being retained. */
1333 addr->next = addr_defer;
1337 /* Don't put the address on the nonrecipients tree yet; wait until an
1338 error message has been successfully sent. */
1342 addr->next = addr_failed;
1346 /* Build up the log line for the message and main logs */
1348 s = reset_point = store_get(size);
1350 /* Create the address string for logging. Must not do this earlier, because
1351 an OK result may be changed to FAIL when a pipe returns text. */
1353 log_address = string_log_address(addr,
1354 (log_write_selector & L_all_parents) != 0, result == OK);
1356 s = string_cat(s, &size, &ptr, log_address, Ustrlen(log_address));
1358 if ((log_extra_selector & LX_sender_on_delivery) != 0)
1359 s = string_append(s, &size, &ptr, 3, US" F=<", sender_address, US">");
1361 /* Return path may not be set if no delivery actually happened */
1363 if (used_return_path != NULL &&
1364 (log_extra_selector & LX_return_path_on_delivery) != 0)
1365 s = string_append(s, &size, &ptr, 3, US" P=<", used_return_path, US">");
1367 if (addr->router != NULL)
1368 s = string_append(s, &size, &ptr, 2, US" R=", addr->router->name);
1369 if (addr->transport != NULL)
1370 s = string_append(s, &size, &ptr, 2, US" T=", addr->transport->name);
1372 if (addr->host_used != NULL)
1373 s = d_hostlog(s, &size, &ptr, addr);
1376 s = d_tlslog(s, &size, &ptr, addr);
1379 if (addr->basic_errno > 0)
1380 s = string_append(s, &size, &ptr, 2, US": ",
1381 US strerror(addr->basic_errno));
1383 if (addr->message != NULL)
1384 s = string_append(s, &size, &ptr, 2, US": ", addr->message);
1388 /* Do the logging. For the message log, "routing failed" for those cases,
1389 just to make it clearer. */
1391 if (driver_name == NULL)
1392 deliver_msglog("%s %s failed for %s\n", now, driver_kind, s);
1394 deliver_msglog("%s %s\n", now, s);
1396 log_write(0, LOG_MAIN, "** %s", s);
1398 #ifdef EXPERIMENTAL_EVENT
1399 msg_event_raise(US"msg:fail:delivery", addr);
1402 store_reset(reset_point);
1405 /* Ensure logging is turned on again in all cases */
1407 disable_logging = FALSE;
1413 /*************************************************
1414 * Address-independent error *
1415 *************************************************/
1417 /* This function is called when there's an error that is not dependent on a
1418 particular address, such as an expansion string failure. It puts the error into
1419 all the addresses in a batch, logs the incident on the main and panic logs, and
1420 clears the expansions. It is mostly called from local_deliver(), but can be
1421 called for a remote delivery via findugid().
1424 logit TRUE if (MAIN+PANIC) logging required
1425 addr the first of the chain of addresses
1427 format format string for error message, or NULL if already set in addr
1428 ... arguments for the format
1434 common_error(BOOL logit, address_item *addr, int code, uschar *format, ...)
1436 address_item *addr2;
1437 addr->basic_errno = code;
1443 va_start(ap, format);
1444 if (!string_vformat(buffer, sizeof(buffer), CS format, ap))
1445 log_write(0, LOG_MAIN|LOG_PANIC_DIE,
1446 "common_error expansion was longer than " SIZE_T_FMT, sizeof(buffer));
1448 addr->message = string_copy(buffer);
1451 for (addr2 = addr->next; addr2 != NULL; addr2 = addr2->next)
1453 addr2->basic_errno = code;
1454 addr2->message = addr->message;
1457 if (logit) log_write(0, LOG_MAIN|LOG_PANIC, "%s", addr->message);
1458 deliver_set_expansions(NULL);
1464 /*************************************************
1465 * Check a "never users" list *
1466 *************************************************/
1468 /* This function is called to check whether a uid is on one of the two "never
1472 uid the uid to be checked
1473 nusers the list to be scanned; the first item in the list is the count
1475 Returns: TRUE if the uid is on the list
1479 check_never_users(uid_t uid, uid_t *nusers)
1482 if (nusers == NULL) return FALSE;
1483 for (i = 1; i <= (int)(nusers[0]); i++) if (nusers[i] == uid) return TRUE;
1489 /*************************************************
1490 * Find uid and gid for a transport *
1491 *************************************************/
1493 /* This function is called for both local and remote deliveries, to find the
1494 uid/gid under which to run the delivery. The values are taken preferentially
1495 from the transport (either explicit or deliver_as_creator), then from the
1496 address (i.e. the router), and if nothing is set, the exim uid/gid are used. If
1497 the resulting uid is on the "never_users" or the "fixed_never_users" list, a
1498 panic error is logged, and the function fails (which normally leads to delivery
1502 addr the address (possibly a chain)
1504 uidp pointer to uid field
1505 gidp pointer to gid field
1506 igfp pointer to the use_initgroups field
1508 Returns: FALSE if failed - error has been set in address(es)
1512 findugid(address_item *addr, transport_instance *tp, uid_t *uidp, gid_t *gidp,
1515 uschar *nuname = NULL;
1516 BOOL gid_set = FALSE;
1518 /* Default initgroups flag comes from the transport */
1520 *igfp = tp->initgroups;
1522 /* First see if there's a gid on the transport, either fixed or expandable.
1523 The expanding function always logs failure itself. */
1530 else if (tp->expand_gid != NULL)
1532 if (route_find_expanded_group(tp->expand_gid, tp->name, US"transport", gidp,
1533 &(addr->message))) gid_set = TRUE;
1536 common_error(FALSE, addr, ERRNO_GIDFAIL, NULL);
1541 /* If the transport did not set a group, see if the router did. */
1543 if (!gid_set && testflag(addr, af_gid_set))
1549 /* Pick up a uid from the transport if one is set. */
1551 if (tp->uid_set) *uidp = tp->uid;
1553 /* Otherwise, try for an expandable uid field. If it ends up as a numeric id,
1554 it does not provide a passwd value from which a gid can be taken. */
1556 else if (tp->expand_uid != NULL)
1559 if (!route_find_expanded_user(tp->expand_uid, tp->name, US"transport", &pw,
1560 uidp, &(addr->message)))
1562 common_error(FALSE, addr, ERRNO_UIDFAIL, NULL);
1565 if (!gid_set && pw != NULL)
1572 /* If the transport doesn't set the uid, test the deliver_as_creator flag. */
1574 else if (tp->deliver_as_creator)
1576 *uidp = originator_uid;
1579 *gidp = originator_gid;
1584 /* Otherwise see if the address specifies the uid and if so, take it and its
1587 else if (testflag(addr, af_uid_set))
1590 *igfp = testflag(addr, af_initgroups);
1593 /* Nothing has specified the uid - default to the Exim user, and group if the
1606 /* If no gid is set, it is a disaster. We default to the Exim gid only if
1607 defaulting to the Exim uid. In other words, if the configuration has specified
1608 a uid, it must also provide a gid. */
1612 common_error(TRUE, addr, ERRNO_GIDFAIL, US"User set without group for "
1613 "%s transport", tp->name);
1617 /* Check that the uid is not on the lists of banned uids that may not be used
1618 for delivery processes. */
1620 if (check_never_users(*uidp, never_users))
1621 nuname = US"never_users";
1622 else if (check_never_users(*uidp, fixed_never_users))
1623 nuname = US"fixed_never_users";
1627 common_error(TRUE, addr, ERRNO_UIDFAIL, US"User %ld set for %s transport "
1628 "is on the %s list", (long int)(*uidp), tp->name, nuname);
1640 /*************************************************
1641 * Check the size of a message for a transport *
1642 *************************************************/
1644 /* Checks that the message isn't too big for the selected transport.
1645 This is called only when it is known that the limit is set.
1649 addr the (first) address being delivered
1652 DEFER expansion failed or did not yield an integer
1653 FAIL message too big
1657 check_message_size(transport_instance *tp, address_item *addr)
1662 deliver_set_expansions(addr);
1663 size_limit = expand_string_integer(tp->message_size_limit, TRUE);
1664 deliver_set_expansions(NULL);
1666 if (expand_string_message != NULL)
1669 if (size_limit == -1)
1670 addr->message = string_sprintf("failed to expand message_size_limit "
1671 "in %s transport: %s", tp->name, expand_string_message);
1673 addr->message = string_sprintf("invalid message_size_limit "
1674 "in %s transport: %s", tp->name, expand_string_message);
1676 else if (size_limit > 0 && message_size > size_limit)
1680 string_sprintf("message is too big (transport limit = %d)",
1689 /*************************************************
1690 * Transport-time check for a previous delivery *
1691 *************************************************/
1693 /* Check that this base address hasn't previously been delivered to its routed
1694 transport. If it has been delivered, mark it done. The check is necessary at
1695 delivery time in order to handle homonymic addresses correctly in cases where
1696 the pattern of redirection changes between delivery attempts (so the unique
1697 fields change). Non-homonymic previous delivery is detected earlier, at routing
1698 time (which saves unnecessary routing).
1701 addr the address item
1702 testing TRUE if testing wanted only, without side effects
1704 Returns: TRUE if previously delivered by the transport
1708 previously_transported(address_item *addr, BOOL testing)
1710 (void)string_format(big_buffer, big_buffer_size, "%s/%s",
1711 addr->unique + (testflag(addr, af_homonym)? 3:0), addr->transport->name);
1713 if (tree_search(tree_nonrecipients, big_buffer) != 0)
1715 DEBUG(D_deliver|D_route|D_transport)
1716 debug_printf("%s was previously delivered (%s transport): discarded\n",
1717 addr->address, addr->transport->name);
1718 if (!testing) child_done(addr, tod_stamp(tod_log));
1727 /******************************************************
1728 * Check for a given header in a header string *
1729 ******************************************************/
1731 /* This function is used when generating quota warnings. The configuration may
1732 specify any header lines it likes in quota_warn_message. If certain of them are
1733 missing, defaults are inserted, so we need to be able to test for the presence
1737 hdr the required header name
1738 hstring the header string
1740 Returns: TRUE the header is in the string
1741 FALSE the header is not in the string
1745 contains_header(uschar *hdr, uschar *hstring)
1747 int len = Ustrlen(hdr);
1748 uschar *p = hstring;
1751 if (strncmpic(p, hdr, len) == 0)
1754 while (*p == ' ' || *p == '\t') p++;
1755 if (*p == ':') return TRUE;
1757 while (*p != 0 && *p != '\n') p++;
1758 if (*p == '\n') p++;
1766 /*************************************************
1767 * Perform a local delivery *
1768 *************************************************/
1770 /* Each local delivery is performed in a separate process which sets its
1771 uid and gid as specified. This is a safer way than simply changing and
1772 restoring using seteuid(); there is a body of opinion that seteuid() cannot be
1773 used safely. From release 4, Exim no longer makes any use of it. Besides, not
1774 all systems have seteuid().
1776 If the uid/gid are specified in the transport_instance, they are used; the
1777 transport initialization must ensure that either both or neither are set.
1778 Otherwise, the values associated with the address are used. If neither are set,
1779 it is a configuration error.
1781 The transport or the address may specify a home directory (transport over-
1782 rides), and if they do, this is set as $home. If neither have set a working
1783 directory, this value is used for that as well. Otherwise $home is left unset
1784 and the cwd is set to "/" - a directory that should be accessible to all users.
1786 Using a separate process makes it more complicated to get error information
1787 back. We use a pipe to pass the return code and also an error code and error
1788 text string back to the parent process.
1791 addr points to an address block for this delivery; for "normal" local
1792 deliveries this is the only address to be delivered, but for
1793 pseudo-remote deliveries (e.g. by batch SMTP to a file or pipe)
1794 a number of addresses can be handled simultaneously, and in this
1795 case addr will point to a chain of addresses with the same
1798 shadowing TRUE if running a shadow transport; this causes output from pipes
1805 deliver_local(address_item *addr, BOOL shadowing)
1807 BOOL use_initgroups;
1810 int status, len, rc;
1813 uschar *working_directory;
1814 address_item *addr2;
1815 transport_instance *tp = addr->transport;
1817 /* Set up the return path from the errors or sender address. If the transport
1818 has its own return path setting, expand it and replace the existing value. */
1820 if(addr->prop.errors_address != NULL)
1821 return_path = addr->prop.errors_address;
1822 #ifdef EXPERIMENTAL_SRS
1823 else if(addr->prop.srs_sender != NULL)
1824 return_path = addr->prop.srs_sender;
1827 return_path = sender_address;
1829 if (tp->return_path != NULL)
1831 uschar *new_return_path = expand_string(tp->return_path);
1832 if (new_return_path == NULL)
1834 if (!expand_string_forcedfail)
1836 common_error(TRUE, addr, ERRNO_EXPANDFAIL,
1837 US"Failed to expand return path \"%s\" in %s transport: %s",
1838 tp->return_path, tp->name, expand_string_message);
1842 else return_path = new_return_path;
1845 /* For local deliveries, one at a time, the value used for logging can just be
1846 set directly, once and for all. */
1848 used_return_path = return_path;
1850 /* Sort out the uid, gid, and initgroups flag. If an error occurs, the message
1851 gets put into the address(es), and the expansions are unset, so we can just
1854 if (!findugid(addr, tp, &uid, &gid, &use_initgroups)) return;
1856 /* See if either the transport or the address specifies a home directory. A
1857 home directory set in the address may already be expanded; a flag is set to
1858 indicate that. In other cases we must expand it. */
1860 if ((deliver_home = tp->home_dir) != NULL || /* Set in transport, or */
1861 ((deliver_home = addr->home_dir) != NULL && /* Set in address and */
1862 !testflag(addr, af_home_expanded))) /* not expanded */
1864 uschar *rawhome = deliver_home;
1865 deliver_home = NULL; /* in case it contains $home */
1866 deliver_home = expand_string(rawhome);
1867 if (deliver_home == NULL)
1869 common_error(TRUE, addr, ERRNO_EXPANDFAIL, US"home directory \"%s\" failed "
1870 "to expand for %s transport: %s", rawhome, tp->name,
1871 expand_string_message);
1874 if (*deliver_home != '/')
1876 common_error(TRUE, addr, ERRNO_NOTABSOLUTE, US"home directory path \"%s\" "
1877 "is not absolute for %s transport", deliver_home, tp->name);
1882 /* See if either the transport or the address specifies a current directory,
1883 and if so, expand it. If nothing is set, use the home directory, unless it is
1884 also unset in which case use "/", which is assumed to be a directory to which
1885 all users have access. It is necessary to be in a visible directory for some
1886 operating systems when running pipes, as some commands (e.g. "rm" under Solaris
1887 2.5) require this. */
1889 working_directory = (tp->current_dir != NULL)?
1890 tp->current_dir : addr->current_dir;
1892 if (working_directory != NULL)
1894 uschar *raw = working_directory;
1895 working_directory = expand_string(raw);
1896 if (working_directory == NULL)
1898 common_error(TRUE, addr, ERRNO_EXPANDFAIL, US"current directory \"%s\" "
1899 "failed to expand for %s transport: %s", raw, tp->name,
1900 expand_string_message);
1903 if (*working_directory != '/')
1905 common_error(TRUE, addr, ERRNO_NOTABSOLUTE, US"current directory path "
1906 "\"%s\" is not absolute for %s transport", working_directory, tp->name);
1910 else working_directory = (deliver_home == NULL)? US"/" : deliver_home;
1912 /* If one of the return_output flags is set on the transport, create and open a
1913 file in the message log directory for the transport to write its output onto.
1914 This is mainly used by pipe transports. The file needs to be unique to the
1915 address. This feature is not available for shadow transports. */
1917 if (!shadowing && (tp->return_output || tp->return_fail_output ||
1918 tp->log_output || tp->log_fail_output))
1921 addr->return_filename =
1922 string_sprintf("%s/msglog/%s/%s-%d-%d", spool_directory, message_subdir,
1923 message_id, getpid(), return_count++);
1924 addr->return_file = open_msglog_file(addr->return_filename, 0400, &error);
1925 if (addr->return_file < 0)
1927 common_error(TRUE, addr, errno, US"Unable to %s file for %s transport "
1928 "to return message: %s", error, tp->name, strerror(errno));
1933 /* Create the pipe for inter-process communication. */
1937 common_error(TRUE, addr, ERRNO_PIPEFAIL, US"Creation of pipe failed: %s",
1942 /* Now fork the process to do the real work in the subprocess, but first
1943 ensure that all cached resources are freed so that the subprocess starts with
1944 a clean slate and doesn't interfere with the parent process. */
1948 if ((pid = fork()) == 0)
1950 BOOL replicate = TRUE;
1952 /* Prevent core dumps, as we don't want them in users' home directories.
1953 HP-UX doesn't have RLIMIT_CORE; I don't know how to do this in that
1954 system. Some experimental/developing systems (e.g. GNU/Hurd) may define
1955 RLIMIT_CORE but not support it in setrlimit(). For such systems, do not
1956 complain if the error is "not supported".
1958 There are two scenarios where changing the max limit has an effect. In one,
1959 the user is using a .forward and invoking a command of their choice via pipe;
1960 for these, we do need the max limit to be 0 unless the admin chooses to
1961 permit an increased limit. In the other, the command is invoked directly by
1962 the transport and is under administrator control, thus being able to raise
1963 the limit aids in debugging. So there's no general always-right answer.
1965 Thus we inhibit core-dumps completely but let individual transports, while
1966 still root, re-raise the limits back up to aid debugging. We make the
1967 default be no core-dumps -- few enough people can use core dumps in
1968 diagnosis that it's reasonable to make them something that has to be explicitly requested.
1975 if (setrlimit(RLIMIT_CORE, &rl) < 0)
1977 # ifdef SETRLIMIT_NOT_SUPPORTED
1978 if (errno != ENOSYS && errno != ENOTSUP)
1980 log_write(0, LOG_MAIN|LOG_PANIC, "setrlimit(RLIMIT_CORE) failed: %s",
1985 /* Reset the random number generator, so different processes don't all
1986 have the same sequence. */
1990 /* If the transport has a setup entry, call this first, while still
1991 privileged. (Appendfile uses this to expand quota, for example, while
1992 able to read private files.) */
1994 if (addr->transport->setup != NULL)
1996 switch((addr->transport->setup)(addr->transport, addr, NULL, uid, gid,
2000 addr->transport_return = DEFER;
2004 addr->transport_return = PANIC;
2009 /* Ignore SIGINT and SIGTERM during delivery. Also ignore SIGUSR1, as
2010 when the process becomes unprivileged, it won't be able to write to the
2011 process log. SIGHUP is ignored throughout exim, except when it is being
2014 signal(SIGINT, SIG_IGN);
2015 signal(SIGTERM, SIG_IGN);
2016 signal(SIGUSR1, SIG_IGN);
2018 /* Close the unwanted half of the pipe, and set close-on-exec for the other
2019 half - for transports that exec things (e.g. pipe). Then set the required
2022 (void)close(pfd[pipe_read]);
2023 (void)fcntl(pfd[pipe_write], F_SETFD, fcntl(pfd[pipe_write], F_GETFD) |
2025 exim_setugid(uid, gid, use_initgroups,
2026 string_sprintf("local delivery to %s <%s> transport=%s", addr->local_part,
2027 addr->address, addr->transport->name));
2031 address_item *batched;
2032 debug_printf(" home=%s current=%s\n", deliver_home, working_directory);
2033 for (batched = addr->next; batched != NULL; batched = batched->next)
2034 debug_printf("additional batched address: %s\n", batched->address);
2037 /* Set an appropriate working directory. */
2039 if (Uchdir(working_directory) < 0)
2041 addr->transport_return = DEFER;
2042 addr->basic_errno = errno;
2043 addr->message = string_sprintf("failed to chdir to %s", working_directory);
2046 /* If successful, call the transport */
2051 set_process_info("delivering %s to %s using %s", message_id,
2052 addr->local_part, addr->transport->name);
2054 /* Setting this global in the subprocess means we need never clear it */
2055 transport_name = addr->transport->name;
2057 /* If a transport filter has been specified, set up its argument list.
2058 Any errors will get put into the address, and FALSE yielded. */
2060 if (addr->transport->filter_command != NULL)
2062 ok = transport_set_up_command(&transport_filter_argv,
2063 addr->transport->filter_command,
2064 TRUE, PANIC, addr, US"transport filter", NULL);
2065 transport_filter_timeout = addr->transport->filter_timeout;
2067 else transport_filter_argv = NULL;
2071 debug_print_string(addr->transport->debug_string);
2072 replicate = !(addr->transport->info->code)(addr->transport, addr);
2076 /* Pass the results back down the pipe. If necessary, first replicate the
2077 status in the top address to the others in the batch. The label is the
2078 subject of a goto when a call to the transport's setup function fails. We
2079 pass the pointer to the transport back in case it got changed as a result of
2080 file_format in appendfile. */
2084 if (replicate) replicate_status(addr);
2085 for (addr2 = addr; addr2 != NULL; addr2 = addr2->next)
2088 int local_part_length = Ustrlen(addr2->local_part);
2092 if( (ret = write(pfd[pipe_write], (void *)&(addr2->transport_return), sizeof(int))) != sizeof(int)
2093 || (ret = write(pfd[pipe_write], (void *)&transport_count, sizeof(transport_count))) != sizeof(transport_count)
2094 || (ret = write(pfd[pipe_write], (void *)&(addr2->flags), sizeof(addr2->flags))) != sizeof(addr2->flags)
2095 || (ret = write(pfd[pipe_write], (void *)&(addr2->basic_errno), sizeof(int))) != sizeof(int)
2096 || (ret = write(pfd[pipe_write], (void *)&(addr2->more_errno), sizeof(int))) != sizeof(int)
2097 || (ret = write(pfd[pipe_write], (void *)&(addr2->special_action), sizeof(int))) != sizeof(int)
2098 || (ret = write(pfd[pipe_write], (void *)&(addr2->transport),
2099 sizeof(transport_instance *))) != sizeof(transport_instance *)
2101 /* For a file delivery, pass back the local part, in case the original
2102 was only part of the final delivery path. This gives more complete
2105 || (testflag(addr2, af_file)
2106 && ( (ret = write(pfd[pipe_write], (void *)&local_part_length, sizeof(int))) != sizeof(int)
2107 || (ret = write(pfd[pipe_write], addr2->local_part, local_part_length)) != local_part_length
2111 log_write(0, LOG_MAIN|LOG_PANIC, "Failed writing transport results to pipe: %s\n",
2112 ret == -1 ? strerror(errno) : "short write");
2114 /* Now any messages */
2116 for (i = 0, s = addr2->message; i < 2; i++, s = addr2->user_message)
2118 int message_length = (s == NULL)? 0 : Ustrlen(s) + 1;
2119 if( (ret = write(pfd[pipe_write], (void *)&message_length, sizeof(int))) != sizeof(int)
2120 || (message_length > 0 && (ret = write(pfd[pipe_write], s, message_length)) != message_length)
2122 log_write(0, LOG_MAIN|LOG_PANIC, "Failed writing transport results to pipe: %s\n",
2123 ret == -1 ? strerror(errno) : "short write");
2127 /* OK, this process is now done. Free any cached resources that it opened,
2128 and close the pipe we were writing down before exiting. */
2130 (void)close(pfd[pipe_write]);
2135 /* Back in the main process: panic if the fork did not succeed. This seems
2136 better than returning an error - if forking is failing it is probably best
2137 not to try other deliveries for this message. */
2140 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Fork failed for local delivery to %s",
2143 /* Read the pipe to get the delivery status codes and error messages. Our copy
2144 of the writing end must be closed first, as otherwise read() won't return zero
2145 on an empty pipe. We check that a status exists for each address before
2146 overwriting the address structure. If data is missing, the default DEFER status
2147 will remain. Afterwards, close the reading end. */
2149 (void)close(pfd[pipe_write]);
2151 for (addr2 = addr; addr2 != NULL; addr2 = addr2->next)
2153 len = read(pfd[pipe_read], (void *)&status, sizeof(int));
2159 addr2->transport_return = status;
2160 len = read(pfd[pipe_read], (void *)&transport_count,
2161 sizeof(transport_count));
2162 len = read(pfd[pipe_read], (void *)&(addr2->flags), sizeof(addr2->flags));
2163 len = read(pfd[pipe_read], (void *)&(addr2->basic_errno), sizeof(int));
2164 len = read(pfd[pipe_read], (void *)&(addr2->more_errno), sizeof(int));
2165 len = read(pfd[pipe_read], (void *)&(addr2->special_action), sizeof(int));
2166 len = read(pfd[pipe_read], (void *)&(addr2->transport),
2167 sizeof(transport_instance *));
2169 if (testflag(addr2, af_file))
2171 int local_part_length;
2172 len = read(pfd[pipe_read], (void *)&local_part_length, sizeof(int));
2173 len = read(pfd[pipe_read], (void *)big_buffer, local_part_length);
2174 big_buffer[local_part_length] = 0;
2175 addr2->local_part = string_copy(big_buffer);
2178 for (i = 0, sptr = &(addr2->message); i < 2;
2179 i++, sptr = &(addr2->user_message))
2182 len = read(pfd[pipe_read], (void *)&message_length, sizeof(int));
2183 if (message_length > 0)
2185 len = read(pfd[pipe_read], (void *)big_buffer, message_length);
2186 if (len > 0) *sptr = string_copy(big_buffer);
2193 log_write(0, LOG_MAIN|LOG_PANIC, "failed to read delivery status for %s "
2194 "from delivery subprocess", addr2->unique);
2199 (void)close(pfd[pipe_read]);
2201 /* Unless shadowing, write all successful addresses immediately to the journal
2202 file, to ensure they are recorded asap. For homonymic addresses, use the base
2203 address plus the transport name. Failure to write the journal is panic-worthy,
2204 but don't stop, as it may prove possible subsequently to update the spool file
2205 in order to record the delivery. */
2209 for (addr2 = addr; addr2 != NULL; addr2 = addr2->next)
2211 if (addr2->transport_return != OK) continue;
2213 if (testflag(addr2, af_homonym))
2214 sprintf(CS big_buffer, "%.500s/%s\n", addr2->unique + 3, tp->name);
2216 sprintf(CS big_buffer, "%.500s\n", addr2->unique);
2218 /* In the test harness, wait just a bit to let the subprocess finish off
2219 any debug output etc first. */
2221 if (running_in_test_harness) millisleep(300);
2223 DEBUG(D_deliver) debug_printf("journalling %s", big_buffer);
2224 len = Ustrlen(big_buffer);
2225 if (write(journal_fd, big_buffer, len) != len)
2226 log_write(0, LOG_MAIN|LOG_PANIC, "failed to update journal for %s: %s",
2227 big_buffer, strerror(errno));
2230 /* Ensure the journal file is pushed out to disk. */
2232 if (EXIMfsync(journal_fd) < 0)
2233 log_write(0, LOG_MAIN|LOG_PANIC, "failed to fsync journal: %s",
2237 /* Wait for the process to finish. If it terminates with a non-zero code,
2238 freeze the message (except for SIGTERM, SIGKILL and SIGQUIT), but leave the
2239 status values of all the addresses as they are. Take care to handle the case
2240 when the subprocess doesn't seem to exist. This has been seen on one system
2241 when Exim was called from an MUA that set SIGCHLD to SIG_IGN. When that
2242 happens, wait() doesn't recognize the termination of child processes. Exim now
2243 resets SIGCHLD to SIG_DFL, but this code should still be robust. */
2245 while ((rc = wait(&status)) != pid)
2247 if (rc < 0 && errno == ECHILD) /* Process has vanished */
2249 log_write(0, LOG_MAIN, "%s transport process vanished unexpectedly",
2250 addr->transport->driver_name);
2256 if ((status & 0xffff) != 0)
2258 int msb = (status >> 8) & 255;
2259 int lsb = status & 255;
2260 int code = (msb == 0)? (lsb & 0x7f) : msb;
2261 if (msb != 0 || (code != SIGTERM && code != SIGKILL && code != SIGQUIT))
2262 addr->special_action = SPECIAL_FREEZE;
2263 log_write(0, LOG_MAIN|LOG_PANIC, "%s transport process returned non-zero "
2264 "status 0x%04x: %s %d",
2265 addr->transport->driver_name,
2267 (msb == 0)? "terminated by signal" : "exit code",
2271 /* If SPECIAL_WARN is set in the top address, send a warning message. */
2273 if (addr->special_action == SPECIAL_WARN &&
2274 addr->transport->warn_message != NULL)
2277 uschar *warn_message;
2279 DEBUG(D_deliver) debug_printf("Warning message requested by transport\n");
2281 warn_message = expand_string(addr->transport->warn_message);
2282 if (warn_message == NULL)
2283 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand \"%s\" (warning "
2284 "message for %s transport): %s", addr->transport->warn_message,
2285 addr->transport->name, expand_string_message);
2288 pid_t pid = child_open_exim(&fd);
2291 FILE *f = fdopen(fd, "wb");
2292 if (errors_reply_to != NULL &&
2293 !contains_header(US"Reply-To", warn_message))
2294 fprintf(f, "Reply-To: %s\n", errors_reply_to);
2295 fprintf(f, "Auto-Submitted: auto-replied\n");
2296 if (!contains_header(US"From", warn_message)) moan_write_from(f);
2297 fprintf(f, "%s", CS warn_message);
2299 /* Close and wait for child process to complete, without a timeout. */
2302 (void)child_close(pid, 0);
2306 addr->special_action = SPECIAL_NONE;
2312 /*************************************************
2313 * Do local deliveries *
2314 *************************************************/
2316 /* This function processes the list of addresses in addr_local. True local
2317 deliveries are always done one address at a time. However, local deliveries can
2318 be batched up in some cases. Typically this is when writing batched SMTP output
2319 files for use by some external transport mechanism, or when running local
2320 deliveries over LMTP.
2327 do_local_deliveries(void)
2330 open_db *dbm_file = NULL;
2331 time_t now = time(NULL);
2333 /* Loop until we have exhausted the supply of local deliveries */
2335 while (addr_local != NULL)
2337 time_t delivery_start;
2339 address_item *addr2, *addr3, *nextaddr;
2340 int logflags = LOG_MAIN;
2341 int logchar = dont_deliver? '*' : '=';
2342 transport_instance *tp;
2344 /* Pick the first undelivered address off the chain */
2346 address_item *addr = addr_local;
2347 addr_local = addr->next;
2350 DEBUG(D_deliver|D_transport)
2351 debug_printf("--------> %s <--------\n", addr->address);
2353 /* An internal disaster if there is no transport. Should not occur! */
2355 if ((tp = addr->transport) == NULL)
2357 logflags |= LOG_PANIC;
2358 disable_logging = FALSE; /* Jic */
2360 (addr->router != NULL)?
2361 string_sprintf("No transport set by %s router", addr->router->name)
2363 string_sprintf("No transport set by system filter");
2364 post_process_one(addr, DEFER, logflags, DTYPE_TRANSPORT, 0);
2368 /* Check that this base address hasn't previously been delivered to this
2369 transport. The check is necessary at this point to handle homonymic addresses
2370 correctly in cases where the pattern of redirection changes between delivery
2371 attempts. Non-homonymic previous delivery is detected earlier, at routing
2374 if (previously_transported(addr, FALSE)) continue;
2376 /* There are weird cases where logging is disabled */
2378 disable_logging = tp->disable_logging;
2380 /* Check for batched addresses and possible amalgamation. Skip all the work
2381 if either batch_max <= 1 or there aren't any other addresses for local
2384 if (tp->batch_max > 1 && addr_local != NULL)
2386 int batch_count = 1;
2387 BOOL uses_dom = readconf_depends((driver_instance *)tp, US"domain");
2388 BOOL uses_lp = (testflag(addr, af_pfr) &&
2389 (testflag(addr, af_file) || addr->local_part[0] == '|')) ||
2390 readconf_depends((driver_instance *)tp, US"local_part");
2391 uschar *batch_id = NULL;
2392 address_item **anchor = &addr_local;
2393 address_item *last = addr;
2396 /* Expand the batch_id string for comparison with other addresses.
2397 Expansion failure suppresses batching. */
2399 if (tp->batch_id != NULL)
2401 deliver_set_expansions(addr);
2402 batch_id = expand_string(tp->batch_id);
2403 deliver_set_expansions(NULL);
2404 if (batch_id == NULL)
2406 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand batch_id option "
2407 "in %s transport (%s): %s", tp->name, addr->address,
2408 expand_string_message);
2409 batch_count = tp->batch_max;
2413 /* Until we reach the batch_max limit, pick off addresses which have the
2414 same characteristics. These are:
2417 not previously delivered (see comment about 50 lines above)
2418 same local part if the transport's configuration contains $local_part
2419 or if this is a file or pipe delivery from a redirection
2420 same domain if the transport's configuration contains $domain
2422 same additional headers
2423 same headers to be removed
2424 same uid/gid for running the transport
2425 same first host if a host list is set
2428 while ((next = *anchor) != NULL && batch_count < tp->batch_max)
2431 tp == next->transport &&
2432 !previously_transported(next, TRUE) &&
2433 (addr->flags & (af_pfr|af_file)) == (next->flags & (af_pfr|af_file)) &&
2434 (!uses_lp || Ustrcmp(next->local_part, addr->local_part) == 0) &&
2435 (!uses_dom || Ustrcmp(next->domain, addr->domain) == 0) &&
2436 same_strings(next->prop.errors_address, addr->prop.errors_address) &&
2437 same_headers(next->prop.extra_headers, addr->prop.extra_headers) &&
2438 same_strings(next->prop.remove_headers, addr->prop.remove_headers) &&
2439 same_ugid(tp, addr, next) &&
2440 ((addr->host_list == NULL && next->host_list == NULL) ||
2441 (addr->host_list != NULL && next->host_list != NULL &&
2442 Ustrcmp(addr->host_list->name, next->host_list->name) == 0));
2444 /* If the transport has a batch_id setting, batch_id will be non-NULL
2445 from the expansion outside the loop. Expand for this address and compare.
2446 Expansion failure makes this address ineligible for batching. */
2448 if (ok && batch_id != NULL)
2451 address_item *save_nextnext = next->next;
2452 next->next = NULL; /* Expansion for a single address */
2453 deliver_set_expansions(next);
2454 next->next = save_nextnext;
2455 bid = expand_string(tp->batch_id);
2456 deliver_set_expansions(NULL);
2459 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand batch_id option "
2460 "in %s transport (%s): %s", tp->name, next->address,
2461 expand_string_message);
2464 else ok = (Ustrcmp(batch_id, bid) == 0);
2467 /* Take address into batch if OK. */
2471 *anchor = next->next; /* Include the address */
2477 else anchor = &(next->next); /* Skip the address */
2481 /* We now have one or more addresses that can be delivered in a batch. Check
2482 whether the transport is prepared to accept a message of this size. If not,
2483 fail them all forthwith. If the expansion fails, or does not yield an
2484 integer, defer delivery. */
2486 if (tp->message_size_limit != NULL)
2488 int rc = check_message_size(tp, addr);
2491 replicate_status(addr);
2492 while (addr != NULL)
2495 post_process_one(addr, rc, logflags, DTYPE_TRANSPORT, 0);
2498 continue; /* With next batch of addresses */
2502 /* If we are not running the queue, or if forcing, all deliveries will be
2503 attempted. Otherwise, we must respect the retry times for each address. Even
2504 when not doing this, we need to set up the retry key string, and determine
2505 whether a retry record exists, because after a successful delivery, a delete
2506 retry item must be set up. Keep the retry database open only for the duration
2507 of these checks, rather than for all local deliveries, because some local
2508 deliveries (e.g. to pipes) can take a substantial time. */
2510 dbm_file = dbfn_open(US"retry", O_RDONLY, &dbblock, FALSE);
2511 if (dbm_file == NULL)
2513 DEBUG(D_deliver|D_retry|D_hints_lookup)
2514 debug_printf("no retry data available\n");
2519 while (addr2 != NULL)
2521 BOOL ok = TRUE; /* to deliver this address */
2524 /* Set up the retry key to include the domain or not, and change its
2525 leading character from "R" to "T". Must make a copy before doing this,
2526 because the old key may be pointed to from a "delete" retry item after
2529 retry_key = string_copy(
2530 (tp->retry_use_local_part)? addr2->address_retry_key :
2531 addr2->domain_retry_key);
2534 /* Inspect the retry data. If there is no hints file, delivery happens. */
2536 if (dbm_file != NULL)
2538 dbdata_retry *retry_record = dbfn_read(dbm_file, retry_key);
2540 /* If there is no retry record, delivery happens. If there is,
2541 remember it exists so it can be deleted after a successful delivery. */
2543 if (retry_record != NULL)
2545 setflag(addr2, af_lt_retry_exists);
2547 /* A retry record exists for this address. If queue running and not
2548 forcing, inspect its contents. If the record is too old, or if its
2549 retry time has come, or if it has passed its cutoff time, delivery
2554 debug_printf("retry record exists: age=%s ",
2555 readconf_printtime(now - retry_record->time_stamp));
2556 debug_printf("(max %s)\n", readconf_printtime(retry_data_expire));
2557 debug_printf(" time to retry = %s expired = %d\n",
2558 readconf_printtime(retry_record->next_try - now),
2559 retry_record->expired);
2562 if (queue_running && !deliver_force)
2564 ok = (now - retry_record->time_stamp > retry_data_expire) ||
2565 (now >= retry_record->next_try) ||
2566 retry_record->expired;
2568 /* If we haven't reached the retry time, there is one more check
2569 to do, which is for the ultimate address timeout. */
2572 ok = retry_ultimate_address_timeout(retry_key, addr2->domain,
2576 else DEBUG(D_retry) debug_printf("no retry record exists\n");
2579 /* This address is to be delivered. Leave it on the chain. */
2584 addr2 = addr2->next;
2587 /* This address is to be deferred. Take it out of the chain, and
2588 post-process it as complete. Must take it out of the chain first,
2589 because post processing puts it on another chain. */
2593 address_item *this = addr2;
2594 this->message = US"Retry time not yet reached";
2595 this->basic_errno = ERRNO_LRETRY;
2596 if (addr3 == NULL) addr2 = addr = addr2->next;
2597 else addr2 = addr3->next = addr2->next;
2598 post_process_one(this, DEFER, logflags, DTYPE_TRANSPORT, 0);
2602 if (dbm_file != NULL) dbfn_close(dbm_file);
2604 /* If there are no addresses left on the chain, they all deferred. Loop
2605 for the next set of addresses. */
2607 if (addr == NULL) continue;
2609 /* So, finally, we do have some addresses that can be passed to the
2610 transport. Before doing so, set up variables that are relevant to a
2613 deliver_set_expansions(addr);
2614 delivery_start = time(NULL);
2615 deliver_local(addr, FALSE);
2616 deliver_time = (int)(time(NULL) - delivery_start);
2618 /* If a shadow transport (which must perforce be another local transport), is
2619 defined, and its condition is met, we must pass the message to the shadow
2620 too, but only those addresses that succeeded. We do this by making a new
2621 chain of addresses - also to keep the original chain uncontaminated. We must
2622 use a chain rather than doing it one by one, because the shadow transport may
2625 NOTE: if the condition fails because of a lookup defer, there is nothing we
2628 if (tp->shadow != NULL &&
2629 (tp->shadow_condition == NULL ||
2630 expand_check_condition(tp->shadow_condition, tp->name, US"transport")))
2632 transport_instance *stp;
2633 address_item *shadow_addr = NULL;
2634 address_item **last = &shadow_addr;
2636 for (stp = transports; stp != NULL; stp = stp->next)
2637 if (Ustrcmp(stp->name, tp->shadow) == 0) break;
2640 log_write(0, LOG_MAIN|LOG_PANIC, "shadow transport \"%s\" not found ",
2643 /* Pick off the addresses that have succeeded, and make clones. Put into
2644 the shadow_message field a pointer to the shadow_message field of the real
2647 else for (addr2 = addr; addr2 != NULL; addr2 = addr2->next)
2649 if (addr2->transport_return != OK) continue;
2650 addr3 = store_get(sizeof(address_item));
2653 addr3->shadow_message = (uschar *)(&(addr2->shadow_message));
2654 addr3->transport = stp;
2655 addr3->transport_return = DEFER;
2656 addr3->return_filename = NULL;
2657 addr3->return_file = -1;
2659 last = &(addr3->next);
2662 /* If we found any addresses to shadow, run the delivery, and stick any
2663 message back into the shadow_message field in the original. */
2665 if (shadow_addr != NULL)
2667 int save_count = transport_count;
2669 DEBUG(D_deliver|D_transport)
2670 debug_printf(">>>>>>>>>>>>>>>> Shadow delivery >>>>>>>>>>>>>>>>\n");
2671 deliver_local(shadow_addr, TRUE);
2673 for(; shadow_addr != NULL; shadow_addr = shadow_addr->next)
2675 int sresult = shadow_addr->transport_return;
2676 *((uschar **)(shadow_addr->shadow_message)) = (sresult == OK)?
2677 string_sprintf(" ST=%s", stp->name) :
2678 string_sprintf(" ST=%s (%s%s%s)", stp->name,
2679 (shadow_addr->basic_errno <= 0)?
2680 US"" : US strerror(shadow_addr->basic_errno),
2681 (shadow_addr->basic_errno <= 0 || shadow_addr->message == NULL)?
2683 (shadow_addr->message != NULL)? shadow_addr->message :
2684 (shadow_addr->basic_errno <= 0)? US"unknown error" : US"");
2686 DEBUG(D_deliver|D_transport)
2687 debug_printf("%s shadow transport returned %s for %s\n",
2689 (sresult == OK)? "OK" :
2690 (sresult == DEFER)? "DEFER" :
2691 (sresult == FAIL)? "FAIL" :
2692 (sresult == PANIC)? "PANIC" : "?",
2693 shadow_addr->address);
2696 DEBUG(D_deliver|D_transport)
2697 debug_printf(">>>>>>>>>>>>>>>> End shadow delivery >>>>>>>>>>>>>>>>\n");
2699 transport_count = save_count; /* Restore original transport count */
2703 /* Cancel the expansions that were set up for the delivery. */
2705 deliver_set_expansions(NULL);
2707 /* Now we can process the results of the real transport. We must take each
2708 address off the chain first, because post_process_one() puts it on another
2711 for (addr2 = addr; addr2 != NULL; addr2 = nextaddr)
2713 int result = addr2->transport_return;
2714 nextaddr = addr2->next;
2716 DEBUG(D_deliver|D_transport)
2717 debug_printf("%s transport returned %s for %s\n",
2719 (result == OK)? "OK" :
2720 (result == DEFER)? "DEFER" :
2721 (result == FAIL)? "FAIL" :
2722 (result == PANIC)? "PANIC" : "?",
2725 /* If there is a retry_record, or if delivery is deferred, build a retry
2726 item for setting a new retry time or deleting the old retry record from
2727 the database. These items are handled all together after all addresses
2728 have been handled (so the database is open just for a short time for
2731 if (result == DEFER || testflag(addr2, af_lt_retry_exists))
2733 int flags = (result == DEFER)? 0 : rf_delete;
2734 uschar *retry_key = string_copy((tp->retry_use_local_part)?
2735 addr2->address_retry_key : addr2->domain_retry_key);
2737 retry_add_item(addr2, retry_key, flags);
2740 /* Done with this address */
2742 if (result == OK) addr2->more_errno = deliver_time;
2743 post_process_one(addr2, result, logflags, DTYPE_TRANSPORT, logchar);
2745 /* If a pipe delivery generated text to be sent back, the result may be
2746 changed to FAIL, and we must copy this for subsequent addresses in the
2749 if (addr2->transport_return != result)
2751 for (addr3 = nextaddr; addr3 != NULL; addr3 = addr3->next)
2753 addr3->transport_return = addr2->transport_return;
2754 addr3->basic_errno = addr2->basic_errno;
2755 addr3->message = addr2->message;
2757 result = addr2->transport_return;
2760 /* Whether or not the result was changed to FAIL, we need to copy the
2761 return_file value from the first address into all the addresses of the
2762 batch, so they are all listed in the error message. */
2764 addr2->return_file = addr->return_file;
2766 /* Change log character for recording successful deliveries. */
2768 if (result == OK) logchar = '-';
2770 } /* Loop back for next batch of addresses */
2776 /*************************************************
2777 * Sort remote deliveries *
2778 *************************************************/
2780 /* This function is called if remote_sort_domains is set. It arranges that the
2781 chain of addresses for remote deliveries is ordered according to the strings
2782 specified. Try to make this shuffling reasonably efficient by handling
2783 sequences of addresses rather than just single ones.
2790 sort_remote_deliveries(void)
2793 address_item **aptr = &addr_remote;
2794 const uschar *listptr = remote_sort_domains;
2798 while (*aptr != NULL &&
2799 (pattern = string_nextinlist(&listptr, &sep, patbuf, sizeof(patbuf)))
2802 address_item *moved = NULL;
2803 address_item **bptr = &moved;
2805 while (*aptr != NULL)
2807 address_item **next;
2808 deliver_domain = (*aptr)->domain; /* set $domain */
2809 if (match_isinlist(deliver_domain, (const uschar **)&pattern, UCHAR_MAX+1,
2810 &domainlist_anchor, NULL, MCL_DOMAIN, TRUE, NULL) == OK)
2812 aptr = &((*aptr)->next);
2816 next = &((*aptr)->next);
2817 while (*next != NULL &&
2818 (deliver_domain = (*next)->domain, /* Set $domain */
2819 match_isinlist(deliver_domain, (const uschar **)&pattern, UCHAR_MAX+1,
2820 &domainlist_anchor, NULL, MCL_DOMAIN, TRUE, NULL)) != OK)
2821 next = &((*next)->next);
2823 /* If the batch of non-matchers is at the end, add on any that were
2824 extracted further up the chain, and end this iteration. Otherwise,
2825 extract them from the chain and hang on the moved chain. */
2837 aptr = &((*aptr)->next);
2840 /* If the loop ended because the final address matched, *aptr will
2841 be NULL. Add on to the end any extracted non-matching addresses. If
2842 *aptr is not NULL, the loop ended via "break" when *next is null, that
2843 is, there was a string of non-matching addresses at the end. In this
2844 case the extracted addresses have already been added on the end. */
2846 if (*aptr == NULL) *aptr = moved;
2852 debug_printf("remote addresses after sorting:\n");
2853 for (addr = addr_remote; addr != NULL; addr = addr->next)
2854 debug_printf(" %s\n", addr->address);
2860 /*************************************************
2861 * Read from pipe for remote delivery subprocess *
2862 *************************************************/
2864 /* This function is called when the subprocess is complete, but can also be
2865 called before it is complete, in order to empty a pipe that is full (to prevent
2866 deadlock). It must therefore keep track of its progress in the parlist data
2869 We read the pipe to get the delivery status codes and a possible error message
2870 for each address, optionally preceded by unusability data for the hosts and
2871 also by optional retry data.
2873 Read in large chunks into the big buffer and then scan through, interpreting
2874 the data therein. In most cases, only a single read will be necessary. No
2875 individual item will ever be anywhere near 2500 bytes in length, so by ensuring
2876 that we read the next chunk when there is less than 2500 bytes left in the
2877 non-final chunk, we can assume each item is complete in the buffer before
2878 handling it. Each item is written using a single write(), which is atomic for
2879 small items (less than PIPE_BUF, which seems to be at least 512 in any Unix and
2880 often bigger) so even if we are reading while the subprocess is still going, we
2881 should never have only a partial item in the buffer.
2884 poffset the offset of the parlist item
2885 eop TRUE if the process has completed
2887 Returns: TRUE if the terminating 'Z' item has been read,
2888 or there has been a disaster (i.e. no more data needed);
2893 par_read_pipe(int poffset, BOOL eop)
2896 pardata *p = parlist + poffset;
2897 address_item *addrlist = p->addrlist;
2898 address_item *addr = p->addr;
2901 uschar *endptr = big_buffer;
2902 uschar *ptr = endptr;
2903 uschar *msg = p->msg;
2904 BOOL done = p->done;
2905 BOOL unfinished = TRUE;
2906 /* minimum size to read is header size including id, subid and length */
2907 int required = PIPE_HEADER_SIZE;
2909 /* Loop through all items, reading from the pipe when necessary. The pipe
2910 is set up to be non-blocking, but there are two different Unix mechanisms in
2911 use. Exim uses O_NONBLOCK if it is defined. This returns 0 for end of file,
2912 and EAGAIN for no more data. If O_NONBLOCK is not defined, Exim uses O_NDELAY,
2913 which returns 0 for both end of file and no more data. We distinguish the
2914 two cases by taking 0 as end of file only when we know the process has
2917 Each separate item is written to the pipe in a single write(), and as they are
2918 all short items, the writes will all be atomic and we should never find
2919 ourselves in the position of having read an incomplete item. "Short" in this
2920 case can mean up to about 1K in the case when there is a long error message
2921 associated with an address. */
2923 DEBUG(D_deliver) debug_printf("reading pipe for subprocess %d (%s)\n",
2924 (int)p->pid, eop? "ended" : "not ended");
2928 retry_item *r, **rp;
2929 int remaining = endptr - ptr;
2930 uschar header[PIPE_HEADER_SIZE + 1];
2934 /* Read (first time) or top up the chars in the buffer if necessary.
2935 There will be only one read if we get all the available data (i.e. don't
2936 fill the buffer completely). */
2938 if (remaining < required && unfinished)
2941 int available = big_buffer_size - remaining;
2943 if (remaining > 0) memmove(big_buffer, ptr, remaining);
2946 endptr = big_buffer + remaining;
2947 len = read(fd, endptr, available);
2949 DEBUG(D_deliver) debug_printf("read() yielded %d\n", len);
2951 /* If the result is EAGAIN and the process is not complete, just
2952 stop reading any more and process what we have already. */
2956 if (!eop && errno == EAGAIN) len = 0; else
2958 msg = string_sprintf("failed to read pipe from transport process "
2959 "%d for transport %s: %s", pid, addr->transport->driver_name,
2965 /* If the length is zero (eof or no-more-data), just process what we
2966 already have. Note that if the process is still running and we have
2967 read all the data in the pipe (but less that "available") then we
2968 won't read any more, as "unfinished" will get set FALSE. */
2972 unfinished = len == available;
2975 /* If we are at the end of the available data, exit the loop. */
2976 if (ptr >= endptr) break;
2978 /* copy and read header */
2979 memcpy(header, ptr, PIPE_HEADER_SIZE);
2980 header[PIPE_HEADER_SIZE] = '\0';
2983 required = Ustrtol(header + 2, &endc, 10) + PIPE_HEADER_SIZE; /* header + data */
2986 msg = string_sprintf("failed to read pipe from transport process "
2987 "%d for transport %s: error reading size from header", pid, addr->transport->driver_name);
2993 debug_printf("header read id:%c,subid:%c,size:%s,required:%d,remaining:%d,unfinished:%d\n",
2994 id, subid, header+2, required, remaining, unfinished);
2996 /* is there room for the dataset we want to read ? */
2997 if (required > big_buffer_size - PIPE_HEADER_SIZE)
2999 msg = string_sprintf("failed to read pipe from transport process "
3000 "%d for transport %s: big_buffer too small! required size=%d buffer size=%d", pid, addr->transport->driver_name,
3001 required, big_buffer_size - PIPE_HEADER_SIZE);
3006 /* we wrote all datasets with atomic write() calls
3007 remaining < required only happens if big_buffer was too small
3008 to get all available data from pipe. unfinished has to be true
3010 if (remaining < required)
3014 msg = string_sprintf("failed to read pipe from transport process "
3015 "%d for transport %s: required size=%d > remaining size=%d and unfinished=false",
3016 pid, addr->transport->driver_name, required, remaining);
3021 /* step behind the header */
3022 ptr += PIPE_HEADER_SIZE;
3024 /* Handle each possible type of item, assuming the complete item is
3025 available in store. */
3029 /* Host items exist only if any hosts were marked unusable. Match
3030 up by checking the IP address. */
3033 for (h = addrlist->host_list; h != NULL; h = h->next)
3035 if (h->address == NULL || Ustrcmp(h->address, ptr+2) != 0) continue;
3043 /* Retry items are sent in a preceding R item for each address. This is
3044 kept separate to keep each message short enough to guarantee it won't
3045 be split in the pipe. Hopefully, in the majority of cases, there won't in
3046 fact be any retry items at all.
3048 The complete set of retry items might include an item to delete a
3049 routing retry if there was a previous routing delay. However, routing
3050 retries are also used when a remote transport identifies an address error.
3051 In that case, there may also be an "add" item for the same key. Arrange
3052 that a "delete" item is dropped in favour of an "add" item. */
3055 if (addr == NULL) goto ADDR_MISMATCH;
3057 DEBUG(D_deliver|D_retry)
3058 debug_printf("reading retry information for %s from subprocess\n",
3061 /* Cut out any "delete" items on the list. */
3063 for (rp = &(addr->retries); (r = *rp) != NULL; rp = &(r->next))
3065 if (Ustrcmp(r->key, ptr+1) == 0) /* Found item with same key */
3067 if ((r->flags & rf_delete) == 0) break; /* It was not "delete" */
3068 *rp = r->next; /* Excise a delete item */
3069 DEBUG(D_deliver|D_retry)
3070 debug_printf(" existing delete item dropped\n");
3074 /* We want to add a delete item only if there is no non-delete item;
3075 however we still have to step ptr through the data. */
3077 if (r == NULL || (*ptr & rf_delete) == 0)
3079 r = store_get(sizeof(retry_item));
3080 r->next = addr->retries;
3083 r->key = string_copy(ptr);
3085 memcpy(&(r->basic_errno), ptr, sizeof(r->basic_errno));
3086 ptr += sizeof(r->basic_errno);
3087 memcpy(&(r->more_errno), ptr, sizeof(r->more_errno));
3088 ptr += sizeof(r->more_errno);
3089 r->message = (*ptr)? string_copy(ptr) : NULL;
3090 DEBUG(D_deliver|D_retry)
3091 debug_printf(" added %s item\n",
3092 ((r->flags & rf_delete) == 0)? "retry" : "delete");
3097 DEBUG(D_deliver|D_retry)
3098 debug_printf(" delete item not added: non-delete item exists\n");
3101 ptr += sizeof(r->basic_errno) + sizeof(r->more_errno);
3107 /* Put the amount of data written into the parlist block */
3110 memcpy(&(p->transport_count), ptr, sizeof(transport_count));
3111 ptr += sizeof(transport_count);
3114 /* Address items are in the order of items on the address chain. We
3115 remember the current address value in case this function is called
3116 several times to empty the pipe in stages. Information about delivery
3117 over TLS is sent in a preceding X item for each address. We don't put
3118 it in with the other info, in order to keep each message short enough to
3119 guarantee it won't be split in the pipe. */
3123 if (addr == NULL) goto ADDR_MISMATCH; /* Below, in 'A' handler */
3127 addr->cipher = NULL;
3128 addr->peerdn = NULL;
3131 addr->cipher = string_copy(ptr);
3134 addr->peerdn = string_copy(ptr);
3138 addr->peercert = NULL;
3140 (void) tls_import_cert(ptr, &addr->peercert);
3144 addr->ourcert = NULL;
3146 (void) tls_import_cert(ptr, &addr->ourcert);
3149 # ifndef DISABLE_OCSP
3151 addr->ocsp = OCSP_NOT_REQ;
3153 addr->ocsp = *ptr - '0';
3159 #endif /*SUPPORT_TLS*/
3161 case 'C': /* client authenticator information */
3165 addr->authenticator = (*ptr)? string_copy(ptr) : NULL;
3168 addr->auth_id = (*ptr)? string_copy(ptr) : NULL;
3171 addr->auth_sndr = (*ptr)? string_copy(ptr) : NULL;
3177 #ifndef DISABLE_PRDR
3179 addr->flags |= af_prdr_used;
3184 if (addr == NULL) goto ADDR_MISMATCH;
3185 memcpy(&(addr->dsn_aware), ptr, sizeof(addr->dsn_aware));
3186 ptr += sizeof(addr->dsn_aware);
3187 DEBUG(D_deliver) debug_printf("DSN read: addr->dsn_aware = %d\n", addr->dsn_aware);
3194 msg = string_sprintf("address count mismatch for data read from pipe "
3195 "for transport process %d for transport %s", pid,
3196 addrlist->transport->driver_name);
3201 addr->transport_return = *ptr++;
3202 addr->special_action = *ptr++;
3203 memcpy(&(addr->basic_errno), ptr, sizeof(addr->basic_errno));
3204 ptr += sizeof(addr->basic_errno);
3205 memcpy(&(addr->more_errno), ptr, sizeof(addr->more_errno));
3206 ptr += sizeof(addr->more_errno);
3207 memcpy(&(addr->flags), ptr, sizeof(addr->flags));
3208 ptr += sizeof(addr->flags);
3209 addr->message = (*ptr)? string_copy(ptr) : NULL;
3211 addr->user_message = (*ptr)? string_copy(ptr) : NULL;
3214 /* Always two strings for host information, followed by the port number and DNSSEC mark */
3218 h = store_get(sizeof(host_item));
3219 h->name = string_copy(ptr);
3221 h->address = string_copy(ptr);
3223 memcpy(&(h->port), ptr, sizeof(h->port));
3224 ptr += sizeof(h->port);
3225 h->dnssec = *ptr == '2' ? DS_YES
3226 : *ptr == '1' ? DS_NO
3229 addr->host_used = h;
3233 /* Finished with this address */
3238 /* Local interface address/port */
3240 if (*ptr) sending_ip_address = string_copy(ptr);
3242 if (*ptr) sending_port = atoi(CS ptr);
3246 /* Z marks the logical end of the data. It is followed by '0' if
3247 continue_transport was NULL at the end of transporting, otherwise '1'.
3248 We need to know when it becomes NULL during a delivery down a passed SMTP
3249 channel so that we don't try to pass anything more down it. Of course, for
3250 most normal messages it will remain NULL all the time. */
3255 continue_transport = NULL;
3256 continue_hostname = NULL;
3259 DEBUG(D_deliver) debug_printf("Z0%c item read\n", *ptr);
3262 /* Anything else is a disaster. */
3265 msg = string_sprintf("malformed data (%d) read from pipe for transport "
3266 "process %d for transport %s", ptr[-1], pid,
3267 addr->transport->driver_name);
3273 /* The done flag is inspected externally, to determine whether or not to
3274 call the function again when the process finishes. */
3278 /* If the process hadn't finished, and we haven't seen the end of the data
3279 or suffered a disaster, update the rest of the state, and return FALSE to
3280 indicate "not finished". */
3289 /* Close our end of the pipe, to prevent deadlock if the far end is still
3290 pushing stuff into it. */
3295 /* If we have finished without error, but haven't had data for every address,
3296 something is wrong. */
3298 if (msg == NULL && addr != NULL)
3299 msg = string_sprintf("insufficient address data read from pipe "
3300 "for transport process %d for transport %s", pid,
3301 addr->transport->driver_name);
3303 /* If an error message is set, something has gone wrong in getting back
3304 the delivery data. Put the message into each address and freeze it. */
3308 for (addr = addrlist; addr != NULL; addr = addr->next)
3310 addr->transport_return = DEFER;
3311 addr->special_action = SPECIAL_FREEZE;
3312 addr->message = msg;
3316 /* Return TRUE to indicate we have got all we need from this process, even
3317 if it hasn't actually finished yet. */
3324 /*************************************************
3325 * Post-process a set of remote addresses *
3326 *************************************************/
3328 /* Do what has to be done immediately after a remote delivery for each set of
3329 addresses, then re-write the spool if necessary. Note that post_process_one
3330 puts the address on an appropriate queue; hence we must fish off the next
3331 one first. This function is also called if there is a problem with setting
3332 up a subprocess to do a remote delivery in parallel. In this case, the final
3333 argument contains a message, and the action must be forced to DEFER.
3336 addr pointer to chain of address items
3337 logflags flags for logging
3338 msg NULL for normal cases; -> error message for unexpected problems
3339 fallback TRUE if processing fallback hosts
3345 remote_post_process(address_item *addr, int logflags, uschar *msg,
3350 /* If any host addresses were found to be unusable, add them to the unusable
3351 tree so that subsequent deliveries don't try them. */
3353 for (h = addr->host_list; h != NULL; h = h->next)
3355 if (h->address == NULL) continue;
3356 if (h->status >= hstatus_unusable) tree_add_unusable(h);
3359 /* Now handle each address on the chain. The transport has placed '=' or '-'
3360 into the special_action field for each successful delivery. */
3362 while (addr != NULL)
3364 address_item *next = addr->next;
3366 /* If msg == NULL (normal processing) and the result is DEFER and we are
3367 processing the main hosts and there are fallback hosts available, put the
3368 address on the list for fallback delivery. */
3370 if (addr->transport_return == DEFER &&
3371 addr->fallback_hosts != NULL &&
3375 addr->host_list = addr->fallback_hosts;
3376 addr->next = addr_fallback;
3377 addr_fallback = addr;
3378 DEBUG(D_deliver) debug_printf("%s queued for fallback host(s)\n", addr->address);
3381 /* If msg is set (=> unexpected problem), set it in the address before
3382 doing the ordinary post processing. */
3388 addr->message = msg;
3389 addr->transport_return = DEFER;
3391 (void)post_process_one(addr, addr->transport_return, logflags,
3392 DTYPE_TRANSPORT, addr->special_action);
3400 /* If we have just delivered down a passed SMTP channel, and that was
3401 the last address, the channel will have been closed down. Now that
3402 we have logged that delivery, set continue_sequence to 1 so that
3403 any subsequent deliveries don't get "*" incorrectly logged. */
3405 if (continue_transport == NULL) continue_sequence = 1;
3410 /*************************************************
3411 * Wait for one remote delivery subprocess *
3412 *************************************************/
3414 /* This function is called while doing remote deliveries when either the
3415 maximum number of processes exist and we need one to complete so that another
3416 can be created, or when waiting for the last ones to complete. It must wait for
3417 the completion of one subprocess, empty the control block slot, and return a
3418 pointer to the address chain.
3421 Returns: pointer to the chain of addresses handled by the process;
3422 NULL if no subprocess found - this is an unexpected error
3425 static address_item *
3428 int poffset, status;
3429 address_item *addr, *addrlist;
3432 set_process_info("delivering %s: waiting for a remote delivery subprocess "
3433 "to finish", message_id);
3435 /* Loop until either a subprocess completes, or there are no subprocesses in
3436 existence - in which case give an error return. We cannot proceed just by
3437 waiting for a completion, because a subprocess may have filled up its pipe, and
3438 be waiting for it to be emptied. Therefore, if no processes have finished, we
3439 wait for one of the pipes to acquire some data by calling select(), with a
3440 timeout just in case.
3442 The simple approach is just to iterate after reading data from a ready pipe.
3443 This leads to non-ideal behaviour when the subprocess has written its final Z
3444 item, closed the pipe, and is in the process of exiting (the common case). A
3445 call to waitpid() yields nothing completed, but select() shows the pipe ready -
3446 reading it yields EOF, so you end up with busy-waiting until the subprocess has
3449 To avoid this, if all the data that is needed has been read from a subprocess
3450 after select(), an explicit wait() for it is done. We know that all it is doing
3451 is writing to the pipe and then exiting, so the wait should not be long.
3453 The non-blocking waitpid() is to some extent just insurance; if we could
3454 reliably detect end-of-file on the pipe, we could always know when to do a
3455 blocking wait() for a completed process. However, because some systems use
3456 NDELAY, which doesn't distinguish between EOF and pipe empty, it is easier to
3457 use code that functions without the need to recognize EOF.
3459 There's a double loop here just in case we end up with a process that is not in
3460 the list of remote delivery processes. Something has obviously gone wrong if
3461 this is the case. (For example, a process that is incorrectly left over from
3462 routing or local deliveries might be found.) The damage can be minimized by
3463 looping back and looking for another process. If there aren't any, the error
3464 return will happen. */
3466 for (;;) /* Normally we do not repeat this loop */
3468 while ((pid = waitpid(-1, &status, WNOHANG)) <= 0)
3471 fd_set select_pipes;
3472 int maxpipe, readycount;
3474 /* A return value of -1 can mean several things. If errno != ECHILD, it
3475 either means invalid options (which we discount), or that this process was
3476 interrupted by a signal. Just loop to try the waitpid() again.
3478 If errno == ECHILD, waitpid() is telling us that there are no subprocesses
3479 in existence. This should never happen, and is an unexpected error.
3480 However, there is a nasty complication when running under Linux. If "strace
3481 -f" is being used under Linux to trace this process and its children,
3482 subprocesses are "stolen" from their parents and become the children of the
3483 tracing process. A general wait such as the one we've just obeyed returns
3484 as if there are no children while subprocesses are running. Once a
3485 subprocess completes, it is restored to the parent, and waitpid(-1) finds
3486 it. Thanks to Joachim Wieland for finding all this out and suggesting a
3489 This does not happen using "truss" on Solaris, nor (I think) with other
3490 tracing facilities on other OS. It seems to be specific to Linux.
3492 What we do to get round this is to use kill() to see if any of our
3493 subprocesses are still in existence. If kill() gives an OK return, we know
3494 it must be for one of our processes - it can't be for a re-use of the pid,
3495 because if our process had finished, waitpid() would have found it. If any
3496 of our subprocesses are in existence, we proceed to use select() as if
3497 waitpid() had returned zero. I think this is safe. */
3501 if (errno != ECHILD) continue; /* Repeats the waitpid() */
3504 debug_printf("waitpid() returned -1/ECHILD: checking explicitly "
3505 "for process existence\n");
3507 for (poffset = 0; poffset < remote_max_parallel; poffset++)
3509 if ((pid = parlist[poffset].pid) != 0 && kill(pid, 0) == 0)
3511 DEBUG(D_deliver) debug_printf("process %d still exists: assume "
3512 "stolen by strace\n", (int)pid);
3513 break; /* With poffset set */
3517 if (poffset >= remote_max_parallel)
3519 DEBUG(D_deliver) debug_printf("*** no delivery children found\n");
3520 return NULL; /* This is the error return */
3524 /* A pid value greater than 0 breaks the "while" loop. A negative value has
3525 been handled above. A return value of zero means that there is at least one
3526 subprocess, but there are no completed subprocesses. See if any pipes are
3527 ready with any data for reading. */
3529 DEBUG(D_deliver) debug_printf("selecting on subprocess pipes\n");
3532 FD_ZERO(&select_pipes);
3533 for (poffset = 0; poffset < remote_max_parallel; poffset++)
3535 if (parlist[poffset].pid != 0)
3537 int fd = parlist[poffset].fd;
3538 FD_SET(fd, &select_pipes);
3539 if (fd > maxpipe) maxpipe = fd;
3543 /* Stick in a 60-second timeout, just in case. */
3548 readycount = select(maxpipe + 1, (SELECT_ARG2_TYPE *)&select_pipes,
3551 /* Scan through the pipes and read any that are ready; use the count
3552 returned by select() to stop when there are no more. Select() can return
3553 with no processes (e.g. if interrupted). This shouldn't matter.
3555 If par_read_pipe() returns TRUE, it means that either the terminating Z was
3556 read, or there was a disaster. In either case, we are finished with this
3557 process. Do an explicit wait() for the process and break the main loop if
3560 It turns out that we have to deal with the case of an interrupted system
3561 call, which can happen on some operating systems if the signal handling is
3562 set up to do that by default. */
3565 readycount > 0 && poffset < remote_max_parallel;
3568 if ((pid = parlist[poffset].pid) != 0 &&
3569 FD_ISSET(parlist[poffset].fd, &select_pipes))
3572 if (par_read_pipe(poffset, FALSE)) /* Finished with this pipe */
3574 for (;;) /* Loop for signals */
3576 pid_t endedpid = waitpid(pid, &status, 0);
3577 if (endedpid == pid) goto PROCESS_DONE;
3578 if (endedpid != (pid_t)(-1) || errno != EINTR)
3579 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Unexpected error return "
3580 "%d (errno = %d) from waitpid() for process %d",
3581 (int)endedpid, errno, (int)pid);
3587 /* Now go back and look for a completed subprocess again. */
3590 /* A completed process was detected by the non-blocking waitpid(). Find the
3591 data block that corresponds to this subprocess. */
3593 for (poffset = 0; poffset < remote_max_parallel; poffset++)
3594 if (pid == parlist[poffset].pid) break;
3596 /* Found the data block; this is a known remote delivery process. We don't
3597 need to repeat the outer loop. This should be what normally happens. */
3599 if (poffset < remote_max_parallel) break;
3601 /* This situation is an error, but it's probably better to carry on looking
3602 for another process than to give up (as we used to do). */
3604 log_write(0, LOG_MAIN|LOG_PANIC, "Process %d finished: not found in remote "
3605 "transport process list", pid);
3606 } /* End of the "for" loop */
3608 /* Come here when all the data was completely read after a select(), and
3609 the process in pid has been wait()ed for. */
3616 debug_printf("remote delivery process %d ended\n", (int)pid);
3618 debug_printf("remote delivery process %d ended: status=%04x\n", (int)pid,
3622 set_process_info("delivering %s", message_id);
3624 /* Get the chain of processed addresses */
3626 addrlist = parlist[poffset].addrlist;
3628 /* If the process did not finish cleanly, record an error and freeze (except
3629 for SIGTERM, SIGKILL and SIGQUIT), and also ensure the journal is not removed,
3630 in case the delivery did actually happen. */
3632 if ((status & 0xffff) != 0)
3635 int msb = (status >> 8) & 255;
3636 int lsb = status & 255;
3637 int code = (msb == 0)? (lsb & 0x7f) : msb;
3639 msg = string_sprintf("%s transport process returned non-zero status 0x%04x: "
3641 addrlist->transport->driver_name,
3643 (msb == 0)? "terminated by signal" : "exit code",
3646 if (msb != 0 || (code != SIGTERM && code != SIGKILL && code != SIGQUIT))
3647 addrlist->special_action = SPECIAL_FREEZE;
3649 for (addr = addrlist; addr != NULL; addr = addr->next)
3651 addr->transport_return = DEFER;
3652 addr->message = msg;
3655 remove_journal = FALSE;
3658 /* Else complete reading the pipe to get the result of the delivery, if all
3659 the data has not yet been obtained. */
3661 else if (!parlist[poffset].done) (void)par_read_pipe(poffset, TRUE);
3663 /* Put the data count and return path into globals, mark the data slot unused,
3664 decrement the count of subprocesses, and return the address chain. */
3666 transport_count = parlist[poffset].transport_count;
3667 used_return_path = parlist[poffset].return_path;
3668 parlist[poffset].pid = 0;
3675 /*************************************************
3676 * Wait for subprocesses and post-process *
3677 *************************************************/
3679 /* This function waits for subprocesses until the number that are still running
3680 is below a given threshold. For each complete subprocess, the addresses are
3681 post-processed. If we can't find a running process, there is some shambles.
3682 Better not bomb out, as that might lead to multiple copies of the message. Just
3683 log and proceed as if all done.
3686 max maximum number of subprocesses to leave running
3687 fallback TRUE if processing fallback hosts
3693 par_reduce(int max, BOOL fallback)
3695 while (parcount > max)
3697 address_item *doneaddr = par_wait();
3698 if (doneaddr == NULL)
3700 log_write(0, LOG_MAIN|LOG_PANIC,
3701 "remote delivery process count got out of step");
3704 else remote_post_process(doneaddr, LOG_MAIN, NULL, fallback);
3712 rmt_dlv_checked_write(int fd, char id, char subid, void * buf, int size)
3714 uschar writebuffer[PIPE_HEADER_SIZE + BIG_BUFFER_SIZE];
3717 /* we assume that size can't get larger then BIG_BUFFER_SIZE which currently is set to 16k */
3718 /* complain to log if someone tries with buffer sizes we can't handle*/
3722 log_write(0, LOG_MAIN|LOG_PANIC_DIE,
3723 "Failed writing transport result to pipe: can't handle buffers > 99999 bytes. truncating!\n");
3727 /* to keep the write() atomic we build header in writebuffer and copy buf behind */
3728 /* two write() calls would increase the complexity of reading from pipe */
3730 /* convert size to human readable string prepended by id and subid */
3731 header_length = snprintf(CS writebuffer, PIPE_HEADER_SIZE+1, "%c%c%05d", id, subid, size);
3732 if (header_length != PIPE_HEADER_SIZE)
3734 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "header snprintf failed\n");
3735 writebuffer[0] = '\0';
3738 DEBUG(D_deliver) debug_printf("header write id:%c,subid:%c,size:%d,final:%s\n",
3739 id, subid, size, writebuffer);
3741 if (buf && size > 0)
3742 memcpy(writebuffer + PIPE_HEADER_SIZE, buf, size);
3744 size += PIPE_HEADER_SIZE;
3745 int ret = write(fd, writebuffer, size);
3747 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Failed writing transport result to pipe: %s\n",
3748 ret == -1 ? strerror(errno) : "short write");
3751 /*************************************************
3752 * Do remote deliveries *
3753 *************************************************/
3755 /* This function is called to process the addresses in addr_remote. We must
3756 pick off the queue all addresses that have the same transport, remote
3757 destination, and errors address, and hand them to the transport in one go,
3758 subject to some configured limitations. If this is a run to continue delivering
3759 to an existing delivery channel, skip all but those addresses that can go to
3760 that channel. The skipped addresses just get deferred.
3762 If mua_wrapper is set, all addresses must be able to be sent in a single
3763 transaction. If not, this function yields FALSE.
3765 In Exim 4, remote deliveries are always done in separate processes, even
3766 if remote_max_parallel = 1 or if there's only one delivery to do. The reason
3767 is so that the base process can retain privilege. This makes the
3768 implementation of fallback transports feasible (though not initially done.)
3770 We create up to the configured number of subprocesses, each of which passes
3771 back the delivery state via a pipe. (However, when sending down an existing
3772 connection, remote_max_parallel is forced to 1.)
3775 fallback TRUE if processing fallback hosts
3777 Returns: TRUE normally
3778 FALSE if mua_wrapper is set and the addresses cannot all be sent
3783 do_remote_deliveries(BOOL fallback)
3789 parcount = 0; /* Number of executing subprocesses */
3791 /* When sending down an existing channel, only do one delivery at a time.
3792 We use a local variable (parmax) to hold the maximum number of processes;
3793 this gets reduced from remote_max_parallel if we can't create enough pipes. */
3795 if (continue_transport != NULL) remote_max_parallel = 1;
3796 parmax = remote_max_parallel;
3798 /* If the data for keeping a list of processes hasn't yet been
3801 if (parlist == NULL)
3803 parlist = store_get(remote_max_parallel * sizeof(pardata));
3804 for (poffset = 0; poffset < remote_max_parallel; poffset++)
3805 parlist[poffset].pid = 0;
3808 /* Now loop for each remote delivery */
3810 for (delivery_count = 0; addr_remote != NULL; delivery_count++)
3816 int address_count = 1;
3817 int address_count_max;
3819 BOOL use_initgroups;
3820 BOOL pipe_done = FALSE;
3821 transport_instance *tp;
3822 address_item **anchor = &addr_remote;
3823 address_item *addr = addr_remote;
3824 address_item *last = addr;
3827 /* Pull the first address right off the list. */
3829 addr_remote = addr->next;
3832 DEBUG(D_deliver|D_transport)
3833 debug_printf("--------> %s <--------\n", addr->address);
3835 /* If no transport has been set, there has been a big screw-up somewhere. */
3837 if ((tp = addr->transport) == NULL)
3839 disable_logging = FALSE; /* Jic */
3840 remote_post_process(addr, LOG_MAIN|LOG_PANIC,
3841 US"No transport set by router", fallback);
3845 /* Check that this base address hasn't previously been delivered to this
3846 transport. The check is necessary at this point to handle homonymic addresses
3847 correctly in cases where the pattern of redirection changes between delivery
3848 attempts. Non-homonymic previous delivery is detected earlier, at routing
3851 if (previously_transported(addr, FALSE)) continue;
3853 /* Force failure if the message is too big. */
3855 if (tp->message_size_limit != NULL)
3857 int rc = check_message_size(tp, addr);
3860 addr->transport_return = rc;
3861 remote_post_process(addr, LOG_MAIN, NULL, fallback);
3866 /* Get the flag which specifies whether the transport can handle different
3867 domains that nevertheless resolve to the same set of hosts. If it needs
3868 expanding, get variables set: $address_data, $domain_data, $localpart_data,
3869 $host, $host_address, $host_port. */
3870 if (tp->expand_multi_domain)
3871 deliver_set_expansions(addr);
3873 if (exp_bool(addr, US"transport", tp->name, D_transport,
3874 US"multi_domain", tp->multi_domain, tp->expand_multi_domain,
3875 &multi_domain) != OK)
3877 deliver_set_expansions(NULL);
3878 remote_post_process(addr, LOG_MAIN|LOG_PANIC, addr->message, fallback);
3882 /* Get the maximum it can handle in one envelope, with zero meaning
3883 unlimited, which is forced for the MUA wrapper case. */
3885 address_count_max = tp->max_addresses;
3886 if (address_count_max == 0 || mua_wrapper) address_count_max = 999999;
3889 /************************************************************************/
3890 /***** This is slightly experimental code, but should be safe. *****/
3892 /* The address_count_max value is the maximum number of addresses that the
3893 transport can send in one envelope. However, the transport must be capable of
3894 dealing with any number of addresses. If the number it gets exceeds its
3895 envelope limitation, it must send multiple copies of the message. This can be
3896 done over a single connection for SMTP, so uses less resources than making
3897 multiple connections. On the other hand, if remote_max_parallel is greater
3898 than one, it is perhaps a good idea to use parallel processing to move the
3899 message faster, even if that results in multiple simultaneous connections to
3902 How can we come to some compromise between these two ideals? What we do is to
3903 limit the number of addresses passed to a single instance of a transport to
3904 the greater of (a) its address limit (rcpt_max for SMTP) and (b) the total
3905 number of addresses routed to remote transports divided by
3906 remote_max_parallel. For example, if the message has 100 remote recipients,
3907 remote max parallel is 2, and rcpt_max is 10, we'd never send more than 50 at
3908 once. But if rcpt_max is 100, we could send up to 100.
3910 Of course, not all the remotely addresses in a message are going to go to the
3911 same set of hosts (except in smarthost configurations), so this is just a
3912 heuristic way of dividing up the work.
3914 Furthermore (1), because this may not be wanted in some cases, and also to
3915 cope with really pathological cases, there is also a limit to the number of
3916 messages that are sent over one connection. This is the same limit that is
3917 used when sending several different messages over the same connection.
3918 Continue_sequence is set when in this situation, to the number sent so
3919 far, including this message.
3921 Furthermore (2), when somebody explicitly sets the maximum value to 1, it
3922 is probably because they are using VERP, in which case they want to pass only
3923 one address at a time to the transport, in order to be able to use
3924 $local_part and $domain in constructing a new return path. We could test for
3925 the use of these variables, but as it is so likely they will be used when the
3926 maximum is 1, we don't bother. Just leave the value alone. */
3928 if (address_count_max != 1 &&
3929 address_count_max < remote_delivery_count/remote_max_parallel)
3931 int new_max = remote_delivery_count/remote_max_parallel;
3932 int message_max = tp->connection_max_messages;
3933 if (connection_max_messages >= 0) message_max = connection_max_messages;
3934 message_max -= continue_sequence - 1;
3935 if (message_max > 0 && new_max > address_count_max * message_max)
3936 new_max = address_count_max * message_max;
3937 address_count_max = new_max;
3940 /************************************************************************/
3943 /* Pick off all addresses which have the same transport, errors address,
3944 destination, and extra headers. In some cases they point to the same host
3945 list, but we also need to check for identical host lists generated from
3946 entirely different domains. The host list pointers can be NULL in the case
3947 where the hosts are defined in the transport. There is also a configured
3948 maximum limit of addresses that can be handled at once (see comments above
3949 for how it is computed).
3950 If the transport does not handle multiple domains, enforce that also,
3951 and if it might need a per-address check for this, re-evaluate it.
3954 while ((next = *anchor) != NULL && address_count < address_count_max)
3957 if ( (multi_domain || Ustrcmp(next->domain, addr->domain) == 0)
3958 && tp == next->transport
3959 && same_hosts(next->host_list, addr->host_list)
3960 && same_strings(next->prop.errors_address, addr->prop.errors_address)
3961 && same_headers(next->prop.extra_headers, addr->prop.extra_headers)
3962 && same_ugid(tp, next, addr)
3963 && ( next->prop.remove_headers == addr->prop.remove_headers
3964 || ( next->prop.remove_headers
3965 && addr->prop.remove_headers
3966 && Ustrcmp(next->prop.remove_headers, addr->prop.remove_headers) == 0
3970 !tp->expand_multi_domain || (deliver_set_expansions(next), 1),
3972 US"transport", next->transport->name, D_transport,
3973 US"multi_domain", next->transport->multi_domain,
3974 next->transport->expand_multi_domain, &md) == OK
3979 *anchor = next->next;
3981 next->first = addr; /* remember top one (for retry processing) */
3986 else anchor = &(next->next);
3987 deliver_set_expansions(NULL);
3990 /* If we are acting as an MUA wrapper, all addresses must go in a single
3991 transaction. If not, put them back on the chain and yield FALSE. */
3993 if (mua_wrapper && addr_remote != NULL)
3995 last->next = addr_remote;
4000 /* Set up the expansion variables for this set of addresses */
4002 deliver_set_expansions(addr);
4004 /* Ensure any transport-set auth info is fresh */
4005 addr->authenticator = addr->auth_id = addr->auth_sndr = NULL;
4007 /* Compute the return path, expanding a new one if required. The old one
4008 must be set first, as it might be referred to in the expansion. */
4010 if(addr->prop.errors_address != NULL)
4011 return_path = addr->prop.errors_address;
4012 #ifdef EXPERIMENTAL_SRS
4013 else if(addr->prop.srs_sender != NULL)
4014 return_path = addr->prop.srs_sender;
4017 return_path = sender_address;
4019 if (tp->return_path != NULL)
4021 uschar *new_return_path = expand_string(tp->return_path);
4022 if (new_return_path == NULL)
4024 if (!expand_string_forcedfail)
4026 remote_post_process(addr, LOG_MAIN|LOG_PANIC,
4027 string_sprintf("Failed to expand return path \"%s\": %s",
4028 tp->return_path, expand_string_message), fallback);
4032 else return_path = new_return_path;
4035 /* Find the uid, gid, and use_initgroups setting for this transport. Failure
4036 logs and sets up error messages, so we just post-process and continue with
4037 the next address. */
4039 if (!findugid(addr, tp, &uid, &gid, &use_initgroups))
4041 remote_post_process(addr, LOG_MAIN|LOG_PANIC, NULL, fallback);
4045 /* If this transport has a setup function, call it now so that it gets
4046 run in this process and not in any subprocess. That way, the results of
4047 any setup that are retained by the transport can be reusable. One of the
4048 things the setup does is to set the fallback host lists in the addresses.
4049 That is why it is called at this point, before the continue delivery
4050 processing, because that might use the fallback hosts. */
4052 if (tp->setup != NULL)
4053 (void)((tp->setup)(addr->transport, addr, NULL, uid, gid, NULL));
4055 /* If this is a run to continue delivery down an already-established
4056 channel, check that this set of addresses matches the transport and
4057 the channel. If it does not, defer the addresses. If a host list exists,
4058 we must check that the continue host is on the list. Otherwise, the
4059 host is set in the transport. */
4061 continue_more = FALSE; /* In case got set for the last lot */
4062 if (continue_transport != NULL)
4064 BOOL ok = Ustrcmp(continue_transport, tp->name) == 0;
4065 if (ok && addr->host_list != NULL)
4069 for (h = addr->host_list; h != NULL; h = h->next)
4071 if (Ustrcmp(h->name, continue_hostname) == 0)
4072 { ok = TRUE; break; }
4076 /* Addresses not suitable; defer or queue for fallback hosts (which
4077 might be the continue host) and skip to next address. */
4081 DEBUG(D_deliver) debug_printf("not suitable for continue_transport\n");
4084 if (addr->fallback_hosts != NULL && !fallback)
4088 next->host_list = next->fallback_hosts;
4089 DEBUG(D_deliver) debug_printf("%s queued for fallback host(s)\n", next->address);
4090 if (next->next == NULL) break;
4093 next->next = addr_fallback;
4094 addr_fallback = addr;
4099 while (next->next != NULL) next = next->next;
4100 next->next = addr_defer;
4107 /* Set a flag indicating whether there are further addresses that list
4108 the continued host. This tells the transport to leave the channel open,
4109 but not to pass it to another delivery process. */
4111 for (next = addr_remote; next != NULL; next = next->next)
4114 for (h = next->host_list; h != NULL; h = h->next)
4116 if (Ustrcmp(h->name, continue_hostname) == 0)
4117 { continue_more = TRUE; break; }
4122 /* The transports set up the process info themselves as they may connect
4123 to more than one remote machine. They also have to set up the filter
4124 arguments, if required, so that the host name and address are available
4127 transport_filter_argv = NULL;
4129 /* Create the pipe for inter-process communication. If pipe creation
4130 fails, it is probably because the value of remote_max_parallel is so
4131 large that too many file descriptors for pipes have been created. Arrange
4132 to wait for a process to finish, and then try again. If we still can't
4133 create a pipe when all processes have finished, break the retry loop. */
4137 if (pipe(pfd) == 0) pipe_done = TRUE;
4138 else if (parcount > 0) parmax = parcount;
4141 /* We need to make the reading end of the pipe non-blocking. There are
4142 two different options for this. Exim is cunningly (I hope!) coded so
4143 that it can use either of them, though it prefers O_NONBLOCK, which
4144 distinguishes between EOF and no-more-data. */
4147 (void)fcntl(pfd[pipe_read], F_SETFL, O_NONBLOCK);
4149 (void)fcntl(pfd[pipe_read], F_SETFL, O_NDELAY);
4152 /* If the maximum number of subprocesses already exist, wait for a process
4153 to finish. If we ran out of file descriptors, parmax will have been reduced
4154 from its initial value of remote_max_parallel. */
4156 par_reduce(parmax - 1, fallback);
4159 /* If we failed to create a pipe and there were no processes to wait
4160 for, we have to give up on this one. Do this outside the above loop
4161 so that we can continue the main loop. */
4165 remote_post_process(addr, LOG_MAIN|LOG_PANIC,
4166 string_sprintf("unable to create pipe: %s", strerror(errno)), fallback);
4170 /* Find a free slot in the pardata list. Must do this after the possible
4171 waiting for processes to finish, because a terminating process will free
4174 for (poffset = 0; poffset < remote_max_parallel; poffset++)
4175 if (parlist[poffset].pid == 0) break;
4177 /* If there isn't one, there has been a horrible disaster. */
4179 if (poffset >= remote_max_parallel)
4181 (void)close(pfd[pipe_write]);
4182 (void)close(pfd[pipe_read]);
4183 remote_post_process(addr, LOG_MAIN|LOG_PANIC,
4184 US"Unexpectedly no free subprocess slot", fallback);
4188 /* Now fork a subprocess to do the remote delivery, but before doing so,
4189 ensure that any cached resourses are released so as not to interfere with
4190 what happens in the subprocess. */
4194 if ((pid = fork()) == 0)
4196 int fd = pfd[pipe_write];
4199 /* Setting this global in the subprocess means we need never clear it */
4200 transport_name = tp->name;
4202 /* There are weird circumstances in which logging is disabled */
4203 disable_logging = tp->disable_logging;
4205 /* Show pids on debug output if parallelism possible */
4207 if (parmax > 1 && (parcount > 0 || addr_remote != NULL))
4209 DEBUG(D_any|D_v) debug_selector |= D_pid;
4210 DEBUG(D_deliver) debug_printf("Remote delivery process started\n");
4213 /* Reset the random number generator, so different processes don't all
4214 have the same sequence. In the test harness we want different, but
4215 predictable settings for each delivery process, so do something explicit
4216 here rather they rely on the fixed reset in the random number function. */
4218 random_seed = running_in_test_harness? 42 + 2*delivery_count : 0;
4220 /* Set close-on-exec on the pipe so that it doesn't get passed on to
4221 a new process that may be forked to do another delivery down the same
4224 (void)fcntl(fd, F_SETFD, fcntl(fd, F_GETFD) | FD_CLOEXEC);
4226 /* Close open file descriptors for the pipes of other processes
4227 that are running in parallel. */
4229 for (poffset = 0; poffset < remote_max_parallel; poffset++)
4230 if (parlist[poffset].pid != 0) (void)close(parlist[poffset].fd);
4232 /* This process has inherited a copy of the file descriptor
4233 for the data file, but its file pointer is shared with all the
4234 other processes running in parallel. Therefore, we have to re-open
4235 the file in order to get a new file descriptor with its own
4236 file pointer. We don't need to lock it, as the lock is held by
4237 the parent process. There doesn't seem to be any way of doing
4238 a dup-with-new-file-pointer. */
4240 (void)close(deliver_datafile);
4241 sprintf(CS spoolname, "%s/input/%s/%s-D", spool_directory, message_subdir,
4243 deliver_datafile = Uopen(spoolname, O_RDWR | O_APPEND, 0);
4245 if (deliver_datafile < 0)
4246 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Failed to reopen %s for remote "
4247 "parallel delivery: %s", spoolname, strerror(errno));
4249 /* Set the close-on-exec flag */
4251 (void)fcntl(deliver_datafile, F_SETFD, fcntl(deliver_datafile, F_GETFD) |
4254 /* Set the uid/gid of this process; bombs out on failure. */
4256 exim_setugid(uid, gid, use_initgroups,
4257 string_sprintf("remote delivery to %s with transport=%s",
4258 addr->address, tp->name));
4260 /* Close the unwanted half of this process' pipe, set the process state,
4261 and run the transport. Afterwards, transport_count will contain the number
4262 of bytes written. */
4264 (void)close(pfd[pipe_read]);
4265 set_process_info("delivering %s using %s", message_id, tp->name);
4266 debug_print_string(tp->debug_string);
4267 if (!(tp->info->code)(addr->transport, addr)) replicate_status(addr);
4269 set_process_info("delivering %s (just run %s for %s%s in subprocess)",
4270 message_id, tp->name, addr->address, (addr->next == NULL)? "" : ", ...");
4272 /* Ensure any cached resources that we used are now released */
4276 /* Pass the result back down the pipe. This is a lot more information
4277 than is needed for a local delivery. We have to send back the error
4278 status for each address, the usability status for each host that is
4279 flagged as unusable, and all the retry items. When TLS is in use, we
4280 send also the cipher and peerdn information. Each type of information
4281 is flagged by an identifying byte, and is then in a fixed format (with
4282 strings terminated by zeros), and there is a final terminator at the
4283 end. The host information and retry information is all attached to
4284 the first address, so that gets sent at the start. */
4286 /* Host unusability information: for most success cases this will
4289 for (h = addr->host_list; h != NULL; h = h->next)
4291 if (h->address == NULL || h->status < hstatus_unusable) continue;
4292 sprintf(CS big_buffer, "%c%c%s", h->status, h->why, h->address);
4293 rmt_dlv_checked_write(fd, 'H', '0', big_buffer, Ustrlen(big_buffer+2) + 3);
4296 /* The number of bytes written. This is the same for each address. Even
4297 if we sent several copies of the message down the same connection, the
4298 size of each one is the same, and it's that value we have got because
4299 transport_count gets reset before calling transport_write_message(). */
4301 memcpy(big_buffer, &transport_count, sizeof(transport_count));
4302 rmt_dlv_checked_write(fd, 'S', '0', big_buffer, sizeof(transport_count));
4304 /* Information about what happened to each address. Four item types are
4305 used: an optional 'X' item first, for TLS information, then an optional "C"
4306 item for any client-auth info followed by 'R' items for any retry settings,
4307 and finally an 'A' item for the remaining data. */
4309 for(; addr != NULL; addr = addr->next)
4314 /* The certificate verification status goes into the flags */
4315 if (tls_out.certificate_verified) setflag(addr, af_cert_verified);
4316 #ifdef EXPERIMENTAL_DANE
4317 if (tls_out.dane_verified) setflag(addr, af_dane_verified);
4320 /* Use an X item only if there's something to send */
4325 sprintf(CS ptr, "%.128s", addr->cipher);
4331 sprintf(CS ptr, "%.512s", addr->peerdn);
4335 rmt_dlv_checked_write(fd, 'X', '1', big_buffer, ptr - big_buffer);
4340 if (!tls_export_cert(ptr, big_buffer_size-2, addr->peercert))
4344 rmt_dlv_checked_write(fd, 'X', '2', big_buffer, ptr - big_buffer);
4349 if (!tls_export_cert(ptr, big_buffer_size-2, addr->ourcert))
4353 rmt_dlv_checked_write(fd, 'X', '3', big_buffer, ptr - big_buffer);
4355 # ifndef DISABLE_OCSP
4356 if (addr->ocsp > OCSP_NOT_REQ)
4359 sprintf(CS ptr, "%c", addr->ocsp + '0');
4361 rmt_dlv_checked_write(fd, 'X', '4', big_buffer, ptr - big_buffer);
4364 #endif /*SUPPORT_TLS*/
4366 if (client_authenticator)
4369 sprintf(CS big_buffer, "%.64s", client_authenticator);
4371 rmt_dlv_checked_write(fd, 'C', '1', big_buffer, ptr - big_buffer);
4373 if (client_authenticated_id)
4376 sprintf(CS big_buffer, "%.64s", client_authenticated_id);
4378 rmt_dlv_checked_write(fd, 'C', '2', big_buffer, ptr - big_buffer);
4380 if (client_authenticated_sender)
4383 sprintf(CS big_buffer, "%.64s", client_authenticated_sender);
4385 rmt_dlv_checked_write(fd, 'C', '3', big_buffer, ptr - big_buffer);
4388 #ifndef DISABLE_PRDR
4389 if (addr->flags & af_prdr_used)
4390 rmt_dlv_checked_write(fd, 'P', '0', NULL, 0);
4393 memcpy(big_buffer, &addr->dsn_aware, sizeof(addr->dsn_aware));
4394 rmt_dlv_checked_write(fd, 'D', '0', big_buffer, sizeof(addr->dsn_aware));
4395 DEBUG(D_deliver) debug_printf("DSN write: addr->dsn_aware = %d\n", addr->dsn_aware);
4397 /* Retry information: for most success cases this will be null. */
4399 for (r = addr->retries; r != NULL; r = r->next)
4402 sprintf(CS big_buffer, "%c%.500s", r->flags, r->key);
4403 ptr = big_buffer + Ustrlen(big_buffer+2) + 3;
4404 memcpy(ptr, &(r->basic_errno), sizeof(r->basic_errno));
4405 ptr += sizeof(r->basic_errno);
4406 memcpy(ptr, &(r->more_errno), sizeof(r->more_errno));
4407 ptr += sizeof(r->more_errno);
4408 if (r->message == NULL) *ptr++ = 0; else
4410 sprintf(CS ptr, "%.512s", r->message);
4413 rmt_dlv_checked_write(fd, 'R', '0', big_buffer, ptr - big_buffer);
4416 /* The rest of the information goes in an 'A' item. */
4418 ptr = big_buffer + 2;
4419 sprintf(CS big_buffer, "%c%c", addr->transport_return,
4420 addr->special_action);
4421 memcpy(ptr, &(addr->basic_errno), sizeof(addr->basic_errno));
4422 ptr += sizeof(addr->basic_errno);
4423 memcpy(ptr, &(addr->more_errno), sizeof(addr->more_errno));
4424 ptr += sizeof(addr->more_errno);
4425 memcpy(ptr, &(addr->flags), sizeof(addr->flags));
4426 ptr += sizeof(addr->flags);
4428 if (addr->message == NULL) *ptr++ = 0; else
4430 sprintf(CS ptr, "%.1024s", addr->message);
4434 if (addr->user_message == NULL) *ptr++ = 0; else
4436 sprintf(CS ptr, "%.1024s", addr->user_message);
4440 if (addr->host_used == NULL) *ptr++ = 0; else
4442 sprintf(CS ptr, "%.256s", addr->host_used->name);
4444 sprintf(CS ptr, "%.64s", addr->host_used->address);
4446 memcpy(ptr, &(addr->host_used->port), sizeof(addr->host_used->port));
4447 ptr += sizeof(addr->host_used->port);
4449 /* DNS lookup status */
4450 *ptr++ = addr->host_used->dnssec==DS_YES ? '2'
4451 : addr->host_used->dnssec==DS_NO ? '1' : '0';
4454 rmt_dlv_checked_write(fd, 'A', '0', big_buffer, ptr - big_buffer);
4457 /* Local interface address/port */
4458 if (log_extra_selector & LX_incoming_interface && sending_ip_address)
4460 uschar * ptr = big_buffer;
4461 sprintf(CS ptr, "%.128s", sending_ip_address);
4463 sprintf(CS ptr, "%d", sending_port);
4466 rmt_dlv_checked_write(fd, 'I', '0', big_buffer, ptr - big_buffer);
4469 /* Add termination flag, close the pipe, and that's it. The character
4470 after 'Z' indicates whether continue_transport is now NULL or not.
4471 A change from non-NULL to NULL indicates a problem with a continuing
4474 big_buffer[0] = (continue_transport == NULL)? '0' : '1';
4475 rmt_dlv_checked_write(fd, 'Z', '0', big_buffer, 1);
4480 /* Back in the mainline: close the unwanted half of the pipe. */
4482 (void)close(pfd[pipe_write]);
4484 /* Fork failed; defer with error message */
4488 (void)close(pfd[pipe_read]);
4489 remote_post_process(addr, LOG_MAIN|LOG_PANIC,
4490 string_sprintf("fork failed for remote delivery to %s: %s",
4491 addr->domain, strerror(errno)), fallback);
4495 /* Fork succeeded; increment the count, and remember relevant data for
4496 when the process finishes. */
4499 parlist[poffset].addrlist = parlist[poffset].addr = addr;
4500 parlist[poffset].pid = pid;
4501 parlist[poffset].fd = pfd[pipe_read];
4502 parlist[poffset].done = FALSE;
4503 parlist[poffset].msg = NULL;
4504 parlist[poffset].return_path = return_path;
4506 /* If the process we've just started is sending a message down an existing
4507 channel, wait for it now. This ensures that only one such process runs at
4508 once, whatever the value of remote_max parallel. Otherwise, we might try to
4509 send two or more messages simultaneously down the same channel. This could
4510 happen if there are different domains that include the same host in otherwise
4511 different host lists.
4513 Also, if the transport closes down the channel, this information gets back
4514 (continue_transport gets set to NULL) before we consider any other addresses
4517 if (continue_transport != NULL) par_reduce(0, fallback);
4519 /* Otherwise, if we are running in the test harness, wait a bit, to let the
4520 newly created process get going before we create another process. This should
4521 ensure repeatability in the tests. We only need to wait a tad. */
4523 else if (running_in_test_harness) millisleep(500);
4526 /* Reached the end of the list of addresses. Wait for all the subprocesses that
4527 are still running and post-process their addresses. */
4529 par_reduce(0, fallback);
4536 /*************************************************
4537 * Split an address into local part and domain *
4538 *************************************************/
4540 /* This function initializes an address for routing by splitting it up into a
4541 local part and a domain. The local part is set up twice - once in its original
4542 casing, and once in lower case, and it is dequoted. We also do the "percent
4543 hack" for configured domains. This may lead to a DEFER result if a lookup
4544 defers. When a percent-hacking takes place, we insert a copy of the original
4545 address as a new parent of this address, as if we have had a redirection.
4548 addr points to an addr_item block containing the address
4551 DEFER - could not determine if domain is %-hackable
4555 deliver_split_address(address_item *addr)
4557 uschar *address = addr->address;
4558 uschar *domain = Ustrrchr(address, '@');
4560 int len = domain - address;
4562 addr->domain = string_copylc(domain+1); /* Domains are always caseless */
4564 /* The implication in the RFCs (though I can't say I've seen it spelled out
4565 explicitly) is that quoting should be removed from local parts at the point
4566 where they are locally interpreted. [The new draft "821" is more explicit on
4567 this, Jan 1999.] We know the syntax is valid, so this can be done by simply
4568 removing quoting backslashes and any unquoted doublequotes. */
4570 t = addr->cc_local_part = store_get(len+1);
4573 register int c = *address++;
4574 if (c == '\"') continue;
4584 /* We do the percent hack only for those domains that are listed in
4585 percent_hack_domains. A loop is required, to copy with multiple %-hacks. */
4587 if (percent_hack_domains != NULL)
4590 uschar *new_address = NULL;
4591 uschar *local_part = addr->cc_local_part;
4593 deliver_domain = addr->domain; /* set $domain */
4595 while ((rc = match_isinlist(deliver_domain, (const uschar **)&percent_hack_domains, 0,
4596 &domainlist_anchor, addr->domain_cache, MCL_DOMAIN, TRUE, NULL))
4598 (t = Ustrrchr(local_part, '%')) != NULL)
4600 new_address = string_copy(local_part);
4601 new_address[t - local_part] = '@';
4602 deliver_domain = string_copylc(t+1);
4603 local_part = string_copyn(local_part, t - local_part);
4606 if (rc == DEFER) return DEFER; /* lookup deferred */
4608 /* If hackery happened, set up new parent and alter the current address. */
4610 if (new_address != NULL)
4612 address_item *new_parent = store_get(sizeof(address_item));
4613 *new_parent = *addr;
4614 addr->parent = new_parent;
4615 addr->address = new_address;
4616 addr->unique = string_copy(new_address);
4617 addr->domain = deliver_domain;
4618 addr->cc_local_part = local_part;
4619 DEBUG(D_deliver) debug_printf("%%-hack changed address to: %s\n",
4624 /* Create the lowercased version of the final local part, and make that the
4625 default one to be used. */
4627 addr->local_part = addr->lc_local_part = string_copylc(addr->cc_local_part);
4634 /*************************************************
4635 * Get next error message text *
4636 *************************************************/
4638 /* If f is not NULL, read the next "paragraph", from a customized error message
4639 text file, terminated by a line containing ****, and expand it.
4642 f NULL or a file to read from
4643 which string indicating which string (for errors)
4645 Returns: NULL or an expanded string
4649 next_emf(FILE *f, uschar *which)
4653 uschar *para, *yield;
4656 if (f == NULL) return NULL;
4658 if (Ufgets(buffer, sizeof(buffer), f) == NULL ||
4659 Ustrcmp(buffer, "****\n") == 0) return NULL;
4661 para = store_get(size);
4664 para = string_cat(para, &size, &ptr, buffer, Ustrlen(buffer));
4665 if (Ufgets(buffer, sizeof(buffer), f) == NULL ||
4666 Ustrcmp(buffer, "****\n") == 0) break;
4670 yield = expand_string(para);
4671 if (yield != NULL) return yield;
4673 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand string from "
4674 "bounce_message_file or warn_message_file (%s): %s", which,
4675 expand_string_message);
4682 /*************************************************
4683 * Close down a passed transport channel *
4684 *************************************************/
4686 /* This function is called when a passed transport channel cannot be used.
4687 It attempts to close it down tidily. The yield is always DELIVER_NOT_ATTEMPTED
4688 so that the function call can be the argument of a "return" statement.
4691 Returns: DELIVER_NOT_ATTEMPTED
4695 continue_closedown(void)
4697 if (continue_transport != NULL)
4699 transport_instance *t;
4700 for (t = transports; t != NULL; t = t->next)
4702 if (Ustrcmp(t->name, continue_transport) == 0)
4704 if (t->info->closedown != NULL) (t->info->closedown)(t);
4709 return DELIVER_NOT_ATTEMPTED;
4715 /*************************************************
4716 * Print address information *
4717 *************************************************/
4719 /* This function is called to output an address, or information about an
4720 address, for bounce or defer messages. If the hide_child flag is set, all we
4721 output is the original ancestor address.
4724 addr points to the address
4725 f the FILE to print to
4726 si an initial string
4727 sc a continuation string for before "generated"
4730 Returns: TRUE if the address is not hidden
4734 print_address_information(address_item *addr, FILE *f, uschar *si, uschar *sc,
4738 uschar *printed = US"";
4739 address_item *ancestor = addr;
4740 while (ancestor->parent != NULL) ancestor = ancestor->parent;
4742 fprintf(f, "%s", CS si);
4744 if (addr->parent != NULL && testflag(addr, af_hide_child))
4746 printed = US"an undisclosed address";
4749 else if (!testflag(addr, af_pfr) || addr->parent == NULL)
4750 printed = addr->address;
4754 uschar *s = addr->address;
4757 if (addr->address[0] == '>') { ss = US"mail"; s++; }
4758 else if (addr->address[0] == '|') ss = US"pipe";
4761 fprintf(f, "%s to %s%sgenerated by ", ss, s, sc);
4762 printed = addr->parent->address;
4765 fprintf(f, "%s", CS string_printing(printed));
4767 if (ancestor != addr)
4769 uschar *original = (ancestor->onetime_parent == NULL)?
4770 ancestor->address : ancestor->onetime_parent;
4771 if (strcmpic(original, printed) != 0)
4772 fprintf(f, "%s(%sgenerated from %s)", sc,
4773 (ancestor != addr->parent)? "ultimately " : "",
4774 string_printing(original));
4777 if (addr->host_used)
4778 fprintf(f, "\n host %s [%s]",
4779 addr->host_used->name, addr->host_used->address);
4781 fprintf(f, "%s", CS se);
4789 /*************************************************
4790 * Print error for an address *
4791 *************************************************/
4793 /* This function is called to print the error information out of an address for
4794 a bounce or a warning message. It tries to format the message reasonably by
4795 introducing newlines. All lines are indented by 4; the initial printing
4796 position must be set before calling.
4798 This function used always to print the error. Nowadays we want to restrict it
4799 to cases such as LMTP/SMTP errors from a remote host, and errors from :fail:
4800 and filter "fail". We no longer pass other information willy-nilly in bounce
4801 and warning messages. Text in user_message is always output; text in message
4802 only if the af_pass_message flag is set.
4806 f the FILE to print on
4813 print_address_error(address_item *addr, FILE *f, uschar *t)
4815 int count = Ustrlen(t);
4816 uschar *s = testflag(addr, af_pass_message)? addr->message : NULL;
4820 if (addr->user_message != NULL) s = addr->user_message; else return;
4823 fprintf(f, "\n %s", t);
4827 if (*s == '\\' && s[1] == 'n')
4837 if (*s++ == ':' && isspace(*s) && count > 45)
4839 fprintf(f, "\n "); /* sic (because space follows) */
4847 /***********************************************************
4848 * Print Diagnostic-Code for an address *
4849 ************************************************************/
4851 /* This function is called to print the error information out of an address for
4852 a bounce or a warning message. It tries to format the message reasonably as
4853 required by RFC 3461 by adding a space after each newline
4855 we assume that this function is only called if addr->host_used is set and if so
4856 a useable addr->message is available containing some Exim description with ": \n"
4857 ending, followed by the L/SMTP error message.
4861 f the FILE to print on
4867 print_dsn_diagnostic_code(const address_item *addr, FILE *f)
4871 /* check host_used, af_pass_message flag and addr->message for safety reasons */
4872 if (!addr->host_used && testflag(addr, af_pass_message) && addr->message)
4875 /* search first ": ". we assume to find the remote-MTA answer there */
4877 debug_printf("DSN Diagnostic-Code: addr->dsn_message = %s\n", addr->message);
4878 if (!(s = Ustrstr(addr->message, ": ")))
4879 return; /* not found, bail out */
4881 fprintf(f, "Diagnostic-Code: smtp; ");
4883 s += 2; /* skip ": " */
4885 if (*s == '\\' && s[1] == 'n')
4887 fputs("\n ", f); /* as defined in RFC 3461 */
4897 /*************************************************
4898 * Check list of addresses for duplication *
4899 *************************************************/
4901 /* This function was introduced when the test for duplicate addresses that are
4902 not pipes, files, or autoreplies was moved from the middle of routing to when
4903 routing was complete. That was to fix obscure cases when the routing history
4904 affects the subsequent routing of identical addresses. This function is called
4905 after routing, to check that the final routed addresses are not duplicates.
4907 If we detect a duplicate, we remember what it is a duplicate of. Note that
4908 pipe, file, and autoreply de-duplication is handled during routing, so we must
4909 leave such "addresses" alone here, as otherwise they will incorrectly be
4912 Argument: address of list anchor
4917 do_duplicate_check(address_item **anchor)
4920 while ((addr = *anchor) != NULL)
4923 if (testflag(addr, af_pfr))
4925 anchor = &(addr->next);
4927 else if ((tnode = tree_search(tree_duplicates, addr->unique)) != NULL)
4929 DEBUG(D_deliver|D_route)
4930 debug_printf("%s is a duplicate address: discarded\n", addr->unique);
4931 *anchor = addr->next;
4932 addr->dupof = tnode->data.ptr;
4933 addr->next = addr_duplicate;
4934 addr_duplicate = addr;
4938 tree_add_duplicate(addr->unique, addr);
4939 anchor = &(addr->next);
4947 /*************************************************
4948 * Deliver one message *
4949 *************************************************/
4951 /* This is the function which is called when a message is to be delivered. It
4952 is passed the id of the message. It is possible that the message no longer
4953 exists, if some other process has delivered it, and it is also possible that
4954 the message is being worked on by another process, in which case the data file
4957 If no delivery is attempted for any of the above reasons, the function returns
4958 DELIVER_NOT_ATTEMPTED.
4960 If the give_up flag is set true, do not attempt any deliveries, but instead
4961 fail all outstanding addresses and return the message to the sender (or
4964 A delivery operation has a process all to itself; we never deliver more than
4965 one message in the same process. Therefore we needn't worry too much about
4969 id the id of the message to be delivered
4970 forced TRUE if delivery was forced by an administrator; this overrides
4971 retry delays and causes a delivery to be tried regardless
4972 give_up TRUE if an administrator has requested that delivery attempts
4975 Returns: When the global variable mua_wrapper is FALSE:
4976 DELIVER_ATTEMPTED_NORMAL if a delivery attempt was made
4977 DELIVER_NOT_ATTEMPTED otherwise (see comment above)
4978 When the global variable mua_wrapper is TRUE:
4979 DELIVER_MUA_SUCCEEDED if delivery succeeded
4980 DELIVER_MUA_FAILED if delivery failed
4981 DELIVER_NOT_ATTEMPTED if not attempted (should not occur)
4985 deliver_message(uschar *id, BOOL forced, BOOL give_up)
4988 int final_yield = DELIVER_ATTEMPTED_NORMAL;
4989 time_t now = time(NULL);
4990 address_item *addr_last = NULL;
4991 uschar *filter_message = NULL;
4993 int process_recipients = RECIP_ACCEPT;
4996 extern int acl_where;
4998 uschar *info = (queue_run_pid == (pid_t)0)?
4999 string_sprintf("delivering %s", id) :
5000 string_sprintf("delivering %s (queue run pid %d)", id, queue_run_pid);
5002 /* If the D_process_info bit is on, set_process_info() will output debugging
5003 information. If not, we want to show this initial information if D_deliver or
5004 D_queue_run is set or in verbose mode. */
5006 set_process_info("%s", info);
5008 if ((debug_selector & D_process_info) == 0 &&
5009 (debug_selector & (D_deliver|D_queue_run|D_v)) != 0)
5010 debug_printf("%s\n", info);
5012 /* Ensure that we catch any subprocesses that are created. Although Exim
5013 sets SIG_DFL as its initial default, some routes through the code end up
5014 here with it set to SIG_IGN - cases where a non-synchronous delivery process
5015 has been forked, but no re-exec has been done. We use sigaction rather than
5016 plain signal() on those OS where SA_NOCLDWAIT exists, because we want to be
5017 sure it is turned off. (There was a problem on AIX with this.) */
5021 struct sigaction act;
5022 act.sa_handler = SIG_DFL;
5023 sigemptyset(&(act.sa_mask));
5025 sigaction(SIGCHLD, &act, NULL);
5028 signal(SIGCHLD, SIG_DFL);
5031 /* Make the forcing flag available for routers and transports, set up the
5032 global message id field, and initialize the count for returned files and the
5033 message size. This use of strcpy() is OK because the length id is checked when
5034 it is obtained from a command line (the -M or -q options), and otherwise it is
5035 known to be a valid message id. */
5037 Ustrcpy(message_id, id);
5038 deliver_force = forced;
5042 /* Initialize some flags */
5044 update_spool = FALSE;
5045 remove_journal = TRUE;
5047 /* Set a known context for any ACLs we call via expansions */
5048 acl_where = ACL_WHERE_DELIVERY;
5050 /* Reset the random number generator, so that if several delivery processes are
5051 started from a queue runner that has already used random numbers (for sorting),
5052 they don't all get the same sequence. */
5056 /* Open and lock the message's data file. Exim locks on this one because the
5057 header file may get replaced as it is re-written during the delivery process.
5058 Any failures cause messages to be written to the log, except for missing files
5059 while queue running - another process probably completed delivery. As part of
5060 opening the data file, message_subdir gets set. */
5062 if (!spool_open_datafile(id))
5063 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5065 /* The value of message_size at this point has been set to the data length,
5066 plus one for the blank line that notionally precedes the data. */
5068 /* Now read the contents of the header file, which will set up the headers in
5069 store, and also the list of recipients and the tree of non-recipients and
5070 assorted flags. It updates message_size. If there is a reading or format error,
5071 give up; if the message has been around for sufficiently long, remove it. */
5073 sprintf(CS spoolname, "%s-H", id);
5074 if ((rc = spool_read_header(spoolname, TRUE, TRUE)) != spool_read_OK)
5076 if (errno == ERRNO_SPOOLFORMAT)
5078 struct stat statbuf;
5079 sprintf(CS big_buffer, "%s/input/%s/%s", spool_directory, message_subdir,
5081 if (Ustat(big_buffer, &statbuf) == 0)
5082 log_write(0, LOG_MAIN, "Format error in spool file %s: "
5083 "size=" OFF_T_FMT, spoolname, statbuf.st_size);
5084 else log_write(0, LOG_MAIN, "Format error in spool file %s", spoolname);
5087 log_write(0, LOG_MAIN, "Error reading spool file %s: %s", spoolname,
5090 /* If we managed to read the envelope data, received_time contains the
5091 time the message was received. Otherwise, we can calculate it from the
5094 if (rc != spool_read_hdrerror)
5097 for (i = 0; i < 6; i++)
5098 received_time = received_time * BASE_62 + tab62[id[i] - '0'];
5101 /* If we've had this malformed message too long, sling it. */
5103 if (now - received_time > keep_malformed)
5105 sprintf(CS spoolname, "%s/msglog/%s/%s", spool_directory, message_subdir, id);
5107 sprintf(CS spoolname, "%s/input/%s/%s-D", spool_directory, message_subdir, id);
5109 sprintf(CS spoolname, "%s/input/%s/%s-H", spool_directory, message_subdir, id);
5111 sprintf(CS spoolname, "%s/input/%s/%s-J", spool_directory, message_subdir, id);
5113 log_write(0, LOG_MAIN, "Message removed because older than %s",
5114 readconf_printtime(keep_malformed));
5117 (void)close(deliver_datafile);
5118 deliver_datafile = -1;
5119 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5122 /* The spool header file has been read. Look to see if there is an existing
5123 journal file for this message. If there is, it means that a previous delivery
5124 attempt crashed (program or host) before it could update the spool header file.
5125 Read the list of delivered addresses from the journal and add them to the
5126 nonrecipients tree. Then update the spool file. We can leave the journal in
5127 existence, as it will get further successful deliveries added to it in this
5128 run, and it will be deleted if this function gets to its end successfully.
5129 Otherwise it might be needed again. */
5131 sprintf(CS spoolname, "%s/input/%s/%s-J", spool_directory, message_subdir, id);
5132 jread = Ufopen(spoolname, "rb");
5135 while (Ufgets(big_buffer, big_buffer_size, jread) != NULL)
5137 int n = Ustrlen(big_buffer);
5138 big_buffer[n-1] = 0;
5139 tree_add_nonrecipient(big_buffer);
5140 DEBUG(D_deliver) debug_printf("Previously delivered address %s taken from "
5141 "journal file\n", big_buffer);
5143 (void)fclose(jread);
5144 /* Panic-dies on error */
5145 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
5147 else if (errno != ENOENT)
5149 log_write(0, LOG_MAIN|LOG_PANIC, "attempt to open journal for reading gave: "
5150 "%s", strerror(errno));
5151 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5154 /* A null recipients list indicates some kind of disaster. */
5156 if (recipients_list == NULL)
5158 (void)close(deliver_datafile);
5159 deliver_datafile = -1;
5160 log_write(0, LOG_MAIN, "Spool error: no recipients for %s", spoolname);
5161 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5165 /* Handle a message that is frozen. There are a number of different things that
5166 can happen, but in the default situation, unless forced, no delivery is
5171 #ifdef SUPPORT_MOVE_FROZEN_MESSAGES
5172 /* Moving to another directory removes the message from Exim's view. Other
5173 tools must be used to deal with it. Logging of this action happens in
5174 spool_move_message() and its subfunctions. */
5176 if (move_frozen_messages &&
5177 spool_move_message(id, message_subdir, US"", US"F"))
5178 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5181 /* For all frozen messages (bounces or not), timeout_frozen_after sets the
5182 maximum time to keep messages that are frozen. Thaw if we reach it, with a
5183 flag causing all recipients to be failed. The time is the age of the
5184 message, not the time since freezing. */
5186 if (timeout_frozen_after > 0 && message_age >= timeout_frozen_after)
5188 log_write(0, LOG_MAIN, "cancelled by timeout_frozen_after");
5189 process_recipients = RECIP_FAIL_TIMEOUT;
5192 /* For bounce messages (and others with no sender), thaw if the error message
5193 ignore timer is exceeded. The message will be discarded if this delivery
5196 else if (sender_address[0] == 0 && message_age >= ignore_bounce_errors_after)
5198 log_write(0, LOG_MAIN, "Unfrozen by errmsg timer");
5201 /* If this is a bounce message, or there's no auto thaw, or we haven't
5202 reached the auto thaw time yet, and this delivery is not forced by an admin
5203 user, do not attempt delivery of this message. Note that forced is set for
5204 continuing messages down the same channel, in order to skip load checking and
5205 ignore hold domains, but we don't want unfreezing in that case. */
5209 if ((sender_address[0] == 0 ||
5211 now <= deliver_frozen_at + auto_thaw
5214 (!forced || !deliver_force_thaw || !admin_user ||
5215 continue_hostname != NULL
5218 (void)close(deliver_datafile);
5219 deliver_datafile = -1;
5220 log_write(L_skip_delivery, LOG_MAIN, "Message is frozen");
5221 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5224 /* If delivery was forced (by an admin user), assume a manual thaw.
5225 Otherwise it's an auto thaw. */
5229 deliver_manual_thaw = TRUE;
5230 log_write(0, LOG_MAIN, "Unfrozen by forced delivery");
5232 else log_write(0, LOG_MAIN, "Unfrozen by auto-thaw");
5235 /* We get here if any of the rules for unfreezing have triggered. */
5237 deliver_freeze = FALSE;
5238 update_spool = TRUE;
5242 /* Open the message log file if we are using them. This records details of
5243 deliveries, deferments, and failures for the benefit of the mail administrator.
5244 The log is not used by exim itself to track the progress of a message; that is
5245 done by rewriting the header spool file. */
5252 sprintf(CS spoolname, "%s/msglog/%s/%s", spool_directory, message_subdir, id);
5253 fd = open_msglog_file(spoolname, SPOOL_MODE, &error);
5257 log_write(0, LOG_MAIN|LOG_PANIC, "Couldn't %s message log %s: %s", error,
5258 spoolname, strerror(errno));
5259 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5262 /* Make a C stream out of it. */
5264 message_log = fdopen(fd, "a");
5265 if (message_log == NULL)
5267 log_write(0, LOG_MAIN|LOG_PANIC, "Couldn't fdopen message log %s: %s",
5268 spoolname, strerror(errno));
5269 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5274 /* If asked to give up on a message, log who did it, and set the action for all
5279 struct passwd *pw = getpwuid(real_uid);
5280 log_write(0, LOG_MAIN, "cancelled by %s", (pw != NULL)?
5281 US pw->pw_name : string_sprintf("uid %ld", (long int)real_uid));
5282 process_recipients = RECIP_FAIL;
5285 /* Otherwise, if there are too many Received: headers, fail all recipients. */
5287 else if (received_count > received_headers_max)
5288 process_recipients = RECIP_FAIL_LOOP;
5290 /* Otherwise, if a system-wide, address-independent message filter is
5291 specified, run it now, except in the case when we are failing all recipients as
5292 a result of timeout_frozen_after. If the system filter yields "delivered", then
5293 ignore the true recipients of the message. Failure of the filter file is
5294 logged, and the delivery attempt fails. */
5296 else if (system_filter != NULL && process_recipients != RECIP_FAIL_TIMEOUT)
5301 redirect_block redirect;
5303 if (system_filter_uid_set)
5305 ugid.uid = system_filter_uid;
5306 ugid.gid = system_filter_gid;
5307 ugid.uid_set = ugid.gid_set = TRUE;
5311 ugid.uid_set = ugid.gid_set = FALSE;
5314 return_path = sender_address;
5315 enable_dollar_recipients = TRUE; /* Permit $recipients in system filter */
5316 system_filtering = TRUE;
5318 /* Any error in the filter file causes a delivery to be abandoned. */
5320 redirect.string = system_filter;
5321 redirect.isfile = TRUE;
5322 redirect.check_owner = redirect.check_group = FALSE;
5323 redirect.owners = NULL;
5324 redirect.owngroups = NULL;
5326 redirect.modemask = 0;
5328 DEBUG(D_deliver|D_filter) debug_printf("running system filter\n");
5331 &redirect, /* Where the data is */
5332 RDO_DEFER | /* Turn on all the enabling options */
5333 RDO_FAIL | /* Leave off all the disabling options */
5338 NULL, /* No :include: restriction (not used in filter) */
5339 NULL, /* No sieve vacation directory (not sieve!) */
5340 NULL, /* No sieve enotify mailto owner (not sieve!) */
5341 NULL, /* No sieve user address (not sieve!) */
5342 NULL, /* No sieve subaddress (not sieve!) */
5343 &ugid, /* uid/gid data */
5344 &addr_new, /* Where to hang generated addresses */
5345 &filter_message, /* Where to put error message */
5346 NULL, /* Don't skip syntax errors */
5347 &filtertype, /* Will always be set to FILTER_EXIM for this call */
5348 US"system filter"); /* For error messages */
5350 DEBUG(D_deliver|D_filter) debug_printf("system filter returned %d\n", rc);
5352 if (rc == FF_ERROR || rc == FF_NONEXIST)
5354 (void)close(deliver_datafile);
5355 deliver_datafile = -1;
5356 log_write(0, LOG_MAIN|LOG_PANIC, "Error in system filter: %s",
5357 string_printing(filter_message));
5358 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5361 /* Reset things. If the filter message is an empty string, which can happen
5362 for a filter "fail" or "freeze" command with no text, reset it to NULL. */
5364 system_filtering = FALSE;
5365 enable_dollar_recipients = FALSE;
5366 if (filter_message != NULL && filter_message[0] == 0) filter_message = NULL;
5368 /* Save the values of the system filter variables so that user filters
5371 memcpy(filter_sn, filter_n, sizeof(filter_sn));
5373 /* The filter can request that delivery of the original addresses be
5378 process_recipients = RECIP_DEFER;
5379 deliver_msglog("Delivery deferred by system filter\n");
5380 log_write(0, LOG_MAIN, "Delivery deferred by system filter");
5383 /* The filter can request that a message be frozen, but this does not
5384 take place if the message has been manually thawed. In that case, we must
5385 unset "delivered", which is forced by the "freeze" command to make -bF
5388 else if (rc == FF_FREEZE && !deliver_manual_thaw)
5390 deliver_freeze = TRUE;
5391 deliver_frozen_at = time(NULL);
5392 process_recipients = RECIP_DEFER;
5393 frozen_info = string_sprintf(" by the system filter%s%s",
5394 (filter_message == NULL)? US"" : US": ",
5395 (filter_message == NULL)? US"" : filter_message);
5398 /* The filter can request that a message be failed. The error message may be
5399 quite long - it is sent back to the sender in the bounce - but we don't want
5400 to fill up the log with repetitions of it. If it starts with << then the text
5401 between << and >> is written to the log, with the rest left for the bounce
5404 else if (rc == FF_FAIL)
5406 uschar *colon = US"";
5407 uschar *logmsg = US"";
5410 process_recipients = RECIP_FAIL_FILTER;
5412 if (filter_message != NULL)
5416 if (filter_message[0] == '<' && filter_message[1] == '<' &&
5417 (logend = Ustrstr(filter_message, ">>")) != NULL)
5419 logmsg = filter_message + 2;
5420 loglen = logend - logmsg;
5421 filter_message = logend + 2;
5422 if (filter_message[0] == 0) filter_message = NULL;
5426 logmsg = filter_message;
5427 loglen = Ustrlen(filter_message);
5431 log_write(0, LOG_MAIN, "cancelled by system filter%s%.*s", colon, loglen,
5435 /* Delivery can be restricted only to those recipients (if any) that the
5436 filter specified. */
5438 else if (rc == FF_DELIVERED)
5440 process_recipients = RECIP_IGNORE;
5441 if (addr_new == NULL)
5442 log_write(0, LOG_MAIN, "=> discarded (system filter)");
5444 log_write(0, LOG_MAIN, "original recipients ignored (system filter)");
5447 /* If any new addresses were created by the filter, fake up a "parent"
5448 for them. This is necessary for pipes, etc., which are expected to have
5449 parents, and it also gives some sensible logging for others. Allow
5450 pipes, files, and autoreplies, and run them as the filter uid if set,
5451 otherwise as the current uid. */
5453 if (addr_new != NULL)
5455 int uid = (system_filter_uid_set)? system_filter_uid : geteuid();
5456 int gid = (system_filter_gid_set)? system_filter_gid : getegid();
5458 /* The text "system-filter" is tested in transport_set_up_command() and in
5459 set_up_shell_command() in the pipe transport, to enable them to permit
5460 $recipients, so don't change it here without also changing it there. */
5462 address_item *p = addr_new;
5463 address_item *parent = deliver_make_addr(US"system-filter", FALSE);
5465 parent->domain = string_copylc(qualify_domain_recipient);
5466 parent->local_part = US"system-filter";
5468 /* As part of this loop, we arrange for addr_last to end up pointing
5469 at the final address. This is used if we go on to add addresses for the
5470 original recipients. */
5474 if (parent->child_count == SHRT_MAX)
5475 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "system filter generated more "
5476 "than %d delivery addresses", SHRT_MAX);
5477 parent->child_count++;
5480 if (testflag(p, af_pfr))
5486 setflag(p, af_uid_set |
5492 /* Find the name of the system filter's appropriate pfr transport */
5494 if (p->address[0] == '|')
5497 tpname = system_filter_pipe_transport;
5498 address_pipe = p->address;
5500 else if (p->address[0] == '>')
5503 tpname = system_filter_reply_transport;
5507 if (p->address[Ustrlen(p->address)-1] == '/')
5509 type = US"directory";
5510 tpname = system_filter_directory_transport;
5515 tpname = system_filter_file_transport;
5517 address_file = p->address;
5520 /* Now find the actual transport, first expanding the name. We have
5521 set address_file or address_pipe above. */
5525 uschar *tmp = expand_string(tpname);
5526 address_file = address_pipe = NULL;
5528 p->message = string_sprintf("failed to expand \"%s\" as a "
5529 "system filter transport name", tpname);
5534 p->message = string_sprintf("system_filter_%s_transport is unset",
5540 transport_instance *tp;
5541 for (tp = transports; tp != NULL; tp = tp->next)
5543 if (Ustrcmp(tp->name, tpname) == 0)
5550 p->message = string_sprintf("failed to find \"%s\" transport "
5551 "for system filter delivery", tpname);
5554 /* If we couldn't set up a transport, defer the delivery, putting the
5555 error on the panic log as well as the main log. */
5557 if (p->transport == NULL)
5559 address_item *badp = p;
5561 if (addr_last == NULL) addr_new = p; else addr_last->next = p;
5562 badp->local_part = badp->address; /* Needed for log line */
5563 post_process_one(badp, DEFER, LOG_MAIN|LOG_PANIC, DTYPE_ROUTER, 0);
5566 } /* End of pfr handling */
5568 /* Either a non-pfr delivery, or we found a transport */
5570 DEBUG(D_deliver|D_filter)
5571 debug_printf("system filter added %s\n", p->address);
5575 } /* Loop through all addr_new addresses */
5580 /* Scan the recipients list, and for every one that is not in the non-
5581 recipients tree, add an addr item to the chain of new addresses. If the pno
5582 value is non-negative, we must set the onetime parent from it. This which
5583 points to the relevant entry in the recipients list.
5585 This processing can be altered by the setting of the process_recipients
5586 variable, which is changed if recipients are to be ignored, failed, or
5587 deferred. This can happen as a result of system filter activity, or if the -Mg
5588 option is used to fail all of them.
5590 Duplicate addresses are handled later by a different tree structure; we can't
5591 just extend the non-recipients tree, because that will be re-written to the
5592 spool if the message is deferred, and in any case there are casing
5593 complications for local addresses. */
5595 if (process_recipients != RECIP_IGNORE)
5597 for (i = 0; i < recipients_count; i++)
5599 if (tree_search(tree_nonrecipients, recipients_list[i].address) == NULL)
5601 recipient_item *r = recipients_list + i;
5602 address_item *new = deliver_make_addr(r->address, FALSE);
5603 new->prop.errors_address = r->errors_to;
5604 #ifdef EXPERIMENTAL_INTERNATIONAL
5605 if ((new->prop.utf8_msg = message_smtputf8))
5607 new->prop.utf8_downcvt = message_utf8_downconvert == 1;
5608 new->prop.utf8_downcvt_maybe = message_utf8_downconvert == -1;
5609 DEBUG(D_deliver) debug_printf("utf8, downconvert %s\n",
5610 new->prop.utf8_downcvt ? "yes"
5611 : new->prop.utf8_downcvt_maybe ? "ifneeded"
5617 new->onetime_parent = recipients_list[r->pno].address;
5619 /* If DSN support is enabled, set the dsn flags and the original receipt
5620 to be passed on to other DSN enabled MTAs */
5621 new->dsn_flags = r->dsn_flags & rf_dsnflags;
5622 new->dsn_orcpt = r->orcpt;
5623 DEBUG(D_deliver) debug_printf("DSN: set orcpt: %s flags: %d\n",
5624 new->dsn_orcpt, new->dsn_flags);
5626 switch (process_recipients)
5628 /* RECIP_DEFER is set when a system filter freezes a message. */
5631 new->next = addr_defer;
5636 /* RECIP_FAIL_FILTER is set when a system filter has obeyed a "fail"
5639 case RECIP_FAIL_FILTER:
5641 (filter_message == NULL)? US"delivery cancelled" : filter_message;
5642 setflag(new, af_pass_message);
5643 goto RECIP_QUEUE_FAILED; /* below */
5646 /* RECIP_FAIL_TIMEOUT is set when a message is frozen, but is older
5647 than the value in timeout_frozen_after. Treat non-bounce messages
5648 similarly to -Mg; for bounce messages we just want to discard, so
5649 don't put the address on the failed list. The timeout has already
5652 case RECIP_FAIL_TIMEOUT:
5653 new->message = US"delivery cancelled; message timed out";
5654 goto RECIP_QUEUE_FAILED; /* below */
5657 /* RECIP_FAIL is set when -Mg has been used. */
5660 new->message = US"delivery cancelled by administrator";
5663 /* Common code for the failure cases above. If this is not a bounce
5664 message, put the address on the failed list so that it is used to
5665 create a bounce. Otherwise do nothing - this just discards the address.
5666 The incident has already been logged. */
5669 if (sender_address[0] != 0)
5671 new->next = addr_failed;
5677 /* RECIP_FAIL_LOOP is set when there are too many Received: headers
5678 in the message. Process each address as a routing failure; if this
5679 is a bounce message, it will get frozen. */
5681 case RECIP_FAIL_LOOP:
5682 new->message = US"Too many \"Received\" headers - suspected mail loop";
5683 post_process_one(new, FAIL, LOG_MAIN, DTYPE_ROUTER, 0);
5687 /* Value should be RECIP_ACCEPT; take this as the safe default. */
5690 if (addr_new == NULL) addr_new = new; else addr_last->next = new;
5695 #ifdef EXPERIMENTAL_EVENT
5696 if (process_recipients != RECIP_ACCEPT)
5698 uschar * save_local = deliver_localpart;
5699 const uschar * save_domain = deliver_domain;
5701 deliver_localpart = expand_string(
5702 string_sprintf("${local_part:%s}", new->address));
5703 deliver_domain = expand_string(
5704 string_sprintf("${domain:%s}", new->address));
5706 (void) event_raise(event_action,
5707 US"msg:fail:internal", new->message);
5709 deliver_localpart = save_local;
5710 deliver_domain = save_domain;
5719 address_item *p = addr_new;
5720 debug_printf("Delivery address list:\n");
5723 debug_printf(" %s %s\n", p->address, (p->onetime_parent == NULL)? US"" :
5729 /* Set up the buffers used for copying over the file when delivering. */
5731 deliver_in_buffer = store_malloc(DELIVER_IN_BUFFER_SIZE);
5732 deliver_out_buffer = store_malloc(DELIVER_OUT_BUFFER_SIZE);
5736 /* Until there are no more new addresses, handle each one as follows:
5738 . If this is a generated address (indicated by the presence of a parent
5739 pointer) then check to see whether it is a pipe, file, or autoreply, and
5740 if so, handle it directly here. The router that produced the address will
5741 have set the allow flags into the address, and also set the uid/gid required.
5742 Having the routers generate new addresses and then checking them here at
5743 the outer level is tidier than making each router do the checking, and
5744 means that routers don't need access to the failed address queue.
5746 . Break up the address into local part and domain, and make lowercased
5747 versions of these strings. We also make unquoted versions of the local part.
5749 . Handle the percent hack for those domains for which it is valid.
5751 . For child addresses, determine if any of the parents have the same address.
5752 If so, generate a different string for previous delivery checking. Without
5753 this code, if the address spqr generates spqr via a forward or alias file,
5754 delivery of the generated spqr stops further attempts at the top level spqr,
5755 which is not what is wanted - it may have generated other addresses.
5757 . Check on the retry database to see if routing was previously deferred, but
5758 only if in a queue run. Addresses that are to be routed are put on the
5759 addr_route chain. Addresses that are to be deferred are put on the
5760 addr_defer chain. We do all the checking first, so as not to keep the
5761 retry database open any longer than necessary.
5763 . Now we run the addresses through the routers. A router may put the address
5764 on either the addr_local or the addr_remote chain for local or remote
5765 delivery, respectively, or put it on the addr_failed chain if it is
5766 undeliveable, or it may generate child addresses and put them on the
5767 addr_new chain, or it may defer an address. All the chain anchors are
5768 passed as arguments so that the routers can be called for verification
5771 . If new addresses have been generated by the routers, da capo.
5774 header_rewritten = FALSE; /* No headers rewritten yet */
5775 while (addr_new != NULL) /* Loop until all addresses dealt with */
5777 address_item *addr, *parent;
5778 dbm_file = dbfn_open(US"retry", O_RDONLY, &dbblock, FALSE);
5780 /* Failure to open the retry database is treated the same as if it does
5781 not exist. In both cases, dbm_file is NULL. */
5783 if (dbm_file == NULL)
5785 DEBUG(D_deliver|D_retry|D_route|D_hints_lookup)
5786 debug_printf("no retry data available\n");
5789 /* Scan the current batch of new addresses, to handle pipes, files and
5790 autoreplies, and determine which others are ready for routing. */
5792 while (addr_new != NULL)
5797 dbdata_retry *domain_retry_record;
5798 dbdata_retry *address_retry_record;
5801 addr_new = addr->next;
5803 DEBUG(D_deliver|D_retry|D_route)
5805 debug_printf(">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>\n");
5806 debug_printf("Considering: %s\n", addr->address);
5809 /* Handle generated address that is a pipe or a file or an autoreply. */
5811 if (testflag(addr, af_pfr))
5813 /* If an autoreply in a filter could not generate a syntactically valid
5814 address, give up forthwith. Set af_ignore_error so that we don't try to
5815 generate a bounce. */
5817 if (testflag(addr, af_bad_reply))
5819 addr->basic_errno = ERRNO_BADADDRESS2;
5820 addr->local_part = addr->address;
5822 US"filter autoreply generated syntactically invalid recipient";
5823 setflag(addr, af_ignore_error);
5824 (void)post_process_one(addr, FAIL, LOG_MAIN, DTYPE_ROUTER, 0);
5825 continue; /* with the next new address */
5828 /* If two different users specify delivery to the same pipe or file or
5829 autoreply, there should be two different deliveries, so build a unique
5830 string that incorporates the original address, and use this for
5831 duplicate testing and recording delivery, and also for retrying. */
5834 string_sprintf("%s:%s", addr->address, addr->parent->unique +
5835 (testflag(addr->parent, af_homonym)? 3:0));
5837 addr->address_retry_key = addr->domain_retry_key =
5838 string_sprintf("T:%s", addr->unique);
5840 /* If a filter file specifies two deliveries to the same pipe or file,
5841 we want to de-duplicate, but this is probably not wanted for two mail
5842 commands to the same address, where probably both should be delivered.
5843 So, we have to invent a different unique string in that case. Just
5844 keep piling '>' characters on the front. */
5846 if (addr->address[0] == '>')
5848 while (tree_search(tree_duplicates, addr->unique) != NULL)
5849 addr->unique = string_sprintf(">%s", addr->unique);
5852 else if ((tnode = tree_search(tree_duplicates, addr->unique)) != NULL)
5854 DEBUG(D_deliver|D_route)
5855 debug_printf("%s is a duplicate address: discarded\n", addr->address);
5856 addr->dupof = tnode->data.ptr;
5857 addr->next = addr_duplicate;
5858 addr_duplicate = addr;
5862 DEBUG(D_deliver|D_route) debug_printf("unique = %s\n", addr->unique);
5864 /* Check for previous delivery */
5866 if (tree_search(tree_nonrecipients, addr->unique) != NULL)
5868 DEBUG(D_deliver|D_route)
5869 debug_printf("%s was previously delivered: discarded\n", addr->address);
5870 child_done(addr, tod_stamp(tod_log));
5874 /* Save for checking future duplicates */
5876 tree_add_duplicate(addr->unique, addr);
5878 /* Set local part and domain */
5880 addr->local_part = addr->address;
5881 addr->domain = addr->parent->domain;
5883 /* Ensure that the delivery is permitted. */
5885 if (testflag(addr, af_file))
5887 if (!testflag(addr, af_allow_file))
5889 addr->basic_errno = ERRNO_FORBIDFILE;
5890 addr->message = US"delivery to file forbidden";
5891 (void)post_process_one(addr, FAIL, LOG_MAIN, DTYPE_ROUTER, 0);
5892 continue; /* with the next new address */
5895 else if (addr->address[0] == '|')
5897 if (!testflag(addr, af_allow_pipe))
5899 addr->basic_errno = ERRNO_FORBIDPIPE;
5900 addr->message = US"delivery to pipe forbidden";
5901 (void)post_process_one(addr, FAIL, LOG_MAIN, DTYPE_ROUTER, 0);
5902 continue; /* with the next new address */
5905 else if (!testflag(addr, af_allow_reply))
5907 addr->basic_errno = ERRNO_FORBIDREPLY;
5908 addr->message = US"autoreply forbidden";
5909 (void)post_process_one(addr, FAIL, LOG_MAIN, DTYPE_ROUTER, 0);
5910 continue; /* with the next new address */
5913 /* If the errno field is already set to BADTRANSPORT, it indicates
5914 failure to expand a transport string, or find the associated transport,
5915 or an unset transport when one is required. Leave this test till now so
5916 that the forbid errors are given in preference. */
5918 if (addr->basic_errno == ERRNO_BADTRANSPORT)
5920 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_ROUTER, 0);
5924 /* Treat /dev/null as a special case and abandon the delivery. This
5925 avoids having to specify a uid on the transport just for this case.
5926 Arrange for the transport name to be logged as "**bypassed**". */
5928 if (Ustrcmp(addr->address, "/dev/null") == 0)
5930 uschar *save = addr->transport->name;
5931 addr->transport->name = US"**bypassed**";
5932 (void)post_process_one(addr, OK, LOG_MAIN, DTYPE_TRANSPORT, '=');
5933 addr->transport->name = save;
5934 continue; /* with the next new address */
5937 /* Pipe, file, or autoreply delivery is to go ahead as a normal local
5940 DEBUG(D_deliver|D_route)
5941 debug_printf("queued for %s transport\n", addr->transport->name);
5942 addr->next = addr_local;
5944 continue; /* with the next new address */
5947 /* Handle normal addresses. First, split up into local part and domain,
5948 handling the %-hack if necessary. There is the possibility of a defer from
5949 a lookup in percent_hack_domains. */
5951 if ((rc = deliver_split_address(addr)) == DEFER)
5953 addr->message = US"cannot check percent_hack_domains";
5954 addr->basic_errno = ERRNO_LISTDEFER;
5955 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_NONE, 0);
5959 /* Check to see if the domain is held. If so, proceed only if the
5960 delivery was forced by hand. */
5962 deliver_domain = addr->domain; /* set $domain */
5963 if (!forced && hold_domains != NULL &&
5964 (rc = match_isinlist(addr->domain, (const uschar **)&hold_domains, 0,
5965 &domainlist_anchor, addr->domain_cache, MCL_DOMAIN, TRUE,
5970 addr->message = US"hold_domains lookup deferred";
5971 addr->basic_errno = ERRNO_LISTDEFER;
5975 addr->message = US"domain is held";
5976 addr->basic_errno = ERRNO_HELD;
5978 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_NONE, 0);
5982 /* Now we can check for duplicates and previously delivered addresses. In
5983 order to do this, we have to generate a "unique" value for each address,
5984 because there may be identical actual addresses in a line of descendents.
5985 The "unique" field is initialized to the same value as the "address" field,
5986 but gets changed here to cope with identically-named descendents. */
5988 for (parent = addr->parent; parent != NULL; parent = parent->parent)
5989 if (strcmpic(addr->address, parent->address) == 0) break;
5991 /* If there's an ancestor with the same name, set the homonym flag. This
5992 influences how deliveries are recorded. Then add a prefix on the front of
5993 the unique address. We use \n\ where n starts at 0 and increases each time.
5994 It is unlikely to pass 9, but if it does, it may look odd but will still
5995 work. This means that siblings or cousins with the same names are treated
5996 as duplicates, which is what we want. */
6000 setflag(addr, af_homonym);
6001 if (parent->unique[0] != '\\')
6002 addr->unique = string_sprintf("\\0\\%s", addr->address);
6004 addr->unique = string_sprintf("\\%c\\%s", parent->unique[1] + 1,
6008 /* Ensure that the domain in the unique field is lower cased, because
6009 domains are always handled caselessly. */
6011 p = Ustrrchr(addr->unique, '@');
6012 while (*p != 0) { *p = tolower(*p); p++; }
6014 DEBUG(D_deliver|D_route) debug_printf("unique = %s\n", addr->unique);
6016 if (tree_search(tree_nonrecipients, addr->unique) != NULL)
6018 DEBUG(D_deliver|D_route)
6019 debug_printf("%s was previously delivered: discarded\n", addr->unique);
6020 child_done(addr, tod_stamp(tod_log));
6024 /* Get the routing retry status, saving the two retry keys (with and
6025 without the local part) for subsequent use. If there is no retry record for
6026 the standard address routing retry key, we look for the same key with the
6027 sender attached, because this form is used by the smtp transport after a
6028 4xx response to RCPT when address_retry_include_sender is true. */
6030 addr->domain_retry_key = string_sprintf("R:%s", addr->domain);
6031 addr->address_retry_key = string_sprintf("R:%s@%s", addr->local_part,
6034 if (dbm_file == NULL)
6035 domain_retry_record = address_retry_record = NULL;
6038 domain_retry_record = dbfn_read(dbm_file, addr->domain_retry_key);
6039 if (domain_retry_record != NULL &&
6040 now - domain_retry_record->time_stamp > retry_data_expire)
6041 domain_retry_record = NULL; /* Ignore if too old */
6043 address_retry_record = dbfn_read(dbm_file, addr->address_retry_key);
6044 if (address_retry_record != NULL &&
6045 now - address_retry_record->time_stamp > retry_data_expire)
6046 address_retry_record = NULL; /* Ignore if too old */
6048 if (address_retry_record == NULL)
6050 uschar *altkey = string_sprintf("%s:<%s>", addr->address_retry_key,
6052 address_retry_record = dbfn_read(dbm_file, altkey);
6053 if (address_retry_record != NULL &&
6054 now - address_retry_record->time_stamp > retry_data_expire)
6055 address_retry_record = NULL; /* Ignore if too old */
6059 DEBUG(D_deliver|D_retry)
6061 if (domain_retry_record == NULL)
6062 debug_printf("no domain retry record\n");
6063 if (address_retry_record == NULL)
6064 debug_printf("no address retry record\n");
6067 /* If we are sending a message down an existing SMTP connection, we must
6068 assume that the message which created the connection managed to route
6069 an address to that connection. We do not want to run the risk of taking
6070 a long time over routing here, because if we do, the server at the other
6071 end of the connection may time it out. This is especially true for messages
6072 with lots of addresses. For this kind of delivery, queue_running is not
6073 set, so we would normally route all addresses. We take a pragmatic approach
6074 and defer routing any addresses that have any kind of domain retry record.
6075 That is, we don't even look at their retry times. It doesn't matter if this
6076 doesn't work occasionally. This is all just an optimization, after all.
6078 The reason for not doing the same for address retries is that they normally
6079 arise from 4xx responses, not DNS timeouts. */
6081 if (continue_hostname != NULL && domain_retry_record != NULL)
6083 addr->message = US"reusing SMTP connection skips previous routing defer";
6084 addr->basic_errno = ERRNO_RRETRY;
6085 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_ROUTER, 0);
6088 /* If we are in a queue run, defer routing unless there is no retry data or
6089 we've passed the next retry time, or this message is forced. In other
6090 words, ignore retry data when not in a queue run.
6092 However, if the domain retry time has expired, always allow the routing
6093 attempt. If it fails again, the address will be failed. This ensures that
6094 each address is routed at least once, even after long-term routing
6097 If there is an address retry, check that too; just wait for the next
6098 retry time. This helps with the case when the temporary error on the
6099 address was really message-specific rather than address specific, since
6100 it allows other messages through.
6102 We also wait for the next retry time if this is a message sent down an
6103 existing SMTP connection (even though that will be forced). Otherwise there
6104 will be far too many attempts for an address that gets a 4xx error. In
6105 fact, after such an error, we should not get here because, the host should
6106 not be remembered as one this message needs. However, there was a bug that
6107 used to cause this to happen, so it is best to be on the safe side.
6109 Even if we haven't reached the retry time in the hints, there is one more
6110 check to do, which is for the ultimate address timeout. We only do this
6111 check if there is an address retry record and there is not a domain retry
6112 record; this implies that previous attempts to handle the address had the
6113 retry_use_local_parts option turned on. We use this as an approximation
6114 for the destination being like a local delivery, for example delivery over
6115 LMTP to an IMAP message store. In this situation users are liable to bump
6116 into their quota and thereby have intermittently successful deliveries,
6117 which keep the retry record fresh, which can lead to us perpetually
6118 deferring messages. */
6120 else if (((queue_running && !deliver_force) || continue_hostname != NULL)
6122 ((domain_retry_record != NULL &&
6123 now < domain_retry_record->next_try &&
6124 !domain_retry_record->expired)
6126 (address_retry_record != NULL &&
6127 now < address_retry_record->next_try))
6129 (domain_retry_record != NULL ||
6130 address_retry_record == NULL ||
6131 !retry_ultimate_address_timeout(addr->address_retry_key,
6132 addr->domain, address_retry_record, now)))
6134 addr->message = US"retry time not reached";
6135 addr->basic_errno = ERRNO_RRETRY;
6136 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_ROUTER, 0);
6139 /* The domain is OK for routing. Remember if retry data exists so it
6140 can be cleaned up after a successful delivery. */
6144 if (domain_retry_record != NULL || address_retry_record != NULL)
6145 setflag(addr, af_dr_retry_exists);
6146 addr->next = addr_route;
6148 DEBUG(D_deliver|D_route)
6149 debug_printf("%s: queued for routing\n", addr->address);
6153 /* The database is closed while routing is actually happening. Requests to
6154 update it are put on a chain and all processed together at the end. */
6156 if (dbm_file != NULL) dbfn_close(dbm_file);
6158 /* If queue_domains is set, we don't even want to try routing addresses in
6159 those domains. During queue runs, queue_domains is forced to be unset.
6160 Optimize by skipping this pass through the addresses if nothing is set. */
6162 if (!deliver_force && queue_domains != NULL)
6164 address_item *okaddr = NULL;
6165 while (addr_route != NULL)
6167 address_item *addr = addr_route;
6168 addr_route = addr->next;
6170 deliver_domain = addr->domain; /* set $domain */
6171 if ((rc = match_isinlist(addr->domain, (const uschar **)&queue_domains, 0,
6172 &domainlist_anchor, addr->domain_cache, MCL_DOMAIN, TRUE, NULL))
6177 addr->basic_errno = ERRNO_LISTDEFER;
6178 addr->message = US"queue_domains lookup deferred";
6179 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_ROUTER, 0);
6183 addr->next = okaddr;
6189 addr->basic_errno = ERRNO_QUEUE_DOMAIN;
6190 addr->message = US"domain is in queue_domains";
6191 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_ROUTER, 0);
6195 addr_route = okaddr;
6198 /* Now route those addresses that are not deferred. */
6200 while (addr_route != NULL)
6203 address_item *addr = addr_route;
6204 const uschar *old_domain = addr->domain;
6205 uschar *old_unique = addr->unique;
6206 addr_route = addr->next;
6209 /* Just in case some router parameter refers to it. */
6211 return_path = (addr->prop.errors_address != NULL)?
6212 addr->prop.errors_address : sender_address;
6214 /* If a router defers an address, add a retry item. Whether or not to
6215 use the local part in the key is a property of the router. */
6217 if ((rc = route_address(addr, &addr_local, &addr_remote, &addr_new,
6218 &addr_succeed, v_none)) == DEFER)
6219 retry_add_item(addr, (addr->router->retry_use_local_part)?
6220 string_sprintf("R:%s@%s", addr->local_part, addr->domain) :
6221 string_sprintf("R:%s", addr->domain), 0);
6223 /* Otherwise, if there is an existing retry record in the database, add
6224 retry items to delete both forms. We must also allow for the possibility
6225 of a routing retry that includes the sender address. Since the domain might
6226 have been rewritten (expanded to fully qualified) as a result of routing,
6227 ensure that the rewritten form is also deleted. */
6229 else if (testflag(addr, af_dr_retry_exists))
6231 uschar *altkey = string_sprintf("%s:<%s>", addr->address_retry_key,
6233 retry_add_item(addr, altkey, rf_delete);
6234 retry_add_item(addr, addr->address_retry_key, rf_delete);
6235 retry_add_item(addr, addr->domain_retry_key, rf_delete);
6236 if (Ustrcmp(addr->domain, old_domain) != 0)
6237 retry_add_item(addr, string_sprintf("R:%s", old_domain), rf_delete);
6240 /* DISCARD is given for :blackhole: and "seen finish". The event has been
6241 logged, but we need to ensure the address (and maybe parents) is marked
6246 address_done(addr, tod_stamp(tod_log));
6247 continue; /* route next address */
6250 /* The address is finished with (failed or deferred). */
6254 (void)post_process_one(addr, rc, LOG_MAIN, DTYPE_ROUTER, 0);
6255 continue; /* route next address */
6258 /* The address has been routed. If the router changed the domain, it will
6259 also have changed the unique address. We have to test whether this address
6260 has already been delivered, because it's the unique address that finally
6263 if (addr->unique != old_unique &&
6264 tree_search(tree_nonrecipients, addr->unique) != 0)
6266 DEBUG(D_deliver|D_route) debug_printf("%s was previously delivered: "
6267 "discarded\n", addr->address);
6268 if (addr_remote == addr) addr_remote = addr->next;
6269 else if (addr_local == addr) addr_local = addr->next;
6272 /* If the router has same_domain_copy_routing set, we are permitted to copy
6273 the routing for any other addresses with the same domain. This is an
6274 optimisation to save repeated DNS lookups for "standard" remote domain
6275 routing. The option is settable only on routers that generate host lists.
6276 We play it very safe, and do the optimization only if the address is routed
6277 to a remote transport, there are no header changes, and the domain was not
6278 modified by the router. */
6280 if (addr_remote == addr &&
6281 addr->router->same_domain_copy_routing &&
6282 addr->prop.extra_headers == NULL &&
6283 addr->prop.remove_headers == NULL &&
6284 old_domain == addr->domain)
6286 address_item **chain = &addr_route;
6287 while (*chain != NULL)
6289 address_item *addr2 = *chain;
6290 if (Ustrcmp(addr2->domain, addr->domain) != 0)
6292 chain = &(addr2->next);
6296 /* Found a suitable address; take it off the routing list and add it to
6297 the remote delivery list. */
6299 *chain = addr2->next;
6300 addr2->next = addr_remote;
6301 addr_remote = addr2;
6303 /* Copy the routing data */
6305 addr2->domain = addr->domain;
6306 addr2->router = addr->router;
6307 addr2->transport = addr->transport;
6308 addr2->host_list = addr->host_list;
6309 addr2->fallback_hosts = addr->fallback_hosts;
6310 addr2->prop.errors_address = addr->prop.errors_address;
6311 copyflag(addr2, addr, af_hide_child | af_local_host_removed);
6313 DEBUG(D_deliver|D_route)
6315 debug_printf(">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>\n"
6317 "Routing for %s copied from %s\n",
6318 addr2->address, addr2->address, addr->address);
6322 } /* Continue with routing the next address. */
6323 } /* Loop to process any child addresses that the routers created, and
6324 any rerouted addresses that got put back on the new chain. */
6327 /* Debugging: show the results of the routing */
6329 DEBUG(D_deliver|D_retry|D_route)
6331 address_item *p = addr_local;
6332 debug_printf(">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>\n");
6333 debug_printf("After routing:\n Local deliveries:\n");
6336 debug_printf(" %s\n", p->address);
6341 debug_printf(" Remote deliveries:\n");
6344 debug_printf(" %s\n", p->address);
6349 debug_printf(" Failed addresses:\n");
6352 debug_printf(" %s\n", p->address);
6357 debug_printf(" Deferred addresses:\n");
6360 debug_printf(" %s\n", p->address);
6365 /* Free any resources that were cached during routing. */
6370 /* These two variables are set only during routing, after check_local_user.
6371 Ensure they are not set in transports. */
6373 local_user_gid = (gid_t)(-1);
6374 local_user_uid = (uid_t)(-1);
6376 /* Check for any duplicate addresses. This check is delayed until after
6377 routing, because the flexibility of the routing configuration means that
6378 identical addresses with different parentage may end up being redirected to
6379 different addresses. Checking for duplicates too early (as we previously used
6380 to) makes this kind of thing not work. */
6382 do_duplicate_check(&addr_local);
6383 do_duplicate_check(&addr_remote);
6385 /* When acting as an MUA wrapper, we proceed only if all addresses route to a
6386 remote transport. The check that they all end up in one transaction happens in
6387 the do_remote_deliveries() function. */
6389 if (mua_wrapper && (addr_local != NULL || addr_failed != NULL ||
6390 addr_defer != NULL))
6393 uschar *which, *colon, *msg;
6395 if (addr_local != NULL)
6400 else if (addr_defer != NULL)
6403 which = US"deferred";
6411 while (addr->parent != NULL) addr = addr->parent;
6413 if (addr->message != NULL)
6416 msg = addr->message;
6418 else colon = msg = US"";
6420 /* We don't need to log here for a forced failure as it will already
6421 have been logged. Defer will also have been logged, but as a defer, so we do
6422 need to do the failure logging. */
6424 if (addr != addr_failed)
6425 log_write(0, LOG_MAIN, "** %s routing yielded a %s delivery",
6426 addr->address, which);
6428 /* Always write an error to the caller */
6430 fprintf(stderr, "routing %s yielded a %s delivery%s%s\n", addr->address,
6433 final_yield = DELIVER_MUA_FAILED;
6434 addr_failed = addr_defer = NULL; /* So that we remove the message */
6435 goto DELIVERY_TIDYUP;
6439 /* If this is a run to continue deliveries to an external channel that is
6440 already set up, defer any local deliveries. */
6442 if (continue_transport != NULL)
6444 if (addr_defer == NULL) addr_defer = addr_local; else
6446 address_item *addr = addr_defer;
6447 while (addr->next != NULL) addr = addr->next;
6448 addr->next = addr_local;
6454 /* Because address rewriting can happen in the routers, we should not really do
6455 ANY deliveries until all addresses have been routed, so that all recipients of
6456 the message get the same headers. However, this is in practice not always
6457 possible, since sometimes remote addresses give DNS timeouts for days on end.
6458 The pragmatic approach is to deliver what we can now, saving any rewritten
6459 headers so that at least the next lot of recipients benefit from the rewriting
6460 that has already been done.
6462 If any headers have been rewritten during routing, update the spool file to
6463 remember them for all subsequent deliveries. This can be delayed till later if
6464 there is only address to be delivered - if it succeeds the spool write need not
6467 if (header_rewritten &&
6468 ((addr_local != NULL &&
6469 (addr_local->next != NULL || addr_remote != NULL)) ||
6470 (addr_remote != NULL && addr_remote->next != NULL)))
6472 /* Panic-dies on error */
6473 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
6474 header_rewritten = FALSE;
6478 /* If there are any deliveries to be done, open the journal file. This is used
6479 to record successful deliveries as soon as possible after each delivery is
6480 known to be complete. A file opened with O_APPEND is used so that several
6481 processes can run simultaneously.
6483 The journal is just insurance against crashes. When the spool file is
6484 ultimately updated at the end of processing, the journal is deleted. If a
6485 journal is found to exist at the start of delivery, the addresses listed
6486 therein are added to the non-recipients. */
6488 if (addr_local != NULL || addr_remote != NULL)
6490 sprintf(CS spoolname, "%s/input/%s/%s-J", spool_directory, message_subdir, id);
6491 journal_fd = Uopen(spoolname, O_WRONLY|O_APPEND|O_CREAT, SPOOL_MODE);
6495 log_write(0, LOG_MAIN|LOG_PANIC, "Couldn't open journal file %s: %s",
6496 spoolname, strerror(errno));
6497 return DELIVER_NOT_ATTEMPTED;
6500 /* Set the close-on-exec flag, make the file owned by Exim, and ensure
6501 that the mode is correct - the group setting doesn't always seem to get
6502 set automatically. */
6504 if( fcntl(journal_fd, F_SETFD, fcntl(journal_fd, F_GETFD) | FD_CLOEXEC)
6505 || fchown(journal_fd, exim_uid, exim_gid)
6506 || fchmod(journal_fd, SPOOL_MODE)
6509 int ret = Uunlink(spoolname);
6510 log_write(0, LOG_MAIN|LOG_PANIC, "Couldn't set perms on journal file %s: %s",
6511 spoolname, strerror(errno));
6512 if(ret && errno != ENOENT)
6513 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s",
6514 spoolname, strerror(errno));
6515 return DELIVER_NOT_ATTEMPTED;
6521 /* Now we can get down to the business of actually doing deliveries. Local
6522 deliveries are done first, then remote ones. If ever the problems of how to
6523 handle fallback transports are figured out, this section can be put into a loop
6524 for handling fallbacks, though the uid switching will have to be revised. */
6526 /* Precompile a regex that is used to recognize a parameter in response
6527 to an LHLO command, if is isn't already compiled. This may be used on both
6528 local and remote LMTP deliveries. */
6530 if (regex_IGNOREQUOTA == NULL) regex_IGNOREQUOTA =
6531 regex_must_compile(US"\\n250[\\s\\-]IGNOREQUOTA(\\s|\\n|$)", FALSE, TRUE);
6533 /* Handle local deliveries */
6535 if (addr_local != NULL)
6537 DEBUG(D_deliver|D_transport)
6538 debug_printf(">>>>>>>>>>>>>>>> Local deliveries >>>>>>>>>>>>>>>>\n");
6539 do_local_deliveries();
6540 disable_logging = FALSE;
6543 /* If queue_run_local is set, we do not want to attempt any remote deliveries,
6544 so just queue them all. */
6546 if (queue_run_local)
6548 while (addr_remote != NULL)
6550 address_item *addr = addr_remote;
6551 addr_remote = addr->next;
6553 addr->basic_errno = ERRNO_LOCAL_ONLY;
6554 addr->message = US"remote deliveries suppressed";
6555 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_TRANSPORT, 0);
6559 /* Handle remote deliveries */
6561 if (addr_remote != NULL)
6563 DEBUG(D_deliver|D_transport)
6564 debug_printf(">>>>>>>>>>>>>>>> Remote deliveries >>>>>>>>>>>>>>>>\n");
6566 /* Precompile some regex that are used to recognize parameters in response
6567 to an EHLO command, if they aren't already compiled. */
6571 /* Now sort the addresses if required, and do the deliveries. The yield of
6572 do_remote_deliveries is FALSE when mua_wrapper is set and all addresses
6573 cannot be delivered in one transaction. */
6575 if (remote_sort_domains != NULL) sort_remote_deliveries();
6576 if (!do_remote_deliveries(FALSE))
6578 log_write(0, LOG_MAIN, "** mua_wrapper is set but recipients cannot all "
6579 "be delivered in one transaction");
6580 fprintf(stderr, "delivery to smarthost failed (configuration problem)\n");
6582 final_yield = DELIVER_MUA_FAILED;
6583 addr_failed = addr_defer = NULL; /* So that we remove the message */
6584 goto DELIVERY_TIDYUP;
6587 /* See if any of the addresses that failed got put on the queue for delivery
6588 to their fallback hosts. We do it this way because often the same fallback
6589 host is used for many domains, so all can be sent in a single transaction
6590 (if appropriately configured). */
6592 if (addr_fallback != NULL && !mua_wrapper)
6594 DEBUG(D_deliver) debug_printf("Delivering to fallback hosts\n");
6595 addr_remote = addr_fallback;
6596 addr_fallback = NULL;
6597 if (remote_sort_domains != NULL) sort_remote_deliveries();
6598 do_remote_deliveries(TRUE);
6600 disable_logging = FALSE;
6604 /* All deliveries are now complete. Ignore SIGTERM during this tidying up
6605 phase, to minimize cases of half-done things. */
6608 debug_printf(">>>>>>>>>>>>>>>> deliveries are done >>>>>>>>>>>>>>>>\n");
6610 /* Root privilege is no longer needed */
6612 exim_setugid(exim_uid, exim_gid, FALSE, US"post-delivery tidying");
6614 set_process_info("tidying up after delivering %s", message_id);
6615 signal(SIGTERM, SIG_IGN);
6617 /* When we are acting as an MUA wrapper, the smtp transport will either have
6618 succeeded for all addresses, or failed them all in normal cases. However, there
6619 are some setup situations (e.g. when a named port does not exist) that cause an
6620 immediate exit with deferral of all addresses. Convert those into failures. We
6621 do not ever want to retry, nor do we want to send a bounce message. */
6625 if (addr_defer != NULL)
6627 address_item *addr, *nextaddr;
6628 for (addr = addr_defer; addr != NULL; addr = nextaddr)
6630 log_write(0, LOG_MAIN, "** %s mua_wrapper forced failure for deferred "
6631 "delivery", addr->address);
6632 nextaddr = addr->next;
6633 addr->next = addr_failed;
6639 /* Now all should either have succeeded or failed. */
6641 if (addr_failed == NULL) final_yield = DELIVER_MUA_SUCCEEDED; else
6643 uschar *s = (addr_failed->user_message != NULL)?
6644 addr_failed->user_message : addr_failed->message;
6647 fprintf(stderr, "Delivery failed: ");
6648 if (addr_failed->basic_errno > 0)
6650 fprintf(stderr, "%s", strerror(addr_failed->basic_errno));
6651 if (s != NULL) fprintf(stderr, ": ");
6653 if ((host = addr_failed->host_used))
6654 fprintf(stderr, "H=%s [%s]: ", host->name, host->address);
6657 if (addr_failed->basic_errno <= 0) fprintf(stderr, "unknown error");
6659 else fprintf(stderr, "%s", CS s);
6660 fprintf(stderr, "\n");
6662 final_yield = DELIVER_MUA_FAILED;
6667 /* In a normal configuration, we now update the retry database. This is done in
6668 one fell swoop at the end in order not to keep opening and closing (and
6669 locking) the database. The code for handling retries is hived off into a
6670 separate module for convenience. We pass it the addresses of the various
6671 chains, because deferred addresses can get moved onto the failed chain if the
6672 retry cutoff time has expired for all alternative destinations. Bypass the
6673 updating of the database if the -N flag is set, which is a debugging thing that
6674 prevents actual delivery. */
6676 else if (!dont_deliver) retry_update(&addr_defer, &addr_failed, &addr_succeed);
6678 /* Send DSN for successful messages */
6679 addr_dsntmp = addr_succeed;
6680 addr_senddsn = NULL;
6684 /* af_ignore_error not honored here. it's not an error */
6687 debug_printf("DSN: processing router : %s\n"
6688 "DSN: processing successful delivery address: %s\n"
6689 "DSN: Sender_address: %s\n"
6690 "DSN: orcpt: %s flags: %d\n"
6691 "DSN: envid: %s ret: %d\n"
6692 "DSN: Final recipient: %s\n"
6693 "DSN: Remote SMTP server supports DSN: %d\n",
6694 addr_dsntmp->router->name,
6695 addr_dsntmp->address,
6697 addr_dsntmp->dsn_orcpt, addr_dsntmp->dsn_flags,
6699 addr_dsntmp->address,
6700 addr_dsntmp->dsn_aware
6704 /* send report if next hop not DSN aware or a router flagged "last DSN hop"
6705 and a report was requested */
6706 if ( ( addr_dsntmp->dsn_aware != dsn_support_yes
6707 || addr_dsntmp->dsn_flags & rf_dsnlasthop
6709 && addr_dsntmp->dsn_flags & rf_dsnflags
6710 && addr_dsntmp->dsn_flags & rf_notify_success
6713 /* copy and relink address_item and send report with all of them at once later */
6714 address_item *addr_next;
6715 addr_next = addr_senddsn;
6716 addr_senddsn = store_get(sizeof(address_item));
6717 memcpy(addr_senddsn, addr_dsntmp, sizeof(address_item));
6718 addr_senddsn->next = addr_next;
6721 DEBUG(D_deliver) debug_printf("DSN: not sending DSN success message\n");
6723 addr_dsntmp = addr_dsntmp->next;
6731 /* create exim process to send message */
6732 pid = child_open_exim(&fd);
6734 DEBUG(D_deliver) debug_printf("DSN: child_open_exim returns: %d\n", pid);
6736 if (pid < 0) /* Creation of child failed */
6738 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Process %d (parent %d) failed to "
6739 "create child process to send failure message: %s", getpid(),
6740 getppid(), strerror(errno));
6742 DEBUG(D_deliver) debug_printf("DSN: child_open_exim failed\n");
6744 else /* Creation of child succeeded */
6746 FILE *f = fdopen(fd, "wb");
6747 /* header only as required by RFC. only failure DSN needs to honor RET=FULL */
6748 int topt = topt_add_return_path | topt_no_body;
6752 debug_printf("sending error message to: %s\n", sender_address);
6754 /* build unique id for MIME boundary */
6755 bound = string_sprintf(TIME_T_FMT "-eximdsn-%d", time(NULL), rand());
6756 DEBUG(D_deliver) debug_printf("DSN: MIME boundary: %s\n", bound);
6758 if (errors_reply_to)
6759 fprintf(f, "Reply-To: %s\n", errors_reply_to);
6761 fprintf(f, "Auto-Submitted: auto-generated\n"
6762 "From: Mail Delivery System <Mailer-Daemon@%s>\n"
6764 "Subject: Delivery Status Notification\n"
6765 "Content-Type: multipart/report; report-type=delivery-status; boundary=%s\n"
6766 "MIME-Version: 1.0\n\n"
6769 "Content-type: text/plain; charset=us-ascii\n\n"
6771 "This message was created automatically by mail delivery software.\n"
6772 " ----- The following addresses had successful delivery notifications -----\n",
6773 qualify_domain_sender, sender_address, bound, bound);
6775 for (addr_dsntmp = addr_senddsn; addr_dsntmp;
6776 addr_dsntmp = addr_dsntmp->next)
6777 fprintf(f, "<%s> (relayed %s)\n\n",
6778 addr_dsntmp->address,
6779 (addr_dsntmp->dsn_flags & rf_dsnlasthop) == 1
6780 ? "via non DSN router"
6781 : addr_dsntmp->dsn_aware == dsn_support_no
6782 ? "to non-DSN-aware mailer"
6783 : "via non \"Remote SMTP\" router"
6787 "Content-type: message/delivery-status\n\n"
6788 "Reporting-MTA: dns; %s\n",
6789 bound, smtp_active_hostname);
6792 { /* must be decoded from xtext: see RFC 3461:6.3a */
6794 if (auth_xtextdecode(dsn_envid, &xdec_envid) > 0)
6795 fprintf(f, "Original-Envelope-ID: %s\n", dsn_envid);
6797 fprintf(f, "X-Original-Envelope-ID: error decoding xtext formated ENVID\n");
6801 for (addr_dsntmp = addr_senddsn;
6803 addr_dsntmp = addr_dsntmp->next)
6805 if (addr_dsntmp->dsn_orcpt)
6806 fprintf(f,"Original-Recipient: %s\n", addr_dsntmp->dsn_orcpt);
6808 fprintf(f, "Action: delivered\n"
6809 "Final-Recipient: rfc822;%s\n"
6811 addr_dsntmp->address);
6813 if (addr_dsntmp->host_used && addr_dsntmp->host_used->name)
6814 fprintf(f, "Remote-MTA: dns; %s\nDiagnostic-Code: smtp; 250 Ok\n\n",
6815 addr_dsntmp->host_used->name);
6817 fprintf(f, "Diagnostic-Code: X-Exim; relayed via non %s router\n\n",
6818 (addr_dsntmp->dsn_flags & rf_dsnlasthop) == 1 ? "DSN" : "SMTP");
6821 fprintf(f, "--%s\nContent-type: text/rfc822-headers\n\n", bound);
6824 transport_filter_argv = NULL; /* Just in case */
6825 return_path = sender_address; /* In case not previously set */
6827 /* Write the original email out */
6828 transport_write_message(NULL, fileno(f), topt, 0, NULL, NULL, NULL, NULL, NULL, 0);
6831 fprintf(f,"\n--%s--\n", bound);
6835 rc = child_close(pid, 0); /* Waits for child to close, no timeout */
6839 /* If any addresses failed, we must send a message to somebody, unless
6840 af_ignore_error is set, in which case no action is taken. It is possible for
6841 several messages to get sent if there are addresses with different
6844 while (addr_failed != NULL)
6848 uschar *logtod = tod_stamp(tod_log);
6850 address_item *handled_addr = NULL;
6851 address_item **paddr;
6852 address_item *msgchain = NULL;
6853 address_item **pmsgchain = &msgchain;
6855 /* There are weird cases when logging is disabled in the transport. However,
6856 there may not be a transport (address failed by a router). */
6858 disable_logging = FALSE;
6859 if (addr_failed->transport != NULL)
6860 disable_logging = addr_failed->transport->disable_logging;
6863 debug_printf("processing failed address %s\n", addr_failed->address);
6865 /* There are only two ways an address in a bounce message can get here:
6867 (1) When delivery was initially deferred, but has now timed out (in the call
6868 to retry_update() above). We can detect this by testing for
6869 af_retry_timedout. If the address does not have its own errors address,
6870 we arrange to ignore the error.
6872 (2) If delivery failures for bounce messages are being ignored. We can detect
6873 this by testing for af_ignore_error. This will also be set if a bounce
6874 message has been autothawed and the ignore_bounce_errors_after time has
6875 passed. It might also be set if a router was explicitly configured to
6876 ignore errors (errors_to = "").
6878 If neither of these cases obtains, something has gone wrong. Log the
6879 incident, but then ignore the error. */
6881 if (sender_address[0] == 0 && addr_failed->prop.errors_address == NULL)
6883 if ( !testflag(addr_failed, af_retry_timedout)
6884 && !testflag(addr_failed, af_ignore_error))
6886 log_write(0, LOG_MAIN|LOG_PANIC, "internal error: bounce message "
6887 "failure is neither frozen nor ignored (it's been ignored)");
6889 setflag(addr_failed, af_ignore_error);
6892 /* If the first address on the list has af_ignore_error set, just remove
6893 it from the list, throw away any saved message file, log it, and
6894 mark the recipient done. */
6896 if ( testflag(addr_failed, af_ignore_error)
6897 || ( addr_failed->dsn_flags & rf_dsnflags
6898 && (addr_failed->dsn_flags & rf_notify_failure) != rf_notify_failure)
6902 addr_failed = addr->next;
6903 if (addr->return_filename != NULL) Uunlink(addr->return_filename);
6905 log_write(0, LOG_MAIN, "%s%s%s%s: error ignored",
6907 !addr->parent ? US"" : US" <",
6908 !addr->parent ? US"" : addr->parent->address,
6909 !addr->parent ? US"" : US">");
6911 address_done(addr, logtod);
6912 child_done(addr, logtod);
6913 /* Panic-dies on error */
6914 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
6917 /* Otherwise, handle the sending of a message. Find the error address for
6918 the first address, then send a message that includes all failed addresses
6919 that have the same error address. Note the bounce_recipient is a global so
6920 that it can be accesssed by $bounce_recipient while creating a customized
6925 bounce_recipient = addr_failed->prop.errors_address
6926 ? addr_failed->prop.errors_address : sender_address;
6928 /* Make a subprocess to send a message */
6930 if ((pid = child_open_exim(&fd)) < 0)
6931 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Process %d (parent %d) failed to "
6932 "create child process to send failure message: %s", getpid(),
6933 getppid(), strerror(errno));
6935 /* Creation of child succeeded */
6942 uschar *bcc, *emf_text;
6943 FILE *f = fdopen(fd, "wb");
6945 BOOL to_sender = strcmpic(sender_address, bounce_recipient) == 0;
6946 int max = (bounce_return_size_limit/DELIVER_IN_BUFFER_SIZE + 1) *
6947 DELIVER_IN_BUFFER_SIZE;
6949 uschar *dsnlimitmsg;
6950 uschar *dsnnotifyhdr;
6954 debug_printf("sending error message to: %s\n", bounce_recipient);
6956 /* Scan the addresses for all that have the same errors address, removing
6957 them from the addr_failed chain, and putting them on msgchain. */
6959 paddr = &addr_failed;
6960 for (addr = addr_failed; addr != NULL; addr = *paddr)
6961 if (Ustrcmp(bounce_recipient, addr->prop.errors_address
6962 ? addr->prop.errors_address : sender_address) == 0)
6963 { /* The same - dechain */
6964 *paddr = addr->next;
6967 pmsgchain = &(addr->next);
6970 paddr = &addr->next; /* Not the same; skip */
6972 /* Include X-Failed-Recipients: for automatic interpretation, but do
6973 not let any one header line get too long. We do this by starting a
6974 new header every 50 recipients. Omit any addresses for which the
6975 "hide_child" flag is set. */
6977 for (addr = msgchain; addr != NULL; addr = addr->next)
6979 if (testflag(addr, af_hide_child)) continue;
6986 (rcount++ == 0)? "X-Failed-Recipients: " : ",\n ",
6987 (testflag(addr, af_pfr) && addr->parent != NULL)?
6988 string_printing(addr->parent->address) :
6989 string_printing(addr->address));
6991 if (rcount > 0) fprintf(f, "\n");
6993 /* Output the standard headers */
6995 if (errors_reply_to)
6996 fprintf(f, "Reply-To: %s\n", errors_reply_to);
6997 fprintf(f, "Auto-Submitted: auto-replied\n");
6999 fprintf(f, "To: %s\n", bounce_recipient);
7001 /* generate boundary string and output MIME-Headers */
7002 bound = string_sprintf(TIME_T_FMT "-eximdsn-%d", time(NULL), rand());
7004 fprintf(f, "Content-Type: multipart/report;"
7005 " report-type=delivery-status; boundary=%s\n"
7006 "MIME-Version: 1.0\n",
7009 /* Open a template file if one is provided. Log failure to open, but
7010 carry on - default texts will be used. */
7012 if (bounce_message_file)
7013 if (!(emf = Ufopen(bounce_message_file, "rb")))
7014 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to open %s for error "
7015 "message texts: %s", bounce_message_file, strerror(errno));
7017 /* Quietly copy to configured additional addresses if required. */
7019 if ((bcc = moan_check_errorcopy(bounce_recipient)))
7020 fprintf(f, "Bcc: %s\n", bcc);
7022 /* The texts for the message can be read from a template file; if there
7023 isn't one, or if it is too short, built-in texts are used. The first
7024 emf text is a Subject: and any other headers. */
7026 if ((emf_text = next_emf(emf, US"header")))
7027 fprintf(f, "%s\n", emf_text);
7029 fprintf(f, "Subject: Mail delivery failed%s\n\n",
7030 to_sender? ": returning message to sender" : "");
7032 /* output human readable part as text/plain section */
7034 "Content-type: text/plain; charset=us-ascii\n\n",
7037 if ((emf_text = next_emf(emf, US"intro")))
7038 fprintf(f, "%s", CS emf_text);
7042 /* This message has been reworded several times. It seems to be confusing to
7043 somebody, however it is worded. I have retreated to the original, simple
7045 "This message was created automatically by mail delivery software.\n");
7047 if (bounce_message_text)
7048 fprintf(f, "%s", CS bounce_message_text);
7051 "\nA message that you sent could not be delivered to one or more of its\n"
7052 "recipients. This is a permanent error. The following address(es) failed:\n");
7055 "\nA message sent by\n\n <%s>\n\n"
7056 "could not be delivered to one or more of its recipients. The following\n"
7057 "address(es) failed:\n", sender_address);
7061 /* Process the addresses, leaving them on the msgchain if they have a
7062 file name for a return message. (There has already been a check in
7063 post_process_one() for the existence of data in the message file.) A TRUE
7064 return from print_address_information() means that the address is not
7068 for (addr = msgchain; addr != NULL; addr = *paddr)
7070 if (print_address_information(addr, f, US" ", US"\n ", US""))
7071 print_address_error(addr, f, US"");
7073 /* End the final line for the address */
7077 /* Leave on msgchain if there's a return file. */
7079 if (addr->return_file >= 0)
7081 paddr = &(addr->next);
7085 /* Else save so that we can tick off the recipient when the
7090 *paddr = addr->next;
7091 addr->next = handled_addr;
7092 handled_addr = addr;
7098 /* Get the next text, whether we need it or not, so as to be
7099 positioned for the one after. */
7101 emf_text = next_emf(emf, US"generated text");
7103 /* If there were any file messages passed by the local transports,
7104 include them in the message. Then put the address on the handled chain.
7105 In the case of a batch of addresses that were all sent to the same
7106 transport, the return_file field in all of them will contain the same
7107 fd, and the return_filename field in the *last* one will be set (to the
7108 name of the file). */
7112 address_item *nextaddr;
7115 fprintf(f, "%s", CS emf_text);
7118 "The following text was generated during the delivery "
7119 "attempt%s:\n", (filecount > 1)? "s" : "");
7121 for (addr = msgchain; addr != NULL; addr = nextaddr)
7124 address_item *topaddr = addr;
7126 /* List all the addresses that relate to this file */
7129 while(addr) /* Insurance */
7131 print_address_information(addr, f, US"------ ", US"\n ",
7133 if (addr->return_filename) break;
7138 /* Now copy the file */
7140 fm = Ufopen(addr->return_filename, "rb");
7143 fprintf(f, " +++ Exim error... failed to open text file: %s\n",
7147 while ((ch = fgetc(fm)) != EOF) fputc(ch, f);
7150 Uunlink(addr->return_filename);
7152 /* Can now add to handled chain, first fishing off the next
7153 address on the msgchain. */
7155 nextaddr = addr->next;
7156 addr->next = handled_addr;
7157 handled_addr = topaddr;
7162 /* output machine readable part */
7163 #ifdef EXPERIMENTAL_INTERNATIONAL
7164 if (message_smtputf8)
7166 "Content-type: message/global-delivery-status\n\n"
7167 "Reporting-MTA: dns; %s\n",
7168 bound, smtp_active_hostname);
7172 "Content-type: message/delivery-status\n\n"
7173 "Reporting-MTA: dns; %s\n",
7174 bound, smtp_active_hostname);
7178 /* must be decoded from xtext: see RFC 3461:6.3a */
7180 if (auth_xtextdecode(dsn_envid, &xdec_envid) > 0)
7181 fprintf(f, "Original-Envelope-ID: %s\n", dsn_envid);
7183 fprintf(f, "X-Original-Envelope-ID: error decoding xtext formated ENVID\n");
7187 for (addr = handled_addr; addr; addr = addr->next)
7189 fprintf(f, "Action: failed\n"
7190 "Final-Recipient: rfc822;%s\n"
7193 if (addr->host_used && addr->host_used->name)
7195 fprintf(f, "Remote-MTA: dns; %s\n",
7196 addr->host_used->name);
7197 print_dsn_diagnostic_code(addr, f);
7202 /* Now copy the message, trying to give an intelligible comment if
7203 it is too long for it all to be copied. The limit isn't strictly
7204 applied because of the buffering. There is, however, an option
7205 to suppress copying altogether. */
7207 emf_text = next_emf(emf, US"copy");
7210 we ignore the intro text from template and add
7211 the text for bounce_return_size_limit at the end.
7213 bounce_return_message is ignored
7214 in case RET= is defined we honor these values
7215 otherwise bounce_return_body is honored.
7217 bounce_return_size_limit is always honored.
7220 fprintf(f, "--%s\n", bound);
7222 dsnlimitmsg = US"X-Exim-DSN-Information: Due to administrative limits only headers are returned";
7223 dsnnotifyhdr = NULL;
7224 topt = topt_add_return_path;
7226 /* RET=HDRS? top priority */
7227 if (dsn_ret == dsn_ret_hdrs)
7228 topt |= topt_no_body;
7230 /* no full body return at all? */
7231 if (!bounce_return_body)
7233 topt |= topt_no_body;
7234 /* add header if we overrule RET=FULL */
7235 if (dsn_ret == dsn_ret_full)
7236 dsnnotifyhdr = dsnlimitmsg;
7238 /* size limited ... return headers only if limit reached */
7239 else if (bounce_return_size_limit > 0)
7241 struct stat statbuf;
7242 if (fstat(deliver_datafile, &statbuf) == 0 && statbuf.st_size > max)
7244 topt |= topt_no_body;
7245 dsnnotifyhdr = dsnlimitmsg;
7249 #ifdef EXPERIMENTAL_INTERNATIONAL
7250 if (message_smtputf8)
7251 fputs(topt & topt_no_body ? "Content-type: message/global-headers\n\n"
7252 : "Content-type: message/global\n\n",
7256 fputs(topt & topt_no_body ? "Content-type: text/rfc822-headers\n\n"
7257 : "Content-type: message/rfc822\n\n",
7261 transport_filter_argv = NULL; /* Just in case */
7262 return_path = sender_address; /* In case not previously set */
7263 transport_write_message(NULL, fileno(f), topt,
7264 0, dsnnotifyhdr, NULL, NULL, NULL, NULL, 0);
7267 /* we never add the final text. close the file */
7271 fprintf(f, "\n--%s--\n", bound);
7273 /* Close the file, which should send an EOF to the child process
7274 that is receiving the message. Wait for it to finish. */
7277 rc = child_close(pid, 0); /* Waits for child to close, no timeout */
7279 /* In the test harness, let the child do it's thing first. */
7281 if (running_in_test_harness) millisleep(500);
7283 /* If the process failed, there was some disaster in setting up the
7284 error message. Unless the message is very old, ensure that addr_defer
7285 is non-null, which will have the effect of leaving the message on the
7286 spool. The failed addresses will get tried again next time. However, we
7287 don't really want this to happen too often, so freeze the message unless
7288 there are some genuine deferred addresses to try. To do this we have
7289 to call spool_write_header() here, because with no genuine deferred
7290 addresses the normal code below doesn't get run. */
7295 if (now - received_time < retry_maximum_timeout && addr_defer == NULL)
7297 addr_defer = (address_item *)(+1);
7298 deliver_freeze = TRUE;
7299 deliver_frozen_at = time(NULL);
7300 /* Panic-dies on error */
7301 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
7304 deliver_msglog("Process failed (%d) when writing error message "
7305 "to %s%s", rc, bounce_recipient, s);
7306 log_write(0, LOG_MAIN, "Process failed (%d) when writing error message "
7307 "to %s%s", rc, bounce_recipient, s);
7310 /* The message succeeded. Ensure that the recipients that failed are
7311 now marked finished with on the spool and their parents updated. */
7315 for (addr = handled_addr; addr != NULL; addr = addr->next)
7317 address_done(addr, logtod);
7318 child_done(addr, logtod);
7320 /* Panic-dies on error */
7321 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
7327 disable_logging = FALSE; /* In case left set */
7329 /* Come here from the mua_wrapper case if routing goes wrong */
7333 /* If there are now no deferred addresses, we are done. Preserve the
7334 message log if so configured, and we are using them. Otherwise, sling it.
7335 Then delete the message itself. */
7337 if (addr_defer == NULL)
7341 sprintf(CS spoolname, "%s/msglog/%s/%s", spool_directory, message_subdir,
7343 if (preserve_message_logs)
7346 sprintf(CS big_buffer, "%s/msglog.OLD/%s", spool_directory, id);
7347 if ((rc = Urename(spoolname, big_buffer)) < 0)
7349 (void)directory_make(spool_directory, US"msglog.OLD",
7350 MSGLOG_DIRECTORY_MODE, TRUE);
7351 rc = Urename(spoolname, big_buffer);
7354 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to move %s to the "
7355 "msglog.OLD directory", spoolname);
7358 if (Uunlink(spoolname) < 0)
7359 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s",
7360 spoolname, strerror(errno));
7363 /* Remove the two message files. */
7365 sprintf(CS spoolname, "%s/input/%s/%s-D", spool_directory, message_subdir, id);
7366 if (Uunlink(spoolname) < 0)
7367 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s",
7368 spoolname, strerror(errno));
7369 sprintf(CS spoolname, "%s/input/%s/%s-H", spool_directory, message_subdir, id);
7370 if (Uunlink(spoolname) < 0)
7371 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s",
7372 spoolname, strerror(errno));
7374 /* Log the end of this message, with queue time if requested. */
7376 if ((log_extra_selector & LX_queue_time_overall) != 0)
7377 log_write(0, LOG_MAIN, "Completed QT=%s",
7378 readconf_printtime( (int) ((long)time(NULL) - (long)received_time)) );
7380 log_write(0, LOG_MAIN, "Completed");
7382 /* Unset deliver_freeze so that we won't try to move the spool files further down */
7383 deliver_freeze = FALSE;
7385 #ifdef EXPERIMENTAL_EVENT
7386 (void) event_raise(event_action, US"msg:complete", NULL);
7390 /* If there are deferred addresses, we are keeping this message because it is
7391 not yet completed. Lose any temporary files that were catching output from
7392 pipes for any of the deferred addresses, handle one-time aliases, and see if
7393 the message has been on the queue for so long that it is time to send a warning
7394 message to the sender, unless it is a mailer-daemon. If all deferred addresses
7395 have the same domain, we can set deliver_domain for the expansion of
7396 delay_warning_ condition - if any of them are pipes, files, or autoreplies, use
7397 the parent's domain.
7399 If all the deferred addresses have an error number that indicates "retry time
7400 not reached", skip sending the warning message, because it won't contain the
7401 reason for the delay. It will get sent at the next real delivery attempt.
7402 However, if at least one address has tried, we'd better include all of them in
7405 If we can't make a process to send the message, don't worry.
7407 For mailing list expansions we want to send the warning message to the
7408 mailing list manager. We can't do a perfect job here, as some addresses may
7409 have different errors addresses, but if we take the errors address from
7410 each deferred address it will probably be right in most cases.
7412 If addr_defer == +1, it means there was a problem sending an error message
7413 for failed addresses, and there were no "real" deferred addresses. The value
7414 was set just to keep the message on the spool, so there is nothing to do here.
7417 else if (addr_defer != (address_item *)(+1))
7420 uschar *recipients = US"";
7421 BOOL delivery_attempted = FALSE;
7423 deliver_domain = testflag(addr_defer, af_pfr)?
7424 addr_defer->parent->domain : addr_defer->domain;
7426 for (addr = addr_defer; addr != NULL; addr = addr->next)
7428 address_item *otaddr;
7430 if (addr->basic_errno > ERRNO_RETRY_BASE) delivery_attempted = TRUE;
7432 if (deliver_domain != NULL)
7434 const uschar *d = testflag(addr, af_pfr)
7435 ? addr->parent->domain : addr->domain;
7437 /* The domain may be unset for an address that has never been routed
7438 because the system filter froze the message. */
7440 if (d == NULL || Ustrcmp(d, deliver_domain) != 0) deliver_domain = NULL;
7443 if (addr->return_filename != NULL) Uunlink(addr->return_filename);
7445 /* Handle the case of one-time aliases. If any address in the ancestry
7446 of this one is flagged, ensure it is in the recipients list, suitably
7447 flagged, and that its parent is marked delivered. */
7449 for (otaddr = addr; otaddr != NULL; otaddr = otaddr->parent)
7450 if (otaddr->onetime_parent != NULL) break;
7455 int t = recipients_count;
7457 for (i = 0; i < recipients_count; i++)
7459 uschar *r = recipients_list[i].address;
7460 if (Ustrcmp(otaddr->onetime_parent, r) == 0) t = i;
7461 if (Ustrcmp(otaddr->address, r) == 0) break;
7464 /* Didn't find the address already in the list, and did find the
7465 ultimate parent's address in the list. After adding the recipient,
7466 update the errors address in the recipients list. */
7468 if (i >= recipients_count && t < recipients_count)
7470 DEBUG(D_deliver) debug_printf("one_time: adding %s in place of %s\n",
7471 otaddr->address, otaddr->parent->address);
7472 receive_add_recipient(otaddr->address, t);
7473 recipients_list[recipients_count-1].errors_to = otaddr->prop.errors_address;
7474 tree_add_nonrecipient(otaddr->parent->address);
7475 update_spool = TRUE;
7479 /* Except for error messages, ensure that either the errors address for
7480 this deferred address or, if there is none, the sender address, is on the
7481 list of recipients for a warning message. */
7483 if (sender_address[0] != 0)
7485 if (addr->prop.errors_address == NULL)
7487 if (Ustrstr(recipients, sender_address) == NULL)
7488 recipients = string_sprintf("%s%s%s", recipients,
7489 (recipients[0] == 0)? "" : ",", sender_address);
7493 if (Ustrstr(recipients, addr->prop.errors_address) == NULL)
7494 recipients = string_sprintf("%s%s%s", recipients,
7495 (recipients[0] == 0)? "" : ",", addr->prop.errors_address);
7500 /* Send a warning message if the conditions are right. If the condition check
7501 fails because of a lookup defer, there is nothing we can do. The warning
7502 is not sent. Another attempt will be made at the next delivery attempt (if
7506 && delivery_attempted
7507 && ( ((addr_defer->dsn_flags & rf_dsnflags) == 0)
7508 || (addr_defer->dsn_flags & rf_notify_delay) == rf_notify_delay
7510 && delay_warning[1] > 0
7511 && sender_address[0] != 0
7512 && ( delay_warning_condition == NULL
7513 || expand_check_condition(delay_warning_condition,
7514 US"delay_warning", US"option")
7520 int queue_time = time(NULL) - received_time;
7522 /* When running in the test harness, there's an option that allows us to
7523 fudge this time so as to get repeatability of the tests. Take the first
7524 time off the list. In queue runs, the list pointer gets updated in the
7527 if (running_in_test_harness && fudged_queue_times[0] != 0)
7529 int qt = readconf_readtime(fudged_queue_times, '/', FALSE);
7532 DEBUG(D_deliver) debug_printf("fudged queue_times = %s\n",
7533 fudged_queue_times);
7538 /* See how many warnings we should have sent by now */
7540 for (count = 0; count < delay_warning[1]; count++)
7541 if (queue_time < delay_warning[count+2]) break;
7543 show_time = delay_warning[count+1];
7545 if (count >= delay_warning[1])
7548 int last_gap = show_time;
7549 if (count > 1) last_gap -= delay_warning[count];
7550 extra = (queue_time - delay_warning[count+1])/last_gap;
7551 show_time += last_gap * extra;
7557 debug_printf("time on queue = %s\n", readconf_printtime(queue_time));
7558 debug_printf("warning counts: required %d done %d\n", count,
7562 /* We have computed the number of warnings there should have been by now.
7563 If there haven't been enough, send one, and up the count to what it should
7566 if (warning_count < count)
7570 pid_t pid = child_open_exim(&fd);
7576 FILE *f = fdopen(fd, "wb");
7579 if (warn_message_file)
7581 wmf = Ufopen(warn_message_file, "rb");
7583 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to open %s for warning "
7584 "message texts: %s", warn_message_file, strerror(errno));
7587 warnmsg_recipients = recipients;
7588 warnmsg_delay = (queue_time < 120*60)?
7589 string_sprintf("%d minutes", show_time/60):
7590 string_sprintf("%d hours", show_time/3600);
7592 if (errors_reply_to)
7593 fprintf(f, "Reply-To: %s\n", errors_reply_to);
7594 fprintf(f, "Auto-Submitted: auto-replied\n");
7596 fprintf(f, "To: %s\n", recipients);
7598 /* generated boundary string and output MIME-Headers */
7599 bound = string_sprintf(TIME_T_FMT "-eximdsn-%d", time(NULL), rand());
7601 fprintf(f, "Content-Type: multipart/report;"
7602 " report-type=delivery-status; boundary=%s\n"
7603 "MIME-Version: 1.0\n",
7606 if ((wmf_text = next_emf(wmf, US"header")))
7607 fprintf(f, "%s\n", wmf_text);
7609 fprintf(f, "Subject: Warning: message %s delayed %s\n\n",
7610 message_id, warnmsg_delay);
7612 /* output human readable part as text/plain section */
7614 "Content-type: text/plain; charset=us-ascii\n\n",
7617 if ((wmf_text = next_emf(wmf, US"intro")))
7618 fprintf(f, "%s", CS wmf_text);
7622 "This message was created automatically by mail delivery software.\n");
7624 if (Ustrcmp(recipients, sender_address) == 0)
7626 "A message that you sent has not yet been delivered to one or more of its\n"
7627 "recipients after more than ");
7631 "A message sent by\n\n <%s>\n\n"
7632 "has not yet been delivered to one or more of its recipients after more than \n",
7635 fprintf(f, "%s on the queue on %s.\n\n"
7636 "The message identifier is: %s\n",
7637 warnmsg_delay, primary_hostname, message_id);
7639 for (h = header_list; h != NULL; h = h->next)
7640 if (strncmpic(h->text, US"Subject:", 8) == 0)
7641 fprintf(f, "The subject of the message is: %s", h->text + 9);
7642 else if (strncmpic(h->text, US"Date:", 5) == 0)
7643 fprintf(f, "The date of the message is: %s", h->text + 6);
7646 fprintf(f, "The address%s to which the message has not yet been "
7648 !addr_defer->next ? "" : "es",
7649 !addr_defer->next ? "is": "are");
7652 /* List the addresses, with error information if allowed */
7654 /* store addr_defer for machine readable part */
7655 address_item *addr_dsndefer = addr_defer;
7659 address_item *addr = addr_defer;
7660 addr_defer = addr->next;
7661 if (print_address_information(addr, f, US" ", US"\n ", US""))
7662 print_address_error(addr, f, US"Delay reason: ");
7671 if ((wmf_text = next_emf(wmf, US"final")))
7672 fprintf(f, "%s", CS wmf_text);
7678 "No action is required on your part. Delivery attempts will continue for\n"
7679 "some time, and this warning may be repeated at intervals if the message\n"
7680 "remains undelivered. Eventually the mail delivery software will give up,\n"
7681 "and when that happens, the message will be returned to you.\n");
7684 /* output machine readable part */
7685 fprintf(f, "\n--%s\n"
7686 "Content-type: message/delivery-status\n\n"
7687 "Reporting-MTA: dns; %s\n",
7689 smtp_active_hostname);
7694 /* must be decoded from xtext: see RFC 3461:6.3a */
7696 if (auth_xtextdecode(dsn_envid, &xdec_envid) > 0)
7697 fprintf(f,"Original-Envelope-ID: %s\n", dsn_envid);
7699 fprintf(f,"X-Original-Envelope-ID: error decoding xtext formated ENVID\n");
7703 for ( ; addr_dsndefer; addr_dsndefer = addr_dsndefer->next)
7705 if (addr_dsndefer->dsn_orcpt)
7706 fprintf(f, "Original-Recipient: %s\n", addr_dsndefer->dsn_orcpt);
7708 fprintf(f, "Action: delayed\n"
7709 "Final-Recipient: rfc822;%s\n"
7711 addr_dsndefer->address);
7712 if (addr_dsndefer->host_used && addr_dsndefer->host_used->name)
7714 fprintf(f, "Remote-MTA: dns; %s\n",
7715 addr_dsndefer->host_used->name);
7716 print_dsn_diagnostic_code(addr_dsndefer, f);
7722 "Content-type: text/rfc822-headers\n\n",
7726 /* header only as required by RFC. only failure DSN needs to honor RET=FULL */
7727 int topt = topt_add_return_path | topt_no_body;
7728 transport_filter_argv = NULL; /* Just in case */
7729 return_path = sender_address; /* In case not previously set */
7730 /* Write the original email out */
7731 transport_write_message(NULL, fileno(f), topt, 0, NULL, NULL, NULL, NULL, NULL, 0);
7734 fprintf(f,"\n--%s--\n", bound);
7738 /* Close and wait for child process to complete, without a timeout.
7739 If there's an error, don't update the count. */
7742 if (child_close(pid, 0) == 0)
7744 warning_count = count;
7745 update_spool = TRUE; /* Ensure spool rewritten */
7751 /* Clear deliver_domain */
7753 deliver_domain = NULL;
7755 /* If this was a first delivery attempt, unset the first time flag, and
7756 ensure that the spool gets updated. */
7758 if (deliver_firsttime)
7760 deliver_firsttime = FALSE;
7761 update_spool = TRUE;
7764 /* If delivery was frozen and freeze_tell is set, generate an appropriate
7765 message, unless the message is a local error message (to avoid loops). Then
7766 log the freezing. If the text in "frozen_info" came from a system filter,
7767 it has been escaped into printing characters so as not to mess up log lines.
7768 For the "tell" message, we turn \n back into newline. Also, insert a newline
7769 near the start instead of the ": " string. */
7773 if (freeze_tell != NULL && freeze_tell[0] != 0 && !local_error_message)
7775 uschar *s = string_copy(frozen_info);
7776 uschar *ss = Ustrstr(s, " by the system filter: ");
7787 if (*ss == '\\' && ss[1] == 'n')
7794 moan_tell_someone(freeze_tell, addr_defer, US"Message frozen",
7795 "Message %s has been frozen%s.\nThe sender is <%s>.\n", message_id,
7799 /* Log freezing just before we update the -H file, to minimize the chance
7800 of a race problem. */
7802 deliver_msglog("*** Frozen%s\n", frozen_info);
7803 log_write(0, LOG_MAIN, "Frozen%s", frozen_info);
7806 /* If there have been any updates to the non-recipients list, or other things
7807 that get written to the spool, we must now update the spool header file so
7808 that it has the right information for the next delivery attempt. If there
7809 was more than one address being delivered, the header_change update is done
7810 earlier, in case one succeeds and then something crashes. */
7813 debug_printf("delivery deferred: update_spool=%d header_rewritten=%d\n",
7814 update_spool, header_rewritten);
7816 if (update_spool || header_rewritten)
7817 /* Panic-dies on error */
7818 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
7821 /* Finished with the message log. If the message is complete, it will have
7822 been unlinked or renamed above. */
7824 if (message_logs) (void)fclose(message_log);
7826 /* Now we can close and remove the journal file. Its only purpose is to record
7827 successfully completed deliveries asap so that this information doesn't get
7828 lost if Exim (or the machine) crashes. Forgetting about a failed delivery is
7829 not serious, as trying it again is not harmful. The journal might not be open
7830 if all addresses were deferred at routing or directing. Nevertheless, we must
7831 remove it if it exists (may have been lying around from a crash during the
7832 previous delivery attempt). We don't remove the journal if a delivery
7833 subprocess failed to pass back delivery information; this is controlled by
7834 the remove_journal flag. When the journal is left, we also don't move the
7835 message off the main spool if frozen and the option is set. It should get moved
7836 at the next attempt, after the journal has been inspected. */
7838 if (journal_fd >= 0) (void)close(journal_fd);
7842 sprintf(CS spoolname, "%s/input/%s/%s-J", spool_directory, message_subdir, id);
7843 if (Uunlink(spoolname) < 0 && errno != ENOENT)
7844 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s", spoolname,
7847 /* Move the message off the spool if reqested */
7849 #ifdef SUPPORT_MOVE_FROZEN_MESSAGES
7850 if (deliver_freeze && move_frozen_messages)
7851 (void)spool_move_message(id, message_subdir, US"", US"F");
7855 /* Closing the data file frees the lock; if the file has been unlinked it
7856 will go away. Otherwise the message becomes available for another process
7859 (void)close(deliver_datafile);
7860 deliver_datafile = -1;
7861 DEBUG(D_deliver) debug_printf("end delivery of %s\n", id);
7863 /* It is unlikely that there will be any cached resources, since they are
7864 released after routing, and in the delivery subprocesses. However, it's
7865 possible for an expansion for something afterwards (for example,
7866 expand_check_condition) to do a lookup. We must therefore be sure everything is
7870 acl_where = ACL_WHERE_UNKNOWN;
7879 if (!regex_PIPELINING) regex_PIPELINING =
7880 regex_must_compile(US"\\n250[\\s\\-]PIPELINING(\\s|\\n|$)", FALSE, TRUE);
7882 if (!regex_SIZE) regex_SIZE =
7883 regex_must_compile(US"\\n250[\\s\\-]SIZE(\\s|\\n|$)", FALSE, TRUE);
7885 if (!regex_AUTH) regex_AUTH =
7886 regex_must_compile(US"\\n250[\\s\\-]AUTH\\s+([\\-\\w\\s]+)(?:\\n|$)",
7890 if (!regex_STARTTLS) regex_STARTTLS =
7891 regex_must_compile(US"\\n250[\\s\\-]STARTTLS(\\s|\\n|$)", FALSE, TRUE);
7894 #ifndef DISABLE_PRDR
7895 if (!regex_PRDR) regex_PRDR =
7896 regex_must_compile(US"\\n250[\\s\\-]PRDR(\\s|\\n|$)", FALSE, TRUE);
7899 #ifdef EXPERIMENTAL_INTERNATIONAL
7900 if (!regex_UTF8) regex_UTF8 =
7901 regex_must_compile(US"\\n250[\\s\\-]SMTPUTF8(\\s|\\n|$)", FALSE, TRUE);
7904 if (!regex_DSN) regex_DSN =
7905 regex_must_compile(US"\\n250[\\s\\-]DSN(\\s|\\n|$)", FALSE, TRUE);
7907 if (!regex_IGNOREQUOTA) regex_IGNOREQUOTA =
7908 regex_must_compile(US"\\n250[\\s\\-]IGNOREQUOTA(\\s|\\n|$)", FALSE, TRUE);
7913 deliver_get_sender_address (uschar * id)
7915 if (!spool_open_datafile(id))
7918 sprintf(CS spoolname, "%s-H", id);
7919 if (spool_read_header(spoolname, TRUE, TRUE) != spool_read_OK)
7922 (void)close(deliver_datafile);
7923 deliver_datafile = -1;
7925 return sender_address;
7930 /* End of deliver.c */