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;
1139 delivery_log(LOG_MAIN, addr, logchar, NULL);
1142 if (tls_out.ourcert)
1144 tls_free_cert(tls_out.ourcert);
1145 tls_out.ourcert = NULL;
1147 if (tls_out.peercert)
1149 tls_free_cert(tls_out.peercert);
1150 tls_out.peercert = NULL;
1152 tls_out.cipher = NULL;
1153 tls_out.peerdn = NULL;
1154 tls_out.ocsp = OCSP_NOT_REQ;
1159 /* Soft failure, or local delivery process failed; freezing may be
1162 else if (result == DEFER || result == PANIC)
1164 if (result == PANIC) logflags |= LOG_PANIC;
1166 /* This puts them on the chain in reverse order. Do not change this, because
1167 the code for handling retries assumes that the one with the retry
1168 information is last. */
1170 addr->next = addr_defer;
1173 /* The only currently implemented special action is to freeze the
1174 message. Logging of this is done later, just before the -H file is
1177 if (addr->special_action == SPECIAL_FREEZE)
1179 deliver_freeze = TRUE;
1180 deliver_frozen_at = time(NULL);
1181 update_spool = TRUE;
1184 /* If doing a 2-stage queue run, we skip writing to either the message
1185 log or the main log for SMTP defers. */
1187 if (!queue_2stage || addr->basic_errno != 0)
1191 /* For errors of the type "retry time not reached" (also remotes skipped
1192 on queue run), logging is controlled by L_retry_defer. Note that this kind
1193 of error number is negative, and all the retry ones are less than any
1196 unsigned int use_log_selector = (addr->basic_errno <= ERRNO_RETRY_BASE)?
1199 /* Build up the line that is used for both the message log and the main
1202 s = reset_point = store_get(size);
1204 /* Create the address string for logging. Must not do this earlier, because
1205 an OK result may be changed to FAIL when a pipe returns text. */
1207 log_address = string_log_address(addr,
1208 (log_write_selector & L_all_parents) != 0, result == OK);
1210 s = string_cat(s, &size, &ptr, log_address, Ustrlen(log_address));
1212 /* Either driver_name contains something and driver_kind contains
1213 " router" or " transport" (note the leading space), or driver_name is
1214 a null string and driver_kind contains "routing" without the leading
1215 space, if all routing has been deferred. When a domain has been held,
1216 so nothing has been done at all, both variables contain null strings. */
1218 if (driver_name == NULL)
1220 if (driver_kind != NULL)
1221 s = string_append(s, &size, &ptr, 2, US" ", driver_kind);
1225 if (driver_kind[1] == 't' && addr->router != NULL)
1226 s = string_append(s, &size, &ptr, 2, US" R=", addr->router->name);
1228 ss[1] = toupper(driver_kind[1]);
1229 s = string_append(s, &size, &ptr, 2, ss, driver_name);
1232 sprintf(CS ss, " defer (%d)", addr->basic_errno);
1233 s = string_cat(s, &size, &ptr, ss, Ustrlen(ss));
1235 if (addr->basic_errno > 0)
1236 s = string_append(s, &size, &ptr, 2, US": ",
1237 US strerror(addr->basic_errno));
1239 if (addr->message != NULL)
1240 s = string_append(s, &size, &ptr, 2, US": ", addr->message);
1244 /* Log the deferment in the message log, but don't clutter it
1245 up with retry-time defers after the first delivery attempt. */
1247 if (deliver_firsttime || addr->basic_errno > ERRNO_RETRY_BASE)
1248 deliver_msglog("%s %s\n", now, s);
1250 /* Write the main log and reset the store */
1252 log_write(use_log_selector, logflags, "== %s", s);
1253 store_reset(reset_point);
1258 /* Hard failure. If there is an address to which an error message can be sent,
1259 put this address on the failed list. If not, put it on the deferred list and
1260 freeze the mail message for human attention. The latter action can also be
1261 explicitly requested by a router or transport. */
1265 /* If this is a delivery error, or a message for which no replies are
1266 wanted, and the message's age is greater than ignore_bounce_errors_after,
1267 force the af_ignore_error flag. This will cause the address to be discarded
1268 later (with a log entry). */
1270 if (sender_address[0] == 0 && message_age >= ignore_bounce_errors_after)
1271 setflag(addr, af_ignore_error);
1273 /* Freeze the message if requested, or if this is a bounce message (or other
1274 message with null sender) and this address does not have its own errors
1275 address. However, don't freeze if errors are being ignored. The actual code
1276 to ignore occurs later, instead of sending a message. Logging of freezing
1277 occurs later, just before writing the -H file. */
1279 if (!testflag(addr, af_ignore_error) &&
1280 (addr->special_action == SPECIAL_FREEZE ||
1281 (sender_address[0] == 0 && addr->p.errors_address == NULL)
1284 frozen_info = (addr->special_action == SPECIAL_FREEZE)? US"" :
1285 (sender_local && !local_error_message)?
1286 US" (message created with -f <>)" : US" (delivery error message)";
1287 deliver_freeze = TRUE;
1288 deliver_frozen_at = time(NULL);
1289 update_spool = TRUE;
1291 /* The address is put on the defer rather than the failed queue, because
1292 the message is being retained. */
1294 addr->next = addr_defer;
1298 /* Don't put the address on the nonrecipients tree yet; wait until an
1299 error message has been successfully sent. */
1303 addr->next = addr_failed;
1307 /* Build up the log line for the message and main logs */
1309 s = reset_point = store_get(size);
1311 /* Create the address string for logging. Must not do this earlier, because
1312 an OK result may be changed to FAIL when a pipe returns text. */
1314 log_address = string_log_address(addr,
1315 (log_write_selector & L_all_parents) != 0, result == OK);
1317 s = string_cat(s, &size, &ptr, log_address, Ustrlen(log_address));
1319 if ((log_extra_selector & LX_sender_on_delivery) != 0)
1320 s = string_append(s, &size, &ptr, 3, US" F=<", sender_address, US">");
1322 /* Return path may not be set if no delivery actually happened */
1324 if (used_return_path != NULL &&
1325 (log_extra_selector & LX_return_path_on_delivery) != 0)
1326 s = string_append(s, &size, &ptr, 3, US" P=<", used_return_path, US">");
1328 if (addr->router != NULL)
1329 s = string_append(s, &size, &ptr, 2, US" R=", addr->router->name);
1330 if (addr->transport != NULL)
1331 s = string_append(s, &size, &ptr, 2, US" T=", addr->transport->name);
1333 if (addr->host_used != NULL)
1334 s = d_hostlog(s, &size, &ptr, addr);
1337 s = d_tlslog(s, &size, &ptr, addr);
1340 if (addr->basic_errno > 0)
1341 s = string_append(s, &size, &ptr, 2, US": ",
1342 US strerror(addr->basic_errno));
1344 if (addr->message != NULL)
1345 s = string_append(s, &size, &ptr, 2, US": ", addr->message);
1349 /* Do the logging. For the message log, "routing failed" for those cases,
1350 just to make it clearer. */
1352 if (driver_name == NULL)
1353 deliver_msglog("%s %s failed for %s\n", now, driver_kind, s);
1355 deliver_msglog("%s %s\n", now, s);
1357 log_write(0, LOG_MAIN, "** %s", s);
1358 store_reset(reset_point);
1361 /* Ensure logging is turned on again in all cases */
1363 disable_logging = FALSE;
1369 /*************************************************
1370 * Address-independent error *
1371 *************************************************/
1373 /* This function is called when there's an error that is not dependent on a
1374 particular address, such as an expansion string failure. It puts the error into
1375 all the addresses in a batch, logs the incident on the main and panic logs, and
1376 clears the expansions. It is mostly called from local_deliver(), but can be
1377 called for a remote delivery via findugid().
1380 logit TRUE if (MAIN+PANIC) logging required
1381 addr the first of the chain of addresses
1383 format format string for error message, or NULL if already set in addr
1384 ... arguments for the format
1390 common_error(BOOL logit, address_item *addr, int code, uschar *format, ...)
1392 address_item *addr2;
1393 addr->basic_errno = code;
1399 va_start(ap, format);
1400 if (!string_vformat(buffer, sizeof(buffer), CS format, ap))
1401 log_write(0, LOG_MAIN|LOG_PANIC_DIE,
1402 "common_error expansion was longer than " SIZE_T_FMT, sizeof(buffer));
1404 addr->message = string_copy(buffer);
1407 for (addr2 = addr->next; addr2 != NULL; addr2 = addr2->next)
1409 addr2->basic_errno = code;
1410 addr2->message = addr->message;
1413 if (logit) log_write(0, LOG_MAIN|LOG_PANIC, "%s", addr->message);
1414 deliver_set_expansions(NULL);
1420 /*************************************************
1421 * Check a "never users" list *
1422 *************************************************/
1424 /* This function is called to check whether a uid is on one of the two "never
1428 uid the uid to be checked
1429 nusers the list to be scanned; the first item in the list is the count
1431 Returns: TRUE if the uid is on the list
1435 check_never_users(uid_t uid, uid_t *nusers)
1438 if (nusers == NULL) return FALSE;
1439 for (i = 1; i <= (int)(nusers[0]); i++) if (nusers[i] == uid) return TRUE;
1445 /*************************************************
1446 * Find uid and gid for a transport *
1447 *************************************************/
1449 /* This function is called for both local and remote deliveries, to find the
1450 uid/gid under which to run the delivery. The values are taken preferentially
1451 from the transport (either explicit or deliver_as_creator), then from the
1452 address (i.e. the router), and if nothing is set, the exim uid/gid are used. If
1453 the resulting uid is on the "never_users" or the "fixed_never_users" list, a
1454 panic error is logged, and the function fails (which normally leads to delivery
1458 addr the address (possibly a chain)
1460 uidp pointer to uid field
1461 gidp pointer to gid field
1462 igfp pointer to the use_initgroups field
1464 Returns: FALSE if failed - error has been set in address(es)
1468 findugid(address_item *addr, transport_instance *tp, uid_t *uidp, gid_t *gidp,
1471 uschar *nuname = NULL;
1472 BOOL gid_set = FALSE;
1474 /* Default initgroups flag comes from the transport */
1476 *igfp = tp->initgroups;
1478 /* First see if there's a gid on the transport, either fixed or expandable.
1479 The expanding function always logs failure itself. */
1486 else if (tp->expand_gid != NULL)
1488 if (route_find_expanded_group(tp->expand_gid, tp->name, US"transport", gidp,
1489 &(addr->message))) gid_set = TRUE;
1492 common_error(FALSE, addr, ERRNO_GIDFAIL, NULL);
1497 /* If the transport did not set a group, see if the router did. */
1499 if (!gid_set && testflag(addr, af_gid_set))
1505 /* Pick up a uid from the transport if one is set. */
1507 if (tp->uid_set) *uidp = tp->uid;
1509 /* Otherwise, try for an expandable uid field. If it ends up as a numeric id,
1510 it does not provide a passwd value from which a gid can be taken. */
1512 else if (tp->expand_uid != NULL)
1515 if (!route_find_expanded_user(tp->expand_uid, tp->name, US"transport", &pw,
1516 uidp, &(addr->message)))
1518 common_error(FALSE, addr, ERRNO_UIDFAIL, NULL);
1521 if (!gid_set && pw != NULL)
1528 /* If the transport doesn't set the uid, test the deliver_as_creator flag. */
1530 else if (tp->deliver_as_creator)
1532 *uidp = originator_uid;
1535 *gidp = originator_gid;
1540 /* Otherwise see if the address specifies the uid and if so, take it and its
1543 else if (testflag(addr, af_uid_set))
1546 *igfp = testflag(addr, af_initgroups);
1549 /* Nothing has specified the uid - default to the Exim user, and group if the
1562 /* If no gid is set, it is a disaster. We default to the Exim gid only if
1563 defaulting to the Exim uid. In other words, if the configuration has specified
1564 a uid, it must also provide a gid. */
1568 common_error(TRUE, addr, ERRNO_GIDFAIL, US"User set without group for "
1569 "%s transport", tp->name);
1573 /* Check that the uid is not on the lists of banned uids that may not be used
1574 for delivery processes. */
1576 if (check_never_users(*uidp, never_users))
1577 nuname = US"never_users";
1578 else if (check_never_users(*uidp, fixed_never_users))
1579 nuname = US"fixed_never_users";
1583 common_error(TRUE, addr, ERRNO_UIDFAIL, US"User %ld set for %s transport "
1584 "is on the %s list", (long int)(*uidp), tp->name, nuname);
1596 /*************************************************
1597 * Check the size of a message for a transport *
1598 *************************************************/
1600 /* Checks that the message isn't too big for the selected transport.
1601 This is called only when it is known that the limit is set.
1605 addr the (first) address being delivered
1608 DEFER expansion failed or did not yield an integer
1609 FAIL message too big
1613 check_message_size(transport_instance *tp, address_item *addr)
1618 deliver_set_expansions(addr);
1619 size_limit = expand_string_integer(tp->message_size_limit, TRUE);
1620 deliver_set_expansions(NULL);
1622 if (expand_string_message != NULL)
1625 if (size_limit == -1)
1626 addr->message = string_sprintf("failed to expand message_size_limit "
1627 "in %s transport: %s", tp->name, expand_string_message);
1629 addr->message = string_sprintf("invalid message_size_limit "
1630 "in %s transport: %s", tp->name, expand_string_message);
1632 else if (size_limit > 0 && message_size > size_limit)
1636 string_sprintf("message is too big (transport limit = %d)",
1645 /*************************************************
1646 * Transport-time check for a previous delivery *
1647 *************************************************/
1649 /* Check that this base address hasn't previously been delivered to its routed
1650 transport. If it has been delivered, mark it done. The check is necessary at
1651 delivery time in order to handle homonymic addresses correctly in cases where
1652 the pattern of redirection changes between delivery attempts (so the unique
1653 fields change). Non-homonymic previous delivery is detected earlier, at routing
1654 time (which saves unnecessary routing).
1657 addr the address item
1658 testing TRUE if testing wanted only, without side effects
1660 Returns: TRUE if previously delivered by the transport
1664 previously_transported(address_item *addr, BOOL testing)
1666 (void)string_format(big_buffer, big_buffer_size, "%s/%s",
1667 addr->unique + (testflag(addr, af_homonym)? 3:0), addr->transport->name);
1669 if (tree_search(tree_nonrecipients, big_buffer) != 0)
1671 DEBUG(D_deliver|D_route|D_transport)
1672 debug_printf("%s was previously delivered (%s transport): discarded\n",
1673 addr->address, addr->transport->name);
1674 if (!testing) child_done(addr, tod_stamp(tod_log));
1683 /******************************************************
1684 * Check for a given header in a header string *
1685 ******************************************************/
1687 /* This function is used when generating quota warnings. The configuration may
1688 specify any header lines it likes in quota_warn_message. If certain of them are
1689 missing, defaults are inserted, so we need to be able to test for the presence
1693 hdr the required header name
1694 hstring the header string
1696 Returns: TRUE the header is in the string
1697 FALSE the header is not in the string
1701 contains_header(uschar *hdr, uschar *hstring)
1703 int len = Ustrlen(hdr);
1704 uschar *p = hstring;
1707 if (strncmpic(p, hdr, len) == 0)
1710 while (*p == ' ' || *p == '\t') p++;
1711 if (*p == ':') return TRUE;
1713 while (*p != 0 && *p != '\n') p++;
1714 if (*p == '\n') p++;
1722 /*************************************************
1723 * Perform a local delivery *
1724 *************************************************/
1726 /* Each local delivery is performed in a separate process which sets its
1727 uid and gid as specified. This is a safer way than simply changing and
1728 restoring using seteuid(); there is a body of opinion that seteuid() cannot be
1729 used safely. From release 4, Exim no longer makes any use of it. Besides, not
1730 all systems have seteuid().
1732 If the uid/gid are specified in the transport_instance, they are used; the
1733 transport initialization must ensure that either both or neither are set.
1734 Otherwise, the values associated with the address are used. If neither are set,
1735 it is a configuration error.
1737 The transport or the address may specify a home directory (transport over-
1738 rides), and if they do, this is set as $home. If neither have set a working
1739 directory, this value is used for that as well. Otherwise $home is left unset
1740 and the cwd is set to "/" - a directory that should be accessible to all users.
1742 Using a separate process makes it more complicated to get error information
1743 back. We use a pipe to pass the return code and also an error code and error
1744 text string back to the parent process.
1747 addr points to an address block for this delivery; for "normal" local
1748 deliveries this is the only address to be delivered, but for
1749 pseudo-remote deliveries (e.g. by batch SMTP to a file or pipe)
1750 a number of addresses can be handled simultaneously, and in this
1751 case addr will point to a chain of addresses with the same
1754 shadowing TRUE if running a shadow transport; this causes output from pipes
1761 deliver_local(address_item *addr, BOOL shadowing)
1763 BOOL use_initgroups;
1766 int status, len, rc;
1769 uschar *working_directory;
1770 address_item *addr2;
1771 transport_instance *tp = addr->transport;
1773 /* Set up the return path from the errors or sender address. If the transport
1774 has its own return path setting, expand it and replace the existing value. */
1776 if(addr->p.errors_address != NULL)
1777 return_path = addr->p.errors_address;
1778 #ifdef EXPERIMENTAL_SRS
1779 else if(addr->p.srs_sender != NULL)
1780 return_path = addr->p.srs_sender;
1783 return_path = sender_address;
1785 if (tp->return_path != NULL)
1787 uschar *new_return_path = expand_string(tp->return_path);
1788 if (new_return_path == NULL)
1790 if (!expand_string_forcedfail)
1792 common_error(TRUE, addr, ERRNO_EXPANDFAIL,
1793 US"Failed to expand return path \"%s\" in %s transport: %s",
1794 tp->return_path, tp->name, expand_string_message);
1798 else return_path = new_return_path;
1801 /* For local deliveries, one at a time, the value used for logging can just be
1802 set directly, once and for all. */
1804 used_return_path = return_path;
1806 /* Sort out the uid, gid, and initgroups flag. If an error occurs, the message
1807 gets put into the address(es), and the expansions are unset, so we can just
1810 if (!findugid(addr, tp, &uid, &gid, &use_initgroups)) return;
1812 /* See if either the transport or the address specifies a home directory. A
1813 home directory set in the address may already be expanded; a flag is set to
1814 indicate that. In other cases we must expand it. */
1816 if ((deliver_home = tp->home_dir) != NULL || /* Set in transport, or */
1817 ((deliver_home = addr->home_dir) != NULL && /* Set in address and */
1818 !testflag(addr, af_home_expanded))) /* not expanded */
1820 uschar *rawhome = deliver_home;
1821 deliver_home = NULL; /* in case it contains $home */
1822 deliver_home = expand_string(rawhome);
1823 if (deliver_home == NULL)
1825 common_error(TRUE, addr, ERRNO_EXPANDFAIL, US"home directory \"%s\" failed "
1826 "to expand for %s transport: %s", rawhome, tp->name,
1827 expand_string_message);
1830 if (*deliver_home != '/')
1832 common_error(TRUE, addr, ERRNO_NOTABSOLUTE, US"home directory path \"%s\" "
1833 "is not absolute for %s transport", deliver_home, tp->name);
1838 /* See if either the transport or the address specifies a current directory,
1839 and if so, expand it. If nothing is set, use the home directory, unless it is
1840 also unset in which case use "/", which is assumed to be a directory to which
1841 all users have access. It is necessary to be in a visible directory for some
1842 operating systems when running pipes, as some commands (e.g. "rm" under Solaris
1843 2.5) require this. */
1845 working_directory = (tp->current_dir != NULL)?
1846 tp->current_dir : addr->current_dir;
1848 if (working_directory != NULL)
1850 uschar *raw = working_directory;
1851 working_directory = expand_string(raw);
1852 if (working_directory == NULL)
1854 common_error(TRUE, addr, ERRNO_EXPANDFAIL, US"current directory \"%s\" "
1855 "failed to expand for %s transport: %s", raw, tp->name,
1856 expand_string_message);
1859 if (*working_directory != '/')
1861 common_error(TRUE, addr, ERRNO_NOTABSOLUTE, US"current directory path "
1862 "\"%s\" is not absolute for %s transport", working_directory, tp->name);
1866 else working_directory = (deliver_home == NULL)? US"/" : deliver_home;
1868 /* If one of the return_output flags is set on the transport, create and open a
1869 file in the message log directory for the transport to write its output onto.
1870 This is mainly used by pipe transports. The file needs to be unique to the
1871 address. This feature is not available for shadow transports. */
1873 if (!shadowing && (tp->return_output || tp->return_fail_output ||
1874 tp->log_output || tp->log_fail_output))
1877 addr->return_filename =
1878 string_sprintf("%s/msglog/%s/%s-%d-%d", spool_directory, message_subdir,
1879 message_id, getpid(), return_count++);
1880 addr->return_file = open_msglog_file(addr->return_filename, 0400, &error);
1881 if (addr->return_file < 0)
1883 common_error(TRUE, addr, errno, US"Unable to %s file for %s transport "
1884 "to return message: %s", error, tp->name, strerror(errno));
1889 /* Create the pipe for inter-process communication. */
1893 common_error(TRUE, addr, ERRNO_PIPEFAIL, US"Creation of pipe failed: %s",
1898 /* Now fork the process to do the real work in the subprocess, but first
1899 ensure that all cached resources are freed so that the subprocess starts with
1900 a clean slate and doesn't interfere with the parent process. */
1904 if ((pid = fork()) == 0)
1906 BOOL replicate = TRUE;
1908 /* Prevent core dumps, as we don't want them in users' home directories.
1909 HP-UX doesn't have RLIMIT_CORE; I don't know how to do this in that
1910 system. Some experimental/developing systems (e.g. GNU/Hurd) may define
1911 RLIMIT_CORE but not support it in setrlimit(). For such systems, do not
1912 complain if the error is "not supported".
1914 There are two scenarios where changing the max limit has an effect. In one,
1915 the user is using a .forward and invoking a command of their choice via pipe;
1916 for these, we do need the max limit to be 0 unless the admin chooses to
1917 permit an increased limit. In the other, the command is invoked directly by
1918 the transport and is under administrator control, thus being able to raise
1919 the limit aids in debugging. So there's no general always-right answer.
1921 Thus we inhibit core-dumps completely but let individual transports, while
1922 still root, re-raise the limits back up to aid debugging. We make the
1923 default be no core-dumps -- few enough people can use core dumps in
1924 diagnosis that it's reasonable to make them something that has to be explicitly requested.
1931 if (setrlimit(RLIMIT_CORE, &rl) < 0)
1933 # ifdef SETRLIMIT_NOT_SUPPORTED
1934 if (errno != ENOSYS && errno != ENOTSUP)
1936 log_write(0, LOG_MAIN|LOG_PANIC, "setrlimit(RLIMIT_CORE) failed: %s",
1941 /* Reset the random number generator, so different processes don't all
1942 have the same sequence. */
1946 /* If the transport has a setup entry, call this first, while still
1947 privileged. (Appendfile uses this to expand quota, for example, while
1948 able to read private files.) */
1950 if (addr->transport->setup != NULL)
1952 switch((addr->transport->setup)(addr->transport, addr, NULL, uid, gid,
1956 addr->transport_return = DEFER;
1960 addr->transport_return = PANIC;
1965 /* Ignore SIGINT and SIGTERM during delivery. Also ignore SIGUSR1, as
1966 when the process becomes unprivileged, it won't be able to write to the
1967 process log. SIGHUP is ignored throughout exim, except when it is being
1970 signal(SIGINT, SIG_IGN);
1971 signal(SIGTERM, SIG_IGN);
1972 signal(SIGUSR1, SIG_IGN);
1974 /* Close the unwanted half of the pipe, and set close-on-exec for the other
1975 half - for transports that exec things (e.g. pipe). Then set the required
1978 (void)close(pfd[pipe_read]);
1979 (void)fcntl(pfd[pipe_write], F_SETFD, fcntl(pfd[pipe_write], F_GETFD) |
1981 exim_setugid(uid, gid, use_initgroups,
1982 string_sprintf("local delivery to %s <%s> transport=%s", addr->local_part,
1983 addr->address, addr->transport->name));
1987 address_item *batched;
1988 debug_printf(" home=%s current=%s\n", deliver_home, working_directory);
1989 for (batched = addr->next; batched != NULL; batched = batched->next)
1990 debug_printf("additional batched address: %s\n", batched->address);
1993 /* Set an appropriate working directory. */
1995 if (Uchdir(working_directory) < 0)
1997 addr->transport_return = DEFER;
1998 addr->basic_errno = errno;
1999 addr->message = string_sprintf("failed to chdir to %s", working_directory);
2002 /* If successful, call the transport */
2007 set_process_info("delivering %s to %s using %s", message_id,
2008 addr->local_part, addr->transport->name);
2010 /* Setting this global in the subprocess means we need never clear it */
2011 transport_name = addr->transport->name;
2013 /* If a transport filter has been specified, set up its argument list.
2014 Any errors will get put into the address, and FALSE yielded. */
2016 if (addr->transport->filter_command != NULL)
2018 ok = transport_set_up_command(&transport_filter_argv,
2019 addr->transport->filter_command,
2020 TRUE, PANIC, addr, US"transport filter", NULL);
2021 transport_filter_timeout = addr->transport->filter_timeout;
2023 else transport_filter_argv = NULL;
2027 debug_print_string(addr->transport->debug_string);
2028 replicate = !(addr->transport->info->code)(addr->transport, addr);
2032 /* Pass the results back down the pipe. If necessary, first replicate the
2033 status in the top address to the others in the batch. The label is the
2034 subject of a goto when a call to the transport's setup function fails. We
2035 pass the pointer to the transport back in case it got changed as a result of
2036 file_format in appendfile. */
2040 if (replicate) replicate_status(addr);
2041 for (addr2 = addr; addr2 != NULL; addr2 = addr2->next)
2044 int local_part_length = Ustrlen(addr2->local_part);
2048 if( (ret = write(pfd[pipe_write], (void *)&(addr2->transport_return), sizeof(int))) != sizeof(int)
2049 || (ret = write(pfd[pipe_write], (void *)&transport_count, sizeof(transport_count))) != sizeof(transport_count)
2050 || (ret = write(pfd[pipe_write], (void *)&(addr2->flags), sizeof(addr2->flags))) != sizeof(addr2->flags)
2051 || (ret = write(pfd[pipe_write], (void *)&(addr2->basic_errno), sizeof(int))) != sizeof(int)
2052 || (ret = write(pfd[pipe_write], (void *)&(addr2->more_errno), sizeof(int))) != sizeof(int)
2053 || (ret = write(pfd[pipe_write], (void *)&(addr2->special_action), sizeof(int))) != sizeof(int)
2054 || (ret = write(pfd[pipe_write], (void *)&(addr2->transport),
2055 sizeof(transport_instance *))) != sizeof(transport_instance *)
2057 /* For a file delivery, pass back the local part, in case the original
2058 was only part of the final delivery path. This gives more complete
2061 || (testflag(addr2, af_file)
2062 && ( (ret = write(pfd[pipe_write], (void *)&local_part_length, sizeof(int))) != sizeof(int)
2063 || (ret = write(pfd[pipe_write], addr2->local_part, local_part_length)) != local_part_length
2067 log_write(0, LOG_MAIN|LOG_PANIC, "Failed writing transport results to pipe: %s\n",
2068 ret == -1 ? strerror(errno) : "short write");
2070 /* Now any messages */
2072 for (i = 0, s = addr2->message; i < 2; i++, s = addr2->user_message)
2074 int message_length = (s == NULL)? 0 : Ustrlen(s) + 1;
2075 if( (ret = write(pfd[pipe_write], (void *)&message_length, sizeof(int))) != sizeof(int)
2076 || (message_length > 0 && (ret = write(pfd[pipe_write], s, message_length)) != message_length)
2078 log_write(0, LOG_MAIN|LOG_PANIC, "Failed writing transport results to pipe: %s\n",
2079 ret == -1 ? strerror(errno) : "short write");
2083 /* OK, this process is now done. Free any cached resources that it opened,
2084 and close the pipe we were writing down before exiting. */
2086 (void)close(pfd[pipe_write]);
2091 /* Back in the main process: panic if the fork did not succeed. This seems
2092 better than returning an error - if forking is failing it is probably best
2093 not to try other deliveries for this message. */
2096 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Fork failed for local delivery to %s",
2099 /* Read the pipe to get the delivery status codes and error messages. Our copy
2100 of the writing end must be closed first, as otherwise read() won't return zero
2101 on an empty pipe. We check that a status exists for each address before
2102 overwriting the address structure. If data is missing, the default DEFER status
2103 will remain. Afterwards, close the reading end. */
2105 (void)close(pfd[pipe_write]);
2107 for (addr2 = addr; addr2 != NULL; addr2 = addr2->next)
2109 len = read(pfd[pipe_read], (void *)&status, sizeof(int));
2115 addr2->transport_return = status;
2116 len = read(pfd[pipe_read], (void *)&transport_count,
2117 sizeof(transport_count));
2118 len = read(pfd[pipe_read], (void *)&(addr2->flags), sizeof(addr2->flags));
2119 len = read(pfd[pipe_read], (void *)&(addr2->basic_errno), sizeof(int));
2120 len = read(pfd[pipe_read], (void *)&(addr2->more_errno), sizeof(int));
2121 len = read(pfd[pipe_read], (void *)&(addr2->special_action), sizeof(int));
2122 len = read(pfd[pipe_read], (void *)&(addr2->transport),
2123 sizeof(transport_instance *));
2125 if (testflag(addr2, af_file))
2127 int local_part_length;
2128 len = read(pfd[pipe_read], (void *)&local_part_length, sizeof(int));
2129 len = read(pfd[pipe_read], (void *)big_buffer, local_part_length);
2130 big_buffer[local_part_length] = 0;
2131 addr2->local_part = string_copy(big_buffer);
2134 for (i = 0, sptr = &(addr2->message); i < 2;
2135 i++, sptr = &(addr2->user_message))
2138 len = read(pfd[pipe_read], (void *)&message_length, sizeof(int));
2139 if (message_length > 0)
2141 len = read(pfd[pipe_read], (void *)big_buffer, message_length);
2142 if (len > 0) *sptr = string_copy(big_buffer);
2149 log_write(0, LOG_MAIN|LOG_PANIC, "failed to read delivery status for %s "
2150 "from delivery subprocess", addr2->unique);
2155 (void)close(pfd[pipe_read]);
2157 /* Unless shadowing, write all successful addresses immediately to the journal
2158 file, to ensure they are recorded asap. For homonymic addresses, use the base
2159 address plus the transport name. Failure to write the journal is panic-worthy,
2160 but don't stop, as it may prove possible subsequently to update the spool file
2161 in order to record the delivery. */
2165 for (addr2 = addr; addr2 != NULL; addr2 = addr2->next)
2167 if (addr2->transport_return != OK) continue;
2169 if (testflag(addr2, af_homonym))
2170 sprintf(CS big_buffer, "%.500s/%s\n", addr2->unique + 3, tp->name);
2172 sprintf(CS big_buffer, "%.500s\n", addr2->unique);
2174 /* In the test harness, wait just a bit to let the subprocess finish off
2175 any debug output etc first. */
2177 if (running_in_test_harness) millisleep(300);
2179 DEBUG(D_deliver) debug_printf("journalling %s", big_buffer);
2180 len = Ustrlen(big_buffer);
2181 if (write(journal_fd, big_buffer, len) != len)
2182 log_write(0, LOG_MAIN|LOG_PANIC, "failed to update journal for %s: %s",
2183 big_buffer, strerror(errno));
2186 /* Ensure the journal file is pushed out to disk. */
2188 if (EXIMfsync(journal_fd) < 0)
2189 log_write(0, LOG_MAIN|LOG_PANIC, "failed to fsync journal: %s",
2193 /* Wait for the process to finish. If it terminates with a non-zero code,
2194 freeze the message (except for SIGTERM, SIGKILL and SIGQUIT), but leave the
2195 status values of all the addresses as they are. Take care to handle the case
2196 when the subprocess doesn't seem to exist. This has been seen on one system
2197 when Exim was called from an MUA that set SIGCHLD to SIG_IGN. When that
2198 happens, wait() doesn't recognize the termination of child processes. Exim now
2199 resets SIGCHLD to SIG_DFL, but this code should still be robust. */
2201 while ((rc = wait(&status)) != pid)
2203 if (rc < 0 && errno == ECHILD) /* Process has vanished */
2205 log_write(0, LOG_MAIN, "%s transport process vanished unexpectedly",
2206 addr->transport->driver_name);
2212 if ((status & 0xffff) != 0)
2214 int msb = (status >> 8) & 255;
2215 int lsb = status & 255;
2216 int code = (msb == 0)? (lsb & 0x7f) : msb;
2217 if (msb != 0 || (code != SIGTERM && code != SIGKILL && code != SIGQUIT))
2218 addr->special_action = SPECIAL_FREEZE;
2219 log_write(0, LOG_MAIN|LOG_PANIC, "%s transport process returned non-zero "
2220 "status 0x%04x: %s %d",
2221 addr->transport->driver_name,
2223 (msb == 0)? "terminated by signal" : "exit code",
2227 /* If SPECIAL_WARN is set in the top address, send a warning message. */
2229 if (addr->special_action == SPECIAL_WARN &&
2230 addr->transport->warn_message != NULL)
2233 uschar *warn_message;
2235 DEBUG(D_deliver) debug_printf("Warning message requested by transport\n");
2237 warn_message = expand_string(addr->transport->warn_message);
2238 if (warn_message == NULL)
2239 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand \"%s\" (warning "
2240 "message for %s transport): %s", addr->transport->warn_message,
2241 addr->transport->name, expand_string_message);
2244 pid_t pid = child_open_exim(&fd);
2247 FILE *f = fdopen(fd, "wb");
2248 if (errors_reply_to != NULL &&
2249 !contains_header(US"Reply-To", warn_message))
2250 fprintf(f, "Reply-To: %s\n", errors_reply_to);
2251 fprintf(f, "Auto-Submitted: auto-replied\n");
2252 if (!contains_header(US"From", warn_message)) moan_write_from(f);
2253 fprintf(f, "%s", CS warn_message);
2255 /* Close and wait for child process to complete, without a timeout. */
2258 (void)child_close(pid, 0);
2262 addr->special_action = SPECIAL_NONE;
2268 /*************************************************
2269 * Do local deliveries *
2270 *************************************************/
2272 /* This function processes the list of addresses in addr_local. True local
2273 deliveries are always done one address at a time. However, local deliveries can
2274 be batched up in some cases. Typically this is when writing batched SMTP output
2275 files for use by some external transport mechanism, or when running local
2276 deliveries over LMTP.
2283 do_local_deliveries(void)
2286 open_db *dbm_file = NULL;
2287 time_t now = time(NULL);
2289 /* Loop until we have exhausted the supply of local deliveries */
2291 while (addr_local != NULL)
2293 time_t delivery_start;
2295 address_item *addr2, *addr3, *nextaddr;
2296 int logflags = LOG_MAIN;
2297 int logchar = dont_deliver? '*' : '=';
2298 transport_instance *tp;
2300 /* Pick the first undelivered address off the chain */
2302 address_item *addr = addr_local;
2303 addr_local = addr->next;
2306 DEBUG(D_deliver|D_transport)
2307 debug_printf("--------> %s <--------\n", addr->address);
2309 /* An internal disaster if there is no transport. Should not occur! */
2311 if ((tp = addr->transport) == NULL)
2313 logflags |= LOG_PANIC;
2314 disable_logging = FALSE; /* Jic */
2316 (addr->router != NULL)?
2317 string_sprintf("No transport set by %s router", addr->router->name)
2319 string_sprintf("No transport set by system filter");
2320 post_process_one(addr, DEFER, logflags, DTYPE_TRANSPORT, 0);
2324 /* Check that this base address hasn't previously been delivered to this
2325 transport. The check is necessary at this point to handle homonymic addresses
2326 correctly in cases where the pattern of redirection changes between delivery
2327 attempts. Non-homonymic previous delivery is detected earlier, at routing
2330 if (previously_transported(addr, FALSE)) continue;
2332 /* There are weird cases where logging is disabled */
2334 disable_logging = tp->disable_logging;
2336 /* Check for batched addresses and possible amalgamation. Skip all the work
2337 if either batch_max <= 1 or there aren't any other addresses for local
2340 if (tp->batch_max > 1 && addr_local != NULL)
2342 int batch_count = 1;
2343 BOOL uses_dom = readconf_depends((driver_instance *)tp, US"domain");
2344 BOOL uses_lp = (testflag(addr, af_pfr) &&
2345 (testflag(addr, af_file) || addr->local_part[0] == '|')) ||
2346 readconf_depends((driver_instance *)tp, US"local_part");
2347 uschar *batch_id = NULL;
2348 address_item **anchor = &addr_local;
2349 address_item *last = addr;
2352 /* Expand the batch_id string for comparison with other addresses.
2353 Expansion failure suppresses batching. */
2355 if (tp->batch_id != NULL)
2357 deliver_set_expansions(addr);
2358 batch_id = expand_string(tp->batch_id);
2359 deliver_set_expansions(NULL);
2360 if (batch_id == NULL)
2362 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand batch_id option "
2363 "in %s transport (%s): %s", tp->name, addr->address,
2364 expand_string_message);
2365 batch_count = tp->batch_max;
2369 /* Until we reach the batch_max limit, pick off addresses which have the
2370 same characteristics. These are:
2373 not previously delivered (see comment about 50 lines above)
2374 same local part if the transport's configuration contains $local_part
2375 or if this is a file or pipe delivery from a redirection
2376 same domain if the transport's configuration contains $domain
2378 same additional headers
2379 same headers to be removed
2380 same uid/gid for running the transport
2381 same first host if a host list is set
2384 while ((next = *anchor) != NULL && batch_count < tp->batch_max)
2387 tp == next->transport &&
2388 !previously_transported(next, TRUE) &&
2389 (addr->flags & (af_pfr|af_file)) == (next->flags & (af_pfr|af_file)) &&
2390 (!uses_lp || Ustrcmp(next->local_part, addr->local_part) == 0) &&
2391 (!uses_dom || Ustrcmp(next->domain, addr->domain) == 0) &&
2392 same_strings(next->p.errors_address, addr->p.errors_address) &&
2393 same_headers(next->p.extra_headers, addr->p.extra_headers) &&
2394 same_strings(next->p.remove_headers, addr->p.remove_headers) &&
2395 same_ugid(tp, addr, next) &&
2396 ((addr->host_list == NULL && next->host_list == NULL) ||
2397 (addr->host_list != NULL && next->host_list != NULL &&
2398 Ustrcmp(addr->host_list->name, next->host_list->name) == 0));
2400 /* If the transport has a batch_id setting, batch_id will be non-NULL
2401 from the expansion outside the loop. Expand for this address and compare.
2402 Expansion failure makes this address ineligible for batching. */
2404 if (ok && batch_id != NULL)
2407 address_item *save_nextnext = next->next;
2408 next->next = NULL; /* Expansion for a single address */
2409 deliver_set_expansions(next);
2410 next->next = save_nextnext;
2411 bid = expand_string(tp->batch_id);
2412 deliver_set_expansions(NULL);
2415 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand batch_id option "
2416 "in %s transport (%s): %s", tp->name, next->address,
2417 expand_string_message);
2420 else ok = (Ustrcmp(batch_id, bid) == 0);
2423 /* Take address into batch if OK. */
2427 *anchor = next->next; /* Include the address */
2433 else anchor = &(next->next); /* Skip the address */
2437 /* We now have one or more addresses that can be delivered in a batch. Check
2438 whether the transport is prepared to accept a message of this size. If not,
2439 fail them all forthwith. If the expansion fails, or does not yield an
2440 integer, defer delivery. */
2442 if (tp->message_size_limit != NULL)
2444 int rc = check_message_size(tp, addr);
2447 replicate_status(addr);
2448 while (addr != NULL)
2451 post_process_one(addr, rc, logflags, DTYPE_TRANSPORT, 0);
2454 continue; /* With next batch of addresses */
2458 /* If we are not running the queue, or if forcing, all deliveries will be
2459 attempted. Otherwise, we must respect the retry times for each address. Even
2460 when not doing this, we need to set up the retry key string, and determine
2461 whether a retry record exists, because after a successful delivery, a delete
2462 retry item must be set up. Keep the retry database open only for the duration
2463 of these checks, rather than for all local deliveries, because some local
2464 deliveries (e.g. to pipes) can take a substantial time. */
2466 dbm_file = dbfn_open(US"retry", O_RDONLY, &dbblock, FALSE);
2467 if (dbm_file == NULL)
2469 DEBUG(D_deliver|D_retry|D_hints_lookup)
2470 debug_printf("no retry data available\n");
2475 while (addr2 != NULL)
2477 BOOL ok = TRUE; /* to deliver this address */
2480 /* Set up the retry key to include the domain or not, and change its
2481 leading character from "R" to "T". Must make a copy before doing this,
2482 because the old key may be pointed to from a "delete" retry item after
2485 retry_key = string_copy(
2486 (tp->retry_use_local_part)? addr2->address_retry_key :
2487 addr2->domain_retry_key);
2490 /* Inspect the retry data. If there is no hints file, delivery happens. */
2492 if (dbm_file != NULL)
2494 dbdata_retry *retry_record = dbfn_read(dbm_file, retry_key);
2496 /* If there is no retry record, delivery happens. If there is,
2497 remember it exists so it can be deleted after a successful delivery. */
2499 if (retry_record != NULL)
2501 setflag(addr2, af_lt_retry_exists);
2503 /* A retry record exists for this address. If queue running and not
2504 forcing, inspect its contents. If the record is too old, or if its
2505 retry time has come, or if it has passed its cutoff time, delivery
2510 debug_printf("retry record exists: age=%s ",
2511 readconf_printtime(now - retry_record->time_stamp));
2512 debug_printf("(max %s)\n", readconf_printtime(retry_data_expire));
2513 debug_printf(" time to retry = %s expired = %d\n",
2514 readconf_printtime(retry_record->next_try - now),
2515 retry_record->expired);
2518 if (queue_running && !deliver_force)
2520 ok = (now - retry_record->time_stamp > retry_data_expire) ||
2521 (now >= retry_record->next_try) ||
2522 retry_record->expired;
2524 /* If we haven't reached the retry time, there is one more check
2525 to do, which is for the ultimate address timeout. */
2528 ok = retry_ultimate_address_timeout(retry_key, addr2->domain,
2532 else DEBUG(D_retry) debug_printf("no retry record exists\n");
2535 /* This address is to be delivered. Leave it on the chain. */
2540 addr2 = addr2->next;
2543 /* This address is to be deferred. Take it out of the chain, and
2544 post-process it as complete. Must take it out of the chain first,
2545 because post processing puts it on another chain. */
2549 address_item *this = addr2;
2550 this->message = US"Retry time not yet reached";
2551 this->basic_errno = ERRNO_LRETRY;
2552 if (addr3 == NULL) addr2 = addr = addr2->next;
2553 else addr2 = addr3->next = addr2->next;
2554 post_process_one(this, DEFER, logflags, DTYPE_TRANSPORT, 0);
2558 if (dbm_file != NULL) dbfn_close(dbm_file);
2560 /* If there are no addresses left on the chain, they all deferred. Loop
2561 for the next set of addresses. */
2563 if (addr == NULL) continue;
2565 /* So, finally, we do have some addresses that can be passed to the
2566 transport. Before doing so, set up variables that are relevant to a
2569 deliver_set_expansions(addr);
2570 delivery_start = time(NULL);
2571 deliver_local(addr, FALSE);
2572 deliver_time = (int)(time(NULL) - delivery_start);
2574 /* If a shadow transport (which must perforce be another local transport), is
2575 defined, and its condition is met, we must pass the message to the shadow
2576 too, but only those addresses that succeeded. We do this by making a new
2577 chain of addresses - also to keep the original chain uncontaminated. We must
2578 use a chain rather than doing it one by one, because the shadow transport may
2581 NOTE: if the condition fails because of a lookup defer, there is nothing we
2584 if (tp->shadow != NULL &&
2585 (tp->shadow_condition == NULL ||
2586 expand_check_condition(tp->shadow_condition, tp->name, US"transport")))
2588 transport_instance *stp;
2589 address_item *shadow_addr = NULL;
2590 address_item **last = &shadow_addr;
2592 for (stp = transports; stp != NULL; stp = stp->next)
2593 if (Ustrcmp(stp->name, tp->shadow) == 0) break;
2596 log_write(0, LOG_MAIN|LOG_PANIC, "shadow transport \"%s\" not found ",
2599 /* Pick off the addresses that have succeeded, and make clones. Put into
2600 the shadow_message field a pointer to the shadow_message field of the real
2603 else for (addr2 = addr; addr2 != NULL; addr2 = addr2->next)
2605 if (addr2->transport_return != OK) continue;
2606 addr3 = store_get(sizeof(address_item));
2609 addr3->shadow_message = (uschar *)(&(addr2->shadow_message));
2610 addr3->transport = stp;
2611 addr3->transport_return = DEFER;
2612 addr3->return_filename = NULL;
2613 addr3->return_file = -1;
2615 last = &(addr3->next);
2618 /* If we found any addresses to shadow, run the delivery, and stick any
2619 message back into the shadow_message field in the original. */
2621 if (shadow_addr != NULL)
2623 int save_count = transport_count;
2625 DEBUG(D_deliver|D_transport)
2626 debug_printf(">>>>>>>>>>>>>>>> Shadow delivery >>>>>>>>>>>>>>>>\n");
2627 deliver_local(shadow_addr, TRUE);
2629 for(; shadow_addr != NULL; shadow_addr = shadow_addr->next)
2631 int sresult = shadow_addr->transport_return;
2632 *((uschar **)(shadow_addr->shadow_message)) = (sresult == OK)?
2633 string_sprintf(" ST=%s", stp->name) :
2634 string_sprintf(" ST=%s (%s%s%s)", stp->name,
2635 (shadow_addr->basic_errno <= 0)?
2636 US"" : US strerror(shadow_addr->basic_errno),
2637 (shadow_addr->basic_errno <= 0 || shadow_addr->message == NULL)?
2639 (shadow_addr->message != NULL)? shadow_addr->message :
2640 (shadow_addr->basic_errno <= 0)? US"unknown error" : US"");
2642 DEBUG(D_deliver|D_transport)
2643 debug_printf("%s shadow transport returned %s for %s\n",
2645 (sresult == OK)? "OK" :
2646 (sresult == DEFER)? "DEFER" :
2647 (sresult == FAIL)? "FAIL" :
2648 (sresult == PANIC)? "PANIC" : "?",
2649 shadow_addr->address);
2652 DEBUG(D_deliver|D_transport)
2653 debug_printf(">>>>>>>>>>>>>>>> End shadow delivery >>>>>>>>>>>>>>>>\n");
2655 transport_count = save_count; /* Restore original transport count */
2659 /* Cancel the expansions that were set up for the delivery. */
2661 deliver_set_expansions(NULL);
2663 /* Now we can process the results of the real transport. We must take each
2664 address off the chain first, because post_process_one() puts it on another
2667 for (addr2 = addr; addr2 != NULL; addr2 = nextaddr)
2669 int result = addr2->transport_return;
2670 nextaddr = addr2->next;
2672 DEBUG(D_deliver|D_transport)
2673 debug_printf("%s transport returned %s for %s\n",
2675 (result == OK)? "OK" :
2676 (result == DEFER)? "DEFER" :
2677 (result == FAIL)? "FAIL" :
2678 (result == PANIC)? "PANIC" : "?",
2681 /* If there is a retry_record, or if delivery is deferred, build a retry
2682 item for setting a new retry time or deleting the old retry record from
2683 the database. These items are handled all together after all addresses
2684 have been handled (so the database is open just for a short time for
2687 if (result == DEFER || testflag(addr2, af_lt_retry_exists))
2689 int flags = (result == DEFER)? 0 : rf_delete;
2690 uschar *retry_key = string_copy((tp->retry_use_local_part)?
2691 addr2->address_retry_key : addr2->domain_retry_key);
2693 retry_add_item(addr2, retry_key, flags);
2696 /* Done with this address */
2698 if (result == OK) addr2->more_errno = deliver_time;
2699 post_process_one(addr2, result, logflags, DTYPE_TRANSPORT, logchar);
2701 /* If a pipe delivery generated text to be sent back, the result may be
2702 changed to FAIL, and we must copy this for subsequent addresses in the
2705 if (addr2->transport_return != result)
2707 for (addr3 = nextaddr; addr3 != NULL; addr3 = addr3->next)
2709 addr3->transport_return = addr2->transport_return;
2710 addr3->basic_errno = addr2->basic_errno;
2711 addr3->message = addr2->message;
2713 result = addr2->transport_return;
2716 /* Whether or not the result was changed to FAIL, we need to copy the
2717 return_file value from the first address into all the addresses of the
2718 batch, so they are all listed in the error message. */
2720 addr2->return_file = addr->return_file;
2722 /* Change log character for recording successful deliveries. */
2724 if (result == OK) logchar = '-';
2726 } /* Loop back for next batch of addresses */
2732 /*************************************************
2733 * Sort remote deliveries *
2734 *************************************************/
2736 /* This function is called if remote_sort_domains is set. It arranges that the
2737 chain of addresses for remote deliveries is ordered according to the strings
2738 specified. Try to make this shuffling reasonably efficient by handling
2739 sequences of addresses rather than just single ones.
2746 sort_remote_deliveries(void)
2749 address_item **aptr = &addr_remote;
2750 uschar *listptr = remote_sort_domains;
2754 while (*aptr != NULL &&
2755 (pattern = string_nextinlist(&listptr, &sep, patbuf, sizeof(patbuf)))
2758 address_item *moved = NULL;
2759 address_item **bptr = &moved;
2761 while (*aptr != NULL)
2763 address_item **next;
2764 deliver_domain = (*aptr)->domain; /* set $domain */
2765 if (match_isinlist(deliver_domain, &pattern, UCHAR_MAX+1,
2766 &domainlist_anchor, NULL, MCL_DOMAIN, TRUE, NULL) == OK)
2768 aptr = &((*aptr)->next);
2772 next = &((*aptr)->next);
2773 while (*next != NULL &&
2774 (deliver_domain = (*next)->domain, /* Set $domain */
2775 match_isinlist(deliver_domain, &pattern, UCHAR_MAX+1,
2776 &domainlist_anchor, NULL, MCL_DOMAIN, TRUE, NULL)) != OK)
2777 next = &((*next)->next);
2779 /* If the batch of non-matchers is at the end, add on any that were
2780 extracted further up the chain, and end this iteration. Otherwise,
2781 extract them from the chain and hang on the moved chain. */
2793 aptr = &((*aptr)->next);
2796 /* If the loop ended because the final address matched, *aptr will
2797 be NULL. Add on to the end any extracted non-matching addresses. If
2798 *aptr is not NULL, the loop ended via "break" when *next is null, that
2799 is, there was a string of non-matching addresses at the end. In this
2800 case the extracted addresses have already been added on the end. */
2802 if (*aptr == NULL) *aptr = moved;
2808 debug_printf("remote addresses after sorting:\n");
2809 for (addr = addr_remote; addr != NULL; addr = addr->next)
2810 debug_printf(" %s\n", addr->address);
2816 /*************************************************
2817 * Read from pipe for remote delivery subprocess *
2818 *************************************************/
2820 /* This function is called when the subprocess is complete, but can also be
2821 called before it is complete, in order to empty a pipe that is full (to prevent
2822 deadlock). It must therefore keep track of its progress in the parlist data
2825 We read the pipe to get the delivery status codes and a possible error message
2826 for each address, optionally preceded by unusability data for the hosts and
2827 also by optional retry data.
2829 Read in large chunks into the big buffer and then scan through, interpreting
2830 the data therein. In most cases, only a single read will be necessary. No
2831 individual item will ever be anywhere near 2500 bytes in length, so by ensuring
2832 that we read the next chunk when there is less than 2500 bytes left in the
2833 non-final chunk, we can assume each item is complete in the buffer before
2834 handling it. Each item is written using a single write(), which is atomic for
2835 small items (less than PIPE_BUF, which seems to be at least 512 in any Unix and
2836 often bigger) so even if we are reading while the subprocess is still going, we
2837 should never have only a partial item in the buffer.
2840 poffset the offset of the parlist item
2841 eop TRUE if the process has completed
2843 Returns: TRUE if the terminating 'Z' item has been read,
2844 or there has been a disaster (i.e. no more data needed);
2849 par_read_pipe(int poffset, BOOL eop)
2852 pardata *p = parlist + poffset;
2853 address_item *addrlist = p->addrlist;
2854 address_item *addr = p->addr;
2857 uschar *endptr = big_buffer;
2858 uschar *ptr = endptr;
2859 uschar *msg = p->msg;
2860 BOOL done = p->done;
2861 BOOL unfinished = TRUE;
2863 /* Loop through all items, reading from the pipe when necessary. The pipe
2864 is set up to be non-blocking, but there are two different Unix mechanisms in
2865 use. Exim uses O_NONBLOCK if it is defined. This returns 0 for end of file,
2866 and EAGAIN for no more data. If O_NONBLOCK is not defined, Exim uses O_NDELAY,
2867 which returns 0 for both end of file and no more data. We distinguish the
2868 two cases by taking 0 as end of file only when we know the process has
2871 Each separate item is written to the pipe in a single write(), and as they are
2872 all short items, the writes will all be atomic and we should never find
2873 ourselves in the position of having read an incomplete item. "Short" in this
2874 case can mean up to about 1K in the case when there is a long error message
2875 associated with an address. */
2877 DEBUG(D_deliver) debug_printf("reading pipe for subprocess %d (%s)\n",
2878 (int)p->pid, eop? "ended" : "not ended");
2882 retry_item *r, **rp;
2883 int remaining = endptr - ptr;
2885 /* Read (first time) or top up the chars in the buffer if necessary.
2886 There will be only one read if we get all the available data (i.e. don't
2887 fill the buffer completely). */
2889 if (remaining < 2500 && unfinished)
2892 int available = big_buffer_size - remaining;
2894 if (remaining > 0) memmove(big_buffer, ptr, remaining);
2897 endptr = big_buffer + remaining;
2898 len = read(fd, endptr, available);
2900 DEBUG(D_deliver) debug_printf("read() yielded %d\n", len);
2902 /* If the result is EAGAIN and the process is not complete, just
2903 stop reading any more and process what we have already. */
2907 if (!eop && errno == EAGAIN) len = 0; else
2909 msg = string_sprintf("failed to read pipe from transport process "
2910 "%d for transport %s: %s", pid, addr->transport->driver_name,
2916 /* If the length is zero (eof or no-more-data), just process what we
2917 already have. Note that if the process is still running and we have
2918 read all the data in the pipe (but less that "available") then we
2919 won't read any more, as "unfinished" will get set FALSE. */
2922 unfinished = len == available;
2925 /* If we are at the end of the available data, exit the loop. */
2927 if (ptr >= endptr) break;
2929 /* Handle each possible type of item, assuming the complete item is
2930 available in store. */
2934 /* Host items exist only if any hosts were marked unusable. Match
2935 up by checking the IP address. */
2938 for (h = addrlist->host_list; h != NULL; h = h->next)
2940 if (h->address == NULL || Ustrcmp(h->address, ptr+2) != 0) continue;
2948 /* Retry items are sent in a preceding R item for each address. This is
2949 kept separate to keep each message short enough to guarantee it won't
2950 be split in the pipe. Hopefully, in the majority of cases, there won't in
2951 fact be any retry items at all.
2953 The complete set of retry items might include an item to delete a
2954 routing retry if there was a previous routing delay. However, routing
2955 retries are also used when a remote transport identifies an address error.
2956 In that case, there may also be an "add" item for the same key. Arrange
2957 that a "delete" item is dropped in favour of an "add" item. */
2960 if (addr == NULL) goto ADDR_MISMATCH;
2962 DEBUG(D_deliver|D_retry)
2963 debug_printf("reading retry information for %s from subprocess\n",
2966 /* Cut out any "delete" items on the list. */
2968 for (rp = &(addr->retries); (r = *rp) != NULL; rp = &(r->next))
2970 if (Ustrcmp(r->key, ptr+1) == 0) /* Found item with same key */
2972 if ((r->flags & rf_delete) == 0) break; /* It was not "delete" */
2973 *rp = r->next; /* Excise a delete item */
2974 DEBUG(D_deliver|D_retry)
2975 debug_printf(" existing delete item dropped\n");
2979 /* We want to add a delete item only if there is no non-delete item;
2980 however we still have to step ptr through the data. */
2982 if (r == NULL || (*ptr & rf_delete) == 0)
2984 r = store_get(sizeof(retry_item));
2985 r->next = addr->retries;
2988 r->key = string_copy(ptr);
2990 memcpy(&(r->basic_errno), ptr, sizeof(r->basic_errno));
2991 ptr += sizeof(r->basic_errno);
2992 memcpy(&(r->more_errno), ptr, sizeof(r->more_errno));
2993 ptr += sizeof(r->more_errno);
2994 r->message = (*ptr)? string_copy(ptr) : NULL;
2995 DEBUG(D_deliver|D_retry)
2996 debug_printf(" added %s item\n",
2997 ((r->flags & rf_delete) == 0)? "retry" : "delete");
3002 DEBUG(D_deliver|D_retry)
3003 debug_printf(" delete item not added: non-delete item exists\n");
3006 ptr += sizeof(r->basic_errno) + sizeof(r->more_errno);
3012 /* Put the amount of data written into the parlist block */
3015 memcpy(&(p->transport_count), ptr, sizeof(transport_count));
3016 ptr += sizeof(transport_count);
3019 /* Address items are in the order of items on the address chain. We
3020 remember the current address value in case this function is called
3021 several times to empty the pipe in stages. Information about delivery
3022 over TLS is sent in a preceding X item for each address. We don't put
3023 it in with the other info, in order to keep each message short enough to
3024 guarantee it won't be split in the pipe. */
3028 if (addr == NULL) goto ADDR_MISMATCH; /* Below, in 'A' handler */
3032 addr->cipher = NULL;
3033 addr->peerdn = NULL;
3036 addr->cipher = string_copy(ptr);
3039 addr->peerdn = string_copy(ptr);
3043 addr->peercert = NULL;
3045 (void) tls_import_cert(ptr, &addr->peercert);
3049 addr->ourcert = NULL;
3051 (void) tls_import_cert(ptr, &addr->ourcert);
3054 # ifndef DISABLE_OCSP
3056 addr->ocsp = OCSP_NOT_REQ;
3058 addr->ocsp = *ptr - '0';
3064 #endif /*SUPPORT_TLS*/
3066 case 'C': /* client authenticator information */
3070 addr->authenticator = (*ptr)? string_copy(ptr) : NULL;
3073 addr->auth_id = (*ptr)? string_copy(ptr) : NULL;
3076 addr->auth_sndr = (*ptr)? string_copy(ptr) : NULL;
3082 #ifndef DISABLE_PRDR
3084 addr->flags |= af_prdr_used;
3088 #ifdef EXPERIMENTAL_DSN
3090 if (addr == NULL) break;
3091 memcpy(&(addr->dsn_aware), ptr, sizeof(addr->dsn_aware));
3092 ptr += sizeof(addr->dsn_aware);
3093 DEBUG(D_deliver) debug_printf("DSN read: addr->dsn_aware = %d\n", addr->dsn_aware);
3101 msg = string_sprintf("address count mismatch for data read from pipe "
3102 "for transport process %d for transport %s", pid,
3103 addrlist->transport->driver_name);
3108 addr->transport_return = *ptr++;
3109 addr->special_action = *ptr++;
3110 memcpy(&(addr->basic_errno), ptr, sizeof(addr->basic_errno));
3111 ptr += sizeof(addr->basic_errno);
3112 memcpy(&(addr->more_errno), ptr, sizeof(addr->more_errno));
3113 ptr += sizeof(addr->more_errno);
3114 memcpy(&(addr->flags), ptr, sizeof(addr->flags));
3115 ptr += sizeof(addr->flags);
3116 addr->message = (*ptr)? string_copy(ptr) : NULL;
3118 addr->user_message = (*ptr)? string_copy(ptr) : NULL;
3121 /* Always two strings for host information, followed by the port number and DNSSEC mark */
3125 h = store_get(sizeof(host_item));
3126 h->name = string_copy(ptr);
3128 h->address = string_copy(ptr);
3130 memcpy(&(h->port), ptr, sizeof(h->port));
3131 ptr += sizeof(h->port);
3132 h->dnssec = *ptr == '2' ? DS_YES
3133 : *ptr == '1' ? DS_NO
3136 addr->host_used = h;
3140 /* Finished with this address */
3145 /* Z marks the logical end of the data. It is followed by '0' if
3146 continue_transport was NULL at the end of transporting, otherwise '1'.
3147 We need to know when it becomes NULL during a delivery down a passed SMTP
3148 channel so that we don't try to pass anything more down it. Of course, for
3149 most normal messages it will remain NULL all the time. */
3154 continue_transport = NULL;
3155 continue_hostname = NULL;
3158 DEBUG(D_deliver) debug_printf("Z%c item read\n", *ptr);
3161 /* Anything else is a disaster. */
3164 msg = string_sprintf("malformed data (%d) read from pipe for transport "
3165 "process %d for transport %s", ptr[-1], pid,
3166 addr->transport->driver_name);
3172 /* The done flag is inspected externally, to determine whether or not to
3173 call the function again when the process finishes. */
3177 /* If the process hadn't finished, and we haven't seen the end of the data
3178 or suffered a disaster, update the rest of the state, and return FALSE to
3179 indicate "not finished". */
3188 /* Close our end of the pipe, to prevent deadlock if the far end is still
3189 pushing stuff into it. */
3194 /* If we have finished without error, but haven't had data for every address,
3195 something is wrong. */
3197 if (msg == NULL && addr != NULL)
3198 msg = string_sprintf("insufficient address data read from pipe "
3199 "for transport process %d for transport %s", pid,
3200 addr->transport->driver_name);
3202 /* If an error message is set, something has gone wrong in getting back
3203 the delivery data. Put the message into each address and freeze it. */
3207 for (addr = addrlist; addr != NULL; addr = addr->next)
3209 addr->transport_return = DEFER;
3210 addr->special_action = SPECIAL_FREEZE;
3211 addr->message = msg;
3215 /* Return TRUE to indicate we have got all we need from this process, even
3216 if it hasn't actually finished yet. */
3223 /*************************************************
3224 * Post-process a set of remote addresses *
3225 *************************************************/
3227 /* Do what has to be done immediately after a remote delivery for each set of
3228 addresses, then re-write the spool if necessary. Note that post_process_one
3229 puts the address on an appropriate queue; hence we must fish off the next
3230 one first. This function is also called if there is a problem with setting
3231 up a subprocess to do a remote delivery in parallel. In this case, the final
3232 argument contains a message, and the action must be forced to DEFER.
3235 addr pointer to chain of address items
3236 logflags flags for logging
3237 msg NULL for normal cases; -> error message for unexpected problems
3238 fallback TRUE if processing fallback hosts
3244 remote_post_process(address_item *addr, int logflags, uschar *msg,
3249 /* If any host addresses were found to be unusable, add them to the unusable
3250 tree so that subsequent deliveries don't try them. */
3252 for (h = addr->host_list; h != NULL; h = h->next)
3254 if (h->address == NULL) continue;
3255 if (h->status >= hstatus_unusable) tree_add_unusable(h);
3258 /* Now handle each address on the chain. The transport has placed '=' or '-'
3259 into the special_action field for each successful delivery. */
3261 while (addr != NULL)
3263 address_item *next = addr->next;
3265 /* If msg == NULL (normal processing) and the result is DEFER and we are
3266 processing the main hosts and there are fallback hosts available, put the
3267 address on the list for fallback delivery. */
3269 if (addr->transport_return == DEFER &&
3270 addr->fallback_hosts != NULL &&
3274 addr->host_list = addr->fallback_hosts;
3275 addr->next = addr_fallback;
3276 addr_fallback = addr;
3277 DEBUG(D_deliver) debug_printf("%s queued for fallback host(s)\n", addr->address);
3280 /* If msg is set (=> unexpected problem), set it in the address before
3281 doing the ordinary post processing. */
3287 addr->message = msg;
3288 addr->transport_return = DEFER;
3290 (void)post_process_one(addr, addr->transport_return, logflags,
3291 DTYPE_TRANSPORT, addr->special_action);
3299 /* If we have just delivered down a passed SMTP channel, and that was
3300 the last address, the channel will have been closed down. Now that
3301 we have logged that delivery, set continue_sequence to 1 so that
3302 any subsequent deliveries don't get "*" incorrectly logged. */
3304 if (continue_transport == NULL) continue_sequence = 1;
3309 /*************************************************
3310 * Wait for one remote delivery subprocess *
3311 *************************************************/
3313 /* This function is called while doing remote deliveries when either the
3314 maximum number of processes exist and we need one to complete so that another
3315 can be created, or when waiting for the last ones to complete. It must wait for
3316 the completion of one subprocess, empty the control block slot, and return a
3317 pointer to the address chain.
3320 Returns: pointer to the chain of addresses handled by the process;
3321 NULL if no subprocess found - this is an unexpected error
3324 static address_item *
3327 int poffset, status;
3328 address_item *addr, *addrlist;
3331 set_process_info("delivering %s: waiting for a remote delivery subprocess "
3332 "to finish", message_id);
3334 /* Loop until either a subprocess completes, or there are no subprocesses in
3335 existence - in which case give an error return. We cannot proceed just by
3336 waiting for a completion, because a subprocess may have filled up its pipe, and
3337 be waiting for it to be emptied. Therefore, if no processes have finished, we
3338 wait for one of the pipes to acquire some data by calling select(), with a
3339 timeout just in case.
3341 The simple approach is just to iterate after reading data from a ready pipe.
3342 This leads to non-ideal behaviour when the subprocess has written its final Z
3343 item, closed the pipe, and is in the process of exiting (the common case). A
3344 call to waitpid() yields nothing completed, but select() shows the pipe ready -
3345 reading it yields EOF, so you end up with busy-waiting until the subprocess has
3348 To avoid this, if all the data that is needed has been read from a subprocess
3349 after select(), an explicit wait() for it is done. We know that all it is doing
3350 is writing to the pipe and then exiting, so the wait should not be long.
3352 The non-blocking waitpid() is to some extent just insurance; if we could
3353 reliably detect end-of-file on the pipe, we could always know when to do a
3354 blocking wait() for a completed process. However, because some systems use
3355 NDELAY, which doesn't distinguish between EOF and pipe empty, it is easier to
3356 use code that functions without the need to recognize EOF.
3358 There's a double loop here just in case we end up with a process that is not in
3359 the list of remote delivery processes. Something has obviously gone wrong if
3360 this is the case. (For example, a process that is incorrectly left over from
3361 routing or local deliveries might be found.) The damage can be minimized by
3362 looping back and looking for another process. If there aren't any, the error
3363 return will happen. */
3365 for (;;) /* Normally we do not repeat this loop */
3367 while ((pid = waitpid(-1, &status, WNOHANG)) <= 0)
3370 fd_set select_pipes;
3371 int maxpipe, readycount;
3373 /* A return value of -1 can mean several things. If errno != ECHILD, it
3374 either means invalid options (which we discount), or that this process was
3375 interrupted by a signal. Just loop to try the waitpid() again.
3377 If errno == ECHILD, waitpid() is telling us that there are no subprocesses
3378 in existence. This should never happen, and is an unexpected error.
3379 However, there is a nasty complication when running under Linux. If "strace
3380 -f" is being used under Linux to trace this process and its children,
3381 subprocesses are "stolen" from their parents and become the children of the
3382 tracing process. A general wait such as the one we've just obeyed returns
3383 as if there are no children while subprocesses are running. Once a
3384 subprocess completes, it is restored to the parent, and waitpid(-1) finds
3385 it. Thanks to Joachim Wieland for finding all this out and suggesting a
3388 This does not happen using "truss" on Solaris, nor (I think) with other
3389 tracing facilities on other OS. It seems to be specific to Linux.
3391 What we do to get round this is to use kill() to see if any of our
3392 subprocesses are still in existence. If kill() gives an OK return, we know
3393 it must be for one of our processes - it can't be for a re-use of the pid,
3394 because if our process had finished, waitpid() would have found it. If any
3395 of our subprocesses are in existence, we proceed to use select() as if
3396 waitpid() had returned zero. I think this is safe. */
3400 if (errno != ECHILD) continue; /* Repeats the waitpid() */
3403 debug_printf("waitpid() returned -1/ECHILD: checking explicitly "
3404 "for process existence\n");
3406 for (poffset = 0; poffset < remote_max_parallel; poffset++)
3408 if ((pid = parlist[poffset].pid) != 0 && kill(pid, 0) == 0)
3410 DEBUG(D_deliver) debug_printf("process %d still exists: assume "
3411 "stolen by strace\n", (int)pid);
3412 break; /* With poffset set */
3416 if (poffset >= remote_max_parallel)
3418 DEBUG(D_deliver) debug_printf("*** no delivery children found\n");
3419 return NULL; /* This is the error return */
3423 /* A pid value greater than 0 breaks the "while" loop. A negative value has
3424 been handled above. A return value of zero means that there is at least one
3425 subprocess, but there are no completed subprocesses. See if any pipes are
3426 ready with any data for reading. */
3428 DEBUG(D_deliver) debug_printf("selecting on subprocess pipes\n");
3431 FD_ZERO(&select_pipes);
3432 for (poffset = 0; poffset < remote_max_parallel; poffset++)
3434 if (parlist[poffset].pid != 0)
3436 int fd = parlist[poffset].fd;
3437 FD_SET(fd, &select_pipes);
3438 if (fd > maxpipe) maxpipe = fd;
3442 /* Stick in a 60-second timeout, just in case. */
3447 readycount = select(maxpipe + 1, (SELECT_ARG2_TYPE *)&select_pipes,
3450 /* Scan through the pipes and read any that are ready; use the count
3451 returned by select() to stop when there are no more. Select() can return
3452 with no processes (e.g. if interrupted). This shouldn't matter.
3454 If par_read_pipe() returns TRUE, it means that either the terminating Z was
3455 read, or there was a disaster. In either case, we are finished with this
3456 process. Do an explicit wait() for the process and break the main loop if
3459 It turns out that we have to deal with the case of an interrupted system
3460 call, which can happen on some operating systems if the signal handling is
3461 set up to do that by default. */
3464 readycount > 0 && poffset < remote_max_parallel;
3467 if ((pid = parlist[poffset].pid) != 0 &&
3468 FD_ISSET(parlist[poffset].fd, &select_pipes))
3471 if (par_read_pipe(poffset, FALSE)) /* Finished with this pipe */
3473 for (;;) /* Loop for signals */
3475 pid_t endedpid = waitpid(pid, &status, 0);
3476 if (endedpid == pid) goto PROCESS_DONE;
3477 if (endedpid != (pid_t)(-1) || errno != EINTR)
3478 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Unexpected error return "
3479 "%d (errno = %d) from waitpid() for process %d",
3480 (int)endedpid, errno, (int)pid);
3486 /* Now go back and look for a completed subprocess again. */
3489 /* A completed process was detected by the non-blocking waitpid(). Find the
3490 data block that corresponds to this subprocess. */
3492 for (poffset = 0; poffset < remote_max_parallel; poffset++)
3493 if (pid == parlist[poffset].pid) break;
3495 /* Found the data block; this is a known remote delivery process. We don't
3496 need to repeat the outer loop. This should be what normally happens. */
3498 if (poffset < remote_max_parallel) break;
3500 /* This situation is an error, but it's probably better to carry on looking
3501 for another process than to give up (as we used to do). */
3503 log_write(0, LOG_MAIN|LOG_PANIC, "Process %d finished: not found in remote "
3504 "transport process list", pid);
3505 } /* End of the "for" loop */
3507 /* Come here when all the data was completely read after a select(), and
3508 the process in pid has been wait()ed for. */
3515 debug_printf("remote delivery process %d ended\n", (int)pid);
3517 debug_printf("remote delivery process %d ended: status=%04x\n", (int)pid,
3521 set_process_info("delivering %s", message_id);
3523 /* Get the chain of processed addresses */
3525 addrlist = parlist[poffset].addrlist;
3527 /* If the process did not finish cleanly, record an error and freeze (except
3528 for SIGTERM, SIGKILL and SIGQUIT), and also ensure the journal is not removed,
3529 in case the delivery did actually happen. */
3531 if ((status & 0xffff) != 0)
3534 int msb = (status >> 8) & 255;
3535 int lsb = status & 255;
3536 int code = (msb == 0)? (lsb & 0x7f) : msb;
3538 msg = string_sprintf("%s transport process returned non-zero status 0x%04x: "
3540 addrlist->transport->driver_name,
3542 (msb == 0)? "terminated by signal" : "exit code",
3545 if (msb != 0 || (code != SIGTERM && code != SIGKILL && code != SIGQUIT))
3546 addrlist->special_action = SPECIAL_FREEZE;
3548 for (addr = addrlist; addr != NULL; addr = addr->next)
3550 addr->transport_return = DEFER;
3551 addr->message = msg;
3554 remove_journal = FALSE;
3557 /* Else complete reading the pipe to get the result of the delivery, if all
3558 the data has not yet been obtained. */
3560 else if (!parlist[poffset].done) (void)par_read_pipe(poffset, TRUE);
3562 /* Put the data count and return path into globals, mark the data slot unused,
3563 decrement the count of subprocesses, and return the address chain. */
3565 transport_count = parlist[poffset].transport_count;
3566 used_return_path = parlist[poffset].return_path;
3567 parlist[poffset].pid = 0;
3574 /*************************************************
3575 * Wait for subprocesses and post-process *
3576 *************************************************/
3578 /* This function waits for subprocesses until the number that are still running
3579 is below a given threshold. For each complete subprocess, the addresses are
3580 post-processed. If we can't find a running process, there is some shambles.
3581 Better not bomb out, as that might lead to multiple copies of the message. Just
3582 log and proceed as if all done.
3585 max maximum number of subprocesses to leave running
3586 fallback TRUE if processing fallback hosts
3592 par_reduce(int max, BOOL fallback)
3594 while (parcount > max)
3596 address_item *doneaddr = par_wait();
3597 if (doneaddr == NULL)
3599 log_write(0, LOG_MAIN|LOG_PANIC,
3600 "remote delivery process count got out of step");
3603 else remote_post_process(doneaddr, LOG_MAIN, NULL, fallback);
3611 rmt_dlv_checked_write(int fd, void * buf, int size)
3613 int ret = write(fd, buf, size);
3615 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Failed writing transport result to pipe: %s\n",
3616 ret == -1 ? strerror(errno) : "short write");
3619 /*************************************************
3620 * Do remote deliveries *
3621 *************************************************/
3623 /* This function is called to process the addresses in addr_remote. We must
3624 pick off the queue all addresses that have the same transport, remote
3625 destination, and errors address, and hand them to the transport in one go,
3626 subject to some configured limitations. If this is a run to continue delivering
3627 to an existing delivery channel, skip all but those addresses that can go to
3628 that channel. The skipped addresses just get deferred.
3630 If mua_wrapper is set, all addresses must be able to be sent in a single
3631 transaction. If not, this function yields FALSE.
3633 In Exim 4, remote deliveries are always done in separate processes, even
3634 if remote_max_parallel = 1 or if there's only one delivery to do. The reason
3635 is so that the base process can retain privilege. This makes the
3636 implementation of fallback transports feasible (though not initially done.)
3638 We create up to the configured number of subprocesses, each of which passes
3639 back the delivery state via a pipe. (However, when sending down an existing
3640 connection, remote_max_parallel is forced to 1.)
3643 fallback TRUE if processing fallback hosts
3645 Returns: TRUE normally
3646 FALSE if mua_wrapper is set and the addresses cannot all be sent
3651 do_remote_deliveries(BOOL fallback)
3657 parcount = 0; /* Number of executing subprocesses */
3659 /* When sending down an existing channel, only do one delivery at a time.
3660 We use a local variable (parmax) to hold the maximum number of processes;
3661 this gets reduced from remote_max_parallel if we can't create enough pipes. */
3663 if (continue_transport != NULL) remote_max_parallel = 1;
3664 parmax = remote_max_parallel;
3666 /* If the data for keeping a list of processes hasn't yet been
3669 if (parlist == NULL)
3671 parlist = store_get(remote_max_parallel * sizeof(pardata));
3672 for (poffset = 0; poffset < remote_max_parallel; poffset++)
3673 parlist[poffset].pid = 0;
3676 /* Now loop for each remote delivery */
3678 for (delivery_count = 0; addr_remote != NULL; delivery_count++)
3684 int address_count = 1;
3685 int address_count_max;
3687 BOOL use_initgroups;
3688 BOOL pipe_done = FALSE;
3689 transport_instance *tp;
3690 address_item **anchor = &addr_remote;
3691 address_item *addr = addr_remote;
3692 address_item *last = addr;
3695 /* Pull the first address right off the list. */
3697 addr_remote = addr->next;
3700 DEBUG(D_deliver|D_transport)
3701 debug_printf("--------> %s <--------\n", addr->address);
3703 /* If no transport has been set, there has been a big screw-up somewhere. */
3705 if ((tp = addr->transport) == NULL)
3707 disable_logging = FALSE; /* Jic */
3708 remote_post_process(addr, LOG_MAIN|LOG_PANIC,
3709 US"No transport set by router", fallback);
3713 /* Check that this base address hasn't previously been delivered to this
3714 transport. The check is necessary at this point to handle homonymic addresses
3715 correctly in cases where the pattern of redirection changes between delivery
3716 attempts. Non-homonymic previous delivery is detected earlier, at routing
3719 if (previously_transported(addr, FALSE)) continue;
3721 /* Force failure if the message is too big. */
3723 if (tp->message_size_limit != NULL)
3725 int rc = check_message_size(tp, addr);
3728 addr->transport_return = rc;
3729 remote_post_process(addr, LOG_MAIN, NULL, fallback);
3734 /* Get the flag which specifies whether the transport can handle different
3735 domains that nevertheless resolve to the same set of hosts. */
3737 multi_domain = tp->multi_domain;
3739 /* Get the maximum it can handle in one envelope, with zero meaning
3740 unlimited, which is forced for the MUA wrapper case. */
3742 address_count_max = tp->max_addresses;
3743 if (address_count_max == 0 || mua_wrapper) address_count_max = 999999;
3746 /************************************************************************/
3747 /***** This is slightly experimental code, but should be safe. *****/
3749 /* The address_count_max value is the maximum number of addresses that the
3750 transport can send in one envelope. However, the transport must be capable of
3751 dealing with any number of addresses. If the number it gets exceeds its
3752 envelope limitation, it must send multiple copies of the message. This can be
3753 done over a single connection for SMTP, so uses less resources than making
3754 multiple connections. On the other hand, if remote_max_parallel is greater
3755 than one, it is perhaps a good idea to use parallel processing to move the
3756 message faster, even if that results in multiple simultaneous connections to
3759 How can we come to some compromise between these two ideals? What we do is to
3760 limit the number of addresses passed to a single instance of a transport to
3761 the greater of (a) its address limit (rcpt_max for SMTP) and (b) the total
3762 number of addresses routed to remote transports divided by
3763 remote_max_parallel. For example, if the message has 100 remote recipients,
3764 remote max parallel is 2, and rcpt_max is 10, we'd never send more than 50 at
3765 once. But if rcpt_max is 100, we could send up to 100.
3767 Of course, not all the remotely addresses in a message are going to go to the
3768 same set of hosts (except in smarthost configurations), so this is just a
3769 heuristic way of dividing up the work.
3771 Furthermore (1), because this may not be wanted in some cases, and also to
3772 cope with really pathological cases, there is also a limit to the number of
3773 messages that are sent over one connection. This is the same limit that is
3774 used when sending several different messages over the same connection.
3775 Continue_sequence is set when in this situation, to the number sent so
3776 far, including this message.
3778 Furthermore (2), when somebody explicitly sets the maximum value to 1, it
3779 is probably because they are using VERP, in which case they want to pass only
3780 one address at a time to the transport, in order to be able to use
3781 $local_part and $domain in constructing a new return path. We could test for
3782 the use of these variables, but as it is so likely they will be used when the
3783 maximum is 1, we don't bother. Just leave the value alone. */
3785 if (address_count_max != 1 &&
3786 address_count_max < remote_delivery_count/remote_max_parallel)
3788 int new_max = remote_delivery_count/remote_max_parallel;
3789 int message_max = tp->connection_max_messages;
3790 if (connection_max_messages >= 0) message_max = connection_max_messages;
3791 message_max -= continue_sequence - 1;
3792 if (message_max > 0 && new_max > address_count_max * message_max)
3793 new_max = address_count_max * message_max;
3794 address_count_max = new_max;
3797 /************************************************************************/
3800 /* Pick off all addresses which have the same transport, errors address,
3801 destination, and extra headers. In some cases they point to the same host
3802 list, but we also need to check for identical host lists generated from
3803 entirely different domains. The host list pointers can be NULL in the case
3804 where the hosts are defined in the transport. There is also a configured
3805 maximum limit of addresses that can be handled at once (see comments above
3806 for how it is computed). */
3808 while ((next = *anchor) != NULL && address_count < address_count_max)
3810 if ((multi_domain || Ustrcmp(next->domain, addr->domain) == 0)
3812 tp == next->transport
3814 same_hosts(next->host_list, addr->host_list)
3816 same_strings(next->p.errors_address, addr->p.errors_address)
3818 same_headers(next->p.extra_headers, addr->p.extra_headers)
3820 same_ugid(tp, next, addr)
3822 (next->p.remove_headers == addr->p.remove_headers ||
3823 (next->p.remove_headers != NULL &&
3824 addr->p.remove_headers != NULL &&
3825 Ustrcmp(next->p.remove_headers, addr->p.remove_headers) == 0)))
3827 *anchor = next->next;
3829 next->first = addr; /* remember top one (for retry processing) */
3834 else anchor = &(next->next);
3837 /* If we are acting as an MUA wrapper, all addresses must go in a single
3838 transaction. If not, put them back on the chain and yield FALSE. */
3840 if (mua_wrapper && addr_remote != NULL)
3842 last->next = addr_remote;
3847 /* Set up the expansion variables for this set of addresses */
3849 deliver_set_expansions(addr);
3851 /* Ensure any transport-set auth info is fresh */
3852 addr->authenticator = addr->auth_id = addr->auth_sndr = NULL;
3854 /* Compute the return path, expanding a new one if required. The old one
3855 must be set first, as it might be referred to in the expansion. */
3857 if(addr->p.errors_address != NULL)
3858 return_path = addr->p.errors_address;
3859 #ifdef EXPERIMENTAL_SRS
3860 else if(addr->p.srs_sender != NULL)
3861 return_path = addr->p.srs_sender;
3864 return_path = sender_address;
3866 if (tp->return_path != NULL)
3868 uschar *new_return_path = expand_string(tp->return_path);
3869 if (new_return_path == NULL)
3871 if (!expand_string_forcedfail)
3873 remote_post_process(addr, LOG_MAIN|LOG_PANIC,
3874 string_sprintf("Failed to expand return path \"%s\": %s",
3875 tp->return_path, expand_string_message), fallback);
3879 else return_path = new_return_path;
3882 /* Find the uid, gid, and use_initgroups setting for this transport. Failure
3883 logs and sets up error messages, so we just post-process and continue with
3884 the next address. */
3886 if (!findugid(addr, tp, &uid, &gid, &use_initgroups))
3888 remote_post_process(addr, LOG_MAIN|LOG_PANIC, NULL, fallback);
3892 /* If this transport has a setup function, call it now so that it gets
3893 run in this process and not in any subprocess. That way, the results of
3894 any setup that are retained by the transport can be reusable. One of the
3895 things the setup does is to set the fallback host lists in the addresses.
3896 That is why it is called at this point, before the continue delivery
3897 processing, because that might use the fallback hosts. */
3899 if (tp->setup != NULL)
3900 (void)((tp->setup)(addr->transport, addr, NULL, uid, gid, NULL));
3902 /* If this is a run to continue delivery down an already-established
3903 channel, check that this set of addresses matches the transport and
3904 the channel. If it does not, defer the addresses. If a host list exists,
3905 we must check that the continue host is on the list. Otherwise, the
3906 host is set in the transport. */
3908 continue_more = FALSE; /* In case got set for the last lot */
3909 if (continue_transport != NULL)
3911 BOOL ok = Ustrcmp(continue_transport, tp->name) == 0;
3912 if (ok && addr->host_list != NULL)
3916 for (h = addr->host_list; h != NULL; h = h->next)
3918 if (Ustrcmp(h->name, continue_hostname) == 0)
3919 { ok = TRUE; break; }
3923 /* Addresses not suitable; defer or queue for fallback hosts (which
3924 might be the continue host) and skip to next address. */
3928 DEBUG(D_deliver) debug_printf("not suitable for continue_transport\n");
3931 if (addr->fallback_hosts != NULL && !fallback)
3935 next->host_list = next->fallback_hosts;
3936 DEBUG(D_deliver) debug_printf("%s queued for fallback host(s)\n", next->address);
3937 if (next->next == NULL) break;
3940 next->next = addr_fallback;
3941 addr_fallback = addr;
3946 while (next->next != NULL) next = next->next;
3947 next->next = addr_defer;
3954 /* Set a flag indicating whether there are further addresses that list
3955 the continued host. This tells the transport to leave the channel open,
3956 but not to pass it to another delivery process. */
3958 for (next = addr_remote; next != NULL; next = next->next)
3961 for (h = next->host_list; h != NULL; h = h->next)
3963 if (Ustrcmp(h->name, continue_hostname) == 0)
3964 { continue_more = TRUE; break; }
3969 /* The transports set up the process info themselves as they may connect
3970 to more than one remote machine. They also have to set up the filter
3971 arguments, if required, so that the host name and address are available
3974 transport_filter_argv = NULL;
3976 /* Create the pipe for inter-process communication. If pipe creation
3977 fails, it is probably because the value of remote_max_parallel is so
3978 large that too many file descriptors for pipes have been created. Arrange
3979 to wait for a process to finish, and then try again. If we still can't
3980 create a pipe when all processes have finished, break the retry loop. */
3984 if (pipe(pfd) == 0) pipe_done = TRUE;
3985 else if (parcount > 0) parmax = parcount;
3988 /* We need to make the reading end of the pipe non-blocking. There are
3989 two different options for this. Exim is cunningly (I hope!) coded so
3990 that it can use either of them, though it prefers O_NONBLOCK, which
3991 distinguishes between EOF and no-more-data. */
3994 (void)fcntl(pfd[pipe_read], F_SETFL, O_NONBLOCK);
3996 (void)fcntl(pfd[pipe_read], F_SETFL, O_NDELAY);
3999 /* If the maximum number of subprocesses already exist, wait for a process
4000 to finish. If we ran out of file descriptors, parmax will have been reduced
4001 from its initial value of remote_max_parallel. */
4003 par_reduce(parmax - 1, fallback);
4006 /* If we failed to create a pipe and there were no processes to wait
4007 for, we have to give up on this one. Do this outside the above loop
4008 so that we can continue the main loop. */
4012 remote_post_process(addr, LOG_MAIN|LOG_PANIC,
4013 string_sprintf("unable to create pipe: %s", strerror(errno)), fallback);
4017 /* Find a free slot in the pardata list. Must do this after the possible
4018 waiting for processes to finish, because a terminating process will free
4021 for (poffset = 0; poffset < remote_max_parallel; poffset++)
4022 if (parlist[poffset].pid == 0) break;
4024 /* If there isn't one, there has been a horrible disaster. */
4026 if (poffset >= remote_max_parallel)
4028 (void)close(pfd[pipe_write]);
4029 (void)close(pfd[pipe_read]);
4030 remote_post_process(addr, LOG_MAIN|LOG_PANIC,
4031 US"Unexpectedly no free subprocess slot", fallback);
4035 /* Now fork a subprocess to do the remote delivery, but before doing so,
4036 ensure that any cached resourses are released so as not to interfere with
4037 what happens in the subprocess. */
4041 if ((pid = fork()) == 0)
4043 int fd = pfd[pipe_write];
4046 /* Setting this global in the subprocess means we need never clear it */
4047 transport_name = tp->name;
4049 /* There are weird circumstances in which logging is disabled */
4050 disable_logging = tp->disable_logging;
4052 /* Show pids on debug output if parallelism possible */
4054 if (parmax > 1 && (parcount > 0 || addr_remote != NULL))
4056 DEBUG(D_any|D_v) debug_selector |= D_pid;
4057 DEBUG(D_deliver) debug_printf("Remote delivery process started\n");
4060 /* Reset the random number generator, so different processes don't all
4061 have the same sequence. In the test harness we want different, but
4062 predictable settings for each delivery process, so do something explicit
4063 here rather they rely on the fixed reset in the random number function. */
4065 random_seed = running_in_test_harness? 42 + 2*delivery_count : 0;
4067 /* Set close-on-exec on the pipe so that it doesn't get passed on to
4068 a new process that may be forked to do another delivery down the same
4071 (void)fcntl(fd, F_SETFD, fcntl(fd, F_GETFD) | FD_CLOEXEC);
4073 /* Close open file descriptors for the pipes of other processes
4074 that are running in parallel. */
4076 for (poffset = 0; poffset < remote_max_parallel; poffset++)
4077 if (parlist[poffset].pid != 0) (void)close(parlist[poffset].fd);
4079 /* This process has inherited a copy of the file descriptor
4080 for the data file, but its file pointer is shared with all the
4081 other processes running in parallel. Therefore, we have to re-open
4082 the file in order to get a new file descriptor with its own
4083 file pointer. We don't need to lock it, as the lock is held by
4084 the parent process. There doesn't seem to be any way of doing
4085 a dup-with-new-file-pointer. */
4087 (void)close(deliver_datafile);
4088 sprintf(CS spoolname, "%s/input/%s/%s-D", spool_directory, message_subdir,
4090 deliver_datafile = Uopen(spoolname, O_RDWR | O_APPEND, 0);
4092 if (deliver_datafile < 0)
4093 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Failed to reopen %s for remote "
4094 "parallel delivery: %s", spoolname, strerror(errno));
4096 /* Set the close-on-exec flag */
4098 (void)fcntl(deliver_datafile, F_SETFD, fcntl(deliver_datafile, F_GETFD) |
4101 /* Set the uid/gid of this process; bombs out on failure. */
4103 exim_setugid(uid, gid, use_initgroups,
4104 string_sprintf("remote delivery to %s with transport=%s",
4105 addr->address, tp->name));
4107 /* Close the unwanted half of this process' pipe, set the process state,
4108 and run the transport. Afterwards, transport_count will contain the number
4109 of bytes written. */
4111 (void)close(pfd[pipe_read]);
4112 set_process_info("delivering %s using %s", message_id, tp->name);
4113 debug_print_string(tp->debug_string);
4114 if (!(tp->info->code)(addr->transport, addr)) replicate_status(addr);
4116 set_process_info("delivering %s (just run %s for %s%s in subprocess)",
4117 message_id, tp->name, addr->address, (addr->next == NULL)? "" : ", ...");
4119 /* Ensure any cached resources that we used are now released */
4123 /* Pass the result back down the pipe. This is a lot more information
4124 than is needed for a local delivery. We have to send back the error
4125 status for each address, the usability status for each host that is
4126 flagged as unusable, and all the retry items. When TLS is in use, we
4127 send also the cipher and peerdn information. Each type of information
4128 is flagged by an identifying byte, and is then in a fixed format (with
4129 strings terminated by zeros), and there is a final terminator at the
4130 end. The host information and retry information is all attached to
4131 the first address, so that gets sent at the start. */
4133 /* Host unusability information: for most success cases this will
4136 for (h = addr->host_list; h != NULL; h = h->next)
4138 if (h->address == NULL || h->status < hstatus_unusable) continue;
4139 sprintf(CS big_buffer, "H%c%c%s", h->status, h->why, h->address);
4140 rmt_dlv_checked_write(fd, big_buffer, Ustrlen(big_buffer+3) + 4);
4143 /* The number of bytes written. This is the same for each address. Even
4144 if we sent several copies of the message down the same connection, the
4145 size of each one is the same, and it's that value we have got because
4146 transport_count gets reset before calling transport_write_message(). */
4148 big_buffer[0] = 'S';
4149 memcpy(big_buffer+1, &transport_count, sizeof(transport_count));
4150 rmt_dlv_checked_write(fd, big_buffer, sizeof(transport_count) + 1);
4152 /* Information about what happened to each address. Four item types are
4153 used: an optional 'X' item first, for TLS information, then an optional "C"
4154 item for any client-auth info followed by 'R' items for any retry settings,
4155 and finally an 'A' item for the remaining data. */
4157 for(; addr != NULL; addr = addr->next)
4162 /* The certificate verification status goes into the flags */
4163 if (tls_out.certificate_verified) setflag(addr, af_cert_verified);
4164 #ifdef EXPERIMENTAL_DANE
4165 if (tls_out.dane_verified) setflag(addr, af_dane_verified);
4168 /* Use an X item only if there's something to send */
4173 sprintf(CS ptr, "X1%.128s", addr->cipher);
4179 sprintf(CS ptr, "%.512s", addr->peerdn);
4183 rmt_dlv_checked_write(fd, big_buffer, ptr - big_buffer);
4188 *ptr++ = 'X'; *ptr++ = '2';
4189 if (!tls_export_cert(ptr, big_buffer_size-2, addr->peercert))
4193 rmt_dlv_checked_write(fd, big_buffer, ptr - big_buffer);
4198 *ptr++ = 'X'; *ptr++ = '3';
4199 if (!tls_export_cert(ptr, big_buffer_size-2, addr->ourcert))
4203 rmt_dlv_checked_write(fd, big_buffer, ptr - big_buffer);
4205 # ifndef DISABLE_OCSP
4206 if (addr->ocsp > OCSP_NOT_REQ)
4209 sprintf(CS ptr, "X4%c", addr->ocsp + '0');
4211 rmt_dlv_checked_write(fd, big_buffer, ptr - big_buffer);
4214 #endif /*SUPPORT_TLS*/
4216 if (client_authenticator)
4219 sprintf(CS big_buffer, "C1%.64s", client_authenticator);
4221 rmt_dlv_checked_write(fd, big_buffer, ptr - big_buffer);
4223 if (client_authenticated_id)
4226 sprintf(CS big_buffer, "C2%.64s", client_authenticated_id);
4228 rmt_dlv_checked_write(fd, big_buffer, ptr - big_buffer);
4230 if (client_authenticated_sender)
4233 sprintf(CS big_buffer, "C3%.64s", client_authenticated_sender);
4235 rmt_dlv_checked_write(fd, big_buffer, ptr - big_buffer);
4238 #ifndef DISABLE_PRDR
4239 if (addr->flags & af_prdr_used)
4240 rmt_dlv_checked_write(fd, "P", 1);
4243 #ifdef EXPERIMENTAL_DSN
4244 big_buffer[0] = 'D';
4245 memcpy(big_buffer+1, &addr->dsn_aware, sizeof(addr->dsn_aware));
4246 rmt_dlv_checked_write(fd, big_buffer, sizeof(addr->dsn_aware) + 1);
4247 DEBUG(D_deliver) debug_printf("DSN write: addr->dsn_aware = %d\n", addr->dsn_aware);
4250 /* Retry information: for most success cases this will be null. */
4252 for (r = addr->retries; r != NULL; r = r->next)
4255 sprintf(CS big_buffer, "R%c%.500s", r->flags, r->key);
4256 ptr = big_buffer + Ustrlen(big_buffer+2) + 3;
4257 memcpy(ptr, &(r->basic_errno), sizeof(r->basic_errno));
4258 ptr += sizeof(r->basic_errno);
4259 memcpy(ptr, &(r->more_errno), sizeof(r->more_errno));
4260 ptr += sizeof(r->more_errno);
4261 if (r->message == NULL) *ptr++ = 0; else
4263 sprintf(CS ptr, "%.512s", r->message);
4266 rmt_dlv_checked_write(fd, big_buffer, ptr - big_buffer);
4269 /* The rest of the information goes in an 'A' item. */
4271 ptr = big_buffer + 3;
4272 sprintf(CS big_buffer, "A%c%c", addr->transport_return,
4273 addr->special_action);
4274 memcpy(ptr, &(addr->basic_errno), sizeof(addr->basic_errno));
4275 ptr += sizeof(addr->basic_errno);
4276 memcpy(ptr, &(addr->more_errno), sizeof(addr->more_errno));
4277 ptr += sizeof(addr->more_errno);
4278 memcpy(ptr, &(addr->flags), sizeof(addr->flags));
4279 ptr += sizeof(addr->flags);
4281 if (addr->message == NULL) *ptr++ = 0; else
4283 sprintf(CS ptr, "%.1024s", addr->message);
4287 if (addr->user_message == NULL) *ptr++ = 0; else
4289 sprintf(CS ptr, "%.1024s", addr->user_message);
4293 if (addr->host_used == NULL) *ptr++ = 0; else
4295 sprintf(CS ptr, "%.256s", addr->host_used->name);
4297 sprintf(CS ptr, "%.64s", addr->host_used->address);
4299 memcpy(ptr, &(addr->host_used->port), sizeof(addr->host_used->port));
4300 ptr += sizeof(addr->host_used->port);
4302 /* DNS lookup status */
4303 *ptr++ = addr->host_used->dnssec==DS_YES ? '2'
4304 : addr->host_used->dnssec==DS_NO ? '1' : '0';
4307 rmt_dlv_checked_write(fd, big_buffer, ptr - big_buffer);
4310 /* Add termination flag, close the pipe, and that's it. The character
4311 after 'Z' indicates whether continue_transport is now NULL or not.
4312 A change from non-NULL to NULL indicates a problem with a continuing
4315 big_buffer[0] = 'Z';
4316 big_buffer[1] = (continue_transport == NULL)? '0' : '1';
4317 rmt_dlv_checked_write(fd, big_buffer, 2);
4322 /* Back in the mainline: close the unwanted half of the pipe. */
4324 (void)close(pfd[pipe_write]);
4326 /* Fork failed; defer with error message */
4330 (void)close(pfd[pipe_read]);
4331 remote_post_process(addr, LOG_MAIN|LOG_PANIC,
4332 string_sprintf("fork failed for remote delivery to %s: %s",
4333 addr->domain, strerror(errno)), fallback);
4337 /* Fork succeeded; increment the count, and remember relevant data for
4338 when the process finishes. */
4341 parlist[poffset].addrlist = parlist[poffset].addr = addr;
4342 parlist[poffset].pid = pid;
4343 parlist[poffset].fd = pfd[pipe_read];
4344 parlist[poffset].done = FALSE;
4345 parlist[poffset].msg = NULL;
4346 parlist[poffset].return_path = return_path;
4348 /* If the process we've just started is sending a message down an existing
4349 channel, wait for it now. This ensures that only one such process runs at
4350 once, whatever the value of remote_max parallel. Otherwise, we might try to
4351 send two or more messages simultaneously down the same channel. This could
4352 happen if there are different domains that include the same host in otherwise
4353 different host lists.
4355 Also, if the transport closes down the channel, this information gets back
4356 (continue_transport gets set to NULL) before we consider any other addresses
4359 if (continue_transport != NULL) par_reduce(0, fallback);
4361 /* Otherwise, if we are running in the test harness, wait a bit, to let the
4362 newly created process get going before we create another process. This should
4363 ensure repeatability in the tests. We only need to wait a tad. */
4365 else if (running_in_test_harness) millisleep(500);
4368 /* Reached the end of the list of addresses. Wait for all the subprocesses that
4369 are still running and post-process their addresses. */
4371 par_reduce(0, fallback);
4378 /*************************************************
4379 * Split an address into local part and domain *
4380 *************************************************/
4382 /* This function initializes an address for routing by splitting it up into a
4383 local part and a domain. The local part is set up twice - once in its original
4384 casing, and once in lower case, and it is dequoted. We also do the "percent
4385 hack" for configured domains. This may lead to a DEFER result if a lookup
4386 defers. When a percent-hacking takes place, we insert a copy of the original
4387 address as a new parent of this address, as if we have had a redirection.
4390 addr points to an addr_item block containing the address
4393 DEFER - could not determine if domain is %-hackable
4397 deliver_split_address(address_item *addr)
4399 uschar *address = addr->address;
4400 uschar *domain = Ustrrchr(address, '@');
4402 int len = domain - address;
4404 addr->domain = string_copylc(domain+1); /* Domains are always caseless */
4406 /* The implication in the RFCs (though I can't say I've seen it spelled out
4407 explicitly) is that quoting should be removed from local parts at the point
4408 where they are locally interpreted. [The new draft "821" is more explicit on
4409 this, Jan 1999.] We know the syntax is valid, so this can be done by simply
4410 removing quoting backslashes and any unquoted doublequotes. */
4412 t = addr->cc_local_part = store_get(len+1);
4415 register int c = *address++;
4416 if (c == '\"') continue;
4426 /* We do the percent hack only for those domains that are listed in
4427 percent_hack_domains. A loop is required, to copy with multiple %-hacks. */
4429 if (percent_hack_domains != NULL)
4432 uschar *new_address = NULL;
4433 uschar *local_part = addr->cc_local_part;
4435 deliver_domain = addr->domain; /* set $domain */
4437 while ((rc = match_isinlist(deliver_domain, &percent_hack_domains, 0,
4438 &domainlist_anchor, addr->domain_cache, MCL_DOMAIN, TRUE, NULL))
4440 (t = Ustrrchr(local_part, '%')) != NULL)
4442 new_address = string_copy(local_part);
4443 new_address[t - local_part] = '@';
4444 deliver_domain = string_copylc(t+1);
4445 local_part = string_copyn(local_part, t - local_part);
4448 if (rc == DEFER) return DEFER; /* lookup deferred */
4450 /* If hackery happened, set up new parent and alter the current address. */
4452 if (new_address != NULL)
4454 address_item *new_parent = store_get(sizeof(address_item));
4455 *new_parent = *addr;
4456 addr->parent = new_parent;
4457 addr->address = new_address;
4458 addr->unique = string_copy(new_address);
4459 addr->domain = deliver_domain;
4460 addr->cc_local_part = local_part;
4461 DEBUG(D_deliver) debug_printf("%%-hack changed address to: %s\n",
4466 /* Create the lowercased version of the final local part, and make that the
4467 default one to be used. */
4469 addr->local_part = addr->lc_local_part = string_copylc(addr->cc_local_part);
4476 /*************************************************
4477 * Get next error message text *
4478 *************************************************/
4480 /* If f is not NULL, read the next "paragraph", from a customized error message
4481 text file, terminated by a line containing ****, and expand it.
4484 f NULL or a file to read from
4485 which string indicating which string (for errors)
4487 Returns: NULL or an expanded string
4491 next_emf(FILE *f, uschar *which)
4495 uschar *para, *yield;
4498 if (f == NULL) return NULL;
4500 if (Ufgets(buffer, sizeof(buffer), f) == NULL ||
4501 Ustrcmp(buffer, "****\n") == 0) return NULL;
4503 para = store_get(size);
4506 para = string_cat(para, &size, &ptr, buffer, Ustrlen(buffer));
4507 if (Ufgets(buffer, sizeof(buffer), f) == NULL ||
4508 Ustrcmp(buffer, "****\n") == 0) break;
4512 yield = expand_string(para);
4513 if (yield != NULL) return yield;
4515 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand string from "
4516 "bounce_message_file or warn_message_file (%s): %s", which,
4517 expand_string_message);
4524 /*************************************************
4525 * Close down a passed transport channel *
4526 *************************************************/
4528 /* This function is called when a passed transport channel cannot be used.
4529 It attempts to close it down tidily. The yield is always DELIVER_NOT_ATTEMPTED
4530 so that the function call can be the argument of a "return" statement.
4533 Returns: DELIVER_NOT_ATTEMPTED
4537 continue_closedown(void)
4539 if (continue_transport != NULL)
4541 transport_instance *t;
4542 for (t = transports; t != NULL; t = t->next)
4544 if (Ustrcmp(t->name, continue_transport) == 0)
4546 if (t->info->closedown != NULL) (t->info->closedown)(t);
4551 return DELIVER_NOT_ATTEMPTED;
4557 /*************************************************
4558 * Print address information *
4559 *************************************************/
4561 /* This function is called to output an address, or information about an
4562 address, for bounce or defer messages. If the hide_child flag is set, all we
4563 output is the original ancestor address.
4566 addr points to the address
4567 f the FILE to print to
4568 si an initial string
4569 sc a continuation string for before "generated"
4572 Returns: TRUE if the address is not hidden
4576 print_address_information(address_item *addr, FILE *f, uschar *si, uschar *sc,
4580 uschar *printed = US"";
4581 address_item *ancestor = addr;
4582 while (ancestor->parent != NULL) ancestor = ancestor->parent;
4584 fprintf(f, "%s", CS si);
4586 if (addr->parent != NULL && testflag(addr, af_hide_child))
4588 printed = US"an undisclosed address";
4591 else if (!testflag(addr, af_pfr) || addr->parent == NULL)
4592 printed = addr->address;
4596 uschar *s = addr->address;
4599 if (addr->address[0] == '>') { ss = US"mail"; s++; }
4600 else if (addr->address[0] == '|') ss = US"pipe";
4603 fprintf(f, "%s to %s%sgenerated by ", ss, s, sc);
4604 printed = addr->parent->address;
4607 fprintf(f, "%s", CS string_printing(printed));
4609 if (ancestor != addr)
4611 uschar *original = (ancestor->onetime_parent == NULL)?
4612 ancestor->address : ancestor->onetime_parent;
4613 if (strcmpic(original, printed) != 0)
4614 fprintf(f, "%s(%sgenerated from %s)", sc,
4615 (ancestor != addr->parent)? "ultimately " : "",
4616 string_printing(original));
4619 fprintf(f, "%s", CS se);
4627 /*************************************************
4628 * Print error for an address *
4629 *************************************************/
4631 /* This function is called to print the error information out of an address for
4632 a bounce or a warning message. It tries to format the message reasonably by
4633 introducing newlines. All lines are indented by 4; the initial printing
4634 position must be set before calling.
4636 This function used always to print the error. Nowadays we want to restrict it
4637 to cases such as LMTP/SMTP errors from a remote host, and errors from :fail:
4638 and filter "fail". We no longer pass other information willy-nilly in bounce
4639 and warning messages. Text in user_message is always output; text in message
4640 only if the af_pass_message flag is set.
4644 f the FILE to print on
4651 print_address_error(address_item *addr, FILE *f, uschar *t)
4653 int count = Ustrlen(t);
4654 uschar *s = testflag(addr, af_pass_message)? addr->message : NULL;
4658 if (addr->user_message != NULL) s = addr->user_message; else return;
4661 fprintf(f, "\n %s", t);
4665 if (*s == '\\' && s[1] == 'n')
4675 if (*s++ == ':' && isspace(*s) && count > 45)
4677 fprintf(f, "\n "); /* sic (because space follows) */
4689 /*************************************************
4690 * Check list of addresses for duplication *
4691 *************************************************/
4693 /* This function was introduced when the test for duplicate addresses that are
4694 not pipes, files, or autoreplies was moved from the middle of routing to when
4695 routing was complete. That was to fix obscure cases when the routing history
4696 affects the subsequent routing of identical addresses. This function is called
4697 after routing, to check that the final routed addresses are not duplicates.
4699 If we detect a duplicate, we remember what it is a duplicate of. Note that
4700 pipe, file, and autoreply de-duplication is handled during routing, so we must
4701 leave such "addresses" alone here, as otherwise they will incorrectly be
4704 Argument: address of list anchor
4709 do_duplicate_check(address_item **anchor)
4712 while ((addr = *anchor) != NULL)
4715 if (testflag(addr, af_pfr))
4717 anchor = &(addr->next);
4719 else if ((tnode = tree_search(tree_duplicates, addr->unique)) != NULL)
4721 DEBUG(D_deliver|D_route)
4722 debug_printf("%s is a duplicate address: discarded\n", addr->unique);
4723 *anchor = addr->next;
4724 addr->dupof = tnode->data.ptr;
4725 addr->next = addr_duplicate;
4726 addr_duplicate = addr;
4730 tree_add_duplicate(addr->unique, addr);
4731 anchor = &(addr->next);
4739 /*************************************************
4740 * Deliver one message *
4741 *************************************************/
4743 /* This is the function which is called when a message is to be delivered. It
4744 is passed the id of the message. It is possible that the message no longer
4745 exists, if some other process has delivered it, and it is also possible that
4746 the message is being worked on by another process, in which case the data file
4749 If no delivery is attempted for any of the above reasons, the function returns
4750 DELIVER_NOT_ATTEMPTED.
4752 If the give_up flag is set true, do not attempt any deliveries, but instead
4753 fail all outstanding addresses and return the message to the sender (or
4756 A delivery operation has a process all to itself; we never deliver more than
4757 one message in the same process. Therefore we needn't worry too much about
4761 id the id of the message to be delivered
4762 forced TRUE if delivery was forced by an administrator; this overrides
4763 retry delays and causes a delivery to be tried regardless
4764 give_up TRUE if an administrator has requested that delivery attempts
4767 Returns: When the global variable mua_wrapper is FALSE:
4768 DELIVER_ATTEMPTED_NORMAL if a delivery attempt was made
4769 DELIVER_NOT_ATTEMPTED otherwise (see comment above)
4770 When the global variable mua_wrapper is TRUE:
4771 DELIVER_MUA_SUCCEEDED if delivery succeeded
4772 DELIVER_MUA_FAILED if delivery failed
4773 DELIVER_NOT_ATTEMPTED if not attempted (should not occur)
4777 deliver_message(uschar *id, BOOL forced, BOOL give_up)
4780 int final_yield = DELIVER_ATTEMPTED_NORMAL;
4781 time_t now = time(NULL);
4782 address_item *addr_last = NULL;
4783 uschar *filter_message = NULL;
4785 int process_recipients = RECIP_ACCEPT;
4788 extern int acl_where;
4790 uschar *info = (queue_run_pid == (pid_t)0)?
4791 string_sprintf("delivering %s", id) :
4792 string_sprintf("delivering %s (queue run pid %d)", id, queue_run_pid);
4794 /* If the D_process_info bit is on, set_process_info() will output debugging
4795 information. If not, we want to show this initial information if D_deliver or
4796 D_queue_run is set or in verbose mode. */
4798 set_process_info("%s", info);
4800 if ((debug_selector & D_process_info) == 0 &&
4801 (debug_selector & (D_deliver|D_queue_run|D_v)) != 0)
4802 debug_printf("%s\n", info);
4804 /* Ensure that we catch any subprocesses that are created. Although Exim
4805 sets SIG_DFL as its initial default, some routes through the code end up
4806 here with it set to SIG_IGN - cases where a non-synchronous delivery process
4807 has been forked, but no re-exec has been done. We use sigaction rather than
4808 plain signal() on those OS where SA_NOCLDWAIT exists, because we want to be
4809 sure it is turned off. (There was a problem on AIX with this.) */
4813 struct sigaction act;
4814 act.sa_handler = SIG_DFL;
4815 sigemptyset(&(act.sa_mask));
4817 sigaction(SIGCHLD, &act, NULL);
4820 signal(SIGCHLD, SIG_DFL);
4823 /* Make the forcing flag available for routers and transports, set up the
4824 global message id field, and initialize the count for returned files and the
4825 message size. This use of strcpy() is OK because the length id is checked when
4826 it is obtained from a command line (the -M or -q options), and otherwise it is
4827 known to be a valid message id. */
4829 Ustrcpy(message_id, id);
4830 deliver_force = forced;
4834 /* Initialize some flags */
4836 update_spool = FALSE;
4837 remove_journal = TRUE;
4839 /* Set a known context for any ACLs we call via expansions */
4840 acl_where = ACL_WHERE_DELIVERY;
4842 /* Reset the random number generator, so that if several delivery processes are
4843 started from a queue runner that has already used random numbers (for sorting),
4844 they don't all get the same sequence. */
4848 /* Open and lock the message's data file. Exim locks on this one because the
4849 header file may get replaced as it is re-written during the delivery process.
4850 Any failures cause messages to be written to the log, except for missing files
4851 while queue running - another process probably completed delivery. As part of
4852 opening the data file, message_subdir gets set. */
4854 if (!spool_open_datafile(id))
4855 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
4857 /* The value of message_size at this point has been set to the data length,
4858 plus one for the blank line that notionally precedes the data. */
4860 /* Now read the contents of the header file, which will set up the headers in
4861 store, and also the list of recipients and the tree of non-recipients and
4862 assorted flags. It updates message_size. If there is a reading or format error,
4863 give up; if the message has been around for sufficiently long, remove it. */
4865 sprintf(CS spoolname, "%s-H", id);
4866 if ((rc = spool_read_header(spoolname, TRUE, TRUE)) != spool_read_OK)
4868 if (errno == ERRNO_SPOOLFORMAT)
4870 struct stat statbuf;
4871 sprintf(CS big_buffer, "%s/input/%s/%s", spool_directory, message_subdir,
4873 if (Ustat(big_buffer, &statbuf) == 0)
4874 log_write(0, LOG_MAIN, "Format error in spool file %s: "
4875 "size=" OFF_T_FMT, spoolname, statbuf.st_size);
4876 else log_write(0, LOG_MAIN, "Format error in spool file %s", spoolname);
4879 log_write(0, LOG_MAIN, "Error reading spool file %s: %s", spoolname,
4882 /* If we managed to read the envelope data, received_time contains the
4883 time the message was received. Otherwise, we can calculate it from the
4886 if (rc != spool_read_hdrerror)
4889 for (i = 0; i < 6; i++)
4890 received_time = received_time * BASE_62 + tab62[id[i] - '0'];
4893 /* If we've had this malformed message too long, sling it. */
4895 if (now - received_time > keep_malformed)
4897 sprintf(CS spoolname, "%s/msglog/%s/%s", spool_directory, message_subdir, id);
4899 sprintf(CS spoolname, "%s/input/%s/%s-D", spool_directory, message_subdir, id);
4901 sprintf(CS spoolname, "%s/input/%s/%s-H", spool_directory, message_subdir, id);
4903 sprintf(CS spoolname, "%s/input/%s/%s-J", spool_directory, message_subdir, id);
4905 log_write(0, LOG_MAIN, "Message removed because older than %s",
4906 readconf_printtime(keep_malformed));
4909 (void)close(deliver_datafile);
4910 deliver_datafile = -1;
4911 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
4914 /* The spool header file has been read. Look to see if there is an existing
4915 journal file for this message. If there is, it means that a previous delivery
4916 attempt crashed (program or host) before it could update the spool header file.
4917 Read the list of delivered addresses from the journal and add them to the
4918 nonrecipients tree. Then update the spool file. We can leave the journal in
4919 existence, as it will get further successful deliveries added to it in this
4920 run, and it will be deleted if this function gets to its end successfully.
4921 Otherwise it might be needed again. */
4923 sprintf(CS spoolname, "%s/input/%s/%s-J", spool_directory, message_subdir, id);
4924 jread = Ufopen(spoolname, "rb");
4927 while (Ufgets(big_buffer, big_buffer_size, jread) != NULL)
4929 int n = Ustrlen(big_buffer);
4930 big_buffer[n-1] = 0;
4931 tree_add_nonrecipient(big_buffer);
4932 DEBUG(D_deliver) debug_printf("Previously delivered address %s taken from "
4933 "journal file\n", big_buffer);
4935 (void)fclose(jread);
4936 /* Panic-dies on error */
4937 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
4939 else if (errno != ENOENT)
4941 log_write(0, LOG_MAIN|LOG_PANIC, "attempt to open journal for reading gave: "
4942 "%s", strerror(errno));
4943 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
4946 /* A null recipients list indicates some kind of disaster. */
4948 if (recipients_list == NULL)
4950 (void)close(deliver_datafile);
4951 deliver_datafile = -1;
4952 log_write(0, LOG_MAIN, "Spool error: no recipients for %s", spoolname);
4953 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
4957 /* Handle a message that is frozen. There are a number of different things that
4958 can happen, but in the default situation, unless forced, no delivery is
4963 #ifdef SUPPORT_MOVE_FROZEN_MESSAGES
4964 /* Moving to another directory removes the message from Exim's view. Other
4965 tools must be used to deal with it. Logging of this action happens in
4966 spool_move_message() and its subfunctions. */
4968 if (move_frozen_messages &&
4969 spool_move_message(id, message_subdir, US"", US"F"))
4970 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
4973 /* For all frozen messages (bounces or not), timeout_frozen_after sets the
4974 maximum time to keep messages that are frozen. Thaw if we reach it, with a
4975 flag causing all recipients to be failed. The time is the age of the
4976 message, not the time since freezing. */
4978 if (timeout_frozen_after > 0 && message_age >= timeout_frozen_after)
4980 log_write(0, LOG_MAIN, "cancelled by timeout_frozen_after");
4981 process_recipients = RECIP_FAIL_TIMEOUT;
4984 /* For bounce messages (and others with no sender), thaw if the error message
4985 ignore timer is exceeded. The message will be discarded if this delivery
4988 else if (sender_address[0] == 0 && message_age >= ignore_bounce_errors_after)
4990 log_write(0, LOG_MAIN, "Unfrozen by errmsg timer");
4993 /* If this is a bounce message, or there's no auto thaw, or we haven't
4994 reached the auto thaw time yet, and this delivery is not forced by an admin
4995 user, do not attempt delivery of this message. Note that forced is set for
4996 continuing messages down the same channel, in order to skip load checking and
4997 ignore hold domains, but we don't want unfreezing in that case. */
5001 if ((sender_address[0] == 0 ||
5003 now <= deliver_frozen_at + auto_thaw
5006 (!forced || !deliver_force_thaw || !admin_user ||
5007 continue_hostname != NULL
5010 (void)close(deliver_datafile);
5011 deliver_datafile = -1;
5012 log_write(L_skip_delivery, LOG_MAIN, "Message is frozen");
5013 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5016 /* If delivery was forced (by an admin user), assume a manual thaw.
5017 Otherwise it's an auto thaw. */
5021 deliver_manual_thaw = TRUE;
5022 log_write(0, LOG_MAIN, "Unfrozen by forced delivery");
5024 else log_write(0, LOG_MAIN, "Unfrozen by auto-thaw");
5027 /* We get here if any of the rules for unfreezing have triggered. */
5029 deliver_freeze = FALSE;
5030 update_spool = TRUE;
5034 /* Open the message log file if we are using them. This records details of
5035 deliveries, deferments, and failures for the benefit of the mail administrator.
5036 The log is not used by exim itself to track the progress of a message; that is
5037 done by rewriting the header spool file. */
5044 sprintf(CS spoolname, "%s/msglog/%s/%s", spool_directory, message_subdir, id);
5045 fd = open_msglog_file(spoolname, SPOOL_MODE, &error);
5049 log_write(0, LOG_MAIN|LOG_PANIC, "Couldn't %s message log %s: %s", error,
5050 spoolname, strerror(errno));
5051 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5054 /* Make a C stream out of it. */
5056 message_log = fdopen(fd, "a");
5057 if (message_log == NULL)
5059 log_write(0, LOG_MAIN|LOG_PANIC, "Couldn't fdopen message log %s: %s",
5060 spoolname, strerror(errno));
5061 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5066 /* If asked to give up on a message, log who did it, and set the action for all
5071 struct passwd *pw = getpwuid(real_uid);
5072 log_write(0, LOG_MAIN, "cancelled by %s", (pw != NULL)?
5073 US pw->pw_name : string_sprintf("uid %ld", (long int)real_uid));
5074 process_recipients = RECIP_FAIL;
5077 /* Otherwise, if there are too many Received: headers, fail all recipients. */
5079 else if (received_count > received_headers_max)
5080 process_recipients = RECIP_FAIL_LOOP;
5082 /* Otherwise, if a system-wide, address-independent message filter is
5083 specified, run it now, except in the case when we are failing all recipients as
5084 a result of timeout_frozen_after. If the system filter yields "delivered", then
5085 ignore the true recipients of the message. Failure of the filter file is
5086 logged, and the delivery attempt fails. */
5088 else if (system_filter != NULL && process_recipients != RECIP_FAIL_TIMEOUT)
5093 redirect_block redirect;
5095 if (system_filter_uid_set)
5097 ugid.uid = system_filter_uid;
5098 ugid.gid = system_filter_gid;
5099 ugid.uid_set = ugid.gid_set = TRUE;
5103 ugid.uid_set = ugid.gid_set = FALSE;
5106 return_path = sender_address;
5107 enable_dollar_recipients = TRUE; /* Permit $recipients in system filter */
5108 system_filtering = TRUE;
5110 /* Any error in the filter file causes a delivery to be abandoned. */
5112 redirect.string = system_filter;
5113 redirect.isfile = TRUE;
5114 redirect.check_owner = redirect.check_group = FALSE;
5115 redirect.owners = NULL;
5116 redirect.owngroups = NULL;
5118 redirect.modemask = 0;
5120 DEBUG(D_deliver|D_filter) debug_printf("running system filter\n");
5123 &redirect, /* Where the data is */
5124 RDO_DEFER | /* Turn on all the enabling options */
5125 RDO_FAIL | /* Leave off all the disabling options */
5130 NULL, /* No :include: restriction (not used in filter) */
5131 NULL, /* No sieve vacation directory (not sieve!) */
5132 NULL, /* No sieve enotify mailto owner (not sieve!) */
5133 NULL, /* No sieve user address (not sieve!) */
5134 NULL, /* No sieve subaddress (not sieve!) */
5135 &ugid, /* uid/gid data */
5136 &addr_new, /* Where to hang generated addresses */
5137 &filter_message, /* Where to put error message */
5138 NULL, /* Don't skip syntax errors */
5139 &filtertype, /* Will always be set to FILTER_EXIM for this call */
5140 US"system filter"); /* For error messages */
5142 DEBUG(D_deliver|D_filter) debug_printf("system filter returned %d\n", rc);
5144 if (rc == FF_ERROR || rc == FF_NONEXIST)
5146 (void)close(deliver_datafile);
5147 deliver_datafile = -1;
5148 log_write(0, LOG_MAIN|LOG_PANIC, "Error in system filter: %s",
5149 string_printing(filter_message));
5150 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5153 /* Reset things. If the filter message is an empty string, which can happen
5154 for a filter "fail" or "freeze" command with no text, reset it to NULL. */
5156 system_filtering = FALSE;
5157 enable_dollar_recipients = FALSE;
5158 if (filter_message != NULL && filter_message[0] == 0) filter_message = NULL;
5160 /* Save the values of the system filter variables so that user filters
5163 memcpy(filter_sn, filter_n, sizeof(filter_sn));
5165 /* The filter can request that delivery of the original addresses be
5170 process_recipients = RECIP_DEFER;
5171 deliver_msglog("Delivery deferred by system filter\n");
5172 log_write(0, LOG_MAIN, "Delivery deferred by system filter");
5175 /* The filter can request that a message be frozen, but this does not
5176 take place if the message has been manually thawed. In that case, we must
5177 unset "delivered", which is forced by the "freeze" command to make -bF
5180 else if (rc == FF_FREEZE && !deliver_manual_thaw)
5182 deliver_freeze = TRUE;
5183 deliver_frozen_at = time(NULL);
5184 process_recipients = RECIP_DEFER;
5185 frozen_info = string_sprintf(" by the system filter%s%s",
5186 (filter_message == NULL)? US"" : US": ",
5187 (filter_message == NULL)? US"" : filter_message);
5190 /* The filter can request that a message be failed. The error message may be
5191 quite long - it is sent back to the sender in the bounce - but we don't want
5192 to fill up the log with repetitions of it. If it starts with << then the text
5193 between << and >> is written to the log, with the rest left for the bounce
5196 else if (rc == FF_FAIL)
5198 uschar *colon = US"";
5199 uschar *logmsg = US"";
5202 process_recipients = RECIP_FAIL_FILTER;
5204 if (filter_message != NULL)
5208 if (filter_message[0] == '<' && filter_message[1] == '<' &&
5209 (logend = Ustrstr(filter_message, ">>")) != NULL)
5211 logmsg = filter_message + 2;
5212 loglen = logend - logmsg;
5213 filter_message = logend + 2;
5214 if (filter_message[0] == 0) filter_message = NULL;
5218 logmsg = filter_message;
5219 loglen = Ustrlen(filter_message);
5223 log_write(0, LOG_MAIN, "cancelled by system filter%s%.*s", colon, loglen,
5227 /* Delivery can be restricted only to those recipients (if any) that the
5228 filter specified. */
5230 else if (rc == FF_DELIVERED)
5232 process_recipients = RECIP_IGNORE;
5233 if (addr_new == NULL)
5234 log_write(0, LOG_MAIN, "=> discarded (system filter)");
5236 log_write(0, LOG_MAIN, "original recipients ignored (system filter)");
5239 /* If any new addresses were created by the filter, fake up a "parent"
5240 for them. This is necessary for pipes, etc., which are expected to have
5241 parents, and it also gives some sensible logging for others. Allow
5242 pipes, files, and autoreplies, and run them as the filter uid if set,
5243 otherwise as the current uid. */
5245 if (addr_new != NULL)
5247 int uid = (system_filter_uid_set)? system_filter_uid : geteuid();
5248 int gid = (system_filter_gid_set)? system_filter_gid : getegid();
5250 /* The text "system-filter" is tested in transport_set_up_command() and in
5251 set_up_shell_command() in the pipe transport, to enable them to permit
5252 $recipients, so don't change it here without also changing it there. */
5254 address_item *p = addr_new;
5255 address_item *parent = deliver_make_addr(US"system-filter", FALSE);
5257 parent->domain = string_copylc(qualify_domain_recipient);
5258 parent->local_part = US"system-filter";
5260 /* As part of this loop, we arrange for addr_last to end up pointing
5261 at the final address. This is used if we go on to add addresses for the
5262 original recipients. */
5266 if (parent->child_count == SHRT_MAX)
5267 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "system filter generated more "
5268 "than %d delivery addresses", SHRT_MAX);
5269 parent->child_count++;
5272 if (testflag(p, af_pfr))
5278 setflag(p, af_uid_set |
5284 /* Find the name of the system filter's appropriate pfr transport */
5286 if (p->address[0] == '|')
5289 tpname = system_filter_pipe_transport;
5290 address_pipe = p->address;
5292 else if (p->address[0] == '>')
5295 tpname = system_filter_reply_transport;
5299 if (p->address[Ustrlen(p->address)-1] == '/')
5301 type = US"directory";
5302 tpname = system_filter_directory_transport;
5307 tpname = system_filter_file_transport;
5309 address_file = p->address;
5312 /* Now find the actual transport, first expanding the name. We have
5313 set address_file or address_pipe above. */
5317 uschar *tmp = expand_string(tpname);
5318 address_file = address_pipe = NULL;
5320 p->message = string_sprintf("failed to expand \"%s\" as a "
5321 "system filter transport name", tpname);
5326 p->message = string_sprintf("system_filter_%s_transport is unset",
5332 transport_instance *tp;
5333 for (tp = transports; tp != NULL; tp = tp->next)
5335 if (Ustrcmp(tp->name, tpname) == 0)
5342 p->message = string_sprintf("failed to find \"%s\" transport "
5343 "for system filter delivery", tpname);
5346 /* If we couldn't set up a transport, defer the delivery, putting the
5347 error on the panic log as well as the main log. */
5349 if (p->transport == NULL)
5351 address_item *badp = p;
5353 if (addr_last == NULL) addr_new = p; else addr_last->next = p;
5354 badp->local_part = badp->address; /* Needed for log line */
5355 post_process_one(badp, DEFER, LOG_MAIN|LOG_PANIC, DTYPE_ROUTER, 0);
5358 } /* End of pfr handling */
5360 /* Either a non-pfr delivery, or we found a transport */
5362 DEBUG(D_deliver|D_filter)
5363 debug_printf("system filter added %s\n", p->address);
5367 } /* Loop through all addr_new addresses */
5372 /* Scan the recipients list, and for every one that is not in the non-
5373 recipients tree, add an addr item to the chain of new addresses. If the pno
5374 value is non-negative, we must set the onetime parent from it. This which
5375 points to the relevant entry in the recipients list.
5377 This processing can be altered by the setting of the process_recipients
5378 variable, which is changed if recipients are to be ignored, failed, or
5379 deferred. This can happen as a result of system filter activity, or if the -Mg
5380 option is used to fail all of them.
5382 Duplicate addresses are handled later by a different tree structure; we can't
5383 just extend the non-recipients tree, because that will be re-written to the
5384 spool if the message is deferred, and in any case there are casing
5385 complications for local addresses. */
5387 if (process_recipients != RECIP_IGNORE)
5389 for (i = 0; i < recipients_count; i++)
5391 if (tree_search(tree_nonrecipients, recipients_list[i].address) == NULL)
5393 recipient_item *r = recipients_list + i;
5394 address_item *new = deliver_make_addr(r->address, FALSE);
5395 new->p.errors_address = r->errors_to;
5398 new->onetime_parent = recipients_list[r->pno].address;
5400 #ifdef EXPERIMENTAL_DSN
5401 /* If DSN support is enabled, set the dsn flags and the original receipt
5402 to be passed on to other DSN enabled MTAs */
5403 new->dsn_flags = r->dsn_flags & rf_dsnflags;
5404 new->dsn_orcpt = r->orcpt;
5405 DEBUG(D_deliver) debug_printf("DSN: set orcpt: %s flags: %d\n", new->dsn_orcpt, new->dsn_flags);
5408 switch (process_recipients)
5410 /* RECIP_DEFER is set when a system filter freezes a message. */
5413 new->next = addr_defer;
5418 /* RECIP_FAIL_FILTER is set when a system filter has obeyed a "fail"
5421 case RECIP_FAIL_FILTER:
5423 (filter_message == NULL)? US"delivery cancelled" : filter_message;
5424 setflag(new, af_pass_message);
5425 goto RECIP_QUEUE_FAILED; /* below */
5428 /* RECIP_FAIL_TIMEOUT is set when a message is frozen, but is older
5429 than the value in timeout_frozen_after. Treat non-bounce messages
5430 similarly to -Mg; for bounce messages we just want to discard, so
5431 don't put the address on the failed list. The timeout has already
5434 case RECIP_FAIL_TIMEOUT:
5435 new->message = US"delivery cancelled; message timed out";
5436 goto RECIP_QUEUE_FAILED; /* below */
5439 /* RECIP_FAIL is set when -Mg has been used. */
5442 new->message = US"delivery cancelled by administrator";
5445 /* Common code for the failure cases above. If this is not a bounce
5446 message, put the address on the failed list so that it is used to
5447 create a bounce. Otherwise do nothing - this just discards the address.
5448 The incident has already been logged. */
5451 if (sender_address[0] != 0)
5453 new->next = addr_failed;
5459 /* RECIP_FAIL_LOOP is set when there are too many Received: headers
5460 in the message. Process each address as a routing failure; if this
5461 is a bounce message, it will get frozen. */
5463 case RECIP_FAIL_LOOP:
5464 new->message = US"Too many \"Received\" headers - suspected mail loop";
5465 post_process_one(new, FAIL, LOG_MAIN, DTYPE_ROUTER, 0);
5469 /* Value should be RECIP_ACCEPT; take this as the safe default. */
5472 if (addr_new == NULL) addr_new = new; else addr_last->next = new;
5482 address_item *p = addr_new;
5483 debug_printf("Delivery address list:\n");
5486 debug_printf(" %s %s\n", p->address, (p->onetime_parent == NULL)? US"" :
5492 /* Set up the buffers used for copying over the file when delivering. */
5494 deliver_in_buffer = store_malloc(DELIVER_IN_BUFFER_SIZE);
5495 deliver_out_buffer = store_malloc(DELIVER_OUT_BUFFER_SIZE);
5499 /* Until there are no more new addresses, handle each one as follows:
5501 . If this is a generated address (indicated by the presence of a parent
5502 pointer) then check to see whether it is a pipe, file, or autoreply, and
5503 if so, handle it directly here. The router that produced the address will
5504 have set the allow flags into the address, and also set the uid/gid required.
5505 Having the routers generate new addresses and then checking them here at
5506 the outer level is tidier than making each router do the checking, and
5507 means that routers don't need access to the failed address queue.
5509 . Break up the address into local part and domain, and make lowercased
5510 versions of these strings. We also make unquoted versions of the local part.
5512 . Handle the percent hack for those domains for which it is valid.
5514 . For child addresses, determine if any of the parents have the same address.
5515 If so, generate a different string for previous delivery checking. Without
5516 this code, if the address spqr generates spqr via a forward or alias file,
5517 delivery of the generated spqr stops further attempts at the top level spqr,
5518 which is not what is wanted - it may have generated other addresses.
5520 . Check on the retry database to see if routing was previously deferred, but
5521 only if in a queue run. Addresses that are to be routed are put on the
5522 addr_route chain. Addresses that are to be deferred are put on the
5523 addr_defer chain. We do all the checking first, so as not to keep the
5524 retry database open any longer than necessary.
5526 . Now we run the addresses through the routers. A router may put the address
5527 on either the addr_local or the addr_remote chain for local or remote
5528 delivery, respectively, or put it on the addr_failed chain if it is
5529 undeliveable, or it may generate child addresses and put them on the
5530 addr_new chain, or it may defer an address. All the chain anchors are
5531 passed as arguments so that the routers can be called for verification
5534 . If new addresses have been generated by the routers, da capo.
5537 header_rewritten = FALSE; /* No headers rewritten yet */
5538 while (addr_new != NULL) /* Loop until all addresses dealt with */
5540 address_item *addr, *parent;
5541 dbm_file = dbfn_open(US"retry", O_RDONLY, &dbblock, FALSE);
5543 /* Failure to open the retry database is treated the same as if it does
5544 not exist. In both cases, dbm_file is NULL. */
5546 if (dbm_file == NULL)
5548 DEBUG(D_deliver|D_retry|D_route|D_hints_lookup)
5549 debug_printf("no retry data available\n");
5552 /* Scan the current batch of new addresses, to handle pipes, files and
5553 autoreplies, and determine which others are ready for routing. */
5555 while (addr_new != NULL)
5560 dbdata_retry *domain_retry_record;
5561 dbdata_retry *address_retry_record;
5564 addr_new = addr->next;
5566 DEBUG(D_deliver|D_retry|D_route)
5568 debug_printf(">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>\n");
5569 debug_printf("Considering: %s\n", addr->address);
5572 /* Handle generated address that is a pipe or a file or an autoreply. */
5574 if (testflag(addr, af_pfr))
5576 /* If an autoreply in a filter could not generate a syntactically valid
5577 address, give up forthwith. Set af_ignore_error so that we don't try to
5578 generate a bounce. */
5580 if (testflag(addr, af_bad_reply))
5582 addr->basic_errno = ERRNO_BADADDRESS2;
5583 addr->local_part = addr->address;
5585 US"filter autoreply generated syntactically invalid recipient";
5586 setflag(addr, af_ignore_error);
5587 (void)post_process_one(addr, FAIL, LOG_MAIN, DTYPE_ROUTER, 0);
5588 continue; /* with the next new address */
5591 /* If two different users specify delivery to the same pipe or file or
5592 autoreply, there should be two different deliveries, so build a unique
5593 string that incorporates the original address, and use this for
5594 duplicate testing and recording delivery, and also for retrying. */
5597 string_sprintf("%s:%s", addr->address, addr->parent->unique +
5598 (testflag(addr->parent, af_homonym)? 3:0));
5600 addr->address_retry_key = addr->domain_retry_key =
5601 string_sprintf("T:%s", addr->unique);
5603 /* If a filter file specifies two deliveries to the same pipe or file,
5604 we want to de-duplicate, but this is probably not wanted for two mail
5605 commands to the same address, where probably both should be delivered.
5606 So, we have to invent a different unique string in that case. Just
5607 keep piling '>' characters on the front. */
5609 if (addr->address[0] == '>')
5611 while (tree_search(tree_duplicates, addr->unique) != NULL)
5612 addr->unique = string_sprintf(">%s", addr->unique);
5615 else if ((tnode = tree_search(tree_duplicates, addr->unique)) != NULL)
5617 DEBUG(D_deliver|D_route)
5618 debug_printf("%s is a duplicate address: discarded\n", addr->address);
5619 addr->dupof = tnode->data.ptr;
5620 addr->next = addr_duplicate;
5621 addr_duplicate = addr;
5625 DEBUG(D_deliver|D_route) debug_printf("unique = %s\n", addr->unique);
5627 /* Check for previous delivery */
5629 if (tree_search(tree_nonrecipients, addr->unique) != NULL)
5631 DEBUG(D_deliver|D_route)
5632 debug_printf("%s was previously delivered: discarded\n", addr->address);
5633 child_done(addr, tod_stamp(tod_log));
5637 /* Save for checking future duplicates */
5639 tree_add_duplicate(addr->unique, addr);
5641 /* Set local part and domain */
5643 addr->local_part = addr->address;
5644 addr->domain = addr->parent->domain;
5646 /* Ensure that the delivery is permitted. */
5648 if (testflag(addr, af_file))
5650 if (!testflag(addr, af_allow_file))
5652 addr->basic_errno = ERRNO_FORBIDFILE;
5653 addr->message = US"delivery to file forbidden";
5654 (void)post_process_one(addr, FAIL, LOG_MAIN, DTYPE_ROUTER, 0);
5655 continue; /* with the next new address */
5658 else if (addr->address[0] == '|')
5660 if (!testflag(addr, af_allow_pipe))
5662 addr->basic_errno = ERRNO_FORBIDPIPE;
5663 addr->message = US"delivery to pipe forbidden";
5664 (void)post_process_one(addr, FAIL, LOG_MAIN, DTYPE_ROUTER, 0);
5665 continue; /* with the next new address */
5668 else if (!testflag(addr, af_allow_reply))
5670 addr->basic_errno = ERRNO_FORBIDREPLY;
5671 addr->message = US"autoreply forbidden";
5672 (void)post_process_one(addr, FAIL, LOG_MAIN, DTYPE_ROUTER, 0);
5673 continue; /* with the next new address */
5676 /* If the errno field is already set to BADTRANSPORT, it indicates
5677 failure to expand a transport string, or find the associated transport,
5678 or an unset transport when one is required. Leave this test till now so
5679 that the forbid errors are given in preference. */
5681 if (addr->basic_errno == ERRNO_BADTRANSPORT)
5683 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_ROUTER, 0);
5687 /* Treat /dev/null as a special case and abandon the delivery. This
5688 avoids having to specify a uid on the transport just for this case.
5689 Arrange for the transport name to be logged as "**bypassed**". */
5691 if (Ustrcmp(addr->address, "/dev/null") == 0)
5693 uschar *save = addr->transport->name;
5694 addr->transport->name = US"**bypassed**";
5695 (void)post_process_one(addr, OK, LOG_MAIN, DTYPE_TRANSPORT, '=');
5696 addr->transport->name = save;
5697 continue; /* with the next new address */
5700 /* Pipe, file, or autoreply delivery is to go ahead as a normal local
5703 DEBUG(D_deliver|D_route)
5704 debug_printf("queued for %s transport\n", addr->transport->name);
5705 addr->next = addr_local;
5707 continue; /* with the next new address */
5710 /* Handle normal addresses. First, split up into local part and domain,
5711 handling the %-hack if necessary. There is the possibility of a defer from
5712 a lookup in percent_hack_domains. */
5714 if ((rc = deliver_split_address(addr)) == DEFER)
5716 addr->message = US"cannot check percent_hack_domains";
5717 addr->basic_errno = ERRNO_LISTDEFER;
5718 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_NONE, 0);
5722 /* Check to see if the domain is held. If so, proceed only if the
5723 delivery was forced by hand. */
5725 deliver_domain = addr->domain; /* set $domain */
5726 if (!forced && hold_domains != NULL &&
5727 (rc = match_isinlist(addr->domain, &hold_domains, 0,
5728 &domainlist_anchor, addr->domain_cache, MCL_DOMAIN, TRUE,
5733 addr->message = US"hold_domains lookup deferred";
5734 addr->basic_errno = ERRNO_LISTDEFER;
5738 addr->message = US"domain is held";
5739 addr->basic_errno = ERRNO_HELD;
5741 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_NONE, 0);
5745 /* Now we can check for duplicates and previously delivered addresses. In
5746 order to do this, we have to generate a "unique" value for each address,
5747 because there may be identical actual addresses in a line of descendents.
5748 The "unique" field is initialized to the same value as the "address" field,
5749 but gets changed here to cope with identically-named descendents. */
5751 for (parent = addr->parent; parent != NULL; parent = parent->parent)
5752 if (strcmpic(addr->address, parent->address) == 0) break;
5754 /* If there's an ancestor with the same name, set the homonym flag. This
5755 influences how deliveries are recorded. Then add a prefix on the front of
5756 the unique address. We use \n\ where n starts at 0 and increases each time.
5757 It is unlikely to pass 9, but if it does, it may look odd but will still
5758 work. This means that siblings or cousins with the same names are treated
5759 as duplicates, which is what we want. */
5763 setflag(addr, af_homonym);
5764 if (parent->unique[0] != '\\')
5765 addr->unique = string_sprintf("\\0\\%s", addr->address);
5767 addr->unique = string_sprintf("\\%c\\%s", parent->unique[1] + 1,
5771 /* Ensure that the domain in the unique field is lower cased, because
5772 domains are always handled caselessly. */
5774 p = Ustrrchr(addr->unique, '@');
5775 while (*p != 0) { *p = tolower(*p); p++; }
5777 DEBUG(D_deliver|D_route) debug_printf("unique = %s\n", addr->unique);
5779 if (tree_search(tree_nonrecipients, addr->unique) != NULL)
5781 DEBUG(D_deliver|D_route)
5782 debug_printf("%s was previously delivered: discarded\n", addr->unique);
5783 child_done(addr, tod_stamp(tod_log));
5787 /* Get the routing retry status, saving the two retry keys (with and
5788 without the local part) for subsequent use. If there is no retry record for
5789 the standard address routing retry key, we look for the same key with the
5790 sender attached, because this form is used by the smtp transport after a
5791 4xx response to RCPT when address_retry_include_sender is true. */
5793 addr->domain_retry_key = string_sprintf("R:%s", addr->domain);
5794 addr->address_retry_key = string_sprintf("R:%s@%s", addr->local_part,
5797 if (dbm_file == NULL)
5798 domain_retry_record = address_retry_record = NULL;
5801 domain_retry_record = dbfn_read(dbm_file, addr->domain_retry_key);
5802 if (domain_retry_record != NULL &&
5803 now - domain_retry_record->time_stamp > retry_data_expire)
5804 domain_retry_record = NULL; /* Ignore if too old */
5806 address_retry_record = dbfn_read(dbm_file, addr->address_retry_key);
5807 if (address_retry_record != NULL &&
5808 now - address_retry_record->time_stamp > retry_data_expire)
5809 address_retry_record = NULL; /* Ignore if too old */
5811 if (address_retry_record == NULL)
5813 uschar *altkey = string_sprintf("%s:<%s>", addr->address_retry_key,
5815 address_retry_record = dbfn_read(dbm_file, altkey);
5816 if (address_retry_record != NULL &&
5817 now - address_retry_record->time_stamp > retry_data_expire)
5818 address_retry_record = NULL; /* Ignore if too old */
5822 DEBUG(D_deliver|D_retry)
5824 if (domain_retry_record == NULL)
5825 debug_printf("no domain retry record\n");
5826 if (address_retry_record == NULL)
5827 debug_printf("no address retry record\n");
5830 /* If we are sending a message down an existing SMTP connection, we must
5831 assume that the message which created the connection managed to route
5832 an address to that connection. We do not want to run the risk of taking
5833 a long time over routing here, because if we do, the server at the other
5834 end of the connection may time it out. This is especially true for messages
5835 with lots of addresses. For this kind of delivery, queue_running is not
5836 set, so we would normally route all addresses. We take a pragmatic approach
5837 and defer routing any addresses that have any kind of domain retry record.
5838 That is, we don't even look at their retry times. It doesn't matter if this
5839 doesn't work occasionally. This is all just an optimization, after all.
5841 The reason for not doing the same for address retries is that they normally
5842 arise from 4xx responses, not DNS timeouts. */
5844 if (continue_hostname != NULL && domain_retry_record != NULL)
5846 addr->message = US"reusing SMTP connection skips previous routing defer";
5847 addr->basic_errno = ERRNO_RRETRY;
5848 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_ROUTER, 0);
5851 /* If we are in a queue run, defer routing unless there is no retry data or
5852 we've passed the next retry time, or this message is forced. In other
5853 words, ignore retry data when not in a queue run.
5855 However, if the domain retry time has expired, always allow the routing
5856 attempt. If it fails again, the address will be failed. This ensures that
5857 each address is routed at least once, even after long-term routing
5860 If there is an address retry, check that too; just wait for the next
5861 retry time. This helps with the case when the temporary error on the
5862 address was really message-specific rather than address specific, since
5863 it allows other messages through.
5865 We also wait for the next retry time if this is a message sent down an
5866 existing SMTP connection (even though that will be forced). Otherwise there
5867 will be far too many attempts for an address that gets a 4xx error. In
5868 fact, after such an error, we should not get here because, the host should
5869 not be remembered as one this message needs. However, there was a bug that
5870 used to cause this to happen, so it is best to be on the safe side.
5872 Even if we haven't reached the retry time in the hints, there is one more
5873 check to do, which is for the ultimate address timeout. We only do this
5874 check if there is an address retry record and there is not a domain retry
5875 record; this implies that previous attempts to handle the address had the
5876 retry_use_local_parts option turned on. We use this as an approximation
5877 for the destination being like a local delivery, for example delivery over
5878 LMTP to an IMAP message store. In this situation users are liable to bump
5879 into their quota and thereby have intermittently successful deliveries,
5880 which keep the retry record fresh, which can lead to us perpetually
5881 deferring messages. */
5883 else if (((queue_running && !deliver_force) || continue_hostname != NULL)
5885 ((domain_retry_record != NULL &&
5886 now < domain_retry_record->next_try &&
5887 !domain_retry_record->expired)
5889 (address_retry_record != NULL &&
5890 now < address_retry_record->next_try))
5892 (domain_retry_record != NULL ||
5893 address_retry_record == NULL ||
5894 !retry_ultimate_address_timeout(addr->address_retry_key,
5895 addr->domain, address_retry_record, now)))
5897 addr->message = US"retry time not reached";
5898 addr->basic_errno = ERRNO_RRETRY;
5899 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_ROUTER, 0);
5902 /* The domain is OK for routing. Remember if retry data exists so it
5903 can be cleaned up after a successful delivery. */
5907 if (domain_retry_record != NULL || address_retry_record != NULL)
5908 setflag(addr, af_dr_retry_exists);
5909 addr->next = addr_route;
5911 DEBUG(D_deliver|D_route)
5912 debug_printf("%s: queued for routing\n", addr->address);
5916 /* The database is closed while routing is actually happening. Requests to
5917 update it are put on a chain and all processed together at the end. */
5919 if (dbm_file != NULL) dbfn_close(dbm_file);
5921 /* If queue_domains is set, we don't even want to try routing addresses in
5922 those domains. During queue runs, queue_domains is forced to be unset.
5923 Optimize by skipping this pass through the addresses if nothing is set. */
5925 if (!deliver_force && queue_domains != NULL)
5927 address_item *okaddr = NULL;
5928 while (addr_route != NULL)
5930 address_item *addr = addr_route;
5931 addr_route = addr->next;
5933 deliver_domain = addr->domain; /* set $domain */
5934 if ((rc = match_isinlist(addr->domain, &queue_domains, 0,
5935 &domainlist_anchor, addr->domain_cache, MCL_DOMAIN, TRUE, NULL))
5940 addr->basic_errno = ERRNO_LISTDEFER;
5941 addr->message = US"queue_domains lookup deferred";
5942 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_ROUTER, 0);
5946 addr->next = okaddr;
5952 addr->basic_errno = ERRNO_QUEUE_DOMAIN;
5953 addr->message = US"domain is in queue_domains";
5954 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_ROUTER, 0);
5958 addr_route = okaddr;
5961 /* Now route those addresses that are not deferred. */
5963 while (addr_route != NULL)
5966 address_item *addr = addr_route;
5967 uschar *old_domain = addr->domain;
5968 uschar *old_unique = addr->unique;
5969 addr_route = addr->next;
5972 /* Just in case some router parameter refers to it. */
5974 return_path = (addr->p.errors_address != NULL)?
5975 addr->p.errors_address : sender_address;
5977 /* If a router defers an address, add a retry item. Whether or not to
5978 use the local part in the key is a property of the router. */
5980 if ((rc = route_address(addr, &addr_local, &addr_remote, &addr_new,
5981 &addr_succeed, v_none)) == DEFER)
5982 retry_add_item(addr, (addr->router->retry_use_local_part)?
5983 string_sprintf("R:%s@%s", addr->local_part, addr->domain) :
5984 string_sprintf("R:%s", addr->domain), 0);
5986 /* Otherwise, if there is an existing retry record in the database, add
5987 retry items to delete both forms. We must also allow for the possibility
5988 of a routing retry that includes the sender address. Since the domain might
5989 have been rewritten (expanded to fully qualified) as a result of routing,
5990 ensure that the rewritten form is also deleted. */
5992 else if (testflag(addr, af_dr_retry_exists))
5994 uschar *altkey = string_sprintf("%s:<%s>", addr->address_retry_key,
5996 retry_add_item(addr, altkey, rf_delete);
5997 retry_add_item(addr, addr->address_retry_key, rf_delete);
5998 retry_add_item(addr, addr->domain_retry_key, rf_delete);
5999 if (Ustrcmp(addr->domain, old_domain) != 0)
6000 retry_add_item(addr, string_sprintf("R:%s", old_domain), rf_delete);
6003 /* DISCARD is given for :blackhole: and "seen finish". The event has been
6004 logged, but we need to ensure the address (and maybe parents) is marked
6009 address_done(addr, tod_stamp(tod_log));
6010 continue; /* route next address */
6013 /* The address is finished with (failed or deferred). */
6017 (void)post_process_one(addr, rc, LOG_MAIN, DTYPE_ROUTER, 0);
6018 continue; /* route next address */
6021 /* The address has been routed. If the router changed the domain, it will
6022 also have changed the unique address. We have to test whether this address
6023 has already been delivered, because it's the unique address that finally
6026 if (addr->unique != old_unique &&
6027 tree_search(tree_nonrecipients, addr->unique) != 0)
6029 DEBUG(D_deliver|D_route) debug_printf("%s was previously delivered: "
6030 "discarded\n", addr->address);
6031 if (addr_remote == addr) addr_remote = addr->next;
6032 else if (addr_local == addr) addr_local = addr->next;
6035 /* If the router has same_domain_copy_routing set, we are permitted to copy
6036 the routing for any other addresses with the same domain. This is an
6037 optimisation to save repeated DNS lookups for "standard" remote domain
6038 routing. The option is settable only on routers that generate host lists.
6039 We play it very safe, and do the optimization only if the address is routed
6040 to a remote transport, there are no header changes, and the domain was not
6041 modified by the router. */
6043 if (addr_remote == addr &&
6044 addr->router->same_domain_copy_routing &&
6045 addr->p.extra_headers == NULL &&
6046 addr->p.remove_headers == NULL &&
6047 old_domain == addr->domain)
6049 address_item **chain = &addr_route;
6050 while (*chain != NULL)
6052 address_item *addr2 = *chain;
6053 if (Ustrcmp(addr2->domain, addr->domain) != 0)
6055 chain = &(addr2->next);
6059 /* Found a suitable address; take it off the routing list and add it to
6060 the remote delivery list. */
6062 *chain = addr2->next;
6063 addr2->next = addr_remote;
6064 addr_remote = addr2;
6066 /* Copy the routing data */
6068 addr2->domain = addr->domain;
6069 addr2->router = addr->router;
6070 addr2->transport = addr->transport;
6071 addr2->host_list = addr->host_list;
6072 addr2->fallback_hosts = addr->fallback_hosts;
6073 addr2->p.errors_address = addr->p.errors_address;
6074 copyflag(addr2, addr, af_hide_child | af_local_host_removed);
6076 DEBUG(D_deliver|D_route)
6078 debug_printf(">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>\n"
6080 "Routing for %s copied from %s\n",
6081 addr2->address, addr2->address, addr->address);
6085 } /* Continue with routing the next address. */
6086 } /* Loop to process any child addresses that the routers created, and
6087 any rerouted addresses that got put back on the new chain. */
6090 /* Debugging: show the results of the routing */
6092 DEBUG(D_deliver|D_retry|D_route)
6094 address_item *p = addr_local;
6095 debug_printf(">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>\n");
6096 debug_printf("After routing:\n Local deliveries:\n");
6099 debug_printf(" %s\n", p->address);
6104 debug_printf(" Remote deliveries:\n");
6107 debug_printf(" %s\n", p->address);
6112 debug_printf(" Failed addresses:\n");
6115 debug_printf(" %s\n", p->address);
6120 debug_printf(" Deferred addresses:\n");
6123 debug_printf(" %s\n", p->address);
6128 /* Free any resources that were cached during routing. */
6133 /* These two variables are set only during routing, after check_local_user.
6134 Ensure they are not set in transports. */
6136 local_user_gid = (gid_t)(-1);
6137 local_user_uid = (uid_t)(-1);
6139 /* Check for any duplicate addresses. This check is delayed until after
6140 routing, because the flexibility of the routing configuration means that
6141 identical addresses with different parentage may end up being redirected to
6142 different addresses. Checking for duplicates too early (as we previously used
6143 to) makes this kind of thing not work. */
6145 do_duplicate_check(&addr_local);
6146 do_duplicate_check(&addr_remote);
6148 /* When acting as an MUA wrapper, we proceed only if all addresses route to a
6149 remote transport. The check that they all end up in one transaction happens in
6150 the do_remote_deliveries() function. */
6152 if (mua_wrapper && (addr_local != NULL || addr_failed != NULL ||
6153 addr_defer != NULL))
6156 uschar *which, *colon, *msg;
6158 if (addr_local != NULL)
6163 else if (addr_defer != NULL)
6166 which = US"deferred";
6174 while (addr->parent != NULL) addr = addr->parent;
6176 if (addr->message != NULL)
6179 msg = addr->message;
6181 else colon = msg = US"";
6183 /* We don't need to log here for a forced failure as it will already
6184 have been logged. Defer will also have been logged, but as a defer, so we do
6185 need to do the failure logging. */
6187 if (addr != addr_failed)
6188 log_write(0, LOG_MAIN, "** %s routing yielded a %s delivery",
6189 addr->address, which);
6191 /* Always write an error to the caller */
6193 fprintf(stderr, "routing %s yielded a %s delivery%s%s\n", addr->address,
6196 final_yield = DELIVER_MUA_FAILED;
6197 addr_failed = addr_defer = NULL; /* So that we remove the message */
6198 goto DELIVERY_TIDYUP;
6202 /* If this is a run to continue deliveries to an external channel that is
6203 already set up, defer any local deliveries. */
6205 if (continue_transport != NULL)
6207 if (addr_defer == NULL) addr_defer = addr_local; else
6209 address_item *addr = addr_defer;
6210 while (addr->next != NULL) addr = addr->next;
6211 addr->next = addr_local;
6217 /* Because address rewriting can happen in the routers, we should not really do
6218 ANY deliveries until all addresses have been routed, so that all recipients of
6219 the message get the same headers. However, this is in practice not always
6220 possible, since sometimes remote addresses give DNS timeouts for days on end.
6221 The pragmatic approach is to deliver what we can now, saving any rewritten
6222 headers so that at least the next lot of recipients benefit from the rewriting
6223 that has already been done.
6225 If any headers have been rewritten during routing, update the spool file to
6226 remember them for all subsequent deliveries. This can be delayed till later if
6227 there is only address to be delivered - if it succeeds the spool write need not
6230 if (header_rewritten &&
6231 ((addr_local != NULL &&
6232 (addr_local->next != NULL || addr_remote != NULL)) ||
6233 (addr_remote != NULL && addr_remote->next != NULL)))
6235 /* Panic-dies on error */
6236 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
6237 header_rewritten = FALSE;
6241 /* If there are any deliveries to be done, open the journal file. This is used
6242 to record successful deliveries as soon as possible after each delivery is
6243 known to be complete. A file opened with O_APPEND is used so that several
6244 processes can run simultaneously.
6246 The journal is just insurance against crashes. When the spool file is
6247 ultimately updated at the end of processing, the journal is deleted. If a
6248 journal is found to exist at the start of delivery, the addresses listed
6249 therein are added to the non-recipients. */
6251 if (addr_local != NULL || addr_remote != NULL)
6253 sprintf(CS spoolname, "%s/input/%s/%s-J", spool_directory, message_subdir, id);
6254 journal_fd = Uopen(spoolname, O_WRONLY|O_APPEND|O_CREAT, SPOOL_MODE);
6258 log_write(0, LOG_MAIN|LOG_PANIC, "Couldn't open journal file %s: %s",
6259 spoolname, strerror(errno));
6260 return DELIVER_NOT_ATTEMPTED;
6263 /* Set the close-on-exec flag, make the file owned by Exim, and ensure
6264 that the mode is correct - the group setting doesn't always seem to get
6265 set automatically. */
6267 if( fcntl(journal_fd, F_SETFD, fcntl(journal_fd, F_GETFD) | FD_CLOEXEC)
6268 || fchown(journal_fd, exim_uid, exim_gid)
6269 || fchmod(journal_fd, SPOOL_MODE)
6272 int ret = Uunlink(spoolname);
6273 log_write(0, LOG_MAIN|LOG_PANIC, "Couldn't set perms on journal file %s: %s",
6274 spoolname, strerror(errno));
6275 if(ret && errno != ENOENT)
6276 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s",
6277 spoolname, strerror(errno));
6278 return DELIVER_NOT_ATTEMPTED;
6284 /* Now we can get down to the business of actually doing deliveries. Local
6285 deliveries are done first, then remote ones. If ever the problems of how to
6286 handle fallback transports are figured out, this section can be put into a loop
6287 for handling fallbacks, though the uid switching will have to be revised. */
6289 /* Precompile a regex that is used to recognize a parameter in response
6290 to an LHLO command, if is isn't already compiled. This may be used on both
6291 local and remote LMTP deliveries. */
6293 if (regex_IGNOREQUOTA == NULL) regex_IGNOREQUOTA =
6294 regex_must_compile(US"\\n250[\\s\\-]IGNOREQUOTA(\\s|\\n|$)", FALSE, TRUE);
6296 /* Handle local deliveries */
6298 if (addr_local != NULL)
6300 DEBUG(D_deliver|D_transport)
6301 debug_printf(">>>>>>>>>>>>>>>> Local deliveries >>>>>>>>>>>>>>>>\n");
6302 do_local_deliveries();
6303 disable_logging = FALSE;
6306 /* If queue_run_local is set, we do not want to attempt any remote deliveries,
6307 so just queue them all. */
6309 if (queue_run_local)
6311 while (addr_remote != NULL)
6313 address_item *addr = addr_remote;
6314 addr_remote = addr->next;
6316 addr->basic_errno = ERRNO_LOCAL_ONLY;
6317 addr->message = US"remote deliveries suppressed";
6318 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_TRANSPORT, 0);
6322 /* Handle remote deliveries */
6324 if (addr_remote != NULL)
6326 DEBUG(D_deliver|D_transport)
6327 debug_printf(">>>>>>>>>>>>>>>> Remote deliveries >>>>>>>>>>>>>>>>\n");
6329 /* Precompile some regex that are used to recognize parameters in response
6330 to an EHLO command, if they aren't already compiled. */
6332 if (regex_PIPELINING == NULL) regex_PIPELINING =
6333 regex_must_compile(US"\\n250[\\s\\-]PIPELINING(\\s|\\n|$)", FALSE, TRUE);
6335 if (regex_SIZE == NULL) regex_SIZE =
6336 regex_must_compile(US"\\n250[\\s\\-]SIZE(\\s|\\n|$)", FALSE, TRUE);
6338 if (regex_AUTH == NULL) regex_AUTH =
6339 regex_must_compile(US"\\n250[\\s\\-]AUTH\\s+([\\-\\w\\s]+)(?:\\n|$)",
6343 if (regex_STARTTLS == NULL) regex_STARTTLS =
6344 regex_must_compile(US"\\n250[\\s\\-]STARTTLS(\\s|\\n|$)", FALSE, TRUE);
6347 #ifndef DISABLE_PRDR
6348 if (regex_PRDR == NULL) regex_PRDR =
6349 regex_must_compile(US"\\n250[\\s\\-]PRDR(\\s|\\n|$)", FALSE, TRUE);
6352 #ifdef EXPERIMENTAL_DSN
6353 /* Set the regex to check for DSN support on remote MTA */
6354 if (regex_DSN == NULL) regex_DSN =
6355 regex_must_compile(US"\\n250[\\s\\-]DSN(\\s|\\n|$)", FALSE, TRUE);
6358 /* Now sort the addresses if required, and do the deliveries. The yield of
6359 do_remote_deliveries is FALSE when mua_wrapper is set and all addresses
6360 cannot be delivered in one transaction. */
6362 if (remote_sort_domains != NULL) sort_remote_deliveries();
6363 if (!do_remote_deliveries(FALSE))
6365 log_write(0, LOG_MAIN, "** mua_wrapper is set but recipients cannot all "
6366 "be delivered in one transaction");
6367 fprintf(stderr, "delivery to smarthost failed (configuration problem)\n");
6369 final_yield = DELIVER_MUA_FAILED;
6370 addr_failed = addr_defer = NULL; /* So that we remove the message */
6371 goto DELIVERY_TIDYUP;
6374 /* See if any of the addresses that failed got put on the queue for delivery
6375 to their fallback hosts. We do it this way because often the same fallback
6376 host is used for many domains, so all can be sent in a single transaction
6377 (if appropriately configured). */
6379 if (addr_fallback != NULL && !mua_wrapper)
6381 DEBUG(D_deliver) debug_printf("Delivering to fallback hosts\n");
6382 addr_remote = addr_fallback;
6383 addr_fallback = NULL;
6384 if (remote_sort_domains != NULL) sort_remote_deliveries();
6385 do_remote_deliveries(TRUE);
6387 disable_logging = FALSE;
6391 /* All deliveries are now complete. Ignore SIGTERM during this tidying up
6392 phase, to minimize cases of half-done things. */
6395 debug_printf(">>>>>>>>>>>>>>>> deliveries are done >>>>>>>>>>>>>>>>\n");
6397 /* Root privilege is no longer needed */
6399 exim_setugid(exim_uid, exim_gid, FALSE, US"post-delivery tidying");
6401 set_process_info("tidying up after delivering %s", message_id);
6402 signal(SIGTERM, SIG_IGN);
6404 /* When we are acting as an MUA wrapper, the smtp transport will either have
6405 succeeded for all addresses, or failed them all in normal cases. However, there
6406 are some setup situations (e.g. when a named port does not exist) that cause an
6407 immediate exit with deferral of all addresses. Convert those into failures. We
6408 do not ever want to retry, nor do we want to send a bounce message. */
6412 if (addr_defer != NULL)
6414 address_item *addr, *nextaddr;
6415 for (addr = addr_defer; addr != NULL; addr = nextaddr)
6417 log_write(0, LOG_MAIN, "** %s mua_wrapper forced failure for deferred "
6418 "delivery", addr->address);
6419 nextaddr = addr->next;
6420 addr->next = addr_failed;
6426 /* Now all should either have succeeded or failed. */
6428 if (addr_failed == NULL) final_yield = DELIVER_MUA_SUCCEEDED; else
6430 uschar *s = (addr_failed->user_message != NULL)?
6431 addr_failed->user_message : addr_failed->message;
6433 fprintf(stderr, "Delivery failed: ");
6434 if (addr_failed->basic_errno > 0)
6436 fprintf(stderr, "%s", strerror(addr_failed->basic_errno));
6437 if (s != NULL) fprintf(stderr, ": ");
6441 if (addr_failed->basic_errno <= 0) fprintf(stderr, "unknown error");
6443 else fprintf(stderr, "%s", CS s);
6444 fprintf(stderr, "\n");
6446 final_yield = DELIVER_MUA_FAILED;
6451 /* In a normal configuration, we now update the retry database. This is done in
6452 one fell swoop at the end in order not to keep opening and closing (and
6453 locking) the database. The code for handling retries is hived off into a
6454 separate module for convenience. We pass it the addresses of the various
6455 chains, because deferred addresses can get moved onto the failed chain if the
6456 retry cutoff time has expired for all alternative destinations. Bypass the
6457 updating of the database if the -N flag is set, which is a debugging thing that
6458 prevents actual delivery. */
6460 else if (!dont_deliver) retry_update(&addr_defer, &addr_failed, &addr_succeed);
6462 #ifdef EXPERIMENTAL_DSN
6463 /* Send DSN for successful messages */
6464 addr_dsntmp = addr_succeed;
6465 addr_senddsn = NULL;
6467 while(addr_dsntmp != NULL)
6470 debug_printf("DSN: processing router : %s\n", addr_dsntmp->router->name);
6473 debug_printf("DSN: processing successful delivery address: %s\n", addr_dsntmp->address);
6475 /* af_ignore_error not honored here. it's not an error */
6477 DEBUG(D_deliver) debug_printf("DSN: Sender_address: %s\n", sender_address);
6478 DEBUG(D_deliver) debug_printf("DSN: orcpt: %s flags: %d\n", addr_dsntmp->dsn_orcpt, addr_dsntmp->dsn_flags);
6479 DEBUG(D_deliver) debug_printf("DSN: envid: %s ret: %d\n", dsn_envid, dsn_ret);
6480 DEBUG(D_deliver) debug_printf("DSN: Final recipient: %s\n", addr_dsntmp->address);
6481 DEBUG(D_deliver) debug_printf("DSN: Remote SMTP server supports DSN: %d\n", addr_dsntmp->dsn_aware);
6483 /* send report if next hop not DSN aware or a router flagged "last DSN hop"
6484 and a report was requested */
6485 if (((addr_dsntmp->dsn_aware != dsn_support_yes) ||
6486 ((addr_dsntmp->dsn_flags & rf_dsnlasthop) != 0))
6488 (((addr_dsntmp->dsn_flags & rf_dsnflags) != 0) &&
6489 ((addr_dsntmp->dsn_flags & rf_notify_success) != 0)))
6491 /* copy and relink address_item and send report with all of them at once later */
6492 address_item *addr_next;
6493 addr_next = addr_senddsn;
6494 addr_senddsn = store_get(sizeof(address_item));
6495 memcpy(addr_senddsn, addr_dsntmp, sizeof(address_item));
6496 addr_senddsn->next = addr_next;
6500 DEBUG(D_deliver) debug_printf("DSN: *** NOT SENDING DSN SUCCESS Message ***\n");
6503 addr_dsntmp = addr_dsntmp->next;
6506 if (addr_senddsn != NULL)
6511 /* create exim process to send message */
6512 pid = child_open_exim(&fd);
6514 DEBUG(D_deliver) debug_printf("DSN: child_open_exim returns: %d\n", pid);
6516 if (pid < 0) /* Creation of child failed */
6518 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Process %d (parent %d) failed to "
6519 "create child process to send failure message: %s", getpid(),
6520 getppid(), strerror(errno));
6522 DEBUG(D_deliver) debug_printf("DSN: child_open_exim failed\n");
6525 else /* Creation of child succeeded */
6527 FILE *f = fdopen(fd, "wb");
6528 /* header only as required by RFC. only failure DSN needs to honor RET=FULL */
6529 int topt = topt_add_return_path | topt_no_body;
6530 uschar boundaryStr[64];
6532 DEBUG(D_deliver) debug_printf("sending error message to: %s\n", sender_address);
6534 /* build unique id for MIME boundary */
6535 snprintf(boundaryStr, sizeof(boundaryStr)-1, TIME_T_FMT "-eximdsn-%d",
6536 time(NULL), rand());
6537 DEBUG(D_deliver) debug_printf("DSN: MIME boundary: %s\n", boundaryStr);
6539 if (errors_reply_to)
6540 fprintf(f, "Reply-To: %s\n", errors_reply_to);
6542 fprintf(f, "Auto-Submitted: auto-generated\n"
6543 "From: Mail Delivery System <Mailer-Daemon@%s>\n"
6545 "Subject: Delivery Status Notification\n"
6546 "Content-Type: multipart/report; report-type=delivery-status; boundary=%s\n"
6547 "MIME-Version: 1.0\n\n"
6550 "Content-type: text/plain; charset=us-ascii\n\n"
6552 "This message was created automatically by mail delivery software.\n"
6553 " ----- The following addresses had successful delivery notifications -----\n",
6554 qualify_domain_sender, sender_address, boundaryStr, boundaryStr);
6556 addr_dsntmp = addr_senddsn;
6559 fprintf(f, "<%s> (relayed %s)\n\n",
6560 addr_dsntmp->address,
6561 (addr_dsntmp->dsn_flags & rf_dsnlasthop) == 1
6562 ? "via non DSN router"
6563 : addr_dsntmp->dsn_aware == dsn_support_no
6564 ? "to non-DSN-aware mailer"
6565 : "via non \"Remote SMTP\" router"
6567 addr_dsntmp = addr_dsntmp->next;
6570 "Content-type: message/delivery-status\n\n"
6571 "Reporting-MTA: dns; %s\n",
6572 boundaryStr, smtp_active_hostname);
6574 if (dsn_envid != NULL) {
6575 /* must be decoded from xtext: see RFC 3461:6.3a */
6577 if (auth_xtextdecode(dsn_envid, &xdec_envid) > 0)
6578 fprintf(f, "Original-Envelope-ID: %s\n", dsn_envid);
6580 fprintf(f, "X-Original-Envelope-ID: error decoding xtext formated ENVID\n");
6584 for (addr_dsntmp = addr_senddsn;
6586 addr_dsntmp = addr_dsntmp->next)
6588 if (addr_dsntmp->dsn_orcpt)
6589 fprintf(f,"Original-Recipient: %s\n", addr_dsntmp->dsn_orcpt);
6591 fprintf(f, "Action: delivered\n"
6592 "Final-Recipient: rfc822;%s\n"
6594 addr_dsntmp->address);
6596 if (addr_dsntmp->host_used && addr_dsntmp->host_used->name)
6597 fprintf(f, "Remote-MTA: dns; %s\nDiagnostic-Code: smtp; 250 Ok\n",
6598 addr_dsntmp->host_used->name);
6600 fprintf(f,"Diagnostic-Code: X-Exim; relayed via non %s router\n",
6601 (addr_dsntmp->dsn_flags & rf_dsnlasthop) == 1 ? "DSN" : "SMTP");
6605 fprintf(f, "--%s\nContent-type: text/rfc822-headers\n\n", boundaryStr);
6608 transport_filter_argv = NULL; /* Just in case */
6609 return_path = sender_address; /* In case not previously set */
6611 /* Write the original email out */
6612 transport_write_message(NULL, fileno(f), topt, 0, NULL, NULL, NULL, NULL, NULL, 0);
6616 fprintf(f,"--%s--\n", boundaryStr);
6620 rc = child_close(pid, 0); /* Waits for child to close, no timeout */
6623 #endif /*EXPERIMENTAL_DSN*/
6625 /* If any addresses failed, we must send a message to somebody, unless
6626 af_ignore_error is set, in which case no action is taken. It is possible for
6627 several messages to get sent if there are addresses with different
6630 while (addr_failed != NULL)
6634 uschar *logtod = tod_stamp(tod_log);
6636 address_item *handled_addr = NULL;
6637 address_item **paddr;
6638 address_item *msgchain = NULL;
6639 address_item **pmsgchain = &msgchain;
6641 /* There are weird cases when logging is disabled in the transport. However,
6642 there may not be a transport (address failed by a router). */
6644 disable_logging = FALSE;
6645 if (addr_failed->transport != NULL)
6646 disable_logging = addr_failed->transport->disable_logging;
6649 debug_printf("processing failed address %s\n", addr_failed->address);
6651 /* There are only two ways an address in a bounce message can get here:
6653 (1) When delivery was initially deferred, but has now timed out (in the call
6654 to retry_update() above). We can detect this by testing for
6655 af_retry_timedout. If the address does not have its own errors address,
6656 we arrange to ignore the error.
6658 (2) If delivery failures for bounce messages are being ignored. We can detect
6659 this by testing for af_ignore_error. This will also be set if a bounce
6660 message has been autothawed and the ignore_bounce_errors_after time has
6661 passed. It might also be set if a router was explicitly configured to
6662 ignore errors (errors_to = "").
6664 If neither of these cases obtains, something has gone wrong. Log the
6665 incident, but then ignore the error. */
6667 if (sender_address[0] == 0 && addr_failed->p.errors_address == NULL)
6669 if (!testflag(addr_failed, af_retry_timedout) &&
6670 !testflag(addr_failed, af_ignore_error))
6672 log_write(0, LOG_MAIN|LOG_PANIC, "internal error: bounce message "
6673 "failure is neither frozen nor ignored (it's been ignored)");
6675 setflag(addr_failed, af_ignore_error);
6678 /* If the first address on the list has af_ignore_error set, just remove
6679 it from the list, throw away any saved message file, log it, and
6680 mark the recipient done. */
6682 if (testflag(addr_failed, af_ignore_error)
6683 #ifdef EXPERIMENTAL_DSN
6684 || (((addr_failed->dsn_flags & rf_dsnflags) != 0)
6685 && ((addr_failed->dsn_flags & rf_notify_failure) != rf_notify_failure))
6690 addr_failed = addr->next;
6691 if (addr->return_filename != NULL) Uunlink(addr->return_filename);
6693 log_write(0, LOG_MAIN, "%s%s%s%s: error ignored",
6695 (addr->parent == NULL)? US"" : US" <",
6696 (addr->parent == NULL)? US"" : addr->parent->address,
6697 (addr->parent == NULL)? US"" : US">");
6699 address_done(addr, logtod);
6700 child_done(addr, logtod);
6701 /* Panic-dies on error */
6702 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
6705 /* Otherwise, handle the sending of a message. Find the error address for
6706 the first address, then send a message that includes all failed addresses
6707 that have the same error address. Note the bounce_recipient is a global so
6708 that it can be accesssed by $bounce_recipient while creating a customized
6713 bounce_recipient = (addr_failed->p.errors_address == NULL)?
6714 sender_address : addr_failed->p.errors_address;
6716 /* Make a subprocess to send a message */
6718 pid = child_open_exim(&fd);
6720 /* Creation of child failed */
6723 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Process %d (parent %d) failed to "
6724 "create child process to send failure message: %s", getpid(),
6725 getppid(), strerror(errno));
6727 /* Creation of child succeeded */
6734 uschar *bcc, *emf_text;
6735 FILE *f = fdopen(fd, "wb");
6737 BOOL to_sender = strcmpic(sender_address, bounce_recipient) == 0;
6738 int max = (bounce_return_size_limit/DELIVER_IN_BUFFER_SIZE + 1) *
6739 DELIVER_IN_BUFFER_SIZE;
6740 #ifdef EXPERIMENTAL_DSN
6741 uschar boundaryStr[64];
6742 uschar *dsnlimitmsg;
6743 uschar *dsnnotifyhdr;
6748 debug_printf("sending error message to: %s\n", bounce_recipient);
6750 /* Scan the addresses for all that have the same errors address, removing
6751 them from the addr_failed chain, and putting them on msgchain. */
6753 paddr = &addr_failed;
6754 for (addr = addr_failed; addr != NULL; addr = *paddr)
6756 if (Ustrcmp(bounce_recipient, (addr->p.errors_address == NULL)?
6757 sender_address : addr->p.errors_address) != 0)
6759 paddr = &(addr->next); /* Not the same; skip */
6761 else /* The same - dechain */
6763 *paddr = addr->next;
6766 pmsgchain = &(addr->next);
6770 /* Include X-Failed-Recipients: for automatic interpretation, but do
6771 not let any one header line get too long. We do this by starting a
6772 new header every 50 recipients. Omit any addresses for which the
6773 "hide_child" flag is set. */
6775 for (addr = msgchain; addr != NULL; addr = addr->next)
6777 if (testflag(addr, af_hide_child)) continue;
6784 (rcount++ == 0)? "X-Failed-Recipients: " : ",\n ",
6785 (testflag(addr, af_pfr) && addr->parent != NULL)?
6786 string_printing(addr->parent->address) :
6787 string_printing(addr->address));
6789 if (rcount > 0) fprintf(f, "\n");
6791 /* Output the standard headers */
6793 if (errors_reply_to != NULL)
6794 fprintf(f, "Reply-To: %s\n", errors_reply_to);
6795 fprintf(f, "Auto-Submitted: auto-replied\n");
6797 fprintf(f, "To: %s\n", bounce_recipient);
6799 #ifdef EXPERIMENTAL_DSN
6800 /* generate boundary string and output MIME-Headers */
6801 snprintf(boundaryStr, sizeof(boundaryStr)-1, TIME_T_FMT "-eximdsn-%d",
6802 time(NULL), rand());
6804 fprintf(f, "Content-Type: multipart/report;"
6805 " report-type=delivery-status; boundary=%s\n"
6806 "MIME-Version: 1.0\n",
6810 /* Open a template file if one is provided. Log failure to open, but
6811 carry on - default texts will be used. */
6813 if (bounce_message_file)
6814 if (!(emf = Ufopen(bounce_message_file, "rb")))
6815 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to open %s for error "
6816 "message texts: %s", bounce_message_file, strerror(errno));
6818 /* Quietly copy to configured additional addresses if required. */
6820 if ((bcc = moan_check_errorcopy(bounce_recipient)))
6821 fprintf(f, "Bcc: %s\n", bcc);
6823 /* The texts for the message can be read from a template file; if there
6824 isn't one, or if it is too short, built-in texts are used. The first
6825 emf text is a Subject: and any other headers. */
6827 if ((emf_text = next_emf(emf, US"header")))
6828 fprintf(f, "%s\n", emf_text);
6830 fprintf(f, "Subject: Mail delivery failed%s\n\n",
6831 to_sender? ": returning message to sender" : "");
6833 #ifdef EXPERIMENTAL_DSN
6834 /* output human readable part as text/plain section */
6836 "Content-type: text/plain; charset=us-ascii\n\n",
6840 if ((emf_text = next_emf(emf, US"intro")))
6841 fprintf(f, "%s", CS emf_text);
6845 /* This message has been reworded several times. It seems to be confusing to
6846 somebody, however it is worded. I have retreated to the original, simple
6848 "This message was created automatically by mail delivery software.\n");
6850 if (bounce_message_text)
6851 fprintf(f, "%s", CS bounce_message_text);
6854 "\nA message that you sent could not be delivered to one or more of its\n"
6855 "recipients. This is a permanent error. The following address(es) failed:\n");
6858 "\nA message sent by\n\n <%s>\n\n"
6859 "could not be delivered to one or more of its recipients. The following\n"
6860 "address(es) failed:\n", sender_address);
6864 /* Process the addresses, leaving them on the msgchain if they have a
6865 file name for a return message. (There has already been a check in
6866 post_process_one() for the existence of data in the message file.) A TRUE
6867 return from print_address_information() means that the address is not
6871 for (addr = msgchain; addr != NULL; addr = *paddr)
6873 if (print_address_information(addr, f, US" ", US"\n ", US""))
6874 print_address_error(addr, f, US"");
6876 /* End the final line for the address */
6880 /* Leave on msgchain if there's a return file. */
6882 if (addr->return_file >= 0)
6884 paddr = &(addr->next);
6888 /* Else save so that we can tick off the recipient when the
6893 *paddr = addr->next;
6894 addr->next = handled_addr;
6895 handled_addr = addr;
6901 /* Get the next text, whether we need it or not, so as to be
6902 positioned for the one after. */
6904 emf_text = next_emf(emf, US"generated text");
6906 /* If there were any file messages passed by the local transports,
6907 include them in the message. Then put the address on the handled chain.
6908 In the case of a batch of addresses that were all sent to the same
6909 transport, the return_file field in all of them will contain the same
6910 fd, and the return_filename field in the *last* one will be set (to the
6911 name of the file). */
6915 address_item *nextaddr;
6918 fprintf(f, "%s", CS emf_text);
6921 "The following text was generated during the delivery "
6922 "attempt%s:\n", (filecount > 1)? "s" : "");
6924 for (addr = msgchain; addr != NULL; addr = nextaddr)
6927 address_item *topaddr = addr;
6929 /* List all the addresses that relate to this file */
6932 while(addr) /* Insurance */
6934 print_address_information(addr, f, US"------ ", US"\n ",
6936 if (addr->return_filename) break;
6941 /* Now copy the file */
6943 fm = Ufopen(addr->return_filename, "rb");
6946 fprintf(f, " +++ Exim error... failed to open text file: %s\n",
6950 while ((ch = fgetc(fm)) != EOF) fputc(ch, f);
6953 Uunlink(addr->return_filename);
6955 /* Can now add to handled chain, first fishing off the next
6956 address on the msgchain. */
6958 nextaddr = addr->next;
6959 addr->next = handled_addr;
6960 handled_addr = topaddr;
6965 #ifdef EXPERIMENTAL_DSN
6966 /* output machine readable part */
6968 "Content-type: message/delivery-status\n\n"
6969 "Reporting-MTA: dns; %s\n",
6970 boundaryStr, smtp_active_hostname);
6974 /* must be decoded from xtext: see RFC 3461:6.3a */
6976 if (auth_xtextdecode(dsn_envid, &xdec_envid) > 0)
6977 fprintf(f, "Original-Envelope-ID: %s\n", dsn_envid);
6979 fprintf(f, "X-Original-Envelope-ID: error decoding xtext formated ENVID\n");
6983 for (addr = handled_addr; addr; addr = addr->next)
6985 fprintf(f, "Action: failed\n"
6986 "Final-Recipient: rfc822;%s\n"
6989 if (addr->host_used && addr->host_used->name)
6990 fprintf(f, "Remote-MTA: dns; %s\nDiagnostic-Code: smtp; %d\n",
6991 addr->host_used->name, addr->basic_errno);
6995 /* Now copy the message, trying to give an intelligible comment if
6996 it is too long for it all to be copied. The limit isn't strictly
6997 applied because of the buffering. There is, however, an option
6998 to suppress copying altogether. */
7000 emf_text = next_emf(emf, US"copy");
7002 #ifndef EXPERIMENTAL_DSN
7003 if (bounce_return_message)
7005 int topt = topt_add_return_path;
7006 if (!bounce_return_body) topt |= topt_no_body;
7009 fprintf(f, "%s", CS emf_text);
7012 if (bounce_return_body) fprintf(f,
7013 "------ This is a copy of the message, including all the headers. ------\n");
7015 "------ This is a copy of the message's headers. ------\n");
7018 /* While reading the "truncated" message, set return_size_limit to
7019 the actual max testing value, rounded. We need to read the message
7020 whether we are going to use it or not. */
7023 int temp = bounce_return_size_limit;
7024 bounce_return_size_limit = (max/1000)*1000;
7025 emf_text = next_emf(emf, US"truncated");
7026 bounce_return_size_limit = temp;
7029 if (bounce_return_body && bounce_return_size_limit > 0)
7031 struct stat statbuf;
7032 if (fstat(deliver_datafile, &statbuf) == 0 && statbuf.st_size > max)
7035 fprintf(f, "%s", CS emf_text);
7038 "------ The body of the message is " OFF_T_FMT " characters long; only the first\n"
7039 "------ %d or so are included here.\n", statbuf.st_size, max);
7046 transport_filter_argv = NULL; /* Just in case */
7047 return_path = sender_address; /* In case not previously set */
7048 transport_write_message(NULL, fileno(f), topt,
7049 bounce_return_size_limit, NULL, NULL, NULL, NULL, NULL, 0);
7052 /* Write final text and close the template file if one is open */
7056 if ((emf_text = next_emf(emf, US"final")))
7057 fprintf(f, "%s", CS emf_text);
7062 we ignore the intro text from template and add
7063 the text for bounce_return_size_limit at the end.
7065 bounce_return_message is ignored
7066 in case RET= is defined we honor these values
7067 otherwise bounce_return_body is honored.
7069 bounce_return_size_limit is always honored.
7072 fprintf(f, "\n--%s\n", boundaryStr);
7074 dsnlimitmsg = US"X-Exim-DSN-Information: Due to administrative limits only headers are returned";
7075 dsnnotifyhdr = NULL;
7076 topt = topt_add_return_path;
7078 /* RET=HDRS? top priority */
7079 if (dsn_ret == dsn_ret_hdrs)
7080 topt |= topt_no_body;
7082 /* no full body return at all? */
7083 if (!bounce_return_body)
7085 topt |= topt_no_body;
7086 /* add header if we overrule RET=FULL */
7087 if (dsn_ret == dsn_ret_full)
7088 dsnnotifyhdr = dsnlimitmsg;
7090 /* size limited ... return headers only if limit reached */
7091 else if (bounce_return_size_limit > 0)
7093 struct stat statbuf;
7094 if (fstat(deliver_datafile, &statbuf) == 0 && statbuf.st_size > max)
7096 topt |= topt_no_body;
7097 dsnnotifyhdr = dsnlimitmsg;
7101 if (topt & topt_no_body)
7102 fprintf(f,"Content-type: text/rfc822-headers\n\n");
7104 fprintf(f,"Content-type: message/rfc822\n\n");
7107 transport_filter_argv = NULL; /* Just in case */
7108 return_path = sender_address; /* In case not previously set */
7109 transport_write_message(NULL, fileno(f), topt,
7110 0, dsnnotifyhdr, NULL, NULL, NULL, NULL, 0);
7113 /* we never add the final text. close the file */
7117 fprintf(f, "\n--%s--\n", boundaryStr);
7118 #endif /*EXPERIMENTAL_DSN*/
7120 /* Close the file, which should send an EOF to the child process
7121 that is receiving the message. Wait for it to finish. */
7124 rc = child_close(pid, 0); /* Waits for child to close, no timeout */
7126 /* In the test harness, let the child do it's thing first. */
7128 if (running_in_test_harness) millisleep(500);
7130 /* If the process failed, there was some disaster in setting up the
7131 error message. Unless the message is very old, ensure that addr_defer
7132 is non-null, which will have the effect of leaving the message on the
7133 spool. The failed addresses will get tried again next time. However, we
7134 don't really want this to happen too often, so freeze the message unless
7135 there are some genuine deferred addresses to try. To do this we have
7136 to call spool_write_header() here, because with no genuine deferred
7137 addresses the normal code below doesn't get run. */
7142 if (now - received_time < retry_maximum_timeout && addr_defer == NULL)
7144 addr_defer = (address_item *)(+1);
7145 deliver_freeze = TRUE;
7146 deliver_frozen_at = time(NULL);
7147 /* Panic-dies on error */
7148 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
7151 deliver_msglog("Process failed (%d) when writing error message "
7152 "to %s%s", rc, bounce_recipient, s);
7153 log_write(0, LOG_MAIN, "Process failed (%d) when writing error message "
7154 "to %s%s", rc, bounce_recipient, s);
7157 /* The message succeeded. Ensure that the recipients that failed are
7158 now marked finished with on the spool and their parents updated. */
7162 for (addr = handled_addr; addr != NULL; addr = addr->next)
7164 address_done(addr, logtod);
7165 child_done(addr, logtod);
7167 /* Panic-dies on error */
7168 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
7174 disable_logging = FALSE; /* In case left set */
7176 /* Come here from the mua_wrapper case if routing goes wrong */
7180 /* If there are now no deferred addresses, we are done. Preserve the
7181 message log if so configured, and we are using them. Otherwise, sling it.
7182 Then delete the message itself. */
7184 if (addr_defer == NULL)
7188 sprintf(CS spoolname, "%s/msglog/%s/%s", spool_directory, message_subdir,
7190 if (preserve_message_logs)
7193 sprintf(CS big_buffer, "%s/msglog.OLD/%s", spool_directory, id);
7194 if ((rc = Urename(spoolname, big_buffer)) < 0)
7196 (void)directory_make(spool_directory, US"msglog.OLD",
7197 MSGLOG_DIRECTORY_MODE, TRUE);
7198 rc = Urename(spoolname, big_buffer);
7201 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to move %s to the "
7202 "msglog.OLD directory", spoolname);
7206 if (Uunlink(spoolname) < 0)
7207 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s",
7208 spoolname, strerror(errno));
7212 /* Remove the two message files. */
7214 sprintf(CS spoolname, "%s/input/%s/%s-D", spool_directory, message_subdir, id);
7215 if (Uunlink(spoolname) < 0)
7216 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s",
7217 spoolname, strerror(errno));
7218 sprintf(CS spoolname, "%s/input/%s/%s-H", spool_directory, message_subdir, id);
7219 if (Uunlink(spoolname) < 0)
7220 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s",
7221 spoolname, strerror(errno));
7223 /* Log the end of this message, with queue time if requested. */
7225 if ((log_extra_selector & LX_queue_time_overall) != 0)
7226 log_write(0, LOG_MAIN, "Completed QT=%s",
7227 readconf_printtime( (int) ((long)time(NULL) - (long)received_time)) );
7229 log_write(0, LOG_MAIN, "Completed");
7231 /* Unset deliver_freeze so that we won't try to move the spool files further down */
7232 deliver_freeze = FALSE;
7235 /* If there are deferred addresses, we are keeping this message because it is
7236 not yet completed. Lose any temporary files that were catching output from
7237 pipes for any of the deferred addresses, handle one-time aliases, and see if
7238 the message has been on the queue for so long that it is time to send a warning
7239 message to the sender, unless it is a mailer-daemon. If all deferred addresses
7240 have the same domain, we can set deliver_domain for the expansion of
7241 delay_warning_ condition - if any of them are pipes, files, or autoreplies, use
7242 the parent's domain.
7244 If all the deferred addresses have an error number that indicates "retry time
7245 not reached", skip sending the warning message, because it won't contain the
7246 reason for the delay. It will get sent at the next real delivery attempt.
7247 However, if at least one address has tried, we'd better include all of them in
7250 If we can't make a process to send the message, don't worry.
7252 For mailing list expansions we want to send the warning message to the
7253 mailing list manager. We can't do a perfect job here, as some addresses may
7254 have different errors addresses, but if we take the errors address from
7255 each deferred address it will probably be right in most cases.
7257 If addr_defer == +1, it means there was a problem sending an error message
7258 for failed addresses, and there were no "real" deferred addresses. The value
7259 was set just to keep the message on the spool, so there is nothing to do here.
7262 else if (addr_defer != (address_item *)(+1))
7265 uschar *recipients = US"";
7266 BOOL delivery_attempted = FALSE;
7268 deliver_domain = testflag(addr_defer, af_pfr)?
7269 addr_defer->parent->domain : addr_defer->domain;
7271 for (addr = addr_defer; addr != NULL; addr = addr->next)
7273 address_item *otaddr;
7275 if (addr->basic_errno > ERRNO_RETRY_BASE) delivery_attempted = TRUE;
7277 if (deliver_domain != NULL)
7279 uschar *d = (testflag(addr, af_pfr))? addr->parent->domain : addr->domain;
7281 /* The domain may be unset for an address that has never been routed
7282 because the system filter froze the message. */
7284 if (d == NULL || Ustrcmp(d, deliver_domain) != 0) deliver_domain = NULL;
7287 if (addr->return_filename != NULL) Uunlink(addr->return_filename);
7289 /* Handle the case of one-time aliases. If any address in the ancestry
7290 of this one is flagged, ensure it is in the recipients list, suitably
7291 flagged, and that its parent is marked delivered. */
7293 for (otaddr = addr; otaddr != NULL; otaddr = otaddr->parent)
7294 if (otaddr->onetime_parent != NULL) break;
7299 int t = recipients_count;
7301 for (i = 0; i < recipients_count; i++)
7303 uschar *r = recipients_list[i].address;
7304 if (Ustrcmp(otaddr->onetime_parent, r) == 0) t = i;
7305 if (Ustrcmp(otaddr->address, r) == 0) break;
7308 /* Didn't find the address already in the list, and did find the
7309 ultimate parent's address in the list. After adding the recipient,
7310 update the errors address in the recipients list. */
7312 if (i >= recipients_count && t < recipients_count)
7314 DEBUG(D_deliver) debug_printf("one_time: adding %s in place of %s\n",
7315 otaddr->address, otaddr->parent->address);
7316 receive_add_recipient(otaddr->address, t);
7317 recipients_list[recipients_count-1].errors_to = otaddr->p.errors_address;
7318 tree_add_nonrecipient(otaddr->parent->address);
7319 update_spool = TRUE;
7323 /* Except for error messages, ensure that either the errors address for
7324 this deferred address or, if there is none, the sender address, is on the
7325 list of recipients for a warning message. */
7327 if (sender_address[0] != 0)
7329 if (addr->p.errors_address == NULL)
7331 if (Ustrstr(recipients, sender_address) == NULL)
7332 recipients = string_sprintf("%s%s%s", recipients,
7333 (recipients[0] == 0)? "" : ",", sender_address);
7337 if (Ustrstr(recipients, addr->p.errors_address) == NULL)
7338 recipients = string_sprintf("%s%s%s", recipients,
7339 (recipients[0] == 0)? "" : ",", addr->p.errors_address);
7344 /* Send a warning message if the conditions are right. If the condition check
7345 fails because of a lookup defer, there is nothing we can do. The warning
7346 is not sent. Another attempt will be made at the next delivery attempt (if
7349 if (!queue_2stage && delivery_attempted &&
7350 #ifdef EXPERIMENTAL_DSN
7351 (((addr_defer->dsn_flags & rf_dsnflags) == 0) ||
7352 (addr_defer->dsn_flags & rf_notify_delay) == rf_notify_delay) &&
7354 delay_warning[1] > 0 && sender_address[0] != 0 &&
7355 (delay_warning_condition == NULL ||
7356 expand_check_condition(delay_warning_condition,
7357 US"delay_warning", US"option")))
7361 int queue_time = time(NULL) - received_time;
7363 /* When running in the test harness, there's an option that allows us to
7364 fudge this time so as to get repeatability of the tests. Take the first
7365 time off the list. In queue runs, the list pointer gets updated in the
7368 if (running_in_test_harness && fudged_queue_times[0] != 0)
7370 int qt = readconf_readtime(fudged_queue_times, '/', FALSE);
7373 DEBUG(D_deliver) debug_printf("fudged queue_times = %s\n",
7374 fudged_queue_times);
7379 /* See how many warnings we should have sent by now */
7381 for (count = 0; count < delay_warning[1]; count++)
7382 if (queue_time < delay_warning[count+2]) break;
7384 show_time = delay_warning[count+1];
7386 if (count >= delay_warning[1])
7389 int last_gap = show_time;
7390 if (count > 1) last_gap -= delay_warning[count];
7391 extra = (queue_time - delay_warning[count+1])/last_gap;
7392 show_time += last_gap * extra;
7398 debug_printf("time on queue = %s\n", readconf_printtime(queue_time));
7399 debug_printf("warning counts: required %d done %d\n", count,
7403 /* We have computed the number of warnings there should have been by now.
7404 If there haven't been enough, send one, and up the count to what it should
7407 if (warning_count < count)
7411 pid_t pid = child_open_exim(&fd);
7417 FILE *f = fdopen(fd, "wb");
7418 #ifdef EXPERIMENTAL_DSN
7419 uschar boundaryStr[64];
7422 if (warn_message_file)
7424 wmf = Ufopen(warn_message_file, "rb");
7426 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to open %s for warning "
7427 "message texts: %s", warn_message_file, strerror(errno));
7430 warnmsg_recipients = recipients;
7431 warnmsg_delay = (queue_time < 120*60)?
7432 string_sprintf("%d minutes", show_time/60):
7433 string_sprintf("%d hours", show_time/3600);
7435 if (errors_reply_to)
7436 fprintf(f, "Reply-To: %s\n", errors_reply_to);
7437 fprintf(f, "Auto-Submitted: auto-replied\n");
7439 fprintf(f, "To: %s\n", recipients);
7441 #ifdef EXPERIMENTAL_DSN
7442 /* generated boundary string and output MIME-Headers */
7443 snprintf(boundaryStr, sizeof(boundaryStr)-1,
7444 TIME_T_FMT "-eximdsn-%d", time(NULL), rand());
7446 fprintf(f, "Content-Type: multipart/report;"
7447 " report-type=delivery-status; boundary=%s\n"
7448 "MIME-Version: 1.0\n",
7452 if ((wmf_text = next_emf(wmf, US"header")))
7453 fprintf(f, "%s\n", wmf_text);
7455 fprintf(f, "Subject: Warning: message %s delayed %s\n\n",
7456 message_id, warnmsg_delay);
7458 #ifdef EXPERIMENTAL_DSN
7459 /* output human readable part as text/plain section */
7461 "Content-type: text/plain; charset=us-ascii\n\n",
7465 if ((wmf_text = next_emf(wmf, US"intro")))
7466 fprintf(f, "%s", CS wmf_text);
7470 "This message was created automatically by mail delivery software.\n");
7472 if (Ustrcmp(recipients, sender_address) == 0)
7474 "A message that you sent has not yet been delivered to one or more of its\n"
7475 "recipients after more than ");
7479 "A message sent by\n\n <%s>\n\n"
7480 "has not yet been delivered to one or more of its recipients after more than \n",
7483 fprintf(f, "%s on the queue on %s.\n\n"
7484 "The message identifier is: %s\n",
7485 warnmsg_delay, primary_hostname, message_id);
7487 for (h = header_list; h != NULL; h = h->next)
7488 if (strncmpic(h->text, US"Subject:", 8) == 0)
7489 fprintf(f, "The subject of the message is: %s", h->text + 9);
7490 else if (strncmpic(h->text, US"Date:", 5) == 0)
7491 fprintf(f, "The date of the message is: %s", h->text + 6);
7494 fprintf(f, "The address%s to which the message has not yet been "
7496 !addr_defer->next ? "" : "es",
7497 !addr_defer->next ? "is": "are");
7500 /* List the addresses, with error information if allowed */
7502 #ifdef EXPERIMENTAL_DSN
7503 /* store addr_defer for machine readable part */
7504 address_item *addr_dsndefer = addr_defer;
7509 address_item *addr = addr_defer;
7510 addr_defer = addr->next;
7511 if (print_address_information(addr, f, US" ", US"\n ", US""))
7512 print_address_error(addr, f, US"Delay reason: ");
7521 if ((wmf_text = next_emf(wmf, US"final")))
7522 fprintf(f, "%s", CS wmf_text);
7528 "No action is required on your part. Delivery attempts will continue for\n"
7529 "some time, and this warning may be repeated at intervals if the message\n"
7530 "remains undelivered. Eventually the mail delivery software will give up,\n"
7531 "and when that happens, the message will be returned to you.\n");
7534 #ifdef EXPERIMENTAL_DSN
7535 /* output machine readable part */
7536 fprintf(f, "\n--%s\n"
7537 "Content-type: message/delivery-status\n\n"
7538 "Reporting-MTA: dns; %s\n",
7540 smtp_active_hostname);
7545 /* must be decoded from xtext: see RFC 3461:6.3a */
7547 if (auth_xtextdecode(dsn_envid, &xdec_envid) > 0)
7548 fprintf(f,"Original-Envelope-ID: %s\n", dsn_envid);
7550 fprintf(f,"X-Original-Envelope-ID: error decoding xtext formated ENVID\n");
7554 while (addr_dsndefer)
7556 if (addr_dsndefer->dsn_orcpt)
7557 fprintf(f,"Original-Recipient: %s\n", addr_dsndefer->dsn_orcpt);
7559 fprintf(f,"Action: delayed\n");
7560 fprintf(f,"Final-Recipient: rfc822;%s\n", addr_dsndefer->address);
7561 fprintf(f,"Status: 4.0.0\n");
7562 if (addr_dsndefer->host_used && addr_dsndefer->host_used->name)
7563 fprintf(f,"Remote-MTA: dns; %s\nDiagnostic-Code: smtp; %d\n",
7564 addr_dsndefer->host_used->name, addr_dsndefer->basic_errno);
7565 addr_dsndefer = addr_dsndefer->next;
7568 fprintf(f, "\n--%s\n"
7569 "Content-type: text/rfc822-headers\n\n",
7573 /* header only as required by RFC. only failure DSN needs to honor RET=FULL */
7574 int topt = topt_add_return_path | topt_no_body;
7575 transport_filter_argv = NULL; /* Just in case */
7576 return_path = sender_address; /* In case not previously set */
7577 /* Write the original email out */
7578 transport_write_message(NULL, fileno(f), topt, 0, NULL, NULL, NULL, NULL, NULL, 0);
7581 fprintf(f,"\n--%s--\n", boundaryStr);
7584 #endif /*EXPERIMENTAL_DSN*/
7586 /* Close and wait for child process to complete, without a timeout.
7587 If there's an error, don't update the count. */
7590 if (child_close(pid, 0) == 0)
7592 warning_count = count;
7593 update_spool = TRUE; /* Ensure spool rewritten */
7599 /* Clear deliver_domain */
7601 deliver_domain = NULL;
7603 /* If this was a first delivery attempt, unset the first time flag, and
7604 ensure that the spool gets updated. */
7606 if (deliver_firsttime)
7608 deliver_firsttime = FALSE;
7609 update_spool = TRUE;
7612 /* If delivery was frozen and freeze_tell is set, generate an appropriate
7613 message, unless the message is a local error message (to avoid loops). Then
7614 log the freezing. If the text in "frozen_info" came from a system filter,
7615 it has been escaped into printing characters so as not to mess up log lines.
7616 For the "tell" message, we turn \n back into newline. Also, insert a newline
7617 near the start instead of the ": " string. */
7621 if (freeze_tell != NULL && freeze_tell[0] != 0 && !local_error_message)
7623 uschar *s = string_copy(frozen_info);
7624 uschar *ss = Ustrstr(s, " by the system filter: ");
7635 if (*ss == '\\' && ss[1] == 'n')
7642 moan_tell_someone(freeze_tell, addr_defer, US"Message frozen",
7643 "Message %s has been frozen%s.\nThe sender is <%s>.\n", message_id,
7647 /* Log freezing just before we update the -H file, to minimize the chance
7648 of a race problem. */
7650 deliver_msglog("*** Frozen%s\n", frozen_info);
7651 log_write(0, LOG_MAIN, "Frozen%s", frozen_info);
7654 /* If there have been any updates to the non-recipients list, or other things
7655 that get written to the spool, we must now update the spool header file so
7656 that it has the right information for the next delivery attempt. If there
7657 was more than one address being delivered, the header_change update is done
7658 earlier, in case one succeeds and then something crashes. */
7661 debug_printf("delivery deferred: update_spool=%d header_rewritten=%d\n",
7662 update_spool, header_rewritten);
7664 if (update_spool || header_rewritten)
7665 /* Panic-dies on error */
7666 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
7669 /* Finished with the message log. If the message is complete, it will have
7670 been unlinked or renamed above. */
7672 if (message_logs) (void)fclose(message_log);
7674 /* Now we can close and remove the journal file. Its only purpose is to record
7675 successfully completed deliveries asap so that this information doesn't get
7676 lost if Exim (or the machine) crashes. Forgetting about a failed delivery is
7677 not serious, as trying it again is not harmful. The journal might not be open
7678 if all addresses were deferred at routing or directing. Nevertheless, we must
7679 remove it if it exists (may have been lying around from a crash during the
7680 previous delivery attempt). We don't remove the journal if a delivery
7681 subprocess failed to pass back delivery information; this is controlled by
7682 the remove_journal flag. When the journal is left, we also don't move the
7683 message off the main spool if frozen and the option is set. It should get moved
7684 at the next attempt, after the journal has been inspected. */
7686 if (journal_fd >= 0) (void)close(journal_fd);
7690 sprintf(CS spoolname, "%s/input/%s/%s-J", spool_directory, message_subdir, id);
7691 if (Uunlink(spoolname) < 0 && errno != ENOENT)
7692 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s", spoolname,
7695 /* Move the message off the spool if reqested */
7697 #ifdef SUPPORT_MOVE_FROZEN_MESSAGES
7698 if (deliver_freeze && move_frozen_messages)
7699 (void)spool_move_message(id, message_subdir, US"", US"F");
7703 /* Closing the data file frees the lock; if the file has been unlinked it
7704 will go away. Otherwise the message becomes available for another process
7707 (void)close(deliver_datafile);
7708 deliver_datafile = -1;
7709 DEBUG(D_deliver) debug_printf("end delivery of %s\n", id);
7711 /* It is unlikely that there will be any cached resources, since they are
7712 released after routing, and in the delivery subprocesses. However, it's
7713 possible for an expansion for something afterwards (for example,
7714 expand_check_condition) to do a lookup. We must therefore be sure everything is
7718 acl_where = ACL_WHERE_UNKNOWN;
7724 /* End of deliver.c */