1 /* $Cambridge: exim/src/src/deliver.c,v 1.8 2005/03/15 12:27:54 ph10 Exp $ */
3 /*************************************************
4 * Exim - an Internet mail transport agent *
5 *************************************************/
7 /* Copyright (c) University of Cambridge 1995 - 2005 */
8 /* See the file NOTICE for conditions of use and distribution. */
10 /* The main code for delivering a message. */
16 /* Data block for keeping track of subprocesses for parallel remote
19 typedef struct pardata {
20 address_item *addrlist; /* chain of addresses */
21 address_item *addr; /* next address data expected for */
22 pid_t pid; /* subprocess pid */
23 int fd; /* pipe fd for getting result from subprocess */
24 int transport_count; /* returned transport count value */
25 BOOL done; /* no more data needed */
26 uschar *msg; /* error message */
27 uschar *return_path; /* return_path for these addresses */
30 /* Values for the process_recipients variable */
32 enum { RECIP_ACCEPT, RECIP_IGNORE, RECIP_DEFER,
33 RECIP_FAIL, RECIP_FAIL_FILTER, RECIP_FAIL_TIMEOUT,
36 /* Mutually recursive functions for marking addresses done. */
38 static void child_done(address_item *, uschar *);
39 static void address_done(address_item *, uschar *);
41 /* Table for turning base-62 numbers into binary */
43 static uschar tab62[] =
44 {0,1,2,3,4,5,6,7,8,9,0,0,0,0,0,0, /* 0-9 */
45 0,10,11,12,13,14,15,16,17,18,19,20, /* A-K */
46 21,22,23,24,25,26,27,28,29,30,31,32, /* L-W */
47 33,34,35, 0, 0, 0, 0, 0, /* X-Z */
48 0,36,37,38,39,40,41,42,43,44,45,46, /* a-k */
49 47,48,49,50,51,52,53,54,55,56,57,58, /* l-w */
53 /*************************************************
54 * Local static variables *
55 *************************************************/
57 /* addr_duplicate is global because it needs to be seen from the Envelope-To
60 static address_item *addr_defer = NULL;
61 static address_item *addr_failed = NULL;
62 static address_item *addr_fallback = NULL;
63 static address_item *addr_local = NULL;
64 static address_item *addr_new = NULL;
65 static address_item *addr_remote = NULL;
66 static address_item *addr_route = NULL;
67 static address_item *addr_succeed = NULL;
69 static FILE *message_log = NULL;
70 static BOOL update_spool;
71 static BOOL remove_journal;
72 static int parcount = 0;
73 static pardata *parlist = NULL;
74 static int return_count;
75 static uschar *frozen_info = US"";
76 static uschar *used_return_path = NULL;
78 static uschar spoolname[PATH_MAX];
82 /*************************************************
83 * Make a new address item *
84 *************************************************/
86 /* This function gets the store and initializes with default values. The
87 transport_return value defaults to DEFER, so that any unexpected failure to
88 deliver does not wipe out the message. The default unique string is set to a
89 copy of the address, so that its domain can be lowercased.
92 address the RFC822 address string
93 copy force a copy of the address
95 Returns: a pointer to an initialized address_item
99 deliver_make_addr(uschar *address, BOOL copy)
101 address_item *addr = store_get(sizeof(address_item));
102 *addr = address_defaults;
103 if (copy) address = string_copy(address);
104 addr->address = address;
105 addr->unique = string_copy(address);
112 /*************************************************
113 * Set expansion values for an address *
114 *************************************************/
116 /* Certain expansion variables are valid only when handling an address or
117 address list. This function sets them up or clears the values, according to its
121 addr the address in question, or NULL to clear values
126 deliver_set_expansions(address_item *addr)
130 uschar ***p = address_expansions;
131 while (*p != NULL) **p++ = NULL;
135 /* Exactly what gets set depends on whether there is one or more addresses, and
136 what they contain. These first ones are always set, taking their values from
137 the first address. */
139 if (addr->host_list == NULL)
141 deliver_host = deliver_host_address = US"";
145 deliver_host = addr->host_list->name;
146 deliver_host_address = addr->host_list->address;
149 deliver_recipients = addr;
150 deliver_address_data = addr->p.address_data;
151 deliver_domain_data = addr->p.domain_data;
152 deliver_localpart_data = addr->p.localpart_data;
154 /* These may be unset for multiple addresses */
156 deliver_domain = addr->domain;
157 self_hostname = addr->self_hostname;
159 #ifdef EXPERIMENTAL_BRIGHTMAIL
160 bmi_deliver = 1; /* deliver by default */
161 bmi_alt_location = NULL;
162 bmi_base64_verdict = NULL;
163 bmi_base64_tracker_verdict = NULL;
166 /* If there's only one address we can set everything. */
168 if (addr->next == NULL)
170 address_item *addr_orig;
172 deliver_localpart = addr->local_part;
173 deliver_localpart_prefix = addr->prefix;
174 deliver_localpart_suffix = addr->suffix;
176 for (addr_orig = addr; addr_orig->parent != NULL;
177 addr_orig = addr_orig->parent);
178 deliver_domain_orig = addr_orig->domain;
180 /* Re-instate any prefix and suffix in the original local part. In all
181 normal cases, the address will have a router associated with it, and we can
182 choose the caseful or caseless version accordingly. However, when a system
183 filter sets up a pipe, file, or autoreply delivery, no router is involved.
184 In this case, though, there won't be any prefix or suffix to worry about. */
186 deliver_localpart_orig = (addr_orig->router == NULL)? addr_orig->local_part :
187 addr_orig->router->caseful_local_part?
188 addr_orig->cc_local_part : addr_orig->lc_local_part;
190 /* If there's a parent, make its domain and local part available, and if
191 delivering to a pipe or file, or sending an autoreply, get the local
192 part from the parent. For pipes and files, put the pipe or file string
193 into address_pipe and address_file. */
195 if (addr->parent != NULL)
197 deliver_domain_parent = addr->parent->domain;
198 deliver_localpart_parent = (addr->parent->router == NULL)?
199 addr->parent->local_part :
200 addr->parent->router->caseful_local_part?
201 addr->parent->cc_local_part : addr->parent->lc_local_part;
203 /* File deliveries have their own flag because they need to be picked out
204 as special more often. */
206 if (testflag(addr, af_pfr))
208 if (testflag(addr, af_file)) address_file = addr->local_part;
209 else if (deliver_localpart[0] == '|') address_pipe = addr->local_part;
210 deliver_localpart = addr->parent->local_part;
211 deliver_localpart_prefix = addr->parent->prefix;
212 deliver_localpart_suffix = addr->parent->suffix;
216 #ifdef EXPERIMENTAL_BRIGHTMAIL
217 /* Set expansion variables related to Brightmail AntiSpam */
218 bmi_base64_verdict = bmi_get_base64_verdict(deliver_localpart_orig, deliver_domain_orig);
219 bmi_base64_tracker_verdict = bmi_get_base64_tracker_verdict(bmi_base64_verdict);
220 /* get message delivery status (0 - don't deliver | 1 - deliver) */
221 bmi_deliver = bmi_get_delivery_status(bmi_base64_verdict);
222 /* if message is to be delivered, get eventual alternate location */
223 if (bmi_deliver == 1) {
224 bmi_alt_location = bmi_get_alt_location(bmi_base64_verdict);
230 /* For multiple addresses, don't set local part, and leave the domain and
231 self_hostname set only if it is the same for all of them. */
236 for (addr2 = addr->next; addr2 != NULL; addr2 = addr2->next)
238 if (deliver_domain != NULL &&
239 Ustrcmp(deliver_domain, addr2->domain) != 0)
240 deliver_domain = NULL;
241 if (self_hostname != NULL && (addr2->self_hostname == NULL ||
242 Ustrcmp(self_hostname, addr2->self_hostname) != 0))
243 self_hostname = NULL;
244 if (deliver_domain == NULL && self_hostname == NULL) break;
252 /*************************************************
253 * Open a msglog file *
254 *************************************************/
256 /* This function is used both for normal message logs, and for files in the
257 msglog directory that are used to catch output from pipes. Try to create the
258 directory if it does not exist. From release 4.21, normal message logs should
259 be created when the message is received.
262 filename the file name
263 mode the mode required
264 error used for saying what failed
266 Returns: a file descriptor, or -1 (with errno set)
270 open_msglog_file(uschar *filename, int mode, uschar **error)
272 int fd = Uopen(filename, O_WRONLY|O_APPEND|O_CREAT, mode);
274 if (fd < 0 && errno == ENOENT)
277 sprintf(CS temp, "msglog/%s", message_subdir);
278 if (message_subdir[0] == 0) temp[6] = 0;
279 (void)directory_make(spool_directory, temp, MSGLOG_DIRECTORY_MODE, TRUE);
280 fd = Uopen(filename, O_WRONLY|O_APPEND|O_CREAT, mode);
283 /* Set the close-on-exec flag and change the owner to the exim uid/gid (this
284 function is called as root). Double check the mode, because the group setting
285 doesn't always get set automatically. */
289 fcntl(fd, F_SETFD, fcntl(fd, F_GETFD) | FD_CLOEXEC);
290 if (fchown(fd, exim_uid, exim_gid) < 0)
295 if (fchmod(fd, mode) < 0)
301 else *error = US"create";
309 /*************************************************
310 * Write to msglog if required *
311 *************************************************/
313 /* Write to the message log, if configured. This function may also be called
317 format a string format
323 deliver_msglog(const char *format, ...)
326 if (!message_logs) return;
327 va_start(ap, format);
328 vfprintf(message_log, format, ap);
336 /*************************************************
337 * Replicate status for batch *
338 *************************************************/
340 /* When a transport handles a batch of addresses, it may treat them
341 individually, or it may just put the status in the first one, and return FALSE,
342 requesting that the status be copied to all the others externally. This is the
343 replication function. As well as the status, it copies the transport pointer,
344 which may have changed if appendfile passed the addresses on to a different
347 Argument: pointer to the first address in a chain
352 replicate_status(address_item *addr)
355 for (addr2 = addr->next; addr2 != NULL; addr2 = addr2->next)
357 addr2->transport = addr->transport;
358 addr2->transport_return = addr->transport_return;
359 addr2->basic_errno = addr->basic_errno;
360 addr2->more_errno = addr->more_errno;
361 addr2->special_action = addr->special_action;
362 addr2->message = addr->message;
363 addr2->user_message = addr->user_message;
369 /*************************************************
370 * Compare lists of hosts *
371 *************************************************/
373 /* This function is given two pointers to chains of host items, and it yields
374 TRUE if the lists refer to the same hosts in the same order, except that
376 (1) Multiple hosts with the same non-negative MX values are permitted to appear
377 in different orders. Round-robinning nameservers can cause this to happen.
379 (2) Multiple hosts with the same negative MX values less than MX_NONE are also
380 permitted to appear in different orders. This is caused by randomizing
383 This enables Exim to use a single SMTP transaction for sending to two entirely
384 different domains that happen to end up pointing at the same hosts.
387 one points to the first host list
388 two points to the second host list
390 Returns: TRUE if the lists refer to the same host set
394 same_hosts(host_item *one, host_item *two)
396 while (one != NULL && two != NULL)
398 if (Ustrcmp(one->name, two->name) != 0)
401 host_item *end_one = one;
402 host_item *end_two = two;
404 /* Batch up only if there was no MX and the list was not randomized */
406 if (mx == MX_NONE) return FALSE;
408 /* Find the ends of the shortest sequence of identical MX values */
410 while (end_one->next != NULL && end_one->next->mx == mx &&
411 end_two->next != NULL && end_two->next->mx == mx)
413 end_one = end_one->next;
414 end_two = end_two->next;
417 /* If there aren't any duplicates, there's no match. */
419 if (end_one == one) return FALSE;
421 /* For each host in the 'one' sequence, check that it appears in the 'two'
422 sequence, returning FALSE if not. */
427 for (hi = two; hi != end_two->next; hi = hi->next)
428 if (Ustrcmp(one->name, hi->name) == 0) break;
429 if (hi == end_two->next) return FALSE;
430 if (one == end_one) break;
434 /* All the hosts in the 'one' sequence were found in the 'two' sequence.
435 Ensure both are pointing at the last host, and carry on as for equality. */
446 /* True if both are NULL */
453 /*************************************************
454 * Compare header lines *
455 *************************************************/
457 /* This function is given two pointers to chains of header items, and it yields
458 TRUE if they are the same header texts in the same order.
461 one points to the first header list
462 two points to the second header list
464 Returns: TRUE if the lists refer to the same header set
468 same_headers(header_line *one, header_line *two)
472 if (one == two) return TRUE; /* Includes the case where both NULL */
473 if (one == NULL || two == NULL) return FALSE;
474 if (Ustrcmp(one->text, two->text) != 0) return FALSE;
482 /*************************************************
483 * Compare string settings *
484 *************************************************/
486 /* This function is given two pointers to strings, and it returns
487 TRUE if they are the same pointer, or if the two strings are the same.
490 one points to the first string
491 two points to the second string
493 Returns: TRUE or FALSE
497 same_strings(uschar *one, uschar *two)
499 if (one == two) return TRUE; /* Includes the case where both NULL */
500 if (one == NULL || two == NULL) return FALSE;
501 return (Ustrcmp(one, two) == 0);
506 /*************************************************
507 * Compare uid/gid for addresses *
508 *************************************************/
510 /* This function is given a transport and two addresses. It yields TRUE if the
511 uid/gid/initgroups settings for the two addresses are going to be the same when
516 addr1 the first address
517 addr2 the second address
519 Returns: TRUE or FALSE
523 same_ugid(transport_instance *tp, address_item *addr1, address_item *addr2)
525 if (!tp->uid_set && tp->expand_uid == NULL && !tp->deliver_as_creator)
527 if (testflag(addr1, af_uid_set) != testflag(addr2, af_gid_set) ||
528 (testflag(addr1, af_uid_set) &&
529 (addr1->uid != addr2->uid ||
530 testflag(addr1, af_initgroups) != testflag(addr2, af_initgroups))))
534 if (!tp->gid_set && tp->expand_gid == NULL)
536 if (testflag(addr1, af_gid_set) != testflag(addr2, af_gid_set) ||
537 (testflag(addr1, af_gid_set) && addr1->gid != addr2->gid))
547 /*************************************************
548 * Record that an address is complete *
549 *************************************************/
551 /* This function records that an address is complete. This is straightforward
552 for most addresses, where the unique address is just the full address with the
553 domain lower cased. For homonyms (addresses that are the same as one of their
554 ancestors) their are complications. Their unique addresses have \x\ prepended
555 (where x = 0, 1, 2...), so that de-duplication works correctly for siblings and
558 Exim used to record the unique addresses of homonyms as "complete". This,
559 however, fails when the pattern of redirection varies over time (e.g. if taking
560 unseen copies at only some times of day) because the prepended numbers may vary
561 from one delivery run to the next. This problem is solved by never recording
562 prepended unique addresses as complete. Instead, when a homonymic address has
563 actually been delivered via a transport, we record its basic unique address
564 followed by the name of the transport. This is checked in subsequent delivery
565 runs whenever an address is routed to a transport.
567 If the completed address is a top-level one (has no parent, which means it
568 cannot be homonymic) we also add the original address to the non-recipients
569 tree, so that it gets recorded in the spool file and therefore appears as
570 "done" in any spool listings. The original address may differ from the unique
571 address in the case of the domain.
573 Finally, this function scans the list of duplicates, marks as done any that
574 match this address, and calls child_done() for their ancestors.
577 addr address item that has been completed
578 now current time as a string
584 address_done(address_item *addr, uschar *now)
588 update_spool = TRUE; /* Ensure spool gets updated */
590 /* Top-level address */
592 if (addr->parent == NULL)
594 tree_add_nonrecipient(addr->unique);
595 tree_add_nonrecipient(addr->address);
598 /* Homonymous child address */
600 else if (testflag(addr, af_homonym))
602 if (addr->transport != NULL)
604 tree_add_nonrecipient(
605 string_sprintf("%s/%s", addr->unique + 3, addr->transport->name));
609 /* Non-homonymous child address */
611 else tree_add_nonrecipient(addr->unique);
613 /* Check the list of duplicate addresses and ensure they are now marked
616 for (dup = addr_duplicate; dup != NULL; dup = dup->next)
618 if (Ustrcmp(addr->unique, dup->unique) == 0)
620 tree_add_nonrecipient(dup->address);
621 child_done(dup, now);
629 /*************************************************
630 * Decrease counts in parents and mark done *
631 *************************************************/
633 /* This function is called when an address is complete. If there is a parent
634 address, its count of children is decremented. If there are still other
635 children outstanding, the function exits. Otherwise, if the count has become
636 zero, address_done() is called to mark the parent and its duplicates complete.
637 Then loop for any earlier ancestors.
640 addr points to the completed address item
641 now the current time as a string, for writing to the message log
647 child_done(address_item *addr, uschar *now)
650 while (addr->parent != NULL)
653 if ((addr->child_count -= 1) > 0) return; /* Incomplete parent */
654 address_done(addr, now);
656 /* Log the completion of all descendents only when there is no ancestor with
657 the same original address. */
659 for (aa = addr->parent; aa != NULL; aa = aa->parent)
660 if (Ustrcmp(aa->address, addr->address) == 0) break;
661 if (aa != NULL) continue;
663 deliver_msglog("%s %s: children all complete\n", now, addr->address);
664 DEBUG(D_deliver) debug_printf("%s: children all complete\n", addr->address);
671 /*************************************************
672 * Actions at the end of handling an address *
673 *************************************************/
675 /* This is a function for processing a single address when all that can be done
676 with it has been done.
679 addr points to the address block
680 result the result of the delivery attempt
681 logflags flags for log_write() (LOG_MAIN and/or LOG_PANIC)
682 driver_type indicates which type of driver (transport, or router) was last
683 to process the address
684 logchar '=' or '-' for use when logging deliveries with => or ->
690 post_process_one(address_item *addr, int result, int logflags, int driver_type,
693 uschar *now = tod_stamp(tod_log);
694 uschar *driver_kind = NULL;
695 uschar *driver_name = NULL;
698 int size = 256; /* Used for a temporary, */
699 int ptr = 0; /* expanding buffer, for */
700 uschar *s; /* building log lines; */
701 void *reset_point; /* released afterwards. */
704 DEBUG(D_deliver) debug_printf("post-process %s (%d)\n", addr->address, result);
706 /* Set up driver kind and name for logging. Disable logging if the router or
707 transport has disabled it. */
709 if (driver_type == DTYPE_TRANSPORT)
711 if (addr->transport != NULL)
713 driver_name = addr->transport->name;
714 driver_kind = US" transport";
715 disable_logging = addr->transport->disable_logging;
717 else driver_kind = US"transporting";
719 else if (driver_type == DTYPE_ROUTER)
721 if (addr->router != NULL)
723 driver_name = addr->router->name;
724 driver_kind = US" router";
725 disable_logging = addr->router->disable_logging;
727 else driver_kind = US"routing";
730 /* If there's an error message set, ensure that it contains only printing
731 characters - it should, but occasionally things slip in and this at least
732 stops the log format from getting wrecked. */
734 if (addr->message != NULL) addr->message = string_printing(addr->message);
736 /* If we used a transport that has one of the "return_output" options set, and
737 if it did in fact generate some output, then for return_output we treat the
738 message as failed if it was not already set that way, so that the output gets
739 returned to the sender, provided there is a sender to send it to. For
740 return_fail_output, do this only if the delivery failed. Otherwise we just
741 unlink the file, and remove the name so that if the delivery failed, we don't
742 try to send back an empty or unwanted file. The log_output options operate only
745 In any case, we close the message file, because we cannot afford to leave a
746 file-descriptor for one address while processing (maybe very many) others. */
748 if (addr->return_file >= 0 && addr->return_filename != NULL)
750 BOOL return_output = FALSE;
752 fsync(addr->return_file);
754 /* If there is no output, do nothing. */
756 if (fstat(addr->return_file, &statbuf) == 0 && statbuf.st_size > 0)
758 transport_instance *tb = addr->transport;
760 /* Handle logging options */
762 if (tb->log_output || (result == FAIL && tb->log_fail_output) ||
763 (result == DEFER && tb->log_defer_output))
766 FILE *f = Ufopen(addr->return_filename, "rb");
768 log_write(0, LOG_MAIN|LOG_PANIC, "failed to open %s to log output "
769 "from %s transport: %s", addr->return_filename, tb->name,
773 s = US Ufgets(big_buffer, big_buffer_size, f);
776 uschar *p = big_buffer + Ustrlen(big_buffer);
777 while (p > big_buffer && isspace(p[-1])) p--;
779 s = string_printing(big_buffer);
780 log_write(0, LOG_MAIN, "<%s>: %s transport output: %s",
781 addr->address, tb->name, s);
787 /* Handle returning options, but only if there is an address to return
790 if (sender_address[0] != 0 || addr->p.errors_address != NULL)
792 if (tb->return_output)
794 addr->transport_return = result = FAIL;
795 if (addr->basic_errno == 0 && addr->message == NULL)
796 addr->message = US"return message generated";
797 return_output = TRUE;
800 if (tb->return_fail_output && result == FAIL) return_output = TRUE;
804 /* Get rid of the file unless it might be returned, but close it in
809 Uunlink(addr->return_filename);
810 addr->return_filename = NULL;
811 addr->return_file = -1;
814 close(addr->return_file);
817 /* Create the address string for logging. Must not do this earlier, because
818 an OK result may be changed to FAIL when a pipe returns text. */
820 log_address = string_log_address(addr,
821 (log_write_selector & L_all_parents) != 0, result == OK);
823 /* The sucess case happens only after delivery by a transport. */
827 addr->next = addr_succeed;
830 /* Call address_done() to ensure that we don't deliver to this address again,
831 and write appropriate things to the message log. If it is a child address, we
832 call child_done() to scan the ancestors and mark them complete if this is the
833 last child to complete. */
835 address_done(addr, now);
836 DEBUG(D_deliver) debug_printf("%s delivered\n", addr->address);
838 if (addr->parent == NULL)
840 deliver_msglog("%s %s: %s%s succeeded\n", now, addr->address,
841 driver_name, driver_kind);
845 deliver_msglog("%s %s <%s>: %s%s succeeded\n", now, addr->address,
846 addr->parent->address, driver_name, driver_kind);
847 child_done(addr, now);
850 /* Log the delivery on the main log. We use an extensible string to build up
851 the log line, and reset the store afterwards. Remote deliveries should always
852 have a pointer to the host item that succeeded; local deliveries can have a
853 pointer to a single host item in their host list, for use by the transport. */
855 s = reset_point = store_get(size);
858 s = string_append(s, &size, &ptr, 2, US"> ", log_address);
860 if ((log_extra_selector & LX_sender_on_delivery) != 0)
861 s = string_append(s, &size, &ptr, 3, US" F=<", sender_address, US">");
863 /* You might think that the return path must always be set for a successful
864 delivery; indeed, I did for some time, until this statement crashed. The case
865 when it is not set is for a delivery to /dev/null which is optimised by not
868 if (used_return_path != NULL &&
869 (log_extra_selector & LX_return_path_on_delivery) != 0)
870 s = string_append(s, &size, &ptr, 3, US" P=<", used_return_path, US">");
872 /* For a delivery from a system filter, there may not be a router */
874 if (addr->router != NULL)
875 s = string_append(s, &size, &ptr, 2, US" R=", addr->router->name);
877 s = string_append(s, &size, &ptr, 2, US" T=", addr->transport->name);
879 if ((log_extra_selector & LX_delivery_size) != 0)
880 s = string_append(s, &size, &ptr, 2, US" S=",
881 string_sprintf("%d", transport_count));
885 if (addr->transport->info->local)
887 if (addr->host_list != NULL)
888 s = string_append(s, &size, &ptr, 2, US" H=", addr->host_list->name);
889 if (addr->shadow_message != NULL)
890 s = string_cat(s, &size, &ptr, addr->shadow_message,
891 Ustrlen(addr->shadow_message));
894 /* Remote delivery */
898 if (addr->host_used != NULL)
900 s = string_append(s, &size, &ptr, 5, US" H=", addr->host_used->name,
901 US" [", addr->host_used->address, US"]");
902 if ((log_extra_selector & LX_outgoing_port) != 0)
903 s = string_append(s, &size, &ptr, 2, US":", string_sprintf("%d",
904 addr->host_used->port));
905 if (continue_sequence > 1)
906 s = string_cat(s, &size, &ptr, US"*", 1);
910 if ((log_extra_selector & LX_tls_cipher) != 0 && addr->cipher != NULL)
911 s = string_append(s, &size, &ptr, 2, US" X=", addr->cipher);
912 if ((log_extra_selector & LX_tls_certificate_verified) != 0 &&
913 addr->cipher != NULL)
914 s = string_append(s, &size, &ptr, 2, US" CV=",
915 testflag(addr, af_cert_verified)? "yes":"no");
916 if ((log_extra_selector & LX_tls_peerdn) != 0 && addr->peerdn != NULL)
917 s = string_append(s, &size, &ptr, 3, US" DN=\"", addr->peerdn, US"\"");
920 if ((log_extra_selector & LX_smtp_confirmation) != 0 &&
921 addr->message != NULL)
924 uschar *p = big_buffer;
925 uschar *ss = addr->message;
927 for (i = 0; i < 100 && ss[i] != 0; i++)
929 if (ss[i] == '\"' || ss[i] == '\\') *p++ = '\\';
934 s = string_append(s, &size, &ptr, 2, US" C=", big_buffer);
938 /* Time on queue and actual time taken to deliver */
940 if ((log_extra_selector & LX_queue_time) != 0)
942 s = string_append(s, &size, &ptr, 2, US" QT=",
943 readconf_printtime(time(NULL) - received_time));
946 if ((log_extra_selector & LX_deliver_time) != 0)
948 s = string_append(s, &size, &ptr, 2, US" DT=",
949 readconf_printtime(addr->more_errno));
952 /* string_cat() always leaves room for the terminator. Release the
953 store we used to build the line after writing it. */
956 log_write(0, LOG_MAIN, "%s", s);
957 store_reset(reset_point);
961 /* Soft failure, or local delivery process failed; freezing may be
964 else if (result == DEFER || result == PANIC)
966 if (result == PANIC) logflags |= LOG_PANIC;
968 /* This puts them on the chain in reverse order. Do not change this, because
969 the code for handling retries assumes that the one with the retry
970 information is last. */
972 addr->next = addr_defer;
975 /* The only currently implemented special action is to freeze the
976 message. Logging of this is done later, just before the -H file is
979 if (addr->special_action == SPECIAL_FREEZE)
981 deliver_freeze = TRUE;
982 deliver_frozen_at = time(NULL);
986 /* If doing a 2-stage queue run, we skip writing to either the message
987 log or the main log for SMTP defers. */
989 if (!queue_2stage || addr->basic_errno != 0)
993 /* For errors of the type "retry time not reached" (also remotes skipped
994 on queue run), logging is controlled by L_retry_defer. Note that this kind
995 of error number is negative, and all the retry ones are less than any
998 unsigned int use_log_selector = (addr->basic_errno <= ERRNO_RETRY_BASE)?
1001 /* Build up the line that is used for both the message log and the main
1004 s = reset_point = store_get(size);
1005 s = string_cat(s, &size, &ptr, log_address, Ustrlen(log_address));
1007 /* Either driver_name contains something and driver_kind contains
1008 " router" or " transport" (note the leading space), or driver_name is
1009 a null string and driver_kind contains "routing" without the leading
1010 space, if all routing has been deferred. When a domain has been held,
1011 so nothing has been done at all, both variables contain null strings. */
1013 if (driver_name == NULL)
1015 if (driver_kind != NULL)
1016 s = string_append(s, &size, &ptr, 2, US" ", driver_kind);
1020 if (driver_kind[1] == 't' && addr->router != NULL)
1021 s = string_append(s, &size, &ptr, 2, US" R=", addr->router->name);
1023 ss[1] = toupper(driver_kind[1]);
1024 s = string_append(s, &size, &ptr, 2, ss, driver_name);
1027 sprintf(CS ss, " defer (%d)", addr->basic_errno);
1028 s = string_cat(s, &size, &ptr, ss, Ustrlen(ss));
1030 if (addr->basic_errno > 0)
1031 s = string_append(s, &size, &ptr, 2, US": ",
1032 US strerror(addr->basic_errno));
1034 if (addr->message != NULL)
1035 s = string_append(s, &size, &ptr, 2, US": ", addr->message);
1039 /* Log the deferment in the message log, but don't clutter it
1040 up with retry-time defers after the first delivery attempt. */
1042 if (deliver_firsttime || addr->basic_errno > ERRNO_RETRY_BASE)
1043 deliver_msglog("%s %s\n", now, s);
1045 /* Write the main log and reset the store */
1047 log_write(use_log_selector, logflags, "== %s", s);
1048 store_reset(reset_point);
1053 /* Hard failure. If there is an address to which an error message can be sent,
1054 put this address on the failed list. If not, put it on the deferred list and
1055 freeze the mail message for human attention. The latter action can also be
1056 explicitly requested by a router or transport. */
1060 /* If this is a delivery error, or a message for which no replies are
1061 wanted, and the message's age is greater than ignore_bounce_errors_after,
1062 force the af_ignore_error flag. This will cause the address to be discarded
1063 later (with a log entry). */
1065 if (sender_address[0] == 0 && message_age >= ignore_bounce_errors_after)
1066 setflag(addr, af_ignore_error);
1068 /* Freeze the message if requested, or if this is a bounce message (or other
1069 message with null sender) and this address does not have its own errors
1070 address. However, don't freeze if errors are being ignored. The actual code
1071 to ignore occurs later, instead of sending a message. Logging of freezing
1072 occurs later, just before writing the -H file. */
1074 if (!testflag(addr, af_ignore_error) &&
1075 (addr->special_action == SPECIAL_FREEZE ||
1076 (sender_address[0] == 0 && addr->p.errors_address == NULL)
1079 frozen_info = (addr->special_action == SPECIAL_FREEZE)? US"" :
1080 (sender_local && !local_error_message)?
1081 US" (message created with -f <>)" : US" (delivery error message)";
1082 deliver_freeze = TRUE;
1083 deliver_frozen_at = time(NULL);
1084 update_spool = TRUE;
1086 /* The address is put on the defer rather than the failed queue, because
1087 the message is being retained. */
1089 addr->next = addr_defer;
1093 /* Don't put the address on the nonrecipients tree yet; wait until an
1094 error message has been successfully sent. */
1098 addr->next = addr_failed;
1102 /* Build up the log line for the message and main logs */
1104 s = reset_point = store_get(size);
1105 s = string_cat(s, &size, &ptr, log_address, Ustrlen(log_address));
1107 if ((log_extra_selector & LX_sender_on_delivery) != 0)
1108 s = string_append(s, &size, &ptr, 3, US" F=<", sender_address, US">");
1110 /* Return path may not be set if no delivery actually happened */
1112 if (used_return_path != NULL &&
1113 (log_extra_selector & LX_return_path_on_delivery) != 0)
1115 s = string_append(s, &size, &ptr, 3, US" P=<", used_return_path, US">");
1118 if (addr->router != NULL)
1119 s = string_append(s, &size, &ptr, 2, US" R=", addr->router->name);
1120 if (addr->transport != NULL)
1121 s = string_append(s, &size, &ptr, 2, US" T=", addr->transport->name);
1123 if (addr->host_used != NULL)
1124 s = string_append(s, &size, &ptr, 5, US" H=", addr->host_used->name,
1125 US" [", addr->host_used->address, US"]");
1127 if (addr->basic_errno > 0)
1128 s = string_append(s, &size, &ptr, 2, US": ",
1129 US strerror(addr->basic_errno));
1131 if (addr->message != NULL)
1132 s = string_append(s, &size, &ptr, 2, US": ", addr->message);
1136 /* Do the logging. For the message log, "routing failed" for those cases,
1137 just to make it clearer. */
1139 if (driver_name == NULL)
1140 deliver_msglog("%s %s failed for %s\n", now, driver_kind, s);
1142 deliver_msglog("%s %s\n", now, s);
1144 log_write(0, LOG_MAIN, "** %s", s);
1145 store_reset(reset_point);
1148 /* Ensure logging is turned on again in all cases */
1150 disable_logging = FALSE;
1156 /*************************************************
1157 * Address-independent error *
1158 *************************************************/
1160 /* This function is called when there's an error that is not dependent on a
1161 particular address, such as an expansion string failure. It puts the error into
1162 all the addresses in a batch, logs the incident on the main and panic logs, and
1163 clears the expansions. It is mostly called from local_deliver(), but can be
1164 called for a remote delivery via findugid().
1167 logit TRUE if (MAIN+PANIC) logging required
1168 addr the first of the chain of addresses
1170 format format string for error message, or NULL if already set in addr
1171 ... arguments for the format
1177 common_error(BOOL logit, address_item *addr, int code, uschar *format, ...)
1179 address_item *addr2;
1180 addr->basic_errno = code;
1186 va_start(ap, format);
1187 if (!string_vformat(buffer, sizeof(buffer), CS format, ap))
1188 log_write(0, LOG_MAIN|LOG_PANIC_DIE,
1189 "common_error expansion was longer than %d", sizeof(buffer));
1191 addr->message = string_copy(buffer);
1194 for (addr2 = addr->next; addr2 != NULL; addr2 = addr2->next)
1196 addr2->basic_errno = code;
1197 addr2->message = addr->message;
1200 if (logit) log_write(0, LOG_MAIN|LOG_PANIC, "%s", addr->message);
1201 deliver_set_expansions(NULL);
1207 /*************************************************
1208 * Check a "never users" list *
1209 *************************************************/
1211 /* This function is called to check whether a uid is on one of the two "never
1215 uid the uid to be checked
1216 nusers the list to be scanned; the first item in the list is the count
1218 Returns: TRUE if the uid is on the list
1222 check_never_users(uid_t uid, uid_t *nusers)
1225 if (nusers == NULL) return FALSE;
1226 for (i = 1; i <= (int)(nusers[0]); i++) if (nusers[i] == uid) return TRUE;
1232 /*************************************************
1233 * Find uid and gid for a transport *
1234 *************************************************/
1236 /* This function is called for both local and remote deliveries, to find the
1237 uid/gid under which to run the delivery. The values are taken preferentially
1238 from the transport (either explicit or deliver_as_creator), then from the
1239 address (i.e. the router), and if nothing is set, the exim uid/gid are used. If
1240 the resulting uid is on the "never_users" or the "fixed_never_users" list, a
1241 panic error is logged, and the function fails (which normally leads to delivery
1245 addr the address (possibly a chain)
1247 uidp pointer to uid field
1248 gidp pointer to gid field
1249 igfp pointer to the use_initgroups field
1251 Returns: FALSE if failed - error has been set in address(es)
1255 findugid(address_item *addr, transport_instance *tp, uid_t *uidp, gid_t *gidp,
1258 uschar *nuname = NULL;
1259 BOOL gid_set = FALSE;
1261 /* Default initgroups flag comes from the transport */
1263 *igfp = tp->initgroups;
1265 /* First see if there's a gid on the transport, either fixed or expandable.
1266 The expanding function always logs failure itself. */
1273 else if (tp->expand_gid != NULL)
1275 if (route_find_expanded_group(tp->expand_gid, tp->name, US"transport", gidp,
1276 &(addr->message))) gid_set = TRUE;
1279 common_error(FALSE, addr, ERRNO_GIDFAIL, NULL);
1284 /* Pick up a uid from the transport if one is set. */
1286 if (tp->uid_set) *uidp = tp->uid;
1288 /* Otherwise, try for an expandable uid field. If it ends up as a numeric id,
1289 it does not provide a passwd value from which a gid can be taken. */
1291 else if (tp->expand_uid != NULL)
1294 if (!route_find_expanded_user(tp->expand_uid, tp->name, US"transport", &pw,
1295 uidp, &(addr->message)))
1297 common_error(FALSE, addr, ERRNO_UIDFAIL, NULL);
1300 if (!gid_set && pw != NULL)
1307 /* If the transport doesn't set the uid, test the deliver_as_creator flag. */
1309 else if (tp->deliver_as_creator)
1311 *uidp = originator_uid;
1314 *gidp = originator_gid;
1319 /* Otherwise see if the address specifies the uid and if so, take its
1320 initgroups flag. The gid from the address is taken only if the transport hasn't
1321 set it. In other words, a gid on the transport overrides the gid on the
1324 else if (testflag(addr, af_uid_set))
1327 *igfp = testflag(addr, af_initgroups);
1335 /* Nothing has specified the uid - default to the Exim user, and group if the
1348 /* If no gid is set, it is a disaster. */
1352 common_error(TRUE, addr, ERRNO_GIDFAIL, US"User set without group for "
1353 "%s transport", tp->name);
1357 /* Check that the uid is not on the lists of banned uids that may not be used
1358 for delivery processes. */
1360 if (check_never_users(*uidp, never_users))
1361 nuname = US"never_users";
1362 else if (check_never_users(*uidp, fixed_never_users))
1363 nuname = US"fixed_never_users";
1367 common_error(TRUE, addr, ERRNO_UIDFAIL, US"User %ld set for %s transport "
1368 "is on the %s list", (long int)(*uidp), tp->name, nuname);
1380 /*************************************************
1381 * Check the size of a message for a transport *
1382 *************************************************/
1384 /* Checks that the message isn't too big for the selected transport.
1385 This is called only when it is known that the limit is set.
1389 addr the (first) address being delivered
1392 DEFER expansion failed or did not yield an integer
1393 FAIL message too big
1397 check_message_size(transport_instance *tp, address_item *addr)
1402 deliver_set_expansions(addr);
1403 size_limit = expand_string_integer(tp->message_size_limit);
1404 deliver_set_expansions(NULL);
1409 if (size_limit == -1)
1410 addr->message = string_sprintf("failed to expand message_size_limit "
1411 "in %s transport: %s", tp->name, expand_string_message);
1413 addr->message = string_sprintf("invalid message_size_limit "
1414 "in %s transport: %s", tp->name, expand_string_message);
1416 else if (size_limit > 0 && message_size > size_limit)
1420 string_sprintf("message is too big (transport limit = %d)",
1429 /*************************************************
1430 * Transport-time check for a previous delivery *
1431 *************************************************/
1433 /* Check that this base address hasn't previously been delivered to its routed
1434 transport. The check is necessary at delivery time in order to handle homonymic
1435 addresses correctly in cases where the pattern of redirection changes between
1436 delivery attempts (so the unique fields change). Non-homonymic previous
1437 delivery is detected earlier, at routing time (which saves unnecessary
1440 Argument: the address item
1441 Returns: TRUE if previously delivered by the transport
1445 previously_transported(address_item *addr)
1447 (void)string_format(big_buffer, big_buffer_size, "%s/%s",
1448 addr->unique + (testflag(addr, af_homonym)? 3:0), addr->transport->name);
1450 if (tree_search(tree_nonrecipients, big_buffer) != 0)
1452 DEBUG(D_deliver|D_route|D_transport)
1453 debug_printf("%s was previously delivered (%s transport): discarded\n",
1454 addr->address, addr->transport->name);
1455 child_done(addr, tod_stamp(tod_log));
1465 /*************************************************
1466 * Perform a local delivery *
1467 *************************************************/
1469 /* Each local delivery is performed in a separate process which sets its
1470 uid and gid as specified. This is a safer way than simply changing and
1471 restoring using seteuid(); there is a body of opinion that seteuid() cannot be
1472 used safely. From release 4, Exim no longer makes any use of it. Besides, not
1473 all systems have seteuid().
1475 If the uid/gid are specified in the transport_instance, they are used; the
1476 transport initialization must ensure that either both or neither are set.
1477 Otherwise, the values associated with the address are used. If neither are set,
1478 it is a configuration error.
1480 The transport or the address may specify a home directory (transport over-
1481 rides), and if they do, this is set as $home. If neither have set a working
1482 directory, this value is used for that as well. Otherwise $home is left unset
1483 and the cwd is set to "/" - a directory that should be accessible to all users.
1485 Using a separate process makes it more complicated to get error information
1486 back. We use a pipe to pass the return code and also an error code and error
1487 text string back to the parent process.
1490 addr points to an address block for this delivery; for "normal" local
1491 deliveries this is the only address to be delivered, but for
1492 pseudo-remote deliveries (e.g. by batch SMTP to a file or pipe)
1493 a number of addresses can be handled simultaneously, and in this
1494 case addr will point to a chain of addresses with the same
1497 shadowing TRUE if running a shadow transport; this causes output from pipes
1504 deliver_local(address_item *addr, BOOL shadowing)
1506 BOOL use_initgroups;
1509 int status, len, rc;
1512 uschar *working_directory;
1513 address_item *addr2;
1514 transport_instance *tp = addr->transport;
1516 /* Set up the return path from the errors or sender address. If the transport
1517 has its own return path setting, expand it and replace the existing value. */
1519 return_path = (addr->p.errors_address != NULL)?
1520 addr->p.errors_address : sender_address;
1522 if (tp->return_path != NULL)
1524 uschar *new_return_path = expand_string(tp->return_path);
1525 if (new_return_path == NULL)
1527 if (!expand_string_forcedfail)
1529 common_error(TRUE, addr, ERRNO_EXPANDFAIL,
1530 US"Failed to expand return path \"%s\" in %s transport: %s",
1531 tp->return_path, tp->name, expand_string_message);
1535 else return_path = new_return_path;
1538 /* For local deliveries, one at a time, the value used for logging can just be
1539 set directly, once and for all. */
1541 used_return_path = return_path;
1543 /* Sort out the uid, gid, and initgroups flag. If an error occurs, the message
1544 gets put into the address(es), and the expansions are unset, so we can just
1547 if (!findugid(addr, tp, &uid, &gid, &use_initgroups)) return;
1549 /* See if either the transport or the address specifies a home and/or a current
1550 working directory. Expand it if necessary. If nothing is set, use "/", for the
1551 working directory, which is assumed to be a directory to which all users have
1552 access. It is necessary to be in a visible directory for some operating systems
1553 when running pipes, as some commands (e.g. "rm" under Solaris 2.5) require
1556 deliver_home = (tp->home_dir != NULL)? tp->home_dir :
1557 (addr->home_dir != NULL)? addr->home_dir : NULL;
1559 if (deliver_home != NULL && !testflag(addr, af_home_expanded))
1561 uschar *rawhome = deliver_home;
1562 deliver_home = NULL; /* in case it contains $home */
1563 deliver_home = expand_string(rawhome);
1564 if (deliver_home == NULL)
1566 common_error(TRUE, addr, ERRNO_EXPANDFAIL, US"home directory \"%s\" failed "
1567 "to expand for %s transport: %s", rawhome, tp->name,
1568 expand_string_message);
1571 if (*deliver_home != '/')
1573 common_error(TRUE, addr, ERRNO_NOTABSOLUTE, US"home directory path \"%s\" "
1574 "is not absolute for %s transport", deliver_home, tp->name);
1579 working_directory = (tp->current_dir != NULL)? tp->current_dir :
1580 (addr->current_dir != NULL)? addr->current_dir : NULL;
1582 if (working_directory != NULL)
1584 uschar *raw = working_directory;
1585 working_directory = expand_string(raw);
1586 if (working_directory == NULL)
1588 common_error(TRUE, addr, ERRNO_EXPANDFAIL, US"current directory \"%s\" "
1589 "failed to expand for %s transport: %s", raw, tp->name,
1590 expand_string_message);
1593 if (*working_directory != '/')
1595 common_error(TRUE, addr, ERRNO_NOTABSOLUTE, US"current directory path "
1596 "\"%s\" is not absolute for %s transport", working_directory, tp->name);
1600 else working_directory = (deliver_home == NULL)? US"/" : deliver_home;
1602 /* If one of the return_output flags is set on the transport, create and open a
1603 file in the message log directory for the transport to write its output onto.
1604 This is mainly used by pipe transports. The file needs to be unique to the
1605 address. This feature is not available for shadow transports. */
1607 if (!shadowing && (tp->return_output || tp->return_fail_output ||
1608 tp->log_output || tp->log_fail_output))
1611 addr->return_filename =
1612 string_sprintf("%s/msglog/%s/%s-%d-%d", spool_directory, message_subdir,
1613 message_id, getpid(), return_count++);
1614 addr->return_file = open_msglog_file(addr->return_filename, 0400, &error);
1615 if (addr->return_file < 0)
1617 common_error(TRUE, addr, errno, US"Unable to %s file for %s transport "
1618 "to return message: %s", error, tp->name, strerror(errno));
1623 /* Create the pipe for inter-process communication. */
1627 common_error(TRUE, addr, ERRNO_PIPEFAIL, US"Creation of pipe failed: %s",
1632 /* Now fork the process to do the real work in the subprocess, but first
1633 ensure that all cached resources are freed so that the subprocess starts with
1634 a clean slate and doesn't interfere with the parent process. */
1638 if ((pid = fork()) == 0)
1640 BOOL replicate = TRUE;
1642 /* Prevent core dumps, as we don't want them in users' home directories.
1643 HP-UX doesn't have RLIMIT_CORE; I don't know how to do this in that
1644 system. Some experimental/developing systems (e.g. GNU/Hurd) may define
1645 RLIMIT_CORE but not support it in setrlimit(). For such systems, do not
1646 complain if the error is "not supported". */
1652 if (setrlimit(RLIMIT_CORE, &rl) < 0)
1654 #ifdef SETRLIMIT_NOT_SUPPORTED
1655 if (errno != ENOSYS && errno != ENOTSUP)
1657 log_write(0, LOG_MAIN|LOG_PANIC, "setrlimit(RLIMIT_CORE) failed: %s",
1662 /* Reset the random number generator, so different processes don't all
1663 have the same sequence. */
1667 /* If the transport has a setup entry, call this first, while still
1668 privileged. (Appendfile uses this to expand quota, for example, while
1669 able to read private files.) */
1671 if (addr->transport->setup != NULL)
1673 switch((addr->transport->setup)(addr->transport, addr, NULL,
1677 addr->transport_return = DEFER;
1681 addr->transport_return = PANIC;
1686 /* Ignore SIGINT and SIGTERM during delivery. Also ignore SIGUSR1, as
1687 when the process becomes unprivileged, it won't be able to write to the
1688 process log. SIGHUP is ignored throughout exim, except when it is being
1691 signal(SIGINT, SIG_IGN);
1692 signal(SIGTERM, SIG_IGN);
1693 signal(SIGUSR1, SIG_IGN);
1695 /* Close the unwanted half of the pipe, and set close-on-exec for the other
1696 half - for transports that exec things (e.g. pipe). Then set the required
1699 close(pfd[pipe_read]);
1700 fcntl(pfd[pipe_write], F_SETFD, fcntl(pfd[pipe_write], F_GETFD) |
1702 exim_setugid(uid, gid, use_initgroups,
1703 string_sprintf("local delivery to %s <%s> transport=%s", addr->local_part,
1704 addr->address, addr->transport->name));
1708 address_item *batched;
1709 debug_printf(" home=%s current=%s\n", deliver_home, working_directory);
1710 for (batched = addr->next; batched != NULL; batched = batched->next)
1711 debug_printf("additional batched address: %s\n", batched->address);
1714 /* Set an appropriate working directory. */
1716 if (Uchdir(working_directory) < 0)
1718 addr->transport_return = DEFER;
1719 addr->basic_errno = errno;
1720 addr->message = string_sprintf("failed to chdir to %s", working_directory);
1723 /* If successful, call the transport */
1728 set_process_info("delivering %s to %s using %s", message_id,
1729 addr->local_part, addr->transport->name);
1731 /* If a transport filter has been specified, set up its argument list.
1732 Any errors will get put into the address, and FALSE yielded. */
1734 if (addr->transport->filter_command != NULL)
1736 ok = transport_set_up_command(&transport_filter_argv,
1737 addr->transport->filter_command,
1738 TRUE, PANIC, addr, US"transport filter", NULL);
1739 transport_filter_timeout = addr->transport->filter_timeout;
1741 else transport_filter_argv = NULL;
1745 debug_print_string(addr->transport->debug_string);
1746 replicate = !(addr->transport->info->code)(addr->transport, addr);
1750 /* Pass the results back down the pipe. If necessary, first replicate the
1751 status in the top address to the others in the batch. The label is the
1752 subject of a goto when a call to the transport's setup function fails. We
1753 pass the pointer to the transport back in case it got changed as a result of
1754 file_format in appendfile. */
1758 if (replicate) replicate_status(addr);
1759 for (addr2 = addr; addr2 != NULL; addr2 = addr2->next)
1762 int local_part_length = Ustrlen(addr2->local_part);
1765 write(pfd[pipe_write], (void *)&(addr2->transport_return), sizeof(int));
1766 write(pfd[pipe_write], (void *)&transport_count, sizeof(transport_count));
1767 write(pfd[pipe_write], (void *)&(addr2->flags), sizeof(addr2->flags));
1768 write(pfd[pipe_write], (void *)&(addr2->basic_errno), sizeof(int));
1769 write(pfd[pipe_write], (void *)&(addr2->more_errno), sizeof(int));
1770 write(pfd[pipe_write], (void *)&(addr2->special_action), sizeof(int));
1771 write(pfd[pipe_write], (void *)&(addr2->transport),
1772 sizeof(transport_instance *));
1774 /* For a file delivery, pass back the local part, in case the original
1775 was only part of the final delivery path. This gives more complete
1778 if (testflag(addr2, af_file))
1780 write(pfd[pipe_write], (void *)&local_part_length, sizeof(int));
1781 write(pfd[pipe_write], addr2->local_part, local_part_length);
1784 /* Now any messages */
1786 for (i = 0, s = addr2->message; i < 2; i++, s = addr2->user_message)
1788 int message_length = (s == NULL)? 0 : Ustrlen(s) + 1;
1789 write(pfd[pipe_write], (void *)&message_length, sizeof(int));
1790 if (message_length > 0) write(pfd[pipe_write], s, message_length);
1794 /* OK, this process is now done. Free any cached resources that it opened,
1795 and close the pipe we were writing down before exiting. */
1797 close(pfd[pipe_write]);
1802 /* Back in the main process: panic if the fork did not succeed. This seems
1803 better than returning an error - if forking is failing it is probably best
1804 not to try other deliveries for this message. */
1807 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Fork failed for local delivery to %s",
1810 /* Read the pipe to get the delivery status codes and error messages. Our copy
1811 of the writing end must be closed first, as otherwise read() won't return zero
1812 on an empty pipe. We check that a status exists for each address before
1813 overwriting the address structure. If data is missing, the default DEFER status
1814 will remain. Afterwards, close the reading end. */
1816 close(pfd[pipe_write]);
1818 for (addr2 = addr; addr2 != NULL; addr2 = addr2->next)
1820 len = read(pfd[pipe_read], (void *)&status, sizeof(int));
1826 addr2->transport_return = status;
1827 len = read(pfd[pipe_read], (void *)&transport_count,
1828 sizeof(transport_count));
1829 len = read(pfd[pipe_read], (void *)&(addr2->flags), sizeof(addr2->flags));
1830 len = read(pfd[pipe_read], (void *)&(addr2->basic_errno), sizeof(int));
1831 len = read(pfd[pipe_read], (void *)&(addr2->more_errno), sizeof(int));
1832 len = read(pfd[pipe_read], (void *)&(addr2->special_action), sizeof(int));
1833 len = read(pfd[pipe_read], (void *)&(addr2->transport),
1834 sizeof(transport_instance *));
1836 if (testflag(addr2, af_file))
1838 int local_part_length;
1839 len = read(pfd[pipe_read], (void *)&local_part_length, sizeof(int));
1840 len = read(pfd[pipe_read], (void *)big_buffer, local_part_length);
1841 big_buffer[local_part_length] = 0;
1842 addr2->local_part = string_copy(big_buffer);
1845 for (i = 0, sptr = &(addr2->message); i < 2;
1846 i++, sptr = &(addr2->user_message))
1849 len = read(pfd[pipe_read], (void *)&message_length, sizeof(int));
1850 if (message_length > 0)
1852 len = read(pfd[pipe_read], (void *)big_buffer, message_length);
1853 if (len > 0) *sptr = string_copy(big_buffer);
1860 log_write(0, LOG_MAIN|LOG_PANIC, "failed to read delivery status for %s "
1861 "from delivery subprocess", addr2->unique);
1866 close(pfd[pipe_read]);
1868 /* Unless shadowing, write all successful addresses immediately to the journal
1869 file, to ensure they are recorded asap. For homonymic addresses, use the base
1870 address plus the transport name. Failure to write the journal is panic-worthy,
1871 but don't stop, as it may prove possible subsequently to update the spool file
1872 in order to record the delivery. */
1876 for (addr2 = addr; addr2 != NULL; addr2 = addr2->next)
1878 if (addr2->transport_return != OK) continue;
1880 if (testflag(addr2, af_homonym))
1881 sprintf(CS big_buffer, "%.500s/%s\n", addr2->unique + 3, tp->name);
1883 sprintf(CS big_buffer, "%.500s\n", addr2->unique);
1885 /* In the test harness, wait just a bit to let the subprocess finish off
1886 any debug output etc first. */
1888 if (running_in_test_harness) millisleep(300);
1890 DEBUG(D_deliver) debug_printf("journalling %s", big_buffer);
1891 len = Ustrlen(big_buffer);
1892 if (write(journal_fd, big_buffer, len) != len)
1893 log_write(0, LOG_MAIN|LOG_PANIC, "failed to update journal for %s: %s",
1894 big_buffer, strerror(errno));
1897 /* Ensure the journal file is pushed out to disk. */
1899 if (fsync(journal_fd) < 0)
1900 log_write(0, LOG_MAIN|LOG_PANIC, "failed to fsync journal: %s",
1904 /* Wait for the process to finish. If it terminates with a non-zero code,
1905 freeze the message (except for SIGTERM, SIGKILL and SIGQUIT), but leave the
1906 status values of all the addresses as they are. Take care to handle the case
1907 when the subprocess doesn't seem to exist. This has been seen on one system
1908 when Exim was called from an MUA that set SIGCHLD to SIG_IGN. When that
1909 happens, wait() doesn't recognize the termination of child processes. Exim now
1910 resets SIGCHLD to SIG_DFL, but this code should still be robust. */
1912 while ((rc = wait(&status)) != pid)
1914 if (rc < 0 && errno == ECHILD) /* Process has vanished */
1916 log_write(0, LOG_MAIN, "%s transport process vanished unexpectedly",
1917 addr->transport->driver_name);
1923 if ((status & 0xffff) != 0)
1925 int msb = (status >> 8) & 255;
1926 int lsb = status & 255;
1927 int code = (msb == 0)? (lsb & 0x7f) : msb;
1928 if (msb != 0 || (code != SIGTERM && code != SIGKILL && code != SIGQUIT))
1929 addr->special_action = SPECIAL_FREEZE;
1930 log_write(0, LOG_MAIN|LOG_PANIC, "%s transport process returned non-zero "
1931 "status 0x%04x: %s %d",
1932 addr->transport->driver_name,
1934 (msb == 0)? "terminated by signal" : "exit code",
1938 /* If SPECIAL_WARN is set in the top address, send a warning message. */
1940 if (addr->special_action == SPECIAL_WARN &&
1941 addr->transport->warn_message != NULL)
1944 uschar *warn_message;
1946 DEBUG(D_deliver) debug_printf("Warning message requested by transport\n");
1948 warn_message = expand_string(addr->transport->warn_message);
1949 if (warn_message == NULL)
1950 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand \"%s\" (warning "
1951 "message for %s transport): %s", addr->transport->warn_message,
1952 addr->transport->name, expand_string_message);
1955 pid_t pid = child_open_exim(&fd);
1958 FILE *f = fdopen(fd, "wb");
1960 if (errors_reply_to != NULL)
1961 fprintf(f, "Reply-To: %s\n", errors_reply_to);
1962 fprintf(f, "Auto-Submitted: auto-generated\n");
1963 fprintf(f, "From: Mail Delivery System <Mailer-Daemon@%s>\n",
1964 qualify_domain_sender);
1965 fprintf(f, "%s", CS warn_message);
1967 /* Close and wait for child process to complete, without a timeout. */
1970 (void)child_close(pid, 0);
1974 addr->special_action = SPECIAL_NONE;
1980 /*************************************************
1981 * Do local deliveries *
1982 *************************************************/
1984 /* This function processes the list of addresses in addr_local. True local
1985 deliveries are always done one address at a time. However, local deliveries can
1986 be batched up in some cases. Typically this is when writing batched SMTP output
1987 files for use by some external transport mechanism, or when running local
1988 deliveries over LMTP.
1995 do_local_deliveries(void)
1998 open_db *dbm_file = NULL;
1999 time_t now = time(NULL);
2001 /* Loop until we have exhausted the supply of local deliveries */
2003 while (addr_local != NULL)
2005 time_t delivery_start;
2007 address_item *addr2, *addr3, *nextaddr;
2008 int logflags = LOG_MAIN;
2009 int logchar = dont_deliver? '*' : '=';
2010 transport_instance *tp;
2012 /* Pick the first undelivered address off the chain */
2014 address_item *addr = addr_local;
2015 addr_local = addr->next;
2018 DEBUG(D_deliver|D_transport)
2019 debug_printf("--------> %s <--------\n", addr->address);
2021 /* An internal disaster if there is no transport. Should not occur! */
2023 if ((tp = addr->transport) == NULL)
2025 logflags |= LOG_PANIC;
2026 disable_logging = FALSE; /* Jic */
2028 (addr->router != NULL)?
2029 string_sprintf("No transport set by %s router", addr->router->name)
2031 string_sprintf("No transport set by system filter");
2032 post_process_one(addr, DEFER, logflags, DTYPE_TRANSPORT, 0);
2036 /* Check that this base address hasn't previously been delivered to this
2037 transport. The check is necessary at this point to handle homonymic addresses
2038 correctly in cases where the pattern of redirection changes between delivery
2039 attempts. Non-homonymic previous delivery is detected earlier, at routing
2042 if (previously_transported(addr)) continue;
2044 /* There are weird cases where logging is disabled */
2046 disable_logging = tp->disable_logging;
2048 /* Check for batched addresses and possible amalgamation. File deliveries can
2049 never be batched. Skip all the work if either batch_max <= 1 or there aren't
2050 any other addresses for local delivery. */
2052 if (!testflag(addr, af_file) && tp->batch_max > 1 && addr_local != NULL)
2054 int batch_count = 1;
2055 BOOL uses_dom = readconf_depends((driver_instance *)tp, US"domain");
2056 BOOL uses_lp = readconf_depends((driver_instance *)tp, US"local_part");
2057 uschar *batch_id = NULL;
2058 address_item **anchor = &addr_local;
2059 address_item *last = addr;
2062 /* Expand the batch_id string for comparison with other addresses.
2063 Expansion failure suppresses batching. */
2065 if (tp->batch_id != NULL)
2067 deliver_set_expansions(addr);
2068 batch_id = expand_string(tp->batch_id);
2069 deliver_set_expansions(NULL);
2070 if (batch_id == NULL)
2072 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand batch_id option "
2073 "in %s transport (%s): %s", tp->name, addr->address,
2074 expand_string_message);
2075 batch_count = tp->batch_max;
2079 /* Until we reach the batch_max limit, pick off addresses which have the
2080 same characteristics. These are:
2083 not previously delivered (see comment about 50 lines above)
2084 same local part if the transport's configuration contains $local_part
2085 same domain if the transport's configuration contains $domain
2087 same additional headers
2088 same headers to be removed
2089 same uid/gid for running the transport
2090 same first host if a host list is set
2093 while ((next = *anchor) != NULL && batch_count < tp->batch_max)
2096 tp == next->transport &&
2097 !previously_transported(next) &&
2098 (!uses_lp || Ustrcmp(next->local_part, addr->local_part) == 0) &&
2099 (!uses_dom || Ustrcmp(next->domain, addr->domain) == 0) &&
2100 same_strings(next->p.errors_address, addr->p.errors_address) &&
2101 same_headers(next->p.extra_headers, addr->p.extra_headers) &&
2102 same_strings(next->p.remove_headers, addr->p.remove_headers) &&
2103 same_ugid(tp, addr, next) &&
2104 ((addr->host_list == NULL && next->host_list == NULL) ||
2105 (addr->host_list != NULL && next->host_list != NULL &&
2106 Ustrcmp(addr->host_list->name, next->host_list->name) == 0));
2108 /* If the transport has a batch_id setting, batch_id will be non-NULL
2109 from the expansion outside the loop. Expand for this address and compare.
2110 Expansion failure makes this address ineligible for batching. */
2112 if (ok && batch_id != NULL)
2115 address_item *save_nextnext = next->next;
2116 next->next = NULL; /* Expansion for a single address */
2117 deliver_set_expansions(next);
2118 next->next = save_nextnext;
2119 bid = expand_string(tp->batch_id);
2120 deliver_set_expansions(NULL);
2123 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand batch_id option "
2124 "in %s transport (%s): %s", tp->name, next->address,
2125 expand_string_message);
2128 else ok = (Ustrcmp(batch_id, bid) == 0);
2131 /* Take address into batch if OK. */
2135 *anchor = next->next; /* Include the address */
2141 else anchor = &(next->next); /* Skip the address */
2145 /* We now have one or more addresses that can be delivered in a batch. Check
2146 whether the transport is prepared to accept a message of this size. If not,
2147 fail them all forthwith. If the expansion fails, or does not yield an
2148 integer, defer delivery. */
2150 if (tp->message_size_limit != NULL)
2152 int rc = check_message_size(tp, addr);
2155 replicate_status(addr);
2156 while (addr != NULL)
2159 post_process_one(addr, rc, logflags, DTYPE_TRANSPORT, 0);
2162 continue; /* With next batch of addresses */
2166 /* If we are not running the queue, or if forcing, all deliveries will be
2167 attempted. Otherwise, we must respect the retry times for each address. Even
2168 when not doing this, we need to set up the retry key string, and determine
2169 whether a retry record exists, because after a successful delivery, a delete
2170 retry item must be set up. Keep the retry database open only for the duration
2171 of these checks, rather than for all local deliveries, because some local
2172 deliveries (e.g. to pipes) can take a substantial time. */
2174 dbm_file = dbfn_open(US"retry", O_RDONLY, &dbblock, FALSE);
2175 if (dbm_file == NULL)
2177 DEBUG(D_deliver|D_retry|D_hints_lookup)
2178 debug_printf("no retry data available\n");
2183 while (addr2 != NULL)
2185 BOOL ok = TRUE; /* to deliver this address */
2188 /* Set up the retry key to include the domain or not, and change its
2189 leading character from "R" to "T". Must make a copy before doing this,
2190 because the old key may be pointed to from a "delete" retry item after
2193 retry_key = string_copy(
2194 (tp->retry_use_local_part)? addr2->address_retry_key :
2195 addr2->domain_retry_key);
2198 /* Inspect the retry data. If there is no hints file, delivery happens. */
2200 if (dbm_file != NULL)
2202 dbdata_retry *retry_record = dbfn_read(dbm_file, retry_key);
2204 /* If there is no retry record, delivery happens. If there is,
2205 remember it exists so it can be deleted after a successful delivery. */
2207 if (retry_record != NULL)
2209 setflag(addr2, af_lt_retry_exists);
2211 /* A retry record exists for this address. If queue running and not
2212 forcing, inspect its contents. If the record is too old, or if its
2213 retry time has come, or if it has passed its cutoff time, delivery
2218 debug_printf("retry record exists: age=%d (max=%d)\n",
2219 (int)(now - retry_record->time_stamp), retry_data_expire);
2220 debug_printf(" time to retry = %d expired = %d\n",
2221 (int)(now - retry_record->next_try), retry_record->expired);
2224 if (queue_running && !deliver_force)
2226 ok = (now - retry_record->time_stamp > retry_data_expire) ||
2227 (now >= retry_record->next_try) ||
2228 retry_record->expired;
2230 /* If we haven't reached the retry time, there is one more check
2231 to do, which is for the ultimate address timeout. */
2235 retry_config *retry =
2236 retry_find_config(retry_key+2, addr2->domain,
2237 retry_record->basic_errno,
2238 retry_record->more_errno);
2240 DEBUG(D_deliver|D_retry)
2241 debug_printf("retry time not reached for %s: "
2242 "checking ultimate address timeout\n", addr2->address);
2244 if (retry != NULL && retry->rules != NULL)
2246 retry_rule *last_rule;
2247 for (last_rule = retry->rules;
2248 last_rule->next != NULL;
2249 last_rule = last_rule->next);
2250 if (now - received_time > last_rule->timeout) ok = TRUE;
2252 else ok = TRUE; /* No rule => timed out */
2254 DEBUG(D_deliver|D_retry)
2256 if (ok) debug_printf("on queue longer than maximum retry for "
2257 "address - allowing delivery\n");
2262 else DEBUG(D_retry) debug_printf("no retry record exists\n");
2265 /* This address is to be delivered. Leave it on the chain. */
2270 addr2 = addr2->next;
2273 /* This address is to be deferred. Take it out of the chain, and
2274 post-process it as complete. Must take it out of the chain first,
2275 because post processing puts it on another chain. */
2279 address_item *this = addr2;
2280 this->message = US"Retry time not yet reached";
2281 this->basic_errno = ERRNO_LRETRY;
2282 if (addr3 == NULL) addr2 = addr = addr2->next;
2283 else addr2 = addr3->next = addr2->next;
2284 post_process_one(this, DEFER, logflags, DTYPE_TRANSPORT, 0);
2288 if (dbm_file != NULL) dbfn_close(dbm_file);
2290 /* If there are no addresses left on the chain, they all deferred. Loop
2291 for the next set of addresses. */
2293 if (addr == NULL) continue;
2295 /* So, finally, we do have some addresses that can be passed to the
2296 transport. Before doing so, set up variables that are relevant to a
2299 deliver_set_expansions(addr);
2300 delivery_start = time(NULL);
2301 deliver_local(addr, FALSE);
2302 deliver_time = (int)(time(NULL) - delivery_start);
2304 /* If a shadow transport (which must perforce be another local transport), is
2305 defined, and its condition is met, we must pass the message to the shadow
2306 too, but only those addresses that succeeded. We do this by making a new
2307 chain of addresses - also to keep the original chain uncontaminated. We must
2308 use a chain rather than doing it one by one, because the shadow transport may
2311 NOTE: if the condition fails because of a lookup defer, there is nothing we
2314 if (tp->shadow != NULL &&
2315 (tp->shadow_condition == NULL ||
2316 expand_check_condition(tp->shadow_condition, tp->name, US"transport")))
2318 transport_instance *stp;
2319 address_item *shadow_addr = NULL;
2320 address_item **last = &shadow_addr;
2322 for (stp = transports; stp != NULL; stp = stp->next)
2323 if (Ustrcmp(stp->name, tp->shadow) == 0) break;
2326 log_write(0, LOG_MAIN|LOG_PANIC, "shadow transport \"%s\" not found ",
2329 /* Pick off the addresses that have succeeded, and make clones. Put into
2330 the shadow_message field a pointer to the shadow_message field of the real
2333 else for (addr2 = addr; addr2 != NULL; addr2 = addr2->next)
2335 if (addr2->transport_return != OK) continue;
2336 addr3 = store_get(sizeof(address_item));
2339 addr3->shadow_message = (uschar *)(&(addr2->shadow_message));
2340 addr3->transport = stp;
2341 addr3->transport_return = DEFER;
2342 addr3->return_filename = NULL;
2343 addr3->return_file = -1;
2345 last = &(addr3->next);
2348 /* If we found any addresses to shadow, run the delivery, and stick any
2349 message back into the shadow_message field in the original. */
2351 if (shadow_addr != NULL)
2353 int save_count = transport_count;
2355 DEBUG(D_deliver|D_transport)
2356 debug_printf(">>>>>>>>>>>>>>>> Shadow delivery >>>>>>>>>>>>>>>>\n");
2357 deliver_local(shadow_addr, TRUE);
2359 for(; shadow_addr != NULL; shadow_addr = shadow_addr->next)
2361 int sresult = shadow_addr->transport_return;
2362 *((uschar **)(shadow_addr->shadow_message)) = (sresult == OK)?
2363 string_sprintf(" ST=%s", stp->name) :
2364 string_sprintf(" ST=%s (%s%s%s)", stp->name,
2365 (shadow_addr->basic_errno <= 0)?
2366 US"" : US strerror(shadow_addr->basic_errno),
2367 (shadow_addr->basic_errno <= 0 || shadow_addr->message == NULL)?
2369 (shadow_addr->message != NULL)? shadow_addr->message :
2370 (shadow_addr->basic_errno <= 0)? US"unknown error" : US"");
2372 DEBUG(D_deliver|D_transport)
2373 debug_printf("%s shadow transport returned %s for %s\n",
2375 (sresult == OK)? "OK" :
2376 (sresult == DEFER)? "DEFER" :
2377 (sresult == FAIL)? "FAIL" :
2378 (sresult == PANIC)? "PANIC" : "?",
2379 shadow_addr->address);
2382 DEBUG(D_deliver|D_transport)
2383 debug_printf(">>>>>>>>>>>>>>>> End shadow delivery >>>>>>>>>>>>>>>>\n");
2385 transport_count = save_count; /* Restore original transport count */
2389 /* Cancel the expansions that were set up for the delivery. */
2391 deliver_set_expansions(NULL);
2393 /* Now we can process the results of the real transport. We must take each
2394 address off the chain first, because post_process_one() puts it on another
2397 for (addr2 = addr; addr2 != NULL; addr2 = nextaddr)
2399 int result = addr2->transport_return;
2400 nextaddr = addr2->next;
2402 DEBUG(D_deliver|D_transport)
2403 debug_printf("%s transport returned %s for %s\n",
2405 (result == OK)? "OK" :
2406 (result == DEFER)? "DEFER" :
2407 (result == FAIL)? "FAIL" :
2408 (result == PANIC)? "PANIC" : "?",
2411 /* If there is a retry_record, or if delivery is deferred, build a retry
2412 item for setting a new retry time or deleting the old retry record from
2413 the database. These items are handled all together after all addresses
2414 have been handled (so the database is open just for a short time for
2417 if (result == DEFER || testflag(addr2, af_lt_retry_exists))
2419 int flags = (result == DEFER)? 0 : rf_delete;
2420 uschar *retry_key = string_copy((tp->retry_use_local_part)?
2421 addr2->address_retry_key : addr2->domain_retry_key);
2423 retry_add_item(addr2, retry_key, flags);
2426 /* Done with this address */
2428 if (result == OK) addr2->more_errno = deliver_time;
2429 post_process_one(addr2, result, logflags, DTYPE_TRANSPORT, logchar);
2431 /* If a pipe delivery generated text to be sent back, the result may be
2432 changed to FAIL, and we must copy this for subsequent addresses in the
2435 if (addr2->transport_return != result)
2437 for (addr3 = nextaddr; addr3 != NULL; addr3 = addr3->next)
2439 addr3->transport_return = addr2->transport_return;
2440 addr3->basic_errno = addr2->basic_errno;
2441 addr3->message = addr2->message;
2443 result = addr2->transport_return;
2446 /* Whether or not the result was changed to FAIL, we need to copy the
2447 return_file value from the first address into all the addresses of the
2448 batch, so they are all listed in the error message. */
2450 addr2->return_file = addr->return_file;
2452 /* Change log character for recording successful deliveries. */
2454 if (result == OK) logchar = '-';
2456 } /* Loop back for next batch of addresses */
2462 /*************************************************
2463 * Sort remote deliveries *
2464 *************************************************/
2466 /* This function is called if remote_sort_domains is set. It arranges that the
2467 chain of addresses for remote deliveries is ordered according to the strings
2468 specified. Try to make this shuffling reasonably efficient by handling
2469 sequences of addresses rather than just single ones.
2476 sort_remote_deliveries(void)
2479 address_item **aptr = &addr_remote;
2480 uschar *listptr = remote_sort_domains;
2484 while (*aptr != NULL &&
2485 (pattern = string_nextinlist(&listptr, &sep, patbuf, sizeof(patbuf)))
2488 address_item *moved = NULL;
2489 address_item **bptr = &moved;
2491 while (*aptr != NULL)
2493 address_item **next;
2494 deliver_domain = (*aptr)->domain; /* set $domain */
2495 if (match_isinlist(deliver_domain, &pattern, UCHAR_MAX+1,
2496 &domainlist_anchor, NULL, MCL_DOMAIN, TRUE, NULL) == OK)
2498 aptr = &((*aptr)->next);
2502 next = &((*aptr)->next);
2503 while (*next != NULL &&
2504 (deliver_domain = (*next)->domain, /* Set $domain */
2505 match_isinlist(deliver_domain, &pattern, UCHAR_MAX+1,
2506 &domainlist_anchor, NULL, MCL_DOMAIN, TRUE, NULL)) != OK)
2507 next = &((*next)->next);
2509 /* If the batch of non-matchers is at the end, add on any that were
2510 extracted further up the chain, and end this iteration. Otherwise,
2511 extract them from the chain and hang on the moved chain. */
2523 aptr = &((*aptr)->next);
2526 /* If the loop ended because the final address matched, *aptr will
2527 be NULL. Add on to the end any extracted non-matching addresses. If
2528 *aptr is not NULL, the loop ended via "break" when *next is null, that
2529 is, there was a string of non-matching addresses at the end. In this
2530 case the extracted addresses have already been added on the end. */
2532 if (*aptr == NULL) *aptr = moved;
2538 debug_printf("remote addresses after sorting:\n");
2539 for (addr = addr_remote; addr != NULL; addr = addr->next)
2540 debug_printf(" %s\n", addr->address);
2546 /*************************************************
2547 * Read from pipe for remote delivery subprocess *
2548 *************************************************/
2550 /* This function is called when the subprocess is complete, but can also be
2551 called before it is complete, in order to empty a pipe that is full (to prevent
2552 deadlock). It must therefore keep track of its progress in the parlist data
2555 We read the pipe to get the delivery status codes and a possible error message
2556 for each address, optionally preceded by unusability data for the hosts and
2557 also by optional retry data.
2559 Read in large chunks into the big buffer and then scan through, interpreting
2560 the data therein. In most cases, only a single read will be necessary. No
2561 individual item will ever be anywhere near 2500 bytes in length, so by ensuring
2562 that we read the next chunk when there is less than 2500 bytes left in the
2563 non-final chunk, we can assume each item is complete in the buffer before
2564 handling it. Each item is written using a single write(), which is atomic for
2565 small items (less than PIPE_BUF, which seems to be at least 512 in any Unix and
2566 often bigger) so even if we are reading while the subprocess is still going, we
2567 should never have only a partial item in the buffer.
2570 poffset the offset of the parlist item
2571 eop TRUE if the process has completed
2573 Returns: TRUE if the terminating 'Z' item has been read,
2574 or there has been a disaster (i.e. no more data needed);
2579 par_read_pipe(int poffset, BOOL eop)
2582 pardata *p = parlist + poffset;
2583 address_item *addrlist = p->addrlist;
2584 address_item *addr = p->addr;
2587 uschar *endptr = big_buffer;
2588 uschar *ptr = endptr;
2589 uschar *msg = p->msg;
2590 BOOL done = p->done;
2591 BOOL unfinished = TRUE;
2593 /* Loop through all items, reading from the pipe when necessary. The pipe
2594 is set up to be non-blocking, but there are two different Unix mechanisms in
2595 use. Exim uses O_NONBLOCK if it is defined. This returns 0 for end of file,
2596 and EAGAIN for no more data. If O_NONBLOCK is not defined, Exim uses O_NDELAY,
2597 which returns 0 for both end of file and no more data. We distinguish the
2598 two cases by taking 0 as end of file only when we know the process has
2601 Each separate item is written to the pipe in a single write(), and as they are
2602 all short items, the writes will all be atomic and we should never find
2603 ourselves in the position of having read an incomplete item. "Short" in this
2604 case can mean up to about 1K in the case when there is a long error message
2605 associated with an address. */
2607 DEBUG(D_deliver) debug_printf("reading pipe for subprocess %d (%s)\n",
2608 (int)p->pid, eop? "ended" : "not ended");
2612 retry_item *r, **rp;
2613 int remaining = endptr - ptr;
2615 /* Read (first time) or top up the chars in the buffer if necessary.
2616 There will be only one read if we get all the available data (i.e. don't
2617 fill the buffer completely). */
2619 if (remaining < 2500 && unfinished)
2622 int available = big_buffer_size - remaining;
2624 if (remaining > 0) memmove(big_buffer, ptr, remaining);
2627 endptr = big_buffer + remaining;
2628 len = read(fd, endptr, available);
2630 DEBUG(D_deliver) debug_printf("read() yielded %d\n", len);
2632 /* If the result is EAGAIN and the process is not complete, just
2633 stop reading any more and process what we have already. */
2637 if (!eop && errno == EAGAIN) len = 0; else
2639 msg = string_sprintf("failed to read pipe from transport process "
2640 "%d for transport %s: %s", pid, addr->transport->driver_name,
2646 /* If the length is zero (eof or no-more-data), just process what we
2647 already have. Note that if the process is still running and we have
2648 read all the data in the pipe (but less that "available") then we
2649 won't read any more, as "unfinished" will get set FALSE. */
2652 unfinished = len == available;
2655 /* If we are at the end of the available data, exit the loop. */
2657 if (ptr >= endptr) break;
2659 /* Handle each possible type of item, assuming the complete item is
2660 available in store. */
2664 /* Host items exist only if any hosts were marked unusable. Match
2665 up by checking the IP address. */
2668 for (h = addrlist->host_list; h != NULL; h = h->next)
2670 if (h->address == NULL || Ustrcmp(h->address, ptr+2) != 0) continue;
2678 /* Retry items are sent in a preceding R item for each address. This is
2679 kept separate to keep each message short enough to guarantee it won't
2680 be split in the pipe. Hopefully, in the majority of cases, there won't in
2681 fact be any retry items at all.
2683 The complete set of retry items might include an item to delete a
2684 routing retry if there was a previous routing delay. However, routing
2685 retries are also used when a remote transport identifies an address error.
2686 In that case, there may also be an "add" item for the same key. Arrange
2687 that a "delete" item is dropped in favour of an "add" item. */
2690 if (addr == NULL) goto ADDR_MISMATCH;
2692 DEBUG(D_deliver|D_retry)
2693 debug_printf("reading retry information for %s from subprocess\n",
2696 /* Cut out any "delete" items on the list. */
2698 for (rp = &(addr->retries); (r = *rp) != NULL; rp = &(r->next))
2700 if (Ustrcmp(r->key, ptr+1) == 0) /* Found item with same key */
2702 if ((r->flags & rf_delete) == 0) break; /* It was not "delete" */
2703 *rp = r->next; /* Excise a delete item */
2704 DEBUG(D_deliver|D_retry)
2705 debug_printf(" existing delete item dropped\n");
2709 /* We want to add a delete item only if there is no non-delete item;
2710 however we still have to step ptr through the data. */
2712 if (r == NULL || (*ptr & rf_delete) == 0)
2714 r = store_get(sizeof(retry_item));
2715 r->next = addr->retries;
2718 r->key = string_copy(ptr);
2720 memcpy(&(r->basic_errno), ptr, sizeof(r->basic_errno));
2721 ptr += sizeof(r->basic_errno);
2722 memcpy(&(r->more_errno), ptr, sizeof(r->more_errno));
2723 ptr += sizeof(r->more_errno);
2724 r->message = (*ptr)? string_copy(ptr) : NULL;
2725 DEBUG(D_deliver|D_retry)
2726 debug_printf(" added %s item\n",
2727 ((r->flags & rf_delete) == 0)? "retry" : "delete");
2732 DEBUG(D_deliver|D_retry)
2733 debug_printf(" delete item not added: non-delete item exists\n");
2736 ptr += sizeof(r->basic_errno) + sizeof(r->more_errno);
2742 /* Put the amount of data written into the parlist block */
2745 memcpy(&(p->transport_count), ptr, sizeof(transport_count));
2746 ptr += sizeof(transport_count);
2749 /* Address items are in the order of items on the address chain. We
2750 remember the current address value in case this function is called
2751 several times to empty the pipe in stages. Information about delivery
2752 over TLS is sent in a preceding X item for each address. We don't put
2753 it in with the other info, in order to keep each message short enough to
2754 guarantee it won't be split in the pipe. */
2758 if (addr == NULL) goto ADDR_MISMATCH; /* Below, in 'A' handler */
2759 addr->cipher = (*ptr)? string_copy(ptr) : NULL;
2761 addr->peerdn = (*ptr)? string_copy(ptr) : NULL;
2770 msg = string_sprintf("address count mismatch for data read from pipe "
2771 "for transport process %d for transport %s", pid,
2772 addrlist->transport->driver_name);
2777 addr->transport_return = *ptr++;
2778 addr->special_action = *ptr++;
2779 memcpy(&(addr->basic_errno), ptr, sizeof(addr->basic_errno));
2780 ptr += sizeof(addr->basic_errno);
2781 memcpy(&(addr->more_errno), ptr, sizeof(addr->more_errno));
2782 ptr += sizeof(addr->more_errno);
2783 memcpy(&(addr->flags), ptr, sizeof(addr->flags));
2784 ptr += sizeof(addr->flags);
2785 addr->message = (*ptr)? string_copy(ptr) : NULL;
2787 addr->user_message = (*ptr)? string_copy(ptr) : NULL;
2790 /* Always two strings for host information, followed by the port number */
2794 h = store_get(sizeof(host_item));
2795 h->name = string_copy(ptr);
2797 h->address = string_copy(ptr);
2799 memcpy(&(h->port), ptr, sizeof(h->port));
2800 ptr += sizeof(h->port);
2801 addr->host_used = h;
2805 /* Finished with this address */
2810 /* Z marks the logical end of the data. It is followed by '0' if
2811 continue_transport was NULL at the end of transporting, otherwise '1'.
2812 We need to know when it becomes NULL during a delivery down a passed SMTP
2813 channel so that we don't try to pass anything more down it. Of course, for
2814 most normal messages it will remain NULL all the time. */
2819 continue_transport = NULL;
2820 continue_hostname = NULL;
2823 DEBUG(D_deliver) debug_printf("Z%c item read\n", *ptr);
2826 /* Anything else is a disaster. */
2829 msg = string_sprintf("malformed data (%d) read from pipe for transport "
2830 "process %d for transport %s", ptr[-1], pid,
2831 addr->transport->driver_name);
2837 /* The done flag is inspected externally, to determine whether or not to
2838 call the function again when the process finishes. */
2842 /* If the process hadn't finished, and we haven't seen the end of the data
2843 or suffered a disaster, update the rest of the state, and return FALSE to
2844 indicate "not finished". */
2853 /* Close our end of the pipe, to prevent deadlock if the far end is still
2854 pushing stuff into it. */
2859 /* If we have finished without error, but haven't had data for every address,
2860 something is wrong. */
2862 if (msg == NULL && addr != NULL)
2863 msg = string_sprintf("insufficient address data read from pipe "
2864 "for transport process %d for transport %s", pid,
2865 addr->transport->driver_name);
2867 /* If an error message is set, something has gone wrong in getting back
2868 the delivery data. Put the message into each address and freeze it. */
2872 for (addr = addrlist; addr != NULL; addr = addr->next)
2874 addr->transport_return = DEFER;
2875 addr->special_action = SPECIAL_FREEZE;
2876 addr->message = msg;
2880 /* Return TRUE to indicate we have got all we need from this process, even
2881 if it hasn't actually finished yet. */
2888 /*************************************************
2889 * Post-process a set of remote addresses *
2890 *************************************************/
2892 /* Do what has to be done immediately after a remote delivery for each set of
2893 addresses, then re-write the spool if necessary. Note that post_process_one
2894 puts the address on an appropriate queue; hence we must fish off the next
2895 one first. This function is also called if there is a problem with setting
2896 up a subprocess to do a remote delivery in parallel. In this case, the final
2897 argument contains a message, and the action must be forced to DEFER.
2900 addr pointer to chain of address items
2901 logflags flags for logging
2902 msg NULL for normal cases; -> error message for unexpected problems
2903 fallback TRUE if processing fallback hosts
2909 remote_post_process(address_item *addr, int logflags, uschar *msg,
2914 /* If any host addresses were found to be unusable, add them to the unusable
2915 tree so that subsequent deliveries don't try them. */
2917 for (h = addr->host_list; h != NULL; h = h->next)
2919 if (h->address == NULL) continue;
2920 if (h->status >= hstatus_unusable) tree_add_unusable(h);
2923 /* Now handle each address on the chain. The transport has placed '=' or '-'
2924 into the special_action field for each successful delivery. */
2926 while (addr != NULL)
2928 address_item *next = addr->next;
2930 /* If msg == NULL (normal processing) and the result is DEFER and we are
2931 processing the main hosts and there are fallback hosts available, put the
2932 address on the list for fallback delivery. */
2934 if (addr->transport_return == DEFER &&
2935 addr->fallback_hosts != NULL &&
2939 addr->host_list = addr->fallback_hosts;
2940 addr->next = addr_fallback;
2941 addr_fallback = addr;
2942 DEBUG(D_deliver) debug_printf("%s queued for fallback host(s)\n", addr->address);
2945 /* If msg is set (=> unexpected problem), set it in the address before
2946 doing the ordinary post processing. */
2952 addr->message = msg;
2953 addr->transport_return = DEFER;
2955 (void)post_process_one(addr, addr->transport_return, logflags,
2956 DTYPE_TRANSPORT, addr->special_action);
2964 /* If we have just delivered down a passed SMTP channel, and that was
2965 the last address, the channel will have been closed down. Now that
2966 we have logged that delivery, set continue_sequence to 1 so that
2967 any subsequent deliveries don't get "*" incorrectly logged. */
2969 if (continue_transport == NULL) continue_sequence = 1;
2974 /*************************************************
2975 * Wait for one remote delivery subprocess *
2976 *************************************************/
2978 /* This function is called while doing remote deliveries when either the
2979 maximum number of processes exist and we need one to complete so that another
2980 can be created, or when waiting for the last ones to complete. It must wait for
2981 the completion of one subprocess, empty the control block slot, and return a
2982 pointer to the address chain.
2985 Returns: pointer to the chain of addresses handled by the process;
2986 NULL if no subprocess found - this is an unexpected error
2989 static address_item *
2992 int poffset, status;
2993 address_item *addr, *addrlist;
2996 set_process_info("delivering %s: waiting for a remote delivery subprocess "
2997 "to finish", message_id);
2999 /* Loop until either a subprocess completes, or there are no subprocesses in
3000 existence - in which case give an error return. We cannot proceed just by
3001 waiting for a completion, because a subprocess may have filled up its pipe, and
3002 be waiting for it to be emptied. Therefore, if no processes have finished, we
3003 wait for one of the pipes to acquire some data by calling select(), with a
3004 timeout just in case.
3006 The simple approach is just to iterate after reading data from a ready pipe.
3007 This leads to non-ideal behaviour when the subprocess has written its final Z
3008 item, closed the pipe, and is in the process of exiting (the common case). A
3009 call to waitpid() yields nothing completed, but select() shows the pipe ready -
3010 reading it yields EOF, so you end up with busy-waiting until the subprocess has
3013 To avoid this, if all the data that is needed has been read from a subprocess
3014 after select(), an explicit wait() for it is done. We know that all it is doing
3015 is writing to the pipe and then exiting, so the wait should not be long.
3017 The non-blocking waitpid() is to some extent just insurance; if we could
3018 reliably detect end-of-file on the pipe, we could always know when to do a
3019 blocking wait() for a completed process. However, because some systems use
3020 NDELAY, which doesn't distinguish between EOF and pipe empty, it is easier to
3021 use code that functions without the need to recognize EOF.
3023 There's a double loop here just in case we end up with a process that is not in
3024 the list of remote delivery processes. Something has obviously gone wrong if
3025 this is the case. (For example, a process that is incorrectly left over from
3026 routing or local deliveries might be found.) The damage can be minimized by
3027 looping back and looking for another process. If there aren't any, the error
3028 return will happen. */
3030 for (;;) /* Normally we do not repeat this loop */
3032 while ((pid = waitpid(-1, &status, WNOHANG)) <= 0)
3035 fd_set select_pipes;
3036 int maxpipe, readycount;
3038 /* A return value of -1 can mean several things. If errno != ECHILD, it
3039 either means invalid options (which we discount), or that this process was
3040 interrupted by a signal. Just loop to try the waitpid() again.
3042 If errno == ECHILD, waitpid() is telling us that there are no subprocesses
3043 in existence. This should never happen, and is an unexpected error.
3044 However, there is a nasty complication when running under Linux. If "strace
3045 -f" is being used under Linux to trace this process and its children,
3046 subprocesses are "stolen" from their parents and become the children of the
3047 tracing process. A general wait such as the one we've just obeyed returns
3048 as if there are no children while subprocesses are running. Once a
3049 subprocess completes, it is restored to the parent, and waitpid(-1) finds
3050 it. Thanks to Joachim Wieland for finding all this out and suggesting a
3053 This does not happen using "truss" on Solaris, nor (I think) with other
3054 tracing facilities on other OS. It seems to be specific to Linux.
3056 What we do to get round this is to use kill() to see if any of our
3057 subprocesses are still in existence. If kill() gives an OK return, we know
3058 it must be for one of our processes - it can't be for a re-use of the pid,
3059 because if our process had finished, waitpid() would have found it. If any
3060 of our subprocesses are in existence, we proceed to use select() as if
3061 waitpid() had returned zero. I think this is safe. */
3065 if (errno != ECHILD) continue; /* Repeats the waitpid() */
3068 debug_printf("waitpid() returned -1/ECHILD: checking explicitly "
3069 "for process existence\n");
3071 for (poffset = 0; poffset < remote_max_parallel; poffset++)
3073 if ((pid = parlist[poffset].pid) != 0 && kill(pid, 0) == 0)
3075 DEBUG(D_deliver) debug_printf("process %d still exists: assume "
3076 "stolen by strace\n", (int)pid);
3077 break; /* With poffset set */
3081 if (poffset >= remote_max_parallel)
3083 DEBUG(D_deliver) debug_printf("*** no delivery children found\n");
3084 return NULL; /* This is the error return */
3088 /* A pid value greater than 0 breaks the "while" loop. A negative value has
3089 been handled above. A return value of zero means that there is at least one
3090 subprocess, but there are no completed subprocesses. See if any pipes are
3091 ready with any data for reading. */
3093 DEBUG(D_deliver) debug_printf("selecting on subprocess pipes\n");
3096 FD_ZERO(&select_pipes);
3097 for (poffset = 0; poffset < remote_max_parallel; poffset++)
3099 if (parlist[poffset].pid != 0)
3101 int fd = parlist[poffset].fd;
3102 FD_SET(fd, &select_pipes);
3103 if (fd > maxpipe) maxpipe = fd;
3107 /* Stick in a 60-second timeout, just in case. */
3112 readycount = select(maxpipe + 1, (SELECT_ARG2_TYPE *)&select_pipes,
3115 /* Scan through the pipes and read any that are ready; use the count
3116 returned by select() to stop when there are no more. Select() can return
3117 with no processes (e.g. if interrupted). This shouldn't matter.
3119 If par_read_pipe() returns TRUE, it means that either the terminating Z was
3120 read, or there was a disaster. In either case, we are finished with this
3121 process. Do an explicit wait() for the process and break the main loop if
3124 It turns out that we have to deal with the case of an interrupted system
3125 call, which can happen on some operating systems if the signal handling is
3126 set up to do that by default. */
3129 readycount > 0 && poffset < remote_max_parallel;
3132 if ((pid = parlist[poffset].pid) != 0 &&
3133 FD_ISSET(parlist[poffset].fd, &select_pipes))
3136 if (par_read_pipe(poffset, FALSE)) /* Finished with this pipe */
3138 for (;;) /* Loop for signals */
3140 pid_t endedpid = waitpid(pid, &status, 0);
3141 if (endedpid == pid) goto PROCESS_DONE;
3142 if (endedpid != (pid_t)(-1) || errno != EINTR)
3143 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Unexpected error return "
3144 "%d (errno = %d) from waitpid() for process %d",
3145 (int)endedpid, errno, (int)pid);
3151 /* Now go back and look for a completed subprocess again. */
3154 /* A completed process was detected by the non-blocking waitpid(). Find the
3155 data block that corresponds to this subprocess. */
3157 for (poffset = 0; poffset < remote_max_parallel; poffset++)
3158 if (pid == parlist[poffset].pid) break;
3160 /* Found the data block; this is a known remote delivery process. We don't
3161 need to repeat the outer loop. This should be what normally happens. */
3163 if (poffset < remote_max_parallel) break;
3165 /* This situation is an error, but it's probably better to carry on looking
3166 for another process than to give up (as we used to do). */
3168 log_write(0, LOG_MAIN|LOG_PANIC, "Process %d finished: not found in remote "
3169 "transport process list", pid);
3170 } /* End of the "for" loop */
3172 /* Come here when all the data was completely read after a select(), and
3173 the process in pid has been wait()ed for. */
3180 debug_printf("remote delivery process %d ended\n", (int)pid);
3182 debug_printf("remote delivery process %d ended: status=%04x\n", (int)pid,
3186 set_process_info("delivering %s", message_id);
3188 /* Get the chain of processed addresses */
3190 addrlist = parlist[poffset].addrlist;
3192 /* If the process did not finish cleanly, record an error and freeze (except
3193 for SIGTERM, SIGKILL and SIGQUIT), and also ensure the journal is not removed,
3194 in case the delivery did actually happen. */
3196 if ((status & 0xffff) != 0)
3199 int msb = (status >> 8) & 255;
3200 int lsb = status & 255;
3201 int code = (msb == 0)? (lsb & 0x7f) : msb;
3203 msg = string_sprintf("%s transport process returned non-zero status 0x%04x: "
3205 addrlist->transport->driver_name,
3207 (msb == 0)? "terminated by signal" : "exit code",
3210 if (msb != 0 || (code != SIGTERM && code != SIGKILL && code != SIGQUIT))
3211 addrlist->special_action = SPECIAL_FREEZE;
3213 for (addr = addrlist; addr != NULL; addr = addr->next)
3215 addr->transport_return = DEFER;
3216 addr->message = msg;
3219 remove_journal = FALSE;
3222 /* Else complete reading the pipe to get the result of the delivery, if all
3223 the data has not yet been obtained. */
3225 else if (!parlist[poffset].done) (void)par_read_pipe(poffset, TRUE);
3227 /* Put the data count and return path into globals, mark the data slot unused,
3228 decrement the count of subprocesses, and return the address chain. */
3230 transport_count = parlist[poffset].transport_count;
3231 used_return_path = parlist[poffset].return_path;
3232 parlist[poffset].pid = 0;
3239 /*************************************************
3240 * Wait for subprocesses and post-process *
3241 *************************************************/
3243 /* This function waits for subprocesses until the number that are still running
3244 is below a given threshold. For each complete subprocess, the addresses are
3245 post-processed. If we can't find a running process, there is some shambles.
3246 Better not bomb out, as that might lead to multiple copies of the message. Just
3247 log and proceed as if all done.
3250 max maximum number of subprocesses to leave running
3251 fallback TRUE if processing fallback hosts
3257 par_reduce(int max, BOOL fallback)
3259 while (parcount > max)
3261 address_item *doneaddr = par_wait();
3262 if (doneaddr == NULL)
3264 log_write(0, LOG_MAIN|LOG_PANIC,
3265 "remote delivery process count got out of step");
3268 else remote_post_process(doneaddr, LOG_MAIN, NULL, fallback);
3275 /*************************************************
3276 * Do remote deliveries *
3277 *************************************************/
3279 /* This function is called to process the addresses in addr_remote. We must
3280 pick off the queue all addresses that have the same transport, remote
3281 destination, and errors address, and hand them to the transport in one go,
3282 subject to some configured limitations. If this is a run to continue delivering
3283 to an existing delivery channel, skip all but those addresses that can go to
3284 that channel. The skipped addresses just get deferred.
3286 If mua_wrapper is set, all addresses must be able to be sent in a single
3287 transaction. If not, this function yields FALSE.
3289 In Exim 4, remote deliveries are always done in separate processes, even
3290 if remote_max_parallel = 1 or if there's only one delivery to do. The reason
3291 is so that the base process can retain privilege. This makes the
3292 implementation of fallback transports feasible (though not initially done.)
3294 We create up to the configured number of subprocesses, each of which passes
3295 back the delivery state via a pipe. (However, when sending down an existing
3296 connection, remote_max_parallel is forced to 1.)
3299 fallback TRUE if processing fallback hosts
3301 Returns: TRUE normally
3302 FALSE if mua_wrapper is set and the addresses cannot all be sent
3307 do_remote_deliveries(BOOL fallback)
3313 parcount = 0; /* Number of executing subprocesses */
3315 /* When sending down an existing channel, only do one delivery at a time.
3316 We use a local variable (parmax) to hold the maximum number of processes;
3317 this gets reduced from remote_max_parallel if we can't create enough pipes. */
3319 if (continue_transport != NULL) remote_max_parallel = 1;
3320 parmax = remote_max_parallel;
3322 /* If the data for keeping a list of processes hasn't yet been
3325 if (parlist == NULL)
3327 parlist = store_get(remote_max_parallel * sizeof(pardata));
3328 for (poffset = 0; poffset < remote_max_parallel; poffset++)
3329 parlist[poffset].pid = 0;
3332 /* Now loop for each remote delivery */
3334 for (delivery_count = 0; addr_remote != NULL; delivery_count++)
3340 int address_count = 1;
3341 int address_count_max;
3343 BOOL use_initgroups;
3344 BOOL pipe_done = FALSE;
3345 transport_instance *tp;
3346 address_item **anchor = &addr_remote;
3347 address_item *addr = addr_remote;
3348 address_item *last = addr;
3351 /* Pull the first address right off the list. */
3353 addr_remote = addr->next;
3356 DEBUG(D_deliver|D_transport)
3357 debug_printf("--------> %s <--------\n", addr->address);
3359 /* If no transport has been set, there has been a big screw-up somewhere. */
3361 if ((tp = addr->transport) == NULL)
3363 disable_logging = FALSE; /* Jic */
3364 remote_post_process(addr, LOG_MAIN|LOG_PANIC,
3365 US"No transport set by router", fallback);
3369 /* Check that this base address hasn't previously been delivered to this
3370 transport. The check is necessary at this point to handle homonymic addresses
3371 correctly in cases where the pattern of redirection changes between delivery
3372 attempts. Non-homonymic previous delivery is detected earlier, at routing
3375 if (previously_transported(addr)) continue;
3377 /* Force failure if the message is too big. */
3379 if (tp->message_size_limit != NULL)
3381 int rc = check_message_size(tp, addr);
3384 addr->transport_return = rc;
3385 remote_post_process(addr, LOG_MAIN, NULL, fallback);
3390 /* Get the flag which specifies whether the transport can handle different
3391 domains that nevertheless resolve to the same set of hosts. */
3393 multi_domain = tp->multi_domain;
3395 /* Get the maximum it can handle in one envelope, with zero meaning
3396 unlimited, which is forced for the MUA wrapper case. */
3398 address_count_max = tp->max_addresses;
3399 if (address_count_max == 0 || mua_wrapper) address_count_max = 999999;
3402 /************************************************************************/
3403 /***** This is slightly experimental code, but should be safe. *****/
3405 /* The address_count_max value is the maximum number of addresses that the
3406 transport can send in one envelope. However, the transport must be capable of
3407 dealing with any number of addresses. If the number it gets exceeds its
3408 envelope limitation, it must send multiple copies of the message. This can be
3409 done over a single connection for SMTP, so uses less resources than making
3410 multiple connections. On the other hand, if remote_max_parallel is greater
3411 than one, it is perhaps a good idea to use parallel processing to move the
3412 message faster, even if that results in multiple simultaneous connections to
3415 How can we come to some compromise between these two ideals? What we do is to
3416 limit the number of addresses passed to a single instance of a transport to
3417 the greater of (a) its address limit (rcpt_max for SMTP) and (b) the total
3418 number of addresses routed to remote transports divided by
3419 remote_max_parallel. For example, if the message has 100 remote recipients,
3420 remote max parallel is 2, and rcpt_max is 10, we'd never send more than 50 at
3421 once. But if rcpt_max is 100, we could send up to 100.
3423 Of course, not all the remotely addresses in a message are going to go to the
3424 same set of hosts (except in smarthost configurations), so this is just a
3425 heuristic way of dividing up the work.
3427 Furthermore (1), because this may not be wanted in some cases, and also to
3428 cope with really pathological cases, there is also a limit to the number of
3429 messages that are sent over one connection. This is the same limit that is
3430 used when sending several different messages over the same connection.
3431 Continue_sequence is set when in this situation, to the number sent so
3432 far, including this message.
3434 Furthermore (2), when somebody explicitly sets the maximum value to 1, it
3435 is probably because they are using VERP, in which case they want to pass only
3436 one address at a time to the transport, in order to be able to use
3437 $local_part and $domain in constructing a new return path. We could test for
3438 the use of these variables, but as it is so likely they will be used when the
3439 maximum is 1, we don't bother. Just leave the value alone. */
3441 if (address_count_max != 1 &&
3442 address_count_max < remote_delivery_count/remote_max_parallel)
3444 int new_max = remote_delivery_count/remote_max_parallel;
3445 int message_max = tp->connection_max_messages;
3446 if (connection_max_messages >= 0) message_max = connection_max_messages;
3447 message_max -= continue_sequence - 1;
3448 if (message_max > 0 && new_max > address_count_max * message_max)
3449 new_max = address_count_max * message_max;
3450 address_count_max = new_max;
3453 /************************************************************************/
3456 /* Pick off all addresses which have the same transport, errors address,
3457 destination, and extra headers. In some cases they point to the same host
3458 list, but we also need to check for identical host lists generated from
3459 entirely different domains. The host list pointers can be NULL in the case
3460 where the hosts are defined in the transport. There is also a configured
3461 maximum limit of addresses that can be handled at once (see comments above
3462 for how it is computed). */
3464 while ((next = *anchor) != NULL && address_count < address_count_max)
3466 if ((multi_domain || Ustrcmp(next->domain, addr->domain) == 0)
3468 tp == next->transport
3470 same_hosts(next->host_list, addr->host_list)
3472 same_strings(next->p.errors_address, addr->p.errors_address)
3474 same_headers(next->p.extra_headers, addr->p.extra_headers)
3476 same_ugid(tp, next, addr)
3478 (next->p.remove_headers == addr->p.remove_headers ||
3479 (next->p.remove_headers != NULL &&
3480 addr->p.remove_headers != NULL &&
3481 Ustrcmp(next->p.remove_headers, addr->p.remove_headers) == 0)))
3483 *anchor = next->next;
3485 next->first = addr; /* remember top one (for retry processing) */
3490 else anchor = &(next->next);
3493 /* If we are acting as an MUA wrapper, all addresses must go in a single
3494 transaction. If not, put them back on the chain and yield FALSE. */
3496 if (mua_wrapper && addr_remote != NULL)
3498 last->next = addr_remote;
3503 /* Set up the expansion variables for this set of addresses */
3505 deliver_set_expansions(addr);
3507 /* Compute the return path, expanding a new one if required. The old one
3508 must be set first, as it might be referred to in the expansion. */
3510 return_path = (addr->p.errors_address != NULL)?
3511 addr->p.errors_address : sender_address;
3513 if (tp->return_path != NULL)
3515 uschar *new_return_path = expand_string(tp->return_path);
3516 if (new_return_path == NULL)
3518 if (!expand_string_forcedfail)
3520 remote_post_process(addr, LOG_MAIN|LOG_PANIC,
3521 string_sprintf("Failed to expand return path \"%s\": %s",
3522 tp->return_path, expand_string_message), fallback);
3526 else return_path = new_return_path;
3529 /* If this transport has a setup function, call it now so that it gets
3530 run in this process and not in any subprocess. That way, the results of
3531 any setup that are retained by the transport can be reusable. */
3533 if (tp->setup != NULL)
3534 (void)((tp->setup)(addr->transport, addr, NULL, NULL));
3536 /* If this is a run to continue delivery down an already-established
3537 channel, check that this set of addresses matches the transport and
3538 the channel. If it does not, defer the addresses. If a host list exists,
3539 we must check that the continue host is on the list. Otherwise, the
3540 host is set in the transport. */
3542 continue_more = FALSE; /* In case got set for the last lot */
3543 if (continue_transport != NULL)
3545 BOOL ok = Ustrcmp(continue_transport, tp->name) == 0;
3546 if (ok && addr->host_list != NULL)
3550 for (h = addr->host_list; h != NULL; h = h->next)
3552 if (Ustrcmp(h->name, continue_hostname) == 0)
3553 { ok = TRUE; break; }
3557 /* Addresses not suitable; defer or queue for fallback hosts (which
3558 might be the continue host) and skip to next address. */
3562 DEBUG(D_deliver) debug_printf("not suitable for continue_transport\n");
3565 if (addr->fallback_hosts != NULL && !fallback)
3569 next->host_list = next->fallback_hosts;
3570 DEBUG(D_deliver) debug_printf("%s queued for fallback host(s)\n", next->address);
3571 if (next->next == NULL) break;
3574 next->next = addr_fallback;
3575 addr_fallback = addr;
3580 while (next->next != NULL) next = next->next;
3581 next->next = addr_defer;
3588 /* Set a flag indicating whether there are further addresses that list
3589 the continued host. This tells the transport to leave the channel open,
3590 but not to pass it to another delivery process. */
3592 for (next = addr_remote; next != NULL; next = next->next)
3595 for (h = next->host_list; h != NULL; h = h->next)
3597 if (Ustrcmp(h->name, continue_hostname) == 0)
3598 { continue_more = TRUE; break; }
3603 /* The transports set up the process info themselves as they may connect
3604 to more than one remote machine. They also have to set up the filter
3605 arguments, if required, so that the host name and address are available
3608 transport_filter_argv = NULL;
3610 /* Find the uid, gid, and use_initgroups setting for this transport. Failure
3611 logs and sets up error messages, so we just post-process and continue with
3612 the next address. */
3614 if (!findugid(addr, tp, &uid, &gid, &use_initgroups))
3616 remote_post_process(addr, LOG_MAIN|LOG_PANIC, NULL, fallback);
3620 /* Create the pipe for inter-process communication. If pipe creation
3621 fails, it is probably because the value of remote_max_parallel is so
3622 large that too many file descriptors for pipes have been created. Arrange
3623 to wait for a process to finish, and then try again. If we still can't
3624 create a pipe when all processes have finished, break the retry loop. */
3628 if (pipe(pfd) == 0) pipe_done = TRUE;
3629 else if (parcount > 0) parmax = parcount;
3632 /* We need to make the reading end of the pipe non-blocking. There are
3633 two different options for this. Exim is cunningly (I hope!) coded so
3634 that it can use either of them, though it prefers O_NONBLOCK, which
3635 distinguishes between EOF and no-more-data. */
3638 fcntl(pfd[pipe_read], F_SETFL, O_NONBLOCK);
3640 fcntl(pfd[pipe_read], F_SETFL, O_NDELAY);
3643 /* If the maximum number of subprocesses already exist, wait for a process
3644 to finish. If we ran out of file descriptors, parmax will have been reduced
3645 from its initial value of remote_max_parallel. */
3647 par_reduce(parmax - 1, fallback);
3650 /* If we failed to create a pipe and there were no processes to wait
3651 for, we have to give up on this one. Do this outside the above loop
3652 so that we can continue the main loop. */
3656 remote_post_process(addr, LOG_MAIN|LOG_PANIC,
3657 string_sprintf("unable to create pipe: %s", strerror(errno)), fallback);
3661 /* Find a free slot in the pardata list. Must do this after the possible
3662 waiting for processes to finish, because a terminating process will free
3665 for (poffset = 0; poffset < remote_max_parallel; poffset++)
3666 if (parlist[poffset].pid == 0) break;
3668 /* If there isn't one, there has been a horrible disaster. */
3670 if (poffset >= remote_max_parallel)
3672 close(pfd[pipe_write]);
3673 close(pfd[pipe_read]);
3674 remote_post_process(addr, LOG_MAIN|LOG_PANIC,
3675 US"Unexpectedly no free subprocess slot", fallback);
3679 /* Now fork a subprocess to do the remote delivery, but before doing so,
3680 ensure that any cached resourses are released so as not to interfere with
3681 what happens in the subprocess. */
3685 if ((pid = fork()) == 0)
3687 int fd = pfd[pipe_write];
3690 /* There are weird circumstances in which logging is disabled */
3692 disable_logging = tp->disable_logging;
3694 /* Show pids on debug output if parallelism possible */
3696 if (parmax > 1 && (parcount > 0 || addr_remote != NULL))
3698 DEBUG(D_any|D_v) debug_selector |= D_pid;
3699 DEBUG(D_deliver) debug_printf("Remote delivery process started\n");
3702 /* Reset the random number generator, so different processes don't all
3703 have the same sequence. In the test harness we want different, but
3704 predictable settings for each delivery process, so do something explicit
3705 here rather they rely on the fixed reset in the random number function. */
3707 random_seed = running_in_test_harness? 42 + 2*delivery_count : 0;
3709 /* Set close-on-exec on the pipe so that it doesn't get passed on to
3710 a new process that may be forked to do another delivery down the same
3713 fcntl(fd, F_SETFD, fcntl(fd, F_GETFD) | FD_CLOEXEC);
3715 /* Close open file descriptors for the pipes of other processes
3716 that are running in parallel. */
3718 for (poffset = 0; poffset < remote_max_parallel; poffset++)
3719 if (parlist[poffset].pid != 0) close(parlist[poffset].fd);
3721 /* This process has inherited a copy of the file descriptor
3722 for the data file, but its file pointer is shared with all the
3723 other processes running in parallel. Therefore, we have to re-open
3724 the file in order to get a new file descriptor with its own
3725 file pointer. We don't need to lock it, as the lock is held by
3726 the parent process. There doesn't seem to be any way of doing
3727 a dup-with-new-file-pointer. */
3729 close(deliver_datafile);
3730 sprintf(CS spoolname, "%s/input/%s/%s-D", spool_directory, message_subdir,
3732 deliver_datafile = Uopen(spoolname, O_RDWR | O_APPEND, 0);
3734 if (deliver_datafile < 0)
3735 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Failed to reopen %s for remote "
3736 "parallel delivery: %s", spoolname, strerror(errno));
3738 /* Set the close-on-exec flag */
3740 fcntl(deliver_datafile, F_SETFD, fcntl(deliver_datafile, F_GETFD) |
3743 /* Set the uid/gid of this process; bombs out on failure. */
3745 exim_setugid(uid, gid, use_initgroups,
3746 string_sprintf("remote delivery to %s with transport=%s",
3747 addr->address, tp->name));
3749 /* Close the unwanted half of this process' pipe, set the process state,
3750 and run the transport. Afterwards, transport_count will contain the number
3751 of bytes written. */
3753 close(pfd[pipe_read]);
3754 set_process_info("delivering %s using %s", message_id, tp->name);
3755 debug_print_string(tp->debug_string);
3756 if (!(tp->info->code)(addr->transport, addr)) replicate_status(addr);
3758 set_process_info("delivering %s (just run %s for %s%s in subprocess)",
3759 message_id, tp->name, addr->address, (addr->next == NULL)? "" : ", ...");
3761 /* Ensure any cached resources that we used are now released */
3765 /* Pass the result back down the pipe. This is a lot more information
3766 than is needed for a local delivery. We have to send back the error
3767 status for each address, the usability status for each host that is
3768 flagged as unusable, and all the retry items. When TLS is in use, we
3769 send also the cipher and peerdn information. Each type of information
3770 is flagged by an identifying byte, and is then in a fixed format (with
3771 strings terminated by zeros), and there is a final terminator at the
3772 end. The host information and retry information is all attached to
3773 the first address, so that gets sent at the start. */
3775 /* Host unusability information: for most success cases this will
3778 for (h = addr->host_list; h != NULL; h = h->next)
3780 if (h->address == NULL || h->status < hstatus_unusable) continue;
3781 sprintf(CS big_buffer, "H%c%c%s", h->status, h->why, h->address);
3782 write(fd, big_buffer, Ustrlen(big_buffer+3) + 4);
3785 /* The number of bytes written. This is the same for each address. Even
3786 if we sent several copies of the message down the same connection, the
3787 size of each one is the same, and it's that value we have got because
3788 transport_count gets reset before calling transport_write_message(). */
3790 big_buffer[0] = 'S';
3791 memcpy(big_buffer+1, &transport_count, sizeof(transport_count));
3792 write(fd, big_buffer, sizeof(transport_count) + 1);
3794 /* Information about what happened to each address. Three item types are
3795 used: an optional 'X' item first, for TLS information, followed by 'R'
3796 items for any retry settings, and finally an 'A' item for the remaining
3799 for(; addr != NULL; addr = addr->next)
3804 /* The certificate verification status goes into the flags */
3806 if (tls_certificate_verified) setflag(addr, af_cert_verified);
3808 /* Use an X item only if there's something to send */
3811 if (addr->cipher != NULL)
3815 sprintf(CS ptr, "%.128s", addr->cipher);
3817 if (addr->peerdn == NULL) *ptr++ = 0; else
3819 sprintf(CS ptr, "%.512s", addr->peerdn);
3822 write(fd, big_buffer, ptr - big_buffer);
3826 /* Retry information: for most success cases this will be null. */
3828 for (r = addr->retries; r != NULL; r = r->next)
3831 sprintf(CS big_buffer, "R%c%.500s", r->flags, r->key);
3832 ptr = big_buffer + Ustrlen(big_buffer+2) + 3;
3833 memcpy(ptr, &(r->basic_errno), sizeof(r->basic_errno));
3834 ptr += sizeof(r->basic_errno);
3835 memcpy(ptr, &(r->more_errno), sizeof(r->more_errno));
3836 ptr += sizeof(r->more_errno);
3837 if (r->message == NULL) *ptr++ = 0; else
3839 sprintf(CS ptr, "%.512s", r->message);
3842 write(fd, big_buffer, ptr - big_buffer);
3845 /* The rest of the information goes in an 'A' item. */
3847 ptr = big_buffer + 3;
3848 sprintf(CS big_buffer, "A%c%c", addr->transport_return,
3849 addr->special_action);
3850 memcpy(ptr, &(addr->basic_errno), sizeof(addr->basic_errno));
3851 ptr += sizeof(addr->basic_errno);
3852 memcpy(ptr, &(addr->more_errno), sizeof(addr->more_errno));
3853 ptr += sizeof(addr->more_errno);
3854 memcpy(ptr, &(addr->flags), sizeof(addr->flags));
3855 ptr += sizeof(addr->flags);
3857 if (addr->message == NULL) *ptr++ = 0; else
3859 sprintf(CS ptr, "%.1024s", addr->message);
3863 if (addr->user_message == NULL) *ptr++ = 0; else
3865 sprintf(CS ptr, "%.1024s", addr->user_message);
3869 if (addr->host_used == NULL) *ptr++ = 0; else
3871 sprintf(CS ptr, "%.256s", addr->host_used->name);
3873 sprintf(CS ptr, "%.64s", addr->host_used->address);
3875 memcpy(ptr, &(addr->host_used->port), sizeof(addr->host_used->port));
3876 ptr += sizeof(addr->host_used->port);
3878 write(fd, big_buffer, ptr - big_buffer);
3881 /* Add termination flag, close the pipe, and that's it. The character
3882 after 'Z' indicates whether continue_transport is now NULL or not.
3883 A change from non-NULL to NULL indicates a problem with a continuing
3886 big_buffer[0] = 'Z';
3887 big_buffer[1] = (continue_transport == NULL)? '0' : '1';
3888 write(fd, big_buffer, 2);
3893 /* Back in the mainline: close the unwanted half of the pipe. */
3895 close(pfd[pipe_write]);
3897 /* Fork failed; defer with error message */
3901 close(pfd[pipe_read]);
3902 remote_post_process(addr, LOG_MAIN|LOG_PANIC,
3903 string_sprintf("fork failed for remote delivery to %s: %s",
3904 addr->domain, strerror(errno)), fallback);
3908 /* Fork succeeded; increment the count, and remember relevant data for
3909 when the process finishes. */
3912 parlist[poffset].addrlist = parlist[poffset].addr = addr;
3913 parlist[poffset].pid = pid;
3914 parlist[poffset].fd = pfd[pipe_read];
3915 parlist[poffset].done = FALSE;
3916 parlist[poffset].msg = NULL;
3917 parlist[poffset].return_path = return_path;
3919 /* If the process we've just started is sending a message down an existing
3920 channel, wait for it now. This ensures that only one such process runs at
3921 once, whatever the value of remote_max parallel. Otherwise, we might try to
3922 send two or more messages simultaneously down the same channel. This could
3923 happen if there are different domains that include the same host in otherwise
3924 different host lists.
3926 Also, if the transport closes down the channel, this information gets back
3927 (continue_transport gets set to NULL) before we consider any other addresses
3930 if (continue_transport != NULL) par_reduce(0, fallback);
3932 /* Otherwise, if we are running in the test harness, wait a bit, to let the
3933 newly created process get going before we create another process. This should
3934 ensure repeatability in the tests. We only need to wait a tad. */
3936 else if (running_in_test_harness) millisleep(500);
3939 /* Reached the end of the list of addresses. Wait for all the subprocesses that
3940 are still running and post-process their addresses. */
3942 par_reduce(0, fallback);
3949 /*************************************************
3950 * Split an address into local part and domain *
3951 *************************************************/
3953 /* This function initializes an address for routing by splitting it up into a
3954 local part and a domain. The local part is set up twice - once in its original
3955 casing, and once in lower case, and it is dequoted. We also do the "percent
3956 hack" for configured domains. This may lead to a DEFER result if a lookup
3957 defers. When a percent-hacking takes place, we insert a copy of the original
3958 address as a new parent of this address, as if we have had a redirection.
3961 addr points to an addr_item block containing the address
3964 DEFER - could not determine if domain is %-hackable
3968 deliver_split_address(address_item *addr)
3970 uschar *address = addr->address;
3971 uschar *domain = Ustrrchr(address, '@');
3973 int len = domain - address;
3975 addr->domain = string_copylc(domain+1); /* Domains are always caseless */
3977 /* The implication in the RFCs (though I can't say I've seen it spelled out
3978 explicitly) is that quoting should be removed from local parts at the point
3979 where they are locally interpreted. [The new draft "821" is more explicit on
3980 this, Jan 1999.] We know the syntax is valid, so this can be done by simply
3981 removing quoting backslashes and any unquoted doublequotes. */
3983 t = addr->cc_local_part = store_get(len+1);
3986 register int c = *address++;
3987 if (c == '\"') continue;
3997 /* We do the percent hack only for those domains that are listed in
3998 percent_hack_domains. A loop is required, to copy with multiple %-hacks. */
4000 if (percent_hack_domains != NULL)
4003 uschar *new_address = NULL;
4004 uschar *local_part = addr->cc_local_part;
4006 deliver_domain = addr->domain; /* set $domain */
4008 while ((rc = match_isinlist(deliver_domain, &percent_hack_domains, 0,
4009 &domainlist_anchor, addr->domain_cache, MCL_DOMAIN, TRUE, NULL))
4011 (t = Ustrrchr(local_part, '%')) != NULL)
4013 new_address = string_copy(local_part);
4014 new_address[t - local_part] = '@';
4015 deliver_domain = string_copylc(t+1);
4016 local_part = string_copyn(local_part, t - local_part);
4019 if (rc == DEFER) return DEFER; /* lookup deferred */
4021 /* If hackery happened, set up new parent and alter the current address. */
4023 if (new_address != NULL)
4025 address_item *new_parent = store_get(sizeof(address_item));
4026 *new_parent = *addr;
4027 addr->parent = new_parent;
4028 addr->address = new_address;
4029 addr->unique = string_copy(new_address);
4030 addr->domain = deliver_domain;
4031 addr->cc_local_part = local_part;
4032 DEBUG(D_deliver) debug_printf("%%-hack changed address to: %s\n",
4037 /* Create the lowercased version of the final local part, and make that the
4038 default one to be used. */
4040 addr->local_part = addr->lc_local_part = string_copylc(addr->cc_local_part);
4047 /*************************************************
4048 * Get next error message text *
4049 *************************************************/
4051 /* If f is not NULL, read the next "paragraph", from a customized error message
4052 text file, terminated by a line containing ****, and expand it.
4055 f NULL or a file to read from
4056 which string indicating which string (for errors)
4058 Returns: NULL or an expanded string
4062 next_emf(FILE *f, uschar *which)
4066 uschar *para, *yield;
4069 if (f == NULL) return NULL;
4071 if (Ufgets(buffer, sizeof(buffer), f) == NULL ||
4072 Ustrcmp(buffer, "****\n") == 0) return NULL;
4074 para = store_get(size);
4077 para = string_cat(para, &size, &ptr, buffer, Ustrlen(buffer));
4078 if (Ufgets(buffer, sizeof(buffer), f) == NULL ||
4079 Ustrcmp(buffer, "****\n") == 0) break;
4083 yield = expand_string(para);
4084 if (yield != NULL) return yield;
4086 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand string from "
4087 "bounce_message_file or warn_message_file (%s): %s", which,
4088 expand_string_message);
4095 /*************************************************
4096 * Close down a passed transport channel *
4097 *************************************************/
4099 /* This function is called when a passed transport channel cannot be used.
4100 It attempts to close it down tidily. The yield is always DELIVER_NOT_ATTEMPTED
4101 so that the function call can be the argument of a "return" statement.
4104 Returns: DELIVER_NOT_ATTEMPTED
4108 continue_closedown(void)
4110 if (continue_transport != NULL)
4112 transport_instance *t;
4113 for (t = transports; t != NULL; t = t->next)
4115 if (Ustrcmp(t->name, continue_transport) == 0)
4117 if (t->info->closedown != NULL) (t->info->closedown)(t);
4122 return DELIVER_NOT_ATTEMPTED;
4128 /*************************************************
4129 * Print address information *
4130 *************************************************/
4132 /* This function is called to output an address, or information about an
4133 address, for bounce or defer messages. If the hide_child flag is set, all we
4134 output is the original ancestor address.
4137 addr points to the address
4138 f the FILE to print to
4139 si an initial string
4140 sc a continuation string for before "generated"
4143 Returns: TRUE if the address is not hidden
4147 print_address_information(address_item *addr, FILE *f, uschar *si, uschar *sc,
4151 uschar *printed = US"";
4152 address_item *ancestor = addr;
4153 while (ancestor->parent != NULL) ancestor = ancestor->parent;
4155 fprintf(f, "%s", CS si);
4157 if (addr->parent != NULL && testflag(addr, af_hide_child))
4159 printed = US"an undisclosed address";
4163 else if (!testflag(addr, af_pfr) || addr->parent == NULL)
4164 printed = addr->address;
4168 uschar *s = addr->address;
4171 if (addr->address[0] == '>') { ss = US"mail"; s++; }
4172 else if (addr->address[0] == '|') ss = US"pipe";
4175 fprintf(f, "%s to %s%sgenerated by ", ss, s, sc);
4176 printed = addr->parent->address;
4179 fprintf(f, "%s", CS string_printing(printed));
4181 if (ancestor != addr)
4183 uschar *original = (ancestor->onetime_parent == NULL)?
4184 ancestor->address : ancestor->onetime_parent;
4185 if (strcmpic(original, printed) != 0)
4186 fprintf(f, "%s(%sgenerated from %s)", sc,
4187 (ancestor != addr->parent)? "ultimately " : "",
4188 string_printing(original));
4191 fprintf(f, "%s", CS se);
4200 /*************************************************
4201 * Print error for an address *
4202 *************************************************/
4204 /* This function is called to print the error information out of an address for
4205 a bounce or a warning message. It tries to format the message reasonably by
4206 introducing newlines. All lines are indented by 4; the initial printing
4207 position must be set before calling.
4210 addr points to the address
4211 f the FILE to print on
4217 print_address_error(address_item *addr, FILE *f)
4219 uschar *s = (addr->user_message != NULL)? addr->user_message : addr->message;
4220 if (addr->basic_errno > 0)
4222 fprintf(f, "%s%s", strerror(addr->basic_errno),
4223 (s == NULL)? "" : ":\n ");
4227 if (addr->basic_errno <= 0) fprintf(f, "unknown error");
4234 if (*s == '\\' && s[1] == 'n')
4244 if (*s++ == ':' && isspace(*s) && count > 45)
4246 fprintf(f, "\n "); /* sic (because space follows) */
4257 /*************************************************
4258 * Deliver one message *
4259 *************************************************/
4261 /* This is the function which is called when a message is to be delivered. It
4262 is passed the id of the message. It is possible that the message no longer
4263 exists, if some other process has delivered it, and it is also possible that
4264 the message is being worked on by another process, in which case the data file
4267 If no delivery is attempted for any of the above reasons, the function returns
4268 DELIVER_NOT_ATTEMPTED.
4270 If the give_up flag is set true, do not attempt any deliveries, but instead
4271 fail all outstanding addresses and return the message to the sender (or
4274 A delivery operation has a process all to itself; we never deliver more than
4275 one message in the same process. Therefore we needn't worry too much about
4279 id the id of the message to be delivered
4280 forced TRUE if delivery was forced by an administrator; this overrides
4281 retry delays and causes a delivery to be tried regardless
4282 give_up TRUE if an administrator has requested that delivery attempts
4285 Returns: When the global variable mua_wrapper is FALSE:
4286 DELIVER_ATTEMPTED_NORMAL if a delivery attempt was made
4287 DELIVER_NOT_ATTEMPTED otherwise (see comment above)
4288 When the global variable mua_wrapper is TRUE:
4289 DELIVER_MUA_SUCCEEDED if delivery succeeded
4290 DELIVER_MUA_FAILED if delivery failed
4291 DELIVER_NOT_ATTEMPTED if not attempted (should not occur)
4295 deliver_message(uschar *id, BOOL forced, BOOL give_up)
4298 int final_yield = DELIVER_ATTEMPTED_NORMAL;
4299 time_t now = time(NULL);
4300 address_item *addr_last = NULL;
4301 uschar *filter_message = NULL;
4303 int process_recipients = RECIP_ACCEPT;
4307 uschar *info = (queue_run_pid == (pid_t)0)?
4308 string_sprintf("delivering %s", id) :
4309 string_sprintf("delivering %s (queue run pid %d)", id, queue_run_pid);
4311 /* If the D_process_info bit is on, set_process_info() will output debugging
4312 information. If not, we want to show this initial information if D_deliver or
4313 D_queue_run is set or in verbose mode. */
4315 set_process_info("%s", info);
4317 if ((debug_selector & D_process_info) == 0 &&
4318 (debug_selector & (D_deliver|D_queue_run|D_v)) != 0)
4319 debug_printf("%s\n", info);
4321 /* Ensure that we catch any subprocesses that are created. Although Exim
4322 sets SIG_DFL as its initial default, some routes through the code end up
4323 here with it set to SIG_IGN - cases where a non-synchronous delivery process
4324 has been forked, but no re-exec has been done. We use sigaction rather than
4325 plain signal() on those OS where SA_NOCLDWAIT exists, because we want to be
4326 sure it is turned off. (There was a problem on AIX with this.) */
4330 struct sigaction act;
4331 act.sa_handler = SIG_DFL;
4332 sigemptyset(&(act.sa_mask));
4334 sigaction(SIGCHLD, &act, NULL);
4337 signal(SIGCHLD, SIG_DFL);
4340 /* Make the forcing flag available for routers and transports, set up the
4341 global message id field, and initialize the count for returned files and the
4342 message size. This use of strcpy() is OK because the length id is checked when
4343 it is obtained from a command line (the -M or -q options), and otherwise it is
4344 known to be a valid message id. */
4346 Ustrcpy(message_id, id);
4347 deliver_force = forced;
4351 /* Initialize some flags */
4353 update_spool = FALSE;
4354 remove_journal = TRUE;
4356 /* Reset the random number generator, so that if several delivery processes are
4357 started from a queue runner that has already used random numbers (for sorting),
4358 they don't all get the same sequence. */
4362 /* Open and lock the message's data file. Exim locks on this one because the
4363 header file may get replaced as it is re-written during the delivery process.
4364 Any failures cause messages to be written to the log, except for missing files
4365 while queue running - another process probably completed delivery. As part of
4366 opening the data file, message_subdir gets set. */
4368 if (!spool_open_datafile(id))
4369 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
4371 /* The value of message_size at this point has been set to the data length,
4372 plus one for the blank line that notionally precedes the data. */
4374 /* Now read the contents of the header file, which will set up the headers in
4375 store, and also the list of recipients and the tree of non-recipients and
4376 assorted flags. It updates message_size. If there is a reading or format error,
4377 give up; if the message has been around for sufficiently long, remove it. */
4379 sprintf(CS spoolname, "%s-H", id);
4380 if ((rc = spool_read_header(spoolname, TRUE, TRUE)) != spool_read_OK)
4382 if (errno == ERRNO_SPOOLFORMAT)
4384 struct stat statbuf;
4385 sprintf(CS big_buffer, "%s/input/%s/%s", spool_directory, message_subdir,
4387 if (Ustat(big_buffer, &statbuf) == 0)
4389 int size = statbuf.st_size; /* Because might be a long */
4390 log_write(0, LOG_MAIN, "Format error in spool file %s: size=%d",
4393 else log_write(0, LOG_MAIN, "Format error in spool file %s", spoolname);
4396 log_write(0, LOG_MAIN, "Error reading spool file %s: %s", spoolname,
4399 /* If we managed to read the envelope data, received_time contains the
4400 time the message was received. Otherwise, we can calculate it from the
4403 if (rc != spool_read_hdrerror)
4406 for (i = 0; i < 6; i++)
4407 received_time = received_time * BASE_62 + tab62[id[i] - '0'];
4410 /* If we've had this malformed message too long, sling it. */
4412 if (now - received_time > keep_malformed)
4414 sprintf(CS spoolname, "%s/msglog/%s/%s", spool_directory, message_subdir, id);
4416 sprintf(CS spoolname, "%s/input/%s/%s-D", spool_directory, message_subdir, id);
4418 sprintf(CS spoolname, "%s/input/%s/%s-H", spool_directory, message_subdir, id);
4420 sprintf(CS spoolname, "%s/input/%s/%s-J", spool_directory, message_subdir, id);
4422 log_write(0, LOG_MAIN, "Message removed because older than %s",
4423 readconf_printtime(keep_malformed));
4426 close(deliver_datafile);
4427 deliver_datafile = -1;
4428 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
4431 /* The spool header file has been read. Look to see if there is an existing
4432 journal file for this message. If there is, it means that a previous delivery
4433 attempt crashed (program or host) before it could update the spool header file.
4434 Read the list of delivered addresses from the journal and add them to the
4435 nonrecipients tree. Then update the spool file. We can leave the journal in
4436 existence, as it will get further successful deliveries added to it in this
4437 run, and it will be deleted if this function gets to its end successfully.
4438 Otherwise it might be needed again. */
4440 sprintf(CS spoolname, "%s/input/%s/%s-J", spool_directory, message_subdir, id);
4441 jread = Ufopen(spoolname, "rb");
4444 while (Ufgets(big_buffer, big_buffer_size, jread) != NULL)
4446 int n = Ustrlen(big_buffer);
4447 big_buffer[n-1] = 0;
4448 tree_add_nonrecipient(big_buffer);
4449 DEBUG(D_deliver) debug_printf("Previously delivered address %s taken from "
4450 "journal file\n", big_buffer);
4453 /* Panic-dies on error */
4454 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
4456 else if (errno != ENOENT)
4458 log_write(0, LOG_MAIN|LOG_PANIC, "attempt to open journal for reading gave: "
4459 "%s", strerror(errno));
4460 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
4463 /* A null recipients list indicates some kind of disaster. */
4465 if (recipients_list == NULL)
4467 close(deliver_datafile);
4468 deliver_datafile = -1;
4469 log_write(0, LOG_MAIN, "Spool error: no recipients for %s", spoolname);
4470 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
4474 /* Handle a message that is frozen. There are a number of different things that
4475 can happen, but in the default situation, unless forced, no delivery is
4480 #ifdef SUPPORT_MOVE_FROZEN_MESSAGES
4481 /* Moving to another directory removes the message from Exim's view. Other
4482 tools must be used to deal with it. Logging of this action happens in
4483 spool_move_message() and its subfunctions. */
4485 if (move_frozen_messages &&
4486 spool_move_message(id, message_subdir, US"", US"F"))
4487 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
4490 /* For all frozen messages (bounces or not), timeout_frozen_after sets the
4491 maximum time to keep messages that are frozen. Thaw if we reach it, with a
4492 flag causing all recipients to be failed. The time is the age of the
4493 message, not the time since freezing. */
4495 if (timeout_frozen_after > 0 && message_age >= timeout_frozen_after)
4497 log_write(0, LOG_MAIN, "cancelled by timeout_frozen_after");
4498 process_recipients = RECIP_FAIL_TIMEOUT;
4501 /* For bounce messages (and others with no sender), thaw if the error message
4502 ignore timer is exceeded. The message will be discarded if this delivery
4505 else if (sender_address[0] == 0 && message_age >= ignore_bounce_errors_after)
4507 log_write(0, LOG_MAIN, "Unfrozen by errmsg timer");
4510 /* If there's no auto thaw, or we haven't reached the auto thaw time yet, and
4511 this delivery is not forced by an admin user, do not attempt delivery of this
4512 message. Note that forced is set for continuing messages down the same
4513 channel, in order to skip load checking and ignore hold domains, but we
4514 don't want unfreezing in that case. */
4518 if ((auto_thaw <= 0 || now <= deliver_frozen_at + auto_thaw) &&
4519 (!forced || !deliver_force_thaw || !admin_user ||
4520 continue_hostname != NULL))
4522 close(deliver_datafile);
4523 deliver_datafile = -1;
4524 log_write(L_skip_delivery, LOG_MAIN, "Message is frozen");
4525 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
4528 /* If delivery was forced (by an admin user), assume a manual thaw.
4529 Otherwise it's an auto thaw. */
4533 deliver_manual_thaw = TRUE;
4534 log_write(0, LOG_MAIN, "Unfrozen by forced delivery");
4536 else log_write(0, LOG_MAIN, "Unfrozen by auto-thaw");
4539 /* We get here if any of the rules for unfreezing have triggered. */
4541 deliver_freeze = FALSE;
4542 update_spool = TRUE;
4546 /* Open the message log file if we are using them. This records details of
4547 deliveries, deferments, and failures for the benefit of the mail administrator.
4548 The log is not used by exim itself to track the progress of a message; that is
4549 done by rewriting the header spool file. */
4556 sprintf(CS spoolname, "%s/msglog/%s/%s", spool_directory, message_subdir, id);
4557 fd = open_msglog_file(spoolname, SPOOL_MODE, &error);
4561 log_write(0, LOG_MAIN|LOG_PANIC, "Couldn't %s message log %s: %s", error,
4562 spoolname, strerror(errno));
4563 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
4566 /* Make a C stream out of it. */
4568 message_log = fdopen(fd, "a");
4569 if (message_log == NULL)
4571 log_write(0, LOG_MAIN|LOG_PANIC, "Couldn't fdopen message log %s: %s",
4572 spoolname, strerror(errno));
4573 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
4578 /* If asked to give up on a message, log who did it, and set the action for all
4583 struct passwd *pw = getpwuid(real_uid);
4584 log_write(0, LOG_MAIN, "cancelled by %s", (pw != NULL)?
4585 US pw->pw_name : string_sprintf("uid %ld", (long int)real_uid));
4586 process_recipients = RECIP_FAIL;
4589 /* Otherwise, if there are too many Received: headers, fail all recipients. */
4591 else if (received_count > received_headers_max)
4592 process_recipients = RECIP_FAIL_LOOP;
4594 /* Otherwise, if a system-wide, address-independent message filter is
4595 specified, run it now, except in the case when we are failing all recipients as
4596 a result of timeout_frozen_after. If the system filter yields "delivered", then
4597 ignore the true recipients of the message. Failure of the filter file is
4598 logged, and the delivery attempt fails. */
4600 else if (system_filter != NULL && process_recipients != RECIP_FAIL_TIMEOUT)
4605 redirect_block redirect;
4607 if (system_filter_uid_set)
4609 ugid.uid = system_filter_uid;
4610 ugid.gid = system_filter_gid;
4611 ugid.uid_set = ugid.gid_set = TRUE;
4615 ugid.uid_set = ugid.gid_set = FALSE;
4618 return_path = sender_address;
4619 enable_dollar_recipients = TRUE; /* Permit $recipients in system filter */
4620 system_filtering = TRUE;
4622 /* Any error in the filter file causes a delivery to be abandoned. */
4624 redirect.string = system_filter;
4625 redirect.isfile = TRUE;
4626 redirect.check_owner = redirect.check_group = FALSE;
4627 redirect.owners = NULL;
4628 redirect.owngroups = NULL;
4630 redirect.modemask = 0;
4632 DEBUG(D_deliver|D_filter) debug_printf("running system filter\n");
4635 &redirect, /* Where the data is */
4636 RDO_DEFER | /* Turn on all the enabling options */
4637 RDO_FAIL | /* Leave off all the disabling options */
4642 NULL, /* No :include: restriction (not used in filter) */
4643 NULL, /* No sieve vacation directory (not sieve!) */
4644 &ugid, /* uid/gid data */
4645 &addr_new, /* Where to hang generated addresses */
4646 &filter_message, /* Where to put error message */
4647 NULL, /* Don't skip syntax errors */
4648 &filtertype, /* Will always be set to FILTER_EXIM for this call */
4649 US"system filter"); /* For error messages */
4651 DEBUG(D_deliver|D_filter) debug_printf("system filter returned %d\n", rc);
4653 if (rc == FF_ERROR || rc == FF_NONEXIST)
4655 close(deliver_datafile);
4656 deliver_datafile = -1;
4657 log_write(0, LOG_MAIN|LOG_PANIC, "Error in system filter: %s",
4658 string_printing(filter_message));
4659 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
4662 /* Reset things. If the filter message is an empty string, which can happen
4663 for a filter "fail" or "freeze" command with no text, reset it to NULL. */
4665 system_filtering = FALSE;
4666 enable_dollar_recipients = FALSE;
4667 if (filter_message != NULL && filter_message[0] == 0) filter_message = NULL;
4669 /* Save the values of the system filter variables so that user filters
4672 memcpy(filter_sn, filter_n, sizeof(filter_sn));
4674 /* The filter can request that delivery of the original addresses be
4679 process_recipients = RECIP_DEFER;
4680 deliver_msglog("Delivery deferred by system filter\n");
4681 log_write(0, LOG_MAIN, "Delivery deferred by system filter");
4684 /* The filter can request that a message be frozen, but this does not
4685 take place if the message has been manually thawed. In that case, we must
4686 unset "delivered", which is forced by the "freeze" command to make -bF
4689 else if (rc == FF_FREEZE && !deliver_manual_thaw)
4691 deliver_freeze = TRUE;
4692 deliver_frozen_at = time(NULL);
4693 process_recipients = RECIP_DEFER;
4694 frozen_info = string_sprintf(" by the system filter%s%s",
4695 (filter_message == NULL)? US"" : US": ",
4696 (filter_message == NULL)? US"" : filter_message);
4699 /* The filter can request that a message be failed. The error message may be
4700 quite long - it is sent back to the sender in the bounce - but we don't want
4701 to fill up the log with repetitions of it. If it starts with << then the text
4702 between << and >> is written to the log, with the rest left for the bounce
4705 else if (rc == FF_FAIL)
4707 uschar *colon = US"";
4708 uschar *logmsg = US"";
4711 process_recipients = RECIP_FAIL_FILTER;
4713 if (filter_message != NULL)
4717 if (filter_message[0] == '<' && filter_message[1] == '<' &&
4718 (logend = Ustrstr(filter_message, ">>")) != NULL)
4720 logmsg = filter_message + 2;
4721 loglen = logend - logmsg;
4722 filter_message = logend + 2;
4723 if (filter_message[0] == 0) filter_message = NULL;
4727 logmsg = filter_message;
4728 loglen = Ustrlen(filter_message);
4732 log_write(0, LOG_MAIN, "cancelled by system filter%s%.*s", colon, loglen,
4736 /* Delivery can be restricted only to those recipients (if any) that the
4737 filter specified. */
4739 else if (rc == FF_DELIVERED)
4741 process_recipients = RECIP_IGNORE;
4742 if (addr_new == NULL)
4743 log_write(0, LOG_MAIN, "=> discarded (system filter)");
4745 log_write(0, LOG_MAIN, "original recipients ignored (system filter)");
4748 /* If any new addresses were created by the filter, fake up a "parent"
4749 for them. This is necessary for pipes, etc., which are expected to have
4750 parents, and it also gives some sensible logging for others. Allow
4751 pipes, files, and autoreplies, and run them as the filter uid if set,
4752 otherwise as the current uid. */
4754 if (addr_new != NULL)
4756 int uid = (system_filter_uid_set)? system_filter_uid : geteuid();
4757 int gid = (system_filter_gid_set)? system_filter_gid : getegid();
4759 /* The text "system-filter" is tested in transport_set_up_command() and in
4760 set_up_shell_command() in the pipe transport, to enable them to permit
4761 $recipients, so don't change it here without also changing it there. */
4763 address_item *p = addr_new;
4764 address_item *parent = deliver_make_addr(US"system-filter", FALSE);
4766 parent->domain = string_copylc(qualify_domain_recipient);
4767 parent->local_part = US"system-filter";
4769 /* As part of this loop, we arrange for addr_last to end up pointing
4770 at the final address. This is used if we go on to add addresses for the
4771 original recipients. */
4775 parent->child_count++;
4778 if (testflag(p, af_pfr))
4784 setflag(p, af_uid_set |
4790 /* Find the name of the system filter's appropriate pfr transport */
4792 if (p->address[0] == '|')
4795 tpname = system_filter_pipe_transport;
4796 address_pipe = p->address;
4798 else if (p->address[0] == '>')
4801 tpname = system_filter_reply_transport;
4805 if (p->address[Ustrlen(p->address)-1] == '/')
4807 type = US"directory";
4808 tpname = system_filter_directory_transport;
4813 tpname = system_filter_file_transport;
4815 address_file = p->address;
4818 /* Now find the actual transport, first expanding the name. We have
4819 set address_file or address_pipe above. */
4823 uschar *tmp = expand_string(tpname);
4824 address_file = address_pipe = NULL;
4826 p->message = string_sprintf("failed to expand \"%s\" as a "
4827 "system filter transport name", tpname);
4832 p->message = string_sprintf("system_filter_%s_transport is unset",
4838 transport_instance *tp;
4839 for (tp = transports; tp != NULL; tp = tp->next)
4841 if (Ustrcmp(tp->name, tpname) == 0)
4848 p->message = string_sprintf("failed to find \"%s\" transport "
4849 "for system filter delivery", tpname);
4852 /* If we couldn't set up a transport, defer the delivery, putting the
4853 error on the panic log as well as the main log. */
4855 if (p->transport == NULL)
4857 address_item *badp = p;
4859 if (addr_last == NULL) addr_new = p; else addr_last->next = p;
4860 badp->local_part = badp->address; /* Needed for log line */
4861 post_process_one(badp, DEFER, LOG_MAIN|LOG_PANIC, DTYPE_ROUTER, 0);
4864 } /* End of pfr handling */
4866 /* Either a non-pfr delivery, or we found a transport */
4868 DEBUG(D_deliver|D_filter)
4869 debug_printf("system filter added %s\n", p->address);
4873 } /* Loop through all addr_new addresses */
4878 /* Scan the recipients list, and for every one that is not in the non-
4879 recipients tree, add an addr item to the chain of new addresses. If the pno
4880 value is non-negative, we must set the onetime parent from it. This which
4881 points to the relevant entry in the recipients list.
4883 This processing can be altered by the setting of the process_recipients
4884 variable, which is changed if recipients are to be ignored, failed, or
4885 deferred. This can happen as a result of system filter activity, or if the -Mg
4886 option is used to fail all of them.
4888 Duplicate addresses are handled later by a different tree structure; we can't
4889 just extend the non-recipients tree, because that will be re-written to the
4890 spool if the message is deferred, and in any case there are casing
4891 complications for local addresses. */
4893 if (process_recipients != RECIP_IGNORE)
4895 for (i = 0; i < recipients_count; i++)
4897 if (tree_search(tree_nonrecipients, recipients_list[i].address) == NULL)
4899 recipient_item *r = recipients_list + i;
4900 address_item *new = deliver_make_addr(r->address, FALSE);
4901 new->p.errors_address = r->errors_to;
4904 new->onetime_parent = recipients_list[r->pno].address;
4906 switch (process_recipients)
4908 /* RECIP_DEFER is set when a system filter freezes a message. */
4911 new->next = addr_defer;
4916 /* RECIP_FAIL_FILTER is set when a system filter has obeyed a "fail"
4919 case RECIP_FAIL_FILTER:
4921 (filter_message == NULL)? US"delivery cancelled" : filter_message;
4922 goto RECIP_QUEUE_FAILED; /* below */
4925 /* RECIP_FAIL_TIMEOUT is set when a message is frozen, but is older
4926 than the value in timeout_frozen_after. Treat non-bounce messages
4927 similarly to -Mg; for bounce messages we just want to discard, so
4928 don't put the address on the failed list. The timeout has already
4931 case RECIP_FAIL_TIMEOUT:
4932 new->message = US"delivery cancelled; message timed out";
4933 goto RECIP_QUEUE_FAILED; /* below */
4936 /* RECIP_FAIL is set when -Mg has been used. */
4939 new->message = US"delivery cancelled by administrator";
4942 /* Common code for the failure cases above. If this is not a bounce
4943 message, put the address on the failed list so that it is used to
4944 create a bounce. Otherwise do nothing - this just discards the address.
4945 The incident has already been logged. */
4948 if (sender_address[0] != 0)
4950 new->next = addr_failed;
4956 /* RECIP_FAIL_LOOP is set when there are too many Received: headers
4957 in the message. Process each address as a routing failure; if this
4958 is a bounce message, it will get frozen. */
4960 case RECIP_FAIL_LOOP:
4961 new->message = US"Too many \"Received\" headers - suspected mail loop";
4962 post_process_one(new, FAIL, LOG_MAIN, DTYPE_ROUTER, 0);
4966 /* Value should be RECIP_ACCEPT; take this as the safe default. */
4969 if (addr_new == NULL) addr_new = new; else addr_last->next = new;
4979 address_item *p = addr_new;
4980 debug_printf("Delivery address list:\n");
4983 debug_printf(" %s %s\n", p->address, (p->onetime_parent == NULL)? US"" :
4989 /* Set up the buffers used for copying over the file when delivering. */
4991 deliver_in_buffer = store_malloc(DELIVER_IN_BUFFER_SIZE);
4992 deliver_out_buffer = store_malloc(DELIVER_OUT_BUFFER_SIZE);
4996 /* Until there are no more new addresses, handle each one as follows:
4998 . If this is a generated address (indicated by the presence of a parent
4999 pointer) then check to see whether it is a pipe, file, or autoreply, and
5000 if so, handle it directly here. The router that produced the address will
5001 have set the allow flags into the address, and also set the uid/gid required.
5002 Having the routers generate new addresses and then checking them here at
5003 the outer level is tidier than making each router do the checking, and
5004 means that routers don't need access to the failed address queue.
5006 . Break up the address into local part and domain, and make lowercased
5007 versions of these strings. We also make unquoted versions of the local part.
5009 . Handle the percent hack for those domains for which it is valid.
5011 . For child addresses, determine if any of the parents have the same address.
5012 If so, generate a different string for previous delivery checking. Without
5013 this code, if the address spqr generates spqr via a forward or alias file,
5014 delivery of the generated spqr stops further attempts at the top level spqr,
5015 which is not what is wanted - it may have generated other addresses.
5017 . Check on the retry database to see if routing was previously deferred, but
5018 only if in a queue run. Addresses that are to be routed are put on the
5019 addr_route chain. Addresses that are to be deferred are put on the
5020 addr_defer chain. We do all the checking first, so as not to keep the
5021 retry database open any longer than necessary.
5023 . Now we run the addresses through the routers. A router may put the address
5024 on either the addr_local or the addr_remote chain for local or remote
5025 delivery, respectively, or put it on the addr_failed chain if it is
5026 undeliveable, or it may generate child addresses and put them on the
5027 addr_new chain, or it may defer an address. All the chain anchors are
5028 passed as arguments so that the routers can be called for verification
5031 . If new addresses have been generated by the routers, da capo.
5034 header_rewritten = FALSE; /* No headers rewritten yet */
5035 while (addr_new != NULL) /* Loop until all addresses dealt with */
5037 address_item *addr, *parent;
5038 dbm_file = dbfn_open(US"retry", O_RDONLY, &dbblock, FALSE);
5040 /* Failure to open the retry database is treated the same as if it does
5041 not exist. In both cases, dbm_file is NULL. */
5043 if (dbm_file == NULL)
5045 DEBUG(D_deliver|D_retry|D_route|D_hints_lookup)
5046 debug_printf("no retry data available\n");
5049 /* Scan the current batch of new addresses, to handle pipes, files and
5050 autoreplies, and determine which others are ready for routing. */
5052 while (addr_new != NULL)
5057 dbdata_retry *domain_retry_record;
5058 dbdata_retry *address_retry_record;
5061 addr_new = addr->next;
5063 DEBUG(D_deliver|D_retry|D_route)
5065 debug_printf(">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>\n");
5066 debug_printf("Considering: %s\n", addr->address);
5069 /* Handle generated address that is a pipe or a file or an autoreply. */
5071 if (testflag(addr, af_pfr))
5073 int offset = testflag(addr->parent, af_homonym)? 3:0;
5075 /* If two different users specify delivery to the same pipe or file or
5076 autoreply, there should be two different deliveries, so build a unique
5077 string that incorporates the original address, and use this for
5078 duplicate testing and recording delivery, and also for retrying. */
5081 string_sprintf("%s:%s", addr->address, addr->parent->unique + offset);
5083 addr->address_retry_key = addr->domain_retry_key =
5084 string_sprintf("T:%s", addr->unique);
5086 /* If a filter file specifies two deliveries to the same pipe or file,
5087 we want to de-duplicate, but this is probably not wanted for two mail
5088 commands to the same address, where probably both should be delivered.
5089 So, we have to invent a different unique string in that case. Just
5090 keep piling '>' characters on the front. */
5092 if (addr->address[0] == '>')
5094 while (tree_search(tree_duplicates, addr->unique) != NULL)
5095 addr->unique = string_sprintf(">%s", addr->unique);
5098 else if ((tnode = tree_search(tree_duplicates, addr->unique)) != NULL)
5100 DEBUG(D_deliver|D_route)
5101 debug_printf("%s is a duplicate address: discarded\n", addr->address);
5102 addr->dupof = tnode->data.ptr;
5103 addr->next = addr_duplicate;
5104 addr_duplicate = addr;
5108 DEBUG(D_deliver|D_route) debug_printf("unique = %s\n", addr->unique);
5110 /* Check for previous delivery */
5112 if (tree_search(tree_nonrecipients, addr->unique) != NULL)
5114 DEBUG(D_deliver|D_route)
5115 debug_printf("%s was previously delivered: discarded\n", addr->address);
5116 child_done(addr, tod_stamp(tod_log));
5120 /* Save for checking future duplicates */
5122 tree_add_duplicate(addr->unique, addr);
5124 /* Set local part and domain */
5126 addr->local_part = addr->address;
5127 addr->domain = addr->parent->domain;
5129 /* Ensure that the delivery is permitted. */
5131 if (testflag(addr, af_file))
5133 if (!testflag(addr, af_allow_file))
5135 addr->basic_errno = ERRNO_FORBIDFILE;
5136 addr->message = US"delivery to file forbidden";
5137 (void)post_process_one(addr, FAIL, LOG_MAIN, DTYPE_ROUTER, 0);
5138 continue; /* with the next new address */
5141 else if (addr->address[0] == '|')
5143 if (!testflag(addr, af_allow_pipe))
5145 addr->basic_errno = ERRNO_FORBIDPIPE;
5146 addr->message = US"delivery to pipe forbidden";
5147 (void)post_process_one(addr, FAIL, LOG_MAIN, DTYPE_ROUTER, 0);
5148 continue; /* with the next new address */
5151 else if (!testflag(addr, af_allow_reply))
5153 addr->basic_errno = ERRNO_FORBIDREPLY;
5154 addr->message = US"autoreply forbidden";
5155 (void)post_process_one(addr, FAIL, LOG_MAIN, DTYPE_ROUTER, 0);
5156 continue; /* with the next new address */
5159 /* If the errno field is already set to BADTRANSPORT, it indicates
5160 failure to expand a transport string, or find the associated transport,
5161 or an unset transport when one is required. Leave this test till now so
5162 that the forbid errors are given in preference. */
5164 if (addr->basic_errno == ERRNO_BADTRANSPORT)
5166 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_ROUTER, 0);
5170 /* Treat /dev/null as a special case and abandon the delivery. This
5171 avoids having to specify a uid on the transport just for this case.
5172 Arrange for the transport name to be logged as "**bypassed**". */
5174 if (Ustrcmp(addr->address, "/dev/null") == 0)
5176 uschar *save = addr->transport->name;
5177 addr->transport->name = US"**bypassed**";
5178 (void)post_process_one(addr, OK, LOG_MAIN, DTYPE_TRANSPORT, '=');
5179 addr->transport->name = save;
5180 continue; /* with the next new address */
5183 /* Pipe, file, or autoreply delivery is to go ahead as a normal local
5186 DEBUG(D_deliver|D_route)
5187 debug_printf("queued for %s transport\n", addr->transport->name);
5188 addr->next = addr_local;
5190 continue; /* with the next new address */
5193 /* Handle normal addresses. First, split up into local part and domain,
5194 handling the %-hack if necessary. There is the possibility of a defer from
5195 a lookup in percent_hack_domains. */
5197 if ((rc = deliver_split_address(addr)) == DEFER)
5199 addr->message = US"cannot check percent_hack_domains";
5200 addr->basic_errno = ERRNO_LISTDEFER;
5201 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_NONE, 0);
5205 /* Check to see if the domain is held. If so, proceed only if the
5206 delivery was forced by hand. */
5208 deliver_domain = addr->domain; /* set $domain */
5209 if (!forced && hold_domains != NULL &&
5210 (rc = match_isinlist(addr->domain, &hold_domains, 0,
5211 &domainlist_anchor, addr->domain_cache, MCL_DOMAIN, TRUE,
5216 addr->message = US"hold_domains lookup deferred";
5217 addr->basic_errno = ERRNO_LISTDEFER;
5221 addr->message = US"domain is held";
5222 addr->basic_errno = ERRNO_HELD;
5224 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_NONE, 0);
5228 /* Now we can check for duplicates and previously delivered addresses. In
5229 order to do this, we have to generate a "unique" value for each address,
5230 because there may be identical actual addresses in a line of descendents.
5231 The "unique" field is initialized to the same value as the "address" field,
5232 but gets changed here to cope with identically-named descendents. */
5234 for (parent = addr->parent; parent != NULL; parent = parent->parent)
5235 if (strcmpic(addr->address, parent->address) == 0) break;
5237 /* If there's an ancestor with the same name, set the homonym flag. This
5238 influences how deliveries are recorded. Then add a prefix on the front of
5239 the unique address. We use \n\ where n starts at 0 and increases each time.
5240 It is unlikely to pass 9, but if it does, it may look odd but will still
5241 work. This means that siblings or cousins with the same names are treated
5242 as duplicates, which is what we want. */
5246 setflag(addr, af_homonym);
5247 if (parent->unique[0] != '\\')
5248 addr->unique = string_sprintf("\\0\\%s", addr->address);
5250 addr->unique = string_sprintf("\\%c\\%s", parent->unique[1] + 1,
5254 /* Ensure that the domain in the unique field is lower cased, because
5255 domains are always handled caselessly. */
5257 p = Ustrrchr(addr->unique, '@');
5258 while (*p != 0) { *p = tolower(*p); p++; }
5260 DEBUG(D_deliver|D_route) debug_printf("unique = %s\n", addr->unique);
5262 if (tree_search(tree_nonrecipients, addr->unique) != NULL)
5264 DEBUG(D_deliver|D_route)
5265 debug_printf("%s was previously delivered: discarded\n", addr->unique);
5266 child_done(addr, tod_stamp(tod_log));
5270 /* If it's a duplicate, remember what it's a duplicate of */
5272 if ((tnode = tree_search(tree_duplicates, addr->unique)) != NULL)
5274 DEBUG(D_deliver|D_route)
5275 debug_printf("%s is a duplicate address: discarded\n", addr->unique);
5276 addr->dupof = tnode->data.ptr;
5277 addr->next = addr_duplicate;
5278 addr_duplicate = addr;
5282 /* Record this address, so subsequent duplicates get picked up. */
5284 tree_add_duplicate(addr->unique, addr);
5286 /* Get the routing retry status, saving the two retry keys (with and
5287 without the local part) for subsequent use. Ignore retry records that
5290 addr->domain_retry_key = string_sprintf("R:%s", addr->domain);
5291 addr->address_retry_key = string_sprintf("R:%s@%s", addr->local_part,
5294 if (dbm_file == NULL)
5295 domain_retry_record = address_retry_record = NULL;
5298 domain_retry_record = dbfn_read(dbm_file, addr->domain_retry_key);
5299 if (domain_retry_record != NULL &&
5300 now - domain_retry_record->time_stamp > retry_data_expire)
5301 domain_retry_record = NULL;
5303 address_retry_record = dbfn_read(dbm_file, addr->address_retry_key);
5304 if (address_retry_record != NULL &&
5305 now - address_retry_record->time_stamp > retry_data_expire)
5306 address_retry_record = NULL;
5309 DEBUG(D_deliver|D_retry)
5311 if (domain_retry_record == NULL)
5312 debug_printf("no domain retry record\n");
5313 if (address_retry_record == NULL)
5314 debug_printf("no address retry record\n");
5317 /* If we are sending a message down an existing SMTP connection, we must
5318 assume that the message which created the connection managed to route
5319 an address to that connection. We do not want to run the risk of taking
5320 a long time over routing here, because if we do, the server at the other
5321 end of the connection may time it out. This is especially true for messages
5322 with lots of addresses. For this kind of delivery, queue_running is not
5323 set, so we would normally route all addresses. We take a pragmatic approach
5324 and defer routing any addresses that have any kind of domain retry record.
5325 That is, we don't even look at their retry times. It doesn't matter if this
5326 doesn't work occasionally. This is all just an optimization, after all.
5328 The reason for not doing the same for address retries is that they normally
5329 arise from 4xx responses, not DNS timeouts. */
5331 if (continue_hostname != NULL && domain_retry_record != NULL)
5333 addr->message = US"reusing SMTP connection skips previous routing defer";
5334 addr->basic_errno = ERRNO_RRETRY;
5335 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_ROUTER, 0);
5338 /* If queue_running, defer routing unless no retry data or we've
5339 passed the next retry time, or this message is forced. However,
5340 if the retry time has expired, allow the routing attempt.
5341 If it fails again, the address will be failed. This ensures that
5342 each address is routed at least once, even after long-term routing
5345 If there is an address retry, check that too; just wait for the next
5346 retry time. This helps with the case when the temporary error on the
5347 address was really message-specific rather than address specific, since
5348 it allows other messages through. */
5350 else if (!deliver_force && queue_running &&
5351 ((domain_retry_record != NULL &&
5352 now < domain_retry_record->next_try &&
5353 !domain_retry_record->expired)
5355 (address_retry_record != NULL &&
5356 now < address_retry_record->next_try))
5359 addr->message = US"retry time not reached";
5360 addr->basic_errno = ERRNO_RRETRY;
5361 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_ROUTER, 0);
5364 /* The domain is OK for routing. Remember if retry data exists so it
5365 can be cleaned up after a successful delivery. */
5369 if (domain_retry_record != NULL || address_retry_record != NULL)
5370 setflag(addr, af_dr_retry_exists);
5371 addr->next = addr_route;
5373 DEBUG(D_deliver|D_route)
5374 debug_printf("%s: queued for routing\n", addr->address);
5378 /* The database is closed while routing is actually happening. Requests to
5379 update it are put on a chain and all processed together at the end. */
5381 if (dbm_file != NULL) dbfn_close(dbm_file);
5383 /* If queue_domains is set, we don't even want to try routing addresses in
5384 those domains. During queue runs, queue_domains is forced to be unset.
5385 Optimize by skipping this pass through the addresses if nothing is set. */
5387 if (!deliver_force && queue_domains != NULL)
5389 address_item *okaddr = NULL;
5390 while (addr_route != NULL)
5392 address_item *addr = addr_route;
5393 addr_route = addr->next;
5395 deliver_domain = addr->domain; /* set $domain */
5396 if ((rc = match_isinlist(addr->domain, &queue_domains, 0,
5397 &domainlist_anchor, addr->domain_cache, MCL_DOMAIN, TRUE, NULL))
5402 addr->basic_errno = ERRNO_LISTDEFER;
5403 addr->message = US"queue_domains lookup deferred";
5404 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_ROUTER, 0);
5408 addr->next = okaddr;
5414 addr->basic_errno = ERRNO_QUEUE_DOMAIN;
5415 addr->message = US"domain is in queue_domains";
5416 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_ROUTER, 0);
5420 addr_route = okaddr;
5423 /* Now route those addresses that are not deferred. */
5425 while (addr_route != NULL)
5428 address_item *addr = addr_route;
5429 uschar *old_domain = addr->domain;
5430 uschar *old_unique = addr->unique;
5431 addr_route = addr->next;
5434 /* Just in case some router parameter refers to it. */
5436 return_path = (addr->p.errors_address != NULL)?
5437 addr->p.errors_address : sender_address;
5439 /* If a router defers an address, add a retry item. Whether or not to
5440 use the local part in the key is a property of the router. */
5442 if ((rc = route_address(addr, &addr_local, &addr_remote, &addr_new,
5443 &addr_succeed, v_none)) == DEFER)
5444 retry_add_item(addr, (addr->router->retry_use_local_part)?
5445 string_sprintf("R:%s@%s", addr->local_part, addr->domain) :
5446 string_sprintf("R:%s", addr->domain), 0);
5448 /* Otherwise, if there is an existing retry record in the database, add
5449 retry items to delete both forms. Since the domain might have been
5450 rewritten (expanded to fully qualified) as a result of routing, ensure
5451 that the rewritten form is also deleted. */
5453 else if (testflag(addr, af_dr_retry_exists))
5455 retry_add_item(addr, addr->address_retry_key, rf_delete);
5456 retry_add_item(addr, addr->domain_retry_key, rf_delete);
5457 if (Ustrcmp(addr->domain, old_domain) != 0)
5458 retry_add_item(addr, string_sprintf("R:%s", old_domain), rf_delete);
5461 /* DISCARD is given for :blackhole: and "seen finish". The event has been
5462 logged, but we need to ensure the address (and maybe parents) is marked
5467 address_done(addr, tod_stamp(tod_log));
5468 continue; /* route next address */
5471 /* The address is finished with (failed or deferred). */
5475 (void)post_process_one(addr, rc, LOG_MAIN, DTYPE_ROUTER, 0);
5476 continue; /* route next address */
5479 /* The address has been routed. If the router changed the domain, it will
5480 also have changed the unique address. We have to test whether this address
5481 has already been delivered, because it's the unique address that finally
5484 if (addr->unique != old_unique &&
5485 tree_search(tree_nonrecipients, addr->unique) != 0)
5487 DEBUG(D_deliver|D_route) debug_printf("%s was previously delivered: "
5488 "discarded\n", addr->address);
5489 if (addr_remote == addr) addr_remote = addr->next;
5490 else if (addr_local == addr) addr_local = addr->next;
5493 /* If the router has same_domain_copy_routing set, we are permitted to copy
5494 the routing for any other addresses with the same domain. This is an
5495 optimisation to save repeated DNS lookups for "standard" remote domain
5496 routing. The option is settable only on routers that generate host lists.
5497 We play it very safe, and do the optimization only if the address is routed
5498 to a remote transport, there are no header changes, and the domain was not
5499 modified by the router. */
5501 if (addr_remote == addr &&
5502 addr->router->same_domain_copy_routing &&
5503 addr->p.extra_headers == NULL &&
5504 addr->p.remove_headers == NULL &&
5505 old_domain == addr->domain)
5507 address_item **chain = &addr_route;
5508 while (*chain != NULL)
5510 address_item *addr2 = *chain;
5511 if (Ustrcmp(addr2->domain, addr->domain) != 0)
5513 chain = &(addr2->next);
5517 /* Found a suitable address; take it off the routing list and add it to
5518 the remote delivery list. */
5520 *chain = addr2->next;
5521 addr2->next = addr_remote;
5522 addr_remote = addr2;
5524 /* Copy the routing data */
5526 addr2->domain = addr->domain;
5527 addr2->router = addr->router;
5528 addr2->transport = addr->transport;
5529 addr2->host_list = addr->host_list;
5530 addr2->fallback_hosts = addr->fallback_hosts;
5531 addr2->p.errors_address = addr->p.errors_address;
5532 copyflag(addr2, addr, af_hide_child | af_local_host_removed);
5534 DEBUG(D_deliver|D_route)
5536 debug_printf(">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>\n"
5538 "Routing for %s copied from %s\n",
5539 addr2->address, addr2->address, addr->address);
5543 } /* Continue with routing the next address. */
5544 } /* Loop to process any child addresses that the routers created, and
5545 any rerouted addresses that got put back on the new chain. */
5548 /* Debugging: show the results of the routing */
5550 DEBUG(D_deliver|D_retry|D_route)
5552 address_item *p = addr_local;
5553 debug_printf(">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>\n");
5554 debug_printf("After routing:\n Local deliveries:\n");
5557 debug_printf(" %s\n", p->address);
5562 debug_printf(" Remote deliveries:\n");
5565 debug_printf(" %s\n", p->address);
5570 debug_printf(" Failed addresses:\n");
5573 debug_printf(" %s\n", p->address);
5578 debug_printf(" Deferred addresses:\n");
5581 debug_printf(" %s\n", p->address);
5586 /* Free any resources that were cached during routing. */
5591 /* These two variables are set only during routing, after check_local_user.
5592 Ensure they are not set in transports. */
5594 local_user_gid = (gid_t)(-1);
5595 local_user_uid = (uid_t)(-1);
5597 /* When acting as an MUA wrapper, we proceed only if all addresses route to a
5598 remote transport. The check that they all end up in one transaction happens in
5599 the do_remote_deliveries() function. */
5601 if (mua_wrapper && (addr_local != NULL || addr_failed != NULL ||
5602 addr_defer != NULL))
5605 uschar *which, *colon, *msg;
5607 if (addr_local != NULL)
5612 else if (addr_defer != NULL)
5615 which = US"deferred";
5623 while (addr->parent != NULL) addr = addr->parent;
5625 if (addr->message != NULL)
5628 msg = addr->message;
5630 else colon = msg = US"";
5632 /* We don't need to log here for a forced failure as it will already
5633 have been logged. Defer will also have been logged, but as a defer, so we do
5634 need to do the failure logging. */
5636 if (addr != addr_failed)
5637 log_write(0, LOG_MAIN, "** %s routing yielded a %s delivery",
5638 addr->address, which);
5640 /* Always write an error to the caller */
5642 fprintf(stderr, "routing %s yielded a %s delivery%s%s\n", addr->address,
5645 final_yield = DELIVER_MUA_FAILED;
5646 addr_failed = addr_defer = NULL; /* So that we remove the message */
5647 goto DELIVERY_TIDYUP;
5651 /* If this is a run to continue deliveries to an external channel that is
5652 already set up, defer any local deliveries. */
5654 if (continue_transport != NULL)
5656 if (addr_defer == NULL) addr_defer = addr_local; else
5658 address_item *addr = addr_defer;
5659 while (addr->next != NULL) addr = addr->next;
5660 addr->next = addr_local;
5666 /* Because address rewriting can happen in the routers, we should not really do
5667 ANY deliveries until all addresses have been routed, so that all recipients of
5668 the message get the same headers. However, this is in practice not always
5669 possible, since sometimes remote addresses give DNS timeouts for days on end.
5670 The pragmatic approach is to deliver what we can now, saving any rewritten
5671 headers so that at least the next lot of recipients benefit from the rewriting
5672 that has already been done.
5674 If any headers have been rewritten during routing, update the spool file to
5675 remember them for all subsequent deliveries. This can be delayed till later if
5676 there is only address to be delivered - if it succeeds the spool write need not
5679 if (header_rewritten &&
5680 ((addr_local != NULL &&
5681 (addr_local->next != NULL || addr_remote != NULL)) ||
5682 (addr_remote != NULL && addr_remote->next != NULL)))
5684 /* Panic-dies on error */
5685 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
5686 header_rewritten = FALSE;
5690 /* If there are any deliveries to be done, open the journal file. This is used
5691 to record successful deliveries as soon as possible after each delivery is
5692 known to be complete. A file opened with O_APPEND is used so that several
5693 processes can run simultaneously.
5695 The journal is just insurance against crashes. When the spool file is
5696 ultimately updated at the end of processing, the journal is deleted. If a
5697 journal is found to exist at the start of delivery, the addresses listed
5698 therein are added to the non-recipients. */
5700 if (addr_local != NULL || addr_remote != NULL)
5702 sprintf(CS spoolname, "%s/input/%s/%s-J", spool_directory, message_subdir, id);
5703 journal_fd = Uopen(spoolname, O_WRONLY|O_APPEND|O_CREAT, SPOOL_MODE);
5707 log_write(0, LOG_MAIN|LOG_PANIC, "Couldn't open journal file %s: %s",
5708 spoolname, strerror(errno));
5709 return DELIVER_NOT_ATTEMPTED;
5712 /* Set the close-on-exec flag, make the file owned by Exim, and ensure
5713 that the mode is correct - the group setting doesn't always seem to get
5714 set automatically. */
5716 fcntl(journal_fd, F_SETFD, fcntl(journal_fd, F_GETFD) | FD_CLOEXEC);
5717 fchown(journal_fd, exim_uid, exim_gid);
5718 fchmod(journal_fd, SPOOL_MODE);
5722 /* Now we can get down to the business of actually doing deliveries. Local
5723 deliveries are done first, then remote ones. If ever the problems of how to
5724 handle fallback transports are figured out, this section can be put into a loop
5725 for handling fallbacks, though the uid switching will have to be revised. */
5727 if (addr_local != NULL)
5729 DEBUG(D_deliver|D_transport)
5730 debug_printf(">>>>>>>>>>>>>>>> Local deliveries >>>>>>>>>>>>>>>>\n");
5731 do_local_deliveries();
5732 disable_logging = FALSE;
5735 /* If queue_run_local is set, we do not want to attempt any remote deliveries,
5736 so just queue them all. */
5738 if (queue_run_local)
5740 while (addr_remote != NULL)
5742 address_item *addr = addr_remote;
5743 addr_remote = addr->next;
5745 addr->basic_errno = ERRNO_LOCAL_ONLY;
5746 addr->message = US"remote deliveries suppressed";
5747 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_TRANSPORT, 0);
5751 /* Handle remote deliveries */
5753 if (addr_remote != NULL)
5755 DEBUG(D_deliver|D_transport)
5756 debug_printf(">>>>>>>>>>>>>>>> Remote deliveries >>>>>>>>>>>>>>>>\n");
5758 /* Precompile some regex that are used to recognize parameters in response
5759 to an EHLO command, if they aren't already compiled. */
5761 if (regex_PIPELINING == NULL) regex_PIPELINING =
5762 regex_must_compile(US"\\n250[\\s\\-]PIPELINING(\\s|\\n|$)", FALSE, TRUE);
5764 if (regex_SIZE == NULL) regex_SIZE =
5765 regex_must_compile(US"\\n250[\\s\\-]SIZE(\\s|\\n|$)", FALSE, TRUE);
5767 if (regex_AUTH == NULL) regex_AUTH =
5768 regex_must_compile(US"\\n250[\\s\\-]AUTH\\s+([\\-\\w\\s]+)(?:\\n|$)",
5772 if (regex_STARTTLS == NULL) regex_STARTTLS =
5773 regex_must_compile(US"\\n250[\\s\\-]STARTTLS(\\s|\\n|$)", FALSE, TRUE);
5776 /* Now sort the addresses if required, and do the deliveries. The yield of
5777 do_remote_deliveries is FALSE when mua_wrapper is set and all addresses
5778 cannot be delivered in one transaction. */
5780 if (remote_sort_domains != NULL) sort_remote_deliveries();
5781 if (!do_remote_deliveries(FALSE))
5783 log_write(0, LOG_MAIN, "** mua_wrapper is set but recipients cannot all "
5784 "be delivered in one transaction");
5785 fprintf(stderr, "delivery to smarthost failed (configuration problem)\n");
5787 final_yield = DELIVER_MUA_FAILED;
5788 addr_failed = addr_defer = NULL; /* So that we remove the message */
5789 goto DELIVERY_TIDYUP;
5792 /* See if any of the addresses that failed got put on the queue for delivery
5793 to their fallback hosts. We do it this way because often the same fallback
5794 host is used for many domains, so all can be sent in a single transaction
5795 (if appropriately configured). */
5797 if (addr_fallback != NULL && !mua_wrapper)
5799 DEBUG(D_deliver) debug_printf("Delivering to fallback hosts\n");
5800 addr_remote = addr_fallback;
5801 addr_fallback = NULL;
5802 if (remote_sort_domains != NULL) sort_remote_deliveries();
5803 do_remote_deliveries(TRUE);
5805 disable_logging = FALSE;
5809 /* All deliveries are now complete. Ignore SIGTERM during this tidying up
5810 phase, to minimize cases of half-done things. */
5813 debug_printf(">>>>>>>>>>>>>>>> deliveries are done >>>>>>>>>>>>>>>>\n");
5815 /* Root privilege is no longer needed */
5817 exim_setugid(exim_uid, exim_gid, FALSE, US"post-delivery tidying");
5819 set_process_info("tidying up after delivering %s", message_id);
5820 signal(SIGTERM, SIG_IGN);
5822 /* When we are acting as an MUA wrapper, the smtp transport will either have
5823 succeeded for all addresses, or failed them all. We do not ever want to retry,
5824 nor do we want to send a bounce message. */
5828 if (addr_failed == NULL) final_yield = DELIVER_MUA_SUCCEEDED; else
5830 uschar *s = (addr_failed->user_message != NULL)?
5831 addr_failed->user_message : addr_failed->message;
5833 fprintf(stderr, "Delivery failed: ");
5834 if (addr_failed->basic_errno > 0)
5836 fprintf(stderr, "%s", strerror(addr_failed->basic_errno));
5837 if (s != NULL) fprintf(stderr, ": ");
5841 if (addr_failed->basic_errno <= 0) fprintf(stderr, "unknown error");
5843 else fprintf(stderr, "%s", CS s);
5844 fprintf(stderr, "\n");
5846 final_yield = DELIVER_MUA_FAILED;
5851 /* In a normal configuration, we now update the retry database. This is done in
5852 one fell swoop at the end in order not to keep opening and closing (and
5853 locking) the database. The code for handling retries is hived off into a
5854 separate module for convenience. We pass it the addresses of the various
5855 chains, because deferred addresses can get moved onto the failed chain if the
5856 retry cutoff time has expired for all alternative destinations. Bypass the
5857 updating of the database if the -N flag is set, which is a debugging thing that
5858 prevents actual delivery. */
5860 else if (!dont_deliver) retry_update(&addr_defer, &addr_failed, &addr_succeed);
5862 /* If any addresses failed, we must send a message to somebody, unless
5863 af_ignore_error is set, in which case no action is taken. It is possible for
5864 several messages to get sent if there are addresses with different
5867 while (addr_failed != NULL)
5871 uschar *logtod = tod_stamp(tod_log);
5873 address_item *handled_addr = NULL;
5874 address_item **paddr;
5875 address_item *msgchain = NULL;
5876 address_item **pmsgchain = &msgchain;
5878 /* There are weird cases when logging is disabled in the transport. However,
5879 there may not be a transport (address failed by a router). */
5881 disable_logging = FALSE;
5882 if (addr_failed->transport != NULL)
5883 disable_logging = addr_failed->transport->disable_logging;
5886 debug_printf("processing failed address %s\n", addr_failed->address);
5888 /* There are only two ways an address in a bounce message can get here:
5890 (1) When delivery was initially deferred, but has now timed out (in the call
5891 to retry_update() above). We can detect this by testing for
5892 af_retry_timedout. If the address does not have its own errors address,
5893 we arrange to ignore the error.
5895 (2) If delivery failures for bounce messages are being ignored. We can detect
5896 this by testing for af_ignore_error. This will also be set if a bounce
5897 message has been autothawed and the ignore_bounce_errors_after time has
5898 passed. It might also be set if a router was explicitly configured to
5899 ignore errors (errors_to = "").
5901 If neither of these cases obtains, something has gone wrong. Log the
5902 incident, but then ignore the error. */
5904 if (sender_address[0] == 0 && addr_failed->p.errors_address == NULL)
5906 if (!testflag(addr_failed, af_retry_timedout) &&
5907 !testflag(addr_failed, af_ignore_error))
5909 log_write(0, LOG_MAIN|LOG_PANIC, "internal error: bounce message "
5910 "failure is neither frozen nor ignored (it's been ignored)");
5912 setflag(addr_failed, af_ignore_error);
5915 /* If the first address on the list has af_ignore_error set, just remove
5916 it from the list, throw away any saved message file, log it, and
5917 mark the recipient done. */
5919 if (testflag(addr_failed, af_ignore_error))
5922 addr_failed = addr->next;
5923 if (addr->return_filename != NULL) Uunlink(addr->return_filename);
5925 log_write(0, LOG_MAIN, "%s%s%s%s: error ignored",
5927 (addr->parent == NULL)? US"" : US" <",
5928 (addr->parent == NULL)? US"" : addr->parent->address,
5929 (addr->parent == NULL)? US"" : US">");
5931 address_done(addr, logtod);
5932 child_done(addr, logtod);
5933 /* Panic-dies on error */
5934 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
5937 /* Otherwise, handle the sending of a message. Find the error address for
5938 the first address, then send a message that includes all failed addresses
5939 that have the same error address. Note the bounce_recipient is a global so
5940 that it can be accesssed by $bounce_recipient while creating a customized
5945 bounce_recipient = (addr_failed->p.errors_address == NULL)?
5946 sender_address : addr_failed->p.errors_address;
5948 /* Make a subprocess to send a message */
5950 pid = child_open_exim(&fd);
5952 /* Creation of child failed */
5955 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Process %d (parent %d) failed to "
5956 "create child process to send failure message: %s", getpid(),
5957 getppid(), strerror(errno));
5959 /* Creation of child succeeded */
5966 uschar *bcc, *emf_text;
5967 FILE *f = fdopen(fd, "wb");
5969 BOOL to_sender = strcmpic(sender_address, bounce_recipient) == 0;
5970 int max = (bounce_return_size_limit/DELIVER_IN_BUFFER_SIZE + 1) *
5971 DELIVER_IN_BUFFER_SIZE;
5974 debug_printf("sending error message to: %s\n", bounce_recipient);
5976 /* Scan the addresses for all that have the same errors address, removing
5977 them from the addr_failed chain, and putting them on msgchain. */
5979 paddr = &addr_failed;
5980 for (addr = addr_failed; addr != NULL; addr = *paddr)
5982 if (Ustrcmp(bounce_recipient, (addr->p.errors_address == NULL)?
5983 sender_address : addr->p.errors_address) != 0)
5985 paddr = &(addr->next); /* Not the same; skip */
5987 else /* The same - dechain */
5989 *paddr = addr->next;
5992 pmsgchain = &(addr->next);
5996 /* Include X-Failed-Recipients: for automatic interpretation, but do
5997 not let any one header line get too long. We do this by starting a
5998 new header every 50 recipients. Omit any addresses for which the
5999 "hide_child" flag is set. */
6001 for (addr = msgchain; addr != NULL; addr = addr->next)
6003 if (testflag(addr, af_hide_child)) continue;
6010 (rcount++ == 0)? "X-Failed-Recipients: " : ",\n ",
6011 (testflag(addr, af_pfr) && addr->parent != NULL)?
6012 string_printing(addr->parent->address) :
6013 string_printing(addr->address));
6015 if (rcount > 0) fprintf(f, "\n");
6017 /* Output the standard headers */
6019 if (errors_reply_to != NULL)
6020 fprintf(f, "Reply-To: %s\n", errors_reply_to);
6021 fprintf(f, "Auto-Submitted: auto-generated\n");
6022 fprintf(f, "From: Mail Delivery System <Mailer-Daemon@%s>\n",
6023 qualify_domain_sender);
6024 fprintf(f, "To: %s\n", bounce_recipient);
6026 /* Open a template file if one is provided. Log failure to open, but
6027 carry on - default texts will be used. */
6029 if (bounce_message_file != NULL)
6031 emf = Ufopen(bounce_message_file, "rb");
6033 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to open %s for error "
6034 "message texts: %s", bounce_message_file, strerror(errno));
6037 /* Quietly copy to configured additional addresses if required. */
6039 bcc = moan_check_errorcopy(bounce_recipient);
6040 if (bcc != NULL) fprintf(f, "Bcc: %s\n", bcc);
6042 /* The texts for the message can be read from a template file; if there
6043 isn't one, or if it is too short, built-in texts are used. The first
6044 emf text is a Subject: and any other headers. */
6046 emf_text = next_emf(emf, US"header");
6047 if (emf_text != NULL) fprintf(f, "%s\n", emf_text); else
6049 fprintf(f, "Subject: Mail delivery failed%s\n\n",
6050 to_sender? ": returning message to sender" : "");
6053 emf_text = next_emf(emf, US"intro");
6054 if (emf_text != NULL) fprintf(f, "%s", CS emf_text); else
6057 /* This message has been reworded several times. It seems to be confusing to
6058 somebody, however it is worded. I have retreated to the original, simple
6060 "This message was created automatically by mail delivery software.\n");
6061 if (bounce_message_text != NULL) fprintf(f, "%s", CS bounce_message_text);
6065 "\nA message that you sent could not be delivered to one or more of its\n"
6066 "recipients. This is a permanent error. The following address(es) failed:\n");
6071 "\nA message sent by\n\n <%s>\n\n"
6072 "could not be delivered to one or more of its recipients. The following\n"
6073 "address(es) failed:\n", sender_address);
6078 /* Process the addresses, leaving them on the msgchain if they have a
6079 file name for a return message. (There has already been a check in
6080 post_process_one() for the existence of data in the message file.) */
6083 for (addr = msgchain; addr != NULL; addr = *paddr)
6085 if (print_address_information(addr, f, US" ", US"\n ", US""))
6087 /* A TRUE return from print_address_information() means that the
6088 address is not hidden. If there is a return file, it has already
6089 been checked to ensure it is not empty. Omit the bland "return
6090 message generated" error, but otherwise include error information. */
6092 if (addr->return_file < 0 ||
6093 addr->message == NULL ||
6094 Ustrcmp(addr->message, "return message generated") != 0)
6097 print_address_error(addr, f);
6101 /* End the final line for the address */
6105 /* Leave on msgchain if there's a return file. */
6107 if (addr->return_file >= 0)
6109 paddr = &(addr->next);
6113 /* Else save so that we can tick off the recipient when the
6118 *paddr = addr->next;
6119 addr->next = handled_addr;
6120 handled_addr = addr;
6126 /* Get the next text, whether we need it or not, so as to be
6127 positioned for the one after. */
6129 emf_text = next_emf(emf, US"generated text");
6131 /* If there were any file messages passed by the local transports,
6132 include them in the message. Then put the address on the handled chain.
6133 In the case of a batch of addresses that were all sent to the same
6134 transport, the return_file field in all of them will contain the same
6135 fd, and the return_filename field in the *last* one will be set (to the
6136 name of the file). */
6138 if (msgchain != NULL)
6140 address_item *nextaddr;
6142 if (emf_text != NULL) fprintf(f, "%s", CS emf_text); else
6144 "The following text was generated during the delivery "
6145 "attempt%s:\n", (filecount > 1)? "s" : "");
6147 for (addr = msgchain; addr != NULL; addr = nextaddr)
6150 address_item *topaddr = addr;
6152 /* List all the addresses that relate to this file */
6155 while(addr != NULL) /* Insurance */
6157 print_address_information(addr, f, US"------ ", US"\n ",
6159 if (addr->return_filename != NULL) break;
6164 /* Now copy the file */
6166 fm = Ufopen(addr->return_filename, "rb");
6169 fprintf(f, " +++ Exim error... failed to open text file: %s\n",
6173 while ((ch = fgetc(fm)) != EOF) fputc(ch, f);
6176 Uunlink(addr->return_filename);
6178 /* Can now add to handled chain, first fishing off the next
6179 address on the msgchain. */
6181 nextaddr = addr->next;
6182 addr->next = handled_addr;
6183 handled_addr = topaddr;
6188 /* Now copy the message, trying to give an intelligible comment if
6189 it is too long for it all to be copied. The limit isn't strictly
6190 applied because of the buffering. There is, however, an option
6191 to suppress copying altogether. */
6193 emf_text = next_emf(emf, US"copy");
6195 if (bounce_return_message)
6197 int topt = topt_add_return_path;
6198 if (!bounce_return_body) topt |= topt_no_body;
6200 if (emf_text != NULL) fprintf(f, "%s", CS emf_text); else
6202 if (bounce_return_body) fprintf(f,
6203 "------ This is a copy of the message, including all the headers. ------\n");
6205 "------ This is a copy of the message's headers. ------\n");
6208 /* While reading the "truncated" message, set return_size_limit to
6209 the actual max testing value, rounded. We need to read the message
6210 whether we are going to use it or not. */
6213 int temp = bounce_return_size_limit;
6214 bounce_return_size_limit = (max/1000)*1000;
6215 emf_text = next_emf(emf, US"truncated");
6216 bounce_return_size_limit = temp;
6219 if (bounce_return_body && bounce_return_size_limit > 0)
6221 struct stat statbuf;
6222 if (fstat(deliver_datafile, &statbuf) == 0 && statbuf.st_size > max)
6224 if (emf_text != NULL) fprintf(f, "%s", CS emf_text); else
6227 "------ The body of the message is %d characters long; only the first\n"
6228 "------ %d or so are included here.\n", (int)statbuf.st_size, max);
6235 transport_filter_argv = NULL; /* Just in case */
6236 return_path = sender_address; /* In case not previously set */
6237 transport_write_message(NULL, fileno(f), topt,
6238 bounce_return_size_limit, NULL, NULL, NULL, NULL, NULL, 0);
6241 /* Write final text and close the template file if one is open */
6245 emf_text = next_emf(emf, US"final");
6246 if (emf_text != NULL) fprintf(f, "%s", CS emf_text);
6250 /* Close the file, which should send an EOF to the child process
6251 that is receiving the message. Wait for it to finish. */
6254 rc = child_close(pid, 0); /* Waits for child to close, no timeout */
6256 /* In the test harness, let the child do it's thing first. */
6258 if (running_in_test_harness) millisleep(500);
6260 /* If the process failed, there was some disaster in setting up the
6261 error message. Unless the message is very old, ensure that addr_defer
6262 is non-null, which will have the effect of leaving the message on the
6263 spool. The failed addresses will get tried again next time. However, we
6264 don't really want this to happen too often, so freeze the message unless
6265 there are some genuine deferred addresses to try. To do this we have
6266 to call spool_write_header() here, because with no genuine deferred
6267 addresses the normal code below doesn't get run. */
6272 if (now - received_time < retry_maximum_timeout && addr_defer == NULL)
6274 addr_defer = (address_item *)(+1);
6275 deliver_freeze = TRUE;
6276 deliver_frozen_at = time(NULL);
6277 /* Panic-dies on error */
6278 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
6281 deliver_msglog("Process failed (%d) when writing error message "
6282 "to %s%s", rc, bounce_recipient, s);
6283 log_write(0, LOG_MAIN, "Process failed (%d) when writing error message "
6284 "to %s%s", rc, bounce_recipient, s);
6287 /* The message succeeded. Ensure that the recipients that failed are
6288 now marked finished with on the spool and their parents updated. */
6292 for (addr = handled_addr; addr != NULL; addr = addr->next)
6294 address_done(addr, logtod);
6295 child_done(addr, logtod);
6297 /* Panic-dies on error */
6298 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
6304 disable_logging = FALSE; /* In case left set */
6306 /* Come here from the mua_wrapper case if routing goes wrong */
6310 /* If there are now no deferred addresses, we are done. Preserve the
6311 message log if so configured, and we are using them. Otherwise, sling it.
6312 Then delete the message itself. */
6314 if (addr_defer == NULL)
6318 sprintf(CS spoolname, "%s/msglog/%s/%s", spool_directory, message_subdir,
6320 if (preserve_message_logs)
6323 sprintf(CS big_buffer, "%s/msglog.OLD/%s", spool_directory, id);
6324 if ((rc = Urename(spoolname, big_buffer)) < 0)
6326 (void)directory_make(spool_directory, US"msglog.OLD",
6327 MSGLOG_DIRECTORY_MODE, TRUE);
6328 rc = Urename(spoolname, big_buffer);
6331 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to move %s to the "
6332 "msglog.OLD directory", spoolname);
6336 if (Uunlink(spoolname) < 0)
6337 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s", spoolname);
6341 /* Remove the two message files. */
6343 sprintf(CS spoolname, "%s/input/%s/%s-D", spool_directory, message_subdir, id);
6344 if (Uunlink(spoolname) < 0)
6345 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s", spoolname);
6346 sprintf(CS spoolname, "%s/input/%s/%s-H", spool_directory, message_subdir, id);
6347 if (Uunlink(spoolname) < 0)
6348 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s", spoolname);
6350 /* Log the end of this message, with queue time if requested. */
6352 if ((log_extra_selector & LX_queue_time_overall) != 0)
6353 log_write(0, LOG_MAIN, "Completed QT=%s",
6354 readconf_printtime(time(NULL) - received_time));
6356 log_write(0, LOG_MAIN, "Completed");
6359 /* If there are deferred addresses, we are keeping this message because it is
6360 not yet completed. Lose any temporary files that were catching output from
6361 pipes for any of the deferred addresses, handle one-time aliases, and see if
6362 the message has been on the queue for so long that it is time to send a warning
6363 message to the sender, unless it is a mailer-daemon. If all deferred addresses
6364 have the same domain, we can set deliver_domain for the expansion of
6365 delay_warning_ condition - if any of them are pipes, files, or autoreplies, use
6366 the parent's domain.
6368 If all the deferred addresses have an error number that indicates "retry time
6369 not reached", skip sending the warning message, because it won't contain the
6370 reason for the delay. It will get sent at the next real delivery attempt.
6371 However, if at least one address has tried, we'd better include all of them in
6374 If we can't make a process to send the message, don't worry.
6376 For mailing list expansions we want to send the warning message to the
6377 mailing list manager. We can't do a perfect job here, as some addresses may
6378 have different errors addresses, but if we take the errors address from
6379 each deferred address it will probably be right in most cases.
6381 If addr_defer == +1, it means there was a problem sending an error message
6382 for failed addresses, and there were no "real" deferred addresses. The value
6383 was set just to keep the message on the spool, so there is nothing to do here.
6386 else if (addr_defer != (address_item *)(+1))
6389 uschar *recipients = US"";
6390 BOOL delivery_attempted = FALSE;
6392 deliver_domain = testflag(addr_defer, af_pfr)?
6393 addr_defer->parent->domain : addr_defer->domain;
6395 for (addr = addr_defer; addr != NULL; addr = addr->next)
6397 address_item *otaddr;
6399 if (addr->basic_errno > ERRNO_RETRY_BASE) delivery_attempted = TRUE;
6401 if (deliver_domain != NULL)
6403 uschar *d = (testflag(addr, af_pfr))? addr->parent->domain : addr->domain;
6405 /* The domain may be unset for an address that has never been routed
6406 because the system filter froze the message. */
6408 if (d == NULL || Ustrcmp(d, deliver_domain) != 0) deliver_domain = NULL;
6411 if (addr->return_filename != NULL) Uunlink(addr->return_filename);
6413 /* Handle the case of one-time aliases. If any address in the ancestry
6414 of this one is flagged, ensure it is in the recipients list, suitably
6415 flagged, and that its parent is marked delivered. */
6417 for (otaddr = addr; otaddr != NULL; otaddr = otaddr->parent)
6418 if (otaddr->onetime_parent != NULL) break;
6423 int t = recipients_count;
6425 for (i = 0; i < recipients_count; i++)
6427 uschar *r = recipients_list[i].address;
6428 if (Ustrcmp(otaddr->onetime_parent, r) == 0) t = i;
6429 if (Ustrcmp(otaddr->address, r) == 0) break;
6432 /* Didn't find the address already in the list, and did find the
6433 ultimate parent's address in the list. After adding the recipient,
6434 update the errors address in the recipients list. */
6436 if (i >= recipients_count && t < recipients_count)
6438 DEBUG(D_deliver) debug_printf("one_time: adding %s in place of %s\n",
6439 otaddr->address, otaddr->parent->address);
6440 receive_add_recipient(otaddr->address, t);
6441 recipients_list[recipients_count-1].errors_to = otaddr->p.errors_address;
6442 tree_add_nonrecipient(otaddr->parent->address);
6443 update_spool = TRUE;
6447 /* Except for error messages, ensure that either the errors address for
6448 this deferred address or, if there is none, the sender address, is on the
6449 list of recipients for a warning message. */
6451 if (sender_address[0] != 0)
6453 if (addr->p.errors_address == NULL)
6455 if (Ustrstr(recipients, sender_address) == NULL)
6456 recipients = string_sprintf("%s%s%s", recipients,
6457 (recipients[0] == 0)? "" : ",", sender_address);
6461 if (Ustrstr(recipients, addr->p.errors_address) == NULL)
6462 recipients = string_sprintf("%s%s%s", recipients,
6463 (recipients[0] == 0)? "" : ",", addr->p.errors_address);
6468 /* Send a warning message if the conditions are right. If the condition check
6469 fails because of a lookup defer, there is nothing we can do. The warning
6470 is not sent. Another attempt will be made at the next delivery attempt (if
6473 if (!queue_2stage && delivery_attempted &&
6474 delay_warning[1] > 0 && sender_address[0] != 0 &&
6475 (delay_warning_condition == NULL ||
6476 expand_check_condition(delay_warning_condition,
6477 US"delay_warning", US"option")))
6481 int queue_time = time(NULL) - received_time;
6483 /* When running in the test harness, there's an option that allows us to
6484 fudge this time so as to get repeatability of the tests. Take the first
6485 time off the list. In queue runs, the list pointer gets updated in the
6488 if (running_in_test_harness && fudged_queue_times[0] != 0)
6490 int qt = readconf_readtime(fudged_queue_times, '/', FALSE);
6493 DEBUG(D_deliver) debug_printf("fudged queue_times = %s\n",
6494 fudged_queue_times);
6499 /* See how many warnings we should have sent by now */
6501 for (count = 0; count < delay_warning[1]; count++)
6502 if (queue_time < delay_warning[count+2]) break;
6504 show_time = delay_warning[count+1];
6506 if (count >= delay_warning[1])
6509 int last_gap = show_time;
6510 if (count > 1) last_gap -= delay_warning[count];
6511 extra = (queue_time - delay_warning[count+1])/last_gap;
6512 show_time += last_gap * extra;
6518 debug_printf("time on queue = %s\n", readconf_printtime(queue_time));
6519 debug_printf("warning counts: required %d done %d\n", count,
6523 /* We have computed the number of warnings there should have been by now.
6524 If there haven't been enough, send one, and up the count to what it should
6527 if (warning_count < count)
6531 pid_t pid = child_open_exim(&fd);
6537 FILE *f = fdopen(fd, "wb");
6539 if (warn_message_file != NULL)
6541 wmf = Ufopen(warn_message_file, "rb");
6543 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to open %s for warning "
6544 "message texts: %s", warn_message_file, strerror(errno));
6547 warnmsg_recipients = recipients;
6548 warnmsg_delay = (queue_time < 120*60)?
6549 string_sprintf("%d minutes", show_time/60):
6550 string_sprintf("%d hours", show_time/3600);
6552 if (errors_reply_to != NULL)
6553 fprintf(f, "Reply-To: %s\n", errors_reply_to);
6554 fprintf(f, "Auto-Submitted: auto-generated\n");
6555 fprintf(f, "From: Mail Delivery System <Mailer-Daemon@%s>\n",
6556 qualify_domain_sender);
6557 fprintf(f, "To: %s\n", recipients);
6559 wmf_text = next_emf(wmf, US"header");
6560 if (wmf_text != NULL)
6561 fprintf(f, "%s\n", wmf_text);
6563 fprintf(f, "Subject: Warning: message %s delayed %s\n\n",
6564 message_id, warnmsg_delay);
6566 wmf_text = next_emf(wmf, US"intro");
6567 if (wmf_text != NULL) fprintf(f, "%s", CS wmf_text); else
6570 "This message was created automatically by mail delivery software.\n");
6572 if (Ustrcmp(recipients, sender_address) == 0)
6574 "A message that you sent has not yet been delivered to one or more of its\n"
6575 "recipients after more than ");
6578 "A message sent by\n\n <%s>\n\n"
6579 "has not yet been delivered to one or more of its recipients after more than \n",
6582 fprintf(f, "%s on the queue on %s.\n\n", warnmsg_delay,
6584 fprintf(f, "The message identifier is: %s\n", message_id);
6586 for (h = header_list; h != NULL; h = h->next)
6588 if (strncmpic(h->text, US"Subject:", 8) == 0)
6589 fprintf(f, "The subject of the message is: %s", h->text + 9);
6590 else if (strncmpic(h->text, US"Date:", 5) == 0)
6591 fprintf(f, "The date of the message is: %s", h->text + 6);
6595 fprintf(f, "The address%s to which the message has not yet been "
6597 (addr_defer->next == NULL)? "" : "es",
6598 (addr_defer->next == NULL)? "is": "are");
6601 /* List the addresses. For any that are hidden, don't give the delay
6602 reason, because it might expose that which is hidden. Also, do not give
6603 "retry time not reached" because that isn't helpful. */
6606 while (addr_defer != NULL)
6608 address_item *addr = addr_defer;
6609 addr_defer = addr->next;
6610 if (print_address_information(addr, f, US" ", US"\n ", US"") &&
6611 addr->basic_errno > ERRNO_RETRY_BASE)
6613 fprintf(f, "\n Delay reason: ");
6614 print_address_error(addr, f);
6624 wmf_text = next_emf(wmf, US"final");
6625 if (wmf_text != NULL) fprintf(f, "%s", CS wmf_text);
6631 "No action is required on your part. Delivery attempts will continue for\n"
6632 "some time, and this warning may be repeated at intervals if the message\n"
6633 "remains undelivered. Eventually the mail delivery software will give up,\n"
6634 "and when that happens, the message will be returned to you.\n");
6637 /* Close and wait for child process to complete, without a timeout.
6638 If there's an error, don't update the count. */
6641 if (child_close(pid, 0) == 0)
6643 warning_count = count;
6644 update_spool = TRUE; /* Ensure spool rewritten */
6650 /* Clear deliver_domain */
6652 deliver_domain = NULL;
6654 /* If this was a first delivery attempt, unset the first time flag, and
6655 ensure that the spool gets updated. */
6657 if (deliver_firsttime)
6659 deliver_firsttime = FALSE;
6660 update_spool = TRUE;
6663 /* If delivery was frozen and freeze_tell is set, generate an appropriate
6664 message, unless the message is a local error message (to avoid loops). Then
6665 log the freezing. If the text in "frozen_info" came from a system filter,
6666 it has been escaped into printing characters so as not to mess up log lines.
6667 For the "tell" message, we turn \n back into newline. Also, insert a newline
6668 near the start instead of the ": " string. */
6672 if (freeze_tell != NULL && freeze_tell[0] != 0 && !local_error_message)
6674 uschar *s = string_copy(frozen_info);
6675 uschar *ss = Ustrstr(s, " by the system filter: ");
6686 if (*ss == '\\' && ss[1] == 'n')
6693 moan_tell_someone(freeze_tell, addr_defer, US"Message frozen",
6694 "Message %s has been frozen%s.\nThe sender is <%s>.\n", message_id,
6698 /* Log freezing just before we update the -H file, to minimize the chance
6699 of a race problem. */
6701 deliver_msglog("*** Frozen%s\n", frozen_info);
6702 log_write(0, LOG_MAIN, "Frozen%s", frozen_info);
6705 /* If there have been any updates to the non-recipients list, or other things
6706 that get written to the spool, we must now update the spool header file so
6707 that it has the right information for the next delivery attempt. If there
6708 was more than one address being delivered, the header_change update is done
6709 earlier, in case one succeeds and then something crashes. */
6712 debug_printf("delivery deferred: update_spool=%d header_rewritten=%d\n",
6713 update_spool, header_rewritten);
6715 if (update_spool || header_rewritten)
6716 /* Panic-dies on error */
6717 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
6720 /* Finished with the message log. If the message is complete, it will have
6721 been unlinked or renamed above. */
6723 if (message_logs) fclose(message_log);
6725 /* Now we can close and remove the journal file. Its only purpose is to record
6726 successfully completed deliveries asap so that this information doesn't get
6727 lost if Exim (or the machine) crashes. Forgetting about a failed delivery is
6728 not serious, as trying it again is not harmful. The journal might not be open
6729 if all addresses were deferred at routing or directing. Nevertheless, we must
6730 remove it if it exists (may have been lying around from a crash during the
6731 previous delivery attempt). We don't remove the journal if a delivery
6732 subprocess failed to pass back delivery information; this is controlled by
6733 the remove_journal flag. When the journal is left, we also don't move the
6734 message off the main spool if frozen and the option is set. It should get moved
6735 at the next attempt, after the journal has been inspected. */
6737 if (journal_fd >= 0) close(journal_fd);
6741 sprintf(CS spoolname, "%s/input/%s/%s-J", spool_directory, message_subdir, id);
6742 if (Uunlink(spoolname) < 0 && errno != ENOENT)
6743 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s", spoolname,
6746 /* Move the message off the spool if reqested */
6748 #ifdef SUPPORT_MOVE_FROZEN_MESSAGES
6749 if (deliver_freeze && move_frozen_messages)
6750 (void)spool_move_message(id, message_subdir, US"", US"F");
6754 /* Closing the data file frees the lock; if the file has been unlinked it
6755 will go away. Otherwise the message becomes available for another process
6758 close(deliver_datafile);
6759 deliver_datafile = -1;
6760 DEBUG(D_deliver) debug_printf("end delivery of %s\n", id);
6762 /* It is unlikely that there will be any cached resources, since they are
6763 released after routing, and in the delivery subprocesses. However, it's
6764 possible for an expansion for something afterwards (for example,
6765 expand_check_condition) to do a lookup. We must therefore be sure everything is
6772 /* End of deliver.c */