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 static address_item *addr_dsntmp = NULL;
67 static address_item *addr_senddsn = NULL;
69 static FILE *message_log = NULL;
70 static BOOL update_spool;
71 static BOOL remove_journal;
72 static int parcount = 0;
73 static pardata *parlist = NULL;
74 static int return_count;
75 static uschar *frozen_info = US"";
76 static uschar *used_return_path = NULL;
78 static uschar spoolname[PATH_MAX];
82 /*************************************************
83 * Make a new address item *
84 *************************************************/
86 /* This function gets the store and initializes with default values. The
87 transport_return value defaults to DEFER, so that any unexpected failure to
88 deliver does not wipe out the message. The default unique string is set to a
89 copy of the address, so that its domain can be lowercased.
92 address the RFC822 address string
93 copy force a copy of the address
95 Returns: a pointer to an initialized address_item
99 deliver_make_addr(uschar *address, BOOL copy)
101 address_item *addr = store_get(sizeof(address_item));
102 *addr = address_defaults;
103 if (copy) address = string_copy(address);
104 addr->address = address;
105 addr->unique = string_copy(address);
112 /*************************************************
113 * Set expansion values for an address *
114 *************************************************/
116 /* Certain expansion variables are valid only when handling an address or
117 address list. This function sets them up or clears the values, according to its
121 addr the address in question, or NULL to clear values
126 deliver_set_expansions(address_item *addr)
130 uschar ***p = address_expansions;
131 while (*p != NULL) **p++ = NULL;
135 /* Exactly what gets set depends on whether there is one or more addresses, and
136 what they contain. These first ones are always set, taking their values from
137 the first address. */
139 if (addr->host_list == NULL)
141 deliver_host = deliver_host_address = US"";
142 deliver_host_port = 0;
146 deliver_host = addr->host_list->name;
147 deliver_host_address = addr->host_list->address;
148 deliver_host_port = addr->host_list->port;
151 deliver_recipients = addr;
152 deliver_address_data = addr->p.address_data;
153 deliver_domain_data = addr->p.domain_data;
154 deliver_localpart_data = addr->p.localpart_data;
156 /* These may be unset for multiple addresses */
158 deliver_domain = addr->domain;
159 self_hostname = addr->self_hostname;
161 #ifdef EXPERIMENTAL_BRIGHTMAIL
162 bmi_deliver = 1; /* deliver by default */
163 bmi_alt_location = NULL;
164 bmi_base64_verdict = NULL;
165 bmi_base64_tracker_verdict = NULL;
168 /* If there's only one address we can set everything. */
170 if (addr->next == NULL)
172 address_item *addr_orig;
174 deliver_localpart = addr->local_part;
175 deliver_localpart_prefix = addr->prefix;
176 deliver_localpart_suffix = addr->suffix;
178 for (addr_orig = addr; addr_orig->parent != NULL;
179 addr_orig = addr_orig->parent);
180 deliver_domain_orig = addr_orig->domain;
182 /* Re-instate any prefix and suffix in the original local part. In all
183 normal cases, the address will have a router associated with it, and we can
184 choose the caseful or caseless version accordingly. However, when a system
185 filter sets up a pipe, file, or autoreply delivery, no router is involved.
186 In this case, though, there won't be any prefix or suffix to worry about. */
188 deliver_localpart_orig = (addr_orig->router == NULL)? addr_orig->local_part :
189 addr_orig->router->caseful_local_part?
190 addr_orig->cc_local_part : addr_orig->lc_local_part;
192 /* If there's a parent, make its domain and local part available, and if
193 delivering to a pipe or file, or sending an autoreply, get the local
194 part from the parent. For pipes and files, put the pipe or file string
195 into address_pipe and address_file. */
197 if (addr->parent != NULL)
199 deliver_domain_parent = addr->parent->domain;
200 deliver_localpart_parent = (addr->parent->router == NULL)?
201 addr->parent->local_part :
202 addr->parent->router->caseful_local_part?
203 addr->parent->cc_local_part : addr->parent->lc_local_part;
205 /* File deliveries have their own flag because they need to be picked out
206 as special more often. */
208 if (testflag(addr, af_pfr))
210 if (testflag(addr, af_file)) address_file = addr->local_part;
211 else if (deliver_localpart[0] == '|') address_pipe = addr->local_part;
212 deliver_localpart = addr->parent->local_part;
213 deliver_localpart_prefix = addr->parent->prefix;
214 deliver_localpart_suffix = addr->parent->suffix;
218 #ifdef EXPERIMENTAL_BRIGHTMAIL
219 /* Set expansion variables related to Brightmail AntiSpam */
220 bmi_base64_verdict = bmi_get_base64_verdict(deliver_localpart_orig, deliver_domain_orig);
221 bmi_base64_tracker_verdict = bmi_get_base64_tracker_verdict(bmi_base64_verdict);
222 /* get message delivery status (0 - don't deliver | 1 - deliver) */
223 bmi_deliver = bmi_get_delivery_status(bmi_base64_verdict);
224 /* if message is to be delivered, get eventual alternate location */
225 if (bmi_deliver == 1) {
226 bmi_alt_location = bmi_get_alt_location(bmi_base64_verdict);
232 /* For multiple addresses, don't set local part, and leave the domain and
233 self_hostname set only if it is the same for all of them. It is possible to
234 have multiple pipe and file addresses, but only when all addresses have routed
235 to the same pipe or file. */
240 if (testflag(addr, af_pfr))
242 if (testflag(addr, af_file)) address_file = addr->local_part;
243 else if (addr->local_part[0] == '|') address_pipe = addr->local_part;
245 for (addr2 = addr->next; addr2 != NULL; addr2 = addr2->next)
247 if (deliver_domain != NULL &&
248 Ustrcmp(deliver_domain, addr2->domain) != 0)
249 deliver_domain = NULL;
250 if (self_hostname != NULL && (addr2->self_hostname == NULL ||
251 Ustrcmp(self_hostname, addr2->self_hostname) != 0))
252 self_hostname = NULL;
253 if (deliver_domain == NULL && self_hostname == NULL) break;
261 /*************************************************
262 * Open a msglog file *
263 *************************************************/
265 /* This function is used both for normal message logs, and for files in the
266 msglog directory that are used to catch output from pipes. Try to create the
267 directory if it does not exist. From release 4.21, normal message logs should
268 be created when the message is received.
271 filename the file name
272 mode the mode required
273 error used for saying what failed
275 Returns: a file descriptor, or -1 (with errno set)
279 open_msglog_file(uschar *filename, int mode, uschar **error)
281 int fd = Uopen(filename, O_WRONLY|O_APPEND|O_CREAT, mode);
283 if (fd < 0 && errno == ENOENT)
286 sprintf(CS temp, "msglog/%s", message_subdir);
287 if (message_subdir[0] == 0) temp[6] = 0;
288 (void)directory_make(spool_directory, temp, MSGLOG_DIRECTORY_MODE, TRUE);
289 fd = Uopen(filename, O_WRONLY|O_APPEND|O_CREAT, mode);
292 /* Set the close-on-exec flag and change the owner to the exim uid/gid (this
293 function is called as root). Double check the mode, because the group setting
294 doesn't always get set automatically. */
298 (void)fcntl(fd, F_SETFD, fcntl(fd, F_GETFD) | FD_CLOEXEC);
299 if (fchown(fd, exim_uid, exim_gid) < 0)
304 if (fchmod(fd, mode) < 0)
310 else *error = US"create";
318 /*************************************************
319 * Write to msglog if required *
320 *************************************************/
322 /* Write to the message log, if configured. This function may also be called
326 format a string format
332 deliver_msglog(const char *format, ...)
335 if (!message_logs) return;
336 va_start(ap, format);
337 vfprintf(message_log, format, ap);
345 /*************************************************
346 * Replicate status for batch *
347 *************************************************/
349 /* When a transport handles a batch of addresses, it may treat them
350 individually, or it may just put the status in the first one, and return FALSE,
351 requesting that the status be copied to all the others externally. This is the
352 replication function. As well as the status, it copies the transport pointer,
353 which may have changed if appendfile passed the addresses on to a different
356 Argument: pointer to the first address in a chain
361 replicate_status(address_item *addr)
364 for (addr2 = addr->next; addr2 != NULL; addr2 = addr2->next)
366 addr2->transport = addr->transport;
367 addr2->transport_return = addr->transport_return;
368 addr2->basic_errno = addr->basic_errno;
369 addr2->more_errno = addr->more_errno;
370 addr2->special_action = addr->special_action;
371 addr2->message = addr->message;
372 addr2->user_message = addr->user_message;
378 /*************************************************
379 * Compare lists of hosts *
380 *************************************************/
382 /* This function is given two pointers to chains of host items, and it yields
383 TRUE if the lists refer to the same hosts in the same order, except that
385 (1) Multiple hosts with the same non-negative MX values are permitted to appear
386 in different orders. Round-robinning nameservers can cause this to happen.
388 (2) Multiple hosts with the same negative MX values less than MX_NONE are also
389 permitted to appear in different orders. This is caused by randomizing
392 This enables Exim to use a single SMTP transaction for sending to two entirely
393 different domains that happen to end up pointing at the same hosts.
396 one points to the first host list
397 two points to the second host list
399 Returns: TRUE if the lists refer to the same host set
403 same_hosts(host_item *one, host_item *two)
405 while (one != NULL && two != NULL)
407 if (Ustrcmp(one->name, two->name) != 0)
410 host_item *end_one = one;
411 host_item *end_two = two;
413 /* Batch up only if there was no MX and the list was not randomized */
415 if (mx == MX_NONE) return FALSE;
417 /* Find the ends of the shortest sequence of identical MX values */
419 while (end_one->next != NULL && end_one->next->mx == mx &&
420 end_two->next != NULL && end_two->next->mx == mx)
422 end_one = end_one->next;
423 end_two = end_two->next;
426 /* If there aren't any duplicates, there's no match. */
428 if (end_one == one) return FALSE;
430 /* For each host in the 'one' sequence, check that it appears in the 'two'
431 sequence, returning FALSE if not. */
436 for (hi = two; hi != end_two->next; hi = hi->next)
437 if (Ustrcmp(one->name, hi->name) == 0) break;
438 if (hi == end_two->next) return FALSE;
439 if (one == end_one) break;
443 /* All the hosts in the 'one' sequence were found in the 'two' sequence.
444 Ensure both are pointing at the last host, and carry on as for equality. */
455 /* True if both are NULL */
462 /*************************************************
463 * Compare header lines *
464 *************************************************/
466 /* This function is given two pointers to chains of header items, and it yields
467 TRUE if they are the same header texts in the same order.
470 one points to the first header list
471 two points to the second header list
473 Returns: TRUE if the lists refer to the same header set
477 same_headers(header_line *one, header_line *two)
481 if (one == two) return TRUE; /* Includes the case where both NULL */
482 if (one == NULL || two == NULL) return FALSE;
483 if (Ustrcmp(one->text, two->text) != 0) return FALSE;
491 /*************************************************
492 * Compare string settings *
493 *************************************************/
495 /* This function is given two pointers to strings, and it returns
496 TRUE if they are the same pointer, or if the two strings are the same.
499 one points to the first string
500 two points to the second string
502 Returns: TRUE or FALSE
506 same_strings(uschar *one, uschar *two)
508 if (one == two) return TRUE; /* Includes the case where both NULL */
509 if (one == NULL || two == NULL) return FALSE;
510 return (Ustrcmp(one, two) == 0);
515 /*************************************************
516 * Compare uid/gid for addresses *
517 *************************************************/
519 /* This function is given a transport and two addresses. It yields TRUE if the
520 uid/gid/initgroups settings for the two addresses are going to be the same when
525 addr1 the first address
526 addr2 the second address
528 Returns: TRUE or FALSE
532 same_ugid(transport_instance *tp, address_item *addr1, address_item *addr2)
534 if (!tp->uid_set && tp->expand_uid == NULL && !tp->deliver_as_creator)
536 if (testflag(addr1, af_uid_set) != testflag(addr2, af_gid_set) ||
537 (testflag(addr1, af_uid_set) &&
538 (addr1->uid != addr2->uid ||
539 testflag(addr1, af_initgroups) != testflag(addr2, af_initgroups))))
543 if (!tp->gid_set && tp->expand_gid == NULL)
545 if (testflag(addr1, af_gid_set) != testflag(addr2, af_gid_set) ||
546 (testflag(addr1, af_gid_set) && addr1->gid != addr2->gid))
556 /*************************************************
557 * Record that an address is complete *
558 *************************************************/
560 /* This function records that an address is complete. This is straightforward
561 for most addresses, where the unique address is just the full address with the
562 domain lower cased. For homonyms (addresses that are the same as one of their
563 ancestors) their are complications. Their unique addresses have \x\ prepended
564 (where x = 0, 1, 2...), so that de-duplication works correctly for siblings and
567 Exim used to record the unique addresses of homonyms as "complete". This,
568 however, fails when the pattern of redirection varies over time (e.g. if taking
569 unseen copies at only some times of day) because the prepended numbers may vary
570 from one delivery run to the next. This problem is solved by never recording
571 prepended unique addresses as complete. Instead, when a homonymic address has
572 actually been delivered via a transport, we record its basic unique address
573 followed by the name of the transport. This is checked in subsequent delivery
574 runs whenever an address is routed to a transport.
576 If the completed address is a top-level one (has no parent, which means it
577 cannot be homonymic) we also add the original address to the non-recipients
578 tree, so that it gets recorded in the spool file and therefore appears as
579 "done" in any spool listings. The original address may differ from the unique
580 address in the case of the domain.
582 Finally, this function scans the list of duplicates, marks as done any that
583 match this address, and calls child_done() for their ancestors.
586 addr address item that has been completed
587 now current time as a string
593 address_done(address_item *addr, uschar *now)
597 update_spool = TRUE; /* Ensure spool gets updated */
599 /* Top-level address */
601 if (addr->parent == NULL)
603 tree_add_nonrecipient(addr->unique);
604 tree_add_nonrecipient(addr->address);
607 /* Homonymous child address */
609 else if (testflag(addr, af_homonym))
611 if (addr->transport != NULL)
613 tree_add_nonrecipient(
614 string_sprintf("%s/%s", addr->unique + 3, addr->transport->name));
618 /* Non-homonymous child address */
620 else tree_add_nonrecipient(addr->unique);
622 /* Check the list of duplicate addresses and ensure they are now marked
625 for (dup = addr_duplicate; dup != NULL; dup = dup->next)
627 if (Ustrcmp(addr->unique, dup->unique) == 0)
629 tree_add_nonrecipient(dup->unique);
630 child_done(dup, now);
638 /*************************************************
639 * Decrease counts in parents and mark done *
640 *************************************************/
642 /* This function is called when an address is complete. If there is a parent
643 address, its count of children is decremented. If there are still other
644 children outstanding, the function exits. Otherwise, if the count has become
645 zero, address_done() is called to mark the parent and its duplicates complete.
646 Then loop for any earlier ancestors.
649 addr points to the completed address item
650 now the current time as a string, for writing to the message log
656 child_done(address_item *addr, uschar *now)
659 while (addr->parent != NULL)
662 if ((addr->child_count -= 1) > 0) return; /* Incomplete parent */
663 address_done(addr, now);
665 /* Log the completion of all descendents only when there is no ancestor with
666 the same original address. */
668 for (aa = addr->parent; aa != NULL; aa = aa->parent)
669 if (Ustrcmp(aa->address, addr->address) == 0) break;
670 if (aa != NULL) continue;
672 deliver_msglog("%s %s: children all complete\n", now, addr->address);
673 DEBUG(D_deliver) debug_printf("%s: children all complete\n", addr->address);
681 d_hostlog(uschar * s, int * sizep, int * ptrp, address_item * addr)
683 s = string_append(s, sizep, ptrp, 5, US" H=", addr->host_used->name,
684 US" [", addr->host_used->address, US"]");
685 if ((log_extra_selector & LX_outgoing_port) != 0)
686 s = string_append(s, sizep, ptrp, 2, US":", string_sprintf("%d",
687 addr->host_used->port));
693 d_tlslog(uschar * s, int * sizep, int * ptrp, address_item * addr)
695 if ((log_extra_selector & LX_tls_cipher) != 0 && addr->cipher != NULL)
696 s = string_append(s, sizep, ptrp, 2, US" X=", addr->cipher);
697 if ((log_extra_selector & LX_tls_certificate_verified) != 0 &&
698 addr->cipher != NULL)
699 s = string_append(s, sizep, ptrp, 2, US" CV=",
700 testflag(addr, af_cert_verified)
702 #ifdef EXPERIMENTAL_DANE
703 testflag(addr, af_dane_verified)
709 if ((log_extra_selector & LX_tls_peerdn) != 0 && addr->peerdn != NULL)
710 s = string_append(s, sizep, ptrp, 3, US" DN=\"",
711 string_printing(addr->peerdn), US"\"");
719 #ifdef EXPERIMENTAL_EVENT
721 event_raise(uschar * action, uschar * event, uschar * ev_data)
727 debug_printf("Event(%s): event_action=|%s| delivery_IP=%s\n",
729 action, deliver_host_address);
732 event_data = ev_data;
734 if (!(s = expand_string(action)) && *expand_string_message)
735 log_write(0, LOG_MAIN|LOG_PANIC,
736 "failed to expand event_action %s in %s: %s\n",
737 event, transport_name, expand_string_message);
739 event_name = event_data = NULL;
741 /* If the expansion returns anything but an empty string, flag for
742 the caller to modify his normal processing
747 debug_printf("Event(%s): event_action returned \"%s\"\n", event, s);
755 msg_event_raise(uschar * event, address_item * addr)
757 uschar * save_domain = deliver_domain;
758 uschar * save_local = deliver_localpart;
759 uschar * save_host = deliver_host;
761 if (!addr->transport)
764 router_name = addr->router ? addr->router->name : NULL;
765 transport_name = addr->transport->name;
766 deliver_domain = addr->domain;
767 deliver_localpart = addr->local_part;
768 deliver_host = addr->host_used ? addr->host_used->name : NULL;
770 (void) event_raise(addr->transport->event_action, event,
771 addr->host_used || Ustrcmp(addr->transport->driver_name, "lmtp") == 0
772 ? addr->message : NULL);
774 deliver_host = save_host;
775 deliver_localpart = save_local;
776 deliver_domain = save_domain;
777 router_name = transport_name = NULL;
779 #endif /*EXPERIMENTAL_EVENT*/
783 /* If msg is NULL this is a delivery log and logchar is used. Otherwise
784 this is a nonstandard call; no two-character delivery flag is written
785 but sender-host and sender are prefixed and "msg" is inserted in the log line.
788 flags passed to log_write()
791 delivery_log(int flags, address_item * addr, int logchar, uschar * msg)
794 int size = 256; /* Used for a temporary, */
795 int ptr = 0; /* expanding buffer, for */
796 uschar *s; /* building log lines; */
797 void *reset_point; /* released afterwards. */
799 /* Log the delivery on the main log. We use an extensible string to build up
800 the log line, and reset the store afterwards. Remote deliveries should always
801 have a pointer to the host item that succeeded; local deliveries can have a
802 pointer to a single host item in their host list, for use by the transport. */
804 #ifdef EXPERIMENTAL_EVENT
805 /* presume no successful remote delivery */
806 lookup_dnssec_authenticated = NULL;
809 s = reset_point = store_get(size);
811 log_address = string_log_address(addr, (log_write_selector & L_all_parents) != 0, TRUE);
813 s = string_append(s, &size, &ptr, 3, host_and_ident(TRUE), US" ", log_address);
817 s = string_append(s, &size, &ptr, 2, US"> ", log_address);
820 if ((log_extra_selector & LX_sender_on_delivery) != 0 || msg)
821 s = string_append(s, &size, &ptr, 3, US" F=<", sender_address, US">");
823 #ifdef EXPERIMENTAL_SRS
824 if(addr->p.srs_sender)
825 s = string_append(s, &size, &ptr, 3, US" SRS=<", addr->p.srs_sender, US">");
828 /* You might think that the return path must always be set for a successful
829 delivery; indeed, I did for some time, until this statement crashed. The case
830 when it is not set is for a delivery to /dev/null which is optimised by not
833 if (used_return_path != NULL &&
834 (log_extra_selector & LX_return_path_on_delivery) != 0)
835 s = string_append(s, &size, &ptr, 3, US" P=<", used_return_path, US">");
838 s = string_append(s, &size, &ptr, 2, US" ", msg);
840 /* For a delivery from a system filter, there may not be a router */
841 if (addr->router != NULL)
842 s = string_append(s, &size, &ptr, 2, US" R=", addr->router->name);
844 s = string_append(s, &size, &ptr, 2, US" T=", addr->transport->name);
846 if ((log_extra_selector & LX_delivery_size) != 0)
847 s = string_append(s, &size, &ptr, 2, US" S=",
848 string_sprintf("%d", transport_count));
852 if (addr->transport->info->local)
855 s = string_append(s, &size, &ptr, 2, US" H=", addr->host_list->name);
856 if (addr->shadow_message != NULL)
857 s = string_cat(s, &size, &ptr, addr->shadow_message,
858 Ustrlen(addr->shadow_message));
861 /* Remote delivery */
867 s = d_hostlog(s, &size, &ptr, addr);
868 if (continue_sequence > 1)
869 s = string_cat(s, &size, &ptr, US"*", 1);
871 #ifdef EXPERIMENTAL_EVENT
872 deliver_host_address = addr->host_used->address;
873 deliver_host_port = addr->host_used->port;
874 deliver_host = addr->host_used->name;
876 /* DNS lookup status */
877 lookup_dnssec_authenticated = addr->host_used->dnssec==DS_YES ? US"yes"
878 : addr->host_used->dnssec==DS_NO ? US"no"
884 s = d_tlslog(s, &size, &ptr, addr);
887 if (addr->authenticator)
889 s = string_append(s, &size, &ptr, 2, US" A=", addr->authenticator);
892 s = string_append(s, &size, &ptr, 2, US":", addr->auth_id);
893 if (log_extra_selector & LX_smtp_mailauth && addr->auth_sndr)
894 s = string_append(s, &size, &ptr, 2, US":", addr->auth_sndr);
899 if (addr->flags & af_prdr_used)
900 s = string_append(s, &size, &ptr, 1, US" PRDR");
904 /* confirmation message (SMTP (host_used) and LMTP (driver_name)) */
906 if (log_extra_selector & LX_smtp_confirmation &&
908 (addr->host_used || Ustrcmp(addr->transport->driver_name, "lmtp") == 0))
911 uschar *p = big_buffer;
912 uschar *ss = addr->message;
914 for (i = 0; i < 256 && ss[i] != 0; i++) /* limit logged amount */
916 if (ss[i] == '\"' || ss[i] == '\\') *p++ = '\\'; /* quote \ and " */
921 s = string_append(s, &size, &ptr, 2, US" C=", big_buffer);
924 /* Time on queue and actual time taken to deliver */
926 if ((log_extra_selector & LX_queue_time) != 0)
927 s = string_append(s, &size, &ptr, 2, US" QT=",
928 readconf_printtime( (int) ((long)time(NULL) - (long)received_time)) );
930 if ((log_extra_selector & LX_deliver_time) != 0)
931 s = string_append(s, &size, &ptr, 2, US" DT=",
932 readconf_printtime(addr->more_errno));
934 /* string_cat() always leaves room for the terminator. Release the
935 store we used to build the line after writing it. */
938 log_write(0, flags, "%s", s);
940 #ifdef EXPERIMENTAL_EVENT
941 if (!msg) msg_event_raise(US"msg:delivery", addr);
944 store_reset(reset_point);
950 /*************************************************
951 * Actions at the end of handling an address *
952 *************************************************/
954 /* This is a function for processing a single address when all that can be done
955 with it has been done.
958 addr points to the address block
959 result the result of the delivery attempt
960 logflags flags for log_write() (LOG_MAIN and/or LOG_PANIC)
961 driver_type indicates which type of driver (transport, or router) was last
962 to process the address
963 logchar '=' or '-' for use when logging deliveries with => or ->
969 post_process_one(address_item *addr, int result, int logflags, int driver_type,
972 uschar *now = tod_stamp(tod_log);
973 uschar *driver_kind = NULL;
974 uschar *driver_name = NULL;
977 int size = 256; /* Used for a temporary, */
978 int ptr = 0; /* expanding buffer, for */
979 uschar *s; /* building log lines; */
980 void *reset_point; /* released afterwards. */
982 DEBUG(D_deliver) debug_printf("post-process %s (%d)\n", addr->address, result);
984 /* Set up driver kind and name for logging. Disable logging if the router or
985 transport has disabled it. */
987 if (driver_type == DTYPE_TRANSPORT)
989 if (addr->transport != NULL)
991 driver_name = addr->transport->name;
992 driver_kind = US" transport";
993 disable_logging = addr->transport->disable_logging;
995 else driver_kind = US"transporting";
997 else if (driver_type == DTYPE_ROUTER)
999 if (addr->router != NULL)
1001 driver_name = addr->router->name;
1002 driver_kind = US" router";
1003 disable_logging = addr->router->disable_logging;
1005 else driver_kind = US"routing";
1008 /* If there's an error message set, ensure that it contains only printing
1009 characters - it should, but occasionally things slip in and this at least
1010 stops the log format from getting wrecked. We also scan the message for an LDAP
1011 expansion item that has a password setting, and flatten the password. This is a
1012 fudge, but I don't know a cleaner way of doing this. (If the item is badly
1013 malformed, it won't ever have gone near LDAP.) */
1015 if (addr->message != NULL)
1017 addr->message = string_printing(addr->message);
1018 if (((Ustrstr(addr->message, "failed to expand") != NULL) || (Ustrstr(addr->message, "expansion of ") != NULL)) &&
1019 (Ustrstr(addr->message, "mysql") != NULL ||
1020 Ustrstr(addr->message, "pgsql") != NULL ||
1021 #ifdef EXPERIMENTAL_REDIS
1022 Ustrstr(addr->message, "redis") != NULL ||
1024 Ustrstr(addr->message, "sqlite") != NULL ||
1025 Ustrstr(addr->message, "ldap:") != NULL ||
1026 Ustrstr(addr->message, "ldapdn:") != NULL ||
1027 Ustrstr(addr->message, "ldapm:") != NULL))
1029 addr->message = string_sprintf("Temporary internal error");
1033 /* If we used a transport that has one of the "return_output" options set, and
1034 if it did in fact generate some output, then for return_output we treat the
1035 message as failed if it was not already set that way, so that the output gets
1036 returned to the sender, provided there is a sender to send it to. For
1037 return_fail_output, do this only if the delivery failed. Otherwise we just
1038 unlink the file, and remove the name so that if the delivery failed, we don't
1039 try to send back an empty or unwanted file. The log_output options operate only
1040 on a non-empty file.
1042 In any case, we close the message file, because we cannot afford to leave a
1043 file-descriptor for one address while processing (maybe very many) others. */
1045 if (addr->return_file >= 0 && addr->return_filename != NULL)
1047 BOOL return_output = FALSE;
1048 struct stat statbuf;
1049 (void)EXIMfsync(addr->return_file);
1051 /* If there is no output, do nothing. */
1053 if (fstat(addr->return_file, &statbuf) == 0 && statbuf.st_size > 0)
1055 transport_instance *tb = addr->transport;
1057 /* Handle logging options */
1059 if (tb->log_output || (result == FAIL && tb->log_fail_output) ||
1060 (result == DEFER && tb->log_defer_output))
1063 FILE *f = Ufopen(addr->return_filename, "rb");
1065 log_write(0, LOG_MAIN|LOG_PANIC, "failed to open %s to log output "
1066 "from %s transport: %s", addr->return_filename, tb->name,
1070 s = US Ufgets(big_buffer, big_buffer_size, f);
1073 uschar *p = big_buffer + Ustrlen(big_buffer);
1074 while (p > big_buffer && isspace(p[-1])) p--;
1076 s = string_printing(big_buffer);
1077 log_write(0, LOG_MAIN, "<%s>: %s transport output: %s",
1078 addr->address, tb->name, s);
1084 /* Handle returning options, but only if there is an address to return
1087 if (sender_address[0] != 0 || addr->p.errors_address != NULL)
1089 if (tb->return_output)
1091 addr->transport_return = result = FAIL;
1092 if (addr->basic_errno == 0 && addr->message == NULL)
1093 addr->message = US"return message generated";
1094 return_output = TRUE;
1097 if (tb->return_fail_output && result == FAIL) return_output = TRUE;
1101 /* Get rid of the file unless it might be returned, but close it in
1106 Uunlink(addr->return_filename);
1107 addr->return_filename = NULL;
1108 addr->return_file = -1;
1111 (void)close(addr->return_file);
1114 /* The success case happens only after delivery by a transport. */
1118 addr->next = addr_succeed;
1119 addr_succeed = addr;
1121 /* Call address_done() to ensure that we don't deliver to this address again,
1122 and write appropriate things to the message log. If it is a child address, we
1123 call child_done() to scan the ancestors and mark them complete if this is the
1124 last child to complete. */
1126 address_done(addr, now);
1127 DEBUG(D_deliver) debug_printf("%s delivered\n", addr->address);
1129 if (addr->parent == NULL)
1130 deliver_msglog("%s %s: %s%s succeeded\n", now, addr->address,
1131 driver_name, driver_kind);
1134 deliver_msglog("%s %s <%s>: %s%s succeeded\n", now, addr->address,
1135 addr->parent->address, driver_name, driver_kind);
1136 child_done(addr, now);
1139 /* Certificates for logging (via events) */
1141 tls_out.ourcert = addr->ourcert;
1142 addr->ourcert = NULL;
1143 tls_out.peercert = addr->peercert;
1144 addr->peercert = NULL;
1146 tls_out.cipher = addr->cipher;
1147 tls_out.peerdn = addr->peerdn;
1148 tls_out.ocsp = addr->ocsp;
1149 # ifdef EXPERIMENTAL_DANE
1150 tls_out.dane_verified = testflag(addr, af_dane_verified);
1154 delivery_log(LOG_MAIN, addr, logchar, NULL);
1157 if (tls_out.ourcert)
1159 tls_free_cert(tls_out.ourcert);
1160 tls_out.ourcert = NULL;
1162 if (tls_out.peercert)
1164 tls_free_cert(tls_out.peercert);
1165 tls_out.peercert = NULL;
1167 tls_out.cipher = NULL;
1168 tls_out.peerdn = NULL;
1169 tls_out.ocsp = OCSP_NOT_REQ;
1170 # ifdef EXPERIMENTAL_DANE
1171 tls_out.dane_verified = FALSE;
1177 /* Soft failure, or local delivery process failed; freezing may be
1180 else if (result == DEFER || result == PANIC)
1182 if (result == PANIC) logflags |= LOG_PANIC;
1184 /* This puts them on the chain in reverse order. Do not change this, because
1185 the code for handling retries assumes that the one with the retry
1186 information is last. */
1188 addr->next = addr_defer;
1191 /* The only currently implemented special action is to freeze the
1192 message. Logging of this is done later, just before the -H file is
1195 if (addr->special_action == SPECIAL_FREEZE)
1197 deliver_freeze = TRUE;
1198 deliver_frozen_at = time(NULL);
1199 update_spool = TRUE;
1202 /* If doing a 2-stage queue run, we skip writing to either the message
1203 log or the main log for SMTP defers. */
1205 if (!queue_2stage || addr->basic_errno != 0)
1209 /* For errors of the type "retry time not reached" (also remotes skipped
1210 on queue run), logging is controlled by L_retry_defer. Note that this kind
1211 of error number is negative, and all the retry ones are less than any
1214 unsigned int use_log_selector = (addr->basic_errno <= ERRNO_RETRY_BASE)?
1217 /* Build up the line that is used for both the message log and the main
1220 s = reset_point = store_get(size);
1222 /* Create the address string for logging. Must not do this earlier, because
1223 an OK result may be changed to FAIL when a pipe returns text. */
1225 log_address = string_log_address(addr,
1226 (log_write_selector & L_all_parents) != 0, result == OK);
1228 s = string_cat(s, &size, &ptr, log_address, Ustrlen(log_address));
1230 /* Either driver_name contains something and driver_kind contains
1231 " router" or " transport" (note the leading space), or driver_name is
1232 a null string and driver_kind contains "routing" without the leading
1233 space, if all routing has been deferred. When a domain has been held,
1234 so nothing has been done at all, both variables contain null strings. */
1236 if (driver_name == NULL)
1238 if (driver_kind != NULL)
1239 s = string_append(s, &size, &ptr, 2, US" ", driver_kind);
1243 if (driver_kind[1] == 't' && addr->router != NULL)
1244 s = string_append(s, &size, &ptr, 2, US" R=", addr->router->name);
1246 ss[1] = toupper(driver_kind[1]);
1247 s = string_append(s, &size, &ptr, 2, ss, driver_name);
1250 sprintf(CS ss, " defer (%d)", addr->basic_errno);
1251 s = string_cat(s, &size, &ptr, ss, Ustrlen(ss));
1253 if (addr->basic_errno > 0)
1254 s = string_append(s, &size, &ptr, 2, US": ",
1255 US strerror(addr->basic_errno));
1257 if (addr->host_used)
1258 s = string_append(s, &size, &ptr, 5,
1259 US" H=", addr->host_used->name,
1260 US" [", addr->host_used->address, US"]");
1262 if (addr->message != NULL)
1263 s = string_append(s, &size, &ptr, 2, US": ", addr->message);
1267 /* Log the deferment in the message log, but don't clutter it
1268 up with retry-time defers after the first delivery attempt. */
1270 if (deliver_firsttime || addr->basic_errno > ERRNO_RETRY_BASE)
1271 deliver_msglog("%s %s\n", now, s);
1273 /* Write the main log and reset the store */
1275 log_write(use_log_selector, logflags, "== %s", s);
1276 store_reset(reset_point);
1281 /* Hard failure. If there is an address to which an error message can be sent,
1282 put this address on the failed list. If not, put it on the deferred list and
1283 freeze the mail message for human attention. The latter action can also be
1284 explicitly requested by a router or transport. */
1288 /* If this is a delivery error, or a message for which no replies are
1289 wanted, and the message's age is greater than ignore_bounce_errors_after,
1290 force the af_ignore_error flag. This will cause the address to be discarded
1291 later (with a log entry). */
1293 if (sender_address[0] == 0 && message_age >= ignore_bounce_errors_after)
1294 setflag(addr, af_ignore_error);
1296 /* Freeze the message if requested, or if this is a bounce message (or other
1297 message with null sender) and this address does not have its own errors
1298 address. However, don't freeze if errors are being ignored. The actual code
1299 to ignore occurs later, instead of sending a message. Logging of freezing
1300 occurs later, just before writing the -H file. */
1302 if (!testflag(addr, af_ignore_error) &&
1303 (addr->special_action == SPECIAL_FREEZE ||
1304 (sender_address[0] == 0 && addr->p.errors_address == NULL)
1307 frozen_info = (addr->special_action == SPECIAL_FREEZE)? US"" :
1308 (sender_local && !local_error_message)?
1309 US" (message created with -f <>)" : US" (delivery error message)";
1310 deliver_freeze = TRUE;
1311 deliver_frozen_at = time(NULL);
1312 update_spool = TRUE;
1314 /* The address is put on the defer rather than the failed queue, because
1315 the message is being retained. */
1317 addr->next = addr_defer;
1321 /* Don't put the address on the nonrecipients tree yet; wait until an
1322 error message has been successfully sent. */
1326 addr->next = addr_failed;
1330 /* Build up the log line for the message and main logs */
1332 s = reset_point = store_get(size);
1334 /* Create the address string for logging. Must not do this earlier, because
1335 an OK result may be changed to FAIL when a pipe returns text. */
1337 log_address = string_log_address(addr,
1338 (log_write_selector & L_all_parents) != 0, result == OK);
1340 s = string_cat(s, &size, &ptr, log_address, Ustrlen(log_address));
1342 if ((log_extra_selector & LX_sender_on_delivery) != 0)
1343 s = string_append(s, &size, &ptr, 3, US" F=<", sender_address, US">");
1345 /* Return path may not be set if no delivery actually happened */
1347 if (used_return_path != NULL &&
1348 (log_extra_selector & LX_return_path_on_delivery) != 0)
1349 s = string_append(s, &size, &ptr, 3, US" P=<", used_return_path, US">");
1351 if (addr->router != NULL)
1352 s = string_append(s, &size, &ptr, 2, US" R=", addr->router->name);
1353 if (addr->transport != NULL)
1354 s = string_append(s, &size, &ptr, 2, US" T=", addr->transport->name);
1356 if (addr->host_used != NULL)
1357 s = d_hostlog(s, &size, &ptr, addr);
1360 s = d_tlslog(s, &size, &ptr, addr);
1363 if (addr->basic_errno > 0)
1364 s = string_append(s, &size, &ptr, 2, US": ",
1365 US strerror(addr->basic_errno));
1367 if (addr->message != NULL)
1368 s = string_append(s, &size, &ptr, 2, US": ", addr->message);
1372 /* Do the logging. For the message log, "routing failed" for those cases,
1373 just to make it clearer. */
1375 if (driver_name == NULL)
1376 deliver_msglog("%s %s failed for %s\n", now, driver_kind, s);
1378 deliver_msglog("%s %s\n", now, s);
1380 log_write(0, LOG_MAIN, "** %s", s);
1382 #ifdef EXPERIMENTAL_EVENT
1383 msg_event_raise(US"msg:fail:delivery", addr);
1386 store_reset(reset_point);
1389 /* Ensure logging is turned on again in all cases */
1391 disable_logging = FALSE;
1397 /*************************************************
1398 * Address-independent error *
1399 *************************************************/
1401 /* This function is called when there's an error that is not dependent on a
1402 particular address, such as an expansion string failure. It puts the error into
1403 all the addresses in a batch, logs the incident on the main and panic logs, and
1404 clears the expansions. It is mostly called from local_deliver(), but can be
1405 called for a remote delivery via findugid().
1408 logit TRUE if (MAIN+PANIC) logging required
1409 addr the first of the chain of addresses
1411 format format string for error message, or NULL if already set in addr
1412 ... arguments for the format
1418 common_error(BOOL logit, address_item *addr, int code, uschar *format, ...)
1420 address_item *addr2;
1421 addr->basic_errno = code;
1427 va_start(ap, format);
1428 if (!string_vformat(buffer, sizeof(buffer), CS format, ap))
1429 log_write(0, LOG_MAIN|LOG_PANIC_DIE,
1430 "common_error expansion was longer than " SIZE_T_FMT, sizeof(buffer));
1432 addr->message = string_copy(buffer);
1435 for (addr2 = addr->next; addr2 != NULL; addr2 = addr2->next)
1437 addr2->basic_errno = code;
1438 addr2->message = addr->message;
1441 if (logit) log_write(0, LOG_MAIN|LOG_PANIC, "%s", addr->message);
1442 deliver_set_expansions(NULL);
1448 /*************************************************
1449 * Check a "never users" list *
1450 *************************************************/
1452 /* This function is called to check whether a uid is on one of the two "never
1456 uid the uid to be checked
1457 nusers the list to be scanned; the first item in the list is the count
1459 Returns: TRUE if the uid is on the list
1463 check_never_users(uid_t uid, uid_t *nusers)
1466 if (nusers == NULL) return FALSE;
1467 for (i = 1; i <= (int)(nusers[0]); i++) if (nusers[i] == uid) return TRUE;
1473 /*************************************************
1474 * Find uid and gid for a transport *
1475 *************************************************/
1477 /* This function is called for both local and remote deliveries, to find the
1478 uid/gid under which to run the delivery. The values are taken preferentially
1479 from the transport (either explicit or deliver_as_creator), then from the
1480 address (i.e. the router), and if nothing is set, the exim uid/gid are used. If
1481 the resulting uid is on the "never_users" or the "fixed_never_users" list, a
1482 panic error is logged, and the function fails (which normally leads to delivery
1486 addr the address (possibly a chain)
1488 uidp pointer to uid field
1489 gidp pointer to gid field
1490 igfp pointer to the use_initgroups field
1492 Returns: FALSE if failed - error has been set in address(es)
1496 findugid(address_item *addr, transport_instance *tp, uid_t *uidp, gid_t *gidp,
1499 uschar *nuname = NULL;
1500 BOOL gid_set = FALSE;
1502 /* Default initgroups flag comes from the transport */
1504 *igfp = tp->initgroups;
1506 /* First see if there's a gid on the transport, either fixed or expandable.
1507 The expanding function always logs failure itself. */
1514 else if (tp->expand_gid != NULL)
1516 if (route_find_expanded_group(tp->expand_gid, tp->name, US"transport", gidp,
1517 &(addr->message))) gid_set = TRUE;
1520 common_error(FALSE, addr, ERRNO_GIDFAIL, NULL);
1525 /* If the transport did not set a group, see if the router did. */
1527 if (!gid_set && testflag(addr, af_gid_set))
1533 /* Pick up a uid from the transport if one is set. */
1535 if (tp->uid_set) *uidp = tp->uid;
1537 /* Otherwise, try for an expandable uid field. If it ends up as a numeric id,
1538 it does not provide a passwd value from which a gid can be taken. */
1540 else if (tp->expand_uid != NULL)
1543 if (!route_find_expanded_user(tp->expand_uid, tp->name, US"transport", &pw,
1544 uidp, &(addr->message)))
1546 common_error(FALSE, addr, ERRNO_UIDFAIL, NULL);
1549 if (!gid_set && pw != NULL)
1556 /* If the transport doesn't set the uid, test the deliver_as_creator flag. */
1558 else if (tp->deliver_as_creator)
1560 *uidp = originator_uid;
1563 *gidp = originator_gid;
1568 /* Otherwise see if the address specifies the uid and if so, take it and its
1571 else if (testflag(addr, af_uid_set))
1574 *igfp = testflag(addr, af_initgroups);
1577 /* Nothing has specified the uid - default to the Exim user, and group if the
1590 /* If no gid is set, it is a disaster. We default to the Exim gid only if
1591 defaulting to the Exim uid. In other words, if the configuration has specified
1592 a uid, it must also provide a gid. */
1596 common_error(TRUE, addr, ERRNO_GIDFAIL, US"User set without group for "
1597 "%s transport", tp->name);
1601 /* Check that the uid is not on the lists of banned uids that may not be used
1602 for delivery processes. */
1604 if (check_never_users(*uidp, never_users))
1605 nuname = US"never_users";
1606 else if (check_never_users(*uidp, fixed_never_users))
1607 nuname = US"fixed_never_users";
1611 common_error(TRUE, addr, ERRNO_UIDFAIL, US"User %ld set for %s transport "
1612 "is on the %s list", (long int)(*uidp), tp->name, nuname);
1624 /*************************************************
1625 * Check the size of a message for a transport *
1626 *************************************************/
1628 /* Checks that the message isn't too big for the selected transport.
1629 This is called only when it is known that the limit is set.
1633 addr the (first) address being delivered
1636 DEFER expansion failed or did not yield an integer
1637 FAIL message too big
1641 check_message_size(transport_instance *tp, address_item *addr)
1646 deliver_set_expansions(addr);
1647 size_limit = expand_string_integer(tp->message_size_limit, TRUE);
1648 deliver_set_expansions(NULL);
1650 if (expand_string_message != NULL)
1653 if (size_limit == -1)
1654 addr->message = string_sprintf("failed to expand message_size_limit "
1655 "in %s transport: %s", tp->name, expand_string_message);
1657 addr->message = string_sprintf("invalid message_size_limit "
1658 "in %s transport: %s", tp->name, expand_string_message);
1660 else if (size_limit > 0 && message_size > size_limit)
1664 string_sprintf("message is too big (transport limit = %d)",
1673 /*************************************************
1674 * Transport-time check for a previous delivery *
1675 *************************************************/
1677 /* Check that this base address hasn't previously been delivered to its routed
1678 transport. If it has been delivered, mark it done. The check is necessary at
1679 delivery time in order to handle homonymic addresses correctly in cases where
1680 the pattern of redirection changes between delivery attempts (so the unique
1681 fields change). Non-homonymic previous delivery is detected earlier, at routing
1682 time (which saves unnecessary routing).
1685 addr the address item
1686 testing TRUE if testing wanted only, without side effects
1688 Returns: TRUE if previously delivered by the transport
1692 previously_transported(address_item *addr, BOOL testing)
1694 (void)string_format(big_buffer, big_buffer_size, "%s/%s",
1695 addr->unique + (testflag(addr, af_homonym)? 3:0), addr->transport->name);
1697 if (tree_search(tree_nonrecipients, big_buffer) != 0)
1699 DEBUG(D_deliver|D_route|D_transport)
1700 debug_printf("%s was previously delivered (%s transport): discarded\n",
1701 addr->address, addr->transport->name);
1702 if (!testing) child_done(addr, tod_stamp(tod_log));
1711 /******************************************************
1712 * Check for a given header in a header string *
1713 ******************************************************/
1715 /* This function is used when generating quota warnings. The configuration may
1716 specify any header lines it likes in quota_warn_message. If certain of them are
1717 missing, defaults are inserted, so we need to be able to test for the presence
1721 hdr the required header name
1722 hstring the header string
1724 Returns: TRUE the header is in the string
1725 FALSE the header is not in the string
1729 contains_header(uschar *hdr, uschar *hstring)
1731 int len = Ustrlen(hdr);
1732 uschar *p = hstring;
1735 if (strncmpic(p, hdr, len) == 0)
1738 while (*p == ' ' || *p == '\t') p++;
1739 if (*p == ':') return TRUE;
1741 while (*p != 0 && *p != '\n') p++;
1742 if (*p == '\n') p++;
1750 /*************************************************
1751 * Perform a local delivery *
1752 *************************************************/
1754 /* Each local delivery is performed in a separate process which sets its
1755 uid and gid as specified. This is a safer way than simply changing and
1756 restoring using seteuid(); there is a body of opinion that seteuid() cannot be
1757 used safely. From release 4, Exim no longer makes any use of it. Besides, not
1758 all systems have seteuid().
1760 If the uid/gid are specified in the transport_instance, they are used; the
1761 transport initialization must ensure that either both or neither are set.
1762 Otherwise, the values associated with the address are used. If neither are set,
1763 it is a configuration error.
1765 The transport or the address may specify a home directory (transport over-
1766 rides), and if they do, this is set as $home. If neither have set a working
1767 directory, this value is used for that as well. Otherwise $home is left unset
1768 and the cwd is set to "/" - a directory that should be accessible to all users.
1770 Using a separate process makes it more complicated to get error information
1771 back. We use a pipe to pass the return code and also an error code and error
1772 text string back to the parent process.
1775 addr points to an address block for this delivery; for "normal" local
1776 deliveries this is the only address to be delivered, but for
1777 pseudo-remote deliveries (e.g. by batch SMTP to a file or pipe)
1778 a number of addresses can be handled simultaneously, and in this
1779 case addr will point to a chain of addresses with the same
1782 shadowing TRUE if running a shadow transport; this causes output from pipes
1789 deliver_local(address_item *addr, BOOL shadowing)
1791 BOOL use_initgroups;
1794 int status, len, rc;
1797 uschar *working_directory;
1798 address_item *addr2;
1799 transport_instance *tp = addr->transport;
1801 /* Set up the return path from the errors or sender address. If the transport
1802 has its own return path setting, expand it and replace the existing value. */
1804 if(addr->p.errors_address != NULL)
1805 return_path = addr->p.errors_address;
1806 #ifdef EXPERIMENTAL_SRS
1807 else if(addr->p.srs_sender != NULL)
1808 return_path = addr->p.srs_sender;
1811 return_path = sender_address;
1813 if (tp->return_path != NULL)
1815 uschar *new_return_path = expand_string(tp->return_path);
1816 if (new_return_path == NULL)
1818 if (!expand_string_forcedfail)
1820 common_error(TRUE, addr, ERRNO_EXPANDFAIL,
1821 US"Failed to expand return path \"%s\" in %s transport: %s",
1822 tp->return_path, tp->name, expand_string_message);
1826 else return_path = new_return_path;
1829 /* For local deliveries, one at a time, the value used for logging can just be
1830 set directly, once and for all. */
1832 used_return_path = return_path;
1834 /* Sort out the uid, gid, and initgroups flag. If an error occurs, the message
1835 gets put into the address(es), and the expansions are unset, so we can just
1838 if (!findugid(addr, tp, &uid, &gid, &use_initgroups)) return;
1840 /* See if either the transport or the address specifies a home directory. A
1841 home directory set in the address may already be expanded; a flag is set to
1842 indicate that. In other cases we must expand it. */
1844 if ((deliver_home = tp->home_dir) != NULL || /* Set in transport, or */
1845 ((deliver_home = addr->home_dir) != NULL && /* Set in address and */
1846 !testflag(addr, af_home_expanded))) /* not expanded */
1848 uschar *rawhome = deliver_home;
1849 deliver_home = NULL; /* in case it contains $home */
1850 deliver_home = expand_string(rawhome);
1851 if (deliver_home == NULL)
1853 common_error(TRUE, addr, ERRNO_EXPANDFAIL, US"home directory \"%s\" failed "
1854 "to expand for %s transport: %s", rawhome, tp->name,
1855 expand_string_message);
1858 if (*deliver_home != '/')
1860 common_error(TRUE, addr, ERRNO_NOTABSOLUTE, US"home directory path \"%s\" "
1861 "is not absolute for %s transport", deliver_home, tp->name);
1866 /* See if either the transport or the address specifies a current directory,
1867 and if so, expand it. If nothing is set, use the home directory, unless it is
1868 also unset in which case use "/", which is assumed to be a directory to which
1869 all users have access. It is necessary to be in a visible directory for some
1870 operating systems when running pipes, as some commands (e.g. "rm" under Solaris
1871 2.5) require this. */
1873 working_directory = (tp->current_dir != NULL)?
1874 tp->current_dir : addr->current_dir;
1876 if (working_directory != NULL)
1878 uschar *raw = working_directory;
1879 working_directory = expand_string(raw);
1880 if (working_directory == NULL)
1882 common_error(TRUE, addr, ERRNO_EXPANDFAIL, US"current directory \"%s\" "
1883 "failed to expand for %s transport: %s", raw, tp->name,
1884 expand_string_message);
1887 if (*working_directory != '/')
1889 common_error(TRUE, addr, ERRNO_NOTABSOLUTE, US"current directory path "
1890 "\"%s\" is not absolute for %s transport", working_directory, tp->name);
1894 else working_directory = (deliver_home == NULL)? US"/" : deliver_home;
1896 /* If one of the return_output flags is set on the transport, create and open a
1897 file in the message log directory for the transport to write its output onto.
1898 This is mainly used by pipe transports. The file needs to be unique to the
1899 address. This feature is not available for shadow transports. */
1901 if (!shadowing && (tp->return_output || tp->return_fail_output ||
1902 tp->log_output || tp->log_fail_output))
1905 addr->return_filename =
1906 string_sprintf("%s/msglog/%s/%s-%d-%d", spool_directory, message_subdir,
1907 message_id, getpid(), return_count++);
1908 addr->return_file = open_msglog_file(addr->return_filename, 0400, &error);
1909 if (addr->return_file < 0)
1911 common_error(TRUE, addr, errno, US"Unable to %s file for %s transport "
1912 "to return message: %s", error, tp->name, strerror(errno));
1917 /* Create the pipe for inter-process communication. */
1921 common_error(TRUE, addr, ERRNO_PIPEFAIL, US"Creation of pipe failed: %s",
1926 /* Now fork the process to do the real work in the subprocess, but first
1927 ensure that all cached resources are freed so that the subprocess starts with
1928 a clean slate and doesn't interfere with the parent process. */
1932 if ((pid = fork()) == 0)
1934 BOOL replicate = TRUE;
1936 /* Prevent core dumps, as we don't want them in users' home directories.
1937 HP-UX doesn't have RLIMIT_CORE; I don't know how to do this in that
1938 system. Some experimental/developing systems (e.g. GNU/Hurd) may define
1939 RLIMIT_CORE but not support it in setrlimit(). For such systems, do not
1940 complain if the error is "not supported".
1942 There are two scenarios where changing the max limit has an effect. In one,
1943 the user is using a .forward and invoking a command of their choice via pipe;
1944 for these, we do need the max limit to be 0 unless the admin chooses to
1945 permit an increased limit. In the other, the command is invoked directly by
1946 the transport and is under administrator control, thus being able to raise
1947 the limit aids in debugging. So there's no general always-right answer.
1949 Thus we inhibit core-dumps completely but let individual transports, while
1950 still root, re-raise the limits back up to aid debugging. We make the
1951 default be no core-dumps -- few enough people can use core dumps in
1952 diagnosis that it's reasonable to make them something that has to be explicitly requested.
1959 if (setrlimit(RLIMIT_CORE, &rl) < 0)
1961 # ifdef SETRLIMIT_NOT_SUPPORTED
1962 if (errno != ENOSYS && errno != ENOTSUP)
1964 log_write(0, LOG_MAIN|LOG_PANIC, "setrlimit(RLIMIT_CORE) failed: %s",
1969 /* Reset the random number generator, so different processes don't all
1970 have the same sequence. */
1974 /* If the transport has a setup entry, call this first, while still
1975 privileged. (Appendfile uses this to expand quota, for example, while
1976 able to read private files.) */
1978 if (addr->transport->setup != NULL)
1980 switch((addr->transport->setup)(addr->transport, addr, NULL, uid, gid,
1984 addr->transport_return = DEFER;
1988 addr->transport_return = PANIC;
1993 /* Ignore SIGINT and SIGTERM during delivery. Also ignore SIGUSR1, as
1994 when the process becomes unprivileged, it won't be able to write to the
1995 process log. SIGHUP is ignored throughout exim, except when it is being
1998 signal(SIGINT, SIG_IGN);
1999 signal(SIGTERM, SIG_IGN);
2000 signal(SIGUSR1, SIG_IGN);
2002 /* Close the unwanted half of the pipe, and set close-on-exec for the other
2003 half - for transports that exec things (e.g. pipe). Then set the required
2006 (void)close(pfd[pipe_read]);
2007 (void)fcntl(pfd[pipe_write], F_SETFD, fcntl(pfd[pipe_write], F_GETFD) |
2009 exim_setugid(uid, gid, use_initgroups,
2010 string_sprintf("local delivery to %s <%s> transport=%s", addr->local_part,
2011 addr->address, addr->transport->name));
2015 address_item *batched;
2016 debug_printf(" home=%s current=%s\n", deliver_home, working_directory);
2017 for (batched = addr->next; batched != NULL; batched = batched->next)
2018 debug_printf("additional batched address: %s\n", batched->address);
2021 /* Set an appropriate working directory. */
2023 if (Uchdir(working_directory) < 0)
2025 addr->transport_return = DEFER;
2026 addr->basic_errno = errno;
2027 addr->message = string_sprintf("failed to chdir to %s", working_directory);
2030 /* If successful, call the transport */
2035 set_process_info("delivering %s to %s using %s", message_id,
2036 addr->local_part, addr->transport->name);
2038 /* Setting this global in the subprocess means we need never clear it */
2039 transport_name = addr->transport->name;
2041 /* If a transport filter has been specified, set up its argument list.
2042 Any errors will get put into the address, and FALSE yielded. */
2044 if (addr->transport->filter_command != NULL)
2046 ok = transport_set_up_command(&transport_filter_argv,
2047 addr->transport->filter_command,
2048 TRUE, PANIC, addr, US"transport filter", NULL);
2049 transport_filter_timeout = addr->transport->filter_timeout;
2051 else transport_filter_argv = NULL;
2055 debug_print_string(addr->transport->debug_string);
2056 replicate = !(addr->transport->info->code)(addr->transport, addr);
2060 /* Pass the results back down the pipe. If necessary, first replicate the
2061 status in the top address to the others in the batch. The label is the
2062 subject of a goto when a call to the transport's setup function fails. We
2063 pass the pointer to the transport back in case it got changed as a result of
2064 file_format in appendfile. */
2068 if (replicate) replicate_status(addr);
2069 for (addr2 = addr; addr2 != NULL; addr2 = addr2->next)
2072 int local_part_length = Ustrlen(addr2->local_part);
2076 if( (ret = write(pfd[pipe_write], (void *)&(addr2->transport_return), sizeof(int))) != sizeof(int)
2077 || (ret = write(pfd[pipe_write], (void *)&transport_count, sizeof(transport_count))) != sizeof(transport_count)
2078 || (ret = write(pfd[pipe_write], (void *)&(addr2->flags), sizeof(addr2->flags))) != sizeof(addr2->flags)
2079 || (ret = write(pfd[pipe_write], (void *)&(addr2->basic_errno), sizeof(int))) != sizeof(int)
2080 || (ret = write(pfd[pipe_write], (void *)&(addr2->more_errno), sizeof(int))) != sizeof(int)
2081 || (ret = write(pfd[pipe_write], (void *)&(addr2->special_action), sizeof(int))) != sizeof(int)
2082 || (ret = write(pfd[pipe_write], (void *)&(addr2->transport),
2083 sizeof(transport_instance *))) != sizeof(transport_instance *)
2085 /* For a file delivery, pass back the local part, in case the original
2086 was only part of the final delivery path. This gives more complete
2089 || (testflag(addr2, af_file)
2090 && ( (ret = write(pfd[pipe_write], (void *)&local_part_length, sizeof(int))) != sizeof(int)
2091 || (ret = write(pfd[pipe_write], addr2->local_part, local_part_length)) != local_part_length
2095 log_write(0, LOG_MAIN|LOG_PANIC, "Failed writing transport results to pipe: %s\n",
2096 ret == -1 ? strerror(errno) : "short write");
2098 /* Now any messages */
2100 for (i = 0, s = addr2->message; i < 2; i++, s = addr2->user_message)
2102 int message_length = (s == NULL)? 0 : Ustrlen(s) + 1;
2103 if( (ret = write(pfd[pipe_write], (void *)&message_length, sizeof(int))) != sizeof(int)
2104 || (message_length > 0 && (ret = write(pfd[pipe_write], s, message_length)) != message_length)
2106 log_write(0, LOG_MAIN|LOG_PANIC, "Failed writing transport results to pipe: %s\n",
2107 ret == -1 ? strerror(errno) : "short write");
2111 /* OK, this process is now done. Free any cached resources that it opened,
2112 and close the pipe we were writing down before exiting. */
2114 (void)close(pfd[pipe_write]);
2119 /* Back in the main process: panic if the fork did not succeed. This seems
2120 better than returning an error - if forking is failing it is probably best
2121 not to try other deliveries for this message. */
2124 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Fork failed for local delivery to %s",
2127 /* Read the pipe to get the delivery status codes and error messages. Our copy
2128 of the writing end must be closed first, as otherwise read() won't return zero
2129 on an empty pipe. We check that a status exists for each address before
2130 overwriting the address structure. If data is missing, the default DEFER status
2131 will remain. Afterwards, close the reading end. */
2133 (void)close(pfd[pipe_write]);
2135 for (addr2 = addr; addr2 != NULL; addr2 = addr2->next)
2137 len = read(pfd[pipe_read], (void *)&status, sizeof(int));
2143 addr2->transport_return = status;
2144 len = read(pfd[pipe_read], (void *)&transport_count,
2145 sizeof(transport_count));
2146 len = read(pfd[pipe_read], (void *)&(addr2->flags), sizeof(addr2->flags));
2147 len = read(pfd[pipe_read], (void *)&(addr2->basic_errno), sizeof(int));
2148 len = read(pfd[pipe_read], (void *)&(addr2->more_errno), sizeof(int));
2149 len = read(pfd[pipe_read], (void *)&(addr2->special_action), sizeof(int));
2150 len = read(pfd[pipe_read], (void *)&(addr2->transport),
2151 sizeof(transport_instance *));
2153 if (testflag(addr2, af_file))
2155 int local_part_length;
2156 len = read(pfd[pipe_read], (void *)&local_part_length, sizeof(int));
2157 len = read(pfd[pipe_read], (void *)big_buffer, local_part_length);
2158 big_buffer[local_part_length] = 0;
2159 addr2->local_part = string_copy(big_buffer);
2162 for (i = 0, sptr = &(addr2->message); i < 2;
2163 i++, sptr = &(addr2->user_message))
2166 len = read(pfd[pipe_read], (void *)&message_length, sizeof(int));
2167 if (message_length > 0)
2169 len = read(pfd[pipe_read], (void *)big_buffer, message_length);
2170 if (len > 0) *sptr = string_copy(big_buffer);
2177 log_write(0, LOG_MAIN|LOG_PANIC, "failed to read delivery status for %s "
2178 "from delivery subprocess", addr2->unique);
2183 (void)close(pfd[pipe_read]);
2185 /* Unless shadowing, write all successful addresses immediately to the journal
2186 file, to ensure they are recorded asap. For homonymic addresses, use the base
2187 address plus the transport name. Failure to write the journal is panic-worthy,
2188 but don't stop, as it may prove possible subsequently to update the spool file
2189 in order to record the delivery. */
2193 for (addr2 = addr; addr2 != NULL; addr2 = addr2->next)
2195 if (addr2->transport_return != OK) continue;
2197 if (testflag(addr2, af_homonym))
2198 sprintf(CS big_buffer, "%.500s/%s\n", addr2->unique + 3, tp->name);
2200 sprintf(CS big_buffer, "%.500s\n", addr2->unique);
2202 /* In the test harness, wait just a bit to let the subprocess finish off
2203 any debug output etc first. */
2205 if (running_in_test_harness) millisleep(300);
2207 DEBUG(D_deliver) debug_printf("journalling %s", big_buffer);
2208 len = Ustrlen(big_buffer);
2209 if (write(journal_fd, big_buffer, len) != len)
2210 log_write(0, LOG_MAIN|LOG_PANIC, "failed to update journal for %s: %s",
2211 big_buffer, strerror(errno));
2214 /* Ensure the journal file is pushed out to disk. */
2216 if (EXIMfsync(journal_fd) < 0)
2217 log_write(0, LOG_MAIN|LOG_PANIC, "failed to fsync journal: %s",
2221 /* Wait for the process to finish. If it terminates with a non-zero code,
2222 freeze the message (except for SIGTERM, SIGKILL and SIGQUIT), but leave the
2223 status values of all the addresses as they are. Take care to handle the case
2224 when the subprocess doesn't seem to exist. This has been seen on one system
2225 when Exim was called from an MUA that set SIGCHLD to SIG_IGN. When that
2226 happens, wait() doesn't recognize the termination of child processes. Exim now
2227 resets SIGCHLD to SIG_DFL, but this code should still be robust. */
2229 while ((rc = wait(&status)) != pid)
2231 if (rc < 0 && errno == ECHILD) /* Process has vanished */
2233 log_write(0, LOG_MAIN, "%s transport process vanished unexpectedly",
2234 addr->transport->driver_name);
2240 if ((status & 0xffff) != 0)
2242 int msb = (status >> 8) & 255;
2243 int lsb = status & 255;
2244 int code = (msb == 0)? (lsb & 0x7f) : msb;
2245 if (msb != 0 || (code != SIGTERM && code != SIGKILL && code != SIGQUIT))
2246 addr->special_action = SPECIAL_FREEZE;
2247 log_write(0, LOG_MAIN|LOG_PANIC, "%s transport process returned non-zero "
2248 "status 0x%04x: %s %d",
2249 addr->transport->driver_name,
2251 (msb == 0)? "terminated by signal" : "exit code",
2255 /* If SPECIAL_WARN is set in the top address, send a warning message. */
2257 if (addr->special_action == SPECIAL_WARN &&
2258 addr->transport->warn_message != NULL)
2261 uschar *warn_message;
2263 DEBUG(D_deliver) debug_printf("Warning message requested by transport\n");
2265 warn_message = expand_string(addr->transport->warn_message);
2266 if (warn_message == NULL)
2267 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand \"%s\" (warning "
2268 "message for %s transport): %s", addr->transport->warn_message,
2269 addr->transport->name, expand_string_message);
2272 pid_t pid = child_open_exim(&fd);
2275 FILE *f = fdopen(fd, "wb");
2276 if (errors_reply_to != NULL &&
2277 !contains_header(US"Reply-To", warn_message))
2278 fprintf(f, "Reply-To: %s\n", errors_reply_to);
2279 fprintf(f, "Auto-Submitted: auto-replied\n");
2280 if (!contains_header(US"From", warn_message)) moan_write_from(f);
2281 fprintf(f, "%s", CS warn_message);
2283 /* Close and wait for child process to complete, without a timeout. */
2286 (void)child_close(pid, 0);
2290 addr->special_action = SPECIAL_NONE;
2296 /*************************************************
2297 * Do local deliveries *
2298 *************************************************/
2300 /* This function processes the list of addresses in addr_local. True local
2301 deliveries are always done one address at a time. However, local deliveries can
2302 be batched up in some cases. Typically this is when writing batched SMTP output
2303 files for use by some external transport mechanism, or when running local
2304 deliveries over LMTP.
2311 do_local_deliveries(void)
2314 open_db *dbm_file = NULL;
2315 time_t now = time(NULL);
2317 /* Loop until we have exhausted the supply of local deliveries */
2319 while (addr_local != NULL)
2321 time_t delivery_start;
2323 address_item *addr2, *addr3, *nextaddr;
2324 int logflags = LOG_MAIN;
2325 int logchar = dont_deliver? '*' : '=';
2326 transport_instance *tp;
2328 /* Pick the first undelivered address off the chain */
2330 address_item *addr = addr_local;
2331 addr_local = addr->next;
2334 DEBUG(D_deliver|D_transport)
2335 debug_printf("--------> %s <--------\n", addr->address);
2337 /* An internal disaster if there is no transport. Should not occur! */
2339 if ((tp = addr->transport) == NULL)
2341 logflags |= LOG_PANIC;
2342 disable_logging = FALSE; /* Jic */
2344 (addr->router != NULL)?
2345 string_sprintf("No transport set by %s router", addr->router->name)
2347 string_sprintf("No transport set by system filter");
2348 post_process_one(addr, DEFER, logflags, DTYPE_TRANSPORT, 0);
2352 /* Check that this base address hasn't previously been delivered to this
2353 transport. The check is necessary at this point to handle homonymic addresses
2354 correctly in cases where the pattern of redirection changes between delivery
2355 attempts. Non-homonymic previous delivery is detected earlier, at routing
2358 if (previously_transported(addr, FALSE)) continue;
2360 /* There are weird cases where logging is disabled */
2362 disable_logging = tp->disable_logging;
2364 /* Check for batched addresses and possible amalgamation. Skip all the work
2365 if either batch_max <= 1 or there aren't any other addresses for local
2368 if (tp->batch_max > 1 && addr_local != NULL)
2370 int batch_count = 1;
2371 BOOL uses_dom = readconf_depends((driver_instance *)tp, US"domain");
2372 BOOL uses_lp = (testflag(addr, af_pfr) &&
2373 (testflag(addr, af_file) || addr->local_part[0] == '|')) ||
2374 readconf_depends((driver_instance *)tp, US"local_part");
2375 uschar *batch_id = NULL;
2376 address_item **anchor = &addr_local;
2377 address_item *last = addr;
2380 /* Expand the batch_id string for comparison with other addresses.
2381 Expansion failure suppresses batching. */
2383 if (tp->batch_id != NULL)
2385 deliver_set_expansions(addr);
2386 batch_id = expand_string(tp->batch_id);
2387 deliver_set_expansions(NULL);
2388 if (batch_id == NULL)
2390 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand batch_id option "
2391 "in %s transport (%s): %s", tp->name, addr->address,
2392 expand_string_message);
2393 batch_count = tp->batch_max;
2397 /* Until we reach the batch_max limit, pick off addresses which have the
2398 same characteristics. These are:
2401 not previously delivered (see comment about 50 lines above)
2402 same local part if the transport's configuration contains $local_part
2403 or if this is a file or pipe delivery from a redirection
2404 same domain if the transport's configuration contains $domain
2406 same additional headers
2407 same headers to be removed
2408 same uid/gid for running the transport
2409 same first host if a host list is set
2412 while ((next = *anchor) != NULL && batch_count < tp->batch_max)
2415 tp == next->transport &&
2416 !previously_transported(next, TRUE) &&
2417 (addr->flags & (af_pfr|af_file)) == (next->flags & (af_pfr|af_file)) &&
2418 (!uses_lp || Ustrcmp(next->local_part, addr->local_part) == 0) &&
2419 (!uses_dom || Ustrcmp(next->domain, addr->domain) == 0) &&
2420 same_strings(next->p.errors_address, addr->p.errors_address) &&
2421 same_headers(next->p.extra_headers, addr->p.extra_headers) &&
2422 same_strings(next->p.remove_headers, addr->p.remove_headers) &&
2423 same_ugid(tp, addr, next) &&
2424 ((addr->host_list == NULL && next->host_list == NULL) ||
2425 (addr->host_list != NULL && next->host_list != NULL &&
2426 Ustrcmp(addr->host_list->name, next->host_list->name) == 0));
2428 /* If the transport has a batch_id setting, batch_id will be non-NULL
2429 from the expansion outside the loop. Expand for this address and compare.
2430 Expansion failure makes this address ineligible for batching. */
2432 if (ok && batch_id != NULL)
2435 address_item *save_nextnext = next->next;
2436 next->next = NULL; /* Expansion for a single address */
2437 deliver_set_expansions(next);
2438 next->next = save_nextnext;
2439 bid = expand_string(tp->batch_id);
2440 deliver_set_expansions(NULL);
2443 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand batch_id option "
2444 "in %s transport (%s): %s", tp->name, next->address,
2445 expand_string_message);
2448 else ok = (Ustrcmp(batch_id, bid) == 0);
2451 /* Take address into batch if OK. */
2455 *anchor = next->next; /* Include the address */
2461 else anchor = &(next->next); /* Skip the address */
2465 /* We now have one or more addresses that can be delivered in a batch. Check
2466 whether the transport is prepared to accept a message of this size. If not,
2467 fail them all forthwith. If the expansion fails, or does not yield an
2468 integer, defer delivery. */
2470 if (tp->message_size_limit != NULL)
2472 int rc = check_message_size(tp, addr);
2475 replicate_status(addr);
2476 while (addr != NULL)
2479 post_process_one(addr, rc, logflags, DTYPE_TRANSPORT, 0);
2482 continue; /* With next batch of addresses */
2486 /* If we are not running the queue, or if forcing, all deliveries will be
2487 attempted. Otherwise, we must respect the retry times for each address. Even
2488 when not doing this, we need to set up the retry key string, and determine
2489 whether a retry record exists, because after a successful delivery, a delete
2490 retry item must be set up. Keep the retry database open only for the duration
2491 of these checks, rather than for all local deliveries, because some local
2492 deliveries (e.g. to pipes) can take a substantial time. */
2494 dbm_file = dbfn_open(US"retry", O_RDONLY, &dbblock, FALSE);
2495 if (dbm_file == NULL)
2497 DEBUG(D_deliver|D_retry|D_hints_lookup)
2498 debug_printf("no retry data available\n");
2503 while (addr2 != NULL)
2505 BOOL ok = TRUE; /* to deliver this address */
2508 /* Set up the retry key to include the domain or not, and change its
2509 leading character from "R" to "T". Must make a copy before doing this,
2510 because the old key may be pointed to from a "delete" retry item after
2513 retry_key = string_copy(
2514 (tp->retry_use_local_part)? addr2->address_retry_key :
2515 addr2->domain_retry_key);
2518 /* Inspect the retry data. If there is no hints file, delivery happens. */
2520 if (dbm_file != NULL)
2522 dbdata_retry *retry_record = dbfn_read(dbm_file, retry_key);
2524 /* If there is no retry record, delivery happens. If there is,
2525 remember it exists so it can be deleted after a successful delivery. */
2527 if (retry_record != NULL)
2529 setflag(addr2, af_lt_retry_exists);
2531 /* A retry record exists for this address. If queue running and not
2532 forcing, inspect its contents. If the record is too old, or if its
2533 retry time has come, or if it has passed its cutoff time, delivery
2538 debug_printf("retry record exists: age=%s ",
2539 readconf_printtime(now - retry_record->time_stamp));
2540 debug_printf("(max %s)\n", readconf_printtime(retry_data_expire));
2541 debug_printf(" time to retry = %s expired = %d\n",
2542 readconf_printtime(retry_record->next_try - now),
2543 retry_record->expired);
2546 if (queue_running && !deliver_force)
2548 ok = (now - retry_record->time_stamp > retry_data_expire) ||
2549 (now >= retry_record->next_try) ||
2550 retry_record->expired;
2552 /* If we haven't reached the retry time, there is one more check
2553 to do, which is for the ultimate address timeout. */
2556 ok = retry_ultimate_address_timeout(retry_key, addr2->domain,
2560 else DEBUG(D_retry) debug_printf("no retry record exists\n");
2563 /* This address is to be delivered. Leave it on the chain. */
2568 addr2 = addr2->next;
2571 /* This address is to be deferred. Take it out of the chain, and
2572 post-process it as complete. Must take it out of the chain first,
2573 because post processing puts it on another chain. */
2577 address_item *this = addr2;
2578 this->message = US"Retry time not yet reached";
2579 this->basic_errno = ERRNO_LRETRY;
2580 if (addr3 == NULL) addr2 = addr = addr2->next;
2581 else addr2 = addr3->next = addr2->next;
2582 post_process_one(this, DEFER, logflags, DTYPE_TRANSPORT, 0);
2586 if (dbm_file != NULL) dbfn_close(dbm_file);
2588 /* If there are no addresses left on the chain, they all deferred. Loop
2589 for the next set of addresses. */
2591 if (addr == NULL) continue;
2593 /* So, finally, we do have some addresses that can be passed to the
2594 transport. Before doing so, set up variables that are relevant to a
2597 deliver_set_expansions(addr);
2598 delivery_start = time(NULL);
2599 deliver_local(addr, FALSE);
2600 deliver_time = (int)(time(NULL) - delivery_start);
2602 /* If a shadow transport (which must perforce be another local transport), is
2603 defined, and its condition is met, we must pass the message to the shadow
2604 too, but only those addresses that succeeded. We do this by making a new
2605 chain of addresses - also to keep the original chain uncontaminated. We must
2606 use a chain rather than doing it one by one, because the shadow transport may
2609 NOTE: if the condition fails because of a lookup defer, there is nothing we
2612 if (tp->shadow != NULL &&
2613 (tp->shadow_condition == NULL ||
2614 expand_check_condition(tp->shadow_condition, tp->name, US"transport")))
2616 transport_instance *stp;
2617 address_item *shadow_addr = NULL;
2618 address_item **last = &shadow_addr;
2620 for (stp = transports; stp != NULL; stp = stp->next)
2621 if (Ustrcmp(stp->name, tp->shadow) == 0) break;
2624 log_write(0, LOG_MAIN|LOG_PANIC, "shadow transport \"%s\" not found ",
2627 /* Pick off the addresses that have succeeded, and make clones. Put into
2628 the shadow_message field a pointer to the shadow_message field of the real
2631 else for (addr2 = addr; addr2 != NULL; addr2 = addr2->next)
2633 if (addr2->transport_return != OK) continue;
2634 addr3 = store_get(sizeof(address_item));
2637 addr3->shadow_message = (uschar *)(&(addr2->shadow_message));
2638 addr3->transport = stp;
2639 addr3->transport_return = DEFER;
2640 addr3->return_filename = NULL;
2641 addr3->return_file = -1;
2643 last = &(addr3->next);
2646 /* If we found any addresses to shadow, run the delivery, and stick any
2647 message back into the shadow_message field in the original. */
2649 if (shadow_addr != NULL)
2651 int save_count = transport_count;
2653 DEBUG(D_deliver|D_transport)
2654 debug_printf(">>>>>>>>>>>>>>>> Shadow delivery >>>>>>>>>>>>>>>>\n");
2655 deliver_local(shadow_addr, TRUE);
2657 for(; shadow_addr != NULL; shadow_addr = shadow_addr->next)
2659 int sresult = shadow_addr->transport_return;
2660 *((uschar **)(shadow_addr->shadow_message)) = (sresult == OK)?
2661 string_sprintf(" ST=%s", stp->name) :
2662 string_sprintf(" ST=%s (%s%s%s)", stp->name,
2663 (shadow_addr->basic_errno <= 0)?
2664 US"" : US strerror(shadow_addr->basic_errno),
2665 (shadow_addr->basic_errno <= 0 || shadow_addr->message == NULL)?
2667 (shadow_addr->message != NULL)? shadow_addr->message :
2668 (shadow_addr->basic_errno <= 0)? US"unknown error" : US"");
2670 DEBUG(D_deliver|D_transport)
2671 debug_printf("%s shadow transport returned %s for %s\n",
2673 (sresult == OK)? "OK" :
2674 (sresult == DEFER)? "DEFER" :
2675 (sresult == FAIL)? "FAIL" :
2676 (sresult == PANIC)? "PANIC" : "?",
2677 shadow_addr->address);
2680 DEBUG(D_deliver|D_transport)
2681 debug_printf(">>>>>>>>>>>>>>>> End shadow delivery >>>>>>>>>>>>>>>>\n");
2683 transport_count = save_count; /* Restore original transport count */
2687 /* Cancel the expansions that were set up for the delivery. */
2689 deliver_set_expansions(NULL);
2691 /* Now we can process the results of the real transport. We must take each
2692 address off the chain first, because post_process_one() puts it on another
2695 for (addr2 = addr; addr2 != NULL; addr2 = nextaddr)
2697 int result = addr2->transport_return;
2698 nextaddr = addr2->next;
2700 DEBUG(D_deliver|D_transport)
2701 debug_printf("%s transport returned %s for %s\n",
2703 (result == OK)? "OK" :
2704 (result == DEFER)? "DEFER" :
2705 (result == FAIL)? "FAIL" :
2706 (result == PANIC)? "PANIC" : "?",
2709 /* If there is a retry_record, or if delivery is deferred, build a retry
2710 item for setting a new retry time or deleting the old retry record from
2711 the database. These items are handled all together after all addresses
2712 have been handled (so the database is open just for a short time for
2715 if (result == DEFER || testflag(addr2, af_lt_retry_exists))
2717 int flags = (result == DEFER)? 0 : rf_delete;
2718 uschar *retry_key = string_copy((tp->retry_use_local_part)?
2719 addr2->address_retry_key : addr2->domain_retry_key);
2721 retry_add_item(addr2, retry_key, flags);
2724 /* Done with this address */
2726 if (result == OK) addr2->more_errno = deliver_time;
2727 post_process_one(addr2, result, logflags, DTYPE_TRANSPORT, logchar);
2729 /* If a pipe delivery generated text to be sent back, the result may be
2730 changed to FAIL, and we must copy this for subsequent addresses in the
2733 if (addr2->transport_return != result)
2735 for (addr3 = nextaddr; addr3 != NULL; addr3 = addr3->next)
2737 addr3->transport_return = addr2->transport_return;
2738 addr3->basic_errno = addr2->basic_errno;
2739 addr3->message = addr2->message;
2741 result = addr2->transport_return;
2744 /* Whether or not the result was changed to FAIL, we need to copy the
2745 return_file value from the first address into all the addresses of the
2746 batch, so they are all listed in the error message. */
2748 addr2->return_file = addr->return_file;
2750 /* Change log character for recording successful deliveries. */
2752 if (result == OK) logchar = '-';
2754 } /* Loop back for next batch of addresses */
2760 /*************************************************
2761 * Sort remote deliveries *
2762 *************************************************/
2764 /* This function is called if remote_sort_domains is set. It arranges that the
2765 chain of addresses for remote deliveries is ordered according to the strings
2766 specified. Try to make this shuffling reasonably efficient by handling
2767 sequences of addresses rather than just single ones.
2774 sort_remote_deliveries(void)
2777 address_item **aptr = &addr_remote;
2778 uschar *listptr = remote_sort_domains;
2782 while (*aptr != NULL &&
2783 (pattern = string_nextinlist(&listptr, &sep, patbuf, sizeof(patbuf)))
2786 address_item *moved = NULL;
2787 address_item **bptr = &moved;
2789 while (*aptr != NULL)
2791 address_item **next;
2792 deliver_domain = (*aptr)->domain; /* set $domain */
2793 if (match_isinlist(deliver_domain, &pattern, UCHAR_MAX+1,
2794 &domainlist_anchor, NULL, MCL_DOMAIN, TRUE, NULL) == OK)
2796 aptr = &((*aptr)->next);
2800 next = &((*aptr)->next);
2801 while (*next != NULL &&
2802 (deliver_domain = (*next)->domain, /* Set $domain */
2803 match_isinlist(deliver_domain, &pattern, UCHAR_MAX+1,
2804 &domainlist_anchor, NULL, MCL_DOMAIN, TRUE, NULL)) != OK)
2805 next = &((*next)->next);
2807 /* If the batch of non-matchers is at the end, add on any that were
2808 extracted further up the chain, and end this iteration. Otherwise,
2809 extract them from the chain and hang on the moved chain. */
2821 aptr = &((*aptr)->next);
2824 /* If the loop ended because the final address matched, *aptr will
2825 be NULL. Add on to the end any extracted non-matching addresses. If
2826 *aptr is not NULL, the loop ended via "break" when *next is null, that
2827 is, there was a string of non-matching addresses at the end. In this
2828 case the extracted addresses have already been added on the end. */
2830 if (*aptr == NULL) *aptr = moved;
2836 debug_printf("remote addresses after sorting:\n");
2837 for (addr = addr_remote; addr != NULL; addr = addr->next)
2838 debug_printf(" %s\n", addr->address);
2844 /*************************************************
2845 * Read from pipe for remote delivery subprocess *
2846 *************************************************/
2848 /* This function is called when the subprocess is complete, but can also be
2849 called before it is complete, in order to empty a pipe that is full (to prevent
2850 deadlock). It must therefore keep track of its progress in the parlist data
2853 We read the pipe to get the delivery status codes and a possible error message
2854 for each address, optionally preceded by unusability data for the hosts and
2855 also by optional retry data.
2857 Read in large chunks into the big buffer and then scan through, interpreting
2858 the data therein. In most cases, only a single read will be necessary. No
2859 individual item will ever be anywhere near 2500 bytes in length, so by ensuring
2860 that we read the next chunk when there is less than 2500 bytes left in the
2861 non-final chunk, we can assume each item is complete in the buffer before
2862 handling it. Each item is written using a single write(), which is atomic for
2863 small items (less than PIPE_BUF, which seems to be at least 512 in any Unix and
2864 often bigger) so even if we are reading while the subprocess is still going, we
2865 should never have only a partial item in the buffer.
2868 poffset the offset of the parlist item
2869 eop TRUE if the process has completed
2871 Returns: TRUE if the terminating 'Z' item has been read,
2872 or there has been a disaster (i.e. no more data needed);
2877 par_read_pipe(int poffset, BOOL eop)
2880 pardata *p = parlist + poffset;
2881 address_item *addrlist = p->addrlist;
2882 address_item *addr = p->addr;
2885 uschar *endptr = big_buffer;
2886 uschar *ptr = endptr;
2887 uschar *msg = p->msg;
2888 BOOL done = p->done;
2889 BOOL unfinished = TRUE;
2890 /* minimum size to read is header size including id, subid and length */
2891 int required = PIPE_HEADER_SIZE;
2893 /* Loop through all items, reading from the pipe when necessary. The pipe
2894 is set up to be non-blocking, but there are two different Unix mechanisms in
2895 use. Exim uses O_NONBLOCK if it is defined. This returns 0 for end of file,
2896 and EAGAIN for no more data. If O_NONBLOCK is not defined, Exim uses O_NDELAY,
2897 which returns 0 for both end of file and no more data. We distinguish the
2898 two cases by taking 0 as end of file only when we know the process has
2901 Each separate item is written to the pipe in a single write(), and as they are
2902 all short items, the writes will all be atomic and we should never find
2903 ourselves in the position of having read an incomplete item. "Short" in this
2904 case can mean up to about 1K in the case when there is a long error message
2905 associated with an address. */
2907 DEBUG(D_deliver) debug_printf("reading pipe for subprocess %d (%s)\n",
2908 (int)p->pid, eop? "ended" : "not ended");
2912 retry_item *r, **rp;
2913 int remaining = endptr - ptr;
2914 uschar header[PIPE_HEADER_SIZE + 1];
2918 /* Read (first time) or top up the chars in the buffer if necessary.
2919 There will be only one read if we get all the available data (i.e. don't
2920 fill the buffer completely). */
2922 if (remaining < required && unfinished)
2925 int available = big_buffer_size - remaining;
2927 if (remaining > 0) memmove(big_buffer, ptr, remaining);
2930 endptr = big_buffer + remaining;
2931 len = read(fd, endptr, available);
2933 DEBUG(D_deliver) debug_printf("read() yielded %d\n", len);
2935 /* If the result is EAGAIN and the process is not complete, just
2936 stop reading any more and process what we have already. */
2940 if (!eop && errno == EAGAIN) len = 0; else
2942 msg = string_sprintf("failed to read pipe from transport process "
2943 "%d for transport %s: %s", pid, addr->transport->driver_name,
2949 /* If the length is zero (eof or no-more-data), just process what we
2950 already have. Note that if the process is still running and we have
2951 read all the data in the pipe (but less that "available") then we
2952 won't read any more, as "unfinished" will get set FALSE. */
2956 unfinished = len == available;
2959 /* If we are at the end of the available data, exit the loop. */
2960 if (ptr >= endptr) break;
2962 /* copy and read header */
2963 memcpy(header, ptr, PIPE_HEADER_SIZE);
2964 header[PIPE_HEADER_SIZE] = '\0';
2967 required = Ustrtol(header + 2, &endc, 10) + PIPE_HEADER_SIZE; /* header + data */
2970 msg = string_sprintf("failed to read pipe from transport process "
2971 "%d for transport %s: error reading size from header", pid, addr->transport->driver_name);
2977 debug_printf("header read id:%c,subid:%c,size:%s,required:%d,remaining:%d,unfinished:%d\n",
2978 id, subid, header+2, required, remaining, unfinished);
2980 /* is there room for the dataset we want to read ? */
2981 if (required > big_buffer_size - PIPE_HEADER_SIZE)
2983 msg = string_sprintf("failed to read pipe from transport process "
2984 "%d for transport %s: big_buffer too small! required size=%d buffer size=%d", pid, addr->transport->driver_name,
2985 required, big_buffer_size - PIPE_HEADER_SIZE);
2990 /* we wrote all datasets with atomic write() calls
2991 remaining < required only happens if big_buffer was too small
2992 to get all available data from pipe. unfinished has to be true
2994 if (remaining < required)
2998 msg = string_sprintf("failed to read pipe from transport process "
2999 "%d for transport %s: required size=%d > remaining size=%d and unfinished=false",
3000 pid, addr->transport->driver_name, required, remaining);
3005 /* step behind the header */
3006 ptr += PIPE_HEADER_SIZE;
3008 /* Handle each possible type of item, assuming the complete item is
3009 available in store. */
3013 /* Host items exist only if any hosts were marked unusable. Match
3014 up by checking the IP address. */
3017 for (h = addrlist->host_list; h != NULL; h = h->next)
3019 if (h->address == NULL || Ustrcmp(h->address, ptr+2) != 0) continue;
3027 /* Retry items are sent in a preceding R item for each address. This is
3028 kept separate to keep each message short enough to guarantee it won't
3029 be split in the pipe. Hopefully, in the majority of cases, there won't in
3030 fact be any retry items at all.
3032 The complete set of retry items might include an item to delete a
3033 routing retry if there was a previous routing delay. However, routing
3034 retries are also used when a remote transport identifies an address error.
3035 In that case, there may also be an "add" item for the same key. Arrange
3036 that a "delete" item is dropped in favour of an "add" item. */
3039 if (addr == NULL) goto ADDR_MISMATCH;
3041 DEBUG(D_deliver|D_retry)
3042 debug_printf("reading retry information for %s from subprocess\n",
3045 /* Cut out any "delete" items on the list. */
3047 for (rp = &(addr->retries); (r = *rp) != NULL; rp = &(r->next))
3049 if (Ustrcmp(r->key, ptr+1) == 0) /* Found item with same key */
3051 if ((r->flags & rf_delete) == 0) break; /* It was not "delete" */
3052 *rp = r->next; /* Excise a delete item */
3053 DEBUG(D_deliver|D_retry)
3054 debug_printf(" existing delete item dropped\n");
3058 /* We want to add a delete item only if there is no non-delete item;
3059 however we still have to step ptr through the data. */
3061 if (r == NULL || (*ptr & rf_delete) == 0)
3063 r = store_get(sizeof(retry_item));
3064 r->next = addr->retries;
3067 r->key = string_copy(ptr);
3069 memcpy(&(r->basic_errno), ptr, sizeof(r->basic_errno));
3070 ptr += sizeof(r->basic_errno);
3071 memcpy(&(r->more_errno), ptr, sizeof(r->more_errno));
3072 ptr += sizeof(r->more_errno);
3073 r->message = (*ptr)? string_copy(ptr) : NULL;
3074 DEBUG(D_deliver|D_retry)
3075 debug_printf(" added %s item\n",
3076 ((r->flags & rf_delete) == 0)? "retry" : "delete");
3081 DEBUG(D_deliver|D_retry)
3082 debug_printf(" delete item not added: non-delete item exists\n");
3085 ptr += sizeof(r->basic_errno) + sizeof(r->more_errno);
3091 /* Put the amount of data written into the parlist block */
3094 memcpy(&(p->transport_count), ptr, sizeof(transport_count));
3095 ptr += sizeof(transport_count);
3098 /* Address items are in the order of items on the address chain. We
3099 remember the current address value in case this function is called
3100 several times to empty the pipe in stages. Information about delivery
3101 over TLS is sent in a preceding X item for each address. We don't put
3102 it in with the other info, in order to keep each message short enough to
3103 guarantee it won't be split in the pipe. */
3107 if (addr == NULL) goto ADDR_MISMATCH; /* Below, in 'A' handler */
3111 addr->cipher = NULL;
3112 addr->peerdn = NULL;
3115 addr->cipher = string_copy(ptr);
3118 addr->peerdn = string_copy(ptr);
3122 addr->peercert = NULL;
3124 (void) tls_import_cert(ptr, &addr->peercert);
3128 addr->ourcert = NULL;
3130 (void) tls_import_cert(ptr, &addr->ourcert);
3133 # ifndef DISABLE_OCSP
3135 addr->ocsp = OCSP_NOT_REQ;
3137 addr->ocsp = *ptr - '0';
3143 #endif /*SUPPORT_TLS*/
3145 case 'C': /* client authenticator information */
3149 addr->authenticator = (*ptr)? string_copy(ptr) : NULL;
3152 addr->auth_id = (*ptr)? string_copy(ptr) : NULL;
3155 addr->auth_sndr = (*ptr)? string_copy(ptr) : NULL;
3161 #ifndef DISABLE_PRDR
3163 addr->flags |= af_prdr_used;
3168 if (addr == NULL) goto ADDR_MISMATCH;
3169 memcpy(&(addr->dsn_aware), ptr, sizeof(addr->dsn_aware));
3170 ptr += sizeof(addr->dsn_aware);
3171 DEBUG(D_deliver) debug_printf("DSN read: addr->dsn_aware = %d\n", addr->dsn_aware);
3178 msg = string_sprintf("address count mismatch for data read from pipe "
3179 "for transport process %d for transport %s", pid,
3180 addrlist->transport->driver_name);
3185 addr->transport_return = *ptr++;
3186 addr->special_action = *ptr++;
3187 memcpy(&(addr->basic_errno), ptr, sizeof(addr->basic_errno));
3188 ptr += sizeof(addr->basic_errno);
3189 memcpy(&(addr->more_errno), ptr, sizeof(addr->more_errno));
3190 ptr += sizeof(addr->more_errno);
3191 memcpy(&(addr->flags), ptr, sizeof(addr->flags));
3192 ptr += sizeof(addr->flags);
3193 addr->message = (*ptr)? string_copy(ptr) : NULL;
3195 addr->user_message = (*ptr)? string_copy(ptr) : NULL;
3198 /* Always two strings for host information, followed by the port number and DNSSEC mark */
3202 h = store_get(sizeof(host_item));
3203 h->name = string_copy(ptr);
3205 h->address = string_copy(ptr);
3207 memcpy(&(h->port), ptr, sizeof(h->port));
3208 ptr += sizeof(h->port);
3209 h->dnssec = *ptr == '2' ? DS_YES
3210 : *ptr == '1' ? DS_NO
3213 addr->host_used = h;
3217 /* Finished with this address */
3222 /* Z marks the logical end of the data. It is followed by '0' if
3223 continue_transport was NULL at the end of transporting, otherwise '1'.
3224 We need to know when it becomes NULL during a delivery down a passed SMTP
3225 channel so that we don't try to pass anything more down it. Of course, for
3226 most normal messages it will remain NULL all the time. */
3231 continue_transport = NULL;
3232 continue_hostname = NULL;
3235 DEBUG(D_deliver) debug_printf("Z0%c item read\n", *ptr);
3238 /* Anything else is a disaster. */
3241 msg = string_sprintf("malformed data (%d) read from pipe for transport "
3242 "process %d for transport %s", ptr[-1], pid,
3243 addr->transport->driver_name);
3249 /* The done flag is inspected externally, to determine whether or not to
3250 call the function again when the process finishes. */
3254 /* If the process hadn't finished, and we haven't seen the end of the data
3255 or suffered a disaster, update the rest of the state, and return FALSE to
3256 indicate "not finished". */
3265 /* Close our end of the pipe, to prevent deadlock if the far end is still
3266 pushing stuff into it. */
3271 /* If we have finished without error, but haven't had data for every address,
3272 something is wrong. */
3274 if (msg == NULL && addr != NULL)
3275 msg = string_sprintf("insufficient address data read from pipe "
3276 "for transport process %d for transport %s", pid,
3277 addr->transport->driver_name);
3279 /* If an error message is set, something has gone wrong in getting back
3280 the delivery data. Put the message into each address and freeze it. */
3284 for (addr = addrlist; addr != NULL; addr = addr->next)
3286 addr->transport_return = DEFER;
3287 addr->special_action = SPECIAL_FREEZE;
3288 addr->message = msg;
3292 /* Return TRUE to indicate we have got all we need from this process, even
3293 if it hasn't actually finished yet. */
3300 /*************************************************
3301 * Post-process a set of remote addresses *
3302 *************************************************/
3304 /* Do what has to be done immediately after a remote delivery for each set of
3305 addresses, then re-write the spool if necessary. Note that post_process_one
3306 puts the address on an appropriate queue; hence we must fish off the next
3307 one first. This function is also called if there is a problem with setting
3308 up a subprocess to do a remote delivery in parallel. In this case, the final
3309 argument contains a message, and the action must be forced to DEFER.
3312 addr pointer to chain of address items
3313 logflags flags for logging
3314 msg NULL for normal cases; -> error message for unexpected problems
3315 fallback TRUE if processing fallback hosts
3321 remote_post_process(address_item *addr, int logflags, uschar *msg,
3326 /* If any host addresses were found to be unusable, add them to the unusable
3327 tree so that subsequent deliveries don't try them. */
3329 for (h = addr->host_list; h != NULL; h = h->next)
3331 if (h->address == NULL) continue;
3332 if (h->status >= hstatus_unusable) tree_add_unusable(h);
3335 /* Now handle each address on the chain. The transport has placed '=' or '-'
3336 into the special_action field for each successful delivery. */
3338 while (addr != NULL)
3340 address_item *next = addr->next;
3342 /* If msg == NULL (normal processing) and the result is DEFER and we are
3343 processing the main hosts and there are fallback hosts available, put the
3344 address on the list for fallback delivery. */
3346 if (addr->transport_return == DEFER &&
3347 addr->fallback_hosts != NULL &&
3351 addr->host_list = addr->fallback_hosts;
3352 addr->next = addr_fallback;
3353 addr_fallback = addr;
3354 DEBUG(D_deliver) debug_printf("%s queued for fallback host(s)\n", addr->address);
3357 /* If msg is set (=> unexpected problem), set it in the address before
3358 doing the ordinary post processing. */
3364 addr->message = msg;
3365 addr->transport_return = DEFER;
3367 (void)post_process_one(addr, addr->transport_return, logflags,
3368 DTYPE_TRANSPORT, addr->special_action);
3376 /* If we have just delivered down a passed SMTP channel, and that was
3377 the last address, the channel will have been closed down. Now that
3378 we have logged that delivery, set continue_sequence to 1 so that
3379 any subsequent deliveries don't get "*" incorrectly logged. */
3381 if (continue_transport == NULL) continue_sequence = 1;
3386 /*************************************************
3387 * Wait for one remote delivery subprocess *
3388 *************************************************/
3390 /* This function is called while doing remote deliveries when either the
3391 maximum number of processes exist and we need one to complete so that another
3392 can be created, or when waiting for the last ones to complete. It must wait for
3393 the completion of one subprocess, empty the control block slot, and return a
3394 pointer to the address chain.
3397 Returns: pointer to the chain of addresses handled by the process;
3398 NULL if no subprocess found - this is an unexpected error
3401 static address_item *
3404 int poffset, status;
3405 address_item *addr, *addrlist;
3408 set_process_info("delivering %s: waiting for a remote delivery subprocess "
3409 "to finish", message_id);
3411 /* Loop until either a subprocess completes, or there are no subprocesses in
3412 existence - in which case give an error return. We cannot proceed just by
3413 waiting for a completion, because a subprocess may have filled up its pipe, and
3414 be waiting for it to be emptied. Therefore, if no processes have finished, we
3415 wait for one of the pipes to acquire some data by calling select(), with a
3416 timeout just in case.
3418 The simple approach is just to iterate after reading data from a ready pipe.
3419 This leads to non-ideal behaviour when the subprocess has written its final Z
3420 item, closed the pipe, and is in the process of exiting (the common case). A
3421 call to waitpid() yields nothing completed, but select() shows the pipe ready -
3422 reading it yields EOF, so you end up with busy-waiting until the subprocess has
3425 To avoid this, if all the data that is needed has been read from a subprocess
3426 after select(), an explicit wait() for it is done. We know that all it is doing
3427 is writing to the pipe and then exiting, so the wait should not be long.
3429 The non-blocking waitpid() is to some extent just insurance; if we could
3430 reliably detect end-of-file on the pipe, we could always know when to do a
3431 blocking wait() for a completed process. However, because some systems use
3432 NDELAY, which doesn't distinguish between EOF and pipe empty, it is easier to
3433 use code that functions without the need to recognize EOF.
3435 There's a double loop here just in case we end up with a process that is not in
3436 the list of remote delivery processes. Something has obviously gone wrong if
3437 this is the case. (For example, a process that is incorrectly left over from
3438 routing or local deliveries might be found.) The damage can be minimized by
3439 looping back and looking for another process. If there aren't any, the error
3440 return will happen. */
3442 for (;;) /* Normally we do not repeat this loop */
3444 while ((pid = waitpid(-1, &status, WNOHANG)) <= 0)
3447 fd_set select_pipes;
3448 int maxpipe, readycount;
3450 /* A return value of -1 can mean several things. If errno != ECHILD, it
3451 either means invalid options (which we discount), or that this process was
3452 interrupted by a signal. Just loop to try the waitpid() again.
3454 If errno == ECHILD, waitpid() is telling us that there are no subprocesses
3455 in existence. This should never happen, and is an unexpected error.
3456 However, there is a nasty complication when running under Linux. If "strace
3457 -f" is being used under Linux to trace this process and its children,
3458 subprocesses are "stolen" from their parents and become the children of the
3459 tracing process. A general wait such as the one we've just obeyed returns
3460 as if there are no children while subprocesses are running. Once a
3461 subprocess completes, it is restored to the parent, and waitpid(-1) finds
3462 it. Thanks to Joachim Wieland for finding all this out and suggesting a
3465 This does not happen using "truss" on Solaris, nor (I think) with other
3466 tracing facilities on other OS. It seems to be specific to Linux.
3468 What we do to get round this is to use kill() to see if any of our
3469 subprocesses are still in existence. If kill() gives an OK return, we know
3470 it must be for one of our processes - it can't be for a re-use of the pid,
3471 because if our process had finished, waitpid() would have found it. If any
3472 of our subprocesses are in existence, we proceed to use select() as if
3473 waitpid() had returned zero. I think this is safe. */
3477 if (errno != ECHILD) continue; /* Repeats the waitpid() */
3480 debug_printf("waitpid() returned -1/ECHILD: checking explicitly "
3481 "for process existence\n");
3483 for (poffset = 0; poffset < remote_max_parallel; poffset++)
3485 if ((pid = parlist[poffset].pid) != 0 && kill(pid, 0) == 0)
3487 DEBUG(D_deliver) debug_printf("process %d still exists: assume "
3488 "stolen by strace\n", (int)pid);
3489 break; /* With poffset set */
3493 if (poffset >= remote_max_parallel)
3495 DEBUG(D_deliver) debug_printf("*** no delivery children found\n");
3496 return NULL; /* This is the error return */
3500 /* A pid value greater than 0 breaks the "while" loop. A negative value has
3501 been handled above. A return value of zero means that there is at least one
3502 subprocess, but there are no completed subprocesses. See if any pipes are
3503 ready with any data for reading. */
3505 DEBUG(D_deliver) debug_printf("selecting on subprocess pipes\n");
3508 FD_ZERO(&select_pipes);
3509 for (poffset = 0; poffset < remote_max_parallel; poffset++)
3511 if (parlist[poffset].pid != 0)
3513 int fd = parlist[poffset].fd;
3514 FD_SET(fd, &select_pipes);
3515 if (fd > maxpipe) maxpipe = fd;
3519 /* Stick in a 60-second timeout, just in case. */
3524 readycount = select(maxpipe + 1, (SELECT_ARG2_TYPE *)&select_pipes,
3527 /* Scan through the pipes and read any that are ready; use the count
3528 returned by select() to stop when there are no more. Select() can return
3529 with no processes (e.g. if interrupted). This shouldn't matter.
3531 If par_read_pipe() returns TRUE, it means that either the terminating Z was
3532 read, or there was a disaster. In either case, we are finished with this
3533 process. Do an explicit wait() for the process and break the main loop if
3536 It turns out that we have to deal with the case of an interrupted system
3537 call, which can happen on some operating systems if the signal handling is
3538 set up to do that by default. */
3541 readycount > 0 && poffset < remote_max_parallel;
3544 if ((pid = parlist[poffset].pid) != 0 &&
3545 FD_ISSET(parlist[poffset].fd, &select_pipes))
3548 if (par_read_pipe(poffset, FALSE)) /* Finished with this pipe */
3550 for (;;) /* Loop for signals */
3552 pid_t endedpid = waitpid(pid, &status, 0);
3553 if (endedpid == pid) goto PROCESS_DONE;
3554 if (endedpid != (pid_t)(-1) || errno != EINTR)
3555 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Unexpected error return "
3556 "%d (errno = %d) from waitpid() for process %d",
3557 (int)endedpid, errno, (int)pid);
3563 /* Now go back and look for a completed subprocess again. */
3566 /* A completed process was detected by the non-blocking waitpid(). Find the
3567 data block that corresponds to this subprocess. */
3569 for (poffset = 0; poffset < remote_max_parallel; poffset++)
3570 if (pid == parlist[poffset].pid) break;
3572 /* Found the data block; this is a known remote delivery process. We don't
3573 need to repeat the outer loop. This should be what normally happens. */
3575 if (poffset < remote_max_parallel) break;
3577 /* This situation is an error, but it's probably better to carry on looking
3578 for another process than to give up (as we used to do). */
3580 log_write(0, LOG_MAIN|LOG_PANIC, "Process %d finished: not found in remote "
3581 "transport process list", pid);
3582 } /* End of the "for" loop */
3584 /* Come here when all the data was completely read after a select(), and
3585 the process in pid has been wait()ed for. */
3592 debug_printf("remote delivery process %d ended\n", (int)pid);
3594 debug_printf("remote delivery process %d ended: status=%04x\n", (int)pid,
3598 set_process_info("delivering %s", message_id);
3600 /* Get the chain of processed addresses */
3602 addrlist = parlist[poffset].addrlist;
3604 /* If the process did not finish cleanly, record an error and freeze (except
3605 for SIGTERM, SIGKILL and SIGQUIT), and also ensure the journal is not removed,
3606 in case the delivery did actually happen. */
3608 if ((status & 0xffff) != 0)
3611 int msb = (status >> 8) & 255;
3612 int lsb = status & 255;
3613 int code = (msb == 0)? (lsb & 0x7f) : msb;
3615 msg = string_sprintf("%s transport process returned non-zero status 0x%04x: "
3617 addrlist->transport->driver_name,
3619 (msb == 0)? "terminated by signal" : "exit code",
3622 if (msb != 0 || (code != SIGTERM && code != SIGKILL && code != SIGQUIT))
3623 addrlist->special_action = SPECIAL_FREEZE;
3625 for (addr = addrlist; addr != NULL; addr = addr->next)
3627 addr->transport_return = DEFER;
3628 addr->message = msg;
3631 remove_journal = FALSE;
3634 /* Else complete reading the pipe to get the result of the delivery, if all
3635 the data has not yet been obtained. */
3637 else if (!parlist[poffset].done) (void)par_read_pipe(poffset, TRUE);
3639 /* Put the data count and return path into globals, mark the data slot unused,
3640 decrement the count of subprocesses, and return the address chain. */
3642 transport_count = parlist[poffset].transport_count;
3643 used_return_path = parlist[poffset].return_path;
3644 parlist[poffset].pid = 0;
3651 /*************************************************
3652 * Wait for subprocesses and post-process *
3653 *************************************************/
3655 /* This function waits for subprocesses until the number that are still running
3656 is below a given threshold. For each complete subprocess, the addresses are
3657 post-processed. If we can't find a running process, there is some shambles.
3658 Better not bomb out, as that might lead to multiple copies of the message. Just
3659 log and proceed as if all done.
3662 max maximum number of subprocesses to leave running
3663 fallback TRUE if processing fallback hosts
3669 par_reduce(int max, BOOL fallback)
3671 while (parcount > max)
3673 address_item *doneaddr = par_wait();
3674 if (doneaddr == NULL)
3676 log_write(0, LOG_MAIN|LOG_PANIC,
3677 "remote delivery process count got out of step");
3680 else remote_post_process(doneaddr, LOG_MAIN, NULL, fallback);
3688 rmt_dlv_checked_write(int fd, char id, char subid, void * buf, int size)
3690 uschar writebuffer[PIPE_HEADER_SIZE + BIG_BUFFER_SIZE];
3693 /* we assume that size can't get larger then BIG_BUFFER_SIZE which currently is set to 16k */
3694 /* complain to log if someone tries with buffer sizes we can't handle*/
3698 log_write(0, LOG_MAIN|LOG_PANIC_DIE,
3699 "Failed writing transport result to pipe: can't handle buffers > 99999 bytes. truncating!\n");
3703 /* to keep the write() atomic we build header in writebuffer and copy buf behind */
3704 /* two write() calls would increase the complexity of reading from pipe */
3706 /* convert size to human readable string prepended by id and subid */
3707 header_length = snprintf(CS writebuffer, PIPE_HEADER_SIZE+1, "%c%c%05d", id, subid, size);
3708 if (header_length != PIPE_HEADER_SIZE)
3710 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "header snprintf failed\n");
3711 writebuffer[0] = '\0';
3714 DEBUG(D_deliver) debug_printf("header write id:%c,subid:%c,size:%d,final:%s\n",
3715 id, subid, size, writebuffer);
3717 if (buf && size > 0)
3718 memcpy(writebuffer + PIPE_HEADER_SIZE, buf, size);
3720 size += PIPE_HEADER_SIZE;
3721 int ret = write(fd, writebuffer, size);
3723 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Failed writing transport result to pipe: %s\n",
3724 ret == -1 ? strerror(errno) : "short write");
3727 /*************************************************
3728 * Do remote deliveries *
3729 *************************************************/
3731 /* This function is called to process the addresses in addr_remote. We must
3732 pick off the queue all addresses that have the same transport, remote
3733 destination, and errors address, and hand them to the transport in one go,
3734 subject to some configured limitations. If this is a run to continue delivering
3735 to an existing delivery channel, skip all but those addresses that can go to
3736 that channel. The skipped addresses just get deferred.
3738 If mua_wrapper is set, all addresses must be able to be sent in a single
3739 transaction. If not, this function yields FALSE.
3741 In Exim 4, remote deliveries are always done in separate processes, even
3742 if remote_max_parallel = 1 or if there's only one delivery to do. The reason
3743 is so that the base process can retain privilege. This makes the
3744 implementation of fallback transports feasible (though not initially done.)
3746 We create up to the configured number of subprocesses, each of which passes
3747 back the delivery state via a pipe. (However, when sending down an existing
3748 connection, remote_max_parallel is forced to 1.)
3751 fallback TRUE if processing fallback hosts
3753 Returns: TRUE normally
3754 FALSE if mua_wrapper is set and the addresses cannot all be sent
3759 do_remote_deliveries(BOOL fallback)
3765 parcount = 0; /* Number of executing subprocesses */
3767 /* When sending down an existing channel, only do one delivery at a time.
3768 We use a local variable (parmax) to hold the maximum number of processes;
3769 this gets reduced from remote_max_parallel if we can't create enough pipes. */
3771 if (continue_transport != NULL) remote_max_parallel = 1;
3772 parmax = remote_max_parallel;
3774 /* If the data for keeping a list of processes hasn't yet been
3777 if (parlist == NULL)
3779 parlist = store_get(remote_max_parallel * sizeof(pardata));
3780 for (poffset = 0; poffset < remote_max_parallel; poffset++)
3781 parlist[poffset].pid = 0;
3784 /* Now loop for each remote delivery */
3786 for (delivery_count = 0; addr_remote != NULL; delivery_count++)
3792 int address_count = 1;
3793 int address_count_max;
3795 BOOL use_initgroups;
3796 BOOL pipe_done = FALSE;
3797 transport_instance *tp;
3798 address_item **anchor = &addr_remote;
3799 address_item *addr = addr_remote;
3800 address_item *last = addr;
3803 /* Pull the first address right off the list. */
3805 addr_remote = addr->next;
3808 DEBUG(D_deliver|D_transport)
3809 debug_printf("--------> %s <--------\n", addr->address);
3811 /* If no transport has been set, there has been a big screw-up somewhere. */
3813 if ((tp = addr->transport) == NULL)
3815 disable_logging = FALSE; /* Jic */
3816 remote_post_process(addr, LOG_MAIN|LOG_PANIC,
3817 US"No transport set by router", fallback);
3821 /* Check that this base address hasn't previously been delivered to this
3822 transport. The check is necessary at this point to handle homonymic addresses
3823 correctly in cases where the pattern of redirection changes between delivery
3824 attempts. Non-homonymic previous delivery is detected earlier, at routing
3827 if (previously_transported(addr, FALSE)) continue;
3829 /* Force failure if the message is too big. */
3831 if (tp->message_size_limit != NULL)
3833 int rc = check_message_size(tp, addr);
3836 addr->transport_return = rc;
3837 remote_post_process(addr, LOG_MAIN, NULL, fallback);
3842 /* Get the flag which specifies whether the transport can handle different
3843 domains that nevertheless resolve to the same set of hosts. If it needs
3844 expanding, get variables set: $address_data, $domain_data, $localpart_data,
3845 $host, $host_address, $host_port. */
3846 if (tp->expand_multi_domain)
3847 deliver_set_expansions(addr);
3849 if (exp_bool(addr, US"transport", tp->name, D_transport,
3850 US"multi_domain", tp->multi_domain, tp->expand_multi_domain,
3851 &multi_domain) != OK)
3853 deliver_set_expansions(NULL);
3854 remote_post_process(addr, LOG_MAIN|LOG_PANIC, addr->message, fallback);
3858 /* Get the maximum it can handle in one envelope, with zero meaning
3859 unlimited, which is forced for the MUA wrapper case. */
3861 address_count_max = tp->max_addresses;
3862 if (address_count_max == 0 || mua_wrapper) address_count_max = 999999;
3865 /************************************************************************/
3866 /***** This is slightly experimental code, but should be safe. *****/
3868 /* The address_count_max value is the maximum number of addresses that the
3869 transport can send in one envelope. However, the transport must be capable of
3870 dealing with any number of addresses. If the number it gets exceeds its
3871 envelope limitation, it must send multiple copies of the message. This can be
3872 done over a single connection for SMTP, so uses less resources than making
3873 multiple connections. On the other hand, if remote_max_parallel is greater
3874 than one, it is perhaps a good idea to use parallel processing to move the
3875 message faster, even if that results in multiple simultaneous connections to
3878 How can we come to some compromise between these two ideals? What we do is to
3879 limit the number of addresses passed to a single instance of a transport to
3880 the greater of (a) its address limit (rcpt_max for SMTP) and (b) the total
3881 number of addresses routed to remote transports divided by
3882 remote_max_parallel. For example, if the message has 100 remote recipients,
3883 remote max parallel is 2, and rcpt_max is 10, we'd never send more than 50 at
3884 once. But if rcpt_max is 100, we could send up to 100.
3886 Of course, not all the remotely addresses in a message are going to go to the
3887 same set of hosts (except in smarthost configurations), so this is just a
3888 heuristic way of dividing up the work.
3890 Furthermore (1), because this may not be wanted in some cases, and also to
3891 cope with really pathological cases, there is also a limit to the number of
3892 messages that are sent over one connection. This is the same limit that is
3893 used when sending several different messages over the same connection.
3894 Continue_sequence is set when in this situation, to the number sent so
3895 far, including this message.
3897 Furthermore (2), when somebody explicitly sets the maximum value to 1, it
3898 is probably because they are using VERP, in which case they want to pass only
3899 one address at a time to the transport, in order to be able to use
3900 $local_part and $domain in constructing a new return path. We could test for
3901 the use of these variables, but as it is so likely they will be used when the
3902 maximum is 1, we don't bother. Just leave the value alone. */
3904 if (address_count_max != 1 &&
3905 address_count_max < remote_delivery_count/remote_max_parallel)
3907 int new_max = remote_delivery_count/remote_max_parallel;
3908 int message_max = tp->connection_max_messages;
3909 if (connection_max_messages >= 0) message_max = connection_max_messages;
3910 message_max -= continue_sequence - 1;
3911 if (message_max > 0 && new_max > address_count_max * message_max)
3912 new_max = address_count_max * message_max;
3913 address_count_max = new_max;
3916 /************************************************************************/
3919 /* Pick off all addresses which have the same transport, errors address,
3920 destination, and extra headers. In some cases they point to the same host
3921 list, but we also need to check for identical host lists generated from
3922 entirely different domains. The host list pointers can be NULL in the case
3923 where the hosts are defined in the transport. There is also a configured
3924 maximum limit of addresses that can be handled at once (see comments above
3925 for how it is computed).
3926 If the transport does not handle multiple domains, enforce that also,
3927 and if it might need a per-address check for this, re-evaluate it.
3930 while ((next = *anchor) != NULL && address_count < address_count_max)
3933 if ( (multi_domain || Ustrcmp(next->domain, addr->domain) == 0)
3934 && tp == next->transport
3935 && same_hosts(next->host_list, addr->host_list)
3936 && same_strings(next->p.errors_address, addr->p.errors_address)
3937 && same_headers(next->p.extra_headers, addr->p.extra_headers)
3938 && same_ugid(tp, next, addr)
3939 && ( next->p.remove_headers == addr->p.remove_headers
3940 || ( next->p.remove_headers != NULL
3941 && addr->p.remove_headers != NULL
3942 && Ustrcmp(next->p.remove_headers, addr->p.remove_headers) == 0
3946 !tp->expand_multi_domain || (deliver_set_expansions(next), 1),
3948 US"transport", next->transport->name, D_transport,
3949 US"multi_domain", next->transport->multi_domain,
3950 next->transport->expand_multi_domain, &md) == OK
3955 *anchor = next->next;
3957 next->first = addr; /* remember top one (for retry processing) */
3962 else anchor = &(next->next);
3963 deliver_set_expansions(NULL);
3966 /* If we are acting as an MUA wrapper, all addresses must go in a single
3967 transaction. If not, put them back on the chain and yield FALSE. */
3969 if (mua_wrapper && addr_remote != NULL)
3971 last->next = addr_remote;
3976 /* Set up the expansion variables for this set of addresses */
3978 deliver_set_expansions(addr);
3980 /* Ensure any transport-set auth info is fresh */
3981 addr->authenticator = addr->auth_id = addr->auth_sndr = NULL;
3983 /* Compute the return path, expanding a new one if required. The old one
3984 must be set first, as it might be referred to in the expansion. */
3986 if(addr->p.errors_address != NULL)
3987 return_path = addr->p.errors_address;
3988 #ifdef EXPERIMENTAL_SRS
3989 else if(addr->p.srs_sender != NULL)
3990 return_path = addr->p.srs_sender;
3993 return_path = sender_address;
3995 if (tp->return_path != NULL)
3997 uschar *new_return_path = expand_string(tp->return_path);
3998 if (new_return_path == NULL)
4000 if (!expand_string_forcedfail)
4002 remote_post_process(addr, LOG_MAIN|LOG_PANIC,
4003 string_sprintf("Failed to expand return path \"%s\": %s",
4004 tp->return_path, expand_string_message), fallback);
4008 else return_path = new_return_path;
4011 /* Find the uid, gid, and use_initgroups setting for this transport. Failure
4012 logs and sets up error messages, so we just post-process and continue with
4013 the next address. */
4015 if (!findugid(addr, tp, &uid, &gid, &use_initgroups))
4017 remote_post_process(addr, LOG_MAIN|LOG_PANIC, NULL, fallback);
4021 /* If this transport has a setup function, call it now so that it gets
4022 run in this process and not in any subprocess. That way, the results of
4023 any setup that are retained by the transport can be reusable. One of the
4024 things the setup does is to set the fallback host lists in the addresses.
4025 That is why it is called at this point, before the continue delivery
4026 processing, because that might use the fallback hosts. */
4028 if (tp->setup != NULL)
4029 (void)((tp->setup)(addr->transport, addr, NULL, uid, gid, NULL));
4031 /* If this is a run to continue delivery down an already-established
4032 channel, check that this set of addresses matches the transport and
4033 the channel. If it does not, defer the addresses. If a host list exists,
4034 we must check that the continue host is on the list. Otherwise, the
4035 host is set in the transport. */
4037 continue_more = FALSE; /* In case got set for the last lot */
4038 if (continue_transport != NULL)
4040 BOOL ok = Ustrcmp(continue_transport, tp->name) == 0;
4041 if (ok && addr->host_list != NULL)
4045 for (h = addr->host_list; h != NULL; h = h->next)
4047 if (Ustrcmp(h->name, continue_hostname) == 0)
4048 { ok = TRUE; break; }
4052 /* Addresses not suitable; defer or queue for fallback hosts (which
4053 might be the continue host) and skip to next address. */
4057 DEBUG(D_deliver) debug_printf("not suitable for continue_transport\n");
4060 if (addr->fallback_hosts != NULL && !fallback)
4064 next->host_list = next->fallback_hosts;
4065 DEBUG(D_deliver) debug_printf("%s queued for fallback host(s)\n", next->address);
4066 if (next->next == NULL) break;
4069 next->next = addr_fallback;
4070 addr_fallback = addr;
4075 while (next->next != NULL) next = next->next;
4076 next->next = addr_defer;
4083 /* Set a flag indicating whether there are further addresses that list
4084 the continued host. This tells the transport to leave the channel open,
4085 but not to pass it to another delivery process. */
4087 for (next = addr_remote; next != NULL; next = next->next)
4090 for (h = next->host_list; h != NULL; h = h->next)
4092 if (Ustrcmp(h->name, continue_hostname) == 0)
4093 { continue_more = TRUE; break; }
4098 /* The transports set up the process info themselves as they may connect
4099 to more than one remote machine. They also have to set up the filter
4100 arguments, if required, so that the host name and address are available
4103 transport_filter_argv = NULL;
4105 /* Create the pipe for inter-process communication. If pipe creation
4106 fails, it is probably because the value of remote_max_parallel is so
4107 large that too many file descriptors for pipes have been created. Arrange
4108 to wait for a process to finish, and then try again. If we still can't
4109 create a pipe when all processes have finished, break the retry loop. */
4113 if (pipe(pfd) == 0) pipe_done = TRUE;
4114 else if (parcount > 0) parmax = parcount;
4117 /* We need to make the reading end of the pipe non-blocking. There are
4118 two different options for this. Exim is cunningly (I hope!) coded so
4119 that it can use either of them, though it prefers O_NONBLOCK, which
4120 distinguishes between EOF and no-more-data. */
4123 (void)fcntl(pfd[pipe_read], F_SETFL, O_NONBLOCK);
4125 (void)fcntl(pfd[pipe_read], F_SETFL, O_NDELAY);
4128 /* If the maximum number of subprocesses already exist, wait for a process
4129 to finish. If we ran out of file descriptors, parmax will have been reduced
4130 from its initial value of remote_max_parallel. */
4132 par_reduce(parmax - 1, fallback);
4135 /* If we failed to create a pipe and there were no processes to wait
4136 for, we have to give up on this one. Do this outside the above loop
4137 so that we can continue the main loop. */
4141 remote_post_process(addr, LOG_MAIN|LOG_PANIC,
4142 string_sprintf("unable to create pipe: %s", strerror(errno)), fallback);
4146 /* Find a free slot in the pardata list. Must do this after the possible
4147 waiting for processes to finish, because a terminating process will free
4150 for (poffset = 0; poffset < remote_max_parallel; poffset++)
4151 if (parlist[poffset].pid == 0) break;
4153 /* If there isn't one, there has been a horrible disaster. */
4155 if (poffset >= remote_max_parallel)
4157 (void)close(pfd[pipe_write]);
4158 (void)close(pfd[pipe_read]);
4159 remote_post_process(addr, LOG_MAIN|LOG_PANIC,
4160 US"Unexpectedly no free subprocess slot", fallback);
4164 /* Now fork a subprocess to do the remote delivery, but before doing so,
4165 ensure that any cached resourses are released so as not to interfere with
4166 what happens in the subprocess. */
4170 if ((pid = fork()) == 0)
4172 int fd = pfd[pipe_write];
4175 /* Setting this global in the subprocess means we need never clear it */
4176 transport_name = tp->name;
4178 /* There are weird circumstances in which logging is disabled */
4179 disable_logging = tp->disable_logging;
4181 /* Show pids on debug output if parallelism possible */
4183 if (parmax > 1 && (parcount > 0 || addr_remote != NULL))
4185 DEBUG(D_any|D_v) debug_selector |= D_pid;
4186 DEBUG(D_deliver) debug_printf("Remote delivery process started\n");
4189 /* Reset the random number generator, so different processes don't all
4190 have the same sequence. In the test harness we want different, but
4191 predictable settings for each delivery process, so do something explicit
4192 here rather they rely on the fixed reset in the random number function. */
4194 random_seed = running_in_test_harness? 42 + 2*delivery_count : 0;
4196 /* Set close-on-exec on the pipe so that it doesn't get passed on to
4197 a new process that may be forked to do another delivery down the same
4200 (void)fcntl(fd, F_SETFD, fcntl(fd, F_GETFD) | FD_CLOEXEC);
4202 /* Close open file descriptors for the pipes of other processes
4203 that are running in parallel. */
4205 for (poffset = 0; poffset < remote_max_parallel; poffset++)
4206 if (parlist[poffset].pid != 0) (void)close(parlist[poffset].fd);
4208 /* This process has inherited a copy of the file descriptor
4209 for the data file, but its file pointer is shared with all the
4210 other processes running in parallel. Therefore, we have to re-open
4211 the file in order to get a new file descriptor with its own
4212 file pointer. We don't need to lock it, as the lock is held by
4213 the parent process. There doesn't seem to be any way of doing
4214 a dup-with-new-file-pointer. */
4216 (void)close(deliver_datafile);
4217 sprintf(CS spoolname, "%s/input/%s/%s-D", spool_directory, message_subdir,
4219 deliver_datafile = Uopen(spoolname, O_RDWR | O_APPEND, 0);
4221 if (deliver_datafile < 0)
4222 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Failed to reopen %s for remote "
4223 "parallel delivery: %s", spoolname, strerror(errno));
4225 /* Set the close-on-exec flag */
4227 (void)fcntl(deliver_datafile, F_SETFD, fcntl(deliver_datafile, F_GETFD) |
4230 /* Set the uid/gid of this process; bombs out on failure. */
4232 exim_setugid(uid, gid, use_initgroups,
4233 string_sprintf("remote delivery to %s with transport=%s",
4234 addr->address, tp->name));
4236 /* Close the unwanted half of this process' pipe, set the process state,
4237 and run the transport. Afterwards, transport_count will contain the number
4238 of bytes written. */
4240 (void)close(pfd[pipe_read]);
4241 set_process_info("delivering %s using %s", message_id, tp->name);
4242 debug_print_string(tp->debug_string);
4243 if (!(tp->info->code)(addr->transport, addr)) replicate_status(addr);
4245 set_process_info("delivering %s (just run %s for %s%s in subprocess)",
4246 message_id, tp->name, addr->address, (addr->next == NULL)? "" : ", ...");
4248 /* Ensure any cached resources that we used are now released */
4252 /* Pass the result back down the pipe. This is a lot more information
4253 than is needed for a local delivery. We have to send back the error
4254 status for each address, the usability status for each host that is
4255 flagged as unusable, and all the retry items. When TLS is in use, we
4256 send also the cipher and peerdn information. Each type of information
4257 is flagged by an identifying byte, and is then in a fixed format (with
4258 strings terminated by zeros), and there is a final terminator at the
4259 end. The host information and retry information is all attached to
4260 the first address, so that gets sent at the start. */
4262 /* Host unusability information: for most success cases this will
4265 for (h = addr->host_list; h != NULL; h = h->next)
4267 if (h->address == NULL || h->status < hstatus_unusable) continue;
4268 sprintf(CS big_buffer, "%c%c%s", h->status, h->why, h->address);
4269 rmt_dlv_checked_write(fd, 'H', '0', big_buffer, Ustrlen(big_buffer+2) + 3);
4272 /* The number of bytes written. This is the same for each address. Even
4273 if we sent several copies of the message down the same connection, the
4274 size of each one is the same, and it's that value we have got because
4275 transport_count gets reset before calling transport_write_message(). */
4277 memcpy(big_buffer, &transport_count, sizeof(transport_count));
4278 rmt_dlv_checked_write(fd, 'S', '0', big_buffer, sizeof(transport_count));
4280 /* Information about what happened to each address. Four item types are
4281 used: an optional 'X' item first, for TLS information, then an optional "C"
4282 item for any client-auth info followed by 'R' items for any retry settings,
4283 and finally an 'A' item for the remaining data. */
4285 for(; addr != NULL; addr = addr->next)
4290 /* The certificate verification status goes into the flags */
4291 if (tls_out.certificate_verified) setflag(addr, af_cert_verified);
4292 #ifdef EXPERIMENTAL_DANE
4293 if (tls_out.dane_verified) setflag(addr, af_dane_verified);
4296 /* Use an X item only if there's something to send */
4301 sprintf(CS ptr, "%.128s", addr->cipher);
4307 sprintf(CS ptr, "%.512s", addr->peerdn);
4311 rmt_dlv_checked_write(fd, 'X', '1', big_buffer, ptr - big_buffer);
4316 if (!tls_export_cert(ptr, big_buffer_size-2, addr->peercert))
4320 rmt_dlv_checked_write(fd, 'X', '2', big_buffer, ptr - big_buffer);
4325 if (!tls_export_cert(ptr, big_buffer_size-2, addr->ourcert))
4329 rmt_dlv_checked_write(fd, 'X', '3', big_buffer, ptr - big_buffer);
4331 # ifndef DISABLE_OCSP
4332 if (addr->ocsp > OCSP_NOT_REQ)
4335 sprintf(CS ptr, "%c", addr->ocsp + '0');
4337 rmt_dlv_checked_write(fd, 'X', '4', big_buffer, ptr - big_buffer);
4340 #endif /*SUPPORT_TLS*/
4342 if (client_authenticator)
4345 sprintf(CS big_buffer, "%.64s", client_authenticator);
4347 rmt_dlv_checked_write(fd, 'C', '1', big_buffer, ptr - big_buffer);
4349 if (client_authenticated_id)
4352 sprintf(CS big_buffer, "%.64s", client_authenticated_id);
4354 rmt_dlv_checked_write(fd, 'C', '2', big_buffer, ptr - big_buffer);
4356 if (client_authenticated_sender)
4359 sprintf(CS big_buffer, "%.64s", client_authenticated_sender);
4361 rmt_dlv_checked_write(fd, 'C', '3', big_buffer, ptr - big_buffer);
4364 #ifndef DISABLE_PRDR
4365 if (addr->flags & af_prdr_used)
4366 rmt_dlv_checked_write(fd, 'P', '0', NULL, 0);
4369 memcpy(big_buffer, &addr->dsn_aware, sizeof(addr->dsn_aware));
4370 rmt_dlv_checked_write(fd, 'D', '0', big_buffer, sizeof(addr->dsn_aware));
4371 DEBUG(D_deliver) debug_printf("DSN write: addr->dsn_aware = %d\n", addr->dsn_aware);
4373 /* Retry information: for most success cases this will be null. */
4375 for (r = addr->retries; r != NULL; r = r->next)
4378 sprintf(CS big_buffer, "%c%.500s", r->flags, r->key);
4379 ptr = big_buffer + Ustrlen(big_buffer+2) + 3;
4380 memcpy(ptr, &(r->basic_errno), sizeof(r->basic_errno));
4381 ptr += sizeof(r->basic_errno);
4382 memcpy(ptr, &(r->more_errno), sizeof(r->more_errno));
4383 ptr += sizeof(r->more_errno);
4384 if (r->message == NULL) *ptr++ = 0; else
4386 sprintf(CS ptr, "%.512s", r->message);
4389 rmt_dlv_checked_write(fd, 'R', '0', big_buffer, ptr - big_buffer);
4392 /* The rest of the information goes in an 'A' item. */
4394 ptr = big_buffer + 2;
4395 sprintf(CS big_buffer, "%c%c", addr->transport_return,
4396 addr->special_action);
4397 memcpy(ptr, &(addr->basic_errno), sizeof(addr->basic_errno));
4398 ptr += sizeof(addr->basic_errno);
4399 memcpy(ptr, &(addr->more_errno), sizeof(addr->more_errno));
4400 ptr += sizeof(addr->more_errno);
4401 memcpy(ptr, &(addr->flags), sizeof(addr->flags));
4402 ptr += sizeof(addr->flags);
4404 if (addr->message == NULL) *ptr++ = 0; else
4406 sprintf(CS ptr, "%.1024s", addr->message);
4410 if (addr->user_message == NULL) *ptr++ = 0; else
4412 sprintf(CS ptr, "%.1024s", addr->user_message);
4416 if (addr->host_used == NULL) *ptr++ = 0; else
4418 sprintf(CS ptr, "%.256s", addr->host_used->name);
4420 sprintf(CS ptr, "%.64s", addr->host_used->address);
4422 memcpy(ptr, &(addr->host_used->port), sizeof(addr->host_used->port));
4423 ptr += sizeof(addr->host_used->port);
4425 /* DNS lookup status */
4426 *ptr++ = addr->host_used->dnssec==DS_YES ? '2'
4427 : addr->host_used->dnssec==DS_NO ? '1' : '0';
4430 rmt_dlv_checked_write(fd, 'A', '0', big_buffer, ptr - big_buffer);
4433 /* Add termination flag, close the pipe, and that's it. The character
4434 after 'Z' indicates whether continue_transport is now NULL or not.
4435 A change from non-NULL to NULL indicates a problem with a continuing
4438 big_buffer[0] = (continue_transport == NULL)? '0' : '1';
4439 rmt_dlv_checked_write(fd, 'Z', '0', big_buffer, 1);
4444 /* Back in the mainline: close the unwanted half of the pipe. */
4446 (void)close(pfd[pipe_write]);
4448 /* Fork failed; defer with error message */
4452 (void)close(pfd[pipe_read]);
4453 remote_post_process(addr, LOG_MAIN|LOG_PANIC,
4454 string_sprintf("fork failed for remote delivery to %s: %s",
4455 addr->domain, strerror(errno)), fallback);
4459 /* Fork succeeded; increment the count, and remember relevant data for
4460 when the process finishes. */
4463 parlist[poffset].addrlist = parlist[poffset].addr = addr;
4464 parlist[poffset].pid = pid;
4465 parlist[poffset].fd = pfd[pipe_read];
4466 parlist[poffset].done = FALSE;
4467 parlist[poffset].msg = NULL;
4468 parlist[poffset].return_path = return_path;
4470 /* If the process we've just started is sending a message down an existing
4471 channel, wait for it now. This ensures that only one such process runs at
4472 once, whatever the value of remote_max parallel. Otherwise, we might try to
4473 send two or more messages simultaneously down the same channel. This could
4474 happen if there are different domains that include the same host in otherwise
4475 different host lists.
4477 Also, if the transport closes down the channel, this information gets back
4478 (continue_transport gets set to NULL) before we consider any other addresses
4481 if (continue_transport != NULL) par_reduce(0, fallback);
4483 /* Otherwise, if we are running in the test harness, wait a bit, to let the
4484 newly created process get going before we create another process. This should
4485 ensure repeatability in the tests. We only need to wait a tad. */
4487 else if (running_in_test_harness) millisleep(500);
4490 /* Reached the end of the list of addresses. Wait for all the subprocesses that
4491 are still running and post-process their addresses. */
4493 par_reduce(0, fallback);
4500 /*************************************************
4501 * Split an address into local part and domain *
4502 *************************************************/
4504 /* This function initializes an address for routing by splitting it up into a
4505 local part and a domain. The local part is set up twice - once in its original
4506 casing, and once in lower case, and it is dequoted. We also do the "percent
4507 hack" for configured domains. This may lead to a DEFER result if a lookup
4508 defers. When a percent-hacking takes place, we insert a copy of the original
4509 address as a new parent of this address, as if we have had a redirection.
4512 addr points to an addr_item block containing the address
4515 DEFER - could not determine if domain is %-hackable
4519 deliver_split_address(address_item *addr)
4521 uschar *address = addr->address;
4522 uschar *domain = Ustrrchr(address, '@');
4524 int len = domain - address;
4526 addr->domain = string_copylc(domain+1); /* Domains are always caseless */
4528 /* The implication in the RFCs (though I can't say I've seen it spelled out
4529 explicitly) is that quoting should be removed from local parts at the point
4530 where they are locally interpreted. [The new draft "821" is more explicit on
4531 this, Jan 1999.] We know the syntax is valid, so this can be done by simply
4532 removing quoting backslashes and any unquoted doublequotes. */
4534 t = addr->cc_local_part = store_get(len+1);
4537 register int c = *address++;
4538 if (c == '\"') continue;
4548 /* We do the percent hack only for those domains that are listed in
4549 percent_hack_domains. A loop is required, to copy with multiple %-hacks. */
4551 if (percent_hack_domains != NULL)
4554 uschar *new_address = NULL;
4555 uschar *local_part = addr->cc_local_part;
4557 deliver_domain = addr->domain; /* set $domain */
4559 while ((rc = match_isinlist(deliver_domain, &percent_hack_domains, 0,
4560 &domainlist_anchor, addr->domain_cache, MCL_DOMAIN, TRUE, NULL))
4562 (t = Ustrrchr(local_part, '%')) != NULL)
4564 new_address = string_copy(local_part);
4565 new_address[t - local_part] = '@';
4566 deliver_domain = string_copylc(t+1);
4567 local_part = string_copyn(local_part, t - local_part);
4570 if (rc == DEFER) return DEFER; /* lookup deferred */
4572 /* If hackery happened, set up new parent and alter the current address. */
4574 if (new_address != NULL)
4576 address_item *new_parent = store_get(sizeof(address_item));
4577 *new_parent = *addr;
4578 addr->parent = new_parent;
4579 addr->address = new_address;
4580 addr->unique = string_copy(new_address);
4581 addr->domain = deliver_domain;
4582 addr->cc_local_part = local_part;
4583 DEBUG(D_deliver) debug_printf("%%-hack changed address to: %s\n",
4588 /* Create the lowercased version of the final local part, and make that the
4589 default one to be used. */
4591 addr->local_part = addr->lc_local_part = string_copylc(addr->cc_local_part);
4598 /*************************************************
4599 * Get next error message text *
4600 *************************************************/
4602 /* If f is not NULL, read the next "paragraph", from a customized error message
4603 text file, terminated by a line containing ****, and expand it.
4606 f NULL or a file to read from
4607 which string indicating which string (for errors)
4609 Returns: NULL or an expanded string
4613 next_emf(FILE *f, uschar *which)
4617 uschar *para, *yield;
4620 if (f == NULL) return NULL;
4622 if (Ufgets(buffer, sizeof(buffer), f) == NULL ||
4623 Ustrcmp(buffer, "****\n") == 0) return NULL;
4625 para = store_get(size);
4628 para = string_cat(para, &size, &ptr, buffer, Ustrlen(buffer));
4629 if (Ufgets(buffer, sizeof(buffer), f) == NULL ||
4630 Ustrcmp(buffer, "****\n") == 0) break;
4634 yield = expand_string(para);
4635 if (yield != NULL) return yield;
4637 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand string from "
4638 "bounce_message_file or warn_message_file (%s): %s", which,
4639 expand_string_message);
4646 /*************************************************
4647 * Close down a passed transport channel *
4648 *************************************************/
4650 /* This function is called when a passed transport channel cannot be used.
4651 It attempts to close it down tidily. The yield is always DELIVER_NOT_ATTEMPTED
4652 so that the function call can be the argument of a "return" statement.
4655 Returns: DELIVER_NOT_ATTEMPTED
4659 continue_closedown(void)
4661 if (continue_transport != NULL)
4663 transport_instance *t;
4664 for (t = transports; t != NULL; t = t->next)
4666 if (Ustrcmp(t->name, continue_transport) == 0)
4668 if (t->info->closedown != NULL) (t->info->closedown)(t);
4673 return DELIVER_NOT_ATTEMPTED;
4679 /*************************************************
4680 * Print address information *
4681 *************************************************/
4683 /* This function is called to output an address, or information about an
4684 address, for bounce or defer messages. If the hide_child flag is set, all we
4685 output is the original ancestor address.
4688 addr points to the address
4689 f the FILE to print to
4690 si an initial string
4691 sc a continuation string for before "generated"
4694 Returns: TRUE if the address is not hidden
4698 print_address_information(address_item *addr, FILE *f, uschar *si, uschar *sc,
4702 uschar *printed = US"";
4703 address_item *ancestor = addr;
4704 while (ancestor->parent != NULL) ancestor = ancestor->parent;
4706 fprintf(f, "%s", CS si);
4708 if (addr->parent != NULL && testflag(addr, af_hide_child))
4710 printed = US"an undisclosed address";
4713 else if (!testflag(addr, af_pfr) || addr->parent == NULL)
4714 printed = addr->address;
4718 uschar *s = addr->address;
4721 if (addr->address[0] == '>') { ss = US"mail"; s++; }
4722 else if (addr->address[0] == '|') ss = US"pipe";
4725 fprintf(f, "%s to %s%sgenerated by ", ss, s, sc);
4726 printed = addr->parent->address;
4729 fprintf(f, "%s", CS string_printing(printed));
4731 if (ancestor != addr)
4733 uschar *original = (ancestor->onetime_parent == NULL)?
4734 ancestor->address : ancestor->onetime_parent;
4735 if (strcmpic(original, printed) != 0)
4736 fprintf(f, "%s(%sgenerated from %s)", sc,
4737 (ancestor != addr->parent)? "ultimately " : "",
4738 string_printing(original));
4741 if (addr->host_used)
4742 fprintf(f, "\n host %s [%s]",
4743 addr->host_used->name, addr->host_used->address);
4745 fprintf(f, "%s", CS se);
4753 /*************************************************
4754 * Print error for an address *
4755 *************************************************/
4757 /* This function is called to print the error information out of an address for
4758 a bounce or a warning message. It tries to format the message reasonably by
4759 introducing newlines. All lines are indented by 4; the initial printing
4760 position must be set before calling.
4762 This function used always to print the error. Nowadays we want to restrict it
4763 to cases such as LMTP/SMTP errors from a remote host, and errors from :fail:
4764 and filter "fail". We no longer pass other information willy-nilly in bounce
4765 and warning messages. Text in user_message is always output; text in message
4766 only if the af_pass_message flag is set.
4770 f the FILE to print on
4777 print_address_error(address_item *addr, FILE *f, uschar *t)
4779 int count = Ustrlen(t);
4780 uschar *s = testflag(addr, af_pass_message)? addr->message : NULL;
4784 if (addr->user_message != NULL) s = addr->user_message; else return;
4787 fprintf(f, "\n %s", t);
4791 if (*s == '\\' && s[1] == 'n')
4801 if (*s++ == ':' && isspace(*s) && count > 45)
4803 fprintf(f, "\n "); /* sic (because space follows) */
4811 /***********************************************************
4812 * Print Diagnostic-Code for an address *
4813 ************************************************************/
4815 /* This function is called to print the error information out of an address for
4816 a bounce or a warning message. It tries to format the message reasonably as
4817 required by RFC 3461 by adding a space after each newline
4819 we assume that this function is only called if addr->host_used is set and if so
4820 a useable addr->message is available containing some Exim description with ": \n"
4821 ending, followed by the L/SMTP error message.
4825 f the FILE to print on
4831 print_dsn_diagnostic_code(const address_item *addr, FILE *f)
4835 /* check host_used, af_pass_message flag and addr->message for safety reasons */
4836 if (!addr->host_used && testflag(addr, af_pass_message) && addr->message)
4839 /* search first ": ". we assume to find the remote-MTA answer there */
4841 debug_printf("DSN Diagnostic-Code: addr->dsn_message = %s\n", addr->message);
4842 if (!(s = Ustrstr(addr->message, ": ")))
4843 return; /* not found, bail out */
4845 fprintf(f, "Diagnostic-Code: smtp; ");
4847 s += 2; /* skip ": " */
4849 if (*s == '\\' && s[1] == 'n')
4851 fputs("\n ", f); /* as defined in RFC 3461 */
4861 /*************************************************
4862 * Check list of addresses for duplication *
4863 *************************************************/
4865 /* This function was introduced when the test for duplicate addresses that are
4866 not pipes, files, or autoreplies was moved from the middle of routing to when
4867 routing was complete. That was to fix obscure cases when the routing history
4868 affects the subsequent routing of identical addresses. This function is called
4869 after routing, to check that the final routed addresses are not duplicates.
4871 If we detect a duplicate, we remember what it is a duplicate of. Note that
4872 pipe, file, and autoreply de-duplication is handled during routing, so we must
4873 leave such "addresses" alone here, as otherwise they will incorrectly be
4876 Argument: address of list anchor
4881 do_duplicate_check(address_item **anchor)
4884 while ((addr = *anchor) != NULL)
4887 if (testflag(addr, af_pfr))
4889 anchor = &(addr->next);
4891 else if ((tnode = tree_search(tree_duplicates, addr->unique)) != NULL)
4893 DEBUG(D_deliver|D_route)
4894 debug_printf("%s is a duplicate address: discarded\n", addr->unique);
4895 *anchor = addr->next;
4896 addr->dupof = tnode->data.ptr;
4897 addr->next = addr_duplicate;
4898 addr_duplicate = addr;
4902 tree_add_duplicate(addr->unique, addr);
4903 anchor = &(addr->next);
4911 /*************************************************
4912 * Deliver one message *
4913 *************************************************/
4915 /* This is the function which is called when a message is to be delivered. It
4916 is passed the id of the message. It is possible that the message no longer
4917 exists, if some other process has delivered it, and it is also possible that
4918 the message is being worked on by another process, in which case the data file
4921 If no delivery is attempted for any of the above reasons, the function returns
4922 DELIVER_NOT_ATTEMPTED.
4924 If the give_up flag is set true, do not attempt any deliveries, but instead
4925 fail all outstanding addresses and return the message to the sender (or
4928 A delivery operation has a process all to itself; we never deliver more than
4929 one message in the same process. Therefore we needn't worry too much about
4933 id the id of the message to be delivered
4934 forced TRUE if delivery was forced by an administrator; this overrides
4935 retry delays and causes a delivery to be tried regardless
4936 give_up TRUE if an administrator has requested that delivery attempts
4939 Returns: When the global variable mua_wrapper is FALSE:
4940 DELIVER_ATTEMPTED_NORMAL if a delivery attempt was made
4941 DELIVER_NOT_ATTEMPTED otherwise (see comment above)
4942 When the global variable mua_wrapper is TRUE:
4943 DELIVER_MUA_SUCCEEDED if delivery succeeded
4944 DELIVER_MUA_FAILED if delivery failed
4945 DELIVER_NOT_ATTEMPTED if not attempted (should not occur)
4949 deliver_message(uschar *id, BOOL forced, BOOL give_up)
4952 int final_yield = DELIVER_ATTEMPTED_NORMAL;
4953 time_t now = time(NULL);
4954 address_item *addr_last = NULL;
4955 uschar *filter_message = NULL;
4957 int process_recipients = RECIP_ACCEPT;
4960 extern int acl_where;
4962 uschar *info = (queue_run_pid == (pid_t)0)?
4963 string_sprintf("delivering %s", id) :
4964 string_sprintf("delivering %s (queue run pid %d)", id, queue_run_pid);
4966 /* If the D_process_info bit is on, set_process_info() will output debugging
4967 information. If not, we want to show this initial information if D_deliver or
4968 D_queue_run is set or in verbose mode. */
4970 set_process_info("%s", info);
4972 if ((debug_selector & D_process_info) == 0 &&
4973 (debug_selector & (D_deliver|D_queue_run|D_v)) != 0)
4974 debug_printf("%s\n", info);
4976 /* Ensure that we catch any subprocesses that are created. Although Exim
4977 sets SIG_DFL as its initial default, some routes through the code end up
4978 here with it set to SIG_IGN - cases where a non-synchronous delivery process
4979 has been forked, but no re-exec has been done. We use sigaction rather than
4980 plain signal() on those OS where SA_NOCLDWAIT exists, because we want to be
4981 sure it is turned off. (There was a problem on AIX with this.) */
4985 struct sigaction act;
4986 act.sa_handler = SIG_DFL;
4987 sigemptyset(&(act.sa_mask));
4989 sigaction(SIGCHLD, &act, NULL);
4992 signal(SIGCHLD, SIG_DFL);
4995 /* Make the forcing flag available for routers and transports, set up the
4996 global message id field, and initialize the count for returned files and the
4997 message size. This use of strcpy() is OK because the length id is checked when
4998 it is obtained from a command line (the -M or -q options), and otherwise it is
4999 known to be a valid message id. */
5001 Ustrcpy(message_id, id);
5002 deliver_force = forced;
5006 /* Initialize some flags */
5008 update_spool = FALSE;
5009 remove_journal = TRUE;
5011 /* Set a known context for any ACLs we call via expansions */
5012 acl_where = ACL_WHERE_DELIVERY;
5014 /* Reset the random number generator, so that if several delivery processes are
5015 started from a queue runner that has already used random numbers (for sorting),
5016 they don't all get the same sequence. */
5020 /* Open and lock the message's data file. Exim locks on this one because the
5021 header file may get replaced as it is re-written during the delivery process.
5022 Any failures cause messages to be written to the log, except for missing files
5023 while queue running - another process probably completed delivery. As part of
5024 opening the data file, message_subdir gets set. */
5026 if (!spool_open_datafile(id))
5027 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5029 /* The value of message_size at this point has been set to the data length,
5030 plus one for the blank line that notionally precedes the data. */
5032 /* Now read the contents of the header file, which will set up the headers in
5033 store, and also the list of recipients and the tree of non-recipients and
5034 assorted flags. It updates message_size. If there is a reading or format error,
5035 give up; if the message has been around for sufficiently long, remove it. */
5037 sprintf(CS spoolname, "%s-H", id);
5038 if ((rc = spool_read_header(spoolname, TRUE, TRUE)) != spool_read_OK)
5040 if (errno == ERRNO_SPOOLFORMAT)
5042 struct stat statbuf;
5043 sprintf(CS big_buffer, "%s/input/%s/%s", spool_directory, message_subdir,
5045 if (Ustat(big_buffer, &statbuf) == 0)
5046 log_write(0, LOG_MAIN, "Format error in spool file %s: "
5047 "size=" OFF_T_FMT, spoolname, statbuf.st_size);
5048 else log_write(0, LOG_MAIN, "Format error in spool file %s", spoolname);
5051 log_write(0, LOG_MAIN, "Error reading spool file %s: %s", spoolname,
5054 /* If we managed to read the envelope data, received_time contains the
5055 time the message was received. Otherwise, we can calculate it from the
5058 if (rc != spool_read_hdrerror)
5061 for (i = 0; i < 6; i++)
5062 received_time = received_time * BASE_62 + tab62[id[i] - '0'];
5065 /* If we've had this malformed message too long, sling it. */
5067 if (now - received_time > keep_malformed)
5069 sprintf(CS spoolname, "%s/msglog/%s/%s", spool_directory, message_subdir, id);
5071 sprintf(CS spoolname, "%s/input/%s/%s-D", spool_directory, message_subdir, id);
5073 sprintf(CS spoolname, "%s/input/%s/%s-H", spool_directory, message_subdir, id);
5075 sprintf(CS spoolname, "%s/input/%s/%s-J", spool_directory, message_subdir, id);
5077 log_write(0, LOG_MAIN, "Message removed because older than %s",
5078 readconf_printtime(keep_malformed));
5081 (void)close(deliver_datafile);
5082 deliver_datafile = -1;
5083 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5086 /* The spool header file has been read. Look to see if there is an existing
5087 journal file for this message. If there is, it means that a previous delivery
5088 attempt crashed (program or host) before it could update the spool header file.
5089 Read the list of delivered addresses from the journal and add them to the
5090 nonrecipients tree. Then update the spool file. We can leave the journal in
5091 existence, as it will get further successful deliveries added to it in this
5092 run, and it will be deleted if this function gets to its end successfully.
5093 Otherwise it might be needed again. */
5095 sprintf(CS spoolname, "%s/input/%s/%s-J", spool_directory, message_subdir, id);
5096 jread = Ufopen(spoolname, "rb");
5099 while (Ufgets(big_buffer, big_buffer_size, jread) != NULL)
5101 int n = Ustrlen(big_buffer);
5102 big_buffer[n-1] = 0;
5103 tree_add_nonrecipient(big_buffer);
5104 DEBUG(D_deliver) debug_printf("Previously delivered address %s taken from "
5105 "journal file\n", big_buffer);
5107 (void)fclose(jread);
5108 /* Panic-dies on error */
5109 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
5111 else if (errno != ENOENT)
5113 log_write(0, LOG_MAIN|LOG_PANIC, "attempt to open journal for reading gave: "
5114 "%s", strerror(errno));
5115 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5118 /* A null recipients list indicates some kind of disaster. */
5120 if (recipients_list == NULL)
5122 (void)close(deliver_datafile);
5123 deliver_datafile = -1;
5124 log_write(0, LOG_MAIN, "Spool error: no recipients for %s", spoolname);
5125 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5129 /* Handle a message that is frozen. There are a number of different things that
5130 can happen, but in the default situation, unless forced, no delivery is
5135 #ifdef SUPPORT_MOVE_FROZEN_MESSAGES
5136 /* Moving to another directory removes the message from Exim's view. Other
5137 tools must be used to deal with it. Logging of this action happens in
5138 spool_move_message() and its subfunctions. */
5140 if (move_frozen_messages &&
5141 spool_move_message(id, message_subdir, US"", US"F"))
5142 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5145 /* For all frozen messages (bounces or not), timeout_frozen_after sets the
5146 maximum time to keep messages that are frozen. Thaw if we reach it, with a
5147 flag causing all recipients to be failed. The time is the age of the
5148 message, not the time since freezing. */
5150 if (timeout_frozen_after > 0 && message_age >= timeout_frozen_after)
5152 log_write(0, LOG_MAIN, "cancelled by timeout_frozen_after");
5153 process_recipients = RECIP_FAIL_TIMEOUT;
5156 /* For bounce messages (and others with no sender), thaw if the error message
5157 ignore timer is exceeded. The message will be discarded if this delivery
5160 else if (sender_address[0] == 0 && message_age >= ignore_bounce_errors_after)
5162 log_write(0, LOG_MAIN, "Unfrozen by errmsg timer");
5165 /* If this is a bounce message, or there's no auto thaw, or we haven't
5166 reached the auto thaw time yet, and this delivery is not forced by an admin
5167 user, do not attempt delivery of this message. Note that forced is set for
5168 continuing messages down the same channel, in order to skip load checking and
5169 ignore hold domains, but we don't want unfreezing in that case. */
5173 if ((sender_address[0] == 0 ||
5175 now <= deliver_frozen_at + auto_thaw
5178 (!forced || !deliver_force_thaw || !admin_user ||
5179 continue_hostname != NULL
5182 (void)close(deliver_datafile);
5183 deliver_datafile = -1;
5184 log_write(L_skip_delivery, LOG_MAIN, "Message is frozen");
5185 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5188 /* If delivery was forced (by an admin user), assume a manual thaw.
5189 Otherwise it's an auto thaw. */
5193 deliver_manual_thaw = TRUE;
5194 log_write(0, LOG_MAIN, "Unfrozen by forced delivery");
5196 else log_write(0, LOG_MAIN, "Unfrozen by auto-thaw");
5199 /* We get here if any of the rules for unfreezing have triggered. */
5201 deliver_freeze = FALSE;
5202 update_spool = TRUE;
5206 /* Open the message log file if we are using them. This records details of
5207 deliveries, deferments, and failures for the benefit of the mail administrator.
5208 The log is not used by exim itself to track the progress of a message; that is
5209 done by rewriting the header spool file. */
5216 sprintf(CS spoolname, "%s/msglog/%s/%s", spool_directory, message_subdir, id);
5217 fd = open_msglog_file(spoolname, SPOOL_MODE, &error);
5221 log_write(0, LOG_MAIN|LOG_PANIC, "Couldn't %s message log %s: %s", error,
5222 spoolname, strerror(errno));
5223 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5226 /* Make a C stream out of it. */
5228 message_log = fdopen(fd, "a");
5229 if (message_log == NULL)
5231 log_write(0, LOG_MAIN|LOG_PANIC, "Couldn't fdopen message log %s: %s",
5232 spoolname, strerror(errno));
5233 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5238 /* If asked to give up on a message, log who did it, and set the action for all
5243 struct passwd *pw = getpwuid(real_uid);
5244 log_write(0, LOG_MAIN, "cancelled by %s", (pw != NULL)?
5245 US pw->pw_name : string_sprintf("uid %ld", (long int)real_uid));
5246 process_recipients = RECIP_FAIL;
5249 /* Otherwise, if there are too many Received: headers, fail all recipients. */
5251 else if (received_count > received_headers_max)
5252 process_recipients = RECIP_FAIL_LOOP;
5254 /* Otherwise, if a system-wide, address-independent message filter is
5255 specified, run it now, except in the case when we are failing all recipients as
5256 a result of timeout_frozen_after. If the system filter yields "delivered", then
5257 ignore the true recipients of the message. Failure of the filter file is
5258 logged, and the delivery attempt fails. */
5260 else if (system_filter != NULL && process_recipients != RECIP_FAIL_TIMEOUT)
5265 redirect_block redirect;
5267 if (system_filter_uid_set)
5269 ugid.uid = system_filter_uid;
5270 ugid.gid = system_filter_gid;
5271 ugid.uid_set = ugid.gid_set = TRUE;
5275 ugid.uid_set = ugid.gid_set = FALSE;
5278 return_path = sender_address;
5279 enable_dollar_recipients = TRUE; /* Permit $recipients in system filter */
5280 system_filtering = TRUE;
5282 /* Any error in the filter file causes a delivery to be abandoned. */
5284 redirect.string = system_filter;
5285 redirect.isfile = TRUE;
5286 redirect.check_owner = redirect.check_group = FALSE;
5287 redirect.owners = NULL;
5288 redirect.owngroups = NULL;
5290 redirect.modemask = 0;
5292 DEBUG(D_deliver|D_filter) debug_printf("running system filter\n");
5295 &redirect, /* Where the data is */
5296 RDO_DEFER | /* Turn on all the enabling options */
5297 RDO_FAIL | /* Leave off all the disabling options */
5302 NULL, /* No :include: restriction (not used in filter) */
5303 NULL, /* No sieve vacation directory (not sieve!) */
5304 NULL, /* No sieve enotify mailto owner (not sieve!) */
5305 NULL, /* No sieve user address (not sieve!) */
5306 NULL, /* No sieve subaddress (not sieve!) */
5307 &ugid, /* uid/gid data */
5308 &addr_new, /* Where to hang generated addresses */
5309 &filter_message, /* Where to put error message */
5310 NULL, /* Don't skip syntax errors */
5311 &filtertype, /* Will always be set to FILTER_EXIM for this call */
5312 US"system filter"); /* For error messages */
5314 DEBUG(D_deliver|D_filter) debug_printf("system filter returned %d\n", rc);
5316 if (rc == FF_ERROR || rc == FF_NONEXIST)
5318 (void)close(deliver_datafile);
5319 deliver_datafile = -1;
5320 log_write(0, LOG_MAIN|LOG_PANIC, "Error in system filter: %s",
5321 string_printing(filter_message));
5322 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5325 /* Reset things. If the filter message is an empty string, which can happen
5326 for a filter "fail" or "freeze" command with no text, reset it to NULL. */
5328 system_filtering = FALSE;
5329 enable_dollar_recipients = FALSE;
5330 if (filter_message != NULL && filter_message[0] == 0) filter_message = NULL;
5332 /* Save the values of the system filter variables so that user filters
5335 memcpy(filter_sn, filter_n, sizeof(filter_sn));
5337 /* The filter can request that delivery of the original addresses be
5342 process_recipients = RECIP_DEFER;
5343 deliver_msglog("Delivery deferred by system filter\n");
5344 log_write(0, LOG_MAIN, "Delivery deferred by system filter");
5347 /* The filter can request that a message be frozen, but this does not
5348 take place if the message has been manually thawed. In that case, we must
5349 unset "delivered", which is forced by the "freeze" command to make -bF
5352 else if (rc == FF_FREEZE && !deliver_manual_thaw)
5354 deliver_freeze = TRUE;
5355 deliver_frozen_at = time(NULL);
5356 process_recipients = RECIP_DEFER;
5357 frozen_info = string_sprintf(" by the system filter%s%s",
5358 (filter_message == NULL)? US"" : US": ",
5359 (filter_message == NULL)? US"" : filter_message);
5362 /* The filter can request that a message be failed. The error message may be
5363 quite long - it is sent back to the sender in the bounce - but we don't want
5364 to fill up the log with repetitions of it. If it starts with << then the text
5365 between << and >> is written to the log, with the rest left for the bounce
5368 else if (rc == FF_FAIL)
5370 uschar *colon = US"";
5371 uschar *logmsg = US"";
5374 process_recipients = RECIP_FAIL_FILTER;
5376 if (filter_message != NULL)
5380 if (filter_message[0] == '<' && filter_message[1] == '<' &&
5381 (logend = Ustrstr(filter_message, ">>")) != NULL)
5383 logmsg = filter_message + 2;
5384 loglen = logend - logmsg;
5385 filter_message = logend + 2;
5386 if (filter_message[0] == 0) filter_message = NULL;
5390 logmsg = filter_message;
5391 loglen = Ustrlen(filter_message);
5395 log_write(0, LOG_MAIN, "cancelled by system filter%s%.*s", colon, loglen,
5399 /* Delivery can be restricted only to those recipients (if any) that the
5400 filter specified. */
5402 else if (rc == FF_DELIVERED)
5404 process_recipients = RECIP_IGNORE;
5405 if (addr_new == NULL)
5406 log_write(0, LOG_MAIN, "=> discarded (system filter)");
5408 log_write(0, LOG_MAIN, "original recipients ignored (system filter)");
5411 /* If any new addresses were created by the filter, fake up a "parent"
5412 for them. This is necessary for pipes, etc., which are expected to have
5413 parents, and it also gives some sensible logging for others. Allow
5414 pipes, files, and autoreplies, and run them as the filter uid if set,
5415 otherwise as the current uid. */
5417 if (addr_new != NULL)
5419 int uid = (system_filter_uid_set)? system_filter_uid : geteuid();
5420 int gid = (system_filter_gid_set)? system_filter_gid : getegid();
5422 /* The text "system-filter" is tested in transport_set_up_command() and in
5423 set_up_shell_command() in the pipe transport, to enable them to permit
5424 $recipients, so don't change it here without also changing it there. */
5426 address_item *p = addr_new;
5427 address_item *parent = deliver_make_addr(US"system-filter", FALSE);
5429 parent->domain = string_copylc(qualify_domain_recipient);
5430 parent->local_part = US"system-filter";
5432 /* As part of this loop, we arrange for addr_last to end up pointing
5433 at the final address. This is used if we go on to add addresses for the
5434 original recipients. */
5438 if (parent->child_count == SHRT_MAX)
5439 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "system filter generated more "
5440 "than %d delivery addresses", SHRT_MAX);
5441 parent->child_count++;
5444 if (testflag(p, af_pfr))
5450 setflag(p, af_uid_set |
5456 /* Find the name of the system filter's appropriate pfr transport */
5458 if (p->address[0] == '|')
5461 tpname = system_filter_pipe_transport;
5462 address_pipe = p->address;
5464 else if (p->address[0] == '>')
5467 tpname = system_filter_reply_transport;
5471 if (p->address[Ustrlen(p->address)-1] == '/')
5473 type = US"directory";
5474 tpname = system_filter_directory_transport;
5479 tpname = system_filter_file_transport;
5481 address_file = p->address;
5484 /* Now find the actual transport, first expanding the name. We have
5485 set address_file or address_pipe above. */
5489 uschar *tmp = expand_string(tpname);
5490 address_file = address_pipe = NULL;
5492 p->message = string_sprintf("failed to expand \"%s\" as a "
5493 "system filter transport name", tpname);
5498 p->message = string_sprintf("system_filter_%s_transport is unset",
5504 transport_instance *tp;
5505 for (tp = transports; tp != NULL; tp = tp->next)
5507 if (Ustrcmp(tp->name, tpname) == 0)
5514 p->message = string_sprintf("failed to find \"%s\" transport "
5515 "for system filter delivery", tpname);
5518 /* If we couldn't set up a transport, defer the delivery, putting the
5519 error on the panic log as well as the main log. */
5521 if (p->transport == NULL)
5523 address_item *badp = p;
5525 if (addr_last == NULL) addr_new = p; else addr_last->next = p;
5526 badp->local_part = badp->address; /* Needed for log line */
5527 post_process_one(badp, DEFER, LOG_MAIN|LOG_PANIC, DTYPE_ROUTER, 0);
5530 } /* End of pfr handling */
5532 /* Either a non-pfr delivery, or we found a transport */
5534 DEBUG(D_deliver|D_filter)
5535 debug_printf("system filter added %s\n", p->address);
5539 } /* Loop through all addr_new addresses */
5544 /* Scan the recipients list, and for every one that is not in the non-
5545 recipients tree, add an addr item to the chain of new addresses. If the pno
5546 value is non-negative, we must set the onetime parent from it. This which
5547 points to the relevant entry in the recipients list.
5549 This processing can be altered by the setting of the process_recipients
5550 variable, which is changed if recipients are to be ignored, failed, or
5551 deferred. This can happen as a result of system filter activity, or if the -Mg
5552 option is used to fail all of them.
5554 Duplicate addresses are handled later by a different tree structure; we can't
5555 just extend the non-recipients tree, because that will be re-written to the
5556 spool if the message is deferred, and in any case there are casing
5557 complications for local addresses. */
5559 if (process_recipients != RECIP_IGNORE)
5561 for (i = 0; i < recipients_count; i++)
5563 if (tree_search(tree_nonrecipients, recipients_list[i].address) == NULL)
5565 recipient_item *r = recipients_list + i;
5566 address_item *new = deliver_make_addr(r->address, FALSE);
5567 new->p.errors_address = r->errors_to;
5570 new->onetime_parent = recipients_list[r->pno].address;
5572 /* If DSN support is enabled, set the dsn flags and the original receipt
5573 to be passed on to other DSN enabled MTAs */
5574 new->dsn_flags = r->dsn_flags & rf_dsnflags;
5575 new->dsn_orcpt = r->orcpt;
5576 DEBUG(D_deliver) debug_printf("DSN: set orcpt: %s flags: %d\n", new->dsn_orcpt, new->dsn_flags);
5578 switch (process_recipients)
5580 /* RECIP_DEFER is set when a system filter freezes a message. */
5583 new->next = addr_defer;
5588 /* RECIP_FAIL_FILTER is set when a system filter has obeyed a "fail"
5591 case RECIP_FAIL_FILTER:
5593 (filter_message == NULL)? US"delivery cancelled" : filter_message;
5594 setflag(new, af_pass_message);
5595 goto RECIP_QUEUE_FAILED; /* below */
5598 /* RECIP_FAIL_TIMEOUT is set when a message is frozen, but is older
5599 than the value in timeout_frozen_after. Treat non-bounce messages
5600 similarly to -Mg; for bounce messages we just want to discard, so
5601 don't put the address on the failed list. The timeout has already
5604 case RECIP_FAIL_TIMEOUT:
5605 new->message = US"delivery cancelled; message timed out";
5606 goto RECIP_QUEUE_FAILED; /* below */
5609 /* RECIP_FAIL is set when -Mg has been used. */
5612 new->message = US"delivery cancelled by administrator";
5615 /* Common code for the failure cases above. If this is not a bounce
5616 message, put the address on the failed list so that it is used to
5617 create a bounce. Otherwise do nothing - this just discards the address.
5618 The incident has already been logged. */
5621 if (sender_address[0] != 0)
5623 new->next = addr_failed;
5629 /* RECIP_FAIL_LOOP is set when there are too many Received: headers
5630 in the message. Process each address as a routing failure; if this
5631 is a bounce message, it will get frozen. */
5633 case RECIP_FAIL_LOOP:
5634 new->message = US"Too many \"Received\" headers - suspected mail loop";
5635 post_process_one(new, FAIL, LOG_MAIN, DTYPE_ROUTER, 0);
5639 /* Value should be RECIP_ACCEPT; take this as the safe default. */
5642 if (addr_new == NULL) addr_new = new; else addr_last->next = new;
5647 #ifdef EXPERIMENTAL_EVENT
5648 if (process_recipients != RECIP_ACCEPT)
5650 uschar * save_local = deliver_localpart;
5651 uschar * save_domain = deliver_domain;
5653 deliver_localpart = expand_string(
5654 string_sprintf("${local_part:%s}", new->address));
5655 deliver_domain = expand_string(
5656 string_sprintf("${domain:%s}", new->address));
5658 (void) event_raise(event_action,
5659 US"msg:fail:internal", new->message);
5661 deliver_localpart = save_local;
5662 deliver_domain = save_domain;
5671 address_item *p = addr_new;
5672 debug_printf("Delivery address list:\n");
5675 debug_printf(" %s %s\n", p->address, (p->onetime_parent == NULL)? US"" :
5681 /* Set up the buffers used for copying over the file when delivering. */
5683 deliver_in_buffer = store_malloc(DELIVER_IN_BUFFER_SIZE);
5684 deliver_out_buffer = store_malloc(DELIVER_OUT_BUFFER_SIZE);
5688 /* Until there are no more new addresses, handle each one as follows:
5690 . If this is a generated address (indicated by the presence of a parent
5691 pointer) then check to see whether it is a pipe, file, or autoreply, and
5692 if so, handle it directly here. The router that produced the address will
5693 have set the allow flags into the address, and also set the uid/gid required.
5694 Having the routers generate new addresses and then checking them here at
5695 the outer level is tidier than making each router do the checking, and
5696 means that routers don't need access to the failed address queue.
5698 . Break up the address into local part and domain, and make lowercased
5699 versions of these strings. We also make unquoted versions of the local part.
5701 . Handle the percent hack for those domains for which it is valid.
5703 . For child addresses, determine if any of the parents have the same address.
5704 If so, generate a different string for previous delivery checking. Without
5705 this code, if the address spqr generates spqr via a forward or alias file,
5706 delivery of the generated spqr stops further attempts at the top level spqr,
5707 which is not what is wanted - it may have generated other addresses.
5709 . Check on the retry database to see if routing was previously deferred, but
5710 only if in a queue run. Addresses that are to be routed are put on the
5711 addr_route chain. Addresses that are to be deferred are put on the
5712 addr_defer chain. We do all the checking first, so as not to keep the
5713 retry database open any longer than necessary.
5715 . Now we run the addresses through the routers. A router may put the address
5716 on either the addr_local or the addr_remote chain for local or remote
5717 delivery, respectively, or put it on the addr_failed chain if it is
5718 undeliveable, or it may generate child addresses and put them on the
5719 addr_new chain, or it may defer an address. All the chain anchors are
5720 passed as arguments so that the routers can be called for verification
5723 . If new addresses have been generated by the routers, da capo.
5726 header_rewritten = FALSE; /* No headers rewritten yet */
5727 while (addr_new != NULL) /* Loop until all addresses dealt with */
5729 address_item *addr, *parent;
5730 dbm_file = dbfn_open(US"retry", O_RDONLY, &dbblock, FALSE);
5732 /* Failure to open the retry database is treated the same as if it does
5733 not exist. In both cases, dbm_file is NULL. */
5735 if (dbm_file == NULL)
5737 DEBUG(D_deliver|D_retry|D_route|D_hints_lookup)
5738 debug_printf("no retry data available\n");
5741 /* Scan the current batch of new addresses, to handle pipes, files and
5742 autoreplies, and determine which others are ready for routing. */
5744 while (addr_new != NULL)
5749 dbdata_retry *domain_retry_record;
5750 dbdata_retry *address_retry_record;
5753 addr_new = addr->next;
5755 DEBUG(D_deliver|D_retry|D_route)
5757 debug_printf(">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>\n");
5758 debug_printf("Considering: %s\n", addr->address);
5761 /* Handle generated address that is a pipe or a file or an autoreply. */
5763 if (testflag(addr, af_pfr))
5765 /* If an autoreply in a filter could not generate a syntactically valid
5766 address, give up forthwith. Set af_ignore_error so that we don't try to
5767 generate a bounce. */
5769 if (testflag(addr, af_bad_reply))
5771 addr->basic_errno = ERRNO_BADADDRESS2;
5772 addr->local_part = addr->address;
5774 US"filter autoreply generated syntactically invalid recipient";
5775 setflag(addr, af_ignore_error);
5776 (void)post_process_one(addr, FAIL, LOG_MAIN, DTYPE_ROUTER, 0);
5777 continue; /* with the next new address */
5780 /* If two different users specify delivery to the same pipe or file or
5781 autoreply, there should be two different deliveries, so build a unique
5782 string that incorporates the original address, and use this for
5783 duplicate testing and recording delivery, and also for retrying. */
5786 string_sprintf("%s:%s", addr->address, addr->parent->unique +
5787 (testflag(addr->parent, af_homonym)? 3:0));
5789 addr->address_retry_key = addr->domain_retry_key =
5790 string_sprintf("T:%s", addr->unique);
5792 /* If a filter file specifies two deliveries to the same pipe or file,
5793 we want to de-duplicate, but this is probably not wanted for two mail
5794 commands to the same address, where probably both should be delivered.
5795 So, we have to invent a different unique string in that case. Just
5796 keep piling '>' characters on the front. */
5798 if (addr->address[0] == '>')
5800 while (tree_search(tree_duplicates, addr->unique) != NULL)
5801 addr->unique = string_sprintf(">%s", addr->unique);
5804 else if ((tnode = tree_search(tree_duplicates, addr->unique)) != NULL)
5806 DEBUG(D_deliver|D_route)
5807 debug_printf("%s is a duplicate address: discarded\n", addr->address);
5808 addr->dupof = tnode->data.ptr;
5809 addr->next = addr_duplicate;
5810 addr_duplicate = addr;
5814 DEBUG(D_deliver|D_route) debug_printf("unique = %s\n", addr->unique);
5816 /* Check for previous delivery */
5818 if (tree_search(tree_nonrecipients, addr->unique) != NULL)
5820 DEBUG(D_deliver|D_route)
5821 debug_printf("%s was previously delivered: discarded\n", addr->address);
5822 child_done(addr, tod_stamp(tod_log));
5826 /* Save for checking future duplicates */
5828 tree_add_duplicate(addr->unique, addr);
5830 /* Set local part and domain */
5832 addr->local_part = addr->address;
5833 addr->domain = addr->parent->domain;
5835 /* Ensure that the delivery is permitted. */
5837 if (testflag(addr, af_file))
5839 if (!testflag(addr, af_allow_file))
5841 addr->basic_errno = ERRNO_FORBIDFILE;
5842 addr->message = US"delivery to file forbidden";
5843 (void)post_process_one(addr, FAIL, LOG_MAIN, DTYPE_ROUTER, 0);
5844 continue; /* with the next new address */
5847 else if (addr->address[0] == '|')
5849 if (!testflag(addr, af_allow_pipe))
5851 addr->basic_errno = ERRNO_FORBIDPIPE;
5852 addr->message = US"delivery to pipe forbidden";
5853 (void)post_process_one(addr, FAIL, LOG_MAIN, DTYPE_ROUTER, 0);
5854 continue; /* with the next new address */
5857 else if (!testflag(addr, af_allow_reply))
5859 addr->basic_errno = ERRNO_FORBIDREPLY;
5860 addr->message = US"autoreply forbidden";
5861 (void)post_process_one(addr, FAIL, LOG_MAIN, DTYPE_ROUTER, 0);
5862 continue; /* with the next new address */
5865 /* If the errno field is already set to BADTRANSPORT, it indicates
5866 failure to expand a transport string, or find the associated transport,
5867 or an unset transport when one is required. Leave this test till now so
5868 that the forbid errors are given in preference. */
5870 if (addr->basic_errno == ERRNO_BADTRANSPORT)
5872 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_ROUTER, 0);
5876 /* Treat /dev/null as a special case and abandon the delivery. This
5877 avoids having to specify a uid on the transport just for this case.
5878 Arrange for the transport name to be logged as "**bypassed**". */
5880 if (Ustrcmp(addr->address, "/dev/null") == 0)
5882 uschar *save = addr->transport->name;
5883 addr->transport->name = US"**bypassed**";
5884 (void)post_process_one(addr, OK, LOG_MAIN, DTYPE_TRANSPORT, '=');
5885 addr->transport->name = save;
5886 continue; /* with the next new address */
5889 /* Pipe, file, or autoreply delivery is to go ahead as a normal local
5892 DEBUG(D_deliver|D_route)
5893 debug_printf("queued for %s transport\n", addr->transport->name);
5894 addr->next = addr_local;
5896 continue; /* with the next new address */
5899 /* Handle normal addresses. First, split up into local part and domain,
5900 handling the %-hack if necessary. There is the possibility of a defer from
5901 a lookup in percent_hack_domains. */
5903 if ((rc = deliver_split_address(addr)) == DEFER)
5905 addr->message = US"cannot check percent_hack_domains";
5906 addr->basic_errno = ERRNO_LISTDEFER;
5907 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_NONE, 0);
5911 /* Check to see if the domain is held. If so, proceed only if the
5912 delivery was forced by hand. */
5914 deliver_domain = addr->domain; /* set $domain */
5915 if (!forced && hold_domains != NULL &&
5916 (rc = match_isinlist(addr->domain, &hold_domains, 0,
5917 &domainlist_anchor, addr->domain_cache, MCL_DOMAIN, TRUE,
5922 addr->message = US"hold_domains lookup deferred";
5923 addr->basic_errno = ERRNO_LISTDEFER;
5927 addr->message = US"domain is held";
5928 addr->basic_errno = ERRNO_HELD;
5930 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_NONE, 0);
5934 /* Now we can check for duplicates and previously delivered addresses. In
5935 order to do this, we have to generate a "unique" value for each address,
5936 because there may be identical actual addresses in a line of descendents.
5937 The "unique" field is initialized to the same value as the "address" field,
5938 but gets changed here to cope with identically-named descendents. */
5940 for (parent = addr->parent; parent != NULL; parent = parent->parent)
5941 if (strcmpic(addr->address, parent->address) == 0) break;
5943 /* If there's an ancestor with the same name, set the homonym flag. This
5944 influences how deliveries are recorded. Then add a prefix on the front of
5945 the unique address. We use \n\ where n starts at 0 and increases each time.
5946 It is unlikely to pass 9, but if it does, it may look odd but will still
5947 work. This means that siblings or cousins with the same names are treated
5948 as duplicates, which is what we want. */
5952 setflag(addr, af_homonym);
5953 if (parent->unique[0] != '\\')
5954 addr->unique = string_sprintf("\\0\\%s", addr->address);
5956 addr->unique = string_sprintf("\\%c\\%s", parent->unique[1] + 1,
5960 /* Ensure that the domain in the unique field is lower cased, because
5961 domains are always handled caselessly. */
5963 p = Ustrrchr(addr->unique, '@');
5964 while (*p != 0) { *p = tolower(*p); p++; }
5966 DEBUG(D_deliver|D_route) debug_printf("unique = %s\n", addr->unique);
5968 if (tree_search(tree_nonrecipients, addr->unique) != NULL)
5970 DEBUG(D_deliver|D_route)
5971 debug_printf("%s was previously delivered: discarded\n", addr->unique);
5972 child_done(addr, tod_stamp(tod_log));
5976 /* Get the routing retry status, saving the two retry keys (with and
5977 without the local part) for subsequent use. If there is no retry record for
5978 the standard address routing retry key, we look for the same key with the
5979 sender attached, because this form is used by the smtp transport after a
5980 4xx response to RCPT when address_retry_include_sender is true. */
5982 addr->domain_retry_key = string_sprintf("R:%s", addr->domain);
5983 addr->address_retry_key = string_sprintf("R:%s@%s", addr->local_part,
5986 if (dbm_file == NULL)
5987 domain_retry_record = address_retry_record = NULL;
5990 domain_retry_record = dbfn_read(dbm_file, addr->domain_retry_key);
5991 if (domain_retry_record != NULL &&
5992 now - domain_retry_record->time_stamp > retry_data_expire)
5993 domain_retry_record = NULL; /* Ignore if too old */
5995 address_retry_record = dbfn_read(dbm_file, addr->address_retry_key);
5996 if (address_retry_record != NULL &&
5997 now - address_retry_record->time_stamp > retry_data_expire)
5998 address_retry_record = NULL; /* Ignore if too old */
6000 if (address_retry_record == NULL)
6002 uschar *altkey = string_sprintf("%s:<%s>", addr->address_retry_key,
6004 address_retry_record = dbfn_read(dbm_file, altkey);
6005 if (address_retry_record != NULL &&
6006 now - address_retry_record->time_stamp > retry_data_expire)
6007 address_retry_record = NULL; /* Ignore if too old */
6011 DEBUG(D_deliver|D_retry)
6013 if (domain_retry_record == NULL)
6014 debug_printf("no domain retry record\n");
6015 if (address_retry_record == NULL)
6016 debug_printf("no address retry record\n");
6019 /* If we are sending a message down an existing SMTP connection, we must
6020 assume that the message which created the connection managed to route
6021 an address to that connection. We do not want to run the risk of taking
6022 a long time over routing here, because if we do, the server at the other
6023 end of the connection may time it out. This is especially true for messages
6024 with lots of addresses. For this kind of delivery, queue_running is not
6025 set, so we would normally route all addresses. We take a pragmatic approach
6026 and defer routing any addresses that have any kind of domain retry record.
6027 That is, we don't even look at their retry times. It doesn't matter if this
6028 doesn't work occasionally. This is all just an optimization, after all.
6030 The reason for not doing the same for address retries is that they normally
6031 arise from 4xx responses, not DNS timeouts. */
6033 if (continue_hostname != NULL && domain_retry_record != NULL)
6035 addr->message = US"reusing SMTP connection skips previous routing defer";
6036 addr->basic_errno = ERRNO_RRETRY;
6037 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_ROUTER, 0);
6040 /* If we are in a queue run, defer routing unless there is no retry data or
6041 we've passed the next retry time, or this message is forced. In other
6042 words, ignore retry data when not in a queue run.
6044 However, if the domain retry time has expired, always allow the routing
6045 attempt. If it fails again, the address will be failed. This ensures that
6046 each address is routed at least once, even after long-term routing
6049 If there is an address retry, check that too; just wait for the next
6050 retry time. This helps with the case when the temporary error on the
6051 address was really message-specific rather than address specific, since
6052 it allows other messages through.
6054 We also wait for the next retry time if this is a message sent down an
6055 existing SMTP connection (even though that will be forced). Otherwise there
6056 will be far too many attempts for an address that gets a 4xx error. In
6057 fact, after such an error, we should not get here because, the host should
6058 not be remembered as one this message needs. However, there was a bug that
6059 used to cause this to happen, so it is best to be on the safe side.
6061 Even if we haven't reached the retry time in the hints, there is one more
6062 check to do, which is for the ultimate address timeout. We only do this
6063 check if there is an address retry record and there is not a domain retry
6064 record; this implies that previous attempts to handle the address had the
6065 retry_use_local_parts option turned on. We use this as an approximation
6066 for the destination being like a local delivery, for example delivery over
6067 LMTP to an IMAP message store. In this situation users are liable to bump
6068 into their quota and thereby have intermittently successful deliveries,
6069 which keep the retry record fresh, which can lead to us perpetually
6070 deferring messages. */
6072 else if (((queue_running && !deliver_force) || continue_hostname != NULL)
6074 ((domain_retry_record != NULL &&
6075 now < domain_retry_record->next_try &&
6076 !domain_retry_record->expired)
6078 (address_retry_record != NULL &&
6079 now < address_retry_record->next_try))
6081 (domain_retry_record != NULL ||
6082 address_retry_record == NULL ||
6083 !retry_ultimate_address_timeout(addr->address_retry_key,
6084 addr->domain, address_retry_record, now)))
6086 addr->message = US"retry time not reached";
6087 addr->basic_errno = ERRNO_RRETRY;
6088 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_ROUTER, 0);
6091 /* The domain is OK for routing. Remember if retry data exists so it
6092 can be cleaned up after a successful delivery. */
6096 if (domain_retry_record != NULL || address_retry_record != NULL)
6097 setflag(addr, af_dr_retry_exists);
6098 addr->next = addr_route;
6100 DEBUG(D_deliver|D_route)
6101 debug_printf("%s: queued for routing\n", addr->address);
6105 /* The database is closed while routing is actually happening. Requests to
6106 update it are put on a chain and all processed together at the end. */
6108 if (dbm_file != NULL) dbfn_close(dbm_file);
6110 /* If queue_domains is set, we don't even want to try routing addresses in
6111 those domains. During queue runs, queue_domains is forced to be unset.
6112 Optimize by skipping this pass through the addresses if nothing is set. */
6114 if (!deliver_force && queue_domains != NULL)
6116 address_item *okaddr = NULL;
6117 while (addr_route != NULL)
6119 address_item *addr = addr_route;
6120 addr_route = addr->next;
6122 deliver_domain = addr->domain; /* set $domain */
6123 if ((rc = match_isinlist(addr->domain, &queue_domains, 0,
6124 &domainlist_anchor, addr->domain_cache, MCL_DOMAIN, TRUE, NULL))
6129 addr->basic_errno = ERRNO_LISTDEFER;
6130 addr->message = US"queue_domains lookup deferred";
6131 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_ROUTER, 0);
6135 addr->next = okaddr;
6141 addr->basic_errno = ERRNO_QUEUE_DOMAIN;
6142 addr->message = US"domain is in queue_domains";
6143 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_ROUTER, 0);
6147 addr_route = okaddr;
6150 /* Now route those addresses that are not deferred. */
6152 while (addr_route != NULL)
6155 address_item *addr = addr_route;
6156 uschar *old_domain = addr->domain;
6157 uschar *old_unique = addr->unique;
6158 addr_route = addr->next;
6161 /* Just in case some router parameter refers to it. */
6163 return_path = (addr->p.errors_address != NULL)?
6164 addr->p.errors_address : sender_address;
6166 /* If a router defers an address, add a retry item. Whether or not to
6167 use the local part in the key is a property of the router. */
6169 if ((rc = route_address(addr, &addr_local, &addr_remote, &addr_new,
6170 &addr_succeed, v_none)) == DEFER)
6171 retry_add_item(addr, (addr->router->retry_use_local_part)?
6172 string_sprintf("R:%s@%s", addr->local_part, addr->domain) :
6173 string_sprintf("R:%s", addr->domain), 0);
6175 /* Otherwise, if there is an existing retry record in the database, add
6176 retry items to delete both forms. We must also allow for the possibility
6177 of a routing retry that includes the sender address. Since the domain might
6178 have been rewritten (expanded to fully qualified) as a result of routing,
6179 ensure that the rewritten form is also deleted. */
6181 else if (testflag(addr, af_dr_retry_exists))
6183 uschar *altkey = string_sprintf("%s:<%s>", addr->address_retry_key,
6185 retry_add_item(addr, altkey, rf_delete);
6186 retry_add_item(addr, addr->address_retry_key, rf_delete);
6187 retry_add_item(addr, addr->domain_retry_key, rf_delete);
6188 if (Ustrcmp(addr->domain, old_domain) != 0)
6189 retry_add_item(addr, string_sprintf("R:%s", old_domain), rf_delete);
6192 /* DISCARD is given for :blackhole: and "seen finish". The event has been
6193 logged, but we need to ensure the address (and maybe parents) is marked
6198 address_done(addr, tod_stamp(tod_log));
6199 continue; /* route next address */
6202 /* The address is finished with (failed or deferred). */
6206 (void)post_process_one(addr, rc, LOG_MAIN, DTYPE_ROUTER, 0);
6207 continue; /* route next address */
6210 /* The address has been routed. If the router changed the domain, it will
6211 also have changed the unique address. We have to test whether this address
6212 has already been delivered, because it's the unique address that finally
6215 if (addr->unique != old_unique &&
6216 tree_search(tree_nonrecipients, addr->unique) != 0)
6218 DEBUG(D_deliver|D_route) debug_printf("%s was previously delivered: "
6219 "discarded\n", addr->address);
6220 if (addr_remote == addr) addr_remote = addr->next;
6221 else if (addr_local == addr) addr_local = addr->next;
6224 /* If the router has same_domain_copy_routing set, we are permitted to copy
6225 the routing for any other addresses with the same domain. This is an
6226 optimisation to save repeated DNS lookups for "standard" remote domain
6227 routing. The option is settable only on routers that generate host lists.
6228 We play it very safe, and do the optimization only if the address is routed
6229 to a remote transport, there are no header changes, and the domain was not
6230 modified by the router. */
6232 if (addr_remote == addr &&
6233 addr->router->same_domain_copy_routing &&
6234 addr->p.extra_headers == NULL &&
6235 addr->p.remove_headers == NULL &&
6236 old_domain == addr->domain)
6238 address_item **chain = &addr_route;
6239 while (*chain != NULL)
6241 address_item *addr2 = *chain;
6242 if (Ustrcmp(addr2->domain, addr->domain) != 0)
6244 chain = &(addr2->next);
6248 /* Found a suitable address; take it off the routing list and add it to
6249 the remote delivery list. */
6251 *chain = addr2->next;
6252 addr2->next = addr_remote;
6253 addr_remote = addr2;
6255 /* Copy the routing data */
6257 addr2->domain = addr->domain;
6258 addr2->router = addr->router;
6259 addr2->transport = addr->transport;
6260 addr2->host_list = addr->host_list;
6261 addr2->fallback_hosts = addr->fallback_hosts;
6262 addr2->p.errors_address = addr->p.errors_address;
6263 copyflag(addr2, addr, af_hide_child | af_local_host_removed);
6265 DEBUG(D_deliver|D_route)
6267 debug_printf(">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>\n"
6269 "Routing for %s copied from %s\n",
6270 addr2->address, addr2->address, addr->address);
6274 } /* Continue with routing the next address. */
6275 } /* Loop to process any child addresses that the routers created, and
6276 any rerouted addresses that got put back on the new chain. */
6279 /* Debugging: show the results of the routing */
6281 DEBUG(D_deliver|D_retry|D_route)
6283 address_item *p = addr_local;
6284 debug_printf(">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>\n");
6285 debug_printf("After routing:\n Local deliveries:\n");
6288 debug_printf(" %s\n", p->address);
6293 debug_printf(" Remote deliveries:\n");
6296 debug_printf(" %s\n", p->address);
6301 debug_printf(" Failed addresses:\n");
6304 debug_printf(" %s\n", p->address);
6309 debug_printf(" Deferred addresses:\n");
6312 debug_printf(" %s\n", p->address);
6317 /* Free any resources that were cached during routing. */
6322 /* These two variables are set only during routing, after check_local_user.
6323 Ensure they are not set in transports. */
6325 local_user_gid = (gid_t)(-1);
6326 local_user_uid = (uid_t)(-1);
6328 /* Check for any duplicate addresses. This check is delayed until after
6329 routing, because the flexibility of the routing configuration means that
6330 identical addresses with different parentage may end up being redirected to
6331 different addresses. Checking for duplicates too early (as we previously used
6332 to) makes this kind of thing not work. */
6334 do_duplicate_check(&addr_local);
6335 do_duplicate_check(&addr_remote);
6337 /* When acting as an MUA wrapper, we proceed only if all addresses route to a
6338 remote transport. The check that they all end up in one transaction happens in
6339 the do_remote_deliveries() function. */
6341 if (mua_wrapper && (addr_local != NULL || addr_failed != NULL ||
6342 addr_defer != NULL))
6345 uschar *which, *colon, *msg;
6347 if (addr_local != NULL)
6352 else if (addr_defer != NULL)
6355 which = US"deferred";
6363 while (addr->parent != NULL) addr = addr->parent;
6365 if (addr->message != NULL)
6368 msg = addr->message;
6370 else colon = msg = US"";
6372 /* We don't need to log here for a forced failure as it will already
6373 have been logged. Defer will also have been logged, but as a defer, so we do
6374 need to do the failure logging. */
6376 if (addr != addr_failed)
6377 log_write(0, LOG_MAIN, "** %s routing yielded a %s delivery",
6378 addr->address, which);
6380 /* Always write an error to the caller */
6382 fprintf(stderr, "routing %s yielded a %s delivery%s%s\n", addr->address,
6385 final_yield = DELIVER_MUA_FAILED;
6386 addr_failed = addr_defer = NULL; /* So that we remove the message */
6387 goto DELIVERY_TIDYUP;
6391 /* If this is a run to continue deliveries to an external channel that is
6392 already set up, defer any local deliveries. */
6394 if (continue_transport != NULL)
6396 if (addr_defer == NULL) addr_defer = addr_local; else
6398 address_item *addr = addr_defer;
6399 while (addr->next != NULL) addr = addr->next;
6400 addr->next = addr_local;
6406 /* Because address rewriting can happen in the routers, we should not really do
6407 ANY deliveries until all addresses have been routed, so that all recipients of
6408 the message get the same headers. However, this is in practice not always
6409 possible, since sometimes remote addresses give DNS timeouts for days on end.
6410 The pragmatic approach is to deliver what we can now, saving any rewritten
6411 headers so that at least the next lot of recipients benefit from the rewriting
6412 that has already been done.
6414 If any headers have been rewritten during routing, update the spool file to
6415 remember them for all subsequent deliveries. This can be delayed till later if
6416 there is only address to be delivered - if it succeeds the spool write need not
6419 if (header_rewritten &&
6420 ((addr_local != NULL &&
6421 (addr_local->next != NULL || addr_remote != NULL)) ||
6422 (addr_remote != NULL && addr_remote->next != NULL)))
6424 /* Panic-dies on error */
6425 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
6426 header_rewritten = FALSE;
6430 /* If there are any deliveries to be done, open the journal file. This is used
6431 to record successful deliveries as soon as possible after each delivery is
6432 known to be complete. A file opened with O_APPEND is used so that several
6433 processes can run simultaneously.
6435 The journal is just insurance against crashes. When the spool file is
6436 ultimately updated at the end of processing, the journal is deleted. If a
6437 journal is found to exist at the start of delivery, the addresses listed
6438 therein are added to the non-recipients. */
6440 if (addr_local != NULL || addr_remote != NULL)
6442 sprintf(CS spoolname, "%s/input/%s/%s-J", spool_directory, message_subdir, id);
6443 journal_fd = Uopen(spoolname, O_WRONLY|O_APPEND|O_CREAT, SPOOL_MODE);
6447 log_write(0, LOG_MAIN|LOG_PANIC, "Couldn't open journal file %s: %s",
6448 spoolname, strerror(errno));
6449 return DELIVER_NOT_ATTEMPTED;
6452 /* Set the close-on-exec flag, make the file owned by Exim, and ensure
6453 that the mode is correct - the group setting doesn't always seem to get
6454 set automatically. */
6456 if( fcntl(journal_fd, F_SETFD, fcntl(journal_fd, F_GETFD) | FD_CLOEXEC)
6457 || fchown(journal_fd, exim_uid, exim_gid)
6458 || fchmod(journal_fd, SPOOL_MODE)
6461 int ret = Uunlink(spoolname);
6462 log_write(0, LOG_MAIN|LOG_PANIC, "Couldn't set perms on journal file %s: %s",
6463 spoolname, strerror(errno));
6464 if(ret && errno != ENOENT)
6465 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s",
6466 spoolname, strerror(errno));
6467 return DELIVER_NOT_ATTEMPTED;
6473 /* Now we can get down to the business of actually doing deliveries. Local
6474 deliveries are done first, then remote ones. If ever the problems of how to
6475 handle fallback transports are figured out, this section can be put into a loop
6476 for handling fallbacks, though the uid switching will have to be revised. */
6478 /* Precompile a regex that is used to recognize a parameter in response
6479 to an LHLO command, if is isn't already compiled. This may be used on both
6480 local and remote LMTP deliveries. */
6482 if (regex_IGNOREQUOTA == NULL) regex_IGNOREQUOTA =
6483 regex_must_compile(US"\\n250[\\s\\-]IGNOREQUOTA(\\s|\\n|$)", FALSE, TRUE);
6485 /* Handle local deliveries */
6487 if (addr_local != NULL)
6489 DEBUG(D_deliver|D_transport)
6490 debug_printf(">>>>>>>>>>>>>>>> Local deliveries >>>>>>>>>>>>>>>>\n");
6491 do_local_deliveries();
6492 disable_logging = FALSE;
6495 /* If queue_run_local is set, we do not want to attempt any remote deliveries,
6496 so just queue them all. */
6498 if (queue_run_local)
6500 while (addr_remote != NULL)
6502 address_item *addr = addr_remote;
6503 addr_remote = addr->next;
6505 addr->basic_errno = ERRNO_LOCAL_ONLY;
6506 addr->message = US"remote deliveries suppressed";
6507 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_TRANSPORT, 0);
6511 /* Handle remote deliveries */
6513 if (addr_remote != NULL)
6515 DEBUG(D_deliver|D_transport)
6516 debug_printf(">>>>>>>>>>>>>>>> Remote deliveries >>>>>>>>>>>>>>>>\n");
6518 /* Precompile some regex that are used to recognize parameters in response
6519 to an EHLO command, if they aren't already compiled. */
6523 /* Now sort the addresses if required, and do the deliveries. The yield of
6524 do_remote_deliveries is FALSE when mua_wrapper is set and all addresses
6525 cannot be delivered in one transaction. */
6527 if (remote_sort_domains != NULL) sort_remote_deliveries();
6528 if (!do_remote_deliveries(FALSE))
6530 log_write(0, LOG_MAIN, "** mua_wrapper is set but recipients cannot all "
6531 "be delivered in one transaction");
6532 fprintf(stderr, "delivery to smarthost failed (configuration problem)\n");
6534 final_yield = DELIVER_MUA_FAILED;
6535 addr_failed = addr_defer = NULL; /* So that we remove the message */
6536 goto DELIVERY_TIDYUP;
6539 /* See if any of the addresses that failed got put on the queue for delivery
6540 to their fallback hosts. We do it this way because often the same fallback
6541 host is used for many domains, so all can be sent in a single transaction
6542 (if appropriately configured). */
6544 if (addr_fallback != NULL && !mua_wrapper)
6546 DEBUG(D_deliver) debug_printf("Delivering to fallback hosts\n");
6547 addr_remote = addr_fallback;
6548 addr_fallback = NULL;
6549 if (remote_sort_domains != NULL) sort_remote_deliveries();
6550 do_remote_deliveries(TRUE);
6552 disable_logging = FALSE;
6556 /* All deliveries are now complete. Ignore SIGTERM during this tidying up
6557 phase, to minimize cases of half-done things. */
6560 debug_printf(">>>>>>>>>>>>>>>> deliveries are done >>>>>>>>>>>>>>>>\n");
6562 /* Root privilege is no longer needed */
6564 exim_setugid(exim_uid, exim_gid, FALSE, US"post-delivery tidying");
6566 set_process_info("tidying up after delivering %s", message_id);
6567 signal(SIGTERM, SIG_IGN);
6569 /* When we are acting as an MUA wrapper, the smtp transport will either have
6570 succeeded for all addresses, or failed them all in normal cases. However, there
6571 are some setup situations (e.g. when a named port does not exist) that cause an
6572 immediate exit with deferral of all addresses. Convert those into failures. We
6573 do not ever want to retry, nor do we want to send a bounce message. */
6577 if (addr_defer != NULL)
6579 address_item *addr, *nextaddr;
6580 for (addr = addr_defer; addr != NULL; addr = nextaddr)
6582 log_write(0, LOG_MAIN, "** %s mua_wrapper forced failure for deferred "
6583 "delivery", addr->address);
6584 nextaddr = addr->next;
6585 addr->next = addr_failed;
6591 /* Now all should either have succeeded or failed. */
6593 if (addr_failed == NULL) final_yield = DELIVER_MUA_SUCCEEDED; else
6595 uschar *s = (addr_failed->user_message != NULL)?
6596 addr_failed->user_message : addr_failed->message;
6599 fprintf(stderr, "Delivery failed: ");
6600 if (addr_failed->basic_errno > 0)
6602 fprintf(stderr, "%s", strerror(addr_failed->basic_errno));
6603 if (s != NULL) fprintf(stderr, ": ");
6605 if ((host = addr_failed->host_used))
6606 fprintf(stderr, "H=%s [%s]: ", host->name, host->address);
6609 if (addr_failed->basic_errno <= 0) fprintf(stderr, "unknown error");
6611 else fprintf(stderr, "%s", CS s);
6612 fprintf(stderr, "\n");
6614 final_yield = DELIVER_MUA_FAILED;
6619 /* In a normal configuration, we now update the retry database. This is done in
6620 one fell swoop at the end in order not to keep opening and closing (and
6621 locking) the database. The code for handling retries is hived off into a
6622 separate module for convenience. We pass it the addresses of the various
6623 chains, because deferred addresses can get moved onto the failed chain if the
6624 retry cutoff time has expired for all alternative destinations. Bypass the
6625 updating of the database if the -N flag is set, which is a debugging thing that
6626 prevents actual delivery. */
6628 else if (!dont_deliver) retry_update(&addr_defer, &addr_failed, &addr_succeed);
6630 /* Send DSN for successful messages */
6631 addr_dsntmp = addr_succeed;
6632 addr_senddsn = NULL;
6634 while(addr_dsntmp != NULL)
6637 debug_printf("DSN: processing router : %s\n", addr_dsntmp->router->name);
6640 debug_printf("DSN: processing successful delivery address: %s\n", addr_dsntmp->address);
6642 /* af_ignore_error not honored here. it's not an error */
6644 DEBUG(D_deliver) debug_printf("DSN: Sender_address: %s\n", sender_address);
6645 DEBUG(D_deliver) debug_printf("DSN: orcpt: %s flags: %d\n", addr_dsntmp->dsn_orcpt, addr_dsntmp->dsn_flags);
6646 DEBUG(D_deliver) debug_printf("DSN: envid: %s ret: %d\n", dsn_envid, dsn_ret);
6647 DEBUG(D_deliver) debug_printf("DSN: Final recipient: %s\n", addr_dsntmp->address);
6648 DEBUG(D_deliver) debug_printf("DSN: Remote SMTP server supports DSN: %d\n", addr_dsntmp->dsn_aware);
6650 /* send report if next hop not DSN aware or a router flagged "last DSN hop"
6651 and a report was requested */
6652 if (((addr_dsntmp->dsn_aware != dsn_support_yes) ||
6653 ((addr_dsntmp->dsn_flags & rf_dsnlasthop) != 0))
6655 (((addr_dsntmp->dsn_flags & rf_dsnflags) != 0) &&
6656 ((addr_dsntmp->dsn_flags & rf_notify_success) != 0)))
6658 /* copy and relink address_item and send report with all of them at once later */
6659 address_item *addr_next;
6660 addr_next = addr_senddsn;
6661 addr_senddsn = store_get(sizeof(address_item));
6662 memcpy(addr_senddsn, addr_dsntmp, sizeof(address_item));
6663 addr_senddsn->next = addr_next;
6667 DEBUG(D_deliver) debug_printf("DSN: *** NOT SENDING DSN SUCCESS Message ***\n");
6670 addr_dsntmp = addr_dsntmp->next;
6673 if (addr_senddsn != NULL)
6678 /* create exim process to send message */
6679 pid = child_open_exim(&fd);
6681 DEBUG(D_deliver) debug_printf("DSN: child_open_exim returns: %d\n", pid);
6683 if (pid < 0) /* Creation of child failed */
6685 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Process %d (parent %d) failed to "
6686 "create child process to send failure message: %s", getpid(),
6687 getppid(), strerror(errno));
6689 DEBUG(D_deliver) debug_printf("DSN: child_open_exim failed\n");
6692 else /* Creation of child succeeded */
6694 FILE *f = fdopen(fd, "wb");
6695 /* header only as required by RFC. only failure DSN needs to honor RET=FULL */
6696 int topt = topt_add_return_path | topt_no_body;
6699 DEBUG(D_deliver) debug_printf("sending error message to: %s\n", sender_address);
6701 /* build unique id for MIME boundary */
6702 bound = string_sprintf(TIME_T_FMT "-eximdsn-%d", time(NULL), rand());
6703 DEBUG(D_deliver) debug_printf("DSN: MIME boundary: %s\n", bound);
6705 if (errors_reply_to)
6706 fprintf(f, "Reply-To: %s\n", errors_reply_to);
6708 fprintf(f, "Auto-Submitted: auto-generated\n"
6709 "From: Mail Delivery System <Mailer-Daemon@%s>\n"
6711 "Subject: Delivery Status Notification\n"
6712 "Content-Type: multipart/report; report-type=delivery-status; boundary=%s\n"
6713 "MIME-Version: 1.0\n\n"
6716 "Content-type: text/plain; charset=us-ascii\n\n"
6718 "This message was created automatically by mail delivery software.\n"
6719 " ----- The following addresses had successful delivery notifications -----\n",
6720 qualify_domain_sender, sender_address, bound, bound);
6722 addr_dsntmp = addr_senddsn;
6725 fprintf(f, "<%s> (relayed %s)\n\n",
6726 addr_dsntmp->address,
6727 (addr_dsntmp->dsn_flags & rf_dsnlasthop) == 1
6728 ? "via non DSN router"
6729 : addr_dsntmp->dsn_aware == dsn_support_no
6730 ? "to non-DSN-aware mailer"
6731 : "via non \"Remote SMTP\" router"
6733 addr_dsntmp = addr_dsntmp->next;
6736 "Content-type: message/delivery-status\n\n"
6737 "Reporting-MTA: dns; %s\n",
6738 bound, smtp_active_hostname);
6740 if (dsn_envid != NULL) {
6741 /* must be decoded from xtext: see RFC 3461:6.3a */
6743 if (auth_xtextdecode(dsn_envid, &xdec_envid) > 0)
6744 fprintf(f, "Original-Envelope-ID: %s\n", dsn_envid);
6746 fprintf(f, "X-Original-Envelope-ID: error decoding xtext formated ENVID\n");
6750 for (addr_dsntmp = addr_senddsn;
6752 addr_dsntmp = addr_dsntmp->next)
6754 if (addr_dsntmp->dsn_orcpt)
6755 fprintf(f,"Original-Recipient: %s\n", addr_dsntmp->dsn_orcpt);
6757 fprintf(f, "Action: delivered\n"
6758 "Final-Recipient: rfc822;%s\n"
6760 addr_dsntmp->address);
6762 if (addr_dsntmp->host_used && addr_dsntmp->host_used->name)
6763 fprintf(f, "Remote-MTA: dns; %s\nDiagnostic-Code: smtp; 250 Ok\n",
6764 addr_dsntmp->host_used->name);
6766 fprintf(f,"Diagnostic-Code: X-Exim; relayed via non %s router\n",
6767 (addr_dsntmp->dsn_flags & rf_dsnlasthop) == 1 ? "DSN" : "SMTP");
6771 fprintf(f, "--%s\nContent-type: text/rfc822-headers\n\n", bound);
6774 transport_filter_argv = NULL; /* Just in case */
6775 return_path = sender_address; /* In case not previously set */
6777 /* Write the original email out */
6778 transport_write_message(NULL, fileno(f), topt, 0, NULL, NULL, NULL, NULL, NULL, 0);
6781 fprintf(f,"\n--%s--\n", bound);
6785 rc = child_close(pid, 0); /* Waits for child to close, no timeout */
6789 /* If any addresses failed, we must send a message to somebody, unless
6790 af_ignore_error is set, in which case no action is taken. It is possible for
6791 several messages to get sent if there are addresses with different
6794 while (addr_failed != NULL)
6798 uschar *logtod = tod_stamp(tod_log);
6800 address_item *handled_addr = NULL;
6801 address_item **paddr;
6802 address_item *msgchain = NULL;
6803 address_item **pmsgchain = &msgchain;
6805 /* There are weird cases when logging is disabled in the transport. However,
6806 there may not be a transport (address failed by a router). */
6808 disable_logging = FALSE;
6809 if (addr_failed->transport != NULL)
6810 disable_logging = addr_failed->transport->disable_logging;
6813 debug_printf("processing failed address %s\n", addr_failed->address);
6815 /* There are only two ways an address in a bounce message can get here:
6817 (1) When delivery was initially deferred, but has now timed out (in the call
6818 to retry_update() above). We can detect this by testing for
6819 af_retry_timedout. If the address does not have its own errors address,
6820 we arrange to ignore the error.
6822 (2) If delivery failures for bounce messages are being ignored. We can detect
6823 this by testing for af_ignore_error. This will also be set if a bounce
6824 message has been autothawed and the ignore_bounce_errors_after time has
6825 passed. It might also be set if a router was explicitly configured to
6826 ignore errors (errors_to = "").
6828 If neither of these cases obtains, something has gone wrong. Log the
6829 incident, but then ignore the error. */
6831 if (sender_address[0] == 0 && addr_failed->p.errors_address == NULL)
6833 if (!testflag(addr_failed, af_retry_timedout) &&
6834 !testflag(addr_failed, af_ignore_error))
6836 log_write(0, LOG_MAIN|LOG_PANIC, "internal error: bounce message "
6837 "failure is neither frozen nor ignored (it's been ignored)");
6839 setflag(addr_failed, af_ignore_error);
6842 /* If the first address on the list has af_ignore_error set, just remove
6843 it from the list, throw away any saved message file, log it, and
6844 mark the recipient done. */
6846 if ( testflag(addr_failed, af_ignore_error)
6847 || ( ((addr_failed->dsn_flags & rf_dsnflags) != 0)
6848 && ((addr_failed->dsn_flags & rf_notify_failure) != rf_notify_failure))
6852 addr_failed = addr->next;
6853 if (addr->return_filename != NULL) Uunlink(addr->return_filename);
6855 log_write(0, LOG_MAIN, "%s%s%s%s: error ignored",
6857 (addr->parent == NULL)? US"" : US" <",
6858 (addr->parent == NULL)? US"" : addr->parent->address,
6859 (addr->parent == NULL)? US"" : US">");
6861 address_done(addr, logtod);
6862 child_done(addr, logtod);
6863 /* Panic-dies on error */
6864 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
6867 /* Otherwise, handle the sending of a message. Find the error address for
6868 the first address, then send a message that includes all failed addresses
6869 that have the same error address. Note the bounce_recipient is a global so
6870 that it can be accesssed by $bounce_recipient while creating a customized
6875 bounce_recipient = (addr_failed->p.errors_address == NULL)?
6876 sender_address : addr_failed->p.errors_address;
6878 /* Make a subprocess to send a message */
6880 pid = child_open_exim(&fd);
6882 /* Creation of child failed */
6885 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Process %d (parent %d) failed to "
6886 "create child process to send failure message: %s", getpid(),
6887 getppid(), strerror(errno));
6889 /* Creation of child succeeded */
6896 uschar *bcc, *emf_text;
6897 FILE *f = fdopen(fd, "wb");
6899 BOOL to_sender = strcmpic(sender_address, bounce_recipient) == 0;
6900 int max = (bounce_return_size_limit/DELIVER_IN_BUFFER_SIZE + 1) *
6901 DELIVER_IN_BUFFER_SIZE;
6903 uschar *dsnlimitmsg;
6904 uschar *dsnnotifyhdr;
6908 debug_printf("sending error message to: %s\n", bounce_recipient);
6910 /* Scan the addresses for all that have the same errors address, removing
6911 them from the addr_failed chain, and putting them on msgchain. */
6913 paddr = &addr_failed;
6914 for (addr = addr_failed; addr != NULL; addr = *paddr)
6916 if (Ustrcmp(bounce_recipient, (addr->p.errors_address == NULL)?
6917 sender_address : addr->p.errors_address) != 0)
6919 paddr = &(addr->next); /* Not the same; skip */
6921 else /* The same - dechain */
6923 *paddr = addr->next;
6926 pmsgchain = &(addr->next);
6930 /* Include X-Failed-Recipients: for automatic interpretation, but do
6931 not let any one header line get too long. We do this by starting a
6932 new header every 50 recipients. Omit any addresses for which the
6933 "hide_child" flag is set. */
6935 for (addr = msgchain; addr != NULL; addr = addr->next)
6937 if (testflag(addr, af_hide_child)) continue;
6944 (rcount++ == 0)? "X-Failed-Recipients: " : ",\n ",
6945 (testflag(addr, af_pfr) && addr->parent != NULL)?
6946 string_printing(addr->parent->address) :
6947 string_printing(addr->address));
6949 if (rcount > 0) fprintf(f, "\n");
6951 /* Output the standard headers */
6953 if (errors_reply_to != NULL)
6954 fprintf(f, "Reply-To: %s\n", errors_reply_to);
6955 fprintf(f, "Auto-Submitted: auto-replied\n");
6957 fprintf(f, "To: %s\n", bounce_recipient);
6959 /* generate boundary string and output MIME-Headers */
6960 bound = string_sprintf(TIME_T_FMT "-eximdsn-%d", time(NULL), rand());
6962 fprintf(f, "Content-Type: multipart/report;"
6963 " report-type=delivery-status; boundary=%s\n"
6964 "MIME-Version: 1.0\n",
6967 /* Open a template file if one is provided. Log failure to open, but
6968 carry on - default texts will be used. */
6970 if (bounce_message_file)
6971 if (!(emf = Ufopen(bounce_message_file, "rb")))
6972 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to open %s for error "
6973 "message texts: %s", bounce_message_file, strerror(errno));
6975 /* Quietly copy to configured additional addresses if required. */
6977 if ((bcc = moan_check_errorcopy(bounce_recipient)))
6978 fprintf(f, "Bcc: %s\n", bcc);
6980 /* The texts for the message can be read from a template file; if there
6981 isn't one, or if it is too short, built-in texts are used. The first
6982 emf text is a Subject: and any other headers. */
6984 if ((emf_text = next_emf(emf, US"header")))
6985 fprintf(f, "%s\n", emf_text);
6987 fprintf(f, "Subject: Mail delivery failed%s\n\n",
6988 to_sender? ": returning message to sender" : "");
6990 /* output human readable part as text/plain section */
6992 "Content-type: text/plain; charset=us-ascii\n\n",
6995 if ((emf_text = next_emf(emf, US"intro")))
6996 fprintf(f, "%s", CS emf_text);
7000 /* This message has been reworded several times. It seems to be confusing to
7001 somebody, however it is worded. I have retreated to the original, simple
7003 "This message was created automatically by mail delivery software.\n");
7005 if (bounce_message_text)
7006 fprintf(f, "%s", CS bounce_message_text);
7009 "\nA message that you sent could not be delivered to one or more of its\n"
7010 "recipients. This is a permanent error. The following address(es) failed:\n");
7013 "\nA message sent by\n\n <%s>\n\n"
7014 "could not be delivered to one or more of its recipients. The following\n"
7015 "address(es) failed:\n", sender_address);
7019 /* Process the addresses, leaving them on the msgchain if they have a
7020 file name for a return message. (There has already been a check in
7021 post_process_one() for the existence of data in the message file.) A TRUE
7022 return from print_address_information() means that the address is not
7026 for (addr = msgchain; addr != NULL; addr = *paddr)
7028 if (print_address_information(addr, f, US" ", US"\n ", US""))
7029 print_address_error(addr, f, US"");
7031 /* End the final line for the address */
7035 /* Leave on msgchain if there's a return file. */
7037 if (addr->return_file >= 0)
7039 paddr = &(addr->next);
7043 /* Else save so that we can tick off the recipient when the
7048 *paddr = addr->next;
7049 addr->next = handled_addr;
7050 handled_addr = addr;
7056 /* Get the next text, whether we need it or not, so as to be
7057 positioned for the one after. */
7059 emf_text = next_emf(emf, US"generated text");
7061 /* If there were any file messages passed by the local transports,
7062 include them in the message. Then put the address on the handled chain.
7063 In the case of a batch of addresses that were all sent to the same
7064 transport, the return_file field in all of them will contain the same
7065 fd, and the return_filename field in the *last* one will be set (to the
7066 name of the file). */
7070 address_item *nextaddr;
7073 fprintf(f, "%s", CS emf_text);
7076 "The following text was generated during the delivery "
7077 "attempt%s:\n", (filecount > 1)? "s" : "");
7079 for (addr = msgchain; addr != NULL; addr = nextaddr)
7082 address_item *topaddr = addr;
7084 /* List all the addresses that relate to this file */
7087 while(addr) /* Insurance */
7089 print_address_information(addr, f, US"------ ", US"\n ",
7091 if (addr->return_filename) break;
7096 /* Now copy the file */
7098 fm = Ufopen(addr->return_filename, "rb");
7101 fprintf(f, " +++ Exim error... failed to open text file: %s\n",
7105 while ((ch = fgetc(fm)) != EOF) fputc(ch, f);
7108 Uunlink(addr->return_filename);
7110 /* Can now add to handled chain, first fishing off the next
7111 address on the msgchain. */
7113 nextaddr = addr->next;
7114 addr->next = handled_addr;
7115 handled_addr = topaddr;
7120 /* output machine readable part */
7122 "Content-type: message/delivery-status\n\n"
7123 "Reporting-MTA: dns; %s\n",
7124 bound, smtp_active_hostname);
7128 /* must be decoded from xtext: see RFC 3461:6.3a */
7130 if (auth_xtextdecode(dsn_envid, &xdec_envid) > 0)
7131 fprintf(f, "Original-Envelope-ID: %s\n", dsn_envid);
7133 fprintf(f, "X-Original-Envelope-ID: error decoding xtext formated ENVID\n");
7137 for (addr = handled_addr; addr; addr = addr->next)
7139 fprintf(f, "Action: failed\n"
7140 "Final-Recipient: rfc822;%s\n"
7143 if (addr->host_used && addr->host_used->name)
7145 fprintf(f, "Remote-MTA: dns; %s\n",
7146 addr->host_used->name);
7147 print_dsn_diagnostic_code(addr, f);
7151 /* Now copy the message, trying to give an intelligible comment if
7152 it is too long for it all to be copied. The limit isn't strictly
7153 applied because of the buffering. There is, however, an option
7154 to suppress copying altogether. */
7156 emf_text = next_emf(emf, US"copy");
7159 we ignore the intro text from template and add
7160 the text for bounce_return_size_limit at the end.
7162 bounce_return_message is ignored
7163 in case RET= is defined we honor these values
7164 otherwise bounce_return_body is honored.
7166 bounce_return_size_limit is always honored.
7169 fprintf(f, "\n--%s\n", bound);
7171 dsnlimitmsg = US"X-Exim-DSN-Information: Due to administrative limits only headers are returned";
7172 dsnnotifyhdr = NULL;
7173 topt = topt_add_return_path;
7175 /* RET=HDRS? top priority */
7176 if (dsn_ret == dsn_ret_hdrs)
7177 topt |= topt_no_body;
7179 /* no full body return at all? */
7180 if (!bounce_return_body)
7182 topt |= topt_no_body;
7183 /* add header if we overrule RET=FULL */
7184 if (dsn_ret == dsn_ret_full)
7185 dsnnotifyhdr = dsnlimitmsg;
7187 /* size limited ... return headers only if limit reached */
7188 else if (bounce_return_size_limit > 0)
7190 struct stat statbuf;
7191 if (fstat(deliver_datafile, &statbuf) == 0 && statbuf.st_size > max)
7193 topt |= topt_no_body;
7194 dsnnotifyhdr = dsnlimitmsg;
7198 if (topt & topt_no_body)
7199 fprintf(f,"Content-type: text/rfc822-headers\n\n");
7201 fprintf(f,"Content-type: message/rfc822\n\n");
7204 transport_filter_argv = NULL; /* Just in case */
7205 return_path = sender_address; /* In case not previously set */
7206 transport_write_message(NULL, fileno(f), topt,
7207 0, dsnnotifyhdr, NULL, NULL, NULL, NULL, 0);
7210 /* we never add the final text. close the file */
7214 fprintf(f, "\n--%s--\n", bound);
7216 /* Close the file, which should send an EOF to the child process
7217 that is receiving the message. Wait for it to finish. */
7220 rc = child_close(pid, 0); /* Waits for child to close, no timeout */
7222 /* In the test harness, let the child do it's thing first. */
7224 if (running_in_test_harness) millisleep(500);
7226 /* If the process failed, there was some disaster in setting up the
7227 error message. Unless the message is very old, ensure that addr_defer
7228 is non-null, which will have the effect of leaving the message on the
7229 spool. The failed addresses will get tried again next time. However, we
7230 don't really want this to happen too often, so freeze the message unless
7231 there are some genuine deferred addresses to try. To do this we have
7232 to call spool_write_header() here, because with no genuine deferred
7233 addresses the normal code below doesn't get run. */
7238 if (now - received_time < retry_maximum_timeout && addr_defer == NULL)
7240 addr_defer = (address_item *)(+1);
7241 deliver_freeze = TRUE;
7242 deliver_frozen_at = time(NULL);
7243 /* Panic-dies on error */
7244 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
7247 deliver_msglog("Process failed (%d) when writing error message "
7248 "to %s%s", rc, bounce_recipient, s);
7249 log_write(0, LOG_MAIN, "Process failed (%d) when writing error message "
7250 "to %s%s", rc, bounce_recipient, s);
7253 /* The message succeeded. Ensure that the recipients that failed are
7254 now marked finished with on the spool and their parents updated. */
7258 for (addr = handled_addr; addr != NULL; addr = addr->next)
7260 address_done(addr, logtod);
7261 child_done(addr, logtod);
7263 /* Panic-dies on error */
7264 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
7270 disable_logging = FALSE; /* In case left set */
7272 /* Come here from the mua_wrapper case if routing goes wrong */
7276 /* If there are now no deferred addresses, we are done. Preserve the
7277 message log if so configured, and we are using them. Otherwise, sling it.
7278 Then delete the message itself. */
7280 if (addr_defer == NULL)
7284 sprintf(CS spoolname, "%s/msglog/%s/%s", spool_directory, message_subdir,
7286 if (preserve_message_logs)
7289 sprintf(CS big_buffer, "%s/msglog.OLD/%s", spool_directory, id);
7290 if ((rc = Urename(spoolname, big_buffer)) < 0)
7292 (void)directory_make(spool_directory, US"msglog.OLD",
7293 MSGLOG_DIRECTORY_MODE, TRUE);
7294 rc = Urename(spoolname, big_buffer);
7297 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to move %s to the "
7298 "msglog.OLD directory", spoolname);
7302 if (Uunlink(spoolname) < 0)
7303 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s",
7304 spoolname, strerror(errno));
7308 /* Remove the two message files. */
7310 sprintf(CS spoolname, "%s/input/%s/%s-D", spool_directory, message_subdir, id);
7311 if (Uunlink(spoolname) < 0)
7312 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s",
7313 spoolname, strerror(errno));
7314 sprintf(CS spoolname, "%s/input/%s/%s-H", spool_directory, message_subdir, id);
7315 if (Uunlink(spoolname) < 0)
7316 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s",
7317 spoolname, strerror(errno));
7319 /* Log the end of this message, with queue time if requested. */
7321 if ((log_extra_selector & LX_queue_time_overall) != 0)
7322 log_write(0, LOG_MAIN, "Completed QT=%s",
7323 readconf_printtime( (int) ((long)time(NULL) - (long)received_time)) );
7325 log_write(0, LOG_MAIN, "Completed");
7327 /* Unset deliver_freeze so that we won't try to move the spool files further down */
7328 deliver_freeze = FALSE;
7330 #ifdef EXPERIMENTAL_EVENT
7331 (void) event_raise(event_action, US"msg:complete", NULL);
7335 /* If there are deferred addresses, we are keeping this message because it is
7336 not yet completed. Lose any temporary files that were catching output from
7337 pipes for any of the deferred addresses, handle one-time aliases, and see if
7338 the message has been on the queue for so long that it is time to send a warning
7339 message to the sender, unless it is a mailer-daemon. If all deferred addresses
7340 have the same domain, we can set deliver_domain for the expansion of
7341 delay_warning_ condition - if any of them are pipes, files, or autoreplies, use
7342 the parent's domain.
7344 If all the deferred addresses have an error number that indicates "retry time
7345 not reached", skip sending the warning message, because it won't contain the
7346 reason for the delay. It will get sent at the next real delivery attempt.
7347 However, if at least one address has tried, we'd better include all of them in
7350 If we can't make a process to send the message, don't worry.
7352 For mailing list expansions we want to send the warning message to the
7353 mailing list manager. We can't do a perfect job here, as some addresses may
7354 have different errors addresses, but if we take the errors address from
7355 each deferred address it will probably be right in most cases.
7357 If addr_defer == +1, it means there was a problem sending an error message
7358 for failed addresses, and there were no "real" deferred addresses. The value
7359 was set just to keep the message on the spool, so there is nothing to do here.
7362 else if (addr_defer != (address_item *)(+1))
7365 uschar *recipients = US"";
7366 BOOL delivery_attempted = FALSE;
7368 deliver_domain = testflag(addr_defer, af_pfr)?
7369 addr_defer->parent->domain : addr_defer->domain;
7371 for (addr = addr_defer; addr != NULL; addr = addr->next)
7373 address_item *otaddr;
7375 if (addr->basic_errno > ERRNO_RETRY_BASE) delivery_attempted = TRUE;
7377 if (deliver_domain != NULL)
7379 uschar *d = (testflag(addr, af_pfr))? addr->parent->domain : addr->domain;
7381 /* The domain may be unset for an address that has never been routed
7382 because the system filter froze the message. */
7384 if (d == NULL || Ustrcmp(d, deliver_domain) != 0) deliver_domain = NULL;
7387 if (addr->return_filename != NULL) Uunlink(addr->return_filename);
7389 /* Handle the case of one-time aliases. If any address in the ancestry
7390 of this one is flagged, ensure it is in the recipients list, suitably
7391 flagged, and that its parent is marked delivered. */
7393 for (otaddr = addr; otaddr != NULL; otaddr = otaddr->parent)
7394 if (otaddr->onetime_parent != NULL) break;
7399 int t = recipients_count;
7401 for (i = 0; i < recipients_count; i++)
7403 uschar *r = recipients_list[i].address;
7404 if (Ustrcmp(otaddr->onetime_parent, r) == 0) t = i;
7405 if (Ustrcmp(otaddr->address, r) == 0) break;
7408 /* Didn't find the address already in the list, and did find the
7409 ultimate parent's address in the list. After adding the recipient,
7410 update the errors address in the recipients list. */
7412 if (i >= recipients_count && t < recipients_count)
7414 DEBUG(D_deliver) debug_printf("one_time: adding %s in place of %s\n",
7415 otaddr->address, otaddr->parent->address);
7416 receive_add_recipient(otaddr->address, t);
7417 recipients_list[recipients_count-1].errors_to = otaddr->p.errors_address;
7418 tree_add_nonrecipient(otaddr->parent->address);
7419 update_spool = TRUE;
7423 /* Except for error messages, ensure that either the errors address for
7424 this deferred address or, if there is none, the sender address, is on the
7425 list of recipients for a warning message. */
7427 if (sender_address[0] != 0)
7429 if (addr->p.errors_address == NULL)
7431 if (Ustrstr(recipients, sender_address) == NULL)
7432 recipients = string_sprintf("%s%s%s", recipients,
7433 (recipients[0] == 0)? "" : ",", sender_address);
7437 if (Ustrstr(recipients, addr->p.errors_address) == NULL)
7438 recipients = string_sprintf("%s%s%s", recipients,
7439 (recipients[0] == 0)? "" : ",", addr->p.errors_address);
7444 /* Send a warning message if the conditions are right. If the condition check
7445 fails because of a lookup defer, there is nothing we can do. The warning
7446 is not sent. Another attempt will be made at the next delivery attempt (if
7450 && delivery_attempted
7451 && ( ((addr_defer->dsn_flags & rf_dsnflags) == 0)
7452 || (addr_defer->dsn_flags & rf_notify_delay) == rf_notify_delay
7454 && delay_warning[1] > 0
7455 && sender_address[0] != 0
7456 && ( delay_warning_condition == NULL
7457 || expand_check_condition(delay_warning_condition,
7458 US"delay_warning", US"option")
7464 int queue_time = time(NULL) - received_time;
7466 /* When running in the test harness, there's an option that allows us to
7467 fudge this time so as to get repeatability of the tests. Take the first
7468 time off the list. In queue runs, the list pointer gets updated in the
7471 if (running_in_test_harness && fudged_queue_times[0] != 0)
7473 int qt = readconf_readtime(fudged_queue_times, '/', FALSE);
7476 DEBUG(D_deliver) debug_printf("fudged queue_times = %s\n",
7477 fudged_queue_times);
7482 /* See how many warnings we should have sent by now */
7484 for (count = 0; count < delay_warning[1]; count++)
7485 if (queue_time < delay_warning[count+2]) break;
7487 show_time = delay_warning[count+1];
7489 if (count >= delay_warning[1])
7492 int last_gap = show_time;
7493 if (count > 1) last_gap -= delay_warning[count];
7494 extra = (queue_time - delay_warning[count+1])/last_gap;
7495 show_time += last_gap * extra;
7501 debug_printf("time on queue = %s\n", readconf_printtime(queue_time));
7502 debug_printf("warning counts: required %d done %d\n", count,
7506 /* We have computed the number of warnings there should have been by now.
7507 If there haven't been enough, send one, and up the count to what it should
7510 if (warning_count < count)
7514 pid_t pid = child_open_exim(&fd);
7520 FILE *f = fdopen(fd, "wb");
7523 if (warn_message_file)
7525 wmf = Ufopen(warn_message_file, "rb");
7527 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to open %s for warning "
7528 "message texts: %s", warn_message_file, strerror(errno));
7531 warnmsg_recipients = recipients;
7532 warnmsg_delay = (queue_time < 120*60)?
7533 string_sprintf("%d minutes", show_time/60):
7534 string_sprintf("%d hours", show_time/3600);
7536 if (errors_reply_to)
7537 fprintf(f, "Reply-To: %s\n", errors_reply_to);
7538 fprintf(f, "Auto-Submitted: auto-replied\n");
7540 fprintf(f, "To: %s\n", recipients);
7542 /* generated boundary string and output MIME-Headers */
7543 bound = string_sprintf(TIME_T_FMT "-eximdsn-%d", time(NULL), rand());
7545 fprintf(f, "Content-Type: multipart/report;"
7546 " report-type=delivery-status; boundary=%s\n"
7547 "MIME-Version: 1.0\n",
7550 if ((wmf_text = next_emf(wmf, US"header")))
7551 fprintf(f, "%s\n", wmf_text);
7553 fprintf(f, "Subject: Warning: message %s delayed %s\n\n",
7554 message_id, warnmsg_delay);
7556 /* output human readable part as text/plain section */
7558 "Content-type: text/plain; charset=us-ascii\n\n",
7561 if ((wmf_text = next_emf(wmf, US"intro")))
7562 fprintf(f, "%s", CS wmf_text);
7566 "This message was created automatically by mail delivery software.\n");
7568 if (Ustrcmp(recipients, sender_address) == 0)
7570 "A message that you sent has not yet been delivered to one or more of its\n"
7571 "recipients after more than ");
7575 "A message sent by\n\n <%s>\n\n"
7576 "has not yet been delivered to one or more of its recipients after more than \n",
7579 fprintf(f, "%s on the queue on %s.\n\n"
7580 "The message identifier is: %s\n",
7581 warnmsg_delay, primary_hostname, message_id);
7583 for (h = header_list; h != NULL; h = h->next)
7584 if (strncmpic(h->text, US"Subject:", 8) == 0)
7585 fprintf(f, "The subject of the message is: %s", h->text + 9);
7586 else if (strncmpic(h->text, US"Date:", 5) == 0)
7587 fprintf(f, "The date of the message is: %s", h->text + 6);
7590 fprintf(f, "The address%s to which the message has not yet been "
7592 !addr_defer->next ? "" : "es",
7593 !addr_defer->next ? "is": "are");
7596 /* List the addresses, with error information if allowed */
7598 /* store addr_defer for machine readable part */
7599 address_item *addr_dsndefer = addr_defer;
7603 address_item *addr = addr_defer;
7604 addr_defer = addr->next;
7605 if (print_address_information(addr, f, US" ", US"\n ", US""))
7606 print_address_error(addr, f, US"Delay reason: ");
7615 if ((wmf_text = next_emf(wmf, US"final")))
7616 fprintf(f, "%s", CS wmf_text);
7622 "No action is required on your part. Delivery attempts will continue for\n"
7623 "some time, and this warning may be repeated at intervals if the message\n"
7624 "remains undelivered. Eventually the mail delivery software will give up,\n"
7625 "and when that happens, the message will be returned to you.\n");
7628 /* output machine readable part */
7629 fprintf(f, "\n--%s\n"
7630 "Content-type: message/delivery-status\n\n"
7631 "Reporting-MTA: dns; %s\n",
7633 smtp_active_hostname);
7638 /* must be decoded from xtext: see RFC 3461:6.3a */
7640 if (auth_xtextdecode(dsn_envid, &xdec_envid) > 0)
7641 fprintf(f,"Original-Envelope-ID: %s\n", dsn_envid);
7643 fprintf(f,"X-Original-Envelope-ID: error decoding xtext formated ENVID\n");
7647 while (addr_dsndefer)
7649 if (addr_dsndefer->dsn_orcpt)
7650 fprintf(f,"Original-Recipient: %s\n", addr_dsndefer->dsn_orcpt);
7652 fprintf(f,"Action: delayed\n");
7653 fprintf(f,"Final-Recipient: rfc822;%s\n", addr_dsndefer->address);
7654 fprintf(f,"Status: 4.0.0\n");
7655 if (addr_dsndefer->host_used && addr_dsndefer->host_used->name)
7657 fprintf(f,"Remote-MTA: dns; %s\n",
7658 addr_dsndefer->host_used->name);
7659 print_dsn_diagnostic_code(addr_dsndefer, f);
7661 addr_dsndefer = addr_dsndefer->next;
7664 fprintf(f, "\n--%s\n"
7665 "Content-type: text/rfc822-headers\n\n",
7669 /* header only as required by RFC. only failure DSN needs to honor RET=FULL */
7670 int topt = topt_add_return_path | topt_no_body;
7671 transport_filter_argv = NULL; /* Just in case */
7672 return_path = sender_address; /* In case not previously set */
7673 /* Write the original email out */
7674 transport_write_message(NULL, fileno(f), topt, 0, NULL, NULL, NULL, NULL, NULL, 0);
7677 fprintf(f,"\n--%s--\n", bound);
7681 /* Close and wait for child process to complete, without a timeout.
7682 If there's an error, don't update the count. */
7685 if (child_close(pid, 0) == 0)
7687 warning_count = count;
7688 update_spool = TRUE; /* Ensure spool rewritten */
7694 /* Clear deliver_domain */
7696 deliver_domain = NULL;
7698 /* If this was a first delivery attempt, unset the first time flag, and
7699 ensure that the spool gets updated. */
7701 if (deliver_firsttime)
7703 deliver_firsttime = FALSE;
7704 update_spool = TRUE;
7707 /* If delivery was frozen and freeze_tell is set, generate an appropriate
7708 message, unless the message is a local error message (to avoid loops). Then
7709 log the freezing. If the text in "frozen_info" came from a system filter,
7710 it has been escaped into printing characters so as not to mess up log lines.
7711 For the "tell" message, we turn \n back into newline. Also, insert a newline
7712 near the start instead of the ": " string. */
7716 if (freeze_tell != NULL && freeze_tell[0] != 0 && !local_error_message)
7718 uschar *s = string_copy(frozen_info);
7719 uschar *ss = Ustrstr(s, " by the system filter: ");
7730 if (*ss == '\\' && ss[1] == 'n')
7737 moan_tell_someone(freeze_tell, addr_defer, US"Message frozen",
7738 "Message %s has been frozen%s.\nThe sender is <%s>.\n", message_id,
7742 /* Log freezing just before we update the -H file, to minimize the chance
7743 of a race problem. */
7745 deliver_msglog("*** Frozen%s\n", frozen_info);
7746 log_write(0, LOG_MAIN, "Frozen%s", frozen_info);
7749 /* If there have been any updates to the non-recipients list, or other things
7750 that get written to the spool, we must now update the spool header file so
7751 that it has the right information for the next delivery attempt. If there
7752 was more than one address being delivered, the header_change update is done
7753 earlier, in case one succeeds and then something crashes. */
7756 debug_printf("delivery deferred: update_spool=%d header_rewritten=%d\n",
7757 update_spool, header_rewritten);
7759 if (update_spool || header_rewritten)
7760 /* Panic-dies on error */
7761 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
7764 /* Finished with the message log. If the message is complete, it will have
7765 been unlinked or renamed above. */
7767 if (message_logs) (void)fclose(message_log);
7769 /* Now we can close and remove the journal file. Its only purpose is to record
7770 successfully completed deliveries asap so that this information doesn't get
7771 lost if Exim (or the machine) crashes. Forgetting about a failed delivery is
7772 not serious, as trying it again is not harmful. The journal might not be open
7773 if all addresses were deferred at routing or directing. Nevertheless, we must
7774 remove it if it exists (may have been lying around from a crash during the
7775 previous delivery attempt). We don't remove the journal if a delivery
7776 subprocess failed to pass back delivery information; this is controlled by
7777 the remove_journal flag. When the journal is left, we also don't move the
7778 message off the main spool if frozen and the option is set. It should get moved
7779 at the next attempt, after the journal has been inspected. */
7781 if (journal_fd >= 0) (void)close(journal_fd);
7785 sprintf(CS spoolname, "%s/input/%s/%s-J", spool_directory, message_subdir, id);
7786 if (Uunlink(spoolname) < 0 && errno != ENOENT)
7787 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s", spoolname,
7790 /* Move the message off the spool if reqested */
7792 #ifdef SUPPORT_MOVE_FROZEN_MESSAGES
7793 if (deliver_freeze && move_frozen_messages)
7794 (void)spool_move_message(id, message_subdir, US"", US"F");
7798 /* Closing the data file frees the lock; if the file has been unlinked it
7799 will go away. Otherwise the message becomes available for another process
7802 (void)close(deliver_datafile);
7803 deliver_datafile = -1;
7804 DEBUG(D_deliver) debug_printf("end delivery of %s\n", id);
7806 /* It is unlikely that there will be any cached resources, since they are
7807 released after routing, and in the delivery subprocesses. However, it's
7808 possible for an expansion for something afterwards (for example,
7809 expand_check_condition) to do a lookup. We must therefore be sure everything is
7813 acl_where = ACL_WHERE_UNKNOWN;
7822 if (!regex_PIPELINING) regex_PIPELINING =
7823 regex_must_compile(US"\\n250[\\s\\-]PIPELINING(\\s|\\n|$)", FALSE, TRUE);
7825 if (!regex_SIZE) regex_SIZE =
7826 regex_must_compile(US"\\n250[\\s\\-]SIZE(\\s|\\n|$)", FALSE, TRUE);
7828 if (!regex_AUTH) regex_AUTH =
7829 regex_must_compile(US"\\n250[\\s\\-]AUTH\\s+([\\-\\w\\s]+)(?:\\n|$)",
7833 if (!regex_STARTTLS) regex_STARTTLS =
7834 regex_must_compile(US"\\n250[\\s\\-]STARTTLS(\\s|\\n|$)", FALSE, TRUE);
7837 #ifndef DISABLE_PRDR
7838 if (!regex_PRDR) regex_PRDR =
7839 regex_must_compile(US"\\n250[\\s\\-]PRDR(\\s|\\n|$)", FALSE, TRUE);
7842 if (!regex_DSN) regex_DSN =
7843 regex_must_compile(US"\\n250[\\s\\-]DSN(\\s|\\n|$)", FALSE, TRUE);
7845 if (!regex_IGNOREQUOTA) regex_IGNOREQUOTA =
7846 regex_must_compile(US"\\n250[\\s\\-]IGNOREQUOTA(\\s|\\n|$)", FALSE, TRUE);
7852 /* End of deliver.c */