1 /*************************************************
2 * Exim - an Internet mail transport agent *
3 *************************************************/
5 /* Copyright (c) University of Cambridge 1995 - 2015 */
6 /* See the file NOTICE for conditions of use and distribution. */
8 /* The main code for delivering a message. */
14 /* Data block for keeping track of subprocesses for parallel remote
17 typedef struct pardata {
18 address_item *addrlist; /* chain of addresses */
19 address_item *addr; /* next address data expected for */
20 pid_t pid; /* subprocess pid */
21 int fd; /* pipe fd for getting result from subprocess */
22 int transport_count; /* returned transport count value */
23 BOOL done; /* no more data needed */
24 uschar *msg; /* error message */
25 uschar *return_path; /* return_path for these addresses */
28 /* Values for the process_recipients variable */
30 enum { RECIP_ACCEPT, RECIP_IGNORE, RECIP_DEFER,
31 RECIP_FAIL, RECIP_FAIL_FILTER, RECIP_FAIL_TIMEOUT,
34 /* Mutually recursive functions for marking addresses done. */
36 static void child_done(address_item *, uschar *);
37 static void address_done(address_item *, uschar *);
39 /* Table for turning base-62 numbers into binary */
41 static uschar tab62[] =
42 {0,1,2,3,4,5,6,7,8,9,0,0,0,0,0,0, /* 0-9 */
43 0,10,11,12,13,14,15,16,17,18,19,20, /* A-K */
44 21,22,23,24,25,26,27,28,29,30,31,32, /* L-W */
45 33,34,35, 0, 0, 0, 0, 0, /* X-Z */
46 0,36,37,38,39,40,41,42,43,44,45,46, /* a-k */
47 47,48,49,50,51,52,53,54,55,56,57,58, /* l-w */
51 /*************************************************
52 * Local static variables *
53 *************************************************/
55 /* addr_duplicate is global because it needs to be seen from the Envelope-To
58 static address_item *addr_defer = NULL;
59 static address_item *addr_failed = NULL;
60 static address_item *addr_fallback = NULL;
61 static address_item *addr_local = NULL;
62 static address_item *addr_new = NULL;
63 static address_item *addr_remote = NULL;
64 static address_item *addr_route = NULL;
65 static address_item *addr_succeed = NULL;
66 static address_item *addr_dsntmp = NULL;
67 static address_item *addr_senddsn = NULL;
69 static FILE *message_log = NULL;
70 static BOOL update_spool;
71 static BOOL remove_journal;
72 static int parcount = 0;
73 static pardata *parlist = NULL;
74 static int return_count;
75 static uschar *frozen_info = US"";
76 static uschar *used_return_path = NULL;
78 static uschar spoolname[PATH_MAX];
82 /*************************************************
83 * Make a new address item *
84 *************************************************/
86 /* This function gets the store and initializes with default values. The
87 transport_return value defaults to DEFER, so that any unexpected failure to
88 deliver does not wipe out the message. The default unique string is set to a
89 copy of the address, so that its domain can be lowercased.
92 address the RFC822 address string
93 copy force a copy of the address
95 Returns: a pointer to an initialized address_item
99 deliver_make_addr(uschar *address, BOOL copy)
101 address_item *addr = store_get(sizeof(address_item));
102 *addr = address_defaults;
103 if (copy) address = string_copy(address);
104 addr->address = address;
105 addr->unique = string_copy(address);
112 /*************************************************
113 * Set expansion values for an address *
114 *************************************************/
116 /* Certain expansion variables are valid only when handling an address or
117 address list. This function sets them up or clears the values, according to its
121 addr the address in question, or NULL to clear values
126 deliver_set_expansions(address_item *addr)
130 const uschar ***p = address_expansions;
131 while (*p != NULL) **p++ = NULL;
135 /* Exactly what gets set depends on whether there is one or more addresses, and
136 what they contain. These first ones are always set, taking their values from
137 the first address. */
139 if (addr->host_list == NULL)
141 deliver_host = deliver_host_address = US"";
142 deliver_host_port = 0;
146 deliver_host = addr->host_list->name;
147 deliver_host_address = addr->host_list->address;
148 deliver_host_port = addr->host_list->port;
151 deliver_recipients = addr;
152 deliver_address_data = addr->prop.address_data;
153 deliver_domain_data = addr->prop.domain_data;
154 deliver_localpart_data = addr->prop.localpart_data;
156 /* These may be unset for multiple addresses */
158 deliver_domain = addr->domain;
159 self_hostname = addr->self_hostname;
161 #ifdef EXPERIMENTAL_BRIGHTMAIL
162 bmi_deliver = 1; /* deliver by default */
163 bmi_alt_location = NULL;
164 bmi_base64_verdict = NULL;
165 bmi_base64_tracker_verdict = NULL;
168 /* If there's only one address we can set everything. */
170 if (addr->next == NULL)
172 address_item *addr_orig;
174 deliver_localpart = addr->local_part;
175 deliver_localpart_prefix = addr->prefix;
176 deliver_localpart_suffix = addr->suffix;
178 for (addr_orig = addr; addr_orig->parent != NULL;
179 addr_orig = addr_orig->parent);
180 deliver_domain_orig = addr_orig->domain;
182 /* Re-instate any prefix and suffix in the original local part. In all
183 normal cases, the address will have a router associated with it, and we can
184 choose the caseful or caseless version accordingly. However, when a system
185 filter sets up a pipe, file, or autoreply delivery, no router is involved.
186 In this case, though, there won't be any prefix or suffix to worry about. */
188 deliver_localpart_orig = (addr_orig->router == NULL)? addr_orig->local_part :
189 addr_orig->router->caseful_local_part?
190 addr_orig->cc_local_part : addr_orig->lc_local_part;
192 /* If there's a parent, make its domain and local part available, and if
193 delivering to a pipe or file, or sending an autoreply, get the local
194 part from the parent. For pipes and files, put the pipe or file string
195 into address_pipe and address_file. */
197 if (addr->parent != NULL)
199 deliver_domain_parent = addr->parent->domain;
200 deliver_localpart_parent = (addr->parent->router == NULL)?
201 addr->parent->local_part :
202 addr->parent->router->caseful_local_part?
203 addr->parent->cc_local_part : addr->parent->lc_local_part;
205 /* File deliveries have their own flag because they need to be picked out
206 as special more often. */
208 if (testflag(addr, af_pfr))
210 if (testflag(addr, af_file)) address_file = addr->local_part;
211 else if (deliver_localpart[0] == '|') address_pipe = addr->local_part;
212 deliver_localpart = addr->parent->local_part;
213 deliver_localpart_prefix = addr->parent->prefix;
214 deliver_localpart_suffix = addr->parent->suffix;
218 #ifdef EXPERIMENTAL_BRIGHTMAIL
219 /* Set expansion variables related to Brightmail AntiSpam */
220 bmi_base64_verdict = bmi_get_base64_verdict(deliver_localpart_orig, deliver_domain_orig);
221 bmi_base64_tracker_verdict = bmi_get_base64_tracker_verdict(bmi_base64_verdict);
222 /* get message delivery status (0 - don't deliver | 1 - deliver) */
223 bmi_deliver = bmi_get_delivery_status(bmi_base64_verdict);
224 /* if message is to be delivered, get eventual alternate location */
225 if (bmi_deliver == 1) {
226 bmi_alt_location = bmi_get_alt_location(bmi_base64_verdict);
232 /* For multiple addresses, don't set local part, and leave the domain and
233 self_hostname set only if it is the same for all of them. It is possible to
234 have multiple pipe and file addresses, but only when all addresses have routed
235 to the same pipe or file. */
240 if (testflag(addr, af_pfr))
242 if (testflag(addr, af_file)) address_file = addr->local_part;
243 else if (addr->local_part[0] == '|') address_pipe = addr->local_part;
245 for (addr2 = addr->next; addr2 != NULL; addr2 = addr2->next)
247 if (deliver_domain != NULL &&
248 Ustrcmp(deliver_domain, addr2->domain) != 0)
249 deliver_domain = NULL;
250 if (self_hostname != NULL && (addr2->self_hostname == NULL ||
251 Ustrcmp(self_hostname, addr2->self_hostname) != 0))
252 self_hostname = NULL;
253 if (deliver_domain == NULL && self_hostname == NULL) break;
261 /*************************************************
262 * Open a msglog file *
263 *************************************************/
265 /* This function is used both for normal message logs, and for files in the
266 msglog directory that are used to catch output from pipes. Try to create the
267 directory if it does not exist. From release 4.21, normal message logs should
268 be created when the message is received.
271 filename the file name
272 mode the mode required
273 error used for saying what failed
275 Returns: a file descriptor, or -1 (with errno set)
279 open_msglog_file(uschar *filename, int mode, uschar **error)
281 int fd = Uopen(filename, O_WRONLY|O_APPEND|O_CREAT, mode);
283 if (fd < 0 && errno == ENOENT)
286 sprintf(CS temp, "msglog/%s", message_subdir);
287 if (message_subdir[0] == 0) temp[6] = 0;
288 (void)directory_make(spool_directory, temp, MSGLOG_DIRECTORY_MODE, TRUE);
289 fd = Uopen(filename, O_WRONLY|O_APPEND|O_CREAT, mode);
292 /* Set the close-on-exec flag and change the owner to the exim uid/gid (this
293 function is called as root). Double check the mode, because the group setting
294 doesn't always get set automatically. */
298 (void)fcntl(fd, F_SETFD, fcntl(fd, F_GETFD) | FD_CLOEXEC);
299 if (fchown(fd, exim_uid, exim_gid) < 0)
304 if (fchmod(fd, mode) < 0)
310 else *error = US"create";
318 /*************************************************
319 * Write to msglog if required *
320 *************************************************/
322 /* Write to the message log, if configured. This function may also be called
326 format a string format
332 deliver_msglog(const char *format, ...)
335 if (!message_logs) return;
336 va_start(ap, format);
337 vfprintf(message_log, format, ap);
345 /*************************************************
346 * Replicate status for batch *
347 *************************************************/
349 /* When a transport handles a batch of addresses, it may treat them
350 individually, or it may just put the status in the first one, and return FALSE,
351 requesting that the status be copied to all the others externally. This is the
352 replication function. As well as the status, it copies the transport pointer,
353 which may have changed if appendfile passed the addresses on to a different
356 Argument: pointer to the first address in a chain
361 replicate_status(address_item *addr)
364 for (addr2 = addr->next; addr2 != NULL; addr2 = addr2->next)
366 addr2->transport = addr->transport;
367 addr2->transport_return = addr->transport_return;
368 addr2->basic_errno = addr->basic_errno;
369 addr2->more_errno = addr->more_errno;
370 addr2->special_action = addr->special_action;
371 addr2->message = addr->message;
372 addr2->user_message = addr->user_message;
378 /*************************************************
379 * Compare lists of hosts *
380 *************************************************/
382 /* This function is given two pointers to chains of host items, and it yields
383 TRUE if the lists refer to the same hosts in the same order, except that
385 (1) Multiple hosts with the same non-negative MX values are permitted to appear
386 in different orders. Round-robinning nameservers can cause this to happen.
388 (2) Multiple hosts with the same negative MX values less than MX_NONE are also
389 permitted to appear in different orders. This is caused by randomizing
392 This enables Exim to use a single SMTP transaction for sending to two entirely
393 different domains that happen to end up pointing at the same hosts.
396 one points to the first host list
397 two points to the second host list
399 Returns: TRUE if the lists refer to the same host set
403 same_hosts(host_item *one, host_item *two)
405 while (one != NULL && two != NULL)
407 if (Ustrcmp(one->name, two->name) != 0)
410 host_item *end_one = one;
411 host_item *end_two = two;
413 /* Batch up only if there was no MX and the list was not randomized */
415 if (mx == MX_NONE) return FALSE;
417 /* Find the ends of the shortest sequence of identical MX values */
419 while (end_one->next != NULL && end_one->next->mx == mx &&
420 end_two->next != NULL && end_two->next->mx == mx)
422 end_one = end_one->next;
423 end_two = end_two->next;
426 /* If there aren't any duplicates, there's no match. */
428 if (end_one == one) return FALSE;
430 /* For each host in the 'one' sequence, check that it appears in the 'two'
431 sequence, returning FALSE if not. */
436 for (hi = two; hi != end_two->next; hi = hi->next)
437 if (Ustrcmp(one->name, hi->name) == 0) break;
438 if (hi == end_two->next) return FALSE;
439 if (one == end_one) break;
443 /* All the hosts in the 'one' sequence were found in the 'two' sequence.
444 Ensure both are pointing at the last host, and carry on as for equality. */
455 /* True if both are NULL */
462 /*************************************************
463 * Compare header lines *
464 *************************************************/
466 /* This function is given two pointers to chains of header items, and it yields
467 TRUE if they are the same header texts in the same order.
470 one points to the first header list
471 two points to the second header list
473 Returns: TRUE if the lists refer to the same header set
477 same_headers(header_line *one, header_line *two)
481 if (one == two) return TRUE; /* Includes the case where both NULL */
482 if (one == NULL || two == NULL) return FALSE;
483 if (Ustrcmp(one->text, two->text) != 0) return FALSE;
491 /*************************************************
492 * Compare string settings *
493 *************************************************/
495 /* This function is given two pointers to strings, and it returns
496 TRUE if they are the same pointer, or if the two strings are the same.
499 one points to the first string
500 two points to the second string
502 Returns: TRUE or FALSE
506 same_strings(uschar *one, uschar *two)
508 if (one == two) return TRUE; /* Includes the case where both NULL */
509 if (one == NULL || two == NULL) return FALSE;
510 return (Ustrcmp(one, two) == 0);
515 /*************************************************
516 * Compare uid/gid for addresses *
517 *************************************************/
519 /* This function is given a transport and two addresses. It yields TRUE if the
520 uid/gid/initgroups settings for the two addresses are going to be the same when
525 addr1 the first address
526 addr2 the second address
528 Returns: TRUE or FALSE
532 same_ugid(transport_instance *tp, address_item *addr1, address_item *addr2)
534 if (!tp->uid_set && tp->expand_uid == NULL && !tp->deliver_as_creator)
536 if (testflag(addr1, af_uid_set) != testflag(addr2, af_gid_set) ||
537 (testflag(addr1, af_uid_set) &&
538 (addr1->uid != addr2->uid ||
539 testflag(addr1, af_initgroups) != testflag(addr2, af_initgroups))))
543 if (!tp->gid_set && tp->expand_gid == NULL)
545 if (testflag(addr1, af_gid_set) != testflag(addr2, af_gid_set) ||
546 (testflag(addr1, af_gid_set) && addr1->gid != addr2->gid))
556 /*************************************************
557 * Record that an address is complete *
558 *************************************************/
560 /* This function records that an address is complete. This is straightforward
561 for most addresses, where the unique address is just the full address with the
562 domain lower cased. For homonyms (addresses that are the same as one of their
563 ancestors) their are complications. Their unique addresses have \x\ prepended
564 (where x = 0, 1, 2...), so that de-duplication works correctly for siblings and
567 Exim used to record the unique addresses of homonyms as "complete". This,
568 however, fails when the pattern of redirection varies over time (e.g. if taking
569 unseen copies at only some times of day) because the prepended numbers may vary
570 from one delivery run to the next. This problem is solved by never recording
571 prepended unique addresses as complete. Instead, when a homonymic address has
572 actually been delivered via a transport, we record its basic unique address
573 followed by the name of the transport. This is checked in subsequent delivery
574 runs whenever an address is routed to a transport.
576 If the completed address is a top-level one (has no parent, which means it
577 cannot be homonymic) we also add the original address to the non-recipients
578 tree, so that it gets recorded in the spool file and therefore appears as
579 "done" in any spool listings. The original address may differ from the unique
580 address in the case of the domain.
582 Finally, this function scans the list of duplicates, marks as done any that
583 match this address, and calls child_done() for their ancestors.
586 addr address item that has been completed
587 now current time as a string
593 address_done(address_item *addr, uschar *now)
597 update_spool = TRUE; /* Ensure spool gets updated */
599 /* Top-level address */
601 if (addr->parent == NULL)
603 tree_add_nonrecipient(addr->unique);
604 tree_add_nonrecipient(addr->address);
607 /* Homonymous child address */
609 else if (testflag(addr, af_homonym))
611 if (addr->transport != NULL)
613 tree_add_nonrecipient(
614 string_sprintf("%s/%s", addr->unique + 3, addr->transport->name));
618 /* Non-homonymous child address */
620 else tree_add_nonrecipient(addr->unique);
622 /* Check the list of duplicate addresses and ensure they are now marked
625 for (dup = addr_duplicate; dup != NULL; dup = dup->next)
627 if (Ustrcmp(addr->unique, dup->unique) == 0)
629 tree_add_nonrecipient(dup->unique);
630 child_done(dup, now);
638 /*************************************************
639 * Decrease counts in parents and mark done *
640 *************************************************/
642 /* This function is called when an address is complete. If there is a parent
643 address, its count of children is decremented. If there are still other
644 children outstanding, the function exits. Otherwise, if the count has become
645 zero, address_done() is called to mark the parent and its duplicates complete.
646 Then loop for any earlier ancestors.
649 addr points to the completed address item
650 now the current time as a string, for writing to the message log
656 child_done(address_item *addr, uschar *now)
659 while (addr->parent != NULL)
662 if ((addr->child_count -= 1) > 0) return; /* Incomplete parent */
663 address_done(addr, now);
665 /* Log the completion of all descendents only when there is no ancestor with
666 the same original address. */
668 for (aa = addr->parent; aa != NULL; aa = aa->parent)
669 if (Ustrcmp(aa->address, addr->address) == 0) break;
670 if (aa != NULL) continue;
672 deliver_msglog("%s %s: children all complete\n", now, addr->address);
673 DEBUG(D_deliver) debug_printf("%s: children all complete\n", addr->address);
681 d_hostlog(uschar * s, int * sizep, int * ptrp, address_item * addr)
683 s = string_append(s, sizep, ptrp, 5, US" H=", addr->host_used->name,
684 US" [", addr->host_used->address, US"]");
685 if (LOGGING(outgoing_port))
686 s = string_append(s, sizep, ptrp, 2, US":", string_sprintf("%d",
687 addr->host_used->port));
693 d_tlslog(uschar * s, int * sizep, int * ptrp, address_item * addr)
695 if (LOGGING(tls_cipher) && addr->cipher != NULL)
696 s = string_append(s, sizep, ptrp, 2, US" X=", addr->cipher);
697 if (LOGGING(tls_certificate_verified) && addr->cipher != NULL)
698 s = string_append(s, sizep, ptrp, 2, US" CV=",
699 testflag(addr, af_cert_verified)
701 #ifdef EXPERIMENTAL_DANE
702 testflag(addr, af_dane_verified)
708 if (LOGGING(tls_peerdn) && addr->peerdn != NULL)
709 s = string_append(s, sizep, ptrp, 3, US" DN=\"",
710 string_printing(addr->peerdn), US"\"");
718 #ifdef EXPERIMENTAL_EVENT
720 event_raise(uschar * action, const uschar * event, uschar * ev_data)
726 debug_printf("Event(%s): event_action=|%s| delivery_IP=%s\n",
728 action, deliver_host_address);
731 event_data = ev_data;
733 if (!(s = expand_string(action)) && *expand_string_message)
734 log_write(0, LOG_MAIN|LOG_PANIC,
735 "failed to expand event_action %s in %s: %s\n",
736 event, transport_name, expand_string_message);
738 event_name = event_data = NULL;
740 /* If the expansion returns anything but an empty string, flag for
741 the caller to modify his normal processing
746 debug_printf("Event(%s): event_action returned \"%s\"\n", event, s);
754 msg_event_raise(const uschar * event, const address_item * addr)
756 const uschar * save_domain = deliver_domain;
757 uschar * save_local = deliver_localpart;
758 const uschar * save_host = deliver_host;
760 if (!addr->transport)
763 router_name = addr->router ? addr->router->name : NULL;
764 transport_name = addr->transport->name;
765 deliver_domain = addr->domain;
766 deliver_localpart = addr->local_part;
767 deliver_host = addr->host_used ? addr->host_used->name : NULL;
769 (void) event_raise(addr->transport->event_action, event,
770 addr->host_used || Ustrcmp(addr->transport->driver_name, "lmtp") == 0
771 ? addr->message : NULL);
773 deliver_host = save_host;
774 deliver_localpart = save_local;
775 deliver_domain = save_domain;
776 router_name = transport_name = NULL;
778 #endif /*EXPERIMENTAL_EVENT*/
782 /* If msg is NULL this is a delivery log and logchar is used. Otherwise
783 this is a nonstandard call; no two-character delivery flag is written
784 but sender-host and sender are prefixed and "msg" is inserted in the log line.
787 flags passed to log_write()
790 delivery_log(int flags, address_item * addr, int logchar, uschar * msg)
793 int size = 256; /* Used for a temporary, */
794 int ptr = 0; /* expanding buffer, for */
795 uschar *s; /* building log lines; */
796 void *reset_point; /* released afterwards. */
798 /* Log the delivery on the main log. We use an extensible string to build up
799 the log line, and reset the store afterwards. Remote deliveries should always
800 have a pointer to the host item that succeeded; local deliveries can have a
801 pointer to a single host item in their host list, for use by the transport. */
803 #ifdef EXPERIMENTAL_EVENT
804 /* presume no successful remote delivery */
805 lookup_dnssec_authenticated = NULL;
808 s = reset_point = store_get(size);
810 log_address = string_log_address(addr, LOGGING(all_parents), TRUE);
812 s = string_append(s, &size, &ptr, 3, host_and_ident(TRUE), US" ", log_address);
816 s = string_append(s, &size, &ptr, 2, US"> ", log_address);
819 if (LOGGING(incoming_interface) && sending_ip_address)
820 s = string_append(s, &size, &ptr, 3, US" I=[", sending_ip_address, US"]");
821 /* for the port: string_sprintf("%d", sending_port) */
823 if (LOGGING(sender_on_delivery) || msg)
824 s = string_append(s, &size, &ptr, 3, US" F=<",
825 #ifdef EXPERIMENTAL_INTERNATIONAL
826 testflag(addr, af_utf8_downcvt)
827 ? string_address_utf8_to_alabel(sender_address, NULL)
833 #ifdef EXPERIMENTAL_SRS
834 if(addr->prop.srs_sender)
835 s = string_append(s, &size, &ptr, 3, US" SRS=<", addr->prop.srs_sender, US">");
838 /* You might think that the return path must always be set for a successful
839 delivery; indeed, I did for some time, until this statement crashed. The case
840 when it is not set is for a delivery to /dev/null which is optimised by not
843 if (used_return_path != NULL && LOGGING(return_path_on_delivery))
844 s = string_append(s, &size, &ptr, 3, US" P=<", used_return_path, US">");
847 s = string_append(s, &size, &ptr, 2, US" ", msg);
849 /* For a delivery from a system filter, there may not be a router */
850 if (addr->router != NULL)
851 s = string_append(s, &size, &ptr, 2, US" R=", addr->router->name);
853 s = string_append(s, &size, &ptr, 2, US" T=", addr->transport->name);
855 if (LOGGING(delivery_size))
856 s = string_append(s, &size, &ptr, 2, US" S=",
857 string_sprintf("%d", transport_count));
861 if (addr->transport->info->local)
864 s = string_append(s, &size, &ptr, 2, US" H=", addr->host_list->name);
865 if (addr->shadow_message != NULL)
866 s = string_cat(s, &size, &ptr, addr->shadow_message,
867 Ustrlen(addr->shadow_message));
870 /* Remote delivery */
876 s = d_hostlog(s, &size, &ptr, addr);
877 if (continue_sequence > 1)
878 s = string_cat(s, &size, &ptr, US"*", 1);
880 #ifdef EXPERIMENTAL_EVENT
881 deliver_host_address = addr->host_used->address;
882 deliver_host_port = addr->host_used->port;
883 deliver_host = addr->host_used->name;
885 /* DNS lookup status */
886 lookup_dnssec_authenticated = addr->host_used->dnssec==DS_YES ? US"yes"
887 : addr->host_used->dnssec==DS_NO ? US"no"
893 s = d_tlslog(s, &size, &ptr, addr);
896 if (addr->authenticator)
898 s = string_append(s, &size, &ptr, 2, US" A=", addr->authenticator);
901 s = string_append(s, &size, &ptr, 2, US":", addr->auth_id);
902 if (LOGGING(smtp_mailauth) && addr->auth_sndr)
903 s = string_append(s, &size, &ptr, 2, US":", addr->auth_sndr);
908 if (addr->flags & af_prdr_used)
909 s = string_append(s, &size, &ptr, 1, US" PRDR");
913 /* confirmation message (SMTP (host_used) and LMTP (driver_name)) */
915 if (LOGGING(smtp_confirmation) && addr->message &&
916 (addr->host_used || Ustrcmp(addr->transport->driver_name, "lmtp") == 0))
919 unsigned lim = big_buffer_size < 1024 ? big_buffer_size : 1024;
920 uschar *p = big_buffer;
921 uschar *ss = addr->message;
923 for (i = 0; i < lim && ss[i] != 0; i++) /* limit logged amount */
925 if (ss[i] == '\"' || ss[i] == '\\') *p++ = '\\'; /* quote \ and " */
930 s = string_append(s, &size, &ptr, 2, US" C=", big_buffer);
933 /* Time on queue and actual time taken to deliver */
935 if (LOGGING(queue_time))
936 s = string_append(s, &size, &ptr, 2, US" QT=",
937 readconf_printtime( (int) ((long)time(NULL) - (long)received_time)) );
939 if (LOGGING(deliver_time))
940 s = string_append(s, &size, &ptr, 2, US" DT=",
941 readconf_printtime(addr->more_errno));
943 /* string_cat() always leaves room for the terminator. Release the
944 store we used to build the line after writing it. */
947 log_write(0, flags, "%s", s);
949 #ifdef EXPERIMENTAL_EVENT
950 if (!msg) msg_event_raise(US"msg:delivery", addr);
953 store_reset(reset_point);
959 /*************************************************
960 * Actions at the end of handling an address *
961 *************************************************/
963 /* This is a function for processing a single address when all that can be done
964 with it has been done.
967 addr points to the address block
968 result the result of the delivery attempt
969 logflags flags for log_write() (LOG_MAIN and/or LOG_PANIC)
970 driver_type indicates which type of driver (transport, or router) was last
971 to process the address
972 logchar '=' or '-' for use when logging deliveries with => or ->
978 post_process_one(address_item *addr, int result, int logflags, int driver_type,
981 uschar *now = tod_stamp(tod_log);
982 uschar *driver_kind = NULL;
983 uschar *driver_name = NULL;
986 int size = 256; /* Used for a temporary, */
987 int ptr = 0; /* expanding buffer, for */
988 uschar *s; /* building log lines; */
989 void *reset_point; /* released afterwards. */
991 DEBUG(D_deliver) debug_printf("post-process %s (%d)\n", addr->address, result);
993 /* Set up driver kind and name for logging. Disable logging if the router or
994 transport has disabled it. */
996 if (driver_type == DTYPE_TRANSPORT)
998 if (addr->transport != NULL)
1000 driver_name = addr->transport->name;
1001 driver_kind = US" transport";
1002 disable_logging = addr->transport->disable_logging;
1004 else driver_kind = US"transporting";
1006 else if (driver_type == DTYPE_ROUTER)
1008 if (addr->router != NULL)
1010 driver_name = addr->router->name;
1011 driver_kind = US" router";
1012 disable_logging = addr->router->disable_logging;
1014 else driver_kind = US"routing";
1017 /* If there's an error message set, ensure that it contains only printing
1018 characters - it should, but occasionally things slip in and this at least
1019 stops the log format from getting wrecked. We also scan the message for an LDAP
1020 expansion item that has a password setting, and flatten the password. This is a
1021 fudge, but I don't know a cleaner way of doing this. (If the item is badly
1022 malformed, it won't ever have gone near LDAP.) */
1024 if (addr->message != NULL)
1026 const uschar * s = string_printing(addr->message);
1027 if (s != addr->message)
1028 addr->message = US s;
1029 /* deconst cast ok as string_printing known to have alloc'n'copied */
1030 if (((Ustrstr(addr->message, "failed to expand") != NULL) || (Ustrstr(addr->message, "expansion of ") != NULL)) &&
1031 (Ustrstr(addr->message, "mysql") != NULL ||
1032 Ustrstr(addr->message, "pgsql") != NULL ||
1033 #ifdef EXPERIMENTAL_REDIS
1034 Ustrstr(addr->message, "redis") != NULL ||
1036 Ustrstr(addr->message, "sqlite") != NULL ||
1037 Ustrstr(addr->message, "ldap:") != NULL ||
1038 Ustrstr(addr->message, "ldapdn:") != NULL ||
1039 Ustrstr(addr->message, "ldapm:") != NULL))
1041 addr->message = string_sprintf("Temporary internal error");
1045 /* If we used a transport that has one of the "return_output" options set, and
1046 if it did in fact generate some output, then for return_output we treat the
1047 message as failed if it was not already set that way, so that the output gets
1048 returned to the sender, provided there is a sender to send it to. For
1049 return_fail_output, do this only if the delivery failed. Otherwise we just
1050 unlink the file, and remove the name so that if the delivery failed, we don't
1051 try to send back an empty or unwanted file. The log_output options operate only
1052 on a non-empty file.
1054 In any case, we close the message file, because we cannot afford to leave a
1055 file-descriptor for one address while processing (maybe very many) others. */
1057 if (addr->return_file >= 0 && addr->return_filename != NULL)
1059 BOOL return_output = FALSE;
1060 struct stat statbuf;
1061 (void)EXIMfsync(addr->return_file);
1063 /* If there is no output, do nothing. */
1065 if (fstat(addr->return_file, &statbuf) == 0 && statbuf.st_size > 0)
1067 transport_instance *tb = addr->transport;
1069 /* Handle logging options */
1071 if (tb->log_output || (result == FAIL && tb->log_fail_output) ||
1072 (result == DEFER && tb->log_defer_output))
1075 FILE *f = Ufopen(addr->return_filename, "rb");
1077 log_write(0, LOG_MAIN|LOG_PANIC, "failed to open %s to log output "
1078 "from %s transport: %s", addr->return_filename, tb->name,
1082 s = US Ufgets(big_buffer, big_buffer_size, f);
1085 uschar *p = big_buffer + Ustrlen(big_buffer);
1087 while (p > big_buffer && isspace(p[-1])) p--;
1089 sp = string_printing(big_buffer);
1090 log_write(0, LOG_MAIN, "<%s>: %s transport output: %s",
1091 addr->address, tb->name, sp);
1097 /* Handle returning options, but only if there is an address to return
1100 if (sender_address[0] != 0 || addr->prop.errors_address != NULL)
1102 if (tb->return_output)
1104 addr->transport_return = result = FAIL;
1105 if (addr->basic_errno == 0 && addr->message == NULL)
1106 addr->message = US"return message generated";
1107 return_output = TRUE;
1110 if (tb->return_fail_output && result == FAIL) return_output = TRUE;
1114 /* Get rid of the file unless it might be returned, but close it in
1119 Uunlink(addr->return_filename);
1120 addr->return_filename = NULL;
1121 addr->return_file = -1;
1124 (void)close(addr->return_file);
1127 /* The success case happens only after delivery by a transport. */
1131 addr->next = addr_succeed;
1132 addr_succeed = addr;
1134 /* Call address_done() to ensure that we don't deliver to this address again,
1135 and write appropriate things to the message log. If it is a child address, we
1136 call child_done() to scan the ancestors and mark them complete if this is the
1137 last child to complete. */
1139 address_done(addr, now);
1140 DEBUG(D_deliver) debug_printf("%s delivered\n", addr->address);
1142 if (addr->parent == NULL)
1143 deliver_msglog("%s %s: %s%s succeeded\n", now, addr->address,
1144 driver_name, driver_kind);
1147 deliver_msglog("%s %s <%s>: %s%s succeeded\n", now, addr->address,
1148 addr->parent->address, driver_name, driver_kind);
1149 child_done(addr, now);
1152 /* Certificates for logging (via events) */
1154 tls_out.ourcert = addr->ourcert;
1155 addr->ourcert = NULL;
1156 tls_out.peercert = addr->peercert;
1157 addr->peercert = NULL;
1159 tls_out.cipher = addr->cipher;
1160 tls_out.peerdn = addr->peerdn;
1161 tls_out.ocsp = addr->ocsp;
1162 # ifdef EXPERIMENTAL_DANE
1163 tls_out.dane_verified = testflag(addr, af_dane_verified);
1167 delivery_log(LOG_MAIN, addr, logchar, NULL);
1170 tls_free_cert(&tls_out.ourcert);
1171 tls_free_cert(&tls_out.peercert);
1172 tls_out.cipher = NULL;
1173 tls_out.peerdn = NULL;
1174 tls_out.ocsp = OCSP_NOT_REQ;
1175 # ifdef EXPERIMENTAL_DANE
1176 tls_out.dane_verified = FALSE;
1182 /* Soft failure, or local delivery process failed; freezing may be
1185 else if (result == DEFER || result == PANIC)
1187 if (result == PANIC) logflags |= LOG_PANIC;
1189 /* This puts them on the chain in reverse order. Do not change this, because
1190 the code for handling retries assumes that the one with the retry
1191 information is last. */
1193 addr->next = addr_defer;
1196 /* The only currently implemented special action is to freeze the
1197 message. Logging of this is done later, just before the -H file is
1200 if (addr->special_action == SPECIAL_FREEZE)
1202 deliver_freeze = TRUE;
1203 deliver_frozen_at = time(NULL);
1204 update_spool = TRUE;
1207 /* If doing a 2-stage queue run, we skip writing to either the message
1208 log or the main log for SMTP defers. */
1210 if (!queue_2stage || addr->basic_errno != 0)
1214 /* For errors of the type "retry time not reached" (also remotes skipped
1215 on queue run), logging is controlled by L_retry_defer. Note that this kind
1216 of error number is negative, and all the retry ones are less than any
1219 unsigned int use_log_selector = (addr->basic_errno <= ERRNO_RETRY_BASE)?
1222 /* Build up the line that is used for both the message log and the main
1225 s = reset_point = store_get(size);
1227 /* Create the address string for logging. Must not do this earlier, because
1228 an OK result may be changed to FAIL when a pipe returns text. */
1230 log_address = string_log_address(addr, LOGGING(all_parents), result == OK);
1232 s = string_cat(s, &size, &ptr, log_address, Ustrlen(log_address));
1234 /* Either driver_name contains something and driver_kind contains
1235 " router" or " transport" (note the leading space), or driver_name is
1236 a null string and driver_kind contains "routing" without the leading
1237 space, if all routing has been deferred. When a domain has been held,
1238 so nothing has been done at all, both variables contain null strings. */
1240 if (driver_name == NULL)
1242 if (driver_kind != NULL)
1243 s = string_append(s, &size, &ptr, 2, US" ", driver_kind);
1247 if (driver_kind[1] == 't' && addr->router != NULL)
1248 s = string_append(s, &size, &ptr, 2, US" R=", addr->router->name);
1250 ss[1] = toupper(driver_kind[1]);
1251 s = string_append(s, &size, &ptr, 2, ss, driver_name);
1254 sprintf(CS ss, " defer (%d)", addr->basic_errno);
1255 s = string_cat(s, &size, &ptr, ss, Ustrlen(ss));
1257 if (addr->basic_errno > 0)
1258 s = string_append(s, &size, &ptr, 2, US": ",
1259 US strerror(addr->basic_errno));
1261 if (addr->host_used)
1262 s = string_append(s, &size, &ptr, 5,
1263 US" H=", addr->host_used->name,
1264 US" [", addr->host_used->address, US"]");
1266 if (addr->message != NULL)
1267 s = string_append(s, &size, &ptr, 2, US": ", addr->message);
1271 /* Log the deferment in the message log, but don't clutter it
1272 up with retry-time defers after the first delivery attempt. */
1274 if (deliver_firsttime || addr->basic_errno > ERRNO_RETRY_BASE)
1275 deliver_msglog("%s %s\n", now, s);
1277 /* Write the main log and reset the store */
1279 log_write(use_log_selector, logflags, "== %s", s);
1280 store_reset(reset_point);
1285 /* Hard failure. If there is an address to which an error message can be sent,
1286 put this address on the failed list. If not, put it on the deferred list and
1287 freeze the mail message for human attention. The latter action can also be
1288 explicitly requested by a router or transport. */
1292 /* If this is a delivery error, or a message for which no replies are
1293 wanted, and the message's age is greater than ignore_bounce_errors_after,
1294 force the af_ignore_error flag. This will cause the address to be discarded
1295 later (with a log entry). */
1297 if (sender_address[0] == 0 && message_age >= ignore_bounce_errors_after)
1298 setflag(addr, af_ignore_error);
1300 /* Freeze the message if requested, or if this is a bounce message (or other
1301 message with null sender) and this address does not have its own errors
1302 address. However, don't freeze if errors are being ignored. The actual code
1303 to ignore occurs later, instead of sending a message. Logging of freezing
1304 occurs later, just before writing the -H file. */
1306 if (!testflag(addr, af_ignore_error) &&
1307 (addr->special_action == SPECIAL_FREEZE ||
1308 (sender_address[0] == 0 && addr->prop.errors_address == NULL)
1311 frozen_info = (addr->special_action == SPECIAL_FREEZE)? US"" :
1312 (sender_local && !local_error_message)?
1313 US" (message created with -f <>)" : US" (delivery error message)";
1314 deliver_freeze = TRUE;
1315 deliver_frozen_at = time(NULL);
1316 update_spool = TRUE;
1318 /* The address is put on the defer rather than the failed queue, because
1319 the message is being retained. */
1321 addr->next = addr_defer;
1325 /* Don't put the address on the nonrecipients tree yet; wait until an
1326 error message has been successfully sent. */
1330 addr->next = addr_failed;
1334 /* Build up the log line for the message and main logs */
1336 s = reset_point = store_get(size);
1338 /* Create the address string for logging. Must not do this earlier, because
1339 an OK result may be changed to FAIL when a pipe returns text. */
1341 log_address = string_log_address(addr, LOGGING(all_parents), result == OK);
1343 s = string_cat(s, &size, &ptr, log_address, Ustrlen(log_address));
1345 if (LOGGING(sender_on_delivery))
1346 s = string_append(s, &size, &ptr, 3, US" F=<", sender_address, US">");
1348 /* Return path may not be set if no delivery actually happened */
1350 if (used_return_path != NULL && LOGGING(return_path_on_delivery))
1351 s = string_append(s, &size, &ptr, 3, US" P=<", used_return_path, US">");
1353 if (addr->router != NULL)
1354 s = string_append(s, &size, &ptr, 2, US" R=", addr->router->name);
1355 if (addr->transport != NULL)
1356 s = string_append(s, &size, &ptr, 2, US" T=", addr->transport->name);
1358 if (addr->host_used != NULL)
1359 s = d_hostlog(s, &size, &ptr, addr);
1362 s = d_tlslog(s, &size, &ptr, addr);
1365 if (addr->basic_errno > 0)
1366 s = string_append(s, &size, &ptr, 2, US": ",
1367 US strerror(addr->basic_errno));
1369 if (addr->message != NULL)
1370 s = string_append(s, &size, &ptr, 2, US": ", addr->message);
1374 /* Do the logging. For the message log, "routing failed" for those cases,
1375 just to make it clearer. */
1377 if (driver_name == NULL)
1378 deliver_msglog("%s %s failed for %s\n", now, driver_kind, s);
1380 deliver_msglog("%s %s\n", now, s);
1382 log_write(0, LOG_MAIN, "** %s", s);
1384 #ifdef EXPERIMENTAL_EVENT
1385 msg_event_raise(US"msg:fail:delivery", addr);
1388 store_reset(reset_point);
1391 /* Ensure logging is turned on again in all cases */
1393 disable_logging = FALSE;
1399 /*************************************************
1400 * Address-independent error *
1401 *************************************************/
1403 /* This function is called when there's an error that is not dependent on a
1404 particular address, such as an expansion string failure. It puts the error into
1405 all the addresses in a batch, logs the incident on the main and panic logs, and
1406 clears the expansions. It is mostly called from local_deliver(), but can be
1407 called for a remote delivery via findugid().
1410 logit TRUE if (MAIN+PANIC) logging required
1411 addr the first of the chain of addresses
1413 format format string for error message, or NULL if already set in addr
1414 ... arguments for the format
1420 common_error(BOOL logit, address_item *addr, int code, uschar *format, ...)
1422 address_item *addr2;
1423 addr->basic_errno = code;
1429 va_start(ap, format);
1430 if (!string_vformat(buffer, sizeof(buffer), CS format, ap))
1431 log_write(0, LOG_MAIN|LOG_PANIC_DIE,
1432 "common_error expansion was longer than " SIZE_T_FMT, sizeof(buffer));
1434 addr->message = string_copy(buffer);
1437 for (addr2 = addr->next; addr2 != NULL; addr2 = addr2->next)
1439 addr2->basic_errno = code;
1440 addr2->message = addr->message;
1443 if (logit) log_write(0, LOG_MAIN|LOG_PANIC, "%s", addr->message);
1444 deliver_set_expansions(NULL);
1450 /*************************************************
1451 * Check a "never users" list *
1452 *************************************************/
1454 /* This function is called to check whether a uid is on one of the two "never
1458 uid the uid to be checked
1459 nusers the list to be scanned; the first item in the list is the count
1461 Returns: TRUE if the uid is on the list
1465 check_never_users(uid_t uid, uid_t *nusers)
1468 if (nusers == NULL) return FALSE;
1469 for (i = 1; i <= (int)(nusers[0]); i++) if (nusers[i] == uid) return TRUE;
1475 /*************************************************
1476 * Find uid and gid for a transport *
1477 *************************************************/
1479 /* This function is called for both local and remote deliveries, to find the
1480 uid/gid under which to run the delivery. The values are taken preferentially
1481 from the transport (either explicit or deliver_as_creator), then from the
1482 address (i.e. the router), and if nothing is set, the exim uid/gid are used. If
1483 the resulting uid is on the "never_users" or the "fixed_never_users" list, a
1484 panic error is logged, and the function fails (which normally leads to delivery
1488 addr the address (possibly a chain)
1490 uidp pointer to uid field
1491 gidp pointer to gid field
1492 igfp pointer to the use_initgroups field
1494 Returns: FALSE if failed - error has been set in address(es)
1498 findugid(address_item *addr, transport_instance *tp, uid_t *uidp, gid_t *gidp,
1501 uschar *nuname = NULL;
1502 BOOL gid_set = FALSE;
1504 /* Default initgroups flag comes from the transport */
1506 *igfp = tp->initgroups;
1508 /* First see if there's a gid on the transport, either fixed or expandable.
1509 The expanding function always logs failure itself. */
1516 else if (tp->expand_gid != NULL)
1518 if (route_find_expanded_group(tp->expand_gid, tp->name, US"transport", gidp,
1519 &(addr->message))) gid_set = TRUE;
1522 common_error(FALSE, addr, ERRNO_GIDFAIL, NULL);
1527 /* If the transport did not set a group, see if the router did. */
1529 if (!gid_set && testflag(addr, af_gid_set))
1535 /* Pick up a uid from the transport if one is set. */
1537 if (tp->uid_set) *uidp = tp->uid;
1539 /* Otherwise, try for an expandable uid field. If it ends up as a numeric id,
1540 it does not provide a passwd value from which a gid can be taken. */
1542 else if (tp->expand_uid != NULL)
1545 if (!route_find_expanded_user(tp->expand_uid, tp->name, US"transport", &pw,
1546 uidp, &(addr->message)))
1548 common_error(FALSE, addr, ERRNO_UIDFAIL, NULL);
1551 if (!gid_set && pw != NULL)
1558 /* If the transport doesn't set the uid, test the deliver_as_creator flag. */
1560 else if (tp->deliver_as_creator)
1562 *uidp = originator_uid;
1565 *gidp = originator_gid;
1570 /* Otherwise see if the address specifies the uid and if so, take it and its
1573 else if (testflag(addr, af_uid_set))
1576 *igfp = testflag(addr, af_initgroups);
1579 /* Nothing has specified the uid - default to the Exim user, and group if the
1592 /* If no gid is set, it is a disaster. We default to the Exim gid only if
1593 defaulting to the Exim uid. In other words, if the configuration has specified
1594 a uid, it must also provide a gid. */
1598 common_error(TRUE, addr, ERRNO_GIDFAIL, US"User set without group for "
1599 "%s transport", tp->name);
1603 /* Check that the uid is not on the lists of banned uids that may not be used
1604 for delivery processes. */
1606 if (check_never_users(*uidp, never_users))
1607 nuname = US"never_users";
1608 else if (check_never_users(*uidp, fixed_never_users))
1609 nuname = US"fixed_never_users";
1613 common_error(TRUE, addr, ERRNO_UIDFAIL, US"User %ld set for %s transport "
1614 "is on the %s list", (long int)(*uidp), tp->name, nuname);
1626 /*************************************************
1627 * Check the size of a message for a transport *
1628 *************************************************/
1630 /* Checks that the message isn't too big for the selected transport.
1631 This is called only when it is known that the limit is set.
1635 addr the (first) address being delivered
1638 DEFER expansion failed or did not yield an integer
1639 FAIL message too big
1643 check_message_size(transport_instance *tp, address_item *addr)
1648 deliver_set_expansions(addr);
1649 size_limit = expand_string_integer(tp->message_size_limit, TRUE);
1650 deliver_set_expansions(NULL);
1652 if (expand_string_message != NULL)
1655 if (size_limit == -1)
1656 addr->message = string_sprintf("failed to expand message_size_limit "
1657 "in %s transport: %s", tp->name, expand_string_message);
1659 addr->message = string_sprintf("invalid message_size_limit "
1660 "in %s transport: %s", tp->name, expand_string_message);
1662 else if (size_limit > 0 && message_size > size_limit)
1666 string_sprintf("message is too big (transport limit = %d)",
1675 /*************************************************
1676 * Transport-time check for a previous delivery *
1677 *************************************************/
1679 /* Check that this base address hasn't previously been delivered to its routed
1680 transport. If it has been delivered, mark it done. The check is necessary at
1681 delivery time in order to handle homonymic addresses correctly in cases where
1682 the pattern of redirection changes between delivery attempts (so the unique
1683 fields change). Non-homonymic previous delivery is detected earlier, at routing
1684 time (which saves unnecessary routing).
1687 addr the address item
1688 testing TRUE if testing wanted only, without side effects
1690 Returns: TRUE if previously delivered by the transport
1694 previously_transported(address_item *addr, BOOL testing)
1696 (void)string_format(big_buffer, big_buffer_size, "%s/%s",
1697 addr->unique + (testflag(addr, af_homonym)? 3:0), addr->transport->name);
1699 if (tree_search(tree_nonrecipients, big_buffer) != 0)
1701 DEBUG(D_deliver|D_route|D_transport)
1702 debug_printf("%s was previously delivered (%s transport): discarded\n",
1703 addr->address, addr->transport->name);
1704 if (!testing) child_done(addr, tod_stamp(tod_log));
1713 /******************************************************
1714 * Check for a given header in a header string *
1715 ******************************************************/
1717 /* This function is used when generating quota warnings. The configuration may
1718 specify any header lines it likes in quota_warn_message. If certain of them are
1719 missing, defaults are inserted, so we need to be able to test for the presence
1723 hdr the required header name
1724 hstring the header string
1726 Returns: TRUE the header is in the string
1727 FALSE the header is not in the string
1731 contains_header(uschar *hdr, uschar *hstring)
1733 int len = Ustrlen(hdr);
1734 uschar *p = hstring;
1737 if (strncmpic(p, hdr, len) == 0)
1740 while (*p == ' ' || *p == '\t') p++;
1741 if (*p == ':') return TRUE;
1743 while (*p != 0 && *p != '\n') p++;
1744 if (*p == '\n') p++;
1752 /*************************************************
1753 * Perform a local delivery *
1754 *************************************************/
1756 /* Each local delivery is performed in a separate process which sets its
1757 uid and gid as specified. This is a safer way than simply changing and
1758 restoring using seteuid(); there is a body of opinion that seteuid() cannot be
1759 used safely. From release 4, Exim no longer makes any use of it. Besides, not
1760 all systems have seteuid().
1762 If the uid/gid are specified in the transport_instance, they are used; the
1763 transport initialization must ensure that either both or neither are set.
1764 Otherwise, the values associated with the address are used. If neither are set,
1765 it is a configuration error.
1767 The transport or the address may specify a home directory (transport over-
1768 rides), and if they do, this is set as $home. If neither have set a working
1769 directory, this value is used for that as well. Otherwise $home is left unset
1770 and the cwd is set to "/" - a directory that should be accessible to all users.
1772 Using a separate process makes it more complicated to get error information
1773 back. We use a pipe to pass the return code and also an error code and error
1774 text string back to the parent process.
1777 addr points to an address block for this delivery; for "normal" local
1778 deliveries this is the only address to be delivered, but for
1779 pseudo-remote deliveries (e.g. by batch SMTP to a file or pipe)
1780 a number of addresses can be handled simultaneously, and in this
1781 case addr will point to a chain of addresses with the same
1784 shadowing TRUE if running a shadow transport; this causes output from pipes
1791 deliver_local(address_item *addr, BOOL shadowing)
1793 BOOL use_initgroups;
1796 int status, len, rc;
1799 uschar *working_directory;
1800 address_item *addr2;
1801 transport_instance *tp = addr->transport;
1803 /* Set up the return path from the errors or sender address. If the transport
1804 has its own return path setting, expand it and replace the existing value. */
1806 if(addr->prop.errors_address != NULL)
1807 return_path = addr->prop.errors_address;
1808 #ifdef EXPERIMENTAL_SRS
1809 else if(addr->prop.srs_sender != NULL)
1810 return_path = addr->prop.srs_sender;
1813 return_path = sender_address;
1815 if (tp->return_path != NULL)
1817 uschar *new_return_path = expand_string(tp->return_path);
1818 if (new_return_path == NULL)
1820 if (!expand_string_forcedfail)
1822 common_error(TRUE, addr, ERRNO_EXPANDFAIL,
1823 US"Failed to expand return path \"%s\" in %s transport: %s",
1824 tp->return_path, tp->name, expand_string_message);
1828 else return_path = new_return_path;
1831 /* For local deliveries, one at a time, the value used for logging can just be
1832 set directly, once and for all. */
1834 used_return_path = return_path;
1836 /* Sort out the uid, gid, and initgroups flag. If an error occurs, the message
1837 gets put into the address(es), and the expansions are unset, so we can just
1840 if (!findugid(addr, tp, &uid, &gid, &use_initgroups)) return;
1842 /* See if either the transport or the address specifies a home directory. A
1843 home directory set in the address may already be expanded; a flag is set to
1844 indicate that. In other cases we must expand it. */
1846 if ((deliver_home = tp->home_dir) != NULL || /* Set in transport, or */
1847 ((deliver_home = addr->home_dir) != NULL && /* Set in address and */
1848 !testflag(addr, af_home_expanded))) /* not expanded */
1850 uschar *rawhome = deliver_home;
1851 deliver_home = NULL; /* in case it contains $home */
1852 deliver_home = expand_string(rawhome);
1853 if (deliver_home == NULL)
1855 common_error(TRUE, addr, ERRNO_EXPANDFAIL, US"home directory \"%s\" failed "
1856 "to expand for %s transport: %s", rawhome, tp->name,
1857 expand_string_message);
1860 if (*deliver_home != '/')
1862 common_error(TRUE, addr, ERRNO_NOTABSOLUTE, US"home directory path \"%s\" "
1863 "is not absolute for %s transport", deliver_home, tp->name);
1868 /* See if either the transport or the address specifies a current directory,
1869 and if so, expand it. If nothing is set, use the home directory, unless it is
1870 also unset in which case use "/", which is assumed to be a directory to which
1871 all users have access. It is necessary to be in a visible directory for some
1872 operating systems when running pipes, as some commands (e.g. "rm" under Solaris
1873 2.5) require this. */
1875 working_directory = (tp->current_dir != NULL)?
1876 tp->current_dir : addr->current_dir;
1878 if (working_directory != NULL)
1880 uschar *raw = working_directory;
1881 working_directory = expand_string(raw);
1882 if (working_directory == NULL)
1884 common_error(TRUE, addr, ERRNO_EXPANDFAIL, US"current directory \"%s\" "
1885 "failed to expand for %s transport: %s", raw, tp->name,
1886 expand_string_message);
1889 if (*working_directory != '/')
1891 common_error(TRUE, addr, ERRNO_NOTABSOLUTE, US"current directory path "
1892 "\"%s\" is not absolute for %s transport", working_directory, tp->name);
1896 else working_directory = (deliver_home == NULL)? US"/" : deliver_home;
1898 /* If one of the return_output flags is set on the transport, create and open a
1899 file in the message log directory for the transport to write its output onto.
1900 This is mainly used by pipe transports. The file needs to be unique to the
1901 address. This feature is not available for shadow transports. */
1903 if (!shadowing && (tp->return_output || tp->return_fail_output ||
1904 tp->log_output || tp->log_fail_output))
1907 addr->return_filename =
1908 string_sprintf("%s/msglog/%s/%s-%d-%d", spool_directory, message_subdir,
1909 message_id, getpid(), return_count++);
1910 addr->return_file = open_msglog_file(addr->return_filename, 0400, &error);
1911 if (addr->return_file < 0)
1913 common_error(TRUE, addr, errno, US"Unable to %s file for %s transport "
1914 "to return message: %s", error, tp->name, strerror(errno));
1919 /* Create the pipe for inter-process communication. */
1923 common_error(TRUE, addr, ERRNO_PIPEFAIL, US"Creation of pipe failed: %s",
1928 /* Now fork the process to do the real work in the subprocess, but first
1929 ensure that all cached resources are freed so that the subprocess starts with
1930 a clean slate and doesn't interfere with the parent process. */
1934 if ((pid = fork()) == 0)
1936 BOOL replicate = TRUE;
1938 /* Prevent core dumps, as we don't want them in users' home directories.
1939 HP-UX doesn't have RLIMIT_CORE; I don't know how to do this in that
1940 system. Some experimental/developing systems (e.g. GNU/Hurd) may define
1941 RLIMIT_CORE but not support it in setrlimit(). For such systems, do not
1942 complain if the error is "not supported".
1944 There are two scenarios where changing the max limit has an effect. In one,
1945 the user is using a .forward and invoking a command of their choice via pipe;
1946 for these, we do need the max limit to be 0 unless the admin chooses to
1947 permit an increased limit. In the other, the command is invoked directly by
1948 the transport and is under administrator control, thus being able to raise
1949 the limit aids in debugging. So there's no general always-right answer.
1951 Thus we inhibit core-dumps completely but let individual transports, while
1952 still root, re-raise the limits back up to aid debugging. We make the
1953 default be no core-dumps -- few enough people can use core dumps in
1954 diagnosis that it's reasonable to make them something that has to be explicitly requested.
1961 if (setrlimit(RLIMIT_CORE, &rl) < 0)
1963 # ifdef SETRLIMIT_NOT_SUPPORTED
1964 if (errno != ENOSYS && errno != ENOTSUP)
1966 log_write(0, LOG_MAIN|LOG_PANIC, "setrlimit(RLIMIT_CORE) failed: %s",
1971 /* Reset the random number generator, so different processes don't all
1972 have the same sequence. */
1976 /* If the transport has a setup entry, call this first, while still
1977 privileged. (Appendfile uses this to expand quota, for example, while
1978 able to read private files.) */
1980 if (addr->transport->setup != NULL)
1982 switch((addr->transport->setup)(addr->transport, addr, NULL, uid, gid,
1986 addr->transport_return = DEFER;
1990 addr->transport_return = PANIC;
1995 /* Ignore SIGINT and SIGTERM during delivery. Also ignore SIGUSR1, as
1996 when the process becomes unprivileged, it won't be able to write to the
1997 process log. SIGHUP is ignored throughout exim, except when it is being
2000 signal(SIGINT, SIG_IGN);
2001 signal(SIGTERM, SIG_IGN);
2002 signal(SIGUSR1, SIG_IGN);
2004 /* Close the unwanted half of the pipe, and set close-on-exec for the other
2005 half - for transports that exec things (e.g. pipe). Then set the required
2008 (void)close(pfd[pipe_read]);
2009 (void)fcntl(pfd[pipe_write], F_SETFD, fcntl(pfd[pipe_write], F_GETFD) |
2011 exim_setugid(uid, gid, use_initgroups,
2012 string_sprintf("local delivery to %s <%s> transport=%s", addr->local_part,
2013 addr->address, addr->transport->name));
2017 address_item *batched;
2018 debug_printf(" home=%s current=%s\n", deliver_home, working_directory);
2019 for (batched = addr->next; batched != NULL; batched = batched->next)
2020 debug_printf("additional batched address: %s\n", batched->address);
2023 /* Set an appropriate working directory. */
2025 if (Uchdir(working_directory) < 0)
2027 addr->transport_return = DEFER;
2028 addr->basic_errno = errno;
2029 addr->message = string_sprintf("failed to chdir to %s", working_directory);
2032 /* If successful, call the transport */
2037 set_process_info("delivering %s to %s using %s", message_id,
2038 addr->local_part, addr->transport->name);
2040 /* Setting this global in the subprocess means we need never clear it */
2041 transport_name = addr->transport->name;
2043 /* If a transport filter has been specified, set up its argument list.
2044 Any errors will get put into the address, and FALSE yielded. */
2046 if (addr->transport->filter_command != NULL)
2048 ok = transport_set_up_command(&transport_filter_argv,
2049 addr->transport->filter_command,
2050 TRUE, PANIC, addr, US"transport filter", NULL);
2051 transport_filter_timeout = addr->transport->filter_timeout;
2053 else transport_filter_argv = NULL;
2057 debug_print_string(addr->transport->debug_string);
2058 replicate = !(addr->transport->info->code)(addr->transport, addr);
2062 /* Pass the results back down the pipe. If necessary, first replicate the
2063 status in the top address to the others in the batch. The label is the
2064 subject of a goto when a call to the transport's setup function fails. We
2065 pass the pointer to the transport back in case it got changed as a result of
2066 file_format in appendfile. */
2070 if (replicate) replicate_status(addr);
2071 for (addr2 = addr; addr2 != NULL; addr2 = addr2->next)
2074 int local_part_length = Ustrlen(addr2->local_part);
2078 if( (ret = write(pfd[pipe_write], (void *)&(addr2->transport_return), sizeof(int))) != sizeof(int)
2079 || (ret = write(pfd[pipe_write], (void *)&transport_count, sizeof(transport_count))) != sizeof(transport_count)
2080 || (ret = write(pfd[pipe_write], (void *)&(addr2->flags), sizeof(addr2->flags))) != sizeof(addr2->flags)
2081 || (ret = write(pfd[pipe_write], (void *)&(addr2->basic_errno), sizeof(int))) != sizeof(int)
2082 || (ret = write(pfd[pipe_write], (void *)&(addr2->more_errno), sizeof(int))) != sizeof(int)
2083 || (ret = write(pfd[pipe_write], (void *)&(addr2->special_action), sizeof(int))) != sizeof(int)
2084 || (ret = write(pfd[pipe_write], (void *)&(addr2->transport),
2085 sizeof(transport_instance *))) != sizeof(transport_instance *)
2087 /* For a file delivery, pass back the local part, in case the original
2088 was only part of the final delivery path. This gives more complete
2091 || (testflag(addr2, af_file)
2092 && ( (ret = write(pfd[pipe_write], (void *)&local_part_length, sizeof(int))) != sizeof(int)
2093 || (ret = write(pfd[pipe_write], addr2->local_part, local_part_length)) != local_part_length
2097 log_write(0, LOG_MAIN|LOG_PANIC, "Failed writing transport results to pipe: %s\n",
2098 ret == -1 ? strerror(errno) : "short write");
2100 /* Now any messages */
2102 for (i = 0, s = addr2->message; i < 2; i++, s = addr2->user_message)
2104 int message_length = (s == NULL)? 0 : Ustrlen(s) + 1;
2105 if( (ret = write(pfd[pipe_write], (void *)&message_length, sizeof(int))) != sizeof(int)
2106 || (message_length > 0 && (ret = write(pfd[pipe_write], s, message_length)) != message_length)
2108 log_write(0, LOG_MAIN|LOG_PANIC, "Failed writing transport results to pipe: %s\n",
2109 ret == -1 ? strerror(errno) : "short write");
2113 /* OK, this process is now done. Free any cached resources that it opened,
2114 and close the pipe we were writing down before exiting. */
2116 (void)close(pfd[pipe_write]);
2121 /* Back in the main process: panic if the fork did not succeed. This seems
2122 better than returning an error - if forking is failing it is probably best
2123 not to try other deliveries for this message. */
2126 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Fork failed for local delivery to %s",
2129 /* Read the pipe to get the delivery status codes and error messages. Our copy
2130 of the writing end must be closed first, as otherwise read() won't return zero
2131 on an empty pipe. We check that a status exists for each address before
2132 overwriting the address structure. If data is missing, the default DEFER status
2133 will remain. Afterwards, close the reading end. */
2135 (void)close(pfd[pipe_write]);
2137 for (addr2 = addr; addr2 != NULL; addr2 = addr2->next)
2139 len = read(pfd[pipe_read], (void *)&status, sizeof(int));
2145 addr2->transport_return = status;
2146 len = read(pfd[pipe_read], (void *)&transport_count,
2147 sizeof(transport_count));
2148 len = read(pfd[pipe_read], (void *)&(addr2->flags), sizeof(addr2->flags));
2149 len = read(pfd[pipe_read], (void *)&(addr2->basic_errno), sizeof(int));
2150 len = read(pfd[pipe_read], (void *)&(addr2->more_errno), sizeof(int));
2151 len = read(pfd[pipe_read], (void *)&(addr2->special_action), sizeof(int));
2152 len = read(pfd[pipe_read], (void *)&(addr2->transport),
2153 sizeof(transport_instance *));
2155 if (testflag(addr2, af_file))
2157 int local_part_length;
2158 len = read(pfd[pipe_read], (void *)&local_part_length, sizeof(int));
2159 len = read(pfd[pipe_read], (void *)big_buffer, local_part_length);
2160 big_buffer[local_part_length] = 0;
2161 addr2->local_part = string_copy(big_buffer);
2164 for (i = 0, sptr = &(addr2->message); i < 2;
2165 i++, sptr = &(addr2->user_message))
2168 len = read(pfd[pipe_read], (void *)&message_length, sizeof(int));
2169 if (message_length > 0)
2171 len = read(pfd[pipe_read], (void *)big_buffer, message_length);
2172 if (len > 0) *sptr = string_copy(big_buffer);
2179 log_write(0, LOG_MAIN|LOG_PANIC, "failed to read delivery status for %s "
2180 "from delivery subprocess", addr2->unique);
2185 (void)close(pfd[pipe_read]);
2187 /* Unless shadowing, write all successful addresses immediately to the journal
2188 file, to ensure they are recorded asap. For homonymic addresses, use the base
2189 address plus the transport name. Failure to write the journal is panic-worthy,
2190 but don't stop, as it may prove possible subsequently to update the spool file
2191 in order to record the delivery. */
2195 for (addr2 = addr; addr2 != NULL; addr2 = addr2->next)
2197 if (addr2->transport_return != OK) continue;
2199 if (testflag(addr2, af_homonym))
2200 sprintf(CS big_buffer, "%.500s/%s\n", addr2->unique + 3, tp->name);
2202 sprintf(CS big_buffer, "%.500s\n", addr2->unique);
2204 /* In the test harness, wait just a bit to let the subprocess finish off
2205 any debug output etc first. */
2207 if (running_in_test_harness) millisleep(300);
2209 DEBUG(D_deliver) debug_printf("journalling %s", big_buffer);
2210 len = Ustrlen(big_buffer);
2211 if (write(journal_fd, big_buffer, len) != len)
2212 log_write(0, LOG_MAIN|LOG_PANIC, "failed to update journal for %s: %s",
2213 big_buffer, strerror(errno));
2216 /* Ensure the journal file is pushed out to disk. */
2218 if (EXIMfsync(journal_fd) < 0)
2219 log_write(0, LOG_MAIN|LOG_PANIC, "failed to fsync journal: %s",
2223 /* Wait for the process to finish. If it terminates with a non-zero code,
2224 freeze the message (except for SIGTERM, SIGKILL and SIGQUIT), but leave the
2225 status values of all the addresses as they are. Take care to handle the case
2226 when the subprocess doesn't seem to exist. This has been seen on one system
2227 when Exim was called from an MUA that set SIGCHLD to SIG_IGN. When that
2228 happens, wait() doesn't recognize the termination of child processes. Exim now
2229 resets SIGCHLD to SIG_DFL, but this code should still be robust. */
2231 while ((rc = wait(&status)) != pid)
2233 if (rc < 0 && errno == ECHILD) /* Process has vanished */
2235 log_write(0, LOG_MAIN, "%s transport process vanished unexpectedly",
2236 addr->transport->driver_name);
2242 if ((status & 0xffff) != 0)
2244 int msb = (status >> 8) & 255;
2245 int lsb = status & 255;
2246 int code = (msb == 0)? (lsb & 0x7f) : msb;
2247 if (msb != 0 || (code != SIGTERM && code != SIGKILL && code != SIGQUIT))
2248 addr->special_action = SPECIAL_FREEZE;
2249 log_write(0, LOG_MAIN|LOG_PANIC, "%s transport process returned non-zero "
2250 "status 0x%04x: %s %d",
2251 addr->transport->driver_name,
2253 (msb == 0)? "terminated by signal" : "exit code",
2257 /* If SPECIAL_WARN is set in the top address, send a warning message. */
2259 if (addr->special_action == SPECIAL_WARN &&
2260 addr->transport->warn_message != NULL)
2263 uschar *warn_message;
2265 DEBUG(D_deliver) debug_printf("Warning message requested by transport\n");
2267 warn_message = expand_string(addr->transport->warn_message);
2268 if (warn_message == NULL)
2269 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand \"%s\" (warning "
2270 "message for %s transport): %s", addr->transport->warn_message,
2271 addr->transport->name, expand_string_message);
2274 pid_t pid = child_open_exim(&fd);
2277 FILE *f = fdopen(fd, "wb");
2278 if (errors_reply_to != NULL &&
2279 !contains_header(US"Reply-To", warn_message))
2280 fprintf(f, "Reply-To: %s\n", errors_reply_to);
2281 fprintf(f, "Auto-Submitted: auto-replied\n");
2282 if (!contains_header(US"From", warn_message)) moan_write_from(f);
2283 fprintf(f, "%s", CS warn_message);
2285 /* Close and wait for child process to complete, without a timeout. */
2288 (void)child_close(pid, 0);
2292 addr->special_action = SPECIAL_NONE;
2298 /*************************************************
2299 * Do local deliveries *
2300 *************************************************/
2302 /* This function processes the list of addresses in addr_local. True local
2303 deliveries are always done one address at a time. However, local deliveries can
2304 be batched up in some cases. Typically this is when writing batched SMTP output
2305 files for use by some external transport mechanism, or when running local
2306 deliveries over LMTP.
2313 do_local_deliveries(void)
2316 open_db *dbm_file = NULL;
2317 time_t now = time(NULL);
2319 /* Loop until we have exhausted the supply of local deliveries */
2321 while (addr_local != NULL)
2323 time_t delivery_start;
2325 address_item *addr2, *addr3, *nextaddr;
2326 int logflags = LOG_MAIN;
2327 int logchar = dont_deliver? '*' : '=';
2328 transport_instance *tp;
2330 /* Pick the first undelivered address off the chain */
2332 address_item *addr = addr_local;
2333 addr_local = addr->next;
2336 DEBUG(D_deliver|D_transport)
2337 debug_printf("--------> %s <--------\n", addr->address);
2339 /* An internal disaster if there is no transport. Should not occur! */
2341 if ((tp = addr->transport) == NULL)
2343 logflags |= LOG_PANIC;
2344 disable_logging = FALSE; /* Jic */
2346 (addr->router != NULL)?
2347 string_sprintf("No transport set by %s router", addr->router->name)
2349 string_sprintf("No transport set by system filter");
2350 post_process_one(addr, DEFER, logflags, DTYPE_TRANSPORT, 0);
2354 /* Check that this base address hasn't previously been delivered to this
2355 transport. The check is necessary at this point to handle homonymic addresses
2356 correctly in cases where the pattern of redirection changes between delivery
2357 attempts. Non-homonymic previous delivery is detected earlier, at routing
2360 if (previously_transported(addr, FALSE)) continue;
2362 /* There are weird cases where logging is disabled */
2364 disable_logging = tp->disable_logging;
2366 /* Check for batched addresses and possible amalgamation. Skip all the work
2367 if either batch_max <= 1 or there aren't any other addresses for local
2370 if (tp->batch_max > 1 && addr_local != NULL)
2372 int batch_count = 1;
2373 BOOL uses_dom = readconf_depends((driver_instance *)tp, US"domain");
2374 BOOL uses_lp = (testflag(addr, af_pfr) &&
2375 (testflag(addr, af_file) || addr->local_part[0] == '|')) ||
2376 readconf_depends((driver_instance *)tp, US"local_part");
2377 uschar *batch_id = NULL;
2378 address_item **anchor = &addr_local;
2379 address_item *last = addr;
2382 /* Expand the batch_id string for comparison with other addresses.
2383 Expansion failure suppresses batching. */
2385 if (tp->batch_id != NULL)
2387 deliver_set_expansions(addr);
2388 batch_id = expand_string(tp->batch_id);
2389 deliver_set_expansions(NULL);
2390 if (batch_id == NULL)
2392 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand batch_id option "
2393 "in %s transport (%s): %s", tp->name, addr->address,
2394 expand_string_message);
2395 batch_count = tp->batch_max;
2399 /* Until we reach the batch_max limit, pick off addresses which have the
2400 same characteristics. These are:
2403 not previously delivered (see comment about 50 lines above)
2404 same local part if the transport's configuration contains $local_part
2405 or if this is a file or pipe delivery from a redirection
2406 same domain if the transport's configuration contains $domain
2408 same additional headers
2409 same headers to be removed
2410 same uid/gid for running the transport
2411 same first host if a host list is set
2414 while ((next = *anchor) != NULL && batch_count < tp->batch_max)
2417 tp == next->transport &&
2418 !previously_transported(next, TRUE) &&
2419 (addr->flags & (af_pfr|af_file)) == (next->flags & (af_pfr|af_file)) &&
2420 (!uses_lp || Ustrcmp(next->local_part, addr->local_part) == 0) &&
2421 (!uses_dom || Ustrcmp(next->domain, addr->domain) == 0) &&
2422 same_strings(next->prop.errors_address, addr->prop.errors_address) &&
2423 same_headers(next->prop.extra_headers, addr->prop.extra_headers) &&
2424 same_strings(next->prop.remove_headers, addr->prop.remove_headers) &&
2425 same_ugid(tp, addr, next) &&
2426 ((addr->host_list == NULL && next->host_list == NULL) ||
2427 (addr->host_list != NULL && next->host_list != NULL &&
2428 Ustrcmp(addr->host_list->name, next->host_list->name) == 0));
2430 /* If the transport has a batch_id setting, batch_id will be non-NULL
2431 from the expansion outside the loop. Expand for this address and compare.
2432 Expansion failure makes this address ineligible for batching. */
2434 if (ok && batch_id != NULL)
2437 address_item *save_nextnext = next->next;
2438 next->next = NULL; /* Expansion for a single address */
2439 deliver_set_expansions(next);
2440 next->next = save_nextnext;
2441 bid = expand_string(tp->batch_id);
2442 deliver_set_expansions(NULL);
2445 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand batch_id option "
2446 "in %s transport (%s): %s", tp->name, next->address,
2447 expand_string_message);
2450 else ok = (Ustrcmp(batch_id, bid) == 0);
2453 /* Take address into batch if OK. */
2457 *anchor = next->next; /* Include the address */
2463 else anchor = &(next->next); /* Skip the address */
2467 /* We now have one or more addresses that can be delivered in a batch. Check
2468 whether the transport is prepared to accept a message of this size. If not,
2469 fail them all forthwith. If the expansion fails, or does not yield an
2470 integer, defer delivery. */
2472 if (tp->message_size_limit != NULL)
2474 int rc = check_message_size(tp, addr);
2477 replicate_status(addr);
2478 while (addr != NULL)
2481 post_process_one(addr, rc, logflags, DTYPE_TRANSPORT, 0);
2484 continue; /* With next batch of addresses */
2488 /* If we are not running the queue, or if forcing, all deliveries will be
2489 attempted. Otherwise, we must respect the retry times for each address. Even
2490 when not doing this, we need to set up the retry key string, and determine
2491 whether a retry record exists, because after a successful delivery, a delete
2492 retry item must be set up. Keep the retry database open only for the duration
2493 of these checks, rather than for all local deliveries, because some local
2494 deliveries (e.g. to pipes) can take a substantial time. */
2496 dbm_file = dbfn_open(US"retry", O_RDONLY, &dbblock, FALSE);
2497 if (dbm_file == NULL)
2499 DEBUG(D_deliver|D_retry|D_hints_lookup)
2500 debug_printf("no retry data available\n");
2505 while (addr2 != NULL)
2507 BOOL ok = TRUE; /* to deliver this address */
2510 /* Set up the retry key to include the domain or not, and change its
2511 leading character from "R" to "T". Must make a copy before doing this,
2512 because the old key may be pointed to from a "delete" retry item after
2515 retry_key = string_copy(
2516 (tp->retry_use_local_part)? addr2->address_retry_key :
2517 addr2->domain_retry_key);
2520 /* Inspect the retry data. If there is no hints file, delivery happens. */
2522 if (dbm_file != NULL)
2524 dbdata_retry *retry_record = dbfn_read(dbm_file, retry_key);
2526 /* If there is no retry record, delivery happens. If there is,
2527 remember it exists so it can be deleted after a successful delivery. */
2529 if (retry_record != NULL)
2531 setflag(addr2, af_lt_retry_exists);
2533 /* A retry record exists for this address. If queue running and not
2534 forcing, inspect its contents. If the record is too old, or if its
2535 retry time has come, or if it has passed its cutoff time, delivery
2540 debug_printf("retry record exists: age=%s ",
2541 readconf_printtime(now - retry_record->time_stamp));
2542 debug_printf("(max %s)\n", readconf_printtime(retry_data_expire));
2543 debug_printf(" time to retry = %s expired = %d\n",
2544 readconf_printtime(retry_record->next_try - now),
2545 retry_record->expired);
2548 if (queue_running && !deliver_force)
2550 ok = (now - retry_record->time_stamp > retry_data_expire) ||
2551 (now >= retry_record->next_try) ||
2552 retry_record->expired;
2554 /* If we haven't reached the retry time, there is one more check
2555 to do, which is for the ultimate address timeout. */
2558 ok = retry_ultimate_address_timeout(retry_key, addr2->domain,
2562 else DEBUG(D_retry) debug_printf("no retry record exists\n");
2565 /* This address is to be delivered. Leave it on the chain. */
2570 addr2 = addr2->next;
2573 /* This address is to be deferred. Take it out of the chain, and
2574 post-process it as complete. Must take it out of the chain first,
2575 because post processing puts it on another chain. */
2579 address_item *this = addr2;
2580 this->message = US"Retry time not yet reached";
2581 this->basic_errno = ERRNO_LRETRY;
2582 if (addr3 == NULL) addr2 = addr = addr2->next;
2583 else addr2 = addr3->next = addr2->next;
2584 post_process_one(this, DEFER, logflags, DTYPE_TRANSPORT, 0);
2588 if (dbm_file != NULL) dbfn_close(dbm_file);
2590 /* If there are no addresses left on the chain, they all deferred. Loop
2591 for the next set of addresses. */
2593 if (addr == NULL) continue;
2595 /* So, finally, we do have some addresses that can be passed to the
2596 transport. Before doing so, set up variables that are relevant to a
2599 deliver_set_expansions(addr);
2600 delivery_start = time(NULL);
2601 deliver_local(addr, FALSE);
2602 deliver_time = (int)(time(NULL) - delivery_start);
2604 /* If a shadow transport (which must perforce be another local transport), is
2605 defined, and its condition is met, we must pass the message to the shadow
2606 too, but only those addresses that succeeded. We do this by making a new
2607 chain of addresses - also to keep the original chain uncontaminated. We must
2608 use a chain rather than doing it one by one, because the shadow transport may
2611 NOTE: if the condition fails because of a lookup defer, there is nothing we
2614 if (tp->shadow != NULL &&
2615 (tp->shadow_condition == NULL ||
2616 expand_check_condition(tp->shadow_condition, tp->name, US"transport")))
2618 transport_instance *stp;
2619 address_item *shadow_addr = NULL;
2620 address_item **last = &shadow_addr;
2622 for (stp = transports; stp != NULL; stp = stp->next)
2623 if (Ustrcmp(stp->name, tp->shadow) == 0) break;
2626 log_write(0, LOG_MAIN|LOG_PANIC, "shadow transport \"%s\" not found ",
2629 /* Pick off the addresses that have succeeded, and make clones. Put into
2630 the shadow_message field a pointer to the shadow_message field of the real
2633 else for (addr2 = addr; addr2 != NULL; addr2 = addr2->next)
2635 if (addr2->transport_return != OK) continue;
2636 addr3 = store_get(sizeof(address_item));
2639 addr3->shadow_message = (uschar *)(&(addr2->shadow_message));
2640 addr3->transport = stp;
2641 addr3->transport_return = DEFER;
2642 addr3->return_filename = NULL;
2643 addr3->return_file = -1;
2645 last = &(addr3->next);
2648 /* If we found any addresses to shadow, run the delivery, and stick any
2649 message back into the shadow_message field in the original. */
2651 if (shadow_addr != NULL)
2653 int save_count = transport_count;
2655 DEBUG(D_deliver|D_transport)
2656 debug_printf(">>>>>>>>>>>>>>>> Shadow delivery >>>>>>>>>>>>>>>>\n");
2657 deliver_local(shadow_addr, TRUE);
2659 for(; shadow_addr != NULL; shadow_addr = shadow_addr->next)
2661 int sresult = shadow_addr->transport_return;
2662 *((uschar **)(shadow_addr->shadow_message)) = (sresult == OK)?
2663 string_sprintf(" ST=%s", stp->name) :
2664 string_sprintf(" ST=%s (%s%s%s)", stp->name,
2665 (shadow_addr->basic_errno <= 0)?
2666 US"" : US strerror(shadow_addr->basic_errno),
2667 (shadow_addr->basic_errno <= 0 || shadow_addr->message == NULL)?
2669 (shadow_addr->message != NULL)? shadow_addr->message :
2670 (shadow_addr->basic_errno <= 0)? US"unknown error" : US"");
2672 DEBUG(D_deliver|D_transport)
2673 debug_printf("%s shadow transport returned %s for %s\n",
2675 (sresult == OK)? "OK" :
2676 (sresult == DEFER)? "DEFER" :
2677 (sresult == FAIL)? "FAIL" :
2678 (sresult == PANIC)? "PANIC" : "?",
2679 shadow_addr->address);
2682 DEBUG(D_deliver|D_transport)
2683 debug_printf(">>>>>>>>>>>>>>>> End shadow delivery >>>>>>>>>>>>>>>>\n");
2685 transport_count = save_count; /* Restore original transport count */
2689 /* Cancel the expansions that were set up for the delivery. */
2691 deliver_set_expansions(NULL);
2693 /* Now we can process the results of the real transport. We must take each
2694 address off the chain first, because post_process_one() puts it on another
2697 for (addr2 = addr; addr2 != NULL; addr2 = nextaddr)
2699 int result = addr2->transport_return;
2700 nextaddr = addr2->next;
2702 DEBUG(D_deliver|D_transport)
2703 debug_printf("%s transport returned %s for %s\n",
2705 (result == OK)? "OK" :
2706 (result == DEFER)? "DEFER" :
2707 (result == FAIL)? "FAIL" :
2708 (result == PANIC)? "PANIC" : "?",
2711 /* If there is a retry_record, or if delivery is deferred, build a retry
2712 item for setting a new retry time or deleting the old retry record from
2713 the database. These items are handled all together after all addresses
2714 have been handled (so the database is open just for a short time for
2717 if (result == DEFER || testflag(addr2, af_lt_retry_exists))
2719 int flags = (result == DEFER)? 0 : rf_delete;
2720 uschar *retry_key = string_copy((tp->retry_use_local_part)?
2721 addr2->address_retry_key : addr2->domain_retry_key);
2723 retry_add_item(addr2, retry_key, flags);
2726 /* Done with this address */
2728 if (result == OK) addr2->more_errno = deliver_time;
2729 post_process_one(addr2, result, logflags, DTYPE_TRANSPORT, logchar);
2731 /* If a pipe delivery generated text to be sent back, the result may be
2732 changed to FAIL, and we must copy this for subsequent addresses in the
2735 if (addr2->transport_return != result)
2737 for (addr3 = nextaddr; addr3 != NULL; addr3 = addr3->next)
2739 addr3->transport_return = addr2->transport_return;
2740 addr3->basic_errno = addr2->basic_errno;
2741 addr3->message = addr2->message;
2743 result = addr2->transport_return;
2746 /* Whether or not the result was changed to FAIL, we need to copy the
2747 return_file value from the first address into all the addresses of the
2748 batch, so they are all listed in the error message. */
2750 addr2->return_file = addr->return_file;
2752 /* Change log character for recording successful deliveries. */
2754 if (result == OK) logchar = '-';
2756 } /* Loop back for next batch of addresses */
2762 /*************************************************
2763 * Sort remote deliveries *
2764 *************************************************/
2766 /* This function is called if remote_sort_domains is set. It arranges that the
2767 chain of addresses for remote deliveries is ordered according to the strings
2768 specified. Try to make this shuffling reasonably efficient by handling
2769 sequences of addresses rather than just single ones.
2776 sort_remote_deliveries(void)
2779 address_item **aptr = &addr_remote;
2780 const uschar *listptr = remote_sort_domains;
2784 while (*aptr != NULL &&
2785 (pattern = string_nextinlist(&listptr, &sep, patbuf, sizeof(patbuf)))
2788 address_item *moved = NULL;
2789 address_item **bptr = &moved;
2791 while (*aptr != NULL)
2793 address_item **next;
2794 deliver_domain = (*aptr)->domain; /* set $domain */
2795 if (match_isinlist(deliver_domain, (const uschar **)&pattern, UCHAR_MAX+1,
2796 &domainlist_anchor, NULL, MCL_DOMAIN, TRUE, NULL) == OK)
2798 aptr = &((*aptr)->next);
2802 next = &((*aptr)->next);
2803 while (*next != NULL &&
2804 (deliver_domain = (*next)->domain, /* Set $domain */
2805 match_isinlist(deliver_domain, (const uschar **)&pattern, UCHAR_MAX+1,
2806 &domainlist_anchor, NULL, MCL_DOMAIN, TRUE, NULL)) != OK)
2807 next = &((*next)->next);
2809 /* If the batch of non-matchers is at the end, add on any that were
2810 extracted further up the chain, and end this iteration. Otherwise,
2811 extract them from the chain and hang on the moved chain. */
2823 aptr = &((*aptr)->next);
2826 /* If the loop ended because the final address matched, *aptr will
2827 be NULL. Add on to the end any extracted non-matching addresses. If
2828 *aptr is not NULL, the loop ended via "break" when *next is null, that
2829 is, there was a string of non-matching addresses at the end. In this
2830 case the extracted addresses have already been added on the end. */
2832 if (*aptr == NULL) *aptr = moved;
2838 debug_printf("remote addresses after sorting:\n");
2839 for (addr = addr_remote; addr != NULL; addr = addr->next)
2840 debug_printf(" %s\n", addr->address);
2846 /*************************************************
2847 * Read from pipe for remote delivery subprocess *
2848 *************************************************/
2850 /* This function is called when the subprocess is complete, but can also be
2851 called before it is complete, in order to empty a pipe that is full (to prevent
2852 deadlock). It must therefore keep track of its progress in the parlist data
2855 We read the pipe to get the delivery status codes and a possible error message
2856 for each address, optionally preceded by unusability data for the hosts and
2857 also by optional retry data.
2859 Read in large chunks into the big buffer and then scan through, interpreting
2860 the data therein. In most cases, only a single read will be necessary. No
2861 individual item will ever be anywhere near 2500 bytes in length, so by ensuring
2862 that we read the next chunk when there is less than 2500 bytes left in the
2863 non-final chunk, we can assume each item is complete in the buffer before
2864 handling it. Each item is written using a single write(), which is atomic for
2865 small items (less than PIPE_BUF, which seems to be at least 512 in any Unix and
2866 often bigger) so even if we are reading while the subprocess is still going, we
2867 should never have only a partial item in the buffer.
2870 poffset the offset of the parlist item
2871 eop TRUE if the process has completed
2873 Returns: TRUE if the terminating 'Z' item has been read,
2874 or there has been a disaster (i.e. no more data needed);
2879 par_read_pipe(int poffset, BOOL eop)
2882 pardata *p = parlist + poffset;
2883 address_item *addrlist = p->addrlist;
2884 address_item *addr = p->addr;
2887 uschar *endptr = big_buffer;
2888 uschar *ptr = endptr;
2889 uschar *msg = p->msg;
2890 BOOL done = p->done;
2891 BOOL unfinished = TRUE;
2892 /* minimum size to read is header size including id, subid and length */
2893 int required = PIPE_HEADER_SIZE;
2895 /* Loop through all items, reading from the pipe when necessary. The pipe
2896 is set up to be non-blocking, but there are two different Unix mechanisms in
2897 use. Exim uses O_NONBLOCK if it is defined. This returns 0 for end of file,
2898 and EAGAIN for no more data. If O_NONBLOCK is not defined, Exim uses O_NDELAY,
2899 which returns 0 for both end of file and no more data. We distinguish the
2900 two cases by taking 0 as end of file only when we know the process has
2903 Each separate item is written to the pipe in a single write(), and as they are
2904 all short items, the writes will all be atomic and we should never find
2905 ourselves in the position of having read an incomplete item. "Short" in this
2906 case can mean up to about 1K in the case when there is a long error message
2907 associated with an address. */
2909 DEBUG(D_deliver) debug_printf("reading pipe for subprocess %d (%s)\n",
2910 (int)p->pid, eop? "ended" : "not ended");
2914 retry_item *r, **rp;
2915 int remaining = endptr - ptr;
2916 uschar header[PIPE_HEADER_SIZE + 1];
2920 /* Read (first time) or top up the chars in the buffer if necessary.
2921 There will be only one read if we get all the available data (i.e. don't
2922 fill the buffer completely). */
2924 if (remaining < required && unfinished)
2927 int available = big_buffer_size - remaining;
2929 if (remaining > 0) memmove(big_buffer, ptr, remaining);
2932 endptr = big_buffer + remaining;
2933 len = read(fd, endptr, available);
2935 DEBUG(D_deliver) debug_printf("read() yielded %d\n", len);
2937 /* If the result is EAGAIN and the process is not complete, just
2938 stop reading any more and process what we have already. */
2942 if (!eop && errno == EAGAIN) len = 0; else
2944 msg = string_sprintf("failed to read pipe from transport process "
2945 "%d for transport %s: %s", pid, addr->transport->driver_name,
2951 /* If the length is zero (eof or no-more-data), just process what we
2952 already have. Note that if the process is still running and we have
2953 read all the data in the pipe (but less that "available") then we
2954 won't read any more, as "unfinished" will get set FALSE. */
2958 unfinished = len == available;
2961 /* If we are at the end of the available data, exit the loop. */
2962 if (ptr >= endptr) break;
2964 /* copy and read header */
2965 memcpy(header, ptr, PIPE_HEADER_SIZE);
2966 header[PIPE_HEADER_SIZE] = '\0';
2969 required = Ustrtol(header + 2, &endc, 10) + PIPE_HEADER_SIZE; /* header + data */
2972 msg = string_sprintf("failed to read pipe from transport process "
2973 "%d for transport %s: error reading size from header", pid, addr->transport->driver_name);
2979 debug_printf("header read id:%c,subid:%c,size:%s,required:%d,remaining:%d,unfinished:%d\n",
2980 id, subid, header+2, required, remaining, unfinished);
2982 /* is there room for the dataset we want to read ? */
2983 if (required > big_buffer_size - PIPE_HEADER_SIZE)
2985 msg = string_sprintf("failed to read pipe from transport process "
2986 "%d for transport %s: big_buffer too small! required size=%d buffer size=%d", pid, addr->transport->driver_name,
2987 required, big_buffer_size - PIPE_HEADER_SIZE);
2992 /* we wrote all datasets with atomic write() calls
2993 remaining < required only happens if big_buffer was too small
2994 to get all available data from pipe. unfinished has to be true
2996 if (remaining < required)
3000 msg = string_sprintf("failed to read pipe from transport process "
3001 "%d for transport %s: required size=%d > remaining size=%d and unfinished=false",
3002 pid, addr->transport->driver_name, required, remaining);
3007 /* step behind the header */
3008 ptr += PIPE_HEADER_SIZE;
3010 /* Handle each possible type of item, assuming the complete item is
3011 available in store. */
3015 /* Host items exist only if any hosts were marked unusable. Match
3016 up by checking the IP address. */
3019 for (h = addrlist->host_list; h != NULL; h = h->next)
3021 if (h->address == NULL || Ustrcmp(h->address, ptr+2) != 0) continue;
3029 /* Retry items are sent in a preceding R item for each address. This is
3030 kept separate to keep each message short enough to guarantee it won't
3031 be split in the pipe. Hopefully, in the majority of cases, there won't in
3032 fact be any retry items at all.
3034 The complete set of retry items might include an item to delete a
3035 routing retry if there was a previous routing delay. However, routing
3036 retries are also used when a remote transport identifies an address error.
3037 In that case, there may also be an "add" item for the same key. Arrange
3038 that a "delete" item is dropped in favour of an "add" item. */
3041 if (addr == NULL) goto ADDR_MISMATCH;
3043 DEBUG(D_deliver|D_retry)
3044 debug_printf("reading retry information for %s from subprocess\n",
3047 /* Cut out any "delete" items on the list. */
3049 for (rp = &(addr->retries); (r = *rp) != NULL; rp = &(r->next))
3051 if (Ustrcmp(r->key, ptr+1) == 0) /* Found item with same key */
3053 if ((r->flags & rf_delete) == 0) break; /* It was not "delete" */
3054 *rp = r->next; /* Excise a delete item */
3055 DEBUG(D_deliver|D_retry)
3056 debug_printf(" existing delete item dropped\n");
3060 /* We want to add a delete item only if there is no non-delete item;
3061 however we still have to step ptr through the data. */
3063 if (r == NULL || (*ptr & rf_delete) == 0)
3065 r = store_get(sizeof(retry_item));
3066 r->next = addr->retries;
3069 r->key = string_copy(ptr);
3071 memcpy(&(r->basic_errno), ptr, sizeof(r->basic_errno));
3072 ptr += sizeof(r->basic_errno);
3073 memcpy(&(r->more_errno), ptr, sizeof(r->more_errno));
3074 ptr += sizeof(r->more_errno);
3075 r->message = (*ptr)? string_copy(ptr) : NULL;
3076 DEBUG(D_deliver|D_retry)
3077 debug_printf(" added %s item\n",
3078 ((r->flags & rf_delete) == 0)? "retry" : "delete");
3083 DEBUG(D_deliver|D_retry)
3084 debug_printf(" delete item not added: non-delete item exists\n");
3087 ptr += sizeof(r->basic_errno) + sizeof(r->more_errno);
3093 /* Put the amount of data written into the parlist block */
3096 memcpy(&(p->transport_count), ptr, sizeof(transport_count));
3097 ptr += sizeof(transport_count);
3100 /* Address items are in the order of items on the address chain. We
3101 remember the current address value in case this function is called
3102 several times to empty the pipe in stages. Information about delivery
3103 over TLS is sent in a preceding X item for each address. We don't put
3104 it in with the other info, in order to keep each message short enough to
3105 guarantee it won't be split in the pipe. */
3109 if (addr == NULL) goto ADDR_MISMATCH; /* Below, in 'A' handler */
3113 addr->cipher = NULL;
3114 addr->peerdn = NULL;
3117 addr->cipher = string_copy(ptr);
3120 addr->peerdn = string_copy(ptr);
3125 (void) tls_import_cert(ptr, &addr->peercert);
3127 addr->peercert = NULL;
3132 (void) tls_import_cert(ptr, &addr->ourcert);
3134 addr->ourcert = NULL;
3137 # ifndef DISABLE_OCSP
3139 addr->ocsp = OCSP_NOT_REQ;
3141 addr->ocsp = *ptr - '0';
3147 #endif /*SUPPORT_TLS*/
3149 case 'C': /* client authenticator information */
3153 addr->authenticator = (*ptr)? string_copy(ptr) : NULL;
3156 addr->auth_id = (*ptr)? string_copy(ptr) : NULL;
3159 addr->auth_sndr = (*ptr)? string_copy(ptr) : NULL;
3165 #ifndef DISABLE_PRDR
3167 addr->flags |= af_prdr_used;
3172 if (addr == NULL) goto ADDR_MISMATCH;
3173 memcpy(&(addr->dsn_aware), ptr, sizeof(addr->dsn_aware));
3174 ptr += sizeof(addr->dsn_aware);
3175 DEBUG(D_deliver) debug_printf("DSN read: addr->dsn_aware = %d\n", addr->dsn_aware);
3182 msg = string_sprintf("address count mismatch for data read from pipe "
3183 "for transport process %d for transport %s", pid,
3184 addrlist->transport->driver_name);
3189 addr->transport_return = *ptr++;
3190 addr->special_action = *ptr++;
3191 memcpy(&(addr->basic_errno), ptr, sizeof(addr->basic_errno));
3192 ptr += sizeof(addr->basic_errno);
3193 memcpy(&(addr->more_errno), ptr, sizeof(addr->more_errno));
3194 ptr += sizeof(addr->more_errno);
3195 memcpy(&(addr->flags), ptr, sizeof(addr->flags));
3196 ptr += sizeof(addr->flags);
3197 addr->message = (*ptr)? string_copy(ptr) : NULL;
3199 addr->user_message = (*ptr)? string_copy(ptr) : NULL;
3202 /* Always two strings for host information, followed by the port number and DNSSEC mark */
3206 h = store_get(sizeof(host_item));
3207 h->name = string_copy(ptr);
3209 h->address = string_copy(ptr);
3211 memcpy(&(h->port), ptr, sizeof(h->port));
3212 ptr += sizeof(h->port);
3213 h->dnssec = *ptr == '2' ? DS_YES
3214 : *ptr == '1' ? DS_NO
3217 addr->host_used = h;
3221 /* Finished with this address */
3226 /* Local interface address/port */
3228 if (*ptr) sending_ip_address = string_copy(ptr);
3230 if (*ptr) sending_port = atoi(CS ptr);
3234 /* Z marks the logical end of the data. It is followed by '0' if
3235 continue_transport was NULL at the end of transporting, otherwise '1'.
3236 We need to know when it becomes NULL during a delivery down a passed SMTP
3237 channel so that we don't try to pass anything more down it. Of course, for
3238 most normal messages it will remain NULL all the time. */
3243 continue_transport = NULL;
3244 continue_hostname = NULL;
3247 DEBUG(D_deliver) debug_printf("Z0%c item read\n", *ptr);
3250 /* Anything else is a disaster. */
3253 msg = string_sprintf("malformed data (%d) read from pipe for transport "
3254 "process %d for transport %s", ptr[-1], pid,
3255 addr->transport->driver_name);
3261 /* The done flag is inspected externally, to determine whether or not to
3262 call the function again when the process finishes. */
3266 /* If the process hadn't finished, and we haven't seen the end of the data
3267 or suffered a disaster, update the rest of the state, and return FALSE to
3268 indicate "not finished". */
3277 /* Close our end of the pipe, to prevent deadlock if the far end is still
3278 pushing stuff into it. */
3283 /* If we have finished without error, but haven't had data for every address,
3284 something is wrong. */
3286 if (msg == NULL && addr != NULL)
3287 msg = string_sprintf("insufficient address data read from pipe "
3288 "for transport process %d for transport %s", pid,
3289 addr->transport->driver_name);
3291 /* If an error message is set, something has gone wrong in getting back
3292 the delivery data. Put the message into each address and freeze it. */
3296 for (addr = addrlist; addr != NULL; addr = addr->next)
3298 addr->transport_return = DEFER;
3299 addr->special_action = SPECIAL_FREEZE;
3300 addr->message = msg;
3304 /* Return TRUE to indicate we have got all we need from this process, even
3305 if it hasn't actually finished yet. */
3312 /*************************************************
3313 * Post-process a set of remote addresses *
3314 *************************************************/
3316 /* Do what has to be done immediately after a remote delivery for each set of
3317 addresses, then re-write the spool if necessary. Note that post_process_one
3318 puts the address on an appropriate queue; hence we must fish off the next
3319 one first. This function is also called if there is a problem with setting
3320 up a subprocess to do a remote delivery in parallel. In this case, the final
3321 argument contains a message, and the action must be forced to DEFER.
3324 addr pointer to chain of address items
3325 logflags flags for logging
3326 msg NULL for normal cases; -> error message for unexpected problems
3327 fallback TRUE if processing fallback hosts
3333 remote_post_process(address_item *addr, int logflags, uschar *msg,
3338 /* If any host addresses were found to be unusable, add them to the unusable
3339 tree so that subsequent deliveries don't try them. */
3341 for (h = addr->host_list; h != NULL; h = h->next)
3343 if (h->address == NULL) continue;
3344 if (h->status >= hstatus_unusable) tree_add_unusable(h);
3347 /* Now handle each address on the chain. The transport has placed '=' or '-'
3348 into the special_action field for each successful delivery. */
3350 while (addr != NULL)
3352 address_item *next = addr->next;
3354 /* If msg == NULL (normal processing) and the result is DEFER and we are
3355 processing the main hosts and there are fallback hosts available, put the
3356 address on the list for fallback delivery. */
3358 if (addr->transport_return == DEFER &&
3359 addr->fallback_hosts != NULL &&
3363 addr->host_list = addr->fallback_hosts;
3364 addr->next = addr_fallback;
3365 addr_fallback = addr;
3366 DEBUG(D_deliver) debug_printf("%s queued for fallback host(s)\n", addr->address);
3369 /* If msg is set (=> unexpected problem), set it in the address before
3370 doing the ordinary post processing. */
3376 addr->message = msg;
3377 addr->transport_return = DEFER;
3379 (void)post_process_one(addr, addr->transport_return, logflags,
3380 DTYPE_TRANSPORT, addr->special_action);
3388 /* If we have just delivered down a passed SMTP channel, and that was
3389 the last address, the channel will have been closed down. Now that
3390 we have logged that delivery, set continue_sequence to 1 so that
3391 any subsequent deliveries don't get "*" incorrectly logged. */
3393 if (continue_transport == NULL) continue_sequence = 1;
3398 /*************************************************
3399 * Wait for one remote delivery subprocess *
3400 *************************************************/
3402 /* This function is called while doing remote deliveries when either the
3403 maximum number of processes exist and we need one to complete so that another
3404 can be created, or when waiting for the last ones to complete. It must wait for
3405 the completion of one subprocess, empty the control block slot, and return a
3406 pointer to the address chain.
3409 Returns: pointer to the chain of addresses handled by the process;
3410 NULL if no subprocess found - this is an unexpected error
3413 static address_item *
3416 int poffset, status;
3417 address_item *addr, *addrlist;
3420 set_process_info("delivering %s: waiting for a remote delivery subprocess "
3421 "to finish", message_id);
3423 /* Loop until either a subprocess completes, or there are no subprocesses in
3424 existence - in which case give an error return. We cannot proceed just by
3425 waiting for a completion, because a subprocess may have filled up its pipe, and
3426 be waiting for it to be emptied. Therefore, if no processes have finished, we
3427 wait for one of the pipes to acquire some data by calling select(), with a
3428 timeout just in case.
3430 The simple approach is just to iterate after reading data from a ready pipe.
3431 This leads to non-ideal behaviour when the subprocess has written its final Z
3432 item, closed the pipe, and is in the process of exiting (the common case). A
3433 call to waitpid() yields nothing completed, but select() shows the pipe ready -
3434 reading it yields EOF, so you end up with busy-waiting until the subprocess has
3437 To avoid this, if all the data that is needed has been read from a subprocess
3438 after select(), an explicit wait() for it is done. We know that all it is doing
3439 is writing to the pipe and then exiting, so the wait should not be long.
3441 The non-blocking waitpid() is to some extent just insurance; if we could
3442 reliably detect end-of-file on the pipe, we could always know when to do a
3443 blocking wait() for a completed process. However, because some systems use
3444 NDELAY, which doesn't distinguish between EOF and pipe empty, it is easier to
3445 use code that functions without the need to recognize EOF.
3447 There's a double loop here just in case we end up with a process that is not in
3448 the list of remote delivery processes. Something has obviously gone wrong if
3449 this is the case. (For example, a process that is incorrectly left over from
3450 routing or local deliveries might be found.) The damage can be minimized by
3451 looping back and looking for another process. If there aren't any, the error
3452 return will happen. */
3454 for (;;) /* Normally we do not repeat this loop */
3456 while ((pid = waitpid(-1, &status, WNOHANG)) <= 0)
3459 fd_set select_pipes;
3460 int maxpipe, readycount;
3462 /* A return value of -1 can mean several things. If errno != ECHILD, it
3463 either means invalid options (which we discount), or that this process was
3464 interrupted by a signal. Just loop to try the waitpid() again.
3466 If errno == ECHILD, waitpid() is telling us that there are no subprocesses
3467 in existence. This should never happen, and is an unexpected error.
3468 However, there is a nasty complication when running under Linux. If "strace
3469 -f" is being used under Linux to trace this process and its children,
3470 subprocesses are "stolen" from their parents and become the children of the
3471 tracing process. A general wait such as the one we've just obeyed returns
3472 as if there are no children while subprocesses are running. Once a
3473 subprocess completes, it is restored to the parent, and waitpid(-1) finds
3474 it. Thanks to Joachim Wieland for finding all this out and suggesting a
3477 This does not happen using "truss" on Solaris, nor (I think) with other
3478 tracing facilities on other OS. It seems to be specific to Linux.
3480 What we do to get round this is to use kill() to see if any of our
3481 subprocesses are still in existence. If kill() gives an OK return, we know
3482 it must be for one of our processes - it can't be for a re-use of the pid,
3483 because if our process had finished, waitpid() would have found it. If any
3484 of our subprocesses are in existence, we proceed to use select() as if
3485 waitpid() had returned zero. I think this is safe. */
3489 if (errno != ECHILD) continue; /* Repeats the waitpid() */
3492 debug_printf("waitpid() returned -1/ECHILD: checking explicitly "
3493 "for process existence\n");
3495 for (poffset = 0; poffset < remote_max_parallel; poffset++)
3497 if ((pid = parlist[poffset].pid) != 0 && kill(pid, 0) == 0)
3499 DEBUG(D_deliver) debug_printf("process %d still exists: assume "
3500 "stolen by strace\n", (int)pid);
3501 break; /* With poffset set */
3505 if (poffset >= remote_max_parallel)
3507 DEBUG(D_deliver) debug_printf("*** no delivery children found\n");
3508 return NULL; /* This is the error return */
3512 /* A pid value greater than 0 breaks the "while" loop. A negative value has
3513 been handled above. A return value of zero means that there is at least one
3514 subprocess, but there are no completed subprocesses. See if any pipes are
3515 ready with any data for reading. */
3517 DEBUG(D_deliver) debug_printf("selecting on subprocess pipes\n");
3520 FD_ZERO(&select_pipes);
3521 for (poffset = 0; poffset < remote_max_parallel; poffset++)
3523 if (parlist[poffset].pid != 0)
3525 int fd = parlist[poffset].fd;
3526 FD_SET(fd, &select_pipes);
3527 if (fd > maxpipe) maxpipe = fd;
3531 /* Stick in a 60-second timeout, just in case. */
3536 readycount = select(maxpipe + 1, (SELECT_ARG2_TYPE *)&select_pipes,
3539 /* Scan through the pipes and read any that are ready; use the count
3540 returned by select() to stop when there are no more. Select() can return
3541 with no processes (e.g. if interrupted). This shouldn't matter.
3543 If par_read_pipe() returns TRUE, it means that either the terminating Z was
3544 read, or there was a disaster. In either case, we are finished with this
3545 process. Do an explicit wait() for the process and break the main loop if
3548 It turns out that we have to deal with the case of an interrupted system
3549 call, which can happen on some operating systems if the signal handling is
3550 set up to do that by default. */
3553 readycount > 0 && poffset < remote_max_parallel;
3556 if ((pid = parlist[poffset].pid) != 0 &&
3557 FD_ISSET(parlist[poffset].fd, &select_pipes))
3560 if (par_read_pipe(poffset, FALSE)) /* Finished with this pipe */
3562 for (;;) /* Loop for signals */
3564 pid_t endedpid = waitpid(pid, &status, 0);
3565 if (endedpid == pid) goto PROCESS_DONE;
3566 if (endedpid != (pid_t)(-1) || errno != EINTR)
3567 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Unexpected error return "
3568 "%d (errno = %d) from waitpid() for process %d",
3569 (int)endedpid, errno, (int)pid);
3575 /* Now go back and look for a completed subprocess again. */
3578 /* A completed process was detected by the non-blocking waitpid(). Find the
3579 data block that corresponds to this subprocess. */
3581 for (poffset = 0; poffset < remote_max_parallel; poffset++)
3582 if (pid == parlist[poffset].pid) break;
3584 /* Found the data block; this is a known remote delivery process. We don't
3585 need to repeat the outer loop. This should be what normally happens. */
3587 if (poffset < remote_max_parallel) break;
3589 /* This situation is an error, but it's probably better to carry on looking
3590 for another process than to give up (as we used to do). */
3592 log_write(0, LOG_MAIN|LOG_PANIC, "Process %d finished: not found in remote "
3593 "transport process list", pid);
3594 } /* End of the "for" loop */
3596 /* Come here when all the data was completely read after a select(), and
3597 the process in pid has been wait()ed for. */
3604 debug_printf("remote delivery process %d ended\n", (int)pid);
3606 debug_printf("remote delivery process %d ended: status=%04x\n", (int)pid,
3610 set_process_info("delivering %s", message_id);
3612 /* Get the chain of processed addresses */
3614 addrlist = parlist[poffset].addrlist;
3616 /* If the process did not finish cleanly, record an error and freeze (except
3617 for SIGTERM, SIGKILL and SIGQUIT), and also ensure the journal is not removed,
3618 in case the delivery did actually happen. */
3620 if ((status & 0xffff) != 0)
3623 int msb = (status >> 8) & 255;
3624 int lsb = status & 255;
3625 int code = (msb == 0)? (lsb & 0x7f) : msb;
3627 msg = string_sprintf("%s transport process returned non-zero status 0x%04x: "
3629 addrlist->transport->driver_name,
3631 (msb == 0)? "terminated by signal" : "exit code",
3634 if (msb != 0 || (code != SIGTERM && code != SIGKILL && code != SIGQUIT))
3635 addrlist->special_action = SPECIAL_FREEZE;
3637 for (addr = addrlist; addr != NULL; addr = addr->next)
3639 addr->transport_return = DEFER;
3640 addr->message = msg;
3643 remove_journal = FALSE;
3646 /* Else complete reading the pipe to get the result of the delivery, if all
3647 the data has not yet been obtained. */
3649 else if (!parlist[poffset].done) (void)par_read_pipe(poffset, TRUE);
3651 /* Put the data count and return path into globals, mark the data slot unused,
3652 decrement the count of subprocesses, and return the address chain. */
3654 transport_count = parlist[poffset].transport_count;
3655 used_return_path = parlist[poffset].return_path;
3656 parlist[poffset].pid = 0;
3663 /*************************************************
3664 * Wait for subprocesses and post-process *
3665 *************************************************/
3667 /* This function waits for subprocesses until the number that are still running
3668 is below a given threshold. For each complete subprocess, the addresses are
3669 post-processed. If we can't find a running process, there is some shambles.
3670 Better not bomb out, as that might lead to multiple copies of the message. Just
3671 log and proceed as if all done.
3674 max maximum number of subprocesses to leave running
3675 fallback TRUE if processing fallback hosts
3681 par_reduce(int max, BOOL fallback)
3683 while (parcount > max)
3685 address_item *doneaddr = par_wait();
3686 if (doneaddr == NULL)
3688 log_write(0, LOG_MAIN|LOG_PANIC,
3689 "remote delivery process count got out of step");
3692 else remote_post_process(doneaddr, LOG_MAIN, NULL, fallback);
3700 rmt_dlv_checked_write(int fd, char id, char subid, void * buf, int size)
3702 uschar writebuffer[PIPE_HEADER_SIZE + BIG_BUFFER_SIZE];
3705 /* we assume that size can't get larger then BIG_BUFFER_SIZE which currently is set to 16k */
3706 /* complain to log if someone tries with buffer sizes we can't handle*/
3710 log_write(0, LOG_MAIN|LOG_PANIC_DIE,
3711 "Failed writing transport result to pipe: can't handle buffers > 99999 bytes. truncating!\n");
3715 /* to keep the write() atomic we build header in writebuffer and copy buf behind */
3716 /* two write() calls would increase the complexity of reading from pipe */
3718 /* convert size to human readable string prepended by id and subid */
3719 header_length = snprintf(CS writebuffer, PIPE_HEADER_SIZE+1, "%c%c%05d", id, subid, size);
3720 if (header_length != PIPE_HEADER_SIZE)
3722 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "header snprintf failed\n");
3723 writebuffer[0] = '\0';
3726 DEBUG(D_deliver) debug_printf("header write id:%c,subid:%c,size:%d,final:%s\n",
3727 id, subid, size, writebuffer);
3729 if (buf && size > 0)
3730 memcpy(writebuffer + PIPE_HEADER_SIZE, buf, size);
3732 size += PIPE_HEADER_SIZE;
3733 int ret = write(fd, writebuffer, size);
3735 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Failed writing transport result to pipe: %s\n",
3736 ret == -1 ? strerror(errno) : "short write");
3739 /*************************************************
3740 * Do remote deliveries *
3741 *************************************************/
3743 /* This function is called to process the addresses in addr_remote. We must
3744 pick off the queue all addresses that have the same transport, remote
3745 destination, and errors address, and hand them to the transport in one go,
3746 subject to some configured limitations. If this is a run to continue delivering
3747 to an existing delivery channel, skip all but those addresses that can go to
3748 that channel. The skipped addresses just get deferred.
3750 If mua_wrapper is set, all addresses must be able to be sent in a single
3751 transaction. If not, this function yields FALSE.
3753 In Exim 4, remote deliveries are always done in separate processes, even
3754 if remote_max_parallel = 1 or if there's only one delivery to do. The reason
3755 is so that the base process can retain privilege. This makes the
3756 implementation of fallback transports feasible (though not initially done.)
3758 We create up to the configured number of subprocesses, each of which passes
3759 back the delivery state via a pipe. (However, when sending down an existing
3760 connection, remote_max_parallel is forced to 1.)
3763 fallback TRUE if processing fallback hosts
3765 Returns: TRUE normally
3766 FALSE if mua_wrapper is set and the addresses cannot all be sent
3771 do_remote_deliveries(BOOL fallback)
3777 parcount = 0; /* Number of executing subprocesses */
3779 /* When sending down an existing channel, only do one delivery at a time.
3780 We use a local variable (parmax) to hold the maximum number of processes;
3781 this gets reduced from remote_max_parallel if we can't create enough pipes. */
3783 if (continue_transport != NULL) remote_max_parallel = 1;
3784 parmax = remote_max_parallel;
3786 /* If the data for keeping a list of processes hasn't yet been
3789 if (parlist == NULL)
3791 parlist = store_get(remote_max_parallel * sizeof(pardata));
3792 for (poffset = 0; poffset < remote_max_parallel; poffset++)
3793 parlist[poffset].pid = 0;
3796 /* Now loop for each remote delivery */
3798 for (delivery_count = 0; addr_remote != NULL; delivery_count++)
3804 int address_count = 1;
3805 int address_count_max;
3807 BOOL use_initgroups;
3808 BOOL pipe_done = FALSE;
3809 transport_instance *tp;
3810 address_item **anchor = &addr_remote;
3811 address_item *addr = addr_remote;
3812 address_item *last = addr;
3815 /* Pull the first address right off the list. */
3817 addr_remote = addr->next;
3820 DEBUG(D_deliver|D_transport)
3821 debug_printf("--------> %s <--------\n", addr->address);
3823 /* If no transport has been set, there has been a big screw-up somewhere. */
3825 if ((tp = addr->transport) == NULL)
3827 disable_logging = FALSE; /* Jic */
3828 remote_post_process(addr, LOG_MAIN|LOG_PANIC,
3829 US"No transport set by router", fallback);
3833 /* Check that this base address hasn't previously been delivered to this
3834 transport. The check is necessary at this point to handle homonymic addresses
3835 correctly in cases where the pattern of redirection changes between delivery
3836 attempts. Non-homonymic previous delivery is detected earlier, at routing
3839 if (previously_transported(addr, FALSE)) continue;
3841 /* Force failure if the message is too big. */
3843 if (tp->message_size_limit != NULL)
3845 int rc = check_message_size(tp, addr);
3848 addr->transport_return = rc;
3849 remote_post_process(addr, LOG_MAIN, NULL, fallback);
3854 /* Get the flag which specifies whether the transport can handle different
3855 domains that nevertheless resolve to the same set of hosts. If it needs
3856 expanding, get variables set: $address_data, $domain_data, $localpart_data,
3857 $host, $host_address, $host_port. */
3858 if (tp->expand_multi_domain)
3859 deliver_set_expansions(addr);
3861 if (exp_bool(addr, US"transport", tp->name, D_transport,
3862 US"multi_domain", tp->multi_domain, tp->expand_multi_domain,
3863 &multi_domain) != OK)
3865 deliver_set_expansions(NULL);
3866 remote_post_process(addr, LOG_MAIN|LOG_PANIC, addr->message, fallback);
3870 /* Get the maximum it can handle in one envelope, with zero meaning
3871 unlimited, which is forced for the MUA wrapper case. */
3873 address_count_max = tp->max_addresses;
3874 if (address_count_max == 0 || mua_wrapper) address_count_max = 999999;
3877 /************************************************************************/
3878 /***** This is slightly experimental code, but should be safe. *****/
3880 /* The address_count_max value is the maximum number of addresses that the
3881 transport can send in one envelope. However, the transport must be capable of
3882 dealing with any number of addresses. If the number it gets exceeds its
3883 envelope limitation, it must send multiple copies of the message. This can be
3884 done over a single connection for SMTP, so uses less resources than making
3885 multiple connections. On the other hand, if remote_max_parallel is greater
3886 than one, it is perhaps a good idea to use parallel processing to move the
3887 message faster, even if that results in multiple simultaneous connections to
3890 How can we come to some compromise between these two ideals? What we do is to
3891 limit the number of addresses passed to a single instance of a transport to
3892 the greater of (a) its address limit (rcpt_max for SMTP) and (b) the total
3893 number of addresses routed to remote transports divided by
3894 remote_max_parallel. For example, if the message has 100 remote recipients,
3895 remote max parallel is 2, and rcpt_max is 10, we'd never send more than 50 at
3896 once. But if rcpt_max is 100, we could send up to 100.
3898 Of course, not all the remotely addresses in a message are going to go to the
3899 same set of hosts (except in smarthost configurations), so this is just a
3900 heuristic way of dividing up the work.
3902 Furthermore (1), because this may not be wanted in some cases, and also to
3903 cope with really pathological cases, there is also a limit to the number of
3904 messages that are sent over one connection. This is the same limit that is
3905 used when sending several different messages over the same connection.
3906 Continue_sequence is set when in this situation, to the number sent so
3907 far, including this message.
3909 Furthermore (2), when somebody explicitly sets the maximum value to 1, it
3910 is probably because they are using VERP, in which case they want to pass only
3911 one address at a time to the transport, in order to be able to use
3912 $local_part and $domain in constructing a new return path. We could test for
3913 the use of these variables, but as it is so likely they will be used when the
3914 maximum is 1, we don't bother. Just leave the value alone. */
3916 if (address_count_max != 1 &&
3917 address_count_max < remote_delivery_count/remote_max_parallel)
3919 int new_max = remote_delivery_count/remote_max_parallel;
3920 int message_max = tp->connection_max_messages;
3921 if (connection_max_messages >= 0) message_max = connection_max_messages;
3922 message_max -= continue_sequence - 1;
3923 if (message_max > 0 && new_max > address_count_max * message_max)
3924 new_max = address_count_max * message_max;
3925 address_count_max = new_max;
3928 /************************************************************************/
3931 /* Pick off all addresses which have the same transport, errors address,
3932 destination, and extra headers. In some cases they point to the same host
3933 list, but we also need to check for identical host lists generated from
3934 entirely different domains. The host list pointers can be NULL in the case
3935 where the hosts are defined in the transport. There is also a configured
3936 maximum limit of addresses that can be handled at once (see comments above
3937 for how it is computed).
3938 If the transport does not handle multiple domains, enforce that also,
3939 and if it might need a per-address check for this, re-evaluate it.
3942 while ((next = *anchor) != NULL && address_count < address_count_max)
3945 if ( (multi_domain || Ustrcmp(next->domain, addr->domain) == 0)
3946 && tp == next->transport
3947 && same_hosts(next->host_list, addr->host_list)
3948 && same_strings(next->prop.errors_address, addr->prop.errors_address)
3949 && same_headers(next->prop.extra_headers, addr->prop.extra_headers)
3950 && same_ugid(tp, next, addr)
3951 && ( next->prop.remove_headers == addr->prop.remove_headers
3952 || ( next->prop.remove_headers
3953 && addr->prop.remove_headers
3954 && Ustrcmp(next->prop.remove_headers, addr->prop.remove_headers) == 0
3958 !tp->expand_multi_domain || (deliver_set_expansions(next), 1),
3960 US"transport", next->transport->name, D_transport,
3961 US"multi_domain", next->transport->multi_domain,
3962 next->transport->expand_multi_domain, &md) == OK
3967 *anchor = next->next;
3969 next->first = addr; /* remember top one (for retry processing) */
3974 else anchor = &(next->next);
3975 deliver_set_expansions(NULL);
3978 /* If we are acting as an MUA wrapper, all addresses must go in a single
3979 transaction. If not, put them back on the chain and yield FALSE. */
3981 if (mua_wrapper && addr_remote != NULL)
3983 last->next = addr_remote;
3988 /* Set up the expansion variables for this set of addresses */
3990 deliver_set_expansions(addr);
3992 /* Ensure any transport-set auth info is fresh */
3993 addr->authenticator = addr->auth_id = addr->auth_sndr = NULL;
3995 /* Compute the return path, expanding a new one if required. The old one
3996 must be set first, as it might be referred to in the expansion. */
3998 if(addr->prop.errors_address != NULL)
3999 return_path = addr->prop.errors_address;
4000 #ifdef EXPERIMENTAL_SRS
4001 else if(addr->prop.srs_sender != NULL)
4002 return_path = addr->prop.srs_sender;
4005 return_path = sender_address;
4007 if (tp->return_path != NULL)
4009 uschar *new_return_path = expand_string(tp->return_path);
4010 if (new_return_path == NULL)
4012 if (!expand_string_forcedfail)
4014 remote_post_process(addr, LOG_MAIN|LOG_PANIC,
4015 string_sprintf("Failed to expand return path \"%s\": %s",
4016 tp->return_path, expand_string_message), fallback);
4020 else return_path = new_return_path;
4023 /* Find the uid, gid, and use_initgroups setting for this transport. Failure
4024 logs and sets up error messages, so we just post-process and continue with
4025 the next address. */
4027 if (!findugid(addr, tp, &uid, &gid, &use_initgroups))
4029 remote_post_process(addr, LOG_MAIN|LOG_PANIC, NULL, fallback);
4033 /* If this transport has a setup function, call it now so that it gets
4034 run in this process and not in any subprocess. That way, the results of
4035 any setup that are retained by the transport can be reusable. One of the
4036 things the setup does is to set the fallback host lists in the addresses.
4037 That is why it is called at this point, before the continue delivery
4038 processing, because that might use the fallback hosts. */
4040 if (tp->setup != NULL)
4041 (void)((tp->setup)(addr->transport, addr, NULL, uid, gid, NULL));
4043 /* If this is a run to continue delivery down an already-established
4044 channel, check that this set of addresses matches the transport and
4045 the channel. If it does not, defer the addresses. If a host list exists,
4046 we must check that the continue host is on the list. Otherwise, the
4047 host is set in the transport. */
4049 continue_more = FALSE; /* In case got set for the last lot */
4050 if (continue_transport != NULL)
4052 BOOL ok = Ustrcmp(continue_transport, tp->name) == 0;
4053 if (ok && addr->host_list != NULL)
4057 for (h = addr->host_list; h != NULL; h = h->next)
4059 if (Ustrcmp(h->name, continue_hostname) == 0)
4060 { ok = TRUE; break; }
4064 /* Addresses not suitable; defer or queue for fallback hosts (which
4065 might be the continue host) and skip to next address. */
4069 DEBUG(D_deliver) debug_printf("not suitable for continue_transport\n");
4072 if (addr->fallback_hosts != NULL && !fallback)
4076 next->host_list = next->fallback_hosts;
4077 DEBUG(D_deliver) debug_printf("%s queued for fallback host(s)\n", next->address);
4078 if (next->next == NULL) break;
4081 next->next = addr_fallback;
4082 addr_fallback = addr;
4087 while (next->next != NULL) next = next->next;
4088 next->next = addr_defer;
4095 /* Set a flag indicating whether there are further addresses that list
4096 the continued host. This tells the transport to leave the channel open,
4097 but not to pass it to another delivery process. */
4099 for (next = addr_remote; next != NULL; next = next->next)
4102 for (h = next->host_list; h != NULL; h = h->next)
4104 if (Ustrcmp(h->name, continue_hostname) == 0)
4105 { continue_more = TRUE; break; }
4110 /* The transports set up the process info themselves as they may connect
4111 to more than one remote machine. They also have to set up the filter
4112 arguments, if required, so that the host name and address are available
4115 transport_filter_argv = NULL;
4117 /* Create the pipe for inter-process communication. If pipe creation
4118 fails, it is probably because the value of remote_max_parallel is so
4119 large that too many file descriptors for pipes have been created. Arrange
4120 to wait for a process to finish, and then try again. If we still can't
4121 create a pipe when all processes have finished, break the retry loop. */
4125 if (pipe(pfd) == 0) pipe_done = TRUE;
4126 else if (parcount > 0) parmax = parcount;
4129 /* We need to make the reading end of the pipe non-blocking. There are
4130 two different options for this. Exim is cunningly (I hope!) coded so
4131 that it can use either of them, though it prefers O_NONBLOCK, which
4132 distinguishes between EOF and no-more-data. */
4135 (void)fcntl(pfd[pipe_read], F_SETFL, O_NONBLOCK);
4137 (void)fcntl(pfd[pipe_read], F_SETFL, O_NDELAY);
4140 /* If the maximum number of subprocesses already exist, wait for a process
4141 to finish. If we ran out of file descriptors, parmax will have been reduced
4142 from its initial value of remote_max_parallel. */
4144 par_reduce(parmax - 1, fallback);
4147 /* If we failed to create a pipe and there were no processes to wait
4148 for, we have to give up on this one. Do this outside the above loop
4149 so that we can continue the main loop. */
4153 remote_post_process(addr, LOG_MAIN|LOG_PANIC,
4154 string_sprintf("unable to create pipe: %s", strerror(errno)), fallback);
4158 /* Find a free slot in the pardata list. Must do this after the possible
4159 waiting for processes to finish, because a terminating process will free
4162 for (poffset = 0; poffset < remote_max_parallel; poffset++)
4163 if (parlist[poffset].pid == 0) break;
4165 /* If there isn't one, there has been a horrible disaster. */
4167 if (poffset >= remote_max_parallel)
4169 (void)close(pfd[pipe_write]);
4170 (void)close(pfd[pipe_read]);
4171 remote_post_process(addr, LOG_MAIN|LOG_PANIC,
4172 US"Unexpectedly no free subprocess slot", fallback);
4176 /* Now fork a subprocess to do the remote delivery, but before doing so,
4177 ensure that any cached resourses are released so as not to interfere with
4178 what happens in the subprocess. */
4182 if ((pid = fork()) == 0)
4184 int fd = pfd[pipe_write];
4187 /* Setting this global in the subprocess means we need never clear it */
4188 transport_name = tp->name;
4190 /* There are weird circumstances in which logging is disabled */
4191 disable_logging = tp->disable_logging;
4193 /* Show pids on debug output if parallelism possible */
4195 if (parmax > 1 && (parcount > 0 || addr_remote != NULL))
4197 DEBUG(D_any|D_v) debug_selector |= D_pid;
4198 DEBUG(D_deliver) debug_printf("Remote delivery process started\n");
4201 /* Reset the random number generator, so different processes don't all
4202 have the same sequence. In the test harness we want different, but
4203 predictable settings for each delivery process, so do something explicit
4204 here rather they rely on the fixed reset in the random number function. */
4206 random_seed = running_in_test_harness? 42 + 2*delivery_count : 0;
4208 /* Set close-on-exec on the pipe so that it doesn't get passed on to
4209 a new process that may be forked to do another delivery down the same
4212 (void)fcntl(fd, F_SETFD, fcntl(fd, F_GETFD) | FD_CLOEXEC);
4214 /* Close open file descriptors for the pipes of other processes
4215 that are running in parallel. */
4217 for (poffset = 0; poffset < remote_max_parallel; poffset++)
4218 if (parlist[poffset].pid != 0) (void)close(parlist[poffset].fd);
4220 /* This process has inherited a copy of the file descriptor
4221 for the data file, but its file pointer is shared with all the
4222 other processes running in parallel. Therefore, we have to re-open
4223 the file in order to get a new file descriptor with its own
4224 file pointer. We don't need to lock it, as the lock is held by
4225 the parent process. There doesn't seem to be any way of doing
4226 a dup-with-new-file-pointer. */
4228 (void)close(deliver_datafile);
4229 sprintf(CS spoolname, "%s/input/%s/%s-D", spool_directory, message_subdir,
4231 deliver_datafile = Uopen(spoolname, O_RDWR | O_APPEND, 0);
4233 if (deliver_datafile < 0)
4234 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Failed to reopen %s for remote "
4235 "parallel delivery: %s", spoolname, strerror(errno));
4237 /* Set the close-on-exec flag */
4239 (void)fcntl(deliver_datafile, F_SETFD, fcntl(deliver_datafile, F_GETFD) |
4242 /* Set the uid/gid of this process; bombs out on failure. */
4244 exim_setugid(uid, gid, use_initgroups,
4245 string_sprintf("remote delivery to %s with transport=%s",
4246 addr->address, tp->name));
4248 /* Close the unwanted half of this process' pipe, set the process state,
4249 and run the transport. Afterwards, transport_count will contain the number
4250 of bytes written. */
4252 (void)close(pfd[pipe_read]);
4253 set_process_info("delivering %s using %s", message_id, tp->name);
4254 debug_print_string(tp->debug_string);
4255 if (!(tp->info->code)(addr->transport, addr)) replicate_status(addr);
4257 set_process_info("delivering %s (just run %s for %s%s in subprocess)",
4258 message_id, tp->name, addr->address, (addr->next == NULL)? "" : ", ...");
4260 /* Ensure any cached resources that we used are now released */
4264 /* Pass the result back down the pipe. This is a lot more information
4265 than is needed for a local delivery. We have to send back the error
4266 status for each address, the usability status for each host that is
4267 flagged as unusable, and all the retry items. When TLS is in use, we
4268 send also the cipher and peerdn information. Each type of information
4269 is flagged by an identifying byte, and is then in a fixed format (with
4270 strings terminated by zeros), and there is a final terminator at the
4271 end. The host information and retry information is all attached to
4272 the first address, so that gets sent at the start. */
4274 /* Host unusability information: for most success cases this will
4277 for (h = addr->host_list; h != NULL; h = h->next)
4279 if (h->address == NULL || h->status < hstatus_unusable) continue;
4280 sprintf(CS big_buffer, "%c%c%s", h->status, h->why, h->address);
4281 rmt_dlv_checked_write(fd, 'H', '0', big_buffer, Ustrlen(big_buffer+2) + 3);
4284 /* The number of bytes written. This is the same for each address. Even
4285 if we sent several copies of the message down the same connection, the
4286 size of each one is the same, and it's that value we have got because
4287 transport_count gets reset before calling transport_write_message(). */
4289 memcpy(big_buffer, &transport_count, sizeof(transport_count));
4290 rmt_dlv_checked_write(fd, 'S', '0', big_buffer, sizeof(transport_count));
4292 /* Information about what happened to each address. Four item types are
4293 used: an optional 'X' item first, for TLS information, then an optional "C"
4294 item for any client-auth info followed by 'R' items for any retry settings,
4295 and finally an 'A' item for the remaining data. */
4297 for(; addr != NULL; addr = addr->next)
4302 /* The certificate verification status goes into the flags */
4303 if (tls_out.certificate_verified) setflag(addr, af_cert_verified);
4304 #ifdef EXPERIMENTAL_DANE
4305 if (tls_out.dane_verified) setflag(addr, af_dane_verified);
4308 /* Use an X item only if there's something to send */
4313 sprintf(CS ptr, "%.128s", addr->cipher);
4319 sprintf(CS ptr, "%.512s", addr->peerdn);
4323 rmt_dlv_checked_write(fd, 'X', '1', big_buffer, ptr - big_buffer);
4328 if (!tls_export_cert(ptr, big_buffer_size-2, addr->peercert))
4332 rmt_dlv_checked_write(fd, 'X', '2', big_buffer, ptr - big_buffer);
4337 if (!tls_export_cert(ptr, big_buffer_size-2, addr->ourcert))
4341 rmt_dlv_checked_write(fd, 'X', '3', big_buffer, ptr - big_buffer);
4343 # ifndef DISABLE_OCSP
4344 if (addr->ocsp > OCSP_NOT_REQ)
4347 sprintf(CS ptr, "%c", addr->ocsp + '0');
4349 rmt_dlv_checked_write(fd, 'X', '4', big_buffer, ptr - big_buffer);
4352 #endif /*SUPPORT_TLS*/
4354 if (client_authenticator)
4357 sprintf(CS big_buffer, "%.64s", client_authenticator);
4359 rmt_dlv_checked_write(fd, 'C', '1', big_buffer, ptr - big_buffer);
4361 if (client_authenticated_id)
4364 sprintf(CS big_buffer, "%.64s", client_authenticated_id);
4366 rmt_dlv_checked_write(fd, 'C', '2', big_buffer, ptr - big_buffer);
4368 if (client_authenticated_sender)
4371 sprintf(CS big_buffer, "%.64s", client_authenticated_sender);
4373 rmt_dlv_checked_write(fd, 'C', '3', big_buffer, ptr - big_buffer);
4376 #ifndef DISABLE_PRDR
4377 if (addr->flags & af_prdr_used)
4378 rmt_dlv_checked_write(fd, 'P', '0', NULL, 0);
4381 memcpy(big_buffer, &addr->dsn_aware, sizeof(addr->dsn_aware));
4382 rmt_dlv_checked_write(fd, 'D', '0', big_buffer, sizeof(addr->dsn_aware));
4383 DEBUG(D_deliver) debug_printf("DSN write: addr->dsn_aware = %d\n", addr->dsn_aware);
4385 /* Retry information: for most success cases this will be null. */
4387 for (r = addr->retries; r != NULL; r = r->next)
4390 sprintf(CS big_buffer, "%c%.500s", r->flags, r->key);
4391 ptr = big_buffer + Ustrlen(big_buffer+2) + 3;
4392 memcpy(ptr, &(r->basic_errno), sizeof(r->basic_errno));
4393 ptr += sizeof(r->basic_errno);
4394 memcpy(ptr, &(r->more_errno), sizeof(r->more_errno));
4395 ptr += sizeof(r->more_errno);
4396 if (r->message == NULL) *ptr++ = 0; else
4398 sprintf(CS ptr, "%.512s", r->message);
4401 rmt_dlv_checked_write(fd, 'R', '0', big_buffer, ptr - big_buffer);
4404 /* The rest of the information goes in an 'A' item. */
4406 ptr = big_buffer + 2;
4407 sprintf(CS big_buffer, "%c%c", addr->transport_return,
4408 addr->special_action);
4409 memcpy(ptr, &(addr->basic_errno), sizeof(addr->basic_errno));
4410 ptr += sizeof(addr->basic_errno);
4411 memcpy(ptr, &(addr->more_errno), sizeof(addr->more_errno));
4412 ptr += sizeof(addr->more_errno);
4413 memcpy(ptr, &(addr->flags), sizeof(addr->flags));
4414 ptr += sizeof(addr->flags);
4416 if (addr->message == NULL) *ptr++ = 0; else
4418 sprintf(CS ptr, "%.1024s", addr->message);
4422 if (addr->user_message == NULL) *ptr++ = 0; else
4424 sprintf(CS ptr, "%.1024s", addr->user_message);
4428 if (addr->host_used == NULL) *ptr++ = 0; else
4430 sprintf(CS ptr, "%.256s", addr->host_used->name);
4432 sprintf(CS ptr, "%.64s", addr->host_used->address);
4434 memcpy(ptr, &(addr->host_used->port), sizeof(addr->host_used->port));
4435 ptr += sizeof(addr->host_used->port);
4437 /* DNS lookup status */
4438 *ptr++ = addr->host_used->dnssec==DS_YES ? '2'
4439 : addr->host_used->dnssec==DS_NO ? '1' : '0';
4442 rmt_dlv_checked_write(fd, 'A', '0', big_buffer, ptr - big_buffer);
4445 /* Local interface address/port */
4446 if (LOGGING(incoming_interface) && sending_ip_address)
4448 uschar * ptr = big_buffer;
4449 sprintf(CS ptr, "%.128s", sending_ip_address);
4451 sprintf(CS ptr, "%d", sending_port);
4454 rmt_dlv_checked_write(fd, 'I', '0', big_buffer, ptr - big_buffer);
4457 /* Add termination flag, close the pipe, and that's it. The character
4458 after 'Z' indicates whether continue_transport is now NULL or not.
4459 A change from non-NULL to NULL indicates a problem with a continuing
4462 big_buffer[0] = (continue_transport == NULL)? '0' : '1';
4463 rmt_dlv_checked_write(fd, 'Z', '0', big_buffer, 1);
4468 /* Back in the mainline: close the unwanted half of the pipe. */
4470 (void)close(pfd[pipe_write]);
4472 /* Fork failed; defer with error message */
4476 (void)close(pfd[pipe_read]);
4477 remote_post_process(addr, LOG_MAIN|LOG_PANIC,
4478 string_sprintf("fork failed for remote delivery to %s: %s",
4479 addr->domain, strerror(errno)), fallback);
4483 /* Fork succeeded; increment the count, and remember relevant data for
4484 when the process finishes. */
4487 parlist[poffset].addrlist = parlist[poffset].addr = addr;
4488 parlist[poffset].pid = pid;
4489 parlist[poffset].fd = pfd[pipe_read];
4490 parlist[poffset].done = FALSE;
4491 parlist[poffset].msg = NULL;
4492 parlist[poffset].return_path = return_path;
4494 /* If the process we've just started is sending a message down an existing
4495 channel, wait for it now. This ensures that only one such process runs at
4496 once, whatever the value of remote_max parallel. Otherwise, we might try to
4497 send two or more messages simultaneously down the same channel. This could
4498 happen if there are different domains that include the same host in otherwise
4499 different host lists.
4501 Also, if the transport closes down the channel, this information gets back
4502 (continue_transport gets set to NULL) before we consider any other addresses
4505 if (continue_transport != NULL) par_reduce(0, fallback);
4507 /* Otherwise, if we are running in the test harness, wait a bit, to let the
4508 newly created process get going before we create another process. This should
4509 ensure repeatability in the tests. We only need to wait a tad. */
4511 else if (running_in_test_harness) millisleep(500);
4514 /* Reached the end of the list of addresses. Wait for all the subprocesses that
4515 are still running and post-process their addresses. */
4517 par_reduce(0, fallback);
4524 /*************************************************
4525 * Split an address into local part and domain *
4526 *************************************************/
4528 /* This function initializes an address for routing by splitting it up into a
4529 local part and a domain. The local part is set up twice - once in its original
4530 casing, and once in lower case, and it is dequoted. We also do the "percent
4531 hack" for configured domains. This may lead to a DEFER result if a lookup
4532 defers. When a percent-hacking takes place, we insert a copy of the original
4533 address as a new parent of this address, as if we have had a redirection.
4536 addr points to an addr_item block containing the address
4539 DEFER - could not determine if domain is %-hackable
4543 deliver_split_address(address_item *addr)
4545 uschar *address = addr->address;
4546 uschar *domain = Ustrrchr(address, '@');
4548 int len = domain - address;
4550 addr->domain = string_copylc(domain+1); /* Domains are always caseless */
4552 /* The implication in the RFCs (though I can't say I've seen it spelled out
4553 explicitly) is that quoting should be removed from local parts at the point
4554 where they are locally interpreted. [The new draft "821" is more explicit on
4555 this, Jan 1999.] We know the syntax is valid, so this can be done by simply
4556 removing quoting backslashes and any unquoted doublequotes. */
4558 t = addr->cc_local_part = store_get(len+1);
4561 register int c = *address++;
4562 if (c == '\"') continue;
4572 /* We do the percent hack only for those domains that are listed in
4573 percent_hack_domains. A loop is required, to copy with multiple %-hacks. */
4575 if (percent_hack_domains != NULL)
4578 uschar *new_address = NULL;
4579 uschar *local_part = addr->cc_local_part;
4581 deliver_domain = addr->domain; /* set $domain */
4583 while ((rc = match_isinlist(deliver_domain, (const uschar **)&percent_hack_domains, 0,
4584 &domainlist_anchor, addr->domain_cache, MCL_DOMAIN, TRUE, NULL))
4586 (t = Ustrrchr(local_part, '%')) != NULL)
4588 new_address = string_copy(local_part);
4589 new_address[t - local_part] = '@';
4590 deliver_domain = string_copylc(t+1);
4591 local_part = string_copyn(local_part, t - local_part);
4594 if (rc == DEFER) return DEFER; /* lookup deferred */
4596 /* If hackery happened, set up new parent and alter the current address. */
4598 if (new_address != NULL)
4600 address_item *new_parent = store_get(sizeof(address_item));
4601 *new_parent = *addr;
4602 addr->parent = new_parent;
4603 addr->address = new_address;
4604 addr->unique = string_copy(new_address);
4605 addr->domain = deliver_domain;
4606 addr->cc_local_part = local_part;
4607 DEBUG(D_deliver) debug_printf("%%-hack changed address to: %s\n",
4612 /* Create the lowercased version of the final local part, and make that the
4613 default one to be used. */
4615 addr->local_part = addr->lc_local_part = string_copylc(addr->cc_local_part);
4622 /*************************************************
4623 * Get next error message text *
4624 *************************************************/
4626 /* If f is not NULL, read the next "paragraph", from a customized error message
4627 text file, terminated by a line containing ****, and expand it.
4630 f NULL or a file to read from
4631 which string indicating which string (for errors)
4633 Returns: NULL or an expanded string
4637 next_emf(FILE *f, uschar *which)
4641 uschar *para, *yield;
4644 if (f == NULL) return NULL;
4646 if (Ufgets(buffer, sizeof(buffer), f) == NULL ||
4647 Ustrcmp(buffer, "****\n") == 0) return NULL;
4649 para = store_get(size);
4652 para = string_cat(para, &size, &ptr, buffer, Ustrlen(buffer));
4653 if (Ufgets(buffer, sizeof(buffer), f) == NULL ||
4654 Ustrcmp(buffer, "****\n") == 0) break;
4658 yield = expand_string(para);
4659 if (yield != NULL) return yield;
4661 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand string from "
4662 "bounce_message_file or warn_message_file (%s): %s", which,
4663 expand_string_message);
4670 /*************************************************
4671 * Close down a passed transport channel *
4672 *************************************************/
4674 /* This function is called when a passed transport channel cannot be used.
4675 It attempts to close it down tidily. The yield is always DELIVER_NOT_ATTEMPTED
4676 so that the function call can be the argument of a "return" statement.
4679 Returns: DELIVER_NOT_ATTEMPTED
4683 continue_closedown(void)
4685 if (continue_transport != NULL)
4687 transport_instance *t;
4688 for (t = transports; t != NULL; t = t->next)
4690 if (Ustrcmp(t->name, continue_transport) == 0)
4692 if (t->info->closedown != NULL) (t->info->closedown)(t);
4697 return DELIVER_NOT_ATTEMPTED;
4703 /*************************************************
4704 * Print address information *
4705 *************************************************/
4707 /* This function is called to output an address, or information about an
4708 address, for bounce or defer messages. If the hide_child flag is set, all we
4709 output is the original ancestor address.
4712 addr points to the address
4713 f the FILE to print to
4714 si an initial string
4715 sc a continuation string for before "generated"
4718 Returns: TRUE if the address is not hidden
4722 print_address_information(address_item *addr, FILE *f, uschar *si, uschar *sc,
4726 uschar *printed = US"";
4727 address_item *ancestor = addr;
4728 while (ancestor->parent != NULL) ancestor = ancestor->parent;
4730 fprintf(f, "%s", CS si);
4732 if (addr->parent != NULL && testflag(addr, af_hide_child))
4734 printed = US"an undisclosed address";
4737 else if (!testflag(addr, af_pfr) || addr->parent == NULL)
4738 printed = addr->address;
4742 uschar *s = addr->address;
4745 if (addr->address[0] == '>') { ss = US"mail"; s++; }
4746 else if (addr->address[0] == '|') ss = US"pipe";
4749 fprintf(f, "%s to %s%sgenerated by ", ss, s, sc);
4750 printed = addr->parent->address;
4753 fprintf(f, "%s", CS string_printing(printed));
4755 if (ancestor != addr)
4757 uschar *original = (ancestor->onetime_parent == NULL)?
4758 ancestor->address : ancestor->onetime_parent;
4759 if (strcmpic(original, printed) != 0)
4760 fprintf(f, "%s(%sgenerated from %s)", sc,
4761 (ancestor != addr->parent)? "ultimately " : "",
4762 string_printing(original));
4765 if (addr->host_used)
4766 fprintf(f, "\n host %s [%s]",
4767 addr->host_used->name, addr->host_used->address);
4769 fprintf(f, "%s", CS se);
4777 /*************************************************
4778 * Print error for an address *
4779 *************************************************/
4781 /* This function is called to print the error information out of an address for
4782 a bounce or a warning message. It tries to format the message reasonably by
4783 introducing newlines. All lines are indented by 4; the initial printing
4784 position must be set before calling.
4786 This function used always to print the error. Nowadays we want to restrict it
4787 to cases such as LMTP/SMTP errors from a remote host, and errors from :fail:
4788 and filter "fail". We no longer pass other information willy-nilly in bounce
4789 and warning messages. Text in user_message is always output; text in message
4790 only if the af_pass_message flag is set.
4794 f the FILE to print on
4801 print_address_error(address_item *addr, FILE *f, uschar *t)
4803 int count = Ustrlen(t);
4804 uschar *s = testflag(addr, af_pass_message)? addr->message : NULL;
4806 if (!s && !(s = addr->user_message))
4809 fprintf(f, "\n %s", t);
4812 if (*s == '\\' && s[1] == 'n')
4822 if (*s++ == ':' && isspace(*s) && count > 45)
4824 fprintf(f, "\n "); /* sic (because space follows) */
4831 /***********************************************************
4832 * Print Diagnostic-Code for an address *
4833 ************************************************************/
4835 /* This function is called to print the error information out of an address for
4836 a bounce or a warning message. It tries to format the message reasonably as
4837 required by RFC 3461 by adding a space after each newline
4839 it uses the same logic as print_address_error() above. if af_pass_message is true
4840 and addr->message is set it uses the remote host answer. if not addr->user_message
4841 is used instead if available.
4845 f the FILE to print on
4851 print_dsn_diagnostic_code(const address_item *addr, FILE *f)
4853 uschar *s = testflag(addr, af_pass_message) ? addr->message : NULL;
4855 /* af_pass_message and addr->message set ? print remote host answer */
4859 debug_printf("DSN Diagnostic-Code: addr->message = %s\n", addr->message);
4861 /* search first ": ". we assume to find the remote-MTA answer there */
4862 if (!(s = Ustrstr(addr->message, ": ")))
4863 return; /* not found, bail out */
4864 s += 2; /* skip ": " */
4865 fprintf(f, "Diagnostic-Code: smtp; ");
4867 /* no message available. do nothing */
4871 if (*s == '\\' && s[1] == 'n')
4873 fputs("\n ", f); /* as defined in RFC 3461 */
4883 /*************************************************
4884 * Check list of addresses for duplication *
4885 *************************************************/
4887 /* This function was introduced when the test for duplicate addresses that are
4888 not pipes, files, or autoreplies was moved from the middle of routing to when
4889 routing was complete. That was to fix obscure cases when the routing history
4890 affects the subsequent routing of identical addresses. This function is called
4891 after routing, to check that the final routed addresses are not duplicates.
4893 If we detect a duplicate, we remember what it is a duplicate of. Note that
4894 pipe, file, and autoreply de-duplication is handled during routing, so we must
4895 leave such "addresses" alone here, as otherwise they will incorrectly be
4898 Argument: address of list anchor
4903 do_duplicate_check(address_item **anchor)
4906 while ((addr = *anchor) != NULL)
4909 if (testflag(addr, af_pfr))
4911 anchor = &(addr->next);
4913 else if ((tnode = tree_search(tree_duplicates, addr->unique)) != NULL)
4915 DEBUG(D_deliver|D_route)
4916 debug_printf("%s is a duplicate address: discarded\n", addr->unique);
4917 *anchor = addr->next;
4918 addr->dupof = tnode->data.ptr;
4919 addr->next = addr_duplicate;
4920 addr_duplicate = addr;
4924 tree_add_duplicate(addr->unique, addr);
4925 anchor = &(addr->next);
4933 /*************************************************
4934 * Deliver one message *
4935 *************************************************/
4937 /* This is the function which is called when a message is to be delivered. It
4938 is passed the id of the message. It is possible that the message no longer
4939 exists, if some other process has delivered it, and it is also possible that
4940 the message is being worked on by another process, in which case the data file
4943 If no delivery is attempted for any of the above reasons, the function returns
4944 DELIVER_NOT_ATTEMPTED.
4946 If the give_up flag is set true, do not attempt any deliveries, but instead
4947 fail all outstanding addresses and return the message to the sender (or
4950 A delivery operation has a process all to itself; we never deliver more than
4951 one message in the same process. Therefore we needn't worry too much about
4955 id the id of the message to be delivered
4956 forced TRUE if delivery was forced by an administrator; this overrides
4957 retry delays and causes a delivery to be tried regardless
4958 give_up TRUE if an administrator has requested that delivery attempts
4961 Returns: When the global variable mua_wrapper is FALSE:
4962 DELIVER_ATTEMPTED_NORMAL if a delivery attempt was made
4963 DELIVER_NOT_ATTEMPTED otherwise (see comment above)
4964 When the global variable mua_wrapper is TRUE:
4965 DELIVER_MUA_SUCCEEDED if delivery succeeded
4966 DELIVER_MUA_FAILED if delivery failed
4967 DELIVER_NOT_ATTEMPTED if not attempted (should not occur)
4971 deliver_message(uschar *id, BOOL forced, BOOL give_up)
4974 int final_yield = DELIVER_ATTEMPTED_NORMAL;
4975 time_t now = time(NULL);
4976 address_item *addr_last = NULL;
4977 uschar *filter_message = NULL;
4979 int process_recipients = RECIP_ACCEPT;
4982 extern int acl_where;
4984 uschar *info = (queue_run_pid == (pid_t)0)?
4985 string_sprintf("delivering %s", id) :
4986 string_sprintf("delivering %s (queue run pid %d)", id, queue_run_pid);
4988 /* If the D_process_info bit is on, set_process_info() will output debugging
4989 information. If not, we want to show this initial information if D_deliver or
4990 D_queue_run is set or in verbose mode. */
4992 set_process_info("%s", info);
4994 if ((debug_selector & D_process_info) == 0 &&
4995 (debug_selector & (D_deliver|D_queue_run|D_v)) != 0)
4996 debug_printf("%s\n", info);
4998 /* Ensure that we catch any subprocesses that are created. Although Exim
4999 sets SIG_DFL as its initial default, some routes through the code end up
5000 here with it set to SIG_IGN - cases where a non-synchronous delivery process
5001 has been forked, but no re-exec has been done. We use sigaction rather than
5002 plain signal() on those OS where SA_NOCLDWAIT exists, because we want to be
5003 sure it is turned off. (There was a problem on AIX with this.) */
5007 struct sigaction act;
5008 act.sa_handler = SIG_DFL;
5009 sigemptyset(&(act.sa_mask));
5011 sigaction(SIGCHLD, &act, NULL);
5014 signal(SIGCHLD, SIG_DFL);
5017 /* Make the forcing flag available for routers and transports, set up the
5018 global message id field, and initialize the count for returned files and the
5019 message size. This use of strcpy() is OK because the length id is checked when
5020 it is obtained from a command line (the -M or -q options), and otherwise it is
5021 known to be a valid message id. */
5023 Ustrcpy(message_id, id);
5024 deliver_force = forced;
5028 /* Initialize some flags */
5030 update_spool = FALSE;
5031 remove_journal = TRUE;
5033 /* Set a known context for any ACLs we call via expansions */
5034 acl_where = ACL_WHERE_DELIVERY;
5036 /* Reset the random number generator, so that if several delivery processes are
5037 started from a queue runner that has already used random numbers (for sorting),
5038 they don't all get the same sequence. */
5042 /* Open and lock the message's data file. Exim locks on this one because the
5043 header file may get replaced as it is re-written during the delivery process.
5044 Any failures cause messages to be written to the log, except for missing files
5045 while queue running - another process probably completed delivery. As part of
5046 opening the data file, message_subdir gets set. */
5048 if (!spool_open_datafile(id))
5049 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5051 /* The value of message_size at this point has been set to the data length,
5052 plus one for the blank line that notionally precedes the data. */
5054 /* Now read the contents of the header file, which will set up the headers in
5055 store, and also the list of recipients and the tree of non-recipients and
5056 assorted flags. It updates message_size. If there is a reading or format error,
5057 give up; if the message has been around for sufficiently long, remove it. */
5059 sprintf(CS spoolname, "%s-H", id);
5060 if ((rc = spool_read_header(spoolname, TRUE, TRUE)) != spool_read_OK)
5062 if (errno == ERRNO_SPOOLFORMAT)
5064 struct stat statbuf;
5065 sprintf(CS big_buffer, "%s/input/%s/%s", spool_directory, message_subdir,
5067 if (Ustat(big_buffer, &statbuf) == 0)
5068 log_write(0, LOG_MAIN, "Format error in spool file %s: "
5069 "size=" OFF_T_FMT, spoolname, statbuf.st_size);
5070 else log_write(0, LOG_MAIN, "Format error in spool file %s", spoolname);
5073 log_write(0, LOG_MAIN, "Error reading spool file %s: %s", spoolname,
5076 /* If we managed to read the envelope data, received_time contains the
5077 time the message was received. Otherwise, we can calculate it from the
5080 if (rc != spool_read_hdrerror)
5083 for (i = 0; i < 6; i++)
5084 received_time = received_time * BASE_62 + tab62[id[i] - '0'];
5087 /* If we've had this malformed message too long, sling it. */
5089 if (now - received_time > keep_malformed)
5091 sprintf(CS spoolname, "%s/msglog/%s/%s", spool_directory, message_subdir, id);
5093 sprintf(CS spoolname, "%s/input/%s/%s-D", spool_directory, message_subdir, id);
5095 sprintf(CS spoolname, "%s/input/%s/%s-H", spool_directory, message_subdir, id);
5097 sprintf(CS spoolname, "%s/input/%s/%s-J", spool_directory, message_subdir, id);
5099 log_write(0, LOG_MAIN, "Message removed because older than %s",
5100 readconf_printtime(keep_malformed));
5103 (void)close(deliver_datafile);
5104 deliver_datafile = -1;
5105 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5108 /* The spool header file has been read. Look to see if there is an existing
5109 journal file for this message. If there is, it means that a previous delivery
5110 attempt crashed (program or host) before it could update the spool header file.
5111 Read the list of delivered addresses from the journal and add them to the
5112 nonrecipients tree. Then update the spool file. We can leave the journal in
5113 existence, as it will get further successful deliveries added to it in this
5114 run, and it will be deleted if this function gets to its end successfully.
5115 Otherwise it might be needed again. */
5117 sprintf(CS spoolname, "%s/input/%s/%s-J", spool_directory, message_subdir, id);
5118 jread = Ufopen(spoolname, "rb");
5121 while (Ufgets(big_buffer, big_buffer_size, jread) != NULL)
5123 int n = Ustrlen(big_buffer);
5124 big_buffer[n-1] = 0;
5125 tree_add_nonrecipient(big_buffer);
5126 DEBUG(D_deliver) debug_printf("Previously delivered address %s taken from "
5127 "journal file\n", big_buffer);
5129 (void)fclose(jread);
5130 /* Panic-dies on error */
5131 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
5133 else if (errno != ENOENT)
5135 log_write(0, LOG_MAIN|LOG_PANIC, "attempt to open journal for reading gave: "
5136 "%s", strerror(errno));
5137 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5140 /* A null recipients list indicates some kind of disaster. */
5142 if (recipients_list == NULL)
5144 (void)close(deliver_datafile);
5145 deliver_datafile = -1;
5146 log_write(0, LOG_MAIN, "Spool error: no recipients for %s", spoolname);
5147 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5151 /* Handle a message that is frozen. There are a number of different things that
5152 can happen, but in the default situation, unless forced, no delivery is
5157 #ifdef SUPPORT_MOVE_FROZEN_MESSAGES
5158 /* Moving to another directory removes the message from Exim's view. Other
5159 tools must be used to deal with it. Logging of this action happens in
5160 spool_move_message() and its subfunctions. */
5162 if (move_frozen_messages &&
5163 spool_move_message(id, message_subdir, US"", US"F"))
5164 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5167 /* For all frozen messages (bounces or not), timeout_frozen_after sets the
5168 maximum time to keep messages that are frozen. Thaw if we reach it, with a
5169 flag causing all recipients to be failed. The time is the age of the
5170 message, not the time since freezing. */
5172 if (timeout_frozen_after > 0 && message_age >= timeout_frozen_after)
5174 log_write(0, LOG_MAIN, "cancelled by timeout_frozen_after");
5175 process_recipients = RECIP_FAIL_TIMEOUT;
5178 /* For bounce messages (and others with no sender), thaw if the error message
5179 ignore timer is exceeded. The message will be discarded if this delivery
5182 else if (sender_address[0] == 0 && message_age >= ignore_bounce_errors_after)
5184 log_write(0, LOG_MAIN, "Unfrozen by errmsg timer");
5187 /* If this is a bounce message, or there's no auto thaw, or we haven't
5188 reached the auto thaw time yet, and this delivery is not forced by an admin
5189 user, do not attempt delivery of this message. Note that forced is set for
5190 continuing messages down the same channel, in order to skip load checking and
5191 ignore hold domains, but we don't want unfreezing in that case. */
5195 if ((sender_address[0] == 0 ||
5197 now <= deliver_frozen_at + auto_thaw
5200 (!forced || !deliver_force_thaw || !admin_user ||
5201 continue_hostname != NULL
5204 (void)close(deliver_datafile);
5205 deliver_datafile = -1;
5206 log_write(L_skip_delivery, LOG_MAIN, "Message is frozen");
5207 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5210 /* If delivery was forced (by an admin user), assume a manual thaw.
5211 Otherwise it's an auto thaw. */
5215 deliver_manual_thaw = TRUE;
5216 log_write(0, LOG_MAIN, "Unfrozen by forced delivery");
5218 else log_write(0, LOG_MAIN, "Unfrozen by auto-thaw");
5221 /* We get here if any of the rules for unfreezing have triggered. */
5223 deliver_freeze = FALSE;
5224 update_spool = TRUE;
5228 /* Open the message log file if we are using them. This records details of
5229 deliveries, deferments, and failures for the benefit of the mail administrator.
5230 The log is not used by exim itself to track the progress of a message; that is
5231 done by rewriting the header spool file. */
5238 sprintf(CS spoolname, "%s/msglog/%s/%s", spool_directory, message_subdir, id);
5239 fd = open_msglog_file(spoolname, SPOOL_MODE, &error);
5243 log_write(0, LOG_MAIN|LOG_PANIC, "Couldn't %s message log %s: %s", error,
5244 spoolname, strerror(errno));
5245 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5248 /* Make a C stream out of it. */
5250 message_log = fdopen(fd, "a");
5251 if (message_log == NULL)
5253 log_write(0, LOG_MAIN|LOG_PANIC, "Couldn't fdopen message log %s: %s",
5254 spoolname, strerror(errno));
5255 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5260 /* If asked to give up on a message, log who did it, and set the action for all
5265 struct passwd *pw = getpwuid(real_uid);
5266 log_write(0, LOG_MAIN, "cancelled by %s", (pw != NULL)?
5267 US pw->pw_name : string_sprintf("uid %ld", (long int)real_uid));
5268 process_recipients = RECIP_FAIL;
5271 /* Otherwise, if there are too many Received: headers, fail all recipients. */
5273 else if (received_count > received_headers_max)
5274 process_recipients = RECIP_FAIL_LOOP;
5276 /* Otherwise, if a system-wide, address-independent message filter is
5277 specified, run it now, except in the case when we are failing all recipients as
5278 a result of timeout_frozen_after. If the system filter yields "delivered", then
5279 ignore the true recipients of the message. Failure of the filter file is
5280 logged, and the delivery attempt fails. */
5282 else if (system_filter != NULL && process_recipients != RECIP_FAIL_TIMEOUT)
5287 redirect_block redirect;
5289 if (system_filter_uid_set)
5291 ugid.uid = system_filter_uid;
5292 ugid.gid = system_filter_gid;
5293 ugid.uid_set = ugid.gid_set = TRUE;
5297 ugid.uid_set = ugid.gid_set = FALSE;
5300 return_path = sender_address;
5301 enable_dollar_recipients = TRUE; /* Permit $recipients in system filter */
5302 system_filtering = TRUE;
5304 /* Any error in the filter file causes a delivery to be abandoned. */
5306 redirect.string = system_filter;
5307 redirect.isfile = TRUE;
5308 redirect.check_owner = redirect.check_group = FALSE;
5309 redirect.owners = NULL;
5310 redirect.owngroups = NULL;
5312 redirect.modemask = 0;
5314 DEBUG(D_deliver|D_filter) debug_printf("running system filter\n");
5317 &redirect, /* Where the data is */
5318 RDO_DEFER | /* Turn on all the enabling options */
5319 RDO_FAIL | /* Leave off all the disabling options */
5324 NULL, /* No :include: restriction (not used in filter) */
5325 NULL, /* No sieve vacation directory (not sieve!) */
5326 NULL, /* No sieve enotify mailto owner (not sieve!) */
5327 NULL, /* No sieve user address (not sieve!) */
5328 NULL, /* No sieve subaddress (not sieve!) */
5329 &ugid, /* uid/gid data */
5330 &addr_new, /* Where to hang generated addresses */
5331 &filter_message, /* Where to put error message */
5332 NULL, /* Don't skip syntax errors */
5333 &filtertype, /* Will always be set to FILTER_EXIM for this call */
5334 US"system filter"); /* For error messages */
5336 DEBUG(D_deliver|D_filter) debug_printf("system filter returned %d\n", rc);
5338 if (rc == FF_ERROR || rc == FF_NONEXIST)
5340 (void)close(deliver_datafile);
5341 deliver_datafile = -1;
5342 log_write(0, LOG_MAIN|LOG_PANIC, "Error in system filter: %s",
5343 string_printing(filter_message));
5344 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5347 /* Reset things. If the filter message is an empty string, which can happen
5348 for a filter "fail" or "freeze" command with no text, reset it to NULL. */
5350 system_filtering = FALSE;
5351 enable_dollar_recipients = FALSE;
5352 if (filter_message != NULL && filter_message[0] == 0) filter_message = NULL;
5354 /* Save the values of the system filter variables so that user filters
5357 memcpy(filter_sn, filter_n, sizeof(filter_sn));
5359 /* The filter can request that delivery of the original addresses be
5364 process_recipients = RECIP_DEFER;
5365 deliver_msglog("Delivery deferred by system filter\n");
5366 log_write(0, LOG_MAIN, "Delivery deferred by system filter");
5369 /* The filter can request that a message be frozen, but this does not
5370 take place if the message has been manually thawed. In that case, we must
5371 unset "delivered", which is forced by the "freeze" command to make -bF
5374 else if (rc == FF_FREEZE && !deliver_manual_thaw)
5376 deliver_freeze = TRUE;
5377 deliver_frozen_at = time(NULL);
5378 process_recipients = RECIP_DEFER;
5379 frozen_info = string_sprintf(" by the system filter%s%s",
5380 (filter_message == NULL)? US"" : US": ",
5381 (filter_message == NULL)? US"" : filter_message);
5384 /* The filter can request that a message be failed. The error message may be
5385 quite long - it is sent back to the sender in the bounce - but we don't want
5386 to fill up the log with repetitions of it. If it starts with << then the text
5387 between << and >> is written to the log, with the rest left for the bounce
5390 else if (rc == FF_FAIL)
5392 uschar *colon = US"";
5393 uschar *logmsg = US"";
5396 process_recipients = RECIP_FAIL_FILTER;
5398 if (filter_message != NULL)
5402 if (filter_message[0] == '<' && filter_message[1] == '<' &&
5403 (logend = Ustrstr(filter_message, ">>")) != NULL)
5405 logmsg = filter_message + 2;
5406 loglen = logend - logmsg;
5407 filter_message = logend + 2;
5408 if (filter_message[0] == 0) filter_message = NULL;
5412 logmsg = filter_message;
5413 loglen = Ustrlen(filter_message);
5417 log_write(0, LOG_MAIN, "cancelled by system filter%s%.*s", colon, loglen,
5421 /* Delivery can be restricted only to those recipients (if any) that the
5422 filter specified. */
5424 else if (rc == FF_DELIVERED)
5426 process_recipients = RECIP_IGNORE;
5427 if (addr_new == NULL)
5428 log_write(0, LOG_MAIN, "=> discarded (system filter)");
5430 log_write(0, LOG_MAIN, "original recipients ignored (system filter)");
5433 /* If any new addresses were created by the filter, fake up a "parent"
5434 for them. This is necessary for pipes, etc., which are expected to have
5435 parents, and it also gives some sensible logging for others. Allow
5436 pipes, files, and autoreplies, and run them as the filter uid if set,
5437 otherwise as the current uid. */
5439 if (addr_new != NULL)
5441 int uid = (system_filter_uid_set)? system_filter_uid : geteuid();
5442 int gid = (system_filter_gid_set)? system_filter_gid : getegid();
5444 /* The text "system-filter" is tested in transport_set_up_command() and in
5445 set_up_shell_command() in the pipe transport, to enable them to permit
5446 $recipients, so don't change it here without also changing it there. */
5448 address_item *p = addr_new;
5449 address_item *parent = deliver_make_addr(US"system-filter", FALSE);
5451 parent->domain = string_copylc(qualify_domain_recipient);
5452 parent->local_part = US"system-filter";
5454 /* As part of this loop, we arrange for addr_last to end up pointing
5455 at the final address. This is used if we go on to add addresses for the
5456 original recipients. */
5460 if (parent->child_count == SHRT_MAX)
5461 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "system filter generated more "
5462 "than %d delivery addresses", SHRT_MAX);
5463 parent->child_count++;
5466 if (testflag(p, af_pfr))
5472 setflag(p, af_uid_set |
5478 /* Find the name of the system filter's appropriate pfr transport */
5480 if (p->address[0] == '|')
5483 tpname = system_filter_pipe_transport;
5484 address_pipe = p->address;
5486 else if (p->address[0] == '>')
5489 tpname = system_filter_reply_transport;
5493 if (p->address[Ustrlen(p->address)-1] == '/')
5495 type = US"directory";
5496 tpname = system_filter_directory_transport;
5501 tpname = system_filter_file_transport;
5503 address_file = p->address;
5506 /* Now find the actual transport, first expanding the name. We have
5507 set address_file or address_pipe above. */
5511 uschar *tmp = expand_string(tpname);
5512 address_file = address_pipe = NULL;
5514 p->message = string_sprintf("failed to expand \"%s\" as a "
5515 "system filter transport name", tpname);
5520 p->message = string_sprintf("system_filter_%s_transport is unset",
5526 transport_instance *tp;
5527 for (tp = transports; tp != NULL; tp = tp->next)
5529 if (Ustrcmp(tp->name, tpname) == 0)
5536 p->message = string_sprintf("failed to find \"%s\" transport "
5537 "for system filter delivery", tpname);
5540 /* If we couldn't set up a transport, defer the delivery, putting the
5541 error on the panic log as well as the main log. */
5543 if (p->transport == NULL)
5545 address_item *badp = p;
5547 if (addr_last == NULL) addr_new = p; else addr_last->next = p;
5548 badp->local_part = badp->address; /* Needed for log line */
5549 post_process_one(badp, DEFER, LOG_MAIN|LOG_PANIC, DTYPE_ROUTER, 0);
5552 } /* End of pfr handling */
5554 /* Either a non-pfr delivery, or we found a transport */
5556 DEBUG(D_deliver|D_filter)
5557 debug_printf("system filter added %s\n", p->address);
5561 } /* Loop through all addr_new addresses */
5566 /* Scan the recipients list, and for every one that is not in the non-
5567 recipients tree, add an addr item to the chain of new addresses. If the pno
5568 value is non-negative, we must set the onetime parent from it. This which
5569 points to the relevant entry in the recipients list.
5571 This processing can be altered by the setting of the process_recipients
5572 variable, which is changed if recipients are to be ignored, failed, or
5573 deferred. This can happen as a result of system filter activity, or if the -Mg
5574 option is used to fail all of them.
5576 Duplicate addresses are handled later by a different tree structure; we can't
5577 just extend the non-recipients tree, because that will be re-written to the
5578 spool if the message is deferred, and in any case there are casing
5579 complications for local addresses. */
5581 if (process_recipients != RECIP_IGNORE)
5583 for (i = 0; i < recipients_count; i++)
5585 if (tree_search(tree_nonrecipients, recipients_list[i].address) == NULL)
5587 recipient_item *r = recipients_list + i;
5588 address_item *new = deliver_make_addr(r->address, FALSE);
5589 new->prop.errors_address = r->errors_to;
5590 #ifdef EXPERIMENTAL_INTERNATIONAL
5591 if ((new->prop.utf8_msg = message_smtputf8))
5593 new->prop.utf8_downcvt = message_utf8_downconvert == 1;
5594 new->prop.utf8_downcvt_maybe = message_utf8_downconvert == -1;
5595 DEBUG(D_deliver) debug_printf("utf8, downconvert %s\n",
5596 new->prop.utf8_downcvt ? "yes"
5597 : new->prop.utf8_downcvt_maybe ? "ifneeded"
5603 new->onetime_parent = recipients_list[r->pno].address;
5605 /* If DSN support is enabled, set the dsn flags and the original receipt
5606 to be passed on to other DSN enabled MTAs */
5607 new->dsn_flags = r->dsn_flags & rf_dsnflags;
5608 new->dsn_orcpt = r->orcpt;
5609 DEBUG(D_deliver) debug_printf("DSN: set orcpt: %s flags: %d\n",
5610 new->dsn_orcpt, new->dsn_flags);
5612 switch (process_recipients)
5614 /* RECIP_DEFER is set when a system filter freezes a message. */
5617 new->next = addr_defer;
5622 /* RECIP_FAIL_FILTER is set when a system filter has obeyed a "fail"
5625 case RECIP_FAIL_FILTER:
5627 (filter_message == NULL)? US"delivery cancelled" : filter_message;
5628 setflag(new, af_pass_message);
5629 goto RECIP_QUEUE_FAILED; /* below */
5632 /* RECIP_FAIL_TIMEOUT is set when a message is frozen, but is older
5633 than the value in timeout_frozen_after. Treat non-bounce messages
5634 similarly to -Mg; for bounce messages we just want to discard, so
5635 don't put the address on the failed list. The timeout has already
5638 case RECIP_FAIL_TIMEOUT:
5639 new->message = US"delivery cancelled; message timed out";
5640 goto RECIP_QUEUE_FAILED; /* below */
5643 /* RECIP_FAIL is set when -Mg has been used. */
5646 new->message = US"delivery cancelled by administrator";
5649 /* Common code for the failure cases above. If this is not a bounce
5650 message, put the address on the failed list so that it is used to
5651 create a bounce. Otherwise do nothing - this just discards the address.
5652 The incident has already been logged. */
5655 if (sender_address[0] != 0)
5657 new->next = addr_failed;
5663 /* RECIP_FAIL_LOOP is set when there are too many Received: headers
5664 in the message. Process each address as a routing failure; if this
5665 is a bounce message, it will get frozen. */
5667 case RECIP_FAIL_LOOP:
5668 new->message = US"Too many \"Received\" headers - suspected mail loop";
5669 post_process_one(new, FAIL, LOG_MAIN, DTYPE_ROUTER, 0);
5673 /* Value should be RECIP_ACCEPT; take this as the safe default. */
5676 if (addr_new == NULL) addr_new = new; else addr_last->next = new;
5681 #ifdef EXPERIMENTAL_EVENT
5682 if (process_recipients != RECIP_ACCEPT)
5684 uschar * save_local = deliver_localpart;
5685 const uschar * save_domain = deliver_domain;
5687 deliver_localpart = expand_string(
5688 string_sprintf("${local_part:%s}", new->address));
5689 deliver_domain = expand_string(
5690 string_sprintf("${domain:%s}", new->address));
5692 (void) event_raise(event_action,
5693 US"msg:fail:internal", new->message);
5695 deliver_localpart = save_local;
5696 deliver_domain = save_domain;
5705 address_item *p = addr_new;
5706 debug_printf("Delivery address list:\n");
5709 debug_printf(" %s %s\n", p->address, (p->onetime_parent == NULL)? US"" :
5715 /* Set up the buffers used for copying over the file when delivering. */
5717 deliver_in_buffer = store_malloc(DELIVER_IN_BUFFER_SIZE);
5718 deliver_out_buffer = store_malloc(DELIVER_OUT_BUFFER_SIZE);
5722 /* Until there are no more new addresses, handle each one as follows:
5724 . If this is a generated address (indicated by the presence of a parent
5725 pointer) then check to see whether it is a pipe, file, or autoreply, and
5726 if so, handle it directly here. The router that produced the address will
5727 have set the allow flags into the address, and also set the uid/gid required.
5728 Having the routers generate new addresses and then checking them here at
5729 the outer level is tidier than making each router do the checking, and
5730 means that routers don't need access to the failed address queue.
5732 . Break up the address into local part and domain, and make lowercased
5733 versions of these strings. We also make unquoted versions of the local part.
5735 . Handle the percent hack for those domains for which it is valid.
5737 . For child addresses, determine if any of the parents have the same address.
5738 If so, generate a different string for previous delivery checking. Without
5739 this code, if the address spqr generates spqr via a forward or alias file,
5740 delivery of the generated spqr stops further attempts at the top level spqr,
5741 which is not what is wanted - it may have generated other addresses.
5743 . Check on the retry database to see if routing was previously deferred, but
5744 only if in a queue run. Addresses that are to be routed are put on the
5745 addr_route chain. Addresses that are to be deferred are put on the
5746 addr_defer chain. We do all the checking first, so as not to keep the
5747 retry database open any longer than necessary.
5749 . Now we run the addresses through the routers. A router may put the address
5750 on either the addr_local or the addr_remote chain for local or remote
5751 delivery, respectively, or put it on the addr_failed chain if it is
5752 undeliveable, or it may generate child addresses and put them on the
5753 addr_new chain, or it may defer an address. All the chain anchors are
5754 passed as arguments so that the routers can be called for verification
5757 . If new addresses have been generated by the routers, da capo.
5760 header_rewritten = FALSE; /* No headers rewritten yet */
5761 while (addr_new != NULL) /* Loop until all addresses dealt with */
5763 address_item *addr, *parent;
5764 dbm_file = dbfn_open(US"retry", O_RDONLY, &dbblock, FALSE);
5766 /* Failure to open the retry database is treated the same as if it does
5767 not exist. In both cases, dbm_file is NULL. */
5769 if (dbm_file == NULL)
5771 DEBUG(D_deliver|D_retry|D_route|D_hints_lookup)
5772 debug_printf("no retry data available\n");
5775 /* Scan the current batch of new addresses, to handle pipes, files and
5776 autoreplies, and determine which others are ready for routing. */
5778 while (addr_new != NULL)
5783 dbdata_retry *domain_retry_record;
5784 dbdata_retry *address_retry_record;
5787 addr_new = addr->next;
5789 DEBUG(D_deliver|D_retry|D_route)
5791 debug_printf(">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>\n");
5792 debug_printf("Considering: %s\n", addr->address);
5795 /* Handle generated address that is a pipe or a file or an autoreply. */
5797 if (testflag(addr, af_pfr))
5799 /* If an autoreply in a filter could not generate a syntactically valid
5800 address, give up forthwith. Set af_ignore_error so that we don't try to
5801 generate a bounce. */
5803 if (testflag(addr, af_bad_reply))
5805 addr->basic_errno = ERRNO_BADADDRESS2;
5806 addr->local_part = addr->address;
5808 US"filter autoreply generated syntactically invalid recipient";
5809 setflag(addr, af_ignore_error);
5810 (void)post_process_one(addr, FAIL, LOG_MAIN, DTYPE_ROUTER, 0);
5811 continue; /* with the next new address */
5814 /* If two different users specify delivery to the same pipe or file or
5815 autoreply, there should be two different deliveries, so build a unique
5816 string that incorporates the original address, and use this for
5817 duplicate testing and recording delivery, and also for retrying. */
5820 string_sprintf("%s:%s", addr->address, addr->parent->unique +
5821 (testflag(addr->parent, af_homonym)? 3:0));
5823 addr->address_retry_key = addr->domain_retry_key =
5824 string_sprintf("T:%s", addr->unique);
5826 /* If a filter file specifies two deliveries to the same pipe or file,
5827 we want to de-duplicate, but this is probably not wanted for two mail
5828 commands to the same address, where probably both should be delivered.
5829 So, we have to invent a different unique string in that case. Just
5830 keep piling '>' characters on the front. */
5832 if (addr->address[0] == '>')
5834 while (tree_search(tree_duplicates, addr->unique) != NULL)
5835 addr->unique = string_sprintf(">%s", addr->unique);
5838 else if ((tnode = tree_search(tree_duplicates, addr->unique)) != NULL)
5840 DEBUG(D_deliver|D_route)
5841 debug_printf("%s is a duplicate address: discarded\n", addr->address);
5842 addr->dupof = tnode->data.ptr;
5843 addr->next = addr_duplicate;
5844 addr_duplicate = addr;
5848 DEBUG(D_deliver|D_route) debug_printf("unique = %s\n", addr->unique);
5850 /* Check for previous delivery */
5852 if (tree_search(tree_nonrecipients, addr->unique) != NULL)
5854 DEBUG(D_deliver|D_route)
5855 debug_printf("%s was previously delivered: discarded\n", addr->address);
5856 child_done(addr, tod_stamp(tod_log));
5860 /* Save for checking future duplicates */
5862 tree_add_duplicate(addr->unique, addr);
5864 /* Set local part and domain */
5866 addr->local_part = addr->address;
5867 addr->domain = addr->parent->domain;
5869 /* Ensure that the delivery is permitted. */
5871 if (testflag(addr, af_file))
5873 if (!testflag(addr, af_allow_file))
5875 addr->basic_errno = ERRNO_FORBIDFILE;
5876 addr->message = US"delivery to file forbidden";
5877 (void)post_process_one(addr, FAIL, LOG_MAIN, DTYPE_ROUTER, 0);
5878 continue; /* with the next new address */
5881 else if (addr->address[0] == '|')
5883 if (!testflag(addr, af_allow_pipe))
5885 addr->basic_errno = ERRNO_FORBIDPIPE;
5886 addr->message = US"delivery to pipe forbidden";
5887 (void)post_process_one(addr, FAIL, LOG_MAIN, DTYPE_ROUTER, 0);
5888 continue; /* with the next new address */
5891 else if (!testflag(addr, af_allow_reply))
5893 addr->basic_errno = ERRNO_FORBIDREPLY;
5894 addr->message = US"autoreply forbidden";
5895 (void)post_process_one(addr, FAIL, LOG_MAIN, DTYPE_ROUTER, 0);
5896 continue; /* with the next new address */
5899 /* If the errno field is already set to BADTRANSPORT, it indicates
5900 failure to expand a transport string, or find the associated transport,
5901 or an unset transport when one is required. Leave this test till now so
5902 that the forbid errors are given in preference. */
5904 if (addr->basic_errno == ERRNO_BADTRANSPORT)
5906 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_ROUTER, 0);
5910 /* Treat /dev/null as a special case and abandon the delivery. This
5911 avoids having to specify a uid on the transport just for this case.
5912 Arrange for the transport name to be logged as "**bypassed**". */
5914 if (Ustrcmp(addr->address, "/dev/null") == 0)
5916 uschar *save = addr->transport->name;
5917 addr->transport->name = US"**bypassed**";
5918 (void)post_process_one(addr, OK, LOG_MAIN, DTYPE_TRANSPORT, '=');
5919 addr->transport->name = save;
5920 continue; /* with the next new address */
5923 /* Pipe, file, or autoreply delivery is to go ahead as a normal local
5926 DEBUG(D_deliver|D_route)
5927 debug_printf("queued for %s transport\n", addr->transport->name);
5928 addr->next = addr_local;
5930 continue; /* with the next new address */
5933 /* Handle normal addresses. First, split up into local part and domain,
5934 handling the %-hack if necessary. There is the possibility of a defer from
5935 a lookup in percent_hack_domains. */
5937 if ((rc = deliver_split_address(addr)) == DEFER)
5939 addr->message = US"cannot check percent_hack_domains";
5940 addr->basic_errno = ERRNO_LISTDEFER;
5941 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_NONE, 0);
5945 /* Check to see if the domain is held. If so, proceed only if the
5946 delivery was forced by hand. */
5948 deliver_domain = addr->domain; /* set $domain */
5949 if (!forced && hold_domains != NULL &&
5950 (rc = match_isinlist(addr->domain, (const uschar **)&hold_domains, 0,
5951 &domainlist_anchor, addr->domain_cache, MCL_DOMAIN, TRUE,
5956 addr->message = US"hold_domains lookup deferred";
5957 addr->basic_errno = ERRNO_LISTDEFER;
5961 addr->message = US"domain is held";
5962 addr->basic_errno = ERRNO_HELD;
5964 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_NONE, 0);
5968 /* Now we can check for duplicates and previously delivered addresses. In
5969 order to do this, we have to generate a "unique" value for each address,
5970 because there may be identical actual addresses in a line of descendents.
5971 The "unique" field is initialized to the same value as the "address" field,
5972 but gets changed here to cope with identically-named descendents. */
5974 for (parent = addr->parent; parent != NULL; parent = parent->parent)
5975 if (strcmpic(addr->address, parent->address) == 0) break;
5977 /* If there's an ancestor with the same name, set the homonym flag. This
5978 influences how deliveries are recorded. Then add a prefix on the front of
5979 the unique address. We use \n\ where n starts at 0 and increases each time.
5980 It is unlikely to pass 9, but if it does, it may look odd but will still
5981 work. This means that siblings or cousins with the same names are treated
5982 as duplicates, which is what we want. */
5986 setflag(addr, af_homonym);
5987 if (parent->unique[0] != '\\')
5988 addr->unique = string_sprintf("\\0\\%s", addr->address);
5990 addr->unique = string_sprintf("\\%c\\%s", parent->unique[1] + 1,
5994 /* Ensure that the domain in the unique field is lower cased, because
5995 domains are always handled caselessly. */
5997 p = Ustrrchr(addr->unique, '@');
5998 while (*p != 0) { *p = tolower(*p); p++; }
6000 DEBUG(D_deliver|D_route) debug_printf("unique = %s\n", addr->unique);
6002 if (tree_search(tree_nonrecipients, addr->unique) != NULL)
6004 DEBUG(D_deliver|D_route)
6005 debug_printf("%s was previously delivered: discarded\n", addr->unique);
6006 child_done(addr, tod_stamp(tod_log));
6010 /* Get the routing retry status, saving the two retry keys (with and
6011 without the local part) for subsequent use. If there is no retry record for
6012 the standard address routing retry key, we look for the same key with the
6013 sender attached, because this form is used by the smtp transport after a
6014 4xx response to RCPT when address_retry_include_sender is true. */
6016 addr->domain_retry_key = string_sprintf("R:%s", addr->domain);
6017 addr->address_retry_key = string_sprintf("R:%s@%s", addr->local_part,
6020 if (dbm_file == NULL)
6021 domain_retry_record = address_retry_record = NULL;
6024 domain_retry_record = dbfn_read(dbm_file, addr->domain_retry_key);
6025 if (domain_retry_record != NULL &&
6026 now - domain_retry_record->time_stamp > retry_data_expire)
6027 domain_retry_record = NULL; /* Ignore if too old */
6029 address_retry_record = dbfn_read(dbm_file, addr->address_retry_key);
6030 if (address_retry_record != NULL &&
6031 now - address_retry_record->time_stamp > retry_data_expire)
6032 address_retry_record = NULL; /* Ignore if too old */
6034 if (address_retry_record == NULL)
6036 uschar *altkey = string_sprintf("%s:<%s>", addr->address_retry_key,
6038 address_retry_record = dbfn_read(dbm_file, altkey);
6039 if (address_retry_record != NULL &&
6040 now - address_retry_record->time_stamp > retry_data_expire)
6041 address_retry_record = NULL; /* Ignore if too old */
6045 DEBUG(D_deliver|D_retry)
6047 if (domain_retry_record == NULL)
6048 debug_printf("no domain retry record\n");
6049 if (address_retry_record == NULL)
6050 debug_printf("no address retry record\n");
6053 /* If we are sending a message down an existing SMTP connection, we must
6054 assume that the message which created the connection managed to route
6055 an address to that connection. We do not want to run the risk of taking
6056 a long time over routing here, because if we do, the server at the other
6057 end of the connection may time it out. This is especially true for messages
6058 with lots of addresses. For this kind of delivery, queue_running is not
6059 set, so we would normally route all addresses. We take a pragmatic approach
6060 and defer routing any addresses that have any kind of domain retry record.
6061 That is, we don't even look at their retry times. It doesn't matter if this
6062 doesn't work occasionally. This is all just an optimization, after all.
6064 The reason for not doing the same for address retries is that they normally
6065 arise from 4xx responses, not DNS timeouts. */
6067 if (continue_hostname != NULL && domain_retry_record != NULL)
6069 addr->message = US"reusing SMTP connection skips previous routing defer";
6070 addr->basic_errno = ERRNO_RRETRY;
6071 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_ROUTER, 0);
6074 /* If we are in a queue run, defer routing unless there is no retry data or
6075 we've passed the next retry time, or this message is forced. In other
6076 words, ignore retry data when not in a queue run.
6078 However, if the domain retry time has expired, always allow the routing
6079 attempt. If it fails again, the address will be failed. This ensures that
6080 each address is routed at least once, even after long-term routing
6083 If there is an address retry, check that too; just wait for the next
6084 retry time. This helps with the case when the temporary error on the
6085 address was really message-specific rather than address specific, since
6086 it allows other messages through.
6088 We also wait for the next retry time if this is a message sent down an
6089 existing SMTP connection (even though that will be forced). Otherwise there
6090 will be far too many attempts for an address that gets a 4xx error. In
6091 fact, after such an error, we should not get here because, the host should
6092 not be remembered as one this message needs. However, there was a bug that
6093 used to cause this to happen, so it is best to be on the safe side.
6095 Even if we haven't reached the retry time in the hints, there is one more
6096 check to do, which is for the ultimate address timeout. We only do this
6097 check if there is an address retry record and there is not a domain retry
6098 record; this implies that previous attempts to handle the address had the
6099 retry_use_local_parts option turned on. We use this as an approximation
6100 for the destination being like a local delivery, for example delivery over
6101 LMTP to an IMAP message store. In this situation users are liable to bump
6102 into their quota and thereby have intermittently successful deliveries,
6103 which keep the retry record fresh, which can lead to us perpetually
6104 deferring messages. */
6106 else if (((queue_running && !deliver_force) || continue_hostname != NULL)
6108 ((domain_retry_record != NULL &&
6109 now < domain_retry_record->next_try &&
6110 !domain_retry_record->expired)
6112 (address_retry_record != NULL &&
6113 now < address_retry_record->next_try))
6115 (domain_retry_record != NULL ||
6116 address_retry_record == NULL ||
6117 !retry_ultimate_address_timeout(addr->address_retry_key,
6118 addr->domain, address_retry_record, now)))
6120 addr->message = US"retry time not reached";
6121 addr->basic_errno = ERRNO_RRETRY;
6122 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_ROUTER, 0);
6125 /* The domain is OK for routing. Remember if retry data exists so it
6126 can be cleaned up after a successful delivery. */
6130 if (domain_retry_record != NULL || address_retry_record != NULL)
6131 setflag(addr, af_dr_retry_exists);
6132 addr->next = addr_route;
6134 DEBUG(D_deliver|D_route)
6135 debug_printf("%s: queued for routing\n", addr->address);
6139 /* The database is closed while routing is actually happening. Requests to
6140 update it are put on a chain and all processed together at the end. */
6142 if (dbm_file != NULL) dbfn_close(dbm_file);
6144 /* If queue_domains is set, we don't even want to try routing addresses in
6145 those domains. During queue runs, queue_domains is forced to be unset.
6146 Optimize by skipping this pass through the addresses if nothing is set. */
6148 if (!deliver_force && queue_domains != NULL)
6150 address_item *okaddr = NULL;
6151 while (addr_route != NULL)
6153 address_item *addr = addr_route;
6154 addr_route = addr->next;
6156 deliver_domain = addr->domain; /* set $domain */
6157 if ((rc = match_isinlist(addr->domain, (const uschar **)&queue_domains, 0,
6158 &domainlist_anchor, addr->domain_cache, MCL_DOMAIN, TRUE, NULL))
6163 addr->basic_errno = ERRNO_LISTDEFER;
6164 addr->message = US"queue_domains lookup deferred";
6165 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_ROUTER, 0);
6169 addr->next = okaddr;
6175 addr->basic_errno = ERRNO_QUEUE_DOMAIN;
6176 addr->message = US"domain is in queue_domains";
6177 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_ROUTER, 0);
6181 addr_route = okaddr;
6184 /* Now route those addresses that are not deferred. */
6186 while (addr_route != NULL)
6189 address_item *addr = addr_route;
6190 const uschar *old_domain = addr->domain;
6191 uschar *old_unique = addr->unique;
6192 addr_route = addr->next;
6195 /* Just in case some router parameter refers to it. */
6197 return_path = (addr->prop.errors_address != NULL)?
6198 addr->prop.errors_address : sender_address;
6200 /* If a router defers an address, add a retry item. Whether or not to
6201 use the local part in the key is a property of the router. */
6203 if ((rc = route_address(addr, &addr_local, &addr_remote, &addr_new,
6204 &addr_succeed, v_none)) == DEFER)
6205 retry_add_item(addr, (addr->router->retry_use_local_part)?
6206 string_sprintf("R:%s@%s", addr->local_part, addr->domain) :
6207 string_sprintf("R:%s", addr->domain), 0);
6209 /* Otherwise, if there is an existing retry record in the database, add
6210 retry items to delete both forms. We must also allow for the possibility
6211 of a routing retry that includes the sender address. Since the domain might
6212 have been rewritten (expanded to fully qualified) as a result of routing,
6213 ensure that the rewritten form is also deleted. */
6215 else if (testflag(addr, af_dr_retry_exists))
6217 uschar *altkey = string_sprintf("%s:<%s>", addr->address_retry_key,
6219 retry_add_item(addr, altkey, rf_delete);
6220 retry_add_item(addr, addr->address_retry_key, rf_delete);
6221 retry_add_item(addr, addr->domain_retry_key, rf_delete);
6222 if (Ustrcmp(addr->domain, old_domain) != 0)
6223 retry_add_item(addr, string_sprintf("R:%s", old_domain), rf_delete);
6226 /* DISCARD is given for :blackhole: and "seen finish". The event has been
6227 logged, but we need to ensure the address (and maybe parents) is marked
6232 address_done(addr, tod_stamp(tod_log));
6233 continue; /* route next address */
6236 /* The address is finished with (failed or deferred). */
6240 (void)post_process_one(addr, rc, LOG_MAIN, DTYPE_ROUTER, 0);
6241 continue; /* route next address */
6244 /* The address has been routed. If the router changed the domain, it will
6245 also have changed the unique address. We have to test whether this address
6246 has already been delivered, because it's the unique address that finally
6249 if (addr->unique != old_unique &&
6250 tree_search(tree_nonrecipients, addr->unique) != 0)
6252 DEBUG(D_deliver|D_route) debug_printf("%s was previously delivered: "
6253 "discarded\n", addr->address);
6254 if (addr_remote == addr) addr_remote = addr->next;
6255 else if (addr_local == addr) addr_local = addr->next;
6258 /* If the router has same_domain_copy_routing set, we are permitted to copy
6259 the routing for any other addresses with the same domain. This is an
6260 optimisation to save repeated DNS lookups for "standard" remote domain
6261 routing. The option is settable only on routers that generate host lists.
6262 We play it very safe, and do the optimization only if the address is routed
6263 to a remote transport, there are no header changes, and the domain was not
6264 modified by the router. */
6266 if (addr_remote == addr &&
6267 addr->router->same_domain_copy_routing &&
6268 addr->prop.extra_headers == NULL &&
6269 addr->prop.remove_headers == NULL &&
6270 old_domain == addr->domain)
6272 address_item **chain = &addr_route;
6273 while (*chain != NULL)
6275 address_item *addr2 = *chain;
6276 if (Ustrcmp(addr2->domain, addr->domain) != 0)
6278 chain = &(addr2->next);
6282 /* Found a suitable address; take it off the routing list and add it to
6283 the remote delivery list. */
6285 *chain = addr2->next;
6286 addr2->next = addr_remote;
6287 addr_remote = addr2;
6289 /* Copy the routing data */
6291 addr2->domain = addr->domain;
6292 addr2->router = addr->router;
6293 addr2->transport = addr->transport;
6294 addr2->host_list = addr->host_list;
6295 addr2->fallback_hosts = addr->fallback_hosts;
6296 addr2->prop.errors_address = addr->prop.errors_address;
6297 copyflag(addr2, addr, af_hide_child | af_local_host_removed);
6299 DEBUG(D_deliver|D_route)
6301 debug_printf(">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>\n"
6303 "Routing for %s copied from %s\n",
6304 addr2->address, addr2->address, addr->address);
6308 } /* Continue with routing the next address. */
6309 } /* Loop to process any child addresses that the routers created, and
6310 any rerouted addresses that got put back on the new chain. */
6313 /* Debugging: show the results of the routing */
6315 DEBUG(D_deliver|D_retry|D_route)
6317 address_item *p = addr_local;
6318 debug_printf(">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>\n");
6319 debug_printf("After routing:\n Local deliveries:\n");
6322 debug_printf(" %s\n", p->address);
6327 debug_printf(" Remote deliveries:\n");
6330 debug_printf(" %s\n", p->address);
6335 debug_printf(" Failed addresses:\n");
6338 debug_printf(" %s\n", p->address);
6343 debug_printf(" Deferred addresses:\n");
6346 debug_printf(" %s\n", p->address);
6351 /* Free any resources that were cached during routing. */
6356 /* These two variables are set only during routing, after check_local_user.
6357 Ensure they are not set in transports. */
6359 local_user_gid = (gid_t)(-1);
6360 local_user_uid = (uid_t)(-1);
6362 /* Check for any duplicate addresses. This check is delayed until after
6363 routing, because the flexibility of the routing configuration means that
6364 identical addresses with different parentage may end up being redirected to
6365 different addresses. Checking for duplicates too early (as we previously used
6366 to) makes this kind of thing not work. */
6368 do_duplicate_check(&addr_local);
6369 do_duplicate_check(&addr_remote);
6371 /* When acting as an MUA wrapper, we proceed only if all addresses route to a
6372 remote transport. The check that they all end up in one transaction happens in
6373 the do_remote_deliveries() function. */
6375 if (mua_wrapper && (addr_local != NULL || addr_failed != NULL ||
6376 addr_defer != NULL))
6379 uschar *which, *colon, *msg;
6381 if (addr_local != NULL)
6386 else if (addr_defer != NULL)
6389 which = US"deferred";
6397 while (addr->parent != NULL) addr = addr->parent;
6399 if (addr->message != NULL)
6402 msg = addr->message;
6404 else colon = msg = US"";
6406 /* We don't need to log here for a forced failure as it will already
6407 have been logged. Defer will also have been logged, but as a defer, so we do
6408 need to do the failure logging. */
6410 if (addr != addr_failed)
6411 log_write(0, LOG_MAIN, "** %s routing yielded a %s delivery",
6412 addr->address, which);
6414 /* Always write an error to the caller */
6416 fprintf(stderr, "routing %s yielded a %s delivery%s%s\n", addr->address,
6419 final_yield = DELIVER_MUA_FAILED;
6420 addr_failed = addr_defer = NULL; /* So that we remove the message */
6421 goto DELIVERY_TIDYUP;
6425 /* If this is a run to continue deliveries to an external channel that is
6426 already set up, defer any local deliveries. */
6428 if (continue_transport != NULL)
6430 if (addr_defer == NULL) addr_defer = addr_local; else
6432 address_item *addr = addr_defer;
6433 while (addr->next != NULL) addr = addr->next;
6434 addr->next = addr_local;
6440 /* Because address rewriting can happen in the routers, we should not really do
6441 ANY deliveries until all addresses have been routed, so that all recipients of
6442 the message get the same headers. However, this is in practice not always
6443 possible, since sometimes remote addresses give DNS timeouts for days on end.
6444 The pragmatic approach is to deliver what we can now, saving any rewritten
6445 headers so that at least the next lot of recipients benefit from the rewriting
6446 that has already been done.
6448 If any headers have been rewritten during routing, update the spool file to
6449 remember them for all subsequent deliveries. This can be delayed till later if
6450 there is only address to be delivered - if it succeeds the spool write need not
6453 if (header_rewritten &&
6454 ((addr_local != NULL &&
6455 (addr_local->next != NULL || addr_remote != NULL)) ||
6456 (addr_remote != NULL && addr_remote->next != NULL)))
6458 /* Panic-dies on error */
6459 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
6460 header_rewritten = FALSE;
6464 /* If there are any deliveries to be done, open the journal file. This is used
6465 to record successful deliveries as soon as possible after each delivery is
6466 known to be complete. A file opened with O_APPEND is used so that several
6467 processes can run simultaneously.
6469 The journal is just insurance against crashes. When the spool file is
6470 ultimately updated at the end of processing, the journal is deleted. If a
6471 journal is found to exist at the start of delivery, the addresses listed
6472 therein are added to the non-recipients. */
6474 if (addr_local != NULL || addr_remote != NULL)
6476 sprintf(CS spoolname, "%s/input/%s/%s-J", spool_directory, message_subdir, id);
6477 journal_fd = Uopen(spoolname, O_WRONLY|O_APPEND|O_CREAT, SPOOL_MODE);
6481 log_write(0, LOG_MAIN|LOG_PANIC, "Couldn't open journal file %s: %s",
6482 spoolname, strerror(errno));
6483 return DELIVER_NOT_ATTEMPTED;
6486 /* Set the close-on-exec flag, make the file owned by Exim, and ensure
6487 that the mode is correct - the group setting doesn't always seem to get
6488 set automatically. */
6490 if( fcntl(journal_fd, F_SETFD, fcntl(journal_fd, F_GETFD) | FD_CLOEXEC)
6491 || fchown(journal_fd, exim_uid, exim_gid)
6492 || fchmod(journal_fd, SPOOL_MODE)
6495 int ret = Uunlink(spoolname);
6496 log_write(0, LOG_MAIN|LOG_PANIC, "Couldn't set perms on journal file %s: %s",
6497 spoolname, strerror(errno));
6498 if(ret && errno != ENOENT)
6499 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s",
6500 spoolname, strerror(errno));
6501 return DELIVER_NOT_ATTEMPTED;
6507 /* Now we can get down to the business of actually doing deliveries. Local
6508 deliveries are done first, then remote ones. If ever the problems of how to
6509 handle fallback transports are figured out, this section can be put into a loop
6510 for handling fallbacks, though the uid switching will have to be revised. */
6512 /* Precompile a regex that is used to recognize a parameter in response
6513 to an LHLO command, if is isn't already compiled. This may be used on both
6514 local and remote LMTP deliveries. */
6516 if (regex_IGNOREQUOTA == NULL) regex_IGNOREQUOTA =
6517 regex_must_compile(US"\\n250[\\s\\-]IGNOREQUOTA(\\s|\\n|$)", FALSE, TRUE);
6519 /* Handle local deliveries */
6521 if (addr_local != NULL)
6523 DEBUG(D_deliver|D_transport)
6524 debug_printf(">>>>>>>>>>>>>>>> Local deliveries >>>>>>>>>>>>>>>>\n");
6525 do_local_deliveries();
6526 disable_logging = FALSE;
6529 /* If queue_run_local is set, we do not want to attempt any remote deliveries,
6530 so just queue them all. */
6532 if (queue_run_local)
6534 while (addr_remote != NULL)
6536 address_item *addr = addr_remote;
6537 addr_remote = addr->next;
6539 addr->basic_errno = ERRNO_LOCAL_ONLY;
6540 addr->message = US"remote deliveries suppressed";
6541 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_TRANSPORT, 0);
6545 /* Handle remote deliveries */
6547 if (addr_remote != NULL)
6549 DEBUG(D_deliver|D_transport)
6550 debug_printf(">>>>>>>>>>>>>>>> Remote deliveries >>>>>>>>>>>>>>>>\n");
6552 /* Precompile some regex that are used to recognize parameters in response
6553 to an EHLO command, if they aren't already compiled. */
6557 /* Now sort the addresses if required, and do the deliveries. The yield of
6558 do_remote_deliveries is FALSE when mua_wrapper is set and all addresses
6559 cannot be delivered in one transaction. */
6561 if (remote_sort_domains != NULL) sort_remote_deliveries();
6562 if (!do_remote_deliveries(FALSE))
6564 log_write(0, LOG_MAIN, "** mua_wrapper is set but recipients cannot all "
6565 "be delivered in one transaction");
6566 fprintf(stderr, "delivery to smarthost failed (configuration problem)\n");
6568 final_yield = DELIVER_MUA_FAILED;
6569 addr_failed = addr_defer = NULL; /* So that we remove the message */
6570 goto DELIVERY_TIDYUP;
6573 /* See if any of the addresses that failed got put on the queue for delivery
6574 to their fallback hosts. We do it this way because often the same fallback
6575 host is used for many domains, so all can be sent in a single transaction
6576 (if appropriately configured). */
6578 if (addr_fallback != NULL && !mua_wrapper)
6580 DEBUG(D_deliver) debug_printf("Delivering to fallback hosts\n");
6581 addr_remote = addr_fallback;
6582 addr_fallback = NULL;
6583 if (remote_sort_domains != NULL) sort_remote_deliveries();
6584 do_remote_deliveries(TRUE);
6586 disable_logging = FALSE;
6590 /* All deliveries are now complete. Ignore SIGTERM during this tidying up
6591 phase, to minimize cases of half-done things. */
6594 debug_printf(">>>>>>>>>>>>>>>> deliveries are done >>>>>>>>>>>>>>>>\n");
6596 /* Root privilege is no longer needed */
6598 exim_setugid(exim_uid, exim_gid, FALSE, US"post-delivery tidying");
6600 set_process_info("tidying up after delivering %s", message_id);
6601 signal(SIGTERM, SIG_IGN);
6603 /* When we are acting as an MUA wrapper, the smtp transport will either have
6604 succeeded for all addresses, or failed them all in normal cases. However, there
6605 are some setup situations (e.g. when a named port does not exist) that cause an
6606 immediate exit with deferral of all addresses. Convert those into failures. We
6607 do not ever want to retry, nor do we want to send a bounce message. */
6611 if (addr_defer != NULL)
6613 address_item *addr, *nextaddr;
6614 for (addr = addr_defer; addr != NULL; addr = nextaddr)
6616 log_write(0, LOG_MAIN, "** %s mua_wrapper forced failure for deferred "
6617 "delivery", addr->address);
6618 nextaddr = addr->next;
6619 addr->next = addr_failed;
6625 /* Now all should either have succeeded or failed. */
6627 if (addr_failed == NULL) final_yield = DELIVER_MUA_SUCCEEDED; else
6629 uschar *s = (addr_failed->user_message != NULL)?
6630 addr_failed->user_message : addr_failed->message;
6633 fprintf(stderr, "Delivery failed: ");
6634 if (addr_failed->basic_errno > 0)
6636 fprintf(stderr, "%s", strerror(addr_failed->basic_errno));
6637 if (s != NULL) fprintf(stderr, ": ");
6639 if ((host = addr_failed->host_used))
6640 fprintf(stderr, "H=%s [%s]: ", host->name, host->address);
6643 if (addr_failed->basic_errno <= 0) fprintf(stderr, "unknown error");
6645 else fprintf(stderr, "%s", CS s);
6646 fprintf(stderr, "\n");
6648 final_yield = DELIVER_MUA_FAILED;
6653 /* In a normal configuration, we now update the retry database. This is done in
6654 one fell swoop at the end in order not to keep opening and closing (and
6655 locking) the database. The code for handling retries is hived off into a
6656 separate module for convenience. We pass it the addresses of the various
6657 chains, because deferred addresses can get moved onto the failed chain if the
6658 retry cutoff time has expired for all alternative destinations. Bypass the
6659 updating of the database if the -N flag is set, which is a debugging thing that
6660 prevents actual delivery. */
6662 else if (!dont_deliver) retry_update(&addr_defer, &addr_failed, &addr_succeed);
6664 /* Send DSN for successful messages */
6665 addr_dsntmp = addr_succeed;
6666 addr_senddsn = NULL;
6670 /* af_ignore_error not honored here. it's not an error */
6673 debug_printf("DSN: processing router : %s\n"
6674 "DSN: processing successful delivery address: %s\n"
6675 "DSN: Sender_address: %s\n"
6676 "DSN: orcpt: %s flags: %d\n"
6677 "DSN: envid: %s ret: %d\n"
6678 "DSN: Final recipient: %s\n"
6679 "DSN: Remote SMTP server supports DSN: %d\n",
6680 addr_dsntmp->router->name,
6681 addr_dsntmp->address,
6683 addr_dsntmp->dsn_orcpt, addr_dsntmp->dsn_flags,
6685 addr_dsntmp->address,
6686 addr_dsntmp->dsn_aware
6690 /* send report if next hop not DSN aware or a router flagged "last DSN hop"
6691 and a report was requested */
6692 if ( ( addr_dsntmp->dsn_aware != dsn_support_yes
6693 || addr_dsntmp->dsn_flags & rf_dsnlasthop
6695 && addr_dsntmp->dsn_flags & rf_dsnflags
6696 && addr_dsntmp->dsn_flags & rf_notify_success
6699 /* copy and relink address_item and send report with all of them at once later */
6700 address_item *addr_next;
6701 addr_next = addr_senddsn;
6702 addr_senddsn = store_get(sizeof(address_item));
6703 memcpy(addr_senddsn, addr_dsntmp, sizeof(address_item));
6704 addr_senddsn->next = addr_next;
6707 DEBUG(D_deliver) debug_printf("DSN: not sending DSN success message\n");
6709 addr_dsntmp = addr_dsntmp->next;
6717 /* create exim process to send message */
6718 pid = child_open_exim(&fd);
6720 DEBUG(D_deliver) debug_printf("DSN: child_open_exim returns: %d\n", pid);
6722 if (pid < 0) /* Creation of child failed */
6724 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Process %d (parent %d) failed to "
6725 "create child process to send failure message: %s", getpid(),
6726 getppid(), strerror(errno));
6728 DEBUG(D_deliver) debug_printf("DSN: child_open_exim failed\n");
6730 else /* Creation of child succeeded */
6732 FILE *f = fdopen(fd, "wb");
6733 /* header only as required by RFC. only failure DSN needs to honor RET=FULL */
6734 int topt = topt_add_return_path | topt_no_body;
6738 debug_printf("sending error message to: %s\n", sender_address);
6740 /* build unique id for MIME boundary */
6741 bound = string_sprintf(TIME_T_FMT "-eximdsn-%d", time(NULL), rand());
6742 DEBUG(D_deliver) debug_printf("DSN: MIME boundary: %s\n", bound);
6744 if (errors_reply_to)
6745 fprintf(f, "Reply-To: %s\n", errors_reply_to);
6747 fprintf(f, "Auto-Submitted: auto-generated\n"
6748 "From: Mail Delivery System <Mailer-Daemon@%s>\n"
6750 "Subject: Delivery Status Notification\n"
6751 "Content-Type: multipart/report; report-type=delivery-status; boundary=%s\n"
6752 "MIME-Version: 1.0\n\n"
6755 "Content-type: text/plain; charset=us-ascii\n\n"
6757 "This message was created automatically by mail delivery software.\n"
6758 " ----- The following addresses had successful delivery notifications -----\n",
6759 qualify_domain_sender, sender_address, bound, bound);
6761 for (addr_dsntmp = addr_senddsn; addr_dsntmp;
6762 addr_dsntmp = addr_dsntmp->next)
6763 fprintf(f, "<%s> (relayed %s)\n\n",
6764 addr_dsntmp->address,
6765 (addr_dsntmp->dsn_flags & rf_dsnlasthop) == 1
6766 ? "via non DSN router"
6767 : addr_dsntmp->dsn_aware == dsn_support_no
6768 ? "to non-DSN-aware mailer"
6769 : "via non \"Remote SMTP\" router"
6773 "Content-type: message/delivery-status\n\n"
6774 "Reporting-MTA: dns; %s\n",
6775 bound, smtp_active_hostname);
6778 { /* must be decoded from xtext: see RFC 3461:6.3a */
6780 if (auth_xtextdecode(dsn_envid, &xdec_envid) > 0)
6781 fprintf(f, "Original-Envelope-ID: %s\n", dsn_envid);
6783 fprintf(f, "X-Original-Envelope-ID: error decoding xtext formated ENVID\n");
6787 for (addr_dsntmp = addr_senddsn;
6789 addr_dsntmp = addr_dsntmp->next)
6791 if (addr_dsntmp->dsn_orcpt)
6792 fprintf(f,"Original-Recipient: %s\n", addr_dsntmp->dsn_orcpt);
6794 fprintf(f, "Action: delivered\n"
6795 "Final-Recipient: rfc822;%s\n"
6797 addr_dsntmp->address);
6799 if (addr_dsntmp->host_used && addr_dsntmp->host_used->name)
6800 fprintf(f, "Remote-MTA: dns; %s\nDiagnostic-Code: smtp; 250 Ok\n\n",
6801 addr_dsntmp->host_used->name);
6803 fprintf(f, "Diagnostic-Code: X-Exim; relayed via non %s router\n\n",
6804 (addr_dsntmp->dsn_flags & rf_dsnlasthop) == 1 ? "DSN" : "SMTP");
6807 fprintf(f, "--%s\nContent-type: text/rfc822-headers\n\n", bound);
6810 transport_filter_argv = NULL; /* Just in case */
6811 return_path = sender_address; /* In case not previously set */
6813 /* Write the original email out */
6814 transport_write_message(NULL, fileno(f), topt, 0, NULL, NULL, NULL, NULL, NULL, 0);
6817 fprintf(f,"\n--%s--\n", bound);
6821 rc = child_close(pid, 0); /* Waits for child to close, no timeout */
6825 /* If any addresses failed, we must send a message to somebody, unless
6826 af_ignore_error is set, in which case no action is taken. It is possible for
6827 several messages to get sent if there are addresses with different
6830 while (addr_failed != NULL)
6834 uschar *logtod = tod_stamp(tod_log);
6836 address_item *handled_addr = NULL;
6837 address_item **paddr;
6838 address_item *msgchain = NULL;
6839 address_item **pmsgchain = &msgchain;
6841 /* There are weird cases when logging is disabled in the transport. However,
6842 there may not be a transport (address failed by a router). */
6844 disable_logging = FALSE;
6845 if (addr_failed->transport != NULL)
6846 disable_logging = addr_failed->transport->disable_logging;
6849 debug_printf("processing failed address %s\n", addr_failed->address);
6851 /* There are only two ways an address in a bounce message can get here:
6853 (1) When delivery was initially deferred, but has now timed out (in the call
6854 to retry_update() above). We can detect this by testing for
6855 af_retry_timedout. If the address does not have its own errors address,
6856 we arrange to ignore the error.
6858 (2) If delivery failures for bounce messages are being ignored. We can detect
6859 this by testing for af_ignore_error. This will also be set if a bounce
6860 message has been autothawed and the ignore_bounce_errors_after time has
6861 passed. It might also be set if a router was explicitly configured to
6862 ignore errors (errors_to = "").
6864 If neither of these cases obtains, something has gone wrong. Log the
6865 incident, but then ignore the error. */
6867 if (sender_address[0] == 0 && addr_failed->prop.errors_address == NULL)
6869 if ( !testflag(addr_failed, af_retry_timedout)
6870 && !testflag(addr_failed, af_ignore_error))
6872 log_write(0, LOG_MAIN|LOG_PANIC, "internal error: bounce message "
6873 "failure is neither frozen nor ignored (it's been ignored)");
6875 setflag(addr_failed, af_ignore_error);
6878 /* If the first address on the list has af_ignore_error set, just remove
6879 it from the list, throw away any saved message file, log it, and
6880 mark the recipient done. */
6882 if ( testflag(addr_failed, af_ignore_error)
6883 || ( addr_failed->dsn_flags & rf_dsnflags
6884 && (addr_failed->dsn_flags & rf_notify_failure) != rf_notify_failure)
6888 addr_failed = addr->next;
6889 if (addr->return_filename != NULL) Uunlink(addr->return_filename);
6891 log_write(0, LOG_MAIN, "%s%s%s%s: error ignored",
6893 !addr->parent ? US"" : US" <",
6894 !addr->parent ? US"" : addr->parent->address,
6895 !addr->parent ? US"" : US">");
6897 address_done(addr, logtod);
6898 child_done(addr, logtod);
6899 /* Panic-dies on error */
6900 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
6903 /* Otherwise, handle the sending of a message. Find the error address for
6904 the first address, then send a message that includes all failed addresses
6905 that have the same error address. Note the bounce_recipient is a global so
6906 that it can be accesssed by $bounce_recipient while creating a customized
6911 bounce_recipient = addr_failed->prop.errors_address
6912 ? addr_failed->prop.errors_address : sender_address;
6914 /* Make a subprocess to send a message */
6916 if ((pid = child_open_exim(&fd)) < 0)
6917 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Process %d (parent %d) failed to "
6918 "create child process to send failure message: %s", getpid(),
6919 getppid(), strerror(errno));
6921 /* Creation of child succeeded */
6928 uschar *bcc, *emf_text;
6929 FILE *f = fdopen(fd, "wb");
6931 BOOL to_sender = strcmpic(sender_address, bounce_recipient) == 0;
6932 int max = (bounce_return_size_limit/DELIVER_IN_BUFFER_SIZE + 1) *
6933 DELIVER_IN_BUFFER_SIZE;
6935 uschar *dsnlimitmsg;
6936 uschar *dsnnotifyhdr;
6940 debug_printf("sending error message to: %s\n", bounce_recipient);
6942 /* Scan the addresses for all that have the same errors address, removing
6943 them from the addr_failed chain, and putting them on msgchain. */
6945 paddr = &addr_failed;
6946 for (addr = addr_failed; addr != NULL; addr = *paddr)
6947 if (Ustrcmp(bounce_recipient, addr->prop.errors_address
6948 ? addr->prop.errors_address : sender_address) == 0)
6949 { /* The same - dechain */
6950 *paddr = addr->next;
6953 pmsgchain = &(addr->next);
6956 paddr = &addr->next; /* Not the same; skip */
6958 /* Include X-Failed-Recipients: for automatic interpretation, but do
6959 not let any one header line get too long. We do this by starting a
6960 new header every 50 recipients. Omit any addresses for which the
6961 "hide_child" flag is set. */
6963 for (addr = msgchain; addr != NULL; addr = addr->next)
6965 if (testflag(addr, af_hide_child)) continue;
6972 (rcount++ == 0)? "X-Failed-Recipients: " : ",\n ",
6973 (testflag(addr, af_pfr) && addr->parent != NULL)?
6974 string_printing(addr->parent->address) :
6975 string_printing(addr->address));
6977 if (rcount > 0) fprintf(f, "\n");
6979 /* Output the standard headers */
6981 if (errors_reply_to)
6982 fprintf(f, "Reply-To: %s\n", errors_reply_to);
6983 fprintf(f, "Auto-Submitted: auto-replied\n");
6985 fprintf(f, "To: %s\n", bounce_recipient);
6987 /* generate boundary string and output MIME-Headers */
6988 bound = string_sprintf(TIME_T_FMT "-eximdsn-%d", time(NULL), rand());
6990 fprintf(f, "Content-Type: multipart/report;"
6991 " report-type=delivery-status; boundary=%s\n"
6992 "MIME-Version: 1.0\n",
6995 /* Open a template file if one is provided. Log failure to open, but
6996 carry on - default texts will be used. */
6998 if (bounce_message_file)
6999 if (!(emf = Ufopen(bounce_message_file, "rb")))
7000 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to open %s for error "
7001 "message texts: %s", bounce_message_file, strerror(errno));
7003 /* Quietly copy to configured additional addresses if required. */
7005 if ((bcc = moan_check_errorcopy(bounce_recipient)))
7006 fprintf(f, "Bcc: %s\n", bcc);
7008 /* The texts for the message can be read from a template file; if there
7009 isn't one, or if it is too short, built-in texts are used. The first
7010 emf text is a Subject: and any other headers. */
7012 if ((emf_text = next_emf(emf, US"header")))
7013 fprintf(f, "%s\n", emf_text);
7015 fprintf(f, "Subject: Mail delivery failed%s\n\n",
7016 to_sender? ": returning message to sender" : "");
7018 /* output human readable part as text/plain section */
7020 "Content-type: text/plain; charset=us-ascii\n\n",
7023 if ((emf_text = next_emf(emf, US"intro")))
7024 fprintf(f, "%s", CS emf_text);
7028 /* This message has been reworded several times. It seems to be confusing to
7029 somebody, however it is worded. I have retreated to the original, simple
7031 "This message was created automatically by mail delivery software.\n");
7033 if (bounce_message_text)
7034 fprintf(f, "%s", CS bounce_message_text);
7037 "\nA message that you sent could not be delivered to one or more of its\n"
7038 "recipients. This is a permanent error. The following address(es) failed:\n");
7041 "\nA message sent by\n\n <%s>\n\n"
7042 "could not be delivered to one or more of its recipients. The following\n"
7043 "address(es) failed:\n", sender_address);
7047 /* Process the addresses, leaving them on the msgchain if they have a
7048 file name for a return message. (There has already been a check in
7049 post_process_one() for the existence of data in the message file.) A TRUE
7050 return from print_address_information() means that the address is not
7054 for (addr = msgchain; addr != NULL; addr = *paddr)
7056 if (print_address_information(addr, f, US" ", US"\n ", US""))
7057 print_address_error(addr, f, US"");
7059 /* End the final line for the address */
7063 /* Leave on msgchain if there's a return file. */
7065 if (addr->return_file >= 0)
7067 paddr = &(addr->next);
7071 /* Else save so that we can tick off the recipient when the
7076 *paddr = addr->next;
7077 addr->next = handled_addr;
7078 handled_addr = addr;
7084 /* Get the next text, whether we need it or not, so as to be
7085 positioned for the one after. */
7087 emf_text = next_emf(emf, US"generated text");
7089 /* If there were any file messages passed by the local transports,
7090 include them in the message. Then put the address on the handled chain.
7091 In the case of a batch of addresses that were all sent to the same
7092 transport, the return_file field in all of them will contain the same
7093 fd, and the return_filename field in the *last* one will be set (to the
7094 name of the file). */
7098 address_item *nextaddr;
7101 fprintf(f, "%s", CS emf_text);
7104 "The following text was generated during the delivery "
7105 "attempt%s:\n", (filecount > 1)? "s" : "");
7107 for (addr = msgchain; addr != NULL; addr = nextaddr)
7110 address_item *topaddr = addr;
7112 /* List all the addresses that relate to this file */
7115 while(addr) /* Insurance */
7117 print_address_information(addr, f, US"------ ", US"\n ",
7119 if (addr->return_filename) break;
7124 /* Now copy the file */
7126 fm = Ufopen(addr->return_filename, "rb");
7129 fprintf(f, " +++ Exim error... failed to open text file: %s\n",
7133 while ((ch = fgetc(fm)) != EOF) fputc(ch, f);
7136 Uunlink(addr->return_filename);
7138 /* Can now add to handled chain, first fishing off the next
7139 address on the msgchain. */
7141 nextaddr = addr->next;
7142 addr->next = handled_addr;
7143 handled_addr = topaddr;
7148 /* output machine readable part */
7149 #ifdef EXPERIMENTAL_INTERNATIONAL
7150 if (message_smtputf8)
7152 "Content-type: message/global-delivery-status\n\n"
7153 "Reporting-MTA: dns; %s\n",
7154 bound, smtp_active_hostname);
7158 "Content-type: message/delivery-status\n\n"
7159 "Reporting-MTA: dns; %s\n",
7160 bound, smtp_active_hostname);
7164 /* must be decoded from xtext: see RFC 3461:6.3a */
7166 if (auth_xtextdecode(dsn_envid, &xdec_envid) > 0)
7167 fprintf(f, "Original-Envelope-ID: %s\n", dsn_envid);
7169 fprintf(f, "X-Original-Envelope-ID: error decoding xtext formated ENVID\n");
7173 for (addr = handled_addr; addr; addr = addr->next)
7175 fprintf(f, "Action: failed\n"
7176 "Final-Recipient: rfc822;%s\n"
7179 if (addr->host_used && addr->host_used->name)
7181 fprintf(f, "Remote-MTA: dns; %s\n",
7182 addr->host_used->name);
7183 print_dsn_diagnostic_code(addr, f);
7188 /* Now copy the message, trying to give an intelligible comment if
7189 it is too long for it all to be copied. The limit isn't strictly
7190 applied because of the buffering. There is, however, an option
7191 to suppress copying altogether. */
7193 emf_text = next_emf(emf, US"copy");
7196 we ignore the intro text from template and add
7197 the text for bounce_return_size_limit at the end.
7199 bounce_return_message is ignored
7200 in case RET= is defined we honor these values
7201 otherwise bounce_return_body is honored.
7203 bounce_return_size_limit is always honored.
7206 fprintf(f, "--%s\n", bound);
7208 dsnlimitmsg = US"X-Exim-DSN-Information: Due to administrative limits only headers are returned";
7209 dsnnotifyhdr = NULL;
7210 topt = topt_add_return_path;
7212 /* RET=HDRS? top priority */
7213 if (dsn_ret == dsn_ret_hdrs)
7214 topt |= topt_no_body;
7216 /* no full body return at all? */
7217 if (!bounce_return_body)
7219 topt |= topt_no_body;
7220 /* add header if we overrule RET=FULL */
7221 if (dsn_ret == dsn_ret_full)
7222 dsnnotifyhdr = dsnlimitmsg;
7224 /* size limited ... return headers only if limit reached */
7225 else if (bounce_return_size_limit > 0)
7227 struct stat statbuf;
7228 if (fstat(deliver_datafile, &statbuf) == 0 && statbuf.st_size > max)
7230 topt |= topt_no_body;
7231 dsnnotifyhdr = dsnlimitmsg;
7235 #ifdef EXPERIMENTAL_INTERNATIONAL
7236 if (message_smtputf8)
7237 fputs(topt & topt_no_body ? "Content-type: message/global-headers\n\n"
7238 : "Content-type: message/global\n\n",
7242 fputs(topt & topt_no_body ? "Content-type: text/rfc822-headers\n\n"
7243 : "Content-type: message/rfc822\n\n",
7247 transport_filter_argv = NULL; /* Just in case */
7248 return_path = sender_address; /* In case not previously set */
7249 transport_write_message(NULL, fileno(f), topt,
7250 0, dsnnotifyhdr, NULL, NULL, NULL, NULL, 0);
7253 /* we never add the final text. close the file */
7257 fprintf(f, "\n--%s--\n", bound);
7259 /* Close the file, which should send an EOF to the child process
7260 that is receiving the message. Wait for it to finish. */
7263 rc = child_close(pid, 0); /* Waits for child to close, no timeout */
7265 /* In the test harness, let the child do it's thing first. */
7267 if (running_in_test_harness) millisleep(500);
7269 /* If the process failed, there was some disaster in setting up the
7270 error message. Unless the message is very old, ensure that addr_defer
7271 is non-null, which will have the effect of leaving the message on the
7272 spool. The failed addresses will get tried again next time. However, we
7273 don't really want this to happen too often, so freeze the message unless
7274 there are some genuine deferred addresses to try. To do this we have
7275 to call spool_write_header() here, because with no genuine deferred
7276 addresses the normal code below doesn't get run. */
7281 if (now - received_time < retry_maximum_timeout && addr_defer == NULL)
7283 addr_defer = (address_item *)(+1);
7284 deliver_freeze = TRUE;
7285 deliver_frozen_at = time(NULL);
7286 /* Panic-dies on error */
7287 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
7290 deliver_msglog("Process failed (%d) when writing error message "
7291 "to %s%s", rc, bounce_recipient, s);
7292 log_write(0, LOG_MAIN, "Process failed (%d) when writing error message "
7293 "to %s%s", rc, bounce_recipient, s);
7296 /* The message succeeded. Ensure that the recipients that failed are
7297 now marked finished with on the spool and their parents updated. */
7301 for (addr = handled_addr; addr != NULL; addr = addr->next)
7303 address_done(addr, logtod);
7304 child_done(addr, logtod);
7306 /* Panic-dies on error */
7307 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
7313 disable_logging = FALSE; /* In case left set */
7315 /* Come here from the mua_wrapper case if routing goes wrong */
7319 /* If there are now no deferred addresses, we are done. Preserve the
7320 message log if so configured, and we are using them. Otherwise, sling it.
7321 Then delete the message itself. */
7323 if (addr_defer == NULL)
7327 sprintf(CS spoolname, "%s/msglog/%s/%s", spool_directory, message_subdir,
7329 if (preserve_message_logs)
7332 sprintf(CS big_buffer, "%s/msglog.OLD/%s", spool_directory, id);
7333 if ((rc = Urename(spoolname, big_buffer)) < 0)
7335 (void)directory_make(spool_directory, US"msglog.OLD",
7336 MSGLOG_DIRECTORY_MODE, TRUE);
7337 rc = Urename(spoolname, big_buffer);
7340 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to move %s to the "
7341 "msglog.OLD directory", spoolname);
7344 if (Uunlink(spoolname) < 0)
7345 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s",
7346 spoolname, strerror(errno));
7349 /* Remove the two message files. */
7351 sprintf(CS spoolname, "%s/input/%s/%s-D", spool_directory, message_subdir, id);
7352 if (Uunlink(spoolname) < 0)
7353 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s",
7354 spoolname, strerror(errno));
7355 sprintf(CS spoolname, "%s/input/%s/%s-H", spool_directory, message_subdir, id);
7356 if (Uunlink(spoolname) < 0)
7357 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s",
7358 spoolname, strerror(errno));
7360 /* Log the end of this message, with queue time if requested. */
7362 if (LOGGING(queue_time_overall))
7363 log_write(0, LOG_MAIN, "Completed QT=%s",
7364 readconf_printtime( (int) ((long)time(NULL) - (long)received_time)) );
7366 log_write(0, LOG_MAIN, "Completed");
7368 /* Unset deliver_freeze so that we won't try to move the spool files further down */
7369 deliver_freeze = FALSE;
7371 #ifdef EXPERIMENTAL_EVENT
7372 (void) event_raise(event_action, US"msg:complete", NULL);
7376 /* If there are deferred addresses, we are keeping this message because it is
7377 not yet completed. Lose any temporary files that were catching output from
7378 pipes for any of the deferred addresses, handle one-time aliases, and see if
7379 the message has been on the queue for so long that it is time to send a warning
7380 message to the sender, unless it is a mailer-daemon. If all deferred addresses
7381 have the same domain, we can set deliver_domain for the expansion of
7382 delay_warning_ condition - if any of them are pipes, files, or autoreplies, use
7383 the parent's domain.
7385 If all the deferred addresses have an error number that indicates "retry time
7386 not reached", skip sending the warning message, because it won't contain the
7387 reason for the delay. It will get sent at the next real delivery attempt.
7388 However, if at least one address has tried, we'd better include all of them in
7391 If we can't make a process to send the message, don't worry.
7393 For mailing list expansions we want to send the warning message to the
7394 mailing list manager. We can't do a perfect job here, as some addresses may
7395 have different errors addresses, but if we take the errors address from
7396 each deferred address it will probably be right in most cases.
7398 If addr_defer == +1, it means there was a problem sending an error message
7399 for failed addresses, and there were no "real" deferred addresses. The value
7400 was set just to keep the message on the spool, so there is nothing to do here.
7403 else if (addr_defer != (address_item *)(+1))
7406 uschar *recipients = US"";
7407 BOOL delivery_attempted = FALSE;
7409 deliver_domain = testflag(addr_defer, af_pfr)?
7410 addr_defer->parent->domain : addr_defer->domain;
7412 for (addr = addr_defer; addr != NULL; addr = addr->next)
7414 address_item *otaddr;
7416 if (addr->basic_errno > ERRNO_RETRY_BASE) delivery_attempted = TRUE;
7418 if (deliver_domain != NULL)
7420 const uschar *d = testflag(addr, af_pfr)
7421 ? addr->parent->domain : addr->domain;
7423 /* The domain may be unset for an address that has never been routed
7424 because the system filter froze the message. */
7426 if (d == NULL || Ustrcmp(d, deliver_domain) != 0) deliver_domain = NULL;
7429 if (addr->return_filename != NULL) Uunlink(addr->return_filename);
7431 /* Handle the case of one-time aliases. If any address in the ancestry
7432 of this one is flagged, ensure it is in the recipients list, suitably
7433 flagged, and that its parent is marked delivered. */
7435 for (otaddr = addr; otaddr != NULL; otaddr = otaddr->parent)
7436 if (otaddr->onetime_parent != NULL) break;
7441 int t = recipients_count;
7443 for (i = 0; i < recipients_count; i++)
7445 uschar *r = recipients_list[i].address;
7446 if (Ustrcmp(otaddr->onetime_parent, r) == 0) t = i;
7447 if (Ustrcmp(otaddr->address, r) == 0) break;
7450 /* Didn't find the address already in the list, and did find the
7451 ultimate parent's address in the list. After adding the recipient,
7452 update the errors address in the recipients list. */
7454 if (i >= recipients_count && t < recipients_count)
7456 DEBUG(D_deliver) debug_printf("one_time: adding %s in place of %s\n",
7457 otaddr->address, otaddr->parent->address);
7458 receive_add_recipient(otaddr->address, t);
7459 recipients_list[recipients_count-1].errors_to = otaddr->prop.errors_address;
7460 tree_add_nonrecipient(otaddr->parent->address);
7461 update_spool = TRUE;
7465 /* Except for error messages, ensure that either the errors address for
7466 this deferred address or, if there is none, the sender address, is on the
7467 list of recipients for a warning message. */
7469 if (sender_address[0] != 0)
7471 if (addr->prop.errors_address == NULL)
7473 if (Ustrstr(recipients, sender_address) == NULL)
7474 recipients = string_sprintf("%s%s%s", recipients,
7475 (recipients[0] == 0)? "" : ",", sender_address);
7479 if (Ustrstr(recipients, addr->prop.errors_address) == NULL)
7480 recipients = string_sprintf("%s%s%s", recipients,
7481 (recipients[0] == 0)? "" : ",", addr->prop.errors_address);
7486 /* Send a warning message if the conditions are right. If the condition check
7487 fails because of a lookup defer, there is nothing we can do. The warning
7488 is not sent. Another attempt will be made at the next delivery attempt (if
7492 && delivery_attempted
7493 && ( ((addr_defer->dsn_flags & rf_dsnflags) == 0)
7494 || (addr_defer->dsn_flags & rf_notify_delay) == rf_notify_delay
7496 && delay_warning[1] > 0
7497 && sender_address[0] != 0
7498 && ( delay_warning_condition == NULL
7499 || expand_check_condition(delay_warning_condition,
7500 US"delay_warning", US"option")
7506 int queue_time = time(NULL) - received_time;
7508 /* When running in the test harness, there's an option that allows us to
7509 fudge this time so as to get repeatability of the tests. Take the first
7510 time off the list. In queue runs, the list pointer gets updated in the
7513 if (running_in_test_harness && fudged_queue_times[0] != 0)
7515 int qt = readconf_readtime(fudged_queue_times, '/', FALSE);
7518 DEBUG(D_deliver) debug_printf("fudged queue_times = %s\n",
7519 fudged_queue_times);
7524 /* See how many warnings we should have sent by now */
7526 for (count = 0; count < delay_warning[1]; count++)
7527 if (queue_time < delay_warning[count+2]) break;
7529 show_time = delay_warning[count+1];
7531 if (count >= delay_warning[1])
7534 int last_gap = show_time;
7535 if (count > 1) last_gap -= delay_warning[count];
7536 extra = (queue_time - delay_warning[count+1])/last_gap;
7537 show_time += last_gap * extra;
7543 debug_printf("time on queue = %s\n", readconf_printtime(queue_time));
7544 debug_printf("warning counts: required %d done %d\n", count,
7548 /* We have computed the number of warnings there should have been by now.
7549 If there haven't been enough, send one, and up the count to what it should
7552 if (warning_count < count)
7556 pid_t pid = child_open_exim(&fd);
7562 FILE *f = fdopen(fd, "wb");
7565 if (warn_message_file)
7567 wmf = Ufopen(warn_message_file, "rb");
7569 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to open %s for warning "
7570 "message texts: %s", warn_message_file, strerror(errno));
7573 warnmsg_recipients = recipients;
7574 warnmsg_delay = (queue_time < 120*60)?
7575 string_sprintf("%d minutes", show_time/60):
7576 string_sprintf("%d hours", show_time/3600);
7578 if (errors_reply_to)
7579 fprintf(f, "Reply-To: %s\n", errors_reply_to);
7580 fprintf(f, "Auto-Submitted: auto-replied\n");
7582 fprintf(f, "To: %s\n", recipients);
7584 /* generated boundary string and output MIME-Headers */
7585 bound = string_sprintf(TIME_T_FMT "-eximdsn-%d", time(NULL), rand());
7587 fprintf(f, "Content-Type: multipart/report;"
7588 " report-type=delivery-status; boundary=%s\n"
7589 "MIME-Version: 1.0\n",
7592 if ((wmf_text = next_emf(wmf, US"header")))
7593 fprintf(f, "%s\n", wmf_text);
7595 fprintf(f, "Subject: Warning: message %s delayed %s\n\n",
7596 message_id, warnmsg_delay);
7598 /* output human readable part as text/plain section */
7600 "Content-type: text/plain; charset=us-ascii\n\n",
7603 if ((wmf_text = next_emf(wmf, US"intro")))
7604 fprintf(f, "%s", CS wmf_text);
7608 "This message was created automatically by mail delivery software.\n");
7610 if (Ustrcmp(recipients, sender_address) == 0)
7612 "A message that you sent has not yet been delivered to one or more of its\n"
7613 "recipients after more than ");
7617 "A message sent by\n\n <%s>\n\n"
7618 "has not yet been delivered to one or more of its recipients after more than \n",
7621 fprintf(f, "%s on the queue on %s.\n\n"
7622 "The message identifier is: %s\n",
7623 warnmsg_delay, primary_hostname, message_id);
7625 for (h = header_list; h != NULL; h = h->next)
7626 if (strncmpic(h->text, US"Subject:", 8) == 0)
7627 fprintf(f, "The subject of the message is: %s", h->text + 9);
7628 else if (strncmpic(h->text, US"Date:", 5) == 0)
7629 fprintf(f, "The date of the message is: %s", h->text + 6);
7632 fprintf(f, "The address%s to which the message has not yet been "
7634 !addr_defer->next ? "" : "es",
7635 !addr_defer->next ? "is": "are");
7638 /* List the addresses, with error information if allowed */
7640 /* store addr_defer for machine readable part */
7641 address_item *addr_dsndefer = addr_defer;
7645 address_item *addr = addr_defer;
7646 addr_defer = addr->next;
7647 if (print_address_information(addr, f, US" ", US"\n ", US""))
7648 print_address_error(addr, f, US"Delay reason: ");
7657 if ((wmf_text = next_emf(wmf, US"final")))
7658 fprintf(f, "%s", CS wmf_text);
7664 "No action is required on your part. Delivery attempts will continue for\n"
7665 "some time, and this warning may be repeated at intervals if the message\n"
7666 "remains undelivered. Eventually the mail delivery software will give up,\n"
7667 "and when that happens, the message will be returned to you.\n");
7670 /* output machine readable part */
7671 fprintf(f, "\n--%s\n"
7672 "Content-type: message/delivery-status\n\n"
7673 "Reporting-MTA: dns; %s\n",
7675 smtp_active_hostname);
7680 /* must be decoded from xtext: see RFC 3461:6.3a */
7682 if (auth_xtextdecode(dsn_envid, &xdec_envid) > 0)
7683 fprintf(f,"Original-Envelope-ID: %s\n", dsn_envid);
7685 fprintf(f,"X-Original-Envelope-ID: error decoding xtext formated ENVID\n");
7689 for ( ; addr_dsndefer; addr_dsndefer = addr_dsndefer->next)
7691 if (addr_dsndefer->dsn_orcpt)
7692 fprintf(f, "Original-Recipient: %s\n", addr_dsndefer->dsn_orcpt);
7694 fprintf(f, "Action: delayed\n"
7695 "Final-Recipient: rfc822;%s\n"
7697 addr_dsndefer->address);
7698 if (addr_dsndefer->host_used && addr_dsndefer->host_used->name)
7700 fprintf(f, "Remote-MTA: dns; %s\n",
7701 addr_dsndefer->host_used->name);
7702 print_dsn_diagnostic_code(addr_dsndefer, f);
7708 "Content-type: text/rfc822-headers\n\n",
7712 /* header only as required by RFC. only failure DSN needs to honor RET=FULL */
7713 int topt = topt_add_return_path | topt_no_body;
7714 transport_filter_argv = NULL; /* Just in case */
7715 return_path = sender_address; /* In case not previously set */
7716 /* Write the original email out */
7717 transport_write_message(NULL, fileno(f), topt, 0, NULL, NULL, NULL, NULL, NULL, 0);
7720 fprintf(f,"\n--%s--\n", bound);
7724 /* Close and wait for child process to complete, without a timeout.
7725 If there's an error, don't update the count. */
7728 if (child_close(pid, 0) == 0)
7730 warning_count = count;
7731 update_spool = TRUE; /* Ensure spool rewritten */
7737 /* Clear deliver_domain */
7739 deliver_domain = NULL;
7741 /* If this was a first delivery attempt, unset the first time flag, and
7742 ensure that the spool gets updated. */
7744 if (deliver_firsttime)
7746 deliver_firsttime = FALSE;
7747 update_spool = TRUE;
7750 /* If delivery was frozen and freeze_tell is set, generate an appropriate
7751 message, unless the message is a local error message (to avoid loops). Then
7752 log the freezing. If the text in "frozen_info" came from a system filter,
7753 it has been escaped into printing characters so as not to mess up log lines.
7754 For the "tell" message, we turn \n back into newline. Also, insert a newline
7755 near the start instead of the ": " string. */
7759 if (freeze_tell != NULL && freeze_tell[0] != 0 && !local_error_message)
7761 uschar *s = string_copy(frozen_info);
7762 uschar *ss = Ustrstr(s, " by the system filter: ");
7773 if (*ss == '\\' && ss[1] == 'n')
7780 moan_tell_someone(freeze_tell, addr_defer, US"Message frozen",
7781 "Message %s has been frozen%s.\nThe sender is <%s>.\n", message_id,
7785 /* Log freezing just before we update the -H file, to minimize the chance
7786 of a race problem. */
7788 deliver_msglog("*** Frozen%s\n", frozen_info);
7789 log_write(0, LOG_MAIN, "Frozen%s", frozen_info);
7792 /* If there have been any updates to the non-recipients list, or other things
7793 that get written to the spool, we must now update the spool header file so
7794 that it has the right information for the next delivery attempt. If there
7795 was more than one address being delivered, the header_change update is done
7796 earlier, in case one succeeds and then something crashes. */
7799 debug_printf("delivery deferred: update_spool=%d header_rewritten=%d\n",
7800 update_spool, header_rewritten);
7802 if (update_spool || header_rewritten)
7803 /* Panic-dies on error */
7804 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
7807 /* Finished with the message log. If the message is complete, it will have
7808 been unlinked or renamed above. */
7810 if (message_logs) (void)fclose(message_log);
7812 /* Now we can close and remove the journal file. Its only purpose is to record
7813 successfully completed deliveries asap so that this information doesn't get
7814 lost if Exim (or the machine) crashes. Forgetting about a failed delivery is
7815 not serious, as trying it again is not harmful. The journal might not be open
7816 if all addresses were deferred at routing or directing. Nevertheless, we must
7817 remove it if it exists (may have been lying around from a crash during the
7818 previous delivery attempt). We don't remove the journal if a delivery
7819 subprocess failed to pass back delivery information; this is controlled by
7820 the remove_journal flag. When the journal is left, we also don't move the
7821 message off the main spool if frozen and the option is set. It should get moved
7822 at the next attempt, after the journal has been inspected. */
7824 if (journal_fd >= 0) (void)close(journal_fd);
7828 sprintf(CS spoolname, "%s/input/%s/%s-J", spool_directory, message_subdir, id);
7829 if (Uunlink(spoolname) < 0 && errno != ENOENT)
7830 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s", spoolname,
7833 /* Move the message off the spool if reqested */
7835 #ifdef SUPPORT_MOVE_FROZEN_MESSAGES
7836 if (deliver_freeze && move_frozen_messages)
7837 (void)spool_move_message(id, message_subdir, US"", US"F");
7841 /* Closing the data file frees the lock; if the file has been unlinked it
7842 will go away. Otherwise the message becomes available for another process
7845 (void)close(deliver_datafile);
7846 deliver_datafile = -1;
7847 DEBUG(D_deliver) debug_printf("end delivery of %s\n", id);
7849 /* It is unlikely that there will be any cached resources, since they are
7850 released after routing, and in the delivery subprocesses. However, it's
7851 possible for an expansion for something afterwards (for example,
7852 expand_check_condition) to do a lookup. We must therefore be sure everything is
7856 acl_where = ACL_WHERE_UNKNOWN;
7865 if (!regex_PIPELINING) regex_PIPELINING =
7866 regex_must_compile(US"\\n250[\\s\\-]PIPELINING(\\s|\\n|$)", FALSE, TRUE);
7868 if (!regex_SIZE) regex_SIZE =
7869 regex_must_compile(US"\\n250[\\s\\-]SIZE(\\s|\\n|$)", FALSE, TRUE);
7871 if (!regex_AUTH) regex_AUTH =
7872 regex_must_compile(US"\\n250[\\s\\-]AUTH\\s+([\\-\\w\\s]+)(?:\\n|$)",
7876 if (!regex_STARTTLS) regex_STARTTLS =
7877 regex_must_compile(US"\\n250[\\s\\-]STARTTLS(\\s|\\n|$)", FALSE, TRUE);
7880 #ifndef DISABLE_PRDR
7881 if (!regex_PRDR) regex_PRDR =
7882 regex_must_compile(US"\\n250[\\s\\-]PRDR(\\s|\\n|$)", FALSE, TRUE);
7885 #ifdef EXPERIMENTAL_INTERNATIONAL
7886 if (!regex_UTF8) regex_UTF8 =
7887 regex_must_compile(US"\\n250[\\s\\-]SMTPUTF8(\\s|\\n|$)", FALSE, TRUE);
7890 if (!regex_DSN) regex_DSN =
7891 regex_must_compile(US"\\n250[\\s\\-]DSN(\\s|\\n|$)", FALSE, TRUE);
7893 if (!regex_IGNOREQUOTA) regex_IGNOREQUOTA =
7894 regex_must_compile(US"\\n250[\\s\\-]IGNOREQUOTA(\\s|\\n|$)", FALSE, TRUE);
7899 deliver_get_sender_address (uschar * id)
7901 if (!spool_open_datafile(id))
7904 sprintf(CS spoolname, "%s-H", id);
7905 if (spool_read_header(spoolname, TRUE, TRUE) != spool_read_OK)
7908 (void)close(deliver_datafile);
7909 deliver_datafile = -1;
7911 return sender_address;
7916 /* End of deliver.c */