1 /*************************************************
2 * Exim - an Internet mail transport agent *
3 *************************************************/
5 /* Copyright (c) University of Cambridge 1995 - 2014 */
6 /* See the file NOTICE for conditions of use and distribution. */
8 /* The main code for delivering a message. */
14 /* Data block for keeping track of subprocesses for parallel remote
17 typedef struct pardata {
18 address_item *addrlist; /* chain of addresses */
19 address_item *addr; /* next address data expected for */
20 pid_t pid; /* subprocess pid */
21 int fd; /* pipe fd for getting result from subprocess */
22 int transport_count; /* returned transport count value */
23 BOOL done; /* no more data needed */
24 uschar *msg; /* error message */
25 uschar *return_path; /* return_path for these addresses */
28 /* Values for the process_recipients variable */
30 enum { RECIP_ACCEPT, RECIP_IGNORE, RECIP_DEFER,
31 RECIP_FAIL, RECIP_FAIL_FILTER, RECIP_FAIL_TIMEOUT,
34 /* Mutually recursive functions for marking addresses done. */
36 static void child_done(address_item *, uschar *);
37 static void address_done(address_item *, uschar *);
39 /* Table for turning base-62 numbers into binary */
41 static uschar tab62[] =
42 {0,1,2,3,4,5,6,7,8,9,0,0,0,0,0,0, /* 0-9 */
43 0,10,11,12,13,14,15,16,17,18,19,20, /* A-K */
44 21,22,23,24,25,26,27,28,29,30,31,32, /* L-W */
45 33,34,35, 0, 0, 0, 0, 0, /* X-Z */
46 0,36,37,38,39,40,41,42,43,44,45,46, /* a-k */
47 47,48,49,50,51,52,53,54,55,56,57,58, /* l-w */
51 /*************************************************
52 * Local static variables *
53 *************************************************/
55 /* addr_duplicate is global because it needs to be seen from the Envelope-To
58 static address_item *addr_defer = NULL;
59 static address_item *addr_failed = NULL;
60 static address_item *addr_fallback = NULL;
61 static address_item *addr_local = NULL;
62 static address_item *addr_new = NULL;
63 static address_item *addr_remote = NULL;
64 static address_item *addr_route = NULL;
65 static address_item *addr_succeed = NULL;
66 #ifdef EXPERIMENTAL_DSN
67 static address_item *addr_dsntmp = NULL;
68 static address_item *addr_senddsn = NULL;
71 static FILE *message_log = NULL;
72 static BOOL update_spool;
73 static BOOL remove_journal;
74 static int parcount = 0;
75 static pardata *parlist = NULL;
76 static int return_count;
77 static uschar *frozen_info = US"";
78 static uschar *used_return_path = NULL;
80 static uschar spoolname[PATH_MAX];
84 /*************************************************
85 * Make a new address item *
86 *************************************************/
88 /* This function gets the store and initializes with default values. The
89 transport_return value defaults to DEFER, so that any unexpected failure to
90 deliver does not wipe out the message. The default unique string is set to a
91 copy of the address, so that its domain can be lowercased.
94 address the RFC822 address string
95 copy force a copy of the address
97 Returns: a pointer to an initialized address_item
101 deliver_make_addr(uschar *address, BOOL copy)
103 address_item *addr = store_get(sizeof(address_item));
104 *addr = address_defaults;
105 if (copy) address = string_copy(address);
106 addr->address = address;
107 addr->unique = string_copy(address);
114 /*************************************************
115 * Set expansion values for an address *
116 *************************************************/
118 /* Certain expansion variables are valid only when handling an address or
119 address list. This function sets them up or clears the values, according to its
123 addr the address in question, or NULL to clear values
128 deliver_set_expansions(address_item *addr)
132 uschar ***p = address_expansions;
133 while (*p != NULL) **p++ = NULL;
137 /* Exactly what gets set depends on whether there is one or more addresses, and
138 what they contain. These first ones are always set, taking their values from
139 the first address. */
141 if (addr->host_list == NULL)
143 deliver_host = deliver_host_address = US"";
147 deliver_host = addr->host_list->name;
148 deliver_host_address = addr->host_list->address;
151 deliver_recipients = addr;
152 deliver_address_data = addr->p.address_data;
153 deliver_domain_data = addr->p.domain_data;
154 deliver_localpart_data = addr->p.localpart_data;
156 /* These may be unset for multiple addresses */
158 deliver_domain = addr->domain;
159 self_hostname = addr->self_hostname;
161 #ifdef EXPERIMENTAL_BRIGHTMAIL
162 bmi_deliver = 1; /* deliver by default */
163 bmi_alt_location = NULL;
164 bmi_base64_verdict = NULL;
165 bmi_base64_tracker_verdict = NULL;
168 /* If there's only one address we can set everything. */
170 if (addr->next == NULL)
172 address_item *addr_orig;
174 deliver_localpart = addr->local_part;
175 deliver_localpart_prefix = addr->prefix;
176 deliver_localpart_suffix = addr->suffix;
178 for (addr_orig = addr; addr_orig->parent != NULL;
179 addr_orig = addr_orig->parent);
180 deliver_domain_orig = addr_orig->domain;
182 /* Re-instate any prefix and suffix in the original local part. In all
183 normal cases, the address will have a router associated with it, and we can
184 choose the caseful or caseless version accordingly. However, when a system
185 filter sets up a pipe, file, or autoreply delivery, no router is involved.
186 In this case, though, there won't be any prefix or suffix to worry about. */
188 deliver_localpart_orig = (addr_orig->router == NULL)? addr_orig->local_part :
189 addr_orig->router->caseful_local_part?
190 addr_orig->cc_local_part : addr_orig->lc_local_part;
192 /* If there's a parent, make its domain and local part available, and if
193 delivering to a pipe or file, or sending an autoreply, get the local
194 part from the parent. For pipes and files, put the pipe or file string
195 into address_pipe and address_file. */
197 if (addr->parent != NULL)
199 deliver_domain_parent = addr->parent->domain;
200 deliver_localpart_parent = (addr->parent->router == NULL)?
201 addr->parent->local_part :
202 addr->parent->router->caseful_local_part?
203 addr->parent->cc_local_part : addr->parent->lc_local_part;
205 /* File deliveries have their own flag because they need to be picked out
206 as special more often. */
208 if (testflag(addr, af_pfr))
210 if (testflag(addr, af_file)) address_file = addr->local_part;
211 else if (deliver_localpart[0] == '|') address_pipe = addr->local_part;
212 deliver_localpart = addr->parent->local_part;
213 deliver_localpart_prefix = addr->parent->prefix;
214 deliver_localpart_suffix = addr->parent->suffix;
218 #ifdef EXPERIMENTAL_BRIGHTMAIL
219 /* Set expansion variables related to Brightmail AntiSpam */
220 bmi_base64_verdict = bmi_get_base64_verdict(deliver_localpart_orig, deliver_domain_orig);
221 bmi_base64_tracker_verdict = bmi_get_base64_tracker_verdict(bmi_base64_verdict);
222 /* get message delivery status (0 - don't deliver | 1 - deliver) */
223 bmi_deliver = bmi_get_delivery_status(bmi_base64_verdict);
224 /* if message is to be delivered, get eventual alternate location */
225 if (bmi_deliver == 1) {
226 bmi_alt_location = bmi_get_alt_location(bmi_base64_verdict);
232 /* For multiple addresses, don't set local part, and leave the domain and
233 self_hostname set only if it is the same for all of them. It is possible to
234 have multiple pipe and file addresses, but only when all addresses have routed
235 to the same pipe or file. */
240 if (testflag(addr, af_pfr))
242 if (testflag(addr, af_file)) address_file = addr->local_part;
243 else if (addr->local_part[0] == '|') address_pipe = addr->local_part;
245 for (addr2 = addr->next; addr2 != NULL; addr2 = addr2->next)
247 if (deliver_domain != NULL &&
248 Ustrcmp(deliver_domain, addr2->domain) != 0)
249 deliver_domain = NULL;
250 if (self_hostname != NULL && (addr2->self_hostname == NULL ||
251 Ustrcmp(self_hostname, addr2->self_hostname) != 0))
252 self_hostname = NULL;
253 if (deliver_domain == NULL && self_hostname == NULL) break;
261 /*************************************************
262 * Open a msglog file *
263 *************************************************/
265 /* This function is used both for normal message logs, and for files in the
266 msglog directory that are used to catch output from pipes. Try to create the
267 directory if it does not exist. From release 4.21, normal message logs should
268 be created when the message is received.
271 filename the file name
272 mode the mode required
273 error used for saying what failed
275 Returns: a file descriptor, or -1 (with errno set)
279 open_msglog_file(uschar *filename, int mode, uschar **error)
281 int fd = Uopen(filename, O_WRONLY|O_APPEND|O_CREAT, mode);
283 if (fd < 0 && errno == ENOENT)
286 sprintf(CS temp, "msglog/%s", message_subdir);
287 if (message_subdir[0] == 0) temp[6] = 0;
288 (void)directory_make(spool_directory, temp, MSGLOG_DIRECTORY_MODE, TRUE);
289 fd = Uopen(filename, O_WRONLY|O_APPEND|O_CREAT, mode);
292 /* Set the close-on-exec flag and change the owner to the exim uid/gid (this
293 function is called as root). Double check the mode, because the group setting
294 doesn't always get set automatically. */
298 (void)fcntl(fd, F_SETFD, fcntl(fd, F_GETFD) | FD_CLOEXEC);
299 if (fchown(fd, exim_uid, exim_gid) < 0)
304 if (fchmod(fd, mode) < 0)
310 else *error = US"create";
318 /*************************************************
319 * Write to msglog if required *
320 *************************************************/
322 /* Write to the message log, if configured. This function may also be called
326 format a string format
332 deliver_msglog(const char *format, ...)
335 if (!message_logs) return;
336 va_start(ap, format);
337 vfprintf(message_log, format, ap);
345 /*************************************************
346 * Replicate status for batch *
347 *************************************************/
349 /* When a transport handles a batch of addresses, it may treat them
350 individually, or it may just put the status in the first one, and return FALSE,
351 requesting that the status be copied to all the others externally. This is the
352 replication function. As well as the status, it copies the transport pointer,
353 which may have changed if appendfile passed the addresses on to a different
356 Argument: pointer to the first address in a chain
361 replicate_status(address_item *addr)
364 for (addr2 = addr->next; addr2 != NULL; addr2 = addr2->next)
366 addr2->transport = addr->transport;
367 addr2->transport_return = addr->transport_return;
368 addr2->basic_errno = addr->basic_errno;
369 addr2->more_errno = addr->more_errno;
370 addr2->special_action = addr->special_action;
371 addr2->message = addr->message;
372 addr2->user_message = addr->user_message;
378 /*************************************************
379 * Compare lists of hosts *
380 *************************************************/
382 /* This function is given two pointers to chains of host items, and it yields
383 TRUE if the lists refer to the same hosts in the same order, except that
385 (1) Multiple hosts with the same non-negative MX values are permitted to appear
386 in different orders. Round-robinning nameservers can cause this to happen.
388 (2) Multiple hosts with the same negative MX values less than MX_NONE are also
389 permitted to appear in different orders. This is caused by randomizing
392 This enables Exim to use a single SMTP transaction for sending to two entirely
393 different domains that happen to end up pointing at the same hosts.
396 one points to the first host list
397 two points to the second host list
399 Returns: TRUE if the lists refer to the same host set
403 same_hosts(host_item *one, host_item *two)
405 while (one != NULL && two != NULL)
407 if (Ustrcmp(one->name, two->name) != 0)
410 host_item *end_one = one;
411 host_item *end_two = two;
413 /* Batch up only if there was no MX and the list was not randomized */
415 if (mx == MX_NONE) return FALSE;
417 /* Find the ends of the shortest sequence of identical MX values */
419 while (end_one->next != NULL && end_one->next->mx == mx &&
420 end_two->next != NULL && end_two->next->mx == mx)
422 end_one = end_one->next;
423 end_two = end_two->next;
426 /* If there aren't any duplicates, there's no match. */
428 if (end_one == one) return FALSE;
430 /* For each host in the 'one' sequence, check that it appears in the 'two'
431 sequence, returning FALSE if not. */
436 for (hi = two; hi != end_two->next; hi = hi->next)
437 if (Ustrcmp(one->name, hi->name) == 0) break;
438 if (hi == end_two->next) return FALSE;
439 if (one == end_one) break;
443 /* All the hosts in the 'one' sequence were found in the 'two' sequence.
444 Ensure both are pointing at the last host, and carry on as for equality. */
455 /* True if both are NULL */
462 /*************************************************
463 * Compare header lines *
464 *************************************************/
466 /* This function is given two pointers to chains of header items, and it yields
467 TRUE if they are the same header texts in the same order.
470 one points to the first header list
471 two points to the second header list
473 Returns: TRUE if the lists refer to the same header set
477 same_headers(header_line *one, header_line *two)
481 if (one == two) return TRUE; /* Includes the case where both NULL */
482 if (one == NULL || two == NULL) return FALSE;
483 if (Ustrcmp(one->text, two->text) != 0) return FALSE;
491 /*************************************************
492 * Compare string settings *
493 *************************************************/
495 /* This function is given two pointers to strings, and it returns
496 TRUE if they are the same pointer, or if the two strings are the same.
499 one points to the first string
500 two points to the second string
502 Returns: TRUE or FALSE
506 same_strings(uschar *one, uschar *two)
508 if (one == two) return TRUE; /* Includes the case where both NULL */
509 if (one == NULL || two == NULL) return FALSE;
510 return (Ustrcmp(one, two) == 0);
515 /*************************************************
516 * Compare uid/gid for addresses *
517 *************************************************/
519 /* This function is given a transport and two addresses. It yields TRUE if the
520 uid/gid/initgroups settings for the two addresses are going to be the same when
525 addr1 the first address
526 addr2 the second address
528 Returns: TRUE or FALSE
532 same_ugid(transport_instance *tp, address_item *addr1, address_item *addr2)
534 if (!tp->uid_set && tp->expand_uid == NULL && !tp->deliver_as_creator)
536 if (testflag(addr1, af_uid_set) != testflag(addr2, af_gid_set) ||
537 (testflag(addr1, af_uid_set) &&
538 (addr1->uid != addr2->uid ||
539 testflag(addr1, af_initgroups) != testflag(addr2, af_initgroups))))
543 if (!tp->gid_set && tp->expand_gid == NULL)
545 if (testflag(addr1, af_gid_set) != testflag(addr2, af_gid_set) ||
546 (testflag(addr1, af_gid_set) && addr1->gid != addr2->gid))
556 /*************************************************
557 * Record that an address is complete *
558 *************************************************/
560 /* This function records that an address is complete. This is straightforward
561 for most addresses, where the unique address is just the full address with the
562 domain lower cased. For homonyms (addresses that are the same as one of their
563 ancestors) their are complications. Their unique addresses have \x\ prepended
564 (where x = 0, 1, 2...), so that de-duplication works correctly for siblings and
567 Exim used to record the unique addresses of homonyms as "complete". This,
568 however, fails when the pattern of redirection varies over time (e.g. if taking
569 unseen copies at only some times of day) because the prepended numbers may vary
570 from one delivery run to the next. This problem is solved by never recording
571 prepended unique addresses as complete. Instead, when a homonymic address has
572 actually been delivered via a transport, we record its basic unique address
573 followed by the name of the transport. This is checked in subsequent delivery
574 runs whenever an address is routed to a transport.
576 If the completed address is a top-level one (has no parent, which means it
577 cannot be homonymic) we also add the original address to the non-recipients
578 tree, so that it gets recorded in the spool file and therefore appears as
579 "done" in any spool listings. The original address may differ from the unique
580 address in the case of the domain.
582 Finally, this function scans the list of duplicates, marks as done any that
583 match this address, and calls child_done() for their ancestors.
586 addr address item that has been completed
587 now current time as a string
593 address_done(address_item *addr, uschar *now)
597 update_spool = TRUE; /* Ensure spool gets updated */
599 /* Top-level address */
601 if (addr->parent == NULL)
603 tree_add_nonrecipient(addr->unique);
604 tree_add_nonrecipient(addr->address);
607 /* Homonymous child address */
609 else if (testflag(addr, af_homonym))
611 if (addr->transport != NULL)
613 tree_add_nonrecipient(
614 string_sprintf("%s/%s", addr->unique + 3, addr->transport->name));
618 /* Non-homonymous child address */
620 else tree_add_nonrecipient(addr->unique);
622 /* Check the list of duplicate addresses and ensure they are now marked
625 for (dup = addr_duplicate; dup != NULL; dup = dup->next)
627 if (Ustrcmp(addr->unique, dup->unique) == 0)
629 tree_add_nonrecipient(dup->unique);
630 child_done(dup, now);
638 /*************************************************
639 * Decrease counts in parents and mark done *
640 *************************************************/
642 /* This function is called when an address is complete. If there is a parent
643 address, its count of children is decremented. If there are still other
644 children outstanding, the function exits. Otherwise, if the count has become
645 zero, address_done() is called to mark the parent and its duplicates complete.
646 Then loop for any earlier ancestors.
649 addr points to the completed address item
650 now the current time as a string, for writing to the message log
656 child_done(address_item *addr, uschar *now)
659 while (addr->parent != NULL)
662 if ((addr->child_count -= 1) > 0) return; /* Incomplete parent */
663 address_done(addr, now);
665 /* Log the completion of all descendents only when there is no ancestor with
666 the same original address. */
668 for (aa = addr->parent; aa != NULL; aa = aa->parent)
669 if (Ustrcmp(aa->address, addr->address) == 0) break;
670 if (aa != NULL) continue;
672 deliver_msglog("%s %s: children all complete\n", now, addr->address);
673 DEBUG(D_deliver) debug_printf("%s: children all complete\n", addr->address);
681 d_hostlog(uschar * s, int * sizep, int * ptrp, address_item * addr)
683 s = string_append(s, sizep, ptrp, 5, US" H=", addr->host_used->name,
684 US" [", addr->host_used->address, US"]");
685 if ((log_extra_selector & LX_outgoing_port) != 0)
686 s = string_append(s, sizep, ptrp, 2, US":", string_sprintf("%d",
687 addr->host_used->port));
693 d_tlslog(uschar * s, int * sizep, int * ptrp, address_item * addr)
695 if ((log_extra_selector & LX_tls_cipher) != 0 && addr->cipher != NULL)
696 s = string_append(s, sizep, ptrp, 2, US" X=", addr->cipher);
697 if ((log_extra_selector & LX_tls_certificate_verified) != 0 &&
698 addr->cipher != NULL)
699 s = string_append(s, sizep, ptrp, 2, US" CV=",
700 testflag(addr, af_cert_verified)? "yes":"no");
701 if ((log_extra_selector & LX_tls_peerdn) != 0 && addr->peerdn != NULL)
702 s = string_append(s, sizep, ptrp, 3, US" DN=\"",
703 string_printing(addr->peerdn), US"\"");
708 /* If msg is NULL this is a delivery log and logchar is used. Otherwise
709 this is a nonstandard call; no two-character delivery flag is written
710 but sender-host and sender are prefixed and "msg" is inserted in the log line.
713 flags passed to log_write()
716 delivery_log(int flags, address_item * addr, int logchar, uschar * msg)
719 int size = 256; /* Used for a temporary, */
720 int ptr = 0; /* expanding buffer, for */
721 uschar *s; /* building log lines; */
722 void *reset_point; /* released afterwards. */
725 /* Log the delivery on the main log. We use an extensible string to build up
726 the log line, and reset the store afterwards. Remote deliveries should always
727 have a pointer to the host item that succeeded; local deliveries can have a
728 pointer to a single host item in their host list, for use by the transport. */
730 #ifdef EXPERIMENTAL_TPDA
731 tpda_delivery_ip = NULL; /* presume no successful remote delivery */
732 tpda_delivery_port = 0;
733 tpda_delivery_fqdn = NULL;
734 tpda_delivery_local_part = NULL;
735 tpda_delivery_domain = NULL;
736 tpda_delivery_confirmation = NULL;
737 lookup_dnssec_authenticated = NULL;
740 s = reset_point = store_get(size);
742 log_address = string_log_address(addr, (log_write_selector & L_all_parents) != 0, TRUE);
744 s = string_append(s, &size, &ptr, 3, host_and_ident(TRUE), US" ", log_address);
748 s = string_append(s, &size, &ptr, 2, US"> ", log_address);
751 if ((log_extra_selector & LX_sender_on_delivery) != 0 || msg)
752 s = string_append(s, &size, &ptr, 3, US" F=<", sender_address, US">");
754 #ifdef EXPERIMENTAL_SRS
755 if(addr->p.srs_sender)
756 s = string_append(s, &size, &ptr, 3, US" SRS=<", addr->p.srs_sender, US">");
759 /* You might think that the return path must always be set for a successful
760 delivery; indeed, I did for some time, until this statement crashed. The case
761 when it is not set is for a delivery to /dev/null which is optimised by not
764 if (used_return_path != NULL &&
765 (log_extra_selector & LX_return_path_on_delivery) != 0)
766 s = string_append(s, &size, &ptr, 3, US" P=<", used_return_path, US">");
769 s = string_append(s, &size, &ptr, 2, US" ", msg);
771 /* For a delivery from a system filter, there may not be a router */
772 if (addr->router != NULL)
773 s = string_append(s, &size, &ptr, 2, US" R=", addr->router->name);
775 s = string_append(s, &size, &ptr, 2, US" T=", addr->transport->name);
777 if ((log_extra_selector & LX_delivery_size) != 0)
778 s = string_append(s, &size, &ptr, 2, US" S=",
779 string_sprintf("%d", transport_count));
783 if (addr->transport->info->local)
785 if (addr->host_list != NULL)
787 s = string_append(s, &size, &ptr, 2, US" H=", addr->host_list->name);
788 #ifdef EXPERIMENTAL_TPDA
789 tpda_delivery_fqdn = addr->host_list->name;
792 if (addr->shadow_message != NULL)
793 s = string_cat(s, &size, &ptr, addr->shadow_message,
794 Ustrlen(addr->shadow_message));
797 /* Remote delivery */
803 s = d_hostlog(s, &size, &ptr, addr);
804 if (continue_sequence > 1)
805 s = string_cat(s, &size, &ptr, US"*", 1);
807 #ifdef EXPERIMENTAL_TPDA
808 tpda_delivery_ip = addr->host_used->address;
809 tpda_delivery_port = addr->host_used->port;
810 tpda_delivery_fqdn = addr->host_used->name;
811 tpda_delivery_local_part = addr->local_part;
812 tpda_delivery_domain = addr->domain;
813 tpda_delivery_confirmation = addr->message;
815 /* DNS lookup status */
816 lookup_dnssec_authenticated = addr->host_used->dnssec==DS_YES ? US"yes"
817 : addr->host_used->dnssec==DS_NO ? US"no"
823 s = d_tlslog(s, &size, &ptr, addr);
826 if (addr->authenticator)
828 s = string_append(s, &size, &ptr, 2, US" A=", addr->authenticator);
831 s = string_append(s, &size, &ptr, 2, US":", addr->auth_id);
832 if (log_extra_selector & LX_smtp_mailauth && addr->auth_sndr)
833 s = string_append(s, &size, &ptr, 2, US":", addr->auth_sndr);
838 if (addr->flags & af_prdr_used)
839 s = string_append(s, &size, &ptr, 1, US" PRDR");
843 /* confirmation message (SMTP (host_used) and LMTP (driver_name)) */
845 if (log_extra_selector & LX_smtp_confirmation &&
847 (addr->host_used || Ustrcmp(addr->transport->driver_name, "lmtp") == 0))
850 uschar *p = big_buffer;
851 uschar *ss = addr->message;
853 for (i = 0; i < 256 && ss[i] != 0; i++) /* limit logged amount */
855 if (ss[i] == '\"' || ss[i] == '\\') *p++ = '\\'; /* quote \ and " */
860 s = string_append(s, &size, &ptr, 2, US" C=", big_buffer);
863 /* Time on queue and actual time taken to deliver */
865 if ((log_extra_selector & LX_queue_time) != 0)
866 s = string_append(s, &size, &ptr, 2, US" QT=",
867 readconf_printtime( (int) ((long)time(NULL) - (long)received_time)) );
869 if ((log_extra_selector & LX_deliver_time) != 0)
870 s = string_append(s, &size, &ptr, 2, US" DT=",
871 readconf_printtime(addr->more_errno));
873 /* string_cat() always leaves room for the terminator. Release the
874 store we used to build the line after writing it. */
877 log_write(0, flags, "%s", s);
879 #ifdef EXPERIMENTAL_TPDA
880 if (addr->transport->tpda_delivery_action)
883 debug_printf(" TPDA(Delivery): tpda_deliver_action=|%s| tpda_delivery_IP=%s\n",
884 addr->transport->tpda_delivery_action, tpda_delivery_ip);
886 router_name = addr->router->name;
887 transport_name = addr->transport->name;
888 if (!expand_string(addr->transport->tpda_delivery_action) && *expand_string_message)
889 log_write(0, LOG_MAIN|LOG_PANIC, "failed to expand tpda_deliver_action in %s: %s\n",
890 transport_name, expand_string_message);
892 transport_name = NULL;
895 store_reset(reset_point);
901 /*************************************************
902 * Actions at the end of handling an address *
903 *************************************************/
905 /* This is a function for processing a single address when all that can be done
906 with it has been done.
909 addr points to the address block
910 result the result of the delivery attempt
911 logflags flags for log_write() (LOG_MAIN and/or LOG_PANIC)
912 driver_type indicates which type of driver (transport, or router) was last
913 to process the address
914 logchar '=' or '-' for use when logging deliveries with => or ->
920 post_process_one(address_item *addr, int result, int logflags, int driver_type,
923 uschar *now = tod_stamp(tod_log);
924 uschar *driver_kind = NULL;
925 uschar *driver_name = NULL;
928 int size = 256; /* Used for a temporary, */
929 int ptr = 0; /* expanding buffer, for */
930 uschar *s; /* building log lines; */
931 void *reset_point; /* released afterwards. */
934 DEBUG(D_deliver) debug_printf("post-process %s (%d)\n", addr->address, result);
936 /* Set up driver kind and name for logging. Disable logging if the router or
937 transport has disabled it. */
939 if (driver_type == DTYPE_TRANSPORT)
941 if (addr->transport != NULL)
943 driver_name = addr->transport->name;
944 driver_kind = US" transport";
945 disable_logging = addr->transport->disable_logging;
947 else driver_kind = US"transporting";
949 else if (driver_type == DTYPE_ROUTER)
951 if (addr->router != NULL)
953 driver_name = addr->router->name;
954 driver_kind = US" router";
955 disable_logging = addr->router->disable_logging;
957 else driver_kind = US"routing";
960 /* If there's an error message set, ensure that it contains only printing
961 characters - it should, but occasionally things slip in and this at least
962 stops the log format from getting wrecked. We also scan the message for an LDAP
963 expansion item that has a password setting, and flatten the password. This is a
964 fudge, but I don't know a cleaner way of doing this. (If the item is badly
965 malformed, it won't ever have gone near LDAP.) */
967 if (addr->message != NULL)
969 addr->message = string_printing(addr->message);
970 if (((Ustrstr(addr->message, "failed to expand") != NULL) || (Ustrstr(addr->message, "expansion of ") != NULL)) &&
971 (Ustrstr(addr->message, "mysql") != NULL ||
972 Ustrstr(addr->message, "pgsql") != NULL ||
973 #ifdef EXPERIMENTAL_REDIS
974 Ustrstr(addr->message, "redis") != NULL ||
976 Ustrstr(addr->message, "sqlite") != NULL ||
977 Ustrstr(addr->message, "ldap:") != NULL ||
978 Ustrstr(addr->message, "ldapdn:") != NULL ||
979 Ustrstr(addr->message, "ldapm:") != NULL))
981 addr->message = string_sprintf("Temporary internal error");
985 /* If we used a transport that has one of the "return_output" options set, and
986 if it did in fact generate some output, then for return_output we treat the
987 message as failed if it was not already set that way, so that the output gets
988 returned to the sender, provided there is a sender to send it to. For
989 return_fail_output, do this only if the delivery failed. Otherwise we just
990 unlink the file, and remove the name so that if the delivery failed, we don't
991 try to send back an empty or unwanted file. The log_output options operate only
994 In any case, we close the message file, because we cannot afford to leave a
995 file-descriptor for one address while processing (maybe very many) others. */
997 if (addr->return_file >= 0 && addr->return_filename != NULL)
999 BOOL return_output = FALSE;
1000 struct stat statbuf;
1001 (void)EXIMfsync(addr->return_file);
1003 /* If there is no output, do nothing. */
1005 if (fstat(addr->return_file, &statbuf) == 0 && statbuf.st_size > 0)
1007 transport_instance *tb = addr->transport;
1009 /* Handle logging options */
1011 if (tb->log_output || (result == FAIL && tb->log_fail_output) ||
1012 (result == DEFER && tb->log_defer_output))
1015 FILE *f = Ufopen(addr->return_filename, "rb");
1017 log_write(0, LOG_MAIN|LOG_PANIC, "failed to open %s to log output "
1018 "from %s transport: %s", addr->return_filename, tb->name,
1022 s = US Ufgets(big_buffer, big_buffer_size, f);
1025 uschar *p = big_buffer + Ustrlen(big_buffer);
1026 while (p > big_buffer && isspace(p[-1])) p--;
1028 s = string_printing(big_buffer);
1029 log_write(0, LOG_MAIN, "<%s>: %s transport output: %s",
1030 addr->address, tb->name, s);
1036 /* Handle returning options, but only if there is an address to return
1039 if (sender_address[0] != 0 || addr->p.errors_address != NULL)
1041 if (tb->return_output)
1043 addr->transport_return = result = FAIL;
1044 if (addr->basic_errno == 0 && addr->message == NULL)
1045 addr->message = US"return message generated";
1046 return_output = TRUE;
1049 if (tb->return_fail_output && result == FAIL) return_output = TRUE;
1053 /* Get rid of the file unless it might be returned, but close it in
1058 Uunlink(addr->return_filename);
1059 addr->return_filename = NULL;
1060 addr->return_file = -1;
1063 (void)close(addr->return_file);
1066 /* The success case happens only after delivery by a transport. */
1070 addr->next = addr_succeed;
1071 addr_succeed = addr;
1073 /* Call address_done() to ensure that we don't deliver to this address again,
1074 and write appropriate things to the message log. If it is a child address, we
1075 call child_done() to scan the ancestors and mark them complete if this is the
1076 last child to complete. */
1078 address_done(addr, now);
1079 DEBUG(D_deliver) debug_printf("%s delivered\n", addr->address);
1081 if (addr->parent == NULL)
1082 deliver_msglog("%s %s: %s%s succeeded\n", now, addr->address,
1083 driver_name, driver_kind);
1086 deliver_msglog("%s %s <%s>: %s%s succeeded\n", now, addr->address,
1087 addr->parent->address, driver_name, driver_kind);
1088 child_done(addr, now);
1091 /* Certificates for logging (via TPDA) */
1093 tls_out.ourcert = addr->ourcert;
1094 addr->ourcert = NULL;
1095 tls_out.peercert = addr->peercert;
1096 addr->peercert = NULL;
1098 tls_out.cipher = addr->cipher;
1099 tls_out.peerdn = addr->peerdn;
1100 tls_out.ocsp = addr->ocsp;
1103 delivery_log(LOG_MAIN, addr, logchar, NULL);
1106 if (tls_out.ourcert)
1108 tls_free_cert(tls_out.ourcert);
1109 tls_out.ourcert = NULL;
1111 if (tls_out.peercert)
1113 tls_free_cert(tls_out.peercert);
1114 tls_out.peercert = NULL;
1116 tls_out.cipher = NULL;
1117 tls_out.peerdn = NULL;
1118 tls_out.ocsp = OCSP_NOT_REQ;
1123 /* Soft failure, or local delivery process failed; freezing may be
1126 else if (result == DEFER || result == PANIC)
1128 if (result == PANIC) logflags |= LOG_PANIC;
1130 /* This puts them on the chain in reverse order. Do not change this, because
1131 the code for handling retries assumes that the one with the retry
1132 information is last. */
1134 addr->next = addr_defer;
1137 /* The only currently implemented special action is to freeze the
1138 message. Logging of this is done later, just before the -H file is
1141 if (addr->special_action == SPECIAL_FREEZE)
1143 deliver_freeze = TRUE;
1144 deliver_frozen_at = time(NULL);
1145 update_spool = TRUE;
1148 /* If doing a 2-stage queue run, we skip writing to either the message
1149 log or the main log for SMTP defers. */
1151 if (!queue_2stage || addr->basic_errno != 0)
1155 /* For errors of the type "retry time not reached" (also remotes skipped
1156 on queue run), logging is controlled by L_retry_defer. Note that this kind
1157 of error number is negative, and all the retry ones are less than any
1160 unsigned int use_log_selector = (addr->basic_errno <= ERRNO_RETRY_BASE)?
1163 /* Build up the line that is used for both the message log and the main
1166 s = reset_point = store_get(size);
1168 /* Create the address string for logging. Must not do this earlier, because
1169 an OK result may be changed to FAIL when a pipe returns text. */
1171 log_address = string_log_address(addr,
1172 (log_write_selector & L_all_parents) != 0, result == OK);
1174 s = string_cat(s, &size, &ptr, log_address, Ustrlen(log_address));
1176 /* Either driver_name contains something and driver_kind contains
1177 " router" or " transport" (note the leading space), or driver_name is
1178 a null string and driver_kind contains "routing" without the leading
1179 space, if all routing has been deferred. When a domain has been held,
1180 so nothing has been done at all, both variables contain null strings. */
1182 if (driver_name == NULL)
1184 if (driver_kind != NULL)
1185 s = string_append(s, &size, &ptr, 2, US" ", driver_kind);
1189 if (driver_kind[1] == 't' && addr->router != NULL)
1190 s = string_append(s, &size, &ptr, 2, US" R=", addr->router->name);
1192 ss[1] = toupper(driver_kind[1]);
1193 s = string_append(s, &size, &ptr, 2, ss, driver_name);
1196 sprintf(CS ss, " defer (%d)", addr->basic_errno);
1197 s = string_cat(s, &size, &ptr, ss, Ustrlen(ss));
1199 if (addr->basic_errno > 0)
1200 s = string_append(s, &size, &ptr, 2, US": ",
1201 US strerror(addr->basic_errno));
1203 if (addr->message != NULL)
1204 s = string_append(s, &size, &ptr, 2, US": ", addr->message);
1208 /* Log the deferment in the message log, but don't clutter it
1209 up with retry-time defers after the first delivery attempt. */
1211 if (deliver_firsttime || addr->basic_errno > ERRNO_RETRY_BASE)
1212 deliver_msglog("%s %s\n", now, s);
1214 /* Write the main log and reset the store */
1216 log_write(use_log_selector, logflags, "== %s", s);
1217 store_reset(reset_point);
1222 /* Hard failure. If there is an address to which an error message can be sent,
1223 put this address on the failed list. If not, put it on the deferred list and
1224 freeze the mail message for human attention. The latter action can also be
1225 explicitly requested by a router or transport. */
1229 /* If this is a delivery error, or a message for which no replies are
1230 wanted, and the message's age is greater than ignore_bounce_errors_after,
1231 force the af_ignore_error flag. This will cause the address to be discarded
1232 later (with a log entry). */
1234 if (sender_address[0] == 0 && message_age >= ignore_bounce_errors_after)
1235 setflag(addr, af_ignore_error);
1237 /* Freeze the message if requested, or if this is a bounce message (or other
1238 message with null sender) and this address does not have its own errors
1239 address. However, don't freeze if errors are being ignored. The actual code
1240 to ignore occurs later, instead of sending a message. Logging of freezing
1241 occurs later, just before writing the -H file. */
1243 if (!testflag(addr, af_ignore_error) &&
1244 (addr->special_action == SPECIAL_FREEZE ||
1245 (sender_address[0] == 0 && addr->p.errors_address == NULL)
1248 frozen_info = (addr->special_action == SPECIAL_FREEZE)? US"" :
1249 (sender_local && !local_error_message)?
1250 US" (message created with -f <>)" : US" (delivery error message)";
1251 deliver_freeze = TRUE;
1252 deliver_frozen_at = time(NULL);
1253 update_spool = TRUE;
1255 /* The address is put on the defer rather than the failed queue, because
1256 the message is being retained. */
1258 addr->next = addr_defer;
1262 /* Don't put the address on the nonrecipients tree yet; wait until an
1263 error message has been successfully sent. */
1267 addr->next = addr_failed;
1271 /* Build up the log line for the message and main logs */
1273 s = reset_point = store_get(size);
1275 /* Create the address string for logging. Must not do this earlier, because
1276 an OK result may be changed to FAIL when a pipe returns text. */
1278 log_address = string_log_address(addr,
1279 (log_write_selector & L_all_parents) != 0, result == OK);
1281 s = string_cat(s, &size, &ptr, log_address, Ustrlen(log_address));
1283 if ((log_extra_selector & LX_sender_on_delivery) != 0)
1284 s = string_append(s, &size, &ptr, 3, US" F=<", sender_address, US">");
1286 /* Return path may not be set if no delivery actually happened */
1288 if (used_return_path != NULL &&
1289 (log_extra_selector & LX_return_path_on_delivery) != 0)
1290 s = string_append(s, &size, &ptr, 3, US" P=<", used_return_path, US">");
1292 if (addr->router != NULL)
1293 s = string_append(s, &size, &ptr, 2, US" R=", addr->router->name);
1294 if (addr->transport != NULL)
1295 s = string_append(s, &size, &ptr, 2, US" T=", addr->transport->name);
1297 if (addr->host_used != NULL)
1298 s = d_hostlog(s, &size, &ptr, addr);
1301 s = d_tlslog(s, &size, &ptr, addr);
1304 if (addr->basic_errno > 0)
1305 s = string_append(s, &size, &ptr, 2, US": ",
1306 US strerror(addr->basic_errno));
1308 if (addr->message != NULL)
1309 s = string_append(s, &size, &ptr, 2, US": ", addr->message);
1313 /* Do the logging. For the message log, "routing failed" for those cases,
1314 just to make it clearer. */
1316 if (driver_name == NULL)
1317 deliver_msglog("%s %s failed for %s\n", now, driver_kind, s);
1319 deliver_msglog("%s %s\n", now, s);
1321 log_write(0, LOG_MAIN, "** %s", s);
1322 store_reset(reset_point);
1325 /* Ensure logging is turned on again in all cases */
1327 disable_logging = FALSE;
1333 /*************************************************
1334 * Address-independent error *
1335 *************************************************/
1337 /* This function is called when there's an error that is not dependent on a
1338 particular address, such as an expansion string failure. It puts the error into
1339 all the addresses in a batch, logs the incident on the main and panic logs, and
1340 clears the expansions. It is mostly called from local_deliver(), but can be
1341 called for a remote delivery via findugid().
1344 logit TRUE if (MAIN+PANIC) logging required
1345 addr the first of the chain of addresses
1347 format format string for error message, or NULL if already set in addr
1348 ... arguments for the format
1354 common_error(BOOL logit, address_item *addr, int code, uschar *format, ...)
1356 address_item *addr2;
1357 addr->basic_errno = code;
1363 va_start(ap, format);
1364 if (!string_vformat(buffer, sizeof(buffer), CS format, ap))
1365 log_write(0, LOG_MAIN|LOG_PANIC_DIE,
1366 "common_error expansion was longer than " SIZE_T_FMT, sizeof(buffer));
1368 addr->message = string_copy(buffer);
1371 for (addr2 = addr->next; addr2 != NULL; addr2 = addr2->next)
1373 addr2->basic_errno = code;
1374 addr2->message = addr->message;
1377 if (logit) log_write(0, LOG_MAIN|LOG_PANIC, "%s", addr->message);
1378 deliver_set_expansions(NULL);
1384 /*************************************************
1385 * Check a "never users" list *
1386 *************************************************/
1388 /* This function is called to check whether a uid is on one of the two "never
1392 uid the uid to be checked
1393 nusers the list to be scanned; the first item in the list is the count
1395 Returns: TRUE if the uid is on the list
1399 check_never_users(uid_t uid, uid_t *nusers)
1402 if (nusers == NULL) return FALSE;
1403 for (i = 1; i <= (int)(nusers[0]); i++) if (nusers[i] == uid) return TRUE;
1409 /*************************************************
1410 * Find uid and gid for a transport *
1411 *************************************************/
1413 /* This function is called for both local and remote deliveries, to find the
1414 uid/gid under which to run the delivery. The values are taken preferentially
1415 from the transport (either explicit or deliver_as_creator), then from the
1416 address (i.e. the router), and if nothing is set, the exim uid/gid are used. If
1417 the resulting uid is on the "never_users" or the "fixed_never_users" list, a
1418 panic error is logged, and the function fails (which normally leads to delivery
1422 addr the address (possibly a chain)
1424 uidp pointer to uid field
1425 gidp pointer to gid field
1426 igfp pointer to the use_initgroups field
1428 Returns: FALSE if failed - error has been set in address(es)
1432 findugid(address_item *addr, transport_instance *tp, uid_t *uidp, gid_t *gidp,
1435 uschar *nuname = NULL;
1436 BOOL gid_set = FALSE;
1438 /* Default initgroups flag comes from the transport */
1440 *igfp = tp->initgroups;
1442 /* First see if there's a gid on the transport, either fixed or expandable.
1443 The expanding function always logs failure itself. */
1450 else if (tp->expand_gid != NULL)
1452 if (route_find_expanded_group(tp->expand_gid, tp->name, US"transport", gidp,
1453 &(addr->message))) gid_set = TRUE;
1456 common_error(FALSE, addr, ERRNO_GIDFAIL, NULL);
1461 /* If the transport did not set a group, see if the router did. */
1463 if (!gid_set && testflag(addr, af_gid_set))
1469 /* Pick up a uid from the transport if one is set. */
1471 if (tp->uid_set) *uidp = tp->uid;
1473 /* Otherwise, try for an expandable uid field. If it ends up as a numeric id,
1474 it does not provide a passwd value from which a gid can be taken. */
1476 else if (tp->expand_uid != NULL)
1479 if (!route_find_expanded_user(tp->expand_uid, tp->name, US"transport", &pw,
1480 uidp, &(addr->message)))
1482 common_error(FALSE, addr, ERRNO_UIDFAIL, NULL);
1485 if (!gid_set && pw != NULL)
1492 /* If the transport doesn't set the uid, test the deliver_as_creator flag. */
1494 else if (tp->deliver_as_creator)
1496 *uidp = originator_uid;
1499 *gidp = originator_gid;
1504 /* Otherwise see if the address specifies the uid and if so, take it and its
1507 else if (testflag(addr, af_uid_set))
1510 *igfp = testflag(addr, af_initgroups);
1513 /* Nothing has specified the uid - default to the Exim user, and group if the
1526 /* If no gid is set, it is a disaster. We default to the Exim gid only if
1527 defaulting to the Exim uid. In other words, if the configuration has specified
1528 a uid, it must also provide a gid. */
1532 common_error(TRUE, addr, ERRNO_GIDFAIL, US"User set without group for "
1533 "%s transport", tp->name);
1537 /* Check that the uid is not on the lists of banned uids that may not be used
1538 for delivery processes. */
1540 if (check_never_users(*uidp, never_users))
1541 nuname = US"never_users";
1542 else if (check_never_users(*uidp, fixed_never_users))
1543 nuname = US"fixed_never_users";
1547 common_error(TRUE, addr, ERRNO_UIDFAIL, US"User %ld set for %s transport "
1548 "is on the %s list", (long int)(*uidp), tp->name, nuname);
1560 /*************************************************
1561 * Check the size of a message for a transport *
1562 *************************************************/
1564 /* Checks that the message isn't too big for the selected transport.
1565 This is called only when it is known that the limit is set.
1569 addr the (first) address being delivered
1572 DEFER expansion failed or did not yield an integer
1573 FAIL message too big
1577 check_message_size(transport_instance *tp, address_item *addr)
1582 deliver_set_expansions(addr);
1583 size_limit = expand_string_integer(tp->message_size_limit, TRUE);
1584 deliver_set_expansions(NULL);
1586 if (expand_string_message != NULL)
1589 if (size_limit == -1)
1590 addr->message = string_sprintf("failed to expand message_size_limit "
1591 "in %s transport: %s", tp->name, expand_string_message);
1593 addr->message = string_sprintf("invalid message_size_limit "
1594 "in %s transport: %s", tp->name, expand_string_message);
1596 else if (size_limit > 0 && message_size > size_limit)
1600 string_sprintf("message is too big (transport limit = %d)",
1609 /*************************************************
1610 * Transport-time check for a previous delivery *
1611 *************************************************/
1613 /* Check that this base address hasn't previously been delivered to its routed
1614 transport. If it has been delivered, mark it done. The check is necessary at
1615 delivery time in order to handle homonymic addresses correctly in cases where
1616 the pattern of redirection changes between delivery attempts (so the unique
1617 fields change). Non-homonymic previous delivery is detected earlier, at routing
1618 time (which saves unnecessary routing).
1621 addr the address item
1622 testing TRUE if testing wanted only, without side effects
1624 Returns: TRUE if previously delivered by the transport
1628 previously_transported(address_item *addr, BOOL testing)
1630 (void)string_format(big_buffer, big_buffer_size, "%s/%s",
1631 addr->unique + (testflag(addr, af_homonym)? 3:0), addr->transport->name);
1633 if (tree_search(tree_nonrecipients, big_buffer) != 0)
1635 DEBUG(D_deliver|D_route|D_transport)
1636 debug_printf("%s was previously delivered (%s transport): discarded\n",
1637 addr->address, addr->transport->name);
1638 if (!testing) child_done(addr, tod_stamp(tod_log));
1647 /******************************************************
1648 * Check for a given header in a header string *
1649 ******************************************************/
1651 /* This function is used when generating quota warnings. The configuration may
1652 specify any header lines it likes in quota_warn_message. If certain of them are
1653 missing, defaults are inserted, so we need to be able to test for the presence
1657 hdr the required header name
1658 hstring the header string
1660 Returns: TRUE the header is in the string
1661 FALSE the header is not in the string
1665 contains_header(uschar *hdr, uschar *hstring)
1667 int len = Ustrlen(hdr);
1668 uschar *p = hstring;
1671 if (strncmpic(p, hdr, len) == 0)
1674 while (*p == ' ' || *p == '\t') p++;
1675 if (*p == ':') return TRUE;
1677 while (*p != 0 && *p != '\n') p++;
1678 if (*p == '\n') p++;
1686 /*************************************************
1687 * Perform a local delivery *
1688 *************************************************/
1690 /* Each local delivery is performed in a separate process which sets its
1691 uid and gid as specified. This is a safer way than simply changing and
1692 restoring using seteuid(); there is a body of opinion that seteuid() cannot be
1693 used safely. From release 4, Exim no longer makes any use of it. Besides, not
1694 all systems have seteuid().
1696 If the uid/gid are specified in the transport_instance, they are used; the
1697 transport initialization must ensure that either both or neither are set.
1698 Otherwise, the values associated with the address are used. If neither are set,
1699 it is a configuration error.
1701 The transport or the address may specify a home directory (transport over-
1702 rides), and if they do, this is set as $home. If neither have set a working
1703 directory, this value is used for that as well. Otherwise $home is left unset
1704 and the cwd is set to "/" - a directory that should be accessible to all users.
1706 Using a separate process makes it more complicated to get error information
1707 back. We use a pipe to pass the return code and also an error code and error
1708 text string back to the parent process.
1711 addr points to an address block for this delivery; for "normal" local
1712 deliveries this is the only address to be delivered, but for
1713 pseudo-remote deliveries (e.g. by batch SMTP to a file or pipe)
1714 a number of addresses can be handled simultaneously, and in this
1715 case addr will point to a chain of addresses with the same
1718 shadowing TRUE if running a shadow transport; this causes output from pipes
1725 deliver_local(address_item *addr, BOOL shadowing)
1727 BOOL use_initgroups;
1730 int status, len, rc;
1733 uschar *working_directory;
1734 address_item *addr2;
1735 transport_instance *tp = addr->transport;
1737 /* Set up the return path from the errors or sender address. If the transport
1738 has its own return path setting, expand it and replace the existing value. */
1740 if(addr->p.errors_address != NULL)
1741 return_path = addr->p.errors_address;
1742 #ifdef EXPERIMENTAL_SRS
1743 else if(addr->p.srs_sender != NULL)
1744 return_path = addr->p.srs_sender;
1747 return_path = sender_address;
1749 if (tp->return_path != NULL)
1751 uschar *new_return_path = expand_string(tp->return_path);
1752 if (new_return_path == NULL)
1754 if (!expand_string_forcedfail)
1756 common_error(TRUE, addr, ERRNO_EXPANDFAIL,
1757 US"Failed to expand return path \"%s\" in %s transport: %s",
1758 tp->return_path, tp->name, expand_string_message);
1762 else return_path = new_return_path;
1765 /* For local deliveries, one at a time, the value used for logging can just be
1766 set directly, once and for all. */
1768 used_return_path = return_path;
1770 /* Sort out the uid, gid, and initgroups flag. If an error occurs, the message
1771 gets put into the address(es), and the expansions are unset, so we can just
1774 if (!findugid(addr, tp, &uid, &gid, &use_initgroups)) return;
1776 /* See if either the transport or the address specifies a home directory. A
1777 home directory set in the address may already be expanded; a flag is set to
1778 indicate that. In other cases we must expand it. */
1780 if ((deliver_home = tp->home_dir) != NULL || /* Set in transport, or */
1781 ((deliver_home = addr->home_dir) != NULL && /* Set in address and */
1782 !testflag(addr, af_home_expanded))) /* not expanded */
1784 uschar *rawhome = deliver_home;
1785 deliver_home = NULL; /* in case it contains $home */
1786 deliver_home = expand_string(rawhome);
1787 if (deliver_home == NULL)
1789 common_error(TRUE, addr, ERRNO_EXPANDFAIL, US"home directory \"%s\" failed "
1790 "to expand for %s transport: %s", rawhome, tp->name,
1791 expand_string_message);
1794 if (*deliver_home != '/')
1796 common_error(TRUE, addr, ERRNO_NOTABSOLUTE, US"home directory path \"%s\" "
1797 "is not absolute for %s transport", deliver_home, tp->name);
1802 /* See if either the transport or the address specifies a current directory,
1803 and if so, expand it. If nothing is set, use the home directory, unless it is
1804 also unset in which case use "/", which is assumed to be a directory to which
1805 all users have access. It is necessary to be in a visible directory for some
1806 operating systems when running pipes, as some commands (e.g. "rm" under Solaris
1807 2.5) require this. */
1809 working_directory = (tp->current_dir != NULL)?
1810 tp->current_dir : addr->current_dir;
1812 if (working_directory != NULL)
1814 uschar *raw = working_directory;
1815 working_directory = expand_string(raw);
1816 if (working_directory == NULL)
1818 common_error(TRUE, addr, ERRNO_EXPANDFAIL, US"current directory \"%s\" "
1819 "failed to expand for %s transport: %s", raw, tp->name,
1820 expand_string_message);
1823 if (*working_directory != '/')
1825 common_error(TRUE, addr, ERRNO_NOTABSOLUTE, US"current directory path "
1826 "\"%s\" is not absolute for %s transport", working_directory, tp->name);
1830 else working_directory = (deliver_home == NULL)? US"/" : deliver_home;
1832 /* If one of the return_output flags is set on the transport, create and open a
1833 file in the message log directory for the transport to write its output onto.
1834 This is mainly used by pipe transports. The file needs to be unique to the
1835 address. This feature is not available for shadow transports. */
1837 if (!shadowing && (tp->return_output || tp->return_fail_output ||
1838 tp->log_output || tp->log_fail_output))
1841 addr->return_filename =
1842 string_sprintf("%s/msglog/%s/%s-%d-%d", spool_directory, message_subdir,
1843 message_id, getpid(), return_count++);
1844 addr->return_file = open_msglog_file(addr->return_filename, 0400, &error);
1845 if (addr->return_file < 0)
1847 common_error(TRUE, addr, errno, US"Unable to %s file for %s transport "
1848 "to return message: %s", error, tp->name, strerror(errno));
1853 /* Create the pipe for inter-process communication. */
1857 common_error(TRUE, addr, ERRNO_PIPEFAIL, US"Creation of pipe failed: %s",
1862 /* Now fork the process to do the real work in the subprocess, but first
1863 ensure that all cached resources are freed so that the subprocess starts with
1864 a clean slate and doesn't interfere with the parent process. */
1868 if ((pid = fork()) == 0)
1870 BOOL replicate = TRUE;
1872 /* Prevent core dumps, as we don't want them in users' home directories.
1873 HP-UX doesn't have RLIMIT_CORE; I don't know how to do this in that
1874 system. Some experimental/developing systems (e.g. GNU/Hurd) may define
1875 RLIMIT_CORE but not support it in setrlimit(). For such systems, do not
1876 complain if the error is "not supported".
1878 There are two scenarios where changing the max limit has an effect. In one,
1879 the user is using a .forward and invoking a command of their choice via pipe;
1880 for these, we do need the max limit to be 0 unless the admin chooses to
1881 permit an increased limit. In the other, the command is invoked directly by
1882 the transport and is under administrator control, thus being able to raise
1883 the limit aids in debugging. So there's no general always-right answer.
1885 Thus we inhibit core-dumps completely but let individual transports, while
1886 still root, re-raise the limits back up to aid debugging. We make the
1887 default be no core-dumps -- few enough people can use core dumps in
1888 diagnosis that it's reasonable to make them something that has to be explicitly requested.
1895 if (setrlimit(RLIMIT_CORE, &rl) < 0)
1897 #ifdef SETRLIMIT_NOT_SUPPORTED
1898 if (errno != ENOSYS && errno != ENOTSUP)
1900 log_write(0, LOG_MAIN|LOG_PANIC, "setrlimit(RLIMIT_CORE) failed: %s",
1905 /* Reset the random number generator, so different processes don't all
1906 have the same sequence. */
1910 /* If the transport has a setup entry, call this first, while still
1911 privileged. (Appendfile uses this to expand quota, for example, while
1912 able to read private files.) */
1914 if (addr->transport->setup != NULL)
1916 switch((addr->transport->setup)(addr->transport, addr, NULL, uid, gid,
1920 addr->transport_return = DEFER;
1924 addr->transport_return = PANIC;
1929 /* Ignore SIGINT and SIGTERM during delivery. Also ignore SIGUSR1, as
1930 when the process becomes unprivileged, it won't be able to write to the
1931 process log. SIGHUP is ignored throughout exim, except when it is being
1934 signal(SIGINT, SIG_IGN);
1935 signal(SIGTERM, SIG_IGN);
1936 signal(SIGUSR1, SIG_IGN);
1938 /* Close the unwanted half of the pipe, and set close-on-exec for the other
1939 half - for transports that exec things (e.g. pipe). Then set the required
1942 (void)close(pfd[pipe_read]);
1943 (void)fcntl(pfd[pipe_write], F_SETFD, fcntl(pfd[pipe_write], F_GETFD) |
1945 exim_setugid(uid, gid, use_initgroups,
1946 string_sprintf("local delivery to %s <%s> transport=%s", addr->local_part,
1947 addr->address, addr->transport->name));
1951 address_item *batched;
1952 debug_printf(" home=%s current=%s\n", deliver_home, working_directory);
1953 for (batched = addr->next; batched != NULL; batched = batched->next)
1954 debug_printf("additional batched address: %s\n", batched->address);
1957 /* Set an appropriate working directory. */
1959 if (Uchdir(working_directory) < 0)
1961 addr->transport_return = DEFER;
1962 addr->basic_errno = errno;
1963 addr->message = string_sprintf("failed to chdir to %s", working_directory);
1966 /* If successful, call the transport */
1971 set_process_info("delivering %s to %s using %s", message_id,
1972 addr->local_part, addr->transport->name);
1974 /* Setting this global in the subprocess means we need never clear it */
1975 transport_name = addr->transport->name;
1977 /* If a transport filter has been specified, set up its argument list.
1978 Any errors will get put into the address, and FALSE yielded. */
1980 if (addr->transport->filter_command != NULL)
1982 ok = transport_set_up_command(&transport_filter_argv,
1983 addr->transport->filter_command,
1984 TRUE, PANIC, addr, US"transport filter", NULL);
1985 transport_filter_timeout = addr->transport->filter_timeout;
1987 else transport_filter_argv = NULL;
1991 debug_print_string(addr->transport->debug_string);
1992 replicate = !(addr->transport->info->code)(addr->transport, addr);
1996 /* Pass the results back down the pipe. If necessary, first replicate the
1997 status in the top address to the others in the batch. The label is the
1998 subject of a goto when a call to the transport's setup function fails. We
1999 pass the pointer to the transport back in case it got changed as a result of
2000 file_format in appendfile. */
2004 if (replicate) replicate_status(addr);
2005 for (addr2 = addr; addr2 != NULL; addr2 = addr2->next)
2008 int local_part_length = Ustrlen(addr2->local_part);
2012 if( (ret = write(pfd[pipe_write], (void *)&(addr2->transport_return), sizeof(int))) != sizeof(int)
2013 || (ret = write(pfd[pipe_write], (void *)&transport_count, sizeof(transport_count))) != sizeof(transport_count)
2014 || (ret = write(pfd[pipe_write], (void *)&(addr2->flags), sizeof(addr2->flags))) != sizeof(addr2->flags)
2015 || (ret = write(pfd[pipe_write], (void *)&(addr2->basic_errno), sizeof(int))) != sizeof(int)
2016 || (ret = write(pfd[pipe_write], (void *)&(addr2->more_errno), sizeof(int))) != sizeof(int)
2017 || (ret = write(pfd[pipe_write], (void *)&(addr2->special_action), sizeof(int))) != sizeof(int)
2018 || (ret = write(pfd[pipe_write], (void *)&(addr2->transport),
2019 sizeof(transport_instance *))) != sizeof(transport_instance *)
2021 /* For a file delivery, pass back the local part, in case the original
2022 was only part of the final delivery path. This gives more complete
2025 || (testflag(addr2, af_file)
2026 && ( (ret = write(pfd[pipe_write], (void *)&local_part_length, sizeof(int))) != sizeof(int)
2027 || (ret = write(pfd[pipe_write], addr2->local_part, local_part_length)) != local_part_length
2031 log_write(0, LOG_MAIN|LOG_PANIC, "Failed writing transport results to pipe: %s\n",
2032 ret == -1 ? strerror(errno) : "short write");
2034 /* Now any messages */
2036 for (i = 0, s = addr2->message; i < 2; i++, s = addr2->user_message)
2038 int message_length = (s == NULL)? 0 : Ustrlen(s) + 1;
2039 if( (ret = write(pfd[pipe_write], (void *)&message_length, sizeof(int))) != sizeof(int)
2040 || (message_length > 0 && (ret = write(pfd[pipe_write], s, message_length)) != message_length)
2042 log_write(0, LOG_MAIN|LOG_PANIC, "Failed writing transport results to pipe: %s\n",
2043 ret == -1 ? strerror(errno) : "short write");
2047 /* OK, this process is now done. Free any cached resources that it opened,
2048 and close the pipe we were writing down before exiting. */
2050 (void)close(pfd[pipe_write]);
2055 /* Back in the main process: panic if the fork did not succeed. This seems
2056 better than returning an error - if forking is failing it is probably best
2057 not to try other deliveries for this message. */
2060 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Fork failed for local delivery to %s",
2063 /* Read the pipe to get the delivery status codes and error messages. Our copy
2064 of the writing end must be closed first, as otherwise read() won't return zero
2065 on an empty pipe. We check that a status exists for each address before
2066 overwriting the address structure. If data is missing, the default DEFER status
2067 will remain. Afterwards, close the reading end. */
2069 (void)close(pfd[pipe_write]);
2071 for (addr2 = addr; addr2 != NULL; addr2 = addr2->next)
2073 len = read(pfd[pipe_read], (void *)&status, sizeof(int));
2079 addr2->transport_return = status;
2080 len = read(pfd[pipe_read], (void *)&transport_count,
2081 sizeof(transport_count));
2082 len = read(pfd[pipe_read], (void *)&(addr2->flags), sizeof(addr2->flags));
2083 len = read(pfd[pipe_read], (void *)&(addr2->basic_errno), sizeof(int));
2084 len = read(pfd[pipe_read], (void *)&(addr2->more_errno), sizeof(int));
2085 len = read(pfd[pipe_read], (void *)&(addr2->special_action), sizeof(int));
2086 len = read(pfd[pipe_read], (void *)&(addr2->transport),
2087 sizeof(transport_instance *));
2089 if (testflag(addr2, af_file))
2091 int local_part_length;
2092 len = read(pfd[pipe_read], (void *)&local_part_length, sizeof(int));
2093 len = read(pfd[pipe_read], (void *)big_buffer, local_part_length);
2094 big_buffer[local_part_length] = 0;
2095 addr2->local_part = string_copy(big_buffer);
2098 for (i = 0, sptr = &(addr2->message); i < 2;
2099 i++, sptr = &(addr2->user_message))
2102 len = read(pfd[pipe_read], (void *)&message_length, sizeof(int));
2103 if (message_length > 0)
2105 len = read(pfd[pipe_read], (void *)big_buffer, message_length);
2106 if (len > 0) *sptr = string_copy(big_buffer);
2113 log_write(0, LOG_MAIN|LOG_PANIC, "failed to read delivery status for %s "
2114 "from delivery subprocess", addr2->unique);
2119 (void)close(pfd[pipe_read]);
2121 /* Unless shadowing, write all successful addresses immediately to the journal
2122 file, to ensure they are recorded asap. For homonymic addresses, use the base
2123 address plus the transport name. Failure to write the journal is panic-worthy,
2124 but don't stop, as it may prove possible subsequently to update the spool file
2125 in order to record the delivery. */
2129 for (addr2 = addr; addr2 != NULL; addr2 = addr2->next)
2131 if (addr2->transport_return != OK) continue;
2133 if (testflag(addr2, af_homonym))
2134 sprintf(CS big_buffer, "%.500s/%s\n", addr2->unique + 3, tp->name);
2136 sprintf(CS big_buffer, "%.500s\n", addr2->unique);
2138 /* In the test harness, wait just a bit to let the subprocess finish off
2139 any debug output etc first. */
2141 if (running_in_test_harness) millisleep(300);
2143 DEBUG(D_deliver) debug_printf("journalling %s", big_buffer);
2144 len = Ustrlen(big_buffer);
2145 if (write(journal_fd, big_buffer, len) != len)
2146 log_write(0, LOG_MAIN|LOG_PANIC, "failed to update journal for %s: %s",
2147 big_buffer, strerror(errno));
2150 /* Ensure the journal file is pushed out to disk. */
2152 if (EXIMfsync(journal_fd) < 0)
2153 log_write(0, LOG_MAIN|LOG_PANIC, "failed to fsync journal: %s",
2157 /* Wait for the process to finish. If it terminates with a non-zero code,
2158 freeze the message (except for SIGTERM, SIGKILL and SIGQUIT), but leave the
2159 status values of all the addresses as they are. Take care to handle the case
2160 when the subprocess doesn't seem to exist. This has been seen on one system
2161 when Exim was called from an MUA that set SIGCHLD to SIG_IGN. When that
2162 happens, wait() doesn't recognize the termination of child processes. Exim now
2163 resets SIGCHLD to SIG_DFL, but this code should still be robust. */
2165 while ((rc = wait(&status)) != pid)
2167 if (rc < 0 && errno == ECHILD) /* Process has vanished */
2169 log_write(0, LOG_MAIN, "%s transport process vanished unexpectedly",
2170 addr->transport->driver_name);
2176 if ((status & 0xffff) != 0)
2178 int msb = (status >> 8) & 255;
2179 int lsb = status & 255;
2180 int code = (msb == 0)? (lsb & 0x7f) : msb;
2181 if (msb != 0 || (code != SIGTERM && code != SIGKILL && code != SIGQUIT))
2182 addr->special_action = SPECIAL_FREEZE;
2183 log_write(0, LOG_MAIN|LOG_PANIC, "%s transport process returned non-zero "
2184 "status 0x%04x: %s %d",
2185 addr->transport->driver_name,
2187 (msb == 0)? "terminated by signal" : "exit code",
2191 /* If SPECIAL_WARN is set in the top address, send a warning message. */
2193 if (addr->special_action == SPECIAL_WARN &&
2194 addr->transport->warn_message != NULL)
2197 uschar *warn_message;
2199 DEBUG(D_deliver) debug_printf("Warning message requested by transport\n");
2201 warn_message = expand_string(addr->transport->warn_message);
2202 if (warn_message == NULL)
2203 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand \"%s\" (warning "
2204 "message for %s transport): %s", addr->transport->warn_message,
2205 addr->transport->name, expand_string_message);
2208 pid_t pid = child_open_exim(&fd);
2211 FILE *f = fdopen(fd, "wb");
2212 if (errors_reply_to != NULL &&
2213 !contains_header(US"Reply-To", warn_message))
2214 fprintf(f, "Reply-To: %s\n", errors_reply_to);
2215 fprintf(f, "Auto-Submitted: auto-replied\n");
2216 if (!contains_header(US"From", warn_message)) moan_write_from(f);
2217 fprintf(f, "%s", CS warn_message);
2219 /* Close and wait for child process to complete, without a timeout. */
2222 (void)child_close(pid, 0);
2226 addr->special_action = SPECIAL_NONE;
2232 /*************************************************
2233 * Do local deliveries *
2234 *************************************************/
2236 /* This function processes the list of addresses in addr_local. True local
2237 deliveries are always done one address at a time. However, local deliveries can
2238 be batched up in some cases. Typically this is when writing batched SMTP output
2239 files for use by some external transport mechanism, or when running local
2240 deliveries over LMTP.
2247 do_local_deliveries(void)
2250 open_db *dbm_file = NULL;
2251 time_t now = time(NULL);
2253 /* Loop until we have exhausted the supply of local deliveries */
2255 while (addr_local != NULL)
2257 time_t delivery_start;
2259 address_item *addr2, *addr3, *nextaddr;
2260 int logflags = LOG_MAIN;
2261 int logchar = dont_deliver? '*' : '=';
2262 transport_instance *tp;
2264 /* Pick the first undelivered address off the chain */
2266 address_item *addr = addr_local;
2267 addr_local = addr->next;
2270 DEBUG(D_deliver|D_transport)
2271 debug_printf("--------> %s <--------\n", addr->address);
2273 /* An internal disaster if there is no transport. Should not occur! */
2275 if ((tp = addr->transport) == NULL)
2277 logflags |= LOG_PANIC;
2278 disable_logging = FALSE; /* Jic */
2280 (addr->router != NULL)?
2281 string_sprintf("No transport set by %s router", addr->router->name)
2283 string_sprintf("No transport set by system filter");
2284 post_process_one(addr, DEFER, logflags, DTYPE_TRANSPORT, 0);
2288 /* Check that this base address hasn't previously been delivered to this
2289 transport. The check is necessary at this point to handle homonymic addresses
2290 correctly in cases where the pattern of redirection changes between delivery
2291 attempts. Non-homonymic previous delivery is detected earlier, at routing
2294 if (previously_transported(addr, FALSE)) continue;
2296 /* There are weird cases where logging is disabled */
2298 disable_logging = tp->disable_logging;
2300 /* Check for batched addresses and possible amalgamation. Skip all the work
2301 if either batch_max <= 1 or there aren't any other addresses for local
2304 if (tp->batch_max > 1 && addr_local != NULL)
2306 int batch_count = 1;
2307 BOOL uses_dom = readconf_depends((driver_instance *)tp, US"domain");
2308 BOOL uses_lp = (testflag(addr, af_pfr) &&
2309 (testflag(addr, af_file) || addr->local_part[0] == '|')) ||
2310 readconf_depends((driver_instance *)tp, US"local_part");
2311 uschar *batch_id = NULL;
2312 address_item **anchor = &addr_local;
2313 address_item *last = addr;
2316 /* Expand the batch_id string for comparison with other addresses.
2317 Expansion failure suppresses batching. */
2319 if (tp->batch_id != NULL)
2321 deliver_set_expansions(addr);
2322 batch_id = expand_string(tp->batch_id);
2323 deliver_set_expansions(NULL);
2324 if (batch_id == NULL)
2326 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand batch_id option "
2327 "in %s transport (%s): %s", tp->name, addr->address,
2328 expand_string_message);
2329 batch_count = tp->batch_max;
2333 /* Until we reach the batch_max limit, pick off addresses which have the
2334 same characteristics. These are:
2337 not previously delivered (see comment about 50 lines above)
2338 same local part if the transport's configuration contains $local_part
2339 or if this is a file or pipe delivery from a redirection
2340 same domain if the transport's configuration contains $domain
2342 same additional headers
2343 same headers to be removed
2344 same uid/gid for running the transport
2345 same first host if a host list is set
2348 while ((next = *anchor) != NULL && batch_count < tp->batch_max)
2351 tp == next->transport &&
2352 !previously_transported(next, TRUE) &&
2353 (addr->flags & (af_pfr|af_file)) == (next->flags & (af_pfr|af_file)) &&
2354 (!uses_lp || Ustrcmp(next->local_part, addr->local_part) == 0) &&
2355 (!uses_dom || Ustrcmp(next->domain, addr->domain) == 0) &&
2356 same_strings(next->p.errors_address, addr->p.errors_address) &&
2357 same_headers(next->p.extra_headers, addr->p.extra_headers) &&
2358 same_strings(next->p.remove_headers, addr->p.remove_headers) &&
2359 same_ugid(tp, addr, next) &&
2360 ((addr->host_list == NULL && next->host_list == NULL) ||
2361 (addr->host_list != NULL && next->host_list != NULL &&
2362 Ustrcmp(addr->host_list->name, next->host_list->name) == 0));
2364 /* If the transport has a batch_id setting, batch_id will be non-NULL
2365 from the expansion outside the loop. Expand for this address and compare.
2366 Expansion failure makes this address ineligible for batching. */
2368 if (ok && batch_id != NULL)
2371 address_item *save_nextnext = next->next;
2372 next->next = NULL; /* Expansion for a single address */
2373 deliver_set_expansions(next);
2374 next->next = save_nextnext;
2375 bid = expand_string(tp->batch_id);
2376 deliver_set_expansions(NULL);
2379 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand batch_id option "
2380 "in %s transport (%s): %s", tp->name, next->address,
2381 expand_string_message);
2384 else ok = (Ustrcmp(batch_id, bid) == 0);
2387 /* Take address into batch if OK. */
2391 *anchor = next->next; /* Include the address */
2397 else anchor = &(next->next); /* Skip the address */
2401 /* We now have one or more addresses that can be delivered in a batch. Check
2402 whether the transport is prepared to accept a message of this size. If not,
2403 fail them all forthwith. If the expansion fails, or does not yield an
2404 integer, defer delivery. */
2406 if (tp->message_size_limit != NULL)
2408 int rc = check_message_size(tp, addr);
2411 replicate_status(addr);
2412 while (addr != NULL)
2415 post_process_one(addr, rc, logflags, DTYPE_TRANSPORT, 0);
2418 continue; /* With next batch of addresses */
2422 /* If we are not running the queue, or if forcing, all deliveries will be
2423 attempted. Otherwise, we must respect the retry times for each address. Even
2424 when not doing this, we need to set up the retry key string, and determine
2425 whether a retry record exists, because after a successful delivery, a delete
2426 retry item must be set up. Keep the retry database open only for the duration
2427 of these checks, rather than for all local deliveries, because some local
2428 deliveries (e.g. to pipes) can take a substantial time. */
2430 dbm_file = dbfn_open(US"retry", O_RDONLY, &dbblock, FALSE);
2431 if (dbm_file == NULL)
2433 DEBUG(D_deliver|D_retry|D_hints_lookup)
2434 debug_printf("no retry data available\n");
2439 while (addr2 != NULL)
2441 BOOL ok = TRUE; /* to deliver this address */
2444 /* Set up the retry key to include the domain or not, and change its
2445 leading character from "R" to "T". Must make a copy before doing this,
2446 because the old key may be pointed to from a "delete" retry item after
2449 retry_key = string_copy(
2450 (tp->retry_use_local_part)? addr2->address_retry_key :
2451 addr2->domain_retry_key);
2454 /* Inspect the retry data. If there is no hints file, delivery happens. */
2456 if (dbm_file != NULL)
2458 dbdata_retry *retry_record = dbfn_read(dbm_file, retry_key);
2460 /* If there is no retry record, delivery happens. If there is,
2461 remember it exists so it can be deleted after a successful delivery. */
2463 if (retry_record != NULL)
2465 setflag(addr2, af_lt_retry_exists);
2467 /* A retry record exists for this address. If queue running and not
2468 forcing, inspect its contents. If the record is too old, or if its
2469 retry time has come, or if it has passed its cutoff time, delivery
2474 debug_printf("retry record exists: age=%s ",
2475 readconf_printtime(now - retry_record->time_stamp));
2476 debug_printf("(max %s)\n", readconf_printtime(retry_data_expire));
2477 debug_printf(" time to retry = %s expired = %d\n",
2478 readconf_printtime(retry_record->next_try - now),
2479 retry_record->expired);
2482 if (queue_running && !deliver_force)
2484 ok = (now - retry_record->time_stamp > retry_data_expire) ||
2485 (now >= retry_record->next_try) ||
2486 retry_record->expired;
2488 /* If we haven't reached the retry time, there is one more check
2489 to do, which is for the ultimate address timeout. */
2492 ok = retry_ultimate_address_timeout(retry_key, addr2->domain,
2496 else DEBUG(D_retry) debug_printf("no retry record exists\n");
2499 /* This address is to be delivered. Leave it on the chain. */
2504 addr2 = addr2->next;
2507 /* This address is to be deferred. Take it out of the chain, and
2508 post-process it as complete. Must take it out of the chain first,
2509 because post processing puts it on another chain. */
2513 address_item *this = addr2;
2514 this->message = US"Retry time not yet reached";
2515 this->basic_errno = ERRNO_LRETRY;
2516 if (addr3 == NULL) addr2 = addr = addr2->next;
2517 else addr2 = addr3->next = addr2->next;
2518 post_process_one(this, DEFER, logflags, DTYPE_TRANSPORT, 0);
2522 if (dbm_file != NULL) dbfn_close(dbm_file);
2524 /* If there are no addresses left on the chain, they all deferred. Loop
2525 for the next set of addresses. */
2527 if (addr == NULL) continue;
2529 /* So, finally, we do have some addresses that can be passed to the
2530 transport. Before doing so, set up variables that are relevant to a
2533 deliver_set_expansions(addr);
2534 delivery_start = time(NULL);
2535 deliver_local(addr, FALSE);
2536 deliver_time = (int)(time(NULL) - delivery_start);
2538 /* If a shadow transport (which must perforce be another local transport), is
2539 defined, and its condition is met, we must pass the message to the shadow
2540 too, but only those addresses that succeeded. We do this by making a new
2541 chain of addresses - also to keep the original chain uncontaminated. We must
2542 use a chain rather than doing it one by one, because the shadow transport may
2545 NOTE: if the condition fails because of a lookup defer, there is nothing we
2548 if (tp->shadow != NULL &&
2549 (tp->shadow_condition == NULL ||
2550 expand_check_condition(tp->shadow_condition, tp->name, US"transport")))
2552 transport_instance *stp;
2553 address_item *shadow_addr = NULL;
2554 address_item **last = &shadow_addr;
2556 for (stp = transports; stp != NULL; stp = stp->next)
2557 if (Ustrcmp(stp->name, tp->shadow) == 0) break;
2560 log_write(0, LOG_MAIN|LOG_PANIC, "shadow transport \"%s\" not found ",
2563 /* Pick off the addresses that have succeeded, and make clones. Put into
2564 the shadow_message field a pointer to the shadow_message field of the real
2567 else for (addr2 = addr; addr2 != NULL; addr2 = addr2->next)
2569 if (addr2->transport_return != OK) continue;
2570 addr3 = store_get(sizeof(address_item));
2573 addr3->shadow_message = (uschar *)(&(addr2->shadow_message));
2574 addr3->transport = stp;
2575 addr3->transport_return = DEFER;
2576 addr3->return_filename = NULL;
2577 addr3->return_file = -1;
2579 last = &(addr3->next);
2582 /* If we found any addresses to shadow, run the delivery, and stick any
2583 message back into the shadow_message field in the original. */
2585 if (shadow_addr != NULL)
2587 int save_count = transport_count;
2589 DEBUG(D_deliver|D_transport)
2590 debug_printf(">>>>>>>>>>>>>>>> Shadow delivery >>>>>>>>>>>>>>>>\n");
2591 deliver_local(shadow_addr, TRUE);
2593 for(; shadow_addr != NULL; shadow_addr = shadow_addr->next)
2595 int sresult = shadow_addr->transport_return;
2596 *((uschar **)(shadow_addr->shadow_message)) = (sresult == OK)?
2597 string_sprintf(" ST=%s", stp->name) :
2598 string_sprintf(" ST=%s (%s%s%s)", stp->name,
2599 (shadow_addr->basic_errno <= 0)?
2600 US"" : US strerror(shadow_addr->basic_errno),
2601 (shadow_addr->basic_errno <= 0 || shadow_addr->message == NULL)?
2603 (shadow_addr->message != NULL)? shadow_addr->message :
2604 (shadow_addr->basic_errno <= 0)? US"unknown error" : US"");
2606 DEBUG(D_deliver|D_transport)
2607 debug_printf("%s shadow transport returned %s for %s\n",
2609 (sresult == OK)? "OK" :
2610 (sresult == DEFER)? "DEFER" :
2611 (sresult == FAIL)? "FAIL" :
2612 (sresult == PANIC)? "PANIC" : "?",
2613 shadow_addr->address);
2616 DEBUG(D_deliver|D_transport)
2617 debug_printf(">>>>>>>>>>>>>>>> End shadow delivery >>>>>>>>>>>>>>>>\n");
2619 transport_count = save_count; /* Restore original transport count */
2623 /* Cancel the expansions that were set up for the delivery. */
2625 deliver_set_expansions(NULL);
2627 /* Now we can process the results of the real transport. We must take each
2628 address off the chain first, because post_process_one() puts it on another
2631 for (addr2 = addr; addr2 != NULL; addr2 = nextaddr)
2633 int result = addr2->transport_return;
2634 nextaddr = addr2->next;
2636 DEBUG(D_deliver|D_transport)
2637 debug_printf("%s transport returned %s for %s\n",
2639 (result == OK)? "OK" :
2640 (result == DEFER)? "DEFER" :
2641 (result == FAIL)? "FAIL" :
2642 (result == PANIC)? "PANIC" : "?",
2645 /* If there is a retry_record, or if delivery is deferred, build a retry
2646 item for setting a new retry time or deleting the old retry record from
2647 the database. These items are handled all together after all addresses
2648 have been handled (so the database is open just for a short time for
2651 if (result == DEFER || testflag(addr2, af_lt_retry_exists))
2653 int flags = (result == DEFER)? 0 : rf_delete;
2654 uschar *retry_key = string_copy((tp->retry_use_local_part)?
2655 addr2->address_retry_key : addr2->domain_retry_key);
2657 retry_add_item(addr2, retry_key, flags);
2660 /* Done with this address */
2662 if (result == OK) addr2->more_errno = deliver_time;
2663 post_process_one(addr2, result, logflags, DTYPE_TRANSPORT, logchar);
2665 /* If a pipe delivery generated text to be sent back, the result may be
2666 changed to FAIL, and we must copy this for subsequent addresses in the
2669 if (addr2->transport_return != result)
2671 for (addr3 = nextaddr; addr3 != NULL; addr3 = addr3->next)
2673 addr3->transport_return = addr2->transport_return;
2674 addr3->basic_errno = addr2->basic_errno;
2675 addr3->message = addr2->message;
2677 result = addr2->transport_return;
2680 /* Whether or not the result was changed to FAIL, we need to copy the
2681 return_file value from the first address into all the addresses of the
2682 batch, so they are all listed in the error message. */
2684 addr2->return_file = addr->return_file;
2686 /* Change log character for recording successful deliveries. */
2688 if (result == OK) logchar = '-';
2690 } /* Loop back for next batch of addresses */
2696 /*************************************************
2697 * Sort remote deliveries *
2698 *************************************************/
2700 /* This function is called if remote_sort_domains is set. It arranges that the
2701 chain of addresses for remote deliveries is ordered according to the strings
2702 specified. Try to make this shuffling reasonably efficient by handling
2703 sequences of addresses rather than just single ones.
2710 sort_remote_deliveries(void)
2713 address_item **aptr = &addr_remote;
2714 uschar *listptr = remote_sort_domains;
2718 while (*aptr != NULL &&
2719 (pattern = string_nextinlist(&listptr, &sep, patbuf, sizeof(patbuf)))
2722 address_item *moved = NULL;
2723 address_item **bptr = &moved;
2725 while (*aptr != NULL)
2727 address_item **next;
2728 deliver_domain = (*aptr)->domain; /* set $domain */
2729 if (match_isinlist(deliver_domain, &pattern, UCHAR_MAX+1,
2730 &domainlist_anchor, NULL, MCL_DOMAIN, TRUE, NULL) == OK)
2732 aptr = &((*aptr)->next);
2736 next = &((*aptr)->next);
2737 while (*next != NULL &&
2738 (deliver_domain = (*next)->domain, /* Set $domain */
2739 match_isinlist(deliver_domain, &pattern, UCHAR_MAX+1,
2740 &domainlist_anchor, NULL, MCL_DOMAIN, TRUE, NULL)) != OK)
2741 next = &((*next)->next);
2743 /* If the batch of non-matchers is at the end, add on any that were
2744 extracted further up the chain, and end this iteration. Otherwise,
2745 extract them from the chain and hang on the moved chain. */
2757 aptr = &((*aptr)->next);
2760 /* If the loop ended because the final address matched, *aptr will
2761 be NULL. Add on to the end any extracted non-matching addresses. If
2762 *aptr is not NULL, the loop ended via "break" when *next is null, that
2763 is, there was a string of non-matching addresses at the end. In this
2764 case the extracted addresses have already been added on the end. */
2766 if (*aptr == NULL) *aptr = moved;
2772 debug_printf("remote addresses after sorting:\n");
2773 for (addr = addr_remote; addr != NULL; addr = addr->next)
2774 debug_printf(" %s\n", addr->address);
2780 /*************************************************
2781 * Read from pipe for remote delivery subprocess *
2782 *************************************************/
2784 /* This function is called when the subprocess is complete, but can also be
2785 called before it is complete, in order to empty a pipe that is full (to prevent
2786 deadlock). It must therefore keep track of its progress in the parlist data
2789 We read the pipe to get the delivery status codes and a possible error message
2790 for each address, optionally preceded by unusability data for the hosts and
2791 also by optional retry data.
2793 Read in large chunks into the big buffer and then scan through, interpreting
2794 the data therein. In most cases, only a single read will be necessary. No
2795 individual item will ever be anywhere near 2500 bytes in length, so by ensuring
2796 that we read the next chunk when there is less than 2500 bytes left in the
2797 non-final chunk, we can assume each item is complete in the buffer before
2798 handling it. Each item is written using a single write(), which is atomic for
2799 small items (less than PIPE_BUF, which seems to be at least 512 in any Unix and
2800 often bigger) so even if we are reading while the subprocess is still going, we
2801 should never have only a partial item in the buffer.
2804 poffset the offset of the parlist item
2805 eop TRUE if the process has completed
2807 Returns: TRUE if the terminating 'Z' item has been read,
2808 or there has been a disaster (i.e. no more data needed);
2813 par_read_pipe(int poffset, BOOL eop)
2816 pardata *p = parlist + poffset;
2817 address_item *addrlist = p->addrlist;
2818 address_item *addr = p->addr;
2821 uschar *endptr = big_buffer;
2822 uschar *ptr = endptr;
2823 uschar *msg = p->msg;
2824 BOOL done = p->done;
2825 BOOL unfinished = TRUE;
2827 /* Loop through all items, reading from the pipe when necessary. The pipe
2828 is set up to be non-blocking, but there are two different Unix mechanisms in
2829 use. Exim uses O_NONBLOCK if it is defined. This returns 0 for end of file,
2830 and EAGAIN for no more data. If O_NONBLOCK is not defined, Exim uses O_NDELAY,
2831 which returns 0 for both end of file and no more data. We distinguish the
2832 two cases by taking 0 as end of file only when we know the process has
2835 Each separate item is written to the pipe in a single write(), and as they are
2836 all short items, the writes will all be atomic and we should never find
2837 ourselves in the position of having read an incomplete item. "Short" in this
2838 case can mean up to about 1K in the case when there is a long error message
2839 associated with an address. */
2841 DEBUG(D_deliver) debug_printf("reading pipe for subprocess %d (%s)\n",
2842 (int)p->pid, eop? "ended" : "not ended");
2846 retry_item *r, **rp;
2847 int remaining = endptr - ptr;
2849 /* Read (first time) or top up the chars in the buffer if necessary.
2850 There will be only one read if we get all the available data (i.e. don't
2851 fill the buffer completely). */
2853 if (remaining < 2500 && unfinished)
2856 int available = big_buffer_size - remaining;
2858 if (remaining > 0) memmove(big_buffer, ptr, remaining);
2861 endptr = big_buffer + remaining;
2862 len = read(fd, endptr, available);
2864 DEBUG(D_deliver) debug_printf("read() yielded %d\n", len);
2866 /* If the result is EAGAIN and the process is not complete, just
2867 stop reading any more and process what we have already. */
2871 if (!eop && errno == EAGAIN) len = 0; else
2873 msg = string_sprintf("failed to read pipe from transport process "
2874 "%d for transport %s: %s", pid, addr->transport->driver_name,
2880 /* If the length is zero (eof or no-more-data), just process what we
2881 already have. Note that if the process is still running and we have
2882 read all the data in the pipe (but less that "available") then we
2883 won't read any more, as "unfinished" will get set FALSE. */
2886 unfinished = len == available;
2889 /* If we are at the end of the available data, exit the loop. */
2891 if (ptr >= endptr) break;
2893 /* Handle each possible type of item, assuming the complete item is
2894 available in store. */
2898 /* Host items exist only if any hosts were marked unusable. Match
2899 up by checking the IP address. */
2902 for (h = addrlist->host_list; h != NULL; h = h->next)
2904 if (h->address == NULL || Ustrcmp(h->address, ptr+2) != 0) continue;
2912 /* Retry items are sent in a preceding R item for each address. This is
2913 kept separate to keep each message short enough to guarantee it won't
2914 be split in the pipe. Hopefully, in the majority of cases, there won't in
2915 fact be any retry items at all.
2917 The complete set of retry items might include an item to delete a
2918 routing retry if there was a previous routing delay. However, routing
2919 retries are also used when a remote transport identifies an address error.
2920 In that case, there may also be an "add" item for the same key. Arrange
2921 that a "delete" item is dropped in favour of an "add" item. */
2924 if (addr == NULL) goto ADDR_MISMATCH;
2926 DEBUG(D_deliver|D_retry)
2927 debug_printf("reading retry information for %s from subprocess\n",
2930 /* Cut out any "delete" items on the list. */
2932 for (rp = &(addr->retries); (r = *rp) != NULL; rp = &(r->next))
2934 if (Ustrcmp(r->key, ptr+1) == 0) /* Found item with same key */
2936 if ((r->flags & rf_delete) == 0) break; /* It was not "delete" */
2937 *rp = r->next; /* Excise a delete item */
2938 DEBUG(D_deliver|D_retry)
2939 debug_printf(" existing delete item dropped\n");
2943 /* We want to add a delete item only if there is no non-delete item;
2944 however we still have to step ptr through the data. */
2946 if (r == NULL || (*ptr & rf_delete) == 0)
2948 r = store_get(sizeof(retry_item));
2949 r->next = addr->retries;
2952 r->key = string_copy(ptr);
2954 memcpy(&(r->basic_errno), ptr, sizeof(r->basic_errno));
2955 ptr += sizeof(r->basic_errno);
2956 memcpy(&(r->more_errno), ptr, sizeof(r->more_errno));
2957 ptr += sizeof(r->more_errno);
2958 r->message = (*ptr)? string_copy(ptr) : NULL;
2959 DEBUG(D_deliver|D_retry)
2960 debug_printf(" added %s item\n",
2961 ((r->flags & rf_delete) == 0)? "retry" : "delete");
2966 DEBUG(D_deliver|D_retry)
2967 debug_printf(" delete item not added: non-delete item exists\n");
2970 ptr += sizeof(r->basic_errno) + sizeof(r->more_errno);
2976 /* Put the amount of data written into the parlist block */
2979 memcpy(&(p->transport_count), ptr, sizeof(transport_count));
2980 ptr += sizeof(transport_count);
2983 /* Address items are in the order of items on the address chain. We
2984 remember the current address value in case this function is called
2985 several times to empty the pipe in stages. Information about delivery
2986 over TLS is sent in a preceding X item for each address. We don't put
2987 it in with the other info, in order to keep each message short enough to
2988 guarantee it won't be split in the pipe. */
2992 if (addr == NULL) goto ADDR_MISMATCH; /* Below, in 'A' handler */
2996 addr->cipher = NULL;
2997 addr->peerdn = NULL;
3000 addr->cipher = string_copy(ptr);
3003 addr->peerdn = string_copy(ptr);
3007 addr->peercert = NULL;
3009 (void) tls_import_cert(ptr, &addr->peercert);
3013 addr->ourcert = NULL;
3015 (void) tls_import_cert(ptr, &addr->ourcert);
3018 #ifndef DISABLE_OCSP
3020 addr->ocsp = OCSP_NOT_REQ;
3022 addr->ocsp = *ptr - '0';
3028 #endif /*SUPPORT_TLS*/
3030 case 'C': /* client authenticator information */
3034 addr->authenticator = (*ptr)? string_copy(ptr) : NULL;
3037 addr->auth_id = (*ptr)? string_copy(ptr) : NULL;
3040 addr->auth_sndr = (*ptr)? string_copy(ptr) : NULL;
3046 #ifndef DISABLE_PRDR
3048 addr->flags |= af_prdr_used;
3052 #ifdef EXPERIMENTAL_DSN
3054 if (addr == NULL) break;
3055 memcpy(&(addr->dsn_aware), ptr, sizeof(addr->dsn_aware));
3056 ptr += sizeof(addr->dsn_aware);
3057 DEBUG(D_deliver) debug_printf("DSN read: addr->dsn_aware = %d\n", addr->dsn_aware);
3065 msg = string_sprintf("address count mismatch for data read from pipe "
3066 "for transport process %d for transport %s", pid,
3067 addrlist->transport->driver_name);
3072 addr->transport_return = *ptr++;
3073 addr->special_action = *ptr++;
3074 memcpy(&(addr->basic_errno), ptr, sizeof(addr->basic_errno));
3075 ptr += sizeof(addr->basic_errno);
3076 memcpy(&(addr->more_errno), ptr, sizeof(addr->more_errno));
3077 ptr += sizeof(addr->more_errno);
3078 memcpy(&(addr->flags), ptr, sizeof(addr->flags));
3079 ptr += sizeof(addr->flags);
3080 addr->message = (*ptr)? string_copy(ptr) : NULL;
3082 addr->user_message = (*ptr)? string_copy(ptr) : NULL;
3085 /* Always two strings for host information, followed by the port number and DNSSEC mark */
3089 h = store_get(sizeof(host_item));
3090 h->name = string_copy(ptr);
3092 h->address = string_copy(ptr);
3094 memcpy(&(h->port), ptr, sizeof(h->port));
3095 ptr += sizeof(h->port);
3096 h->dnssec = *ptr == '2' ? DS_YES
3097 : *ptr == '1' ? DS_NO
3100 addr->host_used = h;
3104 /* Finished with this address */
3109 /* Z marks the logical end of the data. It is followed by '0' if
3110 continue_transport was NULL at the end of transporting, otherwise '1'.
3111 We need to know when it becomes NULL during a delivery down a passed SMTP
3112 channel so that we don't try to pass anything more down it. Of course, for
3113 most normal messages it will remain NULL all the time. */
3118 continue_transport = NULL;
3119 continue_hostname = NULL;
3122 DEBUG(D_deliver) debug_printf("Z%c item read\n", *ptr);
3125 /* Anything else is a disaster. */
3128 msg = string_sprintf("malformed data (%d) read from pipe for transport "
3129 "process %d for transport %s", ptr[-1], pid,
3130 addr->transport->driver_name);
3136 /* The done flag is inspected externally, to determine whether or not to
3137 call the function again when the process finishes. */
3141 /* If the process hadn't finished, and we haven't seen the end of the data
3142 or suffered a disaster, update the rest of the state, and return FALSE to
3143 indicate "not finished". */
3152 /* Close our end of the pipe, to prevent deadlock if the far end is still
3153 pushing stuff into it. */
3158 /* If we have finished without error, but haven't had data for every address,
3159 something is wrong. */
3161 if (msg == NULL && addr != NULL)
3162 msg = string_sprintf("insufficient address data read from pipe "
3163 "for transport process %d for transport %s", pid,
3164 addr->transport->driver_name);
3166 /* If an error message is set, something has gone wrong in getting back
3167 the delivery data. Put the message into each address and freeze it. */
3171 for (addr = addrlist; addr != NULL; addr = addr->next)
3173 addr->transport_return = DEFER;
3174 addr->special_action = SPECIAL_FREEZE;
3175 addr->message = msg;
3179 /* Return TRUE to indicate we have got all we need from this process, even
3180 if it hasn't actually finished yet. */
3187 /*************************************************
3188 * Post-process a set of remote addresses *
3189 *************************************************/
3191 /* Do what has to be done immediately after a remote delivery for each set of
3192 addresses, then re-write the spool if necessary. Note that post_process_one
3193 puts the address on an appropriate queue; hence we must fish off the next
3194 one first. This function is also called if there is a problem with setting
3195 up a subprocess to do a remote delivery in parallel. In this case, the final
3196 argument contains a message, and the action must be forced to DEFER.
3199 addr pointer to chain of address items
3200 logflags flags for logging
3201 msg NULL for normal cases; -> error message for unexpected problems
3202 fallback TRUE if processing fallback hosts
3208 remote_post_process(address_item *addr, int logflags, uschar *msg,
3213 /* If any host addresses were found to be unusable, add them to the unusable
3214 tree so that subsequent deliveries don't try them. */
3216 for (h = addr->host_list; h != NULL; h = h->next)
3218 if (h->address == NULL) continue;
3219 if (h->status >= hstatus_unusable) tree_add_unusable(h);
3222 /* Now handle each address on the chain. The transport has placed '=' or '-'
3223 into the special_action field for each successful delivery. */
3225 while (addr != NULL)
3227 address_item *next = addr->next;
3229 /* If msg == NULL (normal processing) and the result is DEFER and we are
3230 processing the main hosts and there are fallback hosts available, put the
3231 address on the list for fallback delivery. */
3233 if (addr->transport_return == DEFER &&
3234 addr->fallback_hosts != NULL &&
3238 addr->host_list = addr->fallback_hosts;
3239 addr->next = addr_fallback;
3240 addr_fallback = addr;
3241 DEBUG(D_deliver) debug_printf("%s queued for fallback host(s)\n", addr->address);
3244 /* If msg is set (=> unexpected problem), set it in the address before
3245 doing the ordinary post processing. */
3251 addr->message = msg;
3252 addr->transport_return = DEFER;
3254 (void)post_process_one(addr, addr->transport_return, logflags,
3255 DTYPE_TRANSPORT, addr->special_action);
3263 /* If we have just delivered down a passed SMTP channel, and that was
3264 the last address, the channel will have been closed down. Now that
3265 we have logged that delivery, set continue_sequence to 1 so that
3266 any subsequent deliveries don't get "*" incorrectly logged. */
3268 if (continue_transport == NULL) continue_sequence = 1;
3273 /*************************************************
3274 * Wait for one remote delivery subprocess *
3275 *************************************************/
3277 /* This function is called while doing remote deliveries when either the
3278 maximum number of processes exist and we need one to complete so that another
3279 can be created, or when waiting for the last ones to complete. It must wait for
3280 the completion of one subprocess, empty the control block slot, and return a
3281 pointer to the address chain.
3284 Returns: pointer to the chain of addresses handled by the process;
3285 NULL if no subprocess found - this is an unexpected error
3288 static address_item *
3291 int poffset, status;
3292 address_item *addr, *addrlist;
3295 set_process_info("delivering %s: waiting for a remote delivery subprocess "
3296 "to finish", message_id);
3298 /* Loop until either a subprocess completes, or there are no subprocesses in
3299 existence - in which case give an error return. We cannot proceed just by
3300 waiting for a completion, because a subprocess may have filled up its pipe, and
3301 be waiting for it to be emptied. Therefore, if no processes have finished, we
3302 wait for one of the pipes to acquire some data by calling select(), with a
3303 timeout just in case.
3305 The simple approach is just to iterate after reading data from a ready pipe.
3306 This leads to non-ideal behaviour when the subprocess has written its final Z
3307 item, closed the pipe, and is in the process of exiting (the common case). A
3308 call to waitpid() yields nothing completed, but select() shows the pipe ready -
3309 reading it yields EOF, so you end up with busy-waiting until the subprocess has
3312 To avoid this, if all the data that is needed has been read from a subprocess
3313 after select(), an explicit wait() for it is done. We know that all it is doing
3314 is writing to the pipe and then exiting, so the wait should not be long.
3316 The non-blocking waitpid() is to some extent just insurance; if we could
3317 reliably detect end-of-file on the pipe, we could always know when to do a
3318 blocking wait() for a completed process. However, because some systems use
3319 NDELAY, which doesn't distinguish between EOF and pipe empty, it is easier to
3320 use code that functions without the need to recognize EOF.
3322 There's a double loop here just in case we end up with a process that is not in
3323 the list of remote delivery processes. Something has obviously gone wrong if
3324 this is the case. (For example, a process that is incorrectly left over from
3325 routing or local deliveries might be found.) The damage can be minimized by
3326 looping back and looking for another process. If there aren't any, the error
3327 return will happen. */
3329 for (;;) /* Normally we do not repeat this loop */
3331 while ((pid = waitpid(-1, &status, WNOHANG)) <= 0)
3334 fd_set select_pipes;
3335 int maxpipe, readycount;
3337 /* A return value of -1 can mean several things. If errno != ECHILD, it
3338 either means invalid options (which we discount), or that this process was
3339 interrupted by a signal. Just loop to try the waitpid() again.
3341 If errno == ECHILD, waitpid() is telling us that there are no subprocesses
3342 in existence. This should never happen, and is an unexpected error.
3343 However, there is a nasty complication when running under Linux. If "strace
3344 -f" is being used under Linux to trace this process and its children,
3345 subprocesses are "stolen" from their parents and become the children of the
3346 tracing process. A general wait such as the one we've just obeyed returns
3347 as if there are no children while subprocesses are running. Once a
3348 subprocess completes, it is restored to the parent, and waitpid(-1) finds
3349 it. Thanks to Joachim Wieland for finding all this out and suggesting a
3352 This does not happen using "truss" on Solaris, nor (I think) with other
3353 tracing facilities on other OS. It seems to be specific to Linux.
3355 What we do to get round this is to use kill() to see if any of our
3356 subprocesses are still in existence. If kill() gives an OK return, we know
3357 it must be for one of our processes - it can't be for a re-use of the pid,
3358 because if our process had finished, waitpid() would have found it. If any
3359 of our subprocesses are in existence, we proceed to use select() as if
3360 waitpid() had returned zero. I think this is safe. */
3364 if (errno != ECHILD) continue; /* Repeats the waitpid() */
3367 debug_printf("waitpid() returned -1/ECHILD: checking explicitly "
3368 "for process existence\n");
3370 for (poffset = 0; poffset < remote_max_parallel; poffset++)
3372 if ((pid = parlist[poffset].pid) != 0 && kill(pid, 0) == 0)
3374 DEBUG(D_deliver) debug_printf("process %d still exists: assume "
3375 "stolen by strace\n", (int)pid);
3376 break; /* With poffset set */
3380 if (poffset >= remote_max_parallel)
3382 DEBUG(D_deliver) debug_printf("*** no delivery children found\n");
3383 return NULL; /* This is the error return */
3387 /* A pid value greater than 0 breaks the "while" loop. A negative value has
3388 been handled above. A return value of zero means that there is at least one
3389 subprocess, but there are no completed subprocesses. See if any pipes are
3390 ready with any data for reading. */
3392 DEBUG(D_deliver) debug_printf("selecting on subprocess pipes\n");
3395 FD_ZERO(&select_pipes);
3396 for (poffset = 0; poffset < remote_max_parallel; poffset++)
3398 if (parlist[poffset].pid != 0)
3400 int fd = parlist[poffset].fd;
3401 FD_SET(fd, &select_pipes);
3402 if (fd > maxpipe) maxpipe = fd;
3406 /* Stick in a 60-second timeout, just in case. */
3411 readycount = select(maxpipe + 1, (SELECT_ARG2_TYPE *)&select_pipes,
3414 /* Scan through the pipes and read any that are ready; use the count
3415 returned by select() to stop when there are no more. Select() can return
3416 with no processes (e.g. if interrupted). This shouldn't matter.
3418 If par_read_pipe() returns TRUE, it means that either the terminating Z was
3419 read, or there was a disaster. In either case, we are finished with this
3420 process. Do an explicit wait() for the process and break the main loop if
3423 It turns out that we have to deal with the case of an interrupted system
3424 call, which can happen on some operating systems if the signal handling is
3425 set up to do that by default. */
3428 readycount > 0 && poffset < remote_max_parallel;
3431 if ((pid = parlist[poffset].pid) != 0 &&
3432 FD_ISSET(parlist[poffset].fd, &select_pipes))
3435 if (par_read_pipe(poffset, FALSE)) /* Finished with this pipe */
3437 for (;;) /* Loop for signals */
3439 pid_t endedpid = waitpid(pid, &status, 0);
3440 if (endedpid == pid) goto PROCESS_DONE;
3441 if (endedpid != (pid_t)(-1) || errno != EINTR)
3442 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Unexpected error return "
3443 "%d (errno = %d) from waitpid() for process %d",
3444 (int)endedpid, errno, (int)pid);
3450 /* Now go back and look for a completed subprocess again. */
3453 /* A completed process was detected by the non-blocking waitpid(). Find the
3454 data block that corresponds to this subprocess. */
3456 for (poffset = 0; poffset < remote_max_parallel; poffset++)
3457 if (pid == parlist[poffset].pid) break;
3459 /* Found the data block; this is a known remote delivery process. We don't
3460 need to repeat the outer loop. This should be what normally happens. */
3462 if (poffset < remote_max_parallel) break;
3464 /* This situation is an error, but it's probably better to carry on looking
3465 for another process than to give up (as we used to do). */
3467 log_write(0, LOG_MAIN|LOG_PANIC, "Process %d finished: not found in remote "
3468 "transport process list", pid);
3469 } /* End of the "for" loop */
3471 /* Come here when all the data was completely read after a select(), and
3472 the process in pid has been wait()ed for. */
3479 debug_printf("remote delivery process %d ended\n", (int)pid);
3481 debug_printf("remote delivery process %d ended: status=%04x\n", (int)pid,
3485 set_process_info("delivering %s", message_id);
3487 /* Get the chain of processed addresses */
3489 addrlist = parlist[poffset].addrlist;
3491 /* If the process did not finish cleanly, record an error and freeze (except
3492 for SIGTERM, SIGKILL and SIGQUIT), and also ensure the journal is not removed,
3493 in case the delivery did actually happen. */
3495 if ((status & 0xffff) != 0)
3498 int msb = (status >> 8) & 255;
3499 int lsb = status & 255;
3500 int code = (msb == 0)? (lsb & 0x7f) : msb;
3502 msg = string_sprintf("%s transport process returned non-zero status 0x%04x: "
3504 addrlist->transport->driver_name,
3506 (msb == 0)? "terminated by signal" : "exit code",
3509 if (msb != 0 || (code != SIGTERM && code != SIGKILL && code != SIGQUIT))
3510 addrlist->special_action = SPECIAL_FREEZE;
3512 for (addr = addrlist; addr != NULL; addr = addr->next)
3514 addr->transport_return = DEFER;
3515 addr->message = msg;
3518 remove_journal = FALSE;
3521 /* Else complete reading the pipe to get the result of the delivery, if all
3522 the data has not yet been obtained. */
3524 else if (!parlist[poffset].done) (void)par_read_pipe(poffset, TRUE);
3526 /* Put the data count and return path into globals, mark the data slot unused,
3527 decrement the count of subprocesses, and return the address chain. */
3529 transport_count = parlist[poffset].transport_count;
3530 used_return_path = parlist[poffset].return_path;
3531 parlist[poffset].pid = 0;
3538 /*************************************************
3539 * Wait for subprocesses and post-process *
3540 *************************************************/
3542 /* This function waits for subprocesses until the number that are still running
3543 is below a given threshold. For each complete subprocess, the addresses are
3544 post-processed. If we can't find a running process, there is some shambles.
3545 Better not bomb out, as that might lead to multiple copies of the message. Just
3546 log and proceed as if all done.
3549 max maximum number of subprocesses to leave running
3550 fallback TRUE if processing fallback hosts
3556 par_reduce(int max, BOOL fallback)
3558 while (parcount > max)
3560 address_item *doneaddr = par_wait();
3561 if (doneaddr == NULL)
3563 log_write(0, LOG_MAIN|LOG_PANIC,
3564 "remote delivery process count got out of step");
3567 else remote_post_process(doneaddr, LOG_MAIN, NULL, fallback);
3575 rmt_dlv_checked_write(int fd, void * buf, int size)
3577 int ret = write(fd, buf, size);
3579 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Failed writing transport result to pipe: %s\n",
3580 ret == -1 ? strerror(errno) : "short write");
3583 /*************************************************
3584 * Do remote deliveries *
3585 *************************************************/
3587 /* This function is called to process the addresses in addr_remote. We must
3588 pick off the queue all addresses that have the same transport, remote
3589 destination, and errors address, and hand them to the transport in one go,
3590 subject to some configured limitations. If this is a run to continue delivering
3591 to an existing delivery channel, skip all but those addresses that can go to
3592 that channel. The skipped addresses just get deferred.
3594 If mua_wrapper is set, all addresses must be able to be sent in a single
3595 transaction. If not, this function yields FALSE.
3597 In Exim 4, remote deliveries are always done in separate processes, even
3598 if remote_max_parallel = 1 or if there's only one delivery to do. The reason
3599 is so that the base process can retain privilege. This makes the
3600 implementation of fallback transports feasible (though not initially done.)
3602 We create up to the configured number of subprocesses, each of which passes
3603 back the delivery state via a pipe. (However, when sending down an existing
3604 connection, remote_max_parallel is forced to 1.)
3607 fallback TRUE if processing fallback hosts
3609 Returns: TRUE normally
3610 FALSE if mua_wrapper is set and the addresses cannot all be sent
3615 do_remote_deliveries(BOOL fallback)
3621 parcount = 0; /* Number of executing subprocesses */
3623 /* When sending down an existing channel, only do one delivery at a time.
3624 We use a local variable (parmax) to hold the maximum number of processes;
3625 this gets reduced from remote_max_parallel if we can't create enough pipes. */
3627 if (continue_transport != NULL) remote_max_parallel = 1;
3628 parmax = remote_max_parallel;
3630 /* If the data for keeping a list of processes hasn't yet been
3633 if (parlist == NULL)
3635 parlist = store_get(remote_max_parallel * sizeof(pardata));
3636 for (poffset = 0; poffset < remote_max_parallel; poffset++)
3637 parlist[poffset].pid = 0;
3640 /* Now loop for each remote delivery */
3642 for (delivery_count = 0; addr_remote != NULL; delivery_count++)
3648 int address_count = 1;
3649 int address_count_max;
3651 BOOL use_initgroups;
3652 BOOL pipe_done = FALSE;
3653 transport_instance *tp;
3654 address_item **anchor = &addr_remote;
3655 address_item *addr = addr_remote;
3656 address_item *last = addr;
3659 /* Pull the first address right off the list. */
3661 addr_remote = addr->next;
3664 DEBUG(D_deliver|D_transport)
3665 debug_printf("--------> %s <--------\n", addr->address);
3667 /* If no transport has been set, there has been a big screw-up somewhere. */
3669 if ((tp = addr->transport) == NULL)
3671 disable_logging = FALSE; /* Jic */
3672 remote_post_process(addr, LOG_MAIN|LOG_PANIC,
3673 US"No transport set by router", fallback);
3677 /* Check that this base address hasn't previously been delivered to this
3678 transport. The check is necessary at this point to handle homonymic addresses
3679 correctly in cases where the pattern of redirection changes between delivery
3680 attempts. Non-homonymic previous delivery is detected earlier, at routing
3683 if (previously_transported(addr, FALSE)) continue;
3685 /* Force failure if the message is too big. */
3687 if (tp->message_size_limit != NULL)
3689 int rc = check_message_size(tp, addr);
3692 addr->transport_return = rc;
3693 remote_post_process(addr, LOG_MAIN, NULL, fallback);
3698 /* Get the flag which specifies whether the transport can handle different
3699 domains that nevertheless resolve to the same set of hosts. */
3701 multi_domain = tp->multi_domain;
3703 /* Get the maximum it can handle in one envelope, with zero meaning
3704 unlimited, which is forced for the MUA wrapper case. */
3706 address_count_max = tp->max_addresses;
3707 if (address_count_max == 0 || mua_wrapper) address_count_max = 999999;
3710 /************************************************************************/
3711 /***** This is slightly experimental code, but should be safe. *****/
3713 /* The address_count_max value is the maximum number of addresses that the
3714 transport can send in one envelope. However, the transport must be capable of
3715 dealing with any number of addresses. If the number it gets exceeds its
3716 envelope limitation, it must send multiple copies of the message. This can be
3717 done over a single connection for SMTP, so uses less resources than making
3718 multiple connections. On the other hand, if remote_max_parallel is greater
3719 than one, it is perhaps a good idea to use parallel processing to move the
3720 message faster, even if that results in multiple simultaneous connections to
3723 How can we come to some compromise between these two ideals? What we do is to
3724 limit the number of addresses passed to a single instance of a transport to
3725 the greater of (a) its address limit (rcpt_max for SMTP) and (b) the total
3726 number of addresses routed to remote transports divided by
3727 remote_max_parallel. For example, if the message has 100 remote recipients,
3728 remote max parallel is 2, and rcpt_max is 10, we'd never send more than 50 at
3729 once. But if rcpt_max is 100, we could send up to 100.
3731 Of course, not all the remotely addresses in a message are going to go to the
3732 same set of hosts (except in smarthost configurations), so this is just a
3733 heuristic way of dividing up the work.
3735 Furthermore (1), because this may not be wanted in some cases, and also to
3736 cope with really pathological cases, there is also a limit to the number of
3737 messages that are sent over one connection. This is the same limit that is
3738 used when sending several different messages over the same connection.
3739 Continue_sequence is set when in this situation, to the number sent so
3740 far, including this message.
3742 Furthermore (2), when somebody explicitly sets the maximum value to 1, it
3743 is probably because they are using VERP, in which case they want to pass only
3744 one address at a time to the transport, in order to be able to use
3745 $local_part and $domain in constructing a new return path. We could test for
3746 the use of these variables, but as it is so likely they will be used when the
3747 maximum is 1, we don't bother. Just leave the value alone. */
3749 if (address_count_max != 1 &&
3750 address_count_max < remote_delivery_count/remote_max_parallel)
3752 int new_max = remote_delivery_count/remote_max_parallel;
3753 int message_max = tp->connection_max_messages;
3754 if (connection_max_messages >= 0) message_max = connection_max_messages;
3755 message_max -= continue_sequence - 1;
3756 if (message_max > 0 && new_max > address_count_max * message_max)
3757 new_max = address_count_max * message_max;
3758 address_count_max = new_max;
3761 /************************************************************************/
3764 /* Pick off all addresses which have the same transport, errors address,
3765 destination, and extra headers. In some cases they point to the same host
3766 list, but we also need to check for identical host lists generated from
3767 entirely different domains. The host list pointers can be NULL in the case
3768 where the hosts are defined in the transport. There is also a configured
3769 maximum limit of addresses that can be handled at once (see comments above
3770 for how it is computed). */
3772 while ((next = *anchor) != NULL && address_count < address_count_max)
3774 if ((multi_domain || Ustrcmp(next->domain, addr->domain) == 0)
3776 tp == next->transport
3778 same_hosts(next->host_list, addr->host_list)
3780 same_strings(next->p.errors_address, addr->p.errors_address)
3782 same_headers(next->p.extra_headers, addr->p.extra_headers)
3784 same_ugid(tp, next, addr)
3786 (next->p.remove_headers == addr->p.remove_headers ||
3787 (next->p.remove_headers != NULL &&
3788 addr->p.remove_headers != NULL &&
3789 Ustrcmp(next->p.remove_headers, addr->p.remove_headers) == 0)))
3791 *anchor = next->next;
3793 next->first = addr; /* remember top one (for retry processing) */
3798 else anchor = &(next->next);
3801 /* If we are acting as an MUA wrapper, all addresses must go in a single
3802 transaction. If not, put them back on the chain and yield FALSE. */
3804 if (mua_wrapper && addr_remote != NULL)
3806 last->next = addr_remote;
3811 /* Set up the expansion variables for this set of addresses */
3813 deliver_set_expansions(addr);
3815 /* Ensure any transport-set auth info is fresh */
3816 addr->authenticator = addr->auth_id = addr->auth_sndr = NULL;
3818 /* Compute the return path, expanding a new one if required. The old one
3819 must be set first, as it might be referred to in the expansion. */
3821 if(addr->p.errors_address != NULL)
3822 return_path = addr->p.errors_address;
3823 #ifdef EXPERIMENTAL_SRS
3824 else if(addr->p.srs_sender != NULL)
3825 return_path = addr->p.srs_sender;
3828 return_path = sender_address;
3830 if (tp->return_path != NULL)
3832 uschar *new_return_path = expand_string(tp->return_path);
3833 if (new_return_path == NULL)
3835 if (!expand_string_forcedfail)
3837 remote_post_process(addr, LOG_MAIN|LOG_PANIC,
3838 string_sprintf("Failed to expand return path \"%s\": %s",
3839 tp->return_path, expand_string_message), fallback);
3843 else return_path = new_return_path;
3846 /* Find the uid, gid, and use_initgroups setting for this transport. Failure
3847 logs and sets up error messages, so we just post-process and continue with
3848 the next address. */
3850 if (!findugid(addr, tp, &uid, &gid, &use_initgroups))
3852 remote_post_process(addr, LOG_MAIN|LOG_PANIC, NULL, fallback);
3856 /* If this transport has a setup function, call it now so that it gets
3857 run in this process and not in any subprocess. That way, the results of
3858 any setup that are retained by the transport can be reusable. One of the
3859 things the setup does is to set the fallback host lists in the addresses.
3860 That is why it is called at this point, before the continue delivery
3861 processing, because that might use the fallback hosts. */
3863 if (tp->setup != NULL)
3864 (void)((tp->setup)(addr->transport, addr, NULL, uid, gid, NULL));
3866 /* If this is a run to continue delivery down an already-established
3867 channel, check that this set of addresses matches the transport and
3868 the channel. If it does not, defer the addresses. If a host list exists,
3869 we must check that the continue host is on the list. Otherwise, the
3870 host is set in the transport. */
3872 continue_more = FALSE; /* In case got set for the last lot */
3873 if (continue_transport != NULL)
3875 BOOL ok = Ustrcmp(continue_transport, tp->name) == 0;
3876 if (ok && addr->host_list != NULL)
3880 for (h = addr->host_list; h != NULL; h = h->next)
3882 if (Ustrcmp(h->name, continue_hostname) == 0)
3883 { ok = TRUE; break; }
3887 /* Addresses not suitable; defer or queue for fallback hosts (which
3888 might be the continue host) and skip to next address. */
3892 DEBUG(D_deliver) debug_printf("not suitable for continue_transport\n");
3895 if (addr->fallback_hosts != NULL && !fallback)
3899 next->host_list = next->fallback_hosts;
3900 DEBUG(D_deliver) debug_printf("%s queued for fallback host(s)\n", next->address);
3901 if (next->next == NULL) break;
3904 next->next = addr_fallback;
3905 addr_fallback = addr;
3910 while (next->next != NULL) next = next->next;
3911 next->next = addr_defer;
3918 /* Set a flag indicating whether there are further addresses that list
3919 the continued host. This tells the transport to leave the channel open,
3920 but not to pass it to another delivery process. */
3922 for (next = addr_remote; next != NULL; next = next->next)
3925 for (h = next->host_list; h != NULL; h = h->next)
3927 if (Ustrcmp(h->name, continue_hostname) == 0)
3928 { continue_more = TRUE; break; }
3933 /* The transports set up the process info themselves as they may connect
3934 to more than one remote machine. They also have to set up the filter
3935 arguments, if required, so that the host name and address are available
3938 transport_filter_argv = NULL;
3940 /* Create the pipe for inter-process communication. If pipe creation
3941 fails, it is probably because the value of remote_max_parallel is so
3942 large that too many file descriptors for pipes have been created. Arrange
3943 to wait for a process to finish, and then try again. If we still can't
3944 create a pipe when all processes have finished, break the retry loop. */
3948 if (pipe(pfd) == 0) pipe_done = TRUE;
3949 else if (parcount > 0) parmax = parcount;
3952 /* We need to make the reading end of the pipe non-blocking. There are
3953 two different options for this. Exim is cunningly (I hope!) coded so
3954 that it can use either of them, though it prefers O_NONBLOCK, which
3955 distinguishes between EOF and no-more-data. */
3958 (void)fcntl(pfd[pipe_read], F_SETFL, O_NONBLOCK);
3960 (void)fcntl(pfd[pipe_read], F_SETFL, O_NDELAY);
3963 /* If the maximum number of subprocesses already exist, wait for a process
3964 to finish. If we ran out of file descriptors, parmax will have been reduced
3965 from its initial value of remote_max_parallel. */
3967 par_reduce(parmax - 1, fallback);
3970 /* If we failed to create a pipe and there were no processes to wait
3971 for, we have to give up on this one. Do this outside the above loop
3972 so that we can continue the main loop. */
3976 remote_post_process(addr, LOG_MAIN|LOG_PANIC,
3977 string_sprintf("unable to create pipe: %s", strerror(errno)), fallback);
3981 /* Find a free slot in the pardata list. Must do this after the possible
3982 waiting for processes to finish, because a terminating process will free
3985 for (poffset = 0; poffset < remote_max_parallel; poffset++)
3986 if (parlist[poffset].pid == 0) break;
3988 /* If there isn't one, there has been a horrible disaster. */
3990 if (poffset >= remote_max_parallel)
3992 (void)close(pfd[pipe_write]);
3993 (void)close(pfd[pipe_read]);
3994 remote_post_process(addr, LOG_MAIN|LOG_PANIC,
3995 US"Unexpectedly no free subprocess slot", fallback);
3999 /* Now fork a subprocess to do the remote delivery, but before doing so,
4000 ensure that any cached resourses are released so as not to interfere with
4001 what happens in the subprocess. */
4005 if ((pid = fork()) == 0)
4007 int fd = pfd[pipe_write];
4010 /* Setting this global in the subprocess means we need never clear it */
4011 transport_name = tp->name;
4013 /* There are weird circumstances in which logging is disabled */
4014 disable_logging = tp->disable_logging;
4016 /* Show pids on debug output if parallelism possible */
4018 if (parmax > 1 && (parcount > 0 || addr_remote != NULL))
4020 DEBUG(D_any|D_v) debug_selector |= D_pid;
4021 DEBUG(D_deliver) debug_printf("Remote delivery process started\n");
4024 /* Reset the random number generator, so different processes don't all
4025 have the same sequence. In the test harness we want different, but
4026 predictable settings for each delivery process, so do something explicit
4027 here rather they rely on the fixed reset in the random number function. */
4029 random_seed = running_in_test_harness? 42 + 2*delivery_count : 0;
4031 /* Set close-on-exec on the pipe so that it doesn't get passed on to
4032 a new process that may be forked to do another delivery down the same
4035 (void)fcntl(fd, F_SETFD, fcntl(fd, F_GETFD) | FD_CLOEXEC);
4037 /* Close open file descriptors for the pipes of other processes
4038 that are running in parallel. */
4040 for (poffset = 0; poffset < remote_max_parallel; poffset++)
4041 if (parlist[poffset].pid != 0) (void)close(parlist[poffset].fd);
4043 /* This process has inherited a copy of the file descriptor
4044 for the data file, but its file pointer is shared with all the
4045 other processes running in parallel. Therefore, we have to re-open
4046 the file in order to get a new file descriptor with its own
4047 file pointer. We don't need to lock it, as the lock is held by
4048 the parent process. There doesn't seem to be any way of doing
4049 a dup-with-new-file-pointer. */
4051 (void)close(deliver_datafile);
4052 sprintf(CS spoolname, "%s/input/%s/%s-D", spool_directory, message_subdir,
4054 deliver_datafile = Uopen(spoolname, O_RDWR | O_APPEND, 0);
4056 if (deliver_datafile < 0)
4057 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Failed to reopen %s for remote "
4058 "parallel delivery: %s", spoolname, strerror(errno));
4060 /* Set the close-on-exec flag */
4062 (void)fcntl(deliver_datafile, F_SETFD, fcntl(deliver_datafile, F_GETFD) |
4065 /* Set the uid/gid of this process; bombs out on failure. */
4067 exim_setugid(uid, gid, use_initgroups,
4068 string_sprintf("remote delivery to %s with transport=%s",
4069 addr->address, tp->name));
4071 /* Close the unwanted half of this process' pipe, set the process state,
4072 and run the transport. Afterwards, transport_count will contain the number
4073 of bytes written. */
4075 (void)close(pfd[pipe_read]);
4076 set_process_info("delivering %s using %s", message_id, tp->name);
4077 debug_print_string(tp->debug_string);
4078 if (!(tp->info->code)(addr->transport, addr)) replicate_status(addr);
4080 set_process_info("delivering %s (just run %s for %s%s in subprocess)",
4081 message_id, tp->name, addr->address, (addr->next == NULL)? "" : ", ...");
4083 /* Ensure any cached resources that we used are now released */
4087 /* Pass the result back down the pipe. This is a lot more information
4088 than is needed for a local delivery. We have to send back the error
4089 status for each address, the usability status for each host that is
4090 flagged as unusable, and all the retry items. When TLS is in use, we
4091 send also the cipher and peerdn information. Each type of information
4092 is flagged by an identifying byte, and is then in a fixed format (with
4093 strings terminated by zeros), and there is a final terminator at the
4094 end. The host information and retry information is all attached to
4095 the first address, so that gets sent at the start. */
4097 /* Host unusability information: for most success cases this will
4100 for (h = addr->host_list; h != NULL; h = h->next)
4102 if (h->address == NULL || h->status < hstatus_unusable) continue;
4103 sprintf(CS big_buffer, "H%c%c%s", h->status, h->why, h->address);
4104 rmt_dlv_checked_write(fd, big_buffer, Ustrlen(big_buffer+3) + 4);
4107 /* The number of bytes written. This is the same for each address. Even
4108 if we sent several copies of the message down the same connection, the
4109 size of each one is the same, and it's that value we have got because
4110 transport_count gets reset before calling transport_write_message(). */
4112 big_buffer[0] = 'S';
4113 memcpy(big_buffer+1, &transport_count, sizeof(transport_count));
4114 rmt_dlv_checked_write(fd, big_buffer, sizeof(transport_count) + 1);
4116 /* Information about what happened to each address. Four item types are
4117 used: an optional 'X' item first, for TLS information, then an optional "C"
4118 item for any client-auth info followed by 'R' items for any retry settings,
4119 and finally an 'A' item for the remaining data. */
4121 for(; addr != NULL; addr = addr->next)
4126 /* The certificate verification status goes into the flags */
4127 if (tls_out.certificate_verified) setflag(addr, af_cert_verified);
4129 /* Use an X item only if there's something to send */
4134 sprintf(CS ptr, "X1%.128s", addr->cipher);
4140 sprintf(CS ptr, "%.512s", addr->peerdn);
4144 rmt_dlv_checked_write(fd, big_buffer, ptr - big_buffer);
4149 *ptr++ = 'X'; *ptr++ = '2';
4150 if (!tls_export_cert(ptr, big_buffer_size-2, addr->peercert))
4154 rmt_dlv_checked_write(fd, big_buffer, ptr - big_buffer);
4159 *ptr++ = 'X'; *ptr++ = '3';
4160 if (!tls_export_cert(ptr, big_buffer_size-2, addr->ourcert))
4164 rmt_dlv_checked_write(fd, big_buffer, ptr - big_buffer);
4166 #ifndef DISABLE_OCSP
4167 if (addr->ocsp > OCSP_NOT_REQ)
4170 sprintf(CS ptr, "X4%c", addr->ocsp + '0');
4172 rmt_dlv_checked_write(fd, big_buffer, ptr - big_buffer);
4175 #endif /*SUPPORT_TLS*/
4177 if (client_authenticator)
4180 sprintf(CS big_buffer, "C1%.64s", client_authenticator);
4182 rmt_dlv_checked_write(fd, big_buffer, ptr - big_buffer);
4184 if (client_authenticated_id)
4187 sprintf(CS big_buffer, "C2%.64s", client_authenticated_id);
4189 rmt_dlv_checked_write(fd, big_buffer, ptr - big_buffer);
4191 if (client_authenticated_sender)
4194 sprintf(CS big_buffer, "C3%.64s", client_authenticated_sender);
4196 rmt_dlv_checked_write(fd, big_buffer, ptr - big_buffer);
4199 #ifndef DISABLE_PRDR
4200 if (addr->flags & af_prdr_used)
4201 rmt_dlv_checked_write(fd, "P", 1);
4204 #ifdef EXPERIMENTAL_DSN
4205 big_buffer[0] = 'D';
4206 memcpy(big_buffer+1, &addr->dsn_aware, sizeof(addr->dsn_aware));
4207 rmt_dlv_checked_write(fd, big_buffer, sizeof(addr->dsn_aware) + 1);
4208 DEBUG(D_deliver) debug_printf("DSN write: addr->dsn_aware = %d\n", addr->dsn_aware);
4211 /* Retry information: for most success cases this will be null. */
4213 for (r = addr->retries; r != NULL; r = r->next)
4216 sprintf(CS big_buffer, "R%c%.500s", r->flags, r->key);
4217 ptr = big_buffer + Ustrlen(big_buffer+2) + 3;
4218 memcpy(ptr, &(r->basic_errno), sizeof(r->basic_errno));
4219 ptr += sizeof(r->basic_errno);
4220 memcpy(ptr, &(r->more_errno), sizeof(r->more_errno));
4221 ptr += sizeof(r->more_errno);
4222 if (r->message == NULL) *ptr++ = 0; else
4224 sprintf(CS ptr, "%.512s", r->message);
4227 rmt_dlv_checked_write(fd, big_buffer, ptr - big_buffer);
4230 /* The rest of the information goes in an 'A' item. */
4232 ptr = big_buffer + 3;
4233 sprintf(CS big_buffer, "A%c%c", addr->transport_return,
4234 addr->special_action);
4235 memcpy(ptr, &(addr->basic_errno), sizeof(addr->basic_errno));
4236 ptr += sizeof(addr->basic_errno);
4237 memcpy(ptr, &(addr->more_errno), sizeof(addr->more_errno));
4238 ptr += sizeof(addr->more_errno);
4239 memcpy(ptr, &(addr->flags), sizeof(addr->flags));
4240 ptr += sizeof(addr->flags);
4242 if (addr->message == NULL) *ptr++ = 0; else
4244 sprintf(CS ptr, "%.1024s", addr->message);
4248 if (addr->user_message == NULL) *ptr++ = 0; else
4250 sprintf(CS ptr, "%.1024s", addr->user_message);
4254 if (addr->host_used == NULL) *ptr++ = 0; else
4256 sprintf(CS ptr, "%.256s", addr->host_used->name);
4258 sprintf(CS ptr, "%.64s", addr->host_used->address);
4260 memcpy(ptr, &(addr->host_used->port), sizeof(addr->host_used->port));
4261 ptr += sizeof(addr->host_used->port);
4263 /* DNS lookup status */
4264 *ptr++ = addr->host_used->dnssec==DS_YES ? '2'
4265 : addr->host_used->dnssec==DS_NO ? '1' : '0';
4268 rmt_dlv_checked_write(fd, big_buffer, ptr - big_buffer);
4271 /* Add termination flag, close the pipe, and that's it. The character
4272 after 'Z' indicates whether continue_transport is now NULL or not.
4273 A change from non-NULL to NULL indicates a problem with a continuing
4276 big_buffer[0] = 'Z';
4277 big_buffer[1] = (continue_transport == NULL)? '0' : '1';
4278 rmt_dlv_checked_write(fd, big_buffer, 2);
4283 /* Back in the mainline: close the unwanted half of the pipe. */
4285 (void)close(pfd[pipe_write]);
4287 /* Fork failed; defer with error message */
4291 (void)close(pfd[pipe_read]);
4292 remote_post_process(addr, LOG_MAIN|LOG_PANIC,
4293 string_sprintf("fork failed for remote delivery to %s: %s",
4294 addr->domain, strerror(errno)), fallback);
4298 /* Fork succeeded; increment the count, and remember relevant data for
4299 when the process finishes. */
4302 parlist[poffset].addrlist = parlist[poffset].addr = addr;
4303 parlist[poffset].pid = pid;
4304 parlist[poffset].fd = pfd[pipe_read];
4305 parlist[poffset].done = FALSE;
4306 parlist[poffset].msg = NULL;
4307 parlist[poffset].return_path = return_path;
4309 /* If the process we've just started is sending a message down an existing
4310 channel, wait for it now. This ensures that only one such process runs at
4311 once, whatever the value of remote_max parallel. Otherwise, we might try to
4312 send two or more messages simultaneously down the same channel. This could
4313 happen if there are different domains that include the same host in otherwise
4314 different host lists.
4316 Also, if the transport closes down the channel, this information gets back
4317 (continue_transport gets set to NULL) before we consider any other addresses
4320 if (continue_transport != NULL) par_reduce(0, fallback);
4322 /* Otherwise, if we are running in the test harness, wait a bit, to let the
4323 newly created process get going before we create another process. This should
4324 ensure repeatability in the tests. We only need to wait a tad. */
4326 else if (running_in_test_harness) millisleep(500);
4329 /* Reached the end of the list of addresses. Wait for all the subprocesses that
4330 are still running and post-process their addresses. */
4332 par_reduce(0, fallback);
4339 /*************************************************
4340 * Split an address into local part and domain *
4341 *************************************************/
4343 /* This function initializes an address for routing by splitting it up into a
4344 local part and a domain. The local part is set up twice - once in its original
4345 casing, and once in lower case, and it is dequoted. We also do the "percent
4346 hack" for configured domains. This may lead to a DEFER result if a lookup
4347 defers. When a percent-hacking takes place, we insert a copy of the original
4348 address as a new parent of this address, as if we have had a redirection.
4351 addr points to an addr_item block containing the address
4354 DEFER - could not determine if domain is %-hackable
4358 deliver_split_address(address_item *addr)
4360 uschar *address = addr->address;
4361 uschar *domain = Ustrrchr(address, '@');
4363 int len = domain - address;
4365 addr->domain = string_copylc(domain+1); /* Domains are always caseless */
4367 /* The implication in the RFCs (though I can't say I've seen it spelled out
4368 explicitly) is that quoting should be removed from local parts at the point
4369 where they are locally interpreted. [The new draft "821" is more explicit on
4370 this, Jan 1999.] We know the syntax is valid, so this can be done by simply
4371 removing quoting backslashes and any unquoted doublequotes. */
4373 t = addr->cc_local_part = store_get(len+1);
4376 register int c = *address++;
4377 if (c == '\"') continue;
4387 /* We do the percent hack only for those domains that are listed in
4388 percent_hack_domains. A loop is required, to copy with multiple %-hacks. */
4390 if (percent_hack_domains != NULL)
4393 uschar *new_address = NULL;
4394 uschar *local_part = addr->cc_local_part;
4396 deliver_domain = addr->domain; /* set $domain */
4398 while ((rc = match_isinlist(deliver_domain, &percent_hack_domains, 0,
4399 &domainlist_anchor, addr->domain_cache, MCL_DOMAIN, TRUE, NULL))
4401 (t = Ustrrchr(local_part, '%')) != NULL)
4403 new_address = string_copy(local_part);
4404 new_address[t - local_part] = '@';
4405 deliver_domain = string_copylc(t+1);
4406 local_part = string_copyn(local_part, t - local_part);
4409 if (rc == DEFER) return DEFER; /* lookup deferred */
4411 /* If hackery happened, set up new parent and alter the current address. */
4413 if (new_address != NULL)
4415 address_item *new_parent = store_get(sizeof(address_item));
4416 *new_parent = *addr;
4417 addr->parent = new_parent;
4418 addr->address = new_address;
4419 addr->unique = string_copy(new_address);
4420 addr->domain = deliver_domain;
4421 addr->cc_local_part = local_part;
4422 DEBUG(D_deliver) debug_printf("%%-hack changed address to: %s\n",
4427 /* Create the lowercased version of the final local part, and make that the
4428 default one to be used. */
4430 addr->local_part = addr->lc_local_part = string_copylc(addr->cc_local_part);
4437 /*************************************************
4438 * Get next error message text *
4439 *************************************************/
4441 /* If f is not NULL, read the next "paragraph", from a customized error message
4442 text file, terminated by a line containing ****, and expand it.
4445 f NULL or a file to read from
4446 which string indicating which string (for errors)
4448 Returns: NULL or an expanded string
4452 next_emf(FILE *f, uschar *which)
4456 uschar *para, *yield;
4459 if (f == NULL) return NULL;
4461 if (Ufgets(buffer, sizeof(buffer), f) == NULL ||
4462 Ustrcmp(buffer, "****\n") == 0) return NULL;
4464 para = store_get(size);
4467 para = string_cat(para, &size, &ptr, buffer, Ustrlen(buffer));
4468 if (Ufgets(buffer, sizeof(buffer), f) == NULL ||
4469 Ustrcmp(buffer, "****\n") == 0) break;
4473 yield = expand_string(para);
4474 if (yield != NULL) return yield;
4476 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand string from "
4477 "bounce_message_file or warn_message_file (%s): %s", which,
4478 expand_string_message);
4485 /*************************************************
4486 * Close down a passed transport channel *
4487 *************************************************/
4489 /* This function is called when a passed transport channel cannot be used.
4490 It attempts to close it down tidily. The yield is always DELIVER_NOT_ATTEMPTED
4491 so that the function call can be the argument of a "return" statement.
4494 Returns: DELIVER_NOT_ATTEMPTED
4498 continue_closedown(void)
4500 if (continue_transport != NULL)
4502 transport_instance *t;
4503 for (t = transports; t != NULL; t = t->next)
4505 if (Ustrcmp(t->name, continue_transport) == 0)
4507 if (t->info->closedown != NULL) (t->info->closedown)(t);
4512 return DELIVER_NOT_ATTEMPTED;
4518 /*************************************************
4519 * Print address information *
4520 *************************************************/
4522 /* This function is called to output an address, or information about an
4523 address, for bounce or defer messages. If the hide_child flag is set, all we
4524 output is the original ancestor address.
4527 addr points to the address
4528 f the FILE to print to
4529 si an initial string
4530 sc a continuation string for before "generated"
4533 Returns: TRUE if the address is not hidden
4537 print_address_information(address_item *addr, FILE *f, uschar *si, uschar *sc,
4541 uschar *printed = US"";
4542 address_item *ancestor = addr;
4543 while (ancestor->parent != NULL) ancestor = ancestor->parent;
4545 fprintf(f, "%s", CS si);
4547 if (addr->parent != NULL && testflag(addr, af_hide_child))
4549 printed = US"an undisclosed address";
4552 else if (!testflag(addr, af_pfr) || addr->parent == NULL)
4553 printed = addr->address;
4557 uschar *s = addr->address;
4560 if (addr->address[0] == '>') { ss = US"mail"; s++; }
4561 else if (addr->address[0] == '|') ss = US"pipe";
4564 fprintf(f, "%s to %s%sgenerated by ", ss, s, sc);
4565 printed = addr->parent->address;
4568 fprintf(f, "%s", CS string_printing(printed));
4570 if (ancestor != addr)
4572 uschar *original = (ancestor->onetime_parent == NULL)?
4573 ancestor->address : ancestor->onetime_parent;
4574 if (strcmpic(original, printed) != 0)
4575 fprintf(f, "%s(%sgenerated from %s)", sc,
4576 (ancestor != addr->parent)? "ultimately " : "",
4577 string_printing(original));
4580 fprintf(f, "%s", CS se);
4588 /*************************************************
4589 * Print error for an address *
4590 *************************************************/
4592 /* This function is called to print the error information out of an address for
4593 a bounce or a warning message. It tries to format the message reasonably by
4594 introducing newlines. All lines are indented by 4; the initial printing
4595 position must be set before calling.
4597 This function used always to print the error. Nowadays we want to restrict it
4598 to cases such as LMTP/SMTP errors from a remote host, and errors from :fail:
4599 and filter "fail". We no longer pass other information willy-nilly in bounce
4600 and warning messages. Text in user_message is always output; text in message
4601 only if the af_pass_message flag is set.
4605 f the FILE to print on
4612 print_address_error(address_item *addr, FILE *f, uschar *t)
4614 int count = Ustrlen(t);
4615 uschar *s = testflag(addr, af_pass_message)? addr->message : NULL;
4619 if (addr->user_message != NULL) s = addr->user_message; else return;
4622 fprintf(f, "\n %s", t);
4626 if (*s == '\\' && s[1] == 'n')
4636 if (*s++ == ':' && isspace(*s) && count > 45)
4638 fprintf(f, "\n "); /* sic (because space follows) */
4650 /*************************************************
4651 * Check list of addresses for duplication *
4652 *************************************************/
4654 /* This function was introduced when the test for duplicate addresses that are
4655 not pipes, files, or autoreplies was moved from the middle of routing to when
4656 routing was complete. That was to fix obscure cases when the routing history
4657 affects the subsequent routing of identical addresses. This function is called
4658 after routing, to check that the final routed addresses are not duplicates.
4660 If we detect a duplicate, we remember what it is a duplicate of. Note that
4661 pipe, file, and autoreply de-duplication is handled during routing, so we must
4662 leave such "addresses" alone here, as otherwise they will incorrectly be
4665 Argument: address of list anchor
4670 do_duplicate_check(address_item **anchor)
4673 while ((addr = *anchor) != NULL)
4676 if (testflag(addr, af_pfr))
4678 anchor = &(addr->next);
4680 else if ((tnode = tree_search(tree_duplicates, addr->unique)) != NULL)
4682 DEBUG(D_deliver|D_route)
4683 debug_printf("%s is a duplicate address: discarded\n", addr->unique);
4684 *anchor = addr->next;
4685 addr->dupof = tnode->data.ptr;
4686 addr->next = addr_duplicate;
4687 addr_duplicate = addr;
4691 tree_add_duplicate(addr->unique, addr);
4692 anchor = &(addr->next);
4700 /*************************************************
4701 * Deliver one message *
4702 *************************************************/
4704 /* This is the function which is called when a message is to be delivered. It
4705 is passed the id of the message. It is possible that the message no longer
4706 exists, if some other process has delivered it, and it is also possible that
4707 the message is being worked on by another process, in which case the data file
4710 If no delivery is attempted for any of the above reasons, the function returns
4711 DELIVER_NOT_ATTEMPTED.
4713 If the give_up flag is set true, do not attempt any deliveries, but instead
4714 fail all outstanding addresses and return the message to the sender (or
4717 A delivery operation has a process all to itself; we never deliver more than
4718 one message in the same process. Therefore we needn't worry too much about
4722 id the id of the message to be delivered
4723 forced TRUE if delivery was forced by an administrator; this overrides
4724 retry delays and causes a delivery to be tried regardless
4725 give_up TRUE if an administrator has requested that delivery attempts
4728 Returns: When the global variable mua_wrapper is FALSE:
4729 DELIVER_ATTEMPTED_NORMAL if a delivery attempt was made
4730 DELIVER_NOT_ATTEMPTED otherwise (see comment above)
4731 When the global variable mua_wrapper is TRUE:
4732 DELIVER_MUA_SUCCEEDED if delivery succeeded
4733 DELIVER_MUA_FAILED if delivery failed
4734 DELIVER_NOT_ATTEMPTED if not attempted (should not occur)
4738 deliver_message(uschar *id, BOOL forced, BOOL give_up)
4741 int final_yield = DELIVER_ATTEMPTED_NORMAL;
4742 time_t now = time(NULL);
4743 address_item *addr_last = NULL;
4744 uschar *filter_message = NULL;
4746 int process_recipients = RECIP_ACCEPT;
4749 extern int acl_where;
4751 uschar *info = (queue_run_pid == (pid_t)0)?
4752 string_sprintf("delivering %s", id) :
4753 string_sprintf("delivering %s (queue run pid %d)", id, queue_run_pid);
4755 /* If the D_process_info bit is on, set_process_info() will output debugging
4756 information. If not, we want to show this initial information if D_deliver or
4757 D_queue_run is set or in verbose mode. */
4759 set_process_info("%s", info);
4761 if ((debug_selector & D_process_info) == 0 &&
4762 (debug_selector & (D_deliver|D_queue_run|D_v)) != 0)
4763 debug_printf("%s\n", info);
4765 /* Ensure that we catch any subprocesses that are created. Although Exim
4766 sets SIG_DFL as its initial default, some routes through the code end up
4767 here with it set to SIG_IGN - cases where a non-synchronous delivery process
4768 has been forked, but no re-exec has been done. We use sigaction rather than
4769 plain signal() on those OS where SA_NOCLDWAIT exists, because we want to be
4770 sure it is turned off. (There was a problem on AIX with this.) */
4774 struct sigaction act;
4775 act.sa_handler = SIG_DFL;
4776 sigemptyset(&(act.sa_mask));
4778 sigaction(SIGCHLD, &act, NULL);
4781 signal(SIGCHLD, SIG_DFL);
4784 /* Make the forcing flag available for routers and transports, set up the
4785 global message id field, and initialize the count for returned files and the
4786 message size. This use of strcpy() is OK because the length id is checked when
4787 it is obtained from a command line (the -M or -q options), and otherwise it is
4788 known to be a valid message id. */
4790 Ustrcpy(message_id, id);
4791 deliver_force = forced;
4795 /* Initialize some flags */
4797 update_spool = FALSE;
4798 remove_journal = TRUE;
4800 /* Set a known context for any ACLs we call via expansions */
4801 acl_where = ACL_WHERE_DELIVERY;
4803 /* Reset the random number generator, so that if several delivery processes are
4804 started from a queue runner that has already used random numbers (for sorting),
4805 they don't all get the same sequence. */
4809 /* Open and lock the message's data file. Exim locks on this one because the
4810 header file may get replaced as it is re-written during the delivery process.
4811 Any failures cause messages to be written to the log, except for missing files
4812 while queue running - another process probably completed delivery. As part of
4813 opening the data file, message_subdir gets set. */
4815 if (!spool_open_datafile(id))
4816 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
4818 /* The value of message_size at this point has been set to the data length,
4819 plus one for the blank line that notionally precedes the data. */
4821 /* Now read the contents of the header file, which will set up the headers in
4822 store, and also the list of recipients and the tree of non-recipients and
4823 assorted flags. It updates message_size. If there is a reading or format error,
4824 give up; if the message has been around for sufficiently long, remove it. */
4826 sprintf(CS spoolname, "%s-H", id);
4827 if ((rc = spool_read_header(spoolname, TRUE, TRUE)) != spool_read_OK)
4829 if (errno == ERRNO_SPOOLFORMAT)
4831 struct stat statbuf;
4832 sprintf(CS big_buffer, "%s/input/%s/%s", spool_directory, message_subdir,
4834 if (Ustat(big_buffer, &statbuf) == 0)
4835 log_write(0, LOG_MAIN, "Format error in spool file %s: "
4836 "size=" OFF_T_FMT, spoolname, statbuf.st_size);
4837 else log_write(0, LOG_MAIN, "Format error in spool file %s", spoolname);
4840 log_write(0, LOG_MAIN, "Error reading spool file %s: %s", spoolname,
4843 /* If we managed to read the envelope data, received_time contains the
4844 time the message was received. Otherwise, we can calculate it from the
4847 if (rc != spool_read_hdrerror)
4850 for (i = 0; i < 6; i++)
4851 received_time = received_time * BASE_62 + tab62[id[i] - '0'];
4854 /* If we've had this malformed message too long, sling it. */
4856 if (now - received_time > keep_malformed)
4858 sprintf(CS spoolname, "%s/msglog/%s/%s", spool_directory, message_subdir, id);
4860 sprintf(CS spoolname, "%s/input/%s/%s-D", spool_directory, message_subdir, id);
4862 sprintf(CS spoolname, "%s/input/%s/%s-H", spool_directory, message_subdir, id);
4864 sprintf(CS spoolname, "%s/input/%s/%s-J", spool_directory, message_subdir, id);
4866 log_write(0, LOG_MAIN, "Message removed because older than %s",
4867 readconf_printtime(keep_malformed));
4870 (void)close(deliver_datafile);
4871 deliver_datafile = -1;
4872 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
4875 /* The spool header file has been read. Look to see if there is an existing
4876 journal file for this message. If there is, it means that a previous delivery
4877 attempt crashed (program or host) before it could update the spool header file.
4878 Read the list of delivered addresses from the journal and add them to the
4879 nonrecipients tree. Then update the spool file. We can leave the journal in
4880 existence, as it will get further successful deliveries added to it in this
4881 run, and it will be deleted if this function gets to its end successfully.
4882 Otherwise it might be needed again. */
4884 sprintf(CS spoolname, "%s/input/%s/%s-J", spool_directory, message_subdir, id);
4885 jread = Ufopen(spoolname, "rb");
4888 while (Ufgets(big_buffer, big_buffer_size, jread) != NULL)
4890 int n = Ustrlen(big_buffer);
4891 big_buffer[n-1] = 0;
4892 tree_add_nonrecipient(big_buffer);
4893 DEBUG(D_deliver) debug_printf("Previously delivered address %s taken from "
4894 "journal file\n", big_buffer);
4896 (void)fclose(jread);
4897 /* Panic-dies on error */
4898 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
4900 else if (errno != ENOENT)
4902 log_write(0, LOG_MAIN|LOG_PANIC, "attempt to open journal for reading gave: "
4903 "%s", strerror(errno));
4904 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
4907 /* A null recipients list indicates some kind of disaster. */
4909 if (recipients_list == NULL)
4911 (void)close(deliver_datafile);
4912 deliver_datafile = -1;
4913 log_write(0, LOG_MAIN, "Spool error: no recipients for %s", spoolname);
4914 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
4918 /* Handle a message that is frozen. There are a number of different things that
4919 can happen, but in the default situation, unless forced, no delivery is
4924 #ifdef SUPPORT_MOVE_FROZEN_MESSAGES
4925 /* Moving to another directory removes the message from Exim's view. Other
4926 tools must be used to deal with it. Logging of this action happens in
4927 spool_move_message() and its subfunctions. */
4929 if (move_frozen_messages &&
4930 spool_move_message(id, message_subdir, US"", US"F"))
4931 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
4934 /* For all frozen messages (bounces or not), timeout_frozen_after sets the
4935 maximum time to keep messages that are frozen. Thaw if we reach it, with a
4936 flag causing all recipients to be failed. The time is the age of the
4937 message, not the time since freezing. */
4939 if (timeout_frozen_after > 0 && message_age >= timeout_frozen_after)
4941 log_write(0, LOG_MAIN, "cancelled by timeout_frozen_after");
4942 process_recipients = RECIP_FAIL_TIMEOUT;
4945 /* For bounce messages (and others with no sender), thaw if the error message
4946 ignore timer is exceeded. The message will be discarded if this delivery
4949 else if (sender_address[0] == 0 && message_age >= ignore_bounce_errors_after)
4951 log_write(0, LOG_MAIN, "Unfrozen by errmsg timer");
4954 /* If this is a bounce message, or there's no auto thaw, or we haven't
4955 reached the auto thaw time yet, and this delivery is not forced by an admin
4956 user, do not attempt delivery of this message. Note that forced is set for
4957 continuing messages down the same channel, in order to skip load checking and
4958 ignore hold domains, but we don't want unfreezing in that case. */
4962 if ((sender_address[0] == 0 ||
4964 now <= deliver_frozen_at + auto_thaw
4967 (!forced || !deliver_force_thaw || !admin_user ||
4968 continue_hostname != NULL
4971 (void)close(deliver_datafile);
4972 deliver_datafile = -1;
4973 log_write(L_skip_delivery, LOG_MAIN, "Message is frozen");
4974 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
4977 /* If delivery was forced (by an admin user), assume a manual thaw.
4978 Otherwise it's an auto thaw. */
4982 deliver_manual_thaw = TRUE;
4983 log_write(0, LOG_MAIN, "Unfrozen by forced delivery");
4985 else log_write(0, LOG_MAIN, "Unfrozen by auto-thaw");
4988 /* We get here if any of the rules for unfreezing have triggered. */
4990 deliver_freeze = FALSE;
4991 update_spool = TRUE;
4995 /* Open the message log file if we are using them. This records details of
4996 deliveries, deferments, and failures for the benefit of the mail administrator.
4997 The log is not used by exim itself to track the progress of a message; that is
4998 done by rewriting the header spool file. */
5005 sprintf(CS spoolname, "%s/msglog/%s/%s", spool_directory, message_subdir, id);
5006 fd = open_msglog_file(spoolname, SPOOL_MODE, &error);
5010 log_write(0, LOG_MAIN|LOG_PANIC, "Couldn't %s message log %s: %s", error,
5011 spoolname, strerror(errno));
5012 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5015 /* Make a C stream out of it. */
5017 message_log = fdopen(fd, "a");
5018 if (message_log == NULL)
5020 log_write(0, LOG_MAIN|LOG_PANIC, "Couldn't fdopen message log %s: %s",
5021 spoolname, strerror(errno));
5022 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5027 /* If asked to give up on a message, log who did it, and set the action for all
5032 struct passwd *pw = getpwuid(real_uid);
5033 log_write(0, LOG_MAIN, "cancelled by %s", (pw != NULL)?
5034 US pw->pw_name : string_sprintf("uid %ld", (long int)real_uid));
5035 process_recipients = RECIP_FAIL;
5038 /* Otherwise, if there are too many Received: headers, fail all recipients. */
5040 else if (received_count > received_headers_max)
5041 process_recipients = RECIP_FAIL_LOOP;
5043 /* Otherwise, if a system-wide, address-independent message filter is
5044 specified, run it now, except in the case when we are failing all recipients as
5045 a result of timeout_frozen_after. If the system filter yields "delivered", then
5046 ignore the true recipients of the message. Failure of the filter file is
5047 logged, and the delivery attempt fails. */
5049 else if (system_filter != NULL && process_recipients != RECIP_FAIL_TIMEOUT)
5054 redirect_block redirect;
5056 if (system_filter_uid_set)
5058 ugid.uid = system_filter_uid;
5059 ugid.gid = system_filter_gid;
5060 ugid.uid_set = ugid.gid_set = TRUE;
5064 ugid.uid_set = ugid.gid_set = FALSE;
5067 return_path = sender_address;
5068 enable_dollar_recipients = TRUE; /* Permit $recipients in system filter */
5069 system_filtering = TRUE;
5071 /* Any error in the filter file causes a delivery to be abandoned. */
5073 redirect.string = system_filter;
5074 redirect.isfile = TRUE;
5075 redirect.check_owner = redirect.check_group = FALSE;
5076 redirect.owners = NULL;
5077 redirect.owngroups = NULL;
5079 redirect.modemask = 0;
5081 DEBUG(D_deliver|D_filter) debug_printf("running system filter\n");
5084 &redirect, /* Where the data is */
5085 RDO_DEFER | /* Turn on all the enabling options */
5086 RDO_FAIL | /* Leave off all the disabling options */
5091 NULL, /* No :include: restriction (not used in filter) */
5092 NULL, /* No sieve vacation directory (not sieve!) */
5093 NULL, /* No sieve enotify mailto owner (not sieve!) */
5094 NULL, /* No sieve user address (not sieve!) */
5095 NULL, /* No sieve subaddress (not sieve!) */
5096 &ugid, /* uid/gid data */
5097 &addr_new, /* Where to hang generated addresses */
5098 &filter_message, /* Where to put error message */
5099 NULL, /* Don't skip syntax errors */
5100 &filtertype, /* Will always be set to FILTER_EXIM for this call */
5101 US"system filter"); /* For error messages */
5103 DEBUG(D_deliver|D_filter) debug_printf("system filter returned %d\n", rc);
5105 if (rc == FF_ERROR || rc == FF_NONEXIST)
5107 (void)close(deliver_datafile);
5108 deliver_datafile = -1;
5109 log_write(0, LOG_MAIN|LOG_PANIC, "Error in system filter: %s",
5110 string_printing(filter_message));
5111 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5114 /* Reset things. If the filter message is an empty string, which can happen
5115 for a filter "fail" or "freeze" command with no text, reset it to NULL. */
5117 system_filtering = FALSE;
5118 enable_dollar_recipients = FALSE;
5119 if (filter_message != NULL && filter_message[0] == 0) filter_message = NULL;
5121 /* Save the values of the system filter variables so that user filters
5124 memcpy(filter_sn, filter_n, sizeof(filter_sn));
5126 /* The filter can request that delivery of the original addresses be
5131 process_recipients = RECIP_DEFER;
5132 deliver_msglog("Delivery deferred by system filter\n");
5133 log_write(0, LOG_MAIN, "Delivery deferred by system filter");
5136 /* The filter can request that a message be frozen, but this does not
5137 take place if the message has been manually thawed. In that case, we must
5138 unset "delivered", which is forced by the "freeze" command to make -bF
5141 else if (rc == FF_FREEZE && !deliver_manual_thaw)
5143 deliver_freeze = TRUE;
5144 deliver_frozen_at = time(NULL);
5145 process_recipients = RECIP_DEFER;
5146 frozen_info = string_sprintf(" by the system filter%s%s",
5147 (filter_message == NULL)? US"" : US": ",
5148 (filter_message == NULL)? US"" : filter_message);
5151 /* The filter can request that a message be failed. The error message may be
5152 quite long - it is sent back to the sender in the bounce - but we don't want
5153 to fill up the log with repetitions of it. If it starts with << then the text
5154 between << and >> is written to the log, with the rest left for the bounce
5157 else if (rc == FF_FAIL)
5159 uschar *colon = US"";
5160 uschar *logmsg = US"";
5163 process_recipients = RECIP_FAIL_FILTER;
5165 if (filter_message != NULL)
5169 if (filter_message[0] == '<' && filter_message[1] == '<' &&
5170 (logend = Ustrstr(filter_message, ">>")) != NULL)
5172 logmsg = filter_message + 2;
5173 loglen = logend - logmsg;
5174 filter_message = logend + 2;
5175 if (filter_message[0] == 0) filter_message = NULL;
5179 logmsg = filter_message;
5180 loglen = Ustrlen(filter_message);
5184 log_write(0, LOG_MAIN, "cancelled by system filter%s%.*s", colon, loglen,
5188 /* Delivery can be restricted only to those recipients (if any) that the
5189 filter specified. */
5191 else if (rc == FF_DELIVERED)
5193 process_recipients = RECIP_IGNORE;
5194 if (addr_new == NULL)
5195 log_write(0, LOG_MAIN, "=> discarded (system filter)");
5197 log_write(0, LOG_MAIN, "original recipients ignored (system filter)");
5200 /* If any new addresses were created by the filter, fake up a "parent"
5201 for them. This is necessary for pipes, etc., which are expected to have
5202 parents, and it also gives some sensible logging for others. Allow
5203 pipes, files, and autoreplies, and run them as the filter uid if set,
5204 otherwise as the current uid. */
5206 if (addr_new != NULL)
5208 int uid = (system_filter_uid_set)? system_filter_uid : geteuid();
5209 int gid = (system_filter_gid_set)? system_filter_gid : getegid();
5211 /* The text "system-filter" is tested in transport_set_up_command() and in
5212 set_up_shell_command() in the pipe transport, to enable them to permit
5213 $recipients, so don't change it here without also changing it there. */
5215 address_item *p = addr_new;
5216 address_item *parent = deliver_make_addr(US"system-filter", FALSE);
5218 parent->domain = string_copylc(qualify_domain_recipient);
5219 parent->local_part = US"system-filter";
5221 /* As part of this loop, we arrange for addr_last to end up pointing
5222 at the final address. This is used if we go on to add addresses for the
5223 original recipients. */
5227 if (parent->child_count == SHRT_MAX)
5228 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "system filter generated more "
5229 "than %d delivery addresses", SHRT_MAX);
5230 parent->child_count++;
5233 if (testflag(p, af_pfr))
5239 setflag(p, af_uid_set |
5245 /* Find the name of the system filter's appropriate pfr transport */
5247 if (p->address[0] == '|')
5250 tpname = system_filter_pipe_transport;
5251 address_pipe = p->address;
5253 else if (p->address[0] == '>')
5256 tpname = system_filter_reply_transport;
5260 if (p->address[Ustrlen(p->address)-1] == '/')
5262 type = US"directory";
5263 tpname = system_filter_directory_transport;
5268 tpname = system_filter_file_transport;
5270 address_file = p->address;
5273 /* Now find the actual transport, first expanding the name. We have
5274 set address_file or address_pipe above. */
5278 uschar *tmp = expand_string(tpname);
5279 address_file = address_pipe = NULL;
5281 p->message = string_sprintf("failed to expand \"%s\" as a "
5282 "system filter transport name", tpname);
5287 p->message = string_sprintf("system_filter_%s_transport is unset",
5293 transport_instance *tp;
5294 for (tp = transports; tp != NULL; tp = tp->next)
5296 if (Ustrcmp(tp->name, tpname) == 0)
5303 p->message = string_sprintf("failed to find \"%s\" transport "
5304 "for system filter delivery", tpname);
5307 /* If we couldn't set up a transport, defer the delivery, putting the
5308 error on the panic log as well as the main log. */
5310 if (p->transport == NULL)
5312 address_item *badp = p;
5314 if (addr_last == NULL) addr_new = p; else addr_last->next = p;
5315 badp->local_part = badp->address; /* Needed for log line */
5316 post_process_one(badp, DEFER, LOG_MAIN|LOG_PANIC, DTYPE_ROUTER, 0);
5319 } /* End of pfr handling */
5321 /* Either a non-pfr delivery, or we found a transport */
5323 DEBUG(D_deliver|D_filter)
5324 debug_printf("system filter added %s\n", p->address);
5328 } /* Loop through all addr_new addresses */
5333 /* Scan the recipients list, and for every one that is not in the non-
5334 recipients tree, add an addr item to the chain of new addresses. If the pno
5335 value is non-negative, we must set the onetime parent from it. This which
5336 points to the relevant entry in the recipients list.
5338 This processing can be altered by the setting of the process_recipients
5339 variable, which is changed if recipients are to be ignored, failed, or
5340 deferred. This can happen as a result of system filter activity, or if the -Mg
5341 option is used to fail all of them.
5343 Duplicate addresses are handled later by a different tree structure; we can't
5344 just extend the non-recipients tree, because that will be re-written to the
5345 spool if the message is deferred, and in any case there are casing
5346 complications for local addresses. */
5348 if (process_recipients != RECIP_IGNORE)
5350 for (i = 0; i < recipients_count; i++)
5352 if (tree_search(tree_nonrecipients, recipients_list[i].address) == NULL)
5354 recipient_item *r = recipients_list + i;
5355 address_item *new = deliver_make_addr(r->address, FALSE);
5356 new->p.errors_address = r->errors_to;
5359 new->onetime_parent = recipients_list[r->pno].address;
5361 #ifdef EXPERIMENTAL_DSN
5362 /* If DSN support is enabled, set the dsn flags and the original receipt
5363 to be passed on to other DSN enabled MTAs */
5364 new->dsn_flags = r->dsn_flags & rf_dsnflags;
5365 new->dsn_orcpt = r->orcpt;
5366 DEBUG(D_deliver) debug_printf("DSN: set orcpt: %s flags: %d\n", new->dsn_orcpt, new->dsn_flags);
5369 switch (process_recipients)
5371 /* RECIP_DEFER is set when a system filter freezes a message. */
5374 new->next = addr_defer;
5379 /* RECIP_FAIL_FILTER is set when a system filter has obeyed a "fail"
5382 case RECIP_FAIL_FILTER:
5384 (filter_message == NULL)? US"delivery cancelled" : filter_message;
5385 setflag(new, af_pass_message);
5386 goto RECIP_QUEUE_FAILED; /* below */
5389 /* RECIP_FAIL_TIMEOUT is set when a message is frozen, but is older
5390 than the value in timeout_frozen_after. Treat non-bounce messages
5391 similarly to -Mg; for bounce messages we just want to discard, so
5392 don't put the address on the failed list. The timeout has already
5395 case RECIP_FAIL_TIMEOUT:
5396 new->message = US"delivery cancelled; message timed out";
5397 goto RECIP_QUEUE_FAILED; /* below */
5400 /* RECIP_FAIL is set when -Mg has been used. */
5403 new->message = US"delivery cancelled by administrator";
5406 /* Common code for the failure cases above. If this is not a bounce
5407 message, put the address on the failed list so that it is used to
5408 create a bounce. Otherwise do nothing - this just discards the address.
5409 The incident has already been logged. */
5412 if (sender_address[0] != 0)
5414 new->next = addr_failed;
5420 /* RECIP_FAIL_LOOP is set when there are too many Received: headers
5421 in the message. Process each address as a routing failure; if this
5422 is a bounce message, it will get frozen. */
5424 case RECIP_FAIL_LOOP:
5425 new->message = US"Too many \"Received\" headers - suspected mail loop";
5426 post_process_one(new, FAIL, LOG_MAIN, DTYPE_ROUTER, 0);
5430 /* Value should be RECIP_ACCEPT; take this as the safe default. */
5433 if (addr_new == NULL) addr_new = new; else addr_last->next = new;
5443 address_item *p = addr_new;
5444 debug_printf("Delivery address list:\n");
5447 debug_printf(" %s %s\n", p->address, (p->onetime_parent == NULL)? US"" :
5453 /* Set up the buffers used for copying over the file when delivering. */
5455 deliver_in_buffer = store_malloc(DELIVER_IN_BUFFER_SIZE);
5456 deliver_out_buffer = store_malloc(DELIVER_OUT_BUFFER_SIZE);
5460 /* Until there are no more new addresses, handle each one as follows:
5462 . If this is a generated address (indicated by the presence of a parent
5463 pointer) then check to see whether it is a pipe, file, or autoreply, and
5464 if so, handle it directly here. The router that produced the address will
5465 have set the allow flags into the address, and also set the uid/gid required.
5466 Having the routers generate new addresses and then checking them here at
5467 the outer level is tidier than making each router do the checking, and
5468 means that routers don't need access to the failed address queue.
5470 . Break up the address into local part and domain, and make lowercased
5471 versions of these strings. We also make unquoted versions of the local part.
5473 . Handle the percent hack for those domains for which it is valid.
5475 . For child addresses, determine if any of the parents have the same address.
5476 If so, generate a different string for previous delivery checking. Without
5477 this code, if the address spqr generates spqr via a forward or alias file,
5478 delivery of the generated spqr stops further attempts at the top level spqr,
5479 which is not what is wanted - it may have generated other addresses.
5481 . Check on the retry database to see if routing was previously deferred, but
5482 only if in a queue run. Addresses that are to be routed are put on the
5483 addr_route chain. Addresses that are to be deferred are put on the
5484 addr_defer chain. We do all the checking first, so as not to keep the
5485 retry database open any longer than necessary.
5487 . Now we run the addresses through the routers. A router may put the address
5488 on either the addr_local or the addr_remote chain for local or remote
5489 delivery, respectively, or put it on the addr_failed chain if it is
5490 undeliveable, or it may generate child addresses and put them on the
5491 addr_new chain, or it may defer an address. All the chain anchors are
5492 passed as arguments so that the routers can be called for verification
5495 . If new addresses have been generated by the routers, da capo.
5498 header_rewritten = FALSE; /* No headers rewritten yet */
5499 while (addr_new != NULL) /* Loop until all addresses dealt with */
5501 address_item *addr, *parent;
5502 dbm_file = dbfn_open(US"retry", O_RDONLY, &dbblock, FALSE);
5504 /* Failure to open the retry database is treated the same as if it does
5505 not exist. In both cases, dbm_file is NULL. */
5507 if (dbm_file == NULL)
5509 DEBUG(D_deliver|D_retry|D_route|D_hints_lookup)
5510 debug_printf("no retry data available\n");
5513 /* Scan the current batch of new addresses, to handle pipes, files and
5514 autoreplies, and determine which others are ready for routing. */
5516 while (addr_new != NULL)
5521 dbdata_retry *domain_retry_record;
5522 dbdata_retry *address_retry_record;
5525 addr_new = addr->next;
5527 DEBUG(D_deliver|D_retry|D_route)
5529 debug_printf(">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>\n");
5530 debug_printf("Considering: %s\n", addr->address);
5533 /* Handle generated address that is a pipe or a file or an autoreply. */
5535 if (testflag(addr, af_pfr))
5537 /* If an autoreply in a filter could not generate a syntactically valid
5538 address, give up forthwith. Set af_ignore_error so that we don't try to
5539 generate a bounce. */
5541 if (testflag(addr, af_bad_reply))
5543 addr->basic_errno = ERRNO_BADADDRESS2;
5544 addr->local_part = addr->address;
5546 US"filter autoreply generated syntactically invalid recipient";
5547 setflag(addr, af_ignore_error);
5548 (void)post_process_one(addr, FAIL, LOG_MAIN, DTYPE_ROUTER, 0);
5549 continue; /* with the next new address */
5552 /* If two different users specify delivery to the same pipe or file or
5553 autoreply, there should be two different deliveries, so build a unique
5554 string that incorporates the original address, and use this for
5555 duplicate testing and recording delivery, and also for retrying. */
5558 string_sprintf("%s:%s", addr->address, addr->parent->unique +
5559 (testflag(addr->parent, af_homonym)? 3:0));
5561 addr->address_retry_key = addr->domain_retry_key =
5562 string_sprintf("T:%s", addr->unique);
5564 /* If a filter file specifies two deliveries to the same pipe or file,
5565 we want to de-duplicate, but this is probably not wanted for two mail
5566 commands to the same address, where probably both should be delivered.
5567 So, we have to invent a different unique string in that case. Just
5568 keep piling '>' characters on the front. */
5570 if (addr->address[0] == '>')
5572 while (tree_search(tree_duplicates, addr->unique) != NULL)
5573 addr->unique = string_sprintf(">%s", addr->unique);
5576 else if ((tnode = tree_search(tree_duplicates, addr->unique)) != NULL)
5578 DEBUG(D_deliver|D_route)
5579 debug_printf("%s is a duplicate address: discarded\n", addr->address);
5580 addr->dupof = tnode->data.ptr;
5581 addr->next = addr_duplicate;
5582 addr_duplicate = addr;
5586 DEBUG(D_deliver|D_route) debug_printf("unique = %s\n", addr->unique);
5588 /* Check for previous delivery */
5590 if (tree_search(tree_nonrecipients, addr->unique) != NULL)
5592 DEBUG(D_deliver|D_route)
5593 debug_printf("%s was previously delivered: discarded\n", addr->address);
5594 child_done(addr, tod_stamp(tod_log));
5598 /* Save for checking future duplicates */
5600 tree_add_duplicate(addr->unique, addr);
5602 /* Set local part and domain */
5604 addr->local_part = addr->address;
5605 addr->domain = addr->parent->domain;
5607 /* Ensure that the delivery is permitted. */
5609 if (testflag(addr, af_file))
5611 if (!testflag(addr, af_allow_file))
5613 addr->basic_errno = ERRNO_FORBIDFILE;
5614 addr->message = US"delivery to file forbidden";
5615 (void)post_process_one(addr, FAIL, LOG_MAIN, DTYPE_ROUTER, 0);
5616 continue; /* with the next new address */
5619 else if (addr->address[0] == '|')
5621 if (!testflag(addr, af_allow_pipe))
5623 addr->basic_errno = ERRNO_FORBIDPIPE;
5624 addr->message = US"delivery to pipe forbidden";
5625 (void)post_process_one(addr, FAIL, LOG_MAIN, DTYPE_ROUTER, 0);
5626 continue; /* with the next new address */
5629 else if (!testflag(addr, af_allow_reply))
5631 addr->basic_errno = ERRNO_FORBIDREPLY;
5632 addr->message = US"autoreply forbidden";
5633 (void)post_process_one(addr, FAIL, LOG_MAIN, DTYPE_ROUTER, 0);
5634 continue; /* with the next new address */
5637 /* If the errno field is already set to BADTRANSPORT, it indicates
5638 failure to expand a transport string, or find the associated transport,
5639 or an unset transport when one is required. Leave this test till now so
5640 that the forbid errors are given in preference. */
5642 if (addr->basic_errno == ERRNO_BADTRANSPORT)
5644 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_ROUTER, 0);
5648 /* Treat /dev/null as a special case and abandon the delivery. This
5649 avoids having to specify a uid on the transport just for this case.
5650 Arrange for the transport name to be logged as "**bypassed**". */
5652 if (Ustrcmp(addr->address, "/dev/null") == 0)
5654 uschar *save = addr->transport->name;
5655 addr->transport->name = US"**bypassed**";
5656 (void)post_process_one(addr, OK, LOG_MAIN, DTYPE_TRANSPORT, '=');
5657 addr->transport->name = save;
5658 continue; /* with the next new address */
5661 /* Pipe, file, or autoreply delivery is to go ahead as a normal local
5664 DEBUG(D_deliver|D_route)
5665 debug_printf("queued for %s transport\n", addr->transport->name);
5666 addr->next = addr_local;
5668 continue; /* with the next new address */
5671 /* Handle normal addresses. First, split up into local part and domain,
5672 handling the %-hack if necessary. There is the possibility of a defer from
5673 a lookup in percent_hack_domains. */
5675 if ((rc = deliver_split_address(addr)) == DEFER)
5677 addr->message = US"cannot check percent_hack_domains";
5678 addr->basic_errno = ERRNO_LISTDEFER;
5679 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_NONE, 0);
5683 /* Check to see if the domain is held. If so, proceed only if the
5684 delivery was forced by hand. */
5686 deliver_domain = addr->domain; /* set $domain */
5687 if (!forced && hold_domains != NULL &&
5688 (rc = match_isinlist(addr->domain, &hold_domains, 0,
5689 &domainlist_anchor, addr->domain_cache, MCL_DOMAIN, TRUE,
5694 addr->message = US"hold_domains lookup deferred";
5695 addr->basic_errno = ERRNO_LISTDEFER;
5699 addr->message = US"domain is held";
5700 addr->basic_errno = ERRNO_HELD;
5702 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_NONE, 0);
5706 /* Now we can check for duplicates and previously delivered addresses. In
5707 order to do this, we have to generate a "unique" value for each address,
5708 because there may be identical actual addresses in a line of descendents.
5709 The "unique" field is initialized to the same value as the "address" field,
5710 but gets changed here to cope with identically-named descendents. */
5712 for (parent = addr->parent; parent != NULL; parent = parent->parent)
5713 if (strcmpic(addr->address, parent->address) == 0) break;
5715 /* If there's an ancestor with the same name, set the homonym flag. This
5716 influences how deliveries are recorded. Then add a prefix on the front of
5717 the unique address. We use \n\ where n starts at 0 and increases each time.
5718 It is unlikely to pass 9, but if it does, it may look odd but will still
5719 work. This means that siblings or cousins with the same names are treated
5720 as duplicates, which is what we want. */
5724 setflag(addr, af_homonym);
5725 if (parent->unique[0] != '\\')
5726 addr->unique = string_sprintf("\\0\\%s", addr->address);
5728 addr->unique = string_sprintf("\\%c\\%s", parent->unique[1] + 1,
5732 /* Ensure that the domain in the unique field is lower cased, because
5733 domains are always handled caselessly. */
5735 p = Ustrrchr(addr->unique, '@');
5736 while (*p != 0) { *p = tolower(*p); p++; }
5738 DEBUG(D_deliver|D_route) debug_printf("unique = %s\n", addr->unique);
5740 if (tree_search(tree_nonrecipients, addr->unique) != NULL)
5742 DEBUG(D_deliver|D_route)
5743 debug_printf("%s was previously delivered: discarded\n", addr->unique);
5744 child_done(addr, tod_stamp(tod_log));
5748 /* Get the routing retry status, saving the two retry keys (with and
5749 without the local part) for subsequent use. If there is no retry record for
5750 the standard address routing retry key, we look for the same key with the
5751 sender attached, because this form is used by the smtp transport after a
5752 4xx response to RCPT when address_retry_include_sender is true. */
5754 addr->domain_retry_key = string_sprintf("R:%s", addr->domain);
5755 addr->address_retry_key = string_sprintf("R:%s@%s", addr->local_part,
5758 if (dbm_file == NULL)
5759 domain_retry_record = address_retry_record = NULL;
5762 domain_retry_record = dbfn_read(dbm_file, addr->domain_retry_key);
5763 if (domain_retry_record != NULL &&
5764 now - domain_retry_record->time_stamp > retry_data_expire)
5765 domain_retry_record = NULL; /* Ignore if too old */
5767 address_retry_record = dbfn_read(dbm_file, addr->address_retry_key);
5768 if (address_retry_record != NULL &&
5769 now - address_retry_record->time_stamp > retry_data_expire)
5770 address_retry_record = NULL; /* Ignore if too old */
5772 if (address_retry_record == NULL)
5774 uschar *altkey = string_sprintf("%s:<%s>", addr->address_retry_key,
5776 address_retry_record = dbfn_read(dbm_file, altkey);
5777 if (address_retry_record != NULL &&
5778 now - address_retry_record->time_stamp > retry_data_expire)
5779 address_retry_record = NULL; /* Ignore if too old */
5783 DEBUG(D_deliver|D_retry)
5785 if (domain_retry_record == NULL)
5786 debug_printf("no domain retry record\n");
5787 if (address_retry_record == NULL)
5788 debug_printf("no address retry record\n");
5791 /* If we are sending a message down an existing SMTP connection, we must
5792 assume that the message which created the connection managed to route
5793 an address to that connection. We do not want to run the risk of taking
5794 a long time over routing here, because if we do, the server at the other
5795 end of the connection may time it out. This is especially true for messages
5796 with lots of addresses. For this kind of delivery, queue_running is not
5797 set, so we would normally route all addresses. We take a pragmatic approach
5798 and defer routing any addresses that have any kind of domain retry record.
5799 That is, we don't even look at their retry times. It doesn't matter if this
5800 doesn't work occasionally. This is all just an optimization, after all.
5802 The reason for not doing the same for address retries is that they normally
5803 arise from 4xx responses, not DNS timeouts. */
5805 if (continue_hostname != NULL && domain_retry_record != NULL)
5807 addr->message = US"reusing SMTP connection skips previous routing defer";
5808 addr->basic_errno = ERRNO_RRETRY;
5809 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_ROUTER, 0);
5812 /* If we are in a queue run, defer routing unless there is no retry data or
5813 we've passed the next retry time, or this message is forced. In other
5814 words, ignore retry data when not in a queue run.
5816 However, if the domain retry time has expired, always allow the routing
5817 attempt. If it fails again, the address will be failed. This ensures that
5818 each address is routed at least once, even after long-term routing
5821 If there is an address retry, check that too; just wait for the next
5822 retry time. This helps with the case when the temporary error on the
5823 address was really message-specific rather than address specific, since
5824 it allows other messages through.
5826 We also wait for the next retry time if this is a message sent down an
5827 existing SMTP connection (even though that will be forced). Otherwise there
5828 will be far too many attempts for an address that gets a 4xx error. In
5829 fact, after such an error, we should not get here because, the host should
5830 not be remembered as one this message needs. However, there was a bug that
5831 used to cause this to happen, so it is best to be on the safe side.
5833 Even if we haven't reached the retry time in the hints, there is one more
5834 check to do, which is for the ultimate address timeout. We only do this
5835 check if there is an address retry record and there is not a domain retry
5836 record; this implies that previous attempts to handle the address had the
5837 retry_use_local_parts option turned on. We use this as an approximation
5838 for the destination being like a local delivery, for example delivery over
5839 LMTP to an IMAP message store. In this situation users are liable to bump
5840 into their quota and thereby have intermittently successful deliveries,
5841 which keep the retry record fresh, which can lead to us perpetually
5842 deferring messages. */
5844 else if (((queue_running && !deliver_force) || continue_hostname != NULL)
5846 ((domain_retry_record != NULL &&
5847 now < domain_retry_record->next_try &&
5848 !domain_retry_record->expired)
5850 (address_retry_record != NULL &&
5851 now < address_retry_record->next_try))
5853 (domain_retry_record != NULL ||
5854 address_retry_record == NULL ||
5855 !retry_ultimate_address_timeout(addr->address_retry_key,
5856 addr->domain, address_retry_record, now)))
5858 addr->message = US"retry time not reached";
5859 addr->basic_errno = ERRNO_RRETRY;
5860 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_ROUTER, 0);
5863 /* The domain is OK for routing. Remember if retry data exists so it
5864 can be cleaned up after a successful delivery. */
5868 if (domain_retry_record != NULL || address_retry_record != NULL)
5869 setflag(addr, af_dr_retry_exists);
5870 addr->next = addr_route;
5872 DEBUG(D_deliver|D_route)
5873 debug_printf("%s: queued for routing\n", addr->address);
5877 /* The database is closed while routing is actually happening. Requests to
5878 update it are put on a chain and all processed together at the end. */
5880 if (dbm_file != NULL) dbfn_close(dbm_file);
5882 /* If queue_domains is set, we don't even want to try routing addresses in
5883 those domains. During queue runs, queue_domains is forced to be unset.
5884 Optimize by skipping this pass through the addresses if nothing is set. */
5886 if (!deliver_force && queue_domains != NULL)
5888 address_item *okaddr = NULL;
5889 while (addr_route != NULL)
5891 address_item *addr = addr_route;
5892 addr_route = addr->next;
5894 deliver_domain = addr->domain; /* set $domain */
5895 if ((rc = match_isinlist(addr->domain, &queue_domains, 0,
5896 &domainlist_anchor, addr->domain_cache, MCL_DOMAIN, TRUE, NULL))
5901 addr->basic_errno = ERRNO_LISTDEFER;
5902 addr->message = US"queue_domains lookup deferred";
5903 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_ROUTER, 0);
5907 addr->next = okaddr;
5913 addr->basic_errno = ERRNO_QUEUE_DOMAIN;
5914 addr->message = US"domain is in queue_domains";
5915 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_ROUTER, 0);
5919 addr_route = okaddr;
5922 /* Now route those addresses that are not deferred. */
5924 while (addr_route != NULL)
5927 address_item *addr = addr_route;
5928 uschar *old_domain = addr->domain;
5929 uschar *old_unique = addr->unique;
5930 addr_route = addr->next;
5933 /* Just in case some router parameter refers to it. */
5935 return_path = (addr->p.errors_address != NULL)?
5936 addr->p.errors_address : sender_address;
5938 /* If a router defers an address, add a retry item. Whether or not to
5939 use the local part in the key is a property of the router. */
5941 if ((rc = route_address(addr, &addr_local, &addr_remote, &addr_new,
5942 &addr_succeed, v_none)) == DEFER)
5943 retry_add_item(addr, (addr->router->retry_use_local_part)?
5944 string_sprintf("R:%s@%s", addr->local_part, addr->domain) :
5945 string_sprintf("R:%s", addr->domain), 0);
5947 /* Otherwise, if there is an existing retry record in the database, add
5948 retry items to delete both forms. We must also allow for the possibility
5949 of a routing retry that includes the sender address. Since the domain might
5950 have been rewritten (expanded to fully qualified) as a result of routing,
5951 ensure that the rewritten form is also deleted. */
5953 else if (testflag(addr, af_dr_retry_exists))
5955 uschar *altkey = string_sprintf("%s:<%s>", addr->address_retry_key,
5957 retry_add_item(addr, altkey, rf_delete);
5958 retry_add_item(addr, addr->address_retry_key, rf_delete);
5959 retry_add_item(addr, addr->domain_retry_key, rf_delete);
5960 if (Ustrcmp(addr->domain, old_domain) != 0)
5961 retry_add_item(addr, string_sprintf("R:%s", old_domain), rf_delete);
5964 /* DISCARD is given for :blackhole: and "seen finish". The event has been
5965 logged, but we need to ensure the address (and maybe parents) is marked
5970 address_done(addr, tod_stamp(tod_log));
5971 continue; /* route next address */
5974 /* The address is finished with (failed or deferred). */
5978 (void)post_process_one(addr, rc, LOG_MAIN, DTYPE_ROUTER, 0);
5979 continue; /* route next address */
5982 /* The address has been routed. If the router changed the domain, it will
5983 also have changed the unique address. We have to test whether this address
5984 has already been delivered, because it's the unique address that finally
5987 if (addr->unique != old_unique &&
5988 tree_search(tree_nonrecipients, addr->unique) != 0)
5990 DEBUG(D_deliver|D_route) debug_printf("%s was previously delivered: "
5991 "discarded\n", addr->address);
5992 if (addr_remote == addr) addr_remote = addr->next;
5993 else if (addr_local == addr) addr_local = addr->next;
5996 /* If the router has same_domain_copy_routing set, we are permitted to copy
5997 the routing for any other addresses with the same domain. This is an
5998 optimisation to save repeated DNS lookups for "standard" remote domain
5999 routing. The option is settable only on routers that generate host lists.
6000 We play it very safe, and do the optimization only if the address is routed
6001 to a remote transport, there are no header changes, and the domain was not
6002 modified by the router. */
6004 if (addr_remote == addr &&
6005 addr->router->same_domain_copy_routing &&
6006 addr->p.extra_headers == NULL &&
6007 addr->p.remove_headers == NULL &&
6008 old_domain == addr->domain)
6010 address_item **chain = &addr_route;
6011 while (*chain != NULL)
6013 address_item *addr2 = *chain;
6014 if (Ustrcmp(addr2->domain, addr->domain) != 0)
6016 chain = &(addr2->next);
6020 /* Found a suitable address; take it off the routing list and add it to
6021 the remote delivery list. */
6023 *chain = addr2->next;
6024 addr2->next = addr_remote;
6025 addr_remote = addr2;
6027 /* Copy the routing data */
6029 addr2->domain = addr->domain;
6030 addr2->router = addr->router;
6031 addr2->transport = addr->transport;
6032 addr2->host_list = addr->host_list;
6033 addr2->fallback_hosts = addr->fallback_hosts;
6034 addr2->p.errors_address = addr->p.errors_address;
6035 copyflag(addr2, addr, af_hide_child | af_local_host_removed);
6037 DEBUG(D_deliver|D_route)
6039 debug_printf(">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>\n"
6041 "Routing for %s copied from %s\n",
6042 addr2->address, addr2->address, addr->address);
6046 } /* Continue with routing the next address. */
6047 } /* Loop to process any child addresses that the routers created, and
6048 any rerouted addresses that got put back on the new chain. */
6051 /* Debugging: show the results of the routing */
6053 DEBUG(D_deliver|D_retry|D_route)
6055 address_item *p = addr_local;
6056 debug_printf(">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>\n");
6057 debug_printf("After routing:\n Local deliveries:\n");
6060 debug_printf(" %s\n", p->address);
6065 debug_printf(" Remote deliveries:\n");
6068 debug_printf(" %s\n", p->address);
6073 debug_printf(" Failed addresses:\n");
6076 debug_printf(" %s\n", p->address);
6081 debug_printf(" Deferred addresses:\n");
6084 debug_printf(" %s\n", p->address);
6089 /* Free any resources that were cached during routing. */
6094 /* These two variables are set only during routing, after check_local_user.
6095 Ensure they are not set in transports. */
6097 local_user_gid = (gid_t)(-1);
6098 local_user_uid = (uid_t)(-1);
6100 /* Check for any duplicate addresses. This check is delayed until after
6101 routing, because the flexibility of the routing configuration means that
6102 identical addresses with different parentage may end up being redirected to
6103 different addresses. Checking for duplicates too early (as we previously used
6104 to) makes this kind of thing not work. */
6106 do_duplicate_check(&addr_local);
6107 do_duplicate_check(&addr_remote);
6109 /* When acting as an MUA wrapper, we proceed only if all addresses route to a
6110 remote transport. The check that they all end up in one transaction happens in
6111 the do_remote_deliveries() function. */
6113 if (mua_wrapper && (addr_local != NULL || addr_failed != NULL ||
6114 addr_defer != NULL))
6117 uschar *which, *colon, *msg;
6119 if (addr_local != NULL)
6124 else if (addr_defer != NULL)
6127 which = US"deferred";
6135 while (addr->parent != NULL) addr = addr->parent;
6137 if (addr->message != NULL)
6140 msg = addr->message;
6142 else colon = msg = US"";
6144 /* We don't need to log here for a forced failure as it will already
6145 have been logged. Defer will also have been logged, but as a defer, so we do
6146 need to do the failure logging. */
6148 if (addr != addr_failed)
6149 log_write(0, LOG_MAIN, "** %s routing yielded a %s delivery",
6150 addr->address, which);
6152 /* Always write an error to the caller */
6154 fprintf(stderr, "routing %s yielded a %s delivery%s%s\n", addr->address,
6157 final_yield = DELIVER_MUA_FAILED;
6158 addr_failed = addr_defer = NULL; /* So that we remove the message */
6159 goto DELIVERY_TIDYUP;
6163 /* If this is a run to continue deliveries to an external channel that is
6164 already set up, defer any local deliveries. */
6166 if (continue_transport != NULL)
6168 if (addr_defer == NULL) addr_defer = addr_local; else
6170 address_item *addr = addr_defer;
6171 while (addr->next != NULL) addr = addr->next;
6172 addr->next = addr_local;
6178 /* Because address rewriting can happen in the routers, we should not really do
6179 ANY deliveries until all addresses have been routed, so that all recipients of
6180 the message get the same headers. However, this is in practice not always
6181 possible, since sometimes remote addresses give DNS timeouts for days on end.
6182 The pragmatic approach is to deliver what we can now, saving any rewritten
6183 headers so that at least the next lot of recipients benefit from the rewriting
6184 that has already been done.
6186 If any headers have been rewritten during routing, update the spool file to
6187 remember them for all subsequent deliveries. This can be delayed till later if
6188 there is only address to be delivered - if it succeeds the spool write need not
6191 if (header_rewritten &&
6192 ((addr_local != NULL &&
6193 (addr_local->next != NULL || addr_remote != NULL)) ||
6194 (addr_remote != NULL && addr_remote->next != NULL)))
6196 /* Panic-dies on error */
6197 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
6198 header_rewritten = FALSE;
6202 /* If there are any deliveries to be done, open the journal file. This is used
6203 to record successful deliveries as soon as possible after each delivery is
6204 known to be complete. A file opened with O_APPEND is used so that several
6205 processes can run simultaneously.
6207 The journal is just insurance against crashes. When the spool file is
6208 ultimately updated at the end of processing, the journal is deleted. If a
6209 journal is found to exist at the start of delivery, the addresses listed
6210 therein are added to the non-recipients. */
6212 if (addr_local != NULL || addr_remote != NULL)
6214 sprintf(CS spoolname, "%s/input/%s/%s-J", spool_directory, message_subdir, id);
6215 journal_fd = Uopen(spoolname, O_WRONLY|O_APPEND|O_CREAT, SPOOL_MODE);
6219 log_write(0, LOG_MAIN|LOG_PANIC, "Couldn't open journal file %s: %s",
6220 spoolname, strerror(errno));
6221 return DELIVER_NOT_ATTEMPTED;
6224 /* Set the close-on-exec flag, make the file owned by Exim, and ensure
6225 that the mode is correct - the group setting doesn't always seem to get
6226 set automatically. */
6228 if( fcntl(journal_fd, F_SETFD, fcntl(journal_fd, F_GETFD) | FD_CLOEXEC)
6229 || fchown(journal_fd, exim_uid, exim_gid)
6230 || fchmod(journal_fd, SPOOL_MODE)
6233 int ret = Uunlink(spoolname);
6234 log_write(0, LOG_MAIN|LOG_PANIC, "Couldn't set perms on journal file %s: %s",
6235 spoolname, strerror(errno));
6236 if(ret && errno != ENOENT)
6237 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s",
6238 spoolname, strerror(errno));
6239 return DELIVER_NOT_ATTEMPTED;
6245 /* Now we can get down to the business of actually doing deliveries. Local
6246 deliveries are done first, then remote ones. If ever the problems of how to
6247 handle fallback transports are figured out, this section can be put into a loop
6248 for handling fallbacks, though the uid switching will have to be revised. */
6250 /* Precompile a regex that is used to recognize a parameter in response
6251 to an LHLO command, if is isn't already compiled. This may be used on both
6252 local and remote LMTP deliveries. */
6254 if (regex_IGNOREQUOTA == NULL) regex_IGNOREQUOTA =
6255 regex_must_compile(US"\\n250[\\s\\-]IGNOREQUOTA(\\s|\\n|$)", FALSE, TRUE);
6257 /* Handle local deliveries */
6259 if (addr_local != NULL)
6261 DEBUG(D_deliver|D_transport)
6262 debug_printf(">>>>>>>>>>>>>>>> Local deliveries >>>>>>>>>>>>>>>>\n");
6263 do_local_deliveries();
6264 disable_logging = FALSE;
6267 /* If queue_run_local is set, we do not want to attempt any remote deliveries,
6268 so just queue them all. */
6270 if (queue_run_local)
6272 while (addr_remote != NULL)
6274 address_item *addr = addr_remote;
6275 addr_remote = addr->next;
6277 addr->basic_errno = ERRNO_LOCAL_ONLY;
6278 addr->message = US"remote deliveries suppressed";
6279 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_TRANSPORT, 0);
6283 /* Handle remote deliveries */
6285 if (addr_remote != NULL)
6287 DEBUG(D_deliver|D_transport)
6288 debug_printf(">>>>>>>>>>>>>>>> Remote deliveries >>>>>>>>>>>>>>>>\n");
6290 /* Precompile some regex that are used to recognize parameters in response
6291 to an EHLO command, if they aren't already compiled. */
6293 if (regex_PIPELINING == NULL) regex_PIPELINING =
6294 regex_must_compile(US"\\n250[\\s\\-]PIPELINING(\\s|\\n|$)", FALSE, TRUE);
6296 if (regex_SIZE == NULL) regex_SIZE =
6297 regex_must_compile(US"\\n250[\\s\\-]SIZE(\\s|\\n|$)", FALSE, TRUE);
6299 if (regex_AUTH == NULL) regex_AUTH =
6300 regex_must_compile(US"\\n250[\\s\\-]AUTH\\s+([\\-\\w\\s]+)(?:\\n|$)",
6304 if (regex_STARTTLS == NULL) regex_STARTTLS =
6305 regex_must_compile(US"\\n250[\\s\\-]STARTTLS(\\s|\\n|$)", FALSE, TRUE);
6308 #ifndef DISABLE_PRDR
6309 if (regex_PRDR == NULL) regex_PRDR =
6310 regex_must_compile(US"\\n250[\\s\\-]PRDR(\\s|\\n|$)", FALSE, TRUE);
6313 #ifdef EXPERIMENTAL_DSN
6314 /* Set the regex to check for DSN support on remote MTA */
6315 if (regex_DSN == NULL) regex_DSN =
6316 regex_must_compile(US"\\n250[\\s\\-]DSN(\\s|\\n|$)", FALSE, TRUE);
6319 /* Now sort the addresses if required, and do the deliveries. The yield of
6320 do_remote_deliveries is FALSE when mua_wrapper is set and all addresses
6321 cannot be delivered in one transaction. */
6323 if (remote_sort_domains != NULL) sort_remote_deliveries();
6324 if (!do_remote_deliveries(FALSE))
6326 log_write(0, LOG_MAIN, "** mua_wrapper is set but recipients cannot all "
6327 "be delivered in one transaction");
6328 fprintf(stderr, "delivery to smarthost failed (configuration problem)\n");
6330 final_yield = DELIVER_MUA_FAILED;
6331 addr_failed = addr_defer = NULL; /* So that we remove the message */
6332 goto DELIVERY_TIDYUP;
6335 /* See if any of the addresses that failed got put on the queue for delivery
6336 to their fallback hosts. We do it this way because often the same fallback
6337 host is used for many domains, so all can be sent in a single transaction
6338 (if appropriately configured). */
6340 if (addr_fallback != NULL && !mua_wrapper)
6342 DEBUG(D_deliver) debug_printf("Delivering to fallback hosts\n");
6343 addr_remote = addr_fallback;
6344 addr_fallback = NULL;
6345 if (remote_sort_domains != NULL) sort_remote_deliveries();
6346 do_remote_deliveries(TRUE);
6348 disable_logging = FALSE;
6352 /* All deliveries are now complete. Ignore SIGTERM during this tidying up
6353 phase, to minimize cases of half-done things. */
6356 debug_printf(">>>>>>>>>>>>>>>> deliveries are done >>>>>>>>>>>>>>>>\n");
6358 /* Root privilege is no longer needed */
6360 exim_setugid(exim_uid, exim_gid, FALSE, US"post-delivery tidying");
6362 set_process_info("tidying up after delivering %s", message_id);
6363 signal(SIGTERM, SIG_IGN);
6365 /* When we are acting as an MUA wrapper, the smtp transport will either have
6366 succeeded for all addresses, or failed them all in normal cases. However, there
6367 are some setup situations (e.g. when a named port does not exist) that cause an
6368 immediate exit with deferral of all addresses. Convert those into failures. We
6369 do not ever want to retry, nor do we want to send a bounce message. */
6373 if (addr_defer != NULL)
6375 address_item *addr, *nextaddr;
6376 for (addr = addr_defer; addr != NULL; addr = nextaddr)
6378 log_write(0, LOG_MAIN, "** %s mua_wrapper forced failure for deferred "
6379 "delivery", addr->address);
6380 nextaddr = addr->next;
6381 addr->next = addr_failed;
6387 /* Now all should either have succeeded or failed. */
6389 if (addr_failed == NULL) final_yield = DELIVER_MUA_SUCCEEDED; else
6391 uschar *s = (addr_failed->user_message != NULL)?
6392 addr_failed->user_message : addr_failed->message;
6394 fprintf(stderr, "Delivery failed: ");
6395 if (addr_failed->basic_errno > 0)
6397 fprintf(stderr, "%s", strerror(addr_failed->basic_errno));
6398 if (s != NULL) fprintf(stderr, ": ");
6402 if (addr_failed->basic_errno <= 0) fprintf(stderr, "unknown error");
6404 else fprintf(stderr, "%s", CS s);
6405 fprintf(stderr, "\n");
6407 final_yield = DELIVER_MUA_FAILED;
6412 /* In a normal configuration, we now update the retry database. This is done in
6413 one fell swoop at the end in order not to keep opening and closing (and
6414 locking) the database. The code for handling retries is hived off into a
6415 separate module for convenience. We pass it the addresses of the various
6416 chains, because deferred addresses can get moved onto the failed chain if the
6417 retry cutoff time has expired for all alternative destinations. Bypass the
6418 updating of the database if the -N flag is set, which is a debugging thing that
6419 prevents actual delivery. */
6421 else if (!dont_deliver) retry_update(&addr_defer, &addr_failed, &addr_succeed);
6423 #ifdef EXPERIMENTAL_DSN
6424 /* Send DSN for successful messages */
6425 addr_dsntmp = addr_succeed;
6426 addr_senddsn = NULL;
6428 while(addr_dsntmp != NULL)
6431 debug_printf("DSN: processing router : %s\n", addr_dsntmp->router->name);
6434 debug_printf("DSN: processing successful delivery address: %s\n", addr_dsntmp->address);
6436 /* af_ignore_error not honored here. it's not an error */
6438 DEBUG(D_deliver) debug_printf("DSN: Sender_address: %s\n", sender_address);
6439 DEBUG(D_deliver) debug_printf("DSN: orcpt: %s flags: %d\n", addr_dsntmp->dsn_orcpt, addr_dsntmp->dsn_flags);
6440 DEBUG(D_deliver) debug_printf("DSN: envid: %s ret: %d\n", dsn_envid, dsn_ret);
6441 DEBUG(D_deliver) debug_printf("DSN: Final recipient: %s\n", addr_dsntmp->address);
6442 DEBUG(D_deliver) debug_printf("DSN: Remote SMTP server supports DSN: %d\n", addr_dsntmp->dsn_aware);
6444 /* send report if next hop not DSN aware or a router flagged "last DSN hop"
6445 and a report was requested */
6446 if (((addr_dsntmp->dsn_aware != dsn_support_yes) ||
6447 ((addr_dsntmp->dsn_flags & rf_dsnlasthop) != 0))
6449 (((addr_dsntmp->dsn_flags & rf_dsnflags) != 0) &&
6450 ((addr_dsntmp->dsn_flags & rf_notify_success) != 0)))
6452 /* copy and relink address_item and send report with all of them at once later */
6453 address_item *addr_next;
6454 addr_next = addr_senddsn;
6455 addr_senddsn = store_get(sizeof(address_item));
6456 memcpy(addr_senddsn, addr_dsntmp, sizeof(address_item));
6457 addr_senddsn->next = addr_next;
6461 DEBUG(D_deliver) debug_printf("DSN: *** NOT SENDING DSN SUCCESS Message ***\n");
6464 addr_dsntmp = addr_dsntmp->next;
6467 if (addr_senddsn != NULL)
6472 /* create exim process to send message */
6473 pid = child_open_exim(&fd);
6475 DEBUG(D_deliver) debug_printf("DSN: child_open_exim returns: %d\n", pid);
6477 if (pid < 0) /* Creation of child failed */
6479 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Process %d (parent %d) failed to "
6480 "create child process to send failure message: %s", getpid(),
6481 getppid(), strerror(errno));
6483 DEBUG(D_deliver) debug_printf("DSN: child_open_exim failed\n");
6486 else /* Creation of child succeeded */
6488 FILE *f = fdopen(fd, "wb");
6489 /* header only as required by RFC. only failure DSN needs to honor RET=FULL */
6490 int topt = topt_add_return_path | topt_no_body;
6491 uschar boundaryStr[64];
6493 DEBUG(D_deliver) debug_printf("sending error message to: %s\n", sender_address);
6495 /* build unique id for MIME boundary */
6496 snprintf(boundaryStr, sizeof(boundaryStr)-1, TIME_T_FMT "-eximdsn-%d",
6497 time(NULL), rand());
6498 DEBUG(D_deliver) debug_printf("DSN: MIME boundary: %s\n", boundaryStr);
6500 if (errors_reply_to != NULL) fprintf(f,"Reply-To: %s\n", errors_reply_to);
6502 fprintf(f,"Auto-Submitted: auto-generated\n");
6503 fprintf(f,"From: Mail Delivery System <Mailer-Daemon@%s>\n", qualify_domain_sender);
6504 fprintf(f,"To: %s\n", sender_address);
6505 fprintf(f,"Subject: Delivery Status Notification\n");
6506 fprintf(f,"Content-Type: multipart/report; report-type=delivery-status; boundary=%s\n", boundaryStr);
6507 fprintf(f,"MIME-Version: 1.0\n\n");
6509 fprintf(f,"--%s\n", boundaryStr);
6510 fprintf(f,"Content-type: text/plain; charset=us-ascii\n\n");
6512 fprintf(f,"This message was created automatically by mail delivery software.\n");
6513 fprintf(f," ----- The following addresses had successful delivery notifications -----\n");
6515 addr_dsntmp = addr_senddsn;
6516 while(addr_dsntmp != NULL)
6518 if ((addr_dsntmp->dsn_flags & rf_dsnlasthop) == 1) {
6519 fprintf(f,"<%s> (relayed via non DSN router)\n\n", addr_dsntmp->address);
6521 else if (addr_dsntmp->dsn_aware == dsn_support_no) {
6522 fprintf(f,"<%s> (relayed to non-DSN-aware mailer)\n\n", addr_dsntmp->address);
6525 fprintf(f,"<%s> (relayed via non \"Remote SMTP\" router)\n\n", addr_dsntmp->address);
6527 addr_dsntmp = addr_dsntmp->next;
6529 fprintf(f,"--%s\n", boundaryStr);
6530 fprintf(f,"Content-type: message/delivery-status\n\n");
6532 fprintf(f,"Reporting-MTA: dns; %s\n", smtp_active_hostname);
6533 if (dsn_envid != NULL) {
6534 /* must be decoded from xtext: see RFC 3461:6.3a */
6536 if (auth_xtextdecode(dsn_envid, &xdec_envid) > 0)
6537 fprintf(f,"Original-Envelope-ID: %s\n", dsn_envid);
6539 fprintf(f,"X-Original-Envelope-ID: error decoding xtext formated ENVID\n");
6543 addr_dsntmp = addr_senddsn;
6544 while(addr_dsntmp != NULL)
6546 if (addr_dsntmp->dsn_orcpt != NULL) {
6547 fprintf(f,"Original-Recipient: %s\n", addr_dsntmp->dsn_orcpt);
6549 fprintf(f,"Action: delivered\n");
6550 fprintf(f,"Final-Recipient: rfc822;%s\n", addr_dsntmp->address);
6551 fprintf(f,"Status: 2.0.0\n");
6552 if ((addr_dsntmp->host_used != NULL) && (addr_dsntmp->host_used->name != NULL))
6553 fprintf(f,"Remote-MTA: dns; %s\nDiagnostic-Code: smtp; 250 Ok\n", addr_dsntmp->host_used->name);
6555 if ((addr_dsntmp->dsn_flags & rf_dsnlasthop) == 1)
6556 fprintf(f,"Diagnostic-Code: X-Exim; relayed via non DSN router\n");
6558 fprintf(f,"Diagnostic-Code: X-Exim; relayed via non SMTP router\n");
6560 addr_dsntmp = addr_dsntmp->next;
6563 fprintf(f,"--%s\n", boundaryStr);
6564 fprintf(f,"Content-type: text/rfc822-headers\n\n");
6567 transport_filter_argv = NULL; /* Just in case */
6568 return_path = sender_address; /* In case not previously set */
6570 /* Write the original email out */
6571 transport_write_message(NULL, fileno(f), topt, 0, NULL, NULL, NULL, NULL, NULL, 0);
6575 fprintf(f,"--%s--\n", boundaryStr);
6579 rc = child_close(pid, 0); /* Waits for child to close, no timeout */
6584 /* If any addresses failed, we must send a message to somebody, unless
6585 af_ignore_error is set, in which case no action is taken. It is possible for
6586 several messages to get sent if there are addresses with different
6589 while (addr_failed != NULL)
6593 uschar *logtod = tod_stamp(tod_log);
6595 address_item *handled_addr = NULL;
6596 address_item **paddr;
6597 address_item *msgchain = NULL;
6598 address_item **pmsgchain = &msgchain;
6600 /* There are weird cases when logging is disabled in the transport. However,
6601 there may not be a transport (address failed by a router). */
6603 disable_logging = FALSE;
6604 if (addr_failed->transport != NULL)
6605 disable_logging = addr_failed->transport->disable_logging;
6608 debug_printf("processing failed address %s\n", addr_failed->address);
6610 /* There are only two ways an address in a bounce message can get here:
6612 (1) When delivery was initially deferred, but has now timed out (in the call
6613 to retry_update() above). We can detect this by testing for
6614 af_retry_timedout. If the address does not have its own errors address,
6615 we arrange to ignore the error.
6617 (2) If delivery failures for bounce messages are being ignored. We can detect
6618 this by testing for af_ignore_error. This will also be set if a bounce
6619 message has been autothawed and the ignore_bounce_errors_after time has
6620 passed. It might also be set if a router was explicitly configured to
6621 ignore errors (errors_to = "").
6623 If neither of these cases obtains, something has gone wrong. Log the
6624 incident, but then ignore the error. */
6626 if (sender_address[0] == 0 && addr_failed->p.errors_address == NULL)
6628 if (!testflag(addr_failed, af_retry_timedout) &&
6629 !testflag(addr_failed, af_ignore_error))
6631 log_write(0, LOG_MAIN|LOG_PANIC, "internal error: bounce message "
6632 "failure is neither frozen nor ignored (it's been ignored)");
6634 setflag(addr_failed, af_ignore_error);
6637 /* If the first address on the list has af_ignore_error set, just remove
6638 it from the list, throw away any saved message file, log it, and
6639 mark the recipient done. */
6641 if (testflag(addr_failed, af_ignore_error)
6642 #ifdef EXPERIMENTAL_DSN
6643 || (((addr_failed->dsn_flags & rf_dsnflags) != 0)
6644 && ((addr_failed->dsn_flags & rf_notify_failure) != rf_notify_failure))
6649 addr_failed = addr->next;
6650 if (addr->return_filename != NULL) Uunlink(addr->return_filename);
6652 log_write(0, LOG_MAIN, "%s%s%s%s: error ignored",
6654 (addr->parent == NULL)? US"" : US" <",
6655 (addr->parent == NULL)? US"" : addr->parent->address,
6656 (addr->parent == NULL)? US"" : US">");
6658 address_done(addr, logtod);
6659 child_done(addr, logtod);
6660 /* Panic-dies on error */
6661 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
6664 /* Otherwise, handle the sending of a message. Find the error address for
6665 the first address, then send a message that includes all failed addresses
6666 that have the same error address. Note the bounce_recipient is a global so
6667 that it can be accesssed by $bounce_recipient while creating a customized
6672 bounce_recipient = (addr_failed->p.errors_address == NULL)?
6673 sender_address : addr_failed->p.errors_address;
6675 /* Make a subprocess to send a message */
6677 pid = child_open_exim(&fd);
6679 /* Creation of child failed */
6682 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Process %d (parent %d) failed to "
6683 "create child process to send failure message: %s", getpid(),
6684 getppid(), strerror(errno));
6686 /* Creation of child succeeded */
6693 uschar *bcc, *emf_text;
6694 FILE *f = fdopen(fd, "wb");
6696 BOOL to_sender = strcmpic(sender_address, bounce_recipient) == 0;
6697 int max = (bounce_return_size_limit/DELIVER_IN_BUFFER_SIZE + 1) *
6698 DELIVER_IN_BUFFER_SIZE;
6701 debug_printf("sending error message to: %s\n", bounce_recipient);
6703 /* Scan the addresses for all that have the same errors address, removing
6704 them from the addr_failed chain, and putting them on msgchain. */
6706 paddr = &addr_failed;
6707 for (addr = addr_failed; addr != NULL; addr = *paddr)
6709 if (Ustrcmp(bounce_recipient, (addr->p.errors_address == NULL)?
6710 sender_address : addr->p.errors_address) != 0)
6712 paddr = &(addr->next); /* Not the same; skip */
6714 else /* The same - dechain */
6716 *paddr = addr->next;
6719 pmsgchain = &(addr->next);
6723 /* Include X-Failed-Recipients: for automatic interpretation, but do
6724 not let any one header line get too long. We do this by starting a
6725 new header every 50 recipients. Omit any addresses for which the
6726 "hide_child" flag is set. */
6728 for (addr = msgchain; addr != NULL; addr = addr->next)
6730 if (testflag(addr, af_hide_child)) continue;
6737 (rcount++ == 0)? "X-Failed-Recipients: " : ",\n ",
6738 (testflag(addr, af_pfr) && addr->parent != NULL)?
6739 string_printing(addr->parent->address) :
6740 string_printing(addr->address));
6742 if (rcount > 0) fprintf(f, "\n");
6744 /* Output the standard headers */
6746 if (errors_reply_to != NULL)
6747 fprintf(f, "Reply-To: %s\n", errors_reply_to);
6748 fprintf(f, "Auto-Submitted: auto-replied\n");
6750 fprintf(f, "To: %s\n", bounce_recipient);
6752 #ifdef EXPERIMENTAL_DSN
6753 /* generate boundary string and output MIME-Headers */
6754 uschar boundaryStr[64];
6755 snprintf(boundaryStr, 63, "%l-eximdsn-%d", (long) time(NULL), rand());
6756 fprintf(f,"Content-Type: multipart/report; report-type=delivery-status; boundary=%s\n", boundaryStr);
6757 fprintf(f,"MIME-Version: 1.0\n");
6760 /* Open a template file if one is provided. Log failure to open, but
6761 carry on - default texts will be used. */
6763 if (bounce_message_file != NULL)
6765 emf = Ufopen(bounce_message_file, "rb");
6767 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to open %s for error "
6768 "message texts: %s", bounce_message_file, strerror(errno));
6771 /* Quietly copy to configured additional addresses if required. */
6773 bcc = moan_check_errorcopy(bounce_recipient);
6774 if (bcc != NULL) fprintf(f, "Bcc: %s\n", bcc);
6776 /* The texts for the message can be read from a template file; if there
6777 isn't one, or if it is too short, built-in texts are used. The first
6778 emf text is a Subject: and any other headers. */
6780 emf_text = next_emf(emf, US"header");
6781 if (emf_text != NULL) fprintf(f, "%s\n", emf_text); else
6783 fprintf(f, "Subject: Mail delivery failed%s\n\n",
6784 to_sender? ": returning message to sender" : "");
6787 #ifdef EXPERIMENTAL_DSN
6788 /* output human readable part as text/plain section */
6789 fprintf(f,"--%s\n", boundaryStr);
6790 fprintf(f,"Content-type: text/plain; charset=us-ascii\n\n");
6793 emf_text = next_emf(emf, US"intro");
6794 if (emf_text != NULL) fprintf(f, "%s", CS emf_text); else
6797 /* This message has been reworded several times. It seems to be confusing to
6798 somebody, however it is worded. I have retreated to the original, simple
6800 "This message was created automatically by mail delivery software.\n");
6801 if (bounce_message_text != NULL) fprintf(f, "%s", CS bounce_message_text);
6805 "\nA message that you sent could not be delivered to one or more of its\n"
6806 "recipients. This is a permanent error. The following address(es) failed:\n");
6811 "\nA message sent by\n\n <%s>\n\n"
6812 "could not be delivered to one or more of its recipients. The following\n"
6813 "address(es) failed:\n", sender_address);
6818 /* Process the addresses, leaving them on the msgchain if they have a
6819 file name for a return message. (There has already been a check in
6820 post_process_one() for the existence of data in the message file.) A TRUE
6821 return from print_address_information() means that the address is not
6825 for (addr = msgchain; addr != NULL; addr = *paddr)
6827 if (print_address_information(addr, f, US" ", US"\n ", US""))
6828 print_address_error(addr, f, US"");
6830 /* End the final line for the address */
6834 /* Leave on msgchain if there's a return file. */
6836 if (addr->return_file >= 0)
6838 paddr = &(addr->next);
6842 /* Else save so that we can tick off the recipient when the
6847 *paddr = addr->next;
6848 addr->next = handled_addr;
6849 handled_addr = addr;
6855 /* Get the next text, whether we need it or not, so as to be
6856 positioned for the one after. */
6858 emf_text = next_emf(emf, US"generated text");
6860 /* If there were any file messages passed by the local transports,
6861 include them in the message. Then put the address on the handled chain.
6862 In the case of a batch of addresses that were all sent to the same
6863 transport, the return_file field in all of them will contain the same
6864 fd, and the return_filename field in the *last* one will be set (to the
6865 name of the file). */
6867 if (msgchain != NULL)
6869 address_item *nextaddr;
6871 if (emf_text != NULL) fprintf(f, "%s", CS emf_text); else
6873 "The following text was generated during the delivery "
6874 "attempt%s:\n", (filecount > 1)? "s" : "");
6876 for (addr = msgchain; addr != NULL; addr = nextaddr)
6879 address_item *topaddr = addr;
6881 /* List all the addresses that relate to this file */
6884 while(addr != NULL) /* Insurance */
6886 print_address_information(addr, f, US"------ ", US"\n ",
6888 if (addr->return_filename != NULL) break;
6893 /* Now copy the file */
6895 fm = Ufopen(addr->return_filename, "rb");
6898 fprintf(f, " +++ Exim error... failed to open text file: %s\n",
6902 while ((ch = fgetc(fm)) != EOF) fputc(ch, f);
6905 Uunlink(addr->return_filename);
6907 /* Can now add to handled chain, first fishing off the next
6908 address on the msgchain. */
6910 nextaddr = addr->next;
6911 addr->next = handled_addr;
6912 handled_addr = topaddr;
6917 #ifdef EXPERIMENTAL_DSN
6918 /* output machine readable part */
6919 fprintf(f,"--%s\n", boundaryStr);
6920 fprintf(f,"Content-type: message/delivery-status\n\n");
6922 fprintf(f,"Reporting-MTA: dns; %s\n", smtp_active_hostname);
6923 if (dsn_envid != NULL) {
6924 /* must be decoded from xtext: see RFC 3461:6.3a */
6926 if (auth_xtextdecode(dsn_envid, &xdec_envid) > 0)
6927 fprintf(f,"Original-Envelope-ID: %s\n", dsn_envid);
6929 fprintf(f,"X-Original-Envelope-ID: error decoding xtext formated ENVID\n");
6933 for (addr = handled_addr; addr != NULL; addr = addr->next)
6935 fprintf(f,"Action: failed\n");
6936 fprintf(f,"Final-Recipient: rfc822;%s\n", addr->address);
6937 fprintf(f,"Status: 5.0.0\n");
6938 if ((addr->host_used != NULL) && (addr->host_used->name != NULL))
6939 fprintf(f,"Remote-MTA: dns; %s\nDiagnostic-Code: smtp; %d\n", addr->host_used->name, addr->basic_errno);
6943 /* Now copy the message, trying to give an intelligible comment if
6944 it is too long for it all to be copied. The limit isn't strictly
6945 applied because of the buffering. There is, however, an option
6946 to suppress copying altogether. */
6948 emf_text = next_emf(emf, US"copy");
6950 #ifndef EXPERIMENTAL_DSN
6951 if (bounce_return_message)
6953 int topt = topt_add_return_path;
6954 if (!bounce_return_body) topt |= topt_no_body;
6956 if (emf_text != NULL) fprintf(f, "%s", CS emf_text); else
6958 if (bounce_return_body) fprintf(f,
6959 "------ This is a copy of the message, including all the headers. ------\n");
6961 "------ This is a copy of the message's headers. ------\n");
6964 /* While reading the "truncated" message, set return_size_limit to
6965 the actual max testing value, rounded. We need to read the message
6966 whether we are going to use it or not. */
6969 int temp = bounce_return_size_limit;
6970 bounce_return_size_limit = (max/1000)*1000;
6971 emf_text = next_emf(emf, US"truncated");
6972 bounce_return_size_limit = temp;
6975 if (bounce_return_body && bounce_return_size_limit > 0)
6977 struct stat statbuf;
6978 if (fstat(deliver_datafile, &statbuf) == 0 && statbuf.st_size > max)
6980 if (emf_text != NULL) fprintf(f, "%s", CS emf_text); else
6983 "------ The body of the message is " OFF_T_FMT " characters long; only the first\n"
6984 "------ %d or so are included here.\n", statbuf.st_size, max);
6991 transport_filter_argv = NULL; /* Just in case */
6992 return_path = sender_address; /* In case not previously set */
6993 transport_write_message(NULL, fileno(f), topt,
6994 bounce_return_size_limit, NULL, NULL, NULL, NULL, NULL, 0);
6997 /* Write final text and close the template file if one is open */
7001 emf_text = next_emf(emf, US"final");
7002 if (emf_text != NULL) fprintf(f, "%s", CS emf_text);
7007 we ignore the intro text from template and add
7008 the text for bounce_return_size_limit at the end.
7010 bounce_return_message is ignored
7011 in case RET= is defined we honor these values
7012 otherwise bounce_return_body is honored.
7014 bounce_return_size_limit is always honored.
7017 fprintf(f,"\n--%s\n", boundaryStr);
7019 uschar *dsnlimitmsg = US"X-Exim-DSN-Information: Due to administrative limits only headers are returned";
7020 uschar *dsnnotifyhdr = NULL;
7021 int topt = topt_add_return_path;
7022 /* RET=HDRS? top priority */
7023 if (dsn_ret == dsn_ret_hdrs)
7024 topt |= topt_no_body;
7026 /* no full body return at all? */
7027 if (!bounce_return_body)
7029 topt |= topt_no_body;
7030 /* add header if we overrule RET=FULL */
7031 if (dsn_ret == dsn_ret_full)
7032 dsnnotifyhdr = dsnlimitmsg;
7034 /* size limited ... return headers only if limit reached */
7035 else if (bounce_return_size_limit > 0)
7037 struct stat statbuf;
7038 if (fstat(deliver_datafile, &statbuf) == 0 && statbuf.st_size > max)
7040 topt |= topt_no_body;
7041 dsnnotifyhdr = dsnlimitmsg;
7045 if (topt & topt_no_body)
7046 fprintf(f,"Content-type: text/rfc822-headers\n\n");
7048 fprintf(f,"Content-type: message/rfc822\n\n");
7051 transport_filter_argv = NULL; /* Just in case */
7052 return_path = sender_address; /* In case not previously set */
7053 transport_write_message(NULL, fileno(f), topt,
7054 0, dsnnotifyhdr, NULL, NULL, NULL, NULL, 0);
7057 /* we never add the final text. close the file */
7062 fprintf(f,"--%s--\n", boundaryStr);
7065 /* Close the file, which should send an EOF to the child process
7066 that is receiving the message. Wait for it to finish. */
7069 rc = child_close(pid, 0); /* Waits for child to close, no timeout */
7071 /* In the test harness, let the child do it's thing first. */
7073 if (running_in_test_harness) millisleep(500);
7075 /* If the process failed, there was some disaster in setting up the
7076 error message. Unless the message is very old, ensure that addr_defer
7077 is non-null, which will have the effect of leaving the message on the
7078 spool. The failed addresses will get tried again next time. However, we
7079 don't really want this to happen too often, so freeze the message unless
7080 there are some genuine deferred addresses to try. To do this we have
7081 to call spool_write_header() here, because with no genuine deferred
7082 addresses the normal code below doesn't get run. */
7087 if (now - received_time < retry_maximum_timeout && addr_defer == NULL)
7089 addr_defer = (address_item *)(+1);
7090 deliver_freeze = TRUE;
7091 deliver_frozen_at = time(NULL);
7092 /* Panic-dies on error */
7093 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
7096 deliver_msglog("Process failed (%d) when writing error message "
7097 "to %s%s", rc, bounce_recipient, s);
7098 log_write(0, LOG_MAIN, "Process failed (%d) when writing error message "
7099 "to %s%s", rc, bounce_recipient, s);
7102 /* The message succeeded. Ensure that the recipients that failed are
7103 now marked finished with on the spool and their parents updated. */
7107 for (addr = handled_addr; addr != NULL; addr = addr->next)
7109 address_done(addr, logtod);
7110 child_done(addr, logtod);
7112 /* Panic-dies on error */
7113 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
7119 disable_logging = FALSE; /* In case left set */
7121 /* Come here from the mua_wrapper case if routing goes wrong */
7125 /* If there are now no deferred addresses, we are done. Preserve the
7126 message log if so configured, and we are using them. Otherwise, sling it.
7127 Then delete the message itself. */
7129 if (addr_defer == NULL)
7133 sprintf(CS spoolname, "%s/msglog/%s/%s", spool_directory, message_subdir,
7135 if (preserve_message_logs)
7138 sprintf(CS big_buffer, "%s/msglog.OLD/%s", spool_directory, id);
7139 if ((rc = Urename(spoolname, big_buffer)) < 0)
7141 (void)directory_make(spool_directory, US"msglog.OLD",
7142 MSGLOG_DIRECTORY_MODE, TRUE);
7143 rc = Urename(spoolname, big_buffer);
7146 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to move %s to the "
7147 "msglog.OLD directory", spoolname);
7151 if (Uunlink(spoolname) < 0)
7152 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s",
7153 spoolname, strerror(errno));
7157 /* Remove the two message files. */
7159 sprintf(CS spoolname, "%s/input/%s/%s-D", spool_directory, message_subdir, id);
7160 if (Uunlink(spoolname) < 0)
7161 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s",
7162 spoolname, strerror(errno));
7163 sprintf(CS spoolname, "%s/input/%s/%s-H", spool_directory, message_subdir, id);
7164 if (Uunlink(spoolname) < 0)
7165 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s",
7166 spoolname, strerror(errno));
7168 /* Log the end of this message, with queue time if requested. */
7170 if ((log_extra_selector & LX_queue_time_overall) != 0)
7171 log_write(0, LOG_MAIN, "Completed QT=%s",
7172 readconf_printtime( (int) ((long)time(NULL) - (long)received_time)) );
7174 log_write(0, LOG_MAIN, "Completed");
7176 /* Unset deliver_freeze so that we won't try to move the spool files further down */
7177 deliver_freeze = FALSE;
7180 /* If there are deferred addresses, we are keeping this message because it is
7181 not yet completed. Lose any temporary files that were catching output from
7182 pipes for any of the deferred addresses, handle one-time aliases, and see if
7183 the message has been on the queue for so long that it is time to send a warning
7184 message to the sender, unless it is a mailer-daemon. If all deferred addresses
7185 have the same domain, we can set deliver_domain for the expansion of
7186 delay_warning_ condition - if any of them are pipes, files, or autoreplies, use
7187 the parent's domain.
7189 If all the deferred addresses have an error number that indicates "retry time
7190 not reached", skip sending the warning message, because it won't contain the
7191 reason for the delay. It will get sent at the next real delivery attempt.
7192 However, if at least one address has tried, we'd better include all of them in
7195 If we can't make a process to send the message, don't worry.
7197 For mailing list expansions we want to send the warning message to the
7198 mailing list manager. We can't do a perfect job here, as some addresses may
7199 have different errors addresses, but if we take the errors address from
7200 each deferred address it will probably be right in most cases.
7202 If addr_defer == +1, it means there was a problem sending an error message
7203 for failed addresses, and there were no "real" deferred addresses. The value
7204 was set just to keep the message on the spool, so there is nothing to do here.
7207 else if (addr_defer != (address_item *)(+1))
7210 uschar *recipients = US"";
7211 BOOL delivery_attempted = FALSE;
7213 deliver_domain = testflag(addr_defer, af_pfr)?
7214 addr_defer->parent->domain : addr_defer->domain;
7216 for (addr = addr_defer; addr != NULL; addr = addr->next)
7218 address_item *otaddr;
7220 if (addr->basic_errno > ERRNO_RETRY_BASE) delivery_attempted = TRUE;
7222 if (deliver_domain != NULL)
7224 uschar *d = (testflag(addr, af_pfr))? addr->parent->domain : addr->domain;
7226 /* The domain may be unset for an address that has never been routed
7227 because the system filter froze the message. */
7229 if (d == NULL || Ustrcmp(d, deliver_domain) != 0) deliver_domain = NULL;
7232 if (addr->return_filename != NULL) Uunlink(addr->return_filename);
7234 /* Handle the case of one-time aliases. If any address in the ancestry
7235 of this one is flagged, ensure it is in the recipients list, suitably
7236 flagged, and that its parent is marked delivered. */
7238 for (otaddr = addr; otaddr != NULL; otaddr = otaddr->parent)
7239 if (otaddr->onetime_parent != NULL) break;
7244 int t = recipients_count;
7246 for (i = 0; i < recipients_count; i++)
7248 uschar *r = recipients_list[i].address;
7249 if (Ustrcmp(otaddr->onetime_parent, r) == 0) t = i;
7250 if (Ustrcmp(otaddr->address, r) == 0) break;
7253 /* Didn't find the address already in the list, and did find the
7254 ultimate parent's address in the list. After adding the recipient,
7255 update the errors address in the recipients list. */
7257 if (i >= recipients_count && t < recipients_count)
7259 DEBUG(D_deliver) debug_printf("one_time: adding %s in place of %s\n",
7260 otaddr->address, otaddr->parent->address);
7261 receive_add_recipient(otaddr->address, t);
7262 recipients_list[recipients_count-1].errors_to = otaddr->p.errors_address;
7263 tree_add_nonrecipient(otaddr->parent->address);
7264 update_spool = TRUE;
7268 /* Except for error messages, ensure that either the errors address for
7269 this deferred address or, if there is none, the sender address, is on the
7270 list of recipients for a warning message. */
7272 if (sender_address[0] != 0)
7274 if (addr->p.errors_address == NULL)
7276 if (Ustrstr(recipients, sender_address) == NULL)
7277 recipients = string_sprintf("%s%s%s", recipients,
7278 (recipients[0] == 0)? "" : ",", sender_address);
7282 if (Ustrstr(recipients, addr->p.errors_address) == NULL)
7283 recipients = string_sprintf("%s%s%s", recipients,
7284 (recipients[0] == 0)? "" : ",", addr->p.errors_address);
7289 /* Send a warning message if the conditions are right. If the condition check
7290 fails because of a lookup defer, there is nothing we can do. The warning
7291 is not sent. Another attempt will be made at the next delivery attempt (if
7294 if (!queue_2stage && delivery_attempted &&
7295 #ifdef EXPERIMENTAL_DSN
7296 (((addr_defer->dsn_flags & rf_dsnflags) == 0) ||
7297 (addr_defer->dsn_flags & rf_notify_delay) == rf_notify_delay) &&
7299 delay_warning[1] > 0 && sender_address[0] != 0 &&
7300 (delay_warning_condition == NULL ||
7301 expand_check_condition(delay_warning_condition,
7302 US"delay_warning", US"option")))
7306 int queue_time = time(NULL) - received_time;
7308 /* When running in the test harness, there's an option that allows us to
7309 fudge this time so as to get repeatability of the tests. Take the first
7310 time off the list. In queue runs, the list pointer gets updated in the
7313 if (running_in_test_harness && fudged_queue_times[0] != 0)
7315 int qt = readconf_readtime(fudged_queue_times, '/', FALSE);
7318 DEBUG(D_deliver) debug_printf("fudged queue_times = %s\n",
7319 fudged_queue_times);
7324 /* See how many warnings we should have sent by now */
7326 for (count = 0; count < delay_warning[1]; count++)
7327 if (queue_time < delay_warning[count+2]) break;
7329 show_time = delay_warning[count+1];
7331 if (count >= delay_warning[1])
7334 int last_gap = show_time;
7335 if (count > 1) last_gap -= delay_warning[count];
7336 extra = (queue_time - delay_warning[count+1])/last_gap;
7337 show_time += last_gap * extra;
7343 debug_printf("time on queue = %s\n", readconf_printtime(queue_time));
7344 debug_printf("warning counts: required %d done %d\n", count,
7348 /* We have computed the number of warnings there should have been by now.
7349 If there haven't been enough, send one, and up the count to what it should
7352 if (warning_count < count)
7356 pid_t pid = child_open_exim(&fd);
7362 FILE *f = fdopen(fd, "wb");
7364 if (warn_message_file != NULL)
7366 wmf = Ufopen(warn_message_file, "rb");
7368 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to open %s for warning "
7369 "message texts: %s", warn_message_file, strerror(errno));
7372 warnmsg_recipients = recipients;
7373 warnmsg_delay = (queue_time < 120*60)?
7374 string_sprintf("%d minutes", show_time/60):
7375 string_sprintf("%d hours", show_time/3600);
7377 if (errors_reply_to != NULL)
7378 fprintf(f, "Reply-To: %s\n", errors_reply_to);
7379 fprintf(f, "Auto-Submitted: auto-replied\n");
7381 fprintf(f, "To: %s\n", recipients);
7383 #ifdef EXPERIMENTAL_DSN
7384 /* generated boundary string and output MIME-Headers */
7385 uschar boundaryStr[64];
7386 snprintf(boundaryStr, 63, "%l-eximdsn-%d", (long) time(NULL), rand());
7387 fprintf(f,"Content-Type: multipart/report; report-type=delivery-status; boundary=%s\n", boundaryStr);
7388 fprintf(f,"MIME-Version: 1.0\n");
7391 wmf_text = next_emf(wmf, US"header");
7392 if (wmf_text != NULL)
7393 fprintf(f, "%s\n", wmf_text);
7395 fprintf(f, "Subject: Warning: message %s delayed %s\n\n",
7396 message_id, warnmsg_delay);
7398 #ifdef EXPERIMENTAL_DSN
7399 /* output human readable part as text/plain section */
7400 fprintf(f,"--%s\n", boundaryStr);
7401 fprintf(f,"Content-type: text/plain; charset=us-ascii\n\n");
7404 wmf_text = next_emf(wmf, US"intro");
7405 if (wmf_text != NULL) fprintf(f, "%s", CS wmf_text); else
7408 "This message was created automatically by mail delivery software.\n");
7410 if (Ustrcmp(recipients, sender_address) == 0)
7412 "A message that you sent has not yet been delivered to one or more of its\n"
7413 "recipients after more than ");
7416 "A message sent by\n\n <%s>\n\n"
7417 "has not yet been delivered to one or more of its recipients after more than \n",
7420 fprintf(f, "%s on the queue on %s.\n\n", warnmsg_delay,
7422 fprintf(f, "The message identifier is: %s\n", message_id);
7424 for (h = header_list; h != NULL; h = h->next)
7426 if (strncmpic(h->text, US"Subject:", 8) == 0)
7427 fprintf(f, "The subject of the message is: %s", h->text + 9);
7428 else if (strncmpic(h->text, US"Date:", 5) == 0)
7429 fprintf(f, "The date of the message is: %s", h->text + 6);
7433 fprintf(f, "The address%s to which the message has not yet been "
7435 (addr_defer->next == NULL)? "" : "es",
7436 (addr_defer->next == NULL)? "is": "are");
7439 /* List the addresses, with error information if allowed */
7441 #ifdef EXPERIMENTAL_DSN
7442 /* store addr_defer for machine readable part */
7443 address_item *addr_dsndefer = addr_defer;
7446 while (addr_defer != NULL)
7448 address_item *addr = addr_defer;
7449 addr_defer = addr->next;
7450 if (print_address_information(addr, f, US" ", US"\n ", US""))
7451 print_address_error(addr, f, US"Delay reason: ");
7460 wmf_text = next_emf(wmf, US"final");
7461 if (wmf_text != NULL) fprintf(f, "%s", CS wmf_text);
7467 "No action is required on your part. Delivery attempts will continue for\n"
7468 "some time, and this warning may be repeated at intervals if the message\n"
7469 "remains undelivered. Eventually the mail delivery software will give up,\n"
7470 "and when that happens, the message will be returned to you.\n");
7473 #ifdef EXPERIMENTAL_DSN
7474 /* output machine readable part */
7475 fprintf(f,"\n--%s\n", boundaryStr);
7476 fprintf(f,"Content-type: message/delivery-status\n\n");
7478 fprintf(f,"Reporting-MTA: dns; %s\n", smtp_active_hostname);
7479 if (dsn_envid != NULL) {
7480 /* must be decoded from xtext: see RFC 3461:6.3a */
7482 if (auth_xtextdecode(dsn_envid, &xdec_envid) > 0)
7483 fprintf(f,"Original-Envelope-ID: %s\n", dsn_envid);
7485 fprintf(f,"X-Original-Envelope-ID: error decoding xtext formated ENVID\n");
7489 while (addr_dsndefer != NULL)
7491 if (addr_dsndefer->dsn_orcpt != NULL) {
7492 fprintf(f,"Original-Recipient: %s\n", addr_dsndefer->dsn_orcpt);
7494 fprintf(f,"Action: delayed\n");
7495 fprintf(f,"Final-Recipient: rfc822;%s\n", addr_dsndefer->address);
7496 fprintf(f,"Status: 4.0.0\n");
7497 if ((addr_dsndefer->host_used != NULL) && (addr_dsndefer->host_used->name != NULL))
7498 fprintf(f,"Remote-MTA: dns; %s\nDiagnostic-Code: smtp; %d\n",
7499 addr_dsndefer->host_used->name, addr_dsndefer->basic_errno);
7500 addr_dsndefer = addr_dsndefer->next;
7503 fprintf(f,"\n--%s\n", boundaryStr);
7504 fprintf(f,"Content-type: text/rfc822-headers\n\n");
7507 /* header only as required by RFC. only failure DSN needs to honor RET=FULL */
7508 int topt = topt_add_return_path | topt_no_body;
7509 transport_filter_argv = NULL; /* Just in case */
7510 return_path = sender_address; /* In case not previously set */
7511 /* Write the original email out */
7512 transport_write_message(NULL, fileno(f), topt, 0, NULL, NULL, NULL, NULL, NULL, 0);
7516 fprintf(f,"--%s--\n", boundaryStr);
7521 /* Close and wait for child process to complete, without a timeout.
7522 If there's an error, don't update the count. */
7525 if (child_close(pid, 0) == 0)
7527 warning_count = count;
7528 update_spool = TRUE; /* Ensure spool rewritten */
7534 /* Clear deliver_domain */
7536 deliver_domain = NULL;
7538 /* If this was a first delivery attempt, unset the first time flag, and
7539 ensure that the spool gets updated. */
7541 if (deliver_firsttime)
7543 deliver_firsttime = FALSE;
7544 update_spool = TRUE;
7547 /* If delivery was frozen and freeze_tell is set, generate an appropriate
7548 message, unless the message is a local error message (to avoid loops). Then
7549 log the freezing. If the text in "frozen_info" came from a system filter,
7550 it has been escaped into printing characters so as not to mess up log lines.
7551 For the "tell" message, we turn \n back into newline. Also, insert a newline
7552 near the start instead of the ": " string. */
7556 if (freeze_tell != NULL && freeze_tell[0] != 0 && !local_error_message)
7558 uschar *s = string_copy(frozen_info);
7559 uschar *ss = Ustrstr(s, " by the system filter: ");
7570 if (*ss == '\\' && ss[1] == 'n')
7577 moan_tell_someone(freeze_tell, addr_defer, US"Message frozen",
7578 "Message %s has been frozen%s.\nThe sender is <%s>.\n", message_id,
7582 /* Log freezing just before we update the -H file, to minimize the chance
7583 of a race problem. */
7585 deliver_msglog("*** Frozen%s\n", frozen_info);
7586 log_write(0, LOG_MAIN, "Frozen%s", frozen_info);
7589 /* If there have been any updates to the non-recipients list, or other things
7590 that get written to the spool, we must now update the spool header file so
7591 that it has the right information for the next delivery attempt. If there
7592 was more than one address being delivered, the header_change update is done
7593 earlier, in case one succeeds and then something crashes. */
7596 debug_printf("delivery deferred: update_spool=%d header_rewritten=%d\n",
7597 update_spool, header_rewritten);
7599 if (update_spool || header_rewritten)
7600 /* Panic-dies on error */
7601 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
7604 /* Finished with the message log. If the message is complete, it will have
7605 been unlinked or renamed above. */
7607 if (message_logs) (void)fclose(message_log);
7609 /* Now we can close and remove the journal file. Its only purpose is to record
7610 successfully completed deliveries asap so that this information doesn't get
7611 lost if Exim (or the machine) crashes. Forgetting about a failed delivery is
7612 not serious, as trying it again is not harmful. The journal might not be open
7613 if all addresses were deferred at routing or directing. Nevertheless, we must
7614 remove it if it exists (may have been lying around from a crash during the
7615 previous delivery attempt). We don't remove the journal if a delivery
7616 subprocess failed to pass back delivery information; this is controlled by
7617 the remove_journal flag. When the journal is left, we also don't move the
7618 message off the main spool if frozen and the option is set. It should get moved
7619 at the next attempt, after the journal has been inspected. */
7621 if (journal_fd >= 0) (void)close(journal_fd);
7625 sprintf(CS spoolname, "%s/input/%s/%s-J", spool_directory, message_subdir, id);
7626 if (Uunlink(spoolname) < 0 && errno != ENOENT)
7627 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s", spoolname,
7630 /* Move the message off the spool if reqested */
7632 #ifdef SUPPORT_MOVE_FROZEN_MESSAGES
7633 if (deliver_freeze && move_frozen_messages)
7634 (void)spool_move_message(id, message_subdir, US"", US"F");
7638 /* Closing the data file frees the lock; if the file has been unlinked it
7639 will go away. Otherwise the message becomes available for another process
7642 (void)close(deliver_datafile);
7643 deliver_datafile = -1;
7644 DEBUG(D_deliver) debug_printf("end delivery of %s\n", id);
7646 /* It is unlikely that there will be any cached resources, since they are
7647 released after routing, and in the delivery subprocesses. However, it's
7648 possible for an expansion for something afterwards (for example,
7649 expand_check_condition) to do a lookup. We must therefore be sure everything is
7653 acl_where = ACL_WHERE_UNKNOWN;
7659 /* End of deliver.c */