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 const uschar ***p = address_expansions;
131 while (*p != NULL) **p++ = NULL;
135 /* Exactly what gets set depends on whether there is one or more addresses, and
136 what they contain. These first ones are always set, taking their values from
137 the first address. */
139 if (addr->host_list == NULL)
141 deliver_host = deliver_host_address = US"";
142 deliver_host_port = 0;
146 deliver_host = addr->host_list->name;
147 deliver_host_address = addr->host_list->address;
148 deliver_host_port = addr->host_list->port;
151 deliver_recipients = addr;
152 deliver_address_data = addr->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, const uschar * event, uschar * ev_data)
727 debug_printf("Event(%s): event_action=|%s| delivery_IP=%s\n",
729 action, deliver_host_address);
732 event_data = ev_data;
734 if (!(s = expand_string(action)) && *expand_string_message)
735 log_write(0, LOG_MAIN|LOG_PANIC,
736 "failed to expand event_action %s in %s: %s\n",
737 event, transport_name, expand_string_message);
739 event_name = event_data = NULL;
741 /* If the expansion returns anything but an empty string, flag for
742 the caller to modify his normal processing
747 debug_printf("Event(%s): event_action returned \"%s\"\n", event, s);
755 msg_event_raise(const uschar * event, const address_item * addr)
757 const uschar * save_domain = deliver_domain;
758 uschar * save_local = deliver_localpart;
759 const uschar * save_host = deliver_host;
761 if (!addr->transport)
764 router_name = addr->router ? addr->router->name : NULL;
765 transport_name = addr->transport->name;
766 deliver_domain = addr->domain;
767 deliver_localpart = addr->local_part;
768 deliver_host = addr->host_used ? addr->host_used->name : NULL;
770 (void) event_raise(addr->transport->event_action, event,
771 addr->host_used || Ustrcmp(addr->transport->driver_name, "lmtp") == 0
772 ? addr->message : NULL);
774 deliver_host = save_host;
775 deliver_localpart = save_local;
776 deliver_domain = save_domain;
777 router_name = transport_name = NULL;
779 #endif /*EXPERIMENTAL_EVENT*/
783 /* If msg is NULL this is a delivery log and logchar is used. Otherwise
784 this is a nonstandard call; no two-character delivery flag is written
785 but sender-host and sender are prefixed and "msg" is inserted in the log line.
788 flags passed to log_write()
791 delivery_log(int flags, address_item * addr, int logchar, uschar * msg)
794 int size = 256; /* Used for a temporary, */
795 int ptr = 0; /* expanding buffer, for */
796 uschar *s; /* building log lines; */
797 void *reset_point; /* released afterwards. */
799 /* Log the delivery on the main log. We use an extensible string to build up
800 the log line, and reset the store afterwards. Remote deliveries should always
801 have a pointer to the host item that succeeded; local deliveries can have a
802 pointer to a single host item in their host list, for use by the transport. */
804 #ifdef EXPERIMENTAL_EVENT
805 /* presume no successful remote delivery */
806 lookup_dnssec_authenticated = NULL;
809 s = reset_point = store_get(size);
811 log_address = string_log_address(addr, (log_write_selector & L_all_parents) != 0, TRUE);
813 s = string_append(s, &size, &ptr, 3, host_and_ident(TRUE), US" ", log_address);
817 s = string_append(s, &size, &ptr, 2, US"> ", log_address);
820 if (log_extra_selector & LX_incoming_interface && sending_ip_address)
821 s = string_append(s, &size, &ptr, 3, US" I=[", sending_ip_address, US"]");
822 /* for the port: string_sprintf("%d", sending_port) */
824 if ((log_extra_selector & LX_sender_on_delivery) != 0 || msg)
825 s = string_append(s, &size, &ptr, 3, US" F=<", sender_address, US">");
827 #ifdef EXPERIMENTAL_SRS
828 if(addr->p.srs_sender)
829 s = string_append(s, &size, &ptr, 3, US" SRS=<", addr->p.srs_sender, US">");
832 /* You might think that the return path must always be set for a successful
833 delivery; indeed, I did for some time, until this statement crashed. The case
834 when it is not set is for a delivery to /dev/null which is optimised by not
837 if (used_return_path != NULL &&
838 (log_extra_selector & LX_return_path_on_delivery) != 0)
839 s = string_append(s, &size, &ptr, 3, US" P=<", used_return_path, US">");
842 s = string_append(s, &size, &ptr, 2, US" ", msg);
844 /* For a delivery from a system filter, there may not be a router */
845 if (addr->router != NULL)
846 s = string_append(s, &size, &ptr, 2, US" R=", addr->router->name);
848 s = string_append(s, &size, &ptr, 2, US" T=", addr->transport->name);
850 if ((log_extra_selector & LX_delivery_size) != 0)
851 s = string_append(s, &size, &ptr, 2, US" S=",
852 string_sprintf("%d", transport_count));
856 if (addr->transport->info->local)
859 s = string_append(s, &size, &ptr, 2, US" H=", addr->host_list->name);
860 if (addr->shadow_message != NULL)
861 s = string_cat(s, &size, &ptr, addr->shadow_message,
862 Ustrlen(addr->shadow_message));
865 /* Remote delivery */
871 s = d_hostlog(s, &size, &ptr, addr);
872 if (continue_sequence > 1)
873 s = string_cat(s, &size, &ptr, US"*", 1);
875 #ifdef EXPERIMENTAL_EVENT
876 deliver_host_address = addr->host_used->address;
877 deliver_host_port = addr->host_used->port;
878 deliver_host = addr->host_used->name;
880 /* DNS lookup status */
881 lookup_dnssec_authenticated = addr->host_used->dnssec==DS_YES ? US"yes"
882 : addr->host_used->dnssec==DS_NO ? US"no"
888 s = d_tlslog(s, &size, &ptr, addr);
891 if (addr->authenticator)
893 s = string_append(s, &size, &ptr, 2, US" A=", addr->authenticator);
896 s = string_append(s, &size, &ptr, 2, US":", addr->auth_id);
897 if (log_extra_selector & LX_smtp_mailauth && addr->auth_sndr)
898 s = string_append(s, &size, &ptr, 2, US":", addr->auth_sndr);
903 if (addr->flags & af_prdr_used)
904 s = string_append(s, &size, &ptr, 1, US" PRDR");
908 /* confirmation message (SMTP (host_used) and LMTP (driver_name)) */
910 if (log_extra_selector & LX_smtp_confirmation &&
912 (addr->host_used || Ustrcmp(addr->transport->driver_name, "lmtp") == 0))
915 unsigned lim = big_buffer_size < 1024 ? big_buffer_size : 1024;
916 uschar *p = big_buffer;
917 uschar *ss = addr->message;
919 for (i = 0; i < lim && ss[i] != 0; i++) /* limit logged amount */
921 if (ss[i] == '\"' || ss[i] == '\\') *p++ = '\\'; /* quote \ and " */
926 s = string_append(s, &size, &ptr, 2, US" C=", big_buffer);
929 /* Time on queue and actual time taken to deliver */
931 if ((log_extra_selector & LX_queue_time) != 0)
932 s = string_append(s, &size, &ptr, 2, US" QT=",
933 readconf_printtime( (int) ((long)time(NULL) - (long)received_time)) );
935 if ((log_extra_selector & LX_deliver_time) != 0)
936 s = string_append(s, &size, &ptr, 2, US" DT=",
937 readconf_printtime(addr->more_errno));
939 /* string_cat() always leaves room for the terminator. Release the
940 store we used to build the line after writing it. */
943 log_write(0, flags, "%s", s);
945 #ifdef EXPERIMENTAL_EVENT
946 if (!msg) msg_event_raise(US"msg:delivery", addr);
949 store_reset(reset_point);
955 /*************************************************
956 * Actions at the end of handling an address *
957 *************************************************/
959 /* This is a function for processing a single address when all that can be done
960 with it has been done.
963 addr points to the address block
964 result the result of the delivery attempt
965 logflags flags for log_write() (LOG_MAIN and/or LOG_PANIC)
966 driver_type indicates which type of driver (transport, or router) was last
967 to process the address
968 logchar '=' or '-' for use when logging deliveries with => or ->
974 post_process_one(address_item *addr, int result, int logflags, int driver_type,
977 uschar *now = tod_stamp(tod_log);
978 uschar *driver_kind = NULL;
979 uschar *driver_name = NULL;
982 int size = 256; /* Used for a temporary, */
983 int ptr = 0; /* expanding buffer, for */
984 uschar *s; /* building log lines; */
985 void *reset_point; /* released afterwards. */
987 DEBUG(D_deliver) debug_printf("post-process %s (%d)\n", addr->address, result);
989 /* Set up driver kind and name for logging. Disable logging if the router or
990 transport has disabled it. */
992 if (driver_type == DTYPE_TRANSPORT)
994 if (addr->transport != NULL)
996 driver_name = addr->transport->name;
997 driver_kind = US" transport";
998 disable_logging = addr->transport->disable_logging;
1000 else driver_kind = US"transporting";
1002 else if (driver_type == DTYPE_ROUTER)
1004 if (addr->router != NULL)
1006 driver_name = addr->router->name;
1007 driver_kind = US" router";
1008 disable_logging = addr->router->disable_logging;
1010 else driver_kind = US"routing";
1013 /* If there's an error message set, ensure that it contains only printing
1014 characters - it should, but occasionally things slip in and this at least
1015 stops the log format from getting wrecked. We also scan the message for an LDAP
1016 expansion item that has a password setting, and flatten the password. This is a
1017 fudge, but I don't know a cleaner way of doing this. (If the item is badly
1018 malformed, it won't ever have gone near LDAP.) */
1020 if (addr->message != NULL)
1022 const uschar * s = string_printing(addr->message);
1023 if (s != addr->message)
1024 addr->message = US s;
1025 /* deconst cast ok as string_printing known to have alloc'n'copied */
1026 if (((Ustrstr(addr->message, "failed to expand") != NULL) || (Ustrstr(addr->message, "expansion of ") != NULL)) &&
1027 (Ustrstr(addr->message, "mysql") != NULL ||
1028 Ustrstr(addr->message, "pgsql") != NULL ||
1029 #ifdef EXPERIMENTAL_REDIS
1030 Ustrstr(addr->message, "redis") != NULL ||
1032 Ustrstr(addr->message, "sqlite") != NULL ||
1033 Ustrstr(addr->message, "ldap:") != NULL ||
1034 Ustrstr(addr->message, "ldapdn:") != NULL ||
1035 Ustrstr(addr->message, "ldapm:") != NULL))
1037 addr->message = string_sprintf("Temporary internal error");
1041 /* If we used a transport that has one of the "return_output" options set, and
1042 if it did in fact generate some output, then for return_output we treat the
1043 message as failed if it was not already set that way, so that the output gets
1044 returned to the sender, provided there is a sender to send it to. For
1045 return_fail_output, do this only if the delivery failed. Otherwise we just
1046 unlink the file, and remove the name so that if the delivery failed, we don't
1047 try to send back an empty or unwanted file. The log_output options operate only
1048 on a non-empty file.
1050 In any case, we close the message file, because we cannot afford to leave a
1051 file-descriptor for one address while processing (maybe very many) others. */
1053 if (addr->return_file >= 0 && addr->return_filename != NULL)
1055 BOOL return_output = FALSE;
1056 struct stat statbuf;
1057 (void)EXIMfsync(addr->return_file);
1059 /* If there is no output, do nothing. */
1061 if (fstat(addr->return_file, &statbuf) == 0 && statbuf.st_size > 0)
1063 transport_instance *tb = addr->transport;
1065 /* Handle logging options */
1067 if (tb->log_output || (result == FAIL && tb->log_fail_output) ||
1068 (result == DEFER && tb->log_defer_output))
1071 FILE *f = Ufopen(addr->return_filename, "rb");
1073 log_write(0, LOG_MAIN|LOG_PANIC, "failed to open %s to log output "
1074 "from %s transport: %s", addr->return_filename, tb->name,
1078 s = US Ufgets(big_buffer, big_buffer_size, f);
1081 uschar *p = big_buffer + Ustrlen(big_buffer);
1083 while (p > big_buffer && isspace(p[-1])) p--;
1085 sp = string_printing(big_buffer);
1086 log_write(0, LOG_MAIN, "<%s>: %s transport output: %s",
1087 addr->address, tb->name, sp);
1093 /* Handle returning options, but only if there is an address to return
1096 if (sender_address[0] != 0 || addr->p.errors_address != NULL)
1098 if (tb->return_output)
1100 addr->transport_return = result = FAIL;
1101 if (addr->basic_errno == 0 && addr->message == NULL)
1102 addr->message = US"return message generated";
1103 return_output = TRUE;
1106 if (tb->return_fail_output && result == FAIL) return_output = TRUE;
1110 /* Get rid of the file unless it might be returned, but close it in
1115 Uunlink(addr->return_filename);
1116 addr->return_filename = NULL;
1117 addr->return_file = -1;
1120 (void)close(addr->return_file);
1123 /* The success case happens only after delivery by a transport. */
1127 addr->next = addr_succeed;
1128 addr_succeed = addr;
1130 /* Call address_done() to ensure that we don't deliver to this address again,
1131 and write appropriate things to the message log. If it is a child address, we
1132 call child_done() to scan the ancestors and mark them complete if this is the
1133 last child to complete. */
1135 address_done(addr, now);
1136 DEBUG(D_deliver) debug_printf("%s delivered\n", addr->address);
1138 if (addr->parent == NULL)
1139 deliver_msglog("%s %s: %s%s succeeded\n", now, addr->address,
1140 driver_name, driver_kind);
1143 deliver_msglog("%s %s <%s>: %s%s succeeded\n", now, addr->address,
1144 addr->parent->address, driver_name, driver_kind);
1145 child_done(addr, now);
1148 /* Certificates for logging (via events) */
1150 tls_out.ourcert = addr->ourcert;
1151 addr->ourcert = NULL;
1152 tls_out.peercert = addr->peercert;
1153 addr->peercert = NULL;
1155 tls_out.cipher = addr->cipher;
1156 tls_out.peerdn = addr->peerdn;
1157 tls_out.ocsp = addr->ocsp;
1158 # ifdef EXPERIMENTAL_DANE
1159 tls_out.dane_verified = testflag(addr, af_dane_verified);
1163 delivery_log(LOG_MAIN, addr, logchar, NULL);
1166 if (tls_out.ourcert)
1168 tls_free_cert(tls_out.ourcert);
1169 tls_out.ourcert = NULL;
1171 if (tls_out.peercert)
1173 tls_free_cert(tls_out.peercert);
1174 tls_out.peercert = NULL;
1176 tls_out.cipher = NULL;
1177 tls_out.peerdn = NULL;
1178 tls_out.ocsp = OCSP_NOT_REQ;
1179 # ifdef EXPERIMENTAL_DANE
1180 tls_out.dane_verified = FALSE;
1186 /* Soft failure, or local delivery process failed; freezing may be
1189 else if (result == DEFER || result == PANIC)
1191 if (result == PANIC) logflags |= LOG_PANIC;
1193 /* This puts them on the chain in reverse order. Do not change this, because
1194 the code for handling retries assumes that the one with the retry
1195 information is last. */
1197 addr->next = addr_defer;
1200 /* The only currently implemented special action is to freeze the
1201 message. Logging of this is done later, just before the -H file is
1204 if (addr->special_action == SPECIAL_FREEZE)
1206 deliver_freeze = TRUE;
1207 deliver_frozen_at = time(NULL);
1208 update_spool = TRUE;
1211 /* If doing a 2-stage queue run, we skip writing to either the message
1212 log or the main log for SMTP defers. */
1214 if (!queue_2stage || addr->basic_errno != 0)
1218 /* For errors of the type "retry time not reached" (also remotes skipped
1219 on queue run), logging is controlled by L_retry_defer. Note that this kind
1220 of error number is negative, and all the retry ones are less than any
1223 unsigned int use_log_selector = (addr->basic_errno <= ERRNO_RETRY_BASE)?
1226 /* Build up the line that is used for both the message log and the main
1229 s = reset_point = store_get(size);
1231 /* Create the address string for logging. Must not do this earlier, because
1232 an OK result may be changed to FAIL when a pipe returns text. */
1234 log_address = string_log_address(addr,
1235 (log_write_selector & L_all_parents) != 0, result == OK);
1237 s = string_cat(s, &size, &ptr, log_address, Ustrlen(log_address));
1239 /* Either driver_name contains something and driver_kind contains
1240 " router" or " transport" (note the leading space), or driver_name is
1241 a null string and driver_kind contains "routing" without the leading
1242 space, if all routing has been deferred. When a domain has been held,
1243 so nothing has been done at all, both variables contain null strings. */
1245 if (driver_name == NULL)
1247 if (driver_kind != NULL)
1248 s = string_append(s, &size, &ptr, 2, US" ", driver_kind);
1252 if (driver_kind[1] == 't' && addr->router != NULL)
1253 s = string_append(s, &size, &ptr, 2, US" R=", addr->router->name);
1255 ss[1] = toupper(driver_kind[1]);
1256 s = string_append(s, &size, &ptr, 2, ss, driver_name);
1259 sprintf(CS ss, " defer (%d)", addr->basic_errno);
1260 s = string_cat(s, &size, &ptr, ss, Ustrlen(ss));
1262 if (addr->basic_errno > 0)
1263 s = string_append(s, &size, &ptr, 2, US": ",
1264 US strerror(addr->basic_errno));
1266 if (addr->host_used)
1267 s = string_append(s, &size, &ptr, 5,
1268 US" H=", addr->host_used->name,
1269 US" [", addr->host_used->address, US"]");
1271 if (addr->message != NULL)
1272 s = string_append(s, &size, &ptr, 2, US": ", addr->message);
1276 /* Log the deferment in the message log, but don't clutter it
1277 up with retry-time defers after the first delivery attempt. */
1279 if (deliver_firsttime || addr->basic_errno > ERRNO_RETRY_BASE)
1280 deliver_msglog("%s %s\n", now, s);
1282 /* Write the main log and reset the store */
1284 log_write(use_log_selector, logflags, "== %s", s);
1285 store_reset(reset_point);
1290 /* Hard failure. If there is an address to which an error message can be sent,
1291 put this address on the failed list. If not, put it on the deferred list and
1292 freeze the mail message for human attention. The latter action can also be
1293 explicitly requested by a router or transport. */
1297 /* If this is a delivery error, or a message for which no replies are
1298 wanted, and the message's age is greater than ignore_bounce_errors_after,
1299 force the af_ignore_error flag. This will cause the address to be discarded
1300 later (with a log entry). */
1302 if (sender_address[0] == 0 && message_age >= ignore_bounce_errors_after)
1303 setflag(addr, af_ignore_error);
1305 /* Freeze the message if requested, or if this is a bounce message (or other
1306 message with null sender) and this address does not have its own errors
1307 address. However, don't freeze if errors are being ignored. The actual code
1308 to ignore occurs later, instead of sending a message. Logging of freezing
1309 occurs later, just before writing the -H file. */
1311 if (!testflag(addr, af_ignore_error) &&
1312 (addr->special_action == SPECIAL_FREEZE ||
1313 (sender_address[0] == 0 && addr->p.errors_address == NULL)
1316 frozen_info = (addr->special_action == SPECIAL_FREEZE)? US"" :
1317 (sender_local && !local_error_message)?
1318 US" (message created with -f <>)" : US" (delivery error message)";
1319 deliver_freeze = TRUE;
1320 deliver_frozen_at = time(NULL);
1321 update_spool = TRUE;
1323 /* The address is put on the defer rather than the failed queue, because
1324 the message is being retained. */
1326 addr->next = addr_defer;
1330 /* Don't put the address on the nonrecipients tree yet; wait until an
1331 error message has been successfully sent. */
1335 addr->next = addr_failed;
1339 /* Build up the log line for the message and main logs */
1341 s = reset_point = store_get(size);
1343 /* Create the address string for logging. Must not do this earlier, because
1344 an OK result may be changed to FAIL when a pipe returns text. */
1346 log_address = string_log_address(addr,
1347 (log_write_selector & L_all_parents) != 0, result == OK);
1349 s = string_cat(s, &size, &ptr, log_address, Ustrlen(log_address));
1351 if ((log_extra_selector & LX_sender_on_delivery) != 0)
1352 s = string_append(s, &size, &ptr, 3, US" F=<", sender_address, US">");
1354 /* Return path may not be set if no delivery actually happened */
1356 if (used_return_path != NULL &&
1357 (log_extra_selector & LX_return_path_on_delivery) != 0)
1358 s = string_append(s, &size, &ptr, 3, US" P=<", used_return_path, US">");
1360 if (addr->router != NULL)
1361 s = string_append(s, &size, &ptr, 2, US" R=", addr->router->name);
1362 if (addr->transport != NULL)
1363 s = string_append(s, &size, &ptr, 2, US" T=", addr->transport->name);
1365 if (addr->host_used != NULL)
1366 s = d_hostlog(s, &size, &ptr, addr);
1369 s = d_tlslog(s, &size, &ptr, addr);
1372 if (addr->basic_errno > 0)
1373 s = string_append(s, &size, &ptr, 2, US": ",
1374 US strerror(addr->basic_errno));
1376 if (addr->message != NULL)
1377 s = string_append(s, &size, &ptr, 2, US": ", addr->message);
1381 /* Do the logging. For the message log, "routing failed" for those cases,
1382 just to make it clearer. */
1384 if (driver_name == NULL)
1385 deliver_msglog("%s %s failed for %s\n", now, driver_kind, s);
1387 deliver_msglog("%s %s\n", now, s);
1389 log_write(0, LOG_MAIN, "** %s", s);
1391 #ifdef EXPERIMENTAL_EVENT
1392 msg_event_raise(US"msg:fail:delivery", addr);
1395 store_reset(reset_point);
1398 /* Ensure logging is turned on again in all cases */
1400 disable_logging = FALSE;
1406 /*************************************************
1407 * Address-independent error *
1408 *************************************************/
1410 /* This function is called when there's an error that is not dependent on a
1411 particular address, such as an expansion string failure. It puts the error into
1412 all the addresses in a batch, logs the incident on the main and panic logs, and
1413 clears the expansions. It is mostly called from local_deliver(), but can be
1414 called for a remote delivery via findugid().
1417 logit TRUE if (MAIN+PANIC) logging required
1418 addr the first of the chain of addresses
1420 format format string for error message, or NULL if already set in addr
1421 ... arguments for the format
1427 common_error(BOOL logit, address_item *addr, int code, uschar *format, ...)
1429 address_item *addr2;
1430 addr->basic_errno = code;
1436 va_start(ap, format);
1437 if (!string_vformat(buffer, sizeof(buffer), CS format, ap))
1438 log_write(0, LOG_MAIN|LOG_PANIC_DIE,
1439 "common_error expansion was longer than " SIZE_T_FMT, sizeof(buffer));
1441 addr->message = string_copy(buffer);
1444 for (addr2 = addr->next; addr2 != NULL; addr2 = addr2->next)
1446 addr2->basic_errno = code;
1447 addr2->message = addr->message;
1450 if (logit) log_write(0, LOG_MAIN|LOG_PANIC, "%s", addr->message);
1451 deliver_set_expansions(NULL);
1457 /*************************************************
1458 * Check a "never users" list *
1459 *************************************************/
1461 /* This function is called to check whether a uid is on one of the two "never
1465 uid the uid to be checked
1466 nusers the list to be scanned; the first item in the list is the count
1468 Returns: TRUE if the uid is on the list
1472 check_never_users(uid_t uid, uid_t *nusers)
1475 if (nusers == NULL) return FALSE;
1476 for (i = 1; i <= (int)(nusers[0]); i++) if (nusers[i] == uid) return TRUE;
1482 /*************************************************
1483 * Find uid and gid for a transport *
1484 *************************************************/
1486 /* This function is called for both local and remote deliveries, to find the
1487 uid/gid under which to run the delivery. The values are taken preferentially
1488 from the transport (either explicit or deliver_as_creator), then from the
1489 address (i.e. the router), and if nothing is set, the exim uid/gid are used. If
1490 the resulting uid is on the "never_users" or the "fixed_never_users" list, a
1491 panic error is logged, and the function fails (which normally leads to delivery
1495 addr the address (possibly a chain)
1497 uidp pointer to uid field
1498 gidp pointer to gid field
1499 igfp pointer to the use_initgroups field
1501 Returns: FALSE if failed - error has been set in address(es)
1505 findugid(address_item *addr, transport_instance *tp, uid_t *uidp, gid_t *gidp,
1508 uschar *nuname = NULL;
1509 BOOL gid_set = FALSE;
1511 /* Default initgroups flag comes from the transport */
1513 *igfp = tp->initgroups;
1515 /* First see if there's a gid on the transport, either fixed or expandable.
1516 The expanding function always logs failure itself. */
1523 else if (tp->expand_gid != NULL)
1525 if (route_find_expanded_group(tp->expand_gid, tp->name, US"transport", gidp,
1526 &(addr->message))) gid_set = TRUE;
1529 common_error(FALSE, addr, ERRNO_GIDFAIL, NULL);
1534 /* If the transport did not set a group, see if the router did. */
1536 if (!gid_set && testflag(addr, af_gid_set))
1542 /* Pick up a uid from the transport if one is set. */
1544 if (tp->uid_set) *uidp = tp->uid;
1546 /* Otherwise, try for an expandable uid field. If it ends up as a numeric id,
1547 it does not provide a passwd value from which a gid can be taken. */
1549 else if (tp->expand_uid != NULL)
1552 if (!route_find_expanded_user(tp->expand_uid, tp->name, US"transport", &pw,
1553 uidp, &(addr->message)))
1555 common_error(FALSE, addr, ERRNO_UIDFAIL, NULL);
1558 if (!gid_set && pw != NULL)
1565 /* If the transport doesn't set the uid, test the deliver_as_creator flag. */
1567 else if (tp->deliver_as_creator)
1569 *uidp = originator_uid;
1572 *gidp = originator_gid;
1577 /* Otherwise see if the address specifies the uid and if so, take it and its
1580 else if (testflag(addr, af_uid_set))
1583 *igfp = testflag(addr, af_initgroups);
1586 /* Nothing has specified the uid - default to the Exim user, and group if the
1599 /* If no gid is set, it is a disaster. We default to the Exim gid only if
1600 defaulting to the Exim uid. In other words, if the configuration has specified
1601 a uid, it must also provide a gid. */
1605 common_error(TRUE, addr, ERRNO_GIDFAIL, US"User set without group for "
1606 "%s transport", tp->name);
1610 /* Check that the uid is not on the lists of banned uids that may not be used
1611 for delivery processes. */
1613 if (check_never_users(*uidp, never_users))
1614 nuname = US"never_users";
1615 else if (check_never_users(*uidp, fixed_never_users))
1616 nuname = US"fixed_never_users";
1620 common_error(TRUE, addr, ERRNO_UIDFAIL, US"User %ld set for %s transport "
1621 "is on the %s list", (long int)(*uidp), tp->name, nuname);
1633 /*************************************************
1634 * Check the size of a message for a transport *
1635 *************************************************/
1637 /* Checks that the message isn't too big for the selected transport.
1638 This is called only when it is known that the limit is set.
1642 addr the (first) address being delivered
1645 DEFER expansion failed or did not yield an integer
1646 FAIL message too big
1650 check_message_size(transport_instance *tp, address_item *addr)
1655 deliver_set_expansions(addr);
1656 size_limit = expand_string_integer(tp->message_size_limit, TRUE);
1657 deliver_set_expansions(NULL);
1659 if (expand_string_message != NULL)
1662 if (size_limit == -1)
1663 addr->message = string_sprintf("failed to expand message_size_limit "
1664 "in %s transport: %s", tp->name, expand_string_message);
1666 addr->message = string_sprintf("invalid message_size_limit "
1667 "in %s transport: %s", tp->name, expand_string_message);
1669 else if (size_limit > 0 && message_size > size_limit)
1673 string_sprintf("message is too big (transport limit = %d)",
1682 /*************************************************
1683 * Transport-time check for a previous delivery *
1684 *************************************************/
1686 /* Check that this base address hasn't previously been delivered to its routed
1687 transport. If it has been delivered, mark it done. The check is necessary at
1688 delivery time in order to handle homonymic addresses correctly in cases where
1689 the pattern of redirection changes between delivery attempts (so the unique
1690 fields change). Non-homonymic previous delivery is detected earlier, at routing
1691 time (which saves unnecessary routing).
1694 addr the address item
1695 testing TRUE if testing wanted only, without side effects
1697 Returns: TRUE if previously delivered by the transport
1701 previously_transported(address_item *addr, BOOL testing)
1703 (void)string_format(big_buffer, big_buffer_size, "%s/%s",
1704 addr->unique + (testflag(addr, af_homonym)? 3:0), addr->transport->name);
1706 if (tree_search(tree_nonrecipients, big_buffer) != 0)
1708 DEBUG(D_deliver|D_route|D_transport)
1709 debug_printf("%s was previously delivered (%s transport): discarded\n",
1710 addr->address, addr->transport->name);
1711 if (!testing) child_done(addr, tod_stamp(tod_log));
1720 /******************************************************
1721 * Check for a given header in a header string *
1722 ******************************************************/
1724 /* This function is used when generating quota warnings. The configuration may
1725 specify any header lines it likes in quota_warn_message. If certain of them are
1726 missing, defaults are inserted, so we need to be able to test for the presence
1730 hdr the required header name
1731 hstring the header string
1733 Returns: TRUE the header is in the string
1734 FALSE the header is not in the string
1738 contains_header(uschar *hdr, uschar *hstring)
1740 int len = Ustrlen(hdr);
1741 uschar *p = hstring;
1744 if (strncmpic(p, hdr, len) == 0)
1747 while (*p == ' ' || *p == '\t') p++;
1748 if (*p == ':') return TRUE;
1750 while (*p != 0 && *p != '\n') p++;
1751 if (*p == '\n') p++;
1759 /*************************************************
1760 * Perform a local delivery *
1761 *************************************************/
1763 /* Each local delivery is performed in a separate process which sets its
1764 uid and gid as specified. This is a safer way than simply changing and
1765 restoring using seteuid(); there is a body of opinion that seteuid() cannot be
1766 used safely. From release 4, Exim no longer makes any use of it. Besides, not
1767 all systems have seteuid().
1769 If the uid/gid are specified in the transport_instance, they are used; the
1770 transport initialization must ensure that either both or neither are set.
1771 Otherwise, the values associated with the address are used. If neither are set,
1772 it is a configuration error.
1774 The transport or the address may specify a home directory (transport over-
1775 rides), and if they do, this is set as $home. If neither have set a working
1776 directory, this value is used for that as well. Otherwise $home is left unset
1777 and the cwd is set to "/" - a directory that should be accessible to all users.
1779 Using a separate process makes it more complicated to get error information
1780 back. We use a pipe to pass the return code and also an error code and error
1781 text string back to the parent process.
1784 addr points to an address block for this delivery; for "normal" local
1785 deliveries this is the only address to be delivered, but for
1786 pseudo-remote deliveries (e.g. by batch SMTP to a file or pipe)
1787 a number of addresses can be handled simultaneously, and in this
1788 case addr will point to a chain of addresses with the same
1791 shadowing TRUE if running a shadow transport; this causes output from pipes
1798 deliver_local(address_item *addr, BOOL shadowing)
1800 BOOL use_initgroups;
1803 int status, len, rc;
1806 uschar *working_directory;
1807 address_item *addr2;
1808 transport_instance *tp = addr->transport;
1810 /* Set up the return path from the errors or sender address. If the transport
1811 has its own return path setting, expand it and replace the existing value. */
1813 if(addr->p.errors_address != NULL)
1814 return_path = addr->p.errors_address;
1815 #ifdef EXPERIMENTAL_SRS
1816 else if(addr->p.srs_sender != NULL)
1817 return_path = addr->p.srs_sender;
1820 return_path = sender_address;
1822 if (tp->return_path != NULL)
1824 uschar *new_return_path = expand_string(tp->return_path);
1825 if (new_return_path == NULL)
1827 if (!expand_string_forcedfail)
1829 common_error(TRUE, addr, ERRNO_EXPANDFAIL,
1830 US"Failed to expand return path \"%s\" in %s transport: %s",
1831 tp->return_path, tp->name, expand_string_message);
1835 else return_path = new_return_path;
1838 /* For local deliveries, one at a time, the value used for logging can just be
1839 set directly, once and for all. */
1841 used_return_path = return_path;
1843 /* Sort out the uid, gid, and initgroups flag. If an error occurs, the message
1844 gets put into the address(es), and the expansions are unset, so we can just
1847 if (!findugid(addr, tp, &uid, &gid, &use_initgroups)) return;
1849 /* See if either the transport or the address specifies a home directory. A
1850 home directory set in the address may already be expanded; a flag is set to
1851 indicate that. In other cases we must expand it. */
1853 if ((deliver_home = tp->home_dir) != NULL || /* Set in transport, or */
1854 ((deliver_home = addr->home_dir) != NULL && /* Set in address and */
1855 !testflag(addr, af_home_expanded))) /* not expanded */
1857 uschar *rawhome = deliver_home;
1858 deliver_home = NULL; /* in case it contains $home */
1859 deliver_home = expand_string(rawhome);
1860 if (deliver_home == NULL)
1862 common_error(TRUE, addr, ERRNO_EXPANDFAIL, US"home directory \"%s\" failed "
1863 "to expand for %s transport: %s", rawhome, tp->name,
1864 expand_string_message);
1867 if (*deliver_home != '/')
1869 common_error(TRUE, addr, ERRNO_NOTABSOLUTE, US"home directory path \"%s\" "
1870 "is not absolute for %s transport", deliver_home, tp->name);
1875 /* See if either the transport or the address specifies a current directory,
1876 and if so, expand it. If nothing is set, use the home directory, unless it is
1877 also unset in which case use "/", which is assumed to be a directory to which
1878 all users have access. It is necessary to be in a visible directory for some
1879 operating systems when running pipes, as some commands (e.g. "rm" under Solaris
1880 2.5) require this. */
1882 working_directory = (tp->current_dir != NULL)?
1883 tp->current_dir : addr->current_dir;
1885 if (working_directory != NULL)
1887 uschar *raw = working_directory;
1888 working_directory = expand_string(raw);
1889 if (working_directory == NULL)
1891 common_error(TRUE, addr, ERRNO_EXPANDFAIL, US"current directory \"%s\" "
1892 "failed to expand for %s transport: %s", raw, tp->name,
1893 expand_string_message);
1896 if (*working_directory != '/')
1898 common_error(TRUE, addr, ERRNO_NOTABSOLUTE, US"current directory path "
1899 "\"%s\" is not absolute for %s transport", working_directory, tp->name);
1903 else working_directory = (deliver_home == NULL)? US"/" : deliver_home;
1905 /* If one of the return_output flags is set on the transport, create and open a
1906 file in the message log directory for the transport to write its output onto.
1907 This is mainly used by pipe transports. The file needs to be unique to the
1908 address. This feature is not available for shadow transports. */
1910 if (!shadowing && (tp->return_output || tp->return_fail_output ||
1911 tp->log_output || tp->log_fail_output))
1914 addr->return_filename =
1915 string_sprintf("%s/msglog/%s/%s-%d-%d", spool_directory, message_subdir,
1916 message_id, getpid(), return_count++);
1917 addr->return_file = open_msglog_file(addr->return_filename, 0400, &error);
1918 if (addr->return_file < 0)
1920 common_error(TRUE, addr, errno, US"Unable to %s file for %s transport "
1921 "to return message: %s", error, tp->name, strerror(errno));
1926 /* Create the pipe for inter-process communication. */
1930 common_error(TRUE, addr, ERRNO_PIPEFAIL, US"Creation of pipe failed: %s",
1935 /* Now fork the process to do the real work in the subprocess, but first
1936 ensure that all cached resources are freed so that the subprocess starts with
1937 a clean slate and doesn't interfere with the parent process. */
1941 if ((pid = fork()) == 0)
1943 BOOL replicate = TRUE;
1945 /* Prevent core dumps, as we don't want them in users' home directories.
1946 HP-UX doesn't have RLIMIT_CORE; I don't know how to do this in that
1947 system. Some experimental/developing systems (e.g. GNU/Hurd) may define
1948 RLIMIT_CORE but not support it in setrlimit(). For such systems, do not
1949 complain if the error is "not supported".
1951 There are two scenarios where changing the max limit has an effect. In one,
1952 the user is using a .forward and invoking a command of their choice via pipe;
1953 for these, we do need the max limit to be 0 unless the admin chooses to
1954 permit an increased limit. In the other, the command is invoked directly by
1955 the transport and is under administrator control, thus being able to raise
1956 the limit aids in debugging. So there's no general always-right answer.
1958 Thus we inhibit core-dumps completely but let individual transports, while
1959 still root, re-raise the limits back up to aid debugging. We make the
1960 default be no core-dumps -- few enough people can use core dumps in
1961 diagnosis that it's reasonable to make them something that has to be explicitly requested.
1968 if (setrlimit(RLIMIT_CORE, &rl) < 0)
1970 # ifdef SETRLIMIT_NOT_SUPPORTED
1971 if (errno != ENOSYS && errno != ENOTSUP)
1973 log_write(0, LOG_MAIN|LOG_PANIC, "setrlimit(RLIMIT_CORE) failed: %s",
1978 /* Reset the random number generator, so different processes don't all
1979 have the same sequence. */
1983 /* If the transport has a setup entry, call this first, while still
1984 privileged. (Appendfile uses this to expand quota, for example, while
1985 able to read private files.) */
1987 if (addr->transport->setup != NULL)
1989 switch((addr->transport->setup)(addr->transport, addr, NULL, uid, gid,
1993 addr->transport_return = DEFER;
1997 addr->transport_return = PANIC;
2002 /* Ignore SIGINT and SIGTERM during delivery. Also ignore SIGUSR1, as
2003 when the process becomes unprivileged, it won't be able to write to the
2004 process log. SIGHUP is ignored throughout exim, except when it is being
2007 signal(SIGINT, SIG_IGN);
2008 signal(SIGTERM, SIG_IGN);
2009 signal(SIGUSR1, SIG_IGN);
2011 /* Close the unwanted half of the pipe, and set close-on-exec for the other
2012 half - for transports that exec things (e.g. pipe). Then set the required
2015 (void)close(pfd[pipe_read]);
2016 (void)fcntl(pfd[pipe_write], F_SETFD, fcntl(pfd[pipe_write], F_GETFD) |
2018 exim_setugid(uid, gid, use_initgroups,
2019 string_sprintf("local delivery to %s <%s> transport=%s", addr->local_part,
2020 addr->address, addr->transport->name));
2024 address_item *batched;
2025 debug_printf(" home=%s current=%s\n", deliver_home, working_directory);
2026 for (batched = addr->next; batched != NULL; batched = batched->next)
2027 debug_printf("additional batched address: %s\n", batched->address);
2030 /* Set an appropriate working directory. */
2032 if (Uchdir(working_directory) < 0)
2034 addr->transport_return = DEFER;
2035 addr->basic_errno = errno;
2036 addr->message = string_sprintf("failed to chdir to %s", working_directory);
2039 /* If successful, call the transport */
2044 set_process_info("delivering %s to %s using %s", message_id,
2045 addr->local_part, addr->transport->name);
2047 /* Setting this global in the subprocess means we need never clear it */
2048 transport_name = addr->transport->name;
2050 /* If a transport filter has been specified, set up its argument list.
2051 Any errors will get put into the address, and FALSE yielded. */
2053 if (addr->transport->filter_command != NULL)
2055 ok = transport_set_up_command(&transport_filter_argv,
2056 addr->transport->filter_command,
2057 TRUE, PANIC, addr, US"transport filter", NULL);
2058 transport_filter_timeout = addr->transport->filter_timeout;
2060 else transport_filter_argv = NULL;
2064 debug_print_string(addr->transport->debug_string);
2065 replicate = !(addr->transport->info->code)(addr->transport, addr);
2069 /* Pass the results back down the pipe. If necessary, first replicate the
2070 status in the top address to the others in the batch. The label is the
2071 subject of a goto when a call to the transport's setup function fails. We
2072 pass the pointer to the transport back in case it got changed as a result of
2073 file_format in appendfile. */
2077 if (replicate) replicate_status(addr);
2078 for (addr2 = addr; addr2 != NULL; addr2 = addr2->next)
2081 int local_part_length = Ustrlen(addr2->local_part);
2085 if( (ret = write(pfd[pipe_write], (void *)&(addr2->transport_return), sizeof(int))) != sizeof(int)
2086 || (ret = write(pfd[pipe_write], (void *)&transport_count, sizeof(transport_count))) != sizeof(transport_count)
2087 || (ret = write(pfd[pipe_write], (void *)&(addr2->flags), sizeof(addr2->flags))) != sizeof(addr2->flags)
2088 || (ret = write(pfd[pipe_write], (void *)&(addr2->basic_errno), sizeof(int))) != sizeof(int)
2089 || (ret = write(pfd[pipe_write], (void *)&(addr2->more_errno), sizeof(int))) != sizeof(int)
2090 || (ret = write(pfd[pipe_write], (void *)&(addr2->special_action), sizeof(int))) != sizeof(int)
2091 || (ret = write(pfd[pipe_write], (void *)&(addr2->transport),
2092 sizeof(transport_instance *))) != sizeof(transport_instance *)
2094 /* For a file delivery, pass back the local part, in case the original
2095 was only part of the final delivery path. This gives more complete
2098 || (testflag(addr2, af_file)
2099 && ( (ret = write(pfd[pipe_write], (void *)&local_part_length, sizeof(int))) != sizeof(int)
2100 || (ret = write(pfd[pipe_write], addr2->local_part, local_part_length)) != local_part_length
2104 log_write(0, LOG_MAIN|LOG_PANIC, "Failed writing transport results to pipe: %s\n",
2105 ret == -1 ? strerror(errno) : "short write");
2107 /* Now any messages */
2109 for (i = 0, s = addr2->message; i < 2; i++, s = addr2->user_message)
2111 int message_length = (s == NULL)? 0 : Ustrlen(s) + 1;
2112 if( (ret = write(pfd[pipe_write], (void *)&message_length, sizeof(int))) != sizeof(int)
2113 || (message_length > 0 && (ret = write(pfd[pipe_write], s, message_length)) != message_length)
2115 log_write(0, LOG_MAIN|LOG_PANIC, "Failed writing transport results to pipe: %s\n",
2116 ret == -1 ? strerror(errno) : "short write");
2120 /* OK, this process is now done. Free any cached resources that it opened,
2121 and close the pipe we were writing down before exiting. */
2123 (void)close(pfd[pipe_write]);
2128 /* Back in the main process: panic if the fork did not succeed. This seems
2129 better than returning an error - if forking is failing it is probably best
2130 not to try other deliveries for this message. */
2133 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Fork failed for local delivery to %s",
2136 /* Read the pipe to get the delivery status codes and error messages. Our copy
2137 of the writing end must be closed first, as otherwise read() won't return zero
2138 on an empty pipe. We check that a status exists for each address before
2139 overwriting the address structure. If data is missing, the default DEFER status
2140 will remain. Afterwards, close the reading end. */
2142 (void)close(pfd[pipe_write]);
2144 for (addr2 = addr; addr2 != NULL; addr2 = addr2->next)
2146 len = read(pfd[pipe_read], (void *)&status, sizeof(int));
2152 addr2->transport_return = status;
2153 len = read(pfd[pipe_read], (void *)&transport_count,
2154 sizeof(transport_count));
2155 len = read(pfd[pipe_read], (void *)&(addr2->flags), sizeof(addr2->flags));
2156 len = read(pfd[pipe_read], (void *)&(addr2->basic_errno), sizeof(int));
2157 len = read(pfd[pipe_read], (void *)&(addr2->more_errno), sizeof(int));
2158 len = read(pfd[pipe_read], (void *)&(addr2->special_action), sizeof(int));
2159 len = read(pfd[pipe_read], (void *)&(addr2->transport),
2160 sizeof(transport_instance *));
2162 if (testflag(addr2, af_file))
2164 int local_part_length;
2165 len = read(pfd[pipe_read], (void *)&local_part_length, sizeof(int));
2166 len = read(pfd[pipe_read], (void *)big_buffer, local_part_length);
2167 big_buffer[local_part_length] = 0;
2168 addr2->local_part = string_copy(big_buffer);
2171 for (i = 0, sptr = &(addr2->message); i < 2;
2172 i++, sptr = &(addr2->user_message))
2175 len = read(pfd[pipe_read], (void *)&message_length, sizeof(int));
2176 if (message_length > 0)
2178 len = read(pfd[pipe_read], (void *)big_buffer, message_length);
2179 if (len > 0) *sptr = string_copy(big_buffer);
2186 log_write(0, LOG_MAIN|LOG_PANIC, "failed to read delivery status for %s "
2187 "from delivery subprocess", addr2->unique);
2192 (void)close(pfd[pipe_read]);
2194 /* Unless shadowing, write all successful addresses immediately to the journal
2195 file, to ensure they are recorded asap. For homonymic addresses, use the base
2196 address plus the transport name. Failure to write the journal is panic-worthy,
2197 but don't stop, as it may prove possible subsequently to update the spool file
2198 in order to record the delivery. */
2202 for (addr2 = addr; addr2 != NULL; addr2 = addr2->next)
2204 if (addr2->transport_return != OK) continue;
2206 if (testflag(addr2, af_homonym))
2207 sprintf(CS big_buffer, "%.500s/%s\n", addr2->unique + 3, tp->name);
2209 sprintf(CS big_buffer, "%.500s\n", addr2->unique);
2211 /* In the test harness, wait just a bit to let the subprocess finish off
2212 any debug output etc first. */
2214 if (running_in_test_harness) millisleep(300);
2216 DEBUG(D_deliver) debug_printf("journalling %s", big_buffer);
2217 len = Ustrlen(big_buffer);
2218 if (write(journal_fd, big_buffer, len) != len)
2219 log_write(0, LOG_MAIN|LOG_PANIC, "failed to update journal for %s: %s",
2220 big_buffer, strerror(errno));
2223 /* Ensure the journal file is pushed out to disk. */
2225 if (EXIMfsync(journal_fd) < 0)
2226 log_write(0, LOG_MAIN|LOG_PANIC, "failed to fsync journal: %s",
2230 /* Wait for the process to finish. If it terminates with a non-zero code,
2231 freeze the message (except for SIGTERM, SIGKILL and SIGQUIT), but leave the
2232 status values of all the addresses as they are. Take care to handle the case
2233 when the subprocess doesn't seem to exist. This has been seen on one system
2234 when Exim was called from an MUA that set SIGCHLD to SIG_IGN. When that
2235 happens, wait() doesn't recognize the termination of child processes. Exim now
2236 resets SIGCHLD to SIG_DFL, but this code should still be robust. */
2238 while ((rc = wait(&status)) != pid)
2240 if (rc < 0 && errno == ECHILD) /* Process has vanished */
2242 log_write(0, LOG_MAIN, "%s transport process vanished unexpectedly",
2243 addr->transport->driver_name);
2249 if ((status & 0xffff) != 0)
2251 int msb = (status >> 8) & 255;
2252 int lsb = status & 255;
2253 int code = (msb == 0)? (lsb & 0x7f) : msb;
2254 if (msb != 0 || (code != SIGTERM && code != SIGKILL && code != SIGQUIT))
2255 addr->special_action = SPECIAL_FREEZE;
2256 log_write(0, LOG_MAIN|LOG_PANIC, "%s transport process returned non-zero "
2257 "status 0x%04x: %s %d",
2258 addr->transport->driver_name,
2260 (msb == 0)? "terminated by signal" : "exit code",
2264 /* If SPECIAL_WARN is set in the top address, send a warning message. */
2266 if (addr->special_action == SPECIAL_WARN &&
2267 addr->transport->warn_message != NULL)
2270 uschar *warn_message;
2272 DEBUG(D_deliver) debug_printf("Warning message requested by transport\n");
2274 warn_message = expand_string(addr->transport->warn_message);
2275 if (warn_message == NULL)
2276 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand \"%s\" (warning "
2277 "message for %s transport): %s", addr->transport->warn_message,
2278 addr->transport->name, expand_string_message);
2281 pid_t pid = child_open_exim(&fd);
2284 FILE *f = fdopen(fd, "wb");
2285 if (errors_reply_to != NULL &&
2286 !contains_header(US"Reply-To", warn_message))
2287 fprintf(f, "Reply-To: %s\n", errors_reply_to);
2288 fprintf(f, "Auto-Submitted: auto-replied\n");
2289 if (!contains_header(US"From", warn_message)) moan_write_from(f);
2290 fprintf(f, "%s", CS warn_message);
2292 /* Close and wait for child process to complete, without a timeout. */
2295 (void)child_close(pid, 0);
2299 addr->special_action = SPECIAL_NONE;
2305 /*************************************************
2306 * Do local deliveries *
2307 *************************************************/
2309 /* This function processes the list of addresses in addr_local. True local
2310 deliveries are always done one address at a time. However, local deliveries can
2311 be batched up in some cases. Typically this is when writing batched SMTP output
2312 files for use by some external transport mechanism, or when running local
2313 deliveries over LMTP.
2320 do_local_deliveries(void)
2323 open_db *dbm_file = NULL;
2324 time_t now = time(NULL);
2326 /* Loop until we have exhausted the supply of local deliveries */
2328 while (addr_local != NULL)
2330 time_t delivery_start;
2332 address_item *addr2, *addr3, *nextaddr;
2333 int logflags = LOG_MAIN;
2334 int logchar = dont_deliver? '*' : '=';
2335 transport_instance *tp;
2337 /* Pick the first undelivered address off the chain */
2339 address_item *addr = addr_local;
2340 addr_local = addr->next;
2343 DEBUG(D_deliver|D_transport)
2344 debug_printf("--------> %s <--------\n", addr->address);
2346 /* An internal disaster if there is no transport. Should not occur! */
2348 if ((tp = addr->transport) == NULL)
2350 logflags |= LOG_PANIC;
2351 disable_logging = FALSE; /* Jic */
2353 (addr->router != NULL)?
2354 string_sprintf("No transport set by %s router", addr->router->name)
2356 string_sprintf("No transport set by system filter");
2357 post_process_one(addr, DEFER, logflags, DTYPE_TRANSPORT, 0);
2361 /* Check that this base address hasn't previously been delivered to this
2362 transport. The check is necessary at this point to handle homonymic addresses
2363 correctly in cases where the pattern of redirection changes between delivery
2364 attempts. Non-homonymic previous delivery is detected earlier, at routing
2367 if (previously_transported(addr, FALSE)) continue;
2369 /* There are weird cases where logging is disabled */
2371 disable_logging = tp->disable_logging;
2373 /* Check for batched addresses and possible amalgamation. Skip all the work
2374 if either batch_max <= 1 or there aren't any other addresses for local
2377 if (tp->batch_max > 1 && addr_local != NULL)
2379 int batch_count = 1;
2380 BOOL uses_dom = readconf_depends((driver_instance *)tp, US"domain");
2381 BOOL uses_lp = (testflag(addr, af_pfr) &&
2382 (testflag(addr, af_file) || addr->local_part[0] == '|')) ||
2383 readconf_depends((driver_instance *)tp, US"local_part");
2384 uschar *batch_id = NULL;
2385 address_item **anchor = &addr_local;
2386 address_item *last = addr;
2389 /* Expand the batch_id string for comparison with other addresses.
2390 Expansion failure suppresses batching. */
2392 if (tp->batch_id != NULL)
2394 deliver_set_expansions(addr);
2395 batch_id = expand_string(tp->batch_id);
2396 deliver_set_expansions(NULL);
2397 if (batch_id == NULL)
2399 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand batch_id option "
2400 "in %s transport (%s): %s", tp->name, addr->address,
2401 expand_string_message);
2402 batch_count = tp->batch_max;
2406 /* Until we reach the batch_max limit, pick off addresses which have the
2407 same characteristics. These are:
2410 not previously delivered (see comment about 50 lines above)
2411 same local part if the transport's configuration contains $local_part
2412 or if this is a file or pipe delivery from a redirection
2413 same domain if the transport's configuration contains $domain
2415 same additional headers
2416 same headers to be removed
2417 same uid/gid for running the transport
2418 same first host if a host list is set
2421 while ((next = *anchor) != NULL && batch_count < tp->batch_max)
2424 tp == next->transport &&
2425 !previously_transported(next, TRUE) &&
2426 (addr->flags & (af_pfr|af_file)) == (next->flags & (af_pfr|af_file)) &&
2427 (!uses_lp || Ustrcmp(next->local_part, addr->local_part) == 0) &&
2428 (!uses_dom || Ustrcmp(next->domain, addr->domain) == 0) &&
2429 same_strings(next->p.errors_address, addr->p.errors_address) &&
2430 same_headers(next->p.extra_headers, addr->p.extra_headers) &&
2431 same_strings(next->p.remove_headers, addr->p.remove_headers) &&
2432 same_ugid(tp, addr, next) &&
2433 ((addr->host_list == NULL && next->host_list == NULL) ||
2434 (addr->host_list != NULL && next->host_list != NULL &&
2435 Ustrcmp(addr->host_list->name, next->host_list->name) == 0));
2437 /* If the transport has a batch_id setting, batch_id will be non-NULL
2438 from the expansion outside the loop. Expand for this address and compare.
2439 Expansion failure makes this address ineligible for batching. */
2441 if (ok && batch_id != NULL)
2444 address_item *save_nextnext = next->next;
2445 next->next = NULL; /* Expansion for a single address */
2446 deliver_set_expansions(next);
2447 next->next = save_nextnext;
2448 bid = expand_string(tp->batch_id);
2449 deliver_set_expansions(NULL);
2452 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand batch_id option "
2453 "in %s transport (%s): %s", tp->name, next->address,
2454 expand_string_message);
2457 else ok = (Ustrcmp(batch_id, bid) == 0);
2460 /* Take address into batch if OK. */
2464 *anchor = next->next; /* Include the address */
2470 else anchor = &(next->next); /* Skip the address */
2474 /* We now have one or more addresses that can be delivered in a batch. Check
2475 whether the transport is prepared to accept a message of this size. If not,
2476 fail them all forthwith. If the expansion fails, or does not yield an
2477 integer, defer delivery. */
2479 if (tp->message_size_limit != NULL)
2481 int rc = check_message_size(tp, addr);
2484 replicate_status(addr);
2485 while (addr != NULL)
2488 post_process_one(addr, rc, logflags, DTYPE_TRANSPORT, 0);
2491 continue; /* With next batch of addresses */
2495 /* If we are not running the queue, or if forcing, all deliveries will be
2496 attempted. Otherwise, we must respect the retry times for each address. Even
2497 when not doing this, we need to set up the retry key string, and determine
2498 whether a retry record exists, because after a successful delivery, a delete
2499 retry item must be set up. Keep the retry database open only for the duration
2500 of these checks, rather than for all local deliveries, because some local
2501 deliveries (e.g. to pipes) can take a substantial time. */
2503 dbm_file = dbfn_open(US"retry", O_RDONLY, &dbblock, FALSE);
2504 if (dbm_file == NULL)
2506 DEBUG(D_deliver|D_retry|D_hints_lookup)
2507 debug_printf("no retry data available\n");
2512 while (addr2 != NULL)
2514 BOOL ok = TRUE; /* to deliver this address */
2517 /* Set up the retry key to include the domain or not, and change its
2518 leading character from "R" to "T". Must make a copy before doing this,
2519 because the old key may be pointed to from a "delete" retry item after
2522 retry_key = string_copy(
2523 (tp->retry_use_local_part)? addr2->address_retry_key :
2524 addr2->domain_retry_key);
2527 /* Inspect the retry data. If there is no hints file, delivery happens. */
2529 if (dbm_file != NULL)
2531 dbdata_retry *retry_record = dbfn_read(dbm_file, retry_key);
2533 /* If there is no retry record, delivery happens. If there is,
2534 remember it exists so it can be deleted after a successful delivery. */
2536 if (retry_record != NULL)
2538 setflag(addr2, af_lt_retry_exists);
2540 /* A retry record exists for this address. If queue running and not
2541 forcing, inspect its contents. If the record is too old, or if its
2542 retry time has come, or if it has passed its cutoff time, delivery
2547 debug_printf("retry record exists: age=%s ",
2548 readconf_printtime(now - retry_record->time_stamp));
2549 debug_printf("(max %s)\n", readconf_printtime(retry_data_expire));
2550 debug_printf(" time to retry = %s expired = %d\n",
2551 readconf_printtime(retry_record->next_try - now),
2552 retry_record->expired);
2555 if (queue_running && !deliver_force)
2557 ok = (now - retry_record->time_stamp > retry_data_expire) ||
2558 (now >= retry_record->next_try) ||
2559 retry_record->expired;
2561 /* If we haven't reached the retry time, there is one more check
2562 to do, which is for the ultimate address timeout. */
2565 ok = retry_ultimate_address_timeout(retry_key, addr2->domain,
2569 else DEBUG(D_retry) debug_printf("no retry record exists\n");
2572 /* This address is to be delivered. Leave it on the chain. */
2577 addr2 = addr2->next;
2580 /* This address is to be deferred. Take it out of the chain, and
2581 post-process it as complete. Must take it out of the chain first,
2582 because post processing puts it on another chain. */
2586 address_item *this = addr2;
2587 this->message = US"Retry time not yet reached";
2588 this->basic_errno = ERRNO_LRETRY;
2589 if (addr3 == NULL) addr2 = addr = addr2->next;
2590 else addr2 = addr3->next = addr2->next;
2591 post_process_one(this, DEFER, logflags, DTYPE_TRANSPORT, 0);
2595 if (dbm_file != NULL) dbfn_close(dbm_file);
2597 /* If there are no addresses left on the chain, they all deferred. Loop
2598 for the next set of addresses. */
2600 if (addr == NULL) continue;
2602 /* So, finally, we do have some addresses that can be passed to the
2603 transport. Before doing so, set up variables that are relevant to a
2606 deliver_set_expansions(addr);
2607 delivery_start = time(NULL);
2608 deliver_local(addr, FALSE);
2609 deliver_time = (int)(time(NULL) - delivery_start);
2611 /* If a shadow transport (which must perforce be another local transport), is
2612 defined, and its condition is met, we must pass the message to the shadow
2613 too, but only those addresses that succeeded. We do this by making a new
2614 chain of addresses - also to keep the original chain uncontaminated. We must
2615 use a chain rather than doing it one by one, because the shadow transport may
2618 NOTE: if the condition fails because of a lookup defer, there is nothing we
2621 if (tp->shadow != NULL &&
2622 (tp->shadow_condition == NULL ||
2623 expand_check_condition(tp->shadow_condition, tp->name, US"transport")))
2625 transport_instance *stp;
2626 address_item *shadow_addr = NULL;
2627 address_item **last = &shadow_addr;
2629 for (stp = transports; stp != NULL; stp = stp->next)
2630 if (Ustrcmp(stp->name, tp->shadow) == 0) break;
2633 log_write(0, LOG_MAIN|LOG_PANIC, "shadow transport \"%s\" not found ",
2636 /* Pick off the addresses that have succeeded, and make clones. Put into
2637 the shadow_message field a pointer to the shadow_message field of the real
2640 else for (addr2 = addr; addr2 != NULL; addr2 = addr2->next)
2642 if (addr2->transport_return != OK) continue;
2643 addr3 = store_get(sizeof(address_item));
2646 addr3->shadow_message = (uschar *)(&(addr2->shadow_message));
2647 addr3->transport = stp;
2648 addr3->transport_return = DEFER;
2649 addr3->return_filename = NULL;
2650 addr3->return_file = -1;
2652 last = &(addr3->next);
2655 /* If we found any addresses to shadow, run the delivery, and stick any
2656 message back into the shadow_message field in the original. */
2658 if (shadow_addr != NULL)
2660 int save_count = transport_count;
2662 DEBUG(D_deliver|D_transport)
2663 debug_printf(">>>>>>>>>>>>>>>> Shadow delivery >>>>>>>>>>>>>>>>\n");
2664 deliver_local(shadow_addr, TRUE);
2666 for(; shadow_addr != NULL; shadow_addr = shadow_addr->next)
2668 int sresult = shadow_addr->transport_return;
2669 *((uschar **)(shadow_addr->shadow_message)) = (sresult == OK)?
2670 string_sprintf(" ST=%s", stp->name) :
2671 string_sprintf(" ST=%s (%s%s%s)", stp->name,
2672 (shadow_addr->basic_errno <= 0)?
2673 US"" : US strerror(shadow_addr->basic_errno),
2674 (shadow_addr->basic_errno <= 0 || shadow_addr->message == NULL)?
2676 (shadow_addr->message != NULL)? shadow_addr->message :
2677 (shadow_addr->basic_errno <= 0)? US"unknown error" : US"");
2679 DEBUG(D_deliver|D_transport)
2680 debug_printf("%s shadow transport returned %s for %s\n",
2682 (sresult == OK)? "OK" :
2683 (sresult == DEFER)? "DEFER" :
2684 (sresult == FAIL)? "FAIL" :
2685 (sresult == PANIC)? "PANIC" : "?",
2686 shadow_addr->address);
2689 DEBUG(D_deliver|D_transport)
2690 debug_printf(">>>>>>>>>>>>>>>> End shadow delivery >>>>>>>>>>>>>>>>\n");
2692 transport_count = save_count; /* Restore original transport count */
2696 /* Cancel the expansions that were set up for the delivery. */
2698 deliver_set_expansions(NULL);
2700 /* Now we can process the results of the real transport. We must take each
2701 address off the chain first, because post_process_one() puts it on another
2704 for (addr2 = addr; addr2 != NULL; addr2 = nextaddr)
2706 int result = addr2->transport_return;
2707 nextaddr = addr2->next;
2709 DEBUG(D_deliver|D_transport)
2710 debug_printf("%s transport returned %s for %s\n",
2712 (result == OK)? "OK" :
2713 (result == DEFER)? "DEFER" :
2714 (result == FAIL)? "FAIL" :
2715 (result == PANIC)? "PANIC" : "?",
2718 /* If there is a retry_record, or if delivery is deferred, build a retry
2719 item for setting a new retry time or deleting the old retry record from
2720 the database. These items are handled all together after all addresses
2721 have been handled (so the database is open just for a short time for
2724 if (result == DEFER || testflag(addr2, af_lt_retry_exists))
2726 int flags = (result == DEFER)? 0 : rf_delete;
2727 uschar *retry_key = string_copy((tp->retry_use_local_part)?
2728 addr2->address_retry_key : addr2->domain_retry_key);
2730 retry_add_item(addr2, retry_key, flags);
2733 /* Done with this address */
2735 if (result == OK) addr2->more_errno = deliver_time;
2736 post_process_one(addr2, result, logflags, DTYPE_TRANSPORT, logchar);
2738 /* If a pipe delivery generated text to be sent back, the result may be
2739 changed to FAIL, and we must copy this for subsequent addresses in the
2742 if (addr2->transport_return != result)
2744 for (addr3 = nextaddr; addr3 != NULL; addr3 = addr3->next)
2746 addr3->transport_return = addr2->transport_return;
2747 addr3->basic_errno = addr2->basic_errno;
2748 addr3->message = addr2->message;
2750 result = addr2->transport_return;
2753 /* Whether or not the result was changed to FAIL, we need to copy the
2754 return_file value from the first address into all the addresses of the
2755 batch, so they are all listed in the error message. */
2757 addr2->return_file = addr->return_file;
2759 /* Change log character for recording successful deliveries. */
2761 if (result == OK) logchar = '-';
2763 } /* Loop back for next batch of addresses */
2769 /*************************************************
2770 * Sort remote deliveries *
2771 *************************************************/
2773 /* This function is called if remote_sort_domains is set. It arranges that the
2774 chain of addresses for remote deliveries is ordered according to the strings
2775 specified. Try to make this shuffling reasonably efficient by handling
2776 sequences of addresses rather than just single ones.
2783 sort_remote_deliveries(void)
2786 address_item **aptr = &addr_remote;
2787 const uschar *listptr = remote_sort_domains;
2791 while (*aptr != NULL &&
2792 (pattern = string_nextinlist(&listptr, &sep, patbuf, sizeof(patbuf)))
2795 address_item *moved = NULL;
2796 address_item **bptr = &moved;
2798 while (*aptr != NULL)
2800 address_item **next;
2801 deliver_domain = (*aptr)->domain; /* set $domain */
2802 if (match_isinlist(deliver_domain, (const uschar **)&pattern, UCHAR_MAX+1,
2803 &domainlist_anchor, NULL, MCL_DOMAIN, TRUE, NULL) == OK)
2805 aptr = &((*aptr)->next);
2809 next = &((*aptr)->next);
2810 while (*next != NULL &&
2811 (deliver_domain = (*next)->domain, /* Set $domain */
2812 match_isinlist(deliver_domain, (const uschar **)&pattern, UCHAR_MAX+1,
2813 &domainlist_anchor, NULL, MCL_DOMAIN, TRUE, NULL)) != OK)
2814 next = &((*next)->next);
2816 /* If the batch of non-matchers is at the end, add on any that were
2817 extracted further up the chain, and end this iteration. Otherwise,
2818 extract them from the chain and hang on the moved chain. */
2830 aptr = &((*aptr)->next);
2833 /* If the loop ended because the final address matched, *aptr will
2834 be NULL. Add on to the end any extracted non-matching addresses. If
2835 *aptr is not NULL, the loop ended via "break" when *next is null, that
2836 is, there was a string of non-matching addresses at the end. In this
2837 case the extracted addresses have already been added on the end. */
2839 if (*aptr == NULL) *aptr = moved;
2845 debug_printf("remote addresses after sorting:\n");
2846 for (addr = addr_remote; addr != NULL; addr = addr->next)
2847 debug_printf(" %s\n", addr->address);
2853 /*************************************************
2854 * Read from pipe for remote delivery subprocess *
2855 *************************************************/
2857 /* This function is called when the subprocess is complete, but can also be
2858 called before it is complete, in order to empty a pipe that is full (to prevent
2859 deadlock). It must therefore keep track of its progress in the parlist data
2862 We read the pipe to get the delivery status codes and a possible error message
2863 for each address, optionally preceded by unusability data for the hosts and
2864 also by optional retry data.
2866 Read in large chunks into the big buffer and then scan through, interpreting
2867 the data therein. In most cases, only a single read will be necessary. No
2868 individual item will ever be anywhere near 2500 bytes in length, so by ensuring
2869 that we read the next chunk when there is less than 2500 bytes left in the
2870 non-final chunk, we can assume each item is complete in the buffer before
2871 handling it. Each item is written using a single write(), which is atomic for
2872 small items (less than PIPE_BUF, which seems to be at least 512 in any Unix and
2873 often bigger) so even if we are reading while the subprocess is still going, we
2874 should never have only a partial item in the buffer.
2877 poffset the offset of the parlist item
2878 eop TRUE if the process has completed
2880 Returns: TRUE if the terminating 'Z' item has been read,
2881 or there has been a disaster (i.e. no more data needed);
2886 par_read_pipe(int poffset, BOOL eop)
2889 pardata *p = parlist + poffset;
2890 address_item *addrlist = p->addrlist;
2891 address_item *addr = p->addr;
2894 uschar *endptr = big_buffer;
2895 uschar *ptr = endptr;
2896 uschar *msg = p->msg;
2897 BOOL done = p->done;
2898 BOOL unfinished = TRUE;
2899 /* minimum size to read is header size including id, subid and length */
2900 int required = PIPE_HEADER_SIZE;
2902 /* Loop through all items, reading from the pipe when necessary. The pipe
2903 is set up to be non-blocking, but there are two different Unix mechanisms in
2904 use. Exim uses O_NONBLOCK if it is defined. This returns 0 for end of file,
2905 and EAGAIN for no more data. If O_NONBLOCK is not defined, Exim uses O_NDELAY,
2906 which returns 0 for both end of file and no more data. We distinguish the
2907 two cases by taking 0 as end of file only when we know the process has
2910 Each separate item is written to the pipe in a single write(), and as they are
2911 all short items, the writes will all be atomic and we should never find
2912 ourselves in the position of having read an incomplete item. "Short" in this
2913 case can mean up to about 1K in the case when there is a long error message
2914 associated with an address. */
2916 DEBUG(D_deliver) debug_printf("reading pipe for subprocess %d (%s)\n",
2917 (int)p->pid, eop? "ended" : "not ended");
2921 retry_item *r, **rp;
2922 int remaining = endptr - ptr;
2923 uschar header[PIPE_HEADER_SIZE + 1];
2927 /* Read (first time) or top up the chars in the buffer if necessary.
2928 There will be only one read if we get all the available data (i.e. don't
2929 fill the buffer completely). */
2931 if (remaining < required && unfinished)
2934 int available = big_buffer_size - remaining;
2936 if (remaining > 0) memmove(big_buffer, ptr, remaining);
2939 endptr = big_buffer + remaining;
2940 len = read(fd, endptr, available);
2942 DEBUG(D_deliver) debug_printf("read() yielded %d\n", len);
2944 /* If the result is EAGAIN and the process is not complete, just
2945 stop reading any more and process what we have already. */
2949 if (!eop && errno == EAGAIN) len = 0; else
2951 msg = string_sprintf("failed to read pipe from transport process "
2952 "%d for transport %s: %s", pid, addr->transport->driver_name,
2958 /* If the length is zero (eof or no-more-data), just process what we
2959 already have. Note that if the process is still running and we have
2960 read all the data in the pipe (but less that "available") then we
2961 won't read any more, as "unfinished" will get set FALSE. */
2965 unfinished = len == available;
2968 /* If we are at the end of the available data, exit the loop. */
2969 if (ptr >= endptr) break;
2971 /* copy and read header */
2972 memcpy(header, ptr, PIPE_HEADER_SIZE);
2973 header[PIPE_HEADER_SIZE] = '\0';
2976 required = Ustrtol(header + 2, &endc, 10) + PIPE_HEADER_SIZE; /* header + data */
2979 msg = string_sprintf("failed to read pipe from transport process "
2980 "%d for transport %s: error reading size from header", pid, addr->transport->driver_name);
2986 debug_printf("header read id:%c,subid:%c,size:%s,required:%d,remaining:%d,unfinished:%d\n",
2987 id, subid, header+2, required, remaining, unfinished);
2989 /* is there room for the dataset we want to read ? */
2990 if (required > big_buffer_size - PIPE_HEADER_SIZE)
2992 msg = string_sprintf("failed to read pipe from transport process "
2993 "%d for transport %s: big_buffer too small! required size=%d buffer size=%d", pid, addr->transport->driver_name,
2994 required, big_buffer_size - PIPE_HEADER_SIZE);
2999 /* we wrote all datasets with atomic write() calls
3000 remaining < required only happens if big_buffer was too small
3001 to get all available data from pipe. unfinished has to be true
3003 if (remaining < required)
3007 msg = string_sprintf("failed to read pipe from transport process "
3008 "%d for transport %s: required size=%d > remaining size=%d and unfinished=false",
3009 pid, addr->transport->driver_name, required, remaining);
3014 /* step behind the header */
3015 ptr += PIPE_HEADER_SIZE;
3017 /* Handle each possible type of item, assuming the complete item is
3018 available in store. */
3022 /* Host items exist only if any hosts were marked unusable. Match
3023 up by checking the IP address. */
3026 for (h = addrlist->host_list; h != NULL; h = h->next)
3028 if (h->address == NULL || Ustrcmp(h->address, ptr+2) != 0) continue;
3036 /* Retry items are sent in a preceding R item for each address. This is
3037 kept separate to keep each message short enough to guarantee it won't
3038 be split in the pipe. Hopefully, in the majority of cases, there won't in
3039 fact be any retry items at all.
3041 The complete set of retry items might include an item to delete a
3042 routing retry if there was a previous routing delay. However, routing
3043 retries are also used when a remote transport identifies an address error.
3044 In that case, there may also be an "add" item for the same key. Arrange
3045 that a "delete" item is dropped in favour of an "add" item. */
3048 if (addr == NULL) goto ADDR_MISMATCH;
3050 DEBUG(D_deliver|D_retry)
3051 debug_printf("reading retry information for %s from subprocess\n",
3054 /* Cut out any "delete" items on the list. */
3056 for (rp = &(addr->retries); (r = *rp) != NULL; rp = &(r->next))
3058 if (Ustrcmp(r->key, ptr+1) == 0) /* Found item with same key */
3060 if ((r->flags & rf_delete) == 0) break; /* It was not "delete" */
3061 *rp = r->next; /* Excise a delete item */
3062 DEBUG(D_deliver|D_retry)
3063 debug_printf(" existing delete item dropped\n");
3067 /* We want to add a delete item only if there is no non-delete item;
3068 however we still have to step ptr through the data. */
3070 if (r == NULL || (*ptr & rf_delete) == 0)
3072 r = store_get(sizeof(retry_item));
3073 r->next = addr->retries;
3076 r->key = string_copy(ptr);
3078 memcpy(&(r->basic_errno), ptr, sizeof(r->basic_errno));
3079 ptr += sizeof(r->basic_errno);
3080 memcpy(&(r->more_errno), ptr, sizeof(r->more_errno));
3081 ptr += sizeof(r->more_errno);
3082 r->message = (*ptr)? string_copy(ptr) : NULL;
3083 DEBUG(D_deliver|D_retry)
3084 debug_printf(" added %s item\n",
3085 ((r->flags & rf_delete) == 0)? "retry" : "delete");
3090 DEBUG(D_deliver|D_retry)
3091 debug_printf(" delete item not added: non-delete item exists\n");
3094 ptr += sizeof(r->basic_errno) + sizeof(r->more_errno);
3100 /* Put the amount of data written into the parlist block */
3103 memcpy(&(p->transport_count), ptr, sizeof(transport_count));
3104 ptr += sizeof(transport_count);
3107 /* Address items are in the order of items on the address chain. We
3108 remember the current address value in case this function is called
3109 several times to empty the pipe in stages. Information about delivery
3110 over TLS is sent in a preceding X item for each address. We don't put
3111 it in with the other info, in order to keep each message short enough to
3112 guarantee it won't be split in the pipe. */
3116 if (addr == NULL) goto ADDR_MISMATCH; /* Below, in 'A' handler */
3120 addr->cipher = NULL;
3121 addr->peerdn = NULL;
3124 addr->cipher = string_copy(ptr);
3127 addr->peerdn = string_copy(ptr);
3131 addr->peercert = NULL;
3133 (void) tls_import_cert(ptr, &addr->peercert);
3137 addr->ourcert = NULL;
3139 (void) tls_import_cert(ptr, &addr->ourcert);
3142 # ifndef DISABLE_OCSP
3144 addr->ocsp = OCSP_NOT_REQ;
3146 addr->ocsp = *ptr - '0';
3152 #endif /*SUPPORT_TLS*/
3154 case 'C': /* client authenticator information */
3158 addr->authenticator = (*ptr)? string_copy(ptr) : NULL;
3161 addr->auth_id = (*ptr)? string_copy(ptr) : NULL;
3164 addr->auth_sndr = (*ptr)? string_copy(ptr) : NULL;
3170 #ifndef DISABLE_PRDR
3172 addr->flags |= af_prdr_used;
3177 if (addr == NULL) goto ADDR_MISMATCH;
3178 memcpy(&(addr->dsn_aware), ptr, sizeof(addr->dsn_aware));
3179 ptr += sizeof(addr->dsn_aware);
3180 DEBUG(D_deliver) debug_printf("DSN read: addr->dsn_aware = %d\n", addr->dsn_aware);
3187 msg = string_sprintf("address count mismatch for data read from pipe "
3188 "for transport process %d for transport %s", pid,
3189 addrlist->transport->driver_name);
3194 addr->transport_return = *ptr++;
3195 addr->special_action = *ptr++;
3196 memcpy(&(addr->basic_errno), ptr, sizeof(addr->basic_errno));
3197 ptr += sizeof(addr->basic_errno);
3198 memcpy(&(addr->more_errno), ptr, sizeof(addr->more_errno));
3199 ptr += sizeof(addr->more_errno);
3200 memcpy(&(addr->flags), ptr, sizeof(addr->flags));
3201 ptr += sizeof(addr->flags);
3202 addr->message = (*ptr)? string_copy(ptr) : NULL;
3204 addr->user_message = (*ptr)? string_copy(ptr) : NULL;
3207 /* Always two strings for host information, followed by the port number and DNSSEC mark */
3211 h = store_get(sizeof(host_item));
3212 h->name = string_copy(ptr);
3214 h->address = string_copy(ptr);
3216 memcpy(&(h->port), ptr, sizeof(h->port));
3217 ptr += sizeof(h->port);
3218 h->dnssec = *ptr == '2' ? DS_YES
3219 : *ptr == '1' ? DS_NO
3222 addr->host_used = h;
3226 /* Finished with this address */
3231 /* Local interface address/port */
3233 if (*ptr) sending_ip_address = string_copy(ptr);
3235 if (*ptr) sending_port = atoi(CS ptr);
3239 /* Z marks the logical end of the data. It is followed by '0' if
3240 continue_transport was NULL at the end of transporting, otherwise '1'.
3241 We need to know when it becomes NULL during a delivery down a passed SMTP
3242 channel so that we don't try to pass anything more down it. Of course, for
3243 most normal messages it will remain NULL all the time. */
3248 continue_transport = NULL;
3249 continue_hostname = NULL;
3252 DEBUG(D_deliver) debug_printf("Z0%c item read\n", *ptr);
3255 /* Anything else is a disaster. */
3258 msg = string_sprintf("malformed data (%d) read from pipe for transport "
3259 "process %d for transport %s", ptr[-1], pid,
3260 addr->transport->driver_name);
3266 /* The done flag is inspected externally, to determine whether or not to
3267 call the function again when the process finishes. */
3271 /* If the process hadn't finished, and we haven't seen the end of the data
3272 or suffered a disaster, update the rest of the state, and return FALSE to
3273 indicate "not finished". */
3282 /* Close our end of the pipe, to prevent deadlock if the far end is still
3283 pushing stuff into it. */
3288 /* If we have finished without error, but haven't had data for every address,
3289 something is wrong. */
3291 if (msg == NULL && addr != NULL)
3292 msg = string_sprintf("insufficient address data read from pipe "
3293 "for transport process %d for transport %s", pid,
3294 addr->transport->driver_name);
3296 /* If an error message is set, something has gone wrong in getting back
3297 the delivery data. Put the message into each address and freeze it. */
3301 for (addr = addrlist; addr != NULL; addr = addr->next)
3303 addr->transport_return = DEFER;
3304 addr->special_action = SPECIAL_FREEZE;
3305 addr->message = msg;
3309 /* Return TRUE to indicate we have got all we need from this process, even
3310 if it hasn't actually finished yet. */
3317 /*************************************************
3318 * Post-process a set of remote addresses *
3319 *************************************************/
3321 /* Do what has to be done immediately after a remote delivery for each set of
3322 addresses, then re-write the spool if necessary. Note that post_process_one
3323 puts the address on an appropriate queue; hence we must fish off the next
3324 one first. This function is also called if there is a problem with setting
3325 up a subprocess to do a remote delivery in parallel. In this case, the final
3326 argument contains a message, and the action must be forced to DEFER.
3329 addr pointer to chain of address items
3330 logflags flags for logging
3331 msg NULL for normal cases; -> error message for unexpected problems
3332 fallback TRUE if processing fallback hosts
3338 remote_post_process(address_item *addr, int logflags, uschar *msg,
3343 /* If any host addresses were found to be unusable, add them to the unusable
3344 tree so that subsequent deliveries don't try them. */
3346 for (h = addr->host_list; h != NULL; h = h->next)
3348 if (h->address == NULL) continue;
3349 if (h->status >= hstatus_unusable) tree_add_unusable(h);
3352 /* Now handle each address on the chain. The transport has placed '=' or '-'
3353 into the special_action field for each successful delivery. */
3355 while (addr != NULL)
3357 address_item *next = addr->next;
3359 /* If msg == NULL (normal processing) and the result is DEFER and we are
3360 processing the main hosts and there are fallback hosts available, put the
3361 address on the list for fallback delivery. */
3363 if (addr->transport_return == DEFER &&
3364 addr->fallback_hosts != NULL &&
3368 addr->host_list = addr->fallback_hosts;
3369 addr->next = addr_fallback;
3370 addr_fallback = addr;
3371 DEBUG(D_deliver) debug_printf("%s queued for fallback host(s)\n", addr->address);
3374 /* If msg is set (=> unexpected problem), set it in the address before
3375 doing the ordinary post processing. */
3381 addr->message = msg;
3382 addr->transport_return = DEFER;
3384 (void)post_process_one(addr, addr->transport_return, logflags,
3385 DTYPE_TRANSPORT, addr->special_action);
3393 /* If we have just delivered down a passed SMTP channel, and that was
3394 the last address, the channel will have been closed down. Now that
3395 we have logged that delivery, set continue_sequence to 1 so that
3396 any subsequent deliveries don't get "*" incorrectly logged. */
3398 if (continue_transport == NULL) continue_sequence = 1;
3403 /*************************************************
3404 * Wait for one remote delivery subprocess *
3405 *************************************************/
3407 /* This function is called while doing remote deliveries when either the
3408 maximum number of processes exist and we need one to complete so that another
3409 can be created, or when waiting for the last ones to complete. It must wait for
3410 the completion of one subprocess, empty the control block slot, and return a
3411 pointer to the address chain.
3414 Returns: pointer to the chain of addresses handled by the process;
3415 NULL if no subprocess found - this is an unexpected error
3418 static address_item *
3421 int poffset, status;
3422 address_item *addr, *addrlist;
3425 set_process_info("delivering %s: waiting for a remote delivery subprocess "
3426 "to finish", message_id);
3428 /* Loop until either a subprocess completes, or there are no subprocesses in
3429 existence - in which case give an error return. We cannot proceed just by
3430 waiting for a completion, because a subprocess may have filled up its pipe, and
3431 be waiting for it to be emptied. Therefore, if no processes have finished, we
3432 wait for one of the pipes to acquire some data by calling select(), with a
3433 timeout just in case.
3435 The simple approach is just to iterate after reading data from a ready pipe.
3436 This leads to non-ideal behaviour when the subprocess has written its final Z
3437 item, closed the pipe, and is in the process of exiting (the common case). A
3438 call to waitpid() yields nothing completed, but select() shows the pipe ready -
3439 reading it yields EOF, so you end up with busy-waiting until the subprocess has
3442 To avoid this, if all the data that is needed has been read from a subprocess
3443 after select(), an explicit wait() for it is done. We know that all it is doing
3444 is writing to the pipe and then exiting, so the wait should not be long.
3446 The non-blocking waitpid() is to some extent just insurance; if we could
3447 reliably detect end-of-file on the pipe, we could always know when to do a
3448 blocking wait() for a completed process. However, because some systems use
3449 NDELAY, which doesn't distinguish between EOF and pipe empty, it is easier to
3450 use code that functions without the need to recognize EOF.
3452 There's a double loop here just in case we end up with a process that is not in
3453 the list of remote delivery processes. Something has obviously gone wrong if
3454 this is the case. (For example, a process that is incorrectly left over from
3455 routing or local deliveries might be found.) The damage can be minimized by
3456 looping back and looking for another process. If there aren't any, the error
3457 return will happen. */
3459 for (;;) /* Normally we do not repeat this loop */
3461 while ((pid = waitpid(-1, &status, WNOHANG)) <= 0)
3464 fd_set select_pipes;
3465 int maxpipe, readycount;
3467 /* A return value of -1 can mean several things. If errno != ECHILD, it
3468 either means invalid options (which we discount), or that this process was
3469 interrupted by a signal. Just loop to try the waitpid() again.
3471 If errno == ECHILD, waitpid() is telling us that there are no subprocesses
3472 in existence. This should never happen, and is an unexpected error.
3473 However, there is a nasty complication when running under Linux. If "strace
3474 -f" is being used under Linux to trace this process and its children,
3475 subprocesses are "stolen" from their parents and become the children of the
3476 tracing process. A general wait such as the one we've just obeyed returns
3477 as if there are no children while subprocesses are running. Once a
3478 subprocess completes, it is restored to the parent, and waitpid(-1) finds
3479 it. Thanks to Joachim Wieland for finding all this out and suggesting a
3482 This does not happen using "truss" on Solaris, nor (I think) with other
3483 tracing facilities on other OS. It seems to be specific to Linux.
3485 What we do to get round this is to use kill() to see if any of our
3486 subprocesses are still in existence. If kill() gives an OK return, we know
3487 it must be for one of our processes - it can't be for a re-use of the pid,
3488 because if our process had finished, waitpid() would have found it. If any
3489 of our subprocesses are in existence, we proceed to use select() as if
3490 waitpid() had returned zero. I think this is safe. */
3494 if (errno != ECHILD) continue; /* Repeats the waitpid() */
3497 debug_printf("waitpid() returned -1/ECHILD: checking explicitly "
3498 "for process existence\n");
3500 for (poffset = 0; poffset < remote_max_parallel; poffset++)
3502 if ((pid = parlist[poffset].pid) != 0 && kill(pid, 0) == 0)
3504 DEBUG(D_deliver) debug_printf("process %d still exists: assume "
3505 "stolen by strace\n", (int)pid);
3506 break; /* With poffset set */
3510 if (poffset >= remote_max_parallel)
3512 DEBUG(D_deliver) debug_printf("*** no delivery children found\n");
3513 return NULL; /* This is the error return */
3517 /* A pid value greater than 0 breaks the "while" loop. A negative value has
3518 been handled above. A return value of zero means that there is at least one
3519 subprocess, but there are no completed subprocesses. See if any pipes are
3520 ready with any data for reading. */
3522 DEBUG(D_deliver) debug_printf("selecting on subprocess pipes\n");
3525 FD_ZERO(&select_pipes);
3526 for (poffset = 0; poffset < remote_max_parallel; poffset++)
3528 if (parlist[poffset].pid != 0)
3530 int fd = parlist[poffset].fd;
3531 FD_SET(fd, &select_pipes);
3532 if (fd > maxpipe) maxpipe = fd;
3536 /* Stick in a 60-second timeout, just in case. */
3541 readycount = select(maxpipe + 1, (SELECT_ARG2_TYPE *)&select_pipes,
3544 /* Scan through the pipes and read any that are ready; use the count
3545 returned by select() to stop when there are no more. Select() can return
3546 with no processes (e.g. if interrupted). This shouldn't matter.
3548 If par_read_pipe() returns TRUE, it means that either the terminating Z was
3549 read, or there was a disaster. In either case, we are finished with this
3550 process. Do an explicit wait() for the process and break the main loop if
3553 It turns out that we have to deal with the case of an interrupted system
3554 call, which can happen on some operating systems if the signal handling is
3555 set up to do that by default. */
3558 readycount > 0 && poffset < remote_max_parallel;
3561 if ((pid = parlist[poffset].pid) != 0 &&
3562 FD_ISSET(parlist[poffset].fd, &select_pipes))
3565 if (par_read_pipe(poffset, FALSE)) /* Finished with this pipe */
3567 for (;;) /* Loop for signals */
3569 pid_t endedpid = waitpid(pid, &status, 0);
3570 if (endedpid == pid) goto PROCESS_DONE;
3571 if (endedpid != (pid_t)(-1) || errno != EINTR)
3572 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Unexpected error return "
3573 "%d (errno = %d) from waitpid() for process %d",
3574 (int)endedpid, errno, (int)pid);
3580 /* Now go back and look for a completed subprocess again. */
3583 /* A completed process was detected by the non-blocking waitpid(). Find the
3584 data block that corresponds to this subprocess. */
3586 for (poffset = 0; poffset < remote_max_parallel; poffset++)
3587 if (pid == parlist[poffset].pid) break;
3589 /* Found the data block; this is a known remote delivery process. We don't
3590 need to repeat the outer loop. This should be what normally happens. */
3592 if (poffset < remote_max_parallel) break;
3594 /* This situation is an error, but it's probably better to carry on looking
3595 for another process than to give up (as we used to do). */
3597 log_write(0, LOG_MAIN|LOG_PANIC, "Process %d finished: not found in remote "
3598 "transport process list", pid);
3599 } /* End of the "for" loop */
3601 /* Come here when all the data was completely read after a select(), and
3602 the process in pid has been wait()ed for. */
3609 debug_printf("remote delivery process %d ended\n", (int)pid);
3611 debug_printf("remote delivery process %d ended: status=%04x\n", (int)pid,
3615 set_process_info("delivering %s", message_id);
3617 /* Get the chain of processed addresses */
3619 addrlist = parlist[poffset].addrlist;
3621 /* If the process did not finish cleanly, record an error and freeze (except
3622 for SIGTERM, SIGKILL and SIGQUIT), and also ensure the journal is not removed,
3623 in case the delivery did actually happen. */
3625 if ((status & 0xffff) != 0)
3628 int msb = (status >> 8) & 255;
3629 int lsb = status & 255;
3630 int code = (msb == 0)? (lsb & 0x7f) : msb;
3632 msg = string_sprintf("%s transport process returned non-zero status 0x%04x: "
3634 addrlist->transport->driver_name,
3636 (msb == 0)? "terminated by signal" : "exit code",
3639 if (msb != 0 || (code != SIGTERM && code != SIGKILL && code != SIGQUIT))
3640 addrlist->special_action = SPECIAL_FREEZE;
3642 for (addr = addrlist; addr != NULL; addr = addr->next)
3644 addr->transport_return = DEFER;
3645 addr->message = msg;
3648 remove_journal = FALSE;
3651 /* Else complete reading the pipe to get the result of the delivery, if all
3652 the data has not yet been obtained. */
3654 else if (!parlist[poffset].done) (void)par_read_pipe(poffset, TRUE);
3656 /* Put the data count and return path into globals, mark the data slot unused,
3657 decrement the count of subprocesses, and return the address chain. */
3659 transport_count = parlist[poffset].transport_count;
3660 used_return_path = parlist[poffset].return_path;
3661 parlist[poffset].pid = 0;
3668 /*************************************************
3669 * Wait for subprocesses and post-process *
3670 *************************************************/
3672 /* This function waits for subprocesses until the number that are still running
3673 is below a given threshold. For each complete subprocess, the addresses are
3674 post-processed. If we can't find a running process, there is some shambles.
3675 Better not bomb out, as that might lead to multiple copies of the message. Just
3676 log and proceed as if all done.
3679 max maximum number of subprocesses to leave running
3680 fallback TRUE if processing fallback hosts
3686 par_reduce(int max, BOOL fallback)
3688 while (parcount > max)
3690 address_item *doneaddr = par_wait();
3691 if (doneaddr == NULL)
3693 log_write(0, LOG_MAIN|LOG_PANIC,
3694 "remote delivery process count got out of step");
3697 else remote_post_process(doneaddr, LOG_MAIN, NULL, fallback);
3705 rmt_dlv_checked_write(int fd, char id, char subid, void * buf, int size)
3707 uschar writebuffer[PIPE_HEADER_SIZE + BIG_BUFFER_SIZE];
3710 /* we assume that size can't get larger then BIG_BUFFER_SIZE which currently is set to 16k */
3711 /* complain to log if someone tries with buffer sizes we can't handle*/
3715 log_write(0, LOG_MAIN|LOG_PANIC_DIE,
3716 "Failed writing transport result to pipe: can't handle buffers > 99999 bytes. truncating!\n");
3720 /* to keep the write() atomic we build header in writebuffer and copy buf behind */
3721 /* two write() calls would increase the complexity of reading from pipe */
3723 /* convert size to human readable string prepended by id and subid */
3724 header_length = snprintf(CS writebuffer, PIPE_HEADER_SIZE+1, "%c%c%05d", id, subid, size);
3725 if (header_length != PIPE_HEADER_SIZE)
3727 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "header snprintf failed\n");
3728 writebuffer[0] = '\0';
3731 DEBUG(D_deliver) debug_printf("header write id:%c,subid:%c,size:%d,final:%s\n",
3732 id, subid, size, writebuffer);
3734 if (buf && size > 0)
3735 memcpy(writebuffer + PIPE_HEADER_SIZE, buf, size);
3737 size += PIPE_HEADER_SIZE;
3738 int ret = write(fd, writebuffer, size);
3740 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Failed writing transport result to pipe: %s\n",
3741 ret == -1 ? strerror(errno) : "short write");
3744 /*************************************************
3745 * Do remote deliveries *
3746 *************************************************/
3748 /* This function is called to process the addresses in addr_remote. We must
3749 pick off the queue all addresses that have the same transport, remote
3750 destination, and errors address, and hand them to the transport in one go,
3751 subject to some configured limitations. If this is a run to continue delivering
3752 to an existing delivery channel, skip all but those addresses that can go to
3753 that channel. The skipped addresses just get deferred.
3755 If mua_wrapper is set, all addresses must be able to be sent in a single
3756 transaction. If not, this function yields FALSE.
3758 In Exim 4, remote deliveries are always done in separate processes, even
3759 if remote_max_parallel = 1 or if there's only one delivery to do. The reason
3760 is so that the base process can retain privilege. This makes the
3761 implementation of fallback transports feasible (though not initially done.)
3763 We create up to the configured number of subprocesses, each of which passes
3764 back the delivery state via a pipe. (However, when sending down an existing
3765 connection, remote_max_parallel is forced to 1.)
3768 fallback TRUE if processing fallback hosts
3770 Returns: TRUE normally
3771 FALSE if mua_wrapper is set and the addresses cannot all be sent
3776 do_remote_deliveries(BOOL fallback)
3782 parcount = 0; /* Number of executing subprocesses */
3784 /* When sending down an existing channel, only do one delivery at a time.
3785 We use a local variable (parmax) to hold the maximum number of processes;
3786 this gets reduced from remote_max_parallel if we can't create enough pipes. */
3788 if (continue_transport != NULL) remote_max_parallel = 1;
3789 parmax = remote_max_parallel;
3791 /* If the data for keeping a list of processes hasn't yet been
3794 if (parlist == NULL)
3796 parlist = store_get(remote_max_parallel * sizeof(pardata));
3797 for (poffset = 0; poffset < remote_max_parallel; poffset++)
3798 parlist[poffset].pid = 0;
3801 /* Now loop for each remote delivery */
3803 for (delivery_count = 0; addr_remote != NULL; delivery_count++)
3809 int address_count = 1;
3810 int address_count_max;
3812 BOOL use_initgroups;
3813 BOOL pipe_done = FALSE;
3814 transport_instance *tp;
3815 address_item **anchor = &addr_remote;
3816 address_item *addr = addr_remote;
3817 address_item *last = addr;
3820 /* Pull the first address right off the list. */
3822 addr_remote = addr->next;
3825 DEBUG(D_deliver|D_transport)
3826 debug_printf("--------> %s <--------\n", addr->address);
3828 /* If no transport has been set, there has been a big screw-up somewhere. */
3830 if ((tp = addr->transport) == NULL)
3832 disable_logging = FALSE; /* Jic */
3833 remote_post_process(addr, LOG_MAIN|LOG_PANIC,
3834 US"No transport set by router", fallback);
3838 /* Check that this base address hasn't previously been delivered to this
3839 transport. The check is necessary at this point to handle homonymic addresses
3840 correctly in cases where the pattern of redirection changes between delivery
3841 attempts. Non-homonymic previous delivery is detected earlier, at routing
3844 if (previously_transported(addr, FALSE)) continue;
3846 /* Force failure if the message is too big. */
3848 if (tp->message_size_limit != NULL)
3850 int rc = check_message_size(tp, addr);
3853 addr->transport_return = rc;
3854 remote_post_process(addr, LOG_MAIN, NULL, fallback);
3859 /* Get the flag which specifies whether the transport can handle different
3860 domains that nevertheless resolve to the same set of hosts. If it needs
3861 expanding, get variables set: $address_data, $domain_data, $localpart_data,
3862 $host, $host_address, $host_port. */
3863 if (tp->expand_multi_domain)
3864 deliver_set_expansions(addr);
3866 if (exp_bool(addr, US"transport", tp->name, D_transport,
3867 US"multi_domain", tp->multi_domain, tp->expand_multi_domain,
3868 &multi_domain) != OK)
3870 deliver_set_expansions(NULL);
3871 remote_post_process(addr, LOG_MAIN|LOG_PANIC, addr->message, fallback);
3875 /* Get the maximum it can handle in one envelope, with zero meaning
3876 unlimited, which is forced for the MUA wrapper case. */
3878 address_count_max = tp->max_addresses;
3879 if (address_count_max == 0 || mua_wrapper) address_count_max = 999999;
3882 /************************************************************************/
3883 /***** This is slightly experimental code, but should be safe. *****/
3885 /* The address_count_max value is the maximum number of addresses that the
3886 transport can send in one envelope. However, the transport must be capable of
3887 dealing with any number of addresses. If the number it gets exceeds its
3888 envelope limitation, it must send multiple copies of the message. This can be
3889 done over a single connection for SMTP, so uses less resources than making
3890 multiple connections. On the other hand, if remote_max_parallel is greater
3891 than one, it is perhaps a good idea to use parallel processing to move the
3892 message faster, even if that results in multiple simultaneous connections to
3895 How can we come to some compromise between these two ideals? What we do is to
3896 limit the number of addresses passed to a single instance of a transport to
3897 the greater of (a) its address limit (rcpt_max for SMTP) and (b) the total
3898 number of addresses routed to remote transports divided by
3899 remote_max_parallel. For example, if the message has 100 remote recipients,
3900 remote max parallel is 2, and rcpt_max is 10, we'd never send more than 50 at
3901 once. But if rcpt_max is 100, we could send up to 100.
3903 Of course, not all the remotely addresses in a message are going to go to the
3904 same set of hosts (except in smarthost configurations), so this is just a
3905 heuristic way of dividing up the work.
3907 Furthermore (1), because this may not be wanted in some cases, and also to
3908 cope with really pathological cases, there is also a limit to the number of
3909 messages that are sent over one connection. This is the same limit that is
3910 used when sending several different messages over the same connection.
3911 Continue_sequence is set when in this situation, to the number sent so
3912 far, including this message.
3914 Furthermore (2), when somebody explicitly sets the maximum value to 1, it
3915 is probably because they are using VERP, in which case they want to pass only
3916 one address at a time to the transport, in order to be able to use
3917 $local_part and $domain in constructing a new return path. We could test for
3918 the use of these variables, but as it is so likely they will be used when the
3919 maximum is 1, we don't bother. Just leave the value alone. */
3921 if (address_count_max != 1 &&
3922 address_count_max < remote_delivery_count/remote_max_parallel)
3924 int new_max = remote_delivery_count/remote_max_parallel;
3925 int message_max = tp->connection_max_messages;
3926 if (connection_max_messages >= 0) message_max = connection_max_messages;
3927 message_max -= continue_sequence - 1;
3928 if (message_max > 0 && new_max > address_count_max * message_max)
3929 new_max = address_count_max * message_max;
3930 address_count_max = new_max;
3933 /************************************************************************/
3936 /* Pick off all addresses which have the same transport, errors address,
3937 destination, and extra headers. In some cases they point to the same host
3938 list, but we also need to check for identical host lists generated from
3939 entirely different domains. The host list pointers can be NULL in the case
3940 where the hosts are defined in the transport. There is also a configured
3941 maximum limit of addresses that can be handled at once (see comments above
3942 for how it is computed).
3943 If the transport does not handle multiple domains, enforce that also,
3944 and if it might need a per-address check for this, re-evaluate it.
3947 while ((next = *anchor) != NULL && address_count < address_count_max)
3950 if ( (multi_domain || Ustrcmp(next->domain, addr->domain) == 0)
3951 && tp == next->transport
3952 && same_hosts(next->host_list, addr->host_list)
3953 && same_strings(next->p.errors_address, addr->p.errors_address)
3954 && same_headers(next->p.extra_headers, addr->p.extra_headers)
3955 && same_ugid(tp, next, addr)
3956 && ( next->p.remove_headers == addr->p.remove_headers
3957 || ( next->p.remove_headers != NULL
3958 && addr->p.remove_headers != NULL
3959 && Ustrcmp(next->p.remove_headers, addr->p.remove_headers) == 0
3963 !tp->expand_multi_domain || (deliver_set_expansions(next), 1),
3965 US"transport", next->transport->name, D_transport,
3966 US"multi_domain", next->transport->multi_domain,
3967 next->transport->expand_multi_domain, &md) == OK
3972 *anchor = next->next;
3974 next->first = addr; /* remember top one (for retry processing) */
3979 else anchor = &(next->next);
3980 deliver_set_expansions(NULL);
3983 /* If we are acting as an MUA wrapper, all addresses must go in a single
3984 transaction. If not, put them back on the chain and yield FALSE. */
3986 if (mua_wrapper && addr_remote != NULL)
3988 last->next = addr_remote;
3993 /* Set up the expansion variables for this set of addresses */
3995 deliver_set_expansions(addr);
3997 /* Ensure any transport-set auth info is fresh */
3998 addr->authenticator = addr->auth_id = addr->auth_sndr = NULL;
4000 /* Compute the return path, expanding a new one if required. The old one
4001 must be set first, as it might be referred to in the expansion. */
4003 if(addr->p.errors_address != NULL)
4004 return_path = addr->p.errors_address;
4005 #ifdef EXPERIMENTAL_SRS
4006 else if(addr->p.srs_sender != NULL)
4007 return_path = addr->p.srs_sender;
4010 return_path = sender_address;
4012 if (tp->return_path != NULL)
4014 uschar *new_return_path = expand_string(tp->return_path);
4015 if (new_return_path == NULL)
4017 if (!expand_string_forcedfail)
4019 remote_post_process(addr, LOG_MAIN|LOG_PANIC,
4020 string_sprintf("Failed to expand return path \"%s\": %s",
4021 tp->return_path, expand_string_message), fallback);
4025 else return_path = new_return_path;
4028 /* Find the uid, gid, and use_initgroups setting for this transport. Failure
4029 logs and sets up error messages, so we just post-process and continue with
4030 the next address. */
4032 if (!findugid(addr, tp, &uid, &gid, &use_initgroups))
4034 remote_post_process(addr, LOG_MAIN|LOG_PANIC, NULL, fallback);
4038 /* If this transport has a setup function, call it now so that it gets
4039 run in this process and not in any subprocess. That way, the results of
4040 any setup that are retained by the transport can be reusable. One of the
4041 things the setup does is to set the fallback host lists in the addresses.
4042 That is why it is called at this point, before the continue delivery
4043 processing, because that might use the fallback hosts. */
4045 if (tp->setup != NULL)
4046 (void)((tp->setup)(addr->transport, addr, NULL, uid, gid, NULL));
4048 /* If this is a run to continue delivery down an already-established
4049 channel, check that this set of addresses matches the transport and
4050 the channel. If it does not, defer the addresses. If a host list exists,
4051 we must check that the continue host is on the list. Otherwise, the
4052 host is set in the transport. */
4054 continue_more = FALSE; /* In case got set for the last lot */
4055 if (continue_transport != NULL)
4057 BOOL ok = Ustrcmp(continue_transport, tp->name) == 0;
4058 if (ok && addr->host_list != NULL)
4062 for (h = addr->host_list; h != NULL; h = h->next)
4064 if (Ustrcmp(h->name, continue_hostname) == 0)
4065 { ok = TRUE; break; }
4069 /* Addresses not suitable; defer or queue for fallback hosts (which
4070 might be the continue host) and skip to next address. */
4074 DEBUG(D_deliver) debug_printf("not suitable for continue_transport\n");
4077 if (addr->fallback_hosts != NULL && !fallback)
4081 next->host_list = next->fallback_hosts;
4082 DEBUG(D_deliver) debug_printf("%s queued for fallback host(s)\n", next->address);
4083 if (next->next == NULL) break;
4086 next->next = addr_fallback;
4087 addr_fallback = addr;
4092 while (next->next != NULL) next = next->next;
4093 next->next = addr_defer;
4100 /* Set a flag indicating whether there are further addresses that list
4101 the continued host. This tells the transport to leave the channel open,
4102 but not to pass it to another delivery process. */
4104 for (next = addr_remote; next != NULL; next = next->next)
4107 for (h = next->host_list; h != NULL; h = h->next)
4109 if (Ustrcmp(h->name, continue_hostname) == 0)
4110 { continue_more = TRUE; break; }
4115 /* The transports set up the process info themselves as they may connect
4116 to more than one remote machine. They also have to set up the filter
4117 arguments, if required, so that the host name and address are available
4120 transport_filter_argv = NULL;
4122 /* Create the pipe for inter-process communication. If pipe creation
4123 fails, it is probably because the value of remote_max_parallel is so
4124 large that too many file descriptors for pipes have been created. Arrange
4125 to wait for a process to finish, and then try again. If we still can't
4126 create a pipe when all processes have finished, break the retry loop. */
4130 if (pipe(pfd) == 0) pipe_done = TRUE;
4131 else if (parcount > 0) parmax = parcount;
4134 /* We need to make the reading end of the pipe non-blocking. There are
4135 two different options for this. Exim is cunningly (I hope!) coded so
4136 that it can use either of them, though it prefers O_NONBLOCK, which
4137 distinguishes between EOF and no-more-data. */
4140 (void)fcntl(pfd[pipe_read], F_SETFL, O_NONBLOCK);
4142 (void)fcntl(pfd[pipe_read], F_SETFL, O_NDELAY);
4145 /* If the maximum number of subprocesses already exist, wait for a process
4146 to finish. If we ran out of file descriptors, parmax will have been reduced
4147 from its initial value of remote_max_parallel. */
4149 par_reduce(parmax - 1, fallback);
4152 /* If we failed to create a pipe and there were no processes to wait
4153 for, we have to give up on this one. Do this outside the above loop
4154 so that we can continue the main loop. */
4158 remote_post_process(addr, LOG_MAIN|LOG_PANIC,
4159 string_sprintf("unable to create pipe: %s", strerror(errno)), fallback);
4163 /* Find a free slot in the pardata list. Must do this after the possible
4164 waiting for processes to finish, because a terminating process will free
4167 for (poffset = 0; poffset < remote_max_parallel; poffset++)
4168 if (parlist[poffset].pid == 0) break;
4170 /* If there isn't one, there has been a horrible disaster. */
4172 if (poffset >= remote_max_parallel)
4174 (void)close(pfd[pipe_write]);
4175 (void)close(pfd[pipe_read]);
4176 remote_post_process(addr, LOG_MAIN|LOG_PANIC,
4177 US"Unexpectedly no free subprocess slot", fallback);
4181 /* Now fork a subprocess to do the remote delivery, but before doing so,
4182 ensure that any cached resourses are released so as not to interfere with
4183 what happens in the subprocess. */
4187 if ((pid = fork()) == 0)
4189 int fd = pfd[pipe_write];
4192 /* Setting this global in the subprocess means we need never clear it */
4193 transport_name = tp->name;
4195 /* There are weird circumstances in which logging is disabled */
4196 disable_logging = tp->disable_logging;
4198 /* Show pids on debug output if parallelism possible */
4200 if (parmax > 1 && (parcount > 0 || addr_remote != NULL))
4202 DEBUG(D_any|D_v) debug_selector |= D_pid;
4203 DEBUG(D_deliver) debug_printf("Remote delivery process started\n");
4206 /* Reset the random number generator, so different processes don't all
4207 have the same sequence. In the test harness we want different, but
4208 predictable settings for each delivery process, so do something explicit
4209 here rather they rely on the fixed reset in the random number function. */
4211 random_seed = running_in_test_harness? 42 + 2*delivery_count : 0;
4213 /* Set close-on-exec on the pipe so that it doesn't get passed on to
4214 a new process that may be forked to do another delivery down the same
4217 (void)fcntl(fd, F_SETFD, fcntl(fd, F_GETFD) | FD_CLOEXEC);
4219 /* Close open file descriptors for the pipes of other processes
4220 that are running in parallel. */
4222 for (poffset = 0; poffset < remote_max_parallel; poffset++)
4223 if (parlist[poffset].pid != 0) (void)close(parlist[poffset].fd);
4225 /* This process has inherited a copy of the file descriptor
4226 for the data file, but its file pointer is shared with all the
4227 other processes running in parallel. Therefore, we have to re-open
4228 the file in order to get a new file descriptor with its own
4229 file pointer. We don't need to lock it, as the lock is held by
4230 the parent process. There doesn't seem to be any way of doing
4231 a dup-with-new-file-pointer. */
4233 (void)close(deliver_datafile);
4234 sprintf(CS spoolname, "%s/input/%s/%s-D", spool_directory, message_subdir,
4236 deliver_datafile = Uopen(spoolname, O_RDWR | O_APPEND, 0);
4238 if (deliver_datafile < 0)
4239 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Failed to reopen %s for remote "
4240 "parallel delivery: %s", spoolname, strerror(errno));
4242 /* Set the close-on-exec flag */
4244 (void)fcntl(deliver_datafile, F_SETFD, fcntl(deliver_datafile, F_GETFD) |
4247 /* Set the uid/gid of this process; bombs out on failure. */
4249 exim_setugid(uid, gid, use_initgroups,
4250 string_sprintf("remote delivery to %s with transport=%s",
4251 addr->address, tp->name));
4253 /* Close the unwanted half of this process' pipe, set the process state,
4254 and run the transport. Afterwards, transport_count will contain the number
4255 of bytes written. */
4257 (void)close(pfd[pipe_read]);
4258 set_process_info("delivering %s using %s", message_id, tp->name);
4259 debug_print_string(tp->debug_string);
4260 if (!(tp->info->code)(addr->transport, addr)) replicate_status(addr);
4262 set_process_info("delivering %s (just run %s for %s%s in subprocess)",
4263 message_id, tp->name, addr->address, (addr->next == NULL)? "" : ", ...");
4265 /* Ensure any cached resources that we used are now released */
4269 /* Pass the result back down the pipe. This is a lot more information
4270 than is needed for a local delivery. We have to send back the error
4271 status for each address, the usability status for each host that is
4272 flagged as unusable, and all the retry items. When TLS is in use, we
4273 send also the cipher and peerdn information. Each type of information
4274 is flagged by an identifying byte, and is then in a fixed format (with
4275 strings terminated by zeros), and there is a final terminator at the
4276 end. The host information and retry information is all attached to
4277 the first address, so that gets sent at the start. */
4279 /* Host unusability information: for most success cases this will
4282 for (h = addr->host_list; h != NULL; h = h->next)
4284 if (h->address == NULL || h->status < hstatus_unusable) continue;
4285 sprintf(CS big_buffer, "%c%c%s", h->status, h->why, h->address);
4286 rmt_dlv_checked_write(fd, 'H', '0', big_buffer, Ustrlen(big_buffer+2) + 3);
4289 /* The number of bytes written. This is the same for each address. Even
4290 if we sent several copies of the message down the same connection, the
4291 size of each one is the same, and it's that value we have got because
4292 transport_count gets reset before calling transport_write_message(). */
4294 memcpy(big_buffer, &transport_count, sizeof(transport_count));
4295 rmt_dlv_checked_write(fd, 'S', '0', big_buffer, sizeof(transport_count));
4297 /* Information about what happened to each address. Four item types are
4298 used: an optional 'X' item first, for TLS information, then an optional "C"
4299 item for any client-auth info followed by 'R' items for any retry settings,
4300 and finally an 'A' item for the remaining data. */
4302 for(; addr != NULL; addr = addr->next)
4307 /* The certificate verification status goes into the flags */
4308 if (tls_out.certificate_verified) setflag(addr, af_cert_verified);
4309 #ifdef EXPERIMENTAL_DANE
4310 if (tls_out.dane_verified) setflag(addr, af_dane_verified);
4313 /* Use an X item only if there's something to send */
4318 sprintf(CS ptr, "%.128s", addr->cipher);
4324 sprintf(CS ptr, "%.512s", addr->peerdn);
4328 rmt_dlv_checked_write(fd, 'X', '1', big_buffer, ptr - big_buffer);
4333 if (!tls_export_cert(ptr, big_buffer_size-2, addr->peercert))
4337 rmt_dlv_checked_write(fd, 'X', '2', big_buffer, ptr - big_buffer);
4342 if (!tls_export_cert(ptr, big_buffer_size-2, addr->ourcert))
4346 rmt_dlv_checked_write(fd, 'X', '3', big_buffer, ptr - big_buffer);
4348 # ifndef DISABLE_OCSP
4349 if (addr->ocsp > OCSP_NOT_REQ)
4352 sprintf(CS ptr, "%c", addr->ocsp + '0');
4354 rmt_dlv_checked_write(fd, 'X', '4', big_buffer, ptr - big_buffer);
4357 #endif /*SUPPORT_TLS*/
4359 if (client_authenticator)
4362 sprintf(CS big_buffer, "%.64s", client_authenticator);
4364 rmt_dlv_checked_write(fd, 'C', '1', big_buffer, ptr - big_buffer);
4366 if (client_authenticated_id)
4369 sprintf(CS big_buffer, "%.64s", client_authenticated_id);
4371 rmt_dlv_checked_write(fd, 'C', '2', big_buffer, ptr - big_buffer);
4373 if (client_authenticated_sender)
4376 sprintf(CS big_buffer, "%.64s", client_authenticated_sender);
4378 rmt_dlv_checked_write(fd, 'C', '3', big_buffer, ptr - big_buffer);
4381 #ifndef DISABLE_PRDR
4382 if (addr->flags & af_prdr_used)
4383 rmt_dlv_checked_write(fd, 'P', '0', NULL, 0);
4386 memcpy(big_buffer, &addr->dsn_aware, sizeof(addr->dsn_aware));
4387 rmt_dlv_checked_write(fd, 'D', '0', big_buffer, sizeof(addr->dsn_aware));
4388 DEBUG(D_deliver) debug_printf("DSN write: addr->dsn_aware = %d\n", addr->dsn_aware);
4390 /* Retry information: for most success cases this will be null. */
4392 for (r = addr->retries; r != NULL; r = r->next)
4395 sprintf(CS big_buffer, "%c%.500s", r->flags, r->key);
4396 ptr = big_buffer + Ustrlen(big_buffer+2) + 3;
4397 memcpy(ptr, &(r->basic_errno), sizeof(r->basic_errno));
4398 ptr += sizeof(r->basic_errno);
4399 memcpy(ptr, &(r->more_errno), sizeof(r->more_errno));
4400 ptr += sizeof(r->more_errno);
4401 if (r->message == NULL) *ptr++ = 0; else
4403 sprintf(CS ptr, "%.512s", r->message);
4406 rmt_dlv_checked_write(fd, 'R', '0', big_buffer, ptr - big_buffer);
4409 /* The rest of the information goes in an 'A' item. */
4411 ptr = big_buffer + 2;
4412 sprintf(CS big_buffer, "%c%c", addr->transport_return,
4413 addr->special_action);
4414 memcpy(ptr, &(addr->basic_errno), sizeof(addr->basic_errno));
4415 ptr += sizeof(addr->basic_errno);
4416 memcpy(ptr, &(addr->more_errno), sizeof(addr->more_errno));
4417 ptr += sizeof(addr->more_errno);
4418 memcpy(ptr, &(addr->flags), sizeof(addr->flags));
4419 ptr += sizeof(addr->flags);
4421 if (addr->message == NULL) *ptr++ = 0; else
4423 sprintf(CS ptr, "%.1024s", addr->message);
4427 if (addr->user_message == NULL) *ptr++ = 0; else
4429 sprintf(CS ptr, "%.1024s", addr->user_message);
4433 if (addr->host_used == NULL) *ptr++ = 0; else
4435 sprintf(CS ptr, "%.256s", addr->host_used->name);
4437 sprintf(CS ptr, "%.64s", addr->host_used->address);
4439 memcpy(ptr, &(addr->host_used->port), sizeof(addr->host_used->port));
4440 ptr += sizeof(addr->host_used->port);
4442 /* DNS lookup status */
4443 *ptr++ = addr->host_used->dnssec==DS_YES ? '2'
4444 : addr->host_used->dnssec==DS_NO ? '1' : '0';
4447 rmt_dlv_checked_write(fd, 'A', '0', big_buffer, ptr - big_buffer);
4450 /* Local interface address/port */
4451 if (log_extra_selector & LX_incoming_interface && sending_ip_address)
4453 uschar * ptr = big_buffer;
4454 sprintf(CS ptr, "%.128s", sending_ip_address);
4456 sprintf(CS ptr, "%d", sending_port);
4459 rmt_dlv_checked_write(fd, 'I', '0', big_buffer, ptr - big_buffer);
4462 /* Add termination flag, close the pipe, and that's it. The character
4463 after 'Z' indicates whether continue_transport is now NULL or not.
4464 A change from non-NULL to NULL indicates a problem with a continuing
4467 big_buffer[0] = (continue_transport == NULL)? '0' : '1';
4468 rmt_dlv_checked_write(fd, 'Z', '0', big_buffer, 1);
4473 /* Back in the mainline: close the unwanted half of the pipe. */
4475 (void)close(pfd[pipe_write]);
4477 /* Fork failed; defer with error message */
4481 (void)close(pfd[pipe_read]);
4482 remote_post_process(addr, LOG_MAIN|LOG_PANIC,
4483 string_sprintf("fork failed for remote delivery to %s: %s",
4484 addr->domain, strerror(errno)), fallback);
4488 /* Fork succeeded; increment the count, and remember relevant data for
4489 when the process finishes. */
4492 parlist[poffset].addrlist = parlist[poffset].addr = addr;
4493 parlist[poffset].pid = pid;
4494 parlist[poffset].fd = pfd[pipe_read];
4495 parlist[poffset].done = FALSE;
4496 parlist[poffset].msg = NULL;
4497 parlist[poffset].return_path = return_path;
4499 /* If the process we've just started is sending a message down an existing
4500 channel, wait for it now. This ensures that only one such process runs at
4501 once, whatever the value of remote_max parallel. Otherwise, we might try to
4502 send two or more messages simultaneously down the same channel. This could
4503 happen if there are different domains that include the same host in otherwise
4504 different host lists.
4506 Also, if the transport closes down the channel, this information gets back
4507 (continue_transport gets set to NULL) before we consider any other addresses
4510 if (continue_transport != NULL) par_reduce(0, fallback);
4512 /* Otherwise, if we are running in the test harness, wait a bit, to let the
4513 newly created process get going before we create another process. This should
4514 ensure repeatability in the tests. We only need to wait a tad. */
4516 else if (running_in_test_harness) millisleep(500);
4519 /* Reached the end of the list of addresses. Wait for all the subprocesses that
4520 are still running and post-process their addresses. */
4522 par_reduce(0, fallback);
4529 /*************************************************
4530 * Split an address into local part and domain *
4531 *************************************************/
4533 /* This function initializes an address for routing by splitting it up into a
4534 local part and a domain. The local part is set up twice - once in its original
4535 casing, and once in lower case, and it is dequoted. We also do the "percent
4536 hack" for configured domains. This may lead to a DEFER result if a lookup
4537 defers. When a percent-hacking takes place, we insert a copy of the original
4538 address as a new parent of this address, as if we have had a redirection.
4541 addr points to an addr_item block containing the address
4544 DEFER - could not determine if domain is %-hackable
4548 deliver_split_address(address_item *addr)
4550 uschar *address = addr->address;
4551 uschar *domain = Ustrrchr(address, '@');
4553 int len = domain - address;
4555 addr->domain = string_copylc(domain+1); /* Domains are always caseless */
4557 /* The implication in the RFCs (though I can't say I've seen it spelled out
4558 explicitly) is that quoting should be removed from local parts at the point
4559 where they are locally interpreted. [The new draft "821" is more explicit on
4560 this, Jan 1999.] We know the syntax is valid, so this can be done by simply
4561 removing quoting backslashes and any unquoted doublequotes. */
4563 t = addr->cc_local_part = store_get(len+1);
4566 register int c = *address++;
4567 if (c == '\"') continue;
4577 /* We do the percent hack only for those domains that are listed in
4578 percent_hack_domains. A loop is required, to copy with multiple %-hacks. */
4580 if (percent_hack_domains != NULL)
4583 uschar *new_address = NULL;
4584 uschar *local_part = addr->cc_local_part;
4586 deliver_domain = addr->domain; /* set $domain */
4588 while ((rc = match_isinlist(deliver_domain, (const uschar **)&percent_hack_domains, 0,
4589 &domainlist_anchor, addr->domain_cache, MCL_DOMAIN, TRUE, NULL))
4591 (t = Ustrrchr(local_part, '%')) != NULL)
4593 new_address = string_copy(local_part);
4594 new_address[t - local_part] = '@';
4595 deliver_domain = string_copylc(t+1);
4596 local_part = string_copyn(local_part, t - local_part);
4599 if (rc == DEFER) return DEFER; /* lookup deferred */
4601 /* If hackery happened, set up new parent and alter the current address. */
4603 if (new_address != NULL)
4605 address_item *new_parent = store_get(sizeof(address_item));
4606 *new_parent = *addr;
4607 addr->parent = new_parent;
4608 addr->address = new_address;
4609 addr->unique = string_copy(new_address);
4610 addr->domain = deliver_domain;
4611 addr->cc_local_part = local_part;
4612 DEBUG(D_deliver) debug_printf("%%-hack changed address to: %s\n",
4617 /* Create the lowercased version of the final local part, and make that the
4618 default one to be used. */
4620 addr->local_part = addr->lc_local_part = string_copylc(addr->cc_local_part);
4627 /*************************************************
4628 * Get next error message text *
4629 *************************************************/
4631 /* If f is not NULL, read the next "paragraph", from a customized error message
4632 text file, terminated by a line containing ****, and expand it.
4635 f NULL or a file to read from
4636 which string indicating which string (for errors)
4638 Returns: NULL or an expanded string
4642 next_emf(FILE *f, uschar *which)
4646 uschar *para, *yield;
4649 if (f == NULL) return NULL;
4651 if (Ufgets(buffer, sizeof(buffer), f) == NULL ||
4652 Ustrcmp(buffer, "****\n") == 0) return NULL;
4654 para = store_get(size);
4657 para = string_cat(para, &size, &ptr, buffer, Ustrlen(buffer));
4658 if (Ufgets(buffer, sizeof(buffer), f) == NULL ||
4659 Ustrcmp(buffer, "****\n") == 0) break;
4663 yield = expand_string(para);
4664 if (yield != NULL) return yield;
4666 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand string from "
4667 "bounce_message_file or warn_message_file (%s): %s", which,
4668 expand_string_message);
4675 /*************************************************
4676 * Close down a passed transport channel *
4677 *************************************************/
4679 /* This function is called when a passed transport channel cannot be used.
4680 It attempts to close it down tidily. The yield is always DELIVER_NOT_ATTEMPTED
4681 so that the function call can be the argument of a "return" statement.
4684 Returns: DELIVER_NOT_ATTEMPTED
4688 continue_closedown(void)
4690 if (continue_transport != NULL)
4692 transport_instance *t;
4693 for (t = transports; t != NULL; t = t->next)
4695 if (Ustrcmp(t->name, continue_transport) == 0)
4697 if (t->info->closedown != NULL) (t->info->closedown)(t);
4702 return DELIVER_NOT_ATTEMPTED;
4708 /*************************************************
4709 * Print address information *
4710 *************************************************/
4712 /* This function is called to output an address, or information about an
4713 address, for bounce or defer messages. If the hide_child flag is set, all we
4714 output is the original ancestor address.
4717 addr points to the address
4718 f the FILE to print to
4719 si an initial string
4720 sc a continuation string for before "generated"
4723 Returns: TRUE if the address is not hidden
4727 print_address_information(address_item *addr, FILE *f, uschar *si, uschar *sc,
4731 uschar *printed = US"";
4732 address_item *ancestor = addr;
4733 while (ancestor->parent != NULL) ancestor = ancestor->parent;
4735 fprintf(f, "%s", CS si);
4737 if (addr->parent != NULL && testflag(addr, af_hide_child))
4739 printed = US"an undisclosed address";
4742 else if (!testflag(addr, af_pfr) || addr->parent == NULL)
4743 printed = addr->address;
4747 uschar *s = addr->address;
4750 if (addr->address[0] == '>') { ss = US"mail"; s++; }
4751 else if (addr->address[0] == '|') ss = US"pipe";
4754 fprintf(f, "%s to %s%sgenerated by ", ss, s, sc);
4755 printed = addr->parent->address;
4758 fprintf(f, "%s", CS string_printing(printed));
4760 if (ancestor != addr)
4762 uschar *original = (ancestor->onetime_parent == NULL)?
4763 ancestor->address : ancestor->onetime_parent;
4764 if (strcmpic(original, printed) != 0)
4765 fprintf(f, "%s(%sgenerated from %s)", sc,
4766 (ancestor != addr->parent)? "ultimately " : "",
4767 string_printing(original));
4770 if (addr->host_used)
4771 fprintf(f, "\n host %s [%s]",
4772 addr->host_used->name, addr->host_used->address);
4774 fprintf(f, "%s", CS se);
4782 /*************************************************
4783 * Print error for an address *
4784 *************************************************/
4786 /* This function is called to print the error information out of an address for
4787 a bounce or a warning message. It tries to format the message reasonably by
4788 introducing newlines. All lines are indented by 4; the initial printing
4789 position must be set before calling.
4791 This function used always to print the error. Nowadays we want to restrict it
4792 to cases such as LMTP/SMTP errors from a remote host, and errors from :fail:
4793 and filter "fail". We no longer pass other information willy-nilly in bounce
4794 and warning messages. Text in user_message is always output; text in message
4795 only if the af_pass_message flag is set.
4799 f the FILE to print on
4806 print_address_error(address_item *addr, FILE *f, uschar *t)
4808 int count = Ustrlen(t);
4809 uschar *s = testflag(addr, af_pass_message)? addr->message : NULL;
4813 if (addr->user_message != NULL) s = addr->user_message; else return;
4816 fprintf(f, "\n %s", t);
4820 if (*s == '\\' && s[1] == 'n')
4830 if (*s++ == ':' && isspace(*s) && count > 45)
4832 fprintf(f, "\n "); /* sic (because space follows) */
4840 /***********************************************************
4841 * Print Diagnostic-Code for an address *
4842 ************************************************************/
4844 /* This function is called to print the error information out of an address for
4845 a bounce or a warning message. It tries to format the message reasonably as
4846 required by RFC 3461 by adding a space after each newline
4848 we assume that this function is only called if addr->host_used is set and if so
4849 a useable addr->message is available containing some Exim description with ": \n"
4850 ending, followed by the L/SMTP error message.
4854 f the FILE to print on
4860 print_dsn_diagnostic_code(const address_item *addr, FILE *f)
4864 /* check host_used, af_pass_message flag and addr->message for safety reasons */
4865 if (!addr->host_used && testflag(addr, af_pass_message) && addr->message)
4868 /* search first ": ". we assume to find the remote-MTA answer there */
4870 debug_printf("DSN Diagnostic-Code: addr->dsn_message = %s\n", addr->message);
4871 if (!(s = Ustrstr(addr->message, ": ")))
4872 return; /* not found, bail out */
4874 fprintf(f, "Diagnostic-Code: smtp; ");
4876 s += 2; /* skip ": " */
4878 if (*s == '\\' && s[1] == 'n')
4880 fputs("\n ", f); /* as defined in RFC 3461 */
4890 /*************************************************
4891 * Check list of addresses for duplication *
4892 *************************************************/
4894 /* This function was introduced when the test for duplicate addresses that are
4895 not pipes, files, or autoreplies was moved from the middle of routing to when
4896 routing was complete. That was to fix obscure cases when the routing history
4897 affects the subsequent routing of identical addresses. This function is called
4898 after routing, to check that the final routed addresses are not duplicates.
4900 If we detect a duplicate, we remember what it is a duplicate of. Note that
4901 pipe, file, and autoreply de-duplication is handled during routing, so we must
4902 leave such "addresses" alone here, as otherwise they will incorrectly be
4905 Argument: address of list anchor
4910 do_duplicate_check(address_item **anchor)
4913 while ((addr = *anchor) != NULL)
4916 if (testflag(addr, af_pfr))
4918 anchor = &(addr->next);
4920 else if ((tnode = tree_search(tree_duplicates, addr->unique)) != NULL)
4922 DEBUG(D_deliver|D_route)
4923 debug_printf("%s is a duplicate address: discarded\n", addr->unique);
4924 *anchor = addr->next;
4925 addr->dupof = tnode->data.ptr;
4926 addr->next = addr_duplicate;
4927 addr_duplicate = addr;
4931 tree_add_duplicate(addr->unique, addr);
4932 anchor = &(addr->next);
4940 /*************************************************
4941 * Deliver one message *
4942 *************************************************/
4944 /* This is the function which is called when a message is to be delivered. It
4945 is passed the id of the message. It is possible that the message no longer
4946 exists, if some other process has delivered it, and it is also possible that
4947 the message is being worked on by another process, in which case the data file
4950 If no delivery is attempted for any of the above reasons, the function returns
4951 DELIVER_NOT_ATTEMPTED.
4953 If the give_up flag is set true, do not attempt any deliveries, but instead
4954 fail all outstanding addresses and return the message to the sender (or
4957 A delivery operation has a process all to itself; we never deliver more than
4958 one message in the same process. Therefore we needn't worry too much about
4962 id the id of the message to be delivered
4963 forced TRUE if delivery was forced by an administrator; this overrides
4964 retry delays and causes a delivery to be tried regardless
4965 give_up TRUE if an administrator has requested that delivery attempts
4968 Returns: When the global variable mua_wrapper is FALSE:
4969 DELIVER_ATTEMPTED_NORMAL if a delivery attempt was made
4970 DELIVER_NOT_ATTEMPTED otherwise (see comment above)
4971 When the global variable mua_wrapper is TRUE:
4972 DELIVER_MUA_SUCCEEDED if delivery succeeded
4973 DELIVER_MUA_FAILED if delivery failed
4974 DELIVER_NOT_ATTEMPTED if not attempted (should not occur)
4978 deliver_message(uschar *id, BOOL forced, BOOL give_up)
4981 int final_yield = DELIVER_ATTEMPTED_NORMAL;
4982 time_t now = time(NULL);
4983 address_item *addr_last = NULL;
4984 uschar *filter_message = NULL;
4986 int process_recipients = RECIP_ACCEPT;
4989 extern int acl_where;
4991 uschar *info = (queue_run_pid == (pid_t)0)?
4992 string_sprintf("delivering %s", id) :
4993 string_sprintf("delivering %s (queue run pid %d)", id, queue_run_pid);
4995 /* If the D_process_info bit is on, set_process_info() will output debugging
4996 information. If not, we want to show this initial information if D_deliver or
4997 D_queue_run is set or in verbose mode. */
4999 set_process_info("%s", info);
5001 if ((debug_selector & D_process_info) == 0 &&
5002 (debug_selector & (D_deliver|D_queue_run|D_v)) != 0)
5003 debug_printf("%s\n", info);
5005 /* Ensure that we catch any subprocesses that are created. Although Exim
5006 sets SIG_DFL as its initial default, some routes through the code end up
5007 here with it set to SIG_IGN - cases where a non-synchronous delivery process
5008 has been forked, but no re-exec has been done. We use sigaction rather than
5009 plain signal() on those OS where SA_NOCLDWAIT exists, because we want to be
5010 sure it is turned off. (There was a problem on AIX with this.) */
5014 struct sigaction act;
5015 act.sa_handler = SIG_DFL;
5016 sigemptyset(&(act.sa_mask));
5018 sigaction(SIGCHLD, &act, NULL);
5021 signal(SIGCHLD, SIG_DFL);
5024 /* Make the forcing flag available for routers and transports, set up the
5025 global message id field, and initialize the count for returned files and the
5026 message size. This use of strcpy() is OK because the length id is checked when
5027 it is obtained from a command line (the -M or -q options), and otherwise it is
5028 known to be a valid message id. */
5030 Ustrcpy(message_id, id);
5031 deliver_force = forced;
5035 /* Initialize some flags */
5037 update_spool = FALSE;
5038 remove_journal = TRUE;
5040 /* Set a known context for any ACLs we call via expansions */
5041 acl_where = ACL_WHERE_DELIVERY;
5043 /* Reset the random number generator, so that if several delivery processes are
5044 started from a queue runner that has already used random numbers (for sorting),
5045 they don't all get the same sequence. */
5049 /* Open and lock the message's data file. Exim locks on this one because the
5050 header file may get replaced as it is re-written during the delivery process.
5051 Any failures cause messages to be written to the log, except for missing files
5052 while queue running - another process probably completed delivery. As part of
5053 opening the data file, message_subdir gets set. */
5055 if (!spool_open_datafile(id))
5056 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5058 /* The value of message_size at this point has been set to the data length,
5059 plus one for the blank line that notionally precedes the data. */
5061 /* Now read the contents of the header file, which will set up the headers in
5062 store, and also the list of recipients and the tree of non-recipients and
5063 assorted flags. It updates message_size. If there is a reading or format error,
5064 give up; if the message has been around for sufficiently long, remove it. */
5066 sprintf(CS spoolname, "%s-H", id);
5067 if ((rc = spool_read_header(spoolname, TRUE, TRUE)) != spool_read_OK)
5069 if (errno == ERRNO_SPOOLFORMAT)
5071 struct stat statbuf;
5072 sprintf(CS big_buffer, "%s/input/%s/%s", spool_directory, message_subdir,
5074 if (Ustat(big_buffer, &statbuf) == 0)
5075 log_write(0, LOG_MAIN, "Format error in spool file %s: "
5076 "size=" OFF_T_FMT, spoolname, statbuf.st_size);
5077 else log_write(0, LOG_MAIN, "Format error in spool file %s", spoolname);
5080 log_write(0, LOG_MAIN, "Error reading spool file %s: %s", spoolname,
5083 /* If we managed to read the envelope data, received_time contains the
5084 time the message was received. Otherwise, we can calculate it from the
5087 if (rc != spool_read_hdrerror)
5090 for (i = 0; i < 6; i++)
5091 received_time = received_time * BASE_62 + tab62[id[i] - '0'];
5094 /* If we've had this malformed message too long, sling it. */
5096 if (now - received_time > keep_malformed)
5098 sprintf(CS spoolname, "%s/msglog/%s/%s", spool_directory, message_subdir, id);
5100 sprintf(CS spoolname, "%s/input/%s/%s-D", spool_directory, message_subdir, id);
5102 sprintf(CS spoolname, "%s/input/%s/%s-H", spool_directory, message_subdir, id);
5104 sprintf(CS spoolname, "%s/input/%s/%s-J", spool_directory, message_subdir, id);
5106 log_write(0, LOG_MAIN, "Message removed because older than %s",
5107 readconf_printtime(keep_malformed));
5110 (void)close(deliver_datafile);
5111 deliver_datafile = -1;
5112 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5115 /* The spool header file has been read. Look to see if there is an existing
5116 journal file for this message. If there is, it means that a previous delivery
5117 attempt crashed (program or host) before it could update the spool header file.
5118 Read the list of delivered addresses from the journal and add them to the
5119 nonrecipients tree. Then update the spool file. We can leave the journal in
5120 existence, as it will get further successful deliveries added to it in this
5121 run, and it will be deleted if this function gets to its end successfully.
5122 Otherwise it might be needed again. */
5124 sprintf(CS spoolname, "%s/input/%s/%s-J", spool_directory, message_subdir, id);
5125 jread = Ufopen(spoolname, "rb");
5128 while (Ufgets(big_buffer, big_buffer_size, jread) != NULL)
5130 int n = Ustrlen(big_buffer);
5131 big_buffer[n-1] = 0;
5132 tree_add_nonrecipient(big_buffer);
5133 DEBUG(D_deliver) debug_printf("Previously delivered address %s taken from "
5134 "journal file\n", big_buffer);
5136 (void)fclose(jread);
5137 /* Panic-dies on error */
5138 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
5140 else if (errno != ENOENT)
5142 log_write(0, LOG_MAIN|LOG_PANIC, "attempt to open journal for reading gave: "
5143 "%s", strerror(errno));
5144 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5147 /* A null recipients list indicates some kind of disaster. */
5149 if (recipients_list == NULL)
5151 (void)close(deliver_datafile);
5152 deliver_datafile = -1;
5153 log_write(0, LOG_MAIN, "Spool error: no recipients for %s", spoolname);
5154 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5158 /* Handle a message that is frozen. There are a number of different things that
5159 can happen, but in the default situation, unless forced, no delivery is
5164 #ifdef SUPPORT_MOVE_FROZEN_MESSAGES
5165 /* Moving to another directory removes the message from Exim's view. Other
5166 tools must be used to deal with it. Logging of this action happens in
5167 spool_move_message() and its subfunctions. */
5169 if (move_frozen_messages &&
5170 spool_move_message(id, message_subdir, US"", US"F"))
5171 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5174 /* For all frozen messages (bounces or not), timeout_frozen_after sets the
5175 maximum time to keep messages that are frozen. Thaw if we reach it, with a
5176 flag causing all recipients to be failed. The time is the age of the
5177 message, not the time since freezing. */
5179 if (timeout_frozen_after > 0 && message_age >= timeout_frozen_after)
5181 log_write(0, LOG_MAIN, "cancelled by timeout_frozen_after");
5182 process_recipients = RECIP_FAIL_TIMEOUT;
5185 /* For bounce messages (and others with no sender), thaw if the error message
5186 ignore timer is exceeded. The message will be discarded if this delivery
5189 else if (sender_address[0] == 0 && message_age >= ignore_bounce_errors_after)
5191 log_write(0, LOG_MAIN, "Unfrozen by errmsg timer");
5194 /* If this is a bounce message, or there's no auto thaw, or we haven't
5195 reached the auto thaw time yet, and this delivery is not forced by an admin
5196 user, do not attempt delivery of this message. Note that forced is set for
5197 continuing messages down the same channel, in order to skip load checking and
5198 ignore hold domains, but we don't want unfreezing in that case. */
5202 if ((sender_address[0] == 0 ||
5204 now <= deliver_frozen_at + auto_thaw
5207 (!forced || !deliver_force_thaw || !admin_user ||
5208 continue_hostname != NULL
5211 (void)close(deliver_datafile);
5212 deliver_datafile = -1;
5213 log_write(L_skip_delivery, LOG_MAIN, "Message is frozen");
5214 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5217 /* If delivery was forced (by an admin user), assume a manual thaw.
5218 Otherwise it's an auto thaw. */
5222 deliver_manual_thaw = TRUE;
5223 log_write(0, LOG_MAIN, "Unfrozen by forced delivery");
5225 else log_write(0, LOG_MAIN, "Unfrozen by auto-thaw");
5228 /* We get here if any of the rules for unfreezing have triggered. */
5230 deliver_freeze = FALSE;
5231 update_spool = TRUE;
5235 /* Open the message log file if we are using them. This records details of
5236 deliveries, deferments, and failures for the benefit of the mail administrator.
5237 The log is not used by exim itself to track the progress of a message; that is
5238 done by rewriting the header spool file. */
5245 sprintf(CS spoolname, "%s/msglog/%s/%s", spool_directory, message_subdir, id);
5246 fd = open_msglog_file(spoolname, SPOOL_MODE, &error);
5250 log_write(0, LOG_MAIN|LOG_PANIC, "Couldn't %s message log %s: %s", error,
5251 spoolname, strerror(errno));
5252 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5255 /* Make a C stream out of it. */
5257 message_log = fdopen(fd, "a");
5258 if (message_log == NULL)
5260 log_write(0, LOG_MAIN|LOG_PANIC, "Couldn't fdopen message log %s: %s",
5261 spoolname, strerror(errno));
5262 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5267 /* If asked to give up on a message, log who did it, and set the action for all
5272 struct passwd *pw = getpwuid(real_uid);
5273 log_write(0, LOG_MAIN, "cancelled by %s", (pw != NULL)?
5274 US pw->pw_name : string_sprintf("uid %ld", (long int)real_uid));
5275 process_recipients = RECIP_FAIL;
5278 /* Otherwise, if there are too many Received: headers, fail all recipients. */
5280 else if (received_count > received_headers_max)
5281 process_recipients = RECIP_FAIL_LOOP;
5283 /* Otherwise, if a system-wide, address-independent message filter is
5284 specified, run it now, except in the case when we are failing all recipients as
5285 a result of timeout_frozen_after. If the system filter yields "delivered", then
5286 ignore the true recipients of the message. Failure of the filter file is
5287 logged, and the delivery attempt fails. */
5289 else if (system_filter != NULL && process_recipients != RECIP_FAIL_TIMEOUT)
5294 redirect_block redirect;
5296 if (system_filter_uid_set)
5298 ugid.uid = system_filter_uid;
5299 ugid.gid = system_filter_gid;
5300 ugid.uid_set = ugid.gid_set = TRUE;
5304 ugid.uid_set = ugid.gid_set = FALSE;
5307 return_path = sender_address;
5308 enable_dollar_recipients = TRUE; /* Permit $recipients in system filter */
5309 system_filtering = TRUE;
5311 /* Any error in the filter file causes a delivery to be abandoned. */
5313 redirect.string = system_filter;
5314 redirect.isfile = TRUE;
5315 redirect.check_owner = redirect.check_group = FALSE;
5316 redirect.owners = NULL;
5317 redirect.owngroups = NULL;
5319 redirect.modemask = 0;
5321 DEBUG(D_deliver|D_filter) debug_printf("running system filter\n");
5324 &redirect, /* Where the data is */
5325 RDO_DEFER | /* Turn on all the enabling options */
5326 RDO_FAIL | /* Leave off all the disabling options */
5331 NULL, /* No :include: restriction (not used in filter) */
5332 NULL, /* No sieve vacation directory (not sieve!) */
5333 NULL, /* No sieve enotify mailto owner (not sieve!) */
5334 NULL, /* No sieve user address (not sieve!) */
5335 NULL, /* No sieve subaddress (not sieve!) */
5336 &ugid, /* uid/gid data */
5337 &addr_new, /* Where to hang generated addresses */
5338 &filter_message, /* Where to put error message */
5339 NULL, /* Don't skip syntax errors */
5340 &filtertype, /* Will always be set to FILTER_EXIM for this call */
5341 US"system filter"); /* For error messages */
5343 DEBUG(D_deliver|D_filter) debug_printf("system filter returned %d\n", rc);
5345 if (rc == FF_ERROR || rc == FF_NONEXIST)
5347 (void)close(deliver_datafile);
5348 deliver_datafile = -1;
5349 log_write(0, LOG_MAIN|LOG_PANIC, "Error in system filter: %s",
5350 string_printing(filter_message));
5351 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5354 /* Reset things. If the filter message is an empty string, which can happen
5355 for a filter "fail" or "freeze" command with no text, reset it to NULL. */
5357 system_filtering = FALSE;
5358 enable_dollar_recipients = FALSE;
5359 if (filter_message != NULL && filter_message[0] == 0) filter_message = NULL;
5361 /* Save the values of the system filter variables so that user filters
5364 memcpy(filter_sn, filter_n, sizeof(filter_sn));
5366 /* The filter can request that delivery of the original addresses be
5371 process_recipients = RECIP_DEFER;
5372 deliver_msglog("Delivery deferred by system filter\n");
5373 log_write(0, LOG_MAIN, "Delivery deferred by system filter");
5376 /* The filter can request that a message be frozen, but this does not
5377 take place if the message has been manually thawed. In that case, we must
5378 unset "delivered", which is forced by the "freeze" command to make -bF
5381 else if (rc == FF_FREEZE && !deliver_manual_thaw)
5383 deliver_freeze = TRUE;
5384 deliver_frozen_at = time(NULL);
5385 process_recipients = RECIP_DEFER;
5386 frozen_info = string_sprintf(" by the system filter%s%s",
5387 (filter_message == NULL)? US"" : US": ",
5388 (filter_message == NULL)? US"" : filter_message);
5391 /* The filter can request that a message be failed. The error message may be
5392 quite long - it is sent back to the sender in the bounce - but we don't want
5393 to fill up the log with repetitions of it. If it starts with << then the text
5394 between << and >> is written to the log, with the rest left for the bounce
5397 else if (rc == FF_FAIL)
5399 uschar *colon = US"";
5400 uschar *logmsg = US"";
5403 process_recipients = RECIP_FAIL_FILTER;
5405 if (filter_message != NULL)
5409 if (filter_message[0] == '<' && filter_message[1] == '<' &&
5410 (logend = Ustrstr(filter_message, ">>")) != NULL)
5412 logmsg = filter_message + 2;
5413 loglen = logend - logmsg;
5414 filter_message = logend + 2;
5415 if (filter_message[0] == 0) filter_message = NULL;
5419 logmsg = filter_message;
5420 loglen = Ustrlen(filter_message);
5424 log_write(0, LOG_MAIN, "cancelled by system filter%s%.*s", colon, loglen,
5428 /* Delivery can be restricted only to those recipients (if any) that the
5429 filter specified. */
5431 else if (rc == FF_DELIVERED)
5433 process_recipients = RECIP_IGNORE;
5434 if (addr_new == NULL)
5435 log_write(0, LOG_MAIN, "=> discarded (system filter)");
5437 log_write(0, LOG_MAIN, "original recipients ignored (system filter)");
5440 /* If any new addresses were created by the filter, fake up a "parent"
5441 for them. This is necessary for pipes, etc., which are expected to have
5442 parents, and it also gives some sensible logging for others. Allow
5443 pipes, files, and autoreplies, and run them as the filter uid if set,
5444 otherwise as the current uid. */
5446 if (addr_new != NULL)
5448 int uid = (system_filter_uid_set)? system_filter_uid : geteuid();
5449 int gid = (system_filter_gid_set)? system_filter_gid : getegid();
5451 /* The text "system-filter" is tested in transport_set_up_command() and in
5452 set_up_shell_command() in the pipe transport, to enable them to permit
5453 $recipients, so don't change it here without also changing it there. */
5455 address_item *p = addr_new;
5456 address_item *parent = deliver_make_addr(US"system-filter", FALSE);
5458 parent->domain = string_copylc(qualify_domain_recipient);
5459 parent->local_part = US"system-filter";
5461 /* As part of this loop, we arrange for addr_last to end up pointing
5462 at the final address. This is used if we go on to add addresses for the
5463 original recipients. */
5467 if (parent->child_count == SHRT_MAX)
5468 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "system filter generated more "
5469 "than %d delivery addresses", SHRT_MAX);
5470 parent->child_count++;
5473 if (testflag(p, af_pfr))
5479 setflag(p, af_uid_set |
5485 /* Find the name of the system filter's appropriate pfr transport */
5487 if (p->address[0] == '|')
5490 tpname = system_filter_pipe_transport;
5491 address_pipe = p->address;
5493 else if (p->address[0] == '>')
5496 tpname = system_filter_reply_transport;
5500 if (p->address[Ustrlen(p->address)-1] == '/')
5502 type = US"directory";
5503 tpname = system_filter_directory_transport;
5508 tpname = system_filter_file_transport;
5510 address_file = p->address;
5513 /* Now find the actual transport, first expanding the name. We have
5514 set address_file or address_pipe above. */
5518 uschar *tmp = expand_string(tpname);
5519 address_file = address_pipe = NULL;
5521 p->message = string_sprintf("failed to expand \"%s\" as a "
5522 "system filter transport name", tpname);
5527 p->message = string_sprintf("system_filter_%s_transport is unset",
5533 transport_instance *tp;
5534 for (tp = transports; tp != NULL; tp = tp->next)
5536 if (Ustrcmp(tp->name, tpname) == 0)
5543 p->message = string_sprintf("failed to find \"%s\" transport "
5544 "for system filter delivery", tpname);
5547 /* If we couldn't set up a transport, defer the delivery, putting the
5548 error on the panic log as well as the main log. */
5550 if (p->transport == NULL)
5552 address_item *badp = p;
5554 if (addr_last == NULL) addr_new = p; else addr_last->next = p;
5555 badp->local_part = badp->address; /* Needed for log line */
5556 post_process_one(badp, DEFER, LOG_MAIN|LOG_PANIC, DTYPE_ROUTER, 0);
5559 } /* End of pfr handling */
5561 /* Either a non-pfr delivery, or we found a transport */
5563 DEBUG(D_deliver|D_filter)
5564 debug_printf("system filter added %s\n", p->address);
5568 } /* Loop through all addr_new addresses */
5573 /* Scan the recipients list, and for every one that is not in the non-
5574 recipients tree, add an addr item to the chain of new addresses. If the pno
5575 value is non-negative, we must set the onetime parent from it. This which
5576 points to the relevant entry in the recipients list.
5578 This processing can be altered by the setting of the process_recipients
5579 variable, which is changed if recipients are to be ignored, failed, or
5580 deferred. This can happen as a result of system filter activity, or if the -Mg
5581 option is used to fail all of them.
5583 Duplicate addresses are handled later by a different tree structure; we can't
5584 just extend the non-recipients tree, because that will be re-written to the
5585 spool if the message is deferred, and in any case there are casing
5586 complications for local addresses. */
5588 if (process_recipients != RECIP_IGNORE)
5590 for (i = 0; i < recipients_count; i++)
5592 if (tree_search(tree_nonrecipients, recipients_list[i].address) == NULL)
5594 recipient_item *r = recipients_list + i;
5595 address_item *new = deliver_make_addr(r->address, FALSE);
5596 new->p.errors_address = r->errors_to;
5599 new->onetime_parent = recipients_list[r->pno].address;
5601 /* If DSN support is enabled, set the dsn flags and the original receipt
5602 to be passed on to other DSN enabled MTAs */
5603 new->dsn_flags = r->dsn_flags & rf_dsnflags;
5604 new->dsn_orcpt = r->orcpt;
5605 DEBUG(D_deliver) debug_printf("DSN: set orcpt: %s flags: %d\n", new->dsn_orcpt, new->dsn_flags);
5607 switch (process_recipients)
5609 /* RECIP_DEFER is set when a system filter freezes a message. */
5612 new->next = addr_defer;
5617 /* RECIP_FAIL_FILTER is set when a system filter has obeyed a "fail"
5620 case RECIP_FAIL_FILTER:
5622 (filter_message == NULL)? US"delivery cancelled" : filter_message;
5623 setflag(new, af_pass_message);
5624 goto RECIP_QUEUE_FAILED; /* below */
5627 /* RECIP_FAIL_TIMEOUT is set when a message is frozen, but is older
5628 than the value in timeout_frozen_after. Treat non-bounce messages
5629 similarly to -Mg; for bounce messages we just want to discard, so
5630 don't put the address on the failed list. The timeout has already
5633 case RECIP_FAIL_TIMEOUT:
5634 new->message = US"delivery cancelled; message timed out";
5635 goto RECIP_QUEUE_FAILED; /* below */
5638 /* RECIP_FAIL is set when -Mg has been used. */
5641 new->message = US"delivery cancelled by administrator";
5644 /* Common code for the failure cases above. If this is not a bounce
5645 message, put the address on the failed list so that it is used to
5646 create a bounce. Otherwise do nothing - this just discards the address.
5647 The incident has already been logged. */
5650 if (sender_address[0] != 0)
5652 new->next = addr_failed;
5658 /* RECIP_FAIL_LOOP is set when there are too many Received: headers
5659 in the message. Process each address as a routing failure; if this
5660 is a bounce message, it will get frozen. */
5662 case RECIP_FAIL_LOOP:
5663 new->message = US"Too many \"Received\" headers - suspected mail loop";
5664 post_process_one(new, FAIL, LOG_MAIN, DTYPE_ROUTER, 0);
5668 /* Value should be RECIP_ACCEPT; take this as the safe default. */
5671 if (addr_new == NULL) addr_new = new; else addr_last->next = new;
5676 #ifdef EXPERIMENTAL_EVENT
5677 if (process_recipients != RECIP_ACCEPT)
5679 uschar * save_local = deliver_localpart;
5680 const uschar * save_domain = deliver_domain;
5682 deliver_localpart = expand_string(
5683 string_sprintf("${local_part:%s}", new->address));
5684 deliver_domain = expand_string(
5685 string_sprintf("${domain:%s}", new->address));
5687 (void) event_raise(event_action,
5688 US"msg:fail:internal", new->message);
5690 deliver_localpart = save_local;
5691 deliver_domain = save_domain;
5700 address_item *p = addr_new;
5701 debug_printf("Delivery address list:\n");
5704 debug_printf(" %s %s\n", p->address, (p->onetime_parent == NULL)? US"" :
5710 /* Set up the buffers used for copying over the file when delivering. */
5712 deliver_in_buffer = store_malloc(DELIVER_IN_BUFFER_SIZE);
5713 deliver_out_buffer = store_malloc(DELIVER_OUT_BUFFER_SIZE);
5717 /* Until there are no more new addresses, handle each one as follows:
5719 . If this is a generated address (indicated by the presence of a parent
5720 pointer) then check to see whether it is a pipe, file, or autoreply, and
5721 if so, handle it directly here. The router that produced the address will
5722 have set the allow flags into the address, and also set the uid/gid required.
5723 Having the routers generate new addresses and then checking them here at
5724 the outer level is tidier than making each router do the checking, and
5725 means that routers don't need access to the failed address queue.
5727 . Break up the address into local part and domain, and make lowercased
5728 versions of these strings. We also make unquoted versions of the local part.
5730 . Handle the percent hack for those domains for which it is valid.
5732 . For child addresses, determine if any of the parents have the same address.
5733 If so, generate a different string for previous delivery checking. Without
5734 this code, if the address spqr generates spqr via a forward or alias file,
5735 delivery of the generated spqr stops further attempts at the top level spqr,
5736 which is not what is wanted - it may have generated other addresses.
5738 . Check on the retry database to see if routing was previously deferred, but
5739 only if in a queue run. Addresses that are to be routed are put on the
5740 addr_route chain. Addresses that are to be deferred are put on the
5741 addr_defer chain. We do all the checking first, so as not to keep the
5742 retry database open any longer than necessary.
5744 . Now we run the addresses through the routers. A router may put the address
5745 on either the addr_local or the addr_remote chain for local or remote
5746 delivery, respectively, or put it on the addr_failed chain if it is
5747 undeliveable, or it may generate child addresses and put them on the
5748 addr_new chain, or it may defer an address. All the chain anchors are
5749 passed as arguments so that the routers can be called for verification
5752 . If new addresses have been generated by the routers, da capo.
5755 header_rewritten = FALSE; /* No headers rewritten yet */
5756 while (addr_new != NULL) /* Loop until all addresses dealt with */
5758 address_item *addr, *parent;
5759 dbm_file = dbfn_open(US"retry", O_RDONLY, &dbblock, FALSE);
5761 /* Failure to open the retry database is treated the same as if it does
5762 not exist. In both cases, dbm_file is NULL. */
5764 if (dbm_file == NULL)
5766 DEBUG(D_deliver|D_retry|D_route|D_hints_lookup)
5767 debug_printf("no retry data available\n");
5770 /* Scan the current batch of new addresses, to handle pipes, files and
5771 autoreplies, and determine which others are ready for routing. */
5773 while (addr_new != NULL)
5778 dbdata_retry *domain_retry_record;
5779 dbdata_retry *address_retry_record;
5782 addr_new = addr->next;
5784 DEBUG(D_deliver|D_retry|D_route)
5786 debug_printf(">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>\n");
5787 debug_printf("Considering: %s\n", addr->address);
5790 /* Handle generated address that is a pipe or a file or an autoreply. */
5792 if (testflag(addr, af_pfr))
5794 /* If an autoreply in a filter could not generate a syntactically valid
5795 address, give up forthwith. Set af_ignore_error so that we don't try to
5796 generate a bounce. */
5798 if (testflag(addr, af_bad_reply))
5800 addr->basic_errno = ERRNO_BADADDRESS2;
5801 addr->local_part = addr->address;
5803 US"filter autoreply generated syntactically invalid recipient";
5804 setflag(addr, af_ignore_error);
5805 (void)post_process_one(addr, FAIL, LOG_MAIN, DTYPE_ROUTER, 0);
5806 continue; /* with the next new address */
5809 /* If two different users specify delivery to the same pipe or file or
5810 autoreply, there should be two different deliveries, so build a unique
5811 string that incorporates the original address, and use this for
5812 duplicate testing and recording delivery, and also for retrying. */
5815 string_sprintf("%s:%s", addr->address, addr->parent->unique +
5816 (testflag(addr->parent, af_homonym)? 3:0));
5818 addr->address_retry_key = addr->domain_retry_key =
5819 string_sprintf("T:%s", addr->unique);
5821 /* If a filter file specifies two deliveries to the same pipe or file,
5822 we want to de-duplicate, but this is probably not wanted for two mail
5823 commands to the same address, where probably both should be delivered.
5824 So, we have to invent a different unique string in that case. Just
5825 keep piling '>' characters on the front. */
5827 if (addr->address[0] == '>')
5829 while (tree_search(tree_duplicates, addr->unique) != NULL)
5830 addr->unique = string_sprintf(">%s", addr->unique);
5833 else if ((tnode = tree_search(tree_duplicates, addr->unique)) != NULL)
5835 DEBUG(D_deliver|D_route)
5836 debug_printf("%s is a duplicate address: discarded\n", addr->address);
5837 addr->dupof = tnode->data.ptr;
5838 addr->next = addr_duplicate;
5839 addr_duplicate = addr;
5843 DEBUG(D_deliver|D_route) debug_printf("unique = %s\n", addr->unique);
5845 /* Check for previous delivery */
5847 if (tree_search(tree_nonrecipients, addr->unique) != NULL)
5849 DEBUG(D_deliver|D_route)
5850 debug_printf("%s was previously delivered: discarded\n", addr->address);
5851 child_done(addr, tod_stamp(tod_log));
5855 /* Save for checking future duplicates */
5857 tree_add_duplicate(addr->unique, addr);
5859 /* Set local part and domain */
5861 addr->local_part = addr->address;
5862 addr->domain = addr->parent->domain;
5864 /* Ensure that the delivery is permitted. */
5866 if (testflag(addr, af_file))
5868 if (!testflag(addr, af_allow_file))
5870 addr->basic_errno = ERRNO_FORBIDFILE;
5871 addr->message = US"delivery to file forbidden";
5872 (void)post_process_one(addr, FAIL, LOG_MAIN, DTYPE_ROUTER, 0);
5873 continue; /* with the next new address */
5876 else if (addr->address[0] == '|')
5878 if (!testflag(addr, af_allow_pipe))
5880 addr->basic_errno = ERRNO_FORBIDPIPE;
5881 addr->message = US"delivery to pipe forbidden";
5882 (void)post_process_one(addr, FAIL, LOG_MAIN, DTYPE_ROUTER, 0);
5883 continue; /* with the next new address */
5886 else if (!testflag(addr, af_allow_reply))
5888 addr->basic_errno = ERRNO_FORBIDREPLY;
5889 addr->message = US"autoreply forbidden";
5890 (void)post_process_one(addr, FAIL, LOG_MAIN, DTYPE_ROUTER, 0);
5891 continue; /* with the next new address */
5894 /* If the errno field is already set to BADTRANSPORT, it indicates
5895 failure to expand a transport string, or find the associated transport,
5896 or an unset transport when one is required. Leave this test till now so
5897 that the forbid errors are given in preference. */
5899 if (addr->basic_errno == ERRNO_BADTRANSPORT)
5901 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_ROUTER, 0);
5905 /* Treat /dev/null as a special case and abandon the delivery. This
5906 avoids having to specify a uid on the transport just for this case.
5907 Arrange for the transport name to be logged as "**bypassed**". */
5909 if (Ustrcmp(addr->address, "/dev/null") == 0)
5911 uschar *save = addr->transport->name;
5912 addr->transport->name = US"**bypassed**";
5913 (void)post_process_one(addr, OK, LOG_MAIN, DTYPE_TRANSPORT, '=');
5914 addr->transport->name = save;
5915 continue; /* with the next new address */
5918 /* Pipe, file, or autoreply delivery is to go ahead as a normal local
5921 DEBUG(D_deliver|D_route)
5922 debug_printf("queued for %s transport\n", addr->transport->name);
5923 addr->next = addr_local;
5925 continue; /* with the next new address */
5928 /* Handle normal addresses. First, split up into local part and domain,
5929 handling the %-hack if necessary. There is the possibility of a defer from
5930 a lookup in percent_hack_domains. */
5932 if ((rc = deliver_split_address(addr)) == DEFER)
5934 addr->message = US"cannot check percent_hack_domains";
5935 addr->basic_errno = ERRNO_LISTDEFER;
5936 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_NONE, 0);
5940 /* Check to see if the domain is held. If so, proceed only if the
5941 delivery was forced by hand. */
5943 deliver_domain = addr->domain; /* set $domain */
5944 if (!forced && hold_domains != NULL &&
5945 (rc = match_isinlist(addr->domain, (const uschar **)&hold_domains, 0,
5946 &domainlist_anchor, addr->domain_cache, MCL_DOMAIN, TRUE,
5951 addr->message = US"hold_domains lookup deferred";
5952 addr->basic_errno = ERRNO_LISTDEFER;
5956 addr->message = US"domain is held";
5957 addr->basic_errno = ERRNO_HELD;
5959 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_NONE, 0);
5963 /* Now we can check for duplicates and previously delivered addresses. In
5964 order to do this, we have to generate a "unique" value for each address,
5965 because there may be identical actual addresses in a line of descendents.
5966 The "unique" field is initialized to the same value as the "address" field,
5967 but gets changed here to cope with identically-named descendents. */
5969 for (parent = addr->parent; parent != NULL; parent = parent->parent)
5970 if (strcmpic(addr->address, parent->address) == 0) break;
5972 /* If there's an ancestor with the same name, set the homonym flag. This
5973 influences how deliveries are recorded. Then add a prefix on the front of
5974 the unique address. We use \n\ where n starts at 0 and increases each time.
5975 It is unlikely to pass 9, but if it does, it may look odd but will still
5976 work. This means that siblings or cousins with the same names are treated
5977 as duplicates, which is what we want. */
5981 setflag(addr, af_homonym);
5982 if (parent->unique[0] != '\\')
5983 addr->unique = string_sprintf("\\0\\%s", addr->address);
5985 addr->unique = string_sprintf("\\%c\\%s", parent->unique[1] + 1,
5989 /* Ensure that the domain in the unique field is lower cased, because
5990 domains are always handled caselessly. */
5992 p = Ustrrchr(addr->unique, '@');
5993 while (*p != 0) { *p = tolower(*p); p++; }
5995 DEBUG(D_deliver|D_route) debug_printf("unique = %s\n", addr->unique);
5997 if (tree_search(tree_nonrecipients, addr->unique) != NULL)
5999 DEBUG(D_deliver|D_route)
6000 debug_printf("%s was previously delivered: discarded\n", addr->unique);
6001 child_done(addr, tod_stamp(tod_log));
6005 /* Get the routing retry status, saving the two retry keys (with and
6006 without the local part) for subsequent use. If there is no retry record for
6007 the standard address routing retry key, we look for the same key with the
6008 sender attached, because this form is used by the smtp transport after a
6009 4xx response to RCPT when address_retry_include_sender is true. */
6011 addr->domain_retry_key = string_sprintf("R:%s", addr->domain);
6012 addr->address_retry_key = string_sprintf("R:%s@%s", addr->local_part,
6015 if (dbm_file == NULL)
6016 domain_retry_record = address_retry_record = NULL;
6019 domain_retry_record = dbfn_read(dbm_file, addr->domain_retry_key);
6020 if (domain_retry_record != NULL &&
6021 now - domain_retry_record->time_stamp > retry_data_expire)
6022 domain_retry_record = NULL; /* Ignore if too old */
6024 address_retry_record = dbfn_read(dbm_file, addr->address_retry_key);
6025 if (address_retry_record != NULL &&
6026 now - address_retry_record->time_stamp > retry_data_expire)
6027 address_retry_record = NULL; /* Ignore if too old */
6029 if (address_retry_record == NULL)
6031 uschar *altkey = string_sprintf("%s:<%s>", addr->address_retry_key,
6033 address_retry_record = dbfn_read(dbm_file, altkey);
6034 if (address_retry_record != NULL &&
6035 now - address_retry_record->time_stamp > retry_data_expire)
6036 address_retry_record = NULL; /* Ignore if too old */
6040 DEBUG(D_deliver|D_retry)
6042 if (domain_retry_record == NULL)
6043 debug_printf("no domain retry record\n");
6044 if (address_retry_record == NULL)
6045 debug_printf("no address retry record\n");
6048 /* If we are sending a message down an existing SMTP connection, we must
6049 assume that the message which created the connection managed to route
6050 an address to that connection. We do not want to run the risk of taking
6051 a long time over routing here, because if we do, the server at the other
6052 end of the connection may time it out. This is especially true for messages
6053 with lots of addresses. For this kind of delivery, queue_running is not
6054 set, so we would normally route all addresses. We take a pragmatic approach
6055 and defer routing any addresses that have any kind of domain retry record.
6056 That is, we don't even look at their retry times. It doesn't matter if this
6057 doesn't work occasionally. This is all just an optimization, after all.
6059 The reason for not doing the same for address retries is that they normally
6060 arise from 4xx responses, not DNS timeouts. */
6062 if (continue_hostname != NULL && domain_retry_record != NULL)
6064 addr->message = US"reusing SMTP connection skips previous routing defer";
6065 addr->basic_errno = ERRNO_RRETRY;
6066 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_ROUTER, 0);
6069 /* If we are in a queue run, defer routing unless there is no retry data or
6070 we've passed the next retry time, or this message is forced. In other
6071 words, ignore retry data when not in a queue run.
6073 However, if the domain retry time has expired, always allow the routing
6074 attempt. If it fails again, the address will be failed. This ensures that
6075 each address is routed at least once, even after long-term routing
6078 If there is an address retry, check that too; just wait for the next
6079 retry time. This helps with the case when the temporary error on the
6080 address was really message-specific rather than address specific, since
6081 it allows other messages through.
6083 We also wait for the next retry time if this is a message sent down an
6084 existing SMTP connection (even though that will be forced). Otherwise there
6085 will be far too many attempts for an address that gets a 4xx error. In
6086 fact, after such an error, we should not get here because, the host should
6087 not be remembered as one this message needs. However, there was a bug that
6088 used to cause this to happen, so it is best to be on the safe side.
6090 Even if we haven't reached the retry time in the hints, there is one more
6091 check to do, which is for the ultimate address timeout. We only do this
6092 check if there is an address retry record and there is not a domain retry
6093 record; this implies that previous attempts to handle the address had the
6094 retry_use_local_parts option turned on. We use this as an approximation
6095 for the destination being like a local delivery, for example delivery over
6096 LMTP to an IMAP message store. In this situation users are liable to bump
6097 into their quota and thereby have intermittently successful deliveries,
6098 which keep the retry record fresh, which can lead to us perpetually
6099 deferring messages. */
6101 else if (((queue_running && !deliver_force) || continue_hostname != NULL)
6103 ((domain_retry_record != NULL &&
6104 now < domain_retry_record->next_try &&
6105 !domain_retry_record->expired)
6107 (address_retry_record != NULL &&
6108 now < address_retry_record->next_try))
6110 (domain_retry_record != NULL ||
6111 address_retry_record == NULL ||
6112 !retry_ultimate_address_timeout(addr->address_retry_key,
6113 addr->domain, address_retry_record, now)))
6115 addr->message = US"retry time not reached";
6116 addr->basic_errno = ERRNO_RRETRY;
6117 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_ROUTER, 0);
6120 /* The domain is OK for routing. Remember if retry data exists so it
6121 can be cleaned up after a successful delivery. */
6125 if (domain_retry_record != NULL || address_retry_record != NULL)
6126 setflag(addr, af_dr_retry_exists);
6127 addr->next = addr_route;
6129 DEBUG(D_deliver|D_route)
6130 debug_printf("%s: queued for routing\n", addr->address);
6134 /* The database is closed while routing is actually happening. Requests to
6135 update it are put on a chain and all processed together at the end. */
6137 if (dbm_file != NULL) dbfn_close(dbm_file);
6139 /* If queue_domains is set, we don't even want to try routing addresses in
6140 those domains. During queue runs, queue_domains is forced to be unset.
6141 Optimize by skipping this pass through the addresses if nothing is set. */
6143 if (!deliver_force && queue_domains != NULL)
6145 address_item *okaddr = NULL;
6146 while (addr_route != NULL)
6148 address_item *addr = addr_route;
6149 addr_route = addr->next;
6151 deliver_domain = addr->domain; /* set $domain */
6152 if ((rc = match_isinlist(addr->domain, (const uschar **)&queue_domains, 0,
6153 &domainlist_anchor, addr->domain_cache, MCL_DOMAIN, TRUE, NULL))
6158 addr->basic_errno = ERRNO_LISTDEFER;
6159 addr->message = US"queue_domains lookup deferred";
6160 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_ROUTER, 0);
6164 addr->next = okaddr;
6170 addr->basic_errno = ERRNO_QUEUE_DOMAIN;
6171 addr->message = US"domain is in queue_domains";
6172 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_ROUTER, 0);
6176 addr_route = okaddr;
6179 /* Now route those addresses that are not deferred. */
6181 while (addr_route != NULL)
6184 address_item *addr = addr_route;
6185 const uschar *old_domain = addr->domain;
6186 uschar *old_unique = addr->unique;
6187 addr_route = addr->next;
6190 /* Just in case some router parameter refers to it. */
6192 return_path = (addr->p.errors_address != NULL)?
6193 addr->p.errors_address : sender_address;
6195 /* If a router defers an address, add a retry item. Whether or not to
6196 use the local part in the key is a property of the router. */
6198 if ((rc = route_address(addr, &addr_local, &addr_remote, &addr_new,
6199 &addr_succeed, v_none)) == DEFER)
6200 retry_add_item(addr, (addr->router->retry_use_local_part)?
6201 string_sprintf("R:%s@%s", addr->local_part, addr->domain) :
6202 string_sprintf("R:%s", addr->domain), 0);
6204 /* Otherwise, if there is an existing retry record in the database, add
6205 retry items to delete both forms. We must also allow for the possibility
6206 of a routing retry that includes the sender address. Since the domain might
6207 have been rewritten (expanded to fully qualified) as a result of routing,
6208 ensure that the rewritten form is also deleted. */
6210 else if (testflag(addr, af_dr_retry_exists))
6212 uschar *altkey = string_sprintf("%s:<%s>", addr->address_retry_key,
6214 retry_add_item(addr, altkey, rf_delete);
6215 retry_add_item(addr, addr->address_retry_key, rf_delete);
6216 retry_add_item(addr, addr->domain_retry_key, rf_delete);
6217 if (Ustrcmp(addr->domain, old_domain) != 0)
6218 retry_add_item(addr, string_sprintf("R:%s", old_domain), rf_delete);
6221 /* DISCARD is given for :blackhole: and "seen finish". The event has been
6222 logged, but we need to ensure the address (and maybe parents) is marked
6227 address_done(addr, tod_stamp(tod_log));
6228 continue; /* route next address */
6231 /* The address is finished with (failed or deferred). */
6235 (void)post_process_one(addr, rc, LOG_MAIN, DTYPE_ROUTER, 0);
6236 continue; /* route next address */
6239 /* The address has been routed. If the router changed the domain, it will
6240 also have changed the unique address. We have to test whether this address
6241 has already been delivered, because it's the unique address that finally
6244 if (addr->unique != old_unique &&
6245 tree_search(tree_nonrecipients, addr->unique) != 0)
6247 DEBUG(D_deliver|D_route) debug_printf("%s was previously delivered: "
6248 "discarded\n", addr->address);
6249 if (addr_remote == addr) addr_remote = addr->next;
6250 else if (addr_local == addr) addr_local = addr->next;
6253 /* If the router has same_domain_copy_routing set, we are permitted to copy
6254 the routing for any other addresses with the same domain. This is an
6255 optimisation to save repeated DNS lookups for "standard" remote domain
6256 routing. The option is settable only on routers that generate host lists.
6257 We play it very safe, and do the optimization only if the address is routed
6258 to a remote transport, there are no header changes, and the domain was not
6259 modified by the router. */
6261 if (addr_remote == addr &&
6262 addr->router->same_domain_copy_routing &&
6263 addr->p.extra_headers == NULL &&
6264 addr->p.remove_headers == NULL &&
6265 old_domain == addr->domain)
6267 address_item **chain = &addr_route;
6268 while (*chain != NULL)
6270 address_item *addr2 = *chain;
6271 if (Ustrcmp(addr2->domain, addr->domain) != 0)
6273 chain = &(addr2->next);
6277 /* Found a suitable address; take it off the routing list and add it to
6278 the remote delivery list. */
6280 *chain = addr2->next;
6281 addr2->next = addr_remote;
6282 addr_remote = addr2;
6284 /* Copy the routing data */
6286 addr2->domain = addr->domain;
6287 addr2->router = addr->router;
6288 addr2->transport = addr->transport;
6289 addr2->host_list = addr->host_list;
6290 addr2->fallback_hosts = addr->fallback_hosts;
6291 addr2->p.errors_address = addr->p.errors_address;
6292 copyflag(addr2, addr, af_hide_child | af_local_host_removed);
6294 DEBUG(D_deliver|D_route)
6296 debug_printf(">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>\n"
6298 "Routing for %s copied from %s\n",
6299 addr2->address, addr2->address, addr->address);
6303 } /* Continue with routing the next address. */
6304 } /* Loop to process any child addresses that the routers created, and
6305 any rerouted addresses that got put back on the new chain. */
6308 /* Debugging: show the results of the routing */
6310 DEBUG(D_deliver|D_retry|D_route)
6312 address_item *p = addr_local;
6313 debug_printf(">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>\n");
6314 debug_printf("After routing:\n Local deliveries:\n");
6317 debug_printf(" %s\n", p->address);
6322 debug_printf(" Remote deliveries:\n");
6325 debug_printf(" %s\n", p->address);
6330 debug_printf(" Failed addresses:\n");
6333 debug_printf(" %s\n", p->address);
6338 debug_printf(" Deferred addresses:\n");
6341 debug_printf(" %s\n", p->address);
6346 /* Free any resources that were cached during routing. */
6351 /* These two variables are set only during routing, after check_local_user.
6352 Ensure they are not set in transports. */
6354 local_user_gid = (gid_t)(-1);
6355 local_user_uid = (uid_t)(-1);
6357 /* Check for any duplicate addresses. This check is delayed until after
6358 routing, because the flexibility of the routing configuration means that
6359 identical addresses with different parentage may end up being redirected to
6360 different addresses. Checking for duplicates too early (as we previously used
6361 to) makes this kind of thing not work. */
6363 do_duplicate_check(&addr_local);
6364 do_duplicate_check(&addr_remote);
6366 /* When acting as an MUA wrapper, we proceed only if all addresses route to a
6367 remote transport. The check that they all end up in one transaction happens in
6368 the do_remote_deliveries() function. */
6370 if (mua_wrapper && (addr_local != NULL || addr_failed != NULL ||
6371 addr_defer != NULL))
6374 uschar *which, *colon, *msg;
6376 if (addr_local != NULL)
6381 else if (addr_defer != NULL)
6384 which = US"deferred";
6392 while (addr->parent != NULL) addr = addr->parent;
6394 if (addr->message != NULL)
6397 msg = addr->message;
6399 else colon = msg = US"";
6401 /* We don't need to log here for a forced failure as it will already
6402 have been logged. Defer will also have been logged, but as a defer, so we do
6403 need to do the failure logging. */
6405 if (addr != addr_failed)
6406 log_write(0, LOG_MAIN, "** %s routing yielded a %s delivery",
6407 addr->address, which);
6409 /* Always write an error to the caller */
6411 fprintf(stderr, "routing %s yielded a %s delivery%s%s\n", addr->address,
6414 final_yield = DELIVER_MUA_FAILED;
6415 addr_failed = addr_defer = NULL; /* So that we remove the message */
6416 goto DELIVERY_TIDYUP;
6420 /* If this is a run to continue deliveries to an external channel that is
6421 already set up, defer any local deliveries. */
6423 if (continue_transport != NULL)
6425 if (addr_defer == NULL) addr_defer = addr_local; else
6427 address_item *addr = addr_defer;
6428 while (addr->next != NULL) addr = addr->next;
6429 addr->next = addr_local;
6435 /* Because address rewriting can happen in the routers, we should not really do
6436 ANY deliveries until all addresses have been routed, so that all recipients of
6437 the message get the same headers. However, this is in practice not always
6438 possible, since sometimes remote addresses give DNS timeouts for days on end.
6439 The pragmatic approach is to deliver what we can now, saving any rewritten
6440 headers so that at least the next lot of recipients benefit from the rewriting
6441 that has already been done.
6443 If any headers have been rewritten during routing, update the spool file to
6444 remember them for all subsequent deliveries. This can be delayed till later if
6445 there is only address to be delivered - if it succeeds the spool write need not
6448 if (header_rewritten &&
6449 ((addr_local != NULL &&
6450 (addr_local->next != NULL || addr_remote != NULL)) ||
6451 (addr_remote != NULL && addr_remote->next != NULL)))
6453 /* Panic-dies on error */
6454 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
6455 header_rewritten = FALSE;
6459 /* If there are any deliveries to be done, open the journal file. This is used
6460 to record successful deliveries as soon as possible after each delivery is
6461 known to be complete. A file opened with O_APPEND is used so that several
6462 processes can run simultaneously.
6464 The journal is just insurance against crashes. When the spool file is
6465 ultimately updated at the end of processing, the journal is deleted. If a
6466 journal is found to exist at the start of delivery, the addresses listed
6467 therein are added to the non-recipients. */
6469 if (addr_local != NULL || addr_remote != NULL)
6471 sprintf(CS spoolname, "%s/input/%s/%s-J", spool_directory, message_subdir, id);
6472 journal_fd = Uopen(spoolname, O_WRONLY|O_APPEND|O_CREAT, SPOOL_MODE);
6476 log_write(0, LOG_MAIN|LOG_PANIC, "Couldn't open journal file %s: %s",
6477 spoolname, strerror(errno));
6478 return DELIVER_NOT_ATTEMPTED;
6481 /* Set the close-on-exec flag, make the file owned by Exim, and ensure
6482 that the mode is correct - the group setting doesn't always seem to get
6483 set automatically. */
6485 if( fcntl(journal_fd, F_SETFD, fcntl(journal_fd, F_GETFD) | FD_CLOEXEC)
6486 || fchown(journal_fd, exim_uid, exim_gid)
6487 || fchmod(journal_fd, SPOOL_MODE)
6490 int ret = Uunlink(spoolname);
6491 log_write(0, LOG_MAIN|LOG_PANIC, "Couldn't set perms on journal file %s: %s",
6492 spoolname, strerror(errno));
6493 if(ret && errno != ENOENT)
6494 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s",
6495 spoolname, strerror(errno));
6496 return DELIVER_NOT_ATTEMPTED;
6502 /* Now we can get down to the business of actually doing deliveries. Local
6503 deliveries are done first, then remote ones. If ever the problems of how to
6504 handle fallback transports are figured out, this section can be put into a loop
6505 for handling fallbacks, though the uid switching will have to be revised. */
6507 /* Precompile a regex that is used to recognize a parameter in response
6508 to an LHLO command, if is isn't already compiled. This may be used on both
6509 local and remote LMTP deliveries. */
6511 if (regex_IGNOREQUOTA == NULL) regex_IGNOREQUOTA =
6512 regex_must_compile(US"\\n250[\\s\\-]IGNOREQUOTA(\\s|\\n|$)", FALSE, TRUE);
6514 /* Handle local deliveries */
6516 if (addr_local != NULL)
6518 DEBUG(D_deliver|D_transport)
6519 debug_printf(">>>>>>>>>>>>>>>> Local deliveries >>>>>>>>>>>>>>>>\n");
6520 do_local_deliveries();
6521 disable_logging = FALSE;
6524 /* If queue_run_local is set, we do not want to attempt any remote deliveries,
6525 so just queue them all. */
6527 if (queue_run_local)
6529 while (addr_remote != NULL)
6531 address_item *addr = addr_remote;
6532 addr_remote = addr->next;
6534 addr->basic_errno = ERRNO_LOCAL_ONLY;
6535 addr->message = US"remote deliveries suppressed";
6536 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_TRANSPORT, 0);
6540 /* Handle remote deliveries */
6542 if (addr_remote != NULL)
6544 DEBUG(D_deliver|D_transport)
6545 debug_printf(">>>>>>>>>>>>>>>> Remote deliveries >>>>>>>>>>>>>>>>\n");
6547 /* Precompile some regex that are used to recognize parameters in response
6548 to an EHLO command, if they aren't already compiled. */
6552 /* Now sort the addresses if required, and do the deliveries. The yield of
6553 do_remote_deliveries is FALSE when mua_wrapper is set and all addresses
6554 cannot be delivered in one transaction. */
6556 if (remote_sort_domains != NULL) sort_remote_deliveries();
6557 if (!do_remote_deliveries(FALSE))
6559 log_write(0, LOG_MAIN, "** mua_wrapper is set but recipients cannot all "
6560 "be delivered in one transaction");
6561 fprintf(stderr, "delivery to smarthost failed (configuration problem)\n");
6563 final_yield = DELIVER_MUA_FAILED;
6564 addr_failed = addr_defer = NULL; /* So that we remove the message */
6565 goto DELIVERY_TIDYUP;
6568 /* See if any of the addresses that failed got put on the queue for delivery
6569 to their fallback hosts. We do it this way because often the same fallback
6570 host is used for many domains, so all can be sent in a single transaction
6571 (if appropriately configured). */
6573 if (addr_fallback != NULL && !mua_wrapper)
6575 DEBUG(D_deliver) debug_printf("Delivering to fallback hosts\n");
6576 addr_remote = addr_fallback;
6577 addr_fallback = NULL;
6578 if (remote_sort_domains != NULL) sort_remote_deliveries();
6579 do_remote_deliveries(TRUE);
6581 disable_logging = FALSE;
6585 /* All deliveries are now complete. Ignore SIGTERM during this tidying up
6586 phase, to minimize cases of half-done things. */
6589 debug_printf(">>>>>>>>>>>>>>>> deliveries are done >>>>>>>>>>>>>>>>\n");
6591 /* Root privilege is no longer needed */
6593 exim_setugid(exim_uid, exim_gid, FALSE, US"post-delivery tidying");
6595 set_process_info("tidying up after delivering %s", message_id);
6596 signal(SIGTERM, SIG_IGN);
6598 /* When we are acting as an MUA wrapper, the smtp transport will either have
6599 succeeded for all addresses, or failed them all in normal cases. However, there
6600 are some setup situations (e.g. when a named port does not exist) that cause an
6601 immediate exit with deferral of all addresses. Convert those into failures. We
6602 do not ever want to retry, nor do we want to send a bounce message. */
6606 if (addr_defer != NULL)
6608 address_item *addr, *nextaddr;
6609 for (addr = addr_defer; addr != NULL; addr = nextaddr)
6611 log_write(0, LOG_MAIN, "** %s mua_wrapper forced failure for deferred "
6612 "delivery", addr->address);
6613 nextaddr = addr->next;
6614 addr->next = addr_failed;
6620 /* Now all should either have succeeded or failed. */
6622 if (addr_failed == NULL) final_yield = DELIVER_MUA_SUCCEEDED; else
6624 uschar *s = (addr_failed->user_message != NULL)?
6625 addr_failed->user_message : addr_failed->message;
6628 fprintf(stderr, "Delivery failed: ");
6629 if (addr_failed->basic_errno > 0)
6631 fprintf(stderr, "%s", strerror(addr_failed->basic_errno));
6632 if (s != NULL) fprintf(stderr, ": ");
6634 if ((host = addr_failed->host_used))
6635 fprintf(stderr, "H=%s [%s]: ", host->name, host->address);
6638 if (addr_failed->basic_errno <= 0) fprintf(stderr, "unknown error");
6640 else fprintf(stderr, "%s", CS s);
6641 fprintf(stderr, "\n");
6643 final_yield = DELIVER_MUA_FAILED;
6648 /* In a normal configuration, we now update the retry database. This is done in
6649 one fell swoop at the end in order not to keep opening and closing (and
6650 locking) the database. The code for handling retries is hived off into a
6651 separate module for convenience. We pass it the addresses of the various
6652 chains, because deferred addresses can get moved onto the failed chain if the
6653 retry cutoff time has expired for all alternative destinations. Bypass the
6654 updating of the database if the -N flag is set, which is a debugging thing that
6655 prevents actual delivery. */
6657 else if (!dont_deliver) retry_update(&addr_defer, &addr_failed, &addr_succeed);
6659 /* Send DSN for successful messages */
6660 addr_dsntmp = addr_succeed;
6661 addr_senddsn = NULL;
6663 while(addr_dsntmp != NULL)
6666 debug_printf("DSN: processing router : %s\n", addr_dsntmp->router->name);
6669 debug_printf("DSN: processing successful delivery address: %s\n", addr_dsntmp->address);
6671 /* af_ignore_error not honored here. it's not an error */
6673 DEBUG(D_deliver) debug_printf("DSN: Sender_address: %s\n", sender_address);
6674 DEBUG(D_deliver) debug_printf("DSN: orcpt: %s flags: %d\n", addr_dsntmp->dsn_orcpt, addr_dsntmp->dsn_flags);
6675 DEBUG(D_deliver) debug_printf("DSN: envid: %s ret: %d\n", dsn_envid, dsn_ret);
6676 DEBUG(D_deliver) debug_printf("DSN: Final recipient: %s\n", addr_dsntmp->address);
6677 DEBUG(D_deliver) debug_printf("DSN: Remote SMTP server supports DSN: %d\n", addr_dsntmp->dsn_aware);
6679 /* send report if next hop not DSN aware or a router flagged "last DSN hop"
6680 and a report was requested */
6681 if (((addr_dsntmp->dsn_aware != dsn_support_yes) ||
6682 ((addr_dsntmp->dsn_flags & rf_dsnlasthop) != 0))
6684 (((addr_dsntmp->dsn_flags & rf_dsnflags) != 0) &&
6685 ((addr_dsntmp->dsn_flags & rf_notify_success) != 0)))
6687 /* copy and relink address_item and send report with all of them at once later */
6688 address_item *addr_next;
6689 addr_next = addr_senddsn;
6690 addr_senddsn = store_get(sizeof(address_item));
6691 memcpy(addr_senddsn, addr_dsntmp, sizeof(address_item));
6692 addr_senddsn->next = addr_next;
6696 DEBUG(D_deliver) debug_printf("DSN: *** NOT SENDING DSN SUCCESS Message ***\n");
6699 addr_dsntmp = addr_dsntmp->next;
6702 if (addr_senddsn != NULL)
6707 /* create exim process to send message */
6708 pid = child_open_exim(&fd);
6710 DEBUG(D_deliver) debug_printf("DSN: child_open_exim returns: %d\n", pid);
6712 if (pid < 0) /* Creation of child failed */
6714 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Process %d (parent %d) failed to "
6715 "create child process to send failure message: %s", getpid(),
6716 getppid(), strerror(errno));
6718 DEBUG(D_deliver) debug_printf("DSN: child_open_exim failed\n");
6720 else /* Creation of child succeeded */
6722 FILE *f = fdopen(fd, "wb");
6723 /* header only as required by RFC. only failure DSN needs to honor RET=FULL */
6724 int topt = topt_add_return_path | topt_no_body;
6728 debug_printf("sending error message to: %s\n", sender_address);
6730 /* build unique id for MIME boundary */
6731 bound = string_sprintf(TIME_T_FMT "-eximdsn-%d", time(NULL), rand());
6732 DEBUG(D_deliver) debug_printf("DSN: MIME boundary: %s\n", bound);
6734 if (errors_reply_to)
6735 fprintf(f, "Reply-To: %s\n", errors_reply_to);
6737 fprintf(f, "Auto-Submitted: auto-generated\n"
6738 "From: Mail Delivery System <Mailer-Daemon@%s>\n"
6740 "Subject: Delivery Status Notification\n"
6741 "Content-Type: multipart/report; report-type=delivery-status; boundary=%s\n"
6742 "MIME-Version: 1.0\n\n"
6745 "Content-type: text/plain; charset=us-ascii\n\n"
6747 "This message was created automatically by mail delivery software.\n"
6748 " ----- The following addresses had successful delivery notifications -----\n",
6749 qualify_domain_sender, sender_address, bound, bound);
6751 for (addr_dsntmp = addr_senddsn; addr_dsntmp;
6752 addr_dsntmp = addr_dsntmp->next)
6753 fprintf(f, "<%s> (relayed %s)\n\n",
6754 addr_dsntmp->address,
6755 (addr_dsntmp->dsn_flags & rf_dsnlasthop) == 1
6756 ? "via non DSN router"
6757 : addr_dsntmp->dsn_aware == dsn_support_no
6758 ? "to non-DSN-aware mailer"
6759 : "via non \"Remote SMTP\" router"
6763 "Content-type: message/delivery-status\n\n"
6764 "Reporting-MTA: dns; %s\n",
6765 bound, smtp_active_hostname);
6768 { /* must be decoded from xtext: see RFC 3461:6.3a */
6770 if (auth_xtextdecode(dsn_envid, &xdec_envid) > 0)
6771 fprintf(f, "Original-Envelope-ID: %s\n", dsn_envid);
6773 fprintf(f, "X-Original-Envelope-ID: error decoding xtext formated ENVID\n");
6777 for (addr_dsntmp = addr_senddsn;
6779 addr_dsntmp = addr_dsntmp->next)
6781 if (addr_dsntmp->dsn_orcpt)
6782 fprintf(f,"Original-Recipient: %s\n", addr_dsntmp->dsn_orcpt);
6784 fprintf(f, "Action: delivered\n"
6785 "Final-Recipient: rfc822;%s\n"
6787 addr_dsntmp->address);
6789 if (addr_dsntmp->host_used && addr_dsntmp->host_used->name)
6790 fprintf(f, "Remote-MTA: dns; %s\nDiagnostic-Code: smtp; 250 Ok\n\n",
6791 addr_dsntmp->host_used->name);
6793 fprintf(f, "Diagnostic-Code: X-Exim; relayed via non %s router\n\n",
6794 (addr_dsntmp->dsn_flags & rf_dsnlasthop) == 1 ? "DSN" : "SMTP");
6797 fprintf(f, "--%s\nContent-type: text/rfc822-headers\n\n", bound);
6800 transport_filter_argv = NULL; /* Just in case */
6801 return_path = sender_address; /* In case not previously set */
6803 /* Write the original email out */
6804 transport_write_message(NULL, fileno(f), topt, 0, NULL, NULL, NULL, NULL, NULL, 0);
6807 fprintf(f,"\n--%s--\n", bound);
6811 rc = child_close(pid, 0); /* Waits for child to close, no timeout */
6815 /* If any addresses failed, we must send a message to somebody, unless
6816 af_ignore_error is set, in which case no action is taken. It is possible for
6817 several messages to get sent if there are addresses with different
6820 while (addr_failed != NULL)
6824 uschar *logtod = tod_stamp(tod_log);
6826 address_item *handled_addr = NULL;
6827 address_item **paddr;
6828 address_item *msgchain = NULL;
6829 address_item **pmsgchain = &msgchain;
6831 /* There are weird cases when logging is disabled in the transport. However,
6832 there may not be a transport (address failed by a router). */
6834 disable_logging = FALSE;
6835 if (addr_failed->transport != NULL)
6836 disable_logging = addr_failed->transport->disable_logging;
6839 debug_printf("processing failed address %s\n", addr_failed->address);
6841 /* There are only two ways an address in a bounce message can get here:
6843 (1) When delivery was initially deferred, but has now timed out (in the call
6844 to retry_update() above). We can detect this by testing for
6845 af_retry_timedout. If the address does not have its own errors address,
6846 we arrange to ignore the error.
6848 (2) If delivery failures for bounce messages are being ignored. We can detect
6849 this by testing for af_ignore_error. This will also be set if a bounce
6850 message has been autothawed and the ignore_bounce_errors_after time has
6851 passed. It might also be set if a router was explicitly configured to
6852 ignore errors (errors_to = "").
6854 If neither of these cases obtains, something has gone wrong. Log the
6855 incident, but then ignore the error. */
6857 if (sender_address[0] == 0 && addr_failed->p.errors_address == NULL)
6859 if (!testflag(addr_failed, af_retry_timedout) &&
6860 !testflag(addr_failed, af_ignore_error))
6862 log_write(0, LOG_MAIN|LOG_PANIC, "internal error: bounce message "
6863 "failure is neither frozen nor ignored (it's been ignored)");
6865 setflag(addr_failed, af_ignore_error);
6868 /* If the first address on the list has af_ignore_error set, just remove
6869 it from the list, throw away any saved message file, log it, and
6870 mark the recipient done. */
6872 if ( testflag(addr_failed, af_ignore_error)
6873 || ( ((addr_failed->dsn_flags & rf_dsnflags) != 0)
6874 && ((addr_failed->dsn_flags & rf_notify_failure) != rf_notify_failure))
6878 addr_failed = addr->next;
6879 if (addr->return_filename != NULL) Uunlink(addr->return_filename);
6881 log_write(0, LOG_MAIN, "%s%s%s%s: error ignored",
6883 !addr->parent ? US"" : US" <",
6884 !addr->parent ? US"" : addr->parent->address,
6885 !addr->parent ? US"" : US">");
6887 address_done(addr, logtod);
6888 child_done(addr, logtod);
6889 /* Panic-dies on error */
6890 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
6893 /* Otherwise, handle the sending of a message. Find the error address for
6894 the first address, then send a message that includes all failed addresses
6895 that have the same error address. Note the bounce_recipient is a global so
6896 that it can be accesssed by $bounce_recipient while creating a customized
6901 bounce_recipient = addr_failed->p.errors_address
6902 ? addr_failed->p.errors_address : sender_address;
6904 /* Make a subprocess to send a message */
6906 if ((pid = child_open_exim(&fd)) < 0)
6907 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Process %d (parent %d) failed to "
6908 "create child process to send failure message: %s", getpid(),
6909 getppid(), strerror(errno));
6911 /* Creation of child succeeded */
6918 uschar *bcc, *emf_text;
6919 FILE *f = fdopen(fd, "wb");
6921 BOOL to_sender = strcmpic(sender_address, bounce_recipient) == 0;
6922 int max = (bounce_return_size_limit/DELIVER_IN_BUFFER_SIZE + 1) *
6923 DELIVER_IN_BUFFER_SIZE;
6925 uschar *dsnlimitmsg;
6926 uschar *dsnnotifyhdr;
6930 debug_printf("sending error message to: %s\n", bounce_recipient);
6932 /* Scan the addresses for all that have the same errors address, removing
6933 them from the addr_failed chain, and putting them on msgchain. */
6935 paddr = &addr_failed;
6936 for (addr = addr_failed; addr != NULL; addr = *paddr)
6937 if (Ustrcmp(bounce_recipient, addr->p.errors_address
6938 ? addr->p.errors_address : sender_address) == 0)
6939 { /* The same - dechain */
6940 *paddr = addr->next;
6943 pmsgchain = &(addr->next);
6946 paddr = &addr->next; /* Not the same; skip */
6948 /* Include X-Failed-Recipients: for automatic interpretation, but do
6949 not let any one header line get too long. We do this by starting a
6950 new header every 50 recipients. Omit any addresses for which the
6951 "hide_child" flag is set. */
6953 for (addr = msgchain; addr != NULL; addr = addr->next)
6955 if (testflag(addr, af_hide_child)) continue;
6962 (rcount++ == 0)? "X-Failed-Recipients: " : ",\n ",
6963 (testflag(addr, af_pfr) && addr->parent != NULL)?
6964 string_printing(addr->parent->address) :
6965 string_printing(addr->address));
6967 if (rcount > 0) fprintf(f, "\n");
6969 /* Output the standard headers */
6971 if (errors_reply_to)
6972 fprintf(f, "Reply-To: %s\n", errors_reply_to);
6973 fprintf(f, "Auto-Submitted: auto-replied\n");
6975 fprintf(f, "To: %s\n", bounce_recipient);
6977 /* generate boundary string and output MIME-Headers */
6978 bound = string_sprintf(TIME_T_FMT "-eximdsn-%d", time(NULL), rand());
6980 fprintf(f, "Content-Type: multipart/report;"
6981 " report-type=delivery-status; boundary=%s\n"
6982 "MIME-Version: 1.0\n",
6985 /* Open a template file if one is provided. Log failure to open, but
6986 carry on - default texts will be used. */
6988 if (bounce_message_file)
6989 if (!(emf = Ufopen(bounce_message_file, "rb")))
6990 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to open %s for error "
6991 "message texts: %s", bounce_message_file, strerror(errno));
6993 /* Quietly copy to configured additional addresses if required. */
6995 if ((bcc = moan_check_errorcopy(bounce_recipient)))
6996 fprintf(f, "Bcc: %s\n", bcc);
6998 /* The texts for the message can be read from a template file; if there
6999 isn't one, or if it is too short, built-in texts are used. The first
7000 emf text is a Subject: and any other headers. */
7002 if ((emf_text = next_emf(emf, US"header")))
7003 fprintf(f, "%s\n", emf_text);
7005 fprintf(f, "Subject: Mail delivery failed%s\n\n",
7006 to_sender? ": returning message to sender" : "");
7008 /* output human readable part as text/plain section */
7010 "Content-type: text/plain; charset=us-ascii\n\n",
7013 if ((emf_text = next_emf(emf, US"intro")))
7014 fprintf(f, "%s", CS emf_text);
7018 /* This message has been reworded several times. It seems to be confusing to
7019 somebody, however it is worded. I have retreated to the original, simple
7021 "This message was created automatically by mail delivery software.\n");
7023 if (bounce_message_text)
7024 fprintf(f, "%s", CS bounce_message_text);
7027 "\nA message that you sent could not be delivered to one or more of its\n"
7028 "recipients. This is a permanent error. The following address(es) failed:\n");
7031 "\nA message sent by\n\n <%s>\n\n"
7032 "could not be delivered to one or more of its recipients. The following\n"
7033 "address(es) failed:\n", sender_address);
7037 /* Process the addresses, leaving them on the msgchain if they have a
7038 file name for a return message. (There has already been a check in
7039 post_process_one() for the existence of data in the message file.) A TRUE
7040 return from print_address_information() means that the address is not
7044 for (addr = msgchain; addr != NULL; addr = *paddr)
7046 if (print_address_information(addr, f, US" ", US"\n ", US""))
7047 print_address_error(addr, f, US"");
7049 /* End the final line for the address */
7053 /* Leave on msgchain if there's a return file. */
7055 if (addr->return_file >= 0)
7057 paddr = &(addr->next);
7061 /* Else save so that we can tick off the recipient when the
7066 *paddr = addr->next;
7067 addr->next = handled_addr;
7068 handled_addr = addr;
7074 /* Get the next text, whether we need it or not, so as to be
7075 positioned for the one after. */
7077 emf_text = next_emf(emf, US"generated text");
7079 /* If there were any file messages passed by the local transports,
7080 include them in the message. Then put the address on the handled chain.
7081 In the case of a batch of addresses that were all sent to the same
7082 transport, the return_file field in all of them will contain the same
7083 fd, and the return_filename field in the *last* one will be set (to the
7084 name of the file). */
7088 address_item *nextaddr;
7091 fprintf(f, "%s", CS emf_text);
7094 "The following text was generated during the delivery "
7095 "attempt%s:\n", (filecount > 1)? "s" : "");
7097 for (addr = msgchain; addr != NULL; addr = nextaddr)
7100 address_item *topaddr = addr;
7102 /* List all the addresses that relate to this file */
7105 while(addr) /* Insurance */
7107 print_address_information(addr, f, US"------ ", US"\n ",
7109 if (addr->return_filename) break;
7114 /* Now copy the file */
7116 fm = Ufopen(addr->return_filename, "rb");
7119 fprintf(f, " +++ Exim error... failed to open text file: %s\n",
7123 while ((ch = fgetc(fm)) != EOF) fputc(ch, f);
7126 Uunlink(addr->return_filename);
7128 /* Can now add to handled chain, first fishing off the next
7129 address on the msgchain. */
7131 nextaddr = addr->next;
7132 addr->next = handled_addr;
7133 handled_addr = topaddr;
7138 /* output machine readable part */
7140 "Content-type: message/delivery-status\n\n"
7141 "Reporting-MTA: dns; %s\n",
7142 bound, smtp_active_hostname);
7146 /* must be decoded from xtext: see RFC 3461:6.3a */
7148 if (auth_xtextdecode(dsn_envid, &xdec_envid) > 0)
7149 fprintf(f, "Original-Envelope-ID: %s\n", dsn_envid);
7151 fprintf(f, "X-Original-Envelope-ID: error decoding xtext formated ENVID\n");
7155 for (addr = handled_addr; addr; addr = addr->next)
7157 fprintf(f, "Action: failed\n"
7158 "Final-Recipient: rfc822;%s\n"
7161 if (addr->host_used && addr->host_used->name)
7163 fprintf(f, "Remote-MTA: dns; %s\n",
7164 addr->host_used->name);
7165 print_dsn_diagnostic_code(addr, f);
7170 /* Now copy the message, trying to give an intelligible comment if
7171 it is too long for it all to be copied. The limit isn't strictly
7172 applied because of the buffering. There is, however, an option
7173 to suppress copying altogether. */
7175 emf_text = next_emf(emf, US"copy");
7178 we ignore the intro text from template and add
7179 the text for bounce_return_size_limit at the end.
7181 bounce_return_message is ignored
7182 in case RET= is defined we honor these values
7183 otherwise bounce_return_body is honored.
7185 bounce_return_size_limit is always honored.
7188 fprintf(f, "--%s\n", bound);
7190 dsnlimitmsg = US"X-Exim-DSN-Information: Due to administrative limits only headers are returned";
7191 dsnnotifyhdr = NULL;
7192 topt = topt_add_return_path;
7194 /* RET=HDRS? top priority */
7195 if (dsn_ret == dsn_ret_hdrs)
7196 topt |= topt_no_body;
7198 /* no full body return at all? */
7199 if (!bounce_return_body)
7201 topt |= topt_no_body;
7202 /* add header if we overrule RET=FULL */
7203 if (dsn_ret == dsn_ret_full)
7204 dsnnotifyhdr = dsnlimitmsg;
7206 /* size limited ... return headers only if limit reached */
7207 else if (bounce_return_size_limit > 0)
7209 struct stat statbuf;
7210 if (fstat(deliver_datafile, &statbuf) == 0 && statbuf.st_size > max)
7212 topt |= topt_no_body;
7213 dsnnotifyhdr = dsnlimitmsg;
7217 fputs(topt & topt_no_body ? "Content-type: text/rfc822-headers\n\n"
7218 : "Content-type: message/rfc822\n\n",
7222 transport_filter_argv = NULL; /* Just in case */
7223 return_path = sender_address; /* In case not previously set */
7224 transport_write_message(NULL, fileno(f), topt,
7225 0, dsnnotifyhdr, NULL, NULL, NULL, NULL, 0);
7228 /* we never add the final text. close the file */
7232 fprintf(f, "\n--%s--\n", bound);
7234 /* Close the file, which should send an EOF to the child process
7235 that is receiving the message. Wait for it to finish. */
7238 rc = child_close(pid, 0); /* Waits for child to close, no timeout */
7240 /* In the test harness, let the child do it's thing first. */
7242 if (running_in_test_harness) millisleep(500);
7244 /* If the process failed, there was some disaster in setting up the
7245 error message. Unless the message is very old, ensure that addr_defer
7246 is non-null, which will have the effect of leaving the message on the
7247 spool. The failed addresses will get tried again next time. However, we
7248 don't really want this to happen too often, so freeze the message unless
7249 there are some genuine deferred addresses to try. To do this we have
7250 to call spool_write_header() here, because with no genuine deferred
7251 addresses the normal code below doesn't get run. */
7256 if (now - received_time < retry_maximum_timeout && addr_defer == NULL)
7258 addr_defer = (address_item *)(+1);
7259 deliver_freeze = TRUE;
7260 deliver_frozen_at = time(NULL);
7261 /* Panic-dies on error */
7262 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
7265 deliver_msglog("Process failed (%d) when writing error message "
7266 "to %s%s", rc, bounce_recipient, s);
7267 log_write(0, LOG_MAIN, "Process failed (%d) when writing error message "
7268 "to %s%s", rc, bounce_recipient, s);
7271 /* The message succeeded. Ensure that the recipients that failed are
7272 now marked finished with on the spool and their parents updated. */
7276 for (addr = handled_addr; addr != NULL; addr = addr->next)
7278 address_done(addr, logtod);
7279 child_done(addr, logtod);
7281 /* Panic-dies on error */
7282 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
7288 disable_logging = FALSE; /* In case left set */
7290 /* Come here from the mua_wrapper case if routing goes wrong */
7294 /* If there are now no deferred addresses, we are done. Preserve the
7295 message log if so configured, and we are using them. Otherwise, sling it.
7296 Then delete the message itself. */
7298 if (addr_defer == NULL)
7302 sprintf(CS spoolname, "%s/msglog/%s/%s", spool_directory, message_subdir,
7304 if (preserve_message_logs)
7307 sprintf(CS big_buffer, "%s/msglog.OLD/%s", spool_directory, id);
7308 if ((rc = Urename(spoolname, big_buffer)) < 0)
7310 (void)directory_make(spool_directory, US"msglog.OLD",
7311 MSGLOG_DIRECTORY_MODE, TRUE);
7312 rc = Urename(spoolname, big_buffer);
7315 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to move %s to the "
7316 "msglog.OLD directory", spoolname);
7319 if (Uunlink(spoolname) < 0)
7320 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s",
7321 spoolname, strerror(errno));
7324 /* Remove the two message files. */
7326 sprintf(CS spoolname, "%s/input/%s/%s-D", spool_directory, message_subdir, id);
7327 if (Uunlink(spoolname) < 0)
7328 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s",
7329 spoolname, strerror(errno));
7330 sprintf(CS spoolname, "%s/input/%s/%s-H", spool_directory, message_subdir, id);
7331 if (Uunlink(spoolname) < 0)
7332 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s",
7333 spoolname, strerror(errno));
7335 /* Log the end of this message, with queue time if requested. */
7337 if ((log_extra_selector & LX_queue_time_overall) != 0)
7338 log_write(0, LOG_MAIN, "Completed QT=%s",
7339 readconf_printtime( (int) ((long)time(NULL) - (long)received_time)) );
7341 log_write(0, LOG_MAIN, "Completed");
7343 /* Unset deliver_freeze so that we won't try to move the spool files further down */
7344 deliver_freeze = FALSE;
7346 #ifdef EXPERIMENTAL_EVENT
7347 (void) event_raise(event_action, US"msg:complete", NULL);
7351 /* If there are deferred addresses, we are keeping this message because it is
7352 not yet completed. Lose any temporary files that were catching output from
7353 pipes for any of the deferred addresses, handle one-time aliases, and see if
7354 the message has been on the queue for so long that it is time to send a warning
7355 message to the sender, unless it is a mailer-daemon. If all deferred addresses
7356 have the same domain, we can set deliver_domain for the expansion of
7357 delay_warning_ condition - if any of them are pipes, files, or autoreplies, use
7358 the parent's domain.
7360 If all the deferred addresses have an error number that indicates "retry time
7361 not reached", skip sending the warning message, because it won't contain the
7362 reason for the delay. It will get sent at the next real delivery attempt.
7363 However, if at least one address has tried, we'd better include all of them in
7366 If we can't make a process to send the message, don't worry.
7368 For mailing list expansions we want to send the warning message to the
7369 mailing list manager. We can't do a perfect job here, as some addresses may
7370 have different errors addresses, but if we take the errors address from
7371 each deferred address it will probably be right in most cases.
7373 If addr_defer == +1, it means there was a problem sending an error message
7374 for failed addresses, and there were no "real" deferred addresses. The value
7375 was set just to keep the message on the spool, so there is nothing to do here.
7378 else if (addr_defer != (address_item *)(+1))
7381 uschar *recipients = US"";
7382 BOOL delivery_attempted = FALSE;
7384 deliver_domain = testflag(addr_defer, af_pfr)?
7385 addr_defer->parent->domain : addr_defer->domain;
7387 for (addr = addr_defer; addr != NULL; addr = addr->next)
7389 address_item *otaddr;
7391 if (addr->basic_errno > ERRNO_RETRY_BASE) delivery_attempted = TRUE;
7393 if (deliver_domain != NULL)
7395 const uschar *d = testflag(addr, af_pfr)
7396 ? addr->parent->domain : addr->domain;
7398 /* The domain may be unset for an address that has never been routed
7399 because the system filter froze the message. */
7401 if (d == NULL || Ustrcmp(d, deliver_domain) != 0) deliver_domain = NULL;
7404 if (addr->return_filename != NULL) Uunlink(addr->return_filename);
7406 /* Handle the case of one-time aliases. If any address in the ancestry
7407 of this one is flagged, ensure it is in the recipients list, suitably
7408 flagged, and that its parent is marked delivered. */
7410 for (otaddr = addr; otaddr != NULL; otaddr = otaddr->parent)
7411 if (otaddr->onetime_parent != NULL) break;
7416 int t = recipients_count;
7418 for (i = 0; i < recipients_count; i++)
7420 uschar *r = recipients_list[i].address;
7421 if (Ustrcmp(otaddr->onetime_parent, r) == 0) t = i;
7422 if (Ustrcmp(otaddr->address, r) == 0) break;
7425 /* Didn't find the address already in the list, and did find the
7426 ultimate parent's address in the list. After adding the recipient,
7427 update the errors address in the recipients list. */
7429 if (i >= recipients_count && t < recipients_count)
7431 DEBUG(D_deliver) debug_printf("one_time: adding %s in place of %s\n",
7432 otaddr->address, otaddr->parent->address);
7433 receive_add_recipient(otaddr->address, t);
7434 recipients_list[recipients_count-1].errors_to = otaddr->p.errors_address;
7435 tree_add_nonrecipient(otaddr->parent->address);
7436 update_spool = TRUE;
7440 /* Except for error messages, ensure that either the errors address for
7441 this deferred address or, if there is none, the sender address, is on the
7442 list of recipients for a warning message. */
7444 if (sender_address[0] != 0)
7446 if (addr->p.errors_address == NULL)
7448 if (Ustrstr(recipients, sender_address) == NULL)
7449 recipients = string_sprintf("%s%s%s", recipients,
7450 (recipients[0] == 0)? "" : ",", sender_address);
7454 if (Ustrstr(recipients, addr->p.errors_address) == NULL)
7455 recipients = string_sprintf("%s%s%s", recipients,
7456 (recipients[0] == 0)? "" : ",", addr->p.errors_address);
7461 /* Send a warning message if the conditions are right. If the condition check
7462 fails because of a lookup defer, there is nothing we can do. The warning
7463 is not sent. Another attempt will be made at the next delivery attempt (if
7467 && delivery_attempted
7468 && ( ((addr_defer->dsn_flags & rf_dsnflags) == 0)
7469 || (addr_defer->dsn_flags & rf_notify_delay) == rf_notify_delay
7471 && delay_warning[1] > 0
7472 && sender_address[0] != 0
7473 && ( delay_warning_condition == NULL
7474 || expand_check_condition(delay_warning_condition,
7475 US"delay_warning", US"option")
7481 int queue_time = time(NULL) - received_time;
7483 /* When running in the test harness, there's an option that allows us to
7484 fudge this time so as to get repeatability of the tests. Take the first
7485 time off the list. In queue runs, the list pointer gets updated in the
7488 if (running_in_test_harness && fudged_queue_times[0] != 0)
7490 int qt = readconf_readtime(fudged_queue_times, '/', FALSE);
7493 DEBUG(D_deliver) debug_printf("fudged queue_times = %s\n",
7494 fudged_queue_times);
7499 /* See how many warnings we should have sent by now */
7501 for (count = 0; count < delay_warning[1]; count++)
7502 if (queue_time < delay_warning[count+2]) break;
7504 show_time = delay_warning[count+1];
7506 if (count >= delay_warning[1])
7509 int last_gap = show_time;
7510 if (count > 1) last_gap -= delay_warning[count];
7511 extra = (queue_time - delay_warning[count+1])/last_gap;
7512 show_time += last_gap * extra;
7518 debug_printf("time on queue = %s\n", readconf_printtime(queue_time));
7519 debug_printf("warning counts: required %d done %d\n", count,
7523 /* We have computed the number of warnings there should have been by now.
7524 If there haven't been enough, send one, and up the count to what it should
7527 if (warning_count < count)
7531 pid_t pid = child_open_exim(&fd);
7537 FILE *f = fdopen(fd, "wb");
7540 if (warn_message_file)
7542 wmf = Ufopen(warn_message_file, "rb");
7544 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to open %s for warning "
7545 "message texts: %s", warn_message_file, strerror(errno));
7548 warnmsg_recipients = recipients;
7549 warnmsg_delay = (queue_time < 120*60)?
7550 string_sprintf("%d minutes", show_time/60):
7551 string_sprintf("%d hours", show_time/3600);
7553 if (errors_reply_to)
7554 fprintf(f, "Reply-To: %s\n", errors_reply_to);
7555 fprintf(f, "Auto-Submitted: auto-replied\n");
7557 fprintf(f, "To: %s\n", recipients);
7559 /* generated boundary string and output MIME-Headers */
7560 bound = string_sprintf(TIME_T_FMT "-eximdsn-%d", time(NULL), rand());
7562 fprintf(f, "Content-Type: multipart/report;"
7563 " report-type=delivery-status; boundary=%s\n"
7564 "MIME-Version: 1.0\n",
7567 if ((wmf_text = next_emf(wmf, US"header")))
7568 fprintf(f, "%s\n", wmf_text);
7570 fprintf(f, "Subject: Warning: message %s delayed %s\n\n",
7571 message_id, warnmsg_delay);
7573 /* output human readable part as text/plain section */
7575 "Content-type: text/plain; charset=us-ascii\n\n",
7578 if ((wmf_text = next_emf(wmf, US"intro")))
7579 fprintf(f, "%s", CS wmf_text);
7583 "This message was created automatically by mail delivery software.\n");
7585 if (Ustrcmp(recipients, sender_address) == 0)
7587 "A message that you sent has not yet been delivered to one or more of its\n"
7588 "recipients after more than ");
7592 "A message sent by\n\n <%s>\n\n"
7593 "has not yet been delivered to one or more of its recipients after more than \n",
7596 fprintf(f, "%s on the queue on %s.\n\n"
7597 "The message identifier is: %s\n",
7598 warnmsg_delay, primary_hostname, message_id);
7600 for (h = header_list; h != NULL; h = h->next)
7601 if (strncmpic(h->text, US"Subject:", 8) == 0)
7602 fprintf(f, "The subject of the message is: %s", h->text + 9);
7603 else if (strncmpic(h->text, US"Date:", 5) == 0)
7604 fprintf(f, "The date of the message is: %s", h->text + 6);
7607 fprintf(f, "The address%s to which the message has not yet been "
7609 !addr_defer->next ? "" : "es",
7610 !addr_defer->next ? "is": "are");
7613 /* List the addresses, with error information if allowed */
7615 /* store addr_defer for machine readable part */
7616 address_item *addr_dsndefer = addr_defer;
7620 address_item *addr = addr_defer;
7621 addr_defer = addr->next;
7622 if (print_address_information(addr, f, US" ", US"\n ", US""))
7623 print_address_error(addr, f, US"Delay reason: ");
7632 if ((wmf_text = next_emf(wmf, US"final")))
7633 fprintf(f, "%s", CS wmf_text);
7639 "No action is required on your part. Delivery attempts will continue for\n"
7640 "some time, and this warning may be repeated at intervals if the message\n"
7641 "remains undelivered. Eventually the mail delivery software will give up,\n"
7642 "and when that happens, the message will be returned to you.\n");
7645 /* output machine readable part */
7646 fprintf(f, "\n--%s\n"
7647 "Content-type: message/delivery-status\n\n"
7648 "Reporting-MTA: dns; %s\n",
7650 smtp_active_hostname);
7655 /* must be decoded from xtext: see RFC 3461:6.3a */
7657 if (auth_xtextdecode(dsn_envid, &xdec_envid) > 0)
7658 fprintf(f,"Original-Envelope-ID: %s\n", dsn_envid);
7660 fprintf(f,"X-Original-Envelope-ID: error decoding xtext formated ENVID\n");
7664 for ( ; addr_dsndefer; addr_dsndefer = addr_dsndefer->next)
7666 if (addr_dsndefer->dsn_orcpt)
7667 fprintf(f, "Original-Recipient: %s\n", addr_dsndefer->dsn_orcpt);
7669 fprintf(f, "Action: delayed\n"
7670 "Final-Recipient: rfc822;%s\n"
7672 addr_dsndefer->address);
7673 if (addr_dsndefer->host_used && addr_dsndefer->host_used->name)
7675 fprintf(f, "Remote-MTA: dns; %s\n",
7676 addr_dsndefer->host_used->name);
7677 print_dsn_diagnostic_code(addr_dsndefer, f);
7683 "Content-type: text/rfc822-headers\n\n",
7687 /* header only as required by RFC. only failure DSN needs to honor RET=FULL */
7688 int topt = topt_add_return_path | topt_no_body;
7689 transport_filter_argv = NULL; /* Just in case */
7690 return_path = sender_address; /* In case not previously set */
7691 /* Write the original email out */
7692 transport_write_message(NULL, fileno(f), topt, 0, NULL, NULL, NULL, NULL, NULL, 0);
7695 fprintf(f,"\n--%s--\n", bound);
7699 /* Close and wait for child process to complete, without a timeout.
7700 If there's an error, don't update the count. */
7703 if (child_close(pid, 0) == 0)
7705 warning_count = count;
7706 update_spool = TRUE; /* Ensure spool rewritten */
7712 /* Clear deliver_domain */
7714 deliver_domain = NULL;
7716 /* If this was a first delivery attempt, unset the first time flag, and
7717 ensure that the spool gets updated. */
7719 if (deliver_firsttime)
7721 deliver_firsttime = FALSE;
7722 update_spool = TRUE;
7725 /* If delivery was frozen and freeze_tell is set, generate an appropriate
7726 message, unless the message is a local error message (to avoid loops). Then
7727 log the freezing. If the text in "frozen_info" came from a system filter,
7728 it has been escaped into printing characters so as not to mess up log lines.
7729 For the "tell" message, we turn \n back into newline. Also, insert a newline
7730 near the start instead of the ": " string. */
7734 if (freeze_tell != NULL && freeze_tell[0] != 0 && !local_error_message)
7736 uschar *s = string_copy(frozen_info);
7737 uschar *ss = Ustrstr(s, " by the system filter: ");
7748 if (*ss == '\\' && ss[1] == 'n')
7755 moan_tell_someone(freeze_tell, addr_defer, US"Message frozen",
7756 "Message %s has been frozen%s.\nThe sender is <%s>.\n", message_id,
7760 /* Log freezing just before we update the -H file, to minimize the chance
7761 of a race problem. */
7763 deliver_msglog("*** Frozen%s\n", frozen_info);
7764 log_write(0, LOG_MAIN, "Frozen%s", frozen_info);
7767 /* If there have been any updates to the non-recipients list, or other things
7768 that get written to the spool, we must now update the spool header file so
7769 that it has the right information for the next delivery attempt. If there
7770 was more than one address being delivered, the header_change update is done
7771 earlier, in case one succeeds and then something crashes. */
7774 debug_printf("delivery deferred: update_spool=%d header_rewritten=%d\n",
7775 update_spool, header_rewritten);
7777 if (update_spool || header_rewritten)
7778 /* Panic-dies on error */
7779 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
7782 /* Finished with the message log. If the message is complete, it will have
7783 been unlinked or renamed above. */
7785 if (message_logs) (void)fclose(message_log);
7787 /* Now we can close and remove the journal file. Its only purpose is to record
7788 successfully completed deliveries asap so that this information doesn't get
7789 lost if Exim (or the machine) crashes. Forgetting about a failed delivery is
7790 not serious, as trying it again is not harmful. The journal might not be open
7791 if all addresses were deferred at routing or directing. Nevertheless, we must
7792 remove it if it exists (may have been lying around from a crash during the
7793 previous delivery attempt). We don't remove the journal if a delivery
7794 subprocess failed to pass back delivery information; this is controlled by
7795 the remove_journal flag. When the journal is left, we also don't move the
7796 message off the main spool if frozen and the option is set. It should get moved
7797 at the next attempt, after the journal has been inspected. */
7799 if (journal_fd >= 0) (void)close(journal_fd);
7803 sprintf(CS spoolname, "%s/input/%s/%s-J", spool_directory, message_subdir, id);
7804 if (Uunlink(spoolname) < 0 && errno != ENOENT)
7805 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s", spoolname,
7808 /* Move the message off the spool if reqested */
7810 #ifdef SUPPORT_MOVE_FROZEN_MESSAGES
7811 if (deliver_freeze && move_frozen_messages)
7812 (void)spool_move_message(id, message_subdir, US"", US"F");
7816 /* Closing the data file frees the lock; if the file has been unlinked it
7817 will go away. Otherwise the message becomes available for another process
7820 (void)close(deliver_datafile);
7821 deliver_datafile = -1;
7822 DEBUG(D_deliver) debug_printf("end delivery of %s\n", id);
7824 /* It is unlikely that there will be any cached resources, since they are
7825 released after routing, and in the delivery subprocesses. However, it's
7826 possible for an expansion for something afterwards (for example,
7827 expand_check_condition) to do a lookup. We must therefore be sure everything is
7831 acl_where = ACL_WHERE_UNKNOWN;
7840 if (!regex_PIPELINING) regex_PIPELINING =
7841 regex_must_compile(US"\\n250[\\s\\-]PIPELINING(\\s|\\n|$)", FALSE, TRUE);
7843 if (!regex_SIZE) regex_SIZE =
7844 regex_must_compile(US"\\n250[\\s\\-]SIZE(\\s|\\n|$)", FALSE, TRUE);
7846 if (!regex_AUTH) regex_AUTH =
7847 regex_must_compile(US"\\n250[\\s\\-]AUTH\\s+([\\-\\w\\s]+)(?:\\n|$)",
7851 if (!regex_STARTTLS) regex_STARTTLS =
7852 regex_must_compile(US"\\n250[\\s\\-]STARTTLS(\\s|\\n|$)", FALSE, TRUE);
7855 #ifndef DISABLE_PRDR
7856 if (!regex_PRDR) regex_PRDR =
7857 regex_must_compile(US"\\n250[\\s\\-]PRDR(\\s|\\n|$)", FALSE, TRUE);
7860 if (!regex_DSN) regex_DSN =
7861 regex_must_compile(US"\\n250[\\s\\-]DSN(\\s|\\n|$)", FALSE, TRUE);
7863 if (!regex_IGNOREQUOTA) regex_IGNOREQUOTA =
7864 regex_must_compile(US"\\n250[\\s\\-]IGNOREQUOTA(\\s|\\n|$)", FALSE, TRUE);
7870 /* End of deliver.c */