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 tls_free_cert(&tls_out.ourcert);
1174 tls_free_cert(&tls_out.peercert);
1175 tls_out.cipher = NULL;
1176 tls_out.peerdn = NULL;
1177 tls_out.ocsp = OCSP_NOT_REQ;
1178 # ifdef EXPERIMENTAL_DANE
1179 tls_out.dane_verified = FALSE;
1185 /* Soft failure, or local delivery process failed; freezing may be
1188 else if (result == DEFER || result == PANIC)
1190 if (result == PANIC) logflags |= LOG_PANIC;
1192 /* This puts them on the chain in reverse order. Do not change this, because
1193 the code for handling retries assumes that the one with the retry
1194 information is last. */
1196 addr->next = addr_defer;
1199 /* The only currently implemented special action is to freeze the
1200 message. Logging of this is done later, just before the -H file is
1203 if (addr->special_action == SPECIAL_FREEZE)
1205 deliver_freeze = TRUE;
1206 deliver_frozen_at = time(NULL);
1207 update_spool = TRUE;
1210 /* If doing a 2-stage queue run, we skip writing to either the message
1211 log or the main log for SMTP defers. */
1213 if (!queue_2stage || addr->basic_errno != 0)
1217 /* For errors of the type "retry time not reached" (also remotes skipped
1218 on queue run), logging is controlled by L_retry_defer. Note that this kind
1219 of error number is negative, and all the retry ones are less than any
1222 unsigned int use_log_selector = (addr->basic_errno <= ERRNO_RETRY_BASE)?
1225 /* Build up the line that is used for both the message log and the main
1228 s = reset_point = store_get(size);
1230 /* Create the address string for logging. Must not do this earlier, because
1231 an OK result may be changed to FAIL when a pipe returns text. */
1233 log_address = string_log_address(addr,
1234 (log_write_selector & L_all_parents) != 0, result == OK);
1236 s = string_cat(s, &size, &ptr, log_address, Ustrlen(log_address));
1238 /* Either driver_name contains something and driver_kind contains
1239 " router" or " transport" (note the leading space), or driver_name is
1240 a null string and driver_kind contains "routing" without the leading
1241 space, if all routing has been deferred. When a domain has been held,
1242 so nothing has been done at all, both variables contain null strings. */
1244 if (driver_name == NULL)
1246 if (driver_kind != NULL)
1247 s = string_append(s, &size, &ptr, 2, US" ", driver_kind);
1251 if (driver_kind[1] == 't' && addr->router != NULL)
1252 s = string_append(s, &size, &ptr, 2, US" R=", addr->router->name);
1254 ss[1] = toupper(driver_kind[1]);
1255 s = string_append(s, &size, &ptr, 2, ss, driver_name);
1258 sprintf(CS ss, " defer (%d)", addr->basic_errno);
1259 s = string_cat(s, &size, &ptr, ss, Ustrlen(ss));
1261 if (addr->basic_errno > 0)
1262 s = string_append(s, &size, &ptr, 2, US": ",
1263 US strerror(addr->basic_errno));
1265 if (addr->host_used)
1266 s = string_append(s, &size, &ptr, 5,
1267 US" H=", addr->host_used->name,
1268 US" [", addr->host_used->address, US"]");
1270 if (addr->message != NULL)
1271 s = string_append(s, &size, &ptr, 2, US": ", addr->message);
1275 /* Log the deferment in the message log, but don't clutter it
1276 up with retry-time defers after the first delivery attempt. */
1278 if (deliver_firsttime || addr->basic_errno > ERRNO_RETRY_BASE)
1279 deliver_msglog("%s %s\n", now, s);
1281 /* Write the main log and reset the store */
1283 log_write(use_log_selector, logflags, "== %s", s);
1284 store_reset(reset_point);
1289 /* Hard failure. If there is an address to which an error message can be sent,
1290 put this address on the failed list. If not, put it on the deferred list and
1291 freeze the mail message for human attention. The latter action can also be
1292 explicitly requested by a router or transport. */
1296 /* If this is a delivery error, or a message for which no replies are
1297 wanted, and the message's age is greater than ignore_bounce_errors_after,
1298 force the af_ignore_error flag. This will cause the address to be discarded
1299 later (with a log entry). */
1301 if (sender_address[0] == 0 && message_age >= ignore_bounce_errors_after)
1302 setflag(addr, af_ignore_error);
1304 /* Freeze the message if requested, or if this is a bounce message (or other
1305 message with null sender) and this address does not have its own errors
1306 address. However, don't freeze if errors are being ignored. The actual code
1307 to ignore occurs later, instead of sending a message. Logging of freezing
1308 occurs later, just before writing the -H file. */
1310 if (!testflag(addr, af_ignore_error) &&
1311 (addr->special_action == SPECIAL_FREEZE ||
1312 (sender_address[0] == 0 && addr->prop.errors_address == NULL)
1315 frozen_info = (addr->special_action == SPECIAL_FREEZE)? US"" :
1316 (sender_local && !local_error_message)?
1317 US" (message created with -f <>)" : US" (delivery error message)";
1318 deliver_freeze = TRUE;
1319 deliver_frozen_at = time(NULL);
1320 update_spool = TRUE;
1322 /* The address is put on the defer rather than the failed queue, because
1323 the message is being retained. */
1325 addr->next = addr_defer;
1329 /* Don't put the address on the nonrecipients tree yet; wait until an
1330 error message has been successfully sent. */
1334 addr->next = addr_failed;
1338 /* Build up the log line for the message and main logs */
1340 s = reset_point = store_get(size);
1342 /* Create the address string for logging. Must not do this earlier, because
1343 an OK result may be changed to FAIL when a pipe returns text. */
1345 log_address = string_log_address(addr,
1346 (log_write_selector & L_all_parents) != 0, result == OK);
1348 s = string_cat(s, &size, &ptr, log_address, Ustrlen(log_address));
1350 if ((log_extra_selector & LX_sender_on_delivery) != 0)
1351 s = string_append(s, &size, &ptr, 3, US" F=<", sender_address, US">");
1353 /* Return path may not be set if no delivery actually happened */
1355 if (used_return_path != NULL &&
1356 (log_extra_selector & LX_return_path_on_delivery) != 0)
1357 s = string_append(s, &size, &ptr, 3, US" P=<", used_return_path, US">");
1359 if (addr->router != NULL)
1360 s = string_append(s, &size, &ptr, 2, US" R=", addr->router->name);
1361 if (addr->transport != NULL)
1362 s = string_append(s, &size, &ptr, 2, US" T=", addr->transport->name);
1364 if (addr->host_used != NULL)
1365 s = d_hostlog(s, &size, &ptr, addr);
1368 s = d_tlslog(s, &size, &ptr, addr);
1371 if (addr->basic_errno > 0)
1372 s = string_append(s, &size, &ptr, 2, US": ",
1373 US strerror(addr->basic_errno));
1375 if (addr->message != NULL)
1376 s = string_append(s, &size, &ptr, 2, US": ", addr->message);
1380 /* Do the logging. For the message log, "routing failed" for those cases,
1381 just to make it clearer. */
1383 if (driver_name == NULL)
1384 deliver_msglog("%s %s failed for %s\n", now, driver_kind, s);
1386 deliver_msglog("%s %s\n", now, s);
1388 log_write(0, LOG_MAIN, "** %s", s);
1390 #ifdef EXPERIMENTAL_EVENT
1391 msg_event_raise(US"msg:fail:delivery", addr);
1394 store_reset(reset_point);
1397 /* Ensure logging is turned on again in all cases */
1399 disable_logging = FALSE;
1405 /*************************************************
1406 * Address-independent error *
1407 *************************************************/
1409 /* This function is called when there's an error that is not dependent on a
1410 particular address, such as an expansion string failure. It puts the error into
1411 all the addresses in a batch, logs the incident on the main and panic logs, and
1412 clears the expansions. It is mostly called from local_deliver(), but can be
1413 called for a remote delivery via findugid().
1416 logit TRUE if (MAIN+PANIC) logging required
1417 addr the first of the chain of addresses
1419 format format string for error message, or NULL if already set in addr
1420 ... arguments for the format
1426 common_error(BOOL logit, address_item *addr, int code, uschar *format, ...)
1428 address_item *addr2;
1429 addr->basic_errno = code;
1435 va_start(ap, format);
1436 if (!string_vformat(buffer, sizeof(buffer), CS format, ap))
1437 log_write(0, LOG_MAIN|LOG_PANIC_DIE,
1438 "common_error expansion was longer than " SIZE_T_FMT, sizeof(buffer));
1440 addr->message = string_copy(buffer);
1443 for (addr2 = addr->next; addr2 != NULL; addr2 = addr2->next)
1445 addr2->basic_errno = code;
1446 addr2->message = addr->message;
1449 if (logit) log_write(0, LOG_MAIN|LOG_PANIC, "%s", addr->message);
1450 deliver_set_expansions(NULL);
1456 /*************************************************
1457 * Check a "never users" list *
1458 *************************************************/
1460 /* This function is called to check whether a uid is on one of the two "never
1464 uid the uid to be checked
1465 nusers the list to be scanned; the first item in the list is the count
1467 Returns: TRUE if the uid is on the list
1471 check_never_users(uid_t uid, uid_t *nusers)
1474 if (nusers == NULL) return FALSE;
1475 for (i = 1; i <= (int)(nusers[0]); i++) if (nusers[i] == uid) return TRUE;
1481 /*************************************************
1482 * Find uid and gid for a transport *
1483 *************************************************/
1485 /* This function is called for both local and remote deliveries, to find the
1486 uid/gid under which to run the delivery. The values are taken preferentially
1487 from the transport (either explicit or deliver_as_creator), then from the
1488 address (i.e. the router), and if nothing is set, the exim uid/gid are used. If
1489 the resulting uid is on the "never_users" or the "fixed_never_users" list, a
1490 panic error is logged, and the function fails (which normally leads to delivery
1494 addr the address (possibly a chain)
1496 uidp pointer to uid field
1497 gidp pointer to gid field
1498 igfp pointer to the use_initgroups field
1500 Returns: FALSE if failed - error has been set in address(es)
1504 findugid(address_item *addr, transport_instance *tp, uid_t *uidp, gid_t *gidp,
1507 uschar *nuname = NULL;
1508 BOOL gid_set = FALSE;
1510 /* Default initgroups flag comes from the transport */
1512 *igfp = tp->initgroups;
1514 /* First see if there's a gid on the transport, either fixed or expandable.
1515 The expanding function always logs failure itself. */
1522 else if (tp->expand_gid != NULL)
1524 if (route_find_expanded_group(tp->expand_gid, tp->name, US"transport", gidp,
1525 &(addr->message))) gid_set = TRUE;
1528 common_error(FALSE, addr, ERRNO_GIDFAIL, NULL);
1533 /* If the transport did not set a group, see if the router did. */
1535 if (!gid_set && testflag(addr, af_gid_set))
1541 /* Pick up a uid from the transport if one is set. */
1543 if (tp->uid_set) *uidp = tp->uid;
1545 /* Otherwise, try for an expandable uid field. If it ends up as a numeric id,
1546 it does not provide a passwd value from which a gid can be taken. */
1548 else if (tp->expand_uid != NULL)
1551 if (!route_find_expanded_user(tp->expand_uid, tp->name, US"transport", &pw,
1552 uidp, &(addr->message)))
1554 common_error(FALSE, addr, ERRNO_UIDFAIL, NULL);
1557 if (!gid_set && pw != NULL)
1564 /* If the transport doesn't set the uid, test the deliver_as_creator flag. */
1566 else if (tp->deliver_as_creator)
1568 *uidp = originator_uid;
1571 *gidp = originator_gid;
1576 /* Otherwise see if the address specifies the uid and if so, take it and its
1579 else if (testflag(addr, af_uid_set))
1582 *igfp = testflag(addr, af_initgroups);
1585 /* Nothing has specified the uid - default to the Exim user, and group if the
1598 /* If no gid is set, it is a disaster. We default to the Exim gid only if
1599 defaulting to the Exim uid. In other words, if the configuration has specified
1600 a uid, it must also provide a gid. */
1604 common_error(TRUE, addr, ERRNO_GIDFAIL, US"User set without group for "
1605 "%s transport", tp->name);
1609 /* Check that the uid is not on the lists of banned uids that may not be used
1610 for delivery processes. */
1612 if (check_never_users(*uidp, never_users))
1613 nuname = US"never_users";
1614 else if (check_never_users(*uidp, fixed_never_users))
1615 nuname = US"fixed_never_users";
1619 common_error(TRUE, addr, ERRNO_UIDFAIL, US"User %ld set for %s transport "
1620 "is on the %s list", (long int)(*uidp), tp->name, nuname);
1632 /*************************************************
1633 * Check the size of a message for a transport *
1634 *************************************************/
1636 /* Checks that the message isn't too big for the selected transport.
1637 This is called only when it is known that the limit is set.
1641 addr the (first) address being delivered
1644 DEFER expansion failed or did not yield an integer
1645 FAIL message too big
1649 check_message_size(transport_instance *tp, address_item *addr)
1654 deliver_set_expansions(addr);
1655 size_limit = expand_string_integer(tp->message_size_limit, TRUE);
1656 deliver_set_expansions(NULL);
1658 if (expand_string_message != NULL)
1661 if (size_limit == -1)
1662 addr->message = string_sprintf("failed to expand message_size_limit "
1663 "in %s transport: %s", tp->name, expand_string_message);
1665 addr->message = string_sprintf("invalid message_size_limit "
1666 "in %s transport: %s", tp->name, expand_string_message);
1668 else if (size_limit > 0 && message_size > size_limit)
1672 string_sprintf("message is too big (transport limit = %d)",
1681 /*************************************************
1682 * Transport-time check for a previous delivery *
1683 *************************************************/
1685 /* Check that this base address hasn't previously been delivered to its routed
1686 transport. If it has been delivered, mark it done. The check is necessary at
1687 delivery time in order to handle homonymic addresses correctly in cases where
1688 the pattern of redirection changes between delivery attempts (so the unique
1689 fields change). Non-homonymic previous delivery is detected earlier, at routing
1690 time (which saves unnecessary routing).
1693 addr the address item
1694 testing TRUE if testing wanted only, without side effects
1696 Returns: TRUE if previously delivered by the transport
1700 previously_transported(address_item *addr, BOOL testing)
1702 (void)string_format(big_buffer, big_buffer_size, "%s/%s",
1703 addr->unique + (testflag(addr, af_homonym)? 3:0), addr->transport->name);
1705 if (tree_search(tree_nonrecipients, big_buffer) != 0)
1707 DEBUG(D_deliver|D_route|D_transport)
1708 debug_printf("%s was previously delivered (%s transport): discarded\n",
1709 addr->address, addr->transport->name);
1710 if (!testing) child_done(addr, tod_stamp(tod_log));
1719 /******************************************************
1720 * Check for a given header in a header string *
1721 ******************************************************/
1723 /* This function is used when generating quota warnings. The configuration may
1724 specify any header lines it likes in quota_warn_message. If certain of them are
1725 missing, defaults are inserted, so we need to be able to test for the presence
1729 hdr the required header name
1730 hstring the header string
1732 Returns: TRUE the header is in the string
1733 FALSE the header is not in the string
1737 contains_header(uschar *hdr, uschar *hstring)
1739 int len = Ustrlen(hdr);
1740 uschar *p = hstring;
1743 if (strncmpic(p, hdr, len) == 0)
1746 while (*p == ' ' || *p == '\t') p++;
1747 if (*p == ':') return TRUE;
1749 while (*p != 0 && *p != '\n') p++;
1750 if (*p == '\n') p++;
1758 /*************************************************
1759 * Perform a local delivery *
1760 *************************************************/
1762 /* Each local delivery is performed in a separate process which sets its
1763 uid and gid as specified. This is a safer way than simply changing and
1764 restoring using seteuid(); there is a body of opinion that seteuid() cannot be
1765 used safely. From release 4, Exim no longer makes any use of it. Besides, not
1766 all systems have seteuid().
1768 If the uid/gid are specified in the transport_instance, they are used; the
1769 transport initialization must ensure that either both or neither are set.
1770 Otherwise, the values associated with the address are used. If neither are set,
1771 it is a configuration error.
1773 The transport or the address may specify a home directory (transport over-
1774 rides), and if they do, this is set as $home. If neither have set a working
1775 directory, this value is used for that as well. Otherwise $home is left unset
1776 and the cwd is set to "/" - a directory that should be accessible to all users.
1778 Using a separate process makes it more complicated to get error information
1779 back. We use a pipe to pass the return code and also an error code and error
1780 text string back to the parent process.
1783 addr points to an address block for this delivery; for "normal" local
1784 deliveries this is the only address to be delivered, but for
1785 pseudo-remote deliveries (e.g. by batch SMTP to a file or pipe)
1786 a number of addresses can be handled simultaneously, and in this
1787 case addr will point to a chain of addresses with the same
1790 shadowing TRUE if running a shadow transport; this causes output from pipes
1797 deliver_local(address_item *addr, BOOL shadowing)
1799 BOOL use_initgroups;
1802 int status, len, rc;
1805 uschar *working_directory;
1806 address_item *addr2;
1807 transport_instance *tp = addr->transport;
1809 /* Set up the return path from the errors or sender address. If the transport
1810 has its own return path setting, expand it and replace the existing value. */
1812 if(addr->prop.errors_address != NULL)
1813 return_path = addr->prop.errors_address;
1814 #ifdef EXPERIMENTAL_SRS
1815 else if(addr->prop.srs_sender != NULL)
1816 return_path = addr->prop.srs_sender;
1819 return_path = sender_address;
1821 if (tp->return_path != NULL)
1823 uschar *new_return_path = expand_string(tp->return_path);
1824 if (new_return_path == NULL)
1826 if (!expand_string_forcedfail)
1828 common_error(TRUE, addr, ERRNO_EXPANDFAIL,
1829 US"Failed to expand return path \"%s\" in %s transport: %s",
1830 tp->return_path, tp->name, expand_string_message);
1834 else return_path = new_return_path;
1837 /* For local deliveries, one at a time, the value used for logging can just be
1838 set directly, once and for all. */
1840 used_return_path = return_path;
1842 /* Sort out the uid, gid, and initgroups flag. If an error occurs, the message
1843 gets put into the address(es), and the expansions are unset, so we can just
1846 if (!findugid(addr, tp, &uid, &gid, &use_initgroups)) return;
1848 /* See if either the transport or the address specifies a home directory. A
1849 home directory set in the address may already be expanded; a flag is set to
1850 indicate that. In other cases we must expand it. */
1852 if ((deliver_home = tp->home_dir) != NULL || /* Set in transport, or */
1853 ((deliver_home = addr->home_dir) != NULL && /* Set in address and */
1854 !testflag(addr, af_home_expanded))) /* not expanded */
1856 uschar *rawhome = deliver_home;
1857 deliver_home = NULL; /* in case it contains $home */
1858 deliver_home = expand_string(rawhome);
1859 if (deliver_home == NULL)
1861 common_error(TRUE, addr, ERRNO_EXPANDFAIL, US"home directory \"%s\" failed "
1862 "to expand for %s transport: %s", rawhome, tp->name,
1863 expand_string_message);
1866 if (*deliver_home != '/')
1868 common_error(TRUE, addr, ERRNO_NOTABSOLUTE, US"home directory path \"%s\" "
1869 "is not absolute for %s transport", deliver_home, tp->name);
1874 /* See if either the transport or the address specifies a current directory,
1875 and if so, expand it. If nothing is set, use the home directory, unless it is
1876 also unset in which case use "/", which is assumed to be a directory to which
1877 all users have access. It is necessary to be in a visible directory for some
1878 operating systems when running pipes, as some commands (e.g. "rm" under Solaris
1879 2.5) require this. */
1881 working_directory = (tp->current_dir != NULL)?
1882 tp->current_dir : addr->current_dir;
1884 if (working_directory != NULL)
1886 uschar *raw = working_directory;
1887 working_directory = expand_string(raw);
1888 if (working_directory == NULL)
1890 common_error(TRUE, addr, ERRNO_EXPANDFAIL, US"current directory \"%s\" "
1891 "failed to expand for %s transport: %s", raw, tp->name,
1892 expand_string_message);
1895 if (*working_directory != '/')
1897 common_error(TRUE, addr, ERRNO_NOTABSOLUTE, US"current directory path "
1898 "\"%s\" is not absolute for %s transport", working_directory, tp->name);
1902 else working_directory = (deliver_home == NULL)? US"/" : deliver_home;
1904 /* If one of the return_output flags is set on the transport, create and open a
1905 file in the message log directory for the transport to write its output onto.
1906 This is mainly used by pipe transports. The file needs to be unique to the
1907 address. This feature is not available for shadow transports. */
1909 if (!shadowing && (tp->return_output || tp->return_fail_output ||
1910 tp->log_output || tp->log_fail_output))
1913 addr->return_filename =
1914 string_sprintf("%s/msglog/%s/%s-%d-%d", spool_directory, message_subdir,
1915 message_id, getpid(), return_count++);
1916 addr->return_file = open_msglog_file(addr->return_filename, 0400, &error);
1917 if (addr->return_file < 0)
1919 common_error(TRUE, addr, errno, US"Unable to %s file for %s transport "
1920 "to return message: %s", error, tp->name, strerror(errno));
1925 /* Create the pipe for inter-process communication. */
1929 common_error(TRUE, addr, ERRNO_PIPEFAIL, US"Creation of pipe failed: %s",
1934 /* Now fork the process to do the real work in the subprocess, but first
1935 ensure that all cached resources are freed so that the subprocess starts with
1936 a clean slate and doesn't interfere with the parent process. */
1940 if ((pid = fork()) == 0)
1942 BOOL replicate = TRUE;
1944 /* Prevent core dumps, as we don't want them in users' home directories.
1945 HP-UX doesn't have RLIMIT_CORE; I don't know how to do this in that
1946 system. Some experimental/developing systems (e.g. GNU/Hurd) may define
1947 RLIMIT_CORE but not support it in setrlimit(). For such systems, do not
1948 complain if the error is "not supported".
1950 There are two scenarios where changing the max limit has an effect. In one,
1951 the user is using a .forward and invoking a command of their choice via pipe;
1952 for these, we do need the max limit to be 0 unless the admin chooses to
1953 permit an increased limit. In the other, the command is invoked directly by
1954 the transport and is under administrator control, thus being able to raise
1955 the limit aids in debugging. So there's no general always-right answer.
1957 Thus we inhibit core-dumps completely but let individual transports, while
1958 still root, re-raise the limits back up to aid debugging. We make the
1959 default be no core-dumps -- few enough people can use core dumps in
1960 diagnosis that it's reasonable to make them something that has to be explicitly requested.
1967 if (setrlimit(RLIMIT_CORE, &rl) < 0)
1969 # ifdef SETRLIMIT_NOT_SUPPORTED
1970 if (errno != ENOSYS && errno != ENOTSUP)
1972 log_write(0, LOG_MAIN|LOG_PANIC, "setrlimit(RLIMIT_CORE) failed: %s",
1977 /* Reset the random number generator, so different processes don't all
1978 have the same sequence. */
1982 /* If the transport has a setup entry, call this first, while still
1983 privileged. (Appendfile uses this to expand quota, for example, while
1984 able to read private files.) */
1986 if (addr->transport->setup != NULL)
1988 switch((addr->transport->setup)(addr->transport, addr, NULL, uid, gid,
1992 addr->transport_return = DEFER;
1996 addr->transport_return = PANIC;
2001 /* Ignore SIGINT and SIGTERM during delivery. Also ignore SIGUSR1, as
2002 when the process becomes unprivileged, it won't be able to write to the
2003 process log. SIGHUP is ignored throughout exim, except when it is being
2006 signal(SIGINT, SIG_IGN);
2007 signal(SIGTERM, SIG_IGN);
2008 signal(SIGUSR1, SIG_IGN);
2010 /* Close the unwanted half of the pipe, and set close-on-exec for the other
2011 half - for transports that exec things (e.g. pipe). Then set the required
2014 (void)close(pfd[pipe_read]);
2015 (void)fcntl(pfd[pipe_write], F_SETFD, fcntl(pfd[pipe_write], F_GETFD) |
2017 exim_setugid(uid, gid, use_initgroups,
2018 string_sprintf("local delivery to %s <%s> transport=%s", addr->local_part,
2019 addr->address, addr->transport->name));
2023 address_item *batched;
2024 debug_printf(" home=%s current=%s\n", deliver_home, working_directory);
2025 for (batched = addr->next; batched != NULL; batched = batched->next)
2026 debug_printf("additional batched address: %s\n", batched->address);
2029 /* Set an appropriate working directory. */
2031 if (Uchdir(working_directory) < 0)
2033 addr->transport_return = DEFER;
2034 addr->basic_errno = errno;
2035 addr->message = string_sprintf("failed to chdir to %s", working_directory);
2038 /* If successful, call the transport */
2043 set_process_info("delivering %s to %s using %s", message_id,
2044 addr->local_part, addr->transport->name);
2046 /* Setting this global in the subprocess means we need never clear it */
2047 transport_name = addr->transport->name;
2049 /* If a transport filter has been specified, set up its argument list.
2050 Any errors will get put into the address, and FALSE yielded. */
2052 if (addr->transport->filter_command != NULL)
2054 ok = transport_set_up_command(&transport_filter_argv,
2055 addr->transport->filter_command,
2056 TRUE, PANIC, addr, US"transport filter", NULL);
2057 transport_filter_timeout = addr->transport->filter_timeout;
2059 else transport_filter_argv = NULL;
2063 debug_print_string(addr->transport->debug_string);
2064 replicate = !(addr->transport->info->code)(addr->transport, addr);
2068 /* Pass the results back down the pipe. If necessary, first replicate the
2069 status in the top address to the others in the batch. The label is the
2070 subject of a goto when a call to the transport's setup function fails. We
2071 pass the pointer to the transport back in case it got changed as a result of
2072 file_format in appendfile. */
2076 if (replicate) replicate_status(addr);
2077 for (addr2 = addr; addr2 != NULL; addr2 = addr2->next)
2080 int local_part_length = Ustrlen(addr2->local_part);
2084 if( (ret = write(pfd[pipe_write], (void *)&(addr2->transport_return), sizeof(int))) != sizeof(int)
2085 || (ret = write(pfd[pipe_write], (void *)&transport_count, sizeof(transport_count))) != sizeof(transport_count)
2086 || (ret = write(pfd[pipe_write], (void *)&(addr2->flags), sizeof(addr2->flags))) != sizeof(addr2->flags)
2087 || (ret = write(pfd[pipe_write], (void *)&(addr2->basic_errno), sizeof(int))) != sizeof(int)
2088 || (ret = write(pfd[pipe_write], (void *)&(addr2->more_errno), sizeof(int))) != sizeof(int)
2089 || (ret = write(pfd[pipe_write], (void *)&(addr2->special_action), sizeof(int))) != sizeof(int)
2090 || (ret = write(pfd[pipe_write], (void *)&(addr2->transport),
2091 sizeof(transport_instance *))) != sizeof(transport_instance *)
2093 /* For a file delivery, pass back the local part, in case the original
2094 was only part of the final delivery path. This gives more complete
2097 || (testflag(addr2, af_file)
2098 && ( (ret = write(pfd[pipe_write], (void *)&local_part_length, sizeof(int))) != sizeof(int)
2099 || (ret = write(pfd[pipe_write], addr2->local_part, local_part_length)) != local_part_length
2103 log_write(0, LOG_MAIN|LOG_PANIC, "Failed writing transport results to pipe: %s\n",
2104 ret == -1 ? strerror(errno) : "short write");
2106 /* Now any messages */
2108 for (i = 0, s = addr2->message; i < 2; i++, s = addr2->user_message)
2110 int message_length = (s == NULL)? 0 : Ustrlen(s) + 1;
2111 if( (ret = write(pfd[pipe_write], (void *)&message_length, sizeof(int))) != sizeof(int)
2112 || (message_length > 0 && (ret = write(pfd[pipe_write], s, message_length)) != message_length)
2114 log_write(0, LOG_MAIN|LOG_PANIC, "Failed writing transport results to pipe: %s\n",
2115 ret == -1 ? strerror(errno) : "short write");
2119 /* OK, this process is now done. Free any cached resources that it opened,
2120 and close the pipe we were writing down before exiting. */
2122 (void)close(pfd[pipe_write]);
2127 /* Back in the main process: panic if the fork did not succeed. This seems
2128 better than returning an error - if forking is failing it is probably best
2129 not to try other deliveries for this message. */
2132 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Fork failed for local delivery to %s",
2135 /* Read the pipe to get the delivery status codes and error messages. Our copy
2136 of the writing end must be closed first, as otherwise read() won't return zero
2137 on an empty pipe. We check that a status exists for each address before
2138 overwriting the address structure. If data is missing, the default DEFER status
2139 will remain. Afterwards, close the reading end. */
2141 (void)close(pfd[pipe_write]);
2143 for (addr2 = addr; addr2 != NULL; addr2 = addr2->next)
2145 len = read(pfd[pipe_read], (void *)&status, sizeof(int));
2151 addr2->transport_return = status;
2152 len = read(pfd[pipe_read], (void *)&transport_count,
2153 sizeof(transport_count));
2154 len = read(pfd[pipe_read], (void *)&(addr2->flags), sizeof(addr2->flags));
2155 len = read(pfd[pipe_read], (void *)&(addr2->basic_errno), sizeof(int));
2156 len = read(pfd[pipe_read], (void *)&(addr2->more_errno), sizeof(int));
2157 len = read(pfd[pipe_read], (void *)&(addr2->special_action), sizeof(int));
2158 len = read(pfd[pipe_read], (void *)&(addr2->transport),
2159 sizeof(transport_instance *));
2161 if (testflag(addr2, af_file))
2163 int local_part_length;
2164 len = read(pfd[pipe_read], (void *)&local_part_length, sizeof(int));
2165 len = read(pfd[pipe_read], (void *)big_buffer, local_part_length);
2166 big_buffer[local_part_length] = 0;
2167 addr2->local_part = string_copy(big_buffer);
2170 for (i = 0, sptr = &(addr2->message); i < 2;
2171 i++, sptr = &(addr2->user_message))
2174 len = read(pfd[pipe_read], (void *)&message_length, sizeof(int));
2175 if (message_length > 0)
2177 len = read(pfd[pipe_read], (void *)big_buffer, message_length);
2178 if (len > 0) *sptr = string_copy(big_buffer);
2185 log_write(0, LOG_MAIN|LOG_PANIC, "failed to read delivery status for %s "
2186 "from delivery subprocess", addr2->unique);
2191 (void)close(pfd[pipe_read]);
2193 /* Unless shadowing, write all successful addresses immediately to the journal
2194 file, to ensure they are recorded asap. For homonymic addresses, use the base
2195 address plus the transport name. Failure to write the journal is panic-worthy,
2196 but don't stop, as it may prove possible subsequently to update the spool file
2197 in order to record the delivery. */
2201 for (addr2 = addr; addr2 != NULL; addr2 = addr2->next)
2203 if (addr2->transport_return != OK) continue;
2205 if (testflag(addr2, af_homonym))
2206 sprintf(CS big_buffer, "%.500s/%s\n", addr2->unique + 3, tp->name);
2208 sprintf(CS big_buffer, "%.500s\n", addr2->unique);
2210 /* In the test harness, wait just a bit to let the subprocess finish off
2211 any debug output etc first. */
2213 if (running_in_test_harness) millisleep(300);
2215 DEBUG(D_deliver) debug_printf("journalling %s", big_buffer);
2216 len = Ustrlen(big_buffer);
2217 if (write(journal_fd, big_buffer, len) != len)
2218 log_write(0, LOG_MAIN|LOG_PANIC, "failed to update journal for %s: %s",
2219 big_buffer, strerror(errno));
2222 /* Ensure the journal file is pushed out to disk. */
2224 if (EXIMfsync(journal_fd) < 0)
2225 log_write(0, LOG_MAIN|LOG_PANIC, "failed to fsync journal: %s",
2229 /* Wait for the process to finish. If it terminates with a non-zero code,
2230 freeze the message (except for SIGTERM, SIGKILL and SIGQUIT), but leave the
2231 status values of all the addresses as they are. Take care to handle the case
2232 when the subprocess doesn't seem to exist. This has been seen on one system
2233 when Exim was called from an MUA that set SIGCHLD to SIG_IGN. When that
2234 happens, wait() doesn't recognize the termination of child processes. Exim now
2235 resets SIGCHLD to SIG_DFL, but this code should still be robust. */
2237 while ((rc = wait(&status)) != pid)
2239 if (rc < 0 && errno == ECHILD) /* Process has vanished */
2241 log_write(0, LOG_MAIN, "%s transport process vanished unexpectedly",
2242 addr->transport->driver_name);
2248 if ((status & 0xffff) != 0)
2250 int msb = (status >> 8) & 255;
2251 int lsb = status & 255;
2252 int code = (msb == 0)? (lsb & 0x7f) : msb;
2253 if (msb != 0 || (code != SIGTERM && code != SIGKILL && code != SIGQUIT))
2254 addr->special_action = SPECIAL_FREEZE;
2255 log_write(0, LOG_MAIN|LOG_PANIC, "%s transport process returned non-zero "
2256 "status 0x%04x: %s %d",
2257 addr->transport->driver_name,
2259 (msb == 0)? "terminated by signal" : "exit code",
2263 /* If SPECIAL_WARN is set in the top address, send a warning message. */
2265 if (addr->special_action == SPECIAL_WARN &&
2266 addr->transport->warn_message != NULL)
2269 uschar *warn_message;
2271 DEBUG(D_deliver) debug_printf("Warning message requested by transport\n");
2273 warn_message = expand_string(addr->transport->warn_message);
2274 if (warn_message == NULL)
2275 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand \"%s\" (warning "
2276 "message for %s transport): %s", addr->transport->warn_message,
2277 addr->transport->name, expand_string_message);
2280 pid_t pid = child_open_exim(&fd);
2283 FILE *f = fdopen(fd, "wb");
2284 if (errors_reply_to != NULL &&
2285 !contains_header(US"Reply-To", warn_message))
2286 fprintf(f, "Reply-To: %s\n", errors_reply_to);
2287 fprintf(f, "Auto-Submitted: auto-replied\n");
2288 if (!contains_header(US"From", warn_message)) moan_write_from(f);
2289 fprintf(f, "%s", CS warn_message);
2291 /* Close and wait for child process to complete, without a timeout. */
2294 (void)child_close(pid, 0);
2298 addr->special_action = SPECIAL_NONE;
2304 /*************************************************
2305 * Do local deliveries *
2306 *************************************************/
2308 /* This function processes the list of addresses in addr_local. True local
2309 deliveries are always done one address at a time. However, local deliveries can
2310 be batched up in some cases. Typically this is when writing batched SMTP output
2311 files for use by some external transport mechanism, or when running local
2312 deliveries over LMTP.
2319 do_local_deliveries(void)
2322 open_db *dbm_file = NULL;
2323 time_t now = time(NULL);
2325 /* Loop until we have exhausted the supply of local deliveries */
2327 while (addr_local != NULL)
2329 time_t delivery_start;
2331 address_item *addr2, *addr3, *nextaddr;
2332 int logflags = LOG_MAIN;
2333 int logchar = dont_deliver? '*' : '=';
2334 transport_instance *tp;
2336 /* Pick the first undelivered address off the chain */
2338 address_item *addr = addr_local;
2339 addr_local = addr->next;
2342 DEBUG(D_deliver|D_transport)
2343 debug_printf("--------> %s <--------\n", addr->address);
2345 /* An internal disaster if there is no transport. Should not occur! */
2347 if ((tp = addr->transport) == NULL)
2349 logflags |= LOG_PANIC;
2350 disable_logging = FALSE; /* Jic */
2352 (addr->router != NULL)?
2353 string_sprintf("No transport set by %s router", addr->router->name)
2355 string_sprintf("No transport set by system filter");
2356 post_process_one(addr, DEFER, logflags, DTYPE_TRANSPORT, 0);
2360 /* Check that this base address hasn't previously been delivered to this
2361 transport. The check is necessary at this point to handle homonymic addresses
2362 correctly in cases where the pattern of redirection changes between delivery
2363 attempts. Non-homonymic previous delivery is detected earlier, at routing
2366 if (previously_transported(addr, FALSE)) continue;
2368 /* There are weird cases where logging is disabled */
2370 disable_logging = tp->disable_logging;
2372 /* Check for batched addresses and possible amalgamation. Skip all the work
2373 if either batch_max <= 1 or there aren't any other addresses for local
2376 if (tp->batch_max > 1 && addr_local != NULL)
2378 int batch_count = 1;
2379 BOOL uses_dom = readconf_depends((driver_instance *)tp, US"domain");
2380 BOOL uses_lp = (testflag(addr, af_pfr) &&
2381 (testflag(addr, af_file) || addr->local_part[0] == '|')) ||
2382 readconf_depends((driver_instance *)tp, US"local_part");
2383 uschar *batch_id = NULL;
2384 address_item **anchor = &addr_local;
2385 address_item *last = addr;
2388 /* Expand the batch_id string for comparison with other addresses.
2389 Expansion failure suppresses batching. */
2391 if (tp->batch_id != NULL)
2393 deliver_set_expansions(addr);
2394 batch_id = expand_string(tp->batch_id);
2395 deliver_set_expansions(NULL);
2396 if (batch_id == NULL)
2398 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand batch_id option "
2399 "in %s transport (%s): %s", tp->name, addr->address,
2400 expand_string_message);
2401 batch_count = tp->batch_max;
2405 /* Until we reach the batch_max limit, pick off addresses which have the
2406 same characteristics. These are:
2409 not previously delivered (see comment about 50 lines above)
2410 same local part if the transport's configuration contains $local_part
2411 or if this is a file or pipe delivery from a redirection
2412 same domain if the transport's configuration contains $domain
2414 same additional headers
2415 same headers to be removed
2416 same uid/gid for running the transport
2417 same first host if a host list is set
2420 while ((next = *anchor) != NULL && batch_count < tp->batch_max)
2423 tp == next->transport &&
2424 !previously_transported(next, TRUE) &&
2425 (addr->flags & (af_pfr|af_file)) == (next->flags & (af_pfr|af_file)) &&
2426 (!uses_lp || Ustrcmp(next->local_part, addr->local_part) == 0) &&
2427 (!uses_dom || Ustrcmp(next->domain, addr->domain) == 0) &&
2428 same_strings(next->prop.errors_address, addr->prop.errors_address) &&
2429 same_headers(next->prop.extra_headers, addr->prop.extra_headers) &&
2430 same_strings(next->prop.remove_headers, addr->prop.remove_headers) &&
2431 same_ugid(tp, addr, next) &&
2432 ((addr->host_list == NULL && next->host_list == NULL) ||
2433 (addr->host_list != NULL && next->host_list != NULL &&
2434 Ustrcmp(addr->host_list->name, next->host_list->name) == 0));
2436 /* If the transport has a batch_id setting, batch_id will be non-NULL
2437 from the expansion outside the loop. Expand for this address and compare.
2438 Expansion failure makes this address ineligible for batching. */
2440 if (ok && batch_id != NULL)
2443 address_item *save_nextnext = next->next;
2444 next->next = NULL; /* Expansion for a single address */
2445 deliver_set_expansions(next);
2446 next->next = save_nextnext;
2447 bid = expand_string(tp->batch_id);
2448 deliver_set_expansions(NULL);
2451 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand batch_id option "
2452 "in %s transport (%s): %s", tp->name, next->address,
2453 expand_string_message);
2456 else ok = (Ustrcmp(batch_id, bid) == 0);
2459 /* Take address into batch if OK. */
2463 *anchor = next->next; /* Include the address */
2469 else anchor = &(next->next); /* Skip the address */
2473 /* We now have one or more addresses that can be delivered in a batch. Check
2474 whether the transport is prepared to accept a message of this size. If not,
2475 fail them all forthwith. If the expansion fails, or does not yield an
2476 integer, defer delivery. */
2478 if (tp->message_size_limit != NULL)
2480 int rc = check_message_size(tp, addr);
2483 replicate_status(addr);
2484 while (addr != NULL)
2487 post_process_one(addr, rc, logflags, DTYPE_TRANSPORT, 0);
2490 continue; /* With next batch of addresses */
2494 /* If we are not running the queue, or if forcing, all deliveries will be
2495 attempted. Otherwise, we must respect the retry times for each address. Even
2496 when not doing this, we need to set up the retry key string, and determine
2497 whether a retry record exists, because after a successful delivery, a delete
2498 retry item must be set up. Keep the retry database open only for the duration
2499 of these checks, rather than for all local deliveries, because some local
2500 deliveries (e.g. to pipes) can take a substantial time. */
2502 dbm_file = dbfn_open(US"retry", O_RDONLY, &dbblock, FALSE);
2503 if (dbm_file == NULL)
2505 DEBUG(D_deliver|D_retry|D_hints_lookup)
2506 debug_printf("no retry data available\n");
2511 while (addr2 != NULL)
2513 BOOL ok = TRUE; /* to deliver this address */
2516 /* Set up the retry key to include the domain or not, and change its
2517 leading character from "R" to "T". Must make a copy before doing this,
2518 because the old key may be pointed to from a "delete" retry item after
2521 retry_key = string_copy(
2522 (tp->retry_use_local_part)? addr2->address_retry_key :
2523 addr2->domain_retry_key);
2526 /* Inspect the retry data. If there is no hints file, delivery happens. */
2528 if (dbm_file != NULL)
2530 dbdata_retry *retry_record = dbfn_read(dbm_file, retry_key);
2532 /* If there is no retry record, delivery happens. If there is,
2533 remember it exists so it can be deleted after a successful delivery. */
2535 if (retry_record != NULL)
2537 setflag(addr2, af_lt_retry_exists);
2539 /* A retry record exists for this address. If queue running and not
2540 forcing, inspect its contents. If the record is too old, or if its
2541 retry time has come, or if it has passed its cutoff time, delivery
2546 debug_printf("retry record exists: age=%s ",
2547 readconf_printtime(now - retry_record->time_stamp));
2548 debug_printf("(max %s)\n", readconf_printtime(retry_data_expire));
2549 debug_printf(" time to retry = %s expired = %d\n",
2550 readconf_printtime(retry_record->next_try - now),
2551 retry_record->expired);
2554 if (queue_running && !deliver_force)
2556 ok = (now - retry_record->time_stamp > retry_data_expire) ||
2557 (now >= retry_record->next_try) ||
2558 retry_record->expired;
2560 /* If we haven't reached the retry time, there is one more check
2561 to do, which is for the ultimate address timeout. */
2564 ok = retry_ultimate_address_timeout(retry_key, addr2->domain,
2568 else DEBUG(D_retry) debug_printf("no retry record exists\n");
2571 /* This address is to be delivered. Leave it on the chain. */
2576 addr2 = addr2->next;
2579 /* This address is to be deferred. Take it out of the chain, and
2580 post-process it as complete. Must take it out of the chain first,
2581 because post processing puts it on another chain. */
2585 address_item *this = addr2;
2586 this->message = US"Retry time not yet reached";
2587 this->basic_errno = ERRNO_LRETRY;
2588 if (addr3 == NULL) addr2 = addr = addr2->next;
2589 else addr2 = addr3->next = addr2->next;
2590 post_process_one(this, DEFER, logflags, DTYPE_TRANSPORT, 0);
2594 if (dbm_file != NULL) dbfn_close(dbm_file);
2596 /* If there are no addresses left on the chain, they all deferred. Loop
2597 for the next set of addresses. */
2599 if (addr == NULL) continue;
2601 /* So, finally, we do have some addresses that can be passed to the
2602 transport. Before doing so, set up variables that are relevant to a
2605 deliver_set_expansions(addr);
2606 delivery_start = time(NULL);
2607 deliver_local(addr, FALSE);
2608 deliver_time = (int)(time(NULL) - delivery_start);
2610 /* If a shadow transport (which must perforce be another local transport), is
2611 defined, and its condition is met, we must pass the message to the shadow
2612 too, but only those addresses that succeeded. We do this by making a new
2613 chain of addresses - also to keep the original chain uncontaminated. We must
2614 use a chain rather than doing it one by one, because the shadow transport may
2617 NOTE: if the condition fails because of a lookup defer, there is nothing we
2620 if (tp->shadow != NULL &&
2621 (tp->shadow_condition == NULL ||
2622 expand_check_condition(tp->shadow_condition, tp->name, US"transport")))
2624 transport_instance *stp;
2625 address_item *shadow_addr = NULL;
2626 address_item **last = &shadow_addr;
2628 for (stp = transports; stp != NULL; stp = stp->next)
2629 if (Ustrcmp(stp->name, tp->shadow) == 0) break;
2632 log_write(0, LOG_MAIN|LOG_PANIC, "shadow transport \"%s\" not found ",
2635 /* Pick off the addresses that have succeeded, and make clones. Put into
2636 the shadow_message field a pointer to the shadow_message field of the real
2639 else for (addr2 = addr; addr2 != NULL; addr2 = addr2->next)
2641 if (addr2->transport_return != OK) continue;
2642 addr3 = store_get(sizeof(address_item));
2645 addr3->shadow_message = (uschar *)(&(addr2->shadow_message));
2646 addr3->transport = stp;
2647 addr3->transport_return = DEFER;
2648 addr3->return_filename = NULL;
2649 addr3->return_file = -1;
2651 last = &(addr3->next);
2654 /* If we found any addresses to shadow, run the delivery, and stick any
2655 message back into the shadow_message field in the original. */
2657 if (shadow_addr != NULL)
2659 int save_count = transport_count;
2661 DEBUG(D_deliver|D_transport)
2662 debug_printf(">>>>>>>>>>>>>>>> Shadow delivery >>>>>>>>>>>>>>>>\n");
2663 deliver_local(shadow_addr, TRUE);
2665 for(; shadow_addr != NULL; shadow_addr = shadow_addr->next)
2667 int sresult = shadow_addr->transport_return;
2668 *((uschar **)(shadow_addr->shadow_message)) = (sresult == OK)?
2669 string_sprintf(" ST=%s", stp->name) :
2670 string_sprintf(" ST=%s (%s%s%s)", stp->name,
2671 (shadow_addr->basic_errno <= 0)?
2672 US"" : US strerror(shadow_addr->basic_errno),
2673 (shadow_addr->basic_errno <= 0 || shadow_addr->message == NULL)?
2675 (shadow_addr->message != NULL)? shadow_addr->message :
2676 (shadow_addr->basic_errno <= 0)? US"unknown error" : US"");
2678 DEBUG(D_deliver|D_transport)
2679 debug_printf("%s shadow transport returned %s for %s\n",
2681 (sresult == OK)? "OK" :
2682 (sresult == DEFER)? "DEFER" :
2683 (sresult == FAIL)? "FAIL" :
2684 (sresult == PANIC)? "PANIC" : "?",
2685 shadow_addr->address);
2688 DEBUG(D_deliver|D_transport)
2689 debug_printf(">>>>>>>>>>>>>>>> End shadow delivery >>>>>>>>>>>>>>>>\n");
2691 transport_count = save_count; /* Restore original transport count */
2695 /* Cancel the expansions that were set up for the delivery. */
2697 deliver_set_expansions(NULL);
2699 /* Now we can process the results of the real transport. We must take each
2700 address off the chain first, because post_process_one() puts it on another
2703 for (addr2 = addr; addr2 != NULL; addr2 = nextaddr)
2705 int result = addr2->transport_return;
2706 nextaddr = addr2->next;
2708 DEBUG(D_deliver|D_transport)
2709 debug_printf("%s transport returned %s for %s\n",
2711 (result == OK)? "OK" :
2712 (result == DEFER)? "DEFER" :
2713 (result == FAIL)? "FAIL" :
2714 (result == PANIC)? "PANIC" : "?",
2717 /* If there is a retry_record, or if delivery is deferred, build a retry
2718 item for setting a new retry time or deleting the old retry record from
2719 the database. These items are handled all together after all addresses
2720 have been handled (so the database is open just for a short time for
2723 if (result == DEFER || testflag(addr2, af_lt_retry_exists))
2725 int flags = (result == DEFER)? 0 : rf_delete;
2726 uschar *retry_key = string_copy((tp->retry_use_local_part)?
2727 addr2->address_retry_key : addr2->domain_retry_key);
2729 retry_add_item(addr2, retry_key, flags);
2732 /* Done with this address */
2734 if (result == OK) addr2->more_errno = deliver_time;
2735 post_process_one(addr2, result, logflags, DTYPE_TRANSPORT, logchar);
2737 /* If a pipe delivery generated text to be sent back, the result may be
2738 changed to FAIL, and we must copy this for subsequent addresses in the
2741 if (addr2->transport_return != result)
2743 for (addr3 = nextaddr; addr3 != NULL; addr3 = addr3->next)
2745 addr3->transport_return = addr2->transport_return;
2746 addr3->basic_errno = addr2->basic_errno;
2747 addr3->message = addr2->message;
2749 result = addr2->transport_return;
2752 /* Whether or not the result was changed to FAIL, we need to copy the
2753 return_file value from the first address into all the addresses of the
2754 batch, so they are all listed in the error message. */
2756 addr2->return_file = addr->return_file;
2758 /* Change log character for recording successful deliveries. */
2760 if (result == OK) logchar = '-';
2762 } /* Loop back for next batch of addresses */
2768 /*************************************************
2769 * Sort remote deliveries *
2770 *************************************************/
2772 /* This function is called if remote_sort_domains is set. It arranges that the
2773 chain of addresses for remote deliveries is ordered according to the strings
2774 specified. Try to make this shuffling reasonably efficient by handling
2775 sequences of addresses rather than just single ones.
2782 sort_remote_deliveries(void)
2785 address_item **aptr = &addr_remote;
2786 const uschar *listptr = remote_sort_domains;
2790 while (*aptr != NULL &&
2791 (pattern = string_nextinlist(&listptr, &sep, patbuf, sizeof(patbuf)))
2794 address_item *moved = NULL;
2795 address_item **bptr = &moved;
2797 while (*aptr != NULL)
2799 address_item **next;
2800 deliver_domain = (*aptr)->domain; /* set $domain */
2801 if (match_isinlist(deliver_domain, (const uschar **)&pattern, UCHAR_MAX+1,
2802 &domainlist_anchor, NULL, MCL_DOMAIN, TRUE, NULL) == OK)
2804 aptr = &((*aptr)->next);
2808 next = &((*aptr)->next);
2809 while (*next != NULL &&
2810 (deliver_domain = (*next)->domain, /* Set $domain */
2811 match_isinlist(deliver_domain, (const uschar **)&pattern, UCHAR_MAX+1,
2812 &domainlist_anchor, NULL, MCL_DOMAIN, TRUE, NULL)) != OK)
2813 next = &((*next)->next);
2815 /* If the batch of non-matchers is at the end, add on any that were
2816 extracted further up the chain, and end this iteration. Otherwise,
2817 extract them from the chain and hang on the moved chain. */
2829 aptr = &((*aptr)->next);
2832 /* If the loop ended because the final address matched, *aptr will
2833 be NULL. Add on to the end any extracted non-matching addresses. If
2834 *aptr is not NULL, the loop ended via "break" when *next is null, that
2835 is, there was a string of non-matching addresses at the end. In this
2836 case the extracted addresses have already been added on the end. */
2838 if (*aptr == NULL) *aptr = moved;
2844 debug_printf("remote addresses after sorting:\n");
2845 for (addr = addr_remote; addr != NULL; addr = addr->next)
2846 debug_printf(" %s\n", addr->address);
2852 /*************************************************
2853 * Read from pipe for remote delivery subprocess *
2854 *************************************************/
2856 /* This function is called when the subprocess is complete, but can also be
2857 called before it is complete, in order to empty a pipe that is full (to prevent
2858 deadlock). It must therefore keep track of its progress in the parlist data
2861 We read the pipe to get the delivery status codes and a possible error message
2862 for each address, optionally preceded by unusability data for the hosts and
2863 also by optional retry data.
2865 Read in large chunks into the big buffer and then scan through, interpreting
2866 the data therein. In most cases, only a single read will be necessary. No
2867 individual item will ever be anywhere near 2500 bytes in length, so by ensuring
2868 that we read the next chunk when there is less than 2500 bytes left in the
2869 non-final chunk, we can assume each item is complete in the buffer before
2870 handling it. Each item is written using a single write(), which is atomic for
2871 small items (less than PIPE_BUF, which seems to be at least 512 in any Unix and
2872 often bigger) so even if we are reading while the subprocess is still going, we
2873 should never have only a partial item in the buffer.
2876 poffset the offset of the parlist item
2877 eop TRUE if the process has completed
2879 Returns: TRUE if the terminating 'Z' item has been read,
2880 or there has been a disaster (i.e. no more data needed);
2885 par_read_pipe(int poffset, BOOL eop)
2888 pardata *p = parlist + poffset;
2889 address_item *addrlist = p->addrlist;
2890 address_item *addr = p->addr;
2893 uschar *endptr = big_buffer;
2894 uschar *ptr = endptr;
2895 uschar *msg = p->msg;
2896 BOOL done = p->done;
2897 BOOL unfinished = TRUE;
2898 /* minimum size to read is header size including id, subid and length */
2899 int required = PIPE_HEADER_SIZE;
2901 /* Loop through all items, reading from the pipe when necessary. The pipe
2902 is set up to be non-blocking, but there are two different Unix mechanisms in
2903 use. Exim uses O_NONBLOCK if it is defined. This returns 0 for end of file,
2904 and EAGAIN for no more data. If O_NONBLOCK is not defined, Exim uses O_NDELAY,
2905 which returns 0 for both end of file and no more data. We distinguish the
2906 two cases by taking 0 as end of file only when we know the process has
2909 Each separate item is written to the pipe in a single write(), and as they are
2910 all short items, the writes will all be atomic and we should never find
2911 ourselves in the position of having read an incomplete item. "Short" in this
2912 case can mean up to about 1K in the case when there is a long error message
2913 associated with an address. */
2915 DEBUG(D_deliver) debug_printf("reading pipe for subprocess %d (%s)\n",
2916 (int)p->pid, eop? "ended" : "not ended");
2920 retry_item *r, **rp;
2921 int remaining = endptr - ptr;
2922 uschar header[PIPE_HEADER_SIZE + 1];
2926 /* Read (first time) or top up the chars in the buffer if necessary.
2927 There will be only one read if we get all the available data (i.e. don't
2928 fill the buffer completely). */
2930 if (remaining < required && unfinished)
2933 int available = big_buffer_size - remaining;
2935 if (remaining > 0) memmove(big_buffer, ptr, remaining);
2938 endptr = big_buffer + remaining;
2939 len = read(fd, endptr, available);
2941 DEBUG(D_deliver) debug_printf("read() yielded %d\n", len);
2943 /* If the result is EAGAIN and the process is not complete, just
2944 stop reading any more and process what we have already. */
2948 if (!eop && errno == EAGAIN) len = 0; else
2950 msg = string_sprintf("failed to read pipe from transport process "
2951 "%d for transport %s: %s", pid, addr->transport->driver_name,
2957 /* If the length is zero (eof or no-more-data), just process what we
2958 already have. Note that if the process is still running and we have
2959 read all the data in the pipe (but less that "available") then we
2960 won't read any more, as "unfinished" will get set FALSE. */
2964 unfinished = len == available;
2967 /* If we are at the end of the available data, exit the loop. */
2968 if (ptr >= endptr) break;
2970 /* copy and read header */
2971 memcpy(header, ptr, PIPE_HEADER_SIZE);
2972 header[PIPE_HEADER_SIZE] = '\0';
2975 required = Ustrtol(header + 2, &endc, 10) + PIPE_HEADER_SIZE; /* header + data */
2978 msg = string_sprintf("failed to read pipe from transport process "
2979 "%d for transport %s: error reading size from header", pid, addr->transport->driver_name);
2985 debug_printf("header read id:%c,subid:%c,size:%s,required:%d,remaining:%d,unfinished:%d\n",
2986 id, subid, header+2, required, remaining, unfinished);
2988 /* is there room for the dataset we want to read ? */
2989 if (required > big_buffer_size - PIPE_HEADER_SIZE)
2991 msg = string_sprintf("failed to read pipe from transport process "
2992 "%d for transport %s: big_buffer too small! required size=%d buffer size=%d", pid, addr->transport->driver_name,
2993 required, big_buffer_size - PIPE_HEADER_SIZE);
2998 /* we wrote all datasets with atomic write() calls
2999 remaining < required only happens if big_buffer was too small
3000 to get all available data from pipe. unfinished has to be true
3002 if (remaining < required)
3006 msg = string_sprintf("failed to read pipe from transport process "
3007 "%d for transport %s: required size=%d > remaining size=%d and unfinished=false",
3008 pid, addr->transport->driver_name, required, remaining);
3013 /* step behind the header */
3014 ptr += PIPE_HEADER_SIZE;
3016 /* Handle each possible type of item, assuming the complete item is
3017 available in store. */
3021 /* Host items exist only if any hosts were marked unusable. Match
3022 up by checking the IP address. */
3025 for (h = addrlist->host_list; h != NULL; h = h->next)
3027 if (h->address == NULL || Ustrcmp(h->address, ptr+2) != 0) continue;
3035 /* Retry items are sent in a preceding R item for each address. This is
3036 kept separate to keep each message short enough to guarantee it won't
3037 be split in the pipe. Hopefully, in the majority of cases, there won't in
3038 fact be any retry items at all.
3040 The complete set of retry items might include an item to delete a
3041 routing retry if there was a previous routing delay. However, routing
3042 retries are also used when a remote transport identifies an address error.
3043 In that case, there may also be an "add" item for the same key. Arrange
3044 that a "delete" item is dropped in favour of an "add" item. */
3047 if (addr == NULL) goto ADDR_MISMATCH;
3049 DEBUG(D_deliver|D_retry)
3050 debug_printf("reading retry information for %s from subprocess\n",
3053 /* Cut out any "delete" items on the list. */
3055 for (rp = &(addr->retries); (r = *rp) != NULL; rp = &(r->next))
3057 if (Ustrcmp(r->key, ptr+1) == 0) /* Found item with same key */
3059 if ((r->flags & rf_delete) == 0) break; /* It was not "delete" */
3060 *rp = r->next; /* Excise a delete item */
3061 DEBUG(D_deliver|D_retry)
3062 debug_printf(" existing delete item dropped\n");
3066 /* We want to add a delete item only if there is no non-delete item;
3067 however we still have to step ptr through the data. */
3069 if (r == NULL || (*ptr & rf_delete) == 0)
3071 r = store_get(sizeof(retry_item));
3072 r->next = addr->retries;
3075 r->key = string_copy(ptr);
3077 memcpy(&(r->basic_errno), ptr, sizeof(r->basic_errno));
3078 ptr += sizeof(r->basic_errno);
3079 memcpy(&(r->more_errno), ptr, sizeof(r->more_errno));
3080 ptr += sizeof(r->more_errno);
3081 r->message = (*ptr)? string_copy(ptr) : NULL;
3082 DEBUG(D_deliver|D_retry)
3083 debug_printf(" added %s item\n",
3084 ((r->flags & rf_delete) == 0)? "retry" : "delete");
3089 DEBUG(D_deliver|D_retry)
3090 debug_printf(" delete item not added: non-delete item exists\n");
3093 ptr += sizeof(r->basic_errno) + sizeof(r->more_errno);
3099 /* Put the amount of data written into the parlist block */
3102 memcpy(&(p->transport_count), ptr, sizeof(transport_count));
3103 ptr += sizeof(transport_count);
3106 /* Address items are in the order of items on the address chain. We
3107 remember the current address value in case this function is called
3108 several times to empty the pipe in stages. Information about delivery
3109 over TLS is sent in a preceding X item for each address. We don't put
3110 it in with the other info, in order to keep each message short enough to
3111 guarantee it won't be split in the pipe. */
3115 if (addr == NULL) goto ADDR_MISMATCH; /* Below, in 'A' handler */
3119 addr->cipher = NULL;
3120 addr->peerdn = NULL;
3123 addr->cipher = string_copy(ptr);
3126 addr->peerdn = string_copy(ptr);
3131 (void) tls_import_cert(ptr, &addr->peercert);
3133 addr->peercert = NULL;
3138 (void) tls_import_cert(ptr, &addr->ourcert);
3140 addr->ourcert = NULL;
3143 # ifndef DISABLE_OCSP
3145 addr->ocsp = OCSP_NOT_REQ;
3147 addr->ocsp = *ptr - '0';
3153 #endif /*SUPPORT_TLS*/
3155 case 'C': /* client authenticator information */
3159 addr->authenticator = (*ptr)? string_copy(ptr) : NULL;
3162 addr->auth_id = (*ptr)? string_copy(ptr) : NULL;
3165 addr->auth_sndr = (*ptr)? string_copy(ptr) : NULL;
3171 #ifndef DISABLE_PRDR
3173 addr->flags |= af_prdr_used;
3178 if (addr == NULL) goto ADDR_MISMATCH;
3179 memcpy(&(addr->dsn_aware), ptr, sizeof(addr->dsn_aware));
3180 ptr += sizeof(addr->dsn_aware);
3181 DEBUG(D_deliver) debug_printf("DSN read: addr->dsn_aware = %d\n", addr->dsn_aware);
3188 msg = string_sprintf("address count mismatch for data read from pipe "
3189 "for transport process %d for transport %s", pid,
3190 addrlist->transport->driver_name);
3195 addr->transport_return = *ptr++;
3196 addr->special_action = *ptr++;
3197 memcpy(&(addr->basic_errno), ptr, sizeof(addr->basic_errno));
3198 ptr += sizeof(addr->basic_errno);
3199 memcpy(&(addr->more_errno), ptr, sizeof(addr->more_errno));
3200 ptr += sizeof(addr->more_errno);
3201 memcpy(&(addr->flags), ptr, sizeof(addr->flags));
3202 ptr += sizeof(addr->flags);
3203 addr->message = (*ptr)? string_copy(ptr) : NULL;
3205 addr->user_message = (*ptr)? string_copy(ptr) : NULL;
3208 /* Always two strings for host information, followed by the port number and DNSSEC mark */
3212 h = store_get(sizeof(host_item));
3213 h->name = string_copy(ptr);
3215 h->address = string_copy(ptr);
3217 memcpy(&(h->port), ptr, sizeof(h->port));
3218 ptr += sizeof(h->port);
3219 h->dnssec = *ptr == '2' ? DS_YES
3220 : *ptr == '1' ? DS_NO
3223 addr->host_used = h;
3227 /* Finished with this address */
3232 /* Local interface address/port */
3234 if (*ptr) sending_ip_address = string_copy(ptr);
3236 if (*ptr) sending_port = atoi(CS ptr);
3240 /* Z marks the logical end of the data. It is followed by '0' if
3241 continue_transport was NULL at the end of transporting, otherwise '1'.
3242 We need to know when it becomes NULL during a delivery down a passed SMTP
3243 channel so that we don't try to pass anything more down it. Of course, for
3244 most normal messages it will remain NULL all the time. */
3249 continue_transport = NULL;
3250 continue_hostname = NULL;
3253 DEBUG(D_deliver) debug_printf("Z0%c item read\n", *ptr);
3256 /* Anything else is a disaster. */
3259 msg = string_sprintf("malformed data (%d) read from pipe for transport "
3260 "process %d for transport %s", ptr[-1], pid,
3261 addr->transport->driver_name);
3267 /* The done flag is inspected externally, to determine whether or not to
3268 call the function again when the process finishes. */
3272 /* If the process hadn't finished, and we haven't seen the end of the data
3273 or suffered a disaster, update the rest of the state, and return FALSE to
3274 indicate "not finished". */
3283 /* Close our end of the pipe, to prevent deadlock if the far end is still
3284 pushing stuff into it. */
3289 /* If we have finished without error, but haven't had data for every address,
3290 something is wrong. */
3292 if (msg == NULL && addr != NULL)
3293 msg = string_sprintf("insufficient address data read from pipe "
3294 "for transport process %d for transport %s", pid,
3295 addr->transport->driver_name);
3297 /* If an error message is set, something has gone wrong in getting back
3298 the delivery data. Put the message into each address and freeze it. */
3302 for (addr = addrlist; addr != NULL; addr = addr->next)
3304 addr->transport_return = DEFER;
3305 addr->special_action = SPECIAL_FREEZE;
3306 addr->message = msg;
3310 /* Return TRUE to indicate we have got all we need from this process, even
3311 if it hasn't actually finished yet. */
3318 /*************************************************
3319 * Post-process a set of remote addresses *
3320 *************************************************/
3322 /* Do what has to be done immediately after a remote delivery for each set of
3323 addresses, then re-write the spool if necessary. Note that post_process_one
3324 puts the address on an appropriate queue; hence we must fish off the next
3325 one first. This function is also called if there is a problem with setting
3326 up a subprocess to do a remote delivery in parallel. In this case, the final
3327 argument contains a message, and the action must be forced to DEFER.
3330 addr pointer to chain of address items
3331 logflags flags for logging
3332 msg NULL for normal cases; -> error message for unexpected problems
3333 fallback TRUE if processing fallback hosts
3339 remote_post_process(address_item *addr, int logflags, uschar *msg,
3344 /* If any host addresses were found to be unusable, add them to the unusable
3345 tree so that subsequent deliveries don't try them. */
3347 for (h = addr->host_list; h != NULL; h = h->next)
3349 if (h->address == NULL) continue;
3350 if (h->status >= hstatus_unusable) tree_add_unusable(h);
3353 /* Now handle each address on the chain. The transport has placed '=' or '-'
3354 into the special_action field for each successful delivery. */
3356 while (addr != NULL)
3358 address_item *next = addr->next;
3360 /* If msg == NULL (normal processing) and the result is DEFER and we are
3361 processing the main hosts and there are fallback hosts available, put the
3362 address on the list for fallback delivery. */
3364 if (addr->transport_return == DEFER &&
3365 addr->fallback_hosts != NULL &&
3369 addr->host_list = addr->fallback_hosts;
3370 addr->next = addr_fallback;
3371 addr_fallback = addr;
3372 DEBUG(D_deliver) debug_printf("%s queued for fallback host(s)\n", addr->address);
3375 /* If msg is set (=> unexpected problem), set it in the address before
3376 doing the ordinary post processing. */
3382 addr->message = msg;
3383 addr->transport_return = DEFER;
3385 (void)post_process_one(addr, addr->transport_return, logflags,
3386 DTYPE_TRANSPORT, addr->special_action);
3394 /* If we have just delivered down a passed SMTP channel, and that was
3395 the last address, the channel will have been closed down. Now that
3396 we have logged that delivery, set continue_sequence to 1 so that
3397 any subsequent deliveries don't get "*" incorrectly logged. */
3399 if (continue_transport == NULL) continue_sequence = 1;
3404 /*************************************************
3405 * Wait for one remote delivery subprocess *
3406 *************************************************/
3408 /* This function is called while doing remote deliveries when either the
3409 maximum number of processes exist and we need one to complete so that another
3410 can be created, or when waiting for the last ones to complete. It must wait for
3411 the completion of one subprocess, empty the control block slot, and return a
3412 pointer to the address chain.
3415 Returns: pointer to the chain of addresses handled by the process;
3416 NULL if no subprocess found - this is an unexpected error
3419 static address_item *
3422 int poffset, status;
3423 address_item *addr, *addrlist;
3426 set_process_info("delivering %s: waiting for a remote delivery subprocess "
3427 "to finish", message_id);
3429 /* Loop until either a subprocess completes, or there are no subprocesses in
3430 existence - in which case give an error return. We cannot proceed just by
3431 waiting for a completion, because a subprocess may have filled up its pipe, and
3432 be waiting for it to be emptied. Therefore, if no processes have finished, we
3433 wait for one of the pipes to acquire some data by calling select(), with a
3434 timeout just in case.
3436 The simple approach is just to iterate after reading data from a ready pipe.
3437 This leads to non-ideal behaviour when the subprocess has written its final Z
3438 item, closed the pipe, and is in the process of exiting (the common case). A
3439 call to waitpid() yields nothing completed, but select() shows the pipe ready -
3440 reading it yields EOF, so you end up with busy-waiting until the subprocess has
3443 To avoid this, if all the data that is needed has been read from a subprocess
3444 after select(), an explicit wait() for it is done. We know that all it is doing
3445 is writing to the pipe and then exiting, so the wait should not be long.
3447 The non-blocking waitpid() is to some extent just insurance; if we could
3448 reliably detect end-of-file on the pipe, we could always know when to do a
3449 blocking wait() for a completed process. However, because some systems use
3450 NDELAY, which doesn't distinguish between EOF and pipe empty, it is easier to
3451 use code that functions without the need to recognize EOF.
3453 There's a double loop here just in case we end up with a process that is not in
3454 the list of remote delivery processes. Something has obviously gone wrong if
3455 this is the case. (For example, a process that is incorrectly left over from
3456 routing or local deliveries might be found.) The damage can be minimized by
3457 looping back and looking for another process. If there aren't any, the error
3458 return will happen. */
3460 for (;;) /* Normally we do not repeat this loop */
3462 while ((pid = waitpid(-1, &status, WNOHANG)) <= 0)
3465 fd_set select_pipes;
3466 int maxpipe, readycount;
3468 /* A return value of -1 can mean several things. If errno != ECHILD, it
3469 either means invalid options (which we discount), or that this process was
3470 interrupted by a signal. Just loop to try the waitpid() again.
3472 If errno == ECHILD, waitpid() is telling us that there are no subprocesses
3473 in existence. This should never happen, and is an unexpected error.
3474 However, there is a nasty complication when running under Linux. If "strace
3475 -f" is being used under Linux to trace this process and its children,
3476 subprocesses are "stolen" from their parents and become the children of the
3477 tracing process. A general wait such as the one we've just obeyed returns
3478 as if there are no children while subprocesses are running. Once a
3479 subprocess completes, it is restored to the parent, and waitpid(-1) finds
3480 it. Thanks to Joachim Wieland for finding all this out and suggesting a
3483 This does not happen using "truss" on Solaris, nor (I think) with other
3484 tracing facilities on other OS. It seems to be specific to Linux.
3486 What we do to get round this is to use kill() to see if any of our
3487 subprocesses are still in existence. If kill() gives an OK return, we know
3488 it must be for one of our processes - it can't be for a re-use of the pid,
3489 because if our process had finished, waitpid() would have found it. If any
3490 of our subprocesses are in existence, we proceed to use select() as if
3491 waitpid() had returned zero. I think this is safe. */
3495 if (errno != ECHILD) continue; /* Repeats the waitpid() */
3498 debug_printf("waitpid() returned -1/ECHILD: checking explicitly "
3499 "for process existence\n");
3501 for (poffset = 0; poffset < remote_max_parallel; poffset++)
3503 if ((pid = parlist[poffset].pid) != 0 && kill(pid, 0) == 0)
3505 DEBUG(D_deliver) debug_printf("process %d still exists: assume "
3506 "stolen by strace\n", (int)pid);
3507 break; /* With poffset set */
3511 if (poffset >= remote_max_parallel)
3513 DEBUG(D_deliver) debug_printf("*** no delivery children found\n");
3514 return NULL; /* This is the error return */
3518 /* A pid value greater than 0 breaks the "while" loop. A negative value has
3519 been handled above. A return value of zero means that there is at least one
3520 subprocess, but there are no completed subprocesses. See if any pipes are
3521 ready with any data for reading. */
3523 DEBUG(D_deliver) debug_printf("selecting on subprocess pipes\n");
3526 FD_ZERO(&select_pipes);
3527 for (poffset = 0; poffset < remote_max_parallel; poffset++)
3529 if (parlist[poffset].pid != 0)
3531 int fd = parlist[poffset].fd;
3532 FD_SET(fd, &select_pipes);
3533 if (fd > maxpipe) maxpipe = fd;
3537 /* Stick in a 60-second timeout, just in case. */
3542 readycount = select(maxpipe + 1, (SELECT_ARG2_TYPE *)&select_pipes,
3545 /* Scan through the pipes and read any that are ready; use the count
3546 returned by select() to stop when there are no more. Select() can return
3547 with no processes (e.g. if interrupted). This shouldn't matter.
3549 If par_read_pipe() returns TRUE, it means that either the terminating Z was
3550 read, or there was a disaster. In either case, we are finished with this
3551 process. Do an explicit wait() for the process and break the main loop if
3554 It turns out that we have to deal with the case of an interrupted system
3555 call, which can happen on some operating systems if the signal handling is
3556 set up to do that by default. */
3559 readycount > 0 && poffset < remote_max_parallel;
3562 if ((pid = parlist[poffset].pid) != 0 &&
3563 FD_ISSET(parlist[poffset].fd, &select_pipes))
3566 if (par_read_pipe(poffset, FALSE)) /* Finished with this pipe */
3568 for (;;) /* Loop for signals */
3570 pid_t endedpid = waitpid(pid, &status, 0);
3571 if (endedpid == pid) goto PROCESS_DONE;
3572 if (endedpid != (pid_t)(-1) || errno != EINTR)
3573 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Unexpected error return "
3574 "%d (errno = %d) from waitpid() for process %d",
3575 (int)endedpid, errno, (int)pid);
3581 /* Now go back and look for a completed subprocess again. */
3584 /* A completed process was detected by the non-blocking waitpid(). Find the
3585 data block that corresponds to this subprocess. */
3587 for (poffset = 0; poffset < remote_max_parallel; poffset++)
3588 if (pid == parlist[poffset].pid) break;
3590 /* Found the data block; this is a known remote delivery process. We don't
3591 need to repeat the outer loop. This should be what normally happens. */
3593 if (poffset < remote_max_parallel) break;
3595 /* This situation is an error, but it's probably better to carry on looking
3596 for another process than to give up (as we used to do). */
3598 log_write(0, LOG_MAIN|LOG_PANIC, "Process %d finished: not found in remote "
3599 "transport process list", pid);
3600 } /* End of the "for" loop */
3602 /* Come here when all the data was completely read after a select(), and
3603 the process in pid has been wait()ed for. */
3610 debug_printf("remote delivery process %d ended\n", (int)pid);
3612 debug_printf("remote delivery process %d ended: status=%04x\n", (int)pid,
3616 set_process_info("delivering %s", message_id);
3618 /* Get the chain of processed addresses */
3620 addrlist = parlist[poffset].addrlist;
3622 /* If the process did not finish cleanly, record an error and freeze (except
3623 for SIGTERM, SIGKILL and SIGQUIT), and also ensure the journal is not removed,
3624 in case the delivery did actually happen. */
3626 if ((status & 0xffff) != 0)
3629 int msb = (status >> 8) & 255;
3630 int lsb = status & 255;
3631 int code = (msb == 0)? (lsb & 0x7f) : msb;
3633 msg = string_sprintf("%s transport process returned non-zero status 0x%04x: "
3635 addrlist->transport->driver_name,
3637 (msb == 0)? "terminated by signal" : "exit code",
3640 if (msb != 0 || (code != SIGTERM && code != SIGKILL && code != SIGQUIT))
3641 addrlist->special_action = SPECIAL_FREEZE;
3643 for (addr = addrlist; addr != NULL; addr = addr->next)
3645 addr->transport_return = DEFER;
3646 addr->message = msg;
3649 remove_journal = FALSE;
3652 /* Else complete reading the pipe to get the result of the delivery, if all
3653 the data has not yet been obtained. */
3655 else if (!parlist[poffset].done) (void)par_read_pipe(poffset, TRUE);
3657 /* Put the data count and return path into globals, mark the data slot unused,
3658 decrement the count of subprocesses, and return the address chain. */
3660 transport_count = parlist[poffset].transport_count;
3661 used_return_path = parlist[poffset].return_path;
3662 parlist[poffset].pid = 0;
3669 /*************************************************
3670 * Wait for subprocesses and post-process *
3671 *************************************************/
3673 /* This function waits for subprocesses until the number that are still running
3674 is below a given threshold. For each complete subprocess, the addresses are
3675 post-processed. If we can't find a running process, there is some shambles.
3676 Better not bomb out, as that might lead to multiple copies of the message. Just
3677 log and proceed as if all done.
3680 max maximum number of subprocesses to leave running
3681 fallback TRUE if processing fallback hosts
3687 par_reduce(int max, BOOL fallback)
3689 while (parcount > max)
3691 address_item *doneaddr = par_wait();
3692 if (doneaddr == NULL)
3694 log_write(0, LOG_MAIN|LOG_PANIC,
3695 "remote delivery process count got out of step");
3698 else remote_post_process(doneaddr, LOG_MAIN, NULL, fallback);
3706 rmt_dlv_checked_write(int fd, char id, char subid, void * buf, int size)
3708 uschar writebuffer[PIPE_HEADER_SIZE + BIG_BUFFER_SIZE];
3711 /* we assume that size can't get larger then BIG_BUFFER_SIZE which currently is set to 16k */
3712 /* complain to log if someone tries with buffer sizes we can't handle*/
3716 log_write(0, LOG_MAIN|LOG_PANIC_DIE,
3717 "Failed writing transport result to pipe: can't handle buffers > 99999 bytes. truncating!\n");
3721 /* to keep the write() atomic we build header in writebuffer and copy buf behind */
3722 /* two write() calls would increase the complexity of reading from pipe */
3724 /* convert size to human readable string prepended by id and subid */
3725 header_length = snprintf(CS writebuffer, PIPE_HEADER_SIZE+1, "%c%c%05d", id, subid, size);
3726 if (header_length != PIPE_HEADER_SIZE)
3728 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "header snprintf failed\n");
3729 writebuffer[0] = '\0';
3732 DEBUG(D_deliver) debug_printf("header write id:%c,subid:%c,size:%d,final:%s\n",
3733 id, subid, size, writebuffer);
3735 if (buf && size > 0)
3736 memcpy(writebuffer + PIPE_HEADER_SIZE, buf, size);
3738 size += PIPE_HEADER_SIZE;
3739 int ret = write(fd, writebuffer, size);
3741 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Failed writing transport result to pipe: %s\n",
3742 ret == -1 ? strerror(errno) : "short write");
3745 /*************************************************
3746 * Do remote deliveries *
3747 *************************************************/
3749 /* This function is called to process the addresses in addr_remote. We must
3750 pick off the queue all addresses that have the same transport, remote
3751 destination, and errors address, and hand them to the transport in one go,
3752 subject to some configured limitations. If this is a run to continue delivering
3753 to an existing delivery channel, skip all but those addresses that can go to
3754 that channel. The skipped addresses just get deferred.
3756 If mua_wrapper is set, all addresses must be able to be sent in a single
3757 transaction. If not, this function yields FALSE.
3759 In Exim 4, remote deliveries are always done in separate processes, even
3760 if remote_max_parallel = 1 or if there's only one delivery to do. The reason
3761 is so that the base process can retain privilege. This makes the
3762 implementation of fallback transports feasible (though not initially done.)
3764 We create up to the configured number of subprocesses, each of which passes
3765 back the delivery state via a pipe. (However, when sending down an existing
3766 connection, remote_max_parallel is forced to 1.)
3769 fallback TRUE if processing fallback hosts
3771 Returns: TRUE normally
3772 FALSE if mua_wrapper is set and the addresses cannot all be sent
3777 do_remote_deliveries(BOOL fallback)
3783 parcount = 0; /* Number of executing subprocesses */
3785 /* When sending down an existing channel, only do one delivery at a time.
3786 We use a local variable (parmax) to hold the maximum number of processes;
3787 this gets reduced from remote_max_parallel if we can't create enough pipes. */
3789 if (continue_transport != NULL) remote_max_parallel = 1;
3790 parmax = remote_max_parallel;
3792 /* If the data for keeping a list of processes hasn't yet been
3795 if (parlist == NULL)
3797 parlist = store_get(remote_max_parallel * sizeof(pardata));
3798 for (poffset = 0; poffset < remote_max_parallel; poffset++)
3799 parlist[poffset].pid = 0;
3802 /* Now loop for each remote delivery */
3804 for (delivery_count = 0; addr_remote != NULL; delivery_count++)
3810 int address_count = 1;
3811 int address_count_max;
3813 BOOL use_initgroups;
3814 BOOL pipe_done = FALSE;
3815 transport_instance *tp;
3816 address_item **anchor = &addr_remote;
3817 address_item *addr = addr_remote;
3818 address_item *last = addr;
3821 /* Pull the first address right off the list. */
3823 addr_remote = addr->next;
3826 DEBUG(D_deliver|D_transport)
3827 debug_printf("--------> %s <--------\n", addr->address);
3829 /* If no transport has been set, there has been a big screw-up somewhere. */
3831 if ((tp = addr->transport) == NULL)
3833 disable_logging = FALSE; /* Jic */
3834 remote_post_process(addr, LOG_MAIN|LOG_PANIC,
3835 US"No transport set by router", fallback);
3839 /* Check that this base address hasn't previously been delivered to this
3840 transport. The check is necessary at this point to handle homonymic addresses
3841 correctly in cases where the pattern of redirection changes between delivery
3842 attempts. Non-homonymic previous delivery is detected earlier, at routing
3845 if (previously_transported(addr, FALSE)) continue;
3847 /* Force failure if the message is too big. */
3849 if (tp->message_size_limit != NULL)
3851 int rc = check_message_size(tp, addr);
3854 addr->transport_return = rc;
3855 remote_post_process(addr, LOG_MAIN, NULL, fallback);
3860 /* Get the flag which specifies whether the transport can handle different
3861 domains that nevertheless resolve to the same set of hosts. If it needs
3862 expanding, get variables set: $address_data, $domain_data, $localpart_data,
3863 $host, $host_address, $host_port. */
3864 if (tp->expand_multi_domain)
3865 deliver_set_expansions(addr);
3867 if (exp_bool(addr, US"transport", tp->name, D_transport,
3868 US"multi_domain", tp->multi_domain, tp->expand_multi_domain,
3869 &multi_domain) != OK)
3871 deliver_set_expansions(NULL);
3872 remote_post_process(addr, LOG_MAIN|LOG_PANIC, addr->message, fallback);
3876 /* Get the maximum it can handle in one envelope, with zero meaning
3877 unlimited, which is forced for the MUA wrapper case. */
3879 address_count_max = tp->max_addresses;
3880 if (address_count_max == 0 || mua_wrapper) address_count_max = 999999;
3883 /************************************************************************/
3884 /***** This is slightly experimental code, but should be safe. *****/
3886 /* The address_count_max value is the maximum number of addresses that the
3887 transport can send in one envelope. However, the transport must be capable of
3888 dealing with any number of addresses. If the number it gets exceeds its
3889 envelope limitation, it must send multiple copies of the message. This can be
3890 done over a single connection for SMTP, so uses less resources than making
3891 multiple connections. On the other hand, if remote_max_parallel is greater
3892 than one, it is perhaps a good idea to use parallel processing to move the
3893 message faster, even if that results in multiple simultaneous connections to
3896 How can we come to some compromise between these two ideals? What we do is to
3897 limit the number of addresses passed to a single instance of a transport to
3898 the greater of (a) its address limit (rcpt_max for SMTP) and (b) the total
3899 number of addresses routed to remote transports divided by
3900 remote_max_parallel. For example, if the message has 100 remote recipients,
3901 remote max parallel is 2, and rcpt_max is 10, we'd never send more than 50 at
3902 once. But if rcpt_max is 100, we could send up to 100.
3904 Of course, not all the remotely addresses in a message are going to go to the
3905 same set of hosts (except in smarthost configurations), so this is just a
3906 heuristic way of dividing up the work.
3908 Furthermore (1), because this may not be wanted in some cases, and also to
3909 cope with really pathological cases, there is also a limit to the number of
3910 messages that are sent over one connection. This is the same limit that is
3911 used when sending several different messages over the same connection.
3912 Continue_sequence is set when in this situation, to the number sent so
3913 far, including this message.
3915 Furthermore (2), when somebody explicitly sets the maximum value to 1, it
3916 is probably because they are using VERP, in which case they want to pass only
3917 one address at a time to the transport, in order to be able to use
3918 $local_part and $domain in constructing a new return path. We could test for
3919 the use of these variables, but as it is so likely they will be used when the
3920 maximum is 1, we don't bother. Just leave the value alone. */
3922 if (address_count_max != 1 &&
3923 address_count_max < remote_delivery_count/remote_max_parallel)
3925 int new_max = remote_delivery_count/remote_max_parallel;
3926 int message_max = tp->connection_max_messages;
3927 if (connection_max_messages >= 0) message_max = connection_max_messages;
3928 message_max -= continue_sequence - 1;
3929 if (message_max > 0 && new_max > address_count_max * message_max)
3930 new_max = address_count_max * message_max;
3931 address_count_max = new_max;
3934 /************************************************************************/
3937 /* Pick off all addresses which have the same transport, errors address,
3938 destination, and extra headers. In some cases they point to the same host
3939 list, but we also need to check for identical host lists generated from
3940 entirely different domains. The host list pointers can be NULL in the case
3941 where the hosts are defined in the transport. There is also a configured
3942 maximum limit of addresses that can be handled at once (see comments above
3943 for how it is computed).
3944 If the transport does not handle multiple domains, enforce that also,
3945 and if it might need a per-address check for this, re-evaluate it.
3948 while ((next = *anchor) != NULL && address_count < address_count_max)
3951 if ( (multi_domain || Ustrcmp(next->domain, addr->domain) == 0)
3952 && tp == next->transport
3953 && same_hosts(next->host_list, addr->host_list)
3954 && same_strings(next->prop.errors_address, addr->prop.errors_address)
3955 && same_headers(next->prop.extra_headers, addr->prop.extra_headers)
3956 && same_ugid(tp, next, addr)
3957 && ( next->prop.remove_headers == addr->prop.remove_headers
3958 || ( next->prop.remove_headers
3959 && addr->prop.remove_headers
3960 && Ustrcmp(next->prop.remove_headers, addr->prop.remove_headers) == 0
3964 !tp->expand_multi_domain || (deliver_set_expansions(next), 1),
3966 US"transport", next->transport->name, D_transport,
3967 US"multi_domain", next->transport->multi_domain,
3968 next->transport->expand_multi_domain, &md) == OK
3973 *anchor = next->next;
3975 next->first = addr; /* remember top one (for retry processing) */
3980 else anchor = &(next->next);
3981 deliver_set_expansions(NULL);
3984 /* If we are acting as an MUA wrapper, all addresses must go in a single
3985 transaction. If not, put them back on the chain and yield FALSE. */
3987 if (mua_wrapper && addr_remote != NULL)
3989 last->next = addr_remote;
3994 /* Set up the expansion variables for this set of addresses */
3996 deliver_set_expansions(addr);
3998 /* Ensure any transport-set auth info is fresh */
3999 addr->authenticator = addr->auth_id = addr->auth_sndr = NULL;
4001 /* Compute the return path, expanding a new one if required. The old one
4002 must be set first, as it might be referred to in the expansion. */
4004 if(addr->prop.errors_address != NULL)
4005 return_path = addr->prop.errors_address;
4006 #ifdef EXPERIMENTAL_SRS
4007 else if(addr->prop.srs_sender != NULL)
4008 return_path = addr->prop.srs_sender;
4011 return_path = sender_address;
4013 if (tp->return_path != NULL)
4015 uschar *new_return_path = expand_string(tp->return_path);
4016 if (new_return_path == NULL)
4018 if (!expand_string_forcedfail)
4020 remote_post_process(addr, LOG_MAIN|LOG_PANIC,
4021 string_sprintf("Failed to expand return path \"%s\": %s",
4022 tp->return_path, expand_string_message), fallback);
4026 else return_path = new_return_path;
4029 /* Find the uid, gid, and use_initgroups setting for this transport. Failure
4030 logs and sets up error messages, so we just post-process and continue with
4031 the next address. */
4033 if (!findugid(addr, tp, &uid, &gid, &use_initgroups))
4035 remote_post_process(addr, LOG_MAIN|LOG_PANIC, NULL, fallback);
4039 /* If this transport has a setup function, call it now so that it gets
4040 run in this process and not in any subprocess. That way, the results of
4041 any setup that are retained by the transport can be reusable. One of the
4042 things the setup does is to set the fallback host lists in the addresses.
4043 That is why it is called at this point, before the continue delivery
4044 processing, because that might use the fallback hosts. */
4046 if (tp->setup != NULL)
4047 (void)((tp->setup)(addr->transport, addr, NULL, uid, gid, NULL));
4049 /* If this is a run to continue delivery down an already-established
4050 channel, check that this set of addresses matches the transport and
4051 the channel. If it does not, defer the addresses. If a host list exists,
4052 we must check that the continue host is on the list. Otherwise, the
4053 host is set in the transport. */
4055 continue_more = FALSE; /* In case got set for the last lot */
4056 if (continue_transport != NULL)
4058 BOOL ok = Ustrcmp(continue_transport, tp->name) == 0;
4059 if (ok && addr->host_list != NULL)
4063 for (h = addr->host_list; h != NULL; h = h->next)
4065 if (Ustrcmp(h->name, continue_hostname) == 0)
4066 { ok = TRUE; break; }
4070 /* Addresses not suitable; defer or queue for fallback hosts (which
4071 might be the continue host) and skip to next address. */
4075 DEBUG(D_deliver) debug_printf("not suitable for continue_transport\n");
4078 if (addr->fallback_hosts != NULL && !fallback)
4082 next->host_list = next->fallback_hosts;
4083 DEBUG(D_deliver) debug_printf("%s queued for fallback host(s)\n", next->address);
4084 if (next->next == NULL) break;
4087 next->next = addr_fallback;
4088 addr_fallback = addr;
4093 while (next->next != NULL) next = next->next;
4094 next->next = addr_defer;
4101 /* Set a flag indicating whether there are further addresses that list
4102 the continued host. This tells the transport to leave the channel open,
4103 but not to pass it to another delivery process. */
4105 for (next = addr_remote; next != NULL; next = next->next)
4108 for (h = next->host_list; h != NULL; h = h->next)
4110 if (Ustrcmp(h->name, continue_hostname) == 0)
4111 { continue_more = TRUE; break; }
4116 /* The transports set up the process info themselves as they may connect
4117 to more than one remote machine. They also have to set up the filter
4118 arguments, if required, so that the host name and address are available
4121 transport_filter_argv = NULL;
4123 /* Create the pipe for inter-process communication. If pipe creation
4124 fails, it is probably because the value of remote_max_parallel is so
4125 large that too many file descriptors for pipes have been created. Arrange
4126 to wait for a process to finish, and then try again. If we still can't
4127 create a pipe when all processes have finished, break the retry loop. */
4131 if (pipe(pfd) == 0) pipe_done = TRUE;
4132 else if (parcount > 0) parmax = parcount;
4135 /* We need to make the reading end of the pipe non-blocking. There are
4136 two different options for this. Exim is cunningly (I hope!) coded so
4137 that it can use either of them, though it prefers O_NONBLOCK, which
4138 distinguishes between EOF and no-more-data. */
4141 (void)fcntl(pfd[pipe_read], F_SETFL, O_NONBLOCK);
4143 (void)fcntl(pfd[pipe_read], F_SETFL, O_NDELAY);
4146 /* If the maximum number of subprocesses already exist, wait for a process
4147 to finish. If we ran out of file descriptors, parmax will have been reduced
4148 from its initial value of remote_max_parallel. */
4150 par_reduce(parmax - 1, fallback);
4153 /* If we failed to create a pipe and there were no processes to wait
4154 for, we have to give up on this one. Do this outside the above loop
4155 so that we can continue the main loop. */
4159 remote_post_process(addr, LOG_MAIN|LOG_PANIC,
4160 string_sprintf("unable to create pipe: %s", strerror(errno)), fallback);
4164 /* Find a free slot in the pardata list. Must do this after the possible
4165 waiting for processes to finish, because a terminating process will free
4168 for (poffset = 0; poffset < remote_max_parallel; poffset++)
4169 if (parlist[poffset].pid == 0) break;
4171 /* If there isn't one, there has been a horrible disaster. */
4173 if (poffset >= remote_max_parallel)
4175 (void)close(pfd[pipe_write]);
4176 (void)close(pfd[pipe_read]);
4177 remote_post_process(addr, LOG_MAIN|LOG_PANIC,
4178 US"Unexpectedly no free subprocess slot", fallback);
4182 /* Now fork a subprocess to do the remote delivery, but before doing so,
4183 ensure that any cached resourses are released so as not to interfere with
4184 what happens in the subprocess. */
4188 if ((pid = fork()) == 0)
4190 int fd = pfd[pipe_write];
4193 /* Setting this global in the subprocess means we need never clear it */
4194 transport_name = tp->name;
4196 /* There are weird circumstances in which logging is disabled */
4197 disable_logging = tp->disable_logging;
4199 /* Show pids on debug output if parallelism possible */
4201 if (parmax > 1 && (parcount > 0 || addr_remote != NULL))
4203 DEBUG(D_any|D_v) debug_selector |= D_pid;
4204 DEBUG(D_deliver) debug_printf("Remote delivery process started\n");
4207 /* Reset the random number generator, so different processes don't all
4208 have the same sequence. In the test harness we want different, but
4209 predictable settings for each delivery process, so do something explicit
4210 here rather they rely on the fixed reset in the random number function. */
4212 random_seed = running_in_test_harness? 42 + 2*delivery_count : 0;
4214 /* Set close-on-exec on the pipe so that it doesn't get passed on to
4215 a new process that may be forked to do another delivery down the same
4218 (void)fcntl(fd, F_SETFD, fcntl(fd, F_GETFD) | FD_CLOEXEC);
4220 /* Close open file descriptors for the pipes of other processes
4221 that are running in parallel. */
4223 for (poffset = 0; poffset < remote_max_parallel; poffset++)
4224 if (parlist[poffset].pid != 0) (void)close(parlist[poffset].fd);
4226 /* This process has inherited a copy of the file descriptor
4227 for the data file, but its file pointer is shared with all the
4228 other processes running in parallel. Therefore, we have to re-open
4229 the file in order to get a new file descriptor with its own
4230 file pointer. We don't need to lock it, as the lock is held by
4231 the parent process. There doesn't seem to be any way of doing
4232 a dup-with-new-file-pointer. */
4234 (void)close(deliver_datafile);
4235 sprintf(CS spoolname, "%s/input/%s/%s-D", spool_directory, message_subdir,
4237 deliver_datafile = Uopen(spoolname, O_RDWR | O_APPEND, 0);
4239 if (deliver_datafile < 0)
4240 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Failed to reopen %s for remote "
4241 "parallel delivery: %s", spoolname, strerror(errno));
4243 /* Set the close-on-exec flag */
4245 (void)fcntl(deliver_datafile, F_SETFD, fcntl(deliver_datafile, F_GETFD) |
4248 /* Set the uid/gid of this process; bombs out on failure. */
4250 exim_setugid(uid, gid, use_initgroups,
4251 string_sprintf("remote delivery to %s with transport=%s",
4252 addr->address, tp->name));
4254 /* Close the unwanted half of this process' pipe, set the process state,
4255 and run the transport. Afterwards, transport_count will contain the number
4256 of bytes written. */
4258 (void)close(pfd[pipe_read]);
4259 set_process_info("delivering %s using %s", message_id, tp->name);
4260 debug_print_string(tp->debug_string);
4261 if (!(tp->info->code)(addr->transport, addr)) replicate_status(addr);
4263 set_process_info("delivering %s (just run %s for %s%s in subprocess)",
4264 message_id, tp->name, addr->address, (addr->next == NULL)? "" : ", ...");
4266 /* Ensure any cached resources that we used are now released */
4270 /* Pass the result back down the pipe. This is a lot more information
4271 than is needed for a local delivery. We have to send back the error
4272 status for each address, the usability status for each host that is
4273 flagged as unusable, and all the retry items. When TLS is in use, we
4274 send also the cipher and peerdn information. Each type of information
4275 is flagged by an identifying byte, and is then in a fixed format (with
4276 strings terminated by zeros), and there is a final terminator at the
4277 end. The host information and retry information is all attached to
4278 the first address, so that gets sent at the start. */
4280 /* Host unusability information: for most success cases this will
4283 for (h = addr->host_list; h != NULL; h = h->next)
4285 if (h->address == NULL || h->status < hstatus_unusable) continue;
4286 sprintf(CS big_buffer, "%c%c%s", h->status, h->why, h->address);
4287 rmt_dlv_checked_write(fd, 'H', '0', big_buffer, Ustrlen(big_buffer+2) + 3);
4290 /* The number of bytes written. This is the same for each address. Even
4291 if we sent several copies of the message down the same connection, the
4292 size of each one is the same, and it's that value we have got because
4293 transport_count gets reset before calling transport_write_message(). */
4295 memcpy(big_buffer, &transport_count, sizeof(transport_count));
4296 rmt_dlv_checked_write(fd, 'S', '0', big_buffer, sizeof(transport_count));
4298 /* Information about what happened to each address. Four item types are
4299 used: an optional 'X' item first, for TLS information, then an optional "C"
4300 item for any client-auth info followed by 'R' items for any retry settings,
4301 and finally an 'A' item for the remaining data. */
4303 for(; addr != NULL; addr = addr->next)
4308 /* The certificate verification status goes into the flags */
4309 if (tls_out.certificate_verified) setflag(addr, af_cert_verified);
4310 #ifdef EXPERIMENTAL_DANE
4311 if (tls_out.dane_verified) setflag(addr, af_dane_verified);
4314 /* Use an X item only if there's something to send */
4319 sprintf(CS ptr, "%.128s", addr->cipher);
4325 sprintf(CS ptr, "%.512s", addr->peerdn);
4329 rmt_dlv_checked_write(fd, 'X', '1', big_buffer, ptr - big_buffer);
4334 if (!tls_export_cert(ptr, big_buffer_size-2, addr->peercert))
4338 rmt_dlv_checked_write(fd, 'X', '2', big_buffer, ptr - big_buffer);
4343 if (!tls_export_cert(ptr, big_buffer_size-2, addr->ourcert))
4347 rmt_dlv_checked_write(fd, 'X', '3', big_buffer, ptr - big_buffer);
4349 # ifndef DISABLE_OCSP
4350 if (addr->ocsp > OCSP_NOT_REQ)
4353 sprintf(CS ptr, "%c", addr->ocsp + '0');
4355 rmt_dlv_checked_write(fd, 'X', '4', big_buffer, ptr - big_buffer);
4358 #endif /*SUPPORT_TLS*/
4360 if (client_authenticator)
4363 sprintf(CS big_buffer, "%.64s", client_authenticator);
4365 rmt_dlv_checked_write(fd, 'C', '1', big_buffer, ptr - big_buffer);
4367 if (client_authenticated_id)
4370 sprintf(CS big_buffer, "%.64s", client_authenticated_id);
4372 rmt_dlv_checked_write(fd, 'C', '2', big_buffer, ptr - big_buffer);
4374 if (client_authenticated_sender)
4377 sprintf(CS big_buffer, "%.64s", client_authenticated_sender);
4379 rmt_dlv_checked_write(fd, 'C', '3', big_buffer, ptr - big_buffer);
4382 #ifndef DISABLE_PRDR
4383 if (addr->flags & af_prdr_used)
4384 rmt_dlv_checked_write(fd, 'P', '0', NULL, 0);
4387 memcpy(big_buffer, &addr->dsn_aware, sizeof(addr->dsn_aware));
4388 rmt_dlv_checked_write(fd, 'D', '0', big_buffer, sizeof(addr->dsn_aware));
4389 DEBUG(D_deliver) debug_printf("DSN write: addr->dsn_aware = %d\n", addr->dsn_aware);
4391 /* Retry information: for most success cases this will be null. */
4393 for (r = addr->retries; r != NULL; r = r->next)
4396 sprintf(CS big_buffer, "%c%.500s", r->flags, r->key);
4397 ptr = big_buffer + Ustrlen(big_buffer+2) + 3;
4398 memcpy(ptr, &(r->basic_errno), sizeof(r->basic_errno));
4399 ptr += sizeof(r->basic_errno);
4400 memcpy(ptr, &(r->more_errno), sizeof(r->more_errno));
4401 ptr += sizeof(r->more_errno);
4402 if (r->message == NULL) *ptr++ = 0; else
4404 sprintf(CS ptr, "%.512s", r->message);
4407 rmt_dlv_checked_write(fd, 'R', '0', big_buffer, ptr - big_buffer);
4410 /* The rest of the information goes in an 'A' item. */
4412 ptr = big_buffer + 2;
4413 sprintf(CS big_buffer, "%c%c", addr->transport_return,
4414 addr->special_action);
4415 memcpy(ptr, &(addr->basic_errno), sizeof(addr->basic_errno));
4416 ptr += sizeof(addr->basic_errno);
4417 memcpy(ptr, &(addr->more_errno), sizeof(addr->more_errno));
4418 ptr += sizeof(addr->more_errno);
4419 memcpy(ptr, &(addr->flags), sizeof(addr->flags));
4420 ptr += sizeof(addr->flags);
4422 if (addr->message == NULL) *ptr++ = 0; else
4424 sprintf(CS ptr, "%.1024s", addr->message);
4428 if (addr->user_message == NULL) *ptr++ = 0; else
4430 sprintf(CS ptr, "%.1024s", addr->user_message);
4434 if (addr->host_used == NULL) *ptr++ = 0; else
4436 sprintf(CS ptr, "%.256s", addr->host_used->name);
4438 sprintf(CS ptr, "%.64s", addr->host_used->address);
4440 memcpy(ptr, &(addr->host_used->port), sizeof(addr->host_used->port));
4441 ptr += sizeof(addr->host_used->port);
4443 /* DNS lookup status */
4444 *ptr++ = addr->host_used->dnssec==DS_YES ? '2'
4445 : addr->host_used->dnssec==DS_NO ? '1' : '0';
4448 rmt_dlv_checked_write(fd, 'A', '0', big_buffer, ptr - big_buffer);
4451 /* Local interface address/port */
4452 if (log_extra_selector & LX_incoming_interface && sending_ip_address)
4454 uschar * ptr = big_buffer;
4455 sprintf(CS ptr, "%.128s", sending_ip_address);
4457 sprintf(CS ptr, "%d", sending_port);
4460 rmt_dlv_checked_write(fd, 'I', '0', big_buffer, ptr - big_buffer);
4463 /* Add termination flag, close the pipe, and that's it. The character
4464 after 'Z' indicates whether continue_transport is now NULL or not.
4465 A change from non-NULL to NULL indicates a problem with a continuing
4468 big_buffer[0] = (continue_transport == NULL)? '0' : '1';
4469 rmt_dlv_checked_write(fd, 'Z', '0', big_buffer, 1);
4474 /* Back in the mainline: close the unwanted half of the pipe. */
4476 (void)close(pfd[pipe_write]);
4478 /* Fork failed; defer with error message */
4482 (void)close(pfd[pipe_read]);
4483 remote_post_process(addr, LOG_MAIN|LOG_PANIC,
4484 string_sprintf("fork failed for remote delivery to %s: %s",
4485 addr->domain, strerror(errno)), fallback);
4489 /* Fork succeeded; increment the count, and remember relevant data for
4490 when the process finishes. */
4493 parlist[poffset].addrlist = parlist[poffset].addr = addr;
4494 parlist[poffset].pid = pid;
4495 parlist[poffset].fd = pfd[pipe_read];
4496 parlist[poffset].done = FALSE;
4497 parlist[poffset].msg = NULL;
4498 parlist[poffset].return_path = return_path;
4500 /* If the process we've just started is sending a message down an existing
4501 channel, wait for it now. This ensures that only one such process runs at
4502 once, whatever the value of remote_max parallel. Otherwise, we might try to
4503 send two or more messages simultaneously down the same channel. This could
4504 happen if there are different domains that include the same host in otherwise
4505 different host lists.
4507 Also, if the transport closes down the channel, this information gets back
4508 (continue_transport gets set to NULL) before we consider any other addresses
4511 if (continue_transport != NULL) par_reduce(0, fallback);
4513 /* Otherwise, if we are running in the test harness, wait a bit, to let the
4514 newly created process get going before we create another process. This should
4515 ensure repeatability in the tests. We only need to wait a tad. */
4517 else if (running_in_test_harness) millisleep(500);
4520 /* Reached the end of the list of addresses. Wait for all the subprocesses that
4521 are still running and post-process their addresses. */
4523 par_reduce(0, fallback);
4530 /*************************************************
4531 * Split an address into local part and domain *
4532 *************************************************/
4534 /* This function initializes an address for routing by splitting it up into a
4535 local part and a domain. The local part is set up twice - once in its original
4536 casing, and once in lower case, and it is dequoted. We also do the "percent
4537 hack" for configured domains. This may lead to a DEFER result if a lookup
4538 defers. When a percent-hacking takes place, we insert a copy of the original
4539 address as a new parent of this address, as if we have had a redirection.
4542 addr points to an addr_item block containing the address
4545 DEFER - could not determine if domain is %-hackable
4549 deliver_split_address(address_item *addr)
4551 uschar *address = addr->address;
4552 uschar *domain = Ustrrchr(address, '@');
4554 int len = domain - address;
4556 addr->domain = string_copylc(domain+1); /* Domains are always caseless */
4558 /* The implication in the RFCs (though I can't say I've seen it spelled out
4559 explicitly) is that quoting should be removed from local parts at the point
4560 where they are locally interpreted. [The new draft "821" is more explicit on
4561 this, Jan 1999.] We know the syntax is valid, so this can be done by simply
4562 removing quoting backslashes and any unquoted doublequotes. */
4564 t = addr->cc_local_part = store_get(len+1);
4567 register int c = *address++;
4568 if (c == '\"') continue;
4578 /* We do the percent hack only for those domains that are listed in
4579 percent_hack_domains. A loop is required, to copy with multiple %-hacks. */
4581 if (percent_hack_domains != NULL)
4584 uschar *new_address = NULL;
4585 uschar *local_part = addr->cc_local_part;
4587 deliver_domain = addr->domain; /* set $domain */
4589 while ((rc = match_isinlist(deliver_domain, (const uschar **)&percent_hack_domains, 0,
4590 &domainlist_anchor, addr->domain_cache, MCL_DOMAIN, TRUE, NULL))
4592 (t = Ustrrchr(local_part, '%')) != NULL)
4594 new_address = string_copy(local_part);
4595 new_address[t - local_part] = '@';
4596 deliver_domain = string_copylc(t+1);
4597 local_part = string_copyn(local_part, t - local_part);
4600 if (rc == DEFER) return DEFER; /* lookup deferred */
4602 /* If hackery happened, set up new parent and alter the current address. */
4604 if (new_address != NULL)
4606 address_item *new_parent = store_get(sizeof(address_item));
4607 *new_parent = *addr;
4608 addr->parent = new_parent;
4609 addr->address = new_address;
4610 addr->unique = string_copy(new_address);
4611 addr->domain = deliver_domain;
4612 addr->cc_local_part = local_part;
4613 DEBUG(D_deliver) debug_printf("%%-hack changed address to: %s\n",
4618 /* Create the lowercased version of the final local part, and make that the
4619 default one to be used. */
4621 addr->local_part = addr->lc_local_part = string_copylc(addr->cc_local_part);
4628 /*************************************************
4629 * Get next error message text *
4630 *************************************************/
4632 /* If f is not NULL, read the next "paragraph", from a customized error message
4633 text file, terminated by a line containing ****, and expand it.
4636 f NULL or a file to read from
4637 which string indicating which string (for errors)
4639 Returns: NULL or an expanded string
4643 next_emf(FILE *f, uschar *which)
4647 uschar *para, *yield;
4650 if (f == NULL) return NULL;
4652 if (Ufgets(buffer, sizeof(buffer), f) == NULL ||
4653 Ustrcmp(buffer, "****\n") == 0) return NULL;
4655 para = store_get(size);
4658 para = string_cat(para, &size, &ptr, buffer, Ustrlen(buffer));
4659 if (Ufgets(buffer, sizeof(buffer), f) == NULL ||
4660 Ustrcmp(buffer, "****\n") == 0) break;
4664 yield = expand_string(para);
4665 if (yield != NULL) return yield;
4667 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand string from "
4668 "bounce_message_file or warn_message_file (%s): %s", which,
4669 expand_string_message);
4676 /*************************************************
4677 * Close down a passed transport channel *
4678 *************************************************/
4680 /* This function is called when a passed transport channel cannot be used.
4681 It attempts to close it down tidily. The yield is always DELIVER_NOT_ATTEMPTED
4682 so that the function call can be the argument of a "return" statement.
4685 Returns: DELIVER_NOT_ATTEMPTED
4689 continue_closedown(void)
4691 if (continue_transport != NULL)
4693 transport_instance *t;
4694 for (t = transports; t != NULL; t = t->next)
4696 if (Ustrcmp(t->name, continue_transport) == 0)
4698 if (t->info->closedown != NULL) (t->info->closedown)(t);
4703 return DELIVER_NOT_ATTEMPTED;
4709 /*************************************************
4710 * Print address information *
4711 *************************************************/
4713 /* This function is called to output an address, or information about an
4714 address, for bounce or defer messages. If the hide_child flag is set, all we
4715 output is the original ancestor address.
4718 addr points to the address
4719 f the FILE to print to
4720 si an initial string
4721 sc a continuation string for before "generated"
4724 Returns: TRUE if the address is not hidden
4728 print_address_information(address_item *addr, FILE *f, uschar *si, uschar *sc,
4732 uschar *printed = US"";
4733 address_item *ancestor = addr;
4734 while (ancestor->parent != NULL) ancestor = ancestor->parent;
4736 fprintf(f, "%s", CS si);
4738 if (addr->parent != NULL && testflag(addr, af_hide_child))
4740 printed = US"an undisclosed address";
4743 else if (!testflag(addr, af_pfr) || addr->parent == NULL)
4744 printed = addr->address;
4748 uschar *s = addr->address;
4751 if (addr->address[0] == '>') { ss = US"mail"; s++; }
4752 else if (addr->address[0] == '|') ss = US"pipe";
4755 fprintf(f, "%s to %s%sgenerated by ", ss, s, sc);
4756 printed = addr->parent->address;
4759 fprintf(f, "%s", CS string_printing(printed));
4761 if (ancestor != addr)
4763 uschar *original = (ancestor->onetime_parent == NULL)?
4764 ancestor->address : ancestor->onetime_parent;
4765 if (strcmpic(original, printed) != 0)
4766 fprintf(f, "%s(%sgenerated from %s)", sc,
4767 (ancestor != addr->parent)? "ultimately " : "",
4768 string_printing(original));
4771 if (addr->host_used)
4772 fprintf(f, "\n host %s [%s]",
4773 addr->host_used->name, addr->host_used->address);
4775 fprintf(f, "%s", CS se);
4783 /*************************************************
4784 * Print error for an address *
4785 *************************************************/
4787 /* This function is called to print the error information out of an address for
4788 a bounce or a warning message. It tries to format the message reasonably by
4789 introducing newlines. All lines are indented by 4; the initial printing
4790 position must be set before calling.
4792 This function used always to print the error. Nowadays we want to restrict it
4793 to cases such as LMTP/SMTP errors from a remote host, and errors from :fail:
4794 and filter "fail". We no longer pass other information willy-nilly in bounce
4795 and warning messages. Text in user_message is always output; text in message
4796 only if the af_pass_message flag is set.
4800 f the FILE to print on
4807 print_address_error(address_item *addr, FILE *f, uschar *t)
4809 int count = Ustrlen(t);
4810 uschar *s = testflag(addr, af_pass_message)? addr->message : NULL;
4812 if (!s && !(s = addr->user_message))
4815 fprintf(f, "\n %s", t);
4818 if (*s == '\\' && s[1] == 'n')
4828 if (*s++ == ':' && isspace(*s) && count > 45)
4830 fprintf(f, "\n "); /* sic (because space follows) */
4837 /***********************************************************
4838 * Print Diagnostic-Code for an address *
4839 ************************************************************/
4841 /* This function is called to print the error information out of an address for
4842 a bounce or a warning message. It tries to format the message reasonably as
4843 required by RFC 3461 by adding a space after each newline
4845 it uses the same logic as print_address_error() above. if af_pass_message is true
4846 and addr->message is set it uses the remote host answer. if not addr->user_message
4847 is used instead if available.
4851 f the FILE to print on
4857 print_dsn_diagnostic_code(const address_item *addr, FILE *f)
4859 uschar *s = testflag(addr, af_pass_message) ? addr->message : NULL;
4861 /* af_pass_message and addr->message set ? print remote host answer */
4865 debug_printf("DSN Diagnostic-Code: addr->message = %s\n", addr->message);
4867 /* search first ": ". we assume to find the remote-MTA answer there */
4868 if (!(s = Ustrstr(addr->message, ": ")))
4869 return; /* not found, bail out */
4870 s += 2; /* skip ": " */
4871 fprintf(f, "Diagnostic-Code: smtp; ");
4873 /* no message available. do nothing */
4877 if (*s == '\\' && s[1] == 'n')
4879 fputs("\n ", f); /* as defined in RFC 3461 */
4889 /*************************************************
4890 * Check list of addresses for duplication *
4891 *************************************************/
4893 /* This function was introduced when the test for duplicate addresses that are
4894 not pipes, files, or autoreplies was moved from the middle of routing to when
4895 routing was complete. That was to fix obscure cases when the routing history
4896 affects the subsequent routing of identical addresses. This function is called
4897 after routing, to check that the final routed addresses are not duplicates.
4899 If we detect a duplicate, we remember what it is a duplicate of. Note that
4900 pipe, file, and autoreply de-duplication is handled during routing, so we must
4901 leave such "addresses" alone here, as otherwise they will incorrectly be
4904 Argument: address of list anchor
4909 do_duplicate_check(address_item **anchor)
4912 while ((addr = *anchor) != NULL)
4915 if (testflag(addr, af_pfr))
4917 anchor = &(addr->next);
4919 else if ((tnode = tree_search(tree_duplicates, addr->unique)) != NULL)
4921 DEBUG(D_deliver|D_route)
4922 debug_printf("%s is a duplicate address: discarded\n", addr->unique);
4923 *anchor = addr->next;
4924 addr->dupof = tnode->data.ptr;
4925 addr->next = addr_duplicate;
4926 addr_duplicate = addr;
4930 tree_add_duplicate(addr->unique, addr);
4931 anchor = &(addr->next);
4939 /*************************************************
4940 * Deliver one message *
4941 *************************************************/
4943 /* This is the function which is called when a message is to be delivered. It
4944 is passed the id of the message. It is possible that the message no longer
4945 exists, if some other process has delivered it, and it is also possible that
4946 the message is being worked on by another process, in which case the data file
4949 If no delivery is attempted for any of the above reasons, the function returns
4950 DELIVER_NOT_ATTEMPTED.
4952 If the give_up flag is set true, do not attempt any deliveries, but instead
4953 fail all outstanding addresses and return the message to the sender (or
4956 A delivery operation has a process all to itself; we never deliver more than
4957 one message in the same process. Therefore we needn't worry too much about
4961 id the id of the message to be delivered
4962 forced TRUE if delivery was forced by an administrator; this overrides
4963 retry delays and causes a delivery to be tried regardless
4964 give_up TRUE if an administrator has requested that delivery attempts
4967 Returns: When the global variable mua_wrapper is FALSE:
4968 DELIVER_ATTEMPTED_NORMAL if a delivery attempt was made
4969 DELIVER_NOT_ATTEMPTED otherwise (see comment above)
4970 When the global variable mua_wrapper is TRUE:
4971 DELIVER_MUA_SUCCEEDED if delivery succeeded
4972 DELIVER_MUA_FAILED if delivery failed
4973 DELIVER_NOT_ATTEMPTED if not attempted (should not occur)
4977 deliver_message(uschar *id, BOOL forced, BOOL give_up)
4980 int final_yield = DELIVER_ATTEMPTED_NORMAL;
4981 time_t now = time(NULL);
4982 address_item *addr_last = NULL;
4983 uschar *filter_message = NULL;
4985 int process_recipients = RECIP_ACCEPT;
4988 extern int acl_where;
4990 uschar *info = (queue_run_pid == (pid_t)0)?
4991 string_sprintf("delivering %s", id) :
4992 string_sprintf("delivering %s (queue run pid %d)", id, queue_run_pid);
4994 /* If the D_process_info bit is on, set_process_info() will output debugging
4995 information. If not, we want to show this initial information if D_deliver or
4996 D_queue_run is set or in verbose mode. */
4998 set_process_info("%s", info);
5000 if ((debug_selector & D_process_info) == 0 &&
5001 (debug_selector & (D_deliver|D_queue_run|D_v)) != 0)
5002 debug_printf("%s\n", info);
5004 /* Ensure that we catch any subprocesses that are created. Although Exim
5005 sets SIG_DFL as its initial default, some routes through the code end up
5006 here with it set to SIG_IGN - cases where a non-synchronous delivery process
5007 has been forked, but no re-exec has been done. We use sigaction rather than
5008 plain signal() on those OS where SA_NOCLDWAIT exists, because we want to be
5009 sure it is turned off. (There was a problem on AIX with this.) */
5013 struct sigaction act;
5014 act.sa_handler = SIG_DFL;
5015 sigemptyset(&(act.sa_mask));
5017 sigaction(SIGCHLD, &act, NULL);
5020 signal(SIGCHLD, SIG_DFL);
5023 /* Make the forcing flag available for routers and transports, set up the
5024 global message id field, and initialize the count for returned files and the
5025 message size. This use of strcpy() is OK because the length id is checked when
5026 it is obtained from a command line (the -M or -q options), and otherwise it is
5027 known to be a valid message id. */
5029 Ustrcpy(message_id, id);
5030 deliver_force = forced;
5034 /* Initialize some flags */
5036 update_spool = FALSE;
5037 remove_journal = TRUE;
5039 /* Set a known context for any ACLs we call via expansions */
5040 acl_where = ACL_WHERE_DELIVERY;
5042 /* Reset the random number generator, so that if several delivery processes are
5043 started from a queue runner that has already used random numbers (for sorting),
5044 they don't all get the same sequence. */
5048 /* Open and lock the message's data file. Exim locks on this one because the
5049 header file may get replaced as it is re-written during the delivery process.
5050 Any failures cause messages to be written to the log, except for missing files
5051 while queue running - another process probably completed delivery. As part of
5052 opening the data file, message_subdir gets set. */
5054 if (!spool_open_datafile(id))
5055 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5057 /* The value of message_size at this point has been set to the data length,
5058 plus one for the blank line that notionally precedes the data. */
5060 /* Now read the contents of the header file, which will set up the headers in
5061 store, and also the list of recipients and the tree of non-recipients and
5062 assorted flags. It updates message_size. If there is a reading or format error,
5063 give up; if the message has been around for sufficiently long, remove it. */
5065 sprintf(CS spoolname, "%s-H", id);
5066 if ((rc = spool_read_header(spoolname, TRUE, TRUE)) != spool_read_OK)
5068 if (errno == ERRNO_SPOOLFORMAT)
5070 struct stat statbuf;
5071 sprintf(CS big_buffer, "%s/input/%s/%s", spool_directory, message_subdir,
5073 if (Ustat(big_buffer, &statbuf) == 0)
5074 log_write(0, LOG_MAIN, "Format error in spool file %s: "
5075 "size=" OFF_T_FMT, spoolname, statbuf.st_size);
5076 else log_write(0, LOG_MAIN, "Format error in spool file %s", spoolname);
5079 log_write(0, LOG_MAIN, "Error reading spool file %s: %s", spoolname,
5082 /* If we managed to read the envelope data, received_time contains the
5083 time the message was received. Otherwise, we can calculate it from the
5086 if (rc != spool_read_hdrerror)
5089 for (i = 0; i < 6; i++)
5090 received_time = received_time * BASE_62 + tab62[id[i] - '0'];
5093 /* If we've had this malformed message too long, sling it. */
5095 if (now - received_time > keep_malformed)
5097 sprintf(CS spoolname, "%s/msglog/%s/%s", spool_directory, message_subdir, id);
5099 sprintf(CS spoolname, "%s/input/%s/%s-D", spool_directory, message_subdir, id);
5101 sprintf(CS spoolname, "%s/input/%s/%s-H", spool_directory, message_subdir, id);
5103 sprintf(CS spoolname, "%s/input/%s/%s-J", spool_directory, message_subdir, id);
5105 log_write(0, LOG_MAIN, "Message removed because older than %s",
5106 readconf_printtime(keep_malformed));
5109 (void)close(deliver_datafile);
5110 deliver_datafile = -1;
5111 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5114 /* The spool header file has been read. Look to see if there is an existing
5115 journal file for this message. If there is, it means that a previous delivery
5116 attempt crashed (program or host) before it could update the spool header file.
5117 Read the list of delivered addresses from the journal and add them to the
5118 nonrecipients tree. Then update the spool file. We can leave the journal in
5119 existence, as it will get further successful deliveries added to it in this
5120 run, and it will be deleted if this function gets to its end successfully.
5121 Otherwise it might be needed again. */
5123 sprintf(CS spoolname, "%s/input/%s/%s-J", spool_directory, message_subdir, id);
5124 jread = Ufopen(spoolname, "rb");
5127 while (Ufgets(big_buffer, big_buffer_size, jread) != NULL)
5129 int n = Ustrlen(big_buffer);
5130 big_buffer[n-1] = 0;
5131 tree_add_nonrecipient(big_buffer);
5132 DEBUG(D_deliver) debug_printf("Previously delivered address %s taken from "
5133 "journal file\n", big_buffer);
5135 (void)fclose(jread);
5136 /* Panic-dies on error */
5137 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
5139 else if (errno != ENOENT)
5141 log_write(0, LOG_MAIN|LOG_PANIC, "attempt to open journal for reading gave: "
5142 "%s", strerror(errno));
5143 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5146 /* A null recipients list indicates some kind of disaster. */
5148 if (recipients_list == NULL)
5150 (void)close(deliver_datafile);
5151 deliver_datafile = -1;
5152 log_write(0, LOG_MAIN, "Spool error: no recipients for %s", spoolname);
5153 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5157 /* Handle a message that is frozen. There are a number of different things that
5158 can happen, but in the default situation, unless forced, no delivery is
5163 #ifdef SUPPORT_MOVE_FROZEN_MESSAGES
5164 /* Moving to another directory removes the message from Exim's view. Other
5165 tools must be used to deal with it. Logging of this action happens in
5166 spool_move_message() and its subfunctions. */
5168 if (move_frozen_messages &&
5169 spool_move_message(id, message_subdir, US"", US"F"))
5170 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5173 /* For all frozen messages (bounces or not), timeout_frozen_after sets the
5174 maximum time to keep messages that are frozen. Thaw if we reach it, with a
5175 flag causing all recipients to be failed. The time is the age of the
5176 message, not the time since freezing. */
5178 if (timeout_frozen_after > 0 && message_age >= timeout_frozen_after)
5180 log_write(0, LOG_MAIN, "cancelled by timeout_frozen_after");
5181 process_recipients = RECIP_FAIL_TIMEOUT;
5184 /* For bounce messages (and others with no sender), thaw if the error message
5185 ignore timer is exceeded. The message will be discarded if this delivery
5188 else if (sender_address[0] == 0 && message_age >= ignore_bounce_errors_after)
5190 log_write(0, LOG_MAIN, "Unfrozen by errmsg timer");
5193 /* If this is a bounce message, or there's no auto thaw, or we haven't
5194 reached the auto thaw time yet, and this delivery is not forced by an admin
5195 user, do not attempt delivery of this message. Note that forced is set for
5196 continuing messages down the same channel, in order to skip load checking and
5197 ignore hold domains, but we don't want unfreezing in that case. */
5201 if ((sender_address[0] == 0 ||
5203 now <= deliver_frozen_at + auto_thaw
5206 (!forced || !deliver_force_thaw || !admin_user ||
5207 continue_hostname != NULL
5210 (void)close(deliver_datafile);
5211 deliver_datafile = -1;
5212 log_write(L_skip_delivery, LOG_MAIN, "Message is frozen");
5213 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5216 /* If delivery was forced (by an admin user), assume a manual thaw.
5217 Otherwise it's an auto thaw. */
5221 deliver_manual_thaw = TRUE;
5222 log_write(0, LOG_MAIN, "Unfrozen by forced delivery");
5224 else log_write(0, LOG_MAIN, "Unfrozen by auto-thaw");
5227 /* We get here if any of the rules for unfreezing have triggered. */
5229 deliver_freeze = FALSE;
5230 update_spool = TRUE;
5234 /* Open the message log file if we are using them. This records details of
5235 deliveries, deferments, and failures for the benefit of the mail administrator.
5236 The log is not used by exim itself to track the progress of a message; that is
5237 done by rewriting the header spool file. */
5244 sprintf(CS spoolname, "%s/msglog/%s/%s", spool_directory, message_subdir, id);
5245 fd = open_msglog_file(spoolname, SPOOL_MODE, &error);
5249 log_write(0, LOG_MAIN|LOG_PANIC, "Couldn't %s message log %s: %s", error,
5250 spoolname, strerror(errno));
5251 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5254 /* Make a C stream out of it. */
5256 message_log = fdopen(fd, "a");
5257 if (message_log == NULL)
5259 log_write(0, LOG_MAIN|LOG_PANIC, "Couldn't fdopen message log %s: %s",
5260 spoolname, strerror(errno));
5261 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5266 /* If asked to give up on a message, log who did it, and set the action for all
5271 struct passwd *pw = getpwuid(real_uid);
5272 log_write(0, LOG_MAIN, "cancelled by %s", (pw != NULL)?
5273 US pw->pw_name : string_sprintf("uid %ld", (long int)real_uid));
5274 process_recipients = RECIP_FAIL;
5277 /* Otherwise, if there are too many Received: headers, fail all recipients. */
5279 else if (received_count > received_headers_max)
5280 process_recipients = RECIP_FAIL_LOOP;
5282 /* Otherwise, if a system-wide, address-independent message filter is
5283 specified, run it now, except in the case when we are failing all recipients as
5284 a result of timeout_frozen_after. If the system filter yields "delivered", then
5285 ignore the true recipients of the message. Failure of the filter file is
5286 logged, and the delivery attempt fails. */
5288 else if (system_filter != NULL && process_recipients != RECIP_FAIL_TIMEOUT)
5293 redirect_block redirect;
5295 if (system_filter_uid_set)
5297 ugid.uid = system_filter_uid;
5298 ugid.gid = system_filter_gid;
5299 ugid.uid_set = ugid.gid_set = TRUE;
5303 ugid.uid_set = ugid.gid_set = FALSE;
5306 return_path = sender_address;
5307 enable_dollar_recipients = TRUE; /* Permit $recipients in system filter */
5308 system_filtering = TRUE;
5310 /* Any error in the filter file causes a delivery to be abandoned. */
5312 redirect.string = system_filter;
5313 redirect.isfile = TRUE;
5314 redirect.check_owner = redirect.check_group = FALSE;
5315 redirect.owners = NULL;
5316 redirect.owngroups = NULL;
5318 redirect.modemask = 0;
5320 DEBUG(D_deliver|D_filter) debug_printf("running system filter\n");
5323 &redirect, /* Where the data is */
5324 RDO_DEFER | /* Turn on all the enabling options */
5325 RDO_FAIL | /* Leave off all the disabling options */
5330 NULL, /* No :include: restriction (not used in filter) */
5331 NULL, /* No sieve vacation directory (not sieve!) */
5332 NULL, /* No sieve enotify mailto owner (not sieve!) */
5333 NULL, /* No sieve user address (not sieve!) */
5334 NULL, /* No sieve subaddress (not sieve!) */
5335 &ugid, /* uid/gid data */
5336 &addr_new, /* Where to hang generated addresses */
5337 &filter_message, /* Where to put error message */
5338 NULL, /* Don't skip syntax errors */
5339 &filtertype, /* Will always be set to FILTER_EXIM for this call */
5340 US"system filter"); /* For error messages */
5342 DEBUG(D_deliver|D_filter) debug_printf("system filter returned %d\n", rc);
5344 if (rc == FF_ERROR || rc == FF_NONEXIST)
5346 (void)close(deliver_datafile);
5347 deliver_datafile = -1;
5348 log_write(0, LOG_MAIN|LOG_PANIC, "Error in system filter: %s",
5349 string_printing(filter_message));
5350 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5353 /* Reset things. If the filter message is an empty string, which can happen
5354 for a filter "fail" or "freeze" command with no text, reset it to NULL. */
5356 system_filtering = FALSE;
5357 enable_dollar_recipients = FALSE;
5358 if (filter_message != NULL && filter_message[0] == 0) filter_message = NULL;
5360 /* Save the values of the system filter variables so that user filters
5363 memcpy(filter_sn, filter_n, sizeof(filter_sn));
5365 /* The filter can request that delivery of the original addresses be
5370 process_recipients = RECIP_DEFER;
5371 deliver_msglog("Delivery deferred by system filter\n");
5372 log_write(0, LOG_MAIN, "Delivery deferred by system filter");
5375 /* The filter can request that a message be frozen, but this does not
5376 take place if the message has been manually thawed. In that case, we must
5377 unset "delivered", which is forced by the "freeze" command to make -bF
5380 else if (rc == FF_FREEZE && !deliver_manual_thaw)
5382 deliver_freeze = TRUE;
5383 deliver_frozen_at = time(NULL);
5384 process_recipients = RECIP_DEFER;
5385 frozen_info = string_sprintf(" by the system filter%s%s",
5386 (filter_message == NULL)? US"" : US": ",
5387 (filter_message == NULL)? US"" : filter_message);
5390 /* The filter can request that a message be failed. The error message may be
5391 quite long - it is sent back to the sender in the bounce - but we don't want
5392 to fill up the log with repetitions of it. If it starts with << then the text
5393 between << and >> is written to the log, with the rest left for the bounce
5396 else if (rc == FF_FAIL)
5398 uschar *colon = US"";
5399 uschar *logmsg = US"";
5402 process_recipients = RECIP_FAIL_FILTER;
5404 if (filter_message != NULL)
5408 if (filter_message[0] == '<' && filter_message[1] == '<' &&
5409 (logend = Ustrstr(filter_message, ">>")) != NULL)
5411 logmsg = filter_message + 2;
5412 loglen = logend - logmsg;
5413 filter_message = logend + 2;
5414 if (filter_message[0] == 0) filter_message = NULL;
5418 logmsg = filter_message;
5419 loglen = Ustrlen(filter_message);
5423 log_write(0, LOG_MAIN, "cancelled by system filter%s%.*s", colon, loglen,
5427 /* Delivery can be restricted only to those recipients (if any) that the
5428 filter specified. */
5430 else if (rc == FF_DELIVERED)
5432 process_recipients = RECIP_IGNORE;
5433 if (addr_new == NULL)
5434 log_write(0, LOG_MAIN, "=> discarded (system filter)");
5436 log_write(0, LOG_MAIN, "original recipients ignored (system filter)");
5439 /* If any new addresses were created by the filter, fake up a "parent"
5440 for them. This is necessary for pipes, etc., which are expected to have
5441 parents, and it also gives some sensible logging for others. Allow
5442 pipes, files, and autoreplies, and run them as the filter uid if set,
5443 otherwise as the current uid. */
5445 if (addr_new != NULL)
5447 int uid = (system_filter_uid_set)? system_filter_uid : geteuid();
5448 int gid = (system_filter_gid_set)? system_filter_gid : getegid();
5450 /* The text "system-filter" is tested in transport_set_up_command() and in
5451 set_up_shell_command() in the pipe transport, to enable them to permit
5452 $recipients, so don't change it here without also changing it there. */
5454 address_item *p = addr_new;
5455 address_item *parent = deliver_make_addr(US"system-filter", FALSE);
5457 parent->domain = string_copylc(qualify_domain_recipient);
5458 parent->local_part = US"system-filter";
5460 /* As part of this loop, we arrange for addr_last to end up pointing
5461 at the final address. This is used if we go on to add addresses for the
5462 original recipients. */
5466 if (parent->child_count == SHRT_MAX)
5467 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "system filter generated more "
5468 "than %d delivery addresses", SHRT_MAX);
5469 parent->child_count++;
5472 if (testflag(p, af_pfr))
5478 setflag(p, af_uid_set |
5484 /* Find the name of the system filter's appropriate pfr transport */
5486 if (p->address[0] == '|')
5489 tpname = system_filter_pipe_transport;
5490 address_pipe = p->address;
5492 else if (p->address[0] == '>')
5495 tpname = system_filter_reply_transport;
5499 if (p->address[Ustrlen(p->address)-1] == '/')
5501 type = US"directory";
5502 tpname = system_filter_directory_transport;
5507 tpname = system_filter_file_transport;
5509 address_file = p->address;
5512 /* Now find the actual transport, first expanding the name. We have
5513 set address_file or address_pipe above. */
5517 uschar *tmp = expand_string(tpname);
5518 address_file = address_pipe = NULL;
5520 p->message = string_sprintf("failed to expand \"%s\" as a "
5521 "system filter transport name", tpname);
5526 p->message = string_sprintf("system_filter_%s_transport is unset",
5532 transport_instance *tp;
5533 for (tp = transports; tp != NULL; tp = tp->next)
5535 if (Ustrcmp(tp->name, tpname) == 0)
5542 p->message = string_sprintf("failed to find \"%s\" transport "
5543 "for system filter delivery", tpname);
5546 /* If we couldn't set up a transport, defer the delivery, putting the
5547 error on the panic log as well as the main log. */
5549 if (p->transport == NULL)
5551 address_item *badp = p;
5553 if (addr_last == NULL) addr_new = p; else addr_last->next = p;
5554 badp->local_part = badp->address; /* Needed for log line */
5555 post_process_one(badp, DEFER, LOG_MAIN|LOG_PANIC, DTYPE_ROUTER, 0);
5558 } /* End of pfr handling */
5560 /* Either a non-pfr delivery, or we found a transport */
5562 DEBUG(D_deliver|D_filter)
5563 debug_printf("system filter added %s\n", p->address);
5567 } /* Loop through all addr_new addresses */
5572 /* Scan the recipients list, and for every one that is not in the non-
5573 recipients tree, add an addr item to the chain of new addresses. If the pno
5574 value is non-negative, we must set the onetime parent from it. This which
5575 points to the relevant entry in the recipients list.
5577 This processing can be altered by the setting of the process_recipients
5578 variable, which is changed if recipients are to be ignored, failed, or
5579 deferred. This can happen as a result of system filter activity, or if the -Mg
5580 option is used to fail all of them.
5582 Duplicate addresses are handled later by a different tree structure; we can't
5583 just extend the non-recipients tree, because that will be re-written to the
5584 spool if the message is deferred, and in any case there are casing
5585 complications for local addresses. */
5587 if (process_recipients != RECIP_IGNORE)
5589 for (i = 0; i < recipients_count; i++)
5591 if (tree_search(tree_nonrecipients, recipients_list[i].address) == NULL)
5593 recipient_item *r = recipients_list + i;
5594 address_item *new = deliver_make_addr(r->address, FALSE);
5595 new->prop.errors_address = r->errors_to;
5596 #ifdef EXPERIMENTAL_INTERNATIONAL
5597 if ((new->prop.utf8_msg = message_smtputf8))
5599 new->prop.utf8_downcvt = message_utf8_downconvert == 1;
5600 new->prop.utf8_downcvt_maybe = message_utf8_downconvert == -1;
5601 DEBUG(D_deliver) debug_printf("utf8, downconvert %s\n",
5602 new->prop.utf8_downcvt ? "yes"
5603 : new->prop.utf8_downcvt_maybe ? "ifneeded"
5609 new->onetime_parent = recipients_list[r->pno].address;
5611 /* If DSN support is enabled, set the dsn flags and the original receipt
5612 to be passed on to other DSN enabled MTAs */
5613 new->dsn_flags = r->dsn_flags & rf_dsnflags;
5614 new->dsn_orcpt = r->orcpt;
5615 DEBUG(D_deliver) debug_printf("DSN: set orcpt: %s flags: %d\n",
5616 new->dsn_orcpt, new->dsn_flags);
5618 switch (process_recipients)
5620 /* RECIP_DEFER is set when a system filter freezes a message. */
5623 new->next = addr_defer;
5628 /* RECIP_FAIL_FILTER is set when a system filter has obeyed a "fail"
5631 case RECIP_FAIL_FILTER:
5633 (filter_message == NULL)? US"delivery cancelled" : filter_message;
5634 setflag(new, af_pass_message);
5635 goto RECIP_QUEUE_FAILED; /* below */
5638 /* RECIP_FAIL_TIMEOUT is set when a message is frozen, but is older
5639 than the value in timeout_frozen_after. Treat non-bounce messages
5640 similarly to -Mg; for bounce messages we just want to discard, so
5641 don't put the address on the failed list. The timeout has already
5644 case RECIP_FAIL_TIMEOUT:
5645 new->message = US"delivery cancelled; message timed out";
5646 goto RECIP_QUEUE_FAILED; /* below */
5649 /* RECIP_FAIL is set when -Mg has been used. */
5652 new->message = US"delivery cancelled by administrator";
5655 /* Common code for the failure cases above. If this is not a bounce
5656 message, put the address on the failed list so that it is used to
5657 create a bounce. Otherwise do nothing - this just discards the address.
5658 The incident has already been logged. */
5661 if (sender_address[0] != 0)
5663 new->next = addr_failed;
5669 /* RECIP_FAIL_LOOP is set when there are too many Received: headers
5670 in the message. Process each address as a routing failure; if this
5671 is a bounce message, it will get frozen. */
5673 case RECIP_FAIL_LOOP:
5674 new->message = US"Too many \"Received\" headers - suspected mail loop";
5675 post_process_one(new, FAIL, LOG_MAIN, DTYPE_ROUTER, 0);
5679 /* Value should be RECIP_ACCEPT; take this as the safe default. */
5682 if (addr_new == NULL) addr_new = new; else addr_last->next = new;
5687 #ifdef EXPERIMENTAL_EVENT
5688 if (process_recipients != RECIP_ACCEPT)
5690 uschar * save_local = deliver_localpart;
5691 const uschar * save_domain = deliver_domain;
5693 deliver_localpart = expand_string(
5694 string_sprintf("${local_part:%s}", new->address));
5695 deliver_domain = expand_string(
5696 string_sprintf("${domain:%s}", new->address));
5698 (void) event_raise(event_action,
5699 US"msg:fail:internal", new->message);
5701 deliver_localpart = save_local;
5702 deliver_domain = save_domain;
5711 address_item *p = addr_new;
5712 debug_printf("Delivery address list:\n");
5715 debug_printf(" %s %s\n", p->address, (p->onetime_parent == NULL)? US"" :
5721 /* Set up the buffers used for copying over the file when delivering. */
5723 deliver_in_buffer = store_malloc(DELIVER_IN_BUFFER_SIZE);
5724 deliver_out_buffer = store_malloc(DELIVER_OUT_BUFFER_SIZE);
5728 /* Until there are no more new addresses, handle each one as follows:
5730 . If this is a generated address (indicated by the presence of a parent
5731 pointer) then check to see whether it is a pipe, file, or autoreply, and
5732 if so, handle it directly here. The router that produced the address will
5733 have set the allow flags into the address, and also set the uid/gid required.
5734 Having the routers generate new addresses and then checking them here at
5735 the outer level is tidier than making each router do the checking, and
5736 means that routers don't need access to the failed address queue.
5738 . Break up the address into local part and domain, and make lowercased
5739 versions of these strings. We also make unquoted versions of the local part.
5741 . Handle the percent hack for those domains for which it is valid.
5743 . For child addresses, determine if any of the parents have the same address.
5744 If so, generate a different string for previous delivery checking. Without
5745 this code, if the address spqr generates spqr via a forward or alias file,
5746 delivery of the generated spqr stops further attempts at the top level spqr,
5747 which is not what is wanted - it may have generated other addresses.
5749 . Check on the retry database to see if routing was previously deferred, but
5750 only if in a queue run. Addresses that are to be routed are put on the
5751 addr_route chain. Addresses that are to be deferred are put on the
5752 addr_defer chain. We do all the checking first, so as not to keep the
5753 retry database open any longer than necessary.
5755 . Now we run the addresses through the routers. A router may put the address
5756 on either the addr_local or the addr_remote chain for local or remote
5757 delivery, respectively, or put it on the addr_failed chain if it is
5758 undeliveable, or it may generate child addresses and put them on the
5759 addr_new chain, or it may defer an address. All the chain anchors are
5760 passed as arguments so that the routers can be called for verification
5763 . If new addresses have been generated by the routers, da capo.
5766 header_rewritten = FALSE; /* No headers rewritten yet */
5767 while (addr_new != NULL) /* Loop until all addresses dealt with */
5769 address_item *addr, *parent;
5770 dbm_file = dbfn_open(US"retry", O_RDONLY, &dbblock, FALSE);
5772 /* Failure to open the retry database is treated the same as if it does
5773 not exist. In both cases, dbm_file is NULL. */
5775 if (dbm_file == NULL)
5777 DEBUG(D_deliver|D_retry|D_route|D_hints_lookup)
5778 debug_printf("no retry data available\n");
5781 /* Scan the current batch of new addresses, to handle pipes, files and
5782 autoreplies, and determine which others are ready for routing. */
5784 while (addr_new != NULL)
5789 dbdata_retry *domain_retry_record;
5790 dbdata_retry *address_retry_record;
5793 addr_new = addr->next;
5795 DEBUG(D_deliver|D_retry|D_route)
5797 debug_printf(">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>\n");
5798 debug_printf("Considering: %s\n", addr->address);
5801 /* Handle generated address that is a pipe or a file or an autoreply. */
5803 if (testflag(addr, af_pfr))
5805 /* If an autoreply in a filter could not generate a syntactically valid
5806 address, give up forthwith. Set af_ignore_error so that we don't try to
5807 generate a bounce. */
5809 if (testflag(addr, af_bad_reply))
5811 addr->basic_errno = ERRNO_BADADDRESS2;
5812 addr->local_part = addr->address;
5814 US"filter autoreply generated syntactically invalid recipient";
5815 setflag(addr, af_ignore_error);
5816 (void)post_process_one(addr, FAIL, LOG_MAIN, DTYPE_ROUTER, 0);
5817 continue; /* with the next new address */
5820 /* If two different users specify delivery to the same pipe or file or
5821 autoreply, there should be two different deliveries, so build a unique
5822 string that incorporates the original address, and use this for
5823 duplicate testing and recording delivery, and also for retrying. */
5826 string_sprintf("%s:%s", addr->address, addr->parent->unique +
5827 (testflag(addr->parent, af_homonym)? 3:0));
5829 addr->address_retry_key = addr->domain_retry_key =
5830 string_sprintf("T:%s", addr->unique);
5832 /* If a filter file specifies two deliveries to the same pipe or file,
5833 we want to de-duplicate, but this is probably not wanted for two mail
5834 commands to the same address, where probably both should be delivered.
5835 So, we have to invent a different unique string in that case. Just
5836 keep piling '>' characters on the front. */
5838 if (addr->address[0] == '>')
5840 while (tree_search(tree_duplicates, addr->unique) != NULL)
5841 addr->unique = string_sprintf(">%s", addr->unique);
5844 else if ((tnode = tree_search(tree_duplicates, addr->unique)) != NULL)
5846 DEBUG(D_deliver|D_route)
5847 debug_printf("%s is a duplicate address: discarded\n", addr->address);
5848 addr->dupof = tnode->data.ptr;
5849 addr->next = addr_duplicate;
5850 addr_duplicate = addr;
5854 DEBUG(D_deliver|D_route) debug_printf("unique = %s\n", addr->unique);
5856 /* Check for previous delivery */
5858 if (tree_search(tree_nonrecipients, addr->unique) != NULL)
5860 DEBUG(D_deliver|D_route)
5861 debug_printf("%s was previously delivered: discarded\n", addr->address);
5862 child_done(addr, tod_stamp(tod_log));
5866 /* Save for checking future duplicates */
5868 tree_add_duplicate(addr->unique, addr);
5870 /* Set local part and domain */
5872 addr->local_part = addr->address;
5873 addr->domain = addr->parent->domain;
5875 /* Ensure that the delivery is permitted. */
5877 if (testflag(addr, af_file))
5879 if (!testflag(addr, af_allow_file))
5881 addr->basic_errno = ERRNO_FORBIDFILE;
5882 addr->message = US"delivery to file forbidden";
5883 (void)post_process_one(addr, FAIL, LOG_MAIN, DTYPE_ROUTER, 0);
5884 continue; /* with the next new address */
5887 else if (addr->address[0] == '|')
5889 if (!testflag(addr, af_allow_pipe))
5891 addr->basic_errno = ERRNO_FORBIDPIPE;
5892 addr->message = US"delivery to pipe forbidden";
5893 (void)post_process_one(addr, FAIL, LOG_MAIN, DTYPE_ROUTER, 0);
5894 continue; /* with the next new address */
5897 else if (!testflag(addr, af_allow_reply))
5899 addr->basic_errno = ERRNO_FORBIDREPLY;
5900 addr->message = US"autoreply forbidden";
5901 (void)post_process_one(addr, FAIL, LOG_MAIN, DTYPE_ROUTER, 0);
5902 continue; /* with the next new address */
5905 /* If the errno field is already set to BADTRANSPORT, it indicates
5906 failure to expand a transport string, or find the associated transport,
5907 or an unset transport when one is required. Leave this test till now so
5908 that the forbid errors are given in preference. */
5910 if (addr->basic_errno == ERRNO_BADTRANSPORT)
5912 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_ROUTER, 0);
5916 /* Treat /dev/null as a special case and abandon the delivery. This
5917 avoids having to specify a uid on the transport just for this case.
5918 Arrange for the transport name to be logged as "**bypassed**". */
5920 if (Ustrcmp(addr->address, "/dev/null") == 0)
5922 uschar *save = addr->transport->name;
5923 addr->transport->name = US"**bypassed**";
5924 (void)post_process_one(addr, OK, LOG_MAIN, DTYPE_TRANSPORT, '=');
5925 addr->transport->name = save;
5926 continue; /* with the next new address */
5929 /* Pipe, file, or autoreply delivery is to go ahead as a normal local
5932 DEBUG(D_deliver|D_route)
5933 debug_printf("queued for %s transport\n", addr->transport->name);
5934 addr->next = addr_local;
5936 continue; /* with the next new address */
5939 /* Handle normal addresses. First, split up into local part and domain,
5940 handling the %-hack if necessary. There is the possibility of a defer from
5941 a lookup in percent_hack_domains. */
5943 if ((rc = deliver_split_address(addr)) == DEFER)
5945 addr->message = US"cannot check percent_hack_domains";
5946 addr->basic_errno = ERRNO_LISTDEFER;
5947 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_NONE, 0);
5951 /* Check to see if the domain is held. If so, proceed only if the
5952 delivery was forced by hand. */
5954 deliver_domain = addr->domain; /* set $domain */
5955 if (!forced && hold_domains != NULL &&
5956 (rc = match_isinlist(addr->domain, (const uschar **)&hold_domains, 0,
5957 &domainlist_anchor, addr->domain_cache, MCL_DOMAIN, TRUE,
5962 addr->message = US"hold_domains lookup deferred";
5963 addr->basic_errno = ERRNO_LISTDEFER;
5967 addr->message = US"domain is held";
5968 addr->basic_errno = ERRNO_HELD;
5970 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_NONE, 0);
5974 /* Now we can check for duplicates and previously delivered addresses. In
5975 order to do this, we have to generate a "unique" value for each address,
5976 because there may be identical actual addresses in a line of descendents.
5977 The "unique" field is initialized to the same value as the "address" field,
5978 but gets changed here to cope with identically-named descendents. */
5980 for (parent = addr->parent; parent != NULL; parent = parent->parent)
5981 if (strcmpic(addr->address, parent->address) == 0) break;
5983 /* If there's an ancestor with the same name, set the homonym flag. This
5984 influences how deliveries are recorded. Then add a prefix on the front of
5985 the unique address. We use \n\ where n starts at 0 and increases each time.
5986 It is unlikely to pass 9, but if it does, it may look odd but will still
5987 work. This means that siblings or cousins with the same names are treated
5988 as duplicates, which is what we want. */
5992 setflag(addr, af_homonym);
5993 if (parent->unique[0] != '\\')
5994 addr->unique = string_sprintf("\\0\\%s", addr->address);
5996 addr->unique = string_sprintf("\\%c\\%s", parent->unique[1] + 1,
6000 /* Ensure that the domain in the unique field is lower cased, because
6001 domains are always handled caselessly. */
6003 p = Ustrrchr(addr->unique, '@');
6004 while (*p != 0) { *p = tolower(*p); p++; }
6006 DEBUG(D_deliver|D_route) debug_printf("unique = %s\n", addr->unique);
6008 if (tree_search(tree_nonrecipients, addr->unique) != NULL)
6010 DEBUG(D_deliver|D_route)
6011 debug_printf("%s was previously delivered: discarded\n", addr->unique);
6012 child_done(addr, tod_stamp(tod_log));
6016 /* Get the routing retry status, saving the two retry keys (with and
6017 without the local part) for subsequent use. If there is no retry record for
6018 the standard address routing retry key, we look for the same key with the
6019 sender attached, because this form is used by the smtp transport after a
6020 4xx response to RCPT when address_retry_include_sender is true. */
6022 addr->domain_retry_key = string_sprintf("R:%s", addr->domain);
6023 addr->address_retry_key = string_sprintf("R:%s@%s", addr->local_part,
6026 if (dbm_file == NULL)
6027 domain_retry_record = address_retry_record = NULL;
6030 domain_retry_record = dbfn_read(dbm_file, addr->domain_retry_key);
6031 if (domain_retry_record != NULL &&
6032 now - domain_retry_record->time_stamp > retry_data_expire)
6033 domain_retry_record = NULL; /* Ignore if too old */
6035 address_retry_record = dbfn_read(dbm_file, addr->address_retry_key);
6036 if (address_retry_record != NULL &&
6037 now - address_retry_record->time_stamp > retry_data_expire)
6038 address_retry_record = NULL; /* Ignore if too old */
6040 if (address_retry_record == NULL)
6042 uschar *altkey = string_sprintf("%s:<%s>", addr->address_retry_key,
6044 address_retry_record = dbfn_read(dbm_file, altkey);
6045 if (address_retry_record != NULL &&
6046 now - address_retry_record->time_stamp > retry_data_expire)
6047 address_retry_record = NULL; /* Ignore if too old */
6051 DEBUG(D_deliver|D_retry)
6053 if (domain_retry_record == NULL)
6054 debug_printf("no domain retry record\n");
6055 if (address_retry_record == NULL)
6056 debug_printf("no address retry record\n");
6059 /* If we are sending a message down an existing SMTP connection, we must
6060 assume that the message which created the connection managed to route
6061 an address to that connection. We do not want to run the risk of taking
6062 a long time over routing here, because if we do, the server at the other
6063 end of the connection may time it out. This is especially true for messages
6064 with lots of addresses. For this kind of delivery, queue_running is not
6065 set, so we would normally route all addresses. We take a pragmatic approach
6066 and defer routing any addresses that have any kind of domain retry record.
6067 That is, we don't even look at their retry times. It doesn't matter if this
6068 doesn't work occasionally. This is all just an optimization, after all.
6070 The reason for not doing the same for address retries is that they normally
6071 arise from 4xx responses, not DNS timeouts. */
6073 if (continue_hostname != NULL && domain_retry_record != NULL)
6075 addr->message = US"reusing SMTP connection skips previous routing defer";
6076 addr->basic_errno = ERRNO_RRETRY;
6077 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_ROUTER, 0);
6080 /* If we are in a queue run, defer routing unless there is no retry data or
6081 we've passed the next retry time, or this message is forced. In other
6082 words, ignore retry data when not in a queue run.
6084 However, if the domain retry time has expired, always allow the routing
6085 attempt. If it fails again, the address will be failed. This ensures that
6086 each address is routed at least once, even after long-term routing
6089 If there is an address retry, check that too; just wait for the next
6090 retry time. This helps with the case when the temporary error on the
6091 address was really message-specific rather than address specific, since
6092 it allows other messages through.
6094 We also wait for the next retry time if this is a message sent down an
6095 existing SMTP connection (even though that will be forced). Otherwise there
6096 will be far too many attempts for an address that gets a 4xx error. In
6097 fact, after such an error, we should not get here because, the host should
6098 not be remembered as one this message needs. However, there was a bug that
6099 used to cause this to happen, so it is best to be on the safe side.
6101 Even if we haven't reached the retry time in the hints, there is one more
6102 check to do, which is for the ultimate address timeout. We only do this
6103 check if there is an address retry record and there is not a domain retry
6104 record; this implies that previous attempts to handle the address had the
6105 retry_use_local_parts option turned on. We use this as an approximation
6106 for the destination being like a local delivery, for example delivery over
6107 LMTP to an IMAP message store. In this situation users are liable to bump
6108 into their quota and thereby have intermittently successful deliveries,
6109 which keep the retry record fresh, which can lead to us perpetually
6110 deferring messages. */
6112 else if (((queue_running && !deliver_force) || continue_hostname != NULL)
6114 ((domain_retry_record != NULL &&
6115 now < domain_retry_record->next_try &&
6116 !domain_retry_record->expired)
6118 (address_retry_record != NULL &&
6119 now < address_retry_record->next_try))
6121 (domain_retry_record != NULL ||
6122 address_retry_record == NULL ||
6123 !retry_ultimate_address_timeout(addr->address_retry_key,
6124 addr->domain, address_retry_record, now)))
6126 addr->message = US"retry time not reached";
6127 addr->basic_errno = ERRNO_RRETRY;
6128 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_ROUTER, 0);
6131 /* The domain is OK for routing. Remember if retry data exists so it
6132 can be cleaned up after a successful delivery. */
6136 if (domain_retry_record != NULL || address_retry_record != NULL)
6137 setflag(addr, af_dr_retry_exists);
6138 addr->next = addr_route;
6140 DEBUG(D_deliver|D_route)
6141 debug_printf("%s: queued for routing\n", addr->address);
6145 /* The database is closed while routing is actually happening. Requests to
6146 update it are put on a chain and all processed together at the end. */
6148 if (dbm_file != NULL) dbfn_close(dbm_file);
6150 /* If queue_domains is set, we don't even want to try routing addresses in
6151 those domains. During queue runs, queue_domains is forced to be unset.
6152 Optimize by skipping this pass through the addresses if nothing is set. */
6154 if (!deliver_force && queue_domains != NULL)
6156 address_item *okaddr = NULL;
6157 while (addr_route != NULL)
6159 address_item *addr = addr_route;
6160 addr_route = addr->next;
6162 deliver_domain = addr->domain; /* set $domain */
6163 if ((rc = match_isinlist(addr->domain, (const uschar **)&queue_domains, 0,
6164 &domainlist_anchor, addr->domain_cache, MCL_DOMAIN, TRUE, NULL))
6169 addr->basic_errno = ERRNO_LISTDEFER;
6170 addr->message = US"queue_domains lookup deferred";
6171 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_ROUTER, 0);
6175 addr->next = okaddr;
6181 addr->basic_errno = ERRNO_QUEUE_DOMAIN;
6182 addr->message = US"domain is in queue_domains";
6183 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_ROUTER, 0);
6187 addr_route = okaddr;
6190 /* Now route those addresses that are not deferred. */
6192 while (addr_route != NULL)
6195 address_item *addr = addr_route;
6196 const uschar *old_domain = addr->domain;
6197 uschar *old_unique = addr->unique;
6198 addr_route = addr->next;
6201 /* Just in case some router parameter refers to it. */
6203 return_path = (addr->prop.errors_address != NULL)?
6204 addr->prop.errors_address : sender_address;
6206 /* If a router defers an address, add a retry item. Whether or not to
6207 use the local part in the key is a property of the router. */
6209 if ((rc = route_address(addr, &addr_local, &addr_remote, &addr_new,
6210 &addr_succeed, v_none)) == DEFER)
6211 retry_add_item(addr, (addr->router->retry_use_local_part)?
6212 string_sprintf("R:%s@%s", addr->local_part, addr->domain) :
6213 string_sprintf("R:%s", addr->domain), 0);
6215 /* Otherwise, if there is an existing retry record in the database, add
6216 retry items to delete both forms. We must also allow for the possibility
6217 of a routing retry that includes the sender address. Since the domain might
6218 have been rewritten (expanded to fully qualified) as a result of routing,
6219 ensure that the rewritten form is also deleted. */
6221 else if (testflag(addr, af_dr_retry_exists))
6223 uschar *altkey = string_sprintf("%s:<%s>", addr->address_retry_key,
6225 retry_add_item(addr, altkey, rf_delete);
6226 retry_add_item(addr, addr->address_retry_key, rf_delete);
6227 retry_add_item(addr, addr->domain_retry_key, rf_delete);
6228 if (Ustrcmp(addr->domain, old_domain) != 0)
6229 retry_add_item(addr, string_sprintf("R:%s", old_domain), rf_delete);
6232 /* DISCARD is given for :blackhole: and "seen finish". The event has been
6233 logged, but we need to ensure the address (and maybe parents) is marked
6238 address_done(addr, tod_stamp(tod_log));
6239 continue; /* route next address */
6242 /* The address is finished with (failed or deferred). */
6246 (void)post_process_one(addr, rc, LOG_MAIN, DTYPE_ROUTER, 0);
6247 continue; /* route next address */
6250 /* The address has been routed. If the router changed the domain, it will
6251 also have changed the unique address. We have to test whether this address
6252 has already been delivered, because it's the unique address that finally
6255 if (addr->unique != old_unique &&
6256 tree_search(tree_nonrecipients, addr->unique) != 0)
6258 DEBUG(D_deliver|D_route) debug_printf("%s was previously delivered: "
6259 "discarded\n", addr->address);
6260 if (addr_remote == addr) addr_remote = addr->next;
6261 else if (addr_local == addr) addr_local = addr->next;
6264 /* If the router has same_domain_copy_routing set, we are permitted to copy
6265 the routing for any other addresses with the same domain. This is an
6266 optimisation to save repeated DNS lookups for "standard" remote domain
6267 routing. The option is settable only on routers that generate host lists.
6268 We play it very safe, and do the optimization only if the address is routed
6269 to a remote transport, there are no header changes, and the domain was not
6270 modified by the router. */
6272 if (addr_remote == addr &&
6273 addr->router->same_domain_copy_routing &&
6274 addr->prop.extra_headers == NULL &&
6275 addr->prop.remove_headers == NULL &&
6276 old_domain == addr->domain)
6278 address_item **chain = &addr_route;
6279 while (*chain != NULL)
6281 address_item *addr2 = *chain;
6282 if (Ustrcmp(addr2->domain, addr->domain) != 0)
6284 chain = &(addr2->next);
6288 /* Found a suitable address; take it off the routing list and add it to
6289 the remote delivery list. */
6291 *chain = addr2->next;
6292 addr2->next = addr_remote;
6293 addr_remote = addr2;
6295 /* Copy the routing data */
6297 addr2->domain = addr->domain;
6298 addr2->router = addr->router;
6299 addr2->transport = addr->transport;
6300 addr2->host_list = addr->host_list;
6301 addr2->fallback_hosts = addr->fallback_hosts;
6302 addr2->prop.errors_address = addr->prop.errors_address;
6303 copyflag(addr2, addr, af_hide_child | af_local_host_removed);
6305 DEBUG(D_deliver|D_route)
6307 debug_printf(">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>\n"
6309 "Routing for %s copied from %s\n",
6310 addr2->address, addr2->address, addr->address);
6314 } /* Continue with routing the next address. */
6315 } /* Loop to process any child addresses that the routers created, and
6316 any rerouted addresses that got put back on the new chain. */
6319 /* Debugging: show the results of the routing */
6321 DEBUG(D_deliver|D_retry|D_route)
6323 address_item *p = addr_local;
6324 debug_printf(">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>\n");
6325 debug_printf("After routing:\n Local deliveries:\n");
6328 debug_printf(" %s\n", p->address);
6333 debug_printf(" Remote deliveries:\n");
6336 debug_printf(" %s\n", p->address);
6341 debug_printf(" Failed addresses:\n");
6344 debug_printf(" %s\n", p->address);
6349 debug_printf(" Deferred addresses:\n");
6352 debug_printf(" %s\n", p->address);
6357 /* Free any resources that were cached during routing. */
6362 /* These two variables are set only during routing, after check_local_user.
6363 Ensure they are not set in transports. */
6365 local_user_gid = (gid_t)(-1);
6366 local_user_uid = (uid_t)(-1);
6368 /* Check for any duplicate addresses. This check is delayed until after
6369 routing, because the flexibility of the routing configuration means that
6370 identical addresses with different parentage may end up being redirected to
6371 different addresses. Checking for duplicates too early (as we previously used
6372 to) makes this kind of thing not work. */
6374 do_duplicate_check(&addr_local);
6375 do_duplicate_check(&addr_remote);
6377 /* When acting as an MUA wrapper, we proceed only if all addresses route to a
6378 remote transport. The check that they all end up in one transaction happens in
6379 the do_remote_deliveries() function. */
6381 if (mua_wrapper && (addr_local != NULL || addr_failed != NULL ||
6382 addr_defer != NULL))
6385 uschar *which, *colon, *msg;
6387 if (addr_local != NULL)
6392 else if (addr_defer != NULL)
6395 which = US"deferred";
6403 while (addr->parent != NULL) addr = addr->parent;
6405 if (addr->message != NULL)
6408 msg = addr->message;
6410 else colon = msg = US"";
6412 /* We don't need to log here for a forced failure as it will already
6413 have been logged. Defer will also have been logged, but as a defer, so we do
6414 need to do the failure logging. */
6416 if (addr != addr_failed)
6417 log_write(0, LOG_MAIN, "** %s routing yielded a %s delivery",
6418 addr->address, which);
6420 /* Always write an error to the caller */
6422 fprintf(stderr, "routing %s yielded a %s delivery%s%s\n", addr->address,
6425 final_yield = DELIVER_MUA_FAILED;
6426 addr_failed = addr_defer = NULL; /* So that we remove the message */
6427 goto DELIVERY_TIDYUP;
6431 /* If this is a run to continue deliveries to an external channel that is
6432 already set up, defer any local deliveries. */
6434 if (continue_transport != NULL)
6436 if (addr_defer == NULL) addr_defer = addr_local; else
6438 address_item *addr = addr_defer;
6439 while (addr->next != NULL) addr = addr->next;
6440 addr->next = addr_local;
6446 /* Because address rewriting can happen in the routers, we should not really do
6447 ANY deliveries until all addresses have been routed, so that all recipients of
6448 the message get the same headers. However, this is in practice not always
6449 possible, since sometimes remote addresses give DNS timeouts for days on end.
6450 The pragmatic approach is to deliver what we can now, saving any rewritten
6451 headers so that at least the next lot of recipients benefit from the rewriting
6452 that has already been done.
6454 If any headers have been rewritten during routing, update the spool file to
6455 remember them for all subsequent deliveries. This can be delayed till later if
6456 there is only address to be delivered - if it succeeds the spool write need not
6459 if (header_rewritten &&
6460 ((addr_local != NULL &&
6461 (addr_local->next != NULL || addr_remote != NULL)) ||
6462 (addr_remote != NULL && addr_remote->next != NULL)))
6464 /* Panic-dies on error */
6465 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
6466 header_rewritten = FALSE;
6470 /* If there are any deliveries to be done, open the journal file. This is used
6471 to record successful deliveries as soon as possible after each delivery is
6472 known to be complete. A file opened with O_APPEND is used so that several
6473 processes can run simultaneously.
6475 The journal is just insurance against crashes. When the spool file is
6476 ultimately updated at the end of processing, the journal is deleted. If a
6477 journal is found to exist at the start of delivery, the addresses listed
6478 therein are added to the non-recipients. */
6480 if (addr_local != NULL || addr_remote != NULL)
6482 sprintf(CS spoolname, "%s/input/%s/%s-J", spool_directory, message_subdir, id);
6483 journal_fd = Uopen(spoolname, O_WRONLY|O_APPEND|O_CREAT, SPOOL_MODE);
6487 log_write(0, LOG_MAIN|LOG_PANIC, "Couldn't open journal file %s: %s",
6488 spoolname, strerror(errno));
6489 return DELIVER_NOT_ATTEMPTED;
6492 /* Set the close-on-exec flag, make the file owned by Exim, and ensure
6493 that the mode is correct - the group setting doesn't always seem to get
6494 set automatically. */
6496 if( fcntl(journal_fd, F_SETFD, fcntl(journal_fd, F_GETFD) | FD_CLOEXEC)
6497 || fchown(journal_fd, exim_uid, exim_gid)
6498 || fchmod(journal_fd, SPOOL_MODE)
6501 int ret = Uunlink(spoolname);
6502 log_write(0, LOG_MAIN|LOG_PANIC, "Couldn't set perms on journal file %s: %s",
6503 spoolname, strerror(errno));
6504 if(ret && errno != ENOENT)
6505 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s",
6506 spoolname, strerror(errno));
6507 return DELIVER_NOT_ATTEMPTED;
6513 /* Now we can get down to the business of actually doing deliveries. Local
6514 deliveries are done first, then remote ones. If ever the problems of how to
6515 handle fallback transports are figured out, this section can be put into a loop
6516 for handling fallbacks, though the uid switching will have to be revised. */
6518 /* Precompile a regex that is used to recognize a parameter in response
6519 to an LHLO command, if is isn't already compiled. This may be used on both
6520 local and remote LMTP deliveries. */
6522 if (regex_IGNOREQUOTA == NULL) regex_IGNOREQUOTA =
6523 regex_must_compile(US"\\n250[\\s\\-]IGNOREQUOTA(\\s|\\n|$)", FALSE, TRUE);
6525 /* Handle local deliveries */
6527 if (addr_local != NULL)
6529 DEBUG(D_deliver|D_transport)
6530 debug_printf(">>>>>>>>>>>>>>>> Local deliveries >>>>>>>>>>>>>>>>\n");
6531 do_local_deliveries();
6532 disable_logging = FALSE;
6535 /* If queue_run_local is set, we do not want to attempt any remote deliveries,
6536 so just queue them all. */
6538 if (queue_run_local)
6540 while (addr_remote != NULL)
6542 address_item *addr = addr_remote;
6543 addr_remote = addr->next;
6545 addr->basic_errno = ERRNO_LOCAL_ONLY;
6546 addr->message = US"remote deliveries suppressed";
6547 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_TRANSPORT, 0);
6551 /* Handle remote deliveries */
6553 if (addr_remote != NULL)
6555 DEBUG(D_deliver|D_transport)
6556 debug_printf(">>>>>>>>>>>>>>>> Remote deliveries >>>>>>>>>>>>>>>>\n");
6558 /* Precompile some regex that are used to recognize parameters in response
6559 to an EHLO command, if they aren't already compiled. */
6563 /* Now sort the addresses if required, and do the deliveries. The yield of
6564 do_remote_deliveries is FALSE when mua_wrapper is set and all addresses
6565 cannot be delivered in one transaction. */
6567 if (remote_sort_domains != NULL) sort_remote_deliveries();
6568 if (!do_remote_deliveries(FALSE))
6570 log_write(0, LOG_MAIN, "** mua_wrapper is set but recipients cannot all "
6571 "be delivered in one transaction");
6572 fprintf(stderr, "delivery to smarthost failed (configuration problem)\n");
6574 final_yield = DELIVER_MUA_FAILED;
6575 addr_failed = addr_defer = NULL; /* So that we remove the message */
6576 goto DELIVERY_TIDYUP;
6579 /* See if any of the addresses that failed got put on the queue for delivery
6580 to their fallback hosts. We do it this way because often the same fallback
6581 host is used for many domains, so all can be sent in a single transaction
6582 (if appropriately configured). */
6584 if (addr_fallback != NULL && !mua_wrapper)
6586 DEBUG(D_deliver) debug_printf("Delivering to fallback hosts\n");
6587 addr_remote = addr_fallback;
6588 addr_fallback = NULL;
6589 if (remote_sort_domains != NULL) sort_remote_deliveries();
6590 do_remote_deliveries(TRUE);
6592 disable_logging = FALSE;
6596 /* All deliveries are now complete. Ignore SIGTERM during this tidying up
6597 phase, to minimize cases of half-done things. */
6600 debug_printf(">>>>>>>>>>>>>>>> deliveries are done >>>>>>>>>>>>>>>>\n");
6602 /* Root privilege is no longer needed */
6604 exim_setugid(exim_uid, exim_gid, FALSE, US"post-delivery tidying");
6606 set_process_info("tidying up after delivering %s", message_id);
6607 signal(SIGTERM, SIG_IGN);
6609 /* When we are acting as an MUA wrapper, the smtp transport will either have
6610 succeeded for all addresses, or failed them all in normal cases. However, there
6611 are some setup situations (e.g. when a named port does not exist) that cause an
6612 immediate exit with deferral of all addresses. Convert those into failures. We
6613 do not ever want to retry, nor do we want to send a bounce message. */
6617 if (addr_defer != NULL)
6619 address_item *addr, *nextaddr;
6620 for (addr = addr_defer; addr != NULL; addr = nextaddr)
6622 log_write(0, LOG_MAIN, "** %s mua_wrapper forced failure for deferred "
6623 "delivery", addr->address);
6624 nextaddr = addr->next;
6625 addr->next = addr_failed;
6631 /* Now all should either have succeeded or failed. */
6633 if (addr_failed == NULL) final_yield = DELIVER_MUA_SUCCEEDED; else
6635 uschar *s = (addr_failed->user_message != NULL)?
6636 addr_failed->user_message : addr_failed->message;
6639 fprintf(stderr, "Delivery failed: ");
6640 if (addr_failed->basic_errno > 0)
6642 fprintf(stderr, "%s", strerror(addr_failed->basic_errno));
6643 if (s != NULL) fprintf(stderr, ": ");
6645 if ((host = addr_failed->host_used))
6646 fprintf(stderr, "H=%s [%s]: ", host->name, host->address);
6649 if (addr_failed->basic_errno <= 0) fprintf(stderr, "unknown error");
6651 else fprintf(stderr, "%s", CS s);
6652 fprintf(stderr, "\n");
6654 final_yield = DELIVER_MUA_FAILED;
6659 /* In a normal configuration, we now update the retry database. This is done in
6660 one fell swoop at the end in order not to keep opening and closing (and
6661 locking) the database. The code for handling retries is hived off into a
6662 separate module for convenience. We pass it the addresses of the various
6663 chains, because deferred addresses can get moved onto the failed chain if the
6664 retry cutoff time has expired for all alternative destinations. Bypass the
6665 updating of the database if the -N flag is set, which is a debugging thing that
6666 prevents actual delivery. */
6668 else if (!dont_deliver) retry_update(&addr_defer, &addr_failed, &addr_succeed);
6670 /* Send DSN for successful messages */
6671 addr_dsntmp = addr_succeed;
6672 addr_senddsn = NULL;
6676 /* af_ignore_error not honored here. it's not an error */
6679 debug_printf("DSN: processing router : %s\n"
6680 "DSN: processing successful delivery address: %s\n"
6681 "DSN: Sender_address: %s\n"
6682 "DSN: orcpt: %s flags: %d\n"
6683 "DSN: envid: %s ret: %d\n"
6684 "DSN: Final recipient: %s\n"
6685 "DSN: Remote SMTP server supports DSN: %d\n",
6686 addr_dsntmp->router->name,
6687 addr_dsntmp->address,
6689 addr_dsntmp->dsn_orcpt, addr_dsntmp->dsn_flags,
6691 addr_dsntmp->address,
6692 addr_dsntmp->dsn_aware
6696 /* send report if next hop not DSN aware or a router flagged "last DSN hop"
6697 and a report was requested */
6698 if ( ( addr_dsntmp->dsn_aware != dsn_support_yes
6699 || addr_dsntmp->dsn_flags & rf_dsnlasthop
6701 && addr_dsntmp->dsn_flags & rf_dsnflags
6702 && addr_dsntmp->dsn_flags & rf_notify_success
6705 /* copy and relink address_item and send report with all of them at once later */
6706 address_item *addr_next;
6707 addr_next = addr_senddsn;
6708 addr_senddsn = store_get(sizeof(address_item));
6709 memcpy(addr_senddsn, addr_dsntmp, sizeof(address_item));
6710 addr_senddsn->next = addr_next;
6713 DEBUG(D_deliver) debug_printf("DSN: not sending DSN success message\n");
6715 addr_dsntmp = addr_dsntmp->next;
6723 /* create exim process to send message */
6724 pid = child_open_exim(&fd);
6726 DEBUG(D_deliver) debug_printf("DSN: child_open_exim returns: %d\n", pid);
6728 if (pid < 0) /* Creation of child failed */
6730 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Process %d (parent %d) failed to "
6731 "create child process to send failure message: %s", getpid(),
6732 getppid(), strerror(errno));
6734 DEBUG(D_deliver) debug_printf("DSN: child_open_exim failed\n");
6736 else /* Creation of child succeeded */
6738 FILE *f = fdopen(fd, "wb");
6739 /* header only as required by RFC. only failure DSN needs to honor RET=FULL */
6740 int topt = topt_add_return_path | topt_no_body;
6744 debug_printf("sending error message to: %s\n", sender_address);
6746 /* build unique id for MIME boundary */
6747 bound = string_sprintf(TIME_T_FMT "-eximdsn-%d", time(NULL), rand());
6748 DEBUG(D_deliver) debug_printf("DSN: MIME boundary: %s\n", bound);
6750 if (errors_reply_to)
6751 fprintf(f, "Reply-To: %s\n", errors_reply_to);
6753 fprintf(f, "Auto-Submitted: auto-generated\n"
6754 "From: Mail Delivery System <Mailer-Daemon@%s>\n"
6756 "Subject: Delivery Status Notification\n"
6757 "Content-Type: multipart/report; report-type=delivery-status; boundary=%s\n"
6758 "MIME-Version: 1.0\n\n"
6761 "Content-type: text/plain; charset=us-ascii\n\n"
6763 "This message was created automatically by mail delivery software.\n"
6764 " ----- The following addresses had successful delivery notifications -----\n",
6765 qualify_domain_sender, sender_address, bound, bound);
6767 for (addr_dsntmp = addr_senddsn; addr_dsntmp;
6768 addr_dsntmp = addr_dsntmp->next)
6769 fprintf(f, "<%s> (relayed %s)\n\n",
6770 addr_dsntmp->address,
6771 (addr_dsntmp->dsn_flags & rf_dsnlasthop) == 1
6772 ? "via non DSN router"
6773 : addr_dsntmp->dsn_aware == dsn_support_no
6774 ? "to non-DSN-aware mailer"
6775 : "via non \"Remote SMTP\" router"
6779 "Content-type: message/delivery-status\n\n"
6780 "Reporting-MTA: dns; %s\n",
6781 bound, smtp_active_hostname);
6784 { /* must be decoded from xtext: see RFC 3461:6.3a */
6786 if (auth_xtextdecode(dsn_envid, &xdec_envid) > 0)
6787 fprintf(f, "Original-Envelope-ID: %s\n", dsn_envid);
6789 fprintf(f, "X-Original-Envelope-ID: error decoding xtext formated ENVID\n");
6793 for (addr_dsntmp = addr_senddsn;
6795 addr_dsntmp = addr_dsntmp->next)
6797 if (addr_dsntmp->dsn_orcpt)
6798 fprintf(f,"Original-Recipient: %s\n", addr_dsntmp->dsn_orcpt);
6800 fprintf(f, "Action: delivered\n"
6801 "Final-Recipient: rfc822;%s\n"
6803 addr_dsntmp->address);
6805 if (addr_dsntmp->host_used && addr_dsntmp->host_used->name)
6806 fprintf(f, "Remote-MTA: dns; %s\nDiagnostic-Code: smtp; 250 Ok\n\n",
6807 addr_dsntmp->host_used->name);
6809 fprintf(f, "Diagnostic-Code: X-Exim; relayed via non %s router\n\n",
6810 (addr_dsntmp->dsn_flags & rf_dsnlasthop) == 1 ? "DSN" : "SMTP");
6813 fprintf(f, "--%s\nContent-type: text/rfc822-headers\n\n", bound);
6816 transport_filter_argv = NULL; /* Just in case */
6817 return_path = sender_address; /* In case not previously set */
6819 /* Write the original email out */
6820 transport_write_message(NULL, fileno(f), topt, 0, NULL, NULL, NULL, NULL, NULL, 0);
6823 fprintf(f,"\n--%s--\n", bound);
6827 rc = child_close(pid, 0); /* Waits for child to close, no timeout */
6831 /* If any addresses failed, we must send a message to somebody, unless
6832 af_ignore_error is set, in which case no action is taken. It is possible for
6833 several messages to get sent if there are addresses with different
6836 while (addr_failed != NULL)
6840 uschar *logtod = tod_stamp(tod_log);
6842 address_item *handled_addr = NULL;
6843 address_item **paddr;
6844 address_item *msgchain = NULL;
6845 address_item **pmsgchain = &msgchain;
6847 /* There are weird cases when logging is disabled in the transport. However,
6848 there may not be a transport (address failed by a router). */
6850 disable_logging = FALSE;
6851 if (addr_failed->transport != NULL)
6852 disable_logging = addr_failed->transport->disable_logging;
6855 debug_printf("processing failed address %s\n", addr_failed->address);
6857 /* There are only two ways an address in a bounce message can get here:
6859 (1) When delivery was initially deferred, but has now timed out (in the call
6860 to retry_update() above). We can detect this by testing for
6861 af_retry_timedout. If the address does not have its own errors address,
6862 we arrange to ignore the error.
6864 (2) If delivery failures for bounce messages are being ignored. We can detect
6865 this by testing for af_ignore_error. This will also be set if a bounce
6866 message has been autothawed and the ignore_bounce_errors_after time has
6867 passed. It might also be set if a router was explicitly configured to
6868 ignore errors (errors_to = "").
6870 If neither of these cases obtains, something has gone wrong. Log the
6871 incident, but then ignore the error. */
6873 if (sender_address[0] == 0 && addr_failed->prop.errors_address == NULL)
6875 if ( !testflag(addr_failed, af_retry_timedout)
6876 && !testflag(addr_failed, af_ignore_error))
6878 log_write(0, LOG_MAIN|LOG_PANIC, "internal error: bounce message "
6879 "failure is neither frozen nor ignored (it's been ignored)");
6881 setflag(addr_failed, af_ignore_error);
6884 /* If the first address on the list has af_ignore_error set, just remove
6885 it from the list, throw away any saved message file, log it, and
6886 mark the recipient done. */
6888 if ( testflag(addr_failed, af_ignore_error)
6889 || ( addr_failed->dsn_flags & rf_dsnflags
6890 && (addr_failed->dsn_flags & rf_notify_failure) != rf_notify_failure)
6894 addr_failed = addr->next;
6895 if (addr->return_filename != NULL) Uunlink(addr->return_filename);
6897 log_write(0, LOG_MAIN, "%s%s%s%s: error ignored",
6899 !addr->parent ? US"" : US" <",
6900 !addr->parent ? US"" : addr->parent->address,
6901 !addr->parent ? US"" : US">");
6903 address_done(addr, logtod);
6904 child_done(addr, logtod);
6905 /* Panic-dies on error */
6906 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
6909 /* Otherwise, handle the sending of a message. Find the error address for
6910 the first address, then send a message that includes all failed addresses
6911 that have the same error address. Note the bounce_recipient is a global so
6912 that it can be accesssed by $bounce_recipient while creating a customized
6917 bounce_recipient = addr_failed->prop.errors_address
6918 ? addr_failed->prop.errors_address : sender_address;
6920 /* Make a subprocess to send a message */
6922 if ((pid = child_open_exim(&fd)) < 0)
6923 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Process %d (parent %d) failed to "
6924 "create child process to send failure message: %s", getpid(),
6925 getppid(), strerror(errno));
6927 /* Creation of child succeeded */
6934 uschar *bcc, *emf_text;
6935 FILE *f = fdopen(fd, "wb");
6937 BOOL to_sender = strcmpic(sender_address, bounce_recipient) == 0;
6938 int max = (bounce_return_size_limit/DELIVER_IN_BUFFER_SIZE + 1) *
6939 DELIVER_IN_BUFFER_SIZE;
6941 uschar *dsnlimitmsg;
6942 uschar *dsnnotifyhdr;
6946 debug_printf("sending error message to: %s\n", bounce_recipient);
6948 /* Scan the addresses for all that have the same errors address, removing
6949 them from the addr_failed chain, and putting them on msgchain. */
6951 paddr = &addr_failed;
6952 for (addr = addr_failed; addr != NULL; addr = *paddr)
6953 if (Ustrcmp(bounce_recipient, addr->prop.errors_address
6954 ? addr->prop.errors_address : sender_address) == 0)
6955 { /* The same - dechain */
6956 *paddr = addr->next;
6959 pmsgchain = &(addr->next);
6962 paddr = &addr->next; /* Not the same; skip */
6964 /* Include X-Failed-Recipients: for automatic interpretation, but do
6965 not let any one header line get too long. We do this by starting a
6966 new header every 50 recipients. Omit any addresses for which the
6967 "hide_child" flag is set. */
6969 for (addr = msgchain; addr != NULL; addr = addr->next)
6971 if (testflag(addr, af_hide_child)) continue;
6978 (rcount++ == 0)? "X-Failed-Recipients: " : ",\n ",
6979 (testflag(addr, af_pfr) && addr->parent != NULL)?
6980 string_printing(addr->parent->address) :
6981 string_printing(addr->address));
6983 if (rcount > 0) fprintf(f, "\n");
6985 /* Output the standard headers */
6987 if (errors_reply_to)
6988 fprintf(f, "Reply-To: %s\n", errors_reply_to);
6989 fprintf(f, "Auto-Submitted: auto-replied\n");
6991 fprintf(f, "To: %s\n", bounce_recipient);
6993 /* generate boundary string and output MIME-Headers */
6994 bound = string_sprintf(TIME_T_FMT "-eximdsn-%d", time(NULL), rand());
6996 fprintf(f, "Content-Type: multipart/report;"
6997 " report-type=delivery-status; boundary=%s\n"
6998 "MIME-Version: 1.0\n",
7001 /* Open a template file if one is provided. Log failure to open, but
7002 carry on - default texts will be used. */
7004 if (bounce_message_file)
7005 if (!(emf = Ufopen(bounce_message_file, "rb")))
7006 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to open %s for error "
7007 "message texts: %s", bounce_message_file, strerror(errno));
7009 /* Quietly copy to configured additional addresses if required. */
7011 if ((bcc = moan_check_errorcopy(bounce_recipient)))
7012 fprintf(f, "Bcc: %s\n", bcc);
7014 /* The texts for the message can be read from a template file; if there
7015 isn't one, or if it is too short, built-in texts are used. The first
7016 emf text is a Subject: and any other headers. */
7018 if ((emf_text = next_emf(emf, US"header")))
7019 fprintf(f, "%s\n", emf_text);
7021 fprintf(f, "Subject: Mail delivery failed%s\n\n",
7022 to_sender? ": returning message to sender" : "");
7024 /* output human readable part as text/plain section */
7026 "Content-type: text/plain; charset=us-ascii\n\n",
7029 if ((emf_text = next_emf(emf, US"intro")))
7030 fprintf(f, "%s", CS emf_text);
7034 /* This message has been reworded several times. It seems to be confusing to
7035 somebody, however it is worded. I have retreated to the original, simple
7037 "This message was created automatically by mail delivery software.\n");
7039 if (bounce_message_text)
7040 fprintf(f, "%s", CS bounce_message_text);
7043 "\nA message that you sent could not be delivered to one or more of its\n"
7044 "recipients. This is a permanent error. The following address(es) failed:\n");
7047 "\nA message sent by\n\n <%s>\n\n"
7048 "could not be delivered to one or more of its recipients. The following\n"
7049 "address(es) failed:\n", sender_address);
7053 /* Process the addresses, leaving them on the msgchain if they have a
7054 file name for a return message. (There has already been a check in
7055 post_process_one() for the existence of data in the message file.) A TRUE
7056 return from print_address_information() means that the address is not
7060 for (addr = msgchain; addr != NULL; addr = *paddr)
7062 if (print_address_information(addr, f, US" ", US"\n ", US""))
7063 print_address_error(addr, f, US"");
7065 /* End the final line for the address */
7069 /* Leave on msgchain if there's a return file. */
7071 if (addr->return_file >= 0)
7073 paddr = &(addr->next);
7077 /* Else save so that we can tick off the recipient when the
7082 *paddr = addr->next;
7083 addr->next = handled_addr;
7084 handled_addr = addr;
7090 /* Get the next text, whether we need it or not, so as to be
7091 positioned for the one after. */
7093 emf_text = next_emf(emf, US"generated text");
7095 /* If there were any file messages passed by the local transports,
7096 include them in the message. Then put the address on the handled chain.
7097 In the case of a batch of addresses that were all sent to the same
7098 transport, the return_file field in all of them will contain the same
7099 fd, and the return_filename field in the *last* one will be set (to the
7100 name of the file). */
7104 address_item *nextaddr;
7107 fprintf(f, "%s", CS emf_text);
7110 "The following text was generated during the delivery "
7111 "attempt%s:\n", (filecount > 1)? "s" : "");
7113 for (addr = msgchain; addr != NULL; addr = nextaddr)
7116 address_item *topaddr = addr;
7118 /* List all the addresses that relate to this file */
7121 while(addr) /* Insurance */
7123 print_address_information(addr, f, US"------ ", US"\n ",
7125 if (addr->return_filename) break;
7130 /* Now copy the file */
7132 fm = Ufopen(addr->return_filename, "rb");
7135 fprintf(f, " +++ Exim error... failed to open text file: %s\n",
7139 while ((ch = fgetc(fm)) != EOF) fputc(ch, f);
7142 Uunlink(addr->return_filename);
7144 /* Can now add to handled chain, first fishing off the next
7145 address on the msgchain. */
7147 nextaddr = addr->next;
7148 addr->next = handled_addr;
7149 handled_addr = topaddr;
7154 /* output machine readable part */
7155 #ifdef EXPERIMENTAL_INTERNATIONAL
7156 if (message_smtputf8)
7158 "Content-type: message/global-delivery-status\n\n"
7159 "Reporting-MTA: dns; %s\n",
7160 bound, smtp_active_hostname);
7164 "Content-type: message/delivery-status\n\n"
7165 "Reporting-MTA: dns; %s\n",
7166 bound, smtp_active_hostname);
7170 /* must be decoded from xtext: see RFC 3461:6.3a */
7172 if (auth_xtextdecode(dsn_envid, &xdec_envid) > 0)
7173 fprintf(f, "Original-Envelope-ID: %s\n", dsn_envid);
7175 fprintf(f, "X-Original-Envelope-ID: error decoding xtext formated ENVID\n");
7179 for (addr = handled_addr; addr; addr = addr->next)
7181 fprintf(f, "Action: failed\n"
7182 "Final-Recipient: rfc822;%s\n"
7185 if (addr->host_used && addr->host_used->name)
7187 fprintf(f, "Remote-MTA: dns; %s\n",
7188 addr->host_used->name);
7189 print_dsn_diagnostic_code(addr, f);
7194 /* Now copy the message, trying to give an intelligible comment if
7195 it is too long for it all to be copied. The limit isn't strictly
7196 applied because of the buffering. There is, however, an option
7197 to suppress copying altogether. */
7199 emf_text = next_emf(emf, US"copy");
7202 we ignore the intro text from template and add
7203 the text for bounce_return_size_limit at the end.
7205 bounce_return_message is ignored
7206 in case RET= is defined we honor these values
7207 otherwise bounce_return_body is honored.
7209 bounce_return_size_limit is always honored.
7212 fprintf(f, "--%s\n", bound);
7214 dsnlimitmsg = US"X-Exim-DSN-Information: Due to administrative limits only headers are returned";
7215 dsnnotifyhdr = NULL;
7216 topt = topt_add_return_path;
7218 /* RET=HDRS? top priority */
7219 if (dsn_ret == dsn_ret_hdrs)
7220 topt |= topt_no_body;
7222 /* no full body return at all? */
7223 if (!bounce_return_body)
7225 topt |= topt_no_body;
7226 /* add header if we overrule RET=FULL */
7227 if (dsn_ret == dsn_ret_full)
7228 dsnnotifyhdr = dsnlimitmsg;
7230 /* size limited ... return headers only if limit reached */
7231 else if (bounce_return_size_limit > 0)
7233 struct stat statbuf;
7234 if (fstat(deliver_datafile, &statbuf) == 0 && statbuf.st_size > max)
7236 topt |= topt_no_body;
7237 dsnnotifyhdr = dsnlimitmsg;
7241 #ifdef EXPERIMENTAL_INTERNATIONAL
7242 if (message_smtputf8)
7243 fputs(topt & topt_no_body ? "Content-type: message/global-headers\n\n"
7244 : "Content-type: message/global\n\n",
7248 fputs(topt & topt_no_body ? "Content-type: text/rfc822-headers\n\n"
7249 : "Content-type: message/rfc822\n\n",
7253 transport_filter_argv = NULL; /* Just in case */
7254 return_path = sender_address; /* In case not previously set */
7255 transport_write_message(NULL, fileno(f), topt,
7256 0, dsnnotifyhdr, NULL, NULL, NULL, NULL, 0);
7259 /* we never add the final text. close the file */
7263 fprintf(f, "\n--%s--\n", bound);
7265 /* Close the file, which should send an EOF to the child process
7266 that is receiving the message. Wait for it to finish. */
7269 rc = child_close(pid, 0); /* Waits for child to close, no timeout */
7271 /* In the test harness, let the child do it's thing first. */
7273 if (running_in_test_harness) millisleep(500);
7275 /* If the process failed, there was some disaster in setting up the
7276 error message. Unless the message is very old, ensure that addr_defer
7277 is non-null, which will have the effect of leaving the message on the
7278 spool. The failed addresses will get tried again next time. However, we
7279 don't really want this to happen too often, so freeze the message unless
7280 there are some genuine deferred addresses to try. To do this we have
7281 to call spool_write_header() here, because with no genuine deferred
7282 addresses the normal code below doesn't get run. */
7287 if (now - received_time < retry_maximum_timeout && addr_defer == NULL)
7289 addr_defer = (address_item *)(+1);
7290 deliver_freeze = TRUE;
7291 deliver_frozen_at = time(NULL);
7292 /* Panic-dies on error */
7293 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
7296 deliver_msglog("Process failed (%d) when writing error message "
7297 "to %s%s", rc, bounce_recipient, s);
7298 log_write(0, LOG_MAIN, "Process failed (%d) when writing error message "
7299 "to %s%s", rc, bounce_recipient, s);
7302 /* The message succeeded. Ensure that the recipients that failed are
7303 now marked finished with on the spool and their parents updated. */
7307 for (addr = handled_addr; addr != NULL; addr = addr->next)
7309 address_done(addr, logtod);
7310 child_done(addr, logtod);
7312 /* Panic-dies on error */
7313 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
7319 disable_logging = FALSE; /* In case left set */
7321 /* Come here from the mua_wrapper case if routing goes wrong */
7325 /* If there are now no deferred addresses, we are done. Preserve the
7326 message log if so configured, and we are using them. Otherwise, sling it.
7327 Then delete the message itself. */
7329 if (addr_defer == NULL)
7333 sprintf(CS spoolname, "%s/msglog/%s/%s", spool_directory, message_subdir,
7335 if (preserve_message_logs)
7338 sprintf(CS big_buffer, "%s/msglog.OLD/%s", spool_directory, id);
7339 if ((rc = Urename(spoolname, big_buffer)) < 0)
7341 (void)directory_make(spool_directory, US"msglog.OLD",
7342 MSGLOG_DIRECTORY_MODE, TRUE);
7343 rc = Urename(spoolname, big_buffer);
7346 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to move %s to the "
7347 "msglog.OLD directory", spoolname);
7350 if (Uunlink(spoolname) < 0)
7351 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s",
7352 spoolname, strerror(errno));
7355 /* Remove the two message files. */
7357 sprintf(CS spoolname, "%s/input/%s/%s-D", spool_directory, message_subdir, id);
7358 if (Uunlink(spoolname) < 0)
7359 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s",
7360 spoolname, strerror(errno));
7361 sprintf(CS spoolname, "%s/input/%s/%s-H", spool_directory, message_subdir, id);
7362 if (Uunlink(spoolname) < 0)
7363 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s",
7364 spoolname, strerror(errno));
7366 /* Log the end of this message, with queue time if requested. */
7368 if ((log_extra_selector & LX_queue_time_overall) != 0)
7369 log_write(0, LOG_MAIN, "Completed QT=%s",
7370 readconf_printtime( (int) ((long)time(NULL) - (long)received_time)) );
7372 log_write(0, LOG_MAIN, "Completed");
7374 /* Unset deliver_freeze so that we won't try to move the spool files further down */
7375 deliver_freeze = FALSE;
7377 #ifdef EXPERIMENTAL_EVENT
7378 (void) event_raise(event_action, US"msg:complete", NULL);
7382 /* If there are deferred addresses, we are keeping this message because it is
7383 not yet completed. Lose any temporary files that were catching output from
7384 pipes for any of the deferred addresses, handle one-time aliases, and see if
7385 the message has been on the queue for so long that it is time to send a warning
7386 message to the sender, unless it is a mailer-daemon. If all deferred addresses
7387 have the same domain, we can set deliver_domain for the expansion of
7388 delay_warning_ condition - if any of them are pipes, files, or autoreplies, use
7389 the parent's domain.
7391 If all the deferred addresses have an error number that indicates "retry time
7392 not reached", skip sending the warning message, because it won't contain the
7393 reason for the delay. It will get sent at the next real delivery attempt.
7394 However, if at least one address has tried, we'd better include all of them in
7397 If we can't make a process to send the message, don't worry.
7399 For mailing list expansions we want to send the warning message to the
7400 mailing list manager. We can't do a perfect job here, as some addresses may
7401 have different errors addresses, but if we take the errors address from
7402 each deferred address it will probably be right in most cases.
7404 If addr_defer == +1, it means there was a problem sending an error message
7405 for failed addresses, and there were no "real" deferred addresses. The value
7406 was set just to keep the message on the spool, so there is nothing to do here.
7409 else if (addr_defer != (address_item *)(+1))
7412 uschar *recipients = US"";
7413 BOOL delivery_attempted = FALSE;
7415 deliver_domain = testflag(addr_defer, af_pfr)?
7416 addr_defer->parent->domain : addr_defer->domain;
7418 for (addr = addr_defer; addr != NULL; addr = addr->next)
7420 address_item *otaddr;
7422 if (addr->basic_errno > ERRNO_RETRY_BASE) delivery_attempted = TRUE;
7424 if (deliver_domain != NULL)
7426 const uschar *d = testflag(addr, af_pfr)
7427 ? addr->parent->domain : addr->domain;
7429 /* The domain may be unset for an address that has never been routed
7430 because the system filter froze the message. */
7432 if (d == NULL || Ustrcmp(d, deliver_domain) != 0) deliver_domain = NULL;
7435 if (addr->return_filename != NULL) Uunlink(addr->return_filename);
7437 /* Handle the case of one-time aliases. If any address in the ancestry
7438 of this one is flagged, ensure it is in the recipients list, suitably
7439 flagged, and that its parent is marked delivered. */
7441 for (otaddr = addr; otaddr != NULL; otaddr = otaddr->parent)
7442 if (otaddr->onetime_parent != NULL) break;
7447 int t = recipients_count;
7449 for (i = 0; i < recipients_count; i++)
7451 uschar *r = recipients_list[i].address;
7452 if (Ustrcmp(otaddr->onetime_parent, r) == 0) t = i;
7453 if (Ustrcmp(otaddr->address, r) == 0) break;
7456 /* Didn't find the address already in the list, and did find the
7457 ultimate parent's address in the list. After adding the recipient,
7458 update the errors address in the recipients list. */
7460 if (i >= recipients_count && t < recipients_count)
7462 DEBUG(D_deliver) debug_printf("one_time: adding %s in place of %s\n",
7463 otaddr->address, otaddr->parent->address);
7464 receive_add_recipient(otaddr->address, t);
7465 recipients_list[recipients_count-1].errors_to = otaddr->prop.errors_address;
7466 tree_add_nonrecipient(otaddr->parent->address);
7467 update_spool = TRUE;
7471 /* Except for error messages, ensure that either the errors address for
7472 this deferred address or, if there is none, the sender address, is on the
7473 list of recipients for a warning message. */
7475 if (sender_address[0] != 0)
7477 if (addr->prop.errors_address == NULL)
7479 if (Ustrstr(recipients, sender_address) == NULL)
7480 recipients = string_sprintf("%s%s%s", recipients,
7481 (recipients[0] == 0)? "" : ",", sender_address);
7485 if (Ustrstr(recipients, addr->prop.errors_address) == NULL)
7486 recipients = string_sprintf("%s%s%s", recipients,
7487 (recipients[0] == 0)? "" : ",", addr->prop.errors_address);
7492 /* Send a warning message if the conditions are right. If the condition check
7493 fails because of a lookup defer, there is nothing we can do. The warning
7494 is not sent. Another attempt will be made at the next delivery attempt (if
7498 && delivery_attempted
7499 && ( ((addr_defer->dsn_flags & rf_dsnflags) == 0)
7500 || (addr_defer->dsn_flags & rf_notify_delay) == rf_notify_delay
7502 && delay_warning[1] > 0
7503 && sender_address[0] != 0
7504 && ( delay_warning_condition == NULL
7505 || expand_check_condition(delay_warning_condition,
7506 US"delay_warning", US"option")
7512 int queue_time = time(NULL) - received_time;
7514 /* When running in the test harness, there's an option that allows us to
7515 fudge this time so as to get repeatability of the tests. Take the first
7516 time off the list. In queue runs, the list pointer gets updated in the
7519 if (running_in_test_harness && fudged_queue_times[0] != 0)
7521 int qt = readconf_readtime(fudged_queue_times, '/', FALSE);
7524 DEBUG(D_deliver) debug_printf("fudged queue_times = %s\n",
7525 fudged_queue_times);
7530 /* See how many warnings we should have sent by now */
7532 for (count = 0; count < delay_warning[1]; count++)
7533 if (queue_time < delay_warning[count+2]) break;
7535 show_time = delay_warning[count+1];
7537 if (count >= delay_warning[1])
7540 int last_gap = show_time;
7541 if (count > 1) last_gap -= delay_warning[count];
7542 extra = (queue_time - delay_warning[count+1])/last_gap;
7543 show_time += last_gap * extra;
7549 debug_printf("time on queue = %s\n", readconf_printtime(queue_time));
7550 debug_printf("warning counts: required %d done %d\n", count,
7554 /* We have computed the number of warnings there should have been by now.
7555 If there haven't been enough, send one, and up the count to what it should
7558 if (warning_count < count)
7562 pid_t pid = child_open_exim(&fd);
7568 FILE *f = fdopen(fd, "wb");
7571 if (warn_message_file)
7573 wmf = Ufopen(warn_message_file, "rb");
7575 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to open %s for warning "
7576 "message texts: %s", warn_message_file, strerror(errno));
7579 warnmsg_recipients = recipients;
7580 warnmsg_delay = (queue_time < 120*60)?
7581 string_sprintf("%d minutes", show_time/60):
7582 string_sprintf("%d hours", show_time/3600);
7584 if (errors_reply_to)
7585 fprintf(f, "Reply-To: %s\n", errors_reply_to);
7586 fprintf(f, "Auto-Submitted: auto-replied\n");
7588 fprintf(f, "To: %s\n", recipients);
7590 /* generated boundary string and output MIME-Headers */
7591 bound = string_sprintf(TIME_T_FMT "-eximdsn-%d", time(NULL), rand());
7593 fprintf(f, "Content-Type: multipart/report;"
7594 " report-type=delivery-status; boundary=%s\n"
7595 "MIME-Version: 1.0\n",
7598 if ((wmf_text = next_emf(wmf, US"header")))
7599 fprintf(f, "%s\n", wmf_text);
7601 fprintf(f, "Subject: Warning: message %s delayed %s\n\n",
7602 message_id, warnmsg_delay);
7604 /* output human readable part as text/plain section */
7606 "Content-type: text/plain; charset=us-ascii\n\n",
7609 if ((wmf_text = next_emf(wmf, US"intro")))
7610 fprintf(f, "%s", CS wmf_text);
7614 "This message was created automatically by mail delivery software.\n");
7616 if (Ustrcmp(recipients, sender_address) == 0)
7618 "A message that you sent has not yet been delivered to one or more of its\n"
7619 "recipients after more than ");
7623 "A message sent by\n\n <%s>\n\n"
7624 "has not yet been delivered to one or more of its recipients after more than \n",
7627 fprintf(f, "%s on the queue on %s.\n\n"
7628 "The message identifier is: %s\n",
7629 warnmsg_delay, primary_hostname, message_id);
7631 for (h = header_list; h != NULL; h = h->next)
7632 if (strncmpic(h->text, US"Subject:", 8) == 0)
7633 fprintf(f, "The subject of the message is: %s", h->text + 9);
7634 else if (strncmpic(h->text, US"Date:", 5) == 0)
7635 fprintf(f, "The date of the message is: %s", h->text + 6);
7638 fprintf(f, "The address%s to which the message has not yet been "
7640 !addr_defer->next ? "" : "es",
7641 !addr_defer->next ? "is": "are");
7644 /* List the addresses, with error information if allowed */
7646 /* store addr_defer for machine readable part */
7647 address_item *addr_dsndefer = addr_defer;
7651 address_item *addr = addr_defer;
7652 addr_defer = addr->next;
7653 if (print_address_information(addr, f, US" ", US"\n ", US""))
7654 print_address_error(addr, f, US"Delay reason: ");
7663 if ((wmf_text = next_emf(wmf, US"final")))
7664 fprintf(f, "%s", CS wmf_text);
7670 "No action is required on your part. Delivery attempts will continue for\n"
7671 "some time, and this warning may be repeated at intervals if the message\n"
7672 "remains undelivered. Eventually the mail delivery software will give up,\n"
7673 "and when that happens, the message will be returned to you.\n");
7676 /* output machine readable part */
7677 fprintf(f, "\n--%s\n"
7678 "Content-type: message/delivery-status\n\n"
7679 "Reporting-MTA: dns; %s\n",
7681 smtp_active_hostname);
7686 /* must be decoded from xtext: see RFC 3461:6.3a */
7688 if (auth_xtextdecode(dsn_envid, &xdec_envid) > 0)
7689 fprintf(f,"Original-Envelope-ID: %s\n", dsn_envid);
7691 fprintf(f,"X-Original-Envelope-ID: error decoding xtext formated ENVID\n");
7695 for ( ; addr_dsndefer; addr_dsndefer = addr_dsndefer->next)
7697 if (addr_dsndefer->dsn_orcpt)
7698 fprintf(f, "Original-Recipient: %s\n", addr_dsndefer->dsn_orcpt);
7700 fprintf(f, "Action: delayed\n"
7701 "Final-Recipient: rfc822;%s\n"
7703 addr_dsndefer->address);
7704 if (addr_dsndefer->host_used && addr_dsndefer->host_used->name)
7706 fprintf(f, "Remote-MTA: dns; %s\n",
7707 addr_dsndefer->host_used->name);
7708 print_dsn_diagnostic_code(addr_dsndefer, f);
7714 "Content-type: text/rfc822-headers\n\n",
7718 /* header only as required by RFC. only failure DSN needs to honor RET=FULL */
7719 int topt = topt_add_return_path | topt_no_body;
7720 transport_filter_argv = NULL; /* Just in case */
7721 return_path = sender_address; /* In case not previously set */
7722 /* Write the original email out */
7723 transport_write_message(NULL, fileno(f), topt, 0, NULL, NULL, NULL, NULL, NULL, 0);
7726 fprintf(f,"\n--%s--\n", bound);
7730 /* Close and wait for child process to complete, without a timeout.
7731 If there's an error, don't update the count. */
7734 if (child_close(pid, 0) == 0)
7736 warning_count = count;
7737 update_spool = TRUE; /* Ensure spool rewritten */
7743 /* Clear deliver_domain */
7745 deliver_domain = NULL;
7747 /* If this was a first delivery attempt, unset the first time flag, and
7748 ensure that the spool gets updated. */
7750 if (deliver_firsttime)
7752 deliver_firsttime = FALSE;
7753 update_spool = TRUE;
7756 /* If delivery was frozen and freeze_tell is set, generate an appropriate
7757 message, unless the message is a local error message (to avoid loops). Then
7758 log the freezing. If the text in "frozen_info" came from a system filter,
7759 it has been escaped into printing characters so as not to mess up log lines.
7760 For the "tell" message, we turn \n back into newline. Also, insert a newline
7761 near the start instead of the ": " string. */
7765 if (freeze_tell != NULL && freeze_tell[0] != 0 && !local_error_message)
7767 uschar *s = string_copy(frozen_info);
7768 uschar *ss = Ustrstr(s, " by the system filter: ");
7779 if (*ss == '\\' && ss[1] == 'n')
7786 moan_tell_someone(freeze_tell, addr_defer, US"Message frozen",
7787 "Message %s has been frozen%s.\nThe sender is <%s>.\n", message_id,
7791 /* Log freezing just before we update the -H file, to minimize the chance
7792 of a race problem. */
7794 deliver_msglog("*** Frozen%s\n", frozen_info);
7795 log_write(0, LOG_MAIN, "Frozen%s", frozen_info);
7798 /* If there have been any updates to the non-recipients list, or other things
7799 that get written to the spool, we must now update the spool header file so
7800 that it has the right information for the next delivery attempt. If there
7801 was more than one address being delivered, the header_change update is done
7802 earlier, in case one succeeds and then something crashes. */
7805 debug_printf("delivery deferred: update_spool=%d header_rewritten=%d\n",
7806 update_spool, header_rewritten);
7808 if (update_spool || header_rewritten)
7809 /* Panic-dies on error */
7810 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
7813 /* Finished with the message log. If the message is complete, it will have
7814 been unlinked or renamed above. */
7816 if (message_logs) (void)fclose(message_log);
7818 /* Now we can close and remove the journal file. Its only purpose is to record
7819 successfully completed deliveries asap so that this information doesn't get
7820 lost if Exim (or the machine) crashes. Forgetting about a failed delivery is
7821 not serious, as trying it again is not harmful. The journal might not be open
7822 if all addresses were deferred at routing or directing. Nevertheless, we must
7823 remove it if it exists (may have been lying around from a crash during the
7824 previous delivery attempt). We don't remove the journal if a delivery
7825 subprocess failed to pass back delivery information; this is controlled by
7826 the remove_journal flag. When the journal is left, we also don't move the
7827 message off the main spool if frozen and the option is set. It should get moved
7828 at the next attempt, after the journal has been inspected. */
7830 if (journal_fd >= 0) (void)close(journal_fd);
7834 sprintf(CS spoolname, "%s/input/%s/%s-J", spool_directory, message_subdir, id);
7835 if (Uunlink(spoolname) < 0 && errno != ENOENT)
7836 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s", spoolname,
7839 /* Move the message off the spool if reqested */
7841 #ifdef SUPPORT_MOVE_FROZEN_MESSAGES
7842 if (deliver_freeze && move_frozen_messages)
7843 (void)spool_move_message(id, message_subdir, US"", US"F");
7847 /* Closing the data file frees the lock; if the file has been unlinked it
7848 will go away. Otherwise the message becomes available for another process
7851 (void)close(deliver_datafile);
7852 deliver_datafile = -1;
7853 DEBUG(D_deliver) debug_printf("end delivery of %s\n", id);
7855 /* It is unlikely that there will be any cached resources, since they are
7856 released after routing, and in the delivery subprocesses. However, it's
7857 possible for an expansion for something afterwards (for example,
7858 expand_check_condition) to do a lookup. We must therefore be sure everything is
7862 acl_where = ACL_WHERE_UNKNOWN;
7871 if (!regex_PIPELINING) regex_PIPELINING =
7872 regex_must_compile(US"\\n250[\\s\\-]PIPELINING(\\s|\\n|$)", FALSE, TRUE);
7874 if (!regex_SIZE) regex_SIZE =
7875 regex_must_compile(US"\\n250[\\s\\-]SIZE(\\s|\\n|$)", FALSE, TRUE);
7877 if (!regex_AUTH) regex_AUTH =
7878 regex_must_compile(US"\\n250[\\s\\-]AUTH\\s+([\\-\\w\\s]+)(?:\\n|$)",
7882 if (!regex_STARTTLS) regex_STARTTLS =
7883 regex_must_compile(US"\\n250[\\s\\-]STARTTLS(\\s|\\n|$)", FALSE, TRUE);
7886 #ifndef DISABLE_PRDR
7887 if (!regex_PRDR) regex_PRDR =
7888 regex_must_compile(US"\\n250[\\s\\-]PRDR(\\s|\\n|$)", FALSE, TRUE);
7891 #ifdef EXPERIMENTAL_INTERNATIONAL
7892 if (!regex_UTF8) regex_UTF8 =
7893 regex_must_compile(US"\\n250[\\s\\-]SMTPUTF8(\\s|\\n|$)", FALSE, TRUE);
7896 if (!regex_DSN) regex_DSN =
7897 regex_must_compile(US"\\n250[\\s\\-]DSN(\\s|\\n|$)", FALSE, TRUE);
7899 if (!regex_IGNOREQUOTA) regex_IGNOREQUOTA =
7900 regex_must_compile(US"\\n250[\\s\\-]IGNOREQUOTA(\\s|\\n|$)", FALSE, TRUE);
7905 deliver_get_sender_address (uschar * id)
7907 if (!spool_open_datafile(id))
7910 sprintf(CS spoolname, "%s-H", id);
7911 if (spool_read_header(spoolname, TRUE, TRUE) != spool_read_OK)
7914 (void)close(deliver_datafile);
7915 deliver_datafile = -1;
7917 return sender_address;
7922 /* End of deliver.c */