1 /*************************************************
2 * Exim - an Internet mail transport agent *
3 *************************************************/
5 /* Copyright (c) University of Cambridge 1995 - 2014 */
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 #ifdef EXPERIMENTAL_DSN
67 static address_item *addr_dsntmp = NULL;
68 static address_item *addr_senddsn = NULL;
71 static FILE *message_log = NULL;
72 static BOOL update_spool;
73 static BOOL remove_journal;
74 static int parcount = 0;
75 static pardata *parlist = NULL;
76 static int return_count;
77 static uschar *frozen_info = US"";
78 static uschar *used_return_path = NULL;
80 static uschar spoolname[PATH_MAX];
84 /*************************************************
85 * Make a new address item *
86 *************************************************/
88 /* This function gets the store and initializes with default values. The
89 transport_return value defaults to DEFER, so that any unexpected failure to
90 deliver does not wipe out the message. The default unique string is set to a
91 copy of the address, so that its domain can be lowercased.
94 address the RFC822 address string
95 copy force a copy of the address
97 Returns: a pointer to an initialized address_item
101 deliver_make_addr(uschar *address, BOOL copy)
103 address_item *addr = store_get(sizeof(address_item));
104 *addr = address_defaults;
105 if (copy) address = string_copy(address);
106 addr->address = address;
107 addr->unique = string_copy(address);
114 /*************************************************
115 * Set expansion values for an address *
116 *************************************************/
118 /* Certain expansion variables are valid only when handling an address or
119 address list. This function sets them up or clears the values, according to its
123 addr the address in question, or NULL to clear values
128 deliver_set_expansions(address_item *addr)
132 uschar ***p = address_expansions;
133 while (*p != NULL) **p++ = NULL;
137 /* Exactly what gets set depends on whether there is one or more addresses, and
138 what they contain. These first ones are always set, taking their values from
139 the first address. */
141 if (addr->host_list == NULL)
143 deliver_host = deliver_host_address = US"";
144 deliver_host_port = 0;
148 deliver_host = addr->host_list->name;
149 deliver_host_address = addr->host_list->address;
150 deliver_host_port = addr->host_list->port;
153 deliver_recipients = addr;
154 deliver_address_data = addr->p.address_data;
155 deliver_domain_data = addr->p.domain_data;
156 deliver_localpart_data = addr->p.localpart_data;
158 /* These may be unset for multiple addresses */
160 deliver_domain = addr->domain;
161 self_hostname = addr->self_hostname;
163 #ifdef EXPERIMENTAL_BRIGHTMAIL
164 bmi_deliver = 1; /* deliver by default */
165 bmi_alt_location = NULL;
166 bmi_base64_verdict = NULL;
167 bmi_base64_tracker_verdict = NULL;
170 /* If there's only one address we can set everything. */
172 if (addr->next == NULL)
174 address_item *addr_orig;
176 deliver_localpart = addr->local_part;
177 deliver_localpart_prefix = addr->prefix;
178 deliver_localpart_suffix = addr->suffix;
180 for (addr_orig = addr; addr_orig->parent != NULL;
181 addr_orig = addr_orig->parent);
182 deliver_domain_orig = addr_orig->domain;
184 /* Re-instate any prefix and suffix in the original local part. In all
185 normal cases, the address will have a router associated with it, and we can
186 choose the caseful or caseless version accordingly. However, when a system
187 filter sets up a pipe, file, or autoreply delivery, no router is involved.
188 In this case, though, there won't be any prefix or suffix to worry about. */
190 deliver_localpart_orig = (addr_orig->router == NULL)? addr_orig->local_part :
191 addr_orig->router->caseful_local_part?
192 addr_orig->cc_local_part : addr_orig->lc_local_part;
194 /* If there's a parent, make its domain and local part available, and if
195 delivering to a pipe or file, or sending an autoreply, get the local
196 part from the parent. For pipes and files, put the pipe or file string
197 into address_pipe and address_file. */
199 if (addr->parent != NULL)
201 deliver_domain_parent = addr->parent->domain;
202 deliver_localpart_parent = (addr->parent->router == NULL)?
203 addr->parent->local_part :
204 addr->parent->router->caseful_local_part?
205 addr->parent->cc_local_part : addr->parent->lc_local_part;
207 /* File deliveries have their own flag because they need to be picked out
208 as special more often. */
210 if (testflag(addr, af_pfr))
212 if (testflag(addr, af_file)) address_file = addr->local_part;
213 else if (deliver_localpart[0] == '|') address_pipe = addr->local_part;
214 deliver_localpart = addr->parent->local_part;
215 deliver_localpart_prefix = addr->parent->prefix;
216 deliver_localpart_suffix = addr->parent->suffix;
220 #ifdef EXPERIMENTAL_BRIGHTMAIL
221 /* Set expansion variables related to Brightmail AntiSpam */
222 bmi_base64_verdict = bmi_get_base64_verdict(deliver_localpart_orig, deliver_domain_orig);
223 bmi_base64_tracker_verdict = bmi_get_base64_tracker_verdict(bmi_base64_verdict);
224 /* get message delivery status (0 - don't deliver | 1 - deliver) */
225 bmi_deliver = bmi_get_delivery_status(bmi_base64_verdict);
226 /* if message is to be delivered, get eventual alternate location */
227 if (bmi_deliver == 1) {
228 bmi_alt_location = bmi_get_alt_location(bmi_base64_verdict);
234 /* For multiple addresses, don't set local part, and leave the domain and
235 self_hostname set only if it is the same for all of them. It is possible to
236 have multiple pipe and file addresses, but only when all addresses have routed
237 to the same pipe or file. */
242 if (testflag(addr, af_pfr))
244 if (testflag(addr, af_file)) address_file = addr->local_part;
245 else if (addr->local_part[0] == '|') address_pipe = addr->local_part;
247 for (addr2 = addr->next; addr2 != NULL; addr2 = addr2->next)
249 if (deliver_domain != NULL &&
250 Ustrcmp(deliver_domain, addr2->domain) != 0)
251 deliver_domain = NULL;
252 if (self_hostname != NULL && (addr2->self_hostname == NULL ||
253 Ustrcmp(self_hostname, addr2->self_hostname) != 0))
254 self_hostname = NULL;
255 if (deliver_domain == NULL && self_hostname == NULL) break;
263 /*************************************************
264 * Open a msglog file *
265 *************************************************/
267 /* This function is used both for normal message logs, and for files in the
268 msglog directory that are used to catch output from pipes. Try to create the
269 directory if it does not exist. From release 4.21, normal message logs should
270 be created when the message is received.
273 filename the file name
274 mode the mode required
275 error used for saying what failed
277 Returns: a file descriptor, or -1 (with errno set)
281 open_msglog_file(uschar *filename, int mode, uschar **error)
283 int fd = Uopen(filename, O_WRONLY|O_APPEND|O_CREAT, mode);
285 if (fd < 0 && errno == ENOENT)
288 sprintf(CS temp, "msglog/%s", message_subdir);
289 if (message_subdir[0] == 0) temp[6] = 0;
290 (void)directory_make(spool_directory, temp, MSGLOG_DIRECTORY_MODE, TRUE);
291 fd = Uopen(filename, O_WRONLY|O_APPEND|O_CREAT, mode);
294 /* Set the close-on-exec flag and change the owner to the exim uid/gid (this
295 function is called as root). Double check the mode, because the group setting
296 doesn't always get set automatically. */
300 (void)fcntl(fd, F_SETFD, fcntl(fd, F_GETFD) | FD_CLOEXEC);
301 if (fchown(fd, exim_uid, exim_gid) < 0)
306 if (fchmod(fd, mode) < 0)
312 else *error = US"create";
320 /*************************************************
321 * Write to msglog if required *
322 *************************************************/
324 /* Write to the message log, if configured. This function may also be called
328 format a string format
334 deliver_msglog(const char *format, ...)
337 if (!message_logs) return;
338 va_start(ap, format);
339 vfprintf(message_log, format, ap);
347 /*************************************************
348 * Replicate status for batch *
349 *************************************************/
351 /* When a transport handles a batch of addresses, it may treat them
352 individually, or it may just put the status in the first one, and return FALSE,
353 requesting that the status be copied to all the others externally. This is the
354 replication function. As well as the status, it copies the transport pointer,
355 which may have changed if appendfile passed the addresses on to a different
358 Argument: pointer to the first address in a chain
363 replicate_status(address_item *addr)
366 for (addr2 = addr->next; addr2 != NULL; addr2 = addr2->next)
368 addr2->transport = addr->transport;
369 addr2->transport_return = addr->transport_return;
370 addr2->basic_errno = addr->basic_errno;
371 addr2->more_errno = addr->more_errno;
372 addr2->special_action = addr->special_action;
373 addr2->message = addr->message;
374 addr2->user_message = addr->user_message;
380 /*************************************************
381 * Compare lists of hosts *
382 *************************************************/
384 /* This function is given two pointers to chains of host items, and it yields
385 TRUE if the lists refer to the same hosts in the same order, except that
387 (1) Multiple hosts with the same non-negative MX values are permitted to appear
388 in different orders. Round-robinning nameservers can cause this to happen.
390 (2) Multiple hosts with the same negative MX values less than MX_NONE are also
391 permitted to appear in different orders. This is caused by randomizing
394 This enables Exim to use a single SMTP transaction for sending to two entirely
395 different domains that happen to end up pointing at the same hosts.
398 one points to the first host list
399 two points to the second host list
401 Returns: TRUE if the lists refer to the same host set
405 same_hosts(host_item *one, host_item *two)
407 while (one != NULL && two != NULL)
409 if (Ustrcmp(one->name, two->name) != 0)
412 host_item *end_one = one;
413 host_item *end_two = two;
415 /* Batch up only if there was no MX and the list was not randomized */
417 if (mx == MX_NONE) return FALSE;
419 /* Find the ends of the shortest sequence of identical MX values */
421 while (end_one->next != NULL && end_one->next->mx == mx &&
422 end_two->next != NULL && end_two->next->mx == mx)
424 end_one = end_one->next;
425 end_two = end_two->next;
428 /* If there aren't any duplicates, there's no match. */
430 if (end_one == one) return FALSE;
432 /* For each host in the 'one' sequence, check that it appears in the 'two'
433 sequence, returning FALSE if not. */
438 for (hi = two; hi != end_two->next; hi = hi->next)
439 if (Ustrcmp(one->name, hi->name) == 0) break;
440 if (hi == end_two->next) return FALSE;
441 if (one == end_one) break;
445 /* All the hosts in the 'one' sequence were found in the 'two' sequence.
446 Ensure both are pointing at the last host, and carry on as for equality. */
457 /* True if both are NULL */
464 /*************************************************
465 * Compare header lines *
466 *************************************************/
468 /* This function is given two pointers to chains of header items, and it yields
469 TRUE if they are the same header texts in the same order.
472 one points to the first header list
473 two points to the second header list
475 Returns: TRUE if the lists refer to the same header set
479 same_headers(header_line *one, header_line *two)
483 if (one == two) return TRUE; /* Includes the case where both NULL */
484 if (one == NULL || two == NULL) return FALSE;
485 if (Ustrcmp(one->text, two->text) != 0) return FALSE;
493 /*************************************************
494 * Compare string settings *
495 *************************************************/
497 /* This function is given two pointers to strings, and it returns
498 TRUE if they are the same pointer, or if the two strings are the same.
501 one points to the first string
502 two points to the second string
504 Returns: TRUE or FALSE
508 same_strings(uschar *one, uschar *two)
510 if (one == two) return TRUE; /* Includes the case where both NULL */
511 if (one == NULL || two == NULL) return FALSE;
512 return (Ustrcmp(one, two) == 0);
517 /*************************************************
518 * Compare uid/gid for addresses *
519 *************************************************/
521 /* This function is given a transport and two addresses. It yields TRUE if the
522 uid/gid/initgroups settings for the two addresses are going to be the same when
527 addr1 the first address
528 addr2 the second address
530 Returns: TRUE or FALSE
534 same_ugid(transport_instance *tp, address_item *addr1, address_item *addr2)
536 if (!tp->uid_set && tp->expand_uid == NULL && !tp->deliver_as_creator)
538 if (testflag(addr1, af_uid_set) != testflag(addr2, af_gid_set) ||
539 (testflag(addr1, af_uid_set) &&
540 (addr1->uid != addr2->uid ||
541 testflag(addr1, af_initgroups) != testflag(addr2, af_initgroups))))
545 if (!tp->gid_set && tp->expand_gid == NULL)
547 if (testflag(addr1, af_gid_set) != testflag(addr2, af_gid_set) ||
548 (testflag(addr1, af_gid_set) && addr1->gid != addr2->gid))
558 /*************************************************
559 * Record that an address is complete *
560 *************************************************/
562 /* This function records that an address is complete. This is straightforward
563 for most addresses, where the unique address is just the full address with the
564 domain lower cased. For homonyms (addresses that are the same as one of their
565 ancestors) their are complications. Their unique addresses have \x\ prepended
566 (where x = 0, 1, 2...), so that de-duplication works correctly for siblings and
569 Exim used to record the unique addresses of homonyms as "complete". This,
570 however, fails when the pattern of redirection varies over time (e.g. if taking
571 unseen copies at only some times of day) because the prepended numbers may vary
572 from one delivery run to the next. This problem is solved by never recording
573 prepended unique addresses as complete. Instead, when a homonymic address has
574 actually been delivered via a transport, we record its basic unique address
575 followed by the name of the transport. This is checked in subsequent delivery
576 runs whenever an address is routed to a transport.
578 If the completed address is a top-level one (has no parent, which means it
579 cannot be homonymic) we also add the original address to the non-recipients
580 tree, so that it gets recorded in the spool file and therefore appears as
581 "done" in any spool listings. The original address may differ from the unique
582 address in the case of the domain.
584 Finally, this function scans the list of duplicates, marks as done any that
585 match this address, and calls child_done() for their ancestors.
588 addr address item that has been completed
589 now current time as a string
595 address_done(address_item *addr, uschar *now)
599 update_spool = TRUE; /* Ensure spool gets updated */
601 /* Top-level address */
603 if (addr->parent == NULL)
605 tree_add_nonrecipient(addr->unique);
606 tree_add_nonrecipient(addr->address);
609 /* Homonymous child address */
611 else if (testflag(addr, af_homonym))
613 if (addr->transport != NULL)
615 tree_add_nonrecipient(
616 string_sprintf("%s/%s", addr->unique + 3, addr->transport->name));
620 /* Non-homonymous child address */
622 else tree_add_nonrecipient(addr->unique);
624 /* Check the list of duplicate addresses and ensure they are now marked
627 for (dup = addr_duplicate; dup != NULL; dup = dup->next)
629 if (Ustrcmp(addr->unique, dup->unique) == 0)
631 tree_add_nonrecipient(dup->unique);
632 child_done(dup, now);
640 /*************************************************
641 * Decrease counts in parents and mark done *
642 *************************************************/
644 /* This function is called when an address is complete. If there is a parent
645 address, its count of children is decremented. If there are still other
646 children outstanding, the function exits. Otherwise, if the count has become
647 zero, address_done() is called to mark the parent and its duplicates complete.
648 Then loop for any earlier ancestors.
651 addr points to the completed address item
652 now the current time as a string, for writing to the message log
658 child_done(address_item *addr, uschar *now)
661 while (addr->parent != NULL)
664 if ((addr->child_count -= 1) > 0) return; /* Incomplete parent */
665 address_done(addr, now);
667 /* Log the completion of all descendents only when there is no ancestor with
668 the same original address. */
670 for (aa = addr->parent; aa != NULL; aa = aa->parent)
671 if (Ustrcmp(aa->address, addr->address) == 0) break;
672 if (aa != NULL) continue;
674 deliver_msglog("%s %s: children all complete\n", now, addr->address);
675 DEBUG(D_deliver) debug_printf("%s: children all complete\n", addr->address);
683 d_hostlog(uschar * s, int * sizep, int * ptrp, address_item * addr)
685 s = string_append(s, sizep, ptrp, 5, US" H=", addr->host_used->name,
686 US" [", addr->host_used->address, US"]");
687 if ((log_extra_selector & LX_outgoing_port) != 0)
688 s = string_append(s, sizep, ptrp, 2, US":", string_sprintf("%d",
689 addr->host_used->port));
695 d_tlslog(uschar * s, int * sizep, int * ptrp, address_item * addr)
697 if ((log_extra_selector & LX_tls_cipher) != 0 && addr->cipher != NULL)
698 s = string_append(s, sizep, ptrp, 2, US" X=", addr->cipher);
699 if ((log_extra_selector & LX_tls_certificate_verified) != 0 &&
700 addr->cipher != NULL)
701 s = string_append(s, sizep, ptrp, 2, US" CV=",
702 testflag(addr, af_cert_verified)
704 #ifdef EXPERIMENTAL_DANE
705 testflag(addr, af_dane_verified)
711 if ((log_extra_selector & LX_tls_peerdn) != 0 && addr->peerdn != NULL)
712 s = string_append(s, sizep, ptrp, 3, US" DN=\"",
713 string_printing(addr->peerdn), US"\"");
719 #ifdef EXPERIMENTAL_TPDA
721 tpda_raise_event(uschar * action, uschar * event, uschar * ev_data)
727 debug_printf("TPDA(%s): tpda_event_action=|%s| tpda_delivery_IP=%s\n",
729 action, deliver_host_address);
734 if (!(s = expand_string(action)) && *expand_string_message)
735 log_write(0, LOG_MAIN|LOG_PANIC,
736 "failed to expand tpda_event_action %s in %s: %s\n",
737 event, transport_name, expand_string_message);
739 tpda_event = tpda_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("TPDA(%s): event_action returned \"%s\"\n", s);
755 /* If msg is NULL this is a delivery log and logchar is used. Otherwise
756 this is a nonstandard call; no two-character delivery flag is written
757 but sender-host and sender are prefixed and "msg" is inserted in the log line.
760 flags passed to log_write()
763 delivery_log(int flags, address_item * addr, int logchar, uschar * msg)
766 int size = 256; /* Used for a temporary, */
767 int ptr = 0; /* expanding buffer, for */
768 uschar *s; /* building log lines; */
769 void *reset_point; /* released afterwards. */
772 /* Log the delivery on the main log. We use an extensible string to build up
773 the log line, and reset the store afterwards. Remote deliveries should always
774 have a pointer to the host item that succeeded; local deliveries can have a
775 pointer to a single host item in their host list, for use by the transport. */
777 #ifdef EXPERIMENTAL_TPDA
778 /* presume no successful remote delivery */
779 lookup_dnssec_authenticated = NULL;
782 s = reset_point = store_get(size);
784 log_address = string_log_address(addr, (log_write_selector & L_all_parents) != 0, TRUE);
786 s = string_append(s, &size, &ptr, 3, host_and_ident(TRUE), US" ", log_address);
790 s = string_append(s, &size, &ptr, 2, US"> ", log_address);
793 if ((log_extra_selector & LX_sender_on_delivery) != 0 || msg)
794 s = string_append(s, &size, &ptr, 3, US" F=<", sender_address, US">");
796 #ifdef EXPERIMENTAL_SRS
797 if(addr->p.srs_sender)
798 s = string_append(s, &size, &ptr, 3, US" SRS=<", addr->p.srs_sender, US">");
801 /* You might think that the return path must always be set for a successful
802 delivery; indeed, I did for some time, until this statement crashed. The case
803 when it is not set is for a delivery to /dev/null which is optimised by not
806 if (used_return_path != NULL &&
807 (log_extra_selector & LX_return_path_on_delivery) != 0)
808 s = string_append(s, &size, &ptr, 3, US" P=<", used_return_path, US">");
811 s = string_append(s, &size, &ptr, 2, US" ", msg);
813 /* For a delivery from a system filter, there may not be a router */
814 if (addr->router != NULL)
815 s = string_append(s, &size, &ptr, 2, US" R=", addr->router->name);
817 s = string_append(s, &size, &ptr, 2, US" T=", addr->transport->name);
819 if ((log_extra_selector & LX_delivery_size) != 0)
820 s = string_append(s, &size, &ptr, 2, US" S=",
821 string_sprintf("%d", transport_count));
825 if (addr->transport->info->local)
828 s = string_append(s, &size, &ptr, 2, US" H=", addr->host_list->name);
829 if (addr->shadow_message != NULL)
830 s = string_cat(s, &size, &ptr, addr->shadow_message,
831 Ustrlen(addr->shadow_message));
834 /* Remote delivery */
840 s = d_hostlog(s, &size, &ptr, addr);
841 if (continue_sequence > 1)
842 s = string_cat(s, &size, &ptr, US"*", 1);
844 #ifdef EXPERIMENTAL_TPDA
845 deliver_host_address = addr->host_used->address;
846 deliver_host_port = addr->host_used->port;
848 /* DNS lookup status */
849 lookup_dnssec_authenticated = addr->host_used->dnssec==DS_YES ? US"yes"
850 : addr->host_used->dnssec==DS_NO ? US"no"
856 s = d_tlslog(s, &size, &ptr, addr);
859 if (addr->authenticator)
861 s = string_append(s, &size, &ptr, 2, US" A=", addr->authenticator);
864 s = string_append(s, &size, &ptr, 2, US":", addr->auth_id);
865 if (log_extra_selector & LX_smtp_mailauth && addr->auth_sndr)
866 s = string_append(s, &size, &ptr, 2, US":", addr->auth_sndr);
871 if (addr->flags & af_prdr_used)
872 s = string_append(s, &size, &ptr, 1, US" PRDR");
876 /* confirmation message (SMTP (host_used) and LMTP (driver_name)) */
878 if (log_extra_selector & LX_smtp_confirmation &&
880 (addr->host_used || Ustrcmp(addr->transport->driver_name, "lmtp") == 0))
883 uschar *p = big_buffer;
884 uschar *ss = addr->message;
886 for (i = 0; i < 256 && ss[i] != 0; i++) /* limit logged amount */
888 if (ss[i] == '\"' || ss[i] == '\\') *p++ = '\\'; /* quote \ and " */
893 s = string_append(s, &size, &ptr, 2, US" C=", big_buffer);
896 /* Time on queue and actual time taken to deliver */
898 if ((log_extra_selector & LX_queue_time) != 0)
899 s = string_append(s, &size, &ptr, 2, US" QT=",
900 readconf_printtime( (int) ((long)time(NULL) - (long)received_time)) );
902 if ((log_extra_selector & LX_deliver_time) != 0)
903 s = string_append(s, &size, &ptr, 2, US" DT=",
904 readconf_printtime(addr->more_errno));
906 /* string_cat() always leaves room for the terminator. Release the
907 store we used to build the line after writing it. */
910 log_write(0, flags, "%s", s);
912 #ifdef EXPERIMENTAL_TPDA
914 uschar * save_domain = deliver_domain;
915 uschar * save_local = deliver_localpart;
917 router_name = addr->router ? addr->router->name : NULL;
918 transport_name = addr->transport ? addr->transport->name : NULL;
919 deliver_domain = addr->domain;
920 deliver_localpart = addr->local_part;
922 (void) tpda_raise_event(addr->transport->tpda_event_action, US"msg:delivery",
923 addr->host_used || Ustrcmp(addr->transport->driver_name, "lmtp") == 0
924 ? addr->message : NULL);
926 deliver_localpart = save_local;
927 deliver_domain = save_domain;
928 router_name = transport_name = NULL;
931 store_reset(reset_point);
937 /*************************************************
938 * Actions at the end of handling an address *
939 *************************************************/
941 /* This is a function for processing a single address when all that can be done
942 with it has been done.
945 addr points to the address block
946 result the result of the delivery attempt
947 logflags flags for log_write() (LOG_MAIN and/or LOG_PANIC)
948 driver_type indicates which type of driver (transport, or router) was last
949 to process the address
950 logchar '=' or '-' for use when logging deliveries with => or ->
956 post_process_one(address_item *addr, int result, int logflags, int driver_type,
959 uschar *now = tod_stamp(tod_log);
960 uschar *driver_kind = NULL;
961 uschar *driver_name = NULL;
964 int size = 256; /* Used for a temporary, */
965 int ptr = 0; /* expanding buffer, for */
966 uschar *s; /* building log lines; */
967 void *reset_point; /* released afterwards. */
970 DEBUG(D_deliver) debug_printf("post-process %s (%d)\n", addr->address, result);
972 /* Set up driver kind and name for logging. Disable logging if the router or
973 transport has disabled it. */
975 if (driver_type == DTYPE_TRANSPORT)
977 if (addr->transport != NULL)
979 driver_name = addr->transport->name;
980 driver_kind = US" transport";
981 disable_logging = addr->transport->disable_logging;
983 else driver_kind = US"transporting";
985 else if (driver_type == DTYPE_ROUTER)
987 if (addr->router != NULL)
989 driver_name = addr->router->name;
990 driver_kind = US" router";
991 disable_logging = addr->router->disable_logging;
993 else driver_kind = US"routing";
996 /* If there's an error message set, ensure that it contains only printing
997 characters - it should, but occasionally things slip in and this at least
998 stops the log format from getting wrecked. We also scan the message for an LDAP
999 expansion item that has a password setting, and flatten the password. This is a
1000 fudge, but I don't know a cleaner way of doing this. (If the item is badly
1001 malformed, it won't ever have gone near LDAP.) */
1003 if (addr->message != NULL)
1005 addr->message = string_printing(addr->message);
1006 if (((Ustrstr(addr->message, "failed to expand") != NULL) || (Ustrstr(addr->message, "expansion of ") != NULL)) &&
1007 (Ustrstr(addr->message, "mysql") != NULL ||
1008 Ustrstr(addr->message, "pgsql") != NULL ||
1009 #ifdef EXPERIMENTAL_REDIS
1010 Ustrstr(addr->message, "redis") != NULL ||
1012 Ustrstr(addr->message, "sqlite") != NULL ||
1013 Ustrstr(addr->message, "ldap:") != NULL ||
1014 Ustrstr(addr->message, "ldapdn:") != NULL ||
1015 Ustrstr(addr->message, "ldapm:") != NULL))
1017 addr->message = string_sprintf("Temporary internal error");
1021 /* If we used a transport that has one of the "return_output" options set, and
1022 if it did in fact generate some output, then for return_output we treat the
1023 message as failed if it was not already set that way, so that the output gets
1024 returned to the sender, provided there is a sender to send it to. For
1025 return_fail_output, do this only if the delivery failed. Otherwise we just
1026 unlink the file, and remove the name so that if the delivery failed, we don't
1027 try to send back an empty or unwanted file. The log_output options operate only
1028 on a non-empty file.
1030 In any case, we close the message file, because we cannot afford to leave a
1031 file-descriptor for one address while processing (maybe very many) others. */
1033 if (addr->return_file >= 0 && addr->return_filename != NULL)
1035 BOOL return_output = FALSE;
1036 struct stat statbuf;
1037 (void)EXIMfsync(addr->return_file);
1039 /* If there is no output, do nothing. */
1041 if (fstat(addr->return_file, &statbuf) == 0 && statbuf.st_size > 0)
1043 transport_instance *tb = addr->transport;
1045 /* Handle logging options */
1047 if (tb->log_output || (result == FAIL && tb->log_fail_output) ||
1048 (result == DEFER && tb->log_defer_output))
1051 FILE *f = Ufopen(addr->return_filename, "rb");
1053 log_write(0, LOG_MAIN|LOG_PANIC, "failed to open %s to log output "
1054 "from %s transport: %s", addr->return_filename, tb->name,
1058 s = US Ufgets(big_buffer, big_buffer_size, f);
1061 uschar *p = big_buffer + Ustrlen(big_buffer);
1062 while (p > big_buffer && isspace(p[-1])) p--;
1064 s = string_printing(big_buffer);
1065 log_write(0, LOG_MAIN, "<%s>: %s transport output: %s",
1066 addr->address, tb->name, s);
1072 /* Handle returning options, but only if there is an address to return
1075 if (sender_address[0] != 0 || addr->p.errors_address != NULL)
1077 if (tb->return_output)
1079 addr->transport_return = result = FAIL;
1080 if (addr->basic_errno == 0 && addr->message == NULL)
1081 addr->message = US"return message generated";
1082 return_output = TRUE;
1085 if (tb->return_fail_output && result == FAIL) return_output = TRUE;
1089 /* Get rid of the file unless it might be returned, but close it in
1094 Uunlink(addr->return_filename);
1095 addr->return_filename = NULL;
1096 addr->return_file = -1;
1099 (void)close(addr->return_file);
1102 /* The success case happens only after delivery by a transport. */
1106 addr->next = addr_succeed;
1107 addr_succeed = addr;
1109 /* Call address_done() to ensure that we don't deliver to this address again,
1110 and write appropriate things to the message log. If it is a child address, we
1111 call child_done() to scan the ancestors and mark them complete if this is the
1112 last child to complete. */
1114 address_done(addr, now);
1115 DEBUG(D_deliver) debug_printf("%s delivered\n", addr->address);
1117 if (addr->parent == NULL)
1118 deliver_msglog("%s %s: %s%s succeeded\n", now, addr->address,
1119 driver_name, driver_kind);
1122 deliver_msglog("%s %s <%s>: %s%s succeeded\n", now, addr->address,
1123 addr->parent->address, driver_name, driver_kind);
1124 child_done(addr, now);
1127 /* Certificates for logging (via TPDA) */
1129 tls_out.ourcert = addr->ourcert;
1130 addr->ourcert = NULL;
1131 tls_out.peercert = addr->peercert;
1132 addr->peercert = NULL;
1134 tls_out.cipher = addr->cipher;
1135 tls_out.peerdn = addr->peerdn;
1136 tls_out.ocsp = addr->ocsp;
1137 # ifdef EXPERIMENTAL_DANE
1138 tls_out.dane_verified = testflag(addr, af_dane_verified);
1142 delivery_log(LOG_MAIN, addr, logchar, NULL);
1145 if (tls_out.ourcert)
1147 tls_free_cert(tls_out.ourcert);
1148 tls_out.ourcert = NULL;
1150 if (tls_out.peercert)
1152 tls_free_cert(tls_out.peercert);
1153 tls_out.peercert = NULL;
1155 tls_out.cipher = NULL;
1156 tls_out.peerdn = NULL;
1157 tls_out.ocsp = OCSP_NOT_REQ;
1158 # ifdef EXPERIMENTAL_DANE
1159 tls_out.dane_verified = FALSE;
1165 /* Soft failure, or local delivery process failed; freezing may be
1168 else if (result == DEFER || result == PANIC)
1170 if (result == PANIC) logflags |= LOG_PANIC;
1172 /* This puts them on the chain in reverse order. Do not change this, because
1173 the code for handling retries assumes that the one with the retry
1174 information is last. */
1176 addr->next = addr_defer;
1179 /* The only currently implemented special action is to freeze the
1180 message. Logging of this is done later, just before the -H file is
1183 if (addr->special_action == SPECIAL_FREEZE)
1185 deliver_freeze = TRUE;
1186 deliver_frozen_at = time(NULL);
1187 update_spool = TRUE;
1190 /* If doing a 2-stage queue run, we skip writing to either the message
1191 log or the main log for SMTP defers. */
1193 if (!queue_2stage || addr->basic_errno != 0)
1197 /* For errors of the type "retry time not reached" (also remotes skipped
1198 on queue run), logging is controlled by L_retry_defer. Note that this kind
1199 of error number is negative, and all the retry ones are less than any
1202 unsigned int use_log_selector = (addr->basic_errno <= ERRNO_RETRY_BASE)?
1205 /* Build up the line that is used for both the message log and the main
1208 s = reset_point = store_get(size);
1210 /* Create the address string for logging. Must not do this earlier, because
1211 an OK result may be changed to FAIL when a pipe returns text. */
1213 log_address = string_log_address(addr,
1214 (log_write_selector & L_all_parents) != 0, result == OK);
1216 s = string_cat(s, &size, &ptr, log_address, Ustrlen(log_address));
1218 /* Either driver_name contains something and driver_kind contains
1219 " router" or " transport" (note the leading space), or driver_name is
1220 a null string and driver_kind contains "routing" without the leading
1221 space, if all routing has been deferred. When a domain has been held,
1222 so nothing has been done at all, both variables contain null strings. */
1224 if (driver_name == NULL)
1226 if (driver_kind != NULL)
1227 s = string_append(s, &size, &ptr, 2, US" ", driver_kind);
1231 if (driver_kind[1] == 't' && addr->router != NULL)
1232 s = string_append(s, &size, &ptr, 2, US" R=", addr->router->name);
1234 ss[1] = toupper(driver_kind[1]);
1235 s = string_append(s, &size, &ptr, 2, ss, driver_name);
1238 sprintf(CS ss, " defer (%d)", addr->basic_errno);
1239 s = string_cat(s, &size, &ptr, ss, Ustrlen(ss));
1241 if (addr->basic_errno > 0)
1242 s = string_append(s, &size, &ptr, 2, US": ",
1243 US strerror(addr->basic_errno));
1245 if (addr->message != NULL)
1246 s = string_append(s, &size, &ptr, 2, US": ", addr->message);
1250 /* Log the deferment in the message log, but don't clutter it
1251 up with retry-time defers after the first delivery attempt. */
1253 if (deliver_firsttime || addr->basic_errno > ERRNO_RETRY_BASE)
1254 deliver_msglog("%s %s\n", now, s);
1256 /* Write the main log and reset the store */
1258 log_write(use_log_selector, logflags, "== %s", s);
1259 store_reset(reset_point);
1264 /* Hard failure. If there is an address to which an error message can be sent,
1265 put this address on the failed list. If not, put it on the deferred list and
1266 freeze the mail message for human attention. The latter action can also be
1267 explicitly requested by a router or transport. */
1271 /* If this is a delivery error, or a message for which no replies are
1272 wanted, and the message's age is greater than ignore_bounce_errors_after,
1273 force the af_ignore_error flag. This will cause the address to be discarded
1274 later (with a log entry). */
1276 if (sender_address[0] == 0 && message_age >= ignore_bounce_errors_after)
1277 setflag(addr, af_ignore_error);
1279 /* Freeze the message if requested, or if this is a bounce message (or other
1280 message with null sender) and this address does not have its own errors
1281 address. However, don't freeze if errors are being ignored. The actual code
1282 to ignore occurs later, instead of sending a message. Logging of freezing
1283 occurs later, just before writing the -H file. */
1285 if (!testflag(addr, af_ignore_error) &&
1286 (addr->special_action == SPECIAL_FREEZE ||
1287 (sender_address[0] == 0 && addr->p.errors_address == NULL)
1290 frozen_info = (addr->special_action == SPECIAL_FREEZE)? US"" :
1291 (sender_local && !local_error_message)?
1292 US" (message created with -f <>)" : US" (delivery error message)";
1293 deliver_freeze = TRUE;
1294 deliver_frozen_at = time(NULL);
1295 update_spool = TRUE;
1297 /* The address is put on the defer rather than the failed queue, because
1298 the message is being retained. */
1300 addr->next = addr_defer;
1304 /* Don't put the address on the nonrecipients tree yet; wait until an
1305 error message has been successfully sent. */
1309 addr->next = addr_failed;
1313 /* Build up the log line for the message and main logs */
1315 s = reset_point = store_get(size);
1317 /* Create the address string for logging. Must not do this earlier, because
1318 an OK result may be changed to FAIL when a pipe returns text. */
1320 log_address = string_log_address(addr,
1321 (log_write_selector & L_all_parents) != 0, result == OK);
1323 s = string_cat(s, &size, &ptr, log_address, Ustrlen(log_address));
1325 if ((log_extra_selector & LX_sender_on_delivery) != 0)
1326 s = string_append(s, &size, &ptr, 3, US" F=<", sender_address, US">");
1328 /* Return path may not be set if no delivery actually happened */
1330 if (used_return_path != NULL &&
1331 (log_extra_selector & LX_return_path_on_delivery) != 0)
1332 s = string_append(s, &size, &ptr, 3, US" P=<", used_return_path, US">");
1334 if (addr->router != NULL)
1335 s = string_append(s, &size, &ptr, 2, US" R=", addr->router->name);
1336 if (addr->transport != NULL)
1337 s = string_append(s, &size, &ptr, 2, US" T=", addr->transport->name);
1339 if (addr->host_used != NULL)
1340 s = d_hostlog(s, &size, &ptr, addr);
1343 s = d_tlslog(s, &size, &ptr, addr);
1346 if (addr->basic_errno > 0)
1347 s = string_append(s, &size, &ptr, 2, US": ",
1348 US strerror(addr->basic_errno));
1350 if (addr->message != NULL)
1351 s = string_append(s, &size, &ptr, 2, US": ", addr->message);
1355 /* Do the logging. For the message log, "routing failed" for those cases,
1356 just to make it clearer. */
1358 if (driver_name == NULL)
1359 deliver_msglog("%s %s failed for %s\n", now, driver_kind, s);
1361 deliver_msglog("%s %s\n", now, s);
1363 log_write(0, LOG_MAIN, "** %s", s);
1364 store_reset(reset_point);
1367 /* Ensure logging is turned on again in all cases */
1369 disable_logging = FALSE;
1375 /*************************************************
1376 * Address-independent error *
1377 *************************************************/
1379 /* This function is called when there's an error that is not dependent on a
1380 particular address, such as an expansion string failure. It puts the error into
1381 all the addresses in a batch, logs the incident on the main and panic logs, and
1382 clears the expansions. It is mostly called from local_deliver(), but can be
1383 called for a remote delivery via findugid().
1386 logit TRUE if (MAIN+PANIC) logging required
1387 addr the first of the chain of addresses
1389 format format string for error message, or NULL if already set in addr
1390 ... arguments for the format
1396 common_error(BOOL logit, address_item *addr, int code, uschar *format, ...)
1398 address_item *addr2;
1399 addr->basic_errno = code;
1405 va_start(ap, format);
1406 if (!string_vformat(buffer, sizeof(buffer), CS format, ap))
1407 log_write(0, LOG_MAIN|LOG_PANIC_DIE,
1408 "common_error expansion was longer than " SIZE_T_FMT, sizeof(buffer));
1410 addr->message = string_copy(buffer);
1413 for (addr2 = addr->next; addr2 != NULL; addr2 = addr2->next)
1415 addr2->basic_errno = code;
1416 addr2->message = addr->message;
1419 if (logit) log_write(0, LOG_MAIN|LOG_PANIC, "%s", addr->message);
1420 deliver_set_expansions(NULL);
1426 /*************************************************
1427 * Check a "never users" list *
1428 *************************************************/
1430 /* This function is called to check whether a uid is on one of the two "never
1434 uid the uid to be checked
1435 nusers the list to be scanned; the first item in the list is the count
1437 Returns: TRUE if the uid is on the list
1441 check_never_users(uid_t uid, uid_t *nusers)
1444 if (nusers == NULL) return FALSE;
1445 for (i = 1; i <= (int)(nusers[0]); i++) if (nusers[i] == uid) return TRUE;
1451 /*************************************************
1452 * Find uid and gid for a transport *
1453 *************************************************/
1455 /* This function is called for both local and remote deliveries, to find the
1456 uid/gid under which to run the delivery. The values are taken preferentially
1457 from the transport (either explicit or deliver_as_creator), then from the
1458 address (i.e. the router), and if nothing is set, the exim uid/gid are used. If
1459 the resulting uid is on the "never_users" or the "fixed_never_users" list, a
1460 panic error is logged, and the function fails (which normally leads to delivery
1464 addr the address (possibly a chain)
1466 uidp pointer to uid field
1467 gidp pointer to gid field
1468 igfp pointer to the use_initgroups field
1470 Returns: FALSE if failed - error has been set in address(es)
1474 findugid(address_item *addr, transport_instance *tp, uid_t *uidp, gid_t *gidp,
1477 uschar *nuname = NULL;
1478 BOOL gid_set = FALSE;
1480 /* Default initgroups flag comes from the transport */
1482 *igfp = tp->initgroups;
1484 /* First see if there's a gid on the transport, either fixed or expandable.
1485 The expanding function always logs failure itself. */
1492 else if (tp->expand_gid != NULL)
1494 if (route_find_expanded_group(tp->expand_gid, tp->name, US"transport", gidp,
1495 &(addr->message))) gid_set = TRUE;
1498 common_error(FALSE, addr, ERRNO_GIDFAIL, NULL);
1503 /* If the transport did not set a group, see if the router did. */
1505 if (!gid_set && testflag(addr, af_gid_set))
1511 /* Pick up a uid from the transport if one is set. */
1513 if (tp->uid_set) *uidp = tp->uid;
1515 /* Otherwise, try for an expandable uid field. If it ends up as a numeric id,
1516 it does not provide a passwd value from which a gid can be taken. */
1518 else if (tp->expand_uid != NULL)
1521 if (!route_find_expanded_user(tp->expand_uid, tp->name, US"transport", &pw,
1522 uidp, &(addr->message)))
1524 common_error(FALSE, addr, ERRNO_UIDFAIL, NULL);
1527 if (!gid_set && pw != NULL)
1534 /* If the transport doesn't set the uid, test the deliver_as_creator flag. */
1536 else if (tp->deliver_as_creator)
1538 *uidp = originator_uid;
1541 *gidp = originator_gid;
1546 /* Otherwise see if the address specifies the uid and if so, take it and its
1549 else if (testflag(addr, af_uid_set))
1552 *igfp = testflag(addr, af_initgroups);
1555 /* Nothing has specified the uid - default to the Exim user, and group if the
1568 /* If no gid is set, it is a disaster. We default to the Exim gid only if
1569 defaulting to the Exim uid. In other words, if the configuration has specified
1570 a uid, it must also provide a gid. */
1574 common_error(TRUE, addr, ERRNO_GIDFAIL, US"User set without group for "
1575 "%s transport", tp->name);
1579 /* Check that the uid is not on the lists of banned uids that may not be used
1580 for delivery processes. */
1582 if (check_never_users(*uidp, never_users))
1583 nuname = US"never_users";
1584 else if (check_never_users(*uidp, fixed_never_users))
1585 nuname = US"fixed_never_users";
1589 common_error(TRUE, addr, ERRNO_UIDFAIL, US"User %ld set for %s transport "
1590 "is on the %s list", (long int)(*uidp), tp->name, nuname);
1602 /*************************************************
1603 * Check the size of a message for a transport *
1604 *************************************************/
1606 /* Checks that the message isn't too big for the selected transport.
1607 This is called only when it is known that the limit is set.
1611 addr the (first) address being delivered
1614 DEFER expansion failed or did not yield an integer
1615 FAIL message too big
1619 check_message_size(transport_instance *tp, address_item *addr)
1624 deliver_set_expansions(addr);
1625 size_limit = expand_string_integer(tp->message_size_limit, TRUE);
1626 deliver_set_expansions(NULL);
1628 if (expand_string_message != NULL)
1631 if (size_limit == -1)
1632 addr->message = string_sprintf("failed to expand message_size_limit "
1633 "in %s transport: %s", tp->name, expand_string_message);
1635 addr->message = string_sprintf("invalid message_size_limit "
1636 "in %s transport: %s", tp->name, expand_string_message);
1638 else if (size_limit > 0 && message_size > size_limit)
1642 string_sprintf("message is too big (transport limit = %d)",
1651 /*************************************************
1652 * Transport-time check for a previous delivery *
1653 *************************************************/
1655 /* Check that this base address hasn't previously been delivered to its routed
1656 transport. If it has been delivered, mark it done. The check is necessary at
1657 delivery time in order to handle homonymic addresses correctly in cases where
1658 the pattern of redirection changes between delivery attempts (so the unique
1659 fields change). Non-homonymic previous delivery is detected earlier, at routing
1660 time (which saves unnecessary routing).
1663 addr the address item
1664 testing TRUE if testing wanted only, without side effects
1666 Returns: TRUE if previously delivered by the transport
1670 previously_transported(address_item *addr, BOOL testing)
1672 (void)string_format(big_buffer, big_buffer_size, "%s/%s",
1673 addr->unique + (testflag(addr, af_homonym)? 3:0), addr->transport->name);
1675 if (tree_search(tree_nonrecipients, big_buffer) != 0)
1677 DEBUG(D_deliver|D_route|D_transport)
1678 debug_printf("%s was previously delivered (%s transport): discarded\n",
1679 addr->address, addr->transport->name);
1680 if (!testing) child_done(addr, tod_stamp(tod_log));
1689 /******************************************************
1690 * Check for a given header in a header string *
1691 ******************************************************/
1693 /* This function is used when generating quota warnings. The configuration may
1694 specify any header lines it likes in quota_warn_message. If certain of them are
1695 missing, defaults are inserted, so we need to be able to test for the presence
1699 hdr the required header name
1700 hstring the header string
1702 Returns: TRUE the header is in the string
1703 FALSE the header is not in the string
1707 contains_header(uschar *hdr, uschar *hstring)
1709 int len = Ustrlen(hdr);
1710 uschar *p = hstring;
1713 if (strncmpic(p, hdr, len) == 0)
1716 while (*p == ' ' || *p == '\t') p++;
1717 if (*p == ':') return TRUE;
1719 while (*p != 0 && *p != '\n') p++;
1720 if (*p == '\n') p++;
1728 /*************************************************
1729 * Perform a local delivery *
1730 *************************************************/
1732 /* Each local delivery is performed in a separate process which sets its
1733 uid and gid as specified. This is a safer way than simply changing and
1734 restoring using seteuid(); there is a body of opinion that seteuid() cannot be
1735 used safely. From release 4, Exim no longer makes any use of it. Besides, not
1736 all systems have seteuid().
1738 If the uid/gid are specified in the transport_instance, they are used; the
1739 transport initialization must ensure that either both or neither are set.
1740 Otherwise, the values associated with the address are used. If neither are set,
1741 it is a configuration error.
1743 The transport or the address may specify a home directory (transport over-
1744 rides), and if they do, this is set as $home. If neither have set a working
1745 directory, this value is used for that as well. Otherwise $home is left unset
1746 and the cwd is set to "/" - a directory that should be accessible to all users.
1748 Using a separate process makes it more complicated to get error information
1749 back. We use a pipe to pass the return code and also an error code and error
1750 text string back to the parent process.
1753 addr points to an address block for this delivery; for "normal" local
1754 deliveries this is the only address to be delivered, but for
1755 pseudo-remote deliveries (e.g. by batch SMTP to a file or pipe)
1756 a number of addresses can be handled simultaneously, and in this
1757 case addr will point to a chain of addresses with the same
1760 shadowing TRUE if running a shadow transport; this causes output from pipes
1767 deliver_local(address_item *addr, BOOL shadowing)
1769 BOOL use_initgroups;
1772 int status, len, rc;
1775 uschar *working_directory;
1776 address_item *addr2;
1777 transport_instance *tp = addr->transport;
1779 /* Set up the return path from the errors or sender address. If the transport
1780 has its own return path setting, expand it and replace the existing value. */
1782 if(addr->p.errors_address != NULL)
1783 return_path = addr->p.errors_address;
1784 #ifdef EXPERIMENTAL_SRS
1785 else if(addr->p.srs_sender != NULL)
1786 return_path = addr->p.srs_sender;
1789 return_path = sender_address;
1791 if (tp->return_path != NULL)
1793 uschar *new_return_path = expand_string(tp->return_path);
1794 if (new_return_path == NULL)
1796 if (!expand_string_forcedfail)
1798 common_error(TRUE, addr, ERRNO_EXPANDFAIL,
1799 US"Failed to expand return path \"%s\" in %s transport: %s",
1800 tp->return_path, tp->name, expand_string_message);
1804 else return_path = new_return_path;
1807 /* For local deliveries, one at a time, the value used for logging can just be
1808 set directly, once and for all. */
1810 used_return_path = return_path;
1812 /* Sort out the uid, gid, and initgroups flag. If an error occurs, the message
1813 gets put into the address(es), and the expansions are unset, so we can just
1816 if (!findugid(addr, tp, &uid, &gid, &use_initgroups)) return;
1818 /* See if either the transport or the address specifies a home directory. A
1819 home directory set in the address may already be expanded; a flag is set to
1820 indicate that. In other cases we must expand it. */
1822 if ((deliver_home = tp->home_dir) != NULL || /* Set in transport, or */
1823 ((deliver_home = addr->home_dir) != NULL && /* Set in address and */
1824 !testflag(addr, af_home_expanded))) /* not expanded */
1826 uschar *rawhome = deliver_home;
1827 deliver_home = NULL; /* in case it contains $home */
1828 deliver_home = expand_string(rawhome);
1829 if (deliver_home == NULL)
1831 common_error(TRUE, addr, ERRNO_EXPANDFAIL, US"home directory \"%s\" failed "
1832 "to expand for %s transport: %s", rawhome, tp->name,
1833 expand_string_message);
1836 if (*deliver_home != '/')
1838 common_error(TRUE, addr, ERRNO_NOTABSOLUTE, US"home directory path \"%s\" "
1839 "is not absolute for %s transport", deliver_home, tp->name);
1844 /* See if either the transport or the address specifies a current directory,
1845 and if so, expand it. If nothing is set, use the home directory, unless it is
1846 also unset in which case use "/", which is assumed to be a directory to which
1847 all users have access. It is necessary to be in a visible directory for some
1848 operating systems when running pipes, as some commands (e.g. "rm" under Solaris
1849 2.5) require this. */
1851 working_directory = (tp->current_dir != NULL)?
1852 tp->current_dir : addr->current_dir;
1854 if (working_directory != NULL)
1856 uschar *raw = working_directory;
1857 working_directory = expand_string(raw);
1858 if (working_directory == NULL)
1860 common_error(TRUE, addr, ERRNO_EXPANDFAIL, US"current directory \"%s\" "
1861 "failed to expand for %s transport: %s", raw, tp->name,
1862 expand_string_message);
1865 if (*working_directory != '/')
1867 common_error(TRUE, addr, ERRNO_NOTABSOLUTE, US"current directory path "
1868 "\"%s\" is not absolute for %s transport", working_directory, tp->name);
1872 else working_directory = (deliver_home == NULL)? US"/" : deliver_home;
1874 /* If one of the return_output flags is set on the transport, create and open a
1875 file in the message log directory for the transport to write its output onto.
1876 This is mainly used by pipe transports. The file needs to be unique to the
1877 address. This feature is not available for shadow transports. */
1879 if (!shadowing && (tp->return_output || tp->return_fail_output ||
1880 tp->log_output || tp->log_fail_output))
1883 addr->return_filename =
1884 string_sprintf("%s/msglog/%s/%s-%d-%d", spool_directory, message_subdir,
1885 message_id, getpid(), return_count++);
1886 addr->return_file = open_msglog_file(addr->return_filename, 0400, &error);
1887 if (addr->return_file < 0)
1889 common_error(TRUE, addr, errno, US"Unable to %s file for %s transport "
1890 "to return message: %s", error, tp->name, strerror(errno));
1895 /* Create the pipe for inter-process communication. */
1899 common_error(TRUE, addr, ERRNO_PIPEFAIL, US"Creation of pipe failed: %s",
1904 /* Now fork the process to do the real work in the subprocess, but first
1905 ensure that all cached resources are freed so that the subprocess starts with
1906 a clean slate and doesn't interfere with the parent process. */
1910 if ((pid = fork()) == 0)
1912 BOOL replicate = TRUE;
1914 /* Prevent core dumps, as we don't want them in users' home directories.
1915 HP-UX doesn't have RLIMIT_CORE; I don't know how to do this in that
1916 system. Some experimental/developing systems (e.g. GNU/Hurd) may define
1917 RLIMIT_CORE but not support it in setrlimit(). For such systems, do not
1918 complain if the error is "not supported".
1920 There are two scenarios where changing the max limit has an effect. In one,
1921 the user is using a .forward and invoking a command of their choice via pipe;
1922 for these, we do need the max limit to be 0 unless the admin chooses to
1923 permit an increased limit. In the other, the command is invoked directly by
1924 the transport and is under administrator control, thus being able to raise
1925 the limit aids in debugging. So there's no general always-right answer.
1927 Thus we inhibit core-dumps completely but let individual transports, while
1928 still root, re-raise the limits back up to aid debugging. We make the
1929 default be no core-dumps -- few enough people can use core dumps in
1930 diagnosis that it's reasonable to make them something that has to be explicitly requested.
1937 if (setrlimit(RLIMIT_CORE, &rl) < 0)
1939 # ifdef SETRLIMIT_NOT_SUPPORTED
1940 if (errno != ENOSYS && errno != ENOTSUP)
1942 log_write(0, LOG_MAIN|LOG_PANIC, "setrlimit(RLIMIT_CORE) failed: %s",
1947 /* Reset the random number generator, so different processes don't all
1948 have the same sequence. */
1952 /* If the transport has a setup entry, call this first, while still
1953 privileged. (Appendfile uses this to expand quota, for example, while
1954 able to read private files.) */
1956 if (addr->transport->setup != NULL)
1958 switch((addr->transport->setup)(addr->transport, addr, NULL, uid, gid,
1962 addr->transport_return = DEFER;
1966 addr->transport_return = PANIC;
1971 /* Ignore SIGINT and SIGTERM during delivery. Also ignore SIGUSR1, as
1972 when the process becomes unprivileged, it won't be able to write to the
1973 process log. SIGHUP is ignored throughout exim, except when it is being
1976 signal(SIGINT, SIG_IGN);
1977 signal(SIGTERM, SIG_IGN);
1978 signal(SIGUSR1, SIG_IGN);
1980 /* Close the unwanted half of the pipe, and set close-on-exec for the other
1981 half - for transports that exec things (e.g. pipe). Then set the required
1984 (void)close(pfd[pipe_read]);
1985 (void)fcntl(pfd[pipe_write], F_SETFD, fcntl(pfd[pipe_write], F_GETFD) |
1987 exim_setugid(uid, gid, use_initgroups,
1988 string_sprintf("local delivery to %s <%s> transport=%s", addr->local_part,
1989 addr->address, addr->transport->name));
1993 address_item *batched;
1994 debug_printf(" home=%s current=%s\n", deliver_home, working_directory);
1995 for (batched = addr->next; batched != NULL; batched = batched->next)
1996 debug_printf("additional batched address: %s\n", batched->address);
1999 /* Set an appropriate working directory. */
2001 if (Uchdir(working_directory) < 0)
2003 addr->transport_return = DEFER;
2004 addr->basic_errno = errno;
2005 addr->message = string_sprintf("failed to chdir to %s", working_directory);
2008 /* If successful, call the transport */
2013 set_process_info("delivering %s to %s using %s", message_id,
2014 addr->local_part, addr->transport->name);
2016 /* Setting this global in the subprocess means we need never clear it */
2017 transport_name = addr->transport->name;
2019 /* If a transport filter has been specified, set up its argument list.
2020 Any errors will get put into the address, and FALSE yielded. */
2022 if (addr->transport->filter_command != NULL)
2024 ok = transport_set_up_command(&transport_filter_argv,
2025 addr->transport->filter_command,
2026 TRUE, PANIC, addr, US"transport filter", NULL);
2027 transport_filter_timeout = addr->transport->filter_timeout;
2029 else transport_filter_argv = NULL;
2033 debug_print_string(addr->transport->debug_string);
2034 replicate = !(addr->transport->info->code)(addr->transport, addr);
2038 /* Pass the results back down the pipe. If necessary, first replicate the
2039 status in the top address to the others in the batch. The label is the
2040 subject of a goto when a call to the transport's setup function fails. We
2041 pass the pointer to the transport back in case it got changed as a result of
2042 file_format in appendfile. */
2046 if (replicate) replicate_status(addr);
2047 for (addr2 = addr; addr2 != NULL; addr2 = addr2->next)
2050 int local_part_length = Ustrlen(addr2->local_part);
2054 if( (ret = write(pfd[pipe_write], (void *)&(addr2->transport_return), sizeof(int))) != sizeof(int)
2055 || (ret = write(pfd[pipe_write], (void *)&transport_count, sizeof(transport_count))) != sizeof(transport_count)
2056 || (ret = write(pfd[pipe_write], (void *)&(addr2->flags), sizeof(addr2->flags))) != sizeof(addr2->flags)
2057 || (ret = write(pfd[pipe_write], (void *)&(addr2->basic_errno), sizeof(int))) != sizeof(int)
2058 || (ret = write(pfd[pipe_write], (void *)&(addr2->more_errno), sizeof(int))) != sizeof(int)
2059 || (ret = write(pfd[pipe_write], (void *)&(addr2->special_action), sizeof(int))) != sizeof(int)
2060 || (ret = write(pfd[pipe_write], (void *)&(addr2->transport),
2061 sizeof(transport_instance *))) != sizeof(transport_instance *)
2063 /* For a file delivery, pass back the local part, in case the original
2064 was only part of the final delivery path. This gives more complete
2067 || (testflag(addr2, af_file)
2068 && ( (ret = write(pfd[pipe_write], (void *)&local_part_length, sizeof(int))) != sizeof(int)
2069 || (ret = write(pfd[pipe_write], addr2->local_part, local_part_length)) != local_part_length
2073 log_write(0, LOG_MAIN|LOG_PANIC, "Failed writing transport results to pipe: %s\n",
2074 ret == -1 ? strerror(errno) : "short write");
2076 /* Now any messages */
2078 for (i = 0, s = addr2->message; i < 2; i++, s = addr2->user_message)
2080 int message_length = (s == NULL)? 0 : Ustrlen(s) + 1;
2081 if( (ret = write(pfd[pipe_write], (void *)&message_length, sizeof(int))) != sizeof(int)
2082 || (message_length > 0 && (ret = write(pfd[pipe_write], s, message_length)) != message_length)
2084 log_write(0, LOG_MAIN|LOG_PANIC, "Failed writing transport results to pipe: %s\n",
2085 ret == -1 ? strerror(errno) : "short write");
2089 /* OK, this process is now done. Free any cached resources that it opened,
2090 and close the pipe we were writing down before exiting. */
2092 (void)close(pfd[pipe_write]);
2097 /* Back in the main process: panic if the fork did not succeed. This seems
2098 better than returning an error - if forking is failing it is probably best
2099 not to try other deliveries for this message. */
2102 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Fork failed for local delivery to %s",
2105 /* Read the pipe to get the delivery status codes and error messages. Our copy
2106 of the writing end must be closed first, as otherwise read() won't return zero
2107 on an empty pipe. We check that a status exists for each address before
2108 overwriting the address structure. If data is missing, the default DEFER status
2109 will remain. Afterwards, close the reading end. */
2111 (void)close(pfd[pipe_write]);
2113 for (addr2 = addr; addr2 != NULL; addr2 = addr2->next)
2115 len = read(pfd[pipe_read], (void *)&status, sizeof(int));
2121 addr2->transport_return = status;
2122 len = read(pfd[pipe_read], (void *)&transport_count,
2123 sizeof(transport_count));
2124 len = read(pfd[pipe_read], (void *)&(addr2->flags), sizeof(addr2->flags));
2125 len = read(pfd[pipe_read], (void *)&(addr2->basic_errno), sizeof(int));
2126 len = read(pfd[pipe_read], (void *)&(addr2->more_errno), sizeof(int));
2127 len = read(pfd[pipe_read], (void *)&(addr2->special_action), sizeof(int));
2128 len = read(pfd[pipe_read], (void *)&(addr2->transport),
2129 sizeof(transport_instance *));
2131 if (testflag(addr2, af_file))
2133 int local_part_length;
2134 len = read(pfd[pipe_read], (void *)&local_part_length, sizeof(int));
2135 len = read(pfd[pipe_read], (void *)big_buffer, local_part_length);
2136 big_buffer[local_part_length] = 0;
2137 addr2->local_part = string_copy(big_buffer);
2140 for (i = 0, sptr = &(addr2->message); i < 2;
2141 i++, sptr = &(addr2->user_message))
2144 len = read(pfd[pipe_read], (void *)&message_length, sizeof(int));
2145 if (message_length > 0)
2147 len = read(pfd[pipe_read], (void *)big_buffer, message_length);
2148 if (len > 0) *sptr = string_copy(big_buffer);
2155 log_write(0, LOG_MAIN|LOG_PANIC, "failed to read delivery status for %s "
2156 "from delivery subprocess", addr2->unique);
2161 (void)close(pfd[pipe_read]);
2163 /* Unless shadowing, write all successful addresses immediately to the journal
2164 file, to ensure they are recorded asap. For homonymic addresses, use the base
2165 address plus the transport name. Failure to write the journal is panic-worthy,
2166 but don't stop, as it may prove possible subsequently to update the spool file
2167 in order to record the delivery. */
2171 for (addr2 = addr; addr2 != NULL; addr2 = addr2->next)
2173 if (addr2->transport_return != OK) continue;
2175 if (testflag(addr2, af_homonym))
2176 sprintf(CS big_buffer, "%.500s/%s\n", addr2->unique + 3, tp->name);
2178 sprintf(CS big_buffer, "%.500s\n", addr2->unique);
2180 /* In the test harness, wait just a bit to let the subprocess finish off
2181 any debug output etc first. */
2183 if (running_in_test_harness) millisleep(300);
2185 DEBUG(D_deliver) debug_printf("journalling %s", big_buffer);
2186 len = Ustrlen(big_buffer);
2187 if (write(journal_fd, big_buffer, len) != len)
2188 log_write(0, LOG_MAIN|LOG_PANIC, "failed to update journal for %s: %s",
2189 big_buffer, strerror(errno));
2192 /* Ensure the journal file is pushed out to disk. */
2194 if (EXIMfsync(journal_fd) < 0)
2195 log_write(0, LOG_MAIN|LOG_PANIC, "failed to fsync journal: %s",
2199 /* Wait for the process to finish. If it terminates with a non-zero code,
2200 freeze the message (except for SIGTERM, SIGKILL and SIGQUIT), but leave the
2201 status values of all the addresses as they are. Take care to handle the case
2202 when the subprocess doesn't seem to exist. This has been seen on one system
2203 when Exim was called from an MUA that set SIGCHLD to SIG_IGN. When that
2204 happens, wait() doesn't recognize the termination of child processes. Exim now
2205 resets SIGCHLD to SIG_DFL, but this code should still be robust. */
2207 while ((rc = wait(&status)) != pid)
2209 if (rc < 0 && errno == ECHILD) /* Process has vanished */
2211 log_write(0, LOG_MAIN, "%s transport process vanished unexpectedly",
2212 addr->transport->driver_name);
2218 if ((status & 0xffff) != 0)
2220 int msb = (status >> 8) & 255;
2221 int lsb = status & 255;
2222 int code = (msb == 0)? (lsb & 0x7f) : msb;
2223 if (msb != 0 || (code != SIGTERM && code != SIGKILL && code != SIGQUIT))
2224 addr->special_action = SPECIAL_FREEZE;
2225 log_write(0, LOG_MAIN|LOG_PANIC, "%s transport process returned non-zero "
2226 "status 0x%04x: %s %d",
2227 addr->transport->driver_name,
2229 (msb == 0)? "terminated by signal" : "exit code",
2233 /* If SPECIAL_WARN is set in the top address, send a warning message. */
2235 if (addr->special_action == SPECIAL_WARN &&
2236 addr->transport->warn_message != NULL)
2239 uschar *warn_message;
2241 DEBUG(D_deliver) debug_printf("Warning message requested by transport\n");
2243 warn_message = expand_string(addr->transport->warn_message);
2244 if (warn_message == NULL)
2245 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand \"%s\" (warning "
2246 "message for %s transport): %s", addr->transport->warn_message,
2247 addr->transport->name, expand_string_message);
2250 pid_t pid = child_open_exim(&fd);
2253 FILE *f = fdopen(fd, "wb");
2254 if (errors_reply_to != NULL &&
2255 !contains_header(US"Reply-To", warn_message))
2256 fprintf(f, "Reply-To: %s\n", errors_reply_to);
2257 fprintf(f, "Auto-Submitted: auto-replied\n");
2258 if (!contains_header(US"From", warn_message)) moan_write_from(f);
2259 fprintf(f, "%s", CS warn_message);
2261 /* Close and wait for child process to complete, without a timeout. */
2264 (void)child_close(pid, 0);
2268 addr->special_action = SPECIAL_NONE;
2274 /*************************************************
2275 * Do local deliveries *
2276 *************************************************/
2278 /* This function processes the list of addresses in addr_local. True local
2279 deliveries are always done one address at a time. However, local deliveries can
2280 be batched up in some cases. Typically this is when writing batched SMTP output
2281 files for use by some external transport mechanism, or when running local
2282 deliveries over LMTP.
2289 do_local_deliveries(void)
2292 open_db *dbm_file = NULL;
2293 time_t now = time(NULL);
2295 /* Loop until we have exhausted the supply of local deliveries */
2297 while (addr_local != NULL)
2299 time_t delivery_start;
2301 address_item *addr2, *addr3, *nextaddr;
2302 int logflags = LOG_MAIN;
2303 int logchar = dont_deliver? '*' : '=';
2304 transport_instance *tp;
2306 /* Pick the first undelivered address off the chain */
2308 address_item *addr = addr_local;
2309 addr_local = addr->next;
2312 DEBUG(D_deliver|D_transport)
2313 debug_printf("--------> %s <--------\n", addr->address);
2315 /* An internal disaster if there is no transport. Should not occur! */
2317 if ((tp = addr->transport) == NULL)
2319 logflags |= LOG_PANIC;
2320 disable_logging = FALSE; /* Jic */
2322 (addr->router != NULL)?
2323 string_sprintf("No transport set by %s router", addr->router->name)
2325 string_sprintf("No transport set by system filter");
2326 post_process_one(addr, DEFER, logflags, DTYPE_TRANSPORT, 0);
2330 /* Check that this base address hasn't previously been delivered to this
2331 transport. The check is necessary at this point to handle homonymic addresses
2332 correctly in cases where the pattern of redirection changes between delivery
2333 attempts. Non-homonymic previous delivery is detected earlier, at routing
2336 if (previously_transported(addr, FALSE)) continue;
2338 /* There are weird cases where logging is disabled */
2340 disable_logging = tp->disable_logging;
2342 /* Check for batched addresses and possible amalgamation. Skip all the work
2343 if either batch_max <= 1 or there aren't any other addresses for local
2346 if (tp->batch_max > 1 && addr_local != NULL)
2348 int batch_count = 1;
2349 BOOL uses_dom = readconf_depends((driver_instance *)tp, US"domain");
2350 BOOL uses_lp = (testflag(addr, af_pfr) &&
2351 (testflag(addr, af_file) || addr->local_part[0] == '|')) ||
2352 readconf_depends((driver_instance *)tp, US"local_part");
2353 uschar *batch_id = NULL;
2354 address_item **anchor = &addr_local;
2355 address_item *last = addr;
2358 /* Expand the batch_id string for comparison with other addresses.
2359 Expansion failure suppresses batching. */
2361 if (tp->batch_id != NULL)
2363 deliver_set_expansions(addr);
2364 batch_id = expand_string(tp->batch_id);
2365 deliver_set_expansions(NULL);
2366 if (batch_id == NULL)
2368 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand batch_id option "
2369 "in %s transport (%s): %s", tp->name, addr->address,
2370 expand_string_message);
2371 batch_count = tp->batch_max;
2375 /* Until we reach the batch_max limit, pick off addresses which have the
2376 same characteristics. These are:
2379 not previously delivered (see comment about 50 lines above)
2380 same local part if the transport's configuration contains $local_part
2381 or if this is a file or pipe delivery from a redirection
2382 same domain if the transport's configuration contains $domain
2384 same additional headers
2385 same headers to be removed
2386 same uid/gid for running the transport
2387 same first host if a host list is set
2390 while ((next = *anchor) != NULL && batch_count < tp->batch_max)
2393 tp == next->transport &&
2394 !previously_transported(next, TRUE) &&
2395 (addr->flags & (af_pfr|af_file)) == (next->flags & (af_pfr|af_file)) &&
2396 (!uses_lp || Ustrcmp(next->local_part, addr->local_part) == 0) &&
2397 (!uses_dom || Ustrcmp(next->domain, addr->domain) == 0) &&
2398 same_strings(next->p.errors_address, addr->p.errors_address) &&
2399 same_headers(next->p.extra_headers, addr->p.extra_headers) &&
2400 same_strings(next->p.remove_headers, addr->p.remove_headers) &&
2401 same_ugid(tp, addr, next) &&
2402 ((addr->host_list == NULL && next->host_list == NULL) ||
2403 (addr->host_list != NULL && next->host_list != NULL &&
2404 Ustrcmp(addr->host_list->name, next->host_list->name) == 0));
2406 /* If the transport has a batch_id setting, batch_id will be non-NULL
2407 from the expansion outside the loop. Expand for this address and compare.
2408 Expansion failure makes this address ineligible for batching. */
2410 if (ok && batch_id != NULL)
2413 address_item *save_nextnext = next->next;
2414 next->next = NULL; /* Expansion for a single address */
2415 deliver_set_expansions(next);
2416 next->next = save_nextnext;
2417 bid = expand_string(tp->batch_id);
2418 deliver_set_expansions(NULL);
2421 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand batch_id option "
2422 "in %s transport (%s): %s", tp->name, next->address,
2423 expand_string_message);
2426 else ok = (Ustrcmp(batch_id, bid) == 0);
2429 /* Take address into batch if OK. */
2433 *anchor = next->next; /* Include the address */
2439 else anchor = &(next->next); /* Skip the address */
2443 /* We now have one or more addresses that can be delivered in a batch. Check
2444 whether the transport is prepared to accept a message of this size. If not,
2445 fail them all forthwith. If the expansion fails, or does not yield an
2446 integer, defer delivery. */
2448 if (tp->message_size_limit != NULL)
2450 int rc = check_message_size(tp, addr);
2453 replicate_status(addr);
2454 while (addr != NULL)
2457 post_process_one(addr, rc, logflags, DTYPE_TRANSPORT, 0);
2460 continue; /* With next batch of addresses */
2464 /* If we are not running the queue, or if forcing, all deliveries will be
2465 attempted. Otherwise, we must respect the retry times for each address. Even
2466 when not doing this, we need to set up the retry key string, and determine
2467 whether a retry record exists, because after a successful delivery, a delete
2468 retry item must be set up. Keep the retry database open only for the duration
2469 of these checks, rather than for all local deliveries, because some local
2470 deliveries (e.g. to pipes) can take a substantial time. */
2472 dbm_file = dbfn_open(US"retry", O_RDONLY, &dbblock, FALSE);
2473 if (dbm_file == NULL)
2475 DEBUG(D_deliver|D_retry|D_hints_lookup)
2476 debug_printf("no retry data available\n");
2481 while (addr2 != NULL)
2483 BOOL ok = TRUE; /* to deliver this address */
2486 /* Set up the retry key to include the domain or not, and change its
2487 leading character from "R" to "T". Must make a copy before doing this,
2488 because the old key may be pointed to from a "delete" retry item after
2491 retry_key = string_copy(
2492 (tp->retry_use_local_part)? addr2->address_retry_key :
2493 addr2->domain_retry_key);
2496 /* Inspect the retry data. If there is no hints file, delivery happens. */
2498 if (dbm_file != NULL)
2500 dbdata_retry *retry_record = dbfn_read(dbm_file, retry_key);
2502 /* If there is no retry record, delivery happens. If there is,
2503 remember it exists so it can be deleted after a successful delivery. */
2505 if (retry_record != NULL)
2507 setflag(addr2, af_lt_retry_exists);
2509 /* A retry record exists for this address. If queue running and not
2510 forcing, inspect its contents. If the record is too old, or if its
2511 retry time has come, or if it has passed its cutoff time, delivery
2516 debug_printf("retry record exists: age=%s ",
2517 readconf_printtime(now - retry_record->time_stamp));
2518 debug_printf("(max %s)\n", readconf_printtime(retry_data_expire));
2519 debug_printf(" time to retry = %s expired = %d\n",
2520 readconf_printtime(retry_record->next_try - now),
2521 retry_record->expired);
2524 if (queue_running && !deliver_force)
2526 ok = (now - retry_record->time_stamp > retry_data_expire) ||
2527 (now >= retry_record->next_try) ||
2528 retry_record->expired;
2530 /* If we haven't reached the retry time, there is one more check
2531 to do, which is for the ultimate address timeout. */
2534 ok = retry_ultimate_address_timeout(retry_key, addr2->domain,
2538 else DEBUG(D_retry) debug_printf("no retry record exists\n");
2541 /* This address is to be delivered. Leave it on the chain. */
2546 addr2 = addr2->next;
2549 /* This address is to be deferred. Take it out of the chain, and
2550 post-process it as complete. Must take it out of the chain first,
2551 because post processing puts it on another chain. */
2555 address_item *this = addr2;
2556 this->message = US"Retry time not yet reached";
2557 this->basic_errno = ERRNO_LRETRY;
2558 if (addr3 == NULL) addr2 = addr = addr2->next;
2559 else addr2 = addr3->next = addr2->next;
2560 post_process_one(this, DEFER, logflags, DTYPE_TRANSPORT, 0);
2564 if (dbm_file != NULL) dbfn_close(dbm_file);
2566 /* If there are no addresses left on the chain, they all deferred. Loop
2567 for the next set of addresses. */
2569 if (addr == NULL) continue;
2571 /* So, finally, we do have some addresses that can be passed to the
2572 transport. Before doing so, set up variables that are relevant to a
2575 deliver_set_expansions(addr);
2576 delivery_start = time(NULL);
2577 deliver_local(addr, FALSE);
2578 deliver_time = (int)(time(NULL) - delivery_start);
2580 /* If a shadow transport (which must perforce be another local transport), is
2581 defined, and its condition is met, we must pass the message to the shadow
2582 too, but only those addresses that succeeded. We do this by making a new
2583 chain of addresses - also to keep the original chain uncontaminated. We must
2584 use a chain rather than doing it one by one, because the shadow transport may
2587 NOTE: if the condition fails because of a lookup defer, there is nothing we
2590 if (tp->shadow != NULL &&
2591 (tp->shadow_condition == NULL ||
2592 expand_check_condition(tp->shadow_condition, tp->name, US"transport")))
2594 transport_instance *stp;
2595 address_item *shadow_addr = NULL;
2596 address_item **last = &shadow_addr;
2598 for (stp = transports; stp != NULL; stp = stp->next)
2599 if (Ustrcmp(stp->name, tp->shadow) == 0) break;
2602 log_write(0, LOG_MAIN|LOG_PANIC, "shadow transport \"%s\" not found ",
2605 /* Pick off the addresses that have succeeded, and make clones. Put into
2606 the shadow_message field a pointer to the shadow_message field of the real
2609 else for (addr2 = addr; addr2 != NULL; addr2 = addr2->next)
2611 if (addr2->transport_return != OK) continue;
2612 addr3 = store_get(sizeof(address_item));
2615 addr3->shadow_message = (uschar *)(&(addr2->shadow_message));
2616 addr3->transport = stp;
2617 addr3->transport_return = DEFER;
2618 addr3->return_filename = NULL;
2619 addr3->return_file = -1;
2621 last = &(addr3->next);
2624 /* If we found any addresses to shadow, run the delivery, and stick any
2625 message back into the shadow_message field in the original. */
2627 if (shadow_addr != NULL)
2629 int save_count = transport_count;
2631 DEBUG(D_deliver|D_transport)
2632 debug_printf(">>>>>>>>>>>>>>>> Shadow delivery >>>>>>>>>>>>>>>>\n");
2633 deliver_local(shadow_addr, TRUE);
2635 for(; shadow_addr != NULL; shadow_addr = shadow_addr->next)
2637 int sresult = shadow_addr->transport_return;
2638 *((uschar **)(shadow_addr->shadow_message)) = (sresult == OK)?
2639 string_sprintf(" ST=%s", stp->name) :
2640 string_sprintf(" ST=%s (%s%s%s)", stp->name,
2641 (shadow_addr->basic_errno <= 0)?
2642 US"" : US strerror(shadow_addr->basic_errno),
2643 (shadow_addr->basic_errno <= 0 || shadow_addr->message == NULL)?
2645 (shadow_addr->message != NULL)? shadow_addr->message :
2646 (shadow_addr->basic_errno <= 0)? US"unknown error" : US"");
2648 DEBUG(D_deliver|D_transport)
2649 debug_printf("%s shadow transport returned %s for %s\n",
2651 (sresult == OK)? "OK" :
2652 (sresult == DEFER)? "DEFER" :
2653 (sresult == FAIL)? "FAIL" :
2654 (sresult == PANIC)? "PANIC" : "?",
2655 shadow_addr->address);
2658 DEBUG(D_deliver|D_transport)
2659 debug_printf(">>>>>>>>>>>>>>>> End shadow delivery >>>>>>>>>>>>>>>>\n");
2661 transport_count = save_count; /* Restore original transport count */
2665 /* Cancel the expansions that were set up for the delivery. */
2667 deliver_set_expansions(NULL);
2669 /* Now we can process the results of the real transport. We must take each
2670 address off the chain first, because post_process_one() puts it on another
2673 for (addr2 = addr; addr2 != NULL; addr2 = nextaddr)
2675 int result = addr2->transport_return;
2676 nextaddr = addr2->next;
2678 DEBUG(D_deliver|D_transport)
2679 debug_printf("%s transport returned %s for %s\n",
2681 (result == OK)? "OK" :
2682 (result == DEFER)? "DEFER" :
2683 (result == FAIL)? "FAIL" :
2684 (result == PANIC)? "PANIC" : "?",
2687 /* If there is a retry_record, or if delivery is deferred, build a retry
2688 item for setting a new retry time or deleting the old retry record from
2689 the database. These items are handled all together after all addresses
2690 have been handled (so the database is open just for a short time for
2693 if (result == DEFER || testflag(addr2, af_lt_retry_exists))
2695 int flags = (result == DEFER)? 0 : rf_delete;
2696 uschar *retry_key = string_copy((tp->retry_use_local_part)?
2697 addr2->address_retry_key : addr2->domain_retry_key);
2699 retry_add_item(addr2, retry_key, flags);
2702 /* Done with this address */
2704 if (result == OK) addr2->more_errno = deliver_time;
2705 post_process_one(addr2, result, logflags, DTYPE_TRANSPORT, logchar);
2707 /* If a pipe delivery generated text to be sent back, the result may be
2708 changed to FAIL, and we must copy this for subsequent addresses in the
2711 if (addr2->transport_return != result)
2713 for (addr3 = nextaddr; addr3 != NULL; addr3 = addr3->next)
2715 addr3->transport_return = addr2->transport_return;
2716 addr3->basic_errno = addr2->basic_errno;
2717 addr3->message = addr2->message;
2719 result = addr2->transport_return;
2722 /* Whether or not the result was changed to FAIL, we need to copy the
2723 return_file value from the first address into all the addresses of the
2724 batch, so they are all listed in the error message. */
2726 addr2->return_file = addr->return_file;
2728 /* Change log character for recording successful deliveries. */
2730 if (result == OK) logchar = '-';
2732 } /* Loop back for next batch of addresses */
2738 /*************************************************
2739 * Sort remote deliveries *
2740 *************************************************/
2742 /* This function is called if remote_sort_domains is set. It arranges that the
2743 chain of addresses for remote deliveries is ordered according to the strings
2744 specified. Try to make this shuffling reasonably efficient by handling
2745 sequences of addresses rather than just single ones.
2752 sort_remote_deliveries(void)
2755 address_item **aptr = &addr_remote;
2756 uschar *listptr = remote_sort_domains;
2760 while (*aptr != NULL &&
2761 (pattern = string_nextinlist(&listptr, &sep, patbuf, sizeof(patbuf)))
2764 address_item *moved = NULL;
2765 address_item **bptr = &moved;
2767 while (*aptr != NULL)
2769 address_item **next;
2770 deliver_domain = (*aptr)->domain; /* set $domain */
2771 if (match_isinlist(deliver_domain, &pattern, UCHAR_MAX+1,
2772 &domainlist_anchor, NULL, MCL_DOMAIN, TRUE, NULL) == OK)
2774 aptr = &((*aptr)->next);
2778 next = &((*aptr)->next);
2779 while (*next != NULL &&
2780 (deliver_domain = (*next)->domain, /* Set $domain */
2781 match_isinlist(deliver_domain, &pattern, UCHAR_MAX+1,
2782 &domainlist_anchor, NULL, MCL_DOMAIN, TRUE, NULL)) != OK)
2783 next = &((*next)->next);
2785 /* If the batch of non-matchers is at the end, add on any that were
2786 extracted further up the chain, and end this iteration. Otherwise,
2787 extract them from the chain and hang on the moved chain. */
2799 aptr = &((*aptr)->next);
2802 /* If the loop ended because the final address matched, *aptr will
2803 be NULL. Add on to the end any extracted non-matching addresses. If
2804 *aptr is not NULL, the loop ended via "break" when *next is null, that
2805 is, there was a string of non-matching addresses at the end. In this
2806 case the extracted addresses have already been added on the end. */
2808 if (*aptr == NULL) *aptr = moved;
2814 debug_printf("remote addresses after sorting:\n");
2815 for (addr = addr_remote; addr != NULL; addr = addr->next)
2816 debug_printf(" %s\n", addr->address);
2822 /*************************************************
2823 * Read from pipe for remote delivery subprocess *
2824 *************************************************/
2826 /* This function is called when the subprocess is complete, but can also be
2827 called before it is complete, in order to empty a pipe that is full (to prevent
2828 deadlock). It must therefore keep track of its progress in the parlist data
2831 We read the pipe to get the delivery status codes and a possible error message
2832 for each address, optionally preceded by unusability data for the hosts and
2833 also by optional retry data.
2835 Read in large chunks into the big buffer and then scan through, interpreting
2836 the data therein. In most cases, only a single read will be necessary. No
2837 individual item will ever be anywhere near 2500 bytes in length, so by ensuring
2838 that we read the next chunk when there is less than 2500 bytes left in the
2839 non-final chunk, we can assume each item is complete in the buffer before
2840 handling it. Each item is written using a single write(), which is atomic for
2841 small items (less than PIPE_BUF, which seems to be at least 512 in any Unix and
2842 often bigger) so even if we are reading while the subprocess is still going, we
2843 should never have only a partial item in the buffer.
2846 poffset the offset of the parlist item
2847 eop TRUE if the process has completed
2849 Returns: TRUE if the terminating 'Z' item has been read,
2850 or there has been a disaster (i.e. no more data needed);
2855 par_read_pipe(int poffset, BOOL eop)
2858 pardata *p = parlist + poffset;
2859 address_item *addrlist = p->addrlist;
2860 address_item *addr = p->addr;
2863 uschar *endptr = big_buffer;
2864 uschar *ptr = endptr;
2865 uschar *msg = p->msg;
2866 BOOL done = p->done;
2867 BOOL unfinished = TRUE;
2869 /* Loop through all items, reading from the pipe when necessary. The pipe
2870 is set up to be non-blocking, but there are two different Unix mechanisms in
2871 use. Exim uses O_NONBLOCK if it is defined. This returns 0 for end of file,
2872 and EAGAIN for no more data. If O_NONBLOCK is not defined, Exim uses O_NDELAY,
2873 which returns 0 for both end of file and no more data. We distinguish the
2874 two cases by taking 0 as end of file only when we know the process has
2877 Each separate item is written to the pipe in a single write(), and as they are
2878 all short items, the writes will all be atomic and we should never find
2879 ourselves in the position of having read an incomplete item. "Short" in this
2880 case can mean up to about 1K in the case when there is a long error message
2881 associated with an address. */
2883 DEBUG(D_deliver) debug_printf("reading pipe for subprocess %d (%s)\n",
2884 (int)p->pid, eop? "ended" : "not ended");
2888 retry_item *r, **rp;
2889 int remaining = endptr - ptr;
2891 /* Read (first time) or top up the chars in the buffer if necessary.
2892 There will be only one read if we get all the available data (i.e. don't
2893 fill the buffer completely). */
2895 if (remaining < 2500 && unfinished)
2898 int available = big_buffer_size - remaining;
2900 if (remaining > 0) memmove(big_buffer, ptr, remaining);
2903 endptr = big_buffer + remaining;
2904 len = read(fd, endptr, available);
2906 DEBUG(D_deliver) debug_printf("read() yielded %d\n", len);
2908 /* If the result is EAGAIN and the process is not complete, just
2909 stop reading any more and process what we have already. */
2913 if (!eop && errno == EAGAIN) len = 0; else
2915 msg = string_sprintf("failed to read pipe from transport process "
2916 "%d for transport %s: %s", pid, addr->transport->driver_name,
2922 /* If the length is zero (eof or no-more-data), just process what we
2923 already have. Note that if the process is still running and we have
2924 read all the data in the pipe (but less that "available") then we
2925 won't read any more, as "unfinished" will get set FALSE. */
2928 unfinished = len == available;
2931 /* If we are at the end of the available data, exit the loop. */
2933 if (ptr >= endptr) break;
2935 /* Handle each possible type of item, assuming the complete item is
2936 available in store. */
2940 /* Host items exist only if any hosts were marked unusable. Match
2941 up by checking the IP address. */
2944 for (h = addrlist->host_list; h != NULL; h = h->next)
2946 if (h->address == NULL || Ustrcmp(h->address, ptr+2) != 0) continue;
2954 /* Retry items are sent in a preceding R item for each address. This is
2955 kept separate to keep each message short enough to guarantee it won't
2956 be split in the pipe. Hopefully, in the majority of cases, there won't in
2957 fact be any retry items at all.
2959 The complete set of retry items might include an item to delete a
2960 routing retry if there was a previous routing delay. However, routing
2961 retries are also used when a remote transport identifies an address error.
2962 In that case, there may also be an "add" item for the same key. Arrange
2963 that a "delete" item is dropped in favour of an "add" item. */
2966 if (addr == NULL) goto ADDR_MISMATCH;
2968 DEBUG(D_deliver|D_retry)
2969 debug_printf("reading retry information for %s from subprocess\n",
2972 /* Cut out any "delete" items on the list. */
2974 for (rp = &(addr->retries); (r = *rp) != NULL; rp = &(r->next))
2976 if (Ustrcmp(r->key, ptr+1) == 0) /* Found item with same key */
2978 if ((r->flags & rf_delete) == 0) break; /* It was not "delete" */
2979 *rp = r->next; /* Excise a delete item */
2980 DEBUG(D_deliver|D_retry)
2981 debug_printf(" existing delete item dropped\n");
2985 /* We want to add a delete item only if there is no non-delete item;
2986 however we still have to step ptr through the data. */
2988 if (r == NULL || (*ptr & rf_delete) == 0)
2990 r = store_get(sizeof(retry_item));
2991 r->next = addr->retries;
2994 r->key = string_copy(ptr);
2996 memcpy(&(r->basic_errno), ptr, sizeof(r->basic_errno));
2997 ptr += sizeof(r->basic_errno);
2998 memcpy(&(r->more_errno), ptr, sizeof(r->more_errno));
2999 ptr += sizeof(r->more_errno);
3000 r->message = (*ptr)? string_copy(ptr) : NULL;
3001 DEBUG(D_deliver|D_retry)
3002 debug_printf(" added %s item\n",
3003 ((r->flags & rf_delete) == 0)? "retry" : "delete");
3008 DEBUG(D_deliver|D_retry)
3009 debug_printf(" delete item not added: non-delete item exists\n");
3012 ptr += sizeof(r->basic_errno) + sizeof(r->more_errno);
3018 /* Put the amount of data written into the parlist block */
3021 memcpy(&(p->transport_count), ptr, sizeof(transport_count));
3022 ptr += sizeof(transport_count);
3025 /* Address items are in the order of items on the address chain. We
3026 remember the current address value in case this function is called
3027 several times to empty the pipe in stages. Information about delivery
3028 over TLS is sent in a preceding X item for each address. We don't put
3029 it in with the other info, in order to keep each message short enough to
3030 guarantee it won't be split in the pipe. */
3034 if (addr == NULL) goto ADDR_MISMATCH; /* Below, in 'A' handler */
3038 addr->cipher = NULL;
3039 addr->peerdn = NULL;
3042 addr->cipher = string_copy(ptr);
3045 addr->peerdn = string_copy(ptr);
3049 addr->peercert = NULL;
3051 (void) tls_import_cert(ptr, &addr->peercert);
3055 addr->ourcert = NULL;
3057 (void) tls_import_cert(ptr, &addr->ourcert);
3060 # ifndef DISABLE_OCSP
3062 addr->ocsp = OCSP_NOT_REQ;
3064 addr->ocsp = *ptr - '0';
3070 #endif /*SUPPORT_TLS*/
3072 case 'C': /* client authenticator information */
3076 addr->authenticator = (*ptr)? string_copy(ptr) : NULL;
3079 addr->auth_id = (*ptr)? string_copy(ptr) : NULL;
3082 addr->auth_sndr = (*ptr)? string_copy(ptr) : NULL;
3088 #ifndef DISABLE_PRDR
3090 addr->flags |= af_prdr_used;
3094 #ifdef EXPERIMENTAL_DSN
3096 if (addr == NULL) break;
3097 memcpy(&(addr->dsn_aware), ptr, sizeof(addr->dsn_aware));
3098 ptr += sizeof(addr->dsn_aware);
3099 DEBUG(D_deliver) debug_printf("DSN read: addr->dsn_aware = %d\n", addr->dsn_aware);
3107 msg = string_sprintf("address count mismatch for data read from pipe "
3108 "for transport process %d for transport %s", pid,
3109 addrlist->transport->driver_name);
3114 addr->transport_return = *ptr++;
3115 addr->special_action = *ptr++;
3116 memcpy(&(addr->basic_errno), ptr, sizeof(addr->basic_errno));
3117 ptr += sizeof(addr->basic_errno);
3118 memcpy(&(addr->more_errno), ptr, sizeof(addr->more_errno));
3119 ptr += sizeof(addr->more_errno);
3120 memcpy(&(addr->flags), ptr, sizeof(addr->flags));
3121 ptr += sizeof(addr->flags);
3122 addr->message = (*ptr)? string_copy(ptr) : NULL;
3124 addr->user_message = (*ptr)? string_copy(ptr) : NULL;
3127 /* Always two strings for host information, followed by the port number and DNSSEC mark */
3131 h = store_get(sizeof(host_item));
3132 h->name = string_copy(ptr);
3134 h->address = string_copy(ptr);
3136 memcpy(&(h->port), ptr, sizeof(h->port));
3137 ptr += sizeof(h->port);
3138 h->dnssec = *ptr == '2' ? DS_YES
3139 : *ptr == '1' ? DS_NO
3142 addr->host_used = h;
3146 /* Finished with this address */
3151 /* Z marks the logical end of the data. It is followed by '0' if
3152 continue_transport was NULL at the end of transporting, otherwise '1'.
3153 We need to know when it becomes NULL during a delivery down a passed SMTP
3154 channel so that we don't try to pass anything more down it. Of course, for
3155 most normal messages it will remain NULL all the time. */
3160 continue_transport = NULL;
3161 continue_hostname = NULL;
3164 DEBUG(D_deliver) debug_printf("Z%c item read\n", *ptr);
3167 /* Anything else is a disaster. */
3170 msg = string_sprintf("malformed data (%d) read from pipe for transport "
3171 "process %d for transport %s", ptr[-1], pid,
3172 addr->transport->driver_name);
3178 /* The done flag is inspected externally, to determine whether or not to
3179 call the function again when the process finishes. */
3183 /* If the process hadn't finished, and we haven't seen the end of the data
3184 or suffered a disaster, update the rest of the state, and return FALSE to
3185 indicate "not finished". */
3194 /* Close our end of the pipe, to prevent deadlock if the far end is still
3195 pushing stuff into it. */
3200 /* If we have finished without error, but haven't had data for every address,
3201 something is wrong. */
3203 if (msg == NULL && addr != NULL)
3204 msg = string_sprintf("insufficient address data read from pipe "
3205 "for transport process %d for transport %s", pid,
3206 addr->transport->driver_name);
3208 /* If an error message is set, something has gone wrong in getting back
3209 the delivery data. Put the message into each address and freeze it. */
3213 for (addr = addrlist; addr != NULL; addr = addr->next)
3215 addr->transport_return = DEFER;
3216 addr->special_action = SPECIAL_FREEZE;
3217 addr->message = msg;
3221 /* Return TRUE to indicate we have got all we need from this process, even
3222 if it hasn't actually finished yet. */
3229 /*************************************************
3230 * Post-process a set of remote addresses *
3231 *************************************************/
3233 /* Do what has to be done immediately after a remote delivery for each set of
3234 addresses, then re-write the spool if necessary. Note that post_process_one
3235 puts the address on an appropriate queue; hence we must fish off the next
3236 one first. This function is also called if there is a problem with setting
3237 up a subprocess to do a remote delivery in parallel. In this case, the final
3238 argument contains a message, and the action must be forced to DEFER.
3241 addr pointer to chain of address items
3242 logflags flags for logging
3243 msg NULL for normal cases; -> error message for unexpected problems
3244 fallback TRUE if processing fallback hosts
3250 remote_post_process(address_item *addr, int logflags, uschar *msg,
3255 /* If any host addresses were found to be unusable, add them to the unusable
3256 tree so that subsequent deliveries don't try them. */
3258 for (h = addr->host_list; h != NULL; h = h->next)
3260 if (h->address == NULL) continue;
3261 if (h->status >= hstatus_unusable) tree_add_unusable(h);
3264 /* Now handle each address on the chain. The transport has placed '=' or '-'
3265 into the special_action field for each successful delivery. */
3267 while (addr != NULL)
3269 address_item *next = addr->next;
3271 /* If msg == NULL (normal processing) and the result is DEFER and we are
3272 processing the main hosts and there are fallback hosts available, put the
3273 address on the list for fallback delivery. */
3275 if (addr->transport_return == DEFER &&
3276 addr->fallback_hosts != NULL &&
3280 addr->host_list = addr->fallback_hosts;
3281 addr->next = addr_fallback;
3282 addr_fallback = addr;
3283 DEBUG(D_deliver) debug_printf("%s queued for fallback host(s)\n", addr->address);
3286 /* If msg is set (=> unexpected problem), set it in the address before
3287 doing the ordinary post processing. */
3293 addr->message = msg;
3294 addr->transport_return = DEFER;
3296 (void)post_process_one(addr, addr->transport_return, logflags,
3297 DTYPE_TRANSPORT, addr->special_action);
3305 /* If we have just delivered down a passed SMTP channel, and that was
3306 the last address, the channel will have been closed down. Now that
3307 we have logged that delivery, set continue_sequence to 1 so that
3308 any subsequent deliveries don't get "*" incorrectly logged. */
3310 if (continue_transport == NULL) continue_sequence = 1;
3315 /*************************************************
3316 * Wait for one remote delivery subprocess *
3317 *************************************************/
3319 /* This function is called while doing remote deliveries when either the
3320 maximum number of processes exist and we need one to complete so that another
3321 can be created, or when waiting for the last ones to complete. It must wait for
3322 the completion of one subprocess, empty the control block slot, and return a
3323 pointer to the address chain.
3326 Returns: pointer to the chain of addresses handled by the process;
3327 NULL if no subprocess found - this is an unexpected error
3330 static address_item *
3333 int poffset, status;
3334 address_item *addr, *addrlist;
3337 set_process_info("delivering %s: waiting for a remote delivery subprocess "
3338 "to finish", message_id);
3340 /* Loop until either a subprocess completes, or there are no subprocesses in
3341 existence - in which case give an error return. We cannot proceed just by
3342 waiting for a completion, because a subprocess may have filled up its pipe, and
3343 be waiting for it to be emptied. Therefore, if no processes have finished, we
3344 wait for one of the pipes to acquire some data by calling select(), with a
3345 timeout just in case.
3347 The simple approach is just to iterate after reading data from a ready pipe.
3348 This leads to non-ideal behaviour when the subprocess has written its final Z
3349 item, closed the pipe, and is in the process of exiting (the common case). A
3350 call to waitpid() yields nothing completed, but select() shows the pipe ready -
3351 reading it yields EOF, so you end up with busy-waiting until the subprocess has
3354 To avoid this, if all the data that is needed has been read from a subprocess
3355 after select(), an explicit wait() for it is done. We know that all it is doing
3356 is writing to the pipe and then exiting, so the wait should not be long.
3358 The non-blocking waitpid() is to some extent just insurance; if we could
3359 reliably detect end-of-file on the pipe, we could always know when to do a
3360 blocking wait() for a completed process. However, because some systems use
3361 NDELAY, which doesn't distinguish between EOF and pipe empty, it is easier to
3362 use code that functions without the need to recognize EOF.
3364 There's a double loop here just in case we end up with a process that is not in
3365 the list of remote delivery processes. Something has obviously gone wrong if
3366 this is the case. (For example, a process that is incorrectly left over from
3367 routing or local deliveries might be found.) The damage can be minimized by
3368 looping back and looking for another process. If there aren't any, the error
3369 return will happen. */
3371 for (;;) /* Normally we do not repeat this loop */
3373 while ((pid = waitpid(-1, &status, WNOHANG)) <= 0)
3376 fd_set select_pipes;
3377 int maxpipe, readycount;
3379 /* A return value of -1 can mean several things. If errno != ECHILD, it
3380 either means invalid options (which we discount), or that this process was
3381 interrupted by a signal. Just loop to try the waitpid() again.
3383 If errno == ECHILD, waitpid() is telling us that there are no subprocesses
3384 in existence. This should never happen, and is an unexpected error.
3385 However, there is a nasty complication when running under Linux. If "strace
3386 -f" is being used under Linux to trace this process and its children,
3387 subprocesses are "stolen" from their parents and become the children of the
3388 tracing process. A general wait such as the one we've just obeyed returns
3389 as if there are no children while subprocesses are running. Once a
3390 subprocess completes, it is restored to the parent, and waitpid(-1) finds
3391 it. Thanks to Joachim Wieland for finding all this out and suggesting a
3394 This does not happen using "truss" on Solaris, nor (I think) with other
3395 tracing facilities on other OS. It seems to be specific to Linux.
3397 What we do to get round this is to use kill() to see if any of our
3398 subprocesses are still in existence. If kill() gives an OK return, we know
3399 it must be for one of our processes - it can't be for a re-use of the pid,
3400 because if our process had finished, waitpid() would have found it. If any
3401 of our subprocesses are in existence, we proceed to use select() as if
3402 waitpid() had returned zero. I think this is safe. */
3406 if (errno != ECHILD) continue; /* Repeats the waitpid() */
3409 debug_printf("waitpid() returned -1/ECHILD: checking explicitly "
3410 "for process existence\n");
3412 for (poffset = 0; poffset < remote_max_parallel; poffset++)
3414 if ((pid = parlist[poffset].pid) != 0 && kill(pid, 0) == 0)
3416 DEBUG(D_deliver) debug_printf("process %d still exists: assume "
3417 "stolen by strace\n", (int)pid);
3418 break; /* With poffset set */
3422 if (poffset >= remote_max_parallel)
3424 DEBUG(D_deliver) debug_printf("*** no delivery children found\n");
3425 return NULL; /* This is the error return */
3429 /* A pid value greater than 0 breaks the "while" loop. A negative value has
3430 been handled above. A return value of zero means that there is at least one
3431 subprocess, but there are no completed subprocesses. See if any pipes are
3432 ready with any data for reading. */
3434 DEBUG(D_deliver) debug_printf("selecting on subprocess pipes\n");
3437 FD_ZERO(&select_pipes);
3438 for (poffset = 0; poffset < remote_max_parallel; poffset++)
3440 if (parlist[poffset].pid != 0)
3442 int fd = parlist[poffset].fd;
3443 FD_SET(fd, &select_pipes);
3444 if (fd > maxpipe) maxpipe = fd;
3448 /* Stick in a 60-second timeout, just in case. */
3453 readycount = select(maxpipe + 1, (SELECT_ARG2_TYPE *)&select_pipes,
3456 /* Scan through the pipes and read any that are ready; use the count
3457 returned by select() to stop when there are no more. Select() can return
3458 with no processes (e.g. if interrupted). This shouldn't matter.
3460 If par_read_pipe() returns TRUE, it means that either the terminating Z was
3461 read, or there was a disaster. In either case, we are finished with this
3462 process. Do an explicit wait() for the process and break the main loop if
3465 It turns out that we have to deal with the case of an interrupted system
3466 call, which can happen on some operating systems if the signal handling is
3467 set up to do that by default. */
3470 readycount > 0 && poffset < remote_max_parallel;
3473 if ((pid = parlist[poffset].pid) != 0 &&
3474 FD_ISSET(parlist[poffset].fd, &select_pipes))
3477 if (par_read_pipe(poffset, FALSE)) /* Finished with this pipe */
3479 for (;;) /* Loop for signals */
3481 pid_t endedpid = waitpid(pid, &status, 0);
3482 if (endedpid == pid) goto PROCESS_DONE;
3483 if (endedpid != (pid_t)(-1) || errno != EINTR)
3484 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Unexpected error return "
3485 "%d (errno = %d) from waitpid() for process %d",
3486 (int)endedpid, errno, (int)pid);
3492 /* Now go back and look for a completed subprocess again. */
3495 /* A completed process was detected by the non-blocking waitpid(). Find the
3496 data block that corresponds to this subprocess. */
3498 for (poffset = 0; poffset < remote_max_parallel; poffset++)
3499 if (pid == parlist[poffset].pid) break;
3501 /* Found the data block; this is a known remote delivery process. We don't
3502 need to repeat the outer loop. This should be what normally happens. */
3504 if (poffset < remote_max_parallel) break;
3506 /* This situation is an error, but it's probably better to carry on looking
3507 for another process than to give up (as we used to do). */
3509 log_write(0, LOG_MAIN|LOG_PANIC, "Process %d finished: not found in remote "
3510 "transport process list", pid);
3511 } /* End of the "for" loop */
3513 /* Come here when all the data was completely read after a select(), and
3514 the process in pid has been wait()ed for. */
3521 debug_printf("remote delivery process %d ended\n", (int)pid);
3523 debug_printf("remote delivery process %d ended: status=%04x\n", (int)pid,
3527 set_process_info("delivering %s", message_id);
3529 /* Get the chain of processed addresses */
3531 addrlist = parlist[poffset].addrlist;
3533 /* If the process did not finish cleanly, record an error and freeze (except
3534 for SIGTERM, SIGKILL and SIGQUIT), and also ensure the journal is not removed,
3535 in case the delivery did actually happen. */
3537 if ((status & 0xffff) != 0)
3540 int msb = (status >> 8) & 255;
3541 int lsb = status & 255;
3542 int code = (msb == 0)? (lsb & 0x7f) : msb;
3544 msg = string_sprintf("%s transport process returned non-zero status 0x%04x: "
3546 addrlist->transport->driver_name,
3548 (msb == 0)? "terminated by signal" : "exit code",
3551 if (msb != 0 || (code != SIGTERM && code != SIGKILL && code != SIGQUIT))
3552 addrlist->special_action = SPECIAL_FREEZE;
3554 for (addr = addrlist; addr != NULL; addr = addr->next)
3556 addr->transport_return = DEFER;
3557 addr->message = msg;
3560 remove_journal = FALSE;
3563 /* Else complete reading the pipe to get the result of the delivery, if all
3564 the data has not yet been obtained. */
3566 else if (!parlist[poffset].done) (void)par_read_pipe(poffset, TRUE);
3568 /* Put the data count and return path into globals, mark the data slot unused,
3569 decrement the count of subprocesses, and return the address chain. */
3571 transport_count = parlist[poffset].transport_count;
3572 used_return_path = parlist[poffset].return_path;
3573 parlist[poffset].pid = 0;
3580 /*************************************************
3581 * Wait for subprocesses and post-process *
3582 *************************************************/
3584 /* This function waits for subprocesses until the number that are still running
3585 is below a given threshold. For each complete subprocess, the addresses are
3586 post-processed. If we can't find a running process, there is some shambles.
3587 Better not bomb out, as that might lead to multiple copies of the message. Just
3588 log and proceed as if all done.
3591 max maximum number of subprocesses to leave running
3592 fallback TRUE if processing fallback hosts
3598 par_reduce(int max, BOOL fallback)
3600 while (parcount > max)
3602 address_item *doneaddr = par_wait();
3603 if (doneaddr == NULL)
3605 log_write(0, LOG_MAIN|LOG_PANIC,
3606 "remote delivery process count got out of step");
3609 else remote_post_process(doneaddr, LOG_MAIN, NULL, fallback);
3617 rmt_dlv_checked_write(int fd, void * buf, int size)
3619 int ret = write(fd, buf, size);
3621 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Failed writing transport result to pipe: %s\n",
3622 ret == -1 ? strerror(errno) : "short write");
3625 /*************************************************
3626 * Do remote deliveries *
3627 *************************************************/
3629 /* This function is called to process the addresses in addr_remote. We must
3630 pick off the queue all addresses that have the same transport, remote
3631 destination, and errors address, and hand them to the transport in one go,
3632 subject to some configured limitations. If this is a run to continue delivering
3633 to an existing delivery channel, skip all but those addresses that can go to
3634 that channel. The skipped addresses just get deferred.
3636 If mua_wrapper is set, all addresses must be able to be sent in a single
3637 transaction. If not, this function yields FALSE.
3639 In Exim 4, remote deliveries are always done in separate processes, even
3640 if remote_max_parallel = 1 or if there's only one delivery to do. The reason
3641 is so that the base process can retain privilege. This makes the
3642 implementation of fallback transports feasible (though not initially done.)
3644 We create up to the configured number of subprocesses, each of which passes
3645 back the delivery state via a pipe. (However, when sending down an existing
3646 connection, remote_max_parallel is forced to 1.)
3649 fallback TRUE if processing fallback hosts
3651 Returns: TRUE normally
3652 FALSE if mua_wrapper is set and the addresses cannot all be sent
3657 do_remote_deliveries(BOOL fallback)
3663 parcount = 0; /* Number of executing subprocesses */
3665 /* When sending down an existing channel, only do one delivery at a time.
3666 We use a local variable (parmax) to hold the maximum number of processes;
3667 this gets reduced from remote_max_parallel if we can't create enough pipes. */
3669 if (continue_transport != NULL) remote_max_parallel = 1;
3670 parmax = remote_max_parallel;
3672 /* If the data for keeping a list of processes hasn't yet been
3675 if (parlist == NULL)
3677 parlist = store_get(remote_max_parallel * sizeof(pardata));
3678 for (poffset = 0; poffset < remote_max_parallel; poffset++)
3679 parlist[poffset].pid = 0;
3682 /* Now loop for each remote delivery */
3684 for (delivery_count = 0; addr_remote != NULL; delivery_count++)
3690 int address_count = 1;
3691 int address_count_max;
3693 BOOL use_initgroups;
3694 BOOL pipe_done = FALSE;
3695 transport_instance *tp;
3696 address_item **anchor = &addr_remote;
3697 address_item *addr = addr_remote;
3698 address_item *last = addr;
3701 /* Pull the first address right off the list. */
3703 addr_remote = addr->next;
3706 DEBUG(D_deliver|D_transport)
3707 debug_printf("--------> %s <--------\n", addr->address);
3709 /* If no transport has been set, there has been a big screw-up somewhere. */
3711 if ((tp = addr->transport) == NULL)
3713 disable_logging = FALSE; /* Jic */
3714 remote_post_process(addr, LOG_MAIN|LOG_PANIC,
3715 US"No transport set by router", fallback);
3719 /* Check that this base address hasn't previously been delivered to this
3720 transport. The check is necessary at this point to handle homonymic addresses
3721 correctly in cases where the pattern of redirection changes between delivery
3722 attempts. Non-homonymic previous delivery is detected earlier, at routing
3725 if (previously_transported(addr, FALSE)) continue;
3727 /* Force failure if the message is too big. */
3729 if (tp->message_size_limit != NULL)
3731 int rc = check_message_size(tp, addr);
3734 addr->transport_return = rc;
3735 remote_post_process(addr, LOG_MAIN, NULL, fallback);
3740 /* Get the flag which specifies whether the transport can handle different
3741 domains that nevertheless resolve to the same set of hosts. */
3743 multi_domain = tp->multi_domain;
3745 /* Get the maximum it can handle in one envelope, with zero meaning
3746 unlimited, which is forced for the MUA wrapper case. */
3748 address_count_max = tp->max_addresses;
3749 if (address_count_max == 0 || mua_wrapper) address_count_max = 999999;
3752 /************************************************************************/
3753 /***** This is slightly experimental code, but should be safe. *****/
3755 /* The address_count_max value is the maximum number of addresses that the
3756 transport can send in one envelope. However, the transport must be capable of
3757 dealing with any number of addresses. If the number it gets exceeds its
3758 envelope limitation, it must send multiple copies of the message. This can be
3759 done over a single connection for SMTP, so uses less resources than making
3760 multiple connections. On the other hand, if remote_max_parallel is greater
3761 than one, it is perhaps a good idea to use parallel processing to move the
3762 message faster, even if that results in multiple simultaneous connections to
3765 How can we come to some compromise between these two ideals? What we do is to
3766 limit the number of addresses passed to a single instance of a transport to
3767 the greater of (a) its address limit (rcpt_max for SMTP) and (b) the total
3768 number of addresses routed to remote transports divided by
3769 remote_max_parallel. For example, if the message has 100 remote recipients,
3770 remote max parallel is 2, and rcpt_max is 10, we'd never send more than 50 at
3771 once. But if rcpt_max is 100, we could send up to 100.
3773 Of course, not all the remotely addresses in a message are going to go to the
3774 same set of hosts (except in smarthost configurations), so this is just a
3775 heuristic way of dividing up the work.
3777 Furthermore (1), because this may not be wanted in some cases, and also to
3778 cope with really pathological cases, there is also a limit to the number of
3779 messages that are sent over one connection. This is the same limit that is
3780 used when sending several different messages over the same connection.
3781 Continue_sequence is set when in this situation, to the number sent so
3782 far, including this message.
3784 Furthermore (2), when somebody explicitly sets the maximum value to 1, it
3785 is probably because they are using VERP, in which case they want to pass only
3786 one address at a time to the transport, in order to be able to use
3787 $local_part and $domain in constructing a new return path. We could test for
3788 the use of these variables, but as it is so likely they will be used when the
3789 maximum is 1, we don't bother. Just leave the value alone. */
3791 if (address_count_max != 1 &&
3792 address_count_max < remote_delivery_count/remote_max_parallel)
3794 int new_max = remote_delivery_count/remote_max_parallel;
3795 int message_max = tp->connection_max_messages;
3796 if (connection_max_messages >= 0) message_max = connection_max_messages;
3797 message_max -= continue_sequence - 1;
3798 if (message_max > 0 && new_max > address_count_max * message_max)
3799 new_max = address_count_max * message_max;
3800 address_count_max = new_max;
3803 /************************************************************************/
3806 /* Pick off all addresses which have the same transport, errors address,
3807 destination, and extra headers. In some cases they point to the same host
3808 list, but we also need to check for identical host lists generated from
3809 entirely different domains. The host list pointers can be NULL in the case
3810 where the hosts are defined in the transport. There is also a configured
3811 maximum limit of addresses that can be handled at once (see comments above
3812 for how it is computed). */
3814 while ((next = *anchor) != NULL && address_count < address_count_max)
3816 if ((multi_domain || Ustrcmp(next->domain, addr->domain) == 0)
3818 tp == next->transport
3820 same_hosts(next->host_list, addr->host_list)
3822 same_strings(next->p.errors_address, addr->p.errors_address)
3824 same_headers(next->p.extra_headers, addr->p.extra_headers)
3826 same_ugid(tp, next, addr)
3828 (next->p.remove_headers == addr->p.remove_headers ||
3829 (next->p.remove_headers != NULL &&
3830 addr->p.remove_headers != NULL &&
3831 Ustrcmp(next->p.remove_headers, addr->p.remove_headers) == 0)))
3833 *anchor = next->next;
3835 next->first = addr; /* remember top one (for retry processing) */
3840 else anchor = &(next->next);
3843 /* If we are acting as an MUA wrapper, all addresses must go in a single
3844 transaction. If not, put them back on the chain and yield FALSE. */
3846 if (mua_wrapper && addr_remote != NULL)
3848 last->next = addr_remote;
3853 /* Set up the expansion variables for this set of addresses */
3855 deliver_set_expansions(addr);
3857 /* Ensure any transport-set auth info is fresh */
3858 addr->authenticator = addr->auth_id = addr->auth_sndr = NULL;
3860 /* Compute the return path, expanding a new one if required. The old one
3861 must be set first, as it might be referred to in the expansion. */
3863 if(addr->p.errors_address != NULL)
3864 return_path = addr->p.errors_address;
3865 #ifdef EXPERIMENTAL_SRS
3866 else if(addr->p.srs_sender != NULL)
3867 return_path = addr->p.srs_sender;
3870 return_path = sender_address;
3872 if (tp->return_path != NULL)
3874 uschar *new_return_path = expand_string(tp->return_path);
3875 if (new_return_path == NULL)
3877 if (!expand_string_forcedfail)
3879 remote_post_process(addr, LOG_MAIN|LOG_PANIC,
3880 string_sprintf("Failed to expand return path \"%s\": %s",
3881 tp->return_path, expand_string_message), fallback);
3885 else return_path = new_return_path;
3888 /* Find the uid, gid, and use_initgroups setting for this transport. Failure
3889 logs and sets up error messages, so we just post-process and continue with
3890 the next address. */
3892 if (!findugid(addr, tp, &uid, &gid, &use_initgroups))
3894 remote_post_process(addr, LOG_MAIN|LOG_PANIC, NULL, fallback);
3898 /* If this transport has a setup function, call it now so that it gets
3899 run in this process and not in any subprocess. That way, the results of
3900 any setup that are retained by the transport can be reusable. One of the
3901 things the setup does is to set the fallback host lists in the addresses.
3902 That is why it is called at this point, before the continue delivery
3903 processing, because that might use the fallback hosts. */
3905 if (tp->setup != NULL)
3906 (void)((tp->setup)(addr->transport, addr, NULL, uid, gid, NULL));
3908 /* If this is a run to continue delivery down an already-established
3909 channel, check that this set of addresses matches the transport and
3910 the channel. If it does not, defer the addresses. If a host list exists,
3911 we must check that the continue host is on the list. Otherwise, the
3912 host is set in the transport. */
3914 continue_more = FALSE; /* In case got set for the last lot */
3915 if (continue_transport != NULL)
3917 BOOL ok = Ustrcmp(continue_transport, tp->name) == 0;
3918 if (ok && addr->host_list != NULL)
3922 for (h = addr->host_list; h != NULL; h = h->next)
3924 if (Ustrcmp(h->name, continue_hostname) == 0)
3925 { ok = TRUE; break; }
3929 /* Addresses not suitable; defer or queue for fallback hosts (which
3930 might be the continue host) and skip to next address. */
3934 DEBUG(D_deliver) debug_printf("not suitable for continue_transport\n");
3937 if (addr->fallback_hosts != NULL && !fallback)
3941 next->host_list = next->fallback_hosts;
3942 DEBUG(D_deliver) debug_printf("%s queued for fallback host(s)\n", next->address);
3943 if (next->next == NULL) break;
3946 next->next = addr_fallback;
3947 addr_fallback = addr;
3952 while (next->next != NULL) next = next->next;
3953 next->next = addr_defer;
3960 /* Set a flag indicating whether there are further addresses that list
3961 the continued host. This tells the transport to leave the channel open,
3962 but not to pass it to another delivery process. */
3964 for (next = addr_remote; next != NULL; next = next->next)
3967 for (h = next->host_list; h != NULL; h = h->next)
3969 if (Ustrcmp(h->name, continue_hostname) == 0)
3970 { continue_more = TRUE; break; }
3975 /* The transports set up the process info themselves as they may connect
3976 to more than one remote machine. They also have to set up the filter
3977 arguments, if required, so that the host name and address are available
3980 transport_filter_argv = NULL;
3982 /* Create the pipe for inter-process communication. If pipe creation
3983 fails, it is probably because the value of remote_max_parallel is so
3984 large that too many file descriptors for pipes have been created. Arrange
3985 to wait for a process to finish, and then try again. If we still can't
3986 create a pipe when all processes have finished, break the retry loop. */
3990 if (pipe(pfd) == 0) pipe_done = TRUE;
3991 else if (parcount > 0) parmax = parcount;
3994 /* We need to make the reading end of the pipe non-blocking. There are
3995 two different options for this. Exim is cunningly (I hope!) coded so
3996 that it can use either of them, though it prefers O_NONBLOCK, which
3997 distinguishes between EOF and no-more-data. */
4000 (void)fcntl(pfd[pipe_read], F_SETFL, O_NONBLOCK);
4002 (void)fcntl(pfd[pipe_read], F_SETFL, O_NDELAY);
4005 /* If the maximum number of subprocesses already exist, wait for a process
4006 to finish. If we ran out of file descriptors, parmax will have been reduced
4007 from its initial value of remote_max_parallel. */
4009 par_reduce(parmax - 1, fallback);
4012 /* If we failed to create a pipe and there were no processes to wait
4013 for, we have to give up on this one. Do this outside the above loop
4014 so that we can continue the main loop. */
4018 remote_post_process(addr, LOG_MAIN|LOG_PANIC,
4019 string_sprintf("unable to create pipe: %s", strerror(errno)), fallback);
4023 /* Find a free slot in the pardata list. Must do this after the possible
4024 waiting for processes to finish, because a terminating process will free
4027 for (poffset = 0; poffset < remote_max_parallel; poffset++)
4028 if (parlist[poffset].pid == 0) break;
4030 /* If there isn't one, there has been a horrible disaster. */
4032 if (poffset >= remote_max_parallel)
4034 (void)close(pfd[pipe_write]);
4035 (void)close(pfd[pipe_read]);
4036 remote_post_process(addr, LOG_MAIN|LOG_PANIC,
4037 US"Unexpectedly no free subprocess slot", fallback);
4041 /* Now fork a subprocess to do the remote delivery, but before doing so,
4042 ensure that any cached resourses are released so as not to interfere with
4043 what happens in the subprocess. */
4047 if ((pid = fork()) == 0)
4049 int fd = pfd[pipe_write];
4052 /* Setting this global in the subprocess means we need never clear it */
4053 transport_name = tp->name;
4055 /* There are weird circumstances in which logging is disabled */
4056 disable_logging = tp->disable_logging;
4058 /* Show pids on debug output if parallelism possible */
4060 if (parmax > 1 && (parcount > 0 || addr_remote != NULL))
4062 DEBUG(D_any|D_v) debug_selector |= D_pid;
4063 DEBUG(D_deliver) debug_printf("Remote delivery process started\n");
4066 /* Reset the random number generator, so different processes don't all
4067 have the same sequence. In the test harness we want different, but
4068 predictable settings for each delivery process, so do something explicit
4069 here rather they rely on the fixed reset in the random number function. */
4071 random_seed = running_in_test_harness? 42 + 2*delivery_count : 0;
4073 /* Set close-on-exec on the pipe so that it doesn't get passed on to
4074 a new process that may be forked to do another delivery down the same
4077 (void)fcntl(fd, F_SETFD, fcntl(fd, F_GETFD) | FD_CLOEXEC);
4079 /* Close open file descriptors for the pipes of other processes
4080 that are running in parallel. */
4082 for (poffset = 0; poffset < remote_max_parallel; poffset++)
4083 if (parlist[poffset].pid != 0) (void)close(parlist[poffset].fd);
4085 /* This process has inherited a copy of the file descriptor
4086 for the data file, but its file pointer is shared with all the
4087 other processes running in parallel. Therefore, we have to re-open
4088 the file in order to get a new file descriptor with its own
4089 file pointer. We don't need to lock it, as the lock is held by
4090 the parent process. There doesn't seem to be any way of doing
4091 a dup-with-new-file-pointer. */
4093 (void)close(deliver_datafile);
4094 sprintf(CS spoolname, "%s/input/%s/%s-D", spool_directory, message_subdir,
4096 deliver_datafile = Uopen(spoolname, O_RDWR | O_APPEND, 0);
4098 if (deliver_datafile < 0)
4099 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Failed to reopen %s for remote "
4100 "parallel delivery: %s", spoolname, strerror(errno));
4102 /* Set the close-on-exec flag */
4104 (void)fcntl(deliver_datafile, F_SETFD, fcntl(deliver_datafile, F_GETFD) |
4107 /* Set the uid/gid of this process; bombs out on failure. */
4109 exim_setugid(uid, gid, use_initgroups,
4110 string_sprintf("remote delivery to %s with transport=%s",
4111 addr->address, tp->name));
4113 /* Close the unwanted half of this process' pipe, set the process state,
4114 and run the transport. Afterwards, transport_count will contain the number
4115 of bytes written. */
4117 (void)close(pfd[pipe_read]);
4118 set_process_info("delivering %s using %s", message_id, tp->name);
4119 debug_print_string(tp->debug_string);
4120 if (!(tp->info->code)(addr->transport, addr)) replicate_status(addr);
4122 set_process_info("delivering %s (just run %s for %s%s in subprocess)",
4123 message_id, tp->name, addr->address, (addr->next == NULL)? "" : ", ...");
4125 /* Ensure any cached resources that we used are now released */
4129 /* Pass the result back down the pipe. This is a lot more information
4130 than is needed for a local delivery. We have to send back the error
4131 status for each address, the usability status for each host that is
4132 flagged as unusable, and all the retry items. When TLS is in use, we
4133 send also the cipher and peerdn information. Each type of information
4134 is flagged by an identifying byte, and is then in a fixed format (with
4135 strings terminated by zeros), and there is a final terminator at the
4136 end. The host information and retry information is all attached to
4137 the first address, so that gets sent at the start. */
4139 /* Host unusability information: for most success cases this will
4142 for (h = addr->host_list; h != NULL; h = h->next)
4144 if (h->address == NULL || h->status < hstatus_unusable) continue;
4145 sprintf(CS big_buffer, "H%c%c%s", h->status, h->why, h->address);
4146 rmt_dlv_checked_write(fd, big_buffer, Ustrlen(big_buffer+3) + 4);
4149 /* The number of bytes written. This is the same for each address. Even
4150 if we sent several copies of the message down the same connection, the
4151 size of each one is the same, and it's that value we have got because
4152 transport_count gets reset before calling transport_write_message(). */
4154 big_buffer[0] = 'S';
4155 memcpy(big_buffer+1, &transport_count, sizeof(transport_count));
4156 rmt_dlv_checked_write(fd, big_buffer, sizeof(transport_count) + 1);
4158 /* Information about what happened to each address. Four item types are
4159 used: an optional 'X' item first, for TLS information, then an optional "C"
4160 item for any client-auth info followed by 'R' items for any retry settings,
4161 and finally an 'A' item for the remaining data. */
4163 for(; addr != NULL; addr = addr->next)
4168 /* The certificate verification status goes into the flags */
4169 if (tls_out.certificate_verified) setflag(addr, af_cert_verified);
4170 #ifdef EXPERIMENTAL_DANE
4171 if (tls_out.dane_verified) setflag(addr, af_dane_verified);
4174 /* Use an X item only if there's something to send */
4179 sprintf(CS ptr, "X1%.128s", addr->cipher);
4185 sprintf(CS ptr, "%.512s", addr->peerdn);
4189 rmt_dlv_checked_write(fd, big_buffer, ptr - big_buffer);
4194 *ptr++ = 'X'; *ptr++ = '2';
4195 if (!tls_export_cert(ptr, big_buffer_size-2, addr->peercert))
4199 rmt_dlv_checked_write(fd, big_buffer, ptr - big_buffer);
4204 *ptr++ = 'X'; *ptr++ = '3';
4205 if (!tls_export_cert(ptr, big_buffer_size-2, addr->ourcert))
4209 rmt_dlv_checked_write(fd, big_buffer, ptr - big_buffer);
4211 # ifndef DISABLE_OCSP
4212 if (addr->ocsp > OCSP_NOT_REQ)
4215 sprintf(CS ptr, "X4%c", addr->ocsp + '0');
4217 rmt_dlv_checked_write(fd, big_buffer, ptr - big_buffer);
4220 #endif /*SUPPORT_TLS*/
4222 if (client_authenticator)
4225 sprintf(CS big_buffer, "C1%.64s", client_authenticator);
4227 rmt_dlv_checked_write(fd, big_buffer, ptr - big_buffer);
4229 if (client_authenticated_id)
4232 sprintf(CS big_buffer, "C2%.64s", client_authenticated_id);
4234 rmt_dlv_checked_write(fd, big_buffer, ptr - big_buffer);
4236 if (client_authenticated_sender)
4239 sprintf(CS big_buffer, "C3%.64s", client_authenticated_sender);
4241 rmt_dlv_checked_write(fd, big_buffer, ptr - big_buffer);
4244 #ifndef DISABLE_PRDR
4245 if (addr->flags & af_prdr_used)
4246 rmt_dlv_checked_write(fd, "P", 1);
4249 #ifdef EXPERIMENTAL_DSN
4250 big_buffer[0] = 'D';
4251 memcpy(big_buffer+1, &addr->dsn_aware, sizeof(addr->dsn_aware));
4252 rmt_dlv_checked_write(fd, big_buffer, sizeof(addr->dsn_aware) + 1);
4253 DEBUG(D_deliver) debug_printf("DSN write: addr->dsn_aware = %d\n", addr->dsn_aware);
4256 /* Retry information: for most success cases this will be null. */
4258 for (r = addr->retries; r != NULL; r = r->next)
4261 sprintf(CS big_buffer, "R%c%.500s", r->flags, r->key);
4262 ptr = big_buffer + Ustrlen(big_buffer+2) + 3;
4263 memcpy(ptr, &(r->basic_errno), sizeof(r->basic_errno));
4264 ptr += sizeof(r->basic_errno);
4265 memcpy(ptr, &(r->more_errno), sizeof(r->more_errno));
4266 ptr += sizeof(r->more_errno);
4267 if (r->message == NULL) *ptr++ = 0; else
4269 sprintf(CS ptr, "%.512s", r->message);
4272 rmt_dlv_checked_write(fd, big_buffer, ptr - big_buffer);
4275 /* The rest of the information goes in an 'A' item. */
4277 ptr = big_buffer + 3;
4278 sprintf(CS big_buffer, "A%c%c", addr->transport_return,
4279 addr->special_action);
4280 memcpy(ptr, &(addr->basic_errno), sizeof(addr->basic_errno));
4281 ptr += sizeof(addr->basic_errno);
4282 memcpy(ptr, &(addr->more_errno), sizeof(addr->more_errno));
4283 ptr += sizeof(addr->more_errno);
4284 memcpy(ptr, &(addr->flags), sizeof(addr->flags));
4285 ptr += sizeof(addr->flags);
4287 if (addr->message == NULL) *ptr++ = 0; else
4289 sprintf(CS ptr, "%.1024s", addr->message);
4293 if (addr->user_message == NULL) *ptr++ = 0; else
4295 sprintf(CS ptr, "%.1024s", addr->user_message);
4299 if (addr->host_used == NULL) *ptr++ = 0; else
4301 sprintf(CS ptr, "%.256s", addr->host_used->name);
4303 sprintf(CS ptr, "%.64s", addr->host_used->address);
4305 memcpy(ptr, &(addr->host_used->port), sizeof(addr->host_used->port));
4306 ptr += sizeof(addr->host_used->port);
4308 /* DNS lookup status */
4309 *ptr++ = addr->host_used->dnssec==DS_YES ? '2'
4310 : addr->host_used->dnssec==DS_NO ? '1' : '0';
4313 rmt_dlv_checked_write(fd, big_buffer, ptr - big_buffer);
4316 /* Add termination flag, close the pipe, and that's it. The character
4317 after 'Z' indicates whether continue_transport is now NULL or not.
4318 A change from non-NULL to NULL indicates a problem with a continuing
4321 big_buffer[0] = 'Z';
4322 big_buffer[1] = (continue_transport == NULL)? '0' : '1';
4323 rmt_dlv_checked_write(fd, big_buffer, 2);
4328 /* Back in the mainline: close the unwanted half of the pipe. */
4330 (void)close(pfd[pipe_write]);
4332 /* Fork failed; defer with error message */
4336 (void)close(pfd[pipe_read]);
4337 remote_post_process(addr, LOG_MAIN|LOG_PANIC,
4338 string_sprintf("fork failed for remote delivery to %s: %s",
4339 addr->domain, strerror(errno)), fallback);
4343 /* Fork succeeded; increment the count, and remember relevant data for
4344 when the process finishes. */
4347 parlist[poffset].addrlist = parlist[poffset].addr = addr;
4348 parlist[poffset].pid = pid;
4349 parlist[poffset].fd = pfd[pipe_read];
4350 parlist[poffset].done = FALSE;
4351 parlist[poffset].msg = NULL;
4352 parlist[poffset].return_path = return_path;
4354 /* If the process we've just started is sending a message down an existing
4355 channel, wait for it now. This ensures that only one such process runs at
4356 once, whatever the value of remote_max parallel. Otherwise, we might try to
4357 send two or more messages simultaneously down the same channel. This could
4358 happen if there are different domains that include the same host in otherwise
4359 different host lists.
4361 Also, if the transport closes down the channel, this information gets back
4362 (continue_transport gets set to NULL) before we consider any other addresses
4365 if (continue_transport != NULL) par_reduce(0, fallback);
4367 /* Otherwise, if we are running in the test harness, wait a bit, to let the
4368 newly created process get going before we create another process. This should
4369 ensure repeatability in the tests. We only need to wait a tad. */
4371 else if (running_in_test_harness) millisleep(500);
4374 /* Reached the end of the list of addresses. Wait for all the subprocesses that
4375 are still running and post-process their addresses. */
4377 par_reduce(0, fallback);
4384 /*************************************************
4385 * Split an address into local part and domain *
4386 *************************************************/
4388 /* This function initializes an address for routing by splitting it up into a
4389 local part and a domain. The local part is set up twice - once in its original
4390 casing, and once in lower case, and it is dequoted. We also do the "percent
4391 hack" for configured domains. This may lead to a DEFER result if a lookup
4392 defers. When a percent-hacking takes place, we insert a copy of the original
4393 address as a new parent of this address, as if we have had a redirection.
4396 addr points to an addr_item block containing the address
4399 DEFER - could not determine if domain is %-hackable
4403 deliver_split_address(address_item *addr)
4405 uschar *address = addr->address;
4406 uschar *domain = Ustrrchr(address, '@');
4408 int len = domain - address;
4410 addr->domain = string_copylc(domain+1); /* Domains are always caseless */
4412 /* The implication in the RFCs (though I can't say I've seen it spelled out
4413 explicitly) is that quoting should be removed from local parts at the point
4414 where they are locally interpreted. [The new draft "821" is more explicit on
4415 this, Jan 1999.] We know the syntax is valid, so this can be done by simply
4416 removing quoting backslashes and any unquoted doublequotes. */
4418 t = addr->cc_local_part = store_get(len+1);
4421 register int c = *address++;
4422 if (c == '\"') continue;
4432 /* We do the percent hack only for those domains that are listed in
4433 percent_hack_domains. A loop is required, to copy with multiple %-hacks. */
4435 if (percent_hack_domains != NULL)
4438 uschar *new_address = NULL;
4439 uschar *local_part = addr->cc_local_part;
4441 deliver_domain = addr->domain; /* set $domain */
4443 while ((rc = match_isinlist(deliver_domain, &percent_hack_domains, 0,
4444 &domainlist_anchor, addr->domain_cache, MCL_DOMAIN, TRUE, NULL))
4446 (t = Ustrrchr(local_part, '%')) != NULL)
4448 new_address = string_copy(local_part);
4449 new_address[t - local_part] = '@';
4450 deliver_domain = string_copylc(t+1);
4451 local_part = string_copyn(local_part, t - local_part);
4454 if (rc == DEFER) return DEFER; /* lookup deferred */
4456 /* If hackery happened, set up new parent and alter the current address. */
4458 if (new_address != NULL)
4460 address_item *new_parent = store_get(sizeof(address_item));
4461 *new_parent = *addr;
4462 addr->parent = new_parent;
4463 addr->address = new_address;
4464 addr->unique = string_copy(new_address);
4465 addr->domain = deliver_domain;
4466 addr->cc_local_part = local_part;
4467 DEBUG(D_deliver) debug_printf("%%-hack changed address to: %s\n",
4472 /* Create the lowercased version of the final local part, and make that the
4473 default one to be used. */
4475 addr->local_part = addr->lc_local_part = string_copylc(addr->cc_local_part);
4482 /*************************************************
4483 * Get next error message text *
4484 *************************************************/
4486 /* If f is not NULL, read the next "paragraph", from a customized error message
4487 text file, terminated by a line containing ****, and expand it.
4490 f NULL or a file to read from
4491 which string indicating which string (for errors)
4493 Returns: NULL or an expanded string
4497 next_emf(FILE *f, uschar *which)
4501 uschar *para, *yield;
4504 if (f == NULL) return NULL;
4506 if (Ufgets(buffer, sizeof(buffer), f) == NULL ||
4507 Ustrcmp(buffer, "****\n") == 0) return NULL;
4509 para = store_get(size);
4512 para = string_cat(para, &size, &ptr, buffer, Ustrlen(buffer));
4513 if (Ufgets(buffer, sizeof(buffer), f) == NULL ||
4514 Ustrcmp(buffer, "****\n") == 0) break;
4518 yield = expand_string(para);
4519 if (yield != NULL) return yield;
4521 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand string from "
4522 "bounce_message_file or warn_message_file (%s): %s", which,
4523 expand_string_message);
4530 /*************************************************
4531 * Close down a passed transport channel *
4532 *************************************************/
4534 /* This function is called when a passed transport channel cannot be used.
4535 It attempts to close it down tidily. The yield is always DELIVER_NOT_ATTEMPTED
4536 so that the function call can be the argument of a "return" statement.
4539 Returns: DELIVER_NOT_ATTEMPTED
4543 continue_closedown(void)
4545 if (continue_transport != NULL)
4547 transport_instance *t;
4548 for (t = transports; t != NULL; t = t->next)
4550 if (Ustrcmp(t->name, continue_transport) == 0)
4552 if (t->info->closedown != NULL) (t->info->closedown)(t);
4557 return DELIVER_NOT_ATTEMPTED;
4563 /*************************************************
4564 * Print address information *
4565 *************************************************/
4567 /* This function is called to output an address, or information about an
4568 address, for bounce or defer messages. If the hide_child flag is set, all we
4569 output is the original ancestor address.
4572 addr points to the address
4573 f the FILE to print to
4574 si an initial string
4575 sc a continuation string for before "generated"
4578 Returns: TRUE if the address is not hidden
4582 print_address_information(address_item *addr, FILE *f, uschar *si, uschar *sc,
4586 uschar *printed = US"";
4587 address_item *ancestor = addr;
4588 while (ancestor->parent != NULL) ancestor = ancestor->parent;
4590 fprintf(f, "%s", CS si);
4592 if (addr->parent != NULL && testflag(addr, af_hide_child))
4594 printed = US"an undisclosed address";
4597 else if (!testflag(addr, af_pfr) || addr->parent == NULL)
4598 printed = addr->address;
4602 uschar *s = addr->address;
4605 if (addr->address[0] == '>') { ss = US"mail"; s++; }
4606 else if (addr->address[0] == '|') ss = US"pipe";
4609 fprintf(f, "%s to %s%sgenerated by ", ss, s, sc);
4610 printed = addr->parent->address;
4613 fprintf(f, "%s", CS string_printing(printed));
4615 if (ancestor != addr)
4617 uschar *original = (ancestor->onetime_parent == NULL)?
4618 ancestor->address : ancestor->onetime_parent;
4619 if (strcmpic(original, printed) != 0)
4620 fprintf(f, "%s(%sgenerated from %s)", sc,
4621 (ancestor != addr->parent)? "ultimately " : "",
4622 string_printing(original));
4625 fprintf(f, "%s", CS se);
4633 /*************************************************
4634 * Print error for an address *
4635 *************************************************/
4637 /* This function is called to print the error information out of an address for
4638 a bounce or a warning message. It tries to format the message reasonably by
4639 introducing newlines. All lines are indented by 4; the initial printing
4640 position must be set before calling.
4642 This function used always to print the error. Nowadays we want to restrict it
4643 to cases such as LMTP/SMTP errors from a remote host, and errors from :fail:
4644 and filter "fail". We no longer pass other information willy-nilly in bounce
4645 and warning messages. Text in user_message is always output; text in message
4646 only if the af_pass_message flag is set.
4650 f the FILE to print on
4657 print_address_error(address_item *addr, FILE *f, uschar *t)
4659 int count = Ustrlen(t);
4660 uschar *s = testflag(addr, af_pass_message)? addr->message : NULL;
4664 if (addr->user_message != NULL) s = addr->user_message; else return;
4667 fprintf(f, "\n %s", t);
4671 if (*s == '\\' && s[1] == 'n')
4681 if (*s++ == ':' && isspace(*s) && count > 45)
4683 fprintf(f, "\n "); /* sic (because space follows) */
4695 /*************************************************
4696 * Check list of addresses for duplication *
4697 *************************************************/
4699 /* This function was introduced when the test for duplicate addresses that are
4700 not pipes, files, or autoreplies was moved from the middle of routing to when
4701 routing was complete. That was to fix obscure cases when the routing history
4702 affects the subsequent routing of identical addresses. This function is called
4703 after routing, to check that the final routed addresses are not duplicates.
4705 If we detect a duplicate, we remember what it is a duplicate of. Note that
4706 pipe, file, and autoreply de-duplication is handled during routing, so we must
4707 leave such "addresses" alone here, as otherwise they will incorrectly be
4710 Argument: address of list anchor
4715 do_duplicate_check(address_item **anchor)
4718 while ((addr = *anchor) != NULL)
4721 if (testflag(addr, af_pfr))
4723 anchor = &(addr->next);
4725 else if ((tnode = tree_search(tree_duplicates, addr->unique)) != NULL)
4727 DEBUG(D_deliver|D_route)
4728 debug_printf("%s is a duplicate address: discarded\n", addr->unique);
4729 *anchor = addr->next;
4730 addr->dupof = tnode->data.ptr;
4731 addr->next = addr_duplicate;
4732 addr_duplicate = addr;
4736 tree_add_duplicate(addr->unique, addr);
4737 anchor = &(addr->next);
4745 /*************************************************
4746 * Deliver one message *
4747 *************************************************/
4749 /* This is the function which is called when a message is to be delivered. It
4750 is passed the id of the message. It is possible that the message no longer
4751 exists, if some other process has delivered it, and it is also possible that
4752 the message is being worked on by another process, in which case the data file
4755 If no delivery is attempted for any of the above reasons, the function returns
4756 DELIVER_NOT_ATTEMPTED.
4758 If the give_up flag is set true, do not attempt any deliveries, but instead
4759 fail all outstanding addresses and return the message to the sender (or
4762 A delivery operation has a process all to itself; we never deliver more than
4763 one message in the same process. Therefore we needn't worry too much about
4767 id the id of the message to be delivered
4768 forced TRUE if delivery was forced by an administrator; this overrides
4769 retry delays and causes a delivery to be tried regardless
4770 give_up TRUE if an administrator has requested that delivery attempts
4773 Returns: When the global variable mua_wrapper is FALSE:
4774 DELIVER_ATTEMPTED_NORMAL if a delivery attempt was made
4775 DELIVER_NOT_ATTEMPTED otherwise (see comment above)
4776 When the global variable mua_wrapper is TRUE:
4777 DELIVER_MUA_SUCCEEDED if delivery succeeded
4778 DELIVER_MUA_FAILED if delivery failed
4779 DELIVER_NOT_ATTEMPTED if not attempted (should not occur)
4783 deliver_message(uschar *id, BOOL forced, BOOL give_up)
4786 int final_yield = DELIVER_ATTEMPTED_NORMAL;
4787 time_t now = time(NULL);
4788 address_item *addr_last = NULL;
4789 uschar *filter_message = NULL;
4791 int process_recipients = RECIP_ACCEPT;
4794 extern int acl_where;
4796 uschar *info = (queue_run_pid == (pid_t)0)?
4797 string_sprintf("delivering %s", id) :
4798 string_sprintf("delivering %s (queue run pid %d)", id, queue_run_pid);
4800 /* If the D_process_info bit is on, set_process_info() will output debugging
4801 information. If not, we want to show this initial information if D_deliver or
4802 D_queue_run is set or in verbose mode. */
4804 set_process_info("%s", info);
4806 if ((debug_selector & D_process_info) == 0 &&
4807 (debug_selector & (D_deliver|D_queue_run|D_v)) != 0)
4808 debug_printf("%s\n", info);
4810 /* Ensure that we catch any subprocesses that are created. Although Exim
4811 sets SIG_DFL as its initial default, some routes through the code end up
4812 here with it set to SIG_IGN - cases where a non-synchronous delivery process
4813 has been forked, but no re-exec has been done. We use sigaction rather than
4814 plain signal() on those OS where SA_NOCLDWAIT exists, because we want to be
4815 sure it is turned off. (There was a problem on AIX with this.) */
4819 struct sigaction act;
4820 act.sa_handler = SIG_DFL;
4821 sigemptyset(&(act.sa_mask));
4823 sigaction(SIGCHLD, &act, NULL);
4826 signal(SIGCHLD, SIG_DFL);
4829 /* Make the forcing flag available for routers and transports, set up the
4830 global message id field, and initialize the count for returned files and the
4831 message size. This use of strcpy() is OK because the length id is checked when
4832 it is obtained from a command line (the -M or -q options), and otherwise it is
4833 known to be a valid message id. */
4835 Ustrcpy(message_id, id);
4836 deliver_force = forced;
4840 /* Initialize some flags */
4842 update_spool = FALSE;
4843 remove_journal = TRUE;
4845 /* Set a known context for any ACLs we call via expansions */
4846 acl_where = ACL_WHERE_DELIVERY;
4848 /* Reset the random number generator, so that if several delivery processes are
4849 started from a queue runner that has already used random numbers (for sorting),
4850 they don't all get the same sequence. */
4854 /* Open and lock the message's data file. Exim locks on this one because the
4855 header file may get replaced as it is re-written during the delivery process.
4856 Any failures cause messages to be written to the log, except for missing files
4857 while queue running - another process probably completed delivery. As part of
4858 opening the data file, message_subdir gets set. */
4860 if (!spool_open_datafile(id))
4861 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
4863 /* The value of message_size at this point has been set to the data length,
4864 plus one for the blank line that notionally precedes the data. */
4866 /* Now read the contents of the header file, which will set up the headers in
4867 store, and also the list of recipients and the tree of non-recipients and
4868 assorted flags. It updates message_size. If there is a reading or format error,
4869 give up; if the message has been around for sufficiently long, remove it. */
4871 sprintf(CS spoolname, "%s-H", id);
4872 if ((rc = spool_read_header(spoolname, TRUE, TRUE)) != spool_read_OK)
4874 if (errno == ERRNO_SPOOLFORMAT)
4876 struct stat statbuf;
4877 sprintf(CS big_buffer, "%s/input/%s/%s", spool_directory, message_subdir,
4879 if (Ustat(big_buffer, &statbuf) == 0)
4880 log_write(0, LOG_MAIN, "Format error in spool file %s: "
4881 "size=" OFF_T_FMT, spoolname, statbuf.st_size);
4882 else log_write(0, LOG_MAIN, "Format error in spool file %s", spoolname);
4885 log_write(0, LOG_MAIN, "Error reading spool file %s: %s", spoolname,
4888 /* If we managed to read the envelope data, received_time contains the
4889 time the message was received. Otherwise, we can calculate it from the
4892 if (rc != spool_read_hdrerror)
4895 for (i = 0; i < 6; i++)
4896 received_time = received_time * BASE_62 + tab62[id[i] - '0'];
4899 /* If we've had this malformed message too long, sling it. */
4901 if (now - received_time > keep_malformed)
4903 sprintf(CS spoolname, "%s/msglog/%s/%s", spool_directory, message_subdir, id);
4905 sprintf(CS spoolname, "%s/input/%s/%s-D", spool_directory, message_subdir, id);
4907 sprintf(CS spoolname, "%s/input/%s/%s-H", spool_directory, message_subdir, id);
4909 sprintf(CS spoolname, "%s/input/%s/%s-J", spool_directory, message_subdir, id);
4911 log_write(0, LOG_MAIN, "Message removed because older than %s",
4912 readconf_printtime(keep_malformed));
4915 (void)close(deliver_datafile);
4916 deliver_datafile = -1;
4917 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
4920 /* The spool header file has been read. Look to see if there is an existing
4921 journal file for this message. If there is, it means that a previous delivery
4922 attempt crashed (program or host) before it could update the spool header file.
4923 Read the list of delivered addresses from the journal and add them to the
4924 nonrecipients tree. Then update the spool file. We can leave the journal in
4925 existence, as it will get further successful deliveries added to it in this
4926 run, and it will be deleted if this function gets to its end successfully.
4927 Otherwise it might be needed again. */
4929 sprintf(CS spoolname, "%s/input/%s/%s-J", spool_directory, message_subdir, id);
4930 jread = Ufopen(spoolname, "rb");
4933 while (Ufgets(big_buffer, big_buffer_size, jread) != NULL)
4935 int n = Ustrlen(big_buffer);
4936 big_buffer[n-1] = 0;
4937 tree_add_nonrecipient(big_buffer);
4938 DEBUG(D_deliver) debug_printf("Previously delivered address %s taken from "
4939 "journal file\n", big_buffer);
4941 (void)fclose(jread);
4942 /* Panic-dies on error */
4943 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
4945 else if (errno != ENOENT)
4947 log_write(0, LOG_MAIN|LOG_PANIC, "attempt to open journal for reading gave: "
4948 "%s", strerror(errno));
4949 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
4952 /* A null recipients list indicates some kind of disaster. */
4954 if (recipients_list == NULL)
4956 (void)close(deliver_datafile);
4957 deliver_datafile = -1;
4958 log_write(0, LOG_MAIN, "Spool error: no recipients for %s", spoolname);
4959 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
4963 /* Handle a message that is frozen. There are a number of different things that
4964 can happen, but in the default situation, unless forced, no delivery is
4969 #ifdef SUPPORT_MOVE_FROZEN_MESSAGES
4970 /* Moving to another directory removes the message from Exim's view. Other
4971 tools must be used to deal with it. Logging of this action happens in
4972 spool_move_message() and its subfunctions. */
4974 if (move_frozen_messages &&
4975 spool_move_message(id, message_subdir, US"", US"F"))
4976 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
4979 /* For all frozen messages (bounces or not), timeout_frozen_after sets the
4980 maximum time to keep messages that are frozen. Thaw if we reach it, with a
4981 flag causing all recipients to be failed. The time is the age of the
4982 message, not the time since freezing. */
4984 if (timeout_frozen_after > 0 && message_age >= timeout_frozen_after)
4986 log_write(0, LOG_MAIN, "cancelled by timeout_frozen_after");
4987 process_recipients = RECIP_FAIL_TIMEOUT;
4990 /* For bounce messages (and others with no sender), thaw if the error message
4991 ignore timer is exceeded. The message will be discarded if this delivery
4994 else if (sender_address[0] == 0 && message_age >= ignore_bounce_errors_after)
4996 log_write(0, LOG_MAIN, "Unfrozen by errmsg timer");
4999 /* If this is a bounce message, or there's no auto thaw, or we haven't
5000 reached the auto thaw time yet, and this delivery is not forced by an admin
5001 user, do not attempt delivery of this message. Note that forced is set for
5002 continuing messages down the same channel, in order to skip load checking and
5003 ignore hold domains, but we don't want unfreezing in that case. */
5007 if ((sender_address[0] == 0 ||
5009 now <= deliver_frozen_at + auto_thaw
5012 (!forced || !deliver_force_thaw || !admin_user ||
5013 continue_hostname != NULL
5016 (void)close(deliver_datafile);
5017 deliver_datafile = -1;
5018 log_write(L_skip_delivery, LOG_MAIN, "Message is frozen");
5019 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5022 /* If delivery was forced (by an admin user), assume a manual thaw.
5023 Otherwise it's an auto thaw. */
5027 deliver_manual_thaw = TRUE;
5028 log_write(0, LOG_MAIN, "Unfrozen by forced delivery");
5030 else log_write(0, LOG_MAIN, "Unfrozen by auto-thaw");
5033 /* We get here if any of the rules for unfreezing have triggered. */
5035 deliver_freeze = FALSE;
5036 update_spool = TRUE;
5040 /* Open the message log file if we are using them. This records details of
5041 deliveries, deferments, and failures for the benefit of the mail administrator.
5042 The log is not used by exim itself to track the progress of a message; that is
5043 done by rewriting the header spool file. */
5050 sprintf(CS spoolname, "%s/msglog/%s/%s", spool_directory, message_subdir, id);
5051 fd = open_msglog_file(spoolname, SPOOL_MODE, &error);
5055 log_write(0, LOG_MAIN|LOG_PANIC, "Couldn't %s message log %s: %s", error,
5056 spoolname, strerror(errno));
5057 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5060 /* Make a C stream out of it. */
5062 message_log = fdopen(fd, "a");
5063 if (message_log == NULL)
5065 log_write(0, LOG_MAIN|LOG_PANIC, "Couldn't fdopen message log %s: %s",
5066 spoolname, strerror(errno));
5067 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5072 /* If asked to give up on a message, log who did it, and set the action for all
5077 struct passwd *pw = getpwuid(real_uid);
5078 log_write(0, LOG_MAIN, "cancelled by %s", (pw != NULL)?
5079 US pw->pw_name : string_sprintf("uid %ld", (long int)real_uid));
5080 process_recipients = RECIP_FAIL;
5083 /* Otherwise, if there are too many Received: headers, fail all recipients. */
5085 else if (received_count > received_headers_max)
5086 process_recipients = RECIP_FAIL_LOOP;
5088 /* Otherwise, if a system-wide, address-independent message filter is
5089 specified, run it now, except in the case when we are failing all recipients as
5090 a result of timeout_frozen_after. If the system filter yields "delivered", then
5091 ignore the true recipients of the message. Failure of the filter file is
5092 logged, and the delivery attempt fails. */
5094 else if (system_filter != NULL && process_recipients != RECIP_FAIL_TIMEOUT)
5099 redirect_block redirect;
5101 if (system_filter_uid_set)
5103 ugid.uid = system_filter_uid;
5104 ugid.gid = system_filter_gid;
5105 ugid.uid_set = ugid.gid_set = TRUE;
5109 ugid.uid_set = ugid.gid_set = FALSE;
5112 return_path = sender_address;
5113 enable_dollar_recipients = TRUE; /* Permit $recipients in system filter */
5114 system_filtering = TRUE;
5116 /* Any error in the filter file causes a delivery to be abandoned. */
5118 redirect.string = system_filter;
5119 redirect.isfile = TRUE;
5120 redirect.check_owner = redirect.check_group = FALSE;
5121 redirect.owners = NULL;
5122 redirect.owngroups = NULL;
5124 redirect.modemask = 0;
5126 DEBUG(D_deliver|D_filter) debug_printf("running system filter\n");
5129 &redirect, /* Where the data is */
5130 RDO_DEFER | /* Turn on all the enabling options */
5131 RDO_FAIL | /* Leave off all the disabling options */
5136 NULL, /* No :include: restriction (not used in filter) */
5137 NULL, /* No sieve vacation directory (not sieve!) */
5138 NULL, /* No sieve enotify mailto owner (not sieve!) */
5139 NULL, /* No sieve user address (not sieve!) */
5140 NULL, /* No sieve subaddress (not sieve!) */
5141 &ugid, /* uid/gid data */
5142 &addr_new, /* Where to hang generated addresses */
5143 &filter_message, /* Where to put error message */
5144 NULL, /* Don't skip syntax errors */
5145 &filtertype, /* Will always be set to FILTER_EXIM for this call */
5146 US"system filter"); /* For error messages */
5148 DEBUG(D_deliver|D_filter) debug_printf("system filter returned %d\n", rc);
5150 if (rc == FF_ERROR || rc == FF_NONEXIST)
5152 (void)close(deliver_datafile);
5153 deliver_datafile = -1;
5154 log_write(0, LOG_MAIN|LOG_PANIC, "Error in system filter: %s",
5155 string_printing(filter_message));
5156 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5159 /* Reset things. If the filter message is an empty string, which can happen
5160 for a filter "fail" or "freeze" command with no text, reset it to NULL. */
5162 system_filtering = FALSE;
5163 enable_dollar_recipients = FALSE;
5164 if (filter_message != NULL && filter_message[0] == 0) filter_message = NULL;
5166 /* Save the values of the system filter variables so that user filters
5169 memcpy(filter_sn, filter_n, sizeof(filter_sn));
5171 /* The filter can request that delivery of the original addresses be
5176 process_recipients = RECIP_DEFER;
5177 deliver_msglog("Delivery deferred by system filter\n");
5178 log_write(0, LOG_MAIN, "Delivery deferred by system filter");
5181 /* The filter can request that a message be frozen, but this does not
5182 take place if the message has been manually thawed. In that case, we must
5183 unset "delivered", which is forced by the "freeze" command to make -bF
5186 else if (rc == FF_FREEZE && !deliver_manual_thaw)
5188 deliver_freeze = TRUE;
5189 deliver_frozen_at = time(NULL);
5190 process_recipients = RECIP_DEFER;
5191 frozen_info = string_sprintf(" by the system filter%s%s",
5192 (filter_message == NULL)? US"" : US": ",
5193 (filter_message == NULL)? US"" : filter_message);
5196 /* The filter can request that a message be failed. The error message may be
5197 quite long - it is sent back to the sender in the bounce - but we don't want
5198 to fill up the log with repetitions of it. If it starts with << then the text
5199 between << and >> is written to the log, with the rest left for the bounce
5202 else if (rc == FF_FAIL)
5204 uschar *colon = US"";
5205 uschar *logmsg = US"";
5208 process_recipients = RECIP_FAIL_FILTER;
5210 if (filter_message != NULL)
5214 if (filter_message[0] == '<' && filter_message[1] == '<' &&
5215 (logend = Ustrstr(filter_message, ">>")) != NULL)
5217 logmsg = filter_message + 2;
5218 loglen = logend - logmsg;
5219 filter_message = logend + 2;
5220 if (filter_message[0] == 0) filter_message = NULL;
5224 logmsg = filter_message;
5225 loglen = Ustrlen(filter_message);
5229 log_write(0, LOG_MAIN, "cancelled by system filter%s%.*s", colon, loglen,
5233 /* Delivery can be restricted only to those recipients (if any) that the
5234 filter specified. */
5236 else if (rc == FF_DELIVERED)
5238 process_recipients = RECIP_IGNORE;
5239 if (addr_new == NULL)
5240 log_write(0, LOG_MAIN, "=> discarded (system filter)");
5242 log_write(0, LOG_MAIN, "original recipients ignored (system filter)");
5245 /* If any new addresses were created by the filter, fake up a "parent"
5246 for them. This is necessary for pipes, etc., which are expected to have
5247 parents, and it also gives some sensible logging for others. Allow
5248 pipes, files, and autoreplies, and run them as the filter uid if set,
5249 otherwise as the current uid. */
5251 if (addr_new != NULL)
5253 int uid = (system_filter_uid_set)? system_filter_uid : geteuid();
5254 int gid = (system_filter_gid_set)? system_filter_gid : getegid();
5256 /* The text "system-filter" is tested in transport_set_up_command() and in
5257 set_up_shell_command() in the pipe transport, to enable them to permit
5258 $recipients, so don't change it here without also changing it there. */
5260 address_item *p = addr_new;
5261 address_item *parent = deliver_make_addr(US"system-filter", FALSE);
5263 parent->domain = string_copylc(qualify_domain_recipient);
5264 parent->local_part = US"system-filter";
5266 /* As part of this loop, we arrange for addr_last to end up pointing
5267 at the final address. This is used if we go on to add addresses for the
5268 original recipients. */
5272 if (parent->child_count == SHRT_MAX)
5273 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "system filter generated more "
5274 "than %d delivery addresses", SHRT_MAX);
5275 parent->child_count++;
5278 if (testflag(p, af_pfr))
5284 setflag(p, af_uid_set |
5290 /* Find the name of the system filter's appropriate pfr transport */
5292 if (p->address[0] == '|')
5295 tpname = system_filter_pipe_transport;
5296 address_pipe = p->address;
5298 else if (p->address[0] == '>')
5301 tpname = system_filter_reply_transport;
5305 if (p->address[Ustrlen(p->address)-1] == '/')
5307 type = US"directory";
5308 tpname = system_filter_directory_transport;
5313 tpname = system_filter_file_transport;
5315 address_file = p->address;
5318 /* Now find the actual transport, first expanding the name. We have
5319 set address_file or address_pipe above. */
5323 uschar *tmp = expand_string(tpname);
5324 address_file = address_pipe = NULL;
5326 p->message = string_sprintf("failed to expand \"%s\" as a "
5327 "system filter transport name", tpname);
5332 p->message = string_sprintf("system_filter_%s_transport is unset",
5338 transport_instance *tp;
5339 for (tp = transports; tp != NULL; tp = tp->next)
5341 if (Ustrcmp(tp->name, tpname) == 0)
5348 p->message = string_sprintf("failed to find \"%s\" transport "
5349 "for system filter delivery", tpname);
5352 /* If we couldn't set up a transport, defer the delivery, putting the
5353 error on the panic log as well as the main log. */
5355 if (p->transport == NULL)
5357 address_item *badp = p;
5359 if (addr_last == NULL) addr_new = p; else addr_last->next = p;
5360 badp->local_part = badp->address; /* Needed for log line */
5361 post_process_one(badp, DEFER, LOG_MAIN|LOG_PANIC, DTYPE_ROUTER, 0);
5364 } /* End of pfr handling */
5366 /* Either a non-pfr delivery, or we found a transport */
5368 DEBUG(D_deliver|D_filter)
5369 debug_printf("system filter added %s\n", p->address);
5373 } /* Loop through all addr_new addresses */
5378 /* Scan the recipients list, and for every one that is not in the non-
5379 recipients tree, add an addr item to the chain of new addresses. If the pno
5380 value is non-negative, we must set the onetime parent from it. This which
5381 points to the relevant entry in the recipients list.
5383 This processing can be altered by the setting of the process_recipients
5384 variable, which is changed if recipients are to be ignored, failed, or
5385 deferred. This can happen as a result of system filter activity, or if the -Mg
5386 option is used to fail all of them.
5388 Duplicate addresses are handled later by a different tree structure; we can't
5389 just extend the non-recipients tree, because that will be re-written to the
5390 spool if the message is deferred, and in any case there are casing
5391 complications for local addresses. */
5393 if (process_recipients != RECIP_IGNORE)
5395 for (i = 0; i < recipients_count; i++)
5397 if (tree_search(tree_nonrecipients, recipients_list[i].address) == NULL)
5399 recipient_item *r = recipients_list + i;
5400 address_item *new = deliver_make_addr(r->address, FALSE);
5401 new->p.errors_address = r->errors_to;
5404 new->onetime_parent = recipients_list[r->pno].address;
5406 #ifdef EXPERIMENTAL_DSN
5407 /* If DSN support is enabled, set the dsn flags and the original receipt
5408 to be passed on to other DSN enabled MTAs */
5409 new->dsn_flags = r->dsn_flags & rf_dsnflags;
5410 new->dsn_orcpt = r->orcpt;
5411 DEBUG(D_deliver) debug_printf("DSN: set orcpt: %s flags: %d\n", new->dsn_orcpt, new->dsn_flags);
5414 switch (process_recipients)
5416 /* RECIP_DEFER is set when a system filter freezes a message. */
5419 new->next = addr_defer;
5424 /* RECIP_FAIL_FILTER is set when a system filter has obeyed a "fail"
5427 case RECIP_FAIL_FILTER:
5429 (filter_message == NULL)? US"delivery cancelled" : filter_message;
5430 setflag(new, af_pass_message);
5431 goto RECIP_QUEUE_FAILED; /* below */
5434 /* RECIP_FAIL_TIMEOUT is set when a message is frozen, but is older
5435 than the value in timeout_frozen_after. Treat non-bounce messages
5436 similarly to -Mg; for bounce messages we just want to discard, so
5437 don't put the address on the failed list. The timeout has already
5440 case RECIP_FAIL_TIMEOUT:
5441 new->message = US"delivery cancelled; message timed out";
5442 goto RECIP_QUEUE_FAILED; /* below */
5445 /* RECIP_FAIL is set when -Mg has been used. */
5448 new->message = US"delivery cancelled by administrator";
5451 /* Common code for the failure cases above. If this is not a bounce
5452 message, put the address on the failed list so that it is used to
5453 create a bounce. Otherwise do nothing - this just discards the address.
5454 The incident has already been logged. */
5457 if (sender_address[0] != 0)
5459 new->next = addr_failed;
5465 /* RECIP_FAIL_LOOP is set when there are too many Received: headers
5466 in the message. Process each address as a routing failure; if this
5467 is a bounce message, it will get frozen. */
5469 case RECIP_FAIL_LOOP:
5470 new->message = US"Too many \"Received\" headers - suspected mail loop";
5471 post_process_one(new, FAIL, LOG_MAIN, DTYPE_ROUTER, 0);
5475 /* Value should be RECIP_ACCEPT; take this as the safe default. */
5478 if (addr_new == NULL) addr_new = new; else addr_last->next = new;
5488 address_item *p = addr_new;
5489 debug_printf("Delivery address list:\n");
5492 debug_printf(" %s %s\n", p->address, (p->onetime_parent == NULL)? US"" :
5498 /* Set up the buffers used for copying over the file when delivering. */
5500 deliver_in_buffer = store_malloc(DELIVER_IN_BUFFER_SIZE);
5501 deliver_out_buffer = store_malloc(DELIVER_OUT_BUFFER_SIZE);
5505 /* Until there are no more new addresses, handle each one as follows:
5507 . If this is a generated address (indicated by the presence of a parent
5508 pointer) then check to see whether it is a pipe, file, or autoreply, and
5509 if so, handle it directly here. The router that produced the address will
5510 have set the allow flags into the address, and also set the uid/gid required.
5511 Having the routers generate new addresses and then checking them here at
5512 the outer level is tidier than making each router do the checking, and
5513 means that routers don't need access to the failed address queue.
5515 . Break up the address into local part and domain, and make lowercased
5516 versions of these strings. We also make unquoted versions of the local part.
5518 . Handle the percent hack for those domains for which it is valid.
5520 . For child addresses, determine if any of the parents have the same address.
5521 If so, generate a different string for previous delivery checking. Without
5522 this code, if the address spqr generates spqr via a forward or alias file,
5523 delivery of the generated spqr stops further attempts at the top level spqr,
5524 which is not what is wanted - it may have generated other addresses.
5526 . Check on the retry database to see if routing was previously deferred, but
5527 only if in a queue run. Addresses that are to be routed are put on the
5528 addr_route chain. Addresses that are to be deferred are put on the
5529 addr_defer chain. We do all the checking first, so as not to keep the
5530 retry database open any longer than necessary.
5532 . Now we run the addresses through the routers. A router may put the address
5533 on either the addr_local or the addr_remote chain for local or remote
5534 delivery, respectively, or put it on the addr_failed chain if it is
5535 undeliveable, or it may generate child addresses and put them on the
5536 addr_new chain, or it may defer an address. All the chain anchors are
5537 passed as arguments so that the routers can be called for verification
5540 . If new addresses have been generated by the routers, da capo.
5543 header_rewritten = FALSE; /* No headers rewritten yet */
5544 while (addr_new != NULL) /* Loop until all addresses dealt with */
5546 address_item *addr, *parent;
5547 dbm_file = dbfn_open(US"retry", O_RDONLY, &dbblock, FALSE);
5549 /* Failure to open the retry database is treated the same as if it does
5550 not exist. In both cases, dbm_file is NULL. */
5552 if (dbm_file == NULL)
5554 DEBUG(D_deliver|D_retry|D_route|D_hints_lookup)
5555 debug_printf("no retry data available\n");
5558 /* Scan the current batch of new addresses, to handle pipes, files and
5559 autoreplies, and determine which others are ready for routing. */
5561 while (addr_new != NULL)
5566 dbdata_retry *domain_retry_record;
5567 dbdata_retry *address_retry_record;
5570 addr_new = addr->next;
5572 DEBUG(D_deliver|D_retry|D_route)
5574 debug_printf(">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>\n");
5575 debug_printf("Considering: %s\n", addr->address);
5578 /* Handle generated address that is a pipe or a file or an autoreply. */
5580 if (testflag(addr, af_pfr))
5582 /* If an autoreply in a filter could not generate a syntactically valid
5583 address, give up forthwith. Set af_ignore_error so that we don't try to
5584 generate a bounce. */
5586 if (testflag(addr, af_bad_reply))
5588 addr->basic_errno = ERRNO_BADADDRESS2;
5589 addr->local_part = addr->address;
5591 US"filter autoreply generated syntactically invalid recipient";
5592 setflag(addr, af_ignore_error);
5593 (void)post_process_one(addr, FAIL, LOG_MAIN, DTYPE_ROUTER, 0);
5594 continue; /* with the next new address */
5597 /* If two different users specify delivery to the same pipe or file or
5598 autoreply, there should be two different deliveries, so build a unique
5599 string that incorporates the original address, and use this for
5600 duplicate testing and recording delivery, and also for retrying. */
5603 string_sprintf("%s:%s", addr->address, addr->parent->unique +
5604 (testflag(addr->parent, af_homonym)? 3:0));
5606 addr->address_retry_key = addr->domain_retry_key =
5607 string_sprintf("T:%s", addr->unique);
5609 /* If a filter file specifies two deliveries to the same pipe or file,
5610 we want to de-duplicate, but this is probably not wanted for two mail
5611 commands to the same address, where probably both should be delivered.
5612 So, we have to invent a different unique string in that case. Just
5613 keep piling '>' characters on the front. */
5615 if (addr->address[0] == '>')
5617 while (tree_search(tree_duplicates, addr->unique) != NULL)
5618 addr->unique = string_sprintf(">%s", addr->unique);
5621 else if ((tnode = tree_search(tree_duplicates, addr->unique)) != NULL)
5623 DEBUG(D_deliver|D_route)
5624 debug_printf("%s is a duplicate address: discarded\n", addr->address);
5625 addr->dupof = tnode->data.ptr;
5626 addr->next = addr_duplicate;
5627 addr_duplicate = addr;
5631 DEBUG(D_deliver|D_route) debug_printf("unique = %s\n", addr->unique);
5633 /* Check for previous delivery */
5635 if (tree_search(tree_nonrecipients, addr->unique) != NULL)
5637 DEBUG(D_deliver|D_route)
5638 debug_printf("%s was previously delivered: discarded\n", addr->address);
5639 child_done(addr, tod_stamp(tod_log));
5643 /* Save for checking future duplicates */
5645 tree_add_duplicate(addr->unique, addr);
5647 /* Set local part and domain */
5649 addr->local_part = addr->address;
5650 addr->domain = addr->parent->domain;
5652 /* Ensure that the delivery is permitted. */
5654 if (testflag(addr, af_file))
5656 if (!testflag(addr, af_allow_file))
5658 addr->basic_errno = ERRNO_FORBIDFILE;
5659 addr->message = US"delivery to file forbidden";
5660 (void)post_process_one(addr, FAIL, LOG_MAIN, DTYPE_ROUTER, 0);
5661 continue; /* with the next new address */
5664 else if (addr->address[0] == '|')
5666 if (!testflag(addr, af_allow_pipe))
5668 addr->basic_errno = ERRNO_FORBIDPIPE;
5669 addr->message = US"delivery to pipe forbidden";
5670 (void)post_process_one(addr, FAIL, LOG_MAIN, DTYPE_ROUTER, 0);
5671 continue; /* with the next new address */
5674 else if (!testflag(addr, af_allow_reply))
5676 addr->basic_errno = ERRNO_FORBIDREPLY;
5677 addr->message = US"autoreply forbidden";
5678 (void)post_process_one(addr, FAIL, LOG_MAIN, DTYPE_ROUTER, 0);
5679 continue; /* with the next new address */
5682 /* If the errno field is already set to BADTRANSPORT, it indicates
5683 failure to expand a transport string, or find the associated transport,
5684 or an unset transport when one is required. Leave this test till now so
5685 that the forbid errors are given in preference. */
5687 if (addr->basic_errno == ERRNO_BADTRANSPORT)
5689 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_ROUTER, 0);
5693 /* Treat /dev/null as a special case and abandon the delivery. This
5694 avoids having to specify a uid on the transport just for this case.
5695 Arrange for the transport name to be logged as "**bypassed**". */
5697 if (Ustrcmp(addr->address, "/dev/null") == 0)
5699 uschar *save = addr->transport->name;
5700 addr->transport->name = US"**bypassed**";
5701 (void)post_process_one(addr, OK, LOG_MAIN, DTYPE_TRANSPORT, '=');
5702 addr->transport->name = save;
5703 continue; /* with the next new address */
5706 /* Pipe, file, or autoreply delivery is to go ahead as a normal local
5709 DEBUG(D_deliver|D_route)
5710 debug_printf("queued for %s transport\n", addr->transport->name);
5711 addr->next = addr_local;
5713 continue; /* with the next new address */
5716 /* Handle normal addresses. First, split up into local part and domain,
5717 handling the %-hack if necessary. There is the possibility of a defer from
5718 a lookup in percent_hack_domains. */
5720 if ((rc = deliver_split_address(addr)) == DEFER)
5722 addr->message = US"cannot check percent_hack_domains";
5723 addr->basic_errno = ERRNO_LISTDEFER;
5724 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_NONE, 0);
5728 /* Check to see if the domain is held. If so, proceed only if the
5729 delivery was forced by hand. */
5731 deliver_domain = addr->domain; /* set $domain */
5732 if (!forced && hold_domains != NULL &&
5733 (rc = match_isinlist(addr->domain, &hold_domains, 0,
5734 &domainlist_anchor, addr->domain_cache, MCL_DOMAIN, TRUE,
5739 addr->message = US"hold_domains lookup deferred";
5740 addr->basic_errno = ERRNO_LISTDEFER;
5744 addr->message = US"domain is held";
5745 addr->basic_errno = ERRNO_HELD;
5747 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_NONE, 0);
5751 /* Now we can check for duplicates and previously delivered addresses. In
5752 order to do this, we have to generate a "unique" value for each address,
5753 because there may be identical actual addresses in a line of descendents.
5754 The "unique" field is initialized to the same value as the "address" field,
5755 but gets changed here to cope with identically-named descendents. */
5757 for (parent = addr->parent; parent != NULL; parent = parent->parent)
5758 if (strcmpic(addr->address, parent->address) == 0) break;
5760 /* If there's an ancestor with the same name, set the homonym flag. This
5761 influences how deliveries are recorded. Then add a prefix on the front of
5762 the unique address. We use \n\ where n starts at 0 and increases each time.
5763 It is unlikely to pass 9, but if it does, it may look odd but will still
5764 work. This means that siblings or cousins with the same names are treated
5765 as duplicates, which is what we want. */
5769 setflag(addr, af_homonym);
5770 if (parent->unique[0] != '\\')
5771 addr->unique = string_sprintf("\\0\\%s", addr->address);
5773 addr->unique = string_sprintf("\\%c\\%s", parent->unique[1] + 1,
5777 /* Ensure that the domain in the unique field is lower cased, because
5778 domains are always handled caselessly. */
5780 p = Ustrrchr(addr->unique, '@');
5781 while (*p != 0) { *p = tolower(*p); p++; }
5783 DEBUG(D_deliver|D_route) debug_printf("unique = %s\n", addr->unique);
5785 if (tree_search(tree_nonrecipients, addr->unique) != NULL)
5787 DEBUG(D_deliver|D_route)
5788 debug_printf("%s was previously delivered: discarded\n", addr->unique);
5789 child_done(addr, tod_stamp(tod_log));
5793 /* Get the routing retry status, saving the two retry keys (with and
5794 without the local part) for subsequent use. If there is no retry record for
5795 the standard address routing retry key, we look for the same key with the
5796 sender attached, because this form is used by the smtp transport after a
5797 4xx response to RCPT when address_retry_include_sender is true. */
5799 addr->domain_retry_key = string_sprintf("R:%s", addr->domain);
5800 addr->address_retry_key = string_sprintf("R:%s@%s", addr->local_part,
5803 if (dbm_file == NULL)
5804 domain_retry_record = address_retry_record = NULL;
5807 domain_retry_record = dbfn_read(dbm_file, addr->domain_retry_key);
5808 if (domain_retry_record != NULL &&
5809 now - domain_retry_record->time_stamp > retry_data_expire)
5810 domain_retry_record = NULL; /* Ignore if too old */
5812 address_retry_record = dbfn_read(dbm_file, addr->address_retry_key);
5813 if (address_retry_record != NULL &&
5814 now - address_retry_record->time_stamp > retry_data_expire)
5815 address_retry_record = NULL; /* Ignore if too old */
5817 if (address_retry_record == NULL)
5819 uschar *altkey = string_sprintf("%s:<%s>", addr->address_retry_key,
5821 address_retry_record = dbfn_read(dbm_file, altkey);
5822 if (address_retry_record != NULL &&
5823 now - address_retry_record->time_stamp > retry_data_expire)
5824 address_retry_record = NULL; /* Ignore if too old */
5828 DEBUG(D_deliver|D_retry)
5830 if (domain_retry_record == NULL)
5831 debug_printf("no domain retry record\n");
5832 if (address_retry_record == NULL)
5833 debug_printf("no address retry record\n");
5836 /* If we are sending a message down an existing SMTP connection, we must
5837 assume that the message which created the connection managed to route
5838 an address to that connection. We do not want to run the risk of taking
5839 a long time over routing here, because if we do, the server at the other
5840 end of the connection may time it out. This is especially true for messages
5841 with lots of addresses. For this kind of delivery, queue_running is not
5842 set, so we would normally route all addresses. We take a pragmatic approach
5843 and defer routing any addresses that have any kind of domain retry record.
5844 That is, we don't even look at their retry times. It doesn't matter if this
5845 doesn't work occasionally. This is all just an optimization, after all.
5847 The reason for not doing the same for address retries is that they normally
5848 arise from 4xx responses, not DNS timeouts. */
5850 if (continue_hostname != NULL && domain_retry_record != NULL)
5852 addr->message = US"reusing SMTP connection skips previous routing defer";
5853 addr->basic_errno = ERRNO_RRETRY;
5854 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_ROUTER, 0);
5857 /* If we are in a queue run, defer routing unless there is no retry data or
5858 we've passed the next retry time, or this message is forced. In other
5859 words, ignore retry data when not in a queue run.
5861 However, if the domain retry time has expired, always allow the routing
5862 attempt. If it fails again, the address will be failed. This ensures that
5863 each address is routed at least once, even after long-term routing
5866 If there is an address retry, check that too; just wait for the next
5867 retry time. This helps with the case when the temporary error on the
5868 address was really message-specific rather than address specific, since
5869 it allows other messages through.
5871 We also wait for the next retry time if this is a message sent down an
5872 existing SMTP connection (even though that will be forced). Otherwise there
5873 will be far too many attempts for an address that gets a 4xx error. In
5874 fact, after such an error, we should not get here because, the host should
5875 not be remembered as one this message needs. However, there was a bug that
5876 used to cause this to happen, so it is best to be on the safe side.
5878 Even if we haven't reached the retry time in the hints, there is one more
5879 check to do, which is for the ultimate address timeout. We only do this
5880 check if there is an address retry record and there is not a domain retry
5881 record; this implies that previous attempts to handle the address had the
5882 retry_use_local_parts option turned on. We use this as an approximation
5883 for the destination being like a local delivery, for example delivery over
5884 LMTP to an IMAP message store. In this situation users are liable to bump
5885 into their quota and thereby have intermittently successful deliveries,
5886 which keep the retry record fresh, which can lead to us perpetually
5887 deferring messages. */
5889 else if (((queue_running && !deliver_force) || continue_hostname != NULL)
5891 ((domain_retry_record != NULL &&
5892 now < domain_retry_record->next_try &&
5893 !domain_retry_record->expired)
5895 (address_retry_record != NULL &&
5896 now < address_retry_record->next_try))
5898 (domain_retry_record != NULL ||
5899 address_retry_record == NULL ||
5900 !retry_ultimate_address_timeout(addr->address_retry_key,
5901 addr->domain, address_retry_record, now)))
5903 addr->message = US"retry time not reached";
5904 addr->basic_errno = ERRNO_RRETRY;
5905 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_ROUTER, 0);
5908 /* The domain is OK for routing. Remember if retry data exists so it
5909 can be cleaned up after a successful delivery. */
5913 if (domain_retry_record != NULL || address_retry_record != NULL)
5914 setflag(addr, af_dr_retry_exists);
5915 addr->next = addr_route;
5917 DEBUG(D_deliver|D_route)
5918 debug_printf("%s: queued for routing\n", addr->address);
5922 /* The database is closed while routing is actually happening. Requests to
5923 update it are put on a chain and all processed together at the end. */
5925 if (dbm_file != NULL) dbfn_close(dbm_file);
5927 /* If queue_domains is set, we don't even want to try routing addresses in
5928 those domains. During queue runs, queue_domains is forced to be unset.
5929 Optimize by skipping this pass through the addresses if nothing is set. */
5931 if (!deliver_force && queue_domains != NULL)
5933 address_item *okaddr = NULL;
5934 while (addr_route != NULL)
5936 address_item *addr = addr_route;
5937 addr_route = addr->next;
5939 deliver_domain = addr->domain; /* set $domain */
5940 if ((rc = match_isinlist(addr->domain, &queue_domains, 0,
5941 &domainlist_anchor, addr->domain_cache, MCL_DOMAIN, TRUE, NULL))
5946 addr->basic_errno = ERRNO_LISTDEFER;
5947 addr->message = US"queue_domains lookup deferred";
5948 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_ROUTER, 0);
5952 addr->next = okaddr;
5958 addr->basic_errno = ERRNO_QUEUE_DOMAIN;
5959 addr->message = US"domain is in queue_domains";
5960 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_ROUTER, 0);
5964 addr_route = okaddr;
5967 /* Now route those addresses that are not deferred. */
5969 while (addr_route != NULL)
5972 address_item *addr = addr_route;
5973 uschar *old_domain = addr->domain;
5974 uschar *old_unique = addr->unique;
5975 addr_route = addr->next;
5978 /* Just in case some router parameter refers to it. */
5980 return_path = (addr->p.errors_address != NULL)?
5981 addr->p.errors_address : sender_address;
5983 /* If a router defers an address, add a retry item. Whether or not to
5984 use the local part in the key is a property of the router. */
5986 if ((rc = route_address(addr, &addr_local, &addr_remote, &addr_new,
5987 &addr_succeed, v_none)) == DEFER)
5988 retry_add_item(addr, (addr->router->retry_use_local_part)?
5989 string_sprintf("R:%s@%s", addr->local_part, addr->domain) :
5990 string_sprintf("R:%s", addr->domain), 0);
5992 /* Otherwise, if there is an existing retry record in the database, add
5993 retry items to delete both forms. We must also allow for the possibility
5994 of a routing retry that includes the sender address. Since the domain might
5995 have been rewritten (expanded to fully qualified) as a result of routing,
5996 ensure that the rewritten form is also deleted. */
5998 else if (testflag(addr, af_dr_retry_exists))
6000 uschar *altkey = string_sprintf("%s:<%s>", addr->address_retry_key,
6002 retry_add_item(addr, altkey, rf_delete);
6003 retry_add_item(addr, addr->address_retry_key, rf_delete);
6004 retry_add_item(addr, addr->domain_retry_key, rf_delete);
6005 if (Ustrcmp(addr->domain, old_domain) != 0)
6006 retry_add_item(addr, string_sprintf("R:%s", old_domain), rf_delete);
6009 /* DISCARD is given for :blackhole: and "seen finish". The event has been
6010 logged, but we need to ensure the address (and maybe parents) is marked
6015 address_done(addr, tod_stamp(tod_log));
6016 continue; /* route next address */
6019 /* The address is finished with (failed or deferred). */
6023 (void)post_process_one(addr, rc, LOG_MAIN, DTYPE_ROUTER, 0);
6024 continue; /* route next address */
6027 /* The address has been routed. If the router changed the domain, it will
6028 also have changed the unique address. We have to test whether this address
6029 has already been delivered, because it's the unique address that finally
6032 if (addr->unique != old_unique &&
6033 tree_search(tree_nonrecipients, addr->unique) != 0)
6035 DEBUG(D_deliver|D_route) debug_printf("%s was previously delivered: "
6036 "discarded\n", addr->address);
6037 if (addr_remote == addr) addr_remote = addr->next;
6038 else if (addr_local == addr) addr_local = addr->next;
6041 /* If the router has same_domain_copy_routing set, we are permitted to copy
6042 the routing for any other addresses with the same domain. This is an
6043 optimisation to save repeated DNS lookups for "standard" remote domain
6044 routing. The option is settable only on routers that generate host lists.
6045 We play it very safe, and do the optimization only if the address is routed
6046 to a remote transport, there are no header changes, and the domain was not
6047 modified by the router. */
6049 if (addr_remote == addr &&
6050 addr->router->same_domain_copy_routing &&
6051 addr->p.extra_headers == NULL &&
6052 addr->p.remove_headers == NULL &&
6053 old_domain == addr->domain)
6055 address_item **chain = &addr_route;
6056 while (*chain != NULL)
6058 address_item *addr2 = *chain;
6059 if (Ustrcmp(addr2->domain, addr->domain) != 0)
6061 chain = &(addr2->next);
6065 /* Found a suitable address; take it off the routing list and add it to
6066 the remote delivery list. */
6068 *chain = addr2->next;
6069 addr2->next = addr_remote;
6070 addr_remote = addr2;
6072 /* Copy the routing data */
6074 addr2->domain = addr->domain;
6075 addr2->router = addr->router;
6076 addr2->transport = addr->transport;
6077 addr2->host_list = addr->host_list;
6078 addr2->fallback_hosts = addr->fallback_hosts;
6079 addr2->p.errors_address = addr->p.errors_address;
6080 copyflag(addr2, addr, af_hide_child | af_local_host_removed);
6082 DEBUG(D_deliver|D_route)
6084 debug_printf(">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>\n"
6086 "Routing for %s copied from %s\n",
6087 addr2->address, addr2->address, addr->address);
6091 } /* Continue with routing the next address. */
6092 } /* Loop to process any child addresses that the routers created, and
6093 any rerouted addresses that got put back on the new chain. */
6096 /* Debugging: show the results of the routing */
6098 DEBUG(D_deliver|D_retry|D_route)
6100 address_item *p = addr_local;
6101 debug_printf(">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>\n");
6102 debug_printf("After routing:\n Local deliveries:\n");
6105 debug_printf(" %s\n", p->address);
6110 debug_printf(" Remote deliveries:\n");
6113 debug_printf(" %s\n", p->address);
6118 debug_printf(" Failed addresses:\n");
6121 debug_printf(" %s\n", p->address);
6126 debug_printf(" Deferred addresses:\n");
6129 debug_printf(" %s\n", p->address);
6134 /* Free any resources that were cached during routing. */
6139 /* These two variables are set only during routing, after check_local_user.
6140 Ensure they are not set in transports. */
6142 local_user_gid = (gid_t)(-1);
6143 local_user_uid = (uid_t)(-1);
6145 /* Check for any duplicate addresses. This check is delayed until after
6146 routing, because the flexibility of the routing configuration means that
6147 identical addresses with different parentage may end up being redirected to
6148 different addresses. Checking for duplicates too early (as we previously used
6149 to) makes this kind of thing not work. */
6151 do_duplicate_check(&addr_local);
6152 do_duplicate_check(&addr_remote);
6154 /* When acting as an MUA wrapper, we proceed only if all addresses route to a
6155 remote transport. The check that they all end up in one transaction happens in
6156 the do_remote_deliveries() function. */
6158 if (mua_wrapper && (addr_local != NULL || addr_failed != NULL ||
6159 addr_defer != NULL))
6162 uschar *which, *colon, *msg;
6164 if (addr_local != NULL)
6169 else if (addr_defer != NULL)
6172 which = US"deferred";
6180 while (addr->parent != NULL) addr = addr->parent;
6182 if (addr->message != NULL)
6185 msg = addr->message;
6187 else colon = msg = US"";
6189 /* We don't need to log here for a forced failure as it will already
6190 have been logged. Defer will also have been logged, but as a defer, so we do
6191 need to do the failure logging. */
6193 if (addr != addr_failed)
6194 log_write(0, LOG_MAIN, "** %s routing yielded a %s delivery",
6195 addr->address, which);
6197 /* Always write an error to the caller */
6199 fprintf(stderr, "routing %s yielded a %s delivery%s%s\n", addr->address,
6202 final_yield = DELIVER_MUA_FAILED;
6203 addr_failed = addr_defer = NULL; /* So that we remove the message */
6204 goto DELIVERY_TIDYUP;
6208 /* If this is a run to continue deliveries to an external channel that is
6209 already set up, defer any local deliveries. */
6211 if (continue_transport != NULL)
6213 if (addr_defer == NULL) addr_defer = addr_local; else
6215 address_item *addr = addr_defer;
6216 while (addr->next != NULL) addr = addr->next;
6217 addr->next = addr_local;
6223 /* Because address rewriting can happen in the routers, we should not really do
6224 ANY deliveries until all addresses have been routed, so that all recipients of
6225 the message get the same headers. However, this is in practice not always
6226 possible, since sometimes remote addresses give DNS timeouts for days on end.
6227 The pragmatic approach is to deliver what we can now, saving any rewritten
6228 headers so that at least the next lot of recipients benefit from the rewriting
6229 that has already been done.
6231 If any headers have been rewritten during routing, update the spool file to
6232 remember them for all subsequent deliveries. This can be delayed till later if
6233 there is only address to be delivered - if it succeeds the spool write need not
6236 if (header_rewritten &&
6237 ((addr_local != NULL &&
6238 (addr_local->next != NULL || addr_remote != NULL)) ||
6239 (addr_remote != NULL && addr_remote->next != NULL)))
6241 /* Panic-dies on error */
6242 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
6243 header_rewritten = FALSE;
6247 /* If there are any deliveries to be done, open the journal file. This is used
6248 to record successful deliveries as soon as possible after each delivery is
6249 known to be complete. A file opened with O_APPEND is used so that several
6250 processes can run simultaneously.
6252 The journal is just insurance against crashes. When the spool file is
6253 ultimately updated at the end of processing, the journal is deleted. If a
6254 journal is found to exist at the start of delivery, the addresses listed
6255 therein are added to the non-recipients. */
6257 if (addr_local != NULL || addr_remote != NULL)
6259 sprintf(CS spoolname, "%s/input/%s/%s-J", spool_directory, message_subdir, id);
6260 journal_fd = Uopen(spoolname, O_WRONLY|O_APPEND|O_CREAT, SPOOL_MODE);
6264 log_write(0, LOG_MAIN|LOG_PANIC, "Couldn't open journal file %s: %s",
6265 spoolname, strerror(errno));
6266 return DELIVER_NOT_ATTEMPTED;
6269 /* Set the close-on-exec flag, make the file owned by Exim, and ensure
6270 that the mode is correct - the group setting doesn't always seem to get
6271 set automatically. */
6273 if( fcntl(journal_fd, F_SETFD, fcntl(journal_fd, F_GETFD) | FD_CLOEXEC)
6274 || fchown(journal_fd, exim_uid, exim_gid)
6275 || fchmod(journal_fd, SPOOL_MODE)
6278 int ret = Uunlink(spoolname);
6279 log_write(0, LOG_MAIN|LOG_PANIC, "Couldn't set perms on journal file %s: %s",
6280 spoolname, strerror(errno));
6281 if(ret && errno != ENOENT)
6282 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s",
6283 spoolname, strerror(errno));
6284 return DELIVER_NOT_ATTEMPTED;
6290 /* Now we can get down to the business of actually doing deliveries. Local
6291 deliveries are done first, then remote ones. If ever the problems of how to
6292 handle fallback transports are figured out, this section can be put into a loop
6293 for handling fallbacks, though the uid switching will have to be revised. */
6295 /* Precompile a regex that is used to recognize a parameter in response
6296 to an LHLO command, if is isn't already compiled. This may be used on both
6297 local and remote LMTP deliveries. */
6299 if (regex_IGNOREQUOTA == NULL) regex_IGNOREQUOTA =
6300 regex_must_compile(US"\\n250[\\s\\-]IGNOREQUOTA(\\s|\\n|$)", FALSE, TRUE);
6302 /* Handle local deliveries */
6304 if (addr_local != NULL)
6306 DEBUG(D_deliver|D_transport)
6307 debug_printf(">>>>>>>>>>>>>>>> Local deliveries >>>>>>>>>>>>>>>>\n");
6308 do_local_deliveries();
6309 disable_logging = FALSE;
6312 /* If queue_run_local is set, we do not want to attempt any remote deliveries,
6313 so just queue them all. */
6315 if (queue_run_local)
6317 while (addr_remote != NULL)
6319 address_item *addr = addr_remote;
6320 addr_remote = addr->next;
6322 addr->basic_errno = ERRNO_LOCAL_ONLY;
6323 addr->message = US"remote deliveries suppressed";
6324 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_TRANSPORT, 0);
6328 /* Handle remote deliveries */
6330 if (addr_remote != NULL)
6332 DEBUG(D_deliver|D_transport)
6333 debug_printf(">>>>>>>>>>>>>>>> Remote deliveries >>>>>>>>>>>>>>>>\n");
6335 /* Precompile some regex that are used to recognize parameters in response
6336 to an EHLO command, if they aren't already compiled. */
6338 if (regex_PIPELINING == NULL) regex_PIPELINING =
6339 regex_must_compile(US"\\n250[\\s\\-]PIPELINING(\\s|\\n|$)", FALSE, TRUE);
6341 if (regex_SIZE == NULL) regex_SIZE =
6342 regex_must_compile(US"\\n250[\\s\\-]SIZE(\\s|\\n|$)", FALSE, TRUE);
6344 if (regex_AUTH == NULL) regex_AUTH =
6345 regex_must_compile(US"\\n250[\\s\\-]AUTH\\s+([\\-\\w\\s]+)(?:\\n|$)",
6349 if (regex_STARTTLS == NULL) regex_STARTTLS =
6350 regex_must_compile(US"\\n250[\\s\\-]STARTTLS(\\s|\\n|$)", FALSE, TRUE);
6353 #ifndef DISABLE_PRDR
6354 if (regex_PRDR == NULL) regex_PRDR =
6355 regex_must_compile(US"\\n250[\\s\\-]PRDR(\\s|\\n|$)", FALSE, TRUE);
6358 #ifdef EXPERIMENTAL_DSN
6359 /* Set the regex to check for DSN support on remote MTA */
6360 if (regex_DSN == NULL) regex_DSN =
6361 regex_must_compile(US"\\n250[\\s\\-]DSN(\\s|\\n|$)", FALSE, TRUE);
6364 /* Now sort the addresses if required, and do the deliveries. The yield of
6365 do_remote_deliveries is FALSE when mua_wrapper is set and all addresses
6366 cannot be delivered in one transaction. */
6368 if (remote_sort_domains != NULL) sort_remote_deliveries();
6369 if (!do_remote_deliveries(FALSE))
6371 log_write(0, LOG_MAIN, "** mua_wrapper is set but recipients cannot all "
6372 "be delivered in one transaction");
6373 fprintf(stderr, "delivery to smarthost failed (configuration problem)\n");
6375 final_yield = DELIVER_MUA_FAILED;
6376 addr_failed = addr_defer = NULL; /* So that we remove the message */
6377 goto DELIVERY_TIDYUP;
6380 /* See if any of the addresses that failed got put on the queue for delivery
6381 to their fallback hosts. We do it this way because often the same fallback
6382 host is used for many domains, so all can be sent in a single transaction
6383 (if appropriately configured). */
6385 if (addr_fallback != NULL && !mua_wrapper)
6387 DEBUG(D_deliver) debug_printf("Delivering to fallback hosts\n");
6388 addr_remote = addr_fallback;
6389 addr_fallback = NULL;
6390 if (remote_sort_domains != NULL) sort_remote_deliveries();
6391 do_remote_deliveries(TRUE);
6393 disable_logging = FALSE;
6397 /* All deliveries are now complete. Ignore SIGTERM during this tidying up
6398 phase, to minimize cases of half-done things. */
6401 debug_printf(">>>>>>>>>>>>>>>> deliveries are done >>>>>>>>>>>>>>>>\n");
6403 /* Root privilege is no longer needed */
6405 exim_setugid(exim_uid, exim_gid, FALSE, US"post-delivery tidying");
6407 set_process_info("tidying up after delivering %s", message_id);
6408 signal(SIGTERM, SIG_IGN);
6410 /* When we are acting as an MUA wrapper, the smtp transport will either have
6411 succeeded for all addresses, or failed them all in normal cases. However, there
6412 are some setup situations (e.g. when a named port does not exist) that cause an
6413 immediate exit with deferral of all addresses. Convert those into failures. We
6414 do not ever want to retry, nor do we want to send a bounce message. */
6418 if (addr_defer != NULL)
6420 address_item *addr, *nextaddr;
6421 for (addr = addr_defer; addr != NULL; addr = nextaddr)
6423 log_write(0, LOG_MAIN, "** %s mua_wrapper forced failure for deferred "
6424 "delivery", addr->address);
6425 nextaddr = addr->next;
6426 addr->next = addr_failed;
6432 /* Now all should either have succeeded or failed. */
6434 if (addr_failed == NULL) final_yield = DELIVER_MUA_SUCCEEDED; else
6436 uschar *s = (addr_failed->user_message != NULL)?
6437 addr_failed->user_message : addr_failed->message;
6439 fprintf(stderr, "Delivery failed: ");
6440 if (addr_failed->basic_errno > 0)
6442 fprintf(stderr, "%s", strerror(addr_failed->basic_errno));
6443 if (s != NULL) fprintf(stderr, ": ");
6447 if (addr_failed->basic_errno <= 0) fprintf(stderr, "unknown error");
6449 else fprintf(stderr, "%s", CS s);
6450 fprintf(stderr, "\n");
6452 final_yield = DELIVER_MUA_FAILED;
6457 /* In a normal configuration, we now update the retry database. This is done in
6458 one fell swoop at the end in order not to keep opening and closing (and
6459 locking) the database. The code for handling retries is hived off into a
6460 separate module for convenience. We pass it the addresses of the various
6461 chains, because deferred addresses can get moved onto the failed chain if the
6462 retry cutoff time has expired for all alternative destinations. Bypass the
6463 updating of the database if the -N flag is set, which is a debugging thing that
6464 prevents actual delivery. */
6466 else if (!dont_deliver) retry_update(&addr_defer, &addr_failed, &addr_succeed);
6468 #ifdef EXPERIMENTAL_DSN
6469 /* Send DSN for successful messages */
6470 addr_dsntmp = addr_succeed;
6471 addr_senddsn = NULL;
6473 while(addr_dsntmp != NULL)
6476 debug_printf("DSN: processing router : %s\n", addr_dsntmp->router->name);
6479 debug_printf("DSN: processing successful delivery address: %s\n", addr_dsntmp->address);
6481 /* af_ignore_error not honored here. it's not an error */
6483 DEBUG(D_deliver) debug_printf("DSN: Sender_address: %s\n", sender_address);
6484 DEBUG(D_deliver) debug_printf("DSN: orcpt: %s flags: %d\n", addr_dsntmp->dsn_orcpt, addr_dsntmp->dsn_flags);
6485 DEBUG(D_deliver) debug_printf("DSN: envid: %s ret: %d\n", dsn_envid, dsn_ret);
6486 DEBUG(D_deliver) debug_printf("DSN: Final recipient: %s\n", addr_dsntmp->address);
6487 DEBUG(D_deliver) debug_printf("DSN: Remote SMTP server supports DSN: %d\n", addr_dsntmp->dsn_aware);
6489 /* send report if next hop not DSN aware or a router flagged "last DSN hop"
6490 and a report was requested */
6491 if (((addr_dsntmp->dsn_aware != dsn_support_yes) ||
6492 ((addr_dsntmp->dsn_flags & rf_dsnlasthop) != 0))
6494 (((addr_dsntmp->dsn_flags & rf_dsnflags) != 0) &&
6495 ((addr_dsntmp->dsn_flags & rf_notify_success) != 0)))
6497 /* copy and relink address_item and send report with all of them at once later */
6498 address_item *addr_next;
6499 addr_next = addr_senddsn;
6500 addr_senddsn = store_get(sizeof(address_item));
6501 memcpy(addr_senddsn, addr_dsntmp, sizeof(address_item));
6502 addr_senddsn->next = addr_next;
6506 DEBUG(D_deliver) debug_printf("DSN: *** NOT SENDING DSN SUCCESS Message ***\n");
6509 addr_dsntmp = addr_dsntmp->next;
6512 if (addr_senddsn != NULL)
6517 /* create exim process to send message */
6518 pid = child_open_exim(&fd);
6520 DEBUG(D_deliver) debug_printf("DSN: child_open_exim returns: %d\n", pid);
6522 if (pid < 0) /* Creation of child failed */
6524 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Process %d (parent %d) failed to "
6525 "create child process to send failure message: %s", getpid(),
6526 getppid(), strerror(errno));
6528 DEBUG(D_deliver) debug_printf("DSN: child_open_exim failed\n");
6531 else /* Creation of child succeeded */
6533 FILE *f = fdopen(fd, "wb");
6534 /* header only as required by RFC. only failure DSN needs to honor RET=FULL */
6535 int topt = topt_add_return_path | topt_no_body;
6536 uschar boundaryStr[64];
6538 DEBUG(D_deliver) debug_printf("sending error message to: %s\n", sender_address);
6540 /* build unique id for MIME boundary */
6541 snprintf(boundaryStr, sizeof(boundaryStr)-1, TIME_T_FMT "-eximdsn-%d",
6542 time(NULL), rand());
6543 DEBUG(D_deliver) debug_printf("DSN: MIME boundary: %s\n", boundaryStr);
6545 if (errors_reply_to)
6546 fprintf(f, "Reply-To: %s\n", errors_reply_to);
6548 fprintf(f, "Auto-Submitted: auto-generated\n"
6549 "From: Mail Delivery System <Mailer-Daemon@%s>\n"
6551 "Subject: Delivery Status Notification\n"
6552 "Content-Type: multipart/report; report-type=delivery-status; boundary=%s\n"
6553 "MIME-Version: 1.0\n\n"
6556 "Content-type: text/plain; charset=us-ascii\n\n"
6558 "This message was created automatically by mail delivery software.\n"
6559 " ----- The following addresses had successful delivery notifications -----\n",
6560 qualify_domain_sender, sender_address, boundaryStr, boundaryStr);
6562 addr_dsntmp = addr_senddsn;
6565 fprintf(f, "<%s> (relayed %s)\n\n",
6566 addr_dsntmp->address,
6567 (addr_dsntmp->dsn_flags & rf_dsnlasthop) == 1
6568 ? "via non DSN router"
6569 : addr_dsntmp->dsn_aware == dsn_support_no
6570 ? "to non-DSN-aware mailer"
6571 : "via non \"Remote SMTP\" router"
6573 addr_dsntmp = addr_dsntmp->next;
6576 "Content-type: message/delivery-status\n\n"
6577 "Reporting-MTA: dns; %s\n",
6578 boundaryStr, smtp_active_hostname);
6580 if (dsn_envid != NULL) {
6581 /* must be decoded from xtext: see RFC 3461:6.3a */
6583 if (auth_xtextdecode(dsn_envid, &xdec_envid) > 0)
6584 fprintf(f, "Original-Envelope-ID: %s\n", dsn_envid);
6586 fprintf(f, "X-Original-Envelope-ID: error decoding xtext formated ENVID\n");
6590 for (addr_dsntmp = addr_senddsn;
6592 addr_dsntmp = addr_dsntmp->next)
6594 if (addr_dsntmp->dsn_orcpt)
6595 fprintf(f,"Original-Recipient: %s\n", addr_dsntmp->dsn_orcpt);
6597 fprintf(f, "Action: delivered\n"
6598 "Final-Recipient: rfc822;%s\n"
6600 addr_dsntmp->address);
6602 if (addr_dsntmp->host_used && addr_dsntmp->host_used->name)
6603 fprintf(f, "Remote-MTA: dns; %s\nDiagnostic-Code: smtp; 250 Ok\n",
6604 addr_dsntmp->host_used->name);
6606 fprintf(f,"Diagnostic-Code: X-Exim; relayed via non %s router\n",
6607 (addr_dsntmp->dsn_flags & rf_dsnlasthop) == 1 ? "DSN" : "SMTP");
6611 fprintf(f, "--%s\nContent-type: text/rfc822-headers\n\n", boundaryStr);
6614 transport_filter_argv = NULL; /* Just in case */
6615 return_path = sender_address; /* In case not previously set */
6617 /* Write the original email out */
6618 transport_write_message(NULL, fileno(f), topt, 0, NULL, NULL, NULL, NULL, NULL, 0);
6622 fprintf(f,"--%s--\n", boundaryStr);
6626 rc = child_close(pid, 0); /* Waits for child to close, no timeout */
6629 #endif /*EXPERIMENTAL_DSN*/
6631 /* If any addresses failed, we must send a message to somebody, unless
6632 af_ignore_error is set, in which case no action is taken. It is possible for
6633 several messages to get sent if there are addresses with different
6636 while (addr_failed != NULL)
6640 uschar *logtod = tod_stamp(tod_log);
6642 address_item *handled_addr = NULL;
6643 address_item **paddr;
6644 address_item *msgchain = NULL;
6645 address_item **pmsgchain = &msgchain;
6647 /* There are weird cases when logging is disabled in the transport. However,
6648 there may not be a transport (address failed by a router). */
6650 disable_logging = FALSE;
6651 if (addr_failed->transport != NULL)
6652 disable_logging = addr_failed->transport->disable_logging;
6655 debug_printf("processing failed address %s\n", addr_failed->address);
6657 /* There are only two ways an address in a bounce message can get here:
6659 (1) When delivery was initially deferred, but has now timed out (in the call
6660 to retry_update() above). We can detect this by testing for
6661 af_retry_timedout. If the address does not have its own errors address,
6662 we arrange to ignore the error.
6664 (2) If delivery failures for bounce messages are being ignored. We can detect
6665 this by testing for af_ignore_error. This will also be set if a bounce
6666 message has been autothawed and the ignore_bounce_errors_after time has
6667 passed. It might also be set if a router was explicitly configured to
6668 ignore errors (errors_to = "").
6670 If neither of these cases obtains, something has gone wrong. Log the
6671 incident, but then ignore the error. */
6673 if (sender_address[0] == 0 && addr_failed->p.errors_address == NULL)
6675 if (!testflag(addr_failed, af_retry_timedout) &&
6676 !testflag(addr_failed, af_ignore_error))
6678 log_write(0, LOG_MAIN|LOG_PANIC, "internal error: bounce message "
6679 "failure is neither frozen nor ignored (it's been ignored)");
6681 setflag(addr_failed, af_ignore_error);
6684 /* If the first address on the list has af_ignore_error set, just remove
6685 it from the list, throw away any saved message file, log it, and
6686 mark the recipient done. */
6688 if (testflag(addr_failed, af_ignore_error)
6689 #ifdef EXPERIMENTAL_DSN
6690 || (((addr_failed->dsn_flags & rf_dsnflags) != 0)
6691 && ((addr_failed->dsn_flags & rf_notify_failure) != rf_notify_failure))
6696 addr_failed = addr->next;
6697 if (addr->return_filename != NULL) Uunlink(addr->return_filename);
6699 log_write(0, LOG_MAIN, "%s%s%s%s: error ignored",
6701 (addr->parent == NULL)? US"" : US" <",
6702 (addr->parent == NULL)? US"" : addr->parent->address,
6703 (addr->parent == NULL)? US"" : US">");
6705 address_done(addr, logtod);
6706 child_done(addr, logtod);
6707 /* Panic-dies on error */
6708 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
6711 /* Otherwise, handle the sending of a message. Find the error address for
6712 the first address, then send a message that includes all failed addresses
6713 that have the same error address. Note the bounce_recipient is a global so
6714 that it can be accesssed by $bounce_recipient while creating a customized
6719 bounce_recipient = (addr_failed->p.errors_address == NULL)?
6720 sender_address : addr_failed->p.errors_address;
6722 /* Make a subprocess to send a message */
6724 pid = child_open_exim(&fd);
6726 /* Creation of child failed */
6729 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Process %d (parent %d) failed to "
6730 "create child process to send failure message: %s", getpid(),
6731 getppid(), strerror(errno));
6733 /* Creation of child succeeded */
6740 uschar *bcc, *emf_text;
6741 FILE *f = fdopen(fd, "wb");
6743 BOOL to_sender = strcmpic(sender_address, bounce_recipient) == 0;
6744 int max = (bounce_return_size_limit/DELIVER_IN_BUFFER_SIZE + 1) *
6745 DELIVER_IN_BUFFER_SIZE;
6746 #ifdef EXPERIMENTAL_DSN
6747 uschar boundaryStr[64];
6748 uschar *dsnlimitmsg;
6749 uschar *dsnnotifyhdr;
6754 debug_printf("sending error message to: %s\n", bounce_recipient);
6756 /* Scan the addresses for all that have the same errors address, removing
6757 them from the addr_failed chain, and putting them on msgchain. */
6759 paddr = &addr_failed;
6760 for (addr = addr_failed; addr != NULL; addr = *paddr)
6762 if (Ustrcmp(bounce_recipient, (addr->p.errors_address == NULL)?
6763 sender_address : addr->p.errors_address) != 0)
6765 paddr = &(addr->next); /* Not the same; skip */
6767 else /* The same - dechain */
6769 *paddr = addr->next;
6772 pmsgchain = &(addr->next);
6776 /* Include X-Failed-Recipients: for automatic interpretation, but do
6777 not let any one header line get too long. We do this by starting a
6778 new header every 50 recipients. Omit any addresses for which the
6779 "hide_child" flag is set. */
6781 for (addr = msgchain; addr != NULL; addr = addr->next)
6783 if (testflag(addr, af_hide_child)) continue;
6790 (rcount++ == 0)? "X-Failed-Recipients: " : ",\n ",
6791 (testflag(addr, af_pfr) && addr->parent != NULL)?
6792 string_printing(addr->parent->address) :
6793 string_printing(addr->address));
6795 if (rcount > 0) fprintf(f, "\n");
6797 /* Output the standard headers */
6799 if (errors_reply_to != NULL)
6800 fprintf(f, "Reply-To: %s\n", errors_reply_to);
6801 fprintf(f, "Auto-Submitted: auto-replied\n");
6803 fprintf(f, "To: %s\n", bounce_recipient);
6805 #ifdef EXPERIMENTAL_DSN
6806 /* generate boundary string and output MIME-Headers */
6807 snprintf(boundaryStr, sizeof(boundaryStr)-1, TIME_T_FMT "-eximdsn-%d",
6808 time(NULL), rand());
6810 fprintf(f, "Content-Type: multipart/report;"
6811 " report-type=delivery-status; boundary=%s\n"
6812 "MIME-Version: 1.0\n",
6816 /* Open a template file if one is provided. Log failure to open, but
6817 carry on - default texts will be used. */
6819 if (bounce_message_file)
6820 if (!(emf = Ufopen(bounce_message_file, "rb")))
6821 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to open %s for error "
6822 "message texts: %s", bounce_message_file, strerror(errno));
6824 /* Quietly copy to configured additional addresses if required. */
6826 if ((bcc = moan_check_errorcopy(bounce_recipient)))
6827 fprintf(f, "Bcc: %s\n", bcc);
6829 /* The texts for the message can be read from a template file; if there
6830 isn't one, or if it is too short, built-in texts are used. The first
6831 emf text is a Subject: and any other headers. */
6833 if ((emf_text = next_emf(emf, US"header")))
6834 fprintf(f, "%s\n", emf_text);
6836 fprintf(f, "Subject: Mail delivery failed%s\n\n",
6837 to_sender? ": returning message to sender" : "");
6839 #ifdef EXPERIMENTAL_DSN
6840 /* output human readable part as text/plain section */
6842 "Content-type: text/plain; charset=us-ascii\n\n",
6846 if ((emf_text = next_emf(emf, US"intro")))
6847 fprintf(f, "%s", CS emf_text);
6851 /* This message has been reworded several times. It seems to be confusing to
6852 somebody, however it is worded. I have retreated to the original, simple
6854 "This message was created automatically by mail delivery software.\n");
6856 if (bounce_message_text)
6857 fprintf(f, "%s", CS bounce_message_text);
6860 "\nA message that you sent could not be delivered to one or more of its\n"
6861 "recipients. This is a permanent error. The following address(es) failed:\n");
6864 "\nA message sent by\n\n <%s>\n\n"
6865 "could not be delivered to one or more of its recipients. The following\n"
6866 "address(es) failed:\n", sender_address);
6870 /* Process the addresses, leaving them on the msgchain if they have a
6871 file name for a return message. (There has already been a check in
6872 post_process_one() for the existence of data in the message file.) A TRUE
6873 return from print_address_information() means that the address is not
6877 for (addr = msgchain; addr != NULL; addr = *paddr)
6879 if (print_address_information(addr, f, US" ", US"\n ", US""))
6880 print_address_error(addr, f, US"");
6882 /* End the final line for the address */
6886 /* Leave on msgchain if there's a return file. */
6888 if (addr->return_file >= 0)
6890 paddr = &(addr->next);
6894 /* Else save so that we can tick off the recipient when the
6899 *paddr = addr->next;
6900 addr->next = handled_addr;
6901 handled_addr = addr;
6907 /* Get the next text, whether we need it or not, so as to be
6908 positioned for the one after. */
6910 emf_text = next_emf(emf, US"generated text");
6912 /* If there were any file messages passed by the local transports,
6913 include them in the message. Then put the address on the handled chain.
6914 In the case of a batch of addresses that were all sent to the same
6915 transport, the return_file field in all of them will contain the same
6916 fd, and the return_filename field in the *last* one will be set (to the
6917 name of the file). */
6921 address_item *nextaddr;
6924 fprintf(f, "%s", CS emf_text);
6927 "The following text was generated during the delivery "
6928 "attempt%s:\n", (filecount > 1)? "s" : "");
6930 for (addr = msgchain; addr != NULL; addr = nextaddr)
6933 address_item *topaddr = addr;
6935 /* List all the addresses that relate to this file */
6938 while(addr) /* Insurance */
6940 print_address_information(addr, f, US"------ ", US"\n ",
6942 if (addr->return_filename) break;
6947 /* Now copy the file */
6949 fm = Ufopen(addr->return_filename, "rb");
6952 fprintf(f, " +++ Exim error... failed to open text file: %s\n",
6956 while ((ch = fgetc(fm)) != EOF) fputc(ch, f);
6959 Uunlink(addr->return_filename);
6961 /* Can now add to handled chain, first fishing off the next
6962 address on the msgchain. */
6964 nextaddr = addr->next;
6965 addr->next = handled_addr;
6966 handled_addr = topaddr;
6971 #ifdef EXPERIMENTAL_DSN
6972 /* output machine readable part */
6974 "Content-type: message/delivery-status\n\n"
6975 "Reporting-MTA: dns; %s\n",
6976 boundaryStr, smtp_active_hostname);
6980 /* must be decoded from xtext: see RFC 3461:6.3a */
6982 if (auth_xtextdecode(dsn_envid, &xdec_envid) > 0)
6983 fprintf(f, "Original-Envelope-ID: %s\n", dsn_envid);
6985 fprintf(f, "X-Original-Envelope-ID: error decoding xtext formated ENVID\n");
6989 for (addr = handled_addr; addr; addr = addr->next)
6991 fprintf(f, "Action: failed\n"
6992 "Final-Recipient: rfc822;%s\n"
6995 if (addr->host_used && addr->host_used->name)
6996 fprintf(f, "Remote-MTA: dns; %s\nDiagnostic-Code: smtp; %d\n",
6997 addr->host_used->name, addr->basic_errno);
7001 /* Now copy the message, trying to give an intelligible comment if
7002 it is too long for it all to be copied. The limit isn't strictly
7003 applied because of the buffering. There is, however, an option
7004 to suppress copying altogether. */
7006 emf_text = next_emf(emf, US"copy");
7008 #ifndef EXPERIMENTAL_DSN
7009 if (bounce_return_message)
7011 int topt = topt_add_return_path;
7012 if (!bounce_return_body) topt |= topt_no_body;
7015 fprintf(f, "%s", CS emf_text);
7018 if (bounce_return_body) fprintf(f,
7019 "------ This is a copy of the message, including all the headers. ------\n");
7021 "------ This is a copy of the message's headers. ------\n");
7024 /* While reading the "truncated" message, set return_size_limit to
7025 the actual max testing value, rounded. We need to read the message
7026 whether we are going to use it or not. */
7029 int temp = bounce_return_size_limit;
7030 bounce_return_size_limit = (max/1000)*1000;
7031 emf_text = next_emf(emf, US"truncated");
7032 bounce_return_size_limit = temp;
7035 if (bounce_return_body && bounce_return_size_limit > 0)
7037 struct stat statbuf;
7038 if (fstat(deliver_datafile, &statbuf) == 0 && statbuf.st_size > max)
7041 fprintf(f, "%s", CS emf_text);
7044 "------ The body of the message is " OFF_T_FMT " characters long; only the first\n"
7045 "------ %d or so are included here.\n", statbuf.st_size, max);
7052 transport_filter_argv = NULL; /* Just in case */
7053 return_path = sender_address; /* In case not previously set */
7054 transport_write_message(NULL, fileno(f), topt,
7055 bounce_return_size_limit, NULL, NULL, NULL, NULL, NULL, 0);
7058 /* Write final text and close the template file if one is open */
7062 if ((emf_text = next_emf(emf, US"final")))
7063 fprintf(f, "%s", CS emf_text);
7068 we ignore the intro text from template and add
7069 the text for bounce_return_size_limit at the end.
7071 bounce_return_message is ignored
7072 in case RET= is defined we honor these values
7073 otherwise bounce_return_body is honored.
7075 bounce_return_size_limit is always honored.
7078 fprintf(f, "\n--%s\n", boundaryStr);
7080 dsnlimitmsg = US"X-Exim-DSN-Information: Due to administrative limits only headers are returned";
7081 dsnnotifyhdr = NULL;
7082 topt = topt_add_return_path;
7084 /* RET=HDRS? top priority */
7085 if (dsn_ret == dsn_ret_hdrs)
7086 topt |= topt_no_body;
7088 /* no full body return at all? */
7089 if (!bounce_return_body)
7091 topt |= topt_no_body;
7092 /* add header if we overrule RET=FULL */
7093 if (dsn_ret == dsn_ret_full)
7094 dsnnotifyhdr = dsnlimitmsg;
7096 /* size limited ... return headers only if limit reached */
7097 else if (bounce_return_size_limit > 0)
7099 struct stat statbuf;
7100 if (fstat(deliver_datafile, &statbuf) == 0 && statbuf.st_size > max)
7102 topt |= topt_no_body;
7103 dsnnotifyhdr = dsnlimitmsg;
7107 if (topt & topt_no_body)
7108 fprintf(f,"Content-type: text/rfc822-headers\n\n");
7110 fprintf(f,"Content-type: message/rfc822\n\n");
7113 transport_filter_argv = NULL; /* Just in case */
7114 return_path = sender_address; /* In case not previously set */
7115 transport_write_message(NULL, fileno(f), topt,
7116 0, dsnnotifyhdr, NULL, NULL, NULL, NULL, 0);
7119 /* we never add the final text. close the file */
7123 fprintf(f, "\n--%s--\n", boundaryStr);
7124 #endif /*EXPERIMENTAL_DSN*/
7126 /* Close the file, which should send an EOF to the child process
7127 that is receiving the message. Wait for it to finish. */
7130 rc = child_close(pid, 0); /* Waits for child to close, no timeout */
7132 /* In the test harness, let the child do it's thing first. */
7134 if (running_in_test_harness) millisleep(500);
7136 /* If the process failed, there was some disaster in setting up the
7137 error message. Unless the message is very old, ensure that addr_defer
7138 is non-null, which will have the effect of leaving the message on the
7139 spool. The failed addresses will get tried again next time. However, we
7140 don't really want this to happen too often, so freeze the message unless
7141 there are some genuine deferred addresses to try. To do this we have
7142 to call spool_write_header() here, because with no genuine deferred
7143 addresses the normal code below doesn't get run. */
7148 if (now - received_time < retry_maximum_timeout && addr_defer == NULL)
7150 addr_defer = (address_item *)(+1);
7151 deliver_freeze = TRUE;
7152 deliver_frozen_at = time(NULL);
7153 /* Panic-dies on error */
7154 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
7157 deliver_msglog("Process failed (%d) when writing error message "
7158 "to %s%s", rc, bounce_recipient, s);
7159 log_write(0, LOG_MAIN, "Process failed (%d) when writing error message "
7160 "to %s%s", rc, bounce_recipient, s);
7163 /* The message succeeded. Ensure that the recipients that failed are
7164 now marked finished with on the spool and their parents updated. */
7168 for (addr = handled_addr; addr != NULL; addr = addr->next)
7170 address_done(addr, logtod);
7171 child_done(addr, logtod);
7173 /* Panic-dies on error */
7174 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
7180 disable_logging = FALSE; /* In case left set */
7182 /* Come here from the mua_wrapper case if routing goes wrong */
7186 /* If there are now no deferred addresses, we are done. Preserve the
7187 message log if so configured, and we are using them. Otherwise, sling it.
7188 Then delete the message itself. */
7190 if (addr_defer == NULL)
7194 sprintf(CS spoolname, "%s/msglog/%s/%s", spool_directory, message_subdir,
7196 if (preserve_message_logs)
7199 sprintf(CS big_buffer, "%s/msglog.OLD/%s", spool_directory, id);
7200 if ((rc = Urename(spoolname, big_buffer)) < 0)
7202 (void)directory_make(spool_directory, US"msglog.OLD",
7203 MSGLOG_DIRECTORY_MODE, TRUE);
7204 rc = Urename(spoolname, big_buffer);
7207 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to move %s to the "
7208 "msglog.OLD directory", spoolname);
7212 if (Uunlink(spoolname) < 0)
7213 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s",
7214 spoolname, strerror(errno));
7218 /* Remove the two message files. */
7220 sprintf(CS spoolname, "%s/input/%s/%s-D", spool_directory, message_subdir, id);
7221 if (Uunlink(spoolname) < 0)
7222 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s",
7223 spoolname, strerror(errno));
7224 sprintf(CS spoolname, "%s/input/%s/%s-H", spool_directory, message_subdir, id);
7225 if (Uunlink(spoolname) < 0)
7226 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s",
7227 spoolname, strerror(errno));
7229 /* Log the end of this message, with queue time if requested. */
7231 if ((log_extra_selector & LX_queue_time_overall) != 0)
7232 log_write(0, LOG_MAIN, "Completed QT=%s",
7233 readconf_printtime( (int) ((long)time(NULL) - (long)received_time)) );
7235 log_write(0, LOG_MAIN, "Completed");
7237 /* Unset deliver_freeze so that we won't try to move the spool files further down */
7238 deliver_freeze = FALSE;
7241 /* If there are deferred addresses, we are keeping this message because it is
7242 not yet completed. Lose any temporary files that were catching output from
7243 pipes for any of the deferred addresses, handle one-time aliases, and see if
7244 the message has been on the queue for so long that it is time to send a warning
7245 message to the sender, unless it is a mailer-daemon. If all deferred addresses
7246 have the same domain, we can set deliver_domain for the expansion of
7247 delay_warning_ condition - if any of them are pipes, files, or autoreplies, use
7248 the parent's domain.
7250 If all the deferred addresses have an error number that indicates "retry time
7251 not reached", skip sending the warning message, because it won't contain the
7252 reason for the delay. It will get sent at the next real delivery attempt.
7253 However, if at least one address has tried, we'd better include all of them in
7256 If we can't make a process to send the message, don't worry.
7258 For mailing list expansions we want to send the warning message to the
7259 mailing list manager. We can't do a perfect job here, as some addresses may
7260 have different errors addresses, but if we take the errors address from
7261 each deferred address it will probably be right in most cases.
7263 If addr_defer == +1, it means there was a problem sending an error message
7264 for failed addresses, and there were no "real" deferred addresses. The value
7265 was set just to keep the message on the spool, so there is nothing to do here.
7268 else if (addr_defer != (address_item *)(+1))
7271 uschar *recipients = US"";
7272 BOOL delivery_attempted = FALSE;
7274 deliver_domain = testflag(addr_defer, af_pfr)?
7275 addr_defer->parent->domain : addr_defer->domain;
7277 for (addr = addr_defer; addr != NULL; addr = addr->next)
7279 address_item *otaddr;
7281 if (addr->basic_errno > ERRNO_RETRY_BASE) delivery_attempted = TRUE;
7283 if (deliver_domain != NULL)
7285 uschar *d = (testflag(addr, af_pfr))? addr->parent->domain : addr->domain;
7287 /* The domain may be unset for an address that has never been routed
7288 because the system filter froze the message. */
7290 if (d == NULL || Ustrcmp(d, deliver_domain) != 0) deliver_domain = NULL;
7293 if (addr->return_filename != NULL) Uunlink(addr->return_filename);
7295 /* Handle the case of one-time aliases. If any address in the ancestry
7296 of this one is flagged, ensure it is in the recipients list, suitably
7297 flagged, and that its parent is marked delivered. */
7299 for (otaddr = addr; otaddr != NULL; otaddr = otaddr->parent)
7300 if (otaddr->onetime_parent != NULL) break;
7305 int t = recipients_count;
7307 for (i = 0; i < recipients_count; i++)
7309 uschar *r = recipients_list[i].address;
7310 if (Ustrcmp(otaddr->onetime_parent, r) == 0) t = i;
7311 if (Ustrcmp(otaddr->address, r) == 0) break;
7314 /* Didn't find the address already in the list, and did find the
7315 ultimate parent's address in the list. After adding the recipient,
7316 update the errors address in the recipients list. */
7318 if (i >= recipients_count && t < recipients_count)
7320 DEBUG(D_deliver) debug_printf("one_time: adding %s in place of %s\n",
7321 otaddr->address, otaddr->parent->address);
7322 receive_add_recipient(otaddr->address, t);
7323 recipients_list[recipients_count-1].errors_to = otaddr->p.errors_address;
7324 tree_add_nonrecipient(otaddr->parent->address);
7325 update_spool = TRUE;
7329 /* Except for error messages, ensure that either the errors address for
7330 this deferred address or, if there is none, the sender address, is on the
7331 list of recipients for a warning message. */
7333 if (sender_address[0] != 0)
7335 if (addr->p.errors_address == NULL)
7337 if (Ustrstr(recipients, sender_address) == NULL)
7338 recipients = string_sprintf("%s%s%s", recipients,
7339 (recipients[0] == 0)? "" : ",", sender_address);
7343 if (Ustrstr(recipients, addr->p.errors_address) == NULL)
7344 recipients = string_sprintf("%s%s%s", recipients,
7345 (recipients[0] == 0)? "" : ",", addr->p.errors_address);
7350 /* Send a warning message if the conditions are right. If the condition check
7351 fails because of a lookup defer, there is nothing we can do. The warning
7352 is not sent. Another attempt will be made at the next delivery attempt (if
7355 if (!queue_2stage && delivery_attempted &&
7356 #ifdef EXPERIMENTAL_DSN
7357 (((addr_defer->dsn_flags & rf_dsnflags) == 0) ||
7358 (addr_defer->dsn_flags & rf_notify_delay) == rf_notify_delay) &&
7360 delay_warning[1] > 0 && sender_address[0] != 0 &&
7361 (delay_warning_condition == NULL ||
7362 expand_check_condition(delay_warning_condition,
7363 US"delay_warning", US"option")))
7367 int queue_time = time(NULL) - received_time;
7369 /* When running in the test harness, there's an option that allows us to
7370 fudge this time so as to get repeatability of the tests. Take the first
7371 time off the list. In queue runs, the list pointer gets updated in the
7374 if (running_in_test_harness && fudged_queue_times[0] != 0)
7376 int qt = readconf_readtime(fudged_queue_times, '/', FALSE);
7379 DEBUG(D_deliver) debug_printf("fudged queue_times = %s\n",
7380 fudged_queue_times);
7385 /* See how many warnings we should have sent by now */
7387 for (count = 0; count < delay_warning[1]; count++)
7388 if (queue_time < delay_warning[count+2]) break;
7390 show_time = delay_warning[count+1];
7392 if (count >= delay_warning[1])
7395 int last_gap = show_time;
7396 if (count > 1) last_gap -= delay_warning[count];
7397 extra = (queue_time - delay_warning[count+1])/last_gap;
7398 show_time += last_gap * extra;
7404 debug_printf("time on queue = %s\n", readconf_printtime(queue_time));
7405 debug_printf("warning counts: required %d done %d\n", count,
7409 /* We have computed the number of warnings there should have been by now.
7410 If there haven't been enough, send one, and up the count to what it should
7413 if (warning_count < count)
7417 pid_t pid = child_open_exim(&fd);
7423 FILE *f = fdopen(fd, "wb");
7424 #ifdef EXPERIMENTAL_DSN
7425 uschar boundaryStr[64];
7428 if (warn_message_file)
7430 wmf = Ufopen(warn_message_file, "rb");
7432 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to open %s for warning "
7433 "message texts: %s", warn_message_file, strerror(errno));
7436 warnmsg_recipients = recipients;
7437 warnmsg_delay = (queue_time < 120*60)?
7438 string_sprintf("%d minutes", show_time/60):
7439 string_sprintf("%d hours", show_time/3600);
7441 if (errors_reply_to)
7442 fprintf(f, "Reply-To: %s\n", errors_reply_to);
7443 fprintf(f, "Auto-Submitted: auto-replied\n");
7445 fprintf(f, "To: %s\n", recipients);
7447 #ifdef EXPERIMENTAL_DSN
7448 /* generated boundary string and output MIME-Headers */
7449 snprintf(boundaryStr, sizeof(boundaryStr)-1,
7450 TIME_T_FMT "-eximdsn-%d", time(NULL), rand());
7452 fprintf(f, "Content-Type: multipart/report;"
7453 " report-type=delivery-status; boundary=%s\n"
7454 "MIME-Version: 1.0\n",
7458 if ((wmf_text = next_emf(wmf, US"header")))
7459 fprintf(f, "%s\n", wmf_text);
7461 fprintf(f, "Subject: Warning: message %s delayed %s\n\n",
7462 message_id, warnmsg_delay);
7464 #ifdef EXPERIMENTAL_DSN
7465 /* output human readable part as text/plain section */
7467 "Content-type: text/plain; charset=us-ascii\n\n",
7471 if ((wmf_text = next_emf(wmf, US"intro")))
7472 fprintf(f, "%s", CS wmf_text);
7476 "This message was created automatically by mail delivery software.\n");
7478 if (Ustrcmp(recipients, sender_address) == 0)
7480 "A message that you sent has not yet been delivered to one or more of its\n"
7481 "recipients after more than ");
7485 "A message sent by\n\n <%s>\n\n"
7486 "has not yet been delivered to one or more of its recipients after more than \n",
7489 fprintf(f, "%s on the queue on %s.\n\n"
7490 "The message identifier is: %s\n",
7491 warnmsg_delay, primary_hostname, message_id);
7493 for (h = header_list; h != NULL; h = h->next)
7494 if (strncmpic(h->text, US"Subject:", 8) == 0)
7495 fprintf(f, "The subject of the message is: %s", h->text + 9);
7496 else if (strncmpic(h->text, US"Date:", 5) == 0)
7497 fprintf(f, "The date of the message is: %s", h->text + 6);
7500 fprintf(f, "The address%s to which the message has not yet been "
7502 !addr_defer->next ? "" : "es",
7503 !addr_defer->next ? "is": "are");
7506 /* List the addresses, with error information if allowed */
7508 #ifdef EXPERIMENTAL_DSN
7509 /* store addr_defer for machine readable part */
7510 address_item *addr_dsndefer = addr_defer;
7515 address_item *addr = addr_defer;
7516 addr_defer = addr->next;
7517 if (print_address_information(addr, f, US" ", US"\n ", US""))
7518 print_address_error(addr, f, US"Delay reason: ");
7527 if ((wmf_text = next_emf(wmf, US"final")))
7528 fprintf(f, "%s", CS wmf_text);
7534 "No action is required on your part. Delivery attempts will continue for\n"
7535 "some time, and this warning may be repeated at intervals if the message\n"
7536 "remains undelivered. Eventually the mail delivery software will give up,\n"
7537 "and when that happens, the message will be returned to you.\n");
7540 #ifdef EXPERIMENTAL_DSN
7541 /* output machine readable part */
7542 fprintf(f, "\n--%s\n"
7543 "Content-type: message/delivery-status\n\n"
7544 "Reporting-MTA: dns; %s\n",
7546 smtp_active_hostname);
7551 /* must be decoded from xtext: see RFC 3461:6.3a */
7553 if (auth_xtextdecode(dsn_envid, &xdec_envid) > 0)
7554 fprintf(f,"Original-Envelope-ID: %s\n", dsn_envid);
7556 fprintf(f,"X-Original-Envelope-ID: error decoding xtext formated ENVID\n");
7560 while (addr_dsndefer)
7562 if (addr_dsndefer->dsn_orcpt)
7563 fprintf(f,"Original-Recipient: %s\n", addr_dsndefer->dsn_orcpt);
7565 fprintf(f,"Action: delayed\n");
7566 fprintf(f,"Final-Recipient: rfc822;%s\n", addr_dsndefer->address);
7567 fprintf(f,"Status: 4.0.0\n");
7568 if (addr_dsndefer->host_used && addr_dsndefer->host_used->name)
7569 fprintf(f,"Remote-MTA: dns; %s\nDiagnostic-Code: smtp; %d\n",
7570 addr_dsndefer->host_used->name, addr_dsndefer->basic_errno);
7571 addr_dsndefer = addr_dsndefer->next;
7574 fprintf(f, "\n--%s\n"
7575 "Content-type: text/rfc822-headers\n\n",
7579 /* header only as required by RFC. only failure DSN needs to honor RET=FULL */
7580 int topt = topt_add_return_path | topt_no_body;
7581 transport_filter_argv = NULL; /* Just in case */
7582 return_path = sender_address; /* In case not previously set */
7583 /* Write the original email out */
7584 transport_write_message(NULL, fileno(f), topt, 0, NULL, NULL, NULL, NULL, NULL, 0);
7587 fprintf(f,"\n--%s--\n", boundaryStr);
7590 #endif /*EXPERIMENTAL_DSN*/
7592 /* Close and wait for child process to complete, without a timeout.
7593 If there's an error, don't update the count. */
7596 if (child_close(pid, 0) == 0)
7598 warning_count = count;
7599 update_spool = TRUE; /* Ensure spool rewritten */
7605 /* Clear deliver_domain */
7607 deliver_domain = NULL;
7609 /* If this was a first delivery attempt, unset the first time flag, and
7610 ensure that the spool gets updated. */
7612 if (deliver_firsttime)
7614 deliver_firsttime = FALSE;
7615 update_spool = TRUE;
7618 /* If delivery was frozen and freeze_tell is set, generate an appropriate
7619 message, unless the message is a local error message (to avoid loops). Then
7620 log the freezing. If the text in "frozen_info" came from a system filter,
7621 it has been escaped into printing characters so as not to mess up log lines.
7622 For the "tell" message, we turn \n back into newline. Also, insert a newline
7623 near the start instead of the ": " string. */
7627 if (freeze_tell != NULL && freeze_tell[0] != 0 && !local_error_message)
7629 uschar *s = string_copy(frozen_info);
7630 uschar *ss = Ustrstr(s, " by the system filter: ");
7641 if (*ss == '\\' && ss[1] == 'n')
7648 moan_tell_someone(freeze_tell, addr_defer, US"Message frozen",
7649 "Message %s has been frozen%s.\nThe sender is <%s>.\n", message_id,
7653 /* Log freezing just before we update the -H file, to minimize the chance
7654 of a race problem. */
7656 deliver_msglog("*** Frozen%s\n", frozen_info);
7657 log_write(0, LOG_MAIN, "Frozen%s", frozen_info);
7660 /* If there have been any updates to the non-recipients list, or other things
7661 that get written to the spool, we must now update the spool header file so
7662 that it has the right information for the next delivery attempt. If there
7663 was more than one address being delivered, the header_change update is done
7664 earlier, in case one succeeds and then something crashes. */
7667 debug_printf("delivery deferred: update_spool=%d header_rewritten=%d\n",
7668 update_spool, header_rewritten);
7670 if (update_spool || header_rewritten)
7671 /* Panic-dies on error */
7672 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
7675 /* Finished with the message log. If the message is complete, it will have
7676 been unlinked or renamed above. */
7678 if (message_logs) (void)fclose(message_log);
7680 /* Now we can close and remove the journal file. Its only purpose is to record
7681 successfully completed deliveries asap so that this information doesn't get
7682 lost if Exim (or the machine) crashes. Forgetting about a failed delivery is
7683 not serious, as trying it again is not harmful. The journal might not be open
7684 if all addresses were deferred at routing or directing. Nevertheless, we must
7685 remove it if it exists (may have been lying around from a crash during the
7686 previous delivery attempt). We don't remove the journal if a delivery
7687 subprocess failed to pass back delivery information; this is controlled by
7688 the remove_journal flag. When the journal is left, we also don't move the
7689 message off the main spool if frozen and the option is set. It should get moved
7690 at the next attempt, after the journal has been inspected. */
7692 if (journal_fd >= 0) (void)close(journal_fd);
7696 sprintf(CS spoolname, "%s/input/%s/%s-J", spool_directory, message_subdir, id);
7697 if (Uunlink(spoolname) < 0 && errno != ENOENT)
7698 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s", spoolname,
7701 /* Move the message off the spool if reqested */
7703 #ifdef SUPPORT_MOVE_FROZEN_MESSAGES
7704 if (deliver_freeze && move_frozen_messages)
7705 (void)spool_move_message(id, message_subdir, US"", US"F");
7709 /* Closing the data file frees the lock; if the file has been unlinked it
7710 will go away. Otherwise the message becomes available for another process
7713 (void)close(deliver_datafile);
7714 deliver_datafile = -1;
7715 DEBUG(D_deliver) debug_printf("end delivery of %s\n", id);
7717 /* It is unlikely that there will be any cached resources, since they are
7718 released after routing, and in the delivery subprocesses. However, it's
7719 possible for an expansion for something afterwards (for example,
7720 expand_check_condition) to do a lookup. We must therefore be sure everything is
7724 acl_where = ACL_WHERE_UNKNOWN;
7730 /* End of deliver.c */