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 uschar *p = big_buffer;
916 uschar *ss = addr->message;
918 for (i = 0; i < 256 && ss[i] != 0; i++) /* limit logged amount */
920 if (ss[i] == '\"' || ss[i] == '\\') *p++ = '\\'; /* quote \ and " */
925 s = string_append(s, &size, &ptr, 2, US" C=", big_buffer);
928 /* Time on queue and actual time taken to deliver */
930 if ((log_extra_selector & LX_queue_time) != 0)
931 s = string_append(s, &size, &ptr, 2, US" QT=",
932 readconf_printtime( (int) ((long)time(NULL) - (long)received_time)) );
934 if ((log_extra_selector & LX_deliver_time) != 0)
935 s = string_append(s, &size, &ptr, 2, US" DT=",
936 readconf_printtime(addr->more_errno));
938 /* string_cat() always leaves room for the terminator. Release the
939 store we used to build the line after writing it. */
942 log_write(0, flags, "%s", s);
944 #ifdef EXPERIMENTAL_EVENT
945 if (!msg) msg_event_raise(US"msg:delivery", addr);
948 store_reset(reset_point);
954 /*************************************************
955 * Actions at the end of handling an address *
956 *************************************************/
958 /* This is a function for processing a single address when all that can be done
959 with it has been done.
962 addr points to the address block
963 result the result of the delivery attempt
964 logflags flags for log_write() (LOG_MAIN and/or LOG_PANIC)
965 driver_type indicates which type of driver (transport, or router) was last
966 to process the address
967 logchar '=' or '-' for use when logging deliveries with => or ->
973 post_process_one(address_item *addr, int result, int logflags, int driver_type,
976 uschar *now = tod_stamp(tod_log);
977 uschar *driver_kind = NULL;
978 uschar *driver_name = NULL;
981 int size = 256; /* Used for a temporary, */
982 int ptr = 0; /* expanding buffer, for */
983 uschar *s; /* building log lines; */
984 void *reset_point; /* released afterwards. */
986 DEBUG(D_deliver) debug_printf("post-process %s (%d)\n", addr->address, result);
988 /* Set up driver kind and name for logging. Disable logging if the router or
989 transport has disabled it. */
991 if (driver_type == DTYPE_TRANSPORT)
993 if (addr->transport != NULL)
995 driver_name = addr->transport->name;
996 driver_kind = US" transport";
997 disable_logging = addr->transport->disable_logging;
999 else driver_kind = US"transporting";
1001 else if (driver_type == DTYPE_ROUTER)
1003 if (addr->router != NULL)
1005 driver_name = addr->router->name;
1006 driver_kind = US" router";
1007 disable_logging = addr->router->disable_logging;
1009 else driver_kind = US"routing";
1012 /* If there's an error message set, ensure that it contains only printing
1013 characters - it should, but occasionally things slip in and this at least
1014 stops the log format from getting wrecked. We also scan the message for an LDAP
1015 expansion item that has a password setting, and flatten the password. This is a
1016 fudge, but I don't know a cleaner way of doing this. (If the item is badly
1017 malformed, it won't ever have gone near LDAP.) */
1019 if (addr->message != NULL)
1021 const uschar * s = string_printing(addr->message);
1022 if (s != addr->message)
1023 addr->message = US s;
1024 /* deconst cast ok as string_printing known to have alloc'n'copied */
1025 if (((Ustrstr(addr->message, "failed to expand") != NULL) || (Ustrstr(addr->message, "expansion of ") != NULL)) &&
1026 (Ustrstr(addr->message, "mysql") != NULL ||
1027 Ustrstr(addr->message, "pgsql") != NULL ||
1028 #ifdef EXPERIMENTAL_REDIS
1029 Ustrstr(addr->message, "redis") != NULL ||
1031 Ustrstr(addr->message, "sqlite") != NULL ||
1032 Ustrstr(addr->message, "ldap:") != NULL ||
1033 Ustrstr(addr->message, "ldapdn:") != NULL ||
1034 Ustrstr(addr->message, "ldapm:") != NULL))
1036 addr->message = string_sprintf("Temporary internal error");
1040 /* If we used a transport that has one of the "return_output" options set, and
1041 if it did in fact generate some output, then for return_output we treat the
1042 message as failed if it was not already set that way, so that the output gets
1043 returned to the sender, provided there is a sender to send it to. For
1044 return_fail_output, do this only if the delivery failed. Otherwise we just
1045 unlink the file, and remove the name so that if the delivery failed, we don't
1046 try to send back an empty or unwanted file. The log_output options operate only
1047 on a non-empty file.
1049 In any case, we close the message file, because we cannot afford to leave a
1050 file-descriptor for one address while processing (maybe very many) others. */
1052 if (addr->return_file >= 0 && addr->return_filename != NULL)
1054 BOOL return_output = FALSE;
1055 struct stat statbuf;
1056 (void)EXIMfsync(addr->return_file);
1058 /* If there is no output, do nothing. */
1060 if (fstat(addr->return_file, &statbuf) == 0 && statbuf.st_size > 0)
1062 transport_instance *tb = addr->transport;
1064 /* Handle logging options */
1066 if (tb->log_output || (result == FAIL && tb->log_fail_output) ||
1067 (result == DEFER && tb->log_defer_output))
1070 FILE *f = Ufopen(addr->return_filename, "rb");
1072 log_write(0, LOG_MAIN|LOG_PANIC, "failed to open %s to log output "
1073 "from %s transport: %s", addr->return_filename, tb->name,
1077 s = US Ufgets(big_buffer, big_buffer_size, f);
1080 uschar *p = big_buffer + Ustrlen(big_buffer);
1082 while (p > big_buffer && isspace(p[-1])) p--;
1084 sp = string_printing(big_buffer);
1085 log_write(0, LOG_MAIN, "<%s>: %s transport output: %s",
1086 addr->address, tb->name, sp);
1092 /* Handle returning options, but only if there is an address to return
1095 if (sender_address[0] != 0 || addr->p.errors_address != NULL)
1097 if (tb->return_output)
1099 addr->transport_return = result = FAIL;
1100 if (addr->basic_errno == 0 && addr->message == NULL)
1101 addr->message = US"return message generated";
1102 return_output = TRUE;
1105 if (tb->return_fail_output && result == FAIL) return_output = TRUE;
1109 /* Get rid of the file unless it might be returned, but close it in
1114 Uunlink(addr->return_filename);
1115 addr->return_filename = NULL;
1116 addr->return_file = -1;
1119 (void)close(addr->return_file);
1122 /* The success case happens only after delivery by a transport. */
1126 addr->next = addr_succeed;
1127 addr_succeed = addr;
1129 /* Call address_done() to ensure that we don't deliver to this address again,
1130 and write appropriate things to the message log. If it is a child address, we
1131 call child_done() to scan the ancestors and mark them complete if this is the
1132 last child to complete. */
1134 address_done(addr, now);
1135 DEBUG(D_deliver) debug_printf("%s delivered\n", addr->address);
1137 if (addr->parent == NULL)
1138 deliver_msglog("%s %s: %s%s succeeded\n", now, addr->address,
1139 driver_name, driver_kind);
1142 deliver_msglog("%s %s <%s>: %s%s succeeded\n", now, addr->address,
1143 addr->parent->address, driver_name, driver_kind);
1144 child_done(addr, now);
1147 /* Certificates for logging (via events) */
1149 tls_out.ourcert = addr->ourcert;
1150 addr->ourcert = NULL;
1151 tls_out.peercert = addr->peercert;
1152 addr->peercert = NULL;
1154 tls_out.cipher = addr->cipher;
1155 tls_out.peerdn = addr->peerdn;
1156 tls_out.ocsp = addr->ocsp;
1157 # ifdef EXPERIMENTAL_DANE
1158 tls_out.dane_verified = testflag(addr, af_dane_verified);
1162 delivery_log(LOG_MAIN, addr, logchar, NULL);
1165 if (tls_out.ourcert)
1167 tls_free_cert(tls_out.ourcert);
1168 tls_out.ourcert = NULL;
1170 if (tls_out.peercert)
1172 tls_free_cert(tls_out.peercert);
1173 tls_out.peercert = NULL;
1175 tls_out.cipher = NULL;
1176 tls_out.peerdn = NULL;
1177 tls_out.ocsp = OCSP_NOT_REQ;
1178 # ifdef EXPERIMENTAL_DANE
1179 tls_out.dane_verified = FALSE;
1185 /* Soft failure, or local delivery process failed; freezing may be
1188 else if (result == DEFER || result == PANIC)
1190 if (result == PANIC) logflags |= LOG_PANIC;
1192 /* This puts them on the chain in reverse order. Do not change this, because
1193 the code for handling retries assumes that the one with the retry
1194 information is last. */
1196 addr->next = addr_defer;
1199 /* The only currently implemented special action is to freeze the
1200 message. Logging of this is done later, just before the -H file is
1203 if (addr->special_action == SPECIAL_FREEZE)
1205 deliver_freeze = TRUE;
1206 deliver_frozen_at = time(NULL);
1207 update_spool = TRUE;
1210 /* If doing a 2-stage queue run, we skip writing to either the message
1211 log or the main log for SMTP defers. */
1213 if (!queue_2stage || addr->basic_errno != 0)
1217 /* For errors of the type "retry time not reached" (also remotes skipped
1218 on queue run), logging is controlled by L_retry_defer. Note that this kind
1219 of error number is negative, and all the retry ones are less than any
1222 unsigned int use_log_selector = (addr->basic_errno <= ERRNO_RETRY_BASE)?
1225 /* Build up the line that is used for both the message log and the main
1228 s = reset_point = store_get(size);
1230 /* Create the address string for logging. Must not do this earlier, because
1231 an OK result may be changed to FAIL when a pipe returns text. */
1233 log_address = string_log_address(addr,
1234 (log_write_selector & L_all_parents) != 0, result == OK);
1236 s = string_cat(s, &size, &ptr, log_address, Ustrlen(log_address));
1238 /* Either driver_name contains something and driver_kind contains
1239 " router" or " transport" (note the leading space), or driver_name is
1240 a null string and driver_kind contains "routing" without the leading
1241 space, if all routing has been deferred. When a domain has been held,
1242 so nothing has been done at all, both variables contain null strings. */
1244 if (driver_name == NULL)
1246 if (driver_kind != NULL)
1247 s = string_append(s, &size, &ptr, 2, US" ", driver_kind);
1251 if (driver_kind[1] == 't' && addr->router != NULL)
1252 s = string_append(s, &size, &ptr, 2, US" R=", addr->router->name);
1254 ss[1] = toupper(driver_kind[1]);
1255 s = string_append(s, &size, &ptr, 2, ss, driver_name);
1258 sprintf(CS ss, " defer (%d)", addr->basic_errno);
1259 s = string_cat(s, &size, &ptr, ss, Ustrlen(ss));
1261 if (addr->basic_errno > 0)
1262 s = string_append(s, &size, &ptr, 2, US": ",
1263 US strerror(addr->basic_errno));
1265 if (addr->host_used)
1266 s = string_append(s, &size, &ptr, 5,
1267 US" H=", addr->host_used->name,
1268 US" [", addr->host_used->address, US"]");
1270 if (addr->message != NULL)
1271 s = string_append(s, &size, &ptr, 2, US": ", addr->message);
1275 /* Log the deferment in the message log, but don't clutter it
1276 up with retry-time defers after the first delivery attempt. */
1278 if (deliver_firsttime || addr->basic_errno > ERRNO_RETRY_BASE)
1279 deliver_msglog("%s %s\n", now, s);
1281 /* Write the main log and reset the store */
1283 log_write(use_log_selector, logflags, "== %s", s);
1284 store_reset(reset_point);
1289 /* Hard failure. If there is an address to which an error message can be sent,
1290 put this address on the failed list. If not, put it on the deferred list and
1291 freeze the mail message for human attention. The latter action can also be
1292 explicitly requested by a router or transport. */
1296 /* If this is a delivery error, or a message for which no replies are
1297 wanted, and the message's age is greater than ignore_bounce_errors_after,
1298 force the af_ignore_error flag. This will cause the address to be discarded
1299 later (with a log entry). */
1301 if (sender_address[0] == 0 && message_age >= ignore_bounce_errors_after)
1302 setflag(addr, af_ignore_error);
1304 /* Freeze the message if requested, or if this is a bounce message (or other
1305 message with null sender) and this address does not have its own errors
1306 address. However, don't freeze if errors are being ignored. The actual code
1307 to ignore occurs later, instead of sending a message. Logging of freezing
1308 occurs later, just before writing the -H file. */
1310 if (!testflag(addr, af_ignore_error) &&
1311 (addr->special_action == SPECIAL_FREEZE ||
1312 (sender_address[0] == 0 && addr->p.errors_address == NULL)
1315 frozen_info = (addr->special_action == SPECIAL_FREEZE)? US"" :
1316 (sender_local && !local_error_message)?
1317 US" (message created with -f <>)" : US" (delivery error message)";
1318 deliver_freeze = TRUE;
1319 deliver_frozen_at = time(NULL);
1320 update_spool = TRUE;
1322 /* The address is put on the defer rather than the failed queue, because
1323 the message is being retained. */
1325 addr->next = addr_defer;
1329 /* Don't put the address on the nonrecipients tree yet; wait until an
1330 error message has been successfully sent. */
1334 addr->next = addr_failed;
1338 /* Build up the log line for the message and main logs */
1340 s = reset_point = store_get(size);
1342 /* Create the address string for logging. Must not do this earlier, because
1343 an OK result may be changed to FAIL when a pipe returns text. */
1345 log_address = string_log_address(addr,
1346 (log_write_selector & L_all_parents) != 0, result == OK);
1348 s = string_cat(s, &size, &ptr, log_address, Ustrlen(log_address));
1350 if ((log_extra_selector & LX_sender_on_delivery) != 0)
1351 s = string_append(s, &size, &ptr, 3, US" F=<", sender_address, US">");
1353 /* Return path may not be set if no delivery actually happened */
1355 if (used_return_path != NULL &&
1356 (log_extra_selector & LX_return_path_on_delivery) != 0)
1357 s = string_append(s, &size, &ptr, 3, US" P=<", used_return_path, US">");
1359 if (addr->router != NULL)
1360 s = string_append(s, &size, &ptr, 2, US" R=", addr->router->name);
1361 if (addr->transport != NULL)
1362 s = string_append(s, &size, &ptr, 2, US" T=", addr->transport->name);
1364 if (addr->host_used != NULL)
1365 s = d_hostlog(s, &size, &ptr, addr);
1368 s = d_tlslog(s, &size, &ptr, addr);
1371 if (addr->basic_errno > 0)
1372 s = string_append(s, &size, &ptr, 2, US": ",
1373 US strerror(addr->basic_errno));
1375 if (addr->message != NULL)
1376 s = string_append(s, &size, &ptr, 2, US": ", addr->message);
1380 /* Do the logging. For the message log, "routing failed" for those cases,
1381 just to make it clearer. */
1383 if (driver_name == NULL)
1384 deliver_msglog("%s %s failed for %s\n", now, driver_kind, s);
1386 deliver_msglog("%s %s\n", now, s);
1388 log_write(0, LOG_MAIN, "** %s", s);
1390 #ifdef EXPERIMENTAL_EVENT
1391 msg_event_raise(US"msg:fail:delivery", addr);
1394 store_reset(reset_point);
1397 /* Ensure logging is turned on again in all cases */
1399 disable_logging = FALSE;
1405 /*************************************************
1406 * Address-independent error *
1407 *************************************************/
1409 /* This function is called when there's an error that is not dependent on a
1410 particular address, such as an expansion string failure. It puts the error into
1411 all the addresses in a batch, logs the incident on the main and panic logs, and
1412 clears the expansions. It is mostly called from local_deliver(), but can be
1413 called for a remote delivery via findugid().
1416 logit TRUE if (MAIN+PANIC) logging required
1417 addr the first of the chain of addresses
1419 format format string for error message, or NULL if already set in addr
1420 ... arguments for the format
1426 common_error(BOOL logit, address_item *addr, int code, uschar *format, ...)
1428 address_item *addr2;
1429 addr->basic_errno = code;
1435 va_start(ap, format);
1436 if (!string_vformat(buffer, sizeof(buffer), CS format, ap))
1437 log_write(0, LOG_MAIN|LOG_PANIC_DIE,
1438 "common_error expansion was longer than " SIZE_T_FMT, sizeof(buffer));
1440 addr->message = string_copy(buffer);
1443 for (addr2 = addr->next; addr2 != NULL; addr2 = addr2->next)
1445 addr2->basic_errno = code;
1446 addr2->message = addr->message;
1449 if (logit) log_write(0, LOG_MAIN|LOG_PANIC, "%s", addr->message);
1450 deliver_set_expansions(NULL);
1456 /*************************************************
1457 * Check a "never users" list *
1458 *************************************************/
1460 /* This function is called to check whether a uid is on one of the two "never
1464 uid the uid to be checked
1465 nusers the list to be scanned; the first item in the list is the count
1467 Returns: TRUE if the uid is on the list
1471 check_never_users(uid_t uid, uid_t *nusers)
1474 if (nusers == NULL) return FALSE;
1475 for (i = 1; i <= (int)(nusers[0]); i++) if (nusers[i] == uid) return TRUE;
1481 /*************************************************
1482 * Find uid and gid for a transport *
1483 *************************************************/
1485 /* This function is called for both local and remote deliveries, to find the
1486 uid/gid under which to run the delivery. The values are taken preferentially
1487 from the transport (either explicit or deliver_as_creator), then from the
1488 address (i.e. the router), and if nothing is set, the exim uid/gid are used. If
1489 the resulting uid is on the "never_users" or the "fixed_never_users" list, a
1490 panic error is logged, and the function fails (which normally leads to delivery
1494 addr the address (possibly a chain)
1496 uidp pointer to uid field
1497 gidp pointer to gid field
1498 igfp pointer to the use_initgroups field
1500 Returns: FALSE if failed - error has been set in address(es)
1504 findugid(address_item *addr, transport_instance *tp, uid_t *uidp, gid_t *gidp,
1507 uschar *nuname = NULL;
1508 BOOL gid_set = FALSE;
1510 /* Default initgroups flag comes from the transport */
1512 *igfp = tp->initgroups;
1514 /* First see if there's a gid on the transport, either fixed or expandable.
1515 The expanding function always logs failure itself. */
1522 else if (tp->expand_gid != NULL)
1524 if (route_find_expanded_group(tp->expand_gid, tp->name, US"transport", gidp,
1525 &(addr->message))) gid_set = TRUE;
1528 common_error(FALSE, addr, ERRNO_GIDFAIL, NULL);
1533 /* If the transport did not set a group, see if the router did. */
1535 if (!gid_set && testflag(addr, af_gid_set))
1541 /* Pick up a uid from the transport if one is set. */
1543 if (tp->uid_set) *uidp = tp->uid;
1545 /* Otherwise, try for an expandable uid field. If it ends up as a numeric id,
1546 it does not provide a passwd value from which a gid can be taken. */
1548 else if (tp->expand_uid != NULL)
1551 if (!route_find_expanded_user(tp->expand_uid, tp->name, US"transport", &pw,
1552 uidp, &(addr->message)))
1554 common_error(FALSE, addr, ERRNO_UIDFAIL, NULL);
1557 if (!gid_set && pw != NULL)
1564 /* If the transport doesn't set the uid, test the deliver_as_creator flag. */
1566 else if (tp->deliver_as_creator)
1568 *uidp = originator_uid;
1571 *gidp = originator_gid;
1576 /* Otherwise see if the address specifies the uid and if so, take it and its
1579 else if (testflag(addr, af_uid_set))
1582 *igfp = testflag(addr, af_initgroups);
1585 /* Nothing has specified the uid - default to the Exim user, and group if the
1598 /* If no gid is set, it is a disaster. We default to the Exim gid only if
1599 defaulting to the Exim uid. In other words, if the configuration has specified
1600 a uid, it must also provide a gid. */
1604 common_error(TRUE, addr, ERRNO_GIDFAIL, US"User set without group for "
1605 "%s transport", tp->name);
1609 /* Check that the uid is not on the lists of banned uids that may not be used
1610 for delivery processes. */
1612 if (check_never_users(*uidp, never_users))
1613 nuname = US"never_users";
1614 else if (check_never_users(*uidp, fixed_never_users))
1615 nuname = US"fixed_never_users";
1619 common_error(TRUE, addr, ERRNO_UIDFAIL, US"User %ld set for %s transport "
1620 "is on the %s list", (long int)(*uidp), tp->name, nuname);
1632 /*************************************************
1633 * Check the size of a message for a transport *
1634 *************************************************/
1636 /* Checks that the message isn't too big for the selected transport.
1637 This is called only when it is known that the limit is set.
1641 addr the (first) address being delivered
1644 DEFER expansion failed or did not yield an integer
1645 FAIL message too big
1649 check_message_size(transport_instance *tp, address_item *addr)
1654 deliver_set_expansions(addr);
1655 size_limit = expand_string_integer(tp->message_size_limit, TRUE);
1656 deliver_set_expansions(NULL);
1658 if (expand_string_message != NULL)
1661 if (size_limit == -1)
1662 addr->message = string_sprintf("failed to expand message_size_limit "
1663 "in %s transport: %s", tp->name, expand_string_message);
1665 addr->message = string_sprintf("invalid message_size_limit "
1666 "in %s transport: %s", tp->name, expand_string_message);
1668 else if (size_limit > 0 && message_size > size_limit)
1672 string_sprintf("message is too big (transport limit = %d)",
1681 /*************************************************
1682 * Transport-time check for a previous delivery *
1683 *************************************************/
1685 /* Check that this base address hasn't previously been delivered to its routed
1686 transport. If it has been delivered, mark it done. The check is necessary at
1687 delivery time in order to handle homonymic addresses correctly in cases where
1688 the pattern of redirection changes between delivery attempts (so the unique
1689 fields change). Non-homonymic previous delivery is detected earlier, at routing
1690 time (which saves unnecessary routing).
1693 addr the address item
1694 testing TRUE if testing wanted only, without side effects
1696 Returns: TRUE if previously delivered by the transport
1700 previously_transported(address_item *addr, BOOL testing)
1702 (void)string_format(big_buffer, big_buffer_size, "%s/%s",
1703 addr->unique + (testflag(addr, af_homonym)? 3:0), addr->transport->name);
1705 if (tree_search(tree_nonrecipients, big_buffer) != 0)
1707 DEBUG(D_deliver|D_route|D_transport)
1708 debug_printf("%s was previously delivered (%s transport): discarded\n",
1709 addr->address, addr->transport->name);
1710 if (!testing) child_done(addr, tod_stamp(tod_log));
1719 /******************************************************
1720 * Check for a given header in a header string *
1721 ******************************************************/
1723 /* This function is used when generating quota warnings. The configuration may
1724 specify any header lines it likes in quota_warn_message. If certain of them are
1725 missing, defaults are inserted, so we need to be able to test for the presence
1729 hdr the required header name
1730 hstring the header string
1732 Returns: TRUE the header is in the string
1733 FALSE the header is not in the string
1737 contains_header(uschar *hdr, uschar *hstring)
1739 int len = Ustrlen(hdr);
1740 uschar *p = hstring;
1743 if (strncmpic(p, hdr, len) == 0)
1746 while (*p == ' ' || *p == '\t') p++;
1747 if (*p == ':') return TRUE;
1749 while (*p != 0 && *p != '\n') p++;
1750 if (*p == '\n') p++;
1758 /*************************************************
1759 * Perform a local delivery *
1760 *************************************************/
1762 /* Each local delivery is performed in a separate process which sets its
1763 uid and gid as specified. This is a safer way than simply changing and
1764 restoring using seteuid(); there is a body of opinion that seteuid() cannot be
1765 used safely. From release 4, Exim no longer makes any use of it. Besides, not
1766 all systems have seteuid().
1768 If the uid/gid are specified in the transport_instance, they are used; the
1769 transport initialization must ensure that either both or neither are set.
1770 Otherwise, the values associated with the address are used. If neither are set,
1771 it is a configuration error.
1773 The transport or the address may specify a home directory (transport over-
1774 rides), and if they do, this is set as $home. If neither have set a working
1775 directory, this value is used for that as well. Otherwise $home is left unset
1776 and the cwd is set to "/" - a directory that should be accessible to all users.
1778 Using a separate process makes it more complicated to get error information
1779 back. We use a pipe to pass the return code and also an error code and error
1780 text string back to the parent process.
1783 addr points to an address block for this delivery; for "normal" local
1784 deliveries this is the only address to be delivered, but for
1785 pseudo-remote deliveries (e.g. by batch SMTP to a file or pipe)
1786 a number of addresses can be handled simultaneously, and in this
1787 case addr will point to a chain of addresses with the same
1790 shadowing TRUE if running a shadow transport; this causes output from pipes
1797 deliver_local(address_item *addr, BOOL shadowing)
1799 BOOL use_initgroups;
1802 int status, len, rc;
1805 uschar *working_directory;
1806 address_item *addr2;
1807 transport_instance *tp = addr->transport;
1809 /* Set up the return path from the errors or sender address. If the transport
1810 has its own return path setting, expand it and replace the existing value. */
1812 if(addr->p.errors_address != NULL)
1813 return_path = addr->p.errors_address;
1814 #ifdef EXPERIMENTAL_SRS
1815 else if(addr->p.srs_sender != NULL)
1816 return_path = addr->p.srs_sender;
1819 return_path = sender_address;
1821 if (tp->return_path != NULL)
1823 uschar *new_return_path = expand_string(tp->return_path);
1824 if (new_return_path == NULL)
1826 if (!expand_string_forcedfail)
1828 common_error(TRUE, addr, ERRNO_EXPANDFAIL,
1829 US"Failed to expand return path \"%s\" in %s transport: %s",
1830 tp->return_path, tp->name, expand_string_message);
1834 else return_path = new_return_path;
1837 /* For local deliveries, one at a time, the value used for logging can just be
1838 set directly, once and for all. */
1840 used_return_path = return_path;
1842 /* Sort out the uid, gid, and initgroups flag. If an error occurs, the message
1843 gets put into the address(es), and the expansions are unset, so we can just
1846 if (!findugid(addr, tp, &uid, &gid, &use_initgroups)) return;
1848 /* See if either the transport or the address specifies a home directory. A
1849 home directory set in the address may already be expanded; a flag is set to
1850 indicate that. In other cases we must expand it. */
1852 if ((deliver_home = tp->home_dir) != NULL || /* Set in transport, or */
1853 ((deliver_home = addr->home_dir) != NULL && /* Set in address and */
1854 !testflag(addr, af_home_expanded))) /* not expanded */
1856 uschar *rawhome = deliver_home;
1857 deliver_home = NULL; /* in case it contains $home */
1858 deliver_home = expand_string(rawhome);
1859 if (deliver_home == NULL)
1861 common_error(TRUE, addr, ERRNO_EXPANDFAIL, US"home directory \"%s\" failed "
1862 "to expand for %s transport: %s", rawhome, tp->name,
1863 expand_string_message);
1866 if (*deliver_home != '/')
1868 common_error(TRUE, addr, ERRNO_NOTABSOLUTE, US"home directory path \"%s\" "
1869 "is not absolute for %s transport", deliver_home, tp->name);
1874 /* See if either the transport or the address specifies a current directory,
1875 and if so, expand it. If nothing is set, use the home directory, unless it is
1876 also unset in which case use "/", which is assumed to be a directory to which
1877 all users have access. It is necessary to be in a visible directory for some
1878 operating systems when running pipes, as some commands (e.g. "rm" under Solaris
1879 2.5) require this. */
1881 working_directory = (tp->current_dir != NULL)?
1882 tp->current_dir : addr->current_dir;
1884 if (working_directory != NULL)
1886 uschar *raw = working_directory;
1887 working_directory = expand_string(raw);
1888 if (working_directory == NULL)
1890 common_error(TRUE, addr, ERRNO_EXPANDFAIL, US"current directory \"%s\" "
1891 "failed to expand for %s transport: %s", raw, tp->name,
1892 expand_string_message);
1895 if (*working_directory != '/')
1897 common_error(TRUE, addr, ERRNO_NOTABSOLUTE, US"current directory path "
1898 "\"%s\" is not absolute for %s transport", working_directory, tp->name);
1902 else working_directory = (deliver_home == NULL)? US"/" : deliver_home;
1904 /* If one of the return_output flags is set on the transport, create and open a
1905 file in the message log directory for the transport to write its output onto.
1906 This is mainly used by pipe transports. The file needs to be unique to the
1907 address. This feature is not available for shadow transports. */
1909 if (!shadowing && (tp->return_output || tp->return_fail_output ||
1910 tp->log_output || tp->log_fail_output))
1913 addr->return_filename =
1914 string_sprintf("%s/msglog/%s/%s-%d-%d", spool_directory, message_subdir,
1915 message_id, getpid(), return_count++);
1916 addr->return_file = open_msglog_file(addr->return_filename, 0400, &error);
1917 if (addr->return_file < 0)
1919 common_error(TRUE, addr, errno, US"Unable to %s file for %s transport "
1920 "to return message: %s", error, tp->name, strerror(errno));
1925 /* Create the pipe for inter-process communication. */
1929 common_error(TRUE, addr, ERRNO_PIPEFAIL, US"Creation of pipe failed: %s",
1934 /* Now fork the process to do the real work in the subprocess, but first
1935 ensure that all cached resources are freed so that the subprocess starts with
1936 a clean slate and doesn't interfere with the parent process. */
1940 if ((pid = fork()) == 0)
1942 BOOL replicate = TRUE;
1944 /* Prevent core dumps, as we don't want them in users' home directories.
1945 HP-UX doesn't have RLIMIT_CORE; I don't know how to do this in that
1946 system. Some experimental/developing systems (e.g. GNU/Hurd) may define
1947 RLIMIT_CORE but not support it in setrlimit(). For such systems, do not
1948 complain if the error is "not supported".
1950 There are two scenarios where changing the max limit has an effect. In one,
1951 the user is using a .forward and invoking a command of their choice via pipe;
1952 for these, we do need the max limit to be 0 unless the admin chooses to
1953 permit an increased limit. In the other, the command is invoked directly by
1954 the transport and is under administrator control, thus being able to raise
1955 the limit aids in debugging. So there's no general always-right answer.
1957 Thus we inhibit core-dumps completely but let individual transports, while
1958 still root, re-raise the limits back up to aid debugging. We make the
1959 default be no core-dumps -- few enough people can use core dumps in
1960 diagnosis that it's reasonable to make them something that has to be explicitly requested.
1967 if (setrlimit(RLIMIT_CORE, &rl) < 0)
1969 # ifdef SETRLIMIT_NOT_SUPPORTED
1970 if (errno != ENOSYS && errno != ENOTSUP)
1972 log_write(0, LOG_MAIN|LOG_PANIC, "setrlimit(RLIMIT_CORE) failed: %s",
1977 /* Reset the random number generator, so different processes don't all
1978 have the same sequence. */
1982 /* If the transport has a setup entry, call this first, while still
1983 privileged. (Appendfile uses this to expand quota, for example, while
1984 able to read private files.) */
1986 if (addr->transport->setup != NULL)
1988 switch((addr->transport->setup)(addr->transport, addr, NULL, uid, gid,
1992 addr->transport_return = DEFER;
1996 addr->transport_return = PANIC;
2001 /* Ignore SIGINT and SIGTERM during delivery. Also ignore SIGUSR1, as
2002 when the process becomes unprivileged, it won't be able to write to the
2003 process log. SIGHUP is ignored throughout exim, except when it is being
2006 signal(SIGINT, SIG_IGN);
2007 signal(SIGTERM, SIG_IGN);
2008 signal(SIGUSR1, SIG_IGN);
2010 /* Close the unwanted half of the pipe, and set close-on-exec for the other
2011 half - for transports that exec things (e.g. pipe). Then set the required
2014 (void)close(pfd[pipe_read]);
2015 (void)fcntl(pfd[pipe_write], F_SETFD, fcntl(pfd[pipe_write], F_GETFD) |
2017 exim_setugid(uid, gid, use_initgroups,
2018 string_sprintf("local delivery to %s <%s> transport=%s", addr->local_part,
2019 addr->address, addr->transport->name));
2023 address_item *batched;
2024 debug_printf(" home=%s current=%s\n", deliver_home, working_directory);
2025 for (batched = addr->next; batched != NULL; batched = batched->next)
2026 debug_printf("additional batched address: %s\n", batched->address);
2029 /* Set an appropriate working directory. */
2031 if (Uchdir(working_directory) < 0)
2033 addr->transport_return = DEFER;
2034 addr->basic_errno = errno;
2035 addr->message = string_sprintf("failed to chdir to %s", working_directory);
2038 /* If successful, call the transport */
2043 set_process_info("delivering %s to %s using %s", message_id,
2044 addr->local_part, addr->transport->name);
2046 /* Setting this global in the subprocess means we need never clear it */
2047 transport_name = addr->transport->name;
2049 /* If a transport filter has been specified, set up its argument list.
2050 Any errors will get put into the address, and FALSE yielded. */
2052 if (addr->transport->filter_command != NULL)
2054 ok = transport_set_up_command(&transport_filter_argv,
2055 addr->transport->filter_command,
2056 TRUE, PANIC, addr, US"transport filter", NULL);
2057 transport_filter_timeout = addr->transport->filter_timeout;
2059 else transport_filter_argv = NULL;
2063 debug_print_string(addr->transport->debug_string);
2064 replicate = !(addr->transport->info->code)(addr->transport, addr);
2068 /* Pass the results back down the pipe. If necessary, first replicate the
2069 status in the top address to the others in the batch. The label is the
2070 subject of a goto when a call to the transport's setup function fails. We
2071 pass the pointer to the transport back in case it got changed as a result of
2072 file_format in appendfile. */
2076 if (replicate) replicate_status(addr);
2077 for (addr2 = addr; addr2 != NULL; addr2 = addr2->next)
2080 int local_part_length = Ustrlen(addr2->local_part);
2084 if( (ret = write(pfd[pipe_write], (void *)&(addr2->transport_return), sizeof(int))) != sizeof(int)
2085 || (ret = write(pfd[pipe_write], (void *)&transport_count, sizeof(transport_count))) != sizeof(transport_count)
2086 || (ret = write(pfd[pipe_write], (void *)&(addr2->flags), sizeof(addr2->flags))) != sizeof(addr2->flags)
2087 || (ret = write(pfd[pipe_write], (void *)&(addr2->basic_errno), sizeof(int))) != sizeof(int)
2088 || (ret = write(pfd[pipe_write], (void *)&(addr2->more_errno), sizeof(int))) != sizeof(int)
2089 || (ret = write(pfd[pipe_write], (void *)&(addr2->special_action), sizeof(int))) != sizeof(int)
2090 || (ret = write(pfd[pipe_write], (void *)&(addr2->transport),
2091 sizeof(transport_instance *))) != sizeof(transport_instance *)
2093 /* For a file delivery, pass back the local part, in case the original
2094 was only part of the final delivery path. This gives more complete
2097 || (testflag(addr2, af_file)
2098 && ( (ret = write(pfd[pipe_write], (void *)&local_part_length, sizeof(int))) != sizeof(int)
2099 || (ret = write(pfd[pipe_write], addr2->local_part, local_part_length)) != local_part_length
2103 log_write(0, LOG_MAIN|LOG_PANIC, "Failed writing transport results to pipe: %s\n",
2104 ret == -1 ? strerror(errno) : "short write");
2106 /* Now any messages */
2108 for (i = 0, s = addr2->message; i < 2; i++, s = addr2->user_message)
2110 int message_length = (s == NULL)? 0 : Ustrlen(s) + 1;
2111 if( (ret = write(pfd[pipe_write], (void *)&message_length, sizeof(int))) != sizeof(int)
2112 || (message_length > 0 && (ret = write(pfd[pipe_write], s, message_length)) != message_length)
2114 log_write(0, LOG_MAIN|LOG_PANIC, "Failed writing transport results to pipe: %s\n",
2115 ret == -1 ? strerror(errno) : "short write");
2119 /* OK, this process is now done. Free any cached resources that it opened,
2120 and close the pipe we were writing down before exiting. */
2122 (void)close(pfd[pipe_write]);
2127 /* Back in the main process: panic if the fork did not succeed. This seems
2128 better than returning an error - if forking is failing it is probably best
2129 not to try other deliveries for this message. */
2132 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Fork failed for local delivery to %s",
2135 /* Read the pipe to get the delivery status codes and error messages. Our copy
2136 of the writing end must be closed first, as otherwise read() won't return zero
2137 on an empty pipe. We check that a status exists for each address before
2138 overwriting the address structure. If data is missing, the default DEFER status
2139 will remain. Afterwards, close the reading end. */
2141 (void)close(pfd[pipe_write]);
2143 for (addr2 = addr; addr2 != NULL; addr2 = addr2->next)
2145 len = read(pfd[pipe_read], (void *)&status, sizeof(int));
2151 addr2->transport_return = status;
2152 len = read(pfd[pipe_read], (void *)&transport_count,
2153 sizeof(transport_count));
2154 len = read(pfd[pipe_read], (void *)&(addr2->flags), sizeof(addr2->flags));
2155 len = read(pfd[pipe_read], (void *)&(addr2->basic_errno), sizeof(int));
2156 len = read(pfd[pipe_read], (void *)&(addr2->more_errno), sizeof(int));
2157 len = read(pfd[pipe_read], (void *)&(addr2->special_action), sizeof(int));
2158 len = read(pfd[pipe_read], (void *)&(addr2->transport),
2159 sizeof(transport_instance *));
2161 if (testflag(addr2, af_file))
2163 int local_part_length;
2164 len = read(pfd[pipe_read], (void *)&local_part_length, sizeof(int));
2165 len = read(pfd[pipe_read], (void *)big_buffer, local_part_length);
2166 big_buffer[local_part_length] = 0;
2167 addr2->local_part = string_copy(big_buffer);
2170 for (i = 0, sptr = &(addr2->message); i < 2;
2171 i++, sptr = &(addr2->user_message))
2174 len = read(pfd[pipe_read], (void *)&message_length, sizeof(int));
2175 if (message_length > 0)
2177 len = read(pfd[pipe_read], (void *)big_buffer, message_length);
2178 if (len > 0) *sptr = string_copy(big_buffer);
2185 log_write(0, LOG_MAIN|LOG_PANIC, "failed to read delivery status for %s "
2186 "from delivery subprocess", addr2->unique);
2191 (void)close(pfd[pipe_read]);
2193 /* Unless shadowing, write all successful addresses immediately to the journal
2194 file, to ensure they are recorded asap. For homonymic addresses, use the base
2195 address plus the transport name. Failure to write the journal is panic-worthy,
2196 but don't stop, as it may prove possible subsequently to update the spool file
2197 in order to record the delivery. */
2201 for (addr2 = addr; addr2 != NULL; addr2 = addr2->next)
2203 if (addr2->transport_return != OK) continue;
2205 if (testflag(addr2, af_homonym))
2206 sprintf(CS big_buffer, "%.500s/%s\n", addr2->unique + 3, tp->name);
2208 sprintf(CS big_buffer, "%.500s\n", addr2->unique);
2210 /* In the test harness, wait just a bit to let the subprocess finish off
2211 any debug output etc first. */
2213 if (running_in_test_harness) millisleep(300);
2215 DEBUG(D_deliver) debug_printf("journalling %s", big_buffer);
2216 len = Ustrlen(big_buffer);
2217 if (write(journal_fd, big_buffer, len) != len)
2218 log_write(0, LOG_MAIN|LOG_PANIC, "failed to update journal for %s: %s",
2219 big_buffer, strerror(errno));
2222 /* Ensure the journal file is pushed out to disk. */
2224 if (EXIMfsync(journal_fd) < 0)
2225 log_write(0, LOG_MAIN|LOG_PANIC, "failed to fsync journal: %s",
2229 /* Wait for the process to finish. If it terminates with a non-zero code,
2230 freeze the message (except for SIGTERM, SIGKILL and SIGQUIT), but leave the
2231 status values of all the addresses as they are. Take care to handle the case
2232 when the subprocess doesn't seem to exist. This has been seen on one system
2233 when Exim was called from an MUA that set SIGCHLD to SIG_IGN. When that
2234 happens, wait() doesn't recognize the termination of child processes. Exim now
2235 resets SIGCHLD to SIG_DFL, but this code should still be robust. */
2237 while ((rc = wait(&status)) != pid)
2239 if (rc < 0 && errno == ECHILD) /* Process has vanished */
2241 log_write(0, LOG_MAIN, "%s transport process vanished unexpectedly",
2242 addr->transport->driver_name);
2248 if ((status & 0xffff) != 0)
2250 int msb = (status >> 8) & 255;
2251 int lsb = status & 255;
2252 int code = (msb == 0)? (lsb & 0x7f) : msb;
2253 if (msb != 0 || (code != SIGTERM && code != SIGKILL && code != SIGQUIT))
2254 addr->special_action = SPECIAL_FREEZE;
2255 log_write(0, LOG_MAIN|LOG_PANIC, "%s transport process returned non-zero "
2256 "status 0x%04x: %s %d",
2257 addr->transport->driver_name,
2259 (msb == 0)? "terminated by signal" : "exit code",
2263 /* If SPECIAL_WARN is set in the top address, send a warning message. */
2265 if (addr->special_action == SPECIAL_WARN &&
2266 addr->transport->warn_message != NULL)
2269 uschar *warn_message;
2271 DEBUG(D_deliver) debug_printf("Warning message requested by transport\n");
2273 warn_message = expand_string(addr->transport->warn_message);
2274 if (warn_message == NULL)
2275 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand \"%s\" (warning "
2276 "message for %s transport): %s", addr->transport->warn_message,
2277 addr->transport->name, expand_string_message);
2280 pid_t pid = child_open_exim(&fd);
2283 FILE *f = fdopen(fd, "wb");
2284 if (errors_reply_to != NULL &&
2285 !contains_header(US"Reply-To", warn_message))
2286 fprintf(f, "Reply-To: %s\n", errors_reply_to);
2287 fprintf(f, "Auto-Submitted: auto-replied\n");
2288 if (!contains_header(US"From", warn_message)) moan_write_from(f);
2289 fprintf(f, "%s", CS warn_message);
2291 /* Close and wait for child process to complete, without a timeout. */
2294 (void)child_close(pid, 0);
2298 addr->special_action = SPECIAL_NONE;
2304 /*************************************************
2305 * Do local deliveries *
2306 *************************************************/
2308 /* This function processes the list of addresses in addr_local. True local
2309 deliveries are always done one address at a time. However, local deliveries can
2310 be batched up in some cases. Typically this is when writing batched SMTP output
2311 files for use by some external transport mechanism, or when running local
2312 deliveries over LMTP.
2319 do_local_deliveries(void)
2322 open_db *dbm_file = NULL;
2323 time_t now = time(NULL);
2325 /* Loop until we have exhausted the supply of local deliveries */
2327 while (addr_local != NULL)
2329 time_t delivery_start;
2331 address_item *addr2, *addr3, *nextaddr;
2332 int logflags = LOG_MAIN;
2333 int logchar = dont_deliver? '*' : '=';
2334 transport_instance *tp;
2336 /* Pick the first undelivered address off the chain */
2338 address_item *addr = addr_local;
2339 addr_local = addr->next;
2342 DEBUG(D_deliver|D_transport)
2343 debug_printf("--------> %s <--------\n", addr->address);
2345 /* An internal disaster if there is no transport. Should not occur! */
2347 if ((tp = addr->transport) == NULL)
2349 logflags |= LOG_PANIC;
2350 disable_logging = FALSE; /* Jic */
2352 (addr->router != NULL)?
2353 string_sprintf("No transport set by %s router", addr->router->name)
2355 string_sprintf("No transport set by system filter");
2356 post_process_one(addr, DEFER, logflags, DTYPE_TRANSPORT, 0);
2360 /* Check that this base address hasn't previously been delivered to this
2361 transport. The check is necessary at this point to handle homonymic addresses
2362 correctly in cases where the pattern of redirection changes between delivery
2363 attempts. Non-homonymic previous delivery is detected earlier, at routing
2366 if (previously_transported(addr, FALSE)) continue;
2368 /* There are weird cases where logging is disabled */
2370 disable_logging = tp->disable_logging;
2372 /* Check for batched addresses and possible amalgamation. Skip all the work
2373 if either batch_max <= 1 or there aren't any other addresses for local
2376 if (tp->batch_max > 1 && addr_local != NULL)
2378 int batch_count = 1;
2379 BOOL uses_dom = readconf_depends((driver_instance *)tp, US"domain");
2380 BOOL uses_lp = (testflag(addr, af_pfr) &&
2381 (testflag(addr, af_file) || addr->local_part[0] == '|')) ||
2382 readconf_depends((driver_instance *)tp, US"local_part");
2383 uschar *batch_id = NULL;
2384 address_item **anchor = &addr_local;
2385 address_item *last = addr;
2388 /* Expand the batch_id string for comparison with other addresses.
2389 Expansion failure suppresses batching. */
2391 if (tp->batch_id != NULL)
2393 deliver_set_expansions(addr);
2394 batch_id = expand_string(tp->batch_id);
2395 deliver_set_expansions(NULL);
2396 if (batch_id == NULL)
2398 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand batch_id option "
2399 "in %s transport (%s): %s", tp->name, addr->address,
2400 expand_string_message);
2401 batch_count = tp->batch_max;
2405 /* Until we reach the batch_max limit, pick off addresses which have the
2406 same characteristics. These are:
2409 not previously delivered (see comment about 50 lines above)
2410 same local part if the transport's configuration contains $local_part
2411 or if this is a file or pipe delivery from a redirection
2412 same domain if the transport's configuration contains $domain
2414 same additional headers
2415 same headers to be removed
2416 same uid/gid for running the transport
2417 same first host if a host list is set
2420 while ((next = *anchor) != NULL && batch_count < tp->batch_max)
2423 tp == next->transport &&
2424 !previously_transported(next, TRUE) &&
2425 (addr->flags & (af_pfr|af_file)) == (next->flags & (af_pfr|af_file)) &&
2426 (!uses_lp || Ustrcmp(next->local_part, addr->local_part) == 0) &&
2427 (!uses_dom || Ustrcmp(next->domain, addr->domain) == 0) &&
2428 same_strings(next->p.errors_address, addr->p.errors_address) &&
2429 same_headers(next->p.extra_headers, addr->p.extra_headers) &&
2430 same_strings(next->p.remove_headers, addr->p.remove_headers) &&
2431 same_ugid(tp, addr, next) &&
2432 ((addr->host_list == NULL && next->host_list == NULL) ||
2433 (addr->host_list != NULL && next->host_list != NULL &&
2434 Ustrcmp(addr->host_list->name, next->host_list->name) == 0));
2436 /* If the transport has a batch_id setting, batch_id will be non-NULL
2437 from the expansion outside the loop. Expand for this address and compare.
2438 Expansion failure makes this address ineligible for batching. */
2440 if (ok && batch_id != NULL)
2443 address_item *save_nextnext = next->next;
2444 next->next = NULL; /* Expansion for a single address */
2445 deliver_set_expansions(next);
2446 next->next = save_nextnext;
2447 bid = expand_string(tp->batch_id);
2448 deliver_set_expansions(NULL);
2451 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand batch_id option "
2452 "in %s transport (%s): %s", tp->name, next->address,
2453 expand_string_message);
2456 else ok = (Ustrcmp(batch_id, bid) == 0);
2459 /* Take address into batch if OK. */
2463 *anchor = next->next; /* Include the address */
2469 else anchor = &(next->next); /* Skip the address */
2473 /* We now have one or more addresses that can be delivered in a batch. Check
2474 whether the transport is prepared to accept a message of this size. If not,
2475 fail them all forthwith. If the expansion fails, or does not yield an
2476 integer, defer delivery. */
2478 if (tp->message_size_limit != NULL)
2480 int rc = check_message_size(tp, addr);
2483 replicate_status(addr);
2484 while (addr != NULL)
2487 post_process_one(addr, rc, logflags, DTYPE_TRANSPORT, 0);
2490 continue; /* With next batch of addresses */
2494 /* If we are not running the queue, or if forcing, all deliveries will be
2495 attempted. Otherwise, we must respect the retry times for each address. Even
2496 when not doing this, we need to set up the retry key string, and determine
2497 whether a retry record exists, because after a successful delivery, a delete
2498 retry item must be set up. Keep the retry database open only for the duration
2499 of these checks, rather than for all local deliveries, because some local
2500 deliveries (e.g. to pipes) can take a substantial time. */
2502 dbm_file = dbfn_open(US"retry", O_RDONLY, &dbblock, FALSE);
2503 if (dbm_file == NULL)
2505 DEBUG(D_deliver|D_retry|D_hints_lookup)
2506 debug_printf("no retry data available\n");
2511 while (addr2 != NULL)
2513 BOOL ok = TRUE; /* to deliver this address */
2516 /* Set up the retry key to include the domain or not, and change its
2517 leading character from "R" to "T". Must make a copy before doing this,
2518 because the old key may be pointed to from a "delete" retry item after
2521 retry_key = string_copy(
2522 (tp->retry_use_local_part)? addr2->address_retry_key :
2523 addr2->domain_retry_key);
2526 /* Inspect the retry data. If there is no hints file, delivery happens. */
2528 if (dbm_file != NULL)
2530 dbdata_retry *retry_record = dbfn_read(dbm_file, retry_key);
2532 /* If there is no retry record, delivery happens. If there is,
2533 remember it exists so it can be deleted after a successful delivery. */
2535 if (retry_record != NULL)
2537 setflag(addr2, af_lt_retry_exists);
2539 /* A retry record exists for this address. If queue running and not
2540 forcing, inspect its contents. If the record is too old, or if its
2541 retry time has come, or if it has passed its cutoff time, delivery
2546 debug_printf("retry record exists: age=%s ",
2547 readconf_printtime(now - retry_record->time_stamp));
2548 debug_printf("(max %s)\n", readconf_printtime(retry_data_expire));
2549 debug_printf(" time to retry = %s expired = %d\n",
2550 readconf_printtime(retry_record->next_try - now),
2551 retry_record->expired);
2554 if (queue_running && !deliver_force)
2556 ok = (now - retry_record->time_stamp > retry_data_expire) ||
2557 (now >= retry_record->next_try) ||
2558 retry_record->expired;
2560 /* If we haven't reached the retry time, there is one more check
2561 to do, which is for the ultimate address timeout. */
2564 ok = retry_ultimate_address_timeout(retry_key, addr2->domain,
2568 else DEBUG(D_retry) debug_printf("no retry record exists\n");
2571 /* This address is to be delivered. Leave it on the chain. */
2576 addr2 = addr2->next;
2579 /* This address is to be deferred. Take it out of the chain, and
2580 post-process it as complete. Must take it out of the chain first,
2581 because post processing puts it on another chain. */
2585 address_item *this = addr2;
2586 this->message = US"Retry time not yet reached";
2587 this->basic_errno = ERRNO_LRETRY;
2588 if (addr3 == NULL) addr2 = addr = addr2->next;
2589 else addr2 = addr3->next = addr2->next;
2590 post_process_one(this, DEFER, logflags, DTYPE_TRANSPORT, 0);
2594 if (dbm_file != NULL) dbfn_close(dbm_file);
2596 /* If there are no addresses left on the chain, they all deferred. Loop
2597 for the next set of addresses. */
2599 if (addr == NULL) continue;
2601 /* So, finally, we do have some addresses that can be passed to the
2602 transport. Before doing so, set up variables that are relevant to a
2605 deliver_set_expansions(addr);
2606 delivery_start = time(NULL);
2607 deliver_local(addr, FALSE);
2608 deliver_time = (int)(time(NULL) - delivery_start);
2610 /* If a shadow transport (which must perforce be another local transport), is
2611 defined, and its condition is met, we must pass the message to the shadow
2612 too, but only those addresses that succeeded. We do this by making a new
2613 chain of addresses - also to keep the original chain uncontaminated. We must
2614 use a chain rather than doing it one by one, because the shadow transport may
2617 NOTE: if the condition fails because of a lookup defer, there is nothing we
2620 if (tp->shadow != NULL &&
2621 (tp->shadow_condition == NULL ||
2622 expand_check_condition(tp->shadow_condition, tp->name, US"transport")))
2624 transport_instance *stp;
2625 address_item *shadow_addr = NULL;
2626 address_item **last = &shadow_addr;
2628 for (stp = transports; stp != NULL; stp = stp->next)
2629 if (Ustrcmp(stp->name, tp->shadow) == 0) break;
2632 log_write(0, LOG_MAIN|LOG_PANIC, "shadow transport \"%s\" not found ",
2635 /* Pick off the addresses that have succeeded, and make clones. Put into
2636 the shadow_message field a pointer to the shadow_message field of the real
2639 else for (addr2 = addr; addr2 != NULL; addr2 = addr2->next)
2641 if (addr2->transport_return != OK) continue;
2642 addr3 = store_get(sizeof(address_item));
2645 addr3->shadow_message = (uschar *)(&(addr2->shadow_message));
2646 addr3->transport = stp;
2647 addr3->transport_return = DEFER;
2648 addr3->return_filename = NULL;
2649 addr3->return_file = -1;
2651 last = &(addr3->next);
2654 /* If we found any addresses to shadow, run the delivery, and stick any
2655 message back into the shadow_message field in the original. */
2657 if (shadow_addr != NULL)
2659 int save_count = transport_count;
2661 DEBUG(D_deliver|D_transport)
2662 debug_printf(">>>>>>>>>>>>>>>> Shadow delivery >>>>>>>>>>>>>>>>\n");
2663 deliver_local(shadow_addr, TRUE);
2665 for(; shadow_addr != NULL; shadow_addr = shadow_addr->next)
2667 int sresult = shadow_addr->transport_return;
2668 *((uschar **)(shadow_addr->shadow_message)) = (sresult == OK)?
2669 string_sprintf(" ST=%s", stp->name) :
2670 string_sprintf(" ST=%s (%s%s%s)", stp->name,
2671 (shadow_addr->basic_errno <= 0)?
2672 US"" : US strerror(shadow_addr->basic_errno),
2673 (shadow_addr->basic_errno <= 0 || shadow_addr->message == NULL)?
2675 (shadow_addr->message != NULL)? shadow_addr->message :
2676 (shadow_addr->basic_errno <= 0)? US"unknown error" : US"");
2678 DEBUG(D_deliver|D_transport)
2679 debug_printf("%s shadow transport returned %s for %s\n",
2681 (sresult == OK)? "OK" :
2682 (sresult == DEFER)? "DEFER" :
2683 (sresult == FAIL)? "FAIL" :
2684 (sresult == PANIC)? "PANIC" : "?",
2685 shadow_addr->address);
2688 DEBUG(D_deliver|D_transport)
2689 debug_printf(">>>>>>>>>>>>>>>> End shadow delivery >>>>>>>>>>>>>>>>\n");
2691 transport_count = save_count; /* Restore original transport count */
2695 /* Cancel the expansions that were set up for the delivery. */
2697 deliver_set_expansions(NULL);
2699 /* Now we can process the results of the real transport. We must take each
2700 address off the chain first, because post_process_one() puts it on another
2703 for (addr2 = addr; addr2 != NULL; addr2 = nextaddr)
2705 int result = addr2->transport_return;
2706 nextaddr = addr2->next;
2708 DEBUG(D_deliver|D_transport)
2709 debug_printf("%s transport returned %s for %s\n",
2711 (result == OK)? "OK" :
2712 (result == DEFER)? "DEFER" :
2713 (result == FAIL)? "FAIL" :
2714 (result == PANIC)? "PANIC" : "?",
2717 /* If there is a retry_record, or if delivery is deferred, build a retry
2718 item for setting a new retry time or deleting the old retry record from
2719 the database. These items are handled all together after all addresses
2720 have been handled (so the database is open just for a short time for
2723 if (result == DEFER || testflag(addr2, af_lt_retry_exists))
2725 int flags = (result == DEFER)? 0 : rf_delete;
2726 uschar *retry_key = string_copy((tp->retry_use_local_part)?
2727 addr2->address_retry_key : addr2->domain_retry_key);
2729 retry_add_item(addr2, retry_key, flags);
2732 /* Done with this address */
2734 if (result == OK) addr2->more_errno = deliver_time;
2735 post_process_one(addr2, result, logflags, DTYPE_TRANSPORT, logchar);
2737 /* If a pipe delivery generated text to be sent back, the result may be
2738 changed to FAIL, and we must copy this for subsequent addresses in the
2741 if (addr2->transport_return != result)
2743 for (addr3 = nextaddr; addr3 != NULL; addr3 = addr3->next)
2745 addr3->transport_return = addr2->transport_return;
2746 addr3->basic_errno = addr2->basic_errno;
2747 addr3->message = addr2->message;
2749 result = addr2->transport_return;
2752 /* Whether or not the result was changed to FAIL, we need to copy the
2753 return_file value from the first address into all the addresses of the
2754 batch, so they are all listed in the error message. */
2756 addr2->return_file = addr->return_file;
2758 /* Change log character for recording successful deliveries. */
2760 if (result == OK) logchar = '-';
2762 } /* Loop back for next batch of addresses */
2768 /*************************************************
2769 * Sort remote deliveries *
2770 *************************************************/
2772 /* This function is called if remote_sort_domains is set. It arranges that the
2773 chain of addresses for remote deliveries is ordered according to the strings
2774 specified. Try to make this shuffling reasonably efficient by handling
2775 sequences of addresses rather than just single ones.
2782 sort_remote_deliveries(void)
2785 address_item **aptr = &addr_remote;
2786 const uschar *listptr = remote_sort_domains;
2790 while (*aptr != NULL &&
2791 (pattern = string_nextinlist(&listptr, &sep, patbuf, sizeof(patbuf)))
2794 address_item *moved = NULL;
2795 address_item **bptr = &moved;
2797 while (*aptr != NULL)
2799 address_item **next;
2800 deliver_domain = (*aptr)->domain; /* set $domain */
2801 if (match_isinlist(deliver_domain, (const uschar **)&pattern, UCHAR_MAX+1,
2802 &domainlist_anchor, NULL, MCL_DOMAIN, TRUE, NULL) == OK)
2804 aptr = &((*aptr)->next);
2808 next = &((*aptr)->next);
2809 while (*next != NULL &&
2810 (deliver_domain = (*next)->domain, /* Set $domain */
2811 match_isinlist(deliver_domain, (const uschar **)&pattern, UCHAR_MAX+1,
2812 &domainlist_anchor, NULL, MCL_DOMAIN, TRUE, NULL)) != OK)
2813 next = &((*next)->next);
2815 /* If the batch of non-matchers is at the end, add on any that were
2816 extracted further up the chain, and end this iteration. Otherwise,
2817 extract them from the chain and hang on the moved chain. */
2829 aptr = &((*aptr)->next);
2832 /* If the loop ended because the final address matched, *aptr will
2833 be NULL. Add on to the end any extracted non-matching addresses. If
2834 *aptr is not NULL, the loop ended via "break" when *next is null, that
2835 is, there was a string of non-matching addresses at the end. In this
2836 case the extracted addresses have already been added on the end. */
2838 if (*aptr == NULL) *aptr = moved;
2844 debug_printf("remote addresses after sorting:\n");
2845 for (addr = addr_remote; addr != NULL; addr = addr->next)
2846 debug_printf(" %s\n", addr->address);
2852 /*************************************************
2853 * Read from pipe for remote delivery subprocess *
2854 *************************************************/
2856 /* This function is called when the subprocess is complete, but can also be
2857 called before it is complete, in order to empty a pipe that is full (to prevent
2858 deadlock). It must therefore keep track of its progress in the parlist data
2861 We read the pipe to get the delivery status codes and a possible error message
2862 for each address, optionally preceded by unusability data for the hosts and
2863 also by optional retry data.
2865 Read in large chunks into the big buffer and then scan through, interpreting
2866 the data therein. In most cases, only a single read will be necessary. No
2867 individual item will ever be anywhere near 2500 bytes in length, so by ensuring
2868 that we read the next chunk when there is less than 2500 bytes left in the
2869 non-final chunk, we can assume each item is complete in the buffer before
2870 handling it. Each item is written using a single write(), which is atomic for
2871 small items (less than PIPE_BUF, which seems to be at least 512 in any Unix and
2872 often bigger) so even if we are reading while the subprocess is still going, we
2873 should never have only a partial item in the buffer.
2876 poffset the offset of the parlist item
2877 eop TRUE if the process has completed
2879 Returns: TRUE if the terminating 'Z' item has been read,
2880 or there has been a disaster (i.e. no more data needed);
2885 par_read_pipe(int poffset, BOOL eop)
2888 pardata *p = parlist + poffset;
2889 address_item *addrlist = p->addrlist;
2890 address_item *addr = p->addr;
2893 uschar *endptr = big_buffer;
2894 uschar *ptr = endptr;
2895 uschar *msg = p->msg;
2896 BOOL done = p->done;
2897 BOOL unfinished = TRUE;
2898 /* minimum size to read is header size including id, subid and length */
2899 int required = PIPE_HEADER_SIZE;
2901 /* Loop through all items, reading from the pipe when necessary. The pipe
2902 is set up to be non-blocking, but there are two different Unix mechanisms in
2903 use. Exim uses O_NONBLOCK if it is defined. This returns 0 for end of file,
2904 and EAGAIN for no more data. If O_NONBLOCK is not defined, Exim uses O_NDELAY,
2905 which returns 0 for both end of file and no more data. We distinguish the
2906 two cases by taking 0 as end of file only when we know the process has
2909 Each separate item is written to the pipe in a single write(), and as they are
2910 all short items, the writes will all be atomic and we should never find
2911 ourselves in the position of having read an incomplete item. "Short" in this
2912 case can mean up to about 1K in the case when there is a long error message
2913 associated with an address. */
2915 DEBUG(D_deliver) debug_printf("reading pipe for subprocess %d (%s)\n",
2916 (int)p->pid, eop? "ended" : "not ended");
2920 retry_item *r, **rp;
2921 int remaining = endptr - ptr;
2922 uschar header[PIPE_HEADER_SIZE + 1];
2926 /* Read (first time) or top up the chars in the buffer if necessary.
2927 There will be only one read if we get all the available data (i.e. don't
2928 fill the buffer completely). */
2930 if (remaining < required && unfinished)
2933 int available = big_buffer_size - remaining;
2935 if (remaining > 0) memmove(big_buffer, ptr, remaining);
2938 endptr = big_buffer + remaining;
2939 len = read(fd, endptr, available);
2941 DEBUG(D_deliver) debug_printf("read() yielded %d\n", len);
2943 /* If the result is EAGAIN and the process is not complete, just
2944 stop reading any more and process what we have already. */
2948 if (!eop && errno == EAGAIN) len = 0; else
2950 msg = string_sprintf("failed to read pipe from transport process "
2951 "%d for transport %s: %s", pid, addr->transport->driver_name,
2957 /* If the length is zero (eof or no-more-data), just process what we
2958 already have. Note that if the process is still running and we have
2959 read all the data in the pipe (but less that "available") then we
2960 won't read any more, as "unfinished" will get set FALSE. */
2964 unfinished = len == available;
2967 /* If we are at the end of the available data, exit the loop. */
2968 if (ptr >= endptr) break;
2970 /* copy and read header */
2971 memcpy(header, ptr, PIPE_HEADER_SIZE);
2972 header[PIPE_HEADER_SIZE] = '\0';
2975 required = Ustrtol(header + 2, &endc, 10) + PIPE_HEADER_SIZE; /* header + data */
2978 msg = string_sprintf("failed to read pipe from transport process "
2979 "%d for transport %s: error reading size from header", pid, addr->transport->driver_name);
2985 debug_printf("header read id:%c,subid:%c,size:%s,required:%d,remaining:%d,unfinished:%d\n",
2986 id, subid, header+2, required, remaining, unfinished);
2988 /* is there room for the dataset we want to read ? */
2989 if (required > big_buffer_size - PIPE_HEADER_SIZE)
2991 msg = string_sprintf("failed to read pipe from transport process "
2992 "%d for transport %s: big_buffer too small! required size=%d buffer size=%d", pid, addr->transport->driver_name,
2993 required, big_buffer_size - PIPE_HEADER_SIZE);
2998 /* we wrote all datasets with atomic write() calls
2999 remaining < required only happens if big_buffer was too small
3000 to get all available data from pipe. unfinished has to be true
3002 if (remaining < required)
3006 msg = string_sprintf("failed to read pipe from transport process "
3007 "%d for transport %s: required size=%d > remaining size=%d and unfinished=false",
3008 pid, addr->transport->driver_name, required, remaining);
3013 /* step behind the header */
3014 ptr += PIPE_HEADER_SIZE;
3016 /* Handle each possible type of item, assuming the complete item is
3017 available in store. */
3021 /* Host items exist only if any hosts were marked unusable. Match
3022 up by checking the IP address. */
3025 for (h = addrlist->host_list; h != NULL; h = h->next)
3027 if (h->address == NULL || Ustrcmp(h->address, ptr+2) != 0) continue;
3035 /* Retry items are sent in a preceding R item for each address. This is
3036 kept separate to keep each message short enough to guarantee it won't
3037 be split in the pipe. Hopefully, in the majority of cases, there won't in
3038 fact be any retry items at all.
3040 The complete set of retry items might include an item to delete a
3041 routing retry if there was a previous routing delay. However, routing
3042 retries are also used when a remote transport identifies an address error.
3043 In that case, there may also be an "add" item for the same key. Arrange
3044 that a "delete" item is dropped in favour of an "add" item. */
3047 if (addr == NULL) goto ADDR_MISMATCH;
3049 DEBUG(D_deliver|D_retry)
3050 debug_printf("reading retry information for %s from subprocess\n",
3053 /* Cut out any "delete" items on the list. */
3055 for (rp = &(addr->retries); (r = *rp) != NULL; rp = &(r->next))
3057 if (Ustrcmp(r->key, ptr+1) == 0) /* Found item with same key */
3059 if ((r->flags & rf_delete) == 0) break; /* It was not "delete" */
3060 *rp = r->next; /* Excise a delete item */
3061 DEBUG(D_deliver|D_retry)
3062 debug_printf(" existing delete item dropped\n");
3066 /* We want to add a delete item only if there is no non-delete item;
3067 however we still have to step ptr through the data. */
3069 if (r == NULL || (*ptr & rf_delete) == 0)
3071 r = store_get(sizeof(retry_item));
3072 r->next = addr->retries;
3075 r->key = string_copy(ptr);
3077 memcpy(&(r->basic_errno), ptr, sizeof(r->basic_errno));
3078 ptr += sizeof(r->basic_errno);
3079 memcpy(&(r->more_errno), ptr, sizeof(r->more_errno));
3080 ptr += sizeof(r->more_errno);
3081 r->message = (*ptr)? string_copy(ptr) : NULL;
3082 DEBUG(D_deliver|D_retry)
3083 debug_printf(" added %s item\n",
3084 ((r->flags & rf_delete) == 0)? "retry" : "delete");
3089 DEBUG(D_deliver|D_retry)
3090 debug_printf(" delete item not added: non-delete item exists\n");
3093 ptr += sizeof(r->basic_errno) + sizeof(r->more_errno);
3099 /* Put the amount of data written into the parlist block */
3102 memcpy(&(p->transport_count), ptr, sizeof(transport_count));
3103 ptr += sizeof(transport_count);
3106 /* Address items are in the order of items on the address chain. We
3107 remember the current address value in case this function is called
3108 several times to empty the pipe in stages. Information about delivery
3109 over TLS is sent in a preceding X item for each address. We don't put
3110 it in with the other info, in order to keep each message short enough to
3111 guarantee it won't be split in the pipe. */
3115 if (addr == NULL) goto ADDR_MISMATCH; /* Below, in 'A' handler */
3119 addr->cipher = NULL;
3120 addr->peerdn = NULL;
3123 addr->cipher = string_copy(ptr);
3126 addr->peerdn = string_copy(ptr);
3130 addr->peercert = NULL;
3132 (void) tls_import_cert(ptr, &addr->peercert);
3136 addr->ourcert = NULL;
3138 (void) tls_import_cert(ptr, &addr->ourcert);
3141 # ifndef DISABLE_OCSP
3143 addr->ocsp = OCSP_NOT_REQ;
3145 addr->ocsp = *ptr - '0';
3151 #endif /*SUPPORT_TLS*/
3153 case 'C': /* client authenticator information */
3157 addr->authenticator = (*ptr)? string_copy(ptr) : NULL;
3160 addr->auth_id = (*ptr)? string_copy(ptr) : NULL;
3163 addr->auth_sndr = (*ptr)? string_copy(ptr) : NULL;
3169 #ifndef DISABLE_PRDR
3171 addr->flags |= af_prdr_used;
3176 if (addr == NULL) goto ADDR_MISMATCH;
3177 memcpy(&(addr->dsn_aware), ptr, sizeof(addr->dsn_aware));
3178 ptr += sizeof(addr->dsn_aware);
3179 DEBUG(D_deliver) debug_printf("DSN read: addr->dsn_aware = %d\n", addr->dsn_aware);
3186 msg = string_sprintf("address count mismatch for data read from pipe "
3187 "for transport process %d for transport %s", pid,
3188 addrlist->transport->driver_name);
3193 addr->transport_return = *ptr++;
3194 addr->special_action = *ptr++;
3195 memcpy(&(addr->basic_errno), ptr, sizeof(addr->basic_errno));
3196 ptr += sizeof(addr->basic_errno);
3197 memcpy(&(addr->more_errno), ptr, sizeof(addr->more_errno));
3198 ptr += sizeof(addr->more_errno);
3199 memcpy(&(addr->flags), ptr, sizeof(addr->flags));
3200 ptr += sizeof(addr->flags);
3201 addr->message = (*ptr)? string_copy(ptr) : NULL;
3203 addr->user_message = (*ptr)? string_copy(ptr) : NULL;
3206 /* Always two strings for host information, followed by the port number and DNSSEC mark */
3210 h = store_get(sizeof(host_item));
3211 h->name = string_copy(ptr);
3213 h->address = string_copy(ptr);
3215 memcpy(&(h->port), ptr, sizeof(h->port));
3216 ptr += sizeof(h->port);
3217 h->dnssec = *ptr == '2' ? DS_YES
3218 : *ptr == '1' ? DS_NO
3221 addr->host_used = h;
3225 /* Finished with this address */
3230 /* Local interface address/port */
3232 if (*ptr) sending_ip_address = string_copy(ptr);
3234 if (*ptr) sending_port = atoi(ptr);
3238 /* Z marks the logical end of the data. It is followed by '0' if
3239 continue_transport was NULL at the end of transporting, otherwise '1'.
3240 We need to know when it becomes NULL during a delivery down a passed SMTP
3241 channel so that we don't try to pass anything more down it. Of course, for
3242 most normal messages it will remain NULL all the time. */
3247 continue_transport = NULL;
3248 continue_hostname = NULL;
3251 DEBUG(D_deliver) debug_printf("Z0%c item read\n", *ptr);
3254 /* Anything else is a disaster. */
3257 msg = string_sprintf("malformed data (%d) read from pipe for transport "
3258 "process %d for transport %s", ptr[-1], pid,
3259 addr->transport->driver_name);
3265 /* The done flag is inspected externally, to determine whether or not to
3266 call the function again when the process finishes. */
3270 /* If the process hadn't finished, and we haven't seen the end of the data
3271 or suffered a disaster, update the rest of the state, and return FALSE to
3272 indicate "not finished". */
3281 /* Close our end of the pipe, to prevent deadlock if the far end is still
3282 pushing stuff into it. */
3287 /* If we have finished without error, but haven't had data for every address,
3288 something is wrong. */
3290 if (msg == NULL && addr != NULL)
3291 msg = string_sprintf("insufficient address data read from pipe "
3292 "for transport process %d for transport %s", pid,
3293 addr->transport->driver_name);
3295 /* If an error message is set, something has gone wrong in getting back
3296 the delivery data. Put the message into each address and freeze it. */
3300 for (addr = addrlist; addr != NULL; addr = addr->next)
3302 addr->transport_return = DEFER;
3303 addr->special_action = SPECIAL_FREEZE;
3304 addr->message = msg;
3308 /* Return TRUE to indicate we have got all we need from this process, even
3309 if it hasn't actually finished yet. */
3316 /*************************************************
3317 * Post-process a set of remote addresses *
3318 *************************************************/
3320 /* Do what has to be done immediately after a remote delivery for each set of
3321 addresses, then re-write the spool if necessary. Note that post_process_one
3322 puts the address on an appropriate queue; hence we must fish off the next
3323 one first. This function is also called if there is a problem with setting
3324 up a subprocess to do a remote delivery in parallel. In this case, the final
3325 argument contains a message, and the action must be forced to DEFER.
3328 addr pointer to chain of address items
3329 logflags flags for logging
3330 msg NULL for normal cases; -> error message for unexpected problems
3331 fallback TRUE if processing fallback hosts
3337 remote_post_process(address_item *addr, int logflags, uschar *msg,
3342 /* If any host addresses were found to be unusable, add them to the unusable
3343 tree so that subsequent deliveries don't try them. */
3345 for (h = addr->host_list; h != NULL; h = h->next)
3347 if (h->address == NULL) continue;
3348 if (h->status >= hstatus_unusable) tree_add_unusable(h);
3351 /* Now handle each address on the chain. The transport has placed '=' or '-'
3352 into the special_action field for each successful delivery. */
3354 while (addr != NULL)
3356 address_item *next = addr->next;
3358 /* If msg == NULL (normal processing) and the result is DEFER and we are
3359 processing the main hosts and there are fallback hosts available, put the
3360 address on the list for fallback delivery. */
3362 if (addr->transport_return == DEFER &&
3363 addr->fallback_hosts != NULL &&
3367 addr->host_list = addr->fallback_hosts;
3368 addr->next = addr_fallback;
3369 addr_fallback = addr;
3370 DEBUG(D_deliver) debug_printf("%s queued for fallback host(s)\n", addr->address);
3373 /* If msg is set (=> unexpected problem), set it in the address before
3374 doing the ordinary post processing. */
3380 addr->message = msg;
3381 addr->transport_return = DEFER;
3383 (void)post_process_one(addr, addr->transport_return, logflags,
3384 DTYPE_TRANSPORT, addr->special_action);
3392 /* If we have just delivered down a passed SMTP channel, and that was
3393 the last address, the channel will have been closed down. Now that
3394 we have logged that delivery, set continue_sequence to 1 so that
3395 any subsequent deliveries don't get "*" incorrectly logged. */
3397 if (continue_transport == NULL) continue_sequence = 1;
3402 /*************************************************
3403 * Wait for one remote delivery subprocess *
3404 *************************************************/
3406 /* This function is called while doing remote deliveries when either the
3407 maximum number of processes exist and we need one to complete so that another
3408 can be created, or when waiting for the last ones to complete. It must wait for
3409 the completion of one subprocess, empty the control block slot, and return a
3410 pointer to the address chain.
3413 Returns: pointer to the chain of addresses handled by the process;
3414 NULL if no subprocess found - this is an unexpected error
3417 static address_item *
3420 int poffset, status;
3421 address_item *addr, *addrlist;
3424 set_process_info("delivering %s: waiting for a remote delivery subprocess "
3425 "to finish", message_id);
3427 /* Loop until either a subprocess completes, or there are no subprocesses in
3428 existence - in which case give an error return. We cannot proceed just by
3429 waiting for a completion, because a subprocess may have filled up its pipe, and
3430 be waiting for it to be emptied. Therefore, if no processes have finished, we
3431 wait for one of the pipes to acquire some data by calling select(), with a
3432 timeout just in case.
3434 The simple approach is just to iterate after reading data from a ready pipe.
3435 This leads to non-ideal behaviour when the subprocess has written its final Z
3436 item, closed the pipe, and is in the process of exiting (the common case). A
3437 call to waitpid() yields nothing completed, but select() shows the pipe ready -
3438 reading it yields EOF, so you end up with busy-waiting until the subprocess has
3441 To avoid this, if all the data that is needed has been read from a subprocess
3442 after select(), an explicit wait() for it is done. We know that all it is doing
3443 is writing to the pipe and then exiting, so the wait should not be long.
3445 The non-blocking waitpid() is to some extent just insurance; if we could
3446 reliably detect end-of-file on the pipe, we could always know when to do a
3447 blocking wait() for a completed process. However, because some systems use
3448 NDELAY, which doesn't distinguish between EOF and pipe empty, it is easier to
3449 use code that functions without the need to recognize EOF.
3451 There's a double loop here just in case we end up with a process that is not in
3452 the list of remote delivery processes. Something has obviously gone wrong if
3453 this is the case. (For example, a process that is incorrectly left over from
3454 routing or local deliveries might be found.) The damage can be minimized by
3455 looping back and looking for another process. If there aren't any, the error
3456 return will happen. */
3458 for (;;) /* Normally we do not repeat this loop */
3460 while ((pid = waitpid(-1, &status, WNOHANG)) <= 0)
3463 fd_set select_pipes;
3464 int maxpipe, readycount;
3466 /* A return value of -1 can mean several things. If errno != ECHILD, it
3467 either means invalid options (which we discount), or that this process was
3468 interrupted by a signal. Just loop to try the waitpid() again.
3470 If errno == ECHILD, waitpid() is telling us that there are no subprocesses
3471 in existence. This should never happen, and is an unexpected error.
3472 However, there is a nasty complication when running under Linux. If "strace
3473 -f" is being used under Linux to trace this process and its children,
3474 subprocesses are "stolen" from their parents and become the children of the
3475 tracing process. A general wait such as the one we've just obeyed returns
3476 as if there are no children while subprocesses are running. Once a
3477 subprocess completes, it is restored to the parent, and waitpid(-1) finds
3478 it. Thanks to Joachim Wieland for finding all this out and suggesting a
3481 This does not happen using "truss" on Solaris, nor (I think) with other
3482 tracing facilities on other OS. It seems to be specific to Linux.
3484 What we do to get round this is to use kill() to see if any of our
3485 subprocesses are still in existence. If kill() gives an OK return, we know
3486 it must be for one of our processes - it can't be for a re-use of the pid,
3487 because if our process had finished, waitpid() would have found it. If any
3488 of our subprocesses are in existence, we proceed to use select() as if
3489 waitpid() had returned zero. I think this is safe. */
3493 if (errno != ECHILD) continue; /* Repeats the waitpid() */
3496 debug_printf("waitpid() returned -1/ECHILD: checking explicitly "
3497 "for process existence\n");
3499 for (poffset = 0; poffset < remote_max_parallel; poffset++)
3501 if ((pid = parlist[poffset].pid) != 0 && kill(pid, 0) == 0)
3503 DEBUG(D_deliver) debug_printf("process %d still exists: assume "
3504 "stolen by strace\n", (int)pid);
3505 break; /* With poffset set */
3509 if (poffset >= remote_max_parallel)
3511 DEBUG(D_deliver) debug_printf("*** no delivery children found\n");
3512 return NULL; /* This is the error return */
3516 /* A pid value greater than 0 breaks the "while" loop. A negative value has
3517 been handled above. A return value of zero means that there is at least one
3518 subprocess, but there are no completed subprocesses. See if any pipes are
3519 ready with any data for reading. */
3521 DEBUG(D_deliver) debug_printf("selecting on subprocess pipes\n");
3524 FD_ZERO(&select_pipes);
3525 for (poffset = 0; poffset < remote_max_parallel; poffset++)
3527 if (parlist[poffset].pid != 0)
3529 int fd = parlist[poffset].fd;
3530 FD_SET(fd, &select_pipes);
3531 if (fd > maxpipe) maxpipe = fd;
3535 /* Stick in a 60-second timeout, just in case. */
3540 readycount = select(maxpipe + 1, (SELECT_ARG2_TYPE *)&select_pipes,
3543 /* Scan through the pipes and read any that are ready; use the count
3544 returned by select() to stop when there are no more. Select() can return
3545 with no processes (e.g. if interrupted). This shouldn't matter.
3547 If par_read_pipe() returns TRUE, it means that either the terminating Z was
3548 read, or there was a disaster. In either case, we are finished with this
3549 process. Do an explicit wait() for the process and break the main loop if
3552 It turns out that we have to deal with the case of an interrupted system
3553 call, which can happen on some operating systems if the signal handling is
3554 set up to do that by default. */
3557 readycount > 0 && poffset < remote_max_parallel;
3560 if ((pid = parlist[poffset].pid) != 0 &&
3561 FD_ISSET(parlist[poffset].fd, &select_pipes))
3564 if (par_read_pipe(poffset, FALSE)) /* Finished with this pipe */
3566 for (;;) /* Loop for signals */
3568 pid_t endedpid = waitpid(pid, &status, 0);
3569 if (endedpid == pid) goto PROCESS_DONE;
3570 if (endedpid != (pid_t)(-1) || errno != EINTR)
3571 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Unexpected error return "
3572 "%d (errno = %d) from waitpid() for process %d",
3573 (int)endedpid, errno, (int)pid);
3579 /* Now go back and look for a completed subprocess again. */
3582 /* A completed process was detected by the non-blocking waitpid(). Find the
3583 data block that corresponds to this subprocess. */
3585 for (poffset = 0; poffset < remote_max_parallel; poffset++)
3586 if (pid == parlist[poffset].pid) break;
3588 /* Found the data block; this is a known remote delivery process. We don't
3589 need to repeat the outer loop. This should be what normally happens. */
3591 if (poffset < remote_max_parallel) break;
3593 /* This situation is an error, but it's probably better to carry on looking
3594 for another process than to give up (as we used to do). */
3596 log_write(0, LOG_MAIN|LOG_PANIC, "Process %d finished: not found in remote "
3597 "transport process list", pid);
3598 } /* End of the "for" loop */
3600 /* Come here when all the data was completely read after a select(), and
3601 the process in pid has been wait()ed for. */
3608 debug_printf("remote delivery process %d ended\n", (int)pid);
3610 debug_printf("remote delivery process %d ended: status=%04x\n", (int)pid,
3614 set_process_info("delivering %s", message_id);
3616 /* Get the chain of processed addresses */
3618 addrlist = parlist[poffset].addrlist;
3620 /* If the process did not finish cleanly, record an error and freeze (except
3621 for SIGTERM, SIGKILL and SIGQUIT), and also ensure the journal is not removed,
3622 in case the delivery did actually happen. */
3624 if ((status & 0xffff) != 0)
3627 int msb = (status >> 8) & 255;
3628 int lsb = status & 255;
3629 int code = (msb == 0)? (lsb & 0x7f) : msb;
3631 msg = string_sprintf("%s transport process returned non-zero status 0x%04x: "
3633 addrlist->transport->driver_name,
3635 (msb == 0)? "terminated by signal" : "exit code",
3638 if (msb != 0 || (code != SIGTERM && code != SIGKILL && code != SIGQUIT))
3639 addrlist->special_action = SPECIAL_FREEZE;
3641 for (addr = addrlist; addr != NULL; addr = addr->next)
3643 addr->transport_return = DEFER;
3644 addr->message = msg;
3647 remove_journal = FALSE;
3650 /* Else complete reading the pipe to get the result of the delivery, if all
3651 the data has not yet been obtained. */
3653 else if (!parlist[poffset].done) (void)par_read_pipe(poffset, TRUE);
3655 /* Put the data count and return path into globals, mark the data slot unused,
3656 decrement the count of subprocesses, and return the address chain. */
3658 transport_count = parlist[poffset].transport_count;
3659 used_return_path = parlist[poffset].return_path;
3660 parlist[poffset].pid = 0;
3667 /*************************************************
3668 * Wait for subprocesses and post-process *
3669 *************************************************/
3671 /* This function waits for subprocesses until the number that are still running
3672 is below a given threshold. For each complete subprocess, the addresses are
3673 post-processed. If we can't find a running process, there is some shambles.
3674 Better not bomb out, as that might lead to multiple copies of the message. Just
3675 log and proceed as if all done.
3678 max maximum number of subprocesses to leave running
3679 fallback TRUE if processing fallback hosts
3685 par_reduce(int max, BOOL fallback)
3687 while (parcount > max)
3689 address_item *doneaddr = par_wait();
3690 if (doneaddr == NULL)
3692 log_write(0, LOG_MAIN|LOG_PANIC,
3693 "remote delivery process count got out of step");
3696 else remote_post_process(doneaddr, LOG_MAIN, NULL, fallback);
3704 rmt_dlv_checked_write(int fd, char id, char subid, void * buf, int size)
3706 uschar writebuffer[PIPE_HEADER_SIZE + BIG_BUFFER_SIZE];
3709 /* we assume that size can't get larger then BIG_BUFFER_SIZE which currently is set to 16k */
3710 /* complain to log if someone tries with buffer sizes we can't handle*/
3714 log_write(0, LOG_MAIN|LOG_PANIC_DIE,
3715 "Failed writing transport result to pipe: can't handle buffers > 99999 bytes. truncating!\n");
3719 /* to keep the write() atomic we build header in writebuffer and copy buf behind */
3720 /* two write() calls would increase the complexity of reading from pipe */
3722 /* convert size to human readable string prepended by id and subid */
3723 header_length = snprintf(CS writebuffer, PIPE_HEADER_SIZE+1, "%c%c%05d", id, subid, size);
3724 if (header_length != PIPE_HEADER_SIZE)
3726 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "header snprintf failed\n");
3727 writebuffer[0] = '\0';
3730 DEBUG(D_deliver) debug_printf("header write id:%c,subid:%c,size:%d,final:%s\n",
3731 id, subid, size, writebuffer);
3733 if (buf && size > 0)
3734 memcpy(writebuffer + PIPE_HEADER_SIZE, buf, size);
3736 size += PIPE_HEADER_SIZE;
3737 int ret = write(fd, writebuffer, size);
3739 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Failed writing transport result to pipe: %s\n",
3740 ret == -1 ? strerror(errno) : "short write");
3743 /*************************************************
3744 * Do remote deliveries *
3745 *************************************************/
3747 /* This function is called to process the addresses in addr_remote. We must
3748 pick off the queue all addresses that have the same transport, remote
3749 destination, and errors address, and hand them to the transport in one go,
3750 subject to some configured limitations. If this is a run to continue delivering
3751 to an existing delivery channel, skip all but those addresses that can go to
3752 that channel. The skipped addresses just get deferred.
3754 If mua_wrapper is set, all addresses must be able to be sent in a single
3755 transaction. If not, this function yields FALSE.
3757 In Exim 4, remote deliveries are always done in separate processes, even
3758 if remote_max_parallel = 1 or if there's only one delivery to do. The reason
3759 is so that the base process can retain privilege. This makes the
3760 implementation of fallback transports feasible (though not initially done.)
3762 We create up to the configured number of subprocesses, each of which passes
3763 back the delivery state via a pipe. (However, when sending down an existing
3764 connection, remote_max_parallel is forced to 1.)
3767 fallback TRUE if processing fallback hosts
3769 Returns: TRUE normally
3770 FALSE if mua_wrapper is set and the addresses cannot all be sent
3775 do_remote_deliveries(BOOL fallback)
3781 parcount = 0; /* Number of executing subprocesses */
3783 /* When sending down an existing channel, only do one delivery at a time.
3784 We use a local variable (parmax) to hold the maximum number of processes;
3785 this gets reduced from remote_max_parallel if we can't create enough pipes. */
3787 if (continue_transport != NULL) remote_max_parallel = 1;
3788 parmax = remote_max_parallel;
3790 /* If the data for keeping a list of processes hasn't yet been
3793 if (parlist == NULL)
3795 parlist = store_get(remote_max_parallel * sizeof(pardata));
3796 for (poffset = 0; poffset < remote_max_parallel; poffset++)
3797 parlist[poffset].pid = 0;
3800 /* Now loop for each remote delivery */
3802 for (delivery_count = 0; addr_remote != NULL; delivery_count++)
3808 int address_count = 1;
3809 int address_count_max;
3811 BOOL use_initgroups;
3812 BOOL pipe_done = FALSE;
3813 transport_instance *tp;
3814 address_item **anchor = &addr_remote;
3815 address_item *addr = addr_remote;
3816 address_item *last = addr;
3819 /* Pull the first address right off the list. */
3821 addr_remote = addr->next;
3824 DEBUG(D_deliver|D_transport)
3825 debug_printf("--------> %s <--------\n", addr->address);
3827 /* If no transport has been set, there has been a big screw-up somewhere. */
3829 if ((tp = addr->transport) == NULL)
3831 disable_logging = FALSE; /* Jic */
3832 remote_post_process(addr, LOG_MAIN|LOG_PANIC,
3833 US"No transport set by router", fallback);
3837 /* Check that this base address hasn't previously been delivered to this
3838 transport. The check is necessary at this point to handle homonymic addresses
3839 correctly in cases where the pattern of redirection changes between delivery
3840 attempts. Non-homonymic previous delivery is detected earlier, at routing
3843 if (previously_transported(addr, FALSE)) continue;
3845 /* Force failure if the message is too big. */
3847 if (tp->message_size_limit != NULL)
3849 int rc = check_message_size(tp, addr);
3852 addr->transport_return = rc;
3853 remote_post_process(addr, LOG_MAIN, NULL, fallback);
3858 /* Get the flag which specifies whether the transport can handle different
3859 domains that nevertheless resolve to the same set of hosts. If it needs
3860 expanding, get variables set: $address_data, $domain_data, $localpart_data,
3861 $host, $host_address, $host_port. */
3862 if (tp->expand_multi_domain)
3863 deliver_set_expansions(addr);
3865 if (exp_bool(addr, US"transport", tp->name, D_transport,
3866 US"multi_domain", tp->multi_domain, tp->expand_multi_domain,
3867 &multi_domain) != OK)
3869 deliver_set_expansions(NULL);
3870 remote_post_process(addr, LOG_MAIN|LOG_PANIC, addr->message, fallback);
3874 /* Get the maximum it can handle in one envelope, with zero meaning
3875 unlimited, which is forced for the MUA wrapper case. */
3877 address_count_max = tp->max_addresses;
3878 if (address_count_max == 0 || mua_wrapper) address_count_max = 999999;
3881 /************************************************************************/
3882 /***** This is slightly experimental code, but should be safe. *****/
3884 /* The address_count_max value is the maximum number of addresses that the
3885 transport can send in one envelope. However, the transport must be capable of
3886 dealing with any number of addresses. If the number it gets exceeds its
3887 envelope limitation, it must send multiple copies of the message. This can be
3888 done over a single connection for SMTP, so uses less resources than making
3889 multiple connections. On the other hand, if remote_max_parallel is greater
3890 than one, it is perhaps a good idea to use parallel processing to move the
3891 message faster, even if that results in multiple simultaneous connections to
3894 How can we come to some compromise between these two ideals? What we do is to
3895 limit the number of addresses passed to a single instance of a transport to
3896 the greater of (a) its address limit (rcpt_max for SMTP) and (b) the total
3897 number of addresses routed to remote transports divided by
3898 remote_max_parallel. For example, if the message has 100 remote recipients,
3899 remote max parallel is 2, and rcpt_max is 10, we'd never send more than 50 at
3900 once. But if rcpt_max is 100, we could send up to 100.
3902 Of course, not all the remotely addresses in a message are going to go to the
3903 same set of hosts (except in smarthost configurations), so this is just a
3904 heuristic way of dividing up the work.
3906 Furthermore (1), because this may not be wanted in some cases, and also to
3907 cope with really pathological cases, there is also a limit to the number of
3908 messages that are sent over one connection. This is the same limit that is
3909 used when sending several different messages over the same connection.
3910 Continue_sequence is set when in this situation, to the number sent so
3911 far, including this message.
3913 Furthermore (2), when somebody explicitly sets the maximum value to 1, it
3914 is probably because they are using VERP, in which case they want to pass only
3915 one address at a time to the transport, in order to be able to use
3916 $local_part and $domain in constructing a new return path. We could test for
3917 the use of these variables, but as it is so likely they will be used when the
3918 maximum is 1, we don't bother. Just leave the value alone. */
3920 if (address_count_max != 1 &&
3921 address_count_max < remote_delivery_count/remote_max_parallel)
3923 int new_max = remote_delivery_count/remote_max_parallel;
3924 int message_max = tp->connection_max_messages;
3925 if (connection_max_messages >= 0) message_max = connection_max_messages;
3926 message_max -= continue_sequence - 1;
3927 if (message_max > 0 && new_max > address_count_max * message_max)
3928 new_max = address_count_max * message_max;
3929 address_count_max = new_max;
3932 /************************************************************************/
3935 /* Pick off all addresses which have the same transport, errors address,
3936 destination, and extra headers. In some cases they point to the same host
3937 list, but we also need to check for identical host lists generated from
3938 entirely different domains. The host list pointers can be NULL in the case
3939 where the hosts are defined in the transport. There is also a configured
3940 maximum limit of addresses that can be handled at once (see comments above
3941 for how it is computed).
3942 If the transport does not handle multiple domains, enforce that also,
3943 and if it might need a per-address check for this, re-evaluate it.
3946 while ((next = *anchor) != NULL && address_count < address_count_max)
3949 if ( (multi_domain || Ustrcmp(next->domain, addr->domain) == 0)
3950 && tp == next->transport
3951 && same_hosts(next->host_list, addr->host_list)
3952 && same_strings(next->p.errors_address, addr->p.errors_address)
3953 && same_headers(next->p.extra_headers, addr->p.extra_headers)
3954 && same_ugid(tp, next, addr)
3955 && ( next->p.remove_headers == addr->p.remove_headers
3956 || ( next->p.remove_headers != NULL
3957 && addr->p.remove_headers != NULL
3958 && Ustrcmp(next->p.remove_headers, addr->p.remove_headers) == 0
3962 !tp->expand_multi_domain || (deliver_set_expansions(next), 1),
3964 US"transport", next->transport->name, D_transport,
3965 US"multi_domain", next->transport->multi_domain,
3966 next->transport->expand_multi_domain, &md) == OK
3971 *anchor = next->next;
3973 next->first = addr; /* remember top one (for retry processing) */
3978 else anchor = &(next->next);
3979 deliver_set_expansions(NULL);
3982 /* If we are acting as an MUA wrapper, all addresses must go in a single
3983 transaction. If not, put them back on the chain and yield FALSE. */
3985 if (mua_wrapper && addr_remote != NULL)
3987 last->next = addr_remote;
3992 /* Set up the expansion variables for this set of addresses */
3994 deliver_set_expansions(addr);
3996 /* Ensure any transport-set auth info is fresh */
3997 addr->authenticator = addr->auth_id = addr->auth_sndr = NULL;
3999 /* Compute the return path, expanding a new one if required. The old one
4000 must be set first, as it might be referred to in the expansion. */
4002 if(addr->p.errors_address != NULL)
4003 return_path = addr->p.errors_address;
4004 #ifdef EXPERIMENTAL_SRS
4005 else if(addr->p.srs_sender != NULL)
4006 return_path = addr->p.srs_sender;
4009 return_path = sender_address;
4011 if (tp->return_path != NULL)
4013 uschar *new_return_path = expand_string(tp->return_path);
4014 if (new_return_path == NULL)
4016 if (!expand_string_forcedfail)
4018 remote_post_process(addr, LOG_MAIN|LOG_PANIC,
4019 string_sprintf("Failed to expand return path \"%s\": %s",
4020 tp->return_path, expand_string_message), fallback);
4024 else return_path = new_return_path;
4027 /* Find the uid, gid, and use_initgroups setting for this transport. Failure
4028 logs and sets up error messages, so we just post-process and continue with
4029 the next address. */
4031 if (!findugid(addr, tp, &uid, &gid, &use_initgroups))
4033 remote_post_process(addr, LOG_MAIN|LOG_PANIC, NULL, fallback);
4037 /* If this transport has a setup function, call it now so that it gets
4038 run in this process and not in any subprocess. That way, the results of
4039 any setup that are retained by the transport can be reusable. One of the
4040 things the setup does is to set the fallback host lists in the addresses.
4041 That is why it is called at this point, before the continue delivery
4042 processing, because that might use the fallback hosts. */
4044 if (tp->setup != NULL)
4045 (void)((tp->setup)(addr->transport, addr, NULL, uid, gid, NULL));
4047 /* If this is a run to continue delivery down an already-established
4048 channel, check that this set of addresses matches the transport and
4049 the channel. If it does not, defer the addresses. If a host list exists,
4050 we must check that the continue host is on the list. Otherwise, the
4051 host is set in the transport. */
4053 continue_more = FALSE; /* In case got set for the last lot */
4054 if (continue_transport != NULL)
4056 BOOL ok = Ustrcmp(continue_transport, tp->name) == 0;
4057 if (ok && addr->host_list != NULL)
4061 for (h = addr->host_list; h != NULL; h = h->next)
4063 if (Ustrcmp(h->name, continue_hostname) == 0)
4064 { ok = TRUE; break; }
4068 /* Addresses not suitable; defer or queue for fallback hosts (which
4069 might be the continue host) and skip to next address. */
4073 DEBUG(D_deliver) debug_printf("not suitable for continue_transport\n");
4076 if (addr->fallback_hosts != NULL && !fallback)
4080 next->host_list = next->fallback_hosts;
4081 DEBUG(D_deliver) debug_printf("%s queued for fallback host(s)\n", next->address);
4082 if (next->next == NULL) break;
4085 next->next = addr_fallback;
4086 addr_fallback = addr;
4091 while (next->next != NULL) next = next->next;
4092 next->next = addr_defer;
4099 /* Set a flag indicating whether there are further addresses that list
4100 the continued host. This tells the transport to leave the channel open,
4101 but not to pass it to another delivery process. */
4103 for (next = addr_remote; next != NULL; next = next->next)
4106 for (h = next->host_list; h != NULL; h = h->next)
4108 if (Ustrcmp(h->name, continue_hostname) == 0)
4109 { continue_more = TRUE; break; }
4114 /* The transports set up the process info themselves as they may connect
4115 to more than one remote machine. They also have to set up the filter
4116 arguments, if required, so that the host name and address are available
4119 transport_filter_argv = NULL;
4121 /* Create the pipe for inter-process communication. If pipe creation
4122 fails, it is probably because the value of remote_max_parallel is so
4123 large that too many file descriptors for pipes have been created. Arrange
4124 to wait for a process to finish, and then try again. If we still can't
4125 create a pipe when all processes have finished, break the retry loop. */
4129 if (pipe(pfd) == 0) pipe_done = TRUE;
4130 else if (parcount > 0) parmax = parcount;
4133 /* We need to make the reading end of the pipe non-blocking. There are
4134 two different options for this. Exim is cunningly (I hope!) coded so
4135 that it can use either of them, though it prefers O_NONBLOCK, which
4136 distinguishes between EOF and no-more-data. */
4139 (void)fcntl(pfd[pipe_read], F_SETFL, O_NONBLOCK);
4141 (void)fcntl(pfd[pipe_read], F_SETFL, O_NDELAY);
4144 /* If the maximum number of subprocesses already exist, wait for a process
4145 to finish. If we ran out of file descriptors, parmax will have been reduced
4146 from its initial value of remote_max_parallel. */
4148 par_reduce(parmax - 1, fallback);
4151 /* If we failed to create a pipe and there were no processes to wait
4152 for, we have to give up on this one. Do this outside the above loop
4153 so that we can continue the main loop. */
4157 remote_post_process(addr, LOG_MAIN|LOG_PANIC,
4158 string_sprintf("unable to create pipe: %s", strerror(errno)), fallback);
4162 /* Find a free slot in the pardata list. Must do this after the possible
4163 waiting for processes to finish, because a terminating process will free
4166 for (poffset = 0; poffset < remote_max_parallel; poffset++)
4167 if (parlist[poffset].pid == 0) break;
4169 /* If there isn't one, there has been a horrible disaster. */
4171 if (poffset >= remote_max_parallel)
4173 (void)close(pfd[pipe_write]);
4174 (void)close(pfd[pipe_read]);
4175 remote_post_process(addr, LOG_MAIN|LOG_PANIC,
4176 US"Unexpectedly no free subprocess slot", fallback);
4180 /* Now fork a subprocess to do the remote delivery, but before doing so,
4181 ensure that any cached resourses are released so as not to interfere with
4182 what happens in the subprocess. */
4186 if ((pid = fork()) == 0)
4188 int fd = pfd[pipe_write];
4191 /* Setting this global in the subprocess means we need never clear it */
4192 transport_name = tp->name;
4194 /* There are weird circumstances in which logging is disabled */
4195 disable_logging = tp->disable_logging;
4197 /* Show pids on debug output if parallelism possible */
4199 if (parmax > 1 && (parcount > 0 || addr_remote != NULL))
4201 DEBUG(D_any|D_v) debug_selector |= D_pid;
4202 DEBUG(D_deliver) debug_printf("Remote delivery process started\n");
4205 /* Reset the random number generator, so different processes don't all
4206 have the same sequence. In the test harness we want different, but
4207 predictable settings for each delivery process, so do something explicit
4208 here rather they rely on the fixed reset in the random number function. */
4210 random_seed = running_in_test_harness? 42 + 2*delivery_count : 0;
4212 /* Set close-on-exec on the pipe so that it doesn't get passed on to
4213 a new process that may be forked to do another delivery down the same
4216 (void)fcntl(fd, F_SETFD, fcntl(fd, F_GETFD) | FD_CLOEXEC);
4218 /* Close open file descriptors for the pipes of other processes
4219 that are running in parallel. */
4221 for (poffset = 0; poffset < remote_max_parallel; poffset++)
4222 if (parlist[poffset].pid != 0) (void)close(parlist[poffset].fd);
4224 /* This process has inherited a copy of the file descriptor
4225 for the data file, but its file pointer is shared with all the
4226 other processes running in parallel. Therefore, we have to re-open
4227 the file in order to get a new file descriptor with its own
4228 file pointer. We don't need to lock it, as the lock is held by
4229 the parent process. There doesn't seem to be any way of doing
4230 a dup-with-new-file-pointer. */
4232 (void)close(deliver_datafile);
4233 sprintf(CS spoolname, "%s/input/%s/%s-D", spool_directory, message_subdir,
4235 deliver_datafile = Uopen(spoolname, O_RDWR | O_APPEND, 0);
4237 if (deliver_datafile < 0)
4238 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Failed to reopen %s for remote "
4239 "parallel delivery: %s", spoolname, strerror(errno));
4241 /* Set the close-on-exec flag */
4243 (void)fcntl(deliver_datafile, F_SETFD, fcntl(deliver_datafile, F_GETFD) |
4246 /* Set the uid/gid of this process; bombs out on failure. */
4248 exim_setugid(uid, gid, use_initgroups,
4249 string_sprintf("remote delivery to %s with transport=%s",
4250 addr->address, tp->name));
4252 /* Close the unwanted half of this process' pipe, set the process state,
4253 and run the transport. Afterwards, transport_count will contain the number
4254 of bytes written. */
4256 (void)close(pfd[pipe_read]);
4257 set_process_info("delivering %s using %s", message_id, tp->name);
4258 debug_print_string(tp->debug_string);
4259 if (!(tp->info->code)(addr->transport, addr)) replicate_status(addr);
4261 set_process_info("delivering %s (just run %s for %s%s in subprocess)",
4262 message_id, tp->name, addr->address, (addr->next == NULL)? "" : ", ...");
4264 /* Ensure any cached resources that we used are now released */
4268 /* Pass the result back down the pipe. This is a lot more information
4269 than is needed for a local delivery. We have to send back the error
4270 status for each address, the usability status for each host that is
4271 flagged as unusable, and all the retry items. When TLS is in use, we
4272 send also the cipher and peerdn information. Each type of information
4273 is flagged by an identifying byte, and is then in a fixed format (with
4274 strings terminated by zeros), and there is a final terminator at the
4275 end. The host information and retry information is all attached to
4276 the first address, so that gets sent at the start. */
4278 /* Host unusability information: for most success cases this will
4281 for (h = addr->host_list; h != NULL; h = h->next)
4283 if (h->address == NULL || h->status < hstatus_unusable) continue;
4284 sprintf(CS big_buffer, "%c%c%s", h->status, h->why, h->address);
4285 rmt_dlv_checked_write(fd, 'H', '0', big_buffer, Ustrlen(big_buffer+2) + 3);
4288 /* The number of bytes written. This is the same for each address. Even
4289 if we sent several copies of the message down the same connection, the
4290 size of each one is the same, and it's that value we have got because
4291 transport_count gets reset before calling transport_write_message(). */
4293 memcpy(big_buffer, &transport_count, sizeof(transport_count));
4294 rmt_dlv_checked_write(fd, 'S', '0', big_buffer, sizeof(transport_count));
4296 /* Information about what happened to each address. Four item types are
4297 used: an optional 'X' item first, for TLS information, then an optional "C"
4298 item for any client-auth info followed by 'R' items for any retry settings,
4299 and finally an 'A' item for the remaining data. */
4301 for(; addr != NULL; addr = addr->next)
4306 /* The certificate verification status goes into the flags */
4307 if (tls_out.certificate_verified) setflag(addr, af_cert_verified);
4308 #ifdef EXPERIMENTAL_DANE
4309 if (tls_out.dane_verified) setflag(addr, af_dane_verified);
4312 /* Use an X item only if there's something to send */
4317 sprintf(CS ptr, "%.128s", addr->cipher);
4323 sprintf(CS ptr, "%.512s", addr->peerdn);
4327 rmt_dlv_checked_write(fd, 'X', '1', big_buffer, ptr - big_buffer);
4332 if (!tls_export_cert(ptr, big_buffer_size-2, addr->peercert))
4336 rmt_dlv_checked_write(fd, 'X', '2', big_buffer, ptr - big_buffer);
4341 if (!tls_export_cert(ptr, big_buffer_size-2, addr->ourcert))
4345 rmt_dlv_checked_write(fd, 'X', '3', big_buffer, ptr - big_buffer);
4347 # ifndef DISABLE_OCSP
4348 if (addr->ocsp > OCSP_NOT_REQ)
4351 sprintf(CS ptr, "%c", addr->ocsp + '0');
4353 rmt_dlv_checked_write(fd, 'X', '4', big_buffer, ptr - big_buffer);
4356 #endif /*SUPPORT_TLS*/
4358 if (client_authenticator)
4361 sprintf(CS big_buffer, "%.64s", client_authenticator);
4363 rmt_dlv_checked_write(fd, 'C', '1', big_buffer, ptr - big_buffer);
4365 if (client_authenticated_id)
4368 sprintf(CS big_buffer, "%.64s", client_authenticated_id);
4370 rmt_dlv_checked_write(fd, 'C', '2', big_buffer, ptr - big_buffer);
4372 if (client_authenticated_sender)
4375 sprintf(CS big_buffer, "%.64s", client_authenticated_sender);
4377 rmt_dlv_checked_write(fd, 'C', '3', big_buffer, ptr - big_buffer);
4380 #ifndef DISABLE_PRDR
4381 if (addr->flags & af_prdr_used)
4382 rmt_dlv_checked_write(fd, 'P', '0', NULL, 0);
4385 memcpy(big_buffer, &addr->dsn_aware, sizeof(addr->dsn_aware));
4386 rmt_dlv_checked_write(fd, 'D', '0', big_buffer, sizeof(addr->dsn_aware));
4387 DEBUG(D_deliver) debug_printf("DSN write: addr->dsn_aware = %d\n", addr->dsn_aware);
4389 /* Retry information: for most success cases this will be null. */
4391 for (r = addr->retries; r != NULL; r = r->next)
4394 sprintf(CS big_buffer, "%c%.500s", r->flags, r->key);
4395 ptr = big_buffer + Ustrlen(big_buffer+2) + 3;
4396 memcpy(ptr, &(r->basic_errno), sizeof(r->basic_errno));
4397 ptr += sizeof(r->basic_errno);
4398 memcpy(ptr, &(r->more_errno), sizeof(r->more_errno));
4399 ptr += sizeof(r->more_errno);
4400 if (r->message == NULL) *ptr++ = 0; else
4402 sprintf(CS ptr, "%.512s", r->message);
4405 rmt_dlv_checked_write(fd, 'R', '0', big_buffer, ptr - big_buffer);
4408 /* The rest of the information goes in an 'A' item. */
4410 ptr = big_buffer + 2;
4411 sprintf(CS big_buffer, "%c%c", addr->transport_return,
4412 addr->special_action);
4413 memcpy(ptr, &(addr->basic_errno), sizeof(addr->basic_errno));
4414 ptr += sizeof(addr->basic_errno);
4415 memcpy(ptr, &(addr->more_errno), sizeof(addr->more_errno));
4416 ptr += sizeof(addr->more_errno);
4417 memcpy(ptr, &(addr->flags), sizeof(addr->flags));
4418 ptr += sizeof(addr->flags);
4420 if (addr->message == NULL) *ptr++ = 0; else
4422 sprintf(CS ptr, "%.1024s", addr->message);
4426 if (addr->user_message == NULL) *ptr++ = 0; else
4428 sprintf(CS ptr, "%.1024s", addr->user_message);
4432 if (addr->host_used == NULL) *ptr++ = 0; else
4434 sprintf(CS ptr, "%.256s", addr->host_used->name);
4436 sprintf(CS ptr, "%.64s", addr->host_used->address);
4438 memcpy(ptr, &(addr->host_used->port), sizeof(addr->host_used->port));
4439 ptr += sizeof(addr->host_used->port);
4441 /* DNS lookup status */
4442 *ptr++ = addr->host_used->dnssec==DS_YES ? '2'
4443 : addr->host_used->dnssec==DS_NO ? '1' : '0';
4446 rmt_dlv_checked_write(fd, 'A', '0', big_buffer, ptr - big_buffer);
4449 /* Local interface address/port */
4450 if (log_extra_selector & LX_incoming_interface && sending_ip_address)
4452 uschar * ptr = big_buffer;
4453 sprintf(CS ptr, "%.128s", sending_ip_address);
4455 sprintf(CS ptr, "%d", sending_port);
4458 rmt_dlv_checked_write(fd, 'I', '0', big_buffer, ptr - big_buffer);
4461 /* Add termination flag, close the pipe, and that's it. The character
4462 after 'Z' indicates whether continue_transport is now NULL or not.
4463 A change from non-NULL to NULL indicates a problem with a continuing
4466 big_buffer[0] = (continue_transport == NULL)? '0' : '1';
4467 rmt_dlv_checked_write(fd, 'Z', '0', big_buffer, 1);
4472 /* Back in the mainline: close the unwanted half of the pipe. */
4474 (void)close(pfd[pipe_write]);
4476 /* Fork failed; defer with error message */
4480 (void)close(pfd[pipe_read]);
4481 remote_post_process(addr, LOG_MAIN|LOG_PANIC,
4482 string_sprintf("fork failed for remote delivery to %s: %s",
4483 addr->domain, strerror(errno)), fallback);
4487 /* Fork succeeded; increment the count, and remember relevant data for
4488 when the process finishes. */
4491 parlist[poffset].addrlist = parlist[poffset].addr = addr;
4492 parlist[poffset].pid = pid;
4493 parlist[poffset].fd = pfd[pipe_read];
4494 parlist[poffset].done = FALSE;
4495 parlist[poffset].msg = NULL;
4496 parlist[poffset].return_path = return_path;
4498 /* If the process we've just started is sending a message down an existing
4499 channel, wait for it now. This ensures that only one such process runs at
4500 once, whatever the value of remote_max parallel. Otherwise, we might try to
4501 send two or more messages simultaneously down the same channel. This could
4502 happen if there are different domains that include the same host in otherwise
4503 different host lists.
4505 Also, if the transport closes down the channel, this information gets back
4506 (continue_transport gets set to NULL) before we consider any other addresses
4509 if (continue_transport != NULL) par_reduce(0, fallback);
4511 /* Otherwise, if we are running in the test harness, wait a bit, to let the
4512 newly created process get going before we create another process. This should
4513 ensure repeatability in the tests. We only need to wait a tad. */
4515 else if (running_in_test_harness) millisleep(500);
4518 /* Reached the end of the list of addresses. Wait for all the subprocesses that
4519 are still running and post-process their addresses. */
4521 par_reduce(0, fallback);
4528 /*************************************************
4529 * Split an address into local part and domain *
4530 *************************************************/
4532 /* This function initializes an address for routing by splitting it up into a
4533 local part and a domain. The local part is set up twice - once in its original
4534 casing, and once in lower case, and it is dequoted. We also do the "percent
4535 hack" for configured domains. This may lead to a DEFER result if a lookup
4536 defers. When a percent-hacking takes place, we insert a copy of the original
4537 address as a new parent of this address, as if we have had a redirection.
4540 addr points to an addr_item block containing the address
4543 DEFER - could not determine if domain is %-hackable
4547 deliver_split_address(address_item *addr)
4549 uschar *address = addr->address;
4550 uschar *domain = Ustrrchr(address, '@');
4552 int len = domain - address;
4554 addr->domain = string_copylc(domain+1); /* Domains are always caseless */
4556 /* The implication in the RFCs (though I can't say I've seen it spelled out
4557 explicitly) is that quoting should be removed from local parts at the point
4558 where they are locally interpreted. [The new draft "821" is more explicit on
4559 this, Jan 1999.] We know the syntax is valid, so this can be done by simply
4560 removing quoting backslashes and any unquoted doublequotes. */
4562 t = addr->cc_local_part = store_get(len+1);
4565 register int c = *address++;
4566 if (c == '\"') continue;
4576 /* We do the percent hack only for those domains that are listed in
4577 percent_hack_domains. A loop is required, to copy with multiple %-hacks. */
4579 if (percent_hack_domains != NULL)
4582 uschar *new_address = NULL;
4583 uschar *local_part = addr->cc_local_part;
4585 deliver_domain = addr->domain; /* set $domain */
4587 while ((rc = match_isinlist(deliver_domain, (const uschar **)&percent_hack_domains, 0,
4588 &domainlist_anchor, addr->domain_cache, MCL_DOMAIN, TRUE, NULL))
4590 (t = Ustrrchr(local_part, '%')) != NULL)
4592 new_address = string_copy(local_part);
4593 new_address[t - local_part] = '@';
4594 deliver_domain = string_copylc(t+1);
4595 local_part = string_copyn(local_part, t - local_part);
4598 if (rc == DEFER) return DEFER; /* lookup deferred */
4600 /* If hackery happened, set up new parent and alter the current address. */
4602 if (new_address != NULL)
4604 address_item *new_parent = store_get(sizeof(address_item));
4605 *new_parent = *addr;
4606 addr->parent = new_parent;
4607 addr->address = new_address;
4608 addr->unique = string_copy(new_address);
4609 addr->domain = deliver_domain;
4610 addr->cc_local_part = local_part;
4611 DEBUG(D_deliver) debug_printf("%%-hack changed address to: %s\n",
4616 /* Create the lowercased version of the final local part, and make that the
4617 default one to be used. */
4619 addr->local_part = addr->lc_local_part = string_copylc(addr->cc_local_part);
4626 /*************************************************
4627 * Get next error message text *
4628 *************************************************/
4630 /* If f is not NULL, read the next "paragraph", from a customized error message
4631 text file, terminated by a line containing ****, and expand it.
4634 f NULL or a file to read from
4635 which string indicating which string (for errors)
4637 Returns: NULL or an expanded string
4641 next_emf(FILE *f, uschar *which)
4645 uschar *para, *yield;
4648 if (f == NULL) return NULL;
4650 if (Ufgets(buffer, sizeof(buffer), f) == NULL ||
4651 Ustrcmp(buffer, "****\n") == 0) return NULL;
4653 para = store_get(size);
4656 para = string_cat(para, &size, &ptr, buffer, Ustrlen(buffer));
4657 if (Ufgets(buffer, sizeof(buffer), f) == NULL ||
4658 Ustrcmp(buffer, "****\n") == 0) break;
4662 yield = expand_string(para);
4663 if (yield != NULL) return yield;
4665 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand string from "
4666 "bounce_message_file or warn_message_file (%s): %s", which,
4667 expand_string_message);
4674 /*************************************************
4675 * Close down a passed transport channel *
4676 *************************************************/
4678 /* This function is called when a passed transport channel cannot be used.
4679 It attempts to close it down tidily. The yield is always DELIVER_NOT_ATTEMPTED
4680 so that the function call can be the argument of a "return" statement.
4683 Returns: DELIVER_NOT_ATTEMPTED
4687 continue_closedown(void)
4689 if (continue_transport != NULL)
4691 transport_instance *t;
4692 for (t = transports; t != NULL; t = t->next)
4694 if (Ustrcmp(t->name, continue_transport) == 0)
4696 if (t->info->closedown != NULL) (t->info->closedown)(t);
4701 return DELIVER_NOT_ATTEMPTED;
4707 /*************************************************
4708 * Print address information *
4709 *************************************************/
4711 /* This function is called to output an address, or information about an
4712 address, for bounce or defer messages. If the hide_child flag is set, all we
4713 output is the original ancestor address.
4716 addr points to the address
4717 f the FILE to print to
4718 si an initial string
4719 sc a continuation string for before "generated"
4722 Returns: TRUE if the address is not hidden
4726 print_address_information(address_item *addr, FILE *f, uschar *si, uschar *sc,
4730 uschar *printed = US"";
4731 address_item *ancestor = addr;
4732 while (ancestor->parent != NULL) ancestor = ancestor->parent;
4734 fprintf(f, "%s", CS si);
4736 if (addr->parent != NULL && testflag(addr, af_hide_child))
4738 printed = US"an undisclosed address";
4741 else if (!testflag(addr, af_pfr) || addr->parent == NULL)
4742 printed = addr->address;
4746 uschar *s = addr->address;
4749 if (addr->address[0] == '>') { ss = US"mail"; s++; }
4750 else if (addr->address[0] == '|') ss = US"pipe";
4753 fprintf(f, "%s to %s%sgenerated by ", ss, s, sc);
4754 printed = addr->parent->address;
4757 fprintf(f, "%s", CS string_printing(printed));
4759 if (ancestor != addr)
4761 uschar *original = (ancestor->onetime_parent == NULL)?
4762 ancestor->address : ancestor->onetime_parent;
4763 if (strcmpic(original, printed) != 0)
4764 fprintf(f, "%s(%sgenerated from %s)", sc,
4765 (ancestor != addr->parent)? "ultimately " : "",
4766 string_printing(original));
4769 if (addr->host_used)
4770 fprintf(f, "\n host %s [%s]",
4771 addr->host_used->name, addr->host_used->address);
4773 fprintf(f, "%s", CS se);
4781 /*************************************************
4782 * Print error for an address *
4783 *************************************************/
4785 /* This function is called to print the error information out of an address for
4786 a bounce or a warning message. It tries to format the message reasonably by
4787 introducing newlines. All lines are indented by 4; the initial printing
4788 position must be set before calling.
4790 This function used always to print the error. Nowadays we want to restrict it
4791 to cases such as LMTP/SMTP errors from a remote host, and errors from :fail:
4792 and filter "fail". We no longer pass other information willy-nilly in bounce
4793 and warning messages. Text in user_message is always output; text in message
4794 only if the af_pass_message flag is set.
4798 f the FILE to print on
4805 print_address_error(address_item *addr, FILE *f, uschar *t)
4807 int count = Ustrlen(t);
4808 uschar *s = testflag(addr, af_pass_message)? addr->message : NULL;
4812 if (addr->user_message != NULL) s = addr->user_message; else return;
4815 fprintf(f, "\n %s", t);
4819 if (*s == '\\' && s[1] == 'n')
4829 if (*s++ == ':' && isspace(*s) && count > 45)
4831 fprintf(f, "\n "); /* sic (because space follows) */
4839 /***********************************************************
4840 * Print Diagnostic-Code for an address *
4841 ************************************************************/
4843 /* This function is called to print the error information out of an address for
4844 a bounce or a warning message. It tries to format the message reasonably as
4845 required by RFC 3461 by adding a space after each newline
4847 we assume that this function is only called if addr->host_used is set and if so
4848 a useable addr->message is available containing some Exim description with ": \n"
4849 ending, followed by the L/SMTP error message.
4853 f the FILE to print on
4859 print_dsn_diagnostic_code(const address_item *addr, FILE *f)
4863 /* check host_used, af_pass_message flag and addr->message for safety reasons */
4864 if (!addr->host_used && testflag(addr, af_pass_message) && addr->message)
4867 /* search first ": ". we assume to find the remote-MTA answer there */
4869 debug_printf("DSN Diagnostic-Code: addr->dsn_message = %s\n", addr->message);
4870 if (!(s = Ustrstr(addr->message, ": ")))
4871 return; /* not found, bail out */
4873 fprintf(f, "Diagnostic-Code: smtp; ");
4875 s += 2; /* skip ": " */
4877 if (*s == '\\' && s[1] == 'n')
4879 fputs("\n ", f); /* as defined in RFC 3461 */
4889 /*************************************************
4890 * Check list of addresses for duplication *
4891 *************************************************/
4893 /* This function was introduced when the test for duplicate addresses that are
4894 not pipes, files, or autoreplies was moved from the middle of routing to when
4895 routing was complete. That was to fix obscure cases when the routing history
4896 affects the subsequent routing of identical addresses. This function is called
4897 after routing, to check that the final routed addresses are not duplicates.
4899 If we detect a duplicate, we remember what it is a duplicate of. Note that
4900 pipe, file, and autoreply de-duplication is handled during routing, so we must
4901 leave such "addresses" alone here, as otherwise they will incorrectly be
4904 Argument: address of list anchor
4909 do_duplicate_check(address_item **anchor)
4912 while ((addr = *anchor) != NULL)
4915 if (testflag(addr, af_pfr))
4917 anchor = &(addr->next);
4919 else if ((tnode = tree_search(tree_duplicates, addr->unique)) != NULL)
4921 DEBUG(D_deliver|D_route)
4922 debug_printf("%s is a duplicate address: discarded\n", addr->unique);
4923 *anchor = addr->next;
4924 addr->dupof = tnode->data.ptr;
4925 addr->next = addr_duplicate;
4926 addr_duplicate = addr;
4930 tree_add_duplicate(addr->unique, addr);
4931 anchor = &(addr->next);
4939 /*************************************************
4940 * Deliver one message *
4941 *************************************************/
4943 /* This is the function which is called when a message is to be delivered. It
4944 is passed the id of the message. It is possible that the message no longer
4945 exists, if some other process has delivered it, and it is also possible that
4946 the message is being worked on by another process, in which case the data file
4949 If no delivery is attempted for any of the above reasons, the function returns
4950 DELIVER_NOT_ATTEMPTED.
4952 If the give_up flag is set true, do not attempt any deliveries, but instead
4953 fail all outstanding addresses and return the message to the sender (or
4956 A delivery operation has a process all to itself; we never deliver more than
4957 one message in the same process. Therefore we needn't worry too much about
4961 id the id of the message to be delivered
4962 forced TRUE if delivery was forced by an administrator; this overrides
4963 retry delays and causes a delivery to be tried regardless
4964 give_up TRUE if an administrator has requested that delivery attempts
4967 Returns: When the global variable mua_wrapper is FALSE:
4968 DELIVER_ATTEMPTED_NORMAL if a delivery attempt was made
4969 DELIVER_NOT_ATTEMPTED otherwise (see comment above)
4970 When the global variable mua_wrapper is TRUE:
4971 DELIVER_MUA_SUCCEEDED if delivery succeeded
4972 DELIVER_MUA_FAILED if delivery failed
4973 DELIVER_NOT_ATTEMPTED if not attempted (should not occur)
4977 deliver_message(uschar *id, BOOL forced, BOOL give_up)
4980 int final_yield = DELIVER_ATTEMPTED_NORMAL;
4981 time_t now = time(NULL);
4982 address_item *addr_last = NULL;
4983 uschar *filter_message = NULL;
4985 int process_recipients = RECIP_ACCEPT;
4988 extern int acl_where;
4990 uschar *info = (queue_run_pid == (pid_t)0)?
4991 string_sprintf("delivering %s", id) :
4992 string_sprintf("delivering %s (queue run pid %d)", id, queue_run_pid);
4994 /* If the D_process_info bit is on, set_process_info() will output debugging
4995 information. If not, we want to show this initial information if D_deliver or
4996 D_queue_run is set or in verbose mode. */
4998 set_process_info("%s", info);
5000 if ((debug_selector & D_process_info) == 0 &&
5001 (debug_selector & (D_deliver|D_queue_run|D_v)) != 0)
5002 debug_printf("%s\n", info);
5004 /* Ensure that we catch any subprocesses that are created. Although Exim
5005 sets SIG_DFL as its initial default, some routes through the code end up
5006 here with it set to SIG_IGN - cases where a non-synchronous delivery process
5007 has been forked, but no re-exec has been done. We use sigaction rather than
5008 plain signal() on those OS where SA_NOCLDWAIT exists, because we want to be
5009 sure it is turned off. (There was a problem on AIX with this.) */
5013 struct sigaction act;
5014 act.sa_handler = SIG_DFL;
5015 sigemptyset(&(act.sa_mask));
5017 sigaction(SIGCHLD, &act, NULL);
5020 signal(SIGCHLD, SIG_DFL);
5023 /* Make the forcing flag available for routers and transports, set up the
5024 global message id field, and initialize the count for returned files and the
5025 message size. This use of strcpy() is OK because the length id is checked when
5026 it is obtained from a command line (the -M or -q options), and otherwise it is
5027 known to be a valid message id. */
5029 Ustrcpy(message_id, id);
5030 deliver_force = forced;
5034 /* Initialize some flags */
5036 update_spool = FALSE;
5037 remove_journal = TRUE;
5039 /* Set a known context for any ACLs we call via expansions */
5040 acl_where = ACL_WHERE_DELIVERY;
5042 /* Reset the random number generator, so that if several delivery processes are
5043 started from a queue runner that has already used random numbers (for sorting),
5044 they don't all get the same sequence. */
5048 /* Open and lock the message's data file. Exim locks on this one because the
5049 header file may get replaced as it is re-written during the delivery process.
5050 Any failures cause messages to be written to the log, except for missing files
5051 while queue running - another process probably completed delivery. As part of
5052 opening the data file, message_subdir gets set. */
5054 if (!spool_open_datafile(id))
5055 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5057 /* The value of message_size at this point has been set to the data length,
5058 plus one for the blank line that notionally precedes the data. */
5060 /* Now read the contents of the header file, which will set up the headers in
5061 store, and also the list of recipients and the tree of non-recipients and
5062 assorted flags. It updates message_size. If there is a reading or format error,
5063 give up; if the message has been around for sufficiently long, remove it. */
5065 sprintf(CS spoolname, "%s-H", id);
5066 if ((rc = spool_read_header(spoolname, TRUE, TRUE)) != spool_read_OK)
5068 if (errno == ERRNO_SPOOLFORMAT)
5070 struct stat statbuf;
5071 sprintf(CS big_buffer, "%s/input/%s/%s", spool_directory, message_subdir,
5073 if (Ustat(big_buffer, &statbuf) == 0)
5074 log_write(0, LOG_MAIN, "Format error in spool file %s: "
5075 "size=" OFF_T_FMT, spoolname, statbuf.st_size);
5076 else log_write(0, LOG_MAIN, "Format error in spool file %s", spoolname);
5079 log_write(0, LOG_MAIN, "Error reading spool file %s: %s", spoolname,
5082 /* If we managed to read the envelope data, received_time contains the
5083 time the message was received. Otherwise, we can calculate it from the
5086 if (rc != spool_read_hdrerror)
5089 for (i = 0; i < 6; i++)
5090 received_time = received_time * BASE_62 + tab62[id[i] - '0'];
5093 /* If we've had this malformed message too long, sling it. */
5095 if (now - received_time > keep_malformed)
5097 sprintf(CS spoolname, "%s/msglog/%s/%s", spool_directory, message_subdir, id);
5099 sprintf(CS spoolname, "%s/input/%s/%s-D", spool_directory, message_subdir, id);
5101 sprintf(CS spoolname, "%s/input/%s/%s-H", spool_directory, message_subdir, id);
5103 sprintf(CS spoolname, "%s/input/%s/%s-J", spool_directory, message_subdir, id);
5105 log_write(0, LOG_MAIN, "Message removed because older than %s",
5106 readconf_printtime(keep_malformed));
5109 (void)close(deliver_datafile);
5110 deliver_datafile = -1;
5111 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5114 /* The spool header file has been read. Look to see if there is an existing
5115 journal file for this message. If there is, it means that a previous delivery
5116 attempt crashed (program or host) before it could update the spool header file.
5117 Read the list of delivered addresses from the journal and add them to the
5118 nonrecipients tree. Then update the spool file. We can leave the journal in
5119 existence, as it will get further successful deliveries added to it in this
5120 run, and it will be deleted if this function gets to its end successfully.
5121 Otherwise it might be needed again. */
5123 sprintf(CS spoolname, "%s/input/%s/%s-J", spool_directory, message_subdir, id);
5124 jread = Ufopen(spoolname, "rb");
5127 while (Ufgets(big_buffer, big_buffer_size, jread) != NULL)
5129 int n = Ustrlen(big_buffer);
5130 big_buffer[n-1] = 0;
5131 tree_add_nonrecipient(big_buffer);
5132 DEBUG(D_deliver) debug_printf("Previously delivered address %s taken from "
5133 "journal file\n", big_buffer);
5135 (void)fclose(jread);
5136 /* Panic-dies on error */
5137 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
5139 else if (errno != ENOENT)
5141 log_write(0, LOG_MAIN|LOG_PANIC, "attempt to open journal for reading gave: "
5142 "%s", strerror(errno));
5143 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5146 /* A null recipients list indicates some kind of disaster. */
5148 if (recipients_list == NULL)
5150 (void)close(deliver_datafile);
5151 deliver_datafile = -1;
5152 log_write(0, LOG_MAIN, "Spool error: no recipients for %s", spoolname);
5153 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5157 /* Handle a message that is frozen. There are a number of different things that
5158 can happen, but in the default situation, unless forced, no delivery is
5163 #ifdef SUPPORT_MOVE_FROZEN_MESSAGES
5164 /* Moving to another directory removes the message from Exim's view. Other
5165 tools must be used to deal with it. Logging of this action happens in
5166 spool_move_message() and its subfunctions. */
5168 if (move_frozen_messages &&
5169 spool_move_message(id, message_subdir, US"", US"F"))
5170 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5173 /* For all frozen messages (bounces or not), timeout_frozen_after sets the
5174 maximum time to keep messages that are frozen. Thaw if we reach it, with a
5175 flag causing all recipients to be failed. The time is the age of the
5176 message, not the time since freezing. */
5178 if (timeout_frozen_after > 0 && message_age >= timeout_frozen_after)
5180 log_write(0, LOG_MAIN, "cancelled by timeout_frozen_after");
5181 process_recipients = RECIP_FAIL_TIMEOUT;
5184 /* For bounce messages (and others with no sender), thaw if the error message
5185 ignore timer is exceeded. The message will be discarded if this delivery
5188 else if (sender_address[0] == 0 && message_age >= ignore_bounce_errors_after)
5190 log_write(0, LOG_MAIN, "Unfrozen by errmsg timer");
5193 /* If this is a bounce message, or there's no auto thaw, or we haven't
5194 reached the auto thaw time yet, and this delivery is not forced by an admin
5195 user, do not attempt delivery of this message. Note that forced is set for
5196 continuing messages down the same channel, in order to skip load checking and
5197 ignore hold domains, but we don't want unfreezing in that case. */
5201 if ((sender_address[0] == 0 ||
5203 now <= deliver_frozen_at + auto_thaw
5206 (!forced || !deliver_force_thaw || !admin_user ||
5207 continue_hostname != NULL
5210 (void)close(deliver_datafile);
5211 deliver_datafile = -1;
5212 log_write(L_skip_delivery, LOG_MAIN, "Message is frozen");
5213 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5216 /* If delivery was forced (by an admin user), assume a manual thaw.
5217 Otherwise it's an auto thaw. */
5221 deliver_manual_thaw = TRUE;
5222 log_write(0, LOG_MAIN, "Unfrozen by forced delivery");
5224 else log_write(0, LOG_MAIN, "Unfrozen by auto-thaw");
5227 /* We get here if any of the rules for unfreezing have triggered. */
5229 deliver_freeze = FALSE;
5230 update_spool = TRUE;
5234 /* Open the message log file if we are using them. This records details of
5235 deliveries, deferments, and failures for the benefit of the mail administrator.
5236 The log is not used by exim itself to track the progress of a message; that is
5237 done by rewriting the header spool file. */
5244 sprintf(CS spoolname, "%s/msglog/%s/%s", spool_directory, message_subdir, id);
5245 fd = open_msglog_file(spoolname, SPOOL_MODE, &error);
5249 log_write(0, LOG_MAIN|LOG_PANIC, "Couldn't %s message log %s: %s", error,
5250 spoolname, strerror(errno));
5251 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5254 /* Make a C stream out of it. */
5256 message_log = fdopen(fd, "a");
5257 if (message_log == NULL)
5259 log_write(0, LOG_MAIN|LOG_PANIC, "Couldn't fdopen message log %s: %s",
5260 spoolname, strerror(errno));
5261 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5266 /* If asked to give up on a message, log who did it, and set the action for all
5271 struct passwd *pw = getpwuid(real_uid);
5272 log_write(0, LOG_MAIN, "cancelled by %s", (pw != NULL)?
5273 US pw->pw_name : string_sprintf("uid %ld", (long int)real_uid));
5274 process_recipients = RECIP_FAIL;
5277 /* Otherwise, if there are too many Received: headers, fail all recipients. */
5279 else if (received_count > received_headers_max)
5280 process_recipients = RECIP_FAIL_LOOP;
5282 /* Otherwise, if a system-wide, address-independent message filter is
5283 specified, run it now, except in the case when we are failing all recipients as
5284 a result of timeout_frozen_after. If the system filter yields "delivered", then
5285 ignore the true recipients of the message. Failure of the filter file is
5286 logged, and the delivery attempt fails. */
5288 else if (system_filter != NULL && process_recipients != RECIP_FAIL_TIMEOUT)
5293 redirect_block redirect;
5295 if (system_filter_uid_set)
5297 ugid.uid = system_filter_uid;
5298 ugid.gid = system_filter_gid;
5299 ugid.uid_set = ugid.gid_set = TRUE;
5303 ugid.uid_set = ugid.gid_set = FALSE;
5306 return_path = sender_address;
5307 enable_dollar_recipients = TRUE; /* Permit $recipients in system filter */
5308 system_filtering = TRUE;
5310 /* Any error in the filter file causes a delivery to be abandoned. */
5312 redirect.string = system_filter;
5313 redirect.isfile = TRUE;
5314 redirect.check_owner = redirect.check_group = FALSE;
5315 redirect.owners = NULL;
5316 redirect.owngroups = NULL;
5318 redirect.modemask = 0;
5320 DEBUG(D_deliver|D_filter) debug_printf("running system filter\n");
5323 &redirect, /* Where the data is */
5324 RDO_DEFER | /* Turn on all the enabling options */
5325 RDO_FAIL | /* Leave off all the disabling options */
5330 NULL, /* No :include: restriction (not used in filter) */
5331 NULL, /* No sieve vacation directory (not sieve!) */
5332 NULL, /* No sieve enotify mailto owner (not sieve!) */
5333 NULL, /* No sieve user address (not sieve!) */
5334 NULL, /* No sieve subaddress (not sieve!) */
5335 &ugid, /* uid/gid data */
5336 &addr_new, /* Where to hang generated addresses */
5337 &filter_message, /* Where to put error message */
5338 NULL, /* Don't skip syntax errors */
5339 &filtertype, /* Will always be set to FILTER_EXIM for this call */
5340 US"system filter"); /* For error messages */
5342 DEBUG(D_deliver|D_filter) debug_printf("system filter returned %d\n", rc);
5344 if (rc == FF_ERROR || rc == FF_NONEXIST)
5346 (void)close(deliver_datafile);
5347 deliver_datafile = -1;
5348 log_write(0, LOG_MAIN|LOG_PANIC, "Error in system filter: %s",
5349 string_printing(filter_message));
5350 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5353 /* Reset things. If the filter message is an empty string, which can happen
5354 for a filter "fail" or "freeze" command with no text, reset it to NULL. */
5356 system_filtering = FALSE;
5357 enable_dollar_recipients = FALSE;
5358 if (filter_message != NULL && filter_message[0] == 0) filter_message = NULL;
5360 /* Save the values of the system filter variables so that user filters
5363 memcpy(filter_sn, filter_n, sizeof(filter_sn));
5365 /* The filter can request that delivery of the original addresses be
5370 process_recipients = RECIP_DEFER;
5371 deliver_msglog("Delivery deferred by system filter\n");
5372 log_write(0, LOG_MAIN, "Delivery deferred by system filter");
5375 /* The filter can request that a message be frozen, but this does not
5376 take place if the message has been manually thawed. In that case, we must
5377 unset "delivered", which is forced by the "freeze" command to make -bF
5380 else if (rc == FF_FREEZE && !deliver_manual_thaw)
5382 deliver_freeze = TRUE;
5383 deliver_frozen_at = time(NULL);
5384 process_recipients = RECIP_DEFER;
5385 frozen_info = string_sprintf(" by the system filter%s%s",
5386 (filter_message == NULL)? US"" : US": ",
5387 (filter_message == NULL)? US"" : filter_message);
5390 /* The filter can request that a message be failed. The error message may be
5391 quite long - it is sent back to the sender in the bounce - but we don't want
5392 to fill up the log with repetitions of it. If it starts with << then the text
5393 between << and >> is written to the log, with the rest left for the bounce
5396 else if (rc == FF_FAIL)
5398 uschar *colon = US"";
5399 uschar *logmsg = US"";
5402 process_recipients = RECIP_FAIL_FILTER;
5404 if (filter_message != NULL)
5408 if (filter_message[0] == '<' && filter_message[1] == '<' &&
5409 (logend = Ustrstr(filter_message, ">>")) != NULL)
5411 logmsg = filter_message + 2;
5412 loglen = logend - logmsg;
5413 filter_message = logend + 2;
5414 if (filter_message[0] == 0) filter_message = NULL;
5418 logmsg = filter_message;
5419 loglen = Ustrlen(filter_message);
5423 log_write(0, LOG_MAIN, "cancelled by system filter%s%.*s", colon, loglen,
5427 /* Delivery can be restricted only to those recipients (if any) that the
5428 filter specified. */
5430 else if (rc == FF_DELIVERED)
5432 process_recipients = RECIP_IGNORE;
5433 if (addr_new == NULL)
5434 log_write(0, LOG_MAIN, "=> discarded (system filter)");
5436 log_write(0, LOG_MAIN, "original recipients ignored (system filter)");
5439 /* If any new addresses were created by the filter, fake up a "parent"
5440 for them. This is necessary for pipes, etc., which are expected to have
5441 parents, and it also gives some sensible logging for others. Allow
5442 pipes, files, and autoreplies, and run them as the filter uid if set,
5443 otherwise as the current uid. */
5445 if (addr_new != NULL)
5447 int uid = (system_filter_uid_set)? system_filter_uid : geteuid();
5448 int gid = (system_filter_gid_set)? system_filter_gid : getegid();
5450 /* The text "system-filter" is tested in transport_set_up_command() and in
5451 set_up_shell_command() in the pipe transport, to enable them to permit
5452 $recipients, so don't change it here without also changing it there. */
5454 address_item *p = addr_new;
5455 address_item *parent = deliver_make_addr(US"system-filter", FALSE);
5457 parent->domain = string_copylc(qualify_domain_recipient);
5458 parent->local_part = US"system-filter";
5460 /* As part of this loop, we arrange for addr_last to end up pointing
5461 at the final address. This is used if we go on to add addresses for the
5462 original recipients. */
5466 if (parent->child_count == SHRT_MAX)
5467 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "system filter generated more "
5468 "than %d delivery addresses", SHRT_MAX);
5469 parent->child_count++;
5472 if (testflag(p, af_pfr))
5478 setflag(p, af_uid_set |
5484 /* Find the name of the system filter's appropriate pfr transport */
5486 if (p->address[0] == '|')
5489 tpname = system_filter_pipe_transport;
5490 address_pipe = p->address;
5492 else if (p->address[0] == '>')
5495 tpname = system_filter_reply_transport;
5499 if (p->address[Ustrlen(p->address)-1] == '/')
5501 type = US"directory";
5502 tpname = system_filter_directory_transport;
5507 tpname = system_filter_file_transport;
5509 address_file = p->address;
5512 /* Now find the actual transport, first expanding the name. We have
5513 set address_file or address_pipe above. */
5517 uschar *tmp = expand_string(tpname);
5518 address_file = address_pipe = NULL;
5520 p->message = string_sprintf("failed to expand \"%s\" as a "
5521 "system filter transport name", tpname);
5526 p->message = string_sprintf("system_filter_%s_transport is unset",
5532 transport_instance *tp;
5533 for (tp = transports; tp != NULL; tp = tp->next)
5535 if (Ustrcmp(tp->name, tpname) == 0)
5542 p->message = string_sprintf("failed to find \"%s\" transport "
5543 "for system filter delivery", tpname);
5546 /* If we couldn't set up a transport, defer the delivery, putting the
5547 error on the panic log as well as the main log. */
5549 if (p->transport == NULL)
5551 address_item *badp = p;
5553 if (addr_last == NULL) addr_new = p; else addr_last->next = p;
5554 badp->local_part = badp->address; /* Needed for log line */
5555 post_process_one(badp, DEFER, LOG_MAIN|LOG_PANIC, DTYPE_ROUTER, 0);
5558 } /* End of pfr handling */
5560 /* Either a non-pfr delivery, or we found a transport */
5562 DEBUG(D_deliver|D_filter)
5563 debug_printf("system filter added %s\n", p->address);
5567 } /* Loop through all addr_new addresses */
5572 /* Scan the recipients list, and for every one that is not in the non-
5573 recipients tree, add an addr item to the chain of new addresses. If the pno
5574 value is non-negative, we must set the onetime parent from it. This which
5575 points to the relevant entry in the recipients list.
5577 This processing can be altered by the setting of the process_recipients
5578 variable, which is changed if recipients are to be ignored, failed, or
5579 deferred. This can happen as a result of system filter activity, or if the -Mg
5580 option is used to fail all of them.
5582 Duplicate addresses are handled later by a different tree structure; we can't
5583 just extend the non-recipients tree, because that will be re-written to the
5584 spool if the message is deferred, and in any case there are casing
5585 complications for local addresses. */
5587 if (process_recipients != RECIP_IGNORE)
5589 for (i = 0; i < recipients_count; i++)
5591 if (tree_search(tree_nonrecipients, recipients_list[i].address) == NULL)
5593 recipient_item *r = recipients_list + i;
5594 address_item *new = deliver_make_addr(r->address, FALSE);
5595 new->p.errors_address = r->errors_to;
5598 new->onetime_parent = recipients_list[r->pno].address;
5600 /* If DSN support is enabled, set the dsn flags and the original receipt
5601 to be passed on to other DSN enabled MTAs */
5602 new->dsn_flags = r->dsn_flags & rf_dsnflags;
5603 new->dsn_orcpt = r->orcpt;
5604 DEBUG(D_deliver) debug_printf("DSN: set orcpt: %s flags: %d\n", new->dsn_orcpt, new->dsn_flags);
5606 switch (process_recipients)
5608 /* RECIP_DEFER is set when a system filter freezes a message. */
5611 new->next = addr_defer;
5616 /* RECIP_FAIL_FILTER is set when a system filter has obeyed a "fail"
5619 case RECIP_FAIL_FILTER:
5621 (filter_message == NULL)? US"delivery cancelled" : filter_message;
5622 setflag(new, af_pass_message);
5623 goto RECIP_QUEUE_FAILED; /* below */
5626 /* RECIP_FAIL_TIMEOUT is set when a message is frozen, but is older
5627 than the value in timeout_frozen_after. Treat non-bounce messages
5628 similarly to -Mg; for bounce messages we just want to discard, so
5629 don't put the address on the failed list. The timeout has already
5632 case RECIP_FAIL_TIMEOUT:
5633 new->message = US"delivery cancelled; message timed out";
5634 goto RECIP_QUEUE_FAILED; /* below */
5637 /* RECIP_FAIL is set when -Mg has been used. */
5640 new->message = US"delivery cancelled by administrator";
5643 /* Common code for the failure cases above. If this is not a bounce
5644 message, put the address on the failed list so that it is used to
5645 create a bounce. Otherwise do nothing - this just discards the address.
5646 The incident has already been logged. */
5649 if (sender_address[0] != 0)
5651 new->next = addr_failed;
5657 /* RECIP_FAIL_LOOP is set when there are too many Received: headers
5658 in the message. Process each address as a routing failure; if this
5659 is a bounce message, it will get frozen. */
5661 case RECIP_FAIL_LOOP:
5662 new->message = US"Too many \"Received\" headers - suspected mail loop";
5663 post_process_one(new, FAIL, LOG_MAIN, DTYPE_ROUTER, 0);
5667 /* Value should be RECIP_ACCEPT; take this as the safe default. */
5670 if (addr_new == NULL) addr_new = new; else addr_last->next = new;
5675 #ifdef EXPERIMENTAL_EVENT
5676 if (process_recipients != RECIP_ACCEPT)
5678 uschar * save_local = deliver_localpart;
5679 const uschar * save_domain = deliver_domain;
5681 deliver_localpart = expand_string(
5682 string_sprintf("${local_part:%s}", new->address));
5683 deliver_domain = expand_string(
5684 string_sprintf("${domain:%s}", new->address));
5686 (void) event_raise(event_action,
5687 US"msg:fail:internal", new->message);
5689 deliver_localpart = save_local;
5690 deliver_domain = save_domain;
5699 address_item *p = addr_new;
5700 debug_printf("Delivery address list:\n");
5703 debug_printf(" %s %s\n", p->address, (p->onetime_parent == NULL)? US"" :
5709 /* Set up the buffers used for copying over the file when delivering. */
5711 deliver_in_buffer = store_malloc(DELIVER_IN_BUFFER_SIZE);
5712 deliver_out_buffer = store_malloc(DELIVER_OUT_BUFFER_SIZE);
5716 /* Until there are no more new addresses, handle each one as follows:
5718 . If this is a generated address (indicated by the presence of a parent
5719 pointer) then check to see whether it is a pipe, file, or autoreply, and
5720 if so, handle it directly here. The router that produced the address will
5721 have set the allow flags into the address, and also set the uid/gid required.
5722 Having the routers generate new addresses and then checking them here at
5723 the outer level is tidier than making each router do the checking, and
5724 means that routers don't need access to the failed address queue.
5726 . Break up the address into local part and domain, and make lowercased
5727 versions of these strings. We also make unquoted versions of the local part.
5729 . Handle the percent hack for those domains for which it is valid.
5731 . For child addresses, determine if any of the parents have the same address.
5732 If so, generate a different string for previous delivery checking. Without
5733 this code, if the address spqr generates spqr via a forward or alias file,
5734 delivery of the generated spqr stops further attempts at the top level spqr,
5735 which is not what is wanted - it may have generated other addresses.
5737 . Check on the retry database to see if routing was previously deferred, but
5738 only if in a queue run. Addresses that are to be routed are put on the
5739 addr_route chain. Addresses that are to be deferred are put on the
5740 addr_defer chain. We do all the checking first, so as not to keep the
5741 retry database open any longer than necessary.
5743 . Now we run the addresses through the routers. A router may put the address
5744 on either the addr_local or the addr_remote chain for local or remote
5745 delivery, respectively, or put it on the addr_failed chain if it is
5746 undeliveable, or it may generate child addresses and put them on the
5747 addr_new chain, or it may defer an address. All the chain anchors are
5748 passed as arguments so that the routers can be called for verification
5751 . If new addresses have been generated by the routers, da capo.
5754 header_rewritten = FALSE; /* No headers rewritten yet */
5755 while (addr_new != NULL) /* Loop until all addresses dealt with */
5757 address_item *addr, *parent;
5758 dbm_file = dbfn_open(US"retry", O_RDONLY, &dbblock, FALSE);
5760 /* Failure to open the retry database is treated the same as if it does
5761 not exist. In both cases, dbm_file is NULL. */
5763 if (dbm_file == NULL)
5765 DEBUG(D_deliver|D_retry|D_route|D_hints_lookup)
5766 debug_printf("no retry data available\n");
5769 /* Scan the current batch of new addresses, to handle pipes, files and
5770 autoreplies, and determine which others are ready for routing. */
5772 while (addr_new != NULL)
5777 dbdata_retry *domain_retry_record;
5778 dbdata_retry *address_retry_record;
5781 addr_new = addr->next;
5783 DEBUG(D_deliver|D_retry|D_route)
5785 debug_printf(">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>\n");
5786 debug_printf("Considering: %s\n", addr->address);
5789 /* Handle generated address that is a pipe or a file or an autoreply. */
5791 if (testflag(addr, af_pfr))
5793 /* If an autoreply in a filter could not generate a syntactically valid
5794 address, give up forthwith. Set af_ignore_error so that we don't try to
5795 generate a bounce. */
5797 if (testflag(addr, af_bad_reply))
5799 addr->basic_errno = ERRNO_BADADDRESS2;
5800 addr->local_part = addr->address;
5802 US"filter autoreply generated syntactically invalid recipient";
5803 setflag(addr, af_ignore_error);
5804 (void)post_process_one(addr, FAIL, LOG_MAIN, DTYPE_ROUTER, 0);
5805 continue; /* with the next new address */
5808 /* If two different users specify delivery to the same pipe or file or
5809 autoreply, there should be two different deliveries, so build a unique
5810 string that incorporates the original address, and use this for
5811 duplicate testing and recording delivery, and also for retrying. */
5814 string_sprintf("%s:%s", addr->address, addr->parent->unique +
5815 (testflag(addr->parent, af_homonym)? 3:0));
5817 addr->address_retry_key = addr->domain_retry_key =
5818 string_sprintf("T:%s", addr->unique);
5820 /* If a filter file specifies two deliveries to the same pipe or file,
5821 we want to de-duplicate, but this is probably not wanted for two mail
5822 commands to the same address, where probably both should be delivered.
5823 So, we have to invent a different unique string in that case. Just
5824 keep piling '>' characters on the front. */
5826 if (addr->address[0] == '>')
5828 while (tree_search(tree_duplicates, addr->unique) != NULL)
5829 addr->unique = string_sprintf(">%s", addr->unique);
5832 else if ((tnode = tree_search(tree_duplicates, addr->unique)) != NULL)
5834 DEBUG(D_deliver|D_route)
5835 debug_printf("%s is a duplicate address: discarded\n", addr->address);
5836 addr->dupof = tnode->data.ptr;
5837 addr->next = addr_duplicate;
5838 addr_duplicate = addr;
5842 DEBUG(D_deliver|D_route) debug_printf("unique = %s\n", addr->unique);
5844 /* Check for previous delivery */
5846 if (tree_search(tree_nonrecipients, addr->unique) != NULL)
5848 DEBUG(D_deliver|D_route)
5849 debug_printf("%s was previously delivered: discarded\n", addr->address);
5850 child_done(addr, tod_stamp(tod_log));
5854 /* Save for checking future duplicates */
5856 tree_add_duplicate(addr->unique, addr);
5858 /* Set local part and domain */
5860 addr->local_part = addr->address;
5861 addr->domain = addr->parent->domain;
5863 /* Ensure that the delivery is permitted. */
5865 if (testflag(addr, af_file))
5867 if (!testflag(addr, af_allow_file))
5869 addr->basic_errno = ERRNO_FORBIDFILE;
5870 addr->message = US"delivery to file forbidden";
5871 (void)post_process_one(addr, FAIL, LOG_MAIN, DTYPE_ROUTER, 0);
5872 continue; /* with the next new address */
5875 else if (addr->address[0] == '|')
5877 if (!testflag(addr, af_allow_pipe))
5879 addr->basic_errno = ERRNO_FORBIDPIPE;
5880 addr->message = US"delivery to pipe forbidden";
5881 (void)post_process_one(addr, FAIL, LOG_MAIN, DTYPE_ROUTER, 0);
5882 continue; /* with the next new address */
5885 else if (!testflag(addr, af_allow_reply))
5887 addr->basic_errno = ERRNO_FORBIDREPLY;
5888 addr->message = US"autoreply forbidden";
5889 (void)post_process_one(addr, FAIL, LOG_MAIN, DTYPE_ROUTER, 0);
5890 continue; /* with the next new address */
5893 /* If the errno field is already set to BADTRANSPORT, it indicates
5894 failure to expand a transport string, or find the associated transport,
5895 or an unset transport when one is required. Leave this test till now so
5896 that the forbid errors are given in preference. */
5898 if (addr->basic_errno == ERRNO_BADTRANSPORT)
5900 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_ROUTER, 0);
5904 /* Treat /dev/null as a special case and abandon the delivery. This
5905 avoids having to specify a uid on the transport just for this case.
5906 Arrange for the transport name to be logged as "**bypassed**". */
5908 if (Ustrcmp(addr->address, "/dev/null") == 0)
5910 uschar *save = addr->transport->name;
5911 addr->transport->name = US"**bypassed**";
5912 (void)post_process_one(addr, OK, LOG_MAIN, DTYPE_TRANSPORT, '=');
5913 addr->transport->name = save;
5914 continue; /* with the next new address */
5917 /* Pipe, file, or autoreply delivery is to go ahead as a normal local
5920 DEBUG(D_deliver|D_route)
5921 debug_printf("queued for %s transport\n", addr->transport->name);
5922 addr->next = addr_local;
5924 continue; /* with the next new address */
5927 /* Handle normal addresses. First, split up into local part and domain,
5928 handling the %-hack if necessary. There is the possibility of a defer from
5929 a lookup in percent_hack_domains. */
5931 if ((rc = deliver_split_address(addr)) == DEFER)
5933 addr->message = US"cannot check percent_hack_domains";
5934 addr->basic_errno = ERRNO_LISTDEFER;
5935 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_NONE, 0);
5939 /* Check to see if the domain is held. If so, proceed only if the
5940 delivery was forced by hand. */
5942 deliver_domain = addr->domain; /* set $domain */
5943 if (!forced && hold_domains != NULL &&
5944 (rc = match_isinlist(addr->domain, (const uschar **)&hold_domains, 0,
5945 &domainlist_anchor, addr->domain_cache, MCL_DOMAIN, TRUE,
5950 addr->message = US"hold_domains lookup deferred";
5951 addr->basic_errno = ERRNO_LISTDEFER;
5955 addr->message = US"domain is held";
5956 addr->basic_errno = ERRNO_HELD;
5958 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_NONE, 0);
5962 /* Now we can check for duplicates and previously delivered addresses. In
5963 order to do this, we have to generate a "unique" value for each address,
5964 because there may be identical actual addresses in a line of descendents.
5965 The "unique" field is initialized to the same value as the "address" field,
5966 but gets changed here to cope with identically-named descendents. */
5968 for (parent = addr->parent; parent != NULL; parent = parent->parent)
5969 if (strcmpic(addr->address, parent->address) == 0) break;
5971 /* If there's an ancestor with the same name, set the homonym flag. This
5972 influences how deliveries are recorded. Then add a prefix on the front of
5973 the unique address. We use \n\ where n starts at 0 and increases each time.
5974 It is unlikely to pass 9, but if it does, it may look odd but will still
5975 work. This means that siblings or cousins with the same names are treated
5976 as duplicates, which is what we want. */
5980 setflag(addr, af_homonym);
5981 if (parent->unique[0] != '\\')
5982 addr->unique = string_sprintf("\\0\\%s", addr->address);
5984 addr->unique = string_sprintf("\\%c\\%s", parent->unique[1] + 1,
5988 /* Ensure that the domain in the unique field is lower cased, because
5989 domains are always handled caselessly. */
5991 p = Ustrrchr(addr->unique, '@');
5992 while (*p != 0) { *p = tolower(*p); p++; }
5994 DEBUG(D_deliver|D_route) debug_printf("unique = %s\n", addr->unique);
5996 if (tree_search(tree_nonrecipients, addr->unique) != NULL)
5998 DEBUG(D_deliver|D_route)
5999 debug_printf("%s was previously delivered: discarded\n", addr->unique);
6000 child_done(addr, tod_stamp(tod_log));
6004 /* Get the routing retry status, saving the two retry keys (with and
6005 without the local part) for subsequent use. If there is no retry record for
6006 the standard address routing retry key, we look for the same key with the
6007 sender attached, because this form is used by the smtp transport after a
6008 4xx response to RCPT when address_retry_include_sender is true. */
6010 addr->domain_retry_key = string_sprintf("R:%s", addr->domain);
6011 addr->address_retry_key = string_sprintf("R:%s@%s", addr->local_part,
6014 if (dbm_file == NULL)
6015 domain_retry_record = address_retry_record = NULL;
6018 domain_retry_record = dbfn_read(dbm_file, addr->domain_retry_key);
6019 if (domain_retry_record != NULL &&
6020 now - domain_retry_record->time_stamp > retry_data_expire)
6021 domain_retry_record = NULL; /* Ignore if too old */
6023 address_retry_record = dbfn_read(dbm_file, addr->address_retry_key);
6024 if (address_retry_record != NULL &&
6025 now - address_retry_record->time_stamp > retry_data_expire)
6026 address_retry_record = NULL; /* Ignore if too old */
6028 if (address_retry_record == NULL)
6030 uschar *altkey = string_sprintf("%s:<%s>", addr->address_retry_key,
6032 address_retry_record = dbfn_read(dbm_file, altkey);
6033 if (address_retry_record != NULL &&
6034 now - address_retry_record->time_stamp > retry_data_expire)
6035 address_retry_record = NULL; /* Ignore if too old */
6039 DEBUG(D_deliver|D_retry)
6041 if (domain_retry_record == NULL)
6042 debug_printf("no domain retry record\n");
6043 if (address_retry_record == NULL)
6044 debug_printf("no address retry record\n");
6047 /* If we are sending a message down an existing SMTP connection, we must
6048 assume that the message which created the connection managed to route
6049 an address to that connection. We do not want to run the risk of taking
6050 a long time over routing here, because if we do, the server at the other
6051 end of the connection may time it out. This is especially true for messages
6052 with lots of addresses. For this kind of delivery, queue_running is not
6053 set, so we would normally route all addresses. We take a pragmatic approach
6054 and defer routing any addresses that have any kind of domain retry record.
6055 That is, we don't even look at their retry times. It doesn't matter if this
6056 doesn't work occasionally. This is all just an optimization, after all.
6058 The reason for not doing the same for address retries is that they normally
6059 arise from 4xx responses, not DNS timeouts. */
6061 if (continue_hostname != NULL && domain_retry_record != NULL)
6063 addr->message = US"reusing SMTP connection skips previous routing defer";
6064 addr->basic_errno = ERRNO_RRETRY;
6065 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_ROUTER, 0);
6068 /* If we are in a queue run, defer routing unless there is no retry data or
6069 we've passed the next retry time, or this message is forced. In other
6070 words, ignore retry data when not in a queue run.
6072 However, if the domain retry time has expired, always allow the routing
6073 attempt. If it fails again, the address will be failed. This ensures that
6074 each address is routed at least once, even after long-term routing
6077 If there is an address retry, check that too; just wait for the next
6078 retry time. This helps with the case when the temporary error on the
6079 address was really message-specific rather than address specific, since
6080 it allows other messages through.
6082 We also wait for the next retry time if this is a message sent down an
6083 existing SMTP connection (even though that will be forced). Otherwise there
6084 will be far too many attempts for an address that gets a 4xx error. In
6085 fact, after such an error, we should not get here because, the host should
6086 not be remembered as one this message needs. However, there was a bug that
6087 used to cause this to happen, so it is best to be on the safe side.
6089 Even if we haven't reached the retry time in the hints, there is one more
6090 check to do, which is for the ultimate address timeout. We only do this
6091 check if there is an address retry record and there is not a domain retry
6092 record; this implies that previous attempts to handle the address had the
6093 retry_use_local_parts option turned on. We use this as an approximation
6094 for the destination being like a local delivery, for example delivery over
6095 LMTP to an IMAP message store. In this situation users are liable to bump
6096 into their quota and thereby have intermittently successful deliveries,
6097 which keep the retry record fresh, which can lead to us perpetually
6098 deferring messages. */
6100 else if (((queue_running && !deliver_force) || continue_hostname != NULL)
6102 ((domain_retry_record != NULL &&
6103 now < domain_retry_record->next_try &&
6104 !domain_retry_record->expired)
6106 (address_retry_record != NULL &&
6107 now < address_retry_record->next_try))
6109 (domain_retry_record != NULL ||
6110 address_retry_record == NULL ||
6111 !retry_ultimate_address_timeout(addr->address_retry_key,
6112 addr->domain, address_retry_record, now)))
6114 addr->message = US"retry time not reached";
6115 addr->basic_errno = ERRNO_RRETRY;
6116 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_ROUTER, 0);
6119 /* The domain is OK for routing. Remember if retry data exists so it
6120 can be cleaned up after a successful delivery. */
6124 if (domain_retry_record != NULL || address_retry_record != NULL)
6125 setflag(addr, af_dr_retry_exists);
6126 addr->next = addr_route;
6128 DEBUG(D_deliver|D_route)
6129 debug_printf("%s: queued for routing\n", addr->address);
6133 /* The database is closed while routing is actually happening. Requests to
6134 update it are put on a chain and all processed together at the end. */
6136 if (dbm_file != NULL) dbfn_close(dbm_file);
6138 /* If queue_domains is set, we don't even want to try routing addresses in
6139 those domains. During queue runs, queue_domains is forced to be unset.
6140 Optimize by skipping this pass through the addresses if nothing is set. */
6142 if (!deliver_force && queue_domains != NULL)
6144 address_item *okaddr = NULL;
6145 while (addr_route != NULL)
6147 address_item *addr = addr_route;
6148 addr_route = addr->next;
6150 deliver_domain = addr->domain; /* set $domain */
6151 if ((rc = match_isinlist(addr->domain, (const uschar **)&queue_domains, 0,
6152 &domainlist_anchor, addr->domain_cache, MCL_DOMAIN, TRUE, NULL))
6157 addr->basic_errno = ERRNO_LISTDEFER;
6158 addr->message = US"queue_domains lookup deferred";
6159 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_ROUTER, 0);
6163 addr->next = okaddr;
6169 addr->basic_errno = ERRNO_QUEUE_DOMAIN;
6170 addr->message = US"domain is in queue_domains";
6171 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_ROUTER, 0);
6175 addr_route = okaddr;
6178 /* Now route those addresses that are not deferred. */
6180 while (addr_route != NULL)
6183 address_item *addr = addr_route;
6184 const uschar *old_domain = addr->domain;
6185 uschar *old_unique = addr->unique;
6186 addr_route = addr->next;
6189 /* Just in case some router parameter refers to it. */
6191 return_path = (addr->p.errors_address != NULL)?
6192 addr->p.errors_address : sender_address;
6194 /* If a router defers an address, add a retry item. Whether or not to
6195 use the local part in the key is a property of the router. */
6197 if ((rc = route_address(addr, &addr_local, &addr_remote, &addr_new,
6198 &addr_succeed, v_none)) == DEFER)
6199 retry_add_item(addr, (addr->router->retry_use_local_part)?
6200 string_sprintf("R:%s@%s", addr->local_part, addr->domain) :
6201 string_sprintf("R:%s", addr->domain), 0);
6203 /* Otherwise, if there is an existing retry record in the database, add
6204 retry items to delete both forms. We must also allow for the possibility
6205 of a routing retry that includes the sender address. Since the domain might
6206 have been rewritten (expanded to fully qualified) as a result of routing,
6207 ensure that the rewritten form is also deleted. */
6209 else if (testflag(addr, af_dr_retry_exists))
6211 uschar *altkey = string_sprintf("%s:<%s>", addr->address_retry_key,
6213 retry_add_item(addr, altkey, rf_delete);
6214 retry_add_item(addr, addr->address_retry_key, rf_delete);
6215 retry_add_item(addr, addr->domain_retry_key, rf_delete);
6216 if (Ustrcmp(addr->domain, old_domain) != 0)
6217 retry_add_item(addr, string_sprintf("R:%s", old_domain), rf_delete);
6220 /* DISCARD is given for :blackhole: and "seen finish". The event has been
6221 logged, but we need to ensure the address (and maybe parents) is marked
6226 address_done(addr, tod_stamp(tod_log));
6227 continue; /* route next address */
6230 /* The address is finished with (failed or deferred). */
6234 (void)post_process_one(addr, rc, LOG_MAIN, DTYPE_ROUTER, 0);
6235 continue; /* route next address */
6238 /* The address has been routed. If the router changed the domain, it will
6239 also have changed the unique address. We have to test whether this address
6240 has already been delivered, because it's the unique address that finally
6243 if (addr->unique != old_unique &&
6244 tree_search(tree_nonrecipients, addr->unique) != 0)
6246 DEBUG(D_deliver|D_route) debug_printf("%s was previously delivered: "
6247 "discarded\n", addr->address);
6248 if (addr_remote == addr) addr_remote = addr->next;
6249 else if (addr_local == addr) addr_local = addr->next;
6252 /* If the router has same_domain_copy_routing set, we are permitted to copy
6253 the routing for any other addresses with the same domain. This is an
6254 optimisation to save repeated DNS lookups for "standard" remote domain
6255 routing. The option is settable only on routers that generate host lists.
6256 We play it very safe, and do the optimization only if the address is routed
6257 to a remote transport, there are no header changes, and the domain was not
6258 modified by the router. */
6260 if (addr_remote == addr &&
6261 addr->router->same_domain_copy_routing &&
6262 addr->p.extra_headers == NULL &&
6263 addr->p.remove_headers == NULL &&
6264 old_domain == addr->domain)
6266 address_item **chain = &addr_route;
6267 while (*chain != NULL)
6269 address_item *addr2 = *chain;
6270 if (Ustrcmp(addr2->domain, addr->domain) != 0)
6272 chain = &(addr2->next);
6276 /* Found a suitable address; take it off the routing list and add it to
6277 the remote delivery list. */
6279 *chain = addr2->next;
6280 addr2->next = addr_remote;
6281 addr_remote = addr2;
6283 /* Copy the routing data */
6285 addr2->domain = addr->domain;
6286 addr2->router = addr->router;
6287 addr2->transport = addr->transport;
6288 addr2->host_list = addr->host_list;
6289 addr2->fallback_hosts = addr->fallback_hosts;
6290 addr2->p.errors_address = addr->p.errors_address;
6291 copyflag(addr2, addr, af_hide_child | af_local_host_removed);
6293 DEBUG(D_deliver|D_route)
6295 debug_printf(">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>\n"
6297 "Routing for %s copied from %s\n",
6298 addr2->address, addr2->address, addr->address);
6302 } /* Continue with routing the next address. */
6303 } /* Loop to process any child addresses that the routers created, and
6304 any rerouted addresses that got put back on the new chain. */
6307 /* Debugging: show the results of the routing */
6309 DEBUG(D_deliver|D_retry|D_route)
6311 address_item *p = addr_local;
6312 debug_printf(">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>\n");
6313 debug_printf("After routing:\n Local deliveries:\n");
6316 debug_printf(" %s\n", p->address);
6321 debug_printf(" Remote deliveries:\n");
6324 debug_printf(" %s\n", p->address);
6329 debug_printf(" Failed addresses:\n");
6332 debug_printf(" %s\n", p->address);
6337 debug_printf(" Deferred addresses:\n");
6340 debug_printf(" %s\n", p->address);
6345 /* Free any resources that were cached during routing. */
6350 /* These two variables are set only during routing, after check_local_user.
6351 Ensure they are not set in transports. */
6353 local_user_gid = (gid_t)(-1);
6354 local_user_uid = (uid_t)(-1);
6356 /* Check for any duplicate addresses. This check is delayed until after
6357 routing, because the flexibility of the routing configuration means that
6358 identical addresses with different parentage may end up being redirected to
6359 different addresses. Checking for duplicates too early (as we previously used
6360 to) makes this kind of thing not work. */
6362 do_duplicate_check(&addr_local);
6363 do_duplicate_check(&addr_remote);
6365 /* When acting as an MUA wrapper, we proceed only if all addresses route to a
6366 remote transport. The check that they all end up in one transaction happens in
6367 the do_remote_deliveries() function. */
6369 if (mua_wrapper && (addr_local != NULL || addr_failed != NULL ||
6370 addr_defer != NULL))
6373 uschar *which, *colon, *msg;
6375 if (addr_local != NULL)
6380 else if (addr_defer != NULL)
6383 which = US"deferred";
6391 while (addr->parent != NULL) addr = addr->parent;
6393 if (addr->message != NULL)
6396 msg = addr->message;
6398 else colon = msg = US"";
6400 /* We don't need to log here for a forced failure as it will already
6401 have been logged. Defer will also have been logged, but as a defer, so we do
6402 need to do the failure logging. */
6404 if (addr != addr_failed)
6405 log_write(0, LOG_MAIN, "** %s routing yielded a %s delivery",
6406 addr->address, which);
6408 /* Always write an error to the caller */
6410 fprintf(stderr, "routing %s yielded a %s delivery%s%s\n", addr->address,
6413 final_yield = DELIVER_MUA_FAILED;
6414 addr_failed = addr_defer = NULL; /* So that we remove the message */
6415 goto DELIVERY_TIDYUP;
6419 /* If this is a run to continue deliveries to an external channel that is
6420 already set up, defer any local deliveries. */
6422 if (continue_transport != NULL)
6424 if (addr_defer == NULL) addr_defer = addr_local; else
6426 address_item *addr = addr_defer;
6427 while (addr->next != NULL) addr = addr->next;
6428 addr->next = addr_local;
6434 /* Because address rewriting can happen in the routers, we should not really do
6435 ANY deliveries until all addresses have been routed, so that all recipients of
6436 the message get the same headers. However, this is in practice not always
6437 possible, since sometimes remote addresses give DNS timeouts for days on end.
6438 The pragmatic approach is to deliver what we can now, saving any rewritten
6439 headers so that at least the next lot of recipients benefit from the rewriting
6440 that has already been done.
6442 If any headers have been rewritten during routing, update the spool file to
6443 remember them for all subsequent deliveries. This can be delayed till later if
6444 there is only address to be delivered - if it succeeds the spool write need not
6447 if (header_rewritten &&
6448 ((addr_local != NULL &&
6449 (addr_local->next != NULL || addr_remote != NULL)) ||
6450 (addr_remote != NULL && addr_remote->next != NULL)))
6452 /* Panic-dies on error */
6453 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
6454 header_rewritten = FALSE;
6458 /* If there are any deliveries to be done, open the journal file. This is used
6459 to record successful deliveries as soon as possible after each delivery is
6460 known to be complete. A file opened with O_APPEND is used so that several
6461 processes can run simultaneously.
6463 The journal is just insurance against crashes. When the spool file is
6464 ultimately updated at the end of processing, the journal is deleted. If a
6465 journal is found to exist at the start of delivery, the addresses listed
6466 therein are added to the non-recipients. */
6468 if (addr_local != NULL || addr_remote != NULL)
6470 sprintf(CS spoolname, "%s/input/%s/%s-J", spool_directory, message_subdir, id);
6471 journal_fd = Uopen(spoolname, O_WRONLY|O_APPEND|O_CREAT, SPOOL_MODE);
6475 log_write(0, LOG_MAIN|LOG_PANIC, "Couldn't open journal file %s: %s",
6476 spoolname, strerror(errno));
6477 return DELIVER_NOT_ATTEMPTED;
6480 /* Set the close-on-exec flag, make the file owned by Exim, and ensure
6481 that the mode is correct - the group setting doesn't always seem to get
6482 set automatically. */
6484 if( fcntl(journal_fd, F_SETFD, fcntl(journal_fd, F_GETFD) | FD_CLOEXEC)
6485 || fchown(journal_fd, exim_uid, exim_gid)
6486 || fchmod(journal_fd, SPOOL_MODE)
6489 int ret = Uunlink(spoolname);
6490 log_write(0, LOG_MAIN|LOG_PANIC, "Couldn't set perms on journal file %s: %s",
6491 spoolname, strerror(errno));
6492 if(ret && errno != ENOENT)
6493 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s",
6494 spoolname, strerror(errno));
6495 return DELIVER_NOT_ATTEMPTED;
6501 /* Now we can get down to the business of actually doing deliveries. Local
6502 deliveries are done first, then remote ones. If ever the problems of how to
6503 handle fallback transports are figured out, this section can be put into a loop
6504 for handling fallbacks, though the uid switching will have to be revised. */
6506 /* Precompile a regex that is used to recognize a parameter in response
6507 to an LHLO command, if is isn't already compiled. This may be used on both
6508 local and remote LMTP deliveries. */
6510 if (regex_IGNOREQUOTA == NULL) regex_IGNOREQUOTA =
6511 regex_must_compile(US"\\n250[\\s\\-]IGNOREQUOTA(\\s|\\n|$)", FALSE, TRUE);
6513 /* Handle local deliveries */
6515 if (addr_local != NULL)
6517 DEBUG(D_deliver|D_transport)
6518 debug_printf(">>>>>>>>>>>>>>>> Local deliveries >>>>>>>>>>>>>>>>\n");
6519 do_local_deliveries();
6520 disable_logging = FALSE;
6523 /* If queue_run_local is set, we do not want to attempt any remote deliveries,
6524 so just queue them all. */
6526 if (queue_run_local)
6528 while (addr_remote != NULL)
6530 address_item *addr = addr_remote;
6531 addr_remote = addr->next;
6533 addr->basic_errno = ERRNO_LOCAL_ONLY;
6534 addr->message = US"remote deliveries suppressed";
6535 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_TRANSPORT, 0);
6539 /* Handle remote deliveries */
6541 if (addr_remote != NULL)
6543 DEBUG(D_deliver|D_transport)
6544 debug_printf(">>>>>>>>>>>>>>>> Remote deliveries >>>>>>>>>>>>>>>>\n");
6546 /* Precompile some regex that are used to recognize parameters in response
6547 to an EHLO command, if they aren't already compiled. */
6551 /* Now sort the addresses if required, and do the deliveries. The yield of
6552 do_remote_deliveries is FALSE when mua_wrapper is set and all addresses
6553 cannot be delivered in one transaction. */
6555 if (remote_sort_domains != NULL) sort_remote_deliveries();
6556 if (!do_remote_deliveries(FALSE))
6558 log_write(0, LOG_MAIN, "** mua_wrapper is set but recipients cannot all "
6559 "be delivered in one transaction");
6560 fprintf(stderr, "delivery to smarthost failed (configuration problem)\n");
6562 final_yield = DELIVER_MUA_FAILED;
6563 addr_failed = addr_defer = NULL; /* So that we remove the message */
6564 goto DELIVERY_TIDYUP;
6567 /* See if any of the addresses that failed got put on the queue for delivery
6568 to their fallback hosts. We do it this way because often the same fallback
6569 host is used for many domains, so all can be sent in a single transaction
6570 (if appropriately configured). */
6572 if (addr_fallback != NULL && !mua_wrapper)
6574 DEBUG(D_deliver) debug_printf("Delivering to fallback hosts\n");
6575 addr_remote = addr_fallback;
6576 addr_fallback = NULL;
6577 if (remote_sort_domains != NULL) sort_remote_deliveries();
6578 do_remote_deliveries(TRUE);
6580 disable_logging = FALSE;
6584 /* All deliveries are now complete. Ignore SIGTERM during this tidying up
6585 phase, to minimize cases of half-done things. */
6588 debug_printf(">>>>>>>>>>>>>>>> deliveries are done >>>>>>>>>>>>>>>>\n");
6590 /* Root privilege is no longer needed */
6592 exim_setugid(exim_uid, exim_gid, FALSE, US"post-delivery tidying");
6594 set_process_info("tidying up after delivering %s", message_id);
6595 signal(SIGTERM, SIG_IGN);
6597 /* When we are acting as an MUA wrapper, the smtp transport will either have
6598 succeeded for all addresses, or failed them all in normal cases. However, there
6599 are some setup situations (e.g. when a named port does not exist) that cause an
6600 immediate exit with deferral of all addresses. Convert those into failures. We
6601 do not ever want to retry, nor do we want to send a bounce message. */
6605 if (addr_defer != NULL)
6607 address_item *addr, *nextaddr;
6608 for (addr = addr_defer; addr != NULL; addr = nextaddr)
6610 log_write(0, LOG_MAIN, "** %s mua_wrapper forced failure for deferred "
6611 "delivery", addr->address);
6612 nextaddr = addr->next;
6613 addr->next = addr_failed;
6619 /* Now all should either have succeeded or failed. */
6621 if (addr_failed == NULL) final_yield = DELIVER_MUA_SUCCEEDED; else
6623 uschar *s = (addr_failed->user_message != NULL)?
6624 addr_failed->user_message : addr_failed->message;
6627 fprintf(stderr, "Delivery failed: ");
6628 if (addr_failed->basic_errno > 0)
6630 fprintf(stderr, "%s", strerror(addr_failed->basic_errno));
6631 if (s != NULL) fprintf(stderr, ": ");
6633 if ((host = addr_failed->host_used))
6634 fprintf(stderr, "H=%s [%s]: ", host->name, host->address);
6637 if (addr_failed->basic_errno <= 0) fprintf(stderr, "unknown error");
6639 else fprintf(stderr, "%s", CS s);
6640 fprintf(stderr, "\n");
6642 final_yield = DELIVER_MUA_FAILED;
6647 /* In a normal configuration, we now update the retry database. This is done in
6648 one fell swoop at the end in order not to keep opening and closing (and
6649 locking) the database. The code for handling retries is hived off into a
6650 separate module for convenience. We pass it the addresses of the various
6651 chains, because deferred addresses can get moved onto the failed chain if the
6652 retry cutoff time has expired for all alternative destinations. Bypass the
6653 updating of the database if the -N flag is set, which is a debugging thing that
6654 prevents actual delivery. */
6656 else if (!dont_deliver) retry_update(&addr_defer, &addr_failed, &addr_succeed);
6658 /* Send DSN for successful messages */
6659 addr_dsntmp = addr_succeed;
6660 addr_senddsn = NULL;
6662 while(addr_dsntmp != NULL)
6665 debug_printf("DSN: processing router : %s\n", addr_dsntmp->router->name);
6668 debug_printf("DSN: processing successful delivery address: %s\n", addr_dsntmp->address);
6670 /* af_ignore_error not honored here. it's not an error */
6672 DEBUG(D_deliver) debug_printf("DSN: Sender_address: %s\n", sender_address);
6673 DEBUG(D_deliver) debug_printf("DSN: orcpt: %s flags: %d\n", addr_dsntmp->dsn_orcpt, addr_dsntmp->dsn_flags);
6674 DEBUG(D_deliver) debug_printf("DSN: envid: %s ret: %d\n", dsn_envid, dsn_ret);
6675 DEBUG(D_deliver) debug_printf("DSN: Final recipient: %s\n", addr_dsntmp->address);
6676 DEBUG(D_deliver) debug_printf("DSN: Remote SMTP server supports DSN: %d\n", addr_dsntmp->dsn_aware);
6678 /* send report if next hop not DSN aware or a router flagged "last DSN hop"
6679 and a report was requested */
6680 if (((addr_dsntmp->dsn_aware != dsn_support_yes) ||
6681 ((addr_dsntmp->dsn_flags & rf_dsnlasthop) != 0))
6683 (((addr_dsntmp->dsn_flags & rf_dsnflags) != 0) &&
6684 ((addr_dsntmp->dsn_flags & rf_notify_success) != 0)))
6686 /* copy and relink address_item and send report with all of them at once later */
6687 address_item *addr_next;
6688 addr_next = addr_senddsn;
6689 addr_senddsn = store_get(sizeof(address_item));
6690 memcpy(addr_senddsn, addr_dsntmp, sizeof(address_item));
6691 addr_senddsn->next = addr_next;
6695 DEBUG(D_deliver) debug_printf("DSN: *** NOT SENDING DSN SUCCESS Message ***\n");
6698 addr_dsntmp = addr_dsntmp->next;
6701 if (addr_senddsn != NULL)
6706 /* create exim process to send message */
6707 pid = child_open_exim(&fd);
6709 DEBUG(D_deliver) debug_printf("DSN: child_open_exim returns: %d\n", pid);
6711 if (pid < 0) /* Creation of child failed */
6713 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Process %d (parent %d) failed to "
6714 "create child process to send failure message: %s", getpid(),
6715 getppid(), strerror(errno));
6717 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;
6727 DEBUG(D_deliver) debug_printf("sending error message to: %s\n", sender_address);
6729 /* build unique id for MIME boundary */
6730 bound = string_sprintf(TIME_T_FMT "-eximdsn-%d", time(NULL), rand());
6731 DEBUG(D_deliver) debug_printf("DSN: MIME boundary: %s\n", bound);
6733 if (errors_reply_to)
6734 fprintf(f, "Reply-To: %s\n", errors_reply_to);
6736 fprintf(f, "Auto-Submitted: auto-generated\n"
6737 "From: Mail Delivery System <Mailer-Daemon@%s>\n"
6739 "Subject: Delivery Status Notification\n"
6740 "Content-Type: multipart/report; report-type=delivery-status; boundary=%s\n"
6741 "MIME-Version: 1.0\n\n"
6744 "Content-type: text/plain; charset=us-ascii\n\n"
6746 "This message was created automatically by mail delivery software.\n"
6747 " ----- The following addresses had successful delivery notifications -----\n",
6748 qualify_domain_sender, sender_address, bound, bound);
6750 addr_dsntmp = addr_senddsn;
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"
6761 addr_dsntmp = addr_dsntmp->next;
6764 "Content-type: message/delivery-status\n\n"
6765 "Reporting-MTA: dns; %s\n",
6766 bound, smtp_active_hostname);
6768 if (dsn_envid != NULL) {
6769 /* must be decoded from xtext: see RFC 3461:6.3a */
6771 if (auth_xtextdecode(dsn_envid, &xdec_envid) > 0)
6772 fprintf(f, "Original-Envelope-ID: %s\n", dsn_envid);
6774 fprintf(f, "X-Original-Envelope-ID: error decoding xtext formated ENVID\n");
6778 for (addr_dsntmp = addr_senddsn;
6780 addr_dsntmp = addr_dsntmp->next)
6782 if (addr_dsntmp->dsn_orcpt)
6783 fprintf(f,"Original-Recipient: %s\n", addr_dsntmp->dsn_orcpt);
6785 fprintf(f, "Action: delivered\n"
6786 "Final-Recipient: rfc822;%s\n"
6788 addr_dsntmp->address);
6790 if (addr_dsntmp->host_used && addr_dsntmp->host_used->name)
6791 fprintf(f, "Remote-MTA: dns; %s\nDiagnostic-Code: smtp; 250 Ok\n",
6792 addr_dsntmp->host_used->name);
6794 fprintf(f,"Diagnostic-Code: X-Exim; relayed via non %s router\n",
6795 (addr_dsntmp->dsn_flags & rf_dsnlasthop) == 1 ? "DSN" : "SMTP");
6799 fprintf(f, "--%s\nContent-type: text/rfc822-headers\n\n", bound);
6802 transport_filter_argv = NULL; /* Just in case */
6803 return_path = sender_address; /* In case not previously set */
6805 /* Write the original email out */
6806 transport_write_message(NULL, fileno(f), topt, 0, NULL, NULL, NULL, NULL, NULL, 0);
6809 fprintf(f,"\n--%s--\n", bound);
6813 rc = child_close(pid, 0); /* Waits for child to close, no timeout */
6817 /* If any addresses failed, we must send a message to somebody, unless
6818 af_ignore_error is set, in which case no action is taken. It is possible for
6819 several messages to get sent if there are addresses with different
6822 while (addr_failed != NULL)
6826 uschar *logtod = tod_stamp(tod_log);
6828 address_item *handled_addr = NULL;
6829 address_item **paddr;
6830 address_item *msgchain = NULL;
6831 address_item **pmsgchain = &msgchain;
6833 /* There are weird cases when logging is disabled in the transport. However,
6834 there may not be a transport (address failed by a router). */
6836 disable_logging = FALSE;
6837 if (addr_failed->transport != NULL)
6838 disable_logging = addr_failed->transport->disable_logging;
6841 debug_printf("processing failed address %s\n", addr_failed->address);
6843 /* There are only two ways an address in a bounce message can get here:
6845 (1) When delivery was initially deferred, but has now timed out (in the call
6846 to retry_update() above). We can detect this by testing for
6847 af_retry_timedout. If the address does not have its own errors address,
6848 we arrange to ignore the error.
6850 (2) If delivery failures for bounce messages are being ignored. We can detect
6851 this by testing for af_ignore_error. This will also be set if a bounce
6852 message has been autothawed and the ignore_bounce_errors_after time has
6853 passed. It might also be set if a router was explicitly configured to
6854 ignore errors (errors_to = "").
6856 If neither of these cases obtains, something has gone wrong. Log the
6857 incident, but then ignore the error. */
6859 if (sender_address[0] == 0 && addr_failed->p.errors_address == NULL)
6861 if (!testflag(addr_failed, af_retry_timedout) &&
6862 !testflag(addr_failed, af_ignore_error))
6864 log_write(0, LOG_MAIN|LOG_PANIC, "internal error: bounce message "
6865 "failure is neither frozen nor ignored (it's been ignored)");
6867 setflag(addr_failed, af_ignore_error);
6870 /* If the first address on the list has af_ignore_error set, just remove
6871 it from the list, throw away any saved message file, log it, and
6872 mark the recipient done. */
6874 if ( testflag(addr_failed, af_ignore_error)
6875 || ( ((addr_failed->dsn_flags & rf_dsnflags) != 0)
6876 && ((addr_failed->dsn_flags & rf_notify_failure) != rf_notify_failure))
6880 addr_failed = addr->next;
6881 if (addr->return_filename != NULL) Uunlink(addr->return_filename);
6883 log_write(0, LOG_MAIN, "%s%s%s%s: error ignored",
6885 (addr->parent == NULL)? US"" : US" <",
6886 (addr->parent == NULL)? US"" : addr->parent->address,
6887 (addr->parent == NULL)? US"" : US">");
6889 address_done(addr, logtod);
6890 child_done(addr, logtod);
6891 /* Panic-dies on error */
6892 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
6895 /* Otherwise, handle the sending of a message. Find the error address for
6896 the first address, then send a message that includes all failed addresses
6897 that have the same error address. Note the bounce_recipient is a global so
6898 that it can be accesssed by $bounce_recipient while creating a customized
6903 bounce_recipient = (addr_failed->p.errors_address == NULL)?
6904 sender_address : addr_failed->p.errors_address;
6906 /* Make a subprocess to send a message */
6908 pid = child_open_exim(&fd);
6910 /* Creation of child failed */
6913 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Process %d (parent %d) failed to "
6914 "create child process to send failure message: %s", getpid(),
6915 getppid(), strerror(errno));
6917 /* Creation of child succeeded */
6924 uschar *bcc, *emf_text;
6925 FILE *f = fdopen(fd, "wb");
6927 BOOL to_sender = strcmpic(sender_address, bounce_recipient) == 0;
6928 int max = (bounce_return_size_limit/DELIVER_IN_BUFFER_SIZE + 1) *
6929 DELIVER_IN_BUFFER_SIZE;
6931 uschar *dsnlimitmsg;
6932 uschar *dsnnotifyhdr;
6936 debug_printf("sending error message to: %s\n", bounce_recipient);
6938 /* Scan the addresses for all that have the same errors address, removing
6939 them from the addr_failed chain, and putting them on msgchain. */
6941 paddr = &addr_failed;
6942 for (addr = addr_failed; addr != NULL; addr = *paddr)
6944 if (Ustrcmp(bounce_recipient, (addr->p.errors_address == NULL)?
6945 sender_address : addr->p.errors_address) != 0)
6947 paddr = &(addr->next); /* Not the same; skip */
6949 else /* The same - dechain */
6951 *paddr = addr->next;
6954 pmsgchain = &(addr->next);
6958 /* Include X-Failed-Recipients: for automatic interpretation, but do
6959 not let any one header line get too long. We do this by starting a
6960 new header every 50 recipients. Omit any addresses for which the
6961 "hide_child" flag is set. */
6963 for (addr = msgchain; addr != NULL; addr = addr->next)
6965 if (testflag(addr, af_hide_child)) continue;
6972 (rcount++ == 0)? "X-Failed-Recipients: " : ",\n ",
6973 (testflag(addr, af_pfr) && addr->parent != NULL)?
6974 string_printing(addr->parent->address) :
6975 string_printing(addr->address));
6977 if (rcount > 0) fprintf(f, "\n");
6979 /* Output the standard headers */
6981 if (errors_reply_to != NULL)
6982 fprintf(f, "Reply-To: %s\n", errors_reply_to);
6983 fprintf(f, "Auto-Submitted: auto-replied\n");
6985 fprintf(f, "To: %s\n", bounce_recipient);
6987 /* generate boundary string and output MIME-Headers */
6988 bound = string_sprintf(TIME_T_FMT "-eximdsn-%d", time(NULL), rand());
6990 fprintf(f, "Content-Type: multipart/report;"
6991 " report-type=delivery-status; boundary=%s\n"
6992 "MIME-Version: 1.0\n",
6995 /* Open a template file if one is provided. Log failure to open, but
6996 carry on - default texts will be used. */
6998 if (bounce_message_file)
6999 if (!(emf = Ufopen(bounce_message_file, "rb")))
7000 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to open %s for error "
7001 "message texts: %s", bounce_message_file, strerror(errno));
7003 /* Quietly copy to configured additional addresses if required. */
7005 if ((bcc = moan_check_errorcopy(bounce_recipient)))
7006 fprintf(f, "Bcc: %s\n", bcc);
7008 /* The texts for the message can be read from a template file; if there
7009 isn't one, or if it is too short, built-in texts are used. The first
7010 emf text is a Subject: and any other headers. */
7012 if ((emf_text = next_emf(emf, US"header")))
7013 fprintf(f, "%s\n", emf_text);
7015 fprintf(f, "Subject: Mail delivery failed%s\n\n",
7016 to_sender? ": returning message to sender" : "");
7018 /* output human readable part as text/plain section */
7020 "Content-type: text/plain; charset=us-ascii\n\n",
7023 if ((emf_text = next_emf(emf, US"intro")))
7024 fprintf(f, "%s", CS emf_text);
7028 /* This message has been reworded several times. It seems to be confusing to
7029 somebody, however it is worded. I have retreated to the original, simple
7031 "This message was created automatically by mail delivery software.\n");
7033 if (bounce_message_text)
7034 fprintf(f, "%s", CS bounce_message_text);
7037 "\nA message that you sent could not be delivered to one or more of its\n"
7038 "recipients. This is a permanent error. The following address(es) failed:\n");
7041 "\nA message sent by\n\n <%s>\n\n"
7042 "could not be delivered to one or more of its recipients. The following\n"
7043 "address(es) failed:\n", sender_address);
7047 /* Process the addresses, leaving them on the msgchain if they have a
7048 file name for a return message. (There has already been a check in
7049 post_process_one() for the existence of data in the message file.) A TRUE
7050 return from print_address_information() means that the address is not
7054 for (addr = msgchain; addr != NULL; addr = *paddr)
7056 if (print_address_information(addr, f, US" ", US"\n ", US""))
7057 print_address_error(addr, f, US"");
7059 /* End the final line for the address */
7063 /* Leave on msgchain if there's a return file. */
7065 if (addr->return_file >= 0)
7067 paddr = &(addr->next);
7071 /* Else save so that we can tick off the recipient when the
7076 *paddr = addr->next;
7077 addr->next = handled_addr;
7078 handled_addr = addr;
7084 /* Get the next text, whether we need it or not, so as to be
7085 positioned for the one after. */
7087 emf_text = next_emf(emf, US"generated text");
7089 /* If there were any file messages passed by the local transports,
7090 include them in the message. Then put the address on the handled chain.
7091 In the case of a batch of addresses that were all sent to the same
7092 transport, the return_file field in all of them will contain the same
7093 fd, and the return_filename field in the *last* one will be set (to the
7094 name of the file). */
7098 address_item *nextaddr;
7101 fprintf(f, "%s", CS emf_text);
7104 "The following text was generated during the delivery "
7105 "attempt%s:\n", (filecount > 1)? "s" : "");
7107 for (addr = msgchain; addr != NULL; addr = nextaddr)
7110 address_item *topaddr = addr;
7112 /* List all the addresses that relate to this file */
7115 while(addr) /* Insurance */
7117 print_address_information(addr, f, US"------ ", US"\n ",
7119 if (addr->return_filename) break;
7124 /* Now copy the file */
7126 fm = Ufopen(addr->return_filename, "rb");
7129 fprintf(f, " +++ Exim error... failed to open text file: %s\n",
7133 while ((ch = fgetc(fm)) != EOF) fputc(ch, f);
7136 Uunlink(addr->return_filename);
7138 /* Can now add to handled chain, first fishing off the next
7139 address on the msgchain. */
7141 nextaddr = addr->next;
7142 addr->next = handled_addr;
7143 handled_addr = topaddr;
7148 /* output machine readable part */
7150 "Content-type: message/delivery-status\n\n"
7151 "Reporting-MTA: dns; %s\n",
7152 bound, smtp_active_hostname);
7156 /* must be decoded from xtext: see RFC 3461:6.3a */
7158 if (auth_xtextdecode(dsn_envid, &xdec_envid) > 0)
7159 fprintf(f, "Original-Envelope-ID: %s\n", dsn_envid);
7161 fprintf(f, "X-Original-Envelope-ID: error decoding xtext formated ENVID\n");
7165 for (addr = handled_addr; addr; addr = addr->next)
7167 fprintf(f, "Action: failed\n"
7168 "Final-Recipient: rfc822;%s\n"
7171 if (addr->host_used && addr->host_used->name)
7173 fprintf(f, "Remote-MTA: dns; %s\n",
7174 addr->host_used->name);
7175 print_dsn_diagnostic_code(addr, f);
7179 /* Now copy the message, trying to give an intelligible comment if
7180 it is too long for it all to be copied. The limit isn't strictly
7181 applied because of the buffering. There is, however, an option
7182 to suppress copying altogether. */
7184 emf_text = next_emf(emf, US"copy");
7187 we ignore the intro text from template and add
7188 the text for bounce_return_size_limit at the end.
7190 bounce_return_message is ignored
7191 in case RET= is defined we honor these values
7192 otherwise bounce_return_body is honored.
7194 bounce_return_size_limit is always honored.
7197 fprintf(f, "\n--%s\n", bound);
7199 dsnlimitmsg = US"X-Exim-DSN-Information: Due to administrative limits only headers are returned";
7200 dsnnotifyhdr = NULL;
7201 topt = topt_add_return_path;
7203 /* RET=HDRS? top priority */
7204 if (dsn_ret == dsn_ret_hdrs)
7205 topt |= topt_no_body;
7207 /* no full body return at all? */
7208 if (!bounce_return_body)
7210 topt |= topt_no_body;
7211 /* add header if we overrule RET=FULL */
7212 if (dsn_ret == dsn_ret_full)
7213 dsnnotifyhdr = dsnlimitmsg;
7215 /* size limited ... return headers only if limit reached */
7216 else if (bounce_return_size_limit > 0)
7218 struct stat statbuf;
7219 if (fstat(deliver_datafile, &statbuf) == 0 && statbuf.st_size > max)
7221 topt |= topt_no_body;
7222 dsnnotifyhdr = dsnlimitmsg;
7226 if (topt & topt_no_body)
7227 fprintf(f,"Content-type: text/rfc822-headers\n\n");
7229 fprintf(f,"Content-type: message/rfc822\n\n");
7232 transport_filter_argv = NULL; /* Just in case */
7233 return_path = sender_address; /* In case not previously set */
7234 transport_write_message(NULL, fileno(f), topt,
7235 0, dsnnotifyhdr, NULL, NULL, NULL, NULL, 0);
7238 /* we never add the final text. close the file */
7242 fprintf(f, "\n--%s--\n", bound);
7244 /* Close the file, which should send an EOF to the child process
7245 that is receiving the message. Wait for it to finish. */
7248 rc = child_close(pid, 0); /* Waits for child to close, no timeout */
7250 /* In the test harness, let the child do it's thing first. */
7252 if (running_in_test_harness) millisleep(500);
7254 /* If the process failed, there was some disaster in setting up the
7255 error message. Unless the message is very old, ensure that addr_defer
7256 is non-null, which will have the effect of leaving the message on the
7257 spool. The failed addresses will get tried again next time. However, we
7258 don't really want this to happen too often, so freeze the message unless
7259 there are some genuine deferred addresses to try. To do this we have
7260 to call spool_write_header() here, because with no genuine deferred
7261 addresses the normal code below doesn't get run. */
7266 if (now - received_time < retry_maximum_timeout && addr_defer == NULL)
7268 addr_defer = (address_item *)(+1);
7269 deliver_freeze = TRUE;
7270 deliver_frozen_at = time(NULL);
7271 /* Panic-dies on error */
7272 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
7275 deliver_msglog("Process failed (%d) when writing error message "
7276 "to %s%s", rc, bounce_recipient, s);
7277 log_write(0, LOG_MAIN, "Process failed (%d) when writing error message "
7278 "to %s%s", rc, bounce_recipient, s);
7281 /* The message succeeded. Ensure that the recipients that failed are
7282 now marked finished with on the spool and their parents updated. */
7286 for (addr = handled_addr; addr != NULL; addr = addr->next)
7288 address_done(addr, logtod);
7289 child_done(addr, logtod);
7291 /* Panic-dies on error */
7292 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
7298 disable_logging = FALSE; /* In case left set */
7300 /* Come here from the mua_wrapper case if routing goes wrong */
7304 /* If there are now no deferred addresses, we are done. Preserve the
7305 message log if so configured, and we are using them. Otherwise, sling it.
7306 Then delete the message itself. */
7308 if (addr_defer == NULL)
7312 sprintf(CS spoolname, "%s/msglog/%s/%s", spool_directory, message_subdir,
7314 if (preserve_message_logs)
7317 sprintf(CS big_buffer, "%s/msglog.OLD/%s", spool_directory, id);
7318 if ((rc = Urename(spoolname, big_buffer)) < 0)
7320 (void)directory_make(spool_directory, US"msglog.OLD",
7321 MSGLOG_DIRECTORY_MODE, TRUE);
7322 rc = Urename(spoolname, big_buffer);
7325 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to move %s to the "
7326 "msglog.OLD directory", spoolname);
7330 if (Uunlink(spoolname) < 0)
7331 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s",
7332 spoolname, strerror(errno));
7336 /* Remove the two message files. */
7338 sprintf(CS spoolname, "%s/input/%s/%s-D", spool_directory, message_subdir, id);
7339 if (Uunlink(spoolname) < 0)
7340 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s",
7341 spoolname, strerror(errno));
7342 sprintf(CS spoolname, "%s/input/%s/%s-H", spool_directory, message_subdir, id);
7343 if (Uunlink(spoolname) < 0)
7344 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s",
7345 spoolname, strerror(errno));
7347 /* Log the end of this message, with queue time if requested. */
7349 if ((log_extra_selector & LX_queue_time_overall) != 0)
7350 log_write(0, LOG_MAIN, "Completed QT=%s",
7351 readconf_printtime( (int) ((long)time(NULL) - (long)received_time)) );
7353 log_write(0, LOG_MAIN, "Completed");
7355 /* Unset deliver_freeze so that we won't try to move the spool files further down */
7356 deliver_freeze = FALSE;
7358 #ifdef EXPERIMENTAL_EVENT
7359 (void) event_raise(event_action, US"msg:complete", NULL);
7363 /* If there are deferred addresses, we are keeping this message because it is
7364 not yet completed. Lose any temporary files that were catching output from
7365 pipes for any of the deferred addresses, handle one-time aliases, and see if
7366 the message has been on the queue for so long that it is time to send a warning
7367 message to the sender, unless it is a mailer-daemon. If all deferred addresses
7368 have the same domain, we can set deliver_domain for the expansion of
7369 delay_warning_ condition - if any of them are pipes, files, or autoreplies, use
7370 the parent's domain.
7372 If all the deferred addresses have an error number that indicates "retry time
7373 not reached", skip sending the warning message, because it won't contain the
7374 reason for the delay. It will get sent at the next real delivery attempt.
7375 However, if at least one address has tried, we'd better include all of them in
7378 If we can't make a process to send the message, don't worry.
7380 For mailing list expansions we want to send the warning message to the
7381 mailing list manager. We can't do a perfect job here, as some addresses may
7382 have different errors addresses, but if we take the errors address from
7383 each deferred address it will probably be right in most cases.
7385 If addr_defer == +1, it means there was a problem sending an error message
7386 for failed addresses, and there were no "real" deferred addresses. The value
7387 was set just to keep the message on the spool, so there is nothing to do here.
7390 else if (addr_defer != (address_item *)(+1))
7393 uschar *recipients = US"";
7394 BOOL delivery_attempted = FALSE;
7396 deliver_domain = testflag(addr_defer, af_pfr)?
7397 addr_defer->parent->domain : addr_defer->domain;
7399 for (addr = addr_defer; addr != NULL; addr = addr->next)
7401 address_item *otaddr;
7403 if (addr->basic_errno > ERRNO_RETRY_BASE) delivery_attempted = TRUE;
7405 if (deliver_domain != NULL)
7407 const uschar *d = testflag(addr, af_pfr)
7408 ? addr->parent->domain : addr->domain;
7410 /* The domain may be unset for an address that has never been routed
7411 because the system filter froze the message. */
7413 if (d == NULL || Ustrcmp(d, deliver_domain) != 0) deliver_domain = NULL;
7416 if (addr->return_filename != NULL) Uunlink(addr->return_filename);
7418 /* Handle the case of one-time aliases. If any address in the ancestry
7419 of this one is flagged, ensure it is in the recipients list, suitably
7420 flagged, and that its parent is marked delivered. */
7422 for (otaddr = addr; otaddr != NULL; otaddr = otaddr->parent)
7423 if (otaddr->onetime_parent != NULL) break;
7428 int t = recipients_count;
7430 for (i = 0; i < recipients_count; i++)
7432 uschar *r = recipients_list[i].address;
7433 if (Ustrcmp(otaddr->onetime_parent, r) == 0) t = i;
7434 if (Ustrcmp(otaddr->address, r) == 0) break;
7437 /* Didn't find the address already in the list, and did find the
7438 ultimate parent's address in the list. After adding the recipient,
7439 update the errors address in the recipients list. */
7441 if (i >= recipients_count && t < recipients_count)
7443 DEBUG(D_deliver) debug_printf("one_time: adding %s in place of %s\n",
7444 otaddr->address, otaddr->parent->address);
7445 receive_add_recipient(otaddr->address, t);
7446 recipients_list[recipients_count-1].errors_to = otaddr->p.errors_address;
7447 tree_add_nonrecipient(otaddr->parent->address);
7448 update_spool = TRUE;
7452 /* Except for error messages, ensure that either the errors address for
7453 this deferred address or, if there is none, the sender address, is on the
7454 list of recipients for a warning message. */
7456 if (sender_address[0] != 0)
7458 if (addr->p.errors_address == NULL)
7460 if (Ustrstr(recipients, sender_address) == NULL)
7461 recipients = string_sprintf("%s%s%s", recipients,
7462 (recipients[0] == 0)? "" : ",", sender_address);
7466 if (Ustrstr(recipients, addr->p.errors_address) == NULL)
7467 recipients = string_sprintf("%s%s%s", recipients,
7468 (recipients[0] == 0)? "" : ",", addr->p.errors_address);
7473 /* Send a warning message if the conditions are right. If the condition check
7474 fails because of a lookup defer, there is nothing we can do. The warning
7475 is not sent. Another attempt will be made at the next delivery attempt (if
7479 && delivery_attempted
7480 && ( ((addr_defer->dsn_flags & rf_dsnflags) == 0)
7481 || (addr_defer->dsn_flags & rf_notify_delay) == rf_notify_delay
7483 && delay_warning[1] > 0
7484 && sender_address[0] != 0
7485 && ( delay_warning_condition == NULL
7486 || expand_check_condition(delay_warning_condition,
7487 US"delay_warning", US"option")
7493 int queue_time = time(NULL) - received_time;
7495 /* When running in the test harness, there's an option that allows us to
7496 fudge this time so as to get repeatability of the tests. Take the first
7497 time off the list. In queue runs, the list pointer gets updated in the
7500 if (running_in_test_harness && fudged_queue_times[0] != 0)
7502 int qt = readconf_readtime(fudged_queue_times, '/', FALSE);
7505 DEBUG(D_deliver) debug_printf("fudged queue_times = %s\n",
7506 fudged_queue_times);
7511 /* See how many warnings we should have sent by now */
7513 for (count = 0; count < delay_warning[1]; count++)
7514 if (queue_time < delay_warning[count+2]) break;
7516 show_time = delay_warning[count+1];
7518 if (count >= delay_warning[1])
7521 int last_gap = show_time;
7522 if (count > 1) last_gap -= delay_warning[count];
7523 extra = (queue_time - delay_warning[count+1])/last_gap;
7524 show_time += last_gap * extra;
7530 debug_printf("time on queue = %s\n", readconf_printtime(queue_time));
7531 debug_printf("warning counts: required %d done %d\n", count,
7535 /* We have computed the number of warnings there should have been by now.
7536 If there haven't been enough, send one, and up the count to what it should
7539 if (warning_count < count)
7543 pid_t pid = child_open_exim(&fd);
7549 FILE *f = fdopen(fd, "wb");
7552 if (warn_message_file)
7554 wmf = Ufopen(warn_message_file, "rb");
7556 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to open %s for warning "
7557 "message texts: %s", warn_message_file, strerror(errno));
7560 warnmsg_recipients = recipients;
7561 warnmsg_delay = (queue_time < 120*60)?
7562 string_sprintf("%d minutes", show_time/60):
7563 string_sprintf("%d hours", show_time/3600);
7565 if (errors_reply_to)
7566 fprintf(f, "Reply-To: %s\n", errors_reply_to);
7567 fprintf(f, "Auto-Submitted: auto-replied\n");
7569 fprintf(f, "To: %s\n", recipients);
7571 /* generated boundary string and output MIME-Headers */
7572 bound = string_sprintf(TIME_T_FMT "-eximdsn-%d", time(NULL), rand());
7574 fprintf(f, "Content-Type: multipart/report;"
7575 " report-type=delivery-status; boundary=%s\n"
7576 "MIME-Version: 1.0\n",
7579 if ((wmf_text = next_emf(wmf, US"header")))
7580 fprintf(f, "%s\n", wmf_text);
7582 fprintf(f, "Subject: Warning: message %s delayed %s\n\n",
7583 message_id, warnmsg_delay);
7585 /* output human readable part as text/plain section */
7587 "Content-type: text/plain; charset=us-ascii\n\n",
7590 if ((wmf_text = next_emf(wmf, US"intro")))
7591 fprintf(f, "%s", CS wmf_text);
7595 "This message was created automatically by mail delivery software.\n");
7597 if (Ustrcmp(recipients, sender_address) == 0)
7599 "A message that you sent has not yet been delivered to one or more of its\n"
7600 "recipients after more than ");
7604 "A message sent by\n\n <%s>\n\n"
7605 "has not yet been delivered to one or more of its recipients after more than \n",
7608 fprintf(f, "%s on the queue on %s.\n\n"
7609 "The message identifier is: %s\n",
7610 warnmsg_delay, primary_hostname, message_id);
7612 for (h = header_list; h != NULL; h = h->next)
7613 if (strncmpic(h->text, US"Subject:", 8) == 0)
7614 fprintf(f, "The subject of the message is: %s", h->text + 9);
7615 else if (strncmpic(h->text, US"Date:", 5) == 0)
7616 fprintf(f, "The date of the message is: %s", h->text + 6);
7619 fprintf(f, "The address%s to which the message has not yet been "
7621 !addr_defer->next ? "" : "es",
7622 !addr_defer->next ? "is": "are");
7625 /* List the addresses, with error information if allowed */
7627 /* store addr_defer for machine readable part */
7628 address_item *addr_dsndefer = addr_defer;
7632 address_item *addr = addr_defer;
7633 addr_defer = addr->next;
7634 if (print_address_information(addr, f, US" ", US"\n ", US""))
7635 print_address_error(addr, f, US"Delay reason: ");
7644 if ((wmf_text = next_emf(wmf, US"final")))
7645 fprintf(f, "%s", CS wmf_text);
7651 "No action is required on your part. Delivery attempts will continue for\n"
7652 "some time, and this warning may be repeated at intervals if the message\n"
7653 "remains undelivered. Eventually the mail delivery software will give up,\n"
7654 "and when that happens, the message will be returned to you.\n");
7657 /* output machine readable part */
7658 fprintf(f, "\n--%s\n"
7659 "Content-type: message/delivery-status\n\n"
7660 "Reporting-MTA: dns; %s\n",
7662 smtp_active_hostname);
7667 /* must be decoded from xtext: see RFC 3461:6.3a */
7669 if (auth_xtextdecode(dsn_envid, &xdec_envid) > 0)
7670 fprintf(f,"Original-Envelope-ID: %s\n", dsn_envid);
7672 fprintf(f,"X-Original-Envelope-ID: error decoding xtext formated ENVID\n");
7676 while (addr_dsndefer)
7678 if (addr_dsndefer->dsn_orcpt)
7679 fprintf(f,"Original-Recipient: %s\n", addr_dsndefer->dsn_orcpt);
7681 fprintf(f,"Action: delayed\n");
7682 fprintf(f,"Final-Recipient: rfc822;%s\n", addr_dsndefer->address);
7683 fprintf(f,"Status: 4.0.0\n");
7684 if (addr_dsndefer->host_used && addr_dsndefer->host_used->name)
7686 fprintf(f,"Remote-MTA: dns; %s\n",
7687 addr_dsndefer->host_used->name);
7688 print_dsn_diagnostic_code(addr_dsndefer, f);
7690 addr_dsndefer = addr_dsndefer->next;
7693 fprintf(f, "\n--%s\n"
7694 "Content-type: text/rfc822-headers\n\n",
7698 /* header only as required by RFC. only failure DSN needs to honor RET=FULL */
7699 int topt = topt_add_return_path | topt_no_body;
7700 transport_filter_argv = NULL; /* Just in case */
7701 return_path = sender_address; /* In case not previously set */
7702 /* Write the original email out */
7703 transport_write_message(NULL, fileno(f), topt, 0, NULL, NULL, NULL, NULL, NULL, 0);
7706 fprintf(f,"\n--%s--\n", bound);
7710 /* Close and wait for child process to complete, without a timeout.
7711 If there's an error, don't update the count. */
7714 if (child_close(pid, 0) == 0)
7716 warning_count = count;
7717 update_spool = TRUE; /* Ensure spool rewritten */
7723 /* Clear deliver_domain */
7725 deliver_domain = NULL;
7727 /* If this was a first delivery attempt, unset the first time flag, and
7728 ensure that the spool gets updated. */
7730 if (deliver_firsttime)
7732 deliver_firsttime = FALSE;
7733 update_spool = TRUE;
7736 /* If delivery was frozen and freeze_tell is set, generate an appropriate
7737 message, unless the message is a local error message (to avoid loops). Then
7738 log the freezing. If the text in "frozen_info" came from a system filter,
7739 it has been escaped into printing characters so as not to mess up log lines.
7740 For the "tell" message, we turn \n back into newline. Also, insert a newline
7741 near the start instead of the ": " string. */
7745 if (freeze_tell != NULL && freeze_tell[0] != 0 && !local_error_message)
7747 uschar *s = string_copy(frozen_info);
7748 uschar *ss = Ustrstr(s, " by the system filter: ");
7759 if (*ss == '\\' && ss[1] == 'n')
7766 moan_tell_someone(freeze_tell, addr_defer, US"Message frozen",
7767 "Message %s has been frozen%s.\nThe sender is <%s>.\n", message_id,
7771 /* Log freezing just before we update the -H file, to minimize the chance
7772 of a race problem. */
7774 deliver_msglog("*** Frozen%s\n", frozen_info);
7775 log_write(0, LOG_MAIN, "Frozen%s", frozen_info);
7778 /* If there have been any updates to the non-recipients list, or other things
7779 that get written to the spool, we must now update the spool header file so
7780 that it has the right information for the next delivery attempt. If there
7781 was more than one address being delivered, the header_change update is done
7782 earlier, in case one succeeds and then something crashes. */
7785 debug_printf("delivery deferred: update_spool=%d header_rewritten=%d\n",
7786 update_spool, header_rewritten);
7788 if (update_spool || header_rewritten)
7789 /* Panic-dies on error */
7790 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
7793 /* Finished with the message log. If the message is complete, it will have
7794 been unlinked or renamed above. */
7796 if (message_logs) (void)fclose(message_log);
7798 /* Now we can close and remove the journal file. Its only purpose is to record
7799 successfully completed deliveries asap so that this information doesn't get
7800 lost if Exim (or the machine) crashes. Forgetting about a failed delivery is
7801 not serious, as trying it again is not harmful. The journal might not be open
7802 if all addresses were deferred at routing or directing. Nevertheless, we must
7803 remove it if it exists (may have been lying around from a crash during the
7804 previous delivery attempt). We don't remove the journal if a delivery
7805 subprocess failed to pass back delivery information; this is controlled by
7806 the remove_journal flag. When the journal is left, we also don't move the
7807 message off the main spool if frozen and the option is set. It should get moved
7808 at the next attempt, after the journal has been inspected. */
7810 if (journal_fd >= 0) (void)close(journal_fd);
7814 sprintf(CS spoolname, "%s/input/%s/%s-J", spool_directory, message_subdir, id);
7815 if (Uunlink(spoolname) < 0 && errno != ENOENT)
7816 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s", spoolname,
7819 /* Move the message off the spool if reqested */
7821 #ifdef SUPPORT_MOVE_FROZEN_MESSAGES
7822 if (deliver_freeze && move_frozen_messages)
7823 (void)spool_move_message(id, message_subdir, US"", US"F");
7827 /* Closing the data file frees the lock; if the file has been unlinked it
7828 will go away. Otherwise the message becomes available for another process
7831 (void)close(deliver_datafile);
7832 deliver_datafile = -1;
7833 DEBUG(D_deliver) debug_printf("end delivery of %s\n", id);
7835 /* It is unlikely that there will be any cached resources, since they are
7836 released after routing, and in the delivery subprocesses. However, it's
7837 possible for an expansion for something afterwards (for example,
7838 expand_check_condition) to do a lookup. We must therefore be sure everything is
7842 acl_where = ACL_WHERE_UNKNOWN;
7851 if (!regex_PIPELINING) regex_PIPELINING =
7852 regex_must_compile(US"\\n250[\\s\\-]PIPELINING(\\s|\\n|$)", FALSE, TRUE);
7854 if (!regex_SIZE) regex_SIZE =
7855 regex_must_compile(US"\\n250[\\s\\-]SIZE(\\s|\\n|$)", FALSE, TRUE);
7857 if (!regex_AUTH) regex_AUTH =
7858 regex_must_compile(US"\\n250[\\s\\-]AUTH\\s+([\\-\\w\\s]+)(?:\\n|$)",
7862 if (!regex_STARTTLS) regex_STARTTLS =
7863 regex_must_compile(US"\\n250[\\s\\-]STARTTLS(\\s|\\n|$)", FALSE, TRUE);
7866 #ifndef DISABLE_PRDR
7867 if (!regex_PRDR) regex_PRDR =
7868 regex_must_compile(US"\\n250[\\s\\-]PRDR(\\s|\\n|$)", FALSE, TRUE);
7871 if (!regex_DSN) regex_DSN =
7872 regex_must_compile(US"\\n250[\\s\\-]DSN(\\s|\\n|$)", FALSE, TRUE);
7874 if (!regex_IGNOREQUOTA) regex_IGNOREQUOTA =
7875 regex_must_compile(US"\\n250[\\s\\-]IGNOREQUOTA(\\s|\\n|$)", FALSE, TRUE);
7881 /* End of deliver.c */