1 /*************************************************
2 * Exim - an Internet mail transport agent *
3 *************************************************/
5 /* Copyright (c) University of Cambridge 1995 - 2016 */
6 /* See the file NOTICE for conditions of use and distribution. */
8 /* The main code for delivering a message. */
15 /* Data block for keeping track of subprocesses for parallel remote
18 typedef struct pardata {
19 address_item *addrlist; /* chain of addresses */
20 address_item *addr; /* next address data expected for */
21 pid_t pid; /* subprocess pid */
22 int fd; /* pipe fd for getting result from subprocess */
23 int transport_count; /* returned transport count value */
24 BOOL done; /* no more data needed */
25 uschar *msg; /* error message */
26 uschar *return_path; /* return_path for these addresses */
29 /* Values for the process_recipients variable */
31 enum { RECIP_ACCEPT, RECIP_IGNORE, RECIP_DEFER,
32 RECIP_FAIL, RECIP_FAIL_FILTER, RECIP_FAIL_TIMEOUT,
35 /* Mutually recursive functions for marking addresses done. */
37 static void child_done(address_item *, uschar *);
38 static void address_done(address_item *, uschar *);
40 /* Table for turning base-62 numbers into binary */
42 static uschar tab62[] =
43 {0,1,2,3,4,5,6,7,8,9,0,0,0,0,0,0, /* 0-9 */
44 0,10,11,12,13,14,15,16,17,18,19,20, /* A-K */
45 21,22,23,24,25,26,27,28,29,30,31,32, /* L-W */
46 33,34,35, 0, 0, 0, 0, 0, /* X-Z */
47 0,36,37,38,39,40,41,42,43,44,45,46, /* a-k */
48 47,48,49,50,51,52,53,54,55,56,57,58, /* l-w */
52 /*************************************************
53 * Local static variables *
54 *************************************************/
56 /* addr_duplicate is global because it needs to be seen from the Envelope-To
59 static address_item *addr_defer = NULL;
60 static address_item *addr_failed = NULL;
61 static address_item *addr_fallback = NULL;
62 static address_item *addr_local = NULL;
63 static address_item *addr_new = NULL;
64 static address_item *addr_remote = NULL;
65 static address_item *addr_route = NULL;
66 static address_item *addr_succeed = NULL;
67 static address_item *addr_dsntmp = NULL;
68 static address_item *addr_senddsn = NULL;
70 static FILE *message_log = NULL;
71 static BOOL update_spool;
72 static BOOL remove_journal;
73 static int parcount = 0;
74 static pardata *parlist = NULL;
75 static int return_count;
76 static uschar *frozen_info = US"";
77 static uschar *used_return_path = NULL;
81 /*************************************************
82 * Make a new address item *
83 *************************************************/
85 /* This function gets the store and initializes with default values. The
86 transport_return value defaults to DEFER, so that any unexpected failure to
87 deliver does not wipe out the message. The default unique string is set to a
88 copy of the address, so that its domain can be lowercased.
91 address the RFC822 address string
92 copy force a copy of the address
94 Returns: a pointer to an initialized address_item
98 deliver_make_addr(uschar *address, BOOL copy)
100 address_item *addr = store_get(sizeof(address_item));
101 *addr = address_defaults;
102 if (copy) address = string_copy(address);
103 addr->address = address;
104 addr->unique = string_copy(address);
111 /*************************************************
112 * Set expansion values for an address *
113 *************************************************/
115 /* Certain expansion variables are valid only when handling an address or
116 address list. This function sets them up or clears the values, according to its
120 addr the address in question, or NULL to clear values
125 deliver_set_expansions(address_item *addr)
129 const uschar ***p = address_expansions;
130 while (*p) **p++ = NULL;
134 /* Exactly what gets set depends on whether there is one or more addresses, and
135 what they contain. These first ones are always set, taking their values from
136 the first address. */
138 if (!addr->host_list)
140 deliver_host = deliver_host_address = US"";
141 deliver_host_port = 0;
145 deliver_host = addr->host_list->name;
146 deliver_host_address = addr->host_list->address;
147 deliver_host_port = addr->host_list->port;
150 deliver_recipients = addr;
151 deliver_address_data = addr->prop.address_data;
152 deliver_domain_data = addr->prop.domain_data;
153 deliver_localpart_data = addr->prop.localpart_data;
155 /* These may be unset for multiple addresses */
157 deliver_domain = addr->domain;
158 self_hostname = addr->self_hostname;
160 #ifdef EXPERIMENTAL_BRIGHTMAIL
161 bmi_deliver = 1; /* deliver by default */
162 bmi_alt_location = NULL;
163 bmi_base64_verdict = NULL;
164 bmi_base64_tracker_verdict = NULL;
167 /* If there's only one address we can set everything. */
171 address_item *addr_orig;
173 deliver_localpart = addr->local_part;
174 deliver_localpart_prefix = addr->prefix;
175 deliver_localpart_suffix = addr->suffix;
177 for (addr_orig = addr; addr_orig->parent; addr_orig = addr_orig->parent) ;
178 deliver_domain_orig = addr_orig->domain;
180 /* Re-instate any prefix and suffix in the original local part. In all
181 normal cases, the address will have a router associated with it, and we can
182 choose the caseful or caseless version accordingly. However, when a system
183 filter sets up a pipe, file, or autoreply delivery, no router is involved.
184 In this case, though, there won't be any prefix or suffix to worry about. */
186 deliver_localpart_orig = !addr_orig->router
187 ? addr_orig->local_part
188 : addr_orig->router->caseful_local_part
189 ? addr_orig->cc_local_part
190 : 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. */
199 deliver_domain_parent = addr->parent->domain;
200 deliver_localpart_parent = !addr->parent->router
201 ? addr->parent->local_part
202 : addr->parent->router->caseful_local_part
203 ? addr->parent->cc_local_part
204 : addr->parent->lc_local_part;
206 /* File deliveries have their own flag because they need to be picked out
207 as special more often. */
209 if (testflag(addr, af_pfr))
211 if (testflag(addr, af_file)) address_file = addr->local_part;
212 else if (deliver_localpart[0] == '|') address_pipe = addr->local_part;
213 deliver_localpart = addr->parent->local_part;
214 deliver_localpart_prefix = addr->parent->prefix;
215 deliver_localpart_suffix = addr->parent->suffix;
219 #ifdef EXPERIMENTAL_BRIGHTMAIL
220 /* Set expansion variables related to Brightmail AntiSpam */
221 bmi_base64_verdict = bmi_get_base64_verdict(deliver_localpart_orig, deliver_domain_orig);
222 bmi_base64_tracker_verdict = bmi_get_base64_tracker_verdict(bmi_base64_verdict);
223 /* get message delivery status (0 - don't deliver | 1 - deliver) */
224 bmi_deliver = bmi_get_delivery_status(bmi_base64_verdict);
225 /* if message is to be delivered, get eventual alternate location */
226 if (bmi_deliver == 1)
227 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; addr2 = addr2->next)
247 if (deliver_domain && Ustrcmp(deliver_domain, addr2->domain) != 0)
248 deliver_domain = NULL;
250 && ( !addr2->self_hostname
251 || Ustrcmp(self_hostname, addr2->self_hostname) != 0
253 self_hostname = NULL;
254 if (!deliver_domain && !self_hostname) break;
262 /*************************************************
263 * Open a msglog file *
264 *************************************************/
266 /* This function is used both for normal message logs, and for files in the
267 msglog directory that are used to catch output from pipes. Try to create the
268 directory if it does not exist. From release 4.21, normal message logs should
269 be created when the message is received.
272 filename the file name
273 mode the mode required
274 error used for saying what failed
276 Returns: a file descriptor, or -1 (with errno set)
280 open_msglog_file(uschar *filename, int mode, uschar **error)
282 int fd = Uopen(filename, O_WRONLY|O_APPEND|O_CREAT, mode);
284 if (fd < 0 && errno == ENOENT)
286 (void)directory_make(spool_directory,
287 spool_sname(US"msglog", message_subdir),
288 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; 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)
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 && end_one->next->mx == mx
420 && end_two->next && 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)
479 for (;; one = one->next, two = two->next)
481 if (one == two) return TRUE; /* Includes the case where both NULL */
482 if (!one || !two) return FALSE;
483 if (Ustrcmp(one->text, two->text) != 0) return FALSE;
489 /*************************************************
490 * Compare string settings *
491 *************************************************/
493 /* This function is given two pointers to strings, and it returns
494 TRUE if they are the same pointer, or if the two strings are the same.
497 one points to the first string
498 two points to the second string
500 Returns: TRUE or FALSE
504 same_strings(uschar *one, uschar *two)
506 if (one == two) return TRUE; /* Includes the case where both NULL */
507 if (!one || !two) return FALSE;
508 return (Ustrcmp(one, two) == 0);
513 /*************************************************
514 * Compare uid/gid for addresses *
515 *************************************************/
517 /* This function is given a transport and two addresses. It yields TRUE if the
518 uid/gid/initgroups settings for the two addresses are going to be the same when
523 addr1 the first address
524 addr2 the second address
526 Returns: TRUE or FALSE
530 same_ugid(transport_instance *tp, address_item *addr1, address_item *addr2)
532 if ( !tp->uid_set && !tp->expand_uid
533 && !tp->deliver_as_creator
534 && ( testflag(addr1, af_uid_set) != testflag(addr2, af_gid_set)
535 || ( testflag(addr1, af_uid_set)
536 && ( addr1->uid != addr2->uid
537 || testflag(addr1, af_initgroups) != testflag(addr2, af_initgroups)
541 if ( !tp->gid_set && !tp->expand_gid
542 && ( testflag(addr1, af_gid_set) != testflag(addr2, af_gid_set)
543 || ( testflag(addr1, af_gid_set)
544 && addr1->gid != addr2->gid
554 /*************************************************
555 * Record that an address is complete *
556 *************************************************/
558 /* This function records that an address is complete. This is straightforward
559 for most addresses, where the unique address is just the full address with the
560 domain lower cased. For homonyms (addresses that are the same as one of their
561 ancestors) their are complications. Their unique addresses have \x\ prepended
562 (where x = 0, 1, 2...), so that de-duplication works correctly for siblings and
565 Exim used to record the unique addresses of homonyms as "complete". This,
566 however, fails when the pattern of redirection varies over time (e.g. if taking
567 unseen copies at only some times of day) because the prepended numbers may vary
568 from one delivery run to the next. This problem is solved by never recording
569 prepended unique addresses as complete. Instead, when a homonymic address has
570 actually been delivered via a transport, we record its basic unique address
571 followed by the name of the transport. This is checked in subsequent delivery
572 runs whenever an address is routed to a transport.
574 If the completed address is a top-level one (has no parent, which means it
575 cannot be homonymic) we also add the original address to the non-recipients
576 tree, so that it gets recorded in the spool file and therefore appears as
577 "done" in any spool listings. The original address may differ from the unique
578 address in the case of the domain.
580 Finally, this function scans the list of duplicates, marks as done any that
581 match this address, and calls child_done() for their ancestors.
584 addr address item that has been completed
585 now current time as a string
591 address_done(address_item *addr, uschar *now)
595 update_spool = TRUE; /* Ensure spool gets updated */
597 /* Top-level address */
601 tree_add_nonrecipient(addr->unique);
602 tree_add_nonrecipient(addr->address);
605 /* Homonymous child address */
607 else if (testflag(addr, af_homonym))
610 tree_add_nonrecipient(
611 string_sprintf("%s/%s", addr->unique + 3, addr->transport->name));
614 /* Non-homonymous child address */
616 else tree_add_nonrecipient(addr->unique);
618 /* Check the list of duplicate addresses and ensure they are now marked
621 for (dup = addr_duplicate; dup; dup = dup->next)
622 if (Ustrcmp(addr->unique, dup->unique) == 0)
624 tree_add_nonrecipient(dup->unique);
625 child_done(dup, now);
632 /*************************************************
633 * Decrease counts in parents and mark done *
634 *************************************************/
636 /* This function is called when an address is complete. If there is a parent
637 address, its count of children is decremented. If there are still other
638 children outstanding, the function exits. Otherwise, if the count has become
639 zero, address_done() is called to mark the parent and its duplicates complete.
640 Then loop for any earlier ancestors.
643 addr points to the completed address item
644 now the current time as a string, for writing to the message log
650 child_done(address_item *addr, uschar *now)
656 if ((addr->child_count -= 1) > 0) return; /* Incomplete parent */
657 address_done(addr, now);
659 /* Log the completion of all descendents only when there is no ancestor with
660 the same original address. */
662 for (aa = addr->parent; aa; aa = aa->parent)
663 if (Ustrcmp(aa->address, addr->address) == 0) break;
666 deliver_msglog("%s %s: children all complete\n", now, addr->address);
667 DEBUG(D_deliver) debug_printf("%s: children all complete\n", addr->address);
673 /*************************************************
674 * Delivery logging support functions *
675 *************************************************/
677 /* The LOGGING() checks in d_log_interface() are complicated for backwards
678 compatibility. When outgoing interface logging was originally added, it was
679 conditional on just incoming_interface (which is off by default). The
680 outgoing_interface option is on by default to preserve this behaviour, but
681 you can enable incoming_interface and disable outgoing_interface to get I=
682 fields on incoming lines only.
685 s The log line buffer
686 sizep Pointer to the buffer size
687 ptrp Pointer to current index into buffer
688 addr The address to be logged
690 Returns: New value for s
694 d_log_interface(uschar *s, int *sizep, int *ptrp)
696 if (LOGGING(incoming_interface) && LOGGING(outgoing_interface)
697 && sending_ip_address)
699 s = string_append(s, sizep, ptrp, 2, US" I=[", sending_ip_address);
700 s = LOGGING(outgoing_port)
701 ? string_append(s, sizep, ptrp, 2, US"]:",
702 string_sprintf("%d", sending_port))
703 : string_catn(s, sizep, ptrp, US"]", 1);
711 d_hostlog(uschar *s, int *sizep, int *ptrp, address_item *addr)
713 s = string_append(s, sizep, ptrp, 5, US" H=", addr->host_used->name,
714 US" [", addr->host_used->address, US"]");
715 if (LOGGING(outgoing_port))
716 s = string_append(s, sizep, ptrp, 2, US":", string_sprintf("%d",
717 addr->host_used->port));
720 if (LOGGING(proxy) && proxy_local_address)
722 s = string_append(s, sizep, ptrp, 3, US" PRX=[", proxy_local_address, US"]");
723 if (LOGGING(outgoing_port))
724 s = string_append(s, sizep, ptrp, 2, US":", string_sprintf("%d",
729 return d_log_interface(s, sizep, ptrp);
738 d_tlslog(uschar * s, int * sizep, int * ptrp, address_item * addr)
740 if (LOGGING(tls_cipher) && addr->cipher)
741 s = string_append(s, sizep, ptrp, 2, US" X=", addr->cipher);
742 if (LOGGING(tls_certificate_verified) && addr->cipher)
743 s = string_append(s, sizep, ptrp, 2, US" CV=",
744 testflag(addr, af_cert_verified)
746 #ifdef EXPERIMENTAL_DANE
747 testflag(addr, af_dane_verified)
753 if (LOGGING(tls_peerdn) && addr->peerdn)
754 s = string_append(s, sizep, ptrp, 3, US" DN=\"",
755 string_printing(addr->peerdn), US"\"");
763 #ifndef DISABLE_EVENT
765 event_raise(uschar * action, const uschar * event, uschar * ev_data)
771 debug_printf("Event(%s): event_action=|%s| delivery_IP=%s\n",
773 action, deliver_host_address);
776 event_data = ev_data;
778 if (!(s = expand_string(action)) && *expand_string_message)
779 log_write(0, LOG_MAIN|LOG_PANIC,
780 "failed to expand event_action %s in %s: %s\n",
781 event, transport_name, expand_string_message);
783 event_name = event_data = NULL;
785 /* If the expansion returns anything but an empty string, flag for
786 the caller to modify his normal processing
791 debug_printf("Event(%s): event_action returned \"%s\"\n", event, s);
799 msg_event_raise(const uschar * event, const address_item * addr)
801 const uschar * save_domain = deliver_domain;
802 uschar * save_local = deliver_localpart;
803 const uschar * save_host = deliver_host;
804 const uschar * save_address = deliver_host_address;
805 const int save_port = deliver_host_port;
807 if (!addr->transport)
810 router_name = addr->router ? addr->router->name : NULL;
811 transport_name = addr->transport->name;
812 deliver_domain = addr->domain;
813 deliver_localpart = addr->local_part;
814 deliver_host = addr->host_used ? addr->host_used->name : NULL;
816 (void) event_raise(addr->transport->event_action, event,
818 || Ustrcmp(addr->transport->driver_name, "smtp") == 0
819 || Ustrcmp(addr->transport->driver_name, "lmtp") == 0
820 ? addr->message : NULL);
822 deliver_host_port = save_port;
823 deliver_host_address = save_address;
824 deliver_host = save_host;
825 deliver_localpart = save_local;
826 deliver_domain = save_domain;
827 router_name = transport_name = NULL;
829 #endif /*DISABLE_EVENT*/
833 /* If msg is NULL this is a delivery log and logchar is used. Otherwise
834 this is a nonstandard call; no two-character delivery flag is written
835 but sender-host and sender are prefixed and "msg" is inserted in the log line.
838 flags passed to log_write()
841 delivery_log(int flags, address_item * addr, int logchar, uschar * msg)
844 int size = 256; /* Used for a temporary, */
845 int ptr = 0; /* expanding buffer, for */
846 uschar *s; /* building log lines; */
847 void *reset_point; /* released afterwards. */
849 /* Log the delivery on the main log. We use an extensible string to build up
850 the log line, and reset the store afterwards. Remote deliveries should always
851 have a pointer to the host item that succeeded; local deliveries can have a
852 pointer to a single host item in their host list, for use by the transport. */
854 #ifndef DISABLE_EVENT
855 /* presume no successful remote delivery */
856 lookup_dnssec_authenticated = NULL;
859 s = reset_point = store_get(size);
861 log_address = string_log_address(addr, LOGGING(all_parents), TRUE);
863 s = string_append(s, &size, &ptr, 3, host_and_ident(TRUE), US" ", log_address);
867 s = string_append(s, &size, &ptr, 2, US"> ", log_address);
870 if (LOGGING(sender_on_delivery) || msg)
871 s = string_append(s, &size, &ptr, 3, US" F=<",
873 testflag(addr, af_utf8_downcvt)
874 ? string_address_utf8_to_alabel(sender_address, NULL)
881 s = string_append(s, &size, &ptr, 2, US" Q=", queue_name);
883 #ifdef EXPERIMENTAL_SRS
884 if(addr->prop.srs_sender)
885 s = string_append(s, &size, &ptr, 3, US" SRS=<", addr->prop.srs_sender, US">");
888 /* You might think that the return path must always be set for a successful
889 delivery; indeed, I did for some time, until this statement crashed. The case
890 when it is not set is for a delivery to /dev/null which is optimised by not
893 if (used_return_path && LOGGING(return_path_on_delivery))
894 s = string_append(s, &size, &ptr, 3, US" P=<", used_return_path, US">");
897 s = string_append(s, &size, &ptr, 2, US" ", msg);
899 /* For a delivery from a system filter, there may not be a router */
901 s = string_append(s, &size, &ptr, 2, US" R=", addr->router->name);
903 s = string_append(s, &size, &ptr, 2, US" T=", addr->transport->name);
905 if (LOGGING(delivery_size))
906 s = string_append(s, &size, &ptr, 2, US" S=",
907 string_sprintf("%d", transport_count));
911 if (addr->transport->info->local)
914 s = string_append(s, &size, &ptr, 2, US" H=", addr->host_list->name);
915 s = d_log_interface(s, &size, &ptr);
916 if (addr->shadow_message)
917 s = string_cat(s, &size, &ptr, addr->shadow_message);
920 /* Remote delivery */
926 s = d_hostlog(s, &size, &ptr, addr);
927 if (continue_sequence > 1)
928 s = string_catn(s, &size, &ptr, US"*", 1);
930 #ifndef DISABLE_EVENT
931 deliver_host_address = addr->host_used->address;
932 deliver_host_port = addr->host_used->port;
933 deliver_host = addr->host_used->name;
935 /* DNS lookup status */
936 lookup_dnssec_authenticated = addr->host_used->dnssec==DS_YES ? US"yes"
937 : addr->host_used->dnssec==DS_NO ? US"no"
943 s = d_tlslog(s, &size, &ptr, addr);
946 if (addr->authenticator)
948 s = string_append(s, &size, &ptr, 2, US" A=", addr->authenticator);
951 s = string_append(s, &size, &ptr, 2, US":", addr->auth_id);
952 if (LOGGING(smtp_mailauth) && addr->auth_sndr)
953 s = string_append(s, &size, &ptr, 2, US":", addr->auth_sndr);
958 if (addr->flags & af_prdr_used)
959 s = string_append(s, &size, &ptr, 1, US" PRDR");
963 /* confirmation message (SMTP (host_used) and LMTP (driver_name)) */
965 if ( LOGGING(smtp_confirmation)
967 && (addr->host_used || Ustrcmp(addr->transport->driver_name, "lmtp") == 0)
971 unsigned lim = big_buffer_size < 1024 ? big_buffer_size : 1024;
972 uschar *p = big_buffer;
973 uschar *ss = addr->message;
975 for (i = 0; i < lim && ss[i] != 0; i++) /* limit logged amount */
977 if (ss[i] == '\"' || ss[i] == '\\') *p++ = '\\'; /* quote \ and " */
982 s = string_append(s, &size, &ptr, 2, US" C=", big_buffer);
985 /* Time on queue and actual time taken to deliver */
987 if (LOGGING(queue_time))
988 s = string_append(s, &size, &ptr, 2, US" QT=",
989 readconf_printtime( (int) ((long)time(NULL) - (long)received_time)) );
991 if (LOGGING(deliver_time))
992 s = string_append(s, &size, &ptr, 2, US" DT=",
993 readconf_printtime(addr->more_errno));
995 /* string_cat() always leaves room for the terminator. Release the
996 store we used to build the line after writing it. */
999 log_write(0, flags, "%s", s);
1001 #ifndef DISABLE_EVENT
1002 if (!msg) msg_event_raise(US"msg:delivery", addr);
1005 store_reset(reset_point);
1011 /*************************************************
1012 * Actions at the end of handling an address *
1013 *************************************************/
1015 /* This is a function for processing a single address when all that can be done
1016 with it has been done.
1019 addr points to the address block
1020 result the result of the delivery attempt
1021 logflags flags for log_write() (LOG_MAIN and/or LOG_PANIC)
1022 driver_type indicates which type of driver (transport, or router) was last
1023 to process the address
1024 logchar '=' or '-' for use when logging deliveries with => or ->
1030 post_process_one(address_item *addr, int result, int logflags, int driver_type,
1033 uschar *now = tod_stamp(tod_log);
1034 uschar *driver_kind = NULL;
1035 uschar *driver_name = NULL;
1036 uschar *log_address;
1038 int size = 256; /* Used for a temporary, */
1039 int ptr = 0; /* expanding buffer, for */
1040 uschar *s; /* building log lines; */
1041 void *reset_point; /* released afterwards. */
1043 DEBUG(D_deliver) debug_printf("post-process %s (%d)\n", addr->address, result);
1045 /* Set up driver kind and name for logging. Disable logging if the router or
1046 transport has disabled it. */
1048 if (driver_type == DTYPE_TRANSPORT)
1050 if (addr->transport)
1052 driver_name = addr->transport->name;
1053 driver_kind = US" transport";
1054 disable_logging = addr->transport->disable_logging;
1056 else driver_kind = US"transporting";
1058 else if (driver_type == DTYPE_ROUTER)
1062 driver_name = addr->router->name;
1063 driver_kind = US" router";
1064 disable_logging = addr->router->disable_logging;
1066 else driver_kind = US"routing";
1069 /* If there's an error message set, ensure that it contains only printing
1070 characters - it should, but occasionally things slip in and this at least
1071 stops the log format from getting wrecked. We also scan the message for an LDAP
1072 expansion item that has a password setting, and flatten the password. This is a
1073 fudge, but I don't know a cleaner way of doing this. (If the item is badly
1074 malformed, it won't ever have gone near LDAP.) */
1078 const uschar * s = string_printing(addr->message);
1080 /* deconst cast ok as string_printing known to have alloc'n'copied */
1081 addr->message = expand_hide_passwords(US s);
1084 /* If we used a transport that has one of the "return_output" options set, and
1085 if it did in fact generate some output, then for return_output we treat the
1086 message as failed if it was not already set that way, so that the output gets
1087 returned to the sender, provided there is a sender to send it to. For
1088 return_fail_output, do this only if the delivery failed. Otherwise we just
1089 unlink the file, and remove the name so that if the delivery failed, we don't
1090 try to send back an empty or unwanted file. The log_output options operate only
1091 on a non-empty file.
1093 In any case, we close the message file, because we cannot afford to leave a
1094 file-descriptor for one address while processing (maybe very many) others. */
1096 if (addr->return_file >= 0 && addr->return_filename)
1098 BOOL return_output = FALSE;
1099 struct stat statbuf;
1100 (void)EXIMfsync(addr->return_file);
1102 /* If there is no output, do nothing. */
1104 if (fstat(addr->return_file, &statbuf) == 0 && statbuf.st_size > 0)
1106 transport_instance *tb = addr->transport;
1108 /* Handle logging options */
1111 || result == FAIL && tb->log_fail_output
1112 || result == DEFER && tb->log_defer_output
1116 FILE *f = Ufopen(addr->return_filename, "rb");
1118 log_write(0, LOG_MAIN|LOG_PANIC, "failed to open %s to log output "
1119 "from %s transport: %s", addr->return_filename, tb->name,
1122 if ((s = US Ufgets(big_buffer, big_buffer_size, f)))
1124 uschar *p = big_buffer + Ustrlen(big_buffer);
1126 while (p > big_buffer && isspace(p[-1])) p--;
1128 sp = string_printing(big_buffer);
1129 log_write(0, LOG_MAIN, "<%s>: %s transport output: %s",
1130 addr->address, tb->name, sp);
1135 /* Handle returning options, but only if there is an address to return
1138 if (sender_address[0] != 0 || addr->prop.errors_address)
1139 if (tb->return_output)
1141 addr->transport_return = result = FAIL;
1142 if (addr->basic_errno == 0 && !addr->message)
1143 addr->message = US"return message generated";
1144 return_output = TRUE;
1147 if (tb->return_fail_output && result == FAIL) return_output = TRUE;
1150 /* Get rid of the file unless it might be returned, but close it in
1155 Uunlink(addr->return_filename);
1156 addr->return_filename = NULL;
1157 addr->return_file = -1;
1160 (void)close(addr->return_file);
1163 /* The success case happens only after delivery by a transport. */
1167 addr->next = addr_succeed;
1168 addr_succeed = addr;
1170 /* Call address_done() to ensure that we don't deliver to this address again,
1171 and write appropriate things to the message log. If it is a child address, we
1172 call child_done() to scan the ancestors and mark them complete if this is the
1173 last child to complete. */
1175 address_done(addr, now);
1176 DEBUG(D_deliver) debug_printf("%s delivered\n", addr->address);
1179 deliver_msglog("%s %s: %s%s succeeded\n", now, addr->address,
1180 driver_name, driver_kind);
1183 deliver_msglog("%s %s <%s>: %s%s succeeded\n", now, addr->address,
1184 addr->parent->address, driver_name, driver_kind);
1185 child_done(addr, now);
1188 /* Certificates for logging (via events) */
1190 tls_out.ourcert = addr->ourcert;
1191 addr->ourcert = NULL;
1192 tls_out.peercert = addr->peercert;
1193 addr->peercert = NULL;
1195 tls_out.cipher = addr->cipher;
1196 tls_out.peerdn = addr->peerdn;
1197 tls_out.ocsp = addr->ocsp;
1198 # ifdef EXPERIMENTAL_DANE
1199 tls_out.dane_verified = testflag(addr, af_dane_verified);
1203 delivery_log(LOG_MAIN, addr, logchar, NULL);
1206 tls_free_cert(&tls_out.ourcert);
1207 tls_free_cert(&tls_out.peercert);
1208 tls_out.cipher = NULL;
1209 tls_out.peerdn = NULL;
1210 tls_out.ocsp = OCSP_NOT_REQ;
1211 # ifdef EXPERIMENTAL_DANE
1212 tls_out.dane_verified = FALSE;
1218 /* Soft failure, or local delivery process failed; freezing may be
1221 else if (result == DEFER || result == PANIC)
1223 if (result == PANIC) logflags |= LOG_PANIC;
1225 /* This puts them on the chain in reverse order. Do not change this, because
1226 the code for handling retries assumes that the one with the retry
1227 information is last. */
1229 addr->next = addr_defer;
1232 /* The only currently implemented special action is to freeze the
1233 message. Logging of this is done later, just before the -H file is
1236 if (addr->special_action == SPECIAL_FREEZE)
1238 deliver_freeze = TRUE;
1239 deliver_frozen_at = time(NULL);
1240 update_spool = TRUE;
1243 /* If doing a 2-stage queue run, we skip writing to either the message
1244 log or the main log for SMTP defers. */
1246 if (!queue_2stage || addr->basic_errno != 0)
1250 /* For errors of the type "retry time not reached" (also remotes skipped
1251 on queue run), logging is controlled by L_retry_defer. Note that this kind
1252 of error number is negative, and all the retry ones are less than any
1255 unsigned int use_log_selector = addr->basic_errno <= ERRNO_RETRY_BASE
1256 ? L_retry_defer : 0;
1258 /* Build up the line that is used for both the message log and the main
1261 s = reset_point = store_get(size);
1263 /* Create the address string for logging. Must not do this earlier, because
1264 an OK result may be changed to FAIL when a pipe returns text. */
1266 log_address = string_log_address(addr, LOGGING(all_parents), result == OK);
1268 s = string_cat(s, &size, &ptr, log_address);
1271 s = string_append(s, &size, &ptr, 2, US" Q=", queue_name);
1273 /* Either driver_name contains something and driver_kind contains
1274 " router" or " transport" (note the leading space), or driver_name is
1275 a null string and driver_kind contains "routing" without the leading
1276 space, if all routing has been deferred. When a domain has been held,
1277 so nothing has been done at all, both variables contain null strings. */
1281 if (driver_kind[1] == 't' && addr->router)
1282 s = string_append(s, &size, &ptr, 2, US" R=", addr->router->name);
1284 ss[1] = toupper(driver_kind[1]);
1285 s = string_append(s, &size, &ptr, 2, ss, driver_name);
1287 else if (driver_kind)
1288 s = string_append(s, &size, &ptr, 2, US" ", driver_kind);
1290 sprintf(CS ss, " defer (%d)", addr->basic_errno);
1291 s = string_cat(s, &size, &ptr, ss);
1293 if (addr->basic_errno > 0)
1294 s = string_append(s, &size, &ptr, 2, US": ",
1295 US strerror(addr->basic_errno));
1297 if (addr->host_used)
1299 s = string_append(s, &size, &ptr, 5,
1300 US" H=", addr->host_used->name,
1301 US" [", addr->host_used->address, US"]");
1302 if (LOGGING(outgoing_port))
1304 int port = addr->host_used->port;
1305 s = string_append(s, &size, &ptr, 2,
1306 US":", port == PORT_NONE ? US"25" : string_sprintf("%d", port));
1311 s = string_append(s, &size, &ptr, 2, US": ", addr->message);
1315 /* Log the deferment in the message log, but don't clutter it
1316 up with retry-time defers after the first delivery attempt. */
1318 if (deliver_firsttime || addr->basic_errno > ERRNO_RETRY_BASE)
1319 deliver_msglog("%s %s\n", now, s);
1321 /* Write the main log and reset the store */
1323 log_write(use_log_selector, logflags, "== %s", s);
1324 store_reset(reset_point);
1329 /* Hard failure. If there is an address to which an error message can be sent,
1330 put this address on the failed list. If not, put it on the deferred list and
1331 freeze the mail message for human attention. The latter action can also be
1332 explicitly requested by a router or transport. */
1336 /* If this is a delivery error, or a message for which no replies are
1337 wanted, and the message's age is greater than ignore_bounce_errors_after,
1338 force the af_ignore_error flag. This will cause the address to be discarded
1339 later (with a log entry). */
1341 if (sender_address[0] == 0 && message_age >= ignore_bounce_errors_after)
1342 setflag(addr, af_ignore_error);
1344 /* Freeze the message if requested, or if this is a bounce message (or other
1345 message with null sender) and this address does not have its own errors
1346 address. However, don't freeze if errors are being ignored. The actual code
1347 to ignore occurs later, instead of sending a message. Logging of freezing
1348 occurs later, just before writing the -H file. */
1350 if ( !testflag(addr, af_ignore_error)
1351 && ( addr->special_action == SPECIAL_FREEZE
1352 || (sender_address[0] == 0 && !addr->prop.errors_address)
1355 frozen_info = addr->special_action == SPECIAL_FREEZE
1357 : sender_local && !local_error_message
1358 ? US" (message created with -f <>)"
1359 : US" (delivery error message)";
1360 deliver_freeze = TRUE;
1361 deliver_frozen_at = time(NULL);
1362 update_spool = TRUE;
1364 /* The address is put on the defer rather than the failed queue, because
1365 the message is being retained. */
1367 addr->next = addr_defer;
1371 /* Don't put the address on the nonrecipients tree yet; wait until an
1372 error message has been successfully sent. */
1376 addr->next = addr_failed;
1380 /* Build up the log line for the message and main logs */
1382 s = reset_point = store_get(size);
1384 /* Create the address string for logging. Must not do this earlier, because
1385 an OK result may be changed to FAIL when a pipe returns text. */
1387 log_address = string_log_address(addr, LOGGING(all_parents), result == OK);
1389 s = string_cat(s, &size, &ptr, log_address);
1391 if (LOGGING(sender_on_delivery))
1392 s = string_append(s, &size, &ptr, 3, US" F=<", sender_address, US">");
1395 s = string_append(s, &size, &ptr, 2, US" Q=", queue_name);
1397 /* Return path may not be set if no delivery actually happened */
1399 if (used_return_path && LOGGING(return_path_on_delivery))
1400 s = string_append(s, &size, &ptr, 3, US" P=<", used_return_path, US">");
1403 s = string_append(s, &size, &ptr, 2, US" R=", addr->router->name);
1404 if (addr->transport)
1405 s = string_append(s, &size, &ptr, 2, US" T=", addr->transport->name);
1407 if (addr->host_used)
1408 s = d_hostlog(s, &size, &ptr, addr);
1411 s = d_tlslog(s, &size, &ptr, addr);
1414 if (addr->basic_errno > 0)
1415 s = string_append(s, &size, &ptr, 2, US": ",
1416 US strerror(addr->basic_errno));
1419 s = string_append(s, &size, &ptr, 2, US": ", addr->message);
1423 /* Do the logging. For the message log, "routing failed" for those cases,
1424 just to make it clearer. */
1427 deliver_msglog("%s %s\n", now, s);
1429 deliver_msglog("%s %s failed for %s\n", now, driver_kind, s);
1431 log_write(0, LOG_MAIN, "** %s", s);
1433 #ifndef DISABLE_EVENT
1434 msg_event_raise(US"msg:fail:delivery", addr);
1437 store_reset(reset_point);
1440 /* Ensure logging is turned on again in all cases */
1442 disable_logging = FALSE;
1448 /*************************************************
1449 * Address-independent error *
1450 *************************************************/
1452 /* This function is called when there's an error that is not dependent on a
1453 particular address, such as an expansion string failure. It puts the error into
1454 all the addresses in a batch, logs the incident on the main and panic logs, and
1455 clears the expansions. It is mostly called from local_deliver(), but can be
1456 called for a remote delivery via findugid().
1459 logit TRUE if (MAIN+PANIC) logging required
1460 addr the first of the chain of addresses
1462 format format string for error message, or NULL if already set in addr
1463 ... arguments for the format
1469 common_error(BOOL logit, address_item *addr, int code, uschar *format, ...)
1471 address_item *addr2;
1472 addr->basic_errno = code;
1478 va_start(ap, format);
1479 if (!string_vformat(buffer, sizeof(buffer), CS format, ap))
1480 log_write(0, LOG_MAIN|LOG_PANIC_DIE,
1481 "common_error expansion was longer than " SIZE_T_FMT, sizeof(buffer));
1483 addr->message = string_copy(buffer);
1486 for (addr2 = addr->next; addr2; addr2 = addr2->next)
1488 addr2->basic_errno = code;
1489 addr2->message = addr->message;
1492 if (logit) log_write(0, LOG_MAIN|LOG_PANIC, "%s", addr->message);
1493 deliver_set_expansions(NULL);
1499 /*************************************************
1500 * Check a "never users" list *
1501 *************************************************/
1503 /* This function is called to check whether a uid is on one of the two "never
1507 uid the uid to be checked
1508 nusers the list to be scanned; the first item in the list is the count
1510 Returns: TRUE if the uid is on the list
1514 check_never_users(uid_t uid, uid_t *nusers)
1517 if (!nusers) return FALSE;
1518 for (i = 1; i <= (int)(nusers[0]); i++) if (nusers[i] == uid) return TRUE;
1524 /*************************************************
1525 * Find uid and gid for a transport *
1526 *************************************************/
1528 /* This function is called for both local and remote deliveries, to find the
1529 uid/gid under which to run the delivery. The values are taken preferentially
1530 from the transport (either explicit or deliver_as_creator), then from the
1531 address (i.e. the router), and if nothing is set, the exim uid/gid are used. If
1532 the resulting uid is on the "never_users" or the "fixed_never_users" list, a
1533 panic error is logged, and the function fails (which normally leads to delivery
1537 addr the address (possibly a chain)
1539 uidp pointer to uid field
1540 gidp pointer to gid field
1541 igfp pointer to the use_initgroups field
1543 Returns: FALSE if failed - error has been set in address(es)
1547 findugid(address_item *addr, transport_instance *tp, uid_t *uidp, gid_t *gidp,
1551 BOOL gid_set = FALSE;
1553 /* Default initgroups flag comes from the transport */
1555 *igfp = tp->initgroups;
1557 /* First see if there's a gid on the transport, either fixed or expandable.
1558 The expanding function always logs failure itself. */
1565 else if (tp->expand_gid)
1567 if (!route_find_expanded_group(tp->expand_gid, tp->name, US"transport", gidp,
1570 common_error(FALSE, addr, ERRNO_GIDFAIL, NULL);
1576 /* If the transport did not set a group, see if the router did. */
1578 if (!gid_set && testflag(addr, af_gid_set))
1584 /* Pick up a uid from the transport if one is set. */
1586 if (tp->uid_set) *uidp = tp->uid;
1588 /* Otherwise, try for an expandable uid field. If it ends up as a numeric id,
1589 it does not provide a passwd value from which a gid can be taken. */
1591 else if (tp->expand_uid)
1594 if (!route_find_expanded_user(tp->expand_uid, tp->name, US"transport", &pw,
1595 uidp, &(addr->message)))
1597 common_error(FALSE, addr, ERRNO_UIDFAIL, NULL);
1607 /* If the transport doesn't set the uid, test the deliver_as_creator flag. */
1609 else if (tp->deliver_as_creator)
1611 *uidp = originator_uid;
1614 *gidp = originator_gid;
1619 /* Otherwise see if the address specifies the uid and if so, take it and its
1622 else if (testflag(addr, af_uid_set))
1625 *igfp = testflag(addr, af_initgroups);
1628 /* Nothing has specified the uid - default to the Exim user, and group if the
1641 /* If no gid is set, it is a disaster. We default to the Exim gid only if
1642 defaulting to the Exim uid. In other words, if the configuration has specified
1643 a uid, it must also provide a gid. */
1647 common_error(TRUE, addr, ERRNO_GIDFAIL, US"User set without group for "
1648 "%s transport", tp->name);
1652 /* Check that the uid is not on the lists of banned uids that may not be used
1653 for delivery processes. */
1655 nuname = check_never_users(*uidp, never_users)
1657 : check_never_users(*uidp, fixed_never_users)
1658 ? US"fixed_never_users"
1662 common_error(TRUE, addr, ERRNO_UIDFAIL, US"User %ld set for %s transport "
1663 "is on the %s list", (long int)(*uidp), tp->name, nuname);
1675 /*************************************************
1676 * Check the size of a message for a transport *
1677 *************************************************/
1679 /* Checks that the message isn't too big for the selected transport.
1680 This is called only when it is known that the limit is set.
1684 addr the (first) address being delivered
1687 DEFER expansion failed or did not yield an integer
1688 FAIL message too big
1692 check_message_size(transport_instance *tp, address_item *addr)
1697 deliver_set_expansions(addr);
1698 size_limit = expand_string_integer(tp->message_size_limit, TRUE);
1699 deliver_set_expansions(NULL);
1701 if (expand_string_message)
1704 addr->message = size_limit == -1
1705 ? string_sprintf("failed to expand message_size_limit "
1706 "in %s transport: %s", tp->name, expand_string_message)
1707 : string_sprintf("invalid message_size_limit "
1708 "in %s transport: %s", tp->name, expand_string_message);
1710 else if (size_limit > 0 && message_size > size_limit)
1714 string_sprintf("message is too big (transport limit = %d)",
1723 /*************************************************
1724 * Transport-time check for a previous delivery *
1725 *************************************************/
1727 /* Check that this base address hasn't previously been delivered to its routed
1728 transport. If it has been delivered, mark it done. The check is necessary at
1729 delivery time in order to handle homonymic addresses correctly in cases where
1730 the pattern of redirection changes between delivery attempts (so the unique
1731 fields change). Non-homonymic previous delivery is detected earlier, at routing
1732 time (which saves unnecessary routing).
1735 addr the address item
1736 testing TRUE if testing wanted only, without side effects
1738 Returns: TRUE if previously delivered by the transport
1742 previously_transported(address_item *addr, BOOL testing)
1744 (void)string_format(big_buffer, big_buffer_size, "%s/%s",
1745 addr->unique + (testflag(addr, af_homonym)? 3:0), addr->transport->name);
1747 if (tree_search(tree_nonrecipients, big_buffer) != 0)
1749 DEBUG(D_deliver|D_route|D_transport)
1750 debug_printf("%s was previously delivered (%s transport): discarded\n",
1751 addr->address, addr->transport->name);
1752 if (!testing) child_done(addr, tod_stamp(tod_log));
1761 /******************************************************
1762 * Check for a given header in a header string *
1763 ******************************************************/
1765 /* This function is used when generating quota warnings. The configuration may
1766 specify any header lines it likes in quota_warn_message. If certain of them are
1767 missing, defaults are inserted, so we need to be able to test for the presence
1771 hdr the required header name
1772 hstring the header string
1774 Returns: TRUE the header is in the string
1775 FALSE the header is not in the string
1779 contains_header(uschar *hdr, uschar *hstring)
1781 int len = Ustrlen(hdr);
1782 uschar *p = hstring;
1785 if (strncmpic(p, hdr, len) == 0)
1788 while (*p == ' ' || *p == '\t') p++;
1789 if (*p == ':') return TRUE;
1791 while (*p != 0 && *p != '\n') p++;
1792 if (*p == '\n') p++;
1800 /*************************************************
1801 * Perform a local delivery *
1802 *************************************************/
1804 /* Each local delivery is performed in a separate process which sets its
1805 uid and gid as specified. This is a safer way than simply changing and
1806 restoring using seteuid(); there is a body of opinion that seteuid() cannot be
1807 used safely. From release 4, Exim no longer makes any use of it. Besides, not
1808 all systems have seteuid().
1810 If the uid/gid are specified in the transport_instance, they are used; the
1811 transport initialization must ensure that either both or neither are set.
1812 Otherwise, the values associated with the address are used. If neither are set,
1813 it is a configuration error.
1815 The transport or the address may specify a home directory (transport over-
1816 rides), and if they do, this is set as $home. If neither have set a working
1817 directory, this value is used for that as well. Otherwise $home is left unset
1818 and the cwd is set to "/" - a directory that should be accessible to all users.
1820 Using a separate process makes it more complicated to get error information
1821 back. We use a pipe to pass the return code and also an error code and error
1822 text string back to the parent process.
1825 addr points to an address block for this delivery; for "normal" local
1826 deliveries this is the only address to be delivered, but for
1827 pseudo-remote deliveries (e.g. by batch SMTP to a file or pipe)
1828 a number of addresses can be handled simultaneously, and in this
1829 case addr will point to a chain of addresses with the same
1832 shadowing TRUE if running a shadow transport; this causes output from pipes
1839 deliver_local(address_item *addr, BOOL shadowing)
1841 BOOL use_initgroups;
1844 int status, len, rc;
1847 uschar *working_directory;
1848 address_item *addr2;
1849 transport_instance *tp = addr->transport;
1851 /* Set up the return path from the errors or sender address. If the transport
1852 has its own return path setting, expand it and replace the existing value. */
1854 if(addr->prop.errors_address)
1855 return_path = addr->prop.errors_address;
1856 #ifdef EXPERIMENTAL_SRS
1857 else if (addr->prop.srs_sender)
1858 return_path = addr->prop.srs_sender;
1861 return_path = sender_address;
1863 if (tp->return_path)
1865 uschar *new_return_path = expand_string(tp->return_path);
1866 if (!new_return_path)
1868 if (!expand_string_forcedfail)
1870 common_error(TRUE, addr, ERRNO_EXPANDFAIL,
1871 US"Failed to expand return path \"%s\" in %s transport: %s",
1872 tp->return_path, tp->name, expand_string_message);
1876 else return_path = new_return_path;
1879 /* For local deliveries, one at a time, the value used for logging can just be
1880 set directly, once and for all. */
1882 used_return_path = return_path;
1884 /* Sort out the uid, gid, and initgroups flag. If an error occurs, the message
1885 gets put into the address(es), and the expansions are unset, so we can just
1888 if (!findugid(addr, tp, &uid, &gid, &use_initgroups)) return;
1890 /* See if either the transport or the address specifies a home directory. A
1891 home directory set in the address may already be expanded; a flag is set to
1892 indicate that. In other cases we must expand it. */
1894 if ( (deliver_home = tp->home_dir) /* Set in transport, or */
1895 || ( (deliver_home = addr->home_dir) /* Set in address and */
1896 && !testflag(addr, af_home_expanded) /* not expanded */
1899 uschar *rawhome = deliver_home;
1900 deliver_home = NULL; /* in case it contains $home */
1901 if (!(deliver_home = expand_string(rawhome)))
1903 common_error(TRUE, addr, ERRNO_EXPANDFAIL, US"home directory \"%s\" failed "
1904 "to expand for %s transport: %s", rawhome, tp->name,
1905 expand_string_message);
1908 if (*deliver_home != '/')
1910 common_error(TRUE, addr, ERRNO_NOTABSOLUTE, US"home directory path \"%s\" "
1911 "is not absolute for %s transport", deliver_home, tp->name);
1916 /* See if either the transport or the address specifies a current directory,
1917 and if so, expand it. If nothing is set, use the home directory, unless it is
1918 also unset in which case use "/", which is assumed to be a directory to which
1919 all users have access. It is necessary to be in a visible directory for some
1920 operating systems when running pipes, as some commands (e.g. "rm" under Solaris
1921 2.5) require this. */
1923 working_directory = tp->current_dir ? tp->current_dir : addr->current_dir;
1924 if (working_directory)
1926 uschar *raw = working_directory;
1927 if (!(working_directory = expand_string(raw)))
1929 common_error(TRUE, addr, ERRNO_EXPANDFAIL, US"current directory \"%s\" "
1930 "failed to expand for %s transport: %s", raw, tp->name,
1931 expand_string_message);
1934 if (*working_directory != '/')
1936 common_error(TRUE, addr, ERRNO_NOTABSOLUTE, US"current directory path "
1937 "\"%s\" is not absolute for %s transport", working_directory, tp->name);
1941 else working_directory = deliver_home ? deliver_home : US"/";
1943 /* If one of the return_output flags is set on the transport, create and open a
1944 file in the message log directory for the transport to write its output onto.
1945 This is mainly used by pipe transports. The file needs to be unique to the
1946 address. This feature is not available for shadow transports. */
1949 && ( tp->return_output || tp->return_fail_output
1950 || tp->log_output || tp->log_fail_output || tp->log_defer_output
1955 addr->return_filename =
1956 spool_fname(US"msglog", message_subdir, message_id,
1957 string_sprintf("-%d-%d", getpid(), return_count++));
1959 if ((addr->return_file = open_msglog_file(addr->return_filename, 0400, &error)) < 0)
1961 common_error(TRUE, addr, errno, US"Unable to %s file for %s transport "
1962 "to return message: %s", error, tp->name, strerror(errno));
1967 /* Create the pipe for inter-process communication. */
1971 common_error(TRUE, addr, ERRNO_PIPEFAIL, US"Creation of pipe failed: %s",
1976 /* Now fork the process to do the real work in the subprocess, but first
1977 ensure that all cached resources are freed so that the subprocess starts with
1978 a clean slate and doesn't interfere with the parent process. */
1982 if ((pid = fork()) == 0)
1984 BOOL replicate = TRUE;
1986 /* Prevent core dumps, as we don't want them in users' home directories.
1987 HP-UX doesn't have RLIMIT_CORE; I don't know how to do this in that
1988 system. Some experimental/developing systems (e.g. GNU/Hurd) may define
1989 RLIMIT_CORE but not support it in setrlimit(). For such systems, do not
1990 complain if the error is "not supported".
1992 There are two scenarios where changing the max limit has an effect. In one,
1993 the user is using a .forward and invoking a command of their choice via pipe;
1994 for these, we do need the max limit to be 0 unless the admin chooses to
1995 permit an increased limit. In the other, the command is invoked directly by
1996 the transport and is under administrator control, thus being able to raise
1997 the limit aids in debugging. So there's no general always-right answer.
1999 Thus we inhibit core-dumps completely but let individual transports, while
2000 still root, re-raise the limits back up to aid debugging. We make the
2001 default be no core-dumps -- few enough people can use core dumps in
2002 diagnosis that it's reasonable to make them something that has to be explicitly requested.
2009 if (setrlimit(RLIMIT_CORE, &rl) < 0)
2011 # ifdef SETRLIMIT_NOT_SUPPORTED
2012 if (errno != ENOSYS && errno != ENOTSUP)
2014 log_write(0, LOG_MAIN|LOG_PANIC, "setrlimit(RLIMIT_CORE) failed: %s",
2019 /* Reset the random number generator, so different processes don't all
2020 have the same sequence. */
2024 /* If the transport has a setup entry, call this first, while still
2025 privileged. (Appendfile uses this to expand quota, for example, while
2026 able to read private files.) */
2028 if (addr->transport->setup)
2029 switch((addr->transport->setup)(addr->transport, addr, NULL, uid, gid,
2033 addr->transport_return = DEFER;
2037 addr->transport_return = PANIC;
2041 /* Ignore SIGINT and SIGTERM during delivery. Also ignore SIGUSR1, as
2042 when the process becomes unprivileged, it won't be able to write to the
2043 process log. SIGHUP is ignored throughout exim, except when it is being
2046 signal(SIGINT, SIG_IGN);
2047 signal(SIGTERM, SIG_IGN);
2048 signal(SIGUSR1, SIG_IGN);
2050 /* Close the unwanted half of the pipe, and set close-on-exec for the other
2051 half - for transports that exec things (e.g. pipe). Then set the required
2054 (void)close(pfd[pipe_read]);
2055 (void)fcntl(pfd[pipe_write], F_SETFD, fcntl(pfd[pipe_write], F_GETFD) |
2057 exim_setugid(uid, gid, use_initgroups,
2058 string_sprintf("local delivery to %s <%s> transport=%s", addr->local_part,
2059 addr->address, addr->transport->name));
2063 address_item *batched;
2064 debug_printf(" home=%s current=%s\n", deliver_home, working_directory);
2065 for (batched = addr->next; batched; batched = batched->next)
2066 debug_printf("additional batched address: %s\n", batched->address);
2069 /* Set an appropriate working directory. */
2071 if (Uchdir(working_directory) < 0)
2073 addr->transport_return = DEFER;
2074 addr->basic_errno = errno;
2075 addr->message = string_sprintf("failed to chdir to %s", working_directory);
2078 /* If successful, call the transport */
2083 set_process_info("delivering %s to %s using %s", message_id,
2084 addr->local_part, addr->transport->name);
2086 /* Setting this global in the subprocess means we need never clear it */
2087 transport_name = addr->transport->name;
2089 /* If a transport filter has been specified, set up its argument list.
2090 Any errors will get put into the address, and FALSE yielded. */
2092 if (addr->transport->filter_command)
2094 ok = transport_set_up_command(&transport_filter_argv,
2095 addr->transport->filter_command,
2096 TRUE, PANIC, addr, US"transport filter", NULL);
2097 transport_filter_timeout = addr->transport->filter_timeout;
2099 else transport_filter_argv = NULL;
2103 debug_print_string(addr->transport->debug_string);
2104 replicate = !(addr->transport->info->code)(addr->transport, addr);
2108 /* Pass the results back down the pipe. If necessary, first replicate the
2109 status in the top address to the others in the batch. The label is the
2110 subject of a goto when a call to the transport's setup function fails. We
2111 pass the pointer to the transport back in case it got changed as a result of
2112 file_format in appendfile. */
2116 if (replicate) replicate_status(addr);
2117 for (addr2 = addr; addr2; addr2 = addr2->next)
2120 int local_part_length = Ustrlen(addr2->local_part);
2124 if( (ret = write(pfd[pipe_write], &addr2->transport_return, sizeof(int))) != sizeof(int)
2125 || (ret = write(pfd[pipe_write], &transport_count, sizeof(transport_count))) != sizeof(transport_count)
2126 || (ret = write(pfd[pipe_write], &addr2->flags, sizeof(addr2->flags))) != sizeof(addr2->flags)
2127 || (ret = write(pfd[pipe_write], &addr2->basic_errno, sizeof(int))) != sizeof(int)
2128 || (ret = write(pfd[pipe_write], &addr2->more_errno, sizeof(int))) != sizeof(int)
2129 || (ret = write(pfd[pipe_write], &addr2->special_action, sizeof(int))) != sizeof(int)
2130 || (ret = write(pfd[pipe_write], &addr2->transport,
2131 sizeof(transport_instance *))) != sizeof(transport_instance *)
2133 /* For a file delivery, pass back the local part, in case the original
2134 was only part of the final delivery path. This gives more complete
2137 || (testflag(addr2, af_file)
2138 && ( (ret = write(pfd[pipe_write], &local_part_length, sizeof(int))) != sizeof(int)
2139 || (ret = write(pfd[pipe_write], addr2->local_part, local_part_length)) != local_part_length
2143 log_write(0, LOG_MAIN|LOG_PANIC, "Failed writing transport results to pipe: %s\n",
2144 ret == -1 ? strerror(errno) : "short write");
2146 /* Now any messages */
2148 for (i = 0, s = addr2->message; i < 2; i++, s = addr2->user_message)
2150 int message_length = s ? Ustrlen(s) + 1 : 0;
2151 if( (ret = write(pfd[pipe_write], &message_length, sizeof(int))) != sizeof(int)
2152 || message_length > 0 && (ret = write(pfd[pipe_write], s, message_length)) != message_length
2154 log_write(0, LOG_MAIN|LOG_PANIC, "Failed writing transport results to pipe: %s\n",
2155 ret == -1 ? strerror(errno) : "short write");
2159 /* OK, this process is now done. Free any cached resources that it opened,
2160 and close the pipe we were writing down before exiting. */
2162 (void)close(pfd[pipe_write]);
2167 /* Back in the main process: panic if the fork did not succeed. This seems
2168 better than returning an error - if forking is failing it is probably best
2169 not to try other deliveries for this message. */
2172 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Fork failed for local delivery to %s",
2175 /* Read the pipe to get the delivery status codes and error messages. Our copy
2176 of the writing end must be closed first, as otherwise read() won't return zero
2177 on an empty pipe. We check that a status exists for each address before
2178 overwriting the address structure. If data is missing, the default DEFER status
2179 will remain. Afterwards, close the reading end. */
2181 (void)close(pfd[pipe_write]);
2183 for (addr2 = addr; addr2; addr2 = addr2->next)
2185 len = read(pfd[pipe_read], &status, sizeof(int));
2191 addr2->transport_return = status;
2192 len = read(pfd[pipe_read], &transport_count,
2193 sizeof(transport_count));
2194 len = read(pfd[pipe_read], &addr2->flags, sizeof(addr2->flags));
2195 len = read(pfd[pipe_read], &addr2->basic_errno, sizeof(int));
2196 len = read(pfd[pipe_read], &addr2->more_errno, sizeof(int));
2197 len = read(pfd[pipe_read], &addr2->special_action, sizeof(int));
2198 len = read(pfd[pipe_read], &addr2->transport,
2199 sizeof(transport_instance *));
2201 if (testflag(addr2, af_file))
2203 int local_part_length;
2204 len = read(pfd[pipe_read], &local_part_length, sizeof(int));
2205 len = read(pfd[pipe_read], big_buffer, local_part_length);
2206 big_buffer[local_part_length] = 0;
2207 addr2->local_part = string_copy(big_buffer);
2210 for (i = 0, sptr = &addr2->message; i < 2; i++, sptr = &addr2->user_message)
2213 len = read(pfd[pipe_read], &message_length, sizeof(int));
2214 if (message_length > 0)
2216 len = read(pfd[pipe_read], big_buffer, message_length);
2217 big_buffer[big_buffer_size-1] = '\0'; /* guard byte */
2218 if (len > 0) *sptr = string_copy(big_buffer);
2225 log_write(0, LOG_MAIN|LOG_PANIC, "failed to read delivery status for %s "
2226 "from delivery subprocess", addr2->unique);
2231 (void)close(pfd[pipe_read]);
2233 /* Unless shadowing, write all successful addresses immediately to the journal
2234 file, to ensure they are recorded asap. For homonymic addresses, use the base
2235 address plus the transport name. Failure to write the journal is panic-worthy,
2236 but don't stop, as it may prove possible subsequently to update the spool file
2237 in order to record the delivery. */
2241 for (addr2 = addr; addr2; addr2 = addr2->next)
2242 if (addr2->transport_return == OK)
2244 if (testflag(addr2, af_homonym))
2245 sprintf(CS big_buffer, "%.500s/%s\n", addr2->unique + 3, tp->name);
2247 sprintf(CS big_buffer, "%.500s\n", addr2->unique);
2249 /* In the test harness, wait just a bit to let the subprocess finish off
2250 any debug output etc first. */
2252 if (running_in_test_harness) millisleep(300);
2254 DEBUG(D_deliver) debug_printf("journalling %s", big_buffer);
2255 len = Ustrlen(big_buffer);
2256 if (write(journal_fd, big_buffer, len) != len)
2257 log_write(0, LOG_MAIN|LOG_PANIC, "failed to update journal for %s: %s",
2258 big_buffer, strerror(errno));
2261 /* Ensure the journal file is pushed out to disk. */
2263 if (EXIMfsync(journal_fd) < 0)
2264 log_write(0, LOG_MAIN|LOG_PANIC, "failed to fsync journal: %s",
2268 /* Wait for the process to finish. If it terminates with a non-zero code,
2269 freeze the message (except for SIGTERM, SIGKILL and SIGQUIT), but leave the
2270 status values of all the addresses as they are. Take care to handle the case
2271 when the subprocess doesn't seem to exist. This has been seen on one system
2272 when Exim was called from an MUA that set SIGCHLD to SIG_IGN. When that
2273 happens, wait() doesn't recognize the termination of child processes. Exim now
2274 resets SIGCHLD to SIG_DFL, but this code should still be robust. */
2276 while ((rc = wait(&status)) != pid)
2277 if (rc < 0 && errno == ECHILD) /* Process has vanished */
2279 log_write(0, LOG_MAIN, "%s transport process vanished unexpectedly",
2280 addr->transport->driver_name);
2285 if ((status & 0xffff) != 0)
2287 int msb = (status >> 8) & 255;
2288 int lsb = status & 255;
2289 int code = (msb == 0)? (lsb & 0x7f) : msb;
2290 if (msb != 0 || (code != SIGTERM && code != SIGKILL && code != SIGQUIT))
2291 addr->special_action = SPECIAL_FREEZE;
2292 log_write(0, LOG_MAIN|LOG_PANIC, "%s transport process returned non-zero "
2293 "status 0x%04x: %s %d",
2294 addr->transport->driver_name,
2296 msb == 0 ? "terminated by signal" : "exit code",
2300 /* If SPECIAL_WARN is set in the top address, send a warning message. */
2302 if (addr->special_action == SPECIAL_WARN && addr->transport->warn_message)
2305 uschar *warn_message;
2308 DEBUG(D_deliver) debug_printf("Warning message requested by transport\n");
2310 if (!(warn_message = expand_string(addr->transport->warn_message)))
2311 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand \"%s\" (warning "
2312 "message for %s transport): %s", addr->transport->warn_message,
2313 addr->transport->name, expand_string_message);
2315 else if ((pid = child_open_exim(&fd)) > 0)
2317 FILE *f = fdopen(fd, "wb");
2318 if (errors_reply_to && !contains_header(US"Reply-To", warn_message))
2319 fprintf(f, "Reply-To: %s\n", errors_reply_to);
2320 fprintf(f, "Auto-Submitted: auto-replied\n");
2321 if (!contains_header(US"From", warn_message))
2323 fprintf(f, "%s", CS warn_message);
2325 /* Close and wait for child process to complete, without a timeout. */
2328 (void)child_close(pid, 0);
2331 addr->special_action = SPECIAL_NONE;
2338 /* Check transport for the given concurrency limit. Return TRUE if over
2339 the limit (or an expansion failure), else FALSE and if there was a limit,
2340 the key for the hints database used for the concurrency count. */
2343 tpt_parallel_check(transport_instance * tp, address_item * addr, uschar ** key)
2345 unsigned max_parallel;
2347 if (!tp->max_parallel) return FALSE;
2349 max_parallel = (unsigned) expand_string_integer(tp->max_parallel, TRUE);
2350 if (expand_string_message)
2352 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand max_parallel option "
2353 "in %s transport (%s): %s", tp->name, addr->address,
2354 expand_string_message);
2358 if (max_parallel > 0)
2360 uschar * serialize_key = string_sprintf("tpt-serialize-%s", tp->name);
2361 if (!enq_start(serialize_key, max_parallel))
2363 address_item * next;
2365 debug_printf("skipping tpt %s because concurrency limit %u reached\n",
2366 tp->name, max_parallel);
2370 addr->message = US"concurrency limit reached for transport";
2371 addr->basic_errno = ERRNO_TRETRY;
2372 post_process_one(addr, DEFER, LOG_MAIN, DTYPE_TRANSPORT, 0);
2373 } while ((addr = next));
2376 *key = serialize_key;
2383 /*************************************************
2384 * Do local deliveries *
2385 *************************************************/
2387 /* This function processes the list of addresses in addr_local. True local
2388 deliveries are always done one address at a time. However, local deliveries can
2389 be batched up in some cases. Typically this is when writing batched SMTP output
2390 files for use by some external transport mechanism, or when running local
2391 deliveries over LMTP.
2398 do_local_deliveries(void)
2401 open_db *dbm_file = NULL;
2402 time_t now = time(NULL);
2404 /* Loop until we have exhausted the supply of local deliveries */
2408 time_t delivery_start;
2410 address_item *addr2, *addr3, *nextaddr;
2411 int logflags = LOG_MAIN;
2412 int logchar = dont_deliver? '*' : '=';
2413 transport_instance *tp;
2414 uschar * serialize_key = NULL;
2416 /* Pick the first undelivered address off the chain */
2418 address_item *addr = addr_local;
2419 addr_local = addr->next;
2422 DEBUG(D_deliver|D_transport)
2423 debug_printf("--------> %s <--------\n", addr->address);
2425 /* An internal disaster if there is no transport. Should not occur! */
2427 if (!(tp = addr->transport))
2429 logflags |= LOG_PANIC;
2430 disable_logging = FALSE; /* Jic */
2431 addr->message = addr->router
2432 ? string_sprintf("No transport set by %s router", addr->router->name)
2433 : string_sprintf("No transport set by system filter");
2434 post_process_one(addr, DEFER, logflags, DTYPE_TRANSPORT, 0);
2438 /* Check that this base address hasn't previously been delivered to this
2439 transport. The check is necessary at this point to handle homonymic addresses
2440 correctly in cases where the pattern of redirection changes between delivery
2441 attempts. Non-homonymic previous delivery is detected earlier, at routing
2444 if (previously_transported(addr, FALSE)) continue;
2446 /* There are weird cases where logging is disabled */
2448 disable_logging = tp->disable_logging;
2450 /* Check for batched addresses and possible amalgamation. Skip all the work
2451 if either batch_max <= 1 or there aren't any other addresses for local
2454 if (tp->batch_max > 1 && addr_local)
2456 int batch_count = 1;
2457 BOOL uses_dom = readconf_depends((driver_instance *)tp, US"domain");
2458 BOOL uses_lp = ( testflag(addr, af_pfr)
2459 && (testflag(addr, af_file) || addr->local_part[0] == '|')
2461 || readconf_depends((driver_instance *)tp, US"local_part");
2462 uschar *batch_id = NULL;
2463 address_item **anchor = &addr_local;
2464 address_item *last = addr;
2467 /* Expand the batch_id string for comparison with other addresses.
2468 Expansion failure suppresses batching. */
2472 deliver_set_expansions(addr);
2473 batch_id = expand_string(tp->batch_id);
2474 deliver_set_expansions(NULL);
2477 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand batch_id option "
2478 "in %s transport (%s): %s", tp->name, addr->address,
2479 expand_string_message);
2480 batch_count = tp->batch_max;
2484 /* Until we reach the batch_max limit, pick off addresses which have the
2485 same characteristics. These are:
2488 not previously delivered (see comment about 50 lines above)
2489 same local part if the transport's configuration contains $local_part
2490 or if this is a file or pipe delivery from a redirection
2491 same domain if the transport's configuration contains $domain
2493 same additional headers
2494 same headers to be removed
2495 same uid/gid for running the transport
2496 same first host if a host list is set
2499 while ((next = *anchor) && batch_count < tp->batch_max)
2502 tp == next->transport
2503 && !previously_transported(next, TRUE)
2504 && (addr->flags & (af_pfr|af_file)) == (next->flags & (af_pfr|af_file))
2505 && (!uses_lp || Ustrcmp(next->local_part, addr->local_part) == 0)
2506 && (!uses_dom || Ustrcmp(next->domain, addr->domain) == 0)
2507 && same_strings(next->prop.errors_address, addr->prop.errors_address)
2508 && same_headers(next->prop.extra_headers, addr->prop.extra_headers)
2509 && same_strings(next->prop.remove_headers, addr->prop.remove_headers)
2510 && same_ugid(tp, addr, next)
2511 && ( !addr->host_list && !next->host_list
2514 && Ustrcmp(addr->host_list->name, next->host_list->name) == 0
2517 /* If the transport has a batch_id setting, batch_id will be non-NULL
2518 from the expansion outside the loop. Expand for this address and compare.
2519 Expansion failure makes this address ineligible for batching. */
2524 address_item *save_nextnext = next->next;
2525 next->next = NULL; /* Expansion for a single address */
2526 deliver_set_expansions(next);
2527 next->next = save_nextnext;
2528 bid = expand_string(tp->batch_id);
2529 deliver_set_expansions(NULL);
2532 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand batch_id option "
2533 "in %s transport (%s): %s", tp->name, next->address,
2534 expand_string_message);
2537 else ok = (Ustrcmp(batch_id, bid) == 0);
2540 /* Take address into batch if OK. */
2544 *anchor = next->next; /* Include the address */
2550 else anchor = &next->next; /* Skip the address */
2554 /* We now have one or more addresses that can be delivered in a batch. Check
2555 whether the transport is prepared to accept a message of this size. If not,
2556 fail them all forthwith. If the expansion fails, or does not yield an
2557 integer, defer delivery. */
2559 if (tp->message_size_limit)
2561 int rc = check_message_size(tp, addr);
2564 replicate_status(addr);
2568 post_process_one(addr, rc, logflags, DTYPE_TRANSPORT, 0);
2571 continue; /* With next batch of addresses */
2575 /* If we are not running the queue, or if forcing, all deliveries will be
2576 attempted. Otherwise, we must respect the retry times for each address. Even
2577 when not doing this, we need to set up the retry key string, and determine
2578 whether a retry record exists, because after a successful delivery, a delete
2579 retry item must be set up. Keep the retry database open only for the duration
2580 of these checks, rather than for all local deliveries, because some local
2581 deliveries (e.g. to pipes) can take a substantial time. */
2583 if (!(dbm_file = dbfn_open(US"retry", O_RDONLY, &dbblock, FALSE)))
2585 DEBUG(D_deliver|D_retry|D_hints_lookup)
2586 debug_printf("no retry data available\n");
2593 BOOL ok = TRUE; /* to deliver this address */
2596 /* Set up the retry key to include the domain or not, and change its
2597 leading character from "R" to "T". Must make a copy before doing this,
2598 because the old key may be pointed to from a "delete" retry item after
2601 retry_key = string_copy(
2602 tp->retry_use_local_part ? addr2->address_retry_key :
2603 addr2->domain_retry_key);
2606 /* Inspect the retry data. If there is no hints file, delivery happens. */
2610 dbdata_retry *retry_record = dbfn_read(dbm_file, retry_key);
2612 /* If there is no retry record, delivery happens. If there is,
2613 remember it exists so it can be deleted after a successful delivery. */
2617 setflag(addr2, af_lt_retry_exists);
2619 /* A retry record exists for this address. If queue running and not
2620 forcing, inspect its contents. If the record is too old, or if its
2621 retry time has come, or if it has passed its cutoff time, delivery
2626 debug_printf("retry record exists: age=%s ",
2627 readconf_printtime(now - retry_record->time_stamp));
2628 debug_printf("(max %s)\n", readconf_printtime(retry_data_expire));
2629 debug_printf(" time to retry = %s expired = %d\n",
2630 readconf_printtime(retry_record->next_try - now),
2631 retry_record->expired);
2634 if (queue_running && !deliver_force)
2636 ok = (now - retry_record->time_stamp > retry_data_expire)
2637 || (now >= retry_record->next_try)
2638 || retry_record->expired;
2640 /* If we haven't reached the retry time, there is one more check
2641 to do, which is for the ultimate address timeout. */
2644 ok = retry_ultimate_address_timeout(retry_key, addr2->domain,
2648 else DEBUG(D_retry) debug_printf("no retry record exists\n");
2651 /* This address is to be delivered. Leave it on the chain. */
2656 addr2 = addr2->next;
2659 /* This address is to be deferred. Take it out of the chain, and
2660 post-process it as complete. Must take it out of the chain first,
2661 because post processing puts it on another chain. */
2665 address_item *this = addr2;
2666 this->message = US"Retry time not yet reached";
2667 this->basic_errno = ERRNO_LRETRY;
2668 addr2 = addr3 ? (addr3->next = addr2->next)
2669 : (addr = addr2->next);
2670 post_process_one(this, DEFER, logflags, DTYPE_TRANSPORT, 0);
2674 if (dbm_file) dbfn_close(dbm_file);
2676 /* If there are no addresses left on the chain, they all deferred. Loop
2677 for the next set of addresses. */
2679 if (!addr) continue;
2681 /* If the transport is limited for parallellism, enforce that here.
2682 We use a hints DB entry, incremented here and decremented after
2683 the transport (and any shadow transport) completes. */
2685 if (tpt_parallel_check(tp, addr, &serialize_key))
2687 if (expand_string_message)
2689 logflags |= LOG_PANIC;
2693 post_process_one(addr, DEFER, logflags, DTYPE_TRANSPORT, 0);
2694 } while ((addr = addr2));
2696 continue; /* Loop for the next set of addresses. */
2700 /* So, finally, we do have some addresses that can be passed to the
2701 transport. Before doing so, set up variables that are relevant to a
2704 deliver_set_expansions(addr);
2705 delivery_start = time(NULL);
2706 deliver_local(addr, FALSE);
2707 deliver_time = (int)(time(NULL) - delivery_start);
2709 /* If a shadow transport (which must perforce be another local transport), is
2710 defined, and its condition is met, we must pass the message to the shadow
2711 too, but only those addresses that succeeded. We do this by making a new
2712 chain of addresses - also to keep the original chain uncontaminated. We must
2713 use a chain rather than doing it one by one, because the shadow transport may
2716 NOTE: if the condition fails because of a lookup defer, there is nothing we
2720 && ( !tp->shadow_condition
2721 || expand_check_condition(tp->shadow_condition, tp->name, US"transport")
2724 transport_instance *stp;
2725 address_item *shadow_addr = NULL;
2726 address_item **last = &shadow_addr;
2728 for (stp = transports; stp; stp = stp->next)
2729 if (Ustrcmp(stp->name, tp->shadow) == 0) break;
2732 log_write(0, LOG_MAIN|LOG_PANIC, "shadow transport \"%s\" not found ",
2735 /* Pick off the addresses that have succeeded, and make clones. Put into
2736 the shadow_message field a pointer to the shadow_message field of the real
2739 else for (addr2 = addr; addr2; addr2 = addr2->next)
2740 if (addr2->transport_return == OK)
2742 addr3 = store_get(sizeof(address_item));
2745 addr3->shadow_message = (uschar *) &(addr2->shadow_message);
2746 addr3->transport = stp;
2747 addr3->transport_return = DEFER;
2748 addr3->return_filename = NULL;
2749 addr3->return_file = -1;
2751 last = &(addr3->next);
2754 /* If we found any addresses to shadow, run the delivery, and stick any
2755 message back into the shadow_message field in the original. */
2759 int save_count = transport_count;
2761 DEBUG(D_deliver|D_transport)
2762 debug_printf(">>>>>>>>>>>>>>>> Shadow delivery >>>>>>>>>>>>>>>>\n");
2763 deliver_local(shadow_addr, TRUE);
2765 for(; shadow_addr; shadow_addr = shadow_addr->next)
2767 int sresult = shadow_addr->transport_return;
2768 *(uschar **)shadow_addr->shadow_message =
2770 ? string_sprintf(" ST=%s", stp->name)
2771 : string_sprintf(" ST=%s (%s%s%s)", stp->name,
2772 shadow_addr->basic_errno <= 0
2774 : US strerror(shadow_addr->basic_errno),
2775 shadow_addr->basic_errno <= 0 || !shadow_addr->message
2778 shadow_addr->message
2779 ? shadow_addr->message
2780 : shadow_addr->basic_errno <= 0
2784 DEBUG(D_deliver|D_transport)
2785 debug_printf("%s shadow transport returned %s for %s\n",
2787 sresult == OK ? "OK" :
2788 sresult == DEFER ? "DEFER" :
2789 sresult == FAIL ? "FAIL" :
2790 sresult == PANIC ? "PANIC" : "?",
2791 shadow_addr->address);
2794 DEBUG(D_deliver|D_transport)
2795 debug_printf(">>>>>>>>>>>>>>>> End shadow delivery >>>>>>>>>>>>>>>>\n");
2797 transport_count = save_count; /* Restore original transport count */
2801 /* Cancel the expansions that were set up for the delivery. */
2803 deliver_set_expansions(NULL);
2805 /* If the transport was parallelism-limited, decrement the hints DB record. */
2807 if (serialize_key) enq_end(serialize_key);
2809 /* Now we can process the results of the real transport. We must take each
2810 address off the chain first, because post_process_one() puts it on another
2813 for (addr2 = addr; addr2; addr2 = nextaddr)
2815 int result = addr2->transport_return;
2816 nextaddr = addr2->next;
2818 DEBUG(D_deliver|D_transport)
2819 debug_printf("%s transport returned %s for %s\n",
2821 result == OK ? "OK" :
2822 result == DEFER ? "DEFER" :
2823 result == FAIL ? "FAIL" :
2824 result == PANIC ? "PANIC" : "?",
2827 /* If there is a retry_record, or if delivery is deferred, build a retry
2828 item for setting a new retry time or deleting the old retry record from
2829 the database. These items are handled all together after all addresses
2830 have been handled (so the database is open just for a short time for
2833 if (result == DEFER || testflag(addr2, af_lt_retry_exists))
2835 int flags = result == DEFER ? 0 : rf_delete;
2836 uschar *retry_key = string_copy(tp->retry_use_local_part
2837 ? addr2->address_retry_key : addr2->domain_retry_key);
2839 retry_add_item(addr2, retry_key, flags);
2842 /* Done with this address */
2844 if (result == OK) addr2->more_errno = deliver_time;
2845 post_process_one(addr2, result, logflags, DTYPE_TRANSPORT, logchar);
2847 /* If a pipe delivery generated text to be sent back, the result may be
2848 changed to FAIL, and we must copy this for subsequent addresses in the
2851 if (addr2->transport_return != result)
2853 for (addr3 = nextaddr; addr3; addr3 = addr3->next)
2855 addr3->transport_return = addr2->transport_return;
2856 addr3->basic_errno = addr2->basic_errno;
2857 addr3->message = addr2->message;
2859 result = addr2->transport_return;
2862 /* Whether or not the result was changed to FAIL, we need to copy the
2863 return_file value from the first address into all the addresses of the
2864 batch, so they are all listed in the error message. */
2866 addr2->return_file = addr->return_file;
2868 /* Change log character for recording successful deliveries. */
2870 if (result == OK) logchar = '-';
2872 } /* Loop back for next batch of addresses */
2878 /*************************************************
2879 * Sort remote deliveries *
2880 *************************************************/
2882 /* This function is called if remote_sort_domains is set. It arranges that the
2883 chain of addresses for remote deliveries is ordered according to the strings
2884 specified. Try to make this shuffling reasonably efficient by handling
2885 sequences of addresses rather than just single ones.
2892 sort_remote_deliveries(void)
2895 address_item **aptr = &addr_remote;
2896 const uschar *listptr = remote_sort_domains;
2901 && (pattern = string_nextinlist(&listptr, &sep, patbuf, sizeof(patbuf)))
2904 address_item *moved = NULL;
2905 address_item **bptr = &moved;
2909 address_item **next;
2910 deliver_domain = (*aptr)->domain; /* set $domain */
2911 if (match_isinlist(deliver_domain, (const uschar **)&pattern, UCHAR_MAX+1,
2912 &domainlist_anchor, NULL, MCL_DOMAIN, TRUE, NULL) == OK)
2914 aptr = &(*aptr)->next;
2918 next = &(*aptr)->next;
2920 && (deliver_domain = (*next)->domain, /* Set $domain */
2921 match_isinlist(deliver_domain, (const uschar **)&pattern, UCHAR_MAX+1,
2922 &domainlist_anchor, NULL, MCL_DOMAIN, TRUE, NULL)) != OK
2924 next = &(*next)->next;
2926 /* If the batch of non-matchers is at the end, add on any that were
2927 extracted further up the chain, and end this iteration. Otherwise,
2928 extract them from the chain and hang on the moved chain. */
2940 aptr = &(*aptr)->next;
2943 /* If the loop ended because the final address matched, *aptr will
2944 be NULL. Add on to the end any extracted non-matching addresses. If
2945 *aptr is not NULL, the loop ended via "break" when *next is null, that
2946 is, there was a string of non-matching addresses at the end. In this
2947 case the extracted addresses have already been added on the end. */
2949 if (!*aptr) *aptr = moved;
2955 debug_printf("remote addresses after sorting:\n");
2956 for (addr = addr_remote; addr; addr = addr->next)
2957 debug_printf(" %s\n", addr->address);
2963 /*************************************************
2964 * Read from pipe for remote delivery subprocess *
2965 *************************************************/
2967 /* This function is called when the subprocess is complete, but can also be
2968 called before it is complete, in order to empty a pipe that is full (to prevent
2969 deadlock). It must therefore keep track of its progress in the parlist data
2972 We read the pipe to get the delivery status codes and a possible error message
2973 for each address, optionally preceded by unusability data for the hosts and
2974 also by optional retry data.
2976 Read in large chunks into the big buffer and then scan through, interpreting
2977 the data therein. In most cases, only a single read will be necessary. No
2978 individual item will ever be anywhere near 2500 bytes in length, so by ensuring
2979 that we read the next chunk when there is less than 2500 bytes left in the
2980 non-final chunk, we can assume each item is complete in the buffer before
2981 handling it. Each item is written using a single write(), which is atomic for
2982 small items (less than PIPE_BUF, which seems to be at least 512 in any Unix and
2983 often bigger) so even if we are reading while the subprocess is still going, we
2984 should never have only a partial item in the buffer.
2987 poffset the offset of the parlist item
2988 eop TRUE if the process has completed
2990 Returns: TRUE if the terminating 'Z' item has been read,
2991 or there has been a disaster (i.e. no more data needed);
2996 par_read_pipe(int poffset, BOOL eop)
2999 pardata *p = parlist + poffset;
3000 address_item *addrlist = p->addrlist;
3001 address_item *addr = p->addr;
3004 uschar *endptr = big_buffer;
3005 uschar *ptr = endptr;
3006 uschar *msg = p->msg;
3007 BOOL done = p->done;
3008 BOOL unfinished = TRUE;
3009 /* minimum size to read is header size including id, subid and length */
3010 int required = PIPE_HEADER_SIZE;
3012 /* Loop through all items, reading from the pipe when necessary. The pipe
3013 is set up to be non-blocking, but there are two different Unix mechanisms in
3014 use. Exim uses O_NONBLOCK if it is defined. This returns 0 for end of file,
3015 and EAGAIN for no more data. If O_NONBLOCK is not defined, Exim uses O_NDELAY,
3016 which returns 0 for both end of file and no more data. We distinguish the
3017 two cases by taking 0 as end of file only when we know the process has
3020 Each separate item is written to the pipe in a single write(), and as they are
3021 all short items, the writes will all be atomic and we should never find
3022 ourselves in the position of having read an incomplete item. "Short" in this
3023 case can mean up to about 1K in the case when there is a long error message
3024 associated with an address. */
3026 DEBUG(D_deliver) debug_printf("reading pipe for subprocess %d (%s)\n",
3027 (int)p->pid, eop? "ended" : "not ended");
3031 retry_item *r, **rp;
3032 int remaining = endptr - ptr;
3033 uschar header[PIPE_HEADER_SIZE + 1];
3037 /* Read (first time) or top up the chars in the buffer if necessary.
3038 There will be only one read if we get all the available data (i.e. don't
3039 fill the buffer completely). */
3041 if (remaining < required && unfinished)
3044 int available = big_buffer_size - remaining;
3046 if (remaining > 0) memmove(big_buffer, ptr, remaining);
3049 endptr = big_buffer + remaining;
3050 len = read(fd, endptr, available);
3052 DEBUG(D_deliver) debug_printf("read() yielded %d\n", len);
3054 /* If the result is EAGAIN and the process is not complete, just
3055 stop reading any more and process what we have already. */
3059 if (!eop && errno == EAGAIN) len = 0; else
3061 msg = string_sprintf("failed to read pipe from transport process "
3062 "%d for transport %s: %s", pid, addr->transport->driver_name,
3068 /* If the length is zero (eof or no-more-data), just process what we
3069 already have. Note that if the process is still running and we have
3070 read all the data in the pipe (but less that "available") then we
3071 won't read any more, as "unfinished" will get set FALSE. */
3075 unfinished = len == available;
3078 /* If we are at the end of the available data, exit the loop. */
3079 if (ptr >= endptr) break;
3081 /* copy and read header */
3082 memcpy(header, ptr, PIPE_HEADER_SIZE);
3083 header[PIPE_HEADER_SIZE] = '\0';
3086 required = Ustrtol(header + 2, &endc, 10) + PIPE_HEADER_SIZE; /* header + data */
3089 msg = string_sprintf("failed to read pipe from transport process "
3090 "%d for transport %s: error reading size from header", pid, addr->transport->driver_name);
3096 debug_printf("header read id:%c,subid:%c,size:%s,required:%d,remaining:%d,unfinished:%d\n",
3097 id, subid, header+2, required, remaining, unfinished);
3099 /* is there room for the dataset we want to read ? */
3100 if (required > big_buffer_size - PIPE_HEADER_SIZE)
3102 msg = string_sprintf("failed to read pipe from transport process "
3103 "%d for transport %s: big_buffer too small! required size=%d buffer size=%d", pid, addr->transport->driver_name,
3104 required, big_buffer_size - PIPE_HEADER_SIZE);
3109 /* we wrote all datasets with atomic write() calls
3110 remaining < required only happens if big_buffer was too small
3111 to get all available data from pipe. unfinished has to be true
3113 if (remaining < required)
3117 msg = string_sprintf("failed to read pipe from transport process "
3118 "%d for transport %s: required size=%d > remaining size=%d and unfinished=false",
3119 pid, addr->transport->driver_name, required, remaining);
3124 /* step behind the header */
3125 ptr += PIPE_HEADER_SIZE;
3127 /* Handle each possible type of item, assuming the complete item is
3128 available in store. */
3132 /* Host items exist only if any hosts were marked unusable. Match
3133 up by checking the IP address. */
3136 for (h = addrlist->host_list; h; h = h->next)
3138 if (!h->address || Ustrcmp(h->address, ptr+2) != 0) continue;
3146 /* Retry items are sent in a preceding R item for each address. This is
3147 kept separate to keep each message short enough to guarantee it won't
3148 be split in the pipe. Hopefully, in the majority of cases, there won't in
3149 fact be any retry items at all.
3151 The complete set of retry items might include an item to delete a
3152 routing retry if there was a previous routing delay. However, routing
3153 retries are also used when a remote transport identifies an address error.
3154 In that case, there may also be an "add" item for the same key. Arrange
3155 that a "delete" item is dropped in favour of an "add" item. */
3158 if (!addr) goto ADDR_MISMATCH;
3160 DEBUG(D_deliver|D_retry)
3161 debug_printf("reading retry information for %s from subprocess\n",
3164 /* Cut out any "delete" items on the list. */
3166 for (rp = &(addr->retries); (r = *rp); rp = &r->next)
3167 if (Ustrcmp(r->key, ptr+1) == 0) /* Found item with same key */
3169 if ((r->flags & rf_delete) == 0) break; /* It was not "delete" */
3170 *rp = r->next; /* Excise a delete item */
3171 DEBUG(D_deliver|D_retry)
3172 debug_printf(" existing delete item dropped\n");
3175 /* We want to add a delete item only if there is no non-delete item;
3176 however we still have to step ptr through the data. */
3178 if (!r || (*ptr & rf_delete) == 0)
3180 r = store_get(sizeof(retry_item));
3181 r->next = addr->retries;
3184 r->key = string_copy(ptr);
3186 memcpy(&(r->basic_errno), ptr, sizeof(r->basic_errno));
3187 ptr += sizeof(r->basic_errno);
3188 memcpy(&(r->more_errno), ptr, sizeof(r->more_errno));
3189 ptr += sizeof(r->more_errno);
3190 r->message = (*ptr)? string_copy(ptr) : NULL;
3191 DEBUG(D_deliver|D_retry)
3192 debug_printf(" added %s item\n",
3193 ((r->flags & rf_delete) == 0)? "retry" : "delete");
3198 DEBUG(D_deliver|D_retry)
3199 debug_printf(" delete item not added: non-delete item exists\n");
3202 ptr += sizeof(r->basic_errno) + sizeof(r->more_errno);
3208 /* Put the amount of data written into the parlist block */
3211 memcpy(&(p->transport_count), ptr, sizeof(transport_count));
3212 ptr += sizeof(transport_count);
3215 /* Address items are in the order of items on the address chain. We
3216 remember the current address value in case this function is called
3217 several times to empty the pipe in stages. Information about delivery
3218 over TLS is sent in a preceding X item for each address. We don't put
3219 it in with the other info, in order to keep each message short enough to
3220 guarantee it won't be split in the pipe. */
3224 if (!addr) goto ADDR_MISMATCH; /* Below, in 'A' handler */
3228 addr->cipher = NULL;
3229 addr->peerdn = NULL;
3232 addr->cipher = string_copy(ptr);
3235 addr->peerdn = string_copy(ptr);
3240 (void) tls_import_cert(ptr, &addr->peercert);
3242 addr->peercert = NULL;
3247 (void) tls_import_cert(ptr, &addr->ourcert);
3249 addr->ourcert = NULL;
3252 # ifndef DISABLE_OCSP
3254 addr->ocsp = OCSP_NOT_REQ;
3256 addr->ocsp = *ptr - '0';
3262 #endif /*SUPPORT_TLS*/
3264 case 'C': /* client authenticator information */
3268 addr->authenticator = (*ptr)? string_copy(ptr) : NULL;
3271 addr->auth_id = (*ptr)? string_copy(ptr) : NULL;
3274 addr->auth_sndr = (*ptr)? string_copy(ptr) : NULL;
3280 #ifndef DISABLE_PRDR
3282 addr->flags |= af_prdr_used;
3287 if (!addr) goto ADDR_MISMATCH;
3288 memcpy(&(addr->dsn_aware), ptr, sizeof(addr->dsn_aware));
3289 ptr += sizeof(addr->dsn_aware);
3290 DEBUG(D_deliver) debug_printf("DSN read: addr->dsn_aware = %d\n", addr->dsn_aware);
3297 msg = string_sprintf("address count mismatch for data read from pipe "
3298 "for transport process %d for transport %s", pid,
3299 addrlist->transport->driver_name);
3306 #ifdef SUPPORT_SOCKS
3307 case '2': /* proxy information; must arrive before A0 and applies to that addr XXX oops*/
3308 proxy_session = TRUE; /*XXX shouod this be cleared somewhere? */
3313 proxy_local_address = string_copy(ptr);
3315 memcpy(&proxy_local_port, ptr, sizeof(proxy_local_port));
3316 ptr += sizeof(proxy_local_port);
3321 #ifdef EXPERIMENTAL_DSN_INFO
3322 case '1': /* must arrive before A0, and applies to that addr */
3323 /* Two strings: smtp_greeting and helo_response */
3324 addr->smtp_greeting = string_copy(ptr);
3326 addr->helo_response = string_copy(ptr);
3332 addr->transport_return = *ptr++;
3333 addr->special_action = *ptr++;
3334 memcpy(&(addr->basic_errno), ptr, sizeof(addr->basic_errno));
3335 ptr += sizeof(addr->basic_errno);
3336 memcpy(&(addr->more_errno), ptr, sizeof(addr->more_errno));
3337 ptr += sizeof(addr->more_errno);
3338 memcpy(&(addr->flags), ptr, sizeof(addr->flags));
3339 ptr += sizeof(addr->flags);
3340 addr->message = (*ptr)? string_copy(ptr) : NULL;
3342 addr->user_message = (*ptr)? string_copy(ptr) : NULL;
3345 /* Always two strings for host information, followed by the port number and DNSSEC mark */
3349 h = store_get(sizeof(host_item));
3350 h->name = string_copy(ptr);
3352 h->address = string_copy(ptr);
3354 memcpy(&(h->port), ptr, sizeof(h->port));
3355 ptr += sizeof(h->port);
3356 h->dnssec = *ptr == '2' ? DS_YES
3357 : *ptr == '1' ? DS_NO
3360 addr->host_used = h;
3364 /* Finished with this address */
3371 /* Local interface address/port */
3373 if (*ptr) sending_ip_address = string_copy(ptr);
3375 if (*ptr) sending_port = atoi(CS ptr);
3379 /* Z marks the logical end of the data. It is followed by '0' if
3380 continue_transport was NULL at the end of transporting, otherwise '1'.
3381 We need to know when it becomes NULL during a delivery down a passed SMTP
3382 channel so that we don't try to pass anything more down it. Of course, for
3383 most normal messages it will remain NULL all the time. */
3388 continue_transport = NULL;
3389 continue_hostname = NULL;
3392 DEBUG(D_deliver) debug_printf("Z0%c item read\n", *ptr);
3395 /* Anything else is a disaster. */
3398 msg = string_sprintf("malformed data (%d) read from pipe for transport "
3399 "process %d for transport %s", ptr[-1], pid,
3400 addr->transport->driver_name);
3406 /* The done flag is inspected externally, to determine whether or not to
3407 call the function again when the process finishes. */
3411 /* If the process hadn't finished, and we haven't seen the end of the data
3412 or suffered a disaster, update the rest of the state, and return FALSE to
3413 indicate "not finished". */
3422 /* Close our end of the pipe, to prevent deadlock if the far end is still
3423 pushing stuff into it. */
3428 /* If we have finished without error, but haven't had data for every address,
3429 something is wrong. */
3432 msg = string_sprintf("insufficient address data read from pipe "
3433 "for transport process %d for transport %s", pid,
3434 addr->transport->driver_name);
3436 /* If an error message is set, something has gone wrong in getting back
3437 the delivery data. Put the message into each address and freeze it. */
3440 for (addr = addrlist; addr; addr = addr->next)
3442 addr->transport_return = DEFER;
3443 addr->special_action = SPECIAL_FREEZE;
3444 addr->message = msg;
3447 /* Return TRUE to indicate we have got all we need from this process, even
3448 if it hasn't actually finished yet. */
3455 /*************************************************
3456 * Post-process a set of remote addresses *
3457 *************************************************/
3459 /* Do what has to be done immediately after a remote delivery for each set of
3460 addresses, then re-write the spool if necessary. Note that post_process_one
3461 puts the address on an appropriate queue; hence we must fish off the next
3462 one first. This function is also called if there is a problem with setting
3463 up a subprocess to do a remote delivery in parallel. In this case, the final
3464 argument contains a message, and the action must be forced to DEFER.
3467 addr pointer to chain of address items
3468 logflags flags for logging
3469 msg NULL for normal cases; -> error message for unexpected problems
3470 fallback TRUE if processing fallback hosts
3476 remote_post_process(address_item *addr, int logflags, uschar *msg,
3481 /* If any host addresses were found to be unusable, add them to the unusable
3482 tree so that subsequent deliveries don't try them. */
3484 for (h = addr->host_list; h; h = h->next)
3486 if (h->status >= hstatus_unusable) tree_add_unusable(h);
3488 /* Now handle each address on the chain. The transport has placed '=' or '-'
3489 into the special_action field for each successful delivery. */
3493 address_item *next = addr->next;
3495 /* If msg == NULL (normal processing) and the result is DEFER and we are
3496 processing the main hosts and there are fallback hosts available, put the
3497 address on the list for fallback delivery. */
3499 if ( addr->transport_return == DEFER
3500 && addr->fallback_hosts
3505 addr->host_list = addr->fallback_hosts;
3506 addr->next = addr_fallback;
3507 addr_fallback = addr;
3508 DEBUG(D_deliver) debug_printf("%s queued for fallback host(s)\n", addr->address);
3511 /* If msg is set (=> unexpected problem), set it in the address before
3512 doing the ordinary post processing. */
3518 addr->message = msg;
3519 addr->transport_return = DEFER;
3521 (void)post_process_one(addr, addr->transport_return, logflags,
3522 DTYPE_TRANSPORT, addr->special_action);
3530 /* If we have just delivered down a passed SMTP channel, and that was
3531 the last address, the channel will have been closed down. Now that
3532 we have logged that delivery, set continue_sequence to 1 so that
3533 any subsequent deliveries don't get "*" incorrectly logged. */
3535 if (!continue_transport) continue_sequence = 1;
3540 /*************************************************
3541 * Wait for one remote delivery subprocess *
3542 *************************************************/
3544 /* This function is called while doing remote deliveries when either the
3545 maximum number of processes exist and we need one to complete so that another
3546 can be created, or when waiting for the last ones to complete. It must wait for
3547 the completion of one subprocess, empty the control block slot, and return a
3548 pointer to the address chain.
3551 Returns: pointer to the chain of addresses handled by the process;
3552 NULL if no subprocess found - this is an unexpected error
3555 static address_item *
3558 int poffset, status;
3559 address_item *addr, *addrlist;
3562 set_process_info("delivering %s: waiting for a remote delivery subprocess "
3563 "to finish", message_id);
3565 /* Loop until either a subprocess completes, or there are no subprocesses in
3566 existence - in which case give an error return. We cannot proceed just by
3567 waiting for a completion, because a subprocess may have filled up its pipe, and
3568 be waiting for it to be emptied. Therefore, if no processes have finished, we
3569 wait for one of the pipes to acquire some data by calling select(), with a
3570 timeout just in case.
3572 The simple approach is just to iterate after reading data from a ready pipe.
3573 This leads to non-ideal behaviour when the subprocess has written its final Z
3574 item, closed the pipe, and is in the process of exiting (the common case). A
3575 call to waitpid() yields nothing completed, but select() shows the pipe ready -
3576 reading it yields EOF, so you end up with busy-waiting until the subprocess has
3579 To avoid this, if all the data that is needed has been read from a subprocess
3580 after select(), an explicit wait() for it is done. We know that all it is doing
3581 is writing to the pipe and then exiting, so the wait should not be long.
3583 The non-blocking waitpid() is to some extent just insurance; if we could
3584 reliably detect end-of-file on the pipe, we could always know when to do a
3585 blocking wait() for a completed process. However, because some systems use
3586 NDELAY, which doesn't distinguish between EOF and pipe empty, it is easier to
3587 use code that functions without the need to recognize EOF.
3589 There's a double loop here just in case we end up with a process that is not in
3590 the list of remote delivery processes. Something has obviously gone wrong if
3591 this is the case. (For example, a process that is incorrectly left over from
3592 routing or local deliveries might be found.) The damage can be minimized by
3593 looping back and looking for another process. If there aren't any, the error
3594 return will happen. */
3596 for (;;) /* Normally we do not repeat this loop */
3598 while ((pid = waitpid(-1, &status, WNOHANG)) <= 0)
3601 fd_set select_pipes;
3602 int maxpipe, readycount;
3604 /* A return value of -1 can mean several things. If errno != ECHILD, it
3605 either means invalid options (which we discount), or that this process was
3606 interrupted by a signal. Just loop to try the waitpid() again.
3608 If errno == ECHILD, waitpid() is telling us that there are no subprocesses
3609 in existence. This should never happen, and is an unexpected error.
3610 However, there is a nasty complication when running under Linux. If "strace
3611 -f" is being used under Linux to trace this process and its children,
3612 subprocesses are "stolen" from their parents and become the children of the
3613 tracing process. A general wait such as the one we've just obeyed returns
3614 as if there are no children while subprocesses are running. Once a
3615 subprocess completes, it is restored to the parent, and waitpid(-1) finds
3616 it. Thanks to Joachim Wieland for finding all this out and suggesting a
3619 This does not happen using "truss" on Solaris, nor (I think) with other
3620 tracing facilities on other OS. It seems to be specific to Linux.
3622 What we do to get round this is to use kill() to see if any of our
3623 subprocesses are still in existence. If kill() gives an OK return, we know
3624 it must be for one of our processes - it can't be for a re-use of the pid,
3625 because if our process had finished, waitpid() would have found it. If any
3626 of our subprocesses are in existence, we proceed to use select() as if
3627 waitpid() had returned zero. I think this is safe. */
3631 if (errno != ECHILD) continue; /* Repeats the waitpid() */
3634 debug_printf("waitpid() returned -1/ECHILD: checking explicitly "
3635 "for process existence\n");
3637 for (poffset = 0; poffset < remote_max_parallel; poffset++)
3639 if ((pid = parlist[poffset].pid) != 0 && kill(pid, 0) == 0)
3641 DEBUG(D_deliver) debug_printf("process %d still exists: assume "
3642 "stolen by strace\n", (int)pid);
3643 break; /* With poffset set */
3647 if (poffset >= remote_max_parallel)
3649 DEBUG(D_deliver) debug_printf("*** no delivery children found\n");
3650 return NULL; /* This is the error return */
3654 /* A pid value greater than 0 breaks the "while" loop. A negative value has
3655 been handled above. A return value of zero means that there is at least one
3656 subprocess, but there are no completed subprocesses. See if any pipes are
3657 ready with any data for reading. */
3659 DEBUG(D_deliver) debug_printf("selecting on subprocess pipes\n");
3662 FD_ZERO(&select_pipes);
3663 for (poffset = 0; poffset < remote_max_parallel; poffset++)
3665 if (parlist[poffset].pid != 0)
3667 int fd = parlist[poffset].fd;
3668 FD_SET(fd, &select_pipes);
3669 if (fd > maxpipe) maxpipe = fd;
3673 /* Stick in a 60-second timeout, just in case. */
3678 readycount = select(maxpipe + 1, (SELECT_ARG2_TYPE *)&select_pipes,
3681 /* Scan through the pipes and read any that are ready; use the count
3682 returned by select() to stop when there are no more. Select() can return
3683 with no processes (e.g. if interrupted). This shouldn't matter.
3685 If par_read_pipe() returns TRUE, it means that either the terminating Z was
3686 read, or there was a disaster. In either case, we are finished with this
3687 process. Do an explicit wait() for the process and break the main loop if
3690 It turns out that we have to deal with the case of an interrupted system
3691 call, which can happen on some operating systems if the signal handling is
3692 set up to do that by default. */
3695 readycount > 0 && poffset < remote_max_parallel;
3698 if ( (pid = parlist[poffset].pid) != 0
3699 && FD_ISSET(parlist[poffset].fd, &select_pipes)
3703 if (par_read_pipe(poffset, FALSE)) /* Finished with this pipe */
3705 for (;;) /* Loop for signals */
3707 pid_t endedpid = waitpid(pid, &status, 0);
3708 if (endedpid == pid) goto PROCESS_DONE;
3709 if (endedpid != (pid_t)(-1) || errno != EINTR)
3710 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Unexpected error return "
3711 "%d (errno = %d) from waitpid() for process %d",
3712 (int)endedpid, errno, (int)pid);
3718 /* Now go back and look for a completed subprocess again. */
3721 /* A completed process was detected by the non-blocking waitpid(). Find the
3722 data block that corresponds to this subprocess. */
3724 for (poffset = 0; poffset < remote_max_parallel; poffset++)
3725 if (pid == parlist[poffset].pid) break;
3727 /* Found the data block; this is a known remote delivery process. We don't
3728 need to repeat the outer loop. This should be what normally happens. */
3730 if (poffset < remote_max_parallel) break;
3732 /* This situation is an error, but it's probably better to carry on looking
3733 for another process than to give up (as we used to do). */
3735 log_write(0, LOG_MAIN|LOG_PANIC, "Process %d finished: not found in remote "
3736 "transport process list", pid);
3737 } /* End of the "for" loop */
3739 /* Come here when all the data was completely read after a select(), and
3740 the process in pid has been wait()ed for. */
3747 debug_printf("remote delivery process %d ended\n", (int)pid);
3749 debug_printf("remote delivery process %d ended: status=%04x\n", (int)pid,
3753 set_process_info("delivering %s", message_id);
3755 /* Get the chain of processed addresses */
3757 addrlist = parlist[poffset].addrlist;
3759 /* If the process did not finish cleanly, record an error and freeze (except
3760 for SIGTERM, SIGKILL and SIGQUIT), and also ensure the journal is not removed,
3761 in case the delivery did actually happen. */
3763 if ((status & 0xffff) != 0)
3766 int msb = (status >> 8) & 255;
3767 int lsb = status & 255;
3768 int code = (msb == 0)? (lsb & 0x7f) : msb;
3770 msg = string_sprintf("%s transport process returned non-zero status 0x%04x: "
3772 addrlist->transport->driver_name,
3774 (msb == 0)? "terminated by signal" : "exit code",
3777 if (msb != 0 || (code != SIGTERM && code != SIGKILL && code != SIGQUIT))
3778 addrlist->special_action = SPECIAL_FREEZE;
3780 for (addr = addrlist; addr; addr = addr->next)
3782 addr->transport_return = DEFER;
3783 addr->message = msg;
3786 remove_journal = FALSE;
3789 /* Else complete reading the pipe to get the result of the delivery, if all
3790 the data has not yet been obtained. */
3792 else if (!parlist[poffset].done) (void)par_read_pipe(poffset, TRUE);
3794 /* Put the data count and return path into globals, mark the data slot unused,
3795 decrement the count of subprocesses, and return the address chain. */
3797 transport_count = parlist[poffset].transport_count;
3798 used_return_path = parlist[poffset].return_path;
3799 parlist[poffset].pid = 0;
3806 /*************************************************
3807 * Wait for subprocesses and post-process *
3808 *************************************************/
3810 /* This function waits for subprocesses until the number that are still running
3811 is below a given threshold. For each complete subprocess, the addresses are
3812 post-processed. If we can't find a running process, there is some shambles.
3813 Better not bomb out, as that might lead to multiple copies of the message. Just
3814 log and proceed as if all done.
3817 max maximum number of subprocesses to leave running
3818 fallback TRUE if processing fallback hosts
3824 par_reduce(int max, BOOL fallback)
3826 while (parcount > max)
3828 address_item *doneaddr = par_wait();
3831 log_write(0, LOG_MAIN|LOG_PANIC,
3832 "remote delivery process count got out of step");
3837 transport_instance * tp = doneaddr->transport;
3838 if (tp->max_parallel)
3839 enq_end(string_sprintf("tpt-serialize-%s", tp->name));
3841 remote_post_process(doneaddr, LOG_MAIN, NULL, fallback);
3850 rmt_dlv_checked_write(int fd, char id, char subid, void * buf, int size)
3852 uschar writebuffer[PIPE_HEADER_SIZE + BIG_BUFFER_SIZE];
3856 /* we assume that size can't get larger then BIG_BUFFER_SIZE which currently is set to 16k */
3857 /* complain to log if someone tries with buffer sizes we can't handle*/
3861 log_write(0, LOG_MAIN|LOG_PANIC_DIE,
3862 "Failed writing transport result to pipe: can't handle buffers > 99999 bytes. truncating!\n");
3866 /* to keep the write() atomic we build header in writebuffer and copy buf behind */
3867 /* two write() calls would increase the complexity of reading from pipe */
3869 /* convert size to human readable string prepended by id and subid */
3870 header_length = snprintf(CS writebuffer, PIPE_HEADER_SIZE+1, "%c%c%05d", id, subid, size);
3871 if (header_length != PIPE_HEADER_SIZE)
3873 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "header snprintf failed\n");
3874 writebuffer[0] = '\0';
3877 DEBUG(D_deliver) debug_printf("header write id:%c,subid:%c,size:%d,final:%s\n",
3878 id, subid, size, writebuffer);
3880 if (buf && size > 0)
3881 memcpy(writebuffer + PIPE_HEADER_SIZE, buf, size);
3883 size += PIPE_HEADER_SIZE;
3884 if ((ret = write(fd, writebuffer, size)) != size)
3885 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Failed writing transport result to pipe: %s\n",
3886 ret == -1 ? strerror(errno) : "short write");
3889 /*************************************************
3890 * Do remote deliveries *
3891 *************************************************/
3893 /* This function is called to process the addresses in addr_remote. We must
3894 pick off the queue all addresses that have the same transport, remote
3895 destination, and errors address, and hand them to the transport in one go,
3896 subject to some configured limitations. If this is a run to continue delivering
3897 to an existing delivery channel, skip all but those addresses that can go to
3898 that channel. The skipped addresses just get deferred.
3900 If mua_wrapper is set, all addresses must be able to be sent in a single
3901 transaction. If not, this function yields FALSE.
3903 In Exim 4, remote deliveries are always done in separate processes, even
3904 if remote_max_parallel = 1 or if there's only one delivery to do. The reason
3905 is so that the base process can retain privilege. This makes the
3906 implementation of fallback transports feasible (though not initially done.)
3908 We create up to the configured number of subprocesses, each of which passes
3909 back the delivery state via a pipe. (However, when sending down an existing
3910 connection, remote_max_parallel is forced to 1.)
3913 fallback TRUE if processing fallback hosts
3915 Returns: TRUE normally
3916 FALSE if mua_wrapper is set and the addresses cannot all be sent
3921 do_remote_deliveries(BOOL fallback)
3927 parcount = 0; /* Number of executing subprocesses */
3929 /* When sending down an existing channel, only do one delivery at a time.
3930 We use a local variable (parmax) to hold the maximum number of processes;
3931 this gets reduced from remote_max_parallel if we can't create enough pipes. */
3933 if (continue_transport) remote_max_parallel = 1;
3934 parmax = remote_max_parallel;
3936 /* If the data for keeping a list of processes hasn't yet been
3941 parlist = store_get(remote_max_parallel * sizeof(pardata));
3942 for (poffset = 0; poffset < remote_max_parallel; poffset++)
3943 parlist[poffset].pid = 0;
3946 /* Now loop for each remote delivery */
3948 for (delivery_count = 0; addr_remote; delivery_count++)
3954 int address_count = 1;
3955 int address_count_max;
3957 BOOL use_initgroups;
3958 BOOL pipe_done = FALSE;
3959 transport_instance *tp;
3960 address_item **anchor = &addr_remote;
3961 address_item *addr = addr_remote;
3962 address_item *last = addr;
3965 uschar * serialize_key = NULL;
3967 /* Pull the first address right off the list. */
3969 addr_remote = addr->next;
3972 DEBUG(D_deliver|D_transport)
3973 debug_printf("--------> %s <--------\n", addr->address);
3975 /* If no transport has been set, there has been a big screw-up somewhere. */
3977 if (!(tp = addr->transport))
3979 disable_logging = FALSE; /* Jic */
3980 panicmsg = US"No transport set by router";
3981 goto panic_continue;
3984 /* Check that this base address hasn't previously been delivered to this
3985 transport. The check is necessary at this point to handle homonymic addresses
3986 correctly in cases where the pattern of redirection changes between delivery
3987 attempts. Non-homonymic previous delivery is detected earlier, at routing
3990 if (previously_transported(addr, FALSE)) continue;
3992 /* Force failure if the message is too big. */
3994 if (tp->message_size_limit)
3996 int rc = check_message_size(tp, addr);
3999 addr->transport_return = rc;
4000 remote_post_process(addr, LOG_MAIN, NULL, fallback);
4005 /* Get the flag which specifies whether the transport can handle different
4006 domains that nevertheless resolve to the same set of hosts. If it needs
4007 expanding, get variables set: $address_data, $domain_data, $localpart_data,
4008 $host, $host_address, $host_port. */
4009 if (tp->expand_multi_domain)
4010 deliver_set_expansions(addr);
4012 if (exp_bool(addr, US"transport", tp->name, D_transport,
4013 US"multi_domain", tp->multi_domain, tp->expand_multi_domain,
4014 &multi_domain) != OK)
4016 deliver_set_expansions(NULL);
4017 panicmsg = addr->message;
4018 goto panic_continue;
4021 /* Get the maximum it can handle in one envelope, with zero meaning
4022 unlimited, which is forced for the MUA wrapper case. */
4024 address_count_max = tp->max_addresses;
4025 if (address_count_max == 0 || mua_wrapper) address_count_max = 999999;
4028 /************************************************************************/
4029 /***** This is slightly experimental code, but should be safe. *****/
4031 /* The address_count_max value is the maximum number of addresses that the
4032 transport can send in one envelope. However, the transport must be capable of
4033 dealing with any number of addresses. If the number it gets exceeds its
4034 envelope limitation, it must send multiple copies of the message. This can be
4035 done over a single connection for SMTP, so uses less resources than making
4036 multiple connections. On the other hand, if remote_max_parallel is greater
4037 than one, it is perhaps a good idea to use parallel processing to move the
4038 message faster, even if that results in multiple simultaneous connections to
4041 How can we come to some compromise between these two ideals? What we do is to
4042 limit the number of addresses passed to a single instance of a transport to
4043 the greater of (a) its address limit (rcpt_max for SMTP) and (b) the total
4044 number of addresses routed to remote transports divided by
4045 remote_max_parallel. For example, if the message has 100 remote recipients,
4046 remote max parallel is 2, and rcpt_max is 10, we'd never send more than 50 at
4047 once. But if rcpt_max is 100, we could send up to 100.
4049 Of course, not all the remotely addresses in a message are going to go to the
4050 same set of hosts (except in smarthost configurations), so this is just a
4051 heuristic way of dividing up the work.
4053 Furthermore (1), because this may not be wanted in some cases, and also to
4054 cope with really pathological cases, there is also a limit to the number of
4055 messages that are sent over one connection. This is the same limit that is
4056 used when sending several different messages over the same connection.
4057 Continue_sequence is set when in this situation, to the number sent so
4058 far, including this message.
4060 Furthermore (2), when somebody explicitly sets the maximum value to 1, it
4061 is probably because they are using VERP, in which case they want to pass only
4062 one address at a time to the transport, in order to be able to use
4063 $local_part and $domain in constructing a new return path. We could test for
4064 the use of these variables, but as it is so likely they will be used when the
4065 maximum is 1, we don't bother. Just leave the value alone. */
4067 if ( address_count_max != 1
4068 && address_count_max < remote_delivery_count/remote_max_parallel
4071 int new_max = remote_delivery_count/remote_max_parallel;
4072 int message_max = tp->connection_max_messages;
4073 if (connection_max_messages >= 0) message_max = connection_max_messages;
4074 message_max -= continue_sequence - 1;
4075 if (message_max > 0 && new_max > address_count_max * message_max)
4076 new_max = address_count_max * message_max;
4077 address_count_max = new_max;
4080 /************************************************************************/
4083 /* Pick off all addresses which have the same transport, errors address,
4084 destination, and extra headers. In some cases they point to the same host
4085 list, but we also need to check for identical host lists generated from
4086 entirely different domains. The host list pointers can be NULL in the case
4087 where the hosts are defined in the transport. There is also a configured
4088 maximum limit of addresses that can be handled at once (see comments above
4089 for how it is computed).
4090 If the transport does not handle multiple domains, enforce that also,
4091 and if it might need a per-address check for this, re-evaluate it.
4094 while ((next = *anchor) && address_count < address_count_max)
4097 if ( (multi_domain || Ustrcmp(next->domain, addr->domain) == 0)
4098 && tp == next->transport
4099 && same_hosts(next->host_list, addr->host_list)
4100 && same_strings(next->prop.errors_address, addr->prop.errors_address)
4101 && same_headers(next->prop.extra_headers, addr->prop.extra_headers)
4102 && same_ugid(tp, next, addr)
4103 && ( next->prop.remove_headers == addr->prop.remove_headers
4104 || ( next->prop.remove_headers
4105 && addr->prop.remove_headers
4106 && Ustrcmp(next->prop.remove_headers, addr->prop.remove_headers) == 0
4110 !tp->expand_multi_domain || (deliver_set_expansions(next), 1),
4112 US"transport", next->transport->name, D_transport,
4113 US"multi_domain", next->transport->multi_domain,
4114 next->transport->expand_multi_domain, &md) == OK
4119 *anchor = next->next;
4121 next->first = addr; /* remember top one (for retry processing) */
4126 else anchor = &(next->next);
4127 deliver_set_expansions(NULL);
4130 /* If we are acting as an MUA wrapper, all addresses must go in a single
4131 transaction. If not, put them back on the chain and yield FALSE. */
4133 if (mua_wrapper && addr_remote)
4135 last->next = addr_remote;
4140 /* If the transport is limited for parallellism, enforce that here.
4141 The hints DB entry is decremented in par_reduce(), when we reap the
4142 transport process. */
4144 if (tpt_parallel_check(tp, addr, &serialize_key))
4145 if ((panicmsg = expand_string_message))
4146 goto panic_continue;
4148 continue; /* Loop for the next set of addresses. */
4150 /* Set up the expansion variables for this set of addresses */
4152 deliver_set_expansions(addr);
4154 /* Ensure any transport-set auth info is fresh */
4155 addr->authenticator = addr->auth_id = addr->auth_sndr = NULL;
4157 /* Compute the return path, expanding a new one if required. The old one
4158 must be set first, as it might be referred to in the expansion. */
4160 if(addr->prop.errors_address)
4161 return_path = addr->prop.errors_address;
4162 #ifdef EXPERIMENTAL_SRS
4163 else if(addr->prop.srs_sender)
4164 return_path = addr->prop.srs_sender;
4167 return_path = sender_address;
4169 if (tp->return_path)
4171 uschar *new_return_path = expand_string(tp->return_path);
4172 if (new_return_path)
4173 return_path = new_return_path;
4174 else if (!expand_string_forcedfail)
4176 panicmsg = string_sprintf("Failed to expand return path \"%s\": %s",
4177 tp->return_path, expand_string_message);
4182 /* Find the uid, gid, and use_initgroups setting for this transport. Failure
4183 logs and sets up error messages, so we just post-process and continue with
4184 the next address. */
4186 if (!findugid(addr, tp, &uid, &gid, &use_initgroups))
4192 /* If this transport has a setup function, call it now so that it gets
4193 run in this process and not in any subprocess. That way, the results of
4194 any setup that are retained by the transport can be reusable. One of the
4195 things the setup does is to set the fallback host lists in the addresses.
4196 That is why it is called at this point, before the continue delivery
4197 processing, because that might use the fallback hosts. */
4200 (void)((tp->setup)(addr->transport, addr, NULL, uid, gid, NULL));
4202 /* If this is a run to continue delivery down an already-established
4203 channel, check that this set of addresses matches the transport and
4204 the channel. If it does not, defer the addresses. If a host list exists,
4205 we must check that the continue host is on the list. Otherwise, the
4206 host is set in the transport. */
4208 continue_more = FALSE; /* In case got set for the last lot */
4209 if (continue_transport)
4211 BOOL ok = Ustrcmp(continue_transport, tp->name) == 0;
4212 if (ok && addr->host_list)
4216 for (h = addr->host_list; h; h = h->next)
4217 if (Ustrcmp(h->name, continue_hostname) == 0)
4218 { ok = TRUE; break; }
4221 /* Addresses not suitable; defer or queue for fallback hosts (which
4222 might be the continue host) and skip to next address. */
4226 DEBUG(D_deliver) debug_printf("not suitable for continue_transport\n");
4227 if (serialize_key) enq_end(serialize_key);
4229 if (addr->fallback_hosts && !fallback)
4231 for (next = addr; ; next = next->next)
4233 next->host_list = next->fallback_hosts;
4234 DEBUG(D_deliver) debug_printf("%s queued for fallback host(s)\n", next->address);
4235 if (!next->next) break;
4237 next->next = addr_fallback;
4238 addr_fallback = addr;
4243 while (next->next) next = next->next;
4244 next->next = addr_defer;
4251 /* Set a flag indicating whether there are further addresses that list
4252 the continued host. This tells the transport to leave the channel open,
4253 but not to pass it to another delivery process. */
4255 for (next = addr_remote; next; next = next->next)
4258 for (h = next->host_list; h; h = h->next)
4259 if (Ustrcmp(h->name, continue_hostname) == 0)
4260 { continue_more = TRUE; break; }
4264 /* The transports set up the process info themselves as they may connect
4265 to more than one remote machine. They also have to set up the filter
4266 arguments, if required, so that the host name and address are available
4269 transport_filter_argv = NULL;
4271 /* Create the pipe for inter-process communication. If pipe creation
4272 fails, it is probably because the value of remote_max_parallel is so
4273 large that too many file descriptors for pipes have been created. Arrange
4274 to wait for a process to finish, and then try again. If we still can't
4275 create a pipe when all processes have finished, break the retry loop. */
4279 if (pipe(pfd) == 0) pipe_done = TRUE;
4280 else if (parcount > 0) parmax = parcount;
4283 /* We need to make the reading end of the pipe non-blocking. There are
4284 two different options for this. Exim is cunningly (I hope!) coded so
4285 that it can use either of them, though it prefers O_NONBLOCK, which
4286 distinguishes between EOF and no-more-data. */
4289 (void)fcntl(pfd[pipe_read], F_SETFL, O_NONBLOCK);
4291 (void)fcntl(pfd[pipe_read], F_SETFL, O_NDELAY);
4294 /* If the maximum number of subprocesses already exist, wait for a process
4295 to finish. If we ran out of file descriptors, parmax will have been reduced
4296 from its initial value of remote_max_parallel. */
4298 par_reduce(parmax - 1, fallback);
4301 /* If we failed to create a pipe and there were no processes to wait
4302 for, we have to give up on this one. Do this outside the above loop
4303 so that we can continue the main loop. */
4307 panicmsg = string_sprintf("unable to create pipe: %s", strerror(errno));
4311 /* Find a free slot in the pardata list. Must do this after the possible
4312 waiting for processes to finish, because a terminating process will free
4315 for (poffset = 0; poffset < remote_max_parallel; poffset++)
4316 if (parlist[poffset].pid == 0)
4319 /* If there isn't one, there has been a horrible disaster. */
4321 if (poffset >= remote_max_parallel)
4323 (void)close(pfd[pipe_write]);
4324 (void)close(pfd[pipe_read]);
4325 panicmsg = US"Unexpectedly no free subprocess slot";
4329 /* Now fork a subprocess to do the remote delivery, but before doing so,
4330 ensure that any cached resourses are released so as not to interfere with
4331 what happens in the subprocess. */
4335 if ((pid = fork()) == 0)
4337 int fd = pfd[pipe_write];
4340 /* Setting this global in the subprocess means we need never clear it */
4341 transport_name = tp->name;
4343 /* There are weird circumstances in which logging is disabled */
4344 disable_logging = tp->disable_logging;
4346 /* Show pids on debug output if parallelism possible */
4348 if (parmax > 1 && (parcount > 0 || addr_remote))
4350 DEBUG(D_any|D_v) debug_selector |= D_pid;
4351 DEBUG(D_deliver) debug_printf("Remote delivery process started\n");
4354 /* Reset the random number generator, so different processes don't all
4355 have the same sequence. In the test harness we want different, but
4356 predictable settings for each delivery process, so do something explicit
4357 here rather they rely on the fixed reset in the random number function. */
4359 random_seed = running_in_test_harness? 42 + 2*delivery_count : 0;
4361 /* Set close-on-exec on the pipe so that it doesn't get passed on to
4362 a new process that may be forked to do another delivery down the same
4365 (void)fcntl(fd, F_SETFD, fcntl(fd, F_GETFD) | FD_CLOEXEC);
4367 /* Close open file descriptors for the pipes of other processes
4368 that are running in parallel. */
4370 for (poffset = 0; poffset < remote_max_parallel; poffset++)
4371 if (parlist[poffset].pid != 0) (void)close(parlist[poffset].fd);
4373 /* This process has inherited a copy of the file descriptor
4374 for the data file, but its file pointer is shared with all the
4375 other processes running in parallel. Therefore, we have to re-open
4376 the file in order to get a new file descriptor with its own
4377 file pointer. We don't need to lock it, as the lock is held by
4378 the parent process. There doesn't seem to be any way of doing
4379 a dup-with-new-file-pointer. */
4381 (void)close(deliver_datafile);
4383 uschar * fname = spool_fname(US"input", message_subdir, message_id, US"-D");
4385 if ((deliver_datafile = Uopen(fname, O_RDWR | O_APPEND, 0)) < 0)
4386 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Failed to reopen %s for remote "
4387 "parallel delivery: %s", fname, strerror(errno));
4390 /* Set the close-on-exec flag */
4392 (void)fcntl(deliver_datafile, F_SETFD, fcntl(deliver_datafile, F_GETFD) |
4395 /* Set the uid/gid of this process; bombs out on failure. */
4397 exim_setugid(uid, gid, use_initgroups,
4398 string_sprintf("remote delivery to %s with transport=%s",
4399 addr->address, tp->name));
4401 /* Close the unwanted half of this process' pipe, set the process state,
4402 and run the transport. Afterwards, transport_count will contain the number
4403 of bytes written. */
4405 (void)close(pfd[pipe_read]);
4406 set_process_info("delivering %s using %s", message_id, tp->name);
4407 debug_print_string(tp->debug_string);
4408 if (!(tp->info->code)(addr->transport, addr)) replicate_status(addr);
4410 set_process_info("delivering %s (just run %s for %s%s in subprocess)",
4411 message_id, tp->name, addr->address, addr->next ? ", ..." : "");
4413 /* Ensure any cached resources that we used are now released */
4417 /* Pass the result back down the pipe. This is a lot more information
4418 than is needed for a local delivery. We have to send back the error
4419 status for each address, the usability status for each host that is
4420 flagged as unusable, and all the retry items. When TLS is in use, we
4421 send also the cipher and peerdn information. Each type of information
4422 is flagged by an identifying byte, and is then in a fixed format (with
4423 strings terminated by zeros), and there is a final terminator at the
4424 end. The host information and retry information is all attached to
4425 the first address, so that gets sent at the start. */
4427 /* Host unusability information: for most success cases this will
4430 for (h = addr->host_list; h; h = h->next)
4432 if (!h->address || h->status < hstatus_unusable) continue;
4433 sprintf(CS big_buffer, "%c%c%s", h->status, h->why, h->address);
4434 rmt_dlv_checked_write(fd, 'H', '0', big_buffer, Ustrlen(big_buffer+2) + 3);
4437 /* The number of bytes written. This is the same for each address. Even
4438 if we sent several copies of the message down the same connection, the
4439 size of each one is the same, and it's that value we have got because
4440 transport_count gets reset before calling transport_write_message(). */
4442 memcpy(big_buffer, &transport_count, sizeof(transport_count));
4443 rmt_dlv_checked_write(fd, 'S', '0', big_buffer, sizeof(transport_count));
4445 /* Information about what happened to each address. Four item types are
4446 used: an optional 'X' item first, for TLS information, then an optional "C"
4447 item for any client-auth info followed by 'R' items for any retry settings,
4448 and finally an 'A' item for the remaining data. */
4450 for(; addr; addr = addr->next)
4455 /* The certificate verification status goes into the flags */
4456 if (tls_out.certificate_verified) setflag(addr, af_cert_verified);
4457 #ifdef EXPERIMENTAL_DANE
4458 if (tls_out.dane_verified) setflag(addr, af_dane_verified);
4461 /* Use an X item only if there's something to send */
4465 ptr = big_buffer + sprintf(CS big_buffer, "%.128s", addr->cipher) + 1;
4470 ptr += sprintf(CS ptr, "%.512s", addr->peerdn);
4474 rmt_dlv_checked_write(fd, 'X', '1', big_buffer, ptr - big_buffer);
4479 if (!tls_export_cert(ptr, big_buffer_size-2, addr->peercert))
4483 rmt_dlv_checked_write(fd, 'X', '2', big_buffer, ptr - big_buffer);
4488 if (!tls_export_cert(ptr, big_buffer_size-2, addr->ourcert))
4492 rmt_dlv_checked_write(fd, 'X', '3', big_buffer, ptr - big_buffer);
4494 # ifndef DISABLE_OCSP
4495 if (addr->ocsp > OCSP_NOT_REQ)
4497 ptr = big_buffer + sprintf(CS big_buffer, "%c", addr->ocsp + '0') + 1;
4498 rmt_dlv_checked_write(fd, 'X', '4', big_buffer, ptr - big_buffer);
4501 #endif /*SUPPORT_TLS*/
4503 if (client_authenticator)
4505 ptr = big_buffer + sprintf(CS big_buffer, "%.64s", client_authenticator) + 1;
4506 rmt_dlv_checked_write(fd, 'C', '1', big_buffer, ptr - big_buffer);
4508 if (client_authenticated_id)
4510 ptr = big_buffer + sprintf(CS big_buffer, "%.64s", client_authenticated_id) + 1;
4511 rmt_dlv_checked_write(fd, 'C', '2', big_buffer, ptr - big_buffer);
4513 if (client_authenticated_sender)
4515 ptr = big_buffer + sprintf(CS big_buffer, "%.64s", client_authenticated_sender) + 1;
4516 rmt_dlv_checked_write(fd, 'C', '3', big_buffer, ptr - big_buffer);
4519 #ifndef DISABLE_PRDR
4520 if (addr->flags & af_prdr_used)
4521 rmt_dlv_checked_write(fd, 'P', '0', NULL, 0);
4524 memcpy(big_buffer, &addr->dsn_aware, sizeof(addr->dsn_aware));
4525 rmt_dlv_checked_write(fd, 'D', '0', big_buffer, sizeof(addr->dsn_aware));
4526 DEBUG(D_deliver) debug_printf("DSN write: addr->dsn_aware = %d\n", addr->dsn_aware);
4528 /* Retry information: for most success cases this will be null. */
4530 for (r = addr->retries; r; r = r->next)
4532 sprintf(CS big_buffer, "%c%.500s", r->flags, r->key);
4533 ptr = big_buffer + Ustrlen(big_buffer+2) + 3;
4534 memcpy(ptr, &(r->basic_errno), sizeof(r->basic_errno));
4535 ptr += sizeof(r->basic_errno);
4536 memcpy(ptr, &(r->more_errno), sizeof(r->more_errno));
4537 ptr += sizeof(r->more_errno);
4538 if (!r->message) *ptr++ = 0; else
4540 sprintf(CS ptr, "%.512s", r->message);
4543 rmt_dlv_checked_write(fd, 'R', '0', big_buffer, ptr - big_buffer);
4546 #ifdef SUPPORT_SOCKS
4547 if (LOGGING(proxy) && proxy_session)
4550 if (proxy_local_address)
4552 DEBUG(D_deliver) debug_printf("proxy_local_address '%s'\n", proxy_local_address);
4553 ptr = big_buffer + sprintf(CS ptr, "%.128s", proxy_local_address) + 1;
4554 DEBUG(D_deliver) debug_printf("proxy_local_port %d\n", proxy_local_port);
4555 memcpy(ptr, &proxy_local_port, sizeof(proxy_local_port));
4556 ptr += sizeof(proxy_local_port);
4560 rmt_dlv_checked_write(fd, 'A', '2', big_buffer, ptr - big_buffer);
4564 #ifdef EXPERIMENTAL_DSN_INFO
4565 /*um, are they really per-addr? Other per-conn stuff is not (auth, tls). But host_used is! */
4566 if (addr->smtp_greeting)
4568 DEBUG(D_deliver) debug_printf("smtp_greeting '%s'\n", addr->smtp_greeting);
4569 ptr = big_buffer + sprintf(CS big_buffer, "%.128s", addr->smtp_greeting) + 1;
4570 if (addr->helo_response)
4572 DEBUG(D_deliver) debug_printf("helo_response '%s'\n", addr->helo_response);
4573 ptr += sprintf(CS ptr, "%.128s", addr->helo_response) + 1;
4577 rmt_dlv_checked_write(fd, 'A', '1', big_buffer, ptr - big_buffer);
4581 /* The rest of the information goes in an 'A0' item. */
4583 sprintf(CS big_buffer, "%c%c", addr->transport_return, addr->special_action);
4584 ptr = big_buffer + 2;
4585 memcpy(ptr, &(addr->basic_errno), sizeof(addr->basic_errno));
4586 ptr += sizeof(addr->basic_errno);
4587 memcpy(ptr, &(addr->more_errno), sizeof(addr->more_errno));
4588 ptr += sizeof(addr->more_errno);
4589 memcpy(ptr, &(addr->flags), sizeof(addr->flags));
4590 ptr += sizeof(addr->flags);
4592 if (!addr->message) *ptr++ = 0; else
4593 ptr += sprintf(CS ptr, "%.1024s", addr->message) + 1;
4595 if (!addr->user_message) *ptr++ = 0; else
4596 ptr += sprintf(CS ptr, "%.1024s", addr->user_message) + 1;
4598 if (!addr->host_used) *ptr++ = 0; else
4600 ptr += sprintf(CS ptr, "%.256s", addr->host_used->name) + 1;
4601 ptr += sprintf(CS ptr, "%.64s", addr->host_used->address) + 1;
4602 memcpy(ptr, &(addr->host_used->port), sizeof(addr->host_used->port));
4603 ptr += sizeof(addr->host_used->port);
4605 /* DNS lookup status */
4606 *ptr++ = addr->host_used->dnssec==DS_YES ? '2'
4607 : addr->host_used->dnssec==DS_NO ? '1' : '0';
4610 rmt_dlv_checked_write(fd, 'A', '0', big_buffer, ptr - big_buffer);
4613 /* Local interface address/port */
4614 #ifdef EXPERIMENTAL_DSN_INFO
4615 if (sending_ip_address)
4617 if (LOGGING(incoming_interface) && sending_ip_address)
4621 ptr = big_buffer + sprintf(CS big_buffer, "%.128s", sending_ip_address) + 1;
4622 ptr += sprintf(CS ptr, "%d", sending_port) + 1;
4623 rmt_dlv_checked_write(fd, 'I', '0', big_buffer, ptr - big_buffer);
4626 /* Add termination flag, close the pipe, and that's it. The character
4627 after 'Z' indicates whether continue_transport is now NULL or not.
4628 A change from non-NULL to NULL indicates a problem with a continuing
4631 big_buffer[0] = continue_transport ? '1' : '0';
4632 rmt_dlv_checked_write(fd, 'Z', '0', big_buffer, 1);
4637 /* Back in the mainline: close the unwanted half of the pipe. */
4639 (void)close(pfd[pipe_write]);
4641 /* Fork failed; defer with error message */
4645 (void)close(pfd[pipe_read]);
4646 panicmsg = string_sprintf("fork failed for remote delivery to %s: %s",
4647 addr->domain, strerror(errno));
4651 /* Fork succeeded; increment the count, and remember relevant data for
4652 when the process finishes. */
4655 parlist[poffset].addrlist = parlist[poffset].addr = addr;
4656 parlist[poffset].pid = pid;
4657 parlist[poffset].fd = pfd[pipe_read];
4658 parlist[poffset].done = FALSE;
4659 parlist[poffset].msg = NULL;
4660 parlist[poffset].return_path = return_path;
4662 /* If the process we've just started is sending a message down an existing
4663 channel, wait for it now. This ensures that only one such process runs at
4664 once, whatever the value of remote_max parallel. Otherwise, we might try to
4665 send two or more messages simultaneously down the same channel. This could
4666 happen if there are different domains that include the same host in otherwise
4667 different host lists.
4669 Also, if the transport closes down the channel, this information gets back
4670 (continue_transport gets set to NULL) before we consider any other addresses
4673 if (continue_transport) par_reduce(0, fallback);
4675 /* Otherwise, if we are running in the test harness, wait a bit, to let the
4676 newly created process get going before we create another process. This should
4677 ensure repeatability in the tests. We only need to wait a tad. */
4679 else if (running_in_test_harness) millisleep(500);
4684 if (serialize_key) enq_end(serialize_key);
4686 remote_post_process(addr, LOG_MAIN|LOG_PANIC, panicmsg, fallback);
4690 /* Reached the end of the list of addresses. Wait for all the subprocesses that
4691 are still running and post-process their addresses. */
4693 par_reduce(0, fallback);
4700 /*************************************************
4701 * Split an address into local part and domain *
4702 *************************************************/
4704 /* This function initializes an address for routing by splitting it up into a
4705 local part and a domain. The local part is set up twice - once in its original
4706 casing, and once in lower case, and it is dequoted. We also do the "percent
4707 hack" for configured domains. This may lead to a DEFER result if a lookup
4708 defers. When a percent-hacking takes place, we insert a copy of the original
4709 address as a new parent of this address, as if we have had a redirection.
4712 addr points to an addr_item block containing the address
4715 DEFER - could not determine if domain is %-hackable
4719 deliver_split_address(address_item *addr)
4721 uschar *address = addr->address;
4722 uschar *domain = Ustrrchr(address, '@');
4724 int len = domain - address;
4726 addr->domain = string_copylc(domain+1); /* Domains are always caseless */
4728 /* The implication in the RFCs (though I can't say I've seen it spelled out
4729 explicitly) is that quoting should be removed from local parts at the point
4730 where they are locally interpreted. [The new draft "821" is more explicit on
4731 this, Jan 1999.] We know the syntax is valid, so this can be done by simply
4732 removing quoting backslashes and any unquoted doublequotes. */
4734 t = addr->cc_local_part = store_get(len+1);
4737 register int c = *address++;
4738 if (c == '\"') continue;
4748 /* We do the percent hack only for those domains that are listed in
4749 percent_hack_domains. A loop is required, to copy with multiple %-hacks. */
4751 if (percent_hack_domains)
4754 uschar *new_address = NULL;
4755 uschar *local_part = addr->cc_local_part;
4757 deliver_domain = addr->domain; /* set $domain */
4759 while ( (rc = match_isinlist(deliver_domain, (const uschar **)&percent_hack_domains, 0,
4760 &domainlist_anchor, addr->domain_cache, MCL_DOMAIN, TRUE, NULL))
4762 && (t = Ustrrchr(local_part, '%')) != NULL
4765 new_address = string_copy(local_part);
4766 new_address[t - local_part] = '@';
4767 deliver_domain = string_copylc(t+1);
4768 local_part = string_copyn(local_part, t - local_part);
4771 if (rc == DEFER) return DEFER; /* lookup deferred */
4773 /* If hackery happened, set up new parent and alter the current address. */
4777 address_item *new_parent = store_get(sizeof(address_item));
4778 *new_parent = *addr;
4779 addr->parent = new_parent;
4780 addr->address = new_address;
4781 addr->unique = string_copy(new_address);
4782 addr->domain = deliver_domain;
4783 addr->cc_local_part = local_part;
4784 DEBUG(D_deliver) debug_printf("%%-hack changed address to: %s\n",
4789 /* Create the lowercased version of the final local part, and make that the
4790 default one to be used. */
4792 addr->local_part = addr->lc_local_part = string_copylc(addr->cc_local_part);
4799 /*************************************************
4800 * Get next error message text *
4801 *************************************************/
4803 /* If f is not NULL, read the next "paragraph", from a customized error message
4804 text file, terminated by a line containing ****, and expand it.
4807 f NULL or a file to read from
4808 which string indicating which string (for errors)
4810 Returns: NULL or an expanded string
4814 next_emf(FILE *f, uschar *which)
4818 uschar *para, *yield;
4821 if (!f) return NULL;
4823 if (!Ufgets(buffer, sizeof(buffer), f) || Ustrcmp(buffer, "****\n") == 0)
4826 para = store_get(size);
4829 para = string_cat(para, &size, &ptr, buffer);
4830 if (!Ufgets(buffer, sizeof(buffer), f) || Ustrcmp(buffer, "****\n") == 0)
4835 if ((yield = expand_string(para)))
4838 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand string from "
4839 "bounce_message_file or warn_message_file (%s): %s", which,
4840 expand_string_message);
4847 /*************************************************
4848 * Close down a passed transport channel *
4849 *************************************************/
4851 /* This function is called when a passed transport channel cannot be used.
4852 It attempts to close it down tidily. The yield is always DELIVER_NOT_ATTEMPTED
4853 so that the function call can be the argument of a "return" statement.
4856 Returns: DELIVER_NOT_ATTEMPTED
4860 continue_closedown(void)
4862 if (continue_transport)
4864 transport_instance *t;
4865 for (t = transports; t; t = t->next)
4866 if (Ustrcmp(t->name, continue_transport) == 0)
4868 if (t->info->closedown) (t->info->closedown)(t);
4872 return DELIVER_NOT_ATTEMPTED;
4878 /*************************************************
4879 * Print address information *
4880 *************************************************/
4882 /* This function is called to output an address, or information about an
4883 address, for bounce or defer messages. If the hide_child flag is set, all we
4884 output is the original ancestor address.
4887 addr points to the address
4888 f the FILE to print to
4889 si an initial string
4890 sc a continuation string for before "generated"
4893 Returns: TRUE if the address is not hidden
4897 print_address_information(address_item *addr, FILE *f, uschar *si, uschar *sc,
4901 uschar *printed = US"";
4902 address_item *ancestor = addr;
4903 while (ancestor->parent) ancestor = ancestor->parent;
4905 fprintf(f, "%s", CS si);
4907 if (addr->parent && testflag(addr, af_hide_child))
4909 printed = US"an undisclosed address";
4912 else if (!testflag(addr, af_pfr) || !addr->parent)
4913 printed = addr->address;
4917 uschar *s = addr->address;
4920 if (addr->address[0] == '>') { ss = US"mail"; s++; }
4921 else if (addr->address[0] == '|') ss = US"pipe";
4924 fprintf(f, "%s to %s%sgenerated by ", ss, s, sc);
4925 printed = addr->parent->address;
4928 fprintf(f, "%s", CS string_printing(printed));
4930 if (ancestor != addr)
4932 uschar *original = ancestor->onetime_parent;
4933 if (!original) original= ancestor->address;
4934 if (strcmpic(original, printed) != 0)
4935 fprintf(f, "%s(%sgenerated from %s)", sc,
4936 ancestor != addr->parent ? "ultimately " : "",
4937 string_printing(original));
4940 if (addr->host_used)
4941 fprintf(f, "\n host %s [%s]",
4942 addr->host_used->name, addr->host_used->address);
4944 fprintf(f, "%s", CS se);
4952 /*************************************************
4953 * Print error for an address *
4954 *************************************************/
4956 /* This function is called to print the error information out of an address for
4957 a bounce or a warning message. It tries to format the message reasonably by
4958 introducing newlines. All lines are indented by 4; the initial printing
4959 position must be set before calling.
4961 This function used always to print the error. Nowadays we want to restrict it
4962 to cases such as LMTP/SMTP errors from a remote host, and errors from :fail:
4963 and filter "fail". We no longer pass other information willy-nilly in bounce
4964 and warning messages. Text in user_message is always output; text in message
4965 only if the af_pass_message flag is set.
4969 f the FILE to print on
4976 print_address_error(address_item *addr, FILE *f, uschar *t)
4978 int count = Ustrlen(t);
4979 uschar *s = testflag(addr, af_pass_message)? addr->message : NULL;
4981 if (!s && !(s = addr->user_message))
4984 fprintf(f, "\n %s", t);
4987 if (*s == '\\' && s[1] == 'n')
4997 if (*s++ == ':' && isspace(*s) && count > 45)
4999 fprintf(f, "\n "); /* sic (because space follows) */
5006 /***********************************************************
5007 * Print Diagnostic-Code for an address *
5008 ************************************************************/
5010 /* This function is called to print the error information out of an address for
5011 a bounce or a warning message. It tries to format the message reasonably as
5012 required by RFC 3461 by adding a space after each newline
5014 it uses the same logic as print_address_error() above. if af_pass_message is true
5015 and addr->message is set it uses the remote host answer. if not addr->user_message
5016 is used instead if available.
5020 f the FILE to print on
5026 print_dsn_diagnostic_code(const address_item *addr, FILE *f)
5028 uschar *s = testflag(addr, af_pass_message) ? addr->message : NULL;
5030 /* af_pass_message and addr->message set ? print remote host answer */
5034 debug_printf("DSN Diagnostic-Code: addr->message = %s\n", addr->message);
5036 /* search first ": ". we assume to find the remote-MTA answer there */
5037 if (!(s = Ustrstr(addr->message, ": ")))
5038 return; /* not found, bail out */
5039 s += 2; /* skip ": " */
5040 fprintf(f, "Diagnostic-Code: smtp; ");
5042 /* no message available. do nothing */
5046 if (*s == '\\' && s[1] == 'n')
5048 fputs("\n ", f); /* as defined in RFC 3461 */
5058 /*************************************************
5059 * Check list of addresses for duplication *
5060 *************************************************/
5062 /* This function was introduced when the test for duplicate addresses that are
5063 not pipes, files, or autoreplies was moved from the middle of routing to when
5064 routing was complete. That was to fix obscure cases when the routing history
5065 affects the subsequent routing of identical addresses. This function is called
5066 after routing, to check that the final routed addresses are not duplicates.
5068 If we detect a duplicate, we remember what it is a duplicate of. Note that
5069 pipe, file, and autoreply de-duplication is handled during routing, so we must
5070 leave such "addresses" alone here, as otherwise they will incorrectly be
5073 Argument: address of list anchor
5078 do_duplicate_check(address_item **anchor)
5081 while ((addr = *anchor))
5084 if (testflag(addr, af_pfr))
5086 anchor = &(addr->next);
5088 else if ((tnode = tree_search(tree_duplicates, addr->unique)))
5090 DEBUG(D_deliver|D_route)
5091 debug_printf("%s is a duplicate address: discarded\n", addr->unique);
5092 *anchor = addr->next;
5093 addr->dupof = tnode->data.ptr;
5094 addr->next = addr_duplicate;
5095 addr_duplicate = addr;
5099 tree_add_duplicate(addr->unique, addr);
5100 anchor = &(addr->next);
5108 /*************************************************
5109 * Deliver one message *
5110 *************************************************/
5112 /* This is the function which is called when a message is to be delivered. It
5113 is passed the id of the message. It is possible that the message no longer
5114 exists, if some other process has delivered it, and it is also possible that
5115 the message is being worked on by another process, in which case the data file
5118 If no delivery is attempted for any of the above reasons, the function returns
5119 DELIVER_NOT_ATTEMPTED.
5121 If the give_up flag is set true, do not attempt any deliveries, but instead
5122 fail all outstanding addresses and return the message to the sender (or
5125 A delivery operation has a process all to itself; we never deliver more than
5126 one message in the same process. Therefore we needn't worry too much about
5130 id the id of the message to be delivered
5131 forced TRUE if delivery was forced by an administrator; this overrides
5132 retry delays and causes a delivery to be tried regardless
5133 give_up TRUE if an administrator has requested that delivery attempts
5136 Returns: When the global variable mua_wrapper is FALSE:
5137 DELIVER_ATTEMPTED_NORMAL if a delivery attempt was made
5138 DELIVER_NOT_ATTEMPTED otherwise (see comment above)
5139 When the global variable mua_wrapper is TRUE:
5140 DELIVER_MUA_SUCCEEDED if delivery succeeded
5141 DELIVER_MUA_FAILED if delivery failed
5142 DELIVER_NOT_ATTEMPTED if not attempted (should not occur)
5146 deliver_message(uschar *id, BOOL forced, BOOL give_up)
5149 int final_yield = DELIVER_ATTEMPTED_NORMAL;
5150 time_t now = time(NULL);
5151 address_item *addr_last = NULL;
5152 uschar *filter_message = NULL;
5154 int process_recipients = RECIP_ACCEPT;
5157 extern int acl_where;
5159 uschar *info = queue_run_pid == (pid_t)0
5160 ? string_sprintf("delivering %s", id)
5161 : string_sprintf("delivering %s (queue run pid %d)", id, queue_run_pid);
5163 /* If the D_process_info bit is on, set_process_info() will output debugging
5164 information. If not, we want to show this initial information if D_deliver or
5165 D_queue_run is set or in verbose mode. */
5167 set_process_info("%s", info);
5169 if ( !(debug_selector & D_process_info)
5170 && (debug_selector & (D_deliver|D_queue_run|D_v))
5172 debug_printf("%s\n", info);
5174 /* Ensure that we catch any subprocesses that are created. Although Exim
5175 sets SIG_DFL as its initial default, some routes through the code end up
5176 here with it set to SIG_IGN - cases where a non-synchronous delivery process
5177 has been forked, but no re-exec has been done. We use sigaction rather than
5178 plain signal() on those OS where SA_NOCLDWAIT exists, because we want to be
5179 sure it is turned off. (There was a problem on AIX with this.) */
5183 struct sigaction act;
5184 act.sa_handler = SIG_DFL;
5185 sigemptyset(&(act.sa_mask));
5187 sigaction(SIGCHLD, &act, NULL);
5190 signal(SIGCHLD, SIG_DFL);
5193 /* Make the forcing flag available for routers and transports, set up the
5194 global message id field, and initialize the count for returned files and the
5195 message size. This use of strcpy() is OK because the length id is checked when
5196 it is obtained from a command line (the -M or -q options), and otherwise it is
5197 known to be a valid message id. */
5199 Ustrcpy(message_id, id);
5200 deliver_force = forced;
5204 /* Initialize some flags */
5206 update_spool = FALSE;
5207 remove_journal = TRUE;
5209 /* Set a known context for any ACLs we call via expansions */
5210 acl_where = ACL_WHERE_DELIVERY;
5212 /* Reset the random number generator, so that if several delivery processes are
5213 started from a queue runner that has already used random numbers (for sorting),
5214 they don't all get the same sequence. */
5218 /* Open and lock the message's data file. Exim locks on this one because the
5219 header file may get replaced as it is re-written during the delivery process.
5220 Any failures cause messages to be written to the log, except for missing files
5221 while queue running - another process probably completed delivery. As part of
5222 opening the data file, message_subdir gets set. */
5224 if ((deliver_datafile = spool_open_datafile(id)) < 0)
5225 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5227 /* The value of message_size at this point has been set to the data length,
5228 plus one for the blank line that notionally precedes the data. */
5230 /* Now read the contents of the header file, which will set up the headers in
5231 store, and also the list of recipients and the tree of non-recipients and
5232 assorted flags. It updates message_size. If there is a reading or format error,
5233 give up; if the message has been around for sufficiently long, remove it. */
5236 uschar * spoolname = string_sprintf("%s-H", id);
5237 if ((rc = spool_read_header(spoolname, TRUE, TRUE)) != spool_read_OK)
5239 if (errno == ERRNO_SPOOLFORMAT)
5241 struct stat statbuf;
5242 if (Ustat(spool_fname(US"input", message_subdir, spoolname, US""),
5244 log_write(0, LOG_MAIN, "Format error in spool file %s: "
5245 "size=" OFF_T_FMT, spoolname, statbuf.st_size);
5247 log_write(0, LOG_MAIN, "Format error in spool file %s", spoolname);
5250 log_write(0, LOG_MAIN, "Error reading spool file %s: %s", spoolname,
5253 /* If we managed to read the envelope data, received_time contains the
5254 time the message was received. Otherwise, we can calculate it from the
5257 if (rc != spool_read_hdrerror)
5260 for (i = 0; i < 6; i++)
5261 received_time = received_time * BASE_62 + tab62[id[i] - '0'];
5264 /* If we've had this malformed message too long, sling it. */
5266 if (now - received_time > keep_malformed)
5268 Uunlink(spool_fname(US"msglog", message_subdir, id, US""));
5269 Uunlink(spool_fname(US"input", message_subdir, id, US"-D"));
5270 Uunlink(spool_fname(US"input", message_subdir, id, US"-H"));
5271 Uunlink(spool_fname(US"input", message_subdir, id, US"-J"));
5272 log_write(0, LOG_MAIN, "Message removed because older than %s",
5273 readconf_printtime(keep_malformed));
5276 (void)close(deliver_datafile);
5277 deliver_datafile = -1;
5278 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5282 /* The spool header file has been read. Look to see if there is an existing
5283 journal file for this message. If there is, it means that a previous delivery
5284 attempt crashed (program or host) before it could update the spool header file.
5285 Read the list of delivered addresses from the journal and add them to the
5286 nonrecipients tree. Then update the spool file. We can leave the journal in
5287 existence, as it will get further successful deliveries added to it in this
5288 run, and it will be deleted if this function gets to its end successfully.
5289 Otherwise it might be needed again. */
5292 uschar * fname = spool_fname(US"input", message_subdir, id, US"-J");
5294 if ((jread = Ufopen(fname, "rb")))
5296 while (Ufgets(big_buffer, big_buffer_size, jread))
5298 int n = Ustrlen(big_buffer);
5299 big_buffer[n-1] = 0;
5300 tree_add_nonrecipient(big_buffer);
5301 DEBUG(D_deliver) debug_printf("Previously delivered address %s taken from "
5302 "journal file\n", big_buffer);
5304 (void)fclose(jread);
5305 /* Panic-dies on error */
5306 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
5308 else if (errno != ENOENT)
5310 log_write(0, LOG_MAIN|LOG_PANIC, "attempt to open journal for reading gave: "
5311 "%s", strerror(errno));
5312 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5315 /* A null recipients list indicates some kind of disaster. */
5317 if (!recipients_list)
5319 (void)close(deliver_datafile);
5320 deliver_datafile = -1;
5321 log_write(0, LOG_MAIN, "Spool error: no recipients for %s", fname);
5322 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5327 /* Handle a message that is frozen. There are a number of different things that
5328 can happen, but in the default situation, unless forced, no delivery is
5333 #ifdef SUPPORT_MOVE_FROZEN_MESSAGES
5334 /* Moving to another directory removes the message from Exim's view. Other
5335 tools must be used to deal with it. Logging of this action happens in
5336 spool_move_message() and its subfunctions. */
5338 if ( move_frozen_messages
5339 && spool_move_message(id, message_subdir, US"", US"F")
5341 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5344 /* For all frozen messages (bounces or not), timeout_frozen_after sets the
5345 maximum time to keep messages that are frozen. Thaw if we reach it, with a
5346 flag causing all recipients to be failed. The time is the age of the
5347 message, not the time since freezing. */
5349 if (timeout_frozen_after > 0 && message_age >= timeout_frozen_after)
5351 log_write(0, LOG_MAIN, "cancelled by timeout_frozen_after");
5352 process_recipients = RECIP_FAIL_TIMEOUT;
5355 /* For bounce messages (and others with no sender), thaw if the error message
5356 ignore timer is exceeded. The message will be discarded if this delivery
5359 else if (sender_address[0] == 0 && message_age >= ignore_bounce_errors_after)
5361 log_write(0, LOG_MAIN, "Unfrozen by errmsg timer");
5364 /* If this is a bounce message, or there's no auto thaw, or we haven't
5365 reached the auto thaw time yet, and this delivery is not forced by an admin
5366 user, do not attempt delivery of this message. Note that forced is set for
5367 continuing messages down the same channel, in order to skip load checking and
5368 ignore hold domains, but we don't want unfreezing in that case. */
5372 if ( ( sender_address[0] == 0
5374 || now <= deliver_frozen_at + auto_thaw
5376 && ( !forced || !deliver_force_thaw
5377 || !admin_user || continue_hostname
5380 (void)close(deliver_datafile);
5381 deliver_datafile = -1;
5382 log_write(L_skip_delivery, LOG_MAIN, "Message is frozen");
5383 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5386 /* If delivery was forced (by an admin user), assume a manual thaw.
5387 Otherwise it's an auto thaw. */
5391 deliver_manual_thaw = TRUE;
5392 log_write(0, LOG_MAIN, "Unfrozen by forced delivery");
5394 else log_write(0, LOG_MAIN, "Unfrozen by auto-thaw");
5397 /* We get here if any of the rules for unfreezing have triggered. */
5399 deliver_freeze = FALSE;
5400 update_spool = TRUE;
5404 /* Open the message log file if we are using them. This records details of
5405 deliveries, deferments, and failures for the benefit of the mail administrator.
5406 The log is not used by exim itself to track the progress of a message; that is
5407 done by rewriting the header spool file. */
5411 uschar * fname = spool_fname(US"msglog", message_subdir, id, US"");
5415 if ((fd = open_msglog_file(fname, SPOOL_MODE, &error)) < 0)
5417 log_write(0, LOG_MAIN|LOG_PANIC, "Couldn't %s message log %s: %s", error,
5418 fname, strerror(errno));
5419 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5422 /* Make a C stream out of it. */
5424 if (!(message_log = fdopen(fd, "a")))
5426 log_write(0, LOG_MAIN|LOG_PANIC, "Couldn't fdopen message log %s: %s",
5427 fname, strerror(errno));
5428 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5433 /* If asked to give up on a message, log who did it, and set the action for all
5438 struct passwd *pw = getpwuid(real_uid);
5439 log_write(0, LOG_MAIN, "cancelled by %s",
5440 pw ? US pw->pw_name : string_sprintf("uid %ld", (long int)real_uid));
5441 process_recipients = RECIP_FAIL;
5444 /* Otherwise, if there are too many Received: headers, fail all recipients. */
5446 else if (received_count > received_headers_max)
5447 process_recipients = RECIP_FAIL_LOOP;
5449 /* Otherwise, if a system-wide, address-independent message filter is
5450 specified, run it now, except in the case when we are failing all recipients as
5451 a result of timeout_frozen_after. If the system filter yields "delivered", then
5452 ignore the true recipients of the message. Failure of the filter file is
5453 logged, and the delivery attempt fails. */
5455 else if (system_filter && process_recipients != RECIP_FAIL_TIMEOUT)
5460 redirect_block redirect;
5462 if (system_filter_uid_set)
5464 ugid.uid = system_filter_uid;
5465 ugid.gid = system_filter_gid;
5466 ugid.uid_set = ugid.gid_set = TRUE;
5470 ugid.uid_set = ugid.gid_set = FALSE;
5473 return_path = sender_address;
5474 enable_dollar_recipients = TRUE; /* Permit $recipients in system filter */
5475 system_filtering = TRUE;
5477 /* Any error in the filter file causes a delivery to be abandoned. */
5479 redirect.string = system_filter;
5480 redirect.isfile = TRUE;
5481 redirect.check_owner = redirect.check_group = FALSE;
5482 redirect.owners = NULL;
5483 redirect.owngroups = NULL;
5485 redirect.modemask = 0;
5487 DEBUG(D_deliver|D_filter) debug_printf("running system filter\n");
5490 &redirect, /* Where the data is */
5491 RDO_DEFER | /* Turn on all the enabling options */
5492 RDO_FAIL | /* Leave off all the disabling options */
5497 NULL, /* No :include: restriction (not used in filter) */
5498 NULL, /* No sieve vacation directory (not sieve!) */
5499 NULL, /* No sieve enotify mailto owner (not sieve!) */
5500 NULL, /* No sieve user address (not sieve!) */
5501 NULL, /* No sieve subaddress (not sieve!) */
5502 &ugid, /* uid/gid data */
5503 &addr_new, /* Where to hang generated addresses */
5504 &filter_message, /* Where to put error message */
5505 NULL, /* Don't skip syntax errors */
5506 &filtertype, /* Will always be set to FILTER_EXIM for this call */
5507 US"system filter"); /* For error messages */
5509 DEBUG(D_deliver|D_filter) debug_printf("system filter returned %d\n", rc);
5511 if (rc == FF_ERROR || rc == FF_NONEXIST)
5513 (void)close(deliver_datafile);
5514 deliver_datafile = -1;
5515 log_write(0, LOG_MAIN|LOG_PANIC, "Error in system filter: %s",
5516 string_printing(filter_message));
5517 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5520 /* Reset things. If the filter message is an empty string, which can happen
5521 for a filter "fail" or "freeze" command with no text, reset it to NULL. */
5523 system_filtering = FALSE;
5524 enable_dollar_recipients = FALSE;
5525 if (filter_message && filter_message[0] == 0) filter_message = NULL;
5527 /* Save the values of the system filter variables so that user filters
5530 memcpy(filter_sn, filter_n, sizeof(filter_sn));
5532 /* The filter can request that delivery of the original addresses be
5537 process_recipients = RECIP_DEFER;
5538 deliver_msglog("Delivery deferred by system filter\n");
5539 log_write(0, LOG_MAIN, "Delivery deferred by system filter");
5542 /* The filter can request that a message be frozen, but this does not
5543 take place if the message has been manually thawed. In that case, we must
5544 unset "delivered", which is forced by the "freeze" command to make -bF
5547 else if (rc == FF_FREEZE && !deliver_manual_thaw)
5549 deliver_freeze = TRUE;
5550 deliver_frozen_at = time(NULL);
5551 process_recipients = RECIP_DEFER;
5552 frozen_info = string_sprintf(" by the system filter%s%s",
5553 filter_message ? US": " : US"",
5554 filter_message ? filter_message : US"");
5557 /* The filter can request that a message be failed. The error message may be
5558 quite long - it is sent back to the sender in the bounce - but we don't want
5559 to fill up the log with repetitions of it. If it starts with << then the text
5560 between << and >> is written to the log, with the rest left for the bounce
5563 else if (rc == FF_FAIL)
5565 uschar *colon = US"";
5566 uschar *logmsg = US"";
5569 process_recipients = RECIP_FAIL_FILTER;
5575 if ( filter_message[0] == '<'
5576 && filter_message[1] == '<'
5577 && (logend = Ustrstr(filter_message, ">>"))
5580 logmsg = filter_message + 2;
5581 loglen = logend - logmsg;
5582 filter_message = logend + 2;
5583 if (filter_message[0] == 0) filter_message = NULL;
5587 logmsg = filter_message;
5588 loglen = Ustrlen(filter_message);
5592 log_write(0, LOG_MAIN, "cancelled by system filter%s%.*s", colon, loglen,
5596 /* Delivery can be restricted only to those recipients (if any) that the
5597 filter specified. */
5599 else if (rc == FF_DELIVERED)
5601 process_recipients = RECIP_IGNORE;
5603 log_write(0, LOG_MAIN, "original recipients ignored (system filter)");
5605 log_write(0, LOG_MAIN, "=> discarded (system filter)");
5608 /* If any new addresses were created by the filter, fake up a "parent"
5609 for them. This is necessary for pipes, etc., which are expected to have
5610 parents, and it also gives some sensible logging for others. Allow
5611 pipes, files, and autoreplies, and run them as the filter uid if set,
5612 otherwise as the current uid. */
5616 int uid = (system_filter_uid_set)? system_filter_uid : geteuid();
5617 int gid = (system_filter_gid_set)? system_filter_gid : getegid();
5619 /* The text "system-filter" is tested in transport_set_up_command() and in
5620 set_up_shell_command() in the pipe transport, to enable them to permit
5621 $recipients, so don't change it here without also changing it there. */
5623 address_item *p = addr_new;
5624 address_item *parent = deliver_make_addr(US"system-filter", FALSE);
5626 parent->domain = string_copylc(qualify_domain_recipient);
5627 parent->local_part = US"system-filter";
5629 /* As part of this loop, we arrange for addr_last to end up pointing
5630 at the final address. This is used if we go on to add addresses for the
5631 original recipients. */
5635 if (parent->child_count == SHRT_MAX)
5636 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "system filter generated more "
5637 "than %d delivery addresses", SHRT_MAX);
5638 parent->child_count++;
5641 if (testflag(p, af_pfr))
5647 setflag(p, af_uid_set |
5653 /* Find the name of the system filter's appropriate pfr transport */
5655 if (p->address[0] == '|')
5658 tpname = system_filter_pipe_transport;
5659 address_pipe = p->address;
5661 else if (p->address[0] == '>')
5664 tpname = system_filter_reply_transport;
5668 if (p->address[Ustrlen(p->address)-1] == '/')
5670 type = US"directory";
5671 tpname = system_filter_directory_transport;
5676 tpname = system_filter_file_transport;
5678 address_file = p->address;
5681 /* Now find the actual transport, first expanding the name. We have
5682 set address_file or address_pipe above. */
5686 uschar *tmp = expand_string(tpname);
5687 address_file = address_pipe = NULL;
5689 p->message = string_sprintf("failed to expand \"%s\" as a "
5690 "system filter transport name", tpname);
5695 p->message = string_sprintf("system_filter_%s_transport is unset",
5701 transport_instance *tp;
5702 for (tp = transports; tp; tp = tp->next)
5704 if (Ustrcmp(tp->name, tpname) == 0)
5711 p->message = string_sprintf("failed to find \"%s\" transport "
5712 "for system filter delivery", tpname);
5715 /* If we couldn't set up a transport, defer the delivery, putting the
5716 error on the panic log as well as the main log. */
5720 address_item *badp = p;
5722 if (!addr_last) addr_new = p; else addr_last->next = p;
5723 badp->local_part = badp->address; /* Needed for log line */
5724 post_process_one(badp, DEFER, LOG_MAIN|LOG_PANIC, DTYPE_ROUTER, 0);
5727 } /* End of pfr handling */
5729 /* Either a non-pfr delivery, or we found a transport */
5731 DEBUG(D_deliver|D_filter)
5732 debug_printf("system filter added %s\n", p->address);
5736 } /* Loop through all addr_new addresses */
5741 /* Scan the recipients list, and for every one that is not in the non-
5742 recipients tree, add an addr item to the chain of new addresses. If the pno
5743 value is non-negative, we must set the onetime parent from it. This which
5744 points to the relevant entry in the recipients list.
5746 This processing can be altered by the setting of the process_recipients
5747 variable, which is changed if recipients are to be ignored, failed, or
5748 deferred. This can happen as a result of system filter activity, or if the -Mg
5749 option is used to fail all of them.
5751 Duplicate addresses are handled later by a different tree structure; we can't
5752 just extend the non-recipients tree, because that will be re-written to the
5753 spool if the message is deferred, and in any case there are casing
5754 complications for local addresses. */
5756 if (process_recipients != RECIP_IGNORE)
5758 for (i = 0; i < recipients_count; i++)
5760 if (!tree_search(tree_nonrecipients, recipients_list[i].address))
5762 recipient_item *r = recipients_list + i;
5763 address_item *new = deliver_make_addr(r->address, FALSE);
5764 new->prop.errors_address = r->errors_to;
5766 if ((new->prop.utf8_msg = message_smtputf8))
5768 new->prop.utf8_downcvt = message_utf8_downconvert == 1;
5769 new->prop.utf8_downcvt_maybe = message_utf8_downconvert == -1;
5770 DEBUG(D_deliver) debug_printf("utf8, downconvert %s\n",
5771 new->prop.utf8_downcvt ? "yes"
5772 : new->prop.utf8_downcvt_maybe ? "ifneeded"
5778 new->onetime_parent = recipients_list[r->pno].address;
5780 /* If DSN support is enabled, set the dsn flags and the original receipt
5781 to be passed on to other DSN enabled MTAs */
5782 new->dsn_flags = r->dsn_flags & rf_dsnflags;
5783 new->dsn_orcpt = r->orcpt;
5784 DEBUG(D_deliver) debug_printf("DSN: set orcpt: %s flags: %d\n",
5785 new->dsn_orcpt, new->dsn_flags);
5787 switch (process_recipients)
5789 /* RECIP_DEFER is set when a system filter freezes a message. */
5792 new->next = addr_defer;
5797 /* RECIP_FAIL_FILTER is set when a system filter has obeyed a "fail"
5800 case RECIP_FAIL_FILTER:
5802 filter_message ? filter_message : US"delivery cancelled";
5803 setflag(new, af_pass_message);
5804 goto RECIP_QUEUE_FAILED; /* below */
5807 /* RECIP_FAIL_TIMEOUT is set when a message is frozen, but is older
5808 than the value in timeout_frozen_after. Treat non-bounce messages
5809 similarly to -Mg; for bounce messages we just want to discard, so
5810 don't put the address on the failed list. The timeout has already
5813 case RECIP_FAIL_TIMEOUT:
5814 new->message = US"delivery cancelled; message timed out";
5815 goto RECIP_QUEUE_FAILED; /* below */
5818 /* RECIP_FAIL is set when -Mg has been used. */
5821 new->message = US"delivery cancelled by administrator";
5824 /* Common code for the failure cases above. If this is not a bounce
5825 message, put the address on the failed list so that it is used to
5826 create a bounce. Otherwise do nothing - this just discards the address.
5827 The incident has already been logged. */
5830 if (sender_address[0] != 0)
5832 new->next = addr_failed;
5838 /* RECIP_FAIL_LOOP is set when there are too many Received: headers
5839 in the message. Process each address as a routing failure; if this
5840 is a bounce message, it will get frozen. */
5842 case RECIP_FAIL_LOOP:
5843 new->message = US"Too many \"Received\" headers - suspected mail loop";
5844 post_process_one(new, FAIL, LOG_MAIN, DTYPE_ROUTER, 0);
5848 /* Value should be RECIP_ACCEPT; take this as the safe default. */
5851 if (!addr_new) addr_new = new; else addr_last->next = new;
5856 #ifndef DISABLE_EVENT
5857 if (process_recipients != RECIP_ACCEPT)
5859 uschar * save_local = deliver_localpart;
5860 const uschar * save_domain = deliver_domain;
5862 deliver_localpart = expand_string(
5863 string_sprintf("${local_part:%s}", new->address));
5864 deliver_domain = expand_string(
5865 string_sprintf("${domain:%s}", new->address));
5867 (void) event_raise(event_action,
5868 US"msg:fail:internal", new->message);
5870 deliver_localpart = save_local;
5871 deliver_domain = save_domain;
5881 debug_printf("Delivery address list:\n");
5882 for (p = addr_new; p; p = p->next)
5883 debug_printf(" %s %s\n", p->address,
5884 p->onetime_parent ? p->onetime_parent : US"");
5887 /* Set up the buffers used for copying over the file when delivering. */
5889 deliver_in_buffer = store_malloc(DELIVER_IN_BUFFER_SIZE);
5890 deliver_out_buffer = store_malloc(DELIVER_OUT_BUFFER_SIZE);
5894 /* Until there are no more new addresses, handle each one as follows:
5896 . If this is a generated address (indicated by the presence of a parent
5897 pointer) then check to see whether it is a pipe, file, or autoreply, and
5898 if so, handle it directly here. The router that produced the address will
5899 have set the allow flags into the address, and also set the uid/gid required.
5900 Having the routers generate new addresses and then checking them here at
5901 the outer level is tidier than making each router do the checking, and
5902 means that routers don't need access to the failed address queue.
5904 . Break up the address into local part and domain, and make lowercased
5905 versions of these strings. We also make unquoted versions of the local part.
5907 . Handle the percent hack for those domains for which it is valid.
5909 . For child addresses, determine if any of the parents have the same address.
5910 If so, generate a different string for previous delivery checking. Without
5911 this code, if the address spqr generates spqr via a forward or alias file,
5912 delivery of the generated spqr stops further attempts at the top level spqr,
5913 which is not what is wanted - it may have generated other addresses.
5915 . Check on the retry database to see if routing was previously deferred, but
5916 only if in a queue run. Addresses that are to be routed are put on the
5917 addr_route chain. Addresses that are to be deferred are put on the
5918 addr_defer chain. We do all the checking first, so as not to keep the
5919 retry database open any longer than necessary.
5921 . Now we run the addresses through the routers. A router may put the address
5922 on either the addr_local or the addr_remote chain for local or remote
5923 delivery, respectively, or put it on the addr_failed chain if it is
5924 undeliveable, or it may generate child addresses and put them on the
5925 addr_new chain, or it may defer an address. All the chain anchors are
5926 passed as arguments so that the routers can be called for verification
5929 . If new addresses have been generated by the routers, da capo.
5932 header_rewritten = FALSE; /* No headers rewritten yet */
5933 while (addr_new) /* Loop until all addresses dealt with */
5935 address_item *addr, *parent;
5937 /* Failure to open the retry database is treated the same as if it does
5938 not exist. In both cases, dbm_file is NULL. */
5940 if (!(dbm_file = dbfn_open(US"retry", O_RDONLY, &dbblock, FALSE)))
5942 DEBUG(D_deliver|D_retry|D_route|D_hints_lookup)
5943 debug_printf("no retry data available\n");
5946 /* Scan the current batch of new addresses, to handle pipes, files and
5947 autoreplies, and determine which others are ready for routing. */
5954 dbdata_retry *domain_retry_record;
5955 dbdata_retry *address_retry_record;
5958 addr_new = addr->next;
5960 DEBUG(D_deliver|D_retry|D_route)
5962 debug_printf(">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>\n");
5963 debug_printf("Considering: %s\n", addr->address);
5966 /* Handle generated address that is a pipe or a file or an autoreply. */
5968 if (testflag(addr, af_pfr))
5970 /* If an autoreply in a filter could not generate a syntactically valid
5971 address, give up forthwith. Set af_ignore_error so that we don't try to
5972 generate a bounce. */
5974 if (testflag(addr, af_bad_reply))
5976 addr->basic_errno = ERRNO_BADADDRESS2;
5977 addr->local_part = addr->address;
5979 US"filter autoreply generated syntactically invalid recipient";
5980 setflag(addr, af_ignore_error);
5981 (void)post_process_one(addr, FAIL, LOG_MAIN, DTYPE_ROUTER, 0);
5982 continue; /* with the next new address */
5985 /* If two different users specify delivery to the same pipe or file or
5986 autoreply, there should be two different deliveries, so build a unique
5987 string that incorporates the original address, and use this for
5988 duplicate testing and recording delivery, and also for retrying. */
5991 string_sprintf("%s:%s", addr->address, addr->parent->unique +
5992 (testflag(addr->parent, af_homonym)? 3:0));
5994 addr->address_retry_key = addr->domain_retry_key =
5995 string_sprintf("T:%s", addr->unique);
5997 /* If a filter file specifies two deliveries to the same pipe or file,
5998 we want to de-duplicate, but this is probably not wanted for two mail
5999 commands to the same address, where probably both should be delivered.
6000 So, we have to invent a different unique string in that case. Just
6001 keep piling '>' characters on the front. */
6003 if (addr->address[0] == '>')
6005 while (tree_search(tree_duplicates, addr->unique))
6006 addr->unique = string_sprintf(">%s", addr->unique);
6009 else if ((tnode = tree_search(tree_duplicates, addr->unique)))
6011 DEBUG(D_deliver|D_route)
6012 debug_printf("%s is a duplicate address: discarded\n", addr->address);
6013 addr->dupof = tnode->data.ptr;
6014 addr->next = addr_duplicate;
6015 addr_duplicate = addr;
6019 DEBUG(D_deliver|D_route) debug_printf("unique = %s\n", addr->unique);
6021 /* Check for previous delivery */
6023 if (tree_search(tree_nonrecipients, addr->unique))
6025 DEBUG(D_deliver|D_route)
6026 debug_printf("%s was previously delivered: discarded\n", addr->address);
6027 child_done(addr, tod_stamp(tod_log));
6031 /* Save for checking future duplicates */
6033 tree_add_duplicate(addr->unique, addr);
6035 /* Set local part and domain */
6037 addr->local_part = addr->address;
6038 addr->domain = addr->parent->domain;
6040 /* Ensure that the delivery is permitted. */
6042 if (testflag(addr, af_file))
6044 if (!testflag(addr, af_allow_file))
6046 addr->basic_errno = ERRNO_FORBIDFILE;
6047 addr->message = US"delivery to file forbidden";
6048 (void)post_process_one(addr, FAIL, LOG_MAIN, DTYPE_ROUTER, 0);
6049 continue; /* with the next new address */
6052 else if (addr->address[0] == '|')
6054 if (!testflag(addr, af_allow_pipe))
6056 addr->basic_errno = ERRNO_FORBIDPIPE;
6057 addr->message = US"delivery to pipe forbidden";
6058 (void)post_process_one(addr, FAIL, LOG_MAIN, DTYPE_ROUTER, 0);
6059 continue; /* with the next new address */
6062 else if (!testflag(addr, af_allow_reply))
6064 addr->basic_errno = ERRNO_FORBIDREPLY;
6065 addr->message = US"autoreply forbidden";
6066 (void)post_process_one(addr, FAIL, LOG_MAIN, DTYPE_ROUTER, 0);
6067 continue; /* with the next new address */
6070 /* If the errno field is already set to BADTRANSPORT, it indicates
6071 failure to expand a transport string, or find the associated transport,
6072 or an unset transport when one is required. Leave this test till now so
6073 that the forbid errors are given in preference. */
6075 if (addr->basic_errno == ERRNO_BADTRANSPORT)
6077 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_ROUTER, 0);
6081 /* Treat /dev/null as a special case and abandon the delivery. This
6082 avoids having to specify a uid on the transport just for this case.
6083 Arrange for the transport name to be logged as "**bypassed**". */
6085 if (Ustrcmp(addr->address, "/dev/null") == 0)
6087 uschar *save = addr->transport->name;
6088 addr->transport->name = US"**bypassed**";
6089 (void)post_process_one(addr, OK, LOG_MAIN, DTYPE_TRANSPORT, '=');
6090 addr->transport->name = save;
6091 continue; /* with the next new address */
6094 /* Pipe, file, or autoreply delivery is to go ahead as a normal local
6097 DEBUG(D_deliver|D_route)
6098 debug_printf("queued for %s transport\n", addr->transport->name);
6099 addr->next = addr_local;
6101 continue; /* with the next new address */
6104 /* Handle normal addresses. First, split up into local part and domain,
6105 handling the %-hack if necessary. There is the possibility of a defer from
6106 a lookup in percent_hack_domains. */
6108 if ((rc = deliver_split_address(addr)) == DEFER)
6110 addr->message = US"cannot check percent_hack_domains";
6111 addr->basic_errno = ERRNO_LISTDEFER;
6112 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_NONE, 0);
6116 /* Check to see if the domain is held. If so, proceed only if the
6117 delivery was forced by hand. */
6119 deliver_domain = addr->domain; /* set $domain */
6120 if ( !forced && hold_domains
6121 && (rc = match_isinlist(addr->domain, (const uschar **)&hold_domains, 0,
6122 &domainlist_anchor, addr->domain_cache, MCL_DOMAIN, TRUE,
6128 addr->message = US"hold_domains lookup deferred";
6129 addr->basic_errno = ERRNO_LISTDEFER;
6133 addr->message = US"domain is held";
6134 addr->basic_errno = ERRNO_HELD;
6136 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_NONE, 0);
6140 /* Now we can check for duplicates and previously delivered addresses. In
6141 order to do this, we have to generate a "unique" value for each address,
6142 because there may be identical actual addresses in a line of descendents.
6143 The "unique" field is initialized to the same value as the "address" field,
6144 but gets changed here to cope with identically-named descendents. */
6146 for (parent = addr->parent; parent; parent = parent->parent)
6147 if (strcmpic(addr->address, parent->address) == 0) break;
6149 /* If there's an ancestor with the same name, set the homonym flag. This
6150 influences how deliveries are recorded. Then add a prefix on the front of
6151 the unique address. We use \n\ where n starts at 0 and increases each time.
6152 It is unlikely to pass 9, but if it does, it may look odd but will still
6153 work. This means that siblings or cousins with the same names are treated
6154 as duplicates, which is what we want. */
6158 setflag(addr, af_homonym);
6159 if (parent->unique[0] != '\\')
6160 addr->unique = string_sprintf("\\0\\%s", addr->address);
6162 addr->unique = string_sprintf("\\%c\\%s", parent->unique[1] + 1,
6166 /* Ensure that the domain in the unique field is lower cased, because
6167 domains are always handled caselessly. */
6169 p = Ustrrchr(addr->unique, '@');
6170 while (*p != 0) { *p = tolower(*p); p++; }
6172 DEBUG(D_deliver|D_route) debug_printf("unique = %s\n", addr->unique);
6174 if (tree_search(tree_nonrecipients, addr->unique))
6176 DEBUG(D_deliver|D_route)
6177 debug_printf("%s was previously delivered: discarded\n", addr->unique);
6178 child_done(addr, tod_stamp(tod_log));
6182 /* Get the routing retry status, saving the two retry keys (with and
6183 without the local part) for subsequent use. If there is no retry record for
6184 the standard address routing retry key, we look for the same key with the
6185 sender attached, because this form is used by the smtp transport after a
6186 4xx response to RCPT when address_retry_include_sender is true. */
6188 addr->domain_retry_key = string_sprintf("R:%s", addr->domain);
6189 addr->address_retry_key = string_sprintf("R:%s@%s", addr->local_part,
6194 domain_retry_record = dbfn_read(dbm_file, addr->domain_retry_key);
6195 if ( domain_retry_record
6196 && now - domain_retry_record->time_stamp > retry_data_expire
6198 domain_retry_record = NULL; /* Ignore if too old */
6200 address_retry_record = dbfn_read(dbm_file, addr->address_retry_key);
6201 if ( address_retry_record
6202 && now - address_retry_record->time_stamp > retry_data_expire
6204 address_retry_record = NULL; /* Ignore if too old */
6206 if (!address_retry_record)
6208 uschar *altkey = string_sprintf("%s:<%s>", addr->address_retry_key,
6210 address_retry_record = dbfn_read(dbm_file, altkey);
6211 if ( address_retry_record
6212 && now - address_retry_record->time_stamp > retry_data_expire)
6213 address_retry_record = NULL; /* Ignore if too old */
6217 domain_retry_record = address_retry_record = NULL;
6219 DEBUG(D_deliver|D_retry)
6221 if (!domain_retry_record)
6222 debug_printf("no domain retry record\n");
6223 if (!address_retry_record)
6224 debug_printf("no address retry record\n");
6227 /* If we are sending a message down an existing SMTP connection, we must
6228 assume that the message which created the connection managed to route
6229 an address to that connection. We do not want to run the risk of taking
6230 a long time over routing here, because if we do, the server at the other
6231 end of the connection may time it out. This is especially true for messages
6232 with lots of addresses. For this kind of delivery, queue_running is not
6233 set, so we would normally route all addresses. We take a pragmatic approach
6234 and defer routing any addresses that have any kind of domain retry record.
6235 That is, we don't even look at their retry times. It doesn't matter if this
6236 doesn't work occasionally. This is all just an optimization, after all.
6238 The reason for not doing the same for address retries is that they normally
6239 arise from 4xx responses, not DNS timeouts. */
6241 if (continue_hostname && domain_retry_record)
6243 addr->message = US"reusing SMTP connection skips previous routing defer";
6244 addr->basic_errno = ERRNO_RRETRY;
6245 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_ROUTER, 0);
6248 /* If we are in a queue run, defer routing unless there is no retry data or
6249 we've passed the next retry time, or this message is forced. In other
6250 words, ignore retry data when not in a queue run.
6252 However, if the domain retry time has expired, always allow the routing
6253 attempt. If it fails again, the address will be failed. This ensures that
6254 each address is routed at least once, even after long-term routing
6257 If there is an address retry, check that too; just wait for the next
6258 retry time. This helps with the case when the temporary error on the
6259 address was really message-specific rather than address specific, since
6260 it allows other messages through.
6262 We also wait for the next retry time if this is a message sent down an
6263 existing SMTP connection (even though that will be forced). Otherwise there
6264 will be far too many attempts for an address that gets a 4xx error. In
6265 fact, after such an error, we should not get here because, the host should
6266 not be remembered as one this message needs. However, there was a bug that
6267 used to cause this to happen, so it is best to be on the safe side.
6269 Even if we haven't reached the retry time in the hints, there is one more
6270 check to do, which is for the ultimate address timeout. We only do this
6271 check if there is an address retry record and there is not a domain retry
6272 record; this implies that previous attempts to handle the address had the
6273 retry_use_local_parts option turned on. We use this as an approximation
6274 for the destination being like a local delivery, for example delivery over
6275 LMTP to an IMAP message store. In this situation users are liable to bump
6276 into their quota and thereby have intermittently successful deliveries,
6277 which keep the retry record fresh, which can lead to us perpetually
6278 deferring messages. */
6280 else if ( ( queue_running && !deliver_force
6281 || continue_hostname
6283 && ( ( domain_retry_record
6284 && now < domain_retry_record->next_try
6285 && !domain_retry_record->expired
6287 || ( address_retry_record
6288 && now < address_retry_record->next_try
6290 && ( domain_retry_record
6291 || !address_retry_record
6292 || !retry_ultimate_address_timeout(addr->address_retry_key,
6293 addr->domain, address_retry_record, now)
6296 addr->message = US"retry time not reached";
6297 addr->basic_errno = ERRNO_RRETRY;
6298 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_ROUTER, 0);
6301 /* The domain is OK for routing. Remember if retry data exists so it
6302 can be cleaned up after a successful delivery. */
6306 if (domain_retry_record || address_retry_record)
6307 setflag(addr, af_dr_retry_exists);
6308 addr->next = addr_route;
6310 DEBUG(D_deliver|D_route)
6311 debug_printf("%s: queued for routing\n", addr->address);
6315 /* The database is closed while routing is actually happening. Requests to
6316 update it are put on a chain and all processed together at the end. */
6318 if (dbm_file) dbfn_close(dbm_file);
6320 /* If queue_domains is set, we don't even want to try routing addresses in
6321 those domains. During queue runs, queue_domains is forced to be unset.
6322 Optimize by skipping this pass through the addresses if nothing is set. */
6324 if (!deliver_force && queue_domains)
6326 address_item *okaddr = NULL;
6329 address_item *addr = addr_route;
6330 addr_route = addr->next;
6332 deliver_domain = addr->domain; /* set $domain */
6333 if ((rc = match_isinlist(addr->domain, (const uschar **)&queue_domains, 0,
6334 &domainlist_anchor, addr->domain_cache, MCL_DOMAIN, TRUE, NULL))
6339 addr->basic_errno = ERRNO_LISTDEFER;
6340 addr->message = US"queue_domains lookup deferred";
6341 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_ROUTER, 0);
6345 addr->next = okaddr;
6351 addr->basic_errno = ERRNO_QUEUE_DOMAIN;
6352 addr->message = US"domain is in queue_domains";
6353 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_ROUTER, 0);
6357 addr_route = okaddr;
6360 /* Now route those addresses that are not deferred. */
6365 address_item *addr = addr_route;
6366 const uschar *old_domain = addr->domain;
6367 uschar *old_unique = addr->unique;
6368 addr_route = addr->next;
6371 /* Just in case some router parameter refers to it. */
6373 if (!(return_path = addr->prop.errors_address))
6374 return_path = sender_address;
6376 /* If a router defers an address, add a retry item. Whether or not to
6377 use the local part in the key is a property of the router. */
6379 if ((rc = route_address(addr, &addr_local, &addr_remote, &addr_new,
6380 &addr_succeed, v_none)) == DEFER)
6381 retry_add_item(addr,
6382 addr->router->retry_use_local_part
6383 ? string_sprintf("R:%s@%s", addr->local_part, addr->domain)
6384 : string_sprintf("R:%s", addr->domain),
6387 /* Otherwise, if there is an existing retry record in the database, add
6388 retry items to delete both forms. We must also allow for the possibility
6389 of a routing retry that includes the sender address. Since the domain might
6390 have been rewritten (expanded to fully qualified) as a result of routing,
6391 ensure that the rewritten form is also deleted. */
6393 else if (testflag(addr, af_dr_retry_exists))
6395 uschar *altkey = string_sprintf("%s:<%s>", addr->address_retry_key,
6397 retry_add_item(addr, altkey, rf_delete);
6398 retry_add_item(addr, addr->address_retry_key, rf_delete);
6399 retry_add_item(addr, addr->domain_retry_key, rf_delete);
6400 if (Ustrcmp(addr->domain, old_domain) != 0)
6401 retry_add_item(addr, string_sprintf("R:%s", old_domain), rf_delete);
6404 /* DISCARD is given for :blackhole: and "seen finish". The event has been
6405 logged, but we need to ensure the address (and maybe parents) is marked
6410 address_done(addr, tod_stamp(tod_log));
6411 continue; /* route next address */
6414 /* The address is finished with (failed or deferred). */
6418 (void)post_process_one(addr, rc, LOG_MAIN, DTYPE_ROUTER, 0);
6419 continue; /* route next address */
6422 /* The address has been routed. If the router changed the domain, it will
6423 also have changed the unique address. We have to test whether this address
6424 has already been delivered, because it's the unique address that finally
6427 if ( addr->unique != old_unique
6428 && tree_search(tree_nonrecipients, addr->unique) != 0
6431 DEBUG(D_deliver|D_route) debug_printf("%s was previously delivered: "
6432 "discarded\n", addr->address);
6433 if (addr_remote == addr) addr_remote = addr->next;
6434 else if (addr_local == addr) addr_local = addr->next;
6437 /* If the router has same_domain_copy_routing set, we are permitted to copy
6438 the routing for any other addresses with the same domain. This is an
6439 optimisation to save repeated DNS lookups for "standard" remote domain
6440 routing. The option is settable only on routers that generate host lists.
6441 We play it very safe, and do the optimization only if the address is routed
6442 to a remote transport, there are no header changes, and the domain was not
6443 modified by the router. */
6445 if ( addr_remote == addr
6446 && addr->router->same_domain_copy_routing
6447 && !addr->prop.extra_headers
6448 && !addr->prop.remove_headers
6449 && old_domain == addr->domain
6452 address_item **chain = &addr_route;
6455 address_item *addr2 = *chain;
6456 if (Ustrcmp(addr2->domain, addr->domain) != 0)
6458 chain = &(addr2->next);
6462 /* Found a suitable address; take it off the routing list and add it to
6463 the remote delivery list. */
6465 *chain = addr2->next;
6466 addr2->next = addr_remote;
6467 addr_remote = addr2;
6469 /* Copy the routing data */
6471 addr2->domain = addr->domain;
6472 addr2->router = addr->router;
6473 addr2->transport = addr->transport;
6474 addr2->host_list = addr->host_list;
6475 addr2->fallback_hosts = addr->fallback_hosts;
6476 addr2->prop.errors_address = addr->prop.errors_address;
6477 copyflag(addr2, addr, af_hide_child | af_local_host_removed);
6479 DEBUG(D_deliver|D_route)
6481 debug_printf(">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>\n"
6483 "Routing for %s copied from %s\n",
6484 addr2->address, addr2->address, addr->address);
6488 } /* Continue with routing the next address. */
6489 } /* Loop to process any child addresses that the routers created, and
6490 any rerouted addresses that got put back on the new chain. */
6493 /* Debugging: show the results of the routing */
6495 DEBUG(D_deliver|D_retry|D_route)
6498 debug_printf(">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>\n");
6499 debug_printf("After routing:\n Local deliveries:\n");
6500 for (p = addr_local; p; p = p->next)
6501 debug_printf(" %s\n", p->address);
6503 debug_printf(" Remote deliveries:\n");
6504 for (p = addr_remote; p; p = p->next)
6505 debug_printf(" %s\n", p->address);
6507 debug_printf(" Failed addresses:\n");
6508 for (p = addr_failed; p; p = p->next)
6509 debug_printf(" %s\n", p->address);
6511 debug_printf(" Deferred addresses:\n");
6512 for (p = addr_defer; p; p = p->next)
6513 debug_printf(" %s\n", p->address);
6516 /* Free any resources that were cached during routing. */
6521 /* These two variables are set only during routing, after check_local_user.
6522 Ensure they are not set in transports. */
6524 local_user_gid = (gid_t)(-1);
6525 local_user_uid = (uid_t)(-1);
6527 /* Check for any duplicate addresses. This check is delayed until after
6528 routing, because the flexibility of the routing configuration means that
6529 identical addresses with different parentage may end up being redirected to
6530 different addresses. Checking for duplicates too early (as we previously used
6531 to) makes this kind of thing not work. */
6533 do_duplicate_check(&addr_local);
6534 do_duplicate_check(&addr_remote);
6536 /* When acting as an MUA wrapper, we proceed only if all addresses route to a
6537 remote transport. The check that they all end up in one transaction happens in
6538 the do_remote_deliveries() function. */
6541 && (addr_local || addr_failed || addr_defer)
6545 uschar *which, *colon, *msg;
6552 else if (addr_defer)
6555 which = US"deferred";
6563 while (addr->parent) addr = addr->parent;
6568 msg = addr->message;
6570 else colon = msg = US"";
6572 /* We don't need to log here for a forced failure as it will already
6573 have been logged. Defer will also have been logged, but as a defer, so we do
6574 need to do the failure logging. */
6576 if (addr != addr_failed)
6577 log_write(0, LOG_MAIN, "** %s routing yielded a %s delivery",
6578 addr->address, which);
6580 /* Always write an error to the caller */
6582 fprintf(stderr, "routing %s yielded a %s delivery%s%s\n", addr->address,
6585 final_yield = DELIVER_MUA_FAILED;
6586 addr_failed = addr_defer = NULL; /* So that we remove the message */
6587 goto DELIVERY_TIDYUP;
6591 /* If this is a run to continue deliveries to an external channel that is
6592 already set up, defer any local deliveries. */
6594 if (continue_transport)
6598 address_item *addr = addr_defer;
6599 while (addr->next) addr = addr->next;
6600 addr->next = addr_local;
6603 addr_defer = addr_local;
6608 /* Because address rewriting can happen in the routers, we should not really do
6609 ANY deliveries until all addresses have been routed, so that all recipients of
6610 the message get the same headers. However, this is in practice not always
6611 possible, since sometimes remote addresses give DNS timeouts for days on end.
6612 The pragmatic approach is to deliver what we can now, saving any rewritten
6613 headers so that at least the next lot of recipients benefit from the rewriting
6614 that has already been done.
6616 If any headers have been rewritten during routing, update the spool file to
6617 remember them for all subsequent deliveries. This can be delayed till later if
6618 there is only address to be delivered - if it succeeds the spool write need not
6621 if ( header_rewritten
6623 && (addr_local->next || addr_remote)
6625 || (addr_remote && addr_remote->next)
6628 /* Panic-dies on error */
6629 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
6630 header_rewritten = FALSE;
6634 /* If there are any deliveries to be done, open the journal file. This is used
6635 to record successful deliveries as soon as possible after each delivery is
6636 known to be complete. A file opened with O_APPEND is used so that several
6637 processes can run simultaneously.
6639 The journal is just insurance against crashes. When the spool file is
6640 ultimately updated at the end of processing, the journal is deleted. If a
6641 journal is found to exist at the start of delivery, the addresses listed
6642 therein are added to the non-recipients. */
6644 if (addr_local || addr_remote)
6646 uschar * fname = spool_fname(US"input", message_subdir, id, US"-J");
6648 if ((journal_fd = Uopen(fname, O_WRONLY|O_APPEND|O_CREAT, SPOOL_MODE)) <0)
6650 log_write(0, LOG_MAIN|LOG_PANIC, "Couldn't open journal file %s: %s",
6651 fname, strerror(errno));
6652 return DELIVER_NOT_ATTEMPTED;
6655 /* Set the close-on-exec flag, make the file owned by Exim, and ensure
6656 that the mode is correct - the group setting doesn't always seem to get
6657 set automatically. */
6659 if( fcntl(journal_fd, F_SETFD, fcntl(journal_fd, F_GETFD) | FD_CLOEXEC)
6660 || fchown(journal_fd, exim_uid, exim_gid)
6661 || fchmod(journal_fd, SPOOL_MODE)
6664 int ret = Uunlink(fname);
6665 log_write(0, LOG_MAIN|LOG_PANIC, "Couldn't set perms on journal file %s: %s",
6666 fname, strerror(errno));
6667 if(ret && errno != ENOENT)
6668 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s",
6669 fname, strerror(errno));
6670 return DELIVER_NOT_ATTEMPTED;
6676 /* Now we can get down to the business of actually doing deliveries. Local
6677 deliveries are done first, then remote ones. If ever the problems of how to
6678 handle fallback transports are figured out, this section can be put into a loop
6679 for handling fallbacks, though the uid switching will have to be revised. */
6681 /* Precompile a regex that is used to recognize a parameter in response
6682 to an LHLO command, if is isn't already compiled. This may be used on both
6683 local and remote LMTP deliveries. */
6685 if (!regex_IGNOREQUOTA)
6687 regex_must_compile(US"\\n250[\\s\\-]IGNOREQUOTA(\\s|\\n|$)", FALSE, TRUE);
6689 /* Handle local deliveries */
6693 DEBUG(D_deliver|D_transport)
6694 debug_printf(">>>>>>>>>>>>>>>> Local deliveries >>>>>>>>>>>>>>>>\n");
6695 do_local_deliveries();
6696 disable_logging = FALSE;
6699 /* If queue_run_local is set, we do not want to attempt any remote deliveries,
6700 so just queue them all. */
6702 if (queue_run_local)
6705 address_item *addr = addr_remote;
6706 addr_remote = addr->next;
6708 addr->basic_errno = ERRNO_LOCAL_ONLY;
6709 addr->message = US"remote deliveries suppressed";
6710 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_TRANSPORT, 0);
6713 /* Handle remote deliveries */
6717 DEBUG(D_deliver|D_transport)
6718 debug_printf(">>>>>>>>>>>>>>>> Remote deliveries >>>>>>>>>>>>>>>>\n");
6720 /* Precompile some regex that are used to recognize parameters in response
6721 to an EHLO command, if they aren't already compiled. */
6725 /* Now sort the addresses if required, and do the deliveries. The yield of
6726 do_remote_deliveries is FALSE when mua_wrapper is set and all addresses
6727 cannot be delivered in one transaction. */
6729 if (remote_sort_domains) sort_remote_deliveries();
6730 if (!do_remote_deliveries(FALSE))
6732 log_write(0, LOG_MAIN, "** mua_wrapper is set but recipients cannot all "
6733 "be delivered in one transaction");
6734 fprintf(stderr, "delivery to smarthost failed (configuration problem)\n");
6736 final_yield = DELIVER_MUA_FAILED;
6737 addr_failed = addr_defer = NULL; /* So that we remove the message */
6738 goto DELIVERY_TIDYUP;
6741 /* See if any of the addresses that failed got put on the queue for delivery
6742 to their fallback hosts. We do it this way because often the same fallback
6743 host is used for many domains, so all can be sent in a single transaction
6744 (if appropriately configured). */
6746 if (addr_fallback && !mua_wrapper)
6748 DEBUG(D_deliver) debug_printf("Delivering to fallback hosts\n");
6749 addr_remote = addr_fallback;
6750 addr_fallback = NULL;
6751 if (remote_sort_domains) sort_remote_deliveries();
6752 do_remote_deliveries(TRUE);
6754 disable_logging = FALSE;
6758 /* All deliveries are now complete. Ignore SIGTERM during this tidying up
6759 phase, to minimize cases of half-done things. */
6762 debug_printf(">>>>>>>>>>>>>>>> deliveries are done >>>>>>>>>>>>>>>>\n");
6764 /* Root privilege is no longer needed */
6766 exim_setugid(exim_uid, exim_gid, FALSE, US"post-delivery tidying");
6768 set_process_info("tidying up after delivering %s", message_id);
6769 signal(SIGTERM, SIG_IGN);
6771 /* When we are acting as an MUA wrapper, the smtp transport will either have
6772 succeeded for all addresses, or failed them all in normal cases. However, there
6773 are some setup situations (e.g. when a named port does not exist) that cause an
6774 immediate exit with deferral of all addresses. Convert those into failures. We
6775 do not ever want to retry, nor do we want to send a bounce message. */
6781 address_item *addr, *nextaddr;
6782 for (addr = addr_defer; addr; addr = nextaddr)
6784 log_write(0, LOG_MAIN, "** %s mua_wrapper forced failure for deferred "
6785 "delivery", addr->address);
6786 nextaddr = addr->next;
6787 addr->next = addr_failed;
6793 /* Now all should either have succeeded or failed. */
6796 final_yield = DELIVER_MUA_SUCCEEDED;
6800 uschar *s = addr_failed->user_message;
6802 if (!s) s = addr_failed->message;
6804 fprintf(stderr, "Delivery failed: ");
6805 if (addr_failed->basic_errno > 0)
6807 fprintf(stderr, "%s", strerror(addr_failed->basic_errno));
6808 if (s) fprintf(stderr, ": ");
6810 if ((host = addr_failed->host_used))
6811 fprintf(stderr, "H=%s [%s]: ", host->name, host->address);
6813 fprintf(stderr, "%s", CS s);
6814 else if (addr_failed->basic_errno <= 0)
6815 fprintf(stderr, "unknown error");
6816 fprintf(stderr, "\n");
6818 final_yield = DELIVER_MUA_FAILED;
6823 /* In a normal configuration, we now update the retry database. This is done in
6824 one fell swoop at the end in order not to keep opening and closing (and
6825 locking) the database. The code for handling retries is hived off into a
6826 separate module for convenience. We pass it the addresses of the various
6827 chains, because deferred addresses can get moved onto the failed chain if the
6828 retry cutoff time has expired for all alternative destinations. Bypass the
6829 updating of the database if the -N flag is set, which is a debugging thing that
6830 prevents actual delivery. */
6832 else if (!dont_deliver)
6833 retry_update(&addr_defer, &addr_failed, &addr_succeed);
6835 /* Send DSN for successful messages if requested */
6836 addr_senddsn = NULL;
6838 for (addr_dsntmp = addr_succeed; addr_dsntmp; addr_dsntmp = addr_dsntmp->next)
6840 /* af_ignore_error not honored here. it's not an error */
6841 DEBUG(D_deliver) debug_printf("DSN: processing router : %s\n"
6842 "DSN: processing successful delivery address: %s\n"
6843 "DSN: Sender_address: %s\n"
6844 "DSN: orcpt: %s flags: %d\n"
6845 "DSN: envid: %s ret: %d\n"
6846 "DSN: Final recipient: %s\n"
6847 "DSN: Remote SMTP server supports DSN: %d\n",
6848 addr_dsntmp->router->name,
6849 addr_dsntmp->address,
6851 addr_dsntmp->dsn_orcpt, addr_dsntmp->dsn_flags,
6853 addr_dsntmp->address,
6854 addr_dsntmp->dsn_aware
6857 /* send report if next hop not DSN aware or a router flagged "last DSN hop"
6858 and a report was requested */
6859 if ( ( addr_dsntmp->dsn_aware != dsn_support_yes
6860 || addr_dsntmp->dsn_flags & rf_dsnlasthop
6862 && addr_dsntmp->dsn_flags & rf_dsnflags
6863 && addr_dsntmp->dsn_flags & rf_notify_success
6866 /* copy and relink address_item and send report with all of them at once later */
6867 address_item *addr_next;
6868 addr_next = addr_senddsn;
6869 addr_senddsn = store_get(sizeof(address_item));
6870 memcpy(addr_senddsn, addr_dsntmp, sizeof(address_item));
6871 addr_senddsn->next = addr_next;
6874 DEBUG(D_deliver) debug_printf("DSN: not sending DSN success message\n");
6882 /* create exim process to send message */
6883 pid = child_open_exim(&fd);
6885 DEBUG(D_deliver) debug_printf("DSN: child_open_exim returns: %d\n", pid);
6887 if (pid < 0) /* Creation of child failed */
6889 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Process %d (parent %d) failed to "
6890 "create child process to send failure message: %s", getpid(),
6891 getppid(), strerror(errno));
6893 DEBUG(D_deliver) debug_printf("DSN: child_open_exim failed\n");
6895 else /* Creation of child succeeded */
6897 FILE *f = fdopen(fd, "wb");
6898 /* header only as required by RFC. only failure DSN needs to honor RET=FULL */
6899 int topt = topt_add_return_path | topt_no_body;
6903 debug_printf("sending error message to: %s\n", sender_address);
6905 /* build unique id for MIME boundary */
6906 bound = string_sprintf(TIME_T_FMT "-eximdsn-%d", time(NULL), rand());
6907 DEBUG(D_deliver) debug_printf("DSN: MIME boundary: %s\n", bound);
6909 if (errors_reply_to)
6910 fprintf(f, "Reply-To: %s\n", errors_reply_to);
6912 fprintf(f, "Auto-Submitted: auto-generated\n"
6913 "From: Mail Delivery System <Mailer-Daemon@%s>\n"
6915 "Subject: Delivery Status Notification\n"
6916 "Content-Type: multipart/report; report-type=delivery-status; boundary=%s\n"
6917 "MIME-Version: 1.0\n\n"
6920 "Content-type: text/plain; charset=us-ascii\n\n"
6922 "This message was created automatically by mail delivery software.\n"
6923 " ----- The following addresses had successful delivery notifications -----\n",
6924 qualify_domain_sender, sender_address, bound, bound);
6926 for (addr_dsntmp = addr_senddsn; addr_dsntmp;
6927 addr_dsntmp = addr_dsntmp->next)
6928 fprintf(f, "<%s> (relayed %s)\n\n",
6929 addr_dsntmp->address,
6930 (addr_dsntmp->dsn_flags & rf_dsnlasthop) == 1
6931 ? "via non DSN router"
6932 : addr_dsntmp->dsn_aware == dsn_support_no
6933 ? "to non-DSN-aware mailer"
6934 : "via non \"Remote SMTP\" router"
6938 "Content-type: message/delivery-status\n\n"
6939 "Reporting-MTA: dns; %s\n",
6940 bound, smtp_active_hostname);
6943 { /* must be decoded from xtext: see RFC 3461:6.3a */
6945 if (auth_xtextdecode(dsn_envid, &xdec_envid) > 0)
6946 fprintf(f, "Original-Envelope-ID: %s\n", dsn_envid);
6948 fprintf(f, "X-Original-Envelope-ID: error decoding xtext formatted ENVID\n");
6952 for (addr_dsntmp = addr_senddsn;
6954 addr_dsntmp = addr_dsntmp->next)
6956 if (addr_dsntmp->dsn_orcpt)
6957 fprintf(f,"Original-Recipient: %s\n", addr_dsntmp->dsn_orcpt);
6959 fprintf(f, "Action: delivered\n"
6960 "Final-Recipient: rfc822;%s\n"
6962 addr_dsntmp->address);
6964 if (addr_dsntmp->host_used && addr_dsntmp->host_used->name)
6965 fprintf(f, "Remote-MTA: dns; %s\nDiagnostic-Code: smtp; 250 Ok\n\n",
6966 addr_dsntmp->host_used->name);
6968 fprintf(f, "Diagnostic-Code: X-Exim; relayed via non %s router\n\n",
6969 (addr_dsntmp->dsn_flags & rf_dsnlasthop) == 1 ? "DSN" : "SMTP");
6972 fprintf(f, "--%s\nContent-type: text/rfc822-headers\n\n", bound);
6975 transport_filter_argv = NULL; /* Just in case */
6976 return_path = sender_address; /* In case not previously set */
6978 /* Write the original email out */
6979 transport_write_message(NULL, fileno(f), topt, 0, NULL, NULL, NULL, NULL, NULL, 0);
6982 fprintf(f,"\n--%s--\n", bound);
6986 rc = child_close(pid, 0); /* Waits for child to close, no timeout */
6990 /* If any addresses failed, we must send a message to somebody, unless
6991 af_ignore_error is set, in which case no action is taken. It is possible for
6992 several messages to get sent if there are addresses with different
6999 uschar *logtod = tod_stamp(tod_log);
7001 address_item *handled_addr = NULL;
7002 address_item **paddr;
7003 address_item *msgchain = NULL;
7004 address_item **pmsgchain = &msgchain;
7006 /* There are weird cases when logging is disabled in the transport. However,
7007 there may not be a transport (address failed by a router). */
7009 disable_logging = FALSE;
7010 if (addr_failed->transport)
7011 disable_logging = addr_failed->transport->disable_logging;
7014 debug_printf("processing failed address %s\n", addr_failed->address);
7016 /* There are only two ways an address in a bounce message can get here:
7018 (1) When delivery was initially deferred, but has now timed out (in the call
7019 to retry_update() above). We can detect this by testing for
7020 af_retry_timedout. If the address does not have its own errors address,
7021 we arrange to ignore the error.
7023 (2) If delivery failures for bounce messages are being ignored. We can detect
7024 this by testing for af_ignore_error. This will also be set if a bounce
7025 message has been autothawed and the ignore_bounce_errors_after time has
7026 passed. It might also be set if a router was explicitly configured to
7027 ignore errors (errors_to = "").
7029 If neither of these cases obtains, something has gone wrong. Log the
7030 incident, but then ignore the error. */
7032 if (sender_address[0] == 0 && !addr_failed->prop.errors_address)
7034 if ( !testflag(addr_failed, af_retry_timedout)
7035 && !testflag(addr_failed, af_ignore_error))
7037 log_write(0, LOG_MAIN|LOG_PANIC, "internal error: bounce message "
7038 "failure is neither frozen nor ignored (it's been ignored)");
7040 setflag(addr_failed, af_ignore_error);
7043 /* If the first address on the list has af_ignore_error set, just remove
7044 it from the list, throw away any saved message file, log it, and
7045 mark the recipient done. */
7047 if ( testflag(addr_failed, af_ignore_error)
7048 || ( addr_failed->dsn_flags & rf_dsnflags
7049 && (addr_failed->dsn_flags & rf_notify_failure) != rf_notify_failure
7053 addr_failed = addr->next;
7054 if (addr->return_filename) Uunlink(addr->return_filename);
7056 log_write(0, LOG_MAIN, "%s%s%s%s: error ignored",
7058 !addr->parent ? US"" : US" <",
7059 !addr->parent ? US"" : addr->parent->address,
7060 !addr->parent ? US"" : US">");
7062 address_done(addr, logtod);
7063 child_done(addr, logtod);
7064 /* Panic-dies on error */
7065 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
7068 /* Otherwise, handle the sending of a message. Find the error address for
7069 the first address, then send a message that includes all failed addresses
7070 that have the same error address. Note the bounce_recipient is a global so
7071 that it can be accesssed by $bounce_recipient while creating a customized
7076 if (!(bounce_recipient = addr_failed->prop.errors_address))
7077 bounce_recipient = sender_address;
7079 /* Make a subprocess to send a message */
7081 if ((pid = child_open_exim(&fd)) < 0)
7082 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Process %d (parent %d) failed to "
7083 "create child process to send failure message: %s", getpid(),
7084 getppid(), strerror(errno));
7086 /* Creation of child succeeded */
7093 uschar *bcc, *emf_text;
7094 FILE *f = fdopen(fd, "wb");
7096 BOOL to_sender = strcmpic(sender_address, bounce_recipient) == 0;
7097 int max = (bounce_return_size_limit/DELIVER_IN_BUFFER_SIZE + 1) *
7098 DELIVER_IN_BUFFER_SIZE;
7100 uschar *dsnlimitmsg;
7101 uschar *dsnnotifyhdr;
7105 debug_printf("sending error message to: %s\n", bounce_recipient);
7107 /* Scan the addresses for all that have the same errors address, removing
7108 them from the addr_failed chain, and putting them on msgchain. */
7110 paddr = &addr_failed;
7111 for (addr = addr_failed; addr; addr = *paddr)
7112 if (Ustrcmp(bounce_recipient, addr->prop.errors_address
7113 ? addr->prop.errors_address : sender_address) == 0)
7114 { /* The same - dechain */
7115 *paddr = addr->next;
7118 pmsgchain = &(addr->next);
7121 paddr = &addr->next; /* Not the same; skip */
7123 /* Include X-Failed-Recipients: for automatic interpretation, but do
7124 not let any one header line get too long. We do this by starting a
7125 new header every 50 recipients. Omit any addresses for which the
7126 "hide_child" flag is set. */
7128 for (addr = msgchain; addr; addr = addr->next)
7130 if (testflag(addr, af_hide_child)) continue;
7138 ? "X-Failed-Recipients: "
7140 testflag(addr, af_pfr) && addr->parent
7141 ? string_printing(addr->parent->address)
7142 : string_printing(addr->address));
7144 if (rcount > 0) fprintf(f, "\n");
7146 /* Output the standard headers */
7148 if (errors_reply_to)
7149 fprintf(f, "Reply-To: %s\n", errors_reply_to);
7150 fprintf(f, "Auto-Submitted: auto-replied\n");
7152 fprintf(f, "To: %s\n", bounce_recipient);
7154 /* generate boundary string and output MIME-Headers */
7155 bound = string_sprintf(TIME_T_FMT "-eximdsn-%d", time(NULL), rand());
7157 fprintf(f, "Content-Type: multipart/report;"
7158 " report-type=delivery-status; boundary=%s\n"
7159 "MIME-Version: 1.0\n",
7162 /* Open a template file if one is provided. Log failure to open, but
7163 carry on - default texts will be used. */
7165 if (bounce_message_file)
7166 if (!(emf = Ufopen(bounce_message_file, "rb")))
7167 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to open %s for error "
7168 "message texts: %s", bounce_message_file, strerror(errno));
7170 /* Quietly copy to configured additional addresses if required. */
7172 if ((bcc = moan_check_errorcopy(bounce_recipient)))
7173 fprintf(f, "Bcc: %s\n", bcc);
7175 /* The texts for the message can be read from a template file; if there
7176 isn't one, or if it is too short, built-in texts are used. The first
7177 emf text is a Subject: and any other headers. */
7179 if ((emf_text = next_emf(emf, US"header")))
7180 fprintf(f, "%s\n", emf_text);
7182 fprintf(f, "Subject: Mail delivery failed%s\n\n",
7183 to_sender? ": returning message to sender" : "");
7185 /* output human readable part as text/plain section */
7187 "Content-type: text/plain; charset=us-ascii\n\n",
7190 if ((emf_text = next_emf(emf, US"intro")))
7191 fprintf(f, "%s", CS emf_text);
7195 /* This message has been reworded several times. It seems to be confusing to
7196 somebody, however it is worded. I have retreated to the original, simple
7198 "This message was created automatically by mail delivery software.\n");
7200 if (bounce_message_text)
7201 fprintf(f, "%s", CS bounce_message_text);
7204 "\nA message that you sent could not be delivered to one or more of its\n"
7205 "recipients. This is a permanent error. The following address(es) failed:\n");
7208 "\nA message sent by\n\n <%s>\n\n"
7209 "could not be delivered to one or more of its recipients. The following\n"
7210 "address(es) failed:\n", sender_address);
7214 /* Process the addresses, leaving them on the msgchain if they have a
7215 file name for a return message. (There has already been a check in
7216 post_process_one() for the existence of data in the message file.) A TRUE
7217 return from print_address_information() means that the address is not
7221 for (addr = msgchain; addr; addr = *paddr)
7223 if (print_address_information(addr, f, US" ", US"\n ", US""))
7224 print_address_error(addr, f, US"");
7226 /* End the final line for the address */
7230 /* Leave on msgchain if there's a return file. */
7232 if (addr->return_file >= 0)
7234 paddr = &(addr->next);
7238 /* Else save so that we can tick off the recipient when the
7243 *paddr = addr->next;
7244 addr->next = handled_addr;
7245 handled_addr = addr;
7251 /* Get the next text, whether we need it or not, so as to be
7252 positioned for the one after. */
7254 emf_text = next_emf(emf, US"generated text");
7256 /* If there were any file messages passed by the local transports,
7257 include them in the message. Then put the address on the handled chain.
7258 In the case of a batch of addresses that were all sent to the same
7259 transport, the return_file field in all of them will contain the same
7260 fd, and the return_filename field in the *last* one will be set (to the
7261 name of the file). */
7265 address_item *nextaddr;
7268 fprintf(f, "%s", CS emf_text);
7271 "The following text was generated during the delivery "
7272 "attempt%s:\n", (filecount > 1)? "s" : "");
7274 for (addr = msgchain; addr; addr = nextaddr)
7277 address_item *topaddr = addr;
7279 /* List all the addresses that relate to this file */
7282 while(addr) /* Insurance */
7284 print_address_information(addr, f, US"------ ", US"\n ",
7286 if (addr->return_filename) break;
7291 /* Now copy the file */
7293 if (!(fm = Ufopen(addr->return_filename, "rb")))
7294 fprintf(f, " +++ Exim error... failed to open text file: %s\n",
7298 while ((ch = fgetc(fm)) != EOF) fputc(ch, f);
7301 Uunlink(addr->return_filename);
7303 /* Can now add to handled chain, first fishing off the next
7304 address on the msgchain. */
7306 nextaddr = addr->next;
7307 addr->next = handled_addr;
7308 handled_addr = topaddr;
7313 /* output machine readable part */
7315 if (message_smtputf8)
7317 "Content-type: message/global-delivery-status\n\n"
7318 "Reporting-MTA: dns; %s\n",
7319 bound, smtp_active_hostname);
7323 "Content-type: message/delivery-status\n\n"
7324 "Reporting-MTA: dns; %s\n",
7325 bound, smtp_active_hostname);
7329 /* must be decoded from xtext: see RFC 3461:6.3a */
7331 if (auth_xtextdecode(dsn_envid, &xdec_envid) > 0)
7332 fprintf(f, "Original-Envelope-ID: %s\n", dsn_envid);
7334 fprintf(f, "X-Original-Envelope-ID: error decoding xtext formatted ENVID\n");
7338 for (addr = handled_addr; addr; addr = addr->next)
7341 fprintf(f, "Action: failed\n"
7342 "Final-Recipient: rfc822;%s\n"
7345 if ((hu = addr->host_used) && hu->name)
7348 fprintf(f, "Remote-MTA: dns; %s\n", hu->name);
7349 #ifdef EXPERIMENTAL_DSN_INFO
7352 uschar * p = hu->port == 25
7353 ? US"" : string_sprintf(":%d", hu->port);
7354 fprintf(f, "Remote-MTA: X-ip; [%s]%s\n", hu->address, p);
7356 if ((s = addr->smtp_greeting) && *s)
7357 fprintf(f, "X-Remote-MTA-smtp-greeting: X-str; %s\n", s);
7358 if ((s = addr->helo_response) && *s)
7359 fprintf(f, "X-Remote-MTA-helo-response: X-str; %s\n", s);
7360 if ((s = addr->message) && *s)
7361 fprintf(f, "X-Exim-Diagnostic: X-str; %s\n", s);
7363 print_dsn_diagnostic_code(addr, f);
7368 /* Now copy the message, trying to give an intelligible comment if
7369 it is too long for it all to be copied. The limit isn't strictly
7370 applied because of the buffering. There is, however, an option
7371 to suppress copying altogether. */
7373 emf_text = next_emf(emf, US"copy");
7376 we ignore the intro text from template and add
7377 the text for bounce_return_size_limit at the end.
7379 bounce_return_message is ignored
7380 in case RET= is defined we honor these values
7381 otherwise bounce_return_body is honored.
7383 bounce_return_size_limit is always honored.
7386 fprintf(f, "--%s\n", bound);
7388 dsnlimitmsg = US"X-Exim-DSN-Information: Due to administrative limits only headers are returned";
7389 dsnnotifyhdr = NULL;
7390 topt = topt_add_return_path;
7392 /* RET=HDRS? top priority */
7393 if (dsn_ret == dsn_ret_hdrs)
7394 topt |= topt_no_body;
7397 struct stat statbuf;
7399 /* no full body return at all? */
7400 if (!bounce_return_body)
7402 topt |= topt_no_body;
7403 /* add header if we overrule RET=FULL */
7404 if (dsn_ret == dsn_ret_full)
7405 dsnnotifyhdr = dsnlimitmsg;
7407 /* line length limited... return headers only if oversize */
7408 /* size limited ... return headers only if limit reached */
7409 else if ( max_received_linelength > bounce_return_linesize_limit
7410 || ( bounce_return_size_limit > 0
7411 && fstat(deliver_datafile, &statbuf) == 0
7412 && statbuf.st_size > max
7415 topt |= topt_no_body;
7416 dsnnotifyhdr = dsnlimitmsg;
7421 if (message_smtputf8)
7422 fputs(topt & topt_no_body ? "Content-type: message/global-headers\n\n"
7423 : "Content-type: message/global\n\n",
7427 fputs(topt & topt_no_body ? "Content-type: text/rfc822-headers\n\n"
7428 : "Content-type: message/rfc822\n\n",
7432 transport_filter_argv = NULL; /* Just in case */
7433 return_path = sender_address; /* In case not previously set */
7434 transport_write_message(NULL, fileno(f), topt,
7435 0, dsnnotifyhdr, NULL, NULL, NULL, NULL, 0);
7438 /* we never add the final text. close the file */
7442 fprintf(f, "\n--%s--\n", bound);
7444 /* Close the file, which should send an EOF to the child process
7445 that is receiving the message. Wait for it to finish. */
7448 rc = child_close(pid, 0); /* Waits for child to close, no timeout */
7450 /* In the test harness, let the child do it's thing first. */
7452 if (running_in_test_harness) millisleep(500);
7454 /* If the process failed, there was some disaster in setting up the
7455 error message. Unless the message is very old, ensure that addr_defer
7456 is non-null, which will have the effect of leaving the message on the
7457 spool. The failed addresses will get tried again next time. However, we
7458 don't really want this to happen too often, so freeze the message unless
7459 there are some genuine deferred addresses to try. To do this we have
7460 to call spool_write_header() here, because with no genuine deferred
7461 addresses the normal code below doesn't get run. */
7466 if (now - received_time < retry_maximum_timeout && !addr_defer)
7468 addr_defer = (address_item *)(+1);
7469 deliver_freeze = TRUE;
7470 deliver_frozen_at = time(NULL);
7471 /* Panic-dies on error */
7472 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
7475 deliver_msglog("Process failed (%d) when writing error message "
7476 "to %s%s", rc, bounce_recipient, s);
7477 log_write(0, LOG_MAIN, "Process failed (%d) when writing error message "
7478 "to %s%s", rc, bounce_recipient, s);
7481 /* The message succeeded. Ensure that the recipients that failed are
7482 now marked finished with on the spool and their parents updated. */
7486 for (addr = handled_addr; addr; addr = addr->next)
7488 address_done(addr, logtod);
7489 child_done(addr, logtod);
7491 /* Panic-dies on error */
7492 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
7498 disable_logging = FALSE; /* In case left set */
7500 /* Come here from the mua_wrapper case if routing goes wrong */
7504 /* If there are now no deferred addresses, we are done. Preserve the
7505 message log if so configured, and we are using them. Otherwise, sling it.
7506 Then delete the message itself. */
7514 fname = spool_fname(US"msglog", message_subdir, id, US"");
7515 if (preserve_message_logs)
7518 uschar * moname = spool_fname(US"msglog.OLD", US"", id, US"");
7520 if ((rc = Urename(fname, moname)) < 0)
7522 (void)directory_make(spool_directory,
7523 spool_sname(US"msglog.OLD", US""),
7524 MSGLOG_DIRECTORY_MODE, TRUE);
7525 rc = Urename(fname, moname);
7528 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to move %s to the "
7529 "msglog.OLD directory", fname);
7532 if (Uunlink(fname) < 0)
7533 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s",
7534 fname, strerror(errno));
7537 /* Remove the two message files. */
7539 fname = spool_fname(US"input", message_subdir, id, US"-D");
7540 if (Uunlink(fname) < 0)
7541 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s",
7542 fname, strerror(errno));
7543 fname = spool_fname(US"input", message_subdir, id, US"-H");
7544 if (Uunlink(fname) < 0)
7545 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s",
7546 fname, strerror(errno));
7548 /* Log the end of this message, with queue time if requested. */
7550 if (LOGGING(queue_time_overall))
7551 log_write(0, LOG_MAIN, "Completed QT=%s",
7552 readconf_printtime( (int) ((long)time(NULL) - (long)received_time)) );
7554 log_write(0, LOG_MAIN, "Completed");
7556 /* Unset deliver_freeze so that we won't try to move the spool files further down */
7557 deliver_freeze = FALSE;
7559 #ifndef DISABLE_EVENT
7560 (void) event_raise(event_action, US"msg:complete", NULL);
7564 /* If there are deferred addresses, we are keeping this message because it is
7565 not yet completed. Lose any temporary files that were catching output from
7566 pipes for any of the deferred addresses, handle one-time aliases, and see if
7567 the message has been on the queue for so long that it is time to send a warning
7568 message to the sender, unless it is a mailer-daemon. If all deferred addresses
7569 have the same domain, we can set deliver_domain for the expansion of
7570 delay_warning_ condition - if any of them are pipes, files, or autoreplies, use
7571 the parent's domain.
7573 If all the deferred addresses have an error number that indicates "retry time
7574 not reached", skip sending the warning message, because it won't contain the
7575 reason for the delay. It will get sent at the next real delivery attempt.
7576 However, if at least one address has tried, we'd better include all of them in
7579 If we can't make a process to send the message, don't worry.
7581 For mailing list expansions we want to send the warning message to the
7582 mailing list manager. We can't do a perfect job here, as some addresses may
7583 have different errors addresses, but if we take the errors address from
7584 each deferred address it will probably be right in most cases.
7586 If addr_defer == +1, it means there was a problem sending an error message
7587 for failed addresses, and there were no "real" deferred addresses. The value
7588 was set just to keep the message on the spool, so there is nothing to do here.
7591 else if (addr_defer != (address_item *)(+1))
7594 uschar *recipients = US"";
7595 BOOL delivery_attempted = FALSE;
7597 deliver_domain = testflag(addr_defer, af_pfr)
7598 ? addr_defer->parent->domain : addr_defer->domain;
7600 for (addr = addr_defer; addr; addr = addr->next)
7602 address_item *otaddr;
7604 if (addr->basic_errno > ERRNO_RETRY_BASE) delivery_attempted = TRUE;
7608 const uschar *d = testflag(addr, af_pfr)
7609 ? addr->parent->domain : addr->domain;
7611 /* The domain may be unset for an address that has never been routed
7612 because the system filter froze the message. */
7614 if (!d || Ustrcmp(d, deliver_domain) != 0)
7615 deliver_domain = NULL;
7618 if (addr->return_filename) Uunlink(addr->return_filename);
7620 /* Handle the case of one-time aliases. If any address in the ancestry
7621 of this one is flagged, ensure it is in the recipients list, suitably
7622 flagged, and that its parent is marked delivered. */
7624 for (otaddr = addr; otaddr; otaddr = otaddr->parent)
7625 if (otaddr->onetime_parent) break;
7630 int t = recipients_count;
7632 for (i = 0; i < recipients_count; i++)
7634 uschar *r = recipients_list[i].address;
7635 if (Ustrcmp(otaddr->onetime_parent, r) == 0) t = i;
7636 if (Ustrcmp(otaddr->address, r) == 0) break;
7639 /* Didn't find the address already in the list, and did find the
7640 ultimate parent's address in the list. After adding the recipient,
7641 update the errors address in the recipients list. */
7643 if (i >= recipients_count && t < recipients_count)
7645 DEBUG(D_deliver) debug_printf("one_time: adding %s in place of %s\n",
7646 otaddr->address, otaddr->parent->address);
7647 receive_add_recipient(otaddr->address, t);
7648 recipients_list[recipients_count-1].errors_to = otaddr->prop.errors_address;
7649 tree_add_nonrecipient(otaddr->parent->address);
7650 update_spool = TRUE;
7654 /* Except for error messages, ensure that either the errors address for
7655 this deferred address or, if there is none, the sender address, is on the
7656 list of recipients for a warning message. */
7658 if (sender_address[0] != 0)
7659 if (addr->prop.errors_address)
7661 if (Ustrstr(recipients, addr->prop.errors_address) == NULL)
7662 recipients = string_sprintf("%s%s%s", recipients,
7663 (recipients[0] == 0)? "" : ",", addr->prop.errors_address);
7667 if (Ustrstr(recipients, sender_address) == NULL)
7668 recipients = string_sprintf("%s%s%s", recipients,
7669 (recipients[0] == 0)? "" : ",", sender_address);
7673 /* Send a warning message if the conditions are right. If the condition check
7674 fails because of a lookup defer, there is nothing we can do. The warning
7675 is not sent. Another attempt will be made at the next delivery attempt (if
7679 && delivery_attempted
7680 && ( ((addr_defer->dsn_flags & rf_dsnflags) == 0)
7681 || (addr_defer->dsn_flags & rf_notify_delay) == rf_notify_delay
7683 && delay_warning[1] > 0
7684 && sender_address[0] != 0
7685 && ( !delay_warning_condition
7686 || expand_check_condition(delay_warning_condition,
7687 US"delay_warning", US"option")
7693 int queue_time = time(NULL) - received_time;
7695 /* When running in the test harness, there's an option that allows us to
7696 fudge this time so as to get repeatability of the tests. Take the first
7697 time off the list. In queue runs, the list pointer gets updated in the
7700 if (running_in_test_harness && fudged_queue_times[0] != 0)
7702 int qt = readconf_readtime(fudged_queue_times, '/', FALSE);
7705 DEBUG(D_deliver) debug_printf("fudged queue_times = %s\n",
7706 fudged_queue_times);
7711 /* See how many warnings we should have sent by now */
7713 for (count = 0; count < delay_warning[1]; count++)
7714 if (queue_time < delay_warning[count+2]) break;
7716 show_time = delay_warning[count+1];
7718 if (count >= delay_warning[1])
7721 int last_gap = show_time;
7722 if (count > 1) last_gap -= delay_warning[count];
7723 extra = (queue_time - delay_warning[count+1])/last_gap;
7724 show_time += last_gap * extra;
7730 debug_printf("time on queue = %s\n", readconf_printtime(queue_time));
7731 debug_printf("warning counts: required %d done %d\n", count,
7735 /* We have computed the number of warnings there should have been by now.
7736 If there haven't been enough, send one, and up the count to what it should
7739 if (warning_count < count)
7743 pid_t pid = child_open_exim(&fd);
7749 FILE *f = fdopen(fd, "wb");
7753 if (warn_message_file)
7754 if (!(wmf = Ufopen(warn_message_file, "rb")))
7755 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to open %s for warning "
7756 "message texts: %s", warn_message_file, strerror(errno));
7758 warnmsg_recipients = recipients;
7759 warnmsg_delay = queue_time < 120*60
7760 ? string_sprintf("%d minutes", show_time/60)
7761 : string_sprintf("%d hours", show_time/3600);
7763 if (errors_reply_to)
7764 fprintf(f, "Reply-To: %s\n", errors_reply_to);
7765 fprintf(f, "Auto-Submitted: auto-replied\n");
7767 fprintf(f, "To: %s\n", recipients);
7769 /* generated boundary string and output MIME-Headers */
7770 bound = string_sprintf(TIME_T_FMT "-eximdsn-%d", time(NULL), rand());
7772 fprintf(f, "Content-Type: multipart/report;"
7773 " report-type=delivery-status; boundary=%s\n"
7774 "MIME-Version: 1.0\n",
7777 if ((wmf_text = next_emf(wmf, US"header")))
7778 fprintf(f, "%s\n", wmf_text);
7780 fprintf(f, "Subject: Warning: message %s delayed %s\n\n",
7781 message_id, warnmsg_delay);
7783 /* output human readable part as text/plain section */
7785 "Content-type: text/plain; charset=us-ascii\n\n",
7788 if ((wmf_text = next_emf(wmf, US"intro")))
7789 fprintf(f, "%s", CS wmf_text);
7793 "This message was created automatically by mail delivery software.\n");
7795 if (Ustrcmp(recipients, sender_address) == 0)
7797 "A message that you sent has not yet been delivered to one or more of its\n"
7798 "recipients after more than ");
7802 "A message sent by\n\n <%s>\n\n"
7803 "has not yet been delivered to one or more of its recipients after more than \n",
7806 fprintf(f, "%s on the queue on %s.\n\n"
7807 "The message identifier is: %s\n",
7808 warnmsg_delay, primary_hostname, message_id);
7810 for (h = header_list; h; h = h->next)
7811 if (strncmpic(h->text, US"Subject:", 8) == 0)
7812 fprintf(f, "The subject of the message is: %s", h->text + 9);
7813 else if (strncmpic(h->text, US"Date:", 5) == 0)
7814 fprintf(f, "The date of the message is: %s", h->text + 6);
7817 fprintf(f, "The address%s to which the message has not yet been "
7819 !addr_defer->next ? "" : "es",
7820 !addr_defer->next ? "is": "are");
7823 /* List the addresses, with error information if allowed */
7825 /* store addr_defer for machine readable part */
7826 address_item *addr_dsndefer = addr_defer;
7830 address_item *addr = addr_defer;
7831 addr_defer = addr->next;
7832 if (print_address_information(addr, f, US" ", US"\n ", US""))
7833 print_address_error(addr, f, US"Delay reason: ");
7842 if ((wmf_text = next_emf(wmf, US"final")))
7843 fprintf(f, "%s", CS wmf_text);
7849 "No action is required on your part. Delivery attempts will continue for\n"
7850 "some time, and this warning may be repeated at intervals if the message\n"
7851 "remains undelivered. Eventually the mail delivery software will give up,\n"
7852 "and when that happens, the message will be returned to you.\n");
7855 /* output machine readable part */
7856 fprintf(f, "\n--%s\n"
7857 "Content-type: message/delivery-status\n\n"
7858 "Reporting-MTA: dns; %s\n",
7860 smtp_active_hostname);
7865 /* must be decoded from xtext: see RFC 3461:6.3a */
7867 if (auth_xtextdecode(dsn_envid, &xdec_envid) > 0)
7868 fprintf(f,"Original-Envelope-ID: %s\n", dsn_envid);
7870 fprintf(f,"X-Original-Envelope-ID: error decoding xtext formatted ENVID\n");
7874 for ( ; addr_dsndefer; addr_dsndefer = addr_dsndefer->next)
7876 if (addr_dsndefer->dsn_orcpt)
7877 fprintf(f, "Original-Recipient: %s\n", addr_dsndefer->dsn_orcpt);
7879 fprintf(f, "Action: delayed\n"
7880 "Final-Recipient: rfc822;%s\n"
7882 addr_dsndefer->address);
7883 if (addr_dsndefer->host_used && addr_dsndefer->host_used->name)
7885 fprintf(f, "Remote-MTA: dns; %s\n",
7886 addr_dsndefer->host_used->name);
7887 print_dsn_diagnostic_code(addr_dsndefer, f);
7893 "Content-type: text/rfc822-headers\n\n",
7897 /* header only as required by RFC. only failure DSN needs to honor RET=FULL */
7898 topt = topt_add_return_path | topt_no_body;
7899 transport_filter_argv = NULL; /* Just in case */
7900 return_path = sender_address; /* In case not previously set */
7901 /* Write the original email out */
7902 transport_write_message(NULL, fileno(f), topt, 0, NULL, NULL, NULL, NULL, NULL, 0);
7905 fprintf(f,"\n--%s--\n", bound);
7909 /* Close and wait for child process to complete, without a timeout.
7910 If there's an error, don't update the count. */
7913 if (child_close(pid, 0) == 0)
7915 warning_count = count;
7916 update_spool = TRUE; /* Ensure spool rewritten */
7922 /* Clear deliver_domain */
7924 deliver_domain = NULL;
7926 /* If this was a first delivery attempt, unset the first time flag, and
7927 ensure that the spool gets updated. */
7929 if (deliver_firsttime)
7931 deliver_firsttime = FALSE;
7932 update_spool = TRUE;
7935 /* If delivery was frozen and freeze_tell is set, generate an appropriate
7936 message, unless the message is a local error message (to avoid loops). Then
7937 log the freezing. If the text in "frozen_info" came from a system filter,
7938 it has been escaped into printing characters so as not to mess up log lines.
7939 For the "tell" message, we turn \n back into newline. Also, insert a newline
7940 near the start instead of the ": " string. */
7944 if (freeze_tell && freeze_tell[0] != 0 && !local_error_message)
7946 uschar *s = string_copy(frozen_info);
7947 uschar *ss = Ustrstr(s, " by the system filter: ");
7958 if (*ss == '\\' && ss[1] == 'n')
7965 moan_tell_someone(freeze_tell, addr_defer, US"Message frozen",
7966 "Message %s has been frozen%s.\nThe sender is <%s>.\n", message_id,
7970 /* Log freezing just before we update the -H file, to minimize the chance
7971 of a race problem. */
7973 deliver_msglog("*** Frozen%s\n", frozen_info);
7974 log_write(0, LOG_MAIN, "Frozen%s", frozen_info);
7977 /* If there have been any updates to the non-recipients list, or other things
7978 that get written to the spool, we must now update the spool header file so
7979 that it has the right information for the next delivery attempt. If there
7980 was more than one address being delivered, the header_change update is done
7981 earlier, in case one succeeds and then something crashes. */
7984 debug_printf("delivery deferred: update_spool=%d header_rewritten=%d\n",
7985 update_spool, header_rewritten);
7987 if (update_spool || header_rewritten)
7988 /* Panic-dies on error */
7989 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
7992 /* Finished with the message log. If the message is complete, it will have
7993 been unlinked or renamed above. */
7995 if (message_logs) (void)fclose(message_log);
7997 /* Now we can close and remove the journal file. Its only purpose is to record
7998 successfully completed deliveries asap so that this information doesn't get
7999 lost if Exim (or the machine) crashes. Forgetting about a failed delivery is
8000 not serious, as trying it again is not harmful. The journal might not be open
8001 if all addresses were deferred at routing or directing. Nevertheless, we must
8002 remove it if it exists (may have been lying around from a crash during the
8003 previous delivery attempt). We don't remove the journal if a delivery
8004 subprocess failed to pass back delivery information; this is controlled by
8005 the remove_journal flag. When the journal is left, we also don't move the
8006 message off the main spool if frozen and the option is set. It should get moved
8007 at the next attempt, after the journal has been inspected. */
8009 if (journal_fd >= 0) (void)close(journal_fd);
8013 uschar * fname = spool_fname(US"input", message_subdir, id, US"-J");
8015 if (Uunlink(fname) < 0 && errno != ENOENT)
8016 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s", fname,
8019 /* Move the message off the spool if reqested */
8021 #ifdef SUPPORT_MOVE_FROZEN_MESSAGES
8022 if (deliver_freeze && move_frozen_messages)
8023 (void)spool_move_message(id, message_subdir, US"", US"F");
8027 /* Closing the data file frees the lock; if the file has been unlinked it
8028 will go away. Otherwise the message becomes available for another process
8031 (void)close(deliver_datafile);
8032 deliver_datafile = -1;
8033 DEBUG(D_deliver) debug_printf("end delivery of %s\n", id);
8035 /* It is unlikely that there will be any cached resources, since they are
8036 released after routing, and in the delivery subprocesses. However, it's
8037 possible for an expansion for something afterwards (for example,
8038 expand_check_condition) to do a lookup. We must therefore be sure everything is
8042 acl_where = ACL_WHERE_UNKNOWN;
8051 if (!regex_PIPELINING) regex_PIPELINING =
8052 regex_must_compile(US"\\n250[\\s\\-]PIPELINING(\\s|\\n|$)", FALSE, TRUE);
8054 if (!regex_SIZE) regex_SIZE =
8055 regex_must_compile(US"\\n250[\\s\\-]SIZE(\\s|\\n|$)", FALSE, TRUE);
8057 if (!regex_AUTH) regex_AUTH =
8058 regex_must_compile(US"\\n250[\\s\\-]AUTH\\s+([\\-\\w\\s]+)(?:\\n|$)",
8062 if (!regex_STARTTLS) regex_STARTTLS =
8063 regex_must_compile(US"\\n250[\\s\\-]STARTTLS(\\s|\\n|$)", FALSE, TRUE);
8066 #ifndef DISABLE_PRDR
8067 if (!regex_PRDR) regex_PRDR =
8068 regex_must_compile(US"\\n250[\\s\\-]PRDR(\\s|\\n|$)", FALSE, TRUE);
8072 if (!regex_UTF8) regex_UTF8 =
8073 regex_must_compile(US"\\n250[\\s\\-]SMTPUTF8(\\s|\\n|$)", FALSE, TRUE);
8076 if (!regex_DSN) regex_DSN =
8077 regex_must_compile(US"\\n250[\\s\\-]DSN(\\s|\\n|$)", FALSE, TRUE);
8079 if (!regex_IGNOREQUOTA) regex_IGNOREQUOTA =
8080 regex_must_compile(US"\\n250[\\s\\-]IGNOREQUOTA(\\s|\\n|$)", FALSE, TRUE);
8085 deliver_get_sender_address (uschar * id)
8088 uschar * new_sender_address,
8089 * save_sender_address;
8090 BOOL save_qr = queue_running;
8093 /* make spool_open_datafile non-noisy on fail */
8095 queue_running = TRUE;
8097 /* Side effect: message_subdir is set for the (possibly split) spool directory */
8099 deliver_datafile = spool_open_datafile(id);
8100 queue_running = save_qr;
8101 if (deliver_datafile < 0)
8104 /* Save and restore the global sender_address. I'm not sure if we should
8105 not save/restore all the other global variables too, because
8106 spool_read_header() may change all of them. But OTOH, when this
8107 deliver_get_sender_address() gets called, the current message is done
8108 already and nobody needs the globals anymore. (HS12, 2015-08-21) */
8110 spoolname = string_sprintf("%s-H", id);
8111 save_sender_address = sender_address;
8113 rc = spool_read_header(spoolname, TRUE, TRUE);
8115 new_sender_address = sender_address;
8116 sender_address = save_sender_address;
8118 if (rc != spool_read_OK)
8121 assert(new_sender_address);
8123 (void)close(deliver_datafile);
8124 deliver_datafile = -1;
8126 return new_sender_address;
8131 /* End of deliver.c */