1 /* $Cambridge: exim/src/src/deliver.c,v 1.4 2004/12/16 15:11:47 tom Exp $ */
3 /*************************************************
4 * Exim - an Internet mail transport agent *
5 *************************************************/
7 /* Copyright (c) University of Cambridge 1995 - 2004 */
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 same local part if the transport's configuration contains $local_part
2084 same domain if the transport's configuration contains $domain
2086 same additional headers
2087 same headers to be removed
2088 same uid/gid for running the transport
2089 same first host if a host list is set
2092 while ((next = *anchor) != NULL && batch_count < tp->batch_max)
2095 tp == next->transport &&
2096 (!uses_lp || Ustrcmp(next->local_part, addr->local_part) == 0) &&
2097 (!uses_dom || Ustrcmp(next->domain, addr->domain) == 0) &&
2098 same_strings(next->p.errors_address, addr->p.errors_address) &&
2099 same_headers(next->p.extra_headers, addr->p.extra_headers) &&
2100 same_strings(next->p.remove_headers, addr->p.remove_headers) &&
2101 same_ugid(tp, addr, next) &&
2102 ((addr->host_list == NULL && next->host_list == NULL) ||
2103 (addr->host_list != NULL && next->host_list != NULL &&
2104 Ustrcmp(addr->host_list->name, next->host_list->name) == 0));
2106 /* If the transport has a batch_id setting, batch_id will be non-NULL
2107 from the expansion outside the loop. Expand for this address and compare.
2108 Expansion failure makes this address ineligible for batching. */
2110 if (ok && batch_id != NULL)
2113 address_item *save_nextnext = next->next;
2114 next->next = NULL; /* Expansion for a single address */
2115 deliver_set_expansions(next);
2116 next->next = save_nextnext;
2117 bid = expand_string(tp->batch_id);
2118 deliver_set_expansions(NULL);
2121 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand batch_id option "
2122 "in %s transport (%s): %s", tp->name, next->address,
2123 expand_string_message);
2126 else ok = (Ustrcmp(batch_id, bid) == 0);
2129 /* Take address into batch if OK. */
2133 *anchor = next->next; /* Include the address */
2139 else anchor = &(next->next); /* Skip the address */
2143 /* We now have one or more addresses that can be delivered in a batch. Check
2144 whether the transport is prepared to accept a message of this size. If not,
2145 fail them all forthwith. If the expansion fails, or does not yield an
2146 integer, defer delivery. */
2148 if (tp->message_size_limit != NULL)
2150 int rc = check_message_size(tp, addr);
2153 replicate_status(addr);
2154 while (addr != NULL)
2157 post_process_one(addr, rc, logflags, DTYPE_TRANSPORT, 0);
2160 continue; /* With next batch of addresses */
2164 /* If we are not running the queue, or if forcing, all deliveries will be
2165 attempted. Otherwise, we must respect the retry times for each address. Even
2166 when not doing this, we need to set up the retry key string, and determine
2167 whether a retry record exists, because after a successful delivery, a delete
2168 retry item must be set up. Keep the retry database open only for the duration
2169 of these checks, rather than for all local deliveries, because some local
2170 deliveries (e.g. to pipes) can take a substantial time. */
2172 dbm_file = dbfn_open(US"retry", O_RDONLY, &dbblock, FALSE);
2173 if (dbm_file == NULL)
2175 DEBUG(D_deliver|D_retry|D_hints_lookup)
2176 debug_printf("no retry data available\n");
2181 while (addr2 != NULL)
2183 BOOL ok = TRUE; /* to deliver this address */
2186 /* Set up the retry key to include the domain or not, and change its
2187 leading character from "R" to "T". Must make a copy before doing this,
2188 because the old key may be pointed to from a "delete" retry item after
2191 retry_key = string_copy(
2192 (tp->retry_use_local_part)? addr2->address_retry_key :
2193 addr2->domain_retry_key);
2196 /* Inspect the retry data. If there is no hints file, delivery happens. */
2198 if (dbm_file != NULL)
2200 dbdata_retry *retry_record = dbfn_read(dbm_file, retry_key);
2202 /* If there is no retry record, delivery happens. If there is,
2203 remember it exists so it can be deleted after a successful delivery. */
2205 if (retry_record != NULL)
2207 setflag(addr2, af_lt_retry_exists);
2209 /* A retry record exists for this address. If queue running and not
2210 forcing, inspect its contents. If the record is too old, or if its
2211 retry time has come, or if it has passed its cutoff time, delivery
2216 debug_printf("retry record exists: age=%d (max=%d)\n",
2217 (int)(now - retry_record->time_stamp), retry_data_expire);
2218 debug_printf(" time to retry = %d expired = %d\n",
2219 (int)(now - retry_record->next_try), retry_record->expired);
2222 if (queue_running && !deliver_force)
2224 ok = (now - retry_record->time_stamp > retry_data_expire) ||
2225 (now >= retry_record->next_try) ||
2226 retry_record->expired;
2228 /* If we haven't reached the retry time, there is one more check
2229 to do, which is for the ultimate address timeout. */
2233 retry_config *retry =
2234 retry_find_config(retry_key+2, addr2->domain,
2235 retry_record->basic_errno,
2236 retry_record->more_errno);
2238 DEBUG(D_deliver|D_retry)
2239 debug_printf("retry time not reached for %s: "
2240 "checking ultimate address timeout\n", addr2->address);
2242 if (retry != NULL && retry->rules != NULL)
2244 retry_rule *last_rule;
2245 for (last_rule = retry->rules;
2246 last_rule->next != NULL;
2247 last_rule = last_rule->next);
2248 if (now - received_time > last_rule->timeout) ok = TRUE;
2250 else ok = TRUE; /* No rule => timed out */
2252 DEBUG(D_deliver|D_retry)
2254 if (ok) debug_printf("on queue longer than maximum retry for "
2255 "address - allowing delivery\n");
2260 else DEBUG(D_retry) debug_printf("no retry record exists\n");
2263 /* This address is to be delivered. Leave it on the chain. */
2268 addr2 = addr2->next;
2271 /* This address is to be deferred. Take it out of the chain, and
2272 post-process it as complete. Must take it out of the chain first,
2273 because post processing puts it on another chain. */
2277 address_item *this = addr2;
2278 this->message = US"Retry time not yet reached";
2279 this->basic_errno = ERRNO_LRETRY;
2280 if (addr3 == NULL) addr2 = addr = addr2->next;
2281 else addr2 = addr3->next = addr2->next;
2282 post_process_one(this, DEFER, logflags, DTYPE_TRANSPORT, 0);
2286 if (dbm_file != NULL) dbfn_close(dbm_file);
2288 /* If there are no addresses left on the chain, they all deferred. Loop
2289 for the next set of addresses. */
2291 if (addr == NULL) continue;
2293 /* So, finally, we do have some addresses that can be passed to the
2294 transport. Before doing so, set up variables that are relevant to a
2297 deliver_set_expansions(addr);
2298 delivery_start = time(NULL);
2299 deliver_local(addr, FALSE);
2300 deliver_time = (int)(time(NULL) - delivery_start);
2302 /* If a shadow transport (which must perforce be another local transport), is
2303 defined, and its condition is met, we must pass the message to the shadow
2304 too, but only those addresses that succeeded. We do this by making a new
2305 chain of addresses - also to keep the original chain uncontaminated. We must
2306 use a chain rather than doing it one by one, because the shadow transport may
2309 NOTE: if the condition fails because of a lookup defer, there is nothing we
2312 if (tp->shadow != NULL &&
2313 (tp->shadow_condition == NULL ||
2314 expand_check_condition(tp->shadow_condition, tp->name, US"transport")))
2316 transport_instance *stp;
2317 address_item *shadow_addr = NULL;
2318 address_item **last = &shadow_addr;
2320 for (stp = transports; stp != NULL; stp = stp->next)
2321 if (Ustrcmp(stp->name, tp->shadow) == 0) break;
2324 log_write(0, LOG_MAIN|LOG_PANIC, "shadow transport \"%s\" not found ",
2327 /* Pick off the addresses that have succeeded, and make clones. Put into
2328 the shadow_message field a pointer to the shadow_message field of the real
2331 else for (addr2 = addr; addr2 != NULL; addr2 = addr2->next)
2333 if (addr2->transport_return != OK) continue;
2334 addr3 = store_get(sizeof(address_item));
2337 addr3->shadow_message = (uschar *)(&(addr2->shadow_message));
2338 addr3->transport = stp;
2339 addr3->transport_return = DEFER;
2340 addr3->return_filename = NULL;
2341 addr3->return_file = -1;
2343 last = &(addr3->next);
2346 /* If we found any addresses to shadow, run the delivery, and stick any
2347 message back into the shadow_message field in the original. */
2349 if (shadow_addr != NULL)
2351 int save_count = transport_count;
2353 DEBUG(D_deliver|D_transport)
2354 debug_printf(">>>>>>>>>>>>>>>> Shadow delivery >>>>>>>>>>>>>>>>\n");
2355 deliver_local(shadow_addr, TRUE);
2357 for(; shadow_addr != NULL; shadow_addr = shadow_addr->next)
2359 int sresult = shadow_addr->transport_return;
2360 *((uschar **)(shadow_addr->shadow_message)) = (sresult == OK)?
2361 string_sprintf(" ST=%s", stp->name) :
2362 string_sprintf(" ST=%s (%s%s%s)", stp->name,
2363 (shadow_addr->basic_errno <= 0)?
2364 US"" : US strerror(shadow_addr->basic_errno),
2365 (shadow_addr->basic_errno <= 0 || shadow_addr->message == NULL)?
2367 (shadow_addr->message != NULL)? shadow_addr->message :
2368 (shadow_addr->basic_errno <= 0)? US"unknown error" : US"");
2370 DEBUG(D_deliver|D_transport)
2371 debug_printf("%s shadow transport returned %s for %s\n",
2373 (sresult == OK)? "OK" :
2374 (sresult == DEFER)? "DEFER" :
2375 (sresult == FAIL)? "FAIL" :
2376 (sresult == PANIC)? "PANIC" : "?",
2377 shadow_addr->address);
2380 DEBUG(D_deliver|D_transport)
2381 debug_printf(">>>>>>>>>>>>>>>> End shadow delivery >>>>>>>>>>>>>>>>\n");
2383 transport_count = save_count; /* Restore original transport count */
2387 /* Cancel the expansions that were set up for the delivery. */
2389 deliver_set_expansions(NULL);
2391 /* Now we can process the results of the real transport. We must take each
2392 address off the chain first, because post_process_one() puts it on another
2395 for (addr2 = addr; addr2 != NULL; addr2 = nextaddr)
2397 int result = addr2->transport_return;
2398 nextaddr = addr2->next;
2400 DEBUG(D_deliver|D_transport)
2401 debug_printf("%s transport returned %s for %s\n",
2403 (result == OK)? "OK" :
2404 (result == DEFER)? "DEFER" :
2405 (result == FAIL)? "FAIL" :
2406 (result == PANIC)? "PANIC" : "?",
2409 /* If there is a retry_record, or if delivery is deferred, build a retry
2410 item for setting a new retry time or deleting the old retry record from
2411 the database. These items are handled all together after all addresses
2412 have been handled (so the database is open just for a short time for
2415 if (result == DEFER || testflag(addr2, af_lt_retry_exists))
2417 int flags = (result == DEFER)? 0 : rf_delete;
2418 uschar *retry_key = string_copy((tp->retry_use_local_part)?
2419 addr2->address_retry_key : addr2->domain_retry_key);
2421 retry_add_item(addr2, retry_key, flags);
2424 /* Done with this address */
2426 if (result == OK) addr2->more_errno = deliver_time;
2427 post_process_one(addr2, result, logflags, DTYPE_TRANSPORT, logchar);
2429 /* If a pipe delivery generated text to be sent back, the result may be
2430 changed to FAIL, and we must copy this for subsequent addresses in the
2433 if (addr2->transport_return != result)
2435 for (addr3 = nextaddr; addr3 != NULL; addr3 = addr3->next)
2437 addr3->transport_return = addr2->transport_return;
2438 addr3->basic_errno = addr2->basic_errno;
2439 addr3->message = addr2->message;
2441 result = addr2->transport_return;
2444 /* Whether or not the result was changed to FAIL, we need to copy the
2445 return_file value from the first address into all the addresses of the
2446 batch, so they are all listed in the error message. */
2448 addr2->return_file = addr->return_file;
2450 /* Change log character for recording successful deliveries. */
2452 if (result == OK) logchar = '-';
2454 } /* Loop back for next batch of addresses */
2460 /*************************************************
2461 * Sort remote deliveries *
2462 *************************************************/
2464 /* This function is called if remote_sort_domains is set. It arranges that the
2465 chain of addresses for remote deliveries is ordered according to the strings
2466 specified. Try to make this shuffling reasonably efficient by handling
2467 sequences of addresses rather than just single ones.
2474 sort_remote_deliveries(void)
2477 address_item **aptr = &addr_remote;
2478 uschar *listptr = remote_sort_domains;
2482 while (*aptr != NULL &&
2483 (pattern = string_nextinlist(&listptr, &sep, patbuf, sizeof(patbuf)))
2486 address_item *moved = NULL;
2487 address_item **bptr = &moved;
2489 while (*aptr != NULL)
2491 address_item **next;
2492 deliver_domain = (*aptr)->domain; /* set $domain */
2493 if (match_isinlist(deliver_domain, &pattern, UCHAR_MAX+1,
2494 &domainlist_anchor, NULL, MCL_DOMAIN, TRUE, NULL) == OK)
2496 aptr = &((*aptr)->next);
2500 next = &((*aptr)->next);
2501 while (*next != NULL &&
2502 (deliver_domain = (*next)->domain, /* Set $domain */
2503 match_isinlist(deliver_domain, &pattern, UCHAR_MAX+1,
2504 &domainlist_anchor, NULL, MCL_DOMAIN, TRUE, NULL)) != OK)
2505 next = &((*next)->next);
2507 /* If the batch of non-matchers is at the end, add on any that were
2508 extracted further up the chain, and end this iteration. Otherwise,
2509 extract them from the chain and hang on the moved chain. */
2521 aptr = &((*aptr)->next);
2524 /* If the loop ended because the final address matched, *aptr will
2525 be NULL. Add on to the end any extracted non-matching addresses. If
2526 *aptr is not NULL, the loop ended via "break" when *next is null, that
2527 is, there was a string of non-matching addresses at the end. In this
2528 case the extracted addresses have already been added on the end. */
2530 if (*aptr == NULL) *aptr = moved;
2536 debug_printf("remote addresses after sorting:\n");
2537 for (addr = addr_remote; addr != NULL; addr = addr->next)
2538 debug_printf(" %s\n", addr->address);
2544 /*************************************************
2545 * Read from pipe for remote delivery subprocess *
2546 *************************************************/
2548 /* This function is called when the subprocess is complete, but can also be
2549 called before it is complete, in order to empty a pipe that is full (to prevent
2550 deadlock). It must therefore keep track of its progress in the parlist data
2553 We read the pipe to get the delivery status codes and a possible error message
2554 for each address, optionally preceded by unusability data for the hosts and
2555 also by optional retry data.
2557 Read in large chunks into the big buffer and then scan through, interpreting
2558 the data therein. In most cases, only a single read will be necessary. No
2559 individual item will ever be anywhere near 500 bytes in length, so by ensuring
2560 that we read the next chunk when there is less than 500 bytes left in the
2561 non-final chunk, we can assume each item is complete in store before handling
2562 it. Actually, each item is written using a single write(), which is atomic for
2563 small items (less than PIPE_BUF, which seems to be at least 512 in any Unix) so
2564 even if we are reading while the subprocess is still going, we should never
2565 have only a partial item in the buffer.
2568 poffset the offset of the parlist item
2569 eop TRUE if the process has completed
2571 Returns: TRUE if the terminating 'Z' item has been read,
2572 or there has been a disaster (i.e. no more data needed);
2577 par_read_pipe(int poffset, BOOL eop)
2580 pardata *p = parlist + poffset;
2581 address_item *addrlist = p->addrlist;
2582 address_item *addr = p->addr;
2585 uschar *endptr = big_buffer;
2586 uschar *ptr = endptr;
2587 uschar *msg = p->msg;
2588 BOOL done = p->done;
2589 BOOL unfinished = TRUE;
2591 /* Loop through all items, reading from the pipe when necessary. The pipe
2592 is set up to be non-blocking, but there are two different Unix mechanisms in
2593 use. Exim uses O_NONBLOCK if it is defined. This returns 0 for end of file,
2594 and EAGAIN for no more data. If O_NONBLOCK is not defined, Exim uses O_NDELAY,
2595 which returns 0 for both end of file and no more data. We distinguish the
2596 two cases by taking 0 as end of file only when we know the process has
2599 Each separate item is written to the pipe in a single write(), and as they are
2600 all short items, the writes will all be atomic and we should never find
2601 ourselves in the position of having read an incomplete item. */
2603 DEBUG(D_deliver) debug_printf("reading pipe for subprocess %d (%s)\n",
2604 (int)p->pid, eop? "ended" : "not ended");
2608 retry_item *r, **rp;
2609 int remaining = endptr - ptr;
2611 /* Read (first time) or top up the chars in the buffer if necessary.
2612 There will be only one read if we get all the available data (i.e. don't
2613 fill the buffer completely). */
2615 if (remaining < 500 && unfinished)
2618 int available = big_buffer_size - remaining;
2620 if (remaining > 0) memmove(big_buffer, ptr, remaining);
2623 endptr = big_buffer + remaining;
2624 len = read(fd, endptr, available);
2626 DEBUG(D_deliver) debug_printf("read() yielded %d\n", len);
2628 /* If the result is EAGAIN and the process is not complete, just
2629 stop reading any more and process what we have already. */
2633 if (!eop && errno == EAGAIN) len = 0; else
2635 msg = string_sprintf("failed to read pipe from transport process "
2636 "%d for transport %s: %s", pid, addr->transport->driver_name,
2642 /* If the length is zero (eof or no-more-data), just process what we
2643 already have. Note that if the process is still running and we have
2644 read all the data in the pipe (but less that "available") then we
2645 won't read any more, as "unfinished" will get set FALSE. */
2648 unfinished = len == available;
2651 /* If we are at the end of the available data, exit the loop. */
2653 if (ptr >= endptr) break;
2655 /* Handle each possible type of item, assuming the complete item is
2656 available in store. */
2660 /* Host items exist only if any hosts were marked unusable. Match
2661 up by checking the IP address. */
2664 for (h = addrlist->host_list; h != NULL; h = h->next)
2666 if (h->address == NULL || Ustrcmp(h->address, ptr+2) != 0) continue;
2674 /* Retry items are sent in a preceding R item for each address. This is
2675 kept separate to keep each message short enough to guarantee it won't
2676 be split in the pipe. Hopefully, in the majority of cases, there won't in
2677 fact be any retry items at all.
2679 The complete set of retry items might include an item to delete a
2680 routing retry if there was a previous routing delay. However, routing
2681 retries are also used when a remote transport identifies an address error.
2682 In that case, there may also be an "add" item for the same key. Arrange
2683 that a "delete" item is dropped in favour of an "add" item. */
2686 if (addr == NULL) goto ADDR_MISMATCH;
2688 DEBUG(D_deliver|D_retry)
2689 debug_printf("reading retry information for %s from subprocess\n",
2692 /* Cut out any "delete" items on the list. */
2694 for (rp = &(addr->retries); (r = *rp) != NULL; rp = &(r->next))
2696 if (Ustrcmp(r->key, ptr+1) == 0) /* Found item with same key */
2698 if ((r->flags & rf_delete) == 0) break; /* It was not "delete" */
2699 *rp = r->next; /* Excise a delete item */
2700 DEBUG(D_deliver|D_retry)
2701 debug_printf(" existing delete item dropped\n");
2705 /* We want to add a delete item only if there is no non-delete item;
2706 however we still have to step ptr through the data. */
2708 if (r == NULL || (*ptr & rf_delete) == 0)
2710 r = store_get(sizeof(retry_item));
2711 r->next = addr->retries;
2714 r->key = string_copy(ptr);
2716 memcpy(&(r->basic_errno), ptr, sizeof(r->basic_errno));
2717 ptr += sizeof(r->basic_errno);
2718 memcpy(&(r->more_errno), ptr, sizeof(r->more_errno));
2719 ptr += sizeof(r->more_errno);
2720 r->message = (*ptr)? string_copy(ptr) : NULL;
2721 DEBUG(D_deliver|D_retry)
2722 debug_printf(" added %s item\n",
2723 ((r->flags & rf_delete) == 0)? "retry" : "delete");
2728 DEBUG(D_deliver|D_retry)
2729 debug_printf(" delete item not added: non-delete item exists\n");
2732 ptr += sizeof(r->basic_errno) + sizeof(r->more_errno);
2738 /* Put the amount of data written into the parlist block */
2741 memcpy(&(p->transport_count), ptr, sizeof(transport_count));
2742 ptr += sizeof(transport_count);
2745 /* Address items are in the order of items on the address chain. We
2746 remember the current address value in case this function is called
2747 several times to empty the pipe in stages. Information about delivery
2748 over TLS is sent in a preceding X item for each address. We don't put
2749 it in with the other info, in order to keep each message short enough to
2750 guarantee it won't be split in the pipe. */
2754 if (addr == NULL) goto ADDR_MISMATCH; /* Below, in 'A' handler */
2755 addr->cipher = (*ptr)? string_copy(ptr) : NULL;
2757 addr->peerdn = (*ptr)? string_copy(ptr) : NULL;
2766 msg = string_sprintf("address count mismatch for data read from pipe "
2767 "for transport process %d for transport %s", pid,
2768 addrlist->transport->driver_name);
2773 addr->transport_return = *ptr++;
2774 addr->special_action = *ptr++;
2775 memcpy(&(addr->basic_errno), ptr, sizeof(addr->basic_errno));
2776 ptr += sizeof(addr->basic_errno);
2777 memcpy(&(addr->more_errno), ptr, sizeof(addr->more_errno));
2778 ptr += sizeof(addr->more_errno);
2779 memcpy(&(addr->flags), ptr, sizeof(addr->flags));
2780 ptr += sizeof(addr->flags);
2781 addr->message = (*ptr)? string_copy(ptr) : NULL;
2783 addr->user_message = (*ptr)? string_copy(ptr) : NULL;
2786 /* Always two strings for host information, followed by the port number */
2790 h = store_get(sizeof(host_item));
2791 h->name = string_copy(ptr);
2793 h->address = string_copy(ptr);
2795 memcpy(&(h->port), ptr, sizeof(h->port));
2796 ptr += sizeof(h->port);
2797 addr->host_used = h;
2801 /* Finished with this address */
2806 /* Z marks the logical end of the data. It is followed by '0' if
2807 continue_transport was NULL at the end of transporting, otherwise '1'.
2808 We need to know when it becomes NULL during a delivery down a passed SMTP
2809 channel so that we don't try to pass anything more down it. Of course, for
2810 most normal messages it will remain NULL all the time. */
2815 continue_transport = NULL;
2816 continue_hostname = NULL;
2819 DEBUG(D_deliver) debug_printf("Z%c item read\n", *ptr);
2822 /* Anything else is a disaster. */
2825 msg = string_sprintf("malformed data (%d) read from pipe for transport "
2826 "process %d for transport %s", ptr[-1], pid,
2827 addr->transport->driver_name);
2833 /* The done flag is inspected externally, to determine whether or not to
2834 call the function again when the process finishes. */
2838 /* If the process hadn't finished, and we haven't seen the end of the data
2839 or suffered a disaster, update the rest of the state, and return FALSE to
2840 indicate "not finished". */
2849 /* Close our end of the pipe, to prevent deadlock if the far end is still
2850 pushing stuff into it. */
2855 /* If we have finished without error, but haven't had data for every address,
2856 something is wrong. */
2858 if (msg == NULL && addr != NULL)
2859 msg = string_sprintf("insufficient address data read from pipe "
2860 "for transport process %d for transport %s", pid,
2861 addr->transport->driver_name);
2863 /* If an error message is set, something has gone wrong in getting back
2864 the delivery data. Put the message into each address and freeze it. */
2868 for (addr = addrlist; addr != NULL; addr = addr->next)
2870 addr->transport_return = DEFER;
2871 addr->special_action = SPECIAL_FREEZE;
2872 addr->message = msg;
2876 /* Return TRUE to indicate we have got all we need from this process, even
2877 if it hasn't actually finished yet. */
2884 /*************************************************
2885 * Post-process a set of remote addresses *
2886 *************************************************/
2888 /* Do what has to be done immediately after a remote delivery for each set of
2889 addresses, then re-write the spool if necessary. Note that post_process_one
2890 puts the address on an appropriate queue; hence we must fish off the next
2891 one first. This function is also called if there is a problem with setting
2892 up a subprocess to do a remote delivery in parallel. In this case, the final
2893 argument contains a message, and the action must be forced to DEFER.
2896 addr pointer to chain of address items
2897 logflags flags for logging
2898 msg NULL for normal cases; -> error message for unexpected problems
2899 fallback TRUE if processing fallback hosts
2905 remote_post_process(address_item *addr, int logflags, uschar *msg,
2910 /* If any host addresses were found to be unusable, add them to the unusable
2911 tree so that subsequent deliveries don't try them. */
2913 for (h = addr->host_list; h != NULL; h = h->next)
2915 if (h->address == NULL) continue;
2916 if (h->status >= hstatus_unusable) tree_add_unusable(h);
2919 /* Now handle each address on the chain. The transport has placed '=' or '-'
2920 into the special_action field for each successful delivery. */
2922 while (addr != NULL)
2924 address_item *next = addr->next;
2926 /* If msg == NULL (normal processing) and the result is DEFER and we are
2927 processing the main hosts and there are fallback hosts available, put the
2928 address on the list for fallback delivery. */
2930 if (addr->transport_return == DEFER &&
2931 addr->fallback_hosts != NULL &&
2935 addr->host_list = addr->fallback_hosts;
2936 addr->next = addr_fallback;
2937 addr_fallback = addr;
2938 DEBUG(D_deliver) debug_printf("%s queued for fallback host(s)\n", addr->address);
2941 /* If msg is set (=> unexpected problem), set it in the address before
2942 doing the ordinary post processing. */
2948 addr->message = msg;
2949 addr->transport_return = DEFER;
2951 (void)post_process_one(addr, addr->transport_return, logflags,
2952 DTYPE_TRANSPORT, addr->special_action);
2960 /* If we have just delivered down a passed SMTP channel, and that was
2961 the last address, the channel will have been closed down. Now that
2962 we have logged that delivery, set continue_sequence to 1 so that
2963 any subsequent deliveries don't get "*" incorrectly logged. */
2965 if (continue_transport == NULL) continue_sequence = 1;
2970 /*************************************************
2971 * Wait for one remote delivery subprocess *
2972 *************************************************/
2974 /* This function is called while doing remote deliveries when either the
2975 maximum number of processes exist and we need one to complete so that another
2976 can be created, or when waiting for the last ones to complete. It must wait for
2977 the completion of one subprocess, empty the control block slot, and return a
2978 pointer to the address chain.
2981 Returns: pointer to the chain of addresses handled by the process;
2982 NULL if no subprocess found - this is an unexpected error
2985 static address_item *
2988 int poffset, status;
2989 address_item *addr, *addrlist;
2992 set_process_info("delivering %s: waiting for a remote delivery subprocess "
2993 "to finish", message_id);
2995 /* Loop until either a subprocess completes, or there are no subprocesses in
2996 existence - in which case give an error return. We cannot proceed just by
2997 waiting for a completion, because a subprocess may have filled up its pipe, and
2998 be waiting for it to be emptied. Therefore, if no processes have finished, we
2999 wait for one of the pipes to acquire some data by calling select(), with a
3000 timeout just in case.
3002 The simple approach is just to iterate after reading data from a ready pipe.
3003 This leads to non-ideal behaviour when the subprocess has written its final Z
3004 item, closed the pipe, and is in the process of exiting (the common case). A
3005 call to waitpid() yields nothing completed, but select() shows the pipe ready -
3006 reading it yields EOF, so you end up with busy-waiting until the subprocess has
3009 To avoid this, if all the data that is needed has been read from a subprocess
3010 after select(), an explicit wait() for it is done. We know that all it is doing
3011 is writing to the pipe and then exiting, so the wait should not be long.
3013 The non-blocking waitpid() is to some extent just insurance; if we could
3014 reliably detect end-of-file on the pipe, we could always know when to do a
3015 blocking wait() for a completed process. However, because some systems use
3016 NDELAY, which doesn't distinguish between EOF and pipe empty, it is easier to
3017 use code that functions without the need to recognize EOF.
3019 There's a double loop here just in case we end up with a process that is not in
3020 the list of remote delivery processes. Something has obviously gone wrong if
3021 this is the case. (For example, a process that is incorrectly left over from
3022 routing or local deliveries might be found.) The damage can be minimized by
3023 looping back and looking for another process. If there aren't any, the error
3024 return will happen. */
3026 for (;;) /* Normally we do not repeat this loop */
3028 while ((pid = waitpid(-1, &status, WNOHANG)) <= 0)
3031 fd_set select_pipes;
3032 int maxpipe, readycount;
3034 /* A return value of -1 can mean several things. If errno != ECHILD, it
3035 either means invalid options (which we discount), or that this process was
3036 interrupted by a signal. Just loop to try the waitpid() again.
3038 If errno == ECHILD, waitpid() is telling us that there are no subprocesses
3039 in existence. This should never happen, and is an unexpected error.
3040 However, there is a nasty complication when running under Linux. If "strace
3041 -f" is being used under Linux to trace this process and its children,
3042 subprocesses are "stolen" from their parents and become the children of the
3043 tracing process. A general wait such as the one we've just obeyed returns
3044 as if there are no children while subprocesses are running. Once a
3045 subprocess completes, it is restored to the parent, and waitpid(-1) finds
3046 it. Thanks to Joachim Wieland for finding all this out and suggesting a
3049 This does not happen using "truss" on Solaris, nor (I think) with other
3050 tracing facilities on other OS. It seems to be specific to Linux.
3052 What we do to get round this is to use kill() to see if any of our
3053 subprocesses are still in existence. If kill() gives an OK return, we know
3054 it must be for one of our processes - it can't be for a re-use of the pid,
3055 because if our process had finished, waitpid() would have found it. If any
3056 of our subprocesses are in existence, we proceed to use select() as if
3057 waitpid() had returned zero. I think this is safe. */
3061 if (errno != ECHILD) continue; /* Repeats the waitpid() */
3064 debug_printf("waitpid() returned -1/ECHILD: checking explicitly "
3065 "for process existence\n");
3067 for (poffset = 0; poffset < remote_max_parallel; poffset++)
3069 if ((pid = parlist[poffset].pid) != 0 && kill(pid, 0) == 0)
3071 DEBUG(D_deliver) debug_printf("process %d still exists: assume "
3072 "stolen by strace\n", (int)pid);
3073 break; /* With poffset set */
3077 if (poffset >= remote_max_parallel)
3079 DEBUG(D_deliver) debug_printf("*** no delivery children found\n");
3080 return NULL; /* This is the error return */
3084 /* A pid value greater than 0 breaks the "while" loop. A negative value has
3085 been handled above. A return value of zero means that there is at least one
3086 subprocess, but there are no completed subprocesses. See if any pipes are
3087 ready with any data for reading. */
3089 DEBUG(D_deliver) debug_printf("selecting on subprocess pipes\n");
3092 FD_ZERO(&select_pipes);
3093 for (poffset = 0; poffset < remote_max_parallel; poffset++)
3095 if (parlist[poffset].pid != 0)
3097 int fd = parlist[poffset].fd;
3098 FD_SET(fd, &select_pipes);
3099 if (fd > maxpipe) maxpipe = fd;
3103 /* Stick in a 60-second timeout, just in case. */
3108 readycount = select(maxpipe + 1, (SELECT_ARG2_TYPE *)&select_pipes,
3111 /* Scan through the pipes and read any that are ready; use the count
3112 returned by select() to stop when there are no more. Select() can return
3113 with no processes (e.g. if interrupted). This shouldn't matter.
3115 If par_read_pipe() returns TRUE, it means that either the terminating Z was
3116 read, or there was a disaster. In either case, we are finished with this
3117 process. Do an explicit wait() for the process and break the main loop if
3120 It turns out that we have to deal with the case of an interrupted system
3121 call, which can happen on some operating systems if the signal handling is
3122 set up to do that by default. */
3125 readycount > 0 && poffset < remote_max_parallel;
3128 if ((pid = parlist[poffset].pid) != 0 &&
3129 FD_ISSET(parlist[poffset].fd, &select_pipes))
3132 if (par_read_pipe(poffset, FALSE)) /* Finished with this pipe */
3134 for (;;) /* Loop for signals */
3136 pid_t endedpid = waitpid(pid, &status, 0);
3137 if (endedpid == pid) goto PROCESS_DONE;
3138 if (endedpid != (pid_t)(-1) || errno != EINTR)
3139 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Unexpected error return "
3140 "%d (errno = %d) from waitpid() for process %d",
3141 (int)endedpid, errno, (int)pid);
3147 /* Now go back and look for a completed subprocess again. */
3150 /* A completed process was detected by the non-blocking waitpid(). Find the
3151 data block that corresponds to this subprocess. */
3153 for (poffset = 0; poffset < remote_max_parallel; poffset++)
3154 if (pid == parlist[poffset].pid) break;
3156 /* Found the data block; this is a known remote delivery process. We don't
3157 need to repeat the outer loop. This should be what normally happens. */
3159 if (poffset < remote_max_parallel) break;
3161 /* This situation is an error, but it's probably better to carry on looking
3162 for another process than to give up (as we used to do). */
3164 log_write(0, LOG_MAIN|LOG_PANIC, "Process %d finished: not found in remote "
3165 "transport process list", pid);
3166 } /* End of the "for" loop */
3168 /* Come here when all the data was completely read after a select(), and
3169 the process in pid has been wait()ed for. */
3176 debug_printf("remote delivery process %d ended\n", (int)pid);
3178 debug_printf("remote delivery process %d ended: status=%04x\n", (int)pid,
3182 set_process_info("delivering %s", message_id);
3184 /* Get the chain of processed addresses */
3186 addrlist = parlist[poffset].addrlist;
3188 /* If the process did not finish cleanly, record an error and freeze (except
3189 for SIGTERM, SIGKILL and SIGQUIT), and also ensure the journal is not removed,
3190 in case the delivery did actually happen. */
3192 if ((status & 0xffff) != 0)
3195 int msb = (status >> 8) & 255;
3196 int lsb = status & 255;
3197 int code = (msb == 0)? (lsb & 0x7f) : msb;
3199 msg = string_sprintf("%s transport process returned non-zero status 0x%04x: "
3201 addrlist->transport->driver_name,
3203 (msb == 0)? "terminated by signal" : "exit code",
3206 if (msb != 0 || (code != SIGTERM && code != SIGKILL && code != SIGQUIT))
3207 addrlist->special_action = SPECIAL_FREEZE;
3209 for (addr = addrlist; addr != NULL; addr = addr->next)
3211 addr->transport_return = DEFER;
3212 addr->message = msg;
3215 remove_journal = FALSE;
3218 /* Else complete reading the pipe to get the result of the delivery, if all
3219 the data has not yet been obtained. */
3221 else if (!parlist[poffset].done) (void)par_read_pipe(poffset, TRUE);
3223 /* Put the data count and return path into globals, mark the data slot unused,
3224 decrement the count of subprocesses, and return the address chain. */
3226 transport_count = parlist[poffset].transport_count;
3227 used_return_path = parlist[poffset].return_path;
3228 parlist[poffset].pid = 0;
3235 /*************************************************
3236 * Wait for subprocesses and post-process *
3237 *************************************************/
3239 /* This function waits for subprocesses until the number that are still running
3240 is below a given threshold. For each complete subprocess, the addresses are
3241 post-processed. If we can't find a running process, there is some shambles.
3242 Better not bomb out, as that might lead to multiple copies of the message. Just
3243 log and proceed as if all done.
3246 max maximum number of subprocesses to leave running
3247 fallback TRUE if processing fallback hosts
3253 par_reduce(int max, BOOL fallback)
3255 while (parcount > max)
3257 address_item *doneaddr = par_wait();
3258 if (doneaddr == NULL)
3260 log_write(0, LOG_MAIN|LOG_PANIC,
3261 "remote delivery process count got out of step");
3264 else remote_post_process(doneaddr, LOG_MAIN, NULL, fallback);
3271 /*************************************************
3272 * Do remote deliveries *
3273 *************************************************/
3275 /* This function is called to process the addresses in addr_remote. We must
3276 pick off the queue all addresses that have the same transport, remote
3277 destination, and errors address, and hand them to the transport in one go,
3278 subject to some configured limitations. If this is a run to continue delivering
3279 to an existing delivery channel, skip all but those addresses that can go to
3280 that channel. The skipped addresses just get deferred.
3282 If mua_wrapper is set, all addresses must be able to be sent in a single
3283 transaction. If not, this function yields FALSE.
3285 In Exim 4, remote deliveries are always done in separate processes, even
3286 if remote_max_parallel = 1 or if there's only one delivery to do. The reason
3287 is so that the base process can retain privilege. This makes the
3288 implementation of fallback transports feasible (though not initially done.)
3290 We create up to the configured number of subprocesses, each of which passes
3291 back the delivery state via a pipe. (However, when sending down an existing
3292 connection, remote_max_parallel is forced to 1.)
3295 fallback TRUE if processing fallback hosts
3297 Returns: TRUE normally
3298 FALSE if mua_wrapper is set and the addresses cannot all be sent
3303 do_remote_deliveries(BOOL fallback)
3309 parcount = 0; /* Number of executing subprocesses */
3311 /* When sending down an existing channel, only do one delivery at a time.
3312 We use a local variable (parmax) to hold the maximum number of processes;
3313 this gets reduced from remote_max_parallel if we can't create enough pipes. */
3315 if (continue_transport != NULL) remote_max_parallel = 1;
3316 parmax = remote_max_parallel;
3318 /* If the data for keeping a list of processes hasn't yet been
3321 if (parlist == NULL)
3323 parlist = store_get(remote_max_parallel * sizeof(pardata));
3324 for (poffset = 0; poffset < remote_max_parallel; poffset++)
3325 parlist[poffset].pid = 0;
3328 /* Now loop for each remote delivery */
3330 for (delivery_count = 0; addr_remote != NULL; delivery_count++)
3336 int address_count = 1;
3337 int address_count_max;
3339 BOOL use_initgroups;
3340 BOOL pipe_done = FALSE;
3341 transport_instance *tp;
3342 address_item **anchor = &addr_remote;
3343 address_item *addr = addr_remote;
3344 address_item *last = addr;
3347 /* Pull the first address right off the list. */
3349 addr_remote = addr->next;
3352 DEBUG(D_deliver|D_transport)
3353 debug_printf("--------> %s <--------\n", addr->address);
3355 /* If no transport has been set, there has been a big screw-up somewhere. */
3357 if ((tp = addr->transport) == NULL)
3359 disable_logging = FALSE; /* Jic */
3360 remote_post_process(addr, LOG_MAIN|LOG_PANIC,
3361 US"No transport set by router", fallback);
3365 /* Check that this base address hasn't previously been delivered to this
3366 transport. The check is necessary at this point to handle homonymic addresses
3367 correctly in cases where the pattern of redirection changes between delivery
3368 attempts. Non-homonymic previous delivery is detected earlier, at routing
3371 if (previously_transported(addr)) continue;
3373 /* Force failure if the message is too big. */
3375 if (tp->message_size_limit != NULL)
3377 int rc = check_message_size(tp, addr);
3380 addr->transport_return = rc;
3381 remote_post_process(addr, LOG_MAIN, NULL, fallback);
3386 /* Get the flag which specifies whether the transport can handle different
3387 domains that nevertheless resolve to the same set of hosts. */
3389 multi_domain = tp->multi_domain;
3391 /* Get the maximum it can handle in one envelope, with zero meaning
3392 unlimited, which is forced for the MUA wrapper case. */
3394 address_count_max = tp->max_addresses;
3395 if (address_count_max == 0 || mua_wrapper) address_count_max = 999999;
3398 /************************************************************************/
3399 /***** This is slightly experimental code, but should be safe. *****/
3401 /* The address_count_max value is the maximum number of addresses that the
3402 transport can send in one envelope. However, the transport must be capable of
3403 dealing with any number of addresses. If the number it gets exceeds its
3404 envelope limitation, it must send multiple copies of the message. This can be
3405 done over a single connection for SMTP, so uses less resources than making
3406 multiple connections. On the other hand, if remote_max_parallel is greater
3407 than one, it is perhaps a good idea to use parallel processing to move the
3408 message faster, even if that results in multiple simultaneous connections to
3411 How can we come to some compromise between these two ideals? What we do is to
3412 limit the number of addresses passed to a single instance of a transport to
3413 the greater of (a) its address limit (rcpt_max for SMTP) and (b) the total
3414 number of addresses routed to remote transports divided by
3415 remote_max_parallel. For example, if the message has 100 remote recipients,
3416 remote max parallel is 2, and rcpt_max is 10, we'd never send more than 50 at
3417 once. But if rcpt_max is 100, we could send up to 100.
3419 Of course, not all the remotely addresses in a message are going to go to the
3420 same set of hosts (except in smarthost configurations), so this is just a
3421 heuristic way of dividing up the work.
3423 Furthermore (1), because this may not be wanted in some cases, and also to
3424 cope with really pathological cases, there is also a limit to the number of
3425 messages that are sent over one connection. This is the same limit that is
3426 used when sending several different messages over the same connection.
3427 Continue_sequence is set when in this situation, to the number sent so
3428 far, including this message.
3430 Furthermore (2), when somebody explicitly sets the maximum value to 1, it
3431 is probably because they are using VERP, in which case they want to pass only
3432 one address at a time to the transport, in order to be able to use
3433 $local_part and $domain in constructing a new return path. We could test for
3434 the use of these variables, but as it is so likely they will be used when the
3435 maximum is 1, we don't bother. Just leave the value alone. */
3437 if (address_count_max != 1 &&
3438 address_count_max < remote_delivery_count/remote_max_parallel)
3440 int new_max = remote_delivery_count/remote_max_parallel;
3441 int message_max = tp->connection_max_messages;
3442 if (connection_max_messages >= 0) message_max = connection_max_messages;
3443 message_max -= continue_sequence - 1;
3444 if (message_max > 0 && new_max > address_count_max * message_max)
3445 new_max = address_count_max * message_max;
3446 address_count_max = new_max;
3449 /************************************************************************/
3452 /* Pick off all addresses which have the same transport, errors address,
3453 destination, and extra headers. In some cases they point to the same host
3454 list, but we also need to check for identical host lists generated from
3455 entirely different domains. The host list pointers can be NULL in the case
3456 where the hosts are defined in the transport. There is also a configured
3457 maximum limit of addresses that can be handled at once (see comments above
3458 for how it is computed). */
3460 while ((next = *anchor) != NULL && address_count < address_count_max)
3462 if ((multi_domain || Ustrcmp(next->domain, addr->domain) == 0)
3464 tp == next->transport
3466 same_hosts(next->host_list, addr->host_list)
3468 same_strings(next->p.errors_address, addr->p.errors_address)
3470 same_headers(next->p.extra_headers, addr->p.extra_headers)
3472 same_ugid(tp, next, addr)
3474 (next->p.remove_headers == addr->p.remove_headers ||
3475 (next->p.remove_headers != NULL &&
3476 addr->p.remove_headers != NULL &&
3477 Ustrcmp(next->p.remove_headers, addr->p.remove_headers) == 0)))
3479 *anchor = next->next;
3481 next->first = addr; /* remember top one (for retry processing) */
3486 else anchor = &(next->next);
3489 /* If we are acting as an MUA wrapper, all addresses must go in a single
3490 transaction. If not, put them back on the chain and yield FALSE. */
3492 if (mua_wrapper && addr_remote != NULL)
3494 last->next = addr_remote;
3499 /* Set up the expansion variables for this set of addresses */
3501 deliver_set_expansions(addr);
3503 /* Compute the return path, expanding a new one if required. The old one
3504 must be set first, as it might be referred to in the expansion. */
3506 return_path = (addr->p.errors_address != NULL)?
3507 addr->p.errors_address : sender_address;
3509 if (tp->return_path != NULL)
3511 uschar *new_return_path = expand_string(tp->return_path);
3512 if (new_return_path == NULL)
3514 if (!expand_string_forcedfail)
3516 remote_post_process(addr, LOG_MAIN|LOG_PANIC,
3517 string_sprintf("Failed to expand return path \"%s\": %s",
3518 tp->return_path, expand_string_message), fallback);
3522 else return_path = new_return_path;
3525 /* If this transport has a setup function, call it now so that it gets
3526 run in this process and not in any subprocess. That way, the results of
3527 any setup that are retained by the transport can be reusable. */
3529 if (tp->setup != NULL)
3530 (void)((tp->setup)(addr->transport, addr, NULL, NULL));
3532 /* If this is a run to continue delivery down an already-established
3533 channel, check that this set of addresses matches the transport and
3534 the channel. If it does not, defer the addresses. If a host list exists,
3535 we must check that the continue host is on the list. Otherwise, the
3536 host is set in the transport. */
3538 continue_more = FALSE; /* In case got set for the last lot */
3539 if (continue_transport != NULL)
3541 BOOL ok = Ustrcmp(continue_transport, tp->name) == 0;
3542 if (ok && addr->host_list != NULL)
3546 for (h = addr->host_list; h != NULL; h = h->next)
3548 if (Ustrcmp(h->name, continue_hostname) == 0)
3549 { ok = TRUE; break; }
3553 /* Addresses not suitable; defer or queue for fallback hosts (which
3554 might be the continue host) and skip to next address. */
3558 DEBUG(D_deliver) debug_printf("not suitable for continue_transport\n");
3561 if (addr->fallback_hosts != NULL && !fallback)
3565 next->host_list = next->fallback_hosts;
3566 DEBUG(D_deliver) debug_printf("%s queued for fallback host(s)\n", next->address);
3567 if (next->next == NULL) break;
3570 next->next = addr_fallback;
3571 addr_fallback = addr;
3576 while (next->next != NULL) next = next->next;
3577 next->next = addr_defer;
3584 /* Set a flag indicating whether there are further addresses that list
3585 the continued host. This tells the transport to leave the channel open,
3586 but not to pass it to another delivery process. */
3588 for (next = addr_remote; next != NULL; next = next->next)
3591 for (h = next->host_list; h != NULL; h = h->next)
3593 if (Ustrcmp(h->name, continue_hostname) == 0)
3594 { continue_more = TRUE; break; }
3599 /* The transports set up the process info themselves as they may connect
3600 to more than one remote machine. They also have to set up the filter
3601 arguments, if required, so that the host name and address are available
3604 transport_filter_argv = NULL;
3606 /* Find the uid, gid, and use_initgroups setting for this transport. Failure
3607 logs and sets up error messages, so we just post-process and continue with
3608 the next address. */
3610 if (!findugid(addr, tp, &uid, &gid, &use_initgroups))
3612 remote_post_process(addr, LOG_MAIN|LOG_PANIC, NULL, fallback);
3616 /* Create the pipe for inter-process communication. If pipe creation
3617 fails, it is probably because the value of remote_max_parallel is so
3618 large that too many file descriptors for pipes have been created. Arrange
3619 to wait for a process to finish, and then try again. If we still can't
3620 create a pipe when all processes have finished, break the retry loop. */
3624 if (pipe(pfd) == 0) pipe_done = TRUE;
3625 else if (parcount > 0) parmax = parcount;
3628 /* We need to make the reading end of the pipe non-blocking. There are
3629 two different options for this. Exim is cunningly (I hope!) coded so
3630 that it can use either of them, though it prefers O_NONBLOCK, which
3631 distinguishes between EOF and no-more-data. */
3634 fcntl(pfd[pipe_read], F_SETFL, O_NONBLOCK);
3636 fcntl(pfd[pipe_read], F_SETFL, O_NDELAY);
3639 /* If the maximum number of subprocesses already exist, wait for a process
3640 to finish. If we ran out of file descriptors, parmax will have been reduced
3641 from its initial value of remote_max_parallel. */
3643 par_reduce(parmax - 1, fallback);
3646 /* If we failed to create a pipe and there were no processes to wait
3647 for, we have to give up on this one. Do this outside the above loop
3648 so that we can continue the main loop. */
3652 remote_post_process(addr, LOG_MAIN|LOG_PANIC,
3653 string_sprintf("unable to create pipe: %s", strerror(errno)), fallback);
3657 /* Find a free slot in the pardata list. Must do this after the possible
3658 waiting for processes to finish, because a terminating process will free
3661 for (poffset = 0; poffset < remote_max_parallel; poffset++)
3662 if (parlist[poffset].pid == 0) break;
3664 /* If there isn't one, there has been a horrible disaster. */
3666 if (poffset >= remote_max_parallel)
3668 close(pfd[pipe_write]);
3669 close(pfd[pipe_read]);
3670 remote_post_process(addr, LOG_MAIN|LOG_PANIC,
3671 US"Unexpectedly no free subprocess slot", fallback);
3675 /* Now fork a subprocess to do the remote delivery, but before doing so,
3676 ensure that any cached resourses are released so as not to interfere with
3677 what happens in the subprocess. */
3681 if ((pid = fork()) == 0)
3683 int fd = pfd[pipe_write];
3686 /* There are weird circumstances in which logging is disabled */
3688 disable_logging = tp->disable_logging;
3690 /* Show pids on debug output if parallelism possible */
3692 if (parmax > 1 && (parcount > 0 || addr_remote != NULL))
3694 DEBUG(D_any|D_v) debug_selector |= D_pid;
3695 DEBUG(D_deliver) debug_printf("Remote delivery process started\n");
3698 /* Reset the random number generator, so different processes don't all
3699 have the same sequence. In the test harness we want different, but
3700 predictable settings for each delivery process, so do something explicit
3701 here rather they rely on the fixed reset in the random number function. */
3703 random_seed = running_in_test_harness? 42 + 2*delivery_count : 0;
3705 /* Set close-on-exec on the pipe so that it doesn't get passed on to
3706 a new process that may be forked to do another delivery down the same
3709 fcntl(fd, F_SETFD, fcntl(fd, F_GETFD) | FD_CLOEXEC);
3711 /* Close open file descriptors for the pipes of other processes
3712 that are running in parallel. */
3714 for (poffset = 0; poffset < remote_max_parallel; poffset++)
3715 if (parlist[poffset].pid != 0) close(parlist[poffset].fd);
3717 /* This process has inherited a copy of the file descriptor
3718 for the data file, but its file pointer is shared with all the
3719 other processes running in parallel. Therefore, we have to re-open
3720 the file in order to get a new file descriptor with its own
3721 file pointer. We don't need to lock it, as the lock is held by
3722 the parent process. There doesn't seem to be any way of doing
3723 a dup-with-new-file-pointer. */
3725 close(deliver_datafile);
3726 sprintf(CS spoolname, "%s/input/%s/%s-D", spool_directory, message_subdir,
3728 deliver_datafile = Uopen(spoolname, O_RDWR | O_APPEND, 0);
3730 if (deliver_datafile < 0)
3731 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Failed to reopen %s for remote "
3732 "parallel delivery: %s", spoolname, strerror(errno));
3734 /* Set the close-on-exec flag */
3736 fcntl(deliver_datafile, F_SETFD, fcntl(deliver_datafile, F_GETFD) |
3739 /* Set the uid/gid of this process; bombs out on failure. */
3741 exim_setugid(uid, gid, use_initgroups,
3742 string_sprintf("remote delivery to %s with transport=%s",
3743 addr->address, tp->name));
3745 /* Close the unwanted half of this process' pipe, set the process state,
3746 and run the transport. Afterwards, transport_count will contain the number
3747 of bytes written. */
3749 close(pfd[pipe_read]);
3750 set_process_info("delivering %s using %s", message_id, tp->name);
3751 debug_print_string(tp->debug_string);
3752 if (!(tp->info->code)(addr->transport, addr)) replicate_status(addr);
3754 set_process_info("delivering %s (just run %s for %s%s in subprocess)",
3755 message_id, tp->name, addr->address, (addr->next == NULL)? "" : ", ...");
3757 /* Ensure any cached resources that we used are now released */
3761 /* Pass the result back down the pipe. This is a lot more information
3762 than is needed for a local delivery. We have to send back the error
3763 status for each address, the usability status for each host that is
3764 flagged as unusable, and all the retry items. When TLS is in use, we
3765 send also the cipher and peerdn information. Each type of information
3766 is flagged by an identifying byte, and is then in a fixed format (with
3767 strings terminated by zeros), and there is a final terminator at the
3768 end. The host information and retry information is all attached to
3769 the first address, so that gets sent at the start. */
3771 /* Host unusability information: for most success cases this will
3774 for (h = addr->host_list; h != NULL; h = h->next)
3776 if (h->address == NULL || h->status < hstatus_unusable) continue;
3777 sprintf(CS big_buffer, "H%c%c%s", h->status, h->why, h->address);
3778 write(fd, big_buffer, Ustrlen(big_buffer+3) + 4);
3781 /* The number of bytes written. This is the same for each address. Even
3782 if we sent several copies of the message down the same connection, the
3783 size of each one is the same, and it's that value we have got because
3784 transport_count gets reset before calling transport_write_message(). */
3786 big_buffer[0] = 'S';
3787 memcpy(big_buffer+1, &transport_count, sizeof(transport_count));
3788 write(fd, big_buffer, sizeof(transport_count) + 1);
3790 /* Information about what happened to each address. Three item types are
3791 used: an optional 'X' item first, for TLS information, followed by 'R'
3792 items for any retry settings, and finally an 'A' item for the remaining
3795 for(; addr != NULL; addr = addr->next)
3800 /* The certificate verification status goes into the flags */
3802 if (tls_certificate_verified) setflag(addr, af_cert_verified);
3804 /* Use an X item only if there's something to send */
3807 if (addr->cipher != NULL)
3811 sprintf(CS ptr, "%.128s", addr->cipher);
3813 if (addr->peerdn == NULL) *ptr++ = 0; else
3815 sprintf(CS ptr, "%.512s", addr->peerdn);
3818 write(fd, big_buffer, ptr - big_buffer);
3822 /* Retry information: for most success cases this will be null. */
3824 for (r = addr->retries; r != NULL; r = r->next)
3827 sprintf(CS big_buffer, "R%c%.500s", r->flags, r->key);
3828 ptr = big_buffer + Ustrlen(big_buffer+2) + 3;
3829 memcpy(ptr, &(r->basic_errno), sizeof(r->basic_errno));
3830 ptr += sizeof(r->basic_errno);
3831 memcpy(ptr, &(r->more_errno), sizeof(r->more_errno));
3832 ptr += sizeof(r->more_errno);
3833 if (r->message == NULL) *ptr++ = 0; else
3835 sprintf(CS ptr, "%.512s", r->message);
3838 write(fd, big_buffer, ptr - big_buffer);
3841 /* The rest of the information goes in an 'A' item. */
3843 ptr = big_buffer + 3;
3844 sprintf(CS big_buffer, "A%c%c", addr->transport_return,
3845 addr->special_action);
3846 memcpy(ptr, &(addr->basic_errno), sizeof(addr->basic_errno));
3847 ptr += sizeof(addr->basic_errno);
3848 memcpy(ptr, &(addr->more_errno), sizeof(addr->more_errno));
3849 ptr += sizeof(addr->more_errno);
3850 memcpy(ptr, &(addr->flags), sizeof(addr->flags));
3851 ptr += sizeof(addr->flags);
3853 if (addr->message == NULL) *ptr++ = 0; else
3855 sprintf(CS ptr, "%.1024s", addr->message);
3859 if (addr->user_message == NULL) *ptr++ = 0; else
3861 sprintf(CS ptr, "%.1024s", addr->user_message);
3865 if (addr->host_used == NULL) *ptr++ = 0; else
3867 sprintf(CS ptr, "%.256s", addr->host_used->name);
3869 sprintf(CS ptr, "%.64s", addr->host_used->address);
3871 memcpy(ptr, &(addr->host_used->port), sizeof(addr->host_used->port));
3872 ptr += sizeof(addr->host_used->port);
3874 write(fd, big_buffer, ptr - big_buffer);
3877 /* Add termination flag, close the pipe, and that's it. The character
3878 after 'Z' indicates whether continue_transport is now NULL or not.
3879 A change from non-NULL to NULL indicates a problem with a continuing
3882 big_buffer[0] = 'Z';
3883 big_buffer[1] = (continue_transport == NULL)? '0' : '1';
3884 write(fd, big_buffer, 2);
3889 /* Back in the mainline: close the unwanted half of the pipe. */
3891 close(pfd[pipe_write]);
3893 /* Fork failed; defer with error message */
3897 close(pfd[pipe_read]);
3898 remote_post_process(addr, LOG_MAIN|LOG_PANIC,
3899 string_sprintf("fork failed for remote delivery to %s: %s",
3900 addr->domain, strerror(errno)), fallback);
3904 /* Fork succeeded; increment the count, and remember relevant data for
3905 when the process finishes. */
3908 parlist[poffset].addrlist = parlist[poffset].addr = addr;
3909 parlist[poffset].pid = pid;
3910 parlist[poffset].fd = pfd[pipe_read];
3911 parlist[poffset].done = FALSE;
3912 parlist[poffset].msg = NULL;
3913 parlist[poffset].return_path = return_path;
3915 /* If the process we've just started is sending a message down an existing
3916 channel, wait for it now. This ensures that only one such process runs at
3917 once, whatever the value of remote_max parallel. Otherwise, we might try to
3918 send two or more messages simultaneously down the same channel. This could
3919 happen if there are different domains that include the same host in otherwise
3920 different host lists.
3922 Also, if the transport closes down the channel, this information gets back
3923 (continue_transport gets set to NULL) before we consider any other addresses
3926 if (continue_transport != NULL) par_reduce(0, fallback);
3928 /* Otherwise, if we are running in the test harness, wait a bit, to let the
3929 newly created process get going before we create another process. This should
3930 ensure repeatability in the tests. We only need to wait a tad. */
3932 else if (running_in_test_harness) millisleep(500);
3935 /* Reached the end of the list of addresses. Wait for all the subprocesses that
3936 are still running and post-process their addresses. */
3938 par_reduce(0, fallback);
3945 /*************************************************
3946 * Split an address into local part and domain *
3947 *************************************************/
3949 /* This function initializes an address for routing by splitting it up into a
3950 local part and a domain. The local part is set up twice - once in its original
3951 casing, and once in lower case, and it is dequoted. We also do the "percent
3952 hack" for configured domains. This may lead to a DEFER result if a lookup
3953 defers. When a percent-hacking takes place, we insert a copy of the original
3954 address as a new parent of this address, as if we have had a redirection.
3957 addr points to an addr_item block containing the address
3960 DEFER - could not determine if domain is %-hackable
3964 deliver_split_address(address_item *addr)
3966 uschar *address = addr->address;
3967 uschar *domain = Ustrrchr(address, '@');
3969 int len = domain - address;
3971 addr->domain = string_copylc(domain+1); /* Domains are always caseless */
3973 /* The implication in the RFCs (though I can't say I've seen it spelled out
3974 explicitly) is that quoting should be removed from local parts at the point
3975 where they are locally interpreted. [The new draft "821" is more explicit on
3976 this, Jan 1999.] We know the syntax is valid, so this can be done by simply
3977 removing quoting backslashes and any unquoted doublequotes. */
3979 t = addr->cc_local_part = store_get(len+1);
3982 register int c = *address++;
3983 if (c == '\"') continue;
3993 /* We do the percent hack only for those domains that are listed in
3994 percent_hack_domains. A loop is required, to copy with multiple %-hacks. */
3996 if (percent_hack_domains != NULL)
3999 uschar *new_address = NULL;
4000 uschar *local_part = addr->cc_local_part;
4002 deliver_domain = addr->domain; /* set $domain */
4004 while ((rc = match_isinlist(deliver_domain, &percent_hack_domains, 0,
4005 &domainlist_anchor, addr->domain_cache, MCL_DOMAIN, TRUE, NULL))
4007 (t = Ustrrchr(local_part, '%')) != NULL)
4009 new_address = string_copy(local_part);
4010 new_address[t - local_part] = '@';
4011 deliver_domain = string_copylc(t+1);
4012 local_part = string_copyn(local_part, t - local_part);
4015 if (rc == DEFER) return DEFER; /* lookup deferred */
4017 /* If hackery happened, set up new parent and alter the current address. */
4019 if (new_address != NULL)
4021 address_item *new_parent = store_get(sizeof(address_item));
4022 *new_parent = *addr;
4023 addr->parent = new_parent;
4024 addr->address = new_address;
4025 addr->unique = string_copy(new_address);
4026 addr->domain = deliver_domain;
4027 addr->cc_local_part = local_part;
4028 DEBUG(D_deliver) debug_printf("%%-hack changed address to: %s\n",
4033 /* Create the lowercased version of the final local part, and make that the
4034 default one to be used. */
4036 addr->local_part = addr->lc_local_part = string_copylc(addr->cc_local_part);
4043 /*************************************************
4044 * Get next error message text *
4045 *************************************************/
4047 /* If f is not NULL, read the next "paragraph", from a customized error message
4048 text file, terminated by a line containing ****, and expand it.
4051 f NULL or a file to read from
4052 which string indicating which string (for errors)
4054 Returns: NULL or an expanded string
4058 next_emf(FILE *f, uschar *which)
4062 uschar *para, *yield;
4065 if (f == NULL) return NULL;
4067 if (Ufgets(buffer, sizeof(buffer), f) == NULL ||
4068 Ustrcmp(buffer, "****\n") == 0) return NULL;
4070 para = store_get(size);
4073 para = string_cat(para, &size, &ptr, buffer, Ustrlen(buffer));
4074 if (Ufgets(buffer, sizeof(buffer), f) == NULL ||
4075 Ustrcmp(buffer, "****\n") == 0) break;
4079 yield = expand_string(para);
4080 if (yield != NULL) return yield;
4082 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand string from "
4083 "bounce_message_file or warn_message_file (%s): %s", which,
4084 expand_string_message);
4091 /*************************************************
4092 * Close down a passed transport channel *
4093 *************************************************/
4095 /* This function is called when a passed transport channel cannot be used.
4096 It attempts to close it down tidily. The yield is always DELIVER_NOT_ATTEMPTED
4097 so that the function call can be the argument of a "return" statement.
4100 Returns: DELIVER_NOT_ATTEMPTED
4104 continue_closedown(void)
4106 if (continue_transport != NULL)
4108 transport_instance *t;
4109 for (t = transports; t != NULL; t = t->next)
4111 if (Ustrcmp(t->name, continue_transport) == 0)
4113 if (t->info->closedown != NULL) (t->info->closedown)(t);
4118 return DELIVER_NOT_ATTEMPTED;
4124 /*************************************************
4125 * Print address information *
4126 *************************************************/
4128 /* This function is called to output an address, or information about an
4129 address, for bounce or defer messages. If the hide_child flag is set, all we
4130 output is the original ancestor address.
4133 addr points to the address
4134 f the FILE to print to
4135 si an initial string
4136 sc a continuation string for before "generated"
4139 Returns: TRUE if the address is not hidden
4143 print_address_information(address_item *addr, FILE *f, uschar *si, uschar *sc,
4147 uschar *printed = US"";
4148 address_item *ancestor = addr;
4149 while (ancestor->parent != NULL) ancestor = ancestor->parent;
4151 fprintf(f, "%s", CS si);
4153 if (addr->parent != NULL && testflag(addr, af_hide_child))
4155 printed = US"an undisclosed address";
4159 else if (!testflag(addr, af_pfr) || addr->parent == NULL)
4160 printed = addr->address;
4164 uschar *s = addr->address;
4167 if (addr->address[0] == '>') { ss = US"mail"; s++; }
4168 else if (addr->address[0] == '|') ss = US"pipe";
4171 fprintf(f, "%s to %s%sgenerated by ", ss, s, sc);
4172 printed = addr->parent->address;
4175 fprintf(f, "%s", CS string_printing(printed));
4177 if (ancestor != addr)
4179 uschar *original = (ancestor->onetime_parent == NULL)?
4180 ancestor->address : ancestor->onetime_parent;
4181 if (strcmpic(original, printed) != 0)
4182 fprintf(f, "%s(%sgenerated from %s)", sc,
4183 (ancestor != addr->parent)? "ultimately " : "",
4184 string_printing(original));
4187 fprintf(f, "%s", CS se);
4196 /*************************************************
4197 * Print error for an address *
4198 *************************************************/
4200 /* This function is called to print the error information out of an address for
4201 a bounce or a warning message. It tries to format the message reasonably by
4202 introducing newlines. All lines are indented by 4; the initial printing
4203 position must be set before calling.
4206 addr points to the address
4207 f the FILE to print on
4213 print_address_error(address_item *addr, FILE *f)
4215 uschar *s = (addr->user_message != NULL)? addr->user_message : addr->message;
4216 if (addr->basic_errno > 0)
4218 fprintf(f, "%s%s", strerror(addr->basic_errno),
4219 (s == NULL)? "" : ":\n ");
4223 if (addr->basic_errno <= 0) fprintf(f, "unknown error");
4230 if (*s == '\\' && s[1] == 'n')
4240 if (*s++ == ':' && isspace(*s) && count > 45)
4242 fprintf(f, "\n "); /* sic (because space follows) */
4253 /*************************************************
4254 * Deliver one message *
4255 *************************************************/
4257 /* This is the function which is called when a message is to be delivered. It
4258 is passed the id of the message. It is possible that the message no longer
4259 exists, if some other process has delivered it, and it is also possible that
4260 the message is being worked on by another process, in which case the data file
4263 If no delivery is attempted for any of the above reasons, the function returns
4264 DELIVER_NOT_ATTEMPTED.
4266 If the give_up flag is set true, do not attempt any deliveries, but instead
4267 fail all outstanding addresses and return the message to the sender (or
4270 A delivery operation has a process all to itself; we never deliver more than
4271 one message in the same process. Therefore we needn't worry too much about
4275 id the id of the message to be delivered
4276 forced TRUE if delivery was forced by an administrator; this overrides
4277 retry delays and causes a delivery to be tried regardless
4278 give_up TRUE if an administrator has requested that delivery attempts
4281 Returns: When the global variable mua_wrapper is FALSE:
4282 DELIVER_ATTEMPTED_NORMAL if a delivery attempt was made
4283 DELIVER_NOT_ATTEMPTED otherwise (see comment above)
4284 When the global variable mua_wrapper is TRUE:
4285 DELIVER_MUA_SUCCEEDED if delivery succeeded
4286 DELIVER_MUA_FAILED if delivery failed
4287 DELIVER_NOT_ATTEMPTED if not attempted (should not occur)
4291 deliver_message(uschar *id, BOOL forced, BOOL give_up)
4294 int final_yield = DELIVER_ATTEMPTED_NORMAL;
4295 time_t now = time(NULL);
4296 address_item *addr_last = NULL;
4297 uschar *filter_message = NULL;
4299 int process_recipients = RECIP_ACCEPT;
4303 uschar *info = (queue_run_pid == (pid_t)0)?
4304 string_sprintf("delivering %s", id) :
4305 string_sprintf("delivering %s (queue run pid %d)", id, queue_run_pid);
4307 /* If the D_process_info bit is on, set_process_info() will output debugging
4308 information. If not, we want to show this initial information if D_deliver or
4309 D_queue_run is set or in verbose mode. */
4311 set_process_info("%s", info);
4313 if ((debug_selector & D_process_info) == 0 &&
4314 (debug_selector & (D_deliver|D_queue_run|D_v)) != 0)
4315 debug_printf("%s\n", info);
4317 /* Ensure that we catch any subprocesses that are created. Although Exim
4318 sets SIG_DFL as its initial default, some routes through the code end up
4319 here with it set to SIG_IGN - cases where a non-synchronous delivery process
4320 has been forked, but no re-exec has been done. We use sigaction rather than
4321 plain signal() on those OS where SA_NOCLDWAIT exists, because we want to be
4322 sure it is turned off. (There was a problem on AIX with this.) */
4326 struct sigaction act;
4327 act.sa_handler = SIG_DFL;
4328 sigemptyset(&(act.sa_mask));
4330 sigaction(SIGCHLD, &act, NULL);
4333 signal(SIGCHLD, SIG_DFL);
4336 /* Make the forcing flag available for routers and transports, set up the
4337 global message id field, and initialize the count for returned files and the
4338 message size. This use of strcpy() is OK because the length id is checked when
4339 it is obtained from a command line (the -M or -q options), and otherwise it is
4340 known to be a valid message id. */
4342 Ustrcpy(message_id, id);
4343 deliver_force = forced;
4347 /* Initialize some flags */
4349 update_spool = FALSE;
4350 remove_journal = TRUE;
4352 /* Reset the random number generator, so that if several delivery processes are
4353 started from a queue runner that has already used random numbers (for sorting),
4354 they don't all get the same sequence. */
4358 /* Open and lock the message's data file. Exim locks on this one because the
4359 header file may get replaced as it is re-written during the delivery process.
4360 Any failures cause messages to be written to the log, except for missing files
4361 while queue running - another process probably completed delivery. As part of
4362 opening the data file, message_subdir gets set. */
4364 if (!spool_open_datafile(id))
4365 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
4367 /* The value of message_size at this point has been set to the data length,
4368 plus one for the blank line that notionally precedes the data. */
4370 /* Now read the contents of the header file, which will set up the headers in
4371 store, and also the list of recipients and the tree of non-recipients and
4372 assorted flags. It updates message_size. If there is a reading or format error,
4373 give up; if the message has been around for sufficiently long, remove it. */
4375 sprintf(CS spoolname, "%s-H", id);
4376 if ((rc = spool_read_header(spoolname, TRUE, TRUE)) != spool_read_OK)
4378 if (errno == ERRNO_SPOOLFORMAT)
4380 struct stat statbuf;
4381 sprintf(CS big_buffer, "%s/input/%s/%s", spool_directory, message_subdir,
4383 if (Ustat(big_buffer, &statbuf) == 0)
4385 int size = statbuf.st_size; /* Because might be a long */
4386 log_write(0, LOG_MAIN, "Format error in spool file %s: size=%d",
4389 else log_write(0, LOG_MAIN, "Format error in spool file %s", spoolname);
4392 log_write(0, LOG_MAIN, "Error reading spool file %s: %s", spoolname,
4395 /* If we managed to read the envelope data, received_time contains the
4396 time the message was received. Otherwise, we can calculate it from the
4399 if (rc != spool_read_hdrerror)
4402 for (i = 0; i < 6; i++)
4403 received_time = received_time * BASE_62 + tab62[id[i] - '0'];
4406 /* If we've had this malformed message too long, sling it. */
4408 if (now - received_time > keep_malformed)
4410 sprintf(CS spoolname, "%s/msglog/%s/%s", spool_directory, message_subdir, id);
4412 sprintf(CS spoolname, "%s/input/%s/%s-D", spool_directory, message_subdir, id);
4414 sprintf(CS spoolname, "%s/input/%s/%s-H", spool_directory, message_subdir, id);
4416 sprintf(CS spoolname, "%s/input/%s/%s-J", spool_directory, message_subdir, id);
4418 log_write(0, LOG_MAIN, "Message removed because older than %s",
4419 readconf_printtime(keep_malformed));
4422 close(deliver_datafile);
4423 deliver_datafile = -1;
4424 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
4427 /* The spool header file has been read. Look to see if there is an existing
4428 journal file for this message. If there is, it means that a previous delivery
4429 attempt crashed (program or host) before it could update the spool header file.
4430 Read the list of delivered addresses from the journal and add them to the
4431 nonrecipients tree. Then update the spool file. We can leave the journal in
4432 existence, as it will get further successful deliveries added to it in this
4433 run, and it will be deleted if this function gets to its end successfully.
4434 Otherwise it might be needed again. */
4436 sprintf(CS spoolname, "%s/input/%s/%s-J", spool_directory, message_subdir, id);
4437 jread = Ufopen(spoolname, "rb");
4440 while (Ufgets(big_buffer, big_buffer_size, jread) != NULL)
4442 int n = Ustrlen(big_buffer);
4443 big_buffer[n-1] = 0;
4444 tree_add_nonrecipient(big_buffer);
4445 DEBUG(D_deliver) debug_printf("Previously delivered address %s taken from "
4446 "journal file\n", big_buffer);
4449 /* Panic-dies on error */
4450 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
4452 else if (errno != ENOENT)
4454 log_write(0, LOG_MAIN|LOG_PANIC, "attempt to open journal for reading gave: "
4455 "%s", strerror(errno));
4456 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
4459 /* A null recipients list indicates some kind of disaster. */
4461 if (recipients_list == NULL)
4463 close(deliver_datafile);
4464 deliver_datafile = -1;
4465 log_write(0, LOG_MAIN, "Spool error: no recipients for %s", spoolname);
4466 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
4470 /* Handle a message that is frozen. There are a number of different things that
4471 can happen, but in the default situation, unless forced, no delivery is
4476 #ifdef SUPPORT_MOVE_FROZEN_MESSAGES
4477 /* Moving to another directory removes the message from Exim's view. Other
4478 tools must be used to deal with it. Logging of this action happens in
4479 spool_move_message() and its subfunctions. */
4481 if (move_frozen_messages &&
4482 spool_move_message(id, message_subdir, US"", US"F"))
4483 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
4486 /* For all frozen messages (bounces or not), timeout_frozen_after sets the
4487 maximum time to keep messages that are frozen. Thaw if we reach it, with a
4488 flag causing all recipients to be failed. The time is the age of the
4489 message, not the time since freezing. */
4491 if (timeout_frozen_after > 0 && message_age >= timeout_frozen_after)
4493 log_write(0, LOG_MAIN, "cancelled by timeout_frozen_after");
4494 process_recipients = RECIP_FAIL_TIMEOUT;
4497 /* For bounce messages (and others with no sender), thaw if the error message
4498 ignore timer is exceeded. The message will be discarded if this delivery
4501 else if (sender_address[0] == 0 && message_age >= ignore_bounce_errors_after)
4503 log_write(0, LOG_MAIN, "Unfrozen by errmsg timer");
4506 /* If there's no auto thaw, or we haven't reached the auto thaw time yet, and
4507 this delivery is not forced by an admin user, do not attempt delivery of this
4508 message. Note that forced is set for continuing messages down the same
4509 channel, in order to skip load checking and ignore hold domains, but we
4510 don't want unfreezing in that case. */
4514 if ((auto_thaw <= 0 || now <= deliver_frozen_at + auto_thaw) &&
4515 (!forced || !deliver_force_thaw || !admin_user ||
4516 continue_hostname != NULL))
4518 close(deliver_datafile);
4519 deliver_datafile = -1;
4520 log_write(L_skip_delivery, LOG_MAIN, "Message is frozen");
4521 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
4524 /* If delivery was forced (by an admin user), assume a manual thaw.
4525 Otherwise it's an auto thaw. */
4529 deliver_manual_thaw = TRUE;
4530 log_write(0, LOG_MAIN, "Unfrozen by forced delivery");
4532 else log_write(0, LOG_MAIN, "Unfrozen by auto-thaw");
4535 /* We get here if any of the rules for unfreezing have triggered. */
4537 deliver_freeze = FALSE;
4538 update_spool = TRUE;
4542 /* Open the message log file if we are using them. This records details of
4543 deliveries, deferments, and failures for the benefit of the mail administrator.
4544 The log is not used by exim itself to track the progress of a message; that is
4545 done by rewriting the header spool file. */
4552 sprintf(CS spoolname, "%s/msglog/%s/%s", spool_directory, message_subdir, id);
4553 fd = open_msglog_file(spoolname, SPOOL_MODE, &error);
4557 log_write(0, LOG_MAIN|LOG_PANIC, "Couldn't %s message log %s: %s", error,
4558 spoolname, strerror(errno));
4559 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
4562 /* Make a C stream out of it. */
4564 message_log = fdopen(fd, "a");
4565 if (message_log == NULL)
4567 log_write(0, LOG_MAIN|LOG_PANIC, "Couldn't fdopen message log %s: %s",
4568 spoolname, strerror(errno));
4569 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
4574 /* If asked to give up on a message, log who did it, and set the action for all
4579 struct passwd *pw = getpwuid(real_uid);
4580 log_write(0, LOG_MAIN, "cancelled by %s", (pw != NULL)?
4581 US pw->pw_name : string_sprintf("uid %ld", (long int)real_uid));
4582 process_recipients = RECIP_FAIL;
4585 /* Otherwise, if there are too many Received: headers, fail all recipients. */
4587 else if (received_count > received_headers_max)
4588 process_recipients = RECIP_FAIL_LOOP;
4590 /* Otherwise, if a system-wide, address-independent message filter is
4591 specified, run it now, except in the case when we are failing all recipients as
4592 a result of timeout_frozen_after. If the system filter yields "delivered", then
4593 ignore the true recipients of the message. Failure of the filter file is
4594 logged, and the delivery attempt fails. */
4596 else if (system_filter != NULL && process_recipients != RECIP_FAIL_TIMEOUT)
4601 redirect_block redirect;
4603 if (system_filter_uid_set)
4605 ugid.uid = system_filter_uid;
4606 ugid.gid = system_filter_gid;
4607 ugid.uid_set = ugid.gid_set = TRUE;
4611 ugid.uid_set = ugid.gid_set = FALSE;
4614 return_path = sender_address;
4615 enable_dollar_recipients = TRUE; /* Permit $recipients in system filter */
4616 system_filtering = TRUE;
4618 /* Any error in the filter file causes a delivery to be abandoned. */
4620 redirect.string = system_filter;
4621 redirect.isfile = TRUE;
4622 redirect.check_owner = redirect.check_group = FALSE;
4623 redirect.owners = NULL;
4624 redirect.owngroups = NULL;
4626 redirect.modemask = 0;
4628 DEBUG(D_deliver|D_filter) debug_printf("running system filter\n");
4631 &redirect, /* Where the data is */
4632 RDO_DEFER | /* Turn on all the enabling options */
4633 RDO_FAIL | /* Leave off all the disabling options */
4638 NULL, /* No :include: restriction (not used in filter) */
4639 NULL, /* No sieve vacation directory (not sieve!) */
4640 &ugid, /* uid/gid data */
4641 &addr_new, /* Where to hang generated addresses */
4642 &filter_message, /* Where to put error message */
4643 NULL, /* Don't skip syntax errors */
4644 &filtertype, /* Will always be set to FILTER_EXIM for this call */
4645 US"system filter"); /* For error messages */
4647 DEBUG(D_deliver|D_filter) debug_printf("system filter returned %d\n", rc);
4649 if (rc == FF_ERROR || rc == FF_NONEXIST)
4651 close(deliver_datafile);
4652 deliver_datafile = -1;
4653 log_write(0, LOG_MAIN|LOG_PANIC, "Error in system filter: %s",
4654 string_printing(filter_message));
4655 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
4658 /* Reset things. If the filter message is an empty string, which can happen
4659 for a filter "fail" or "freeze" command with no text, reset it to NULL. */
4661 system_filtering = FALSE;
4662 enable_dollar_recipients = FALSE;
4663 if (filter_message != NULL && filter_message[0] == 0) filter_message = NULL;
4665 /* Save the values of the system filter variables so that user filters
4668 memcpy(filter_sn, filter_n, sizeof(filter_sn));
4670 /* The filter can request that delivery of the original addresses be
4675 process_recipients = RECIP_DEFER;
4676 deliver_msglog("Delivery deferred by system filter\n");
4677 log_write(0, LOG_MAIN, "Delivery deferred by system filter");
4680 /* The filter can request that a message be frozen, but this does not
4681 take place if the message has been manually thawed. In that case, we must
4682 unset "delivered", which is forced by the "freeze" command to make -bF
4685 else if (rc == FF_FREEZE && !deliver_manual_thaw)
4687 deliver_freeze = TRUE;
4688 deliver_frozen_at = time(NULL);
4689 process_recipients = RECIP_DEFER;
4690 frozen_info = string_sprintf(" by the system filter%s%s",
4691 (filter_message == NULL)? US"" : US": ",
4692 (filter_message == NULL)? US"" : filter_message);
4695 /* The filter can request that a message be failed. The error message may be
4696 quite long - it is sent back to the sender in the bounce - but we don't want
4697 to fill up the log with repetitions of it. If it starts with << then the text
4698 between << and >> is written to the log, with the rest left for the bounce
4701 else if (rc == FF_FAIL)
4703 uschar *colon = US"";
4704 uschar *logmsg = US"";
4707 process_recipients = RECIP_FAIL_FILTER;
4709 if (filter_message != NULL)
4713 if (filter_message[0] == '<' && filter_message[1] == '<' &&
4714 (logend = Ustrstr(filter_message, ">>")) != NULL)
4716 logmsg = filter_message + 2;
4717 loglen = logend - logmsg;
4718 filter_message = logend + 2;
4719 if (filter_message[0] == 0) filter_message = NULL;
4723 logmsg = filter_message;
4724 loglen = Ustrlen(filter_message);
4728 log_write(0, LOG_MAIN, "cancelled by system filter%s%.*s", colon, loglen,
4732 /* Delivery can be restricted only to those recipients (if any) that the
4733 filter specified. */
4735 else if (rc == FF_DELIVERED)
4737 process_recipients = RECIP_IGNORE;
4738 if (addr_new == NULL)
4739 log_write(0, LOG_MAIN, "=> discarded (system filter)");
4741 log_write(0, LOG_MAIN, "original recipients ignored (system filter)");
4744 /* If any new addresses were created by the filter, fake up a "parent"
4745 for them. This is necessary for pipes, etc., which are expected to have
4746 parents, and it also gives some sensible logging for others. Allow
4747 pipes, files, and autoreplies, and run them as the filter uid if set,
4748 otherwise as the current uid. */
4750 if (addr_new != NULL)
4752 int uid = (system_filter_uid_set)? system_filter_uid : geteuid();
4753 int gid = (system_filter_gid_set)? system_filter_gid : getegid();
4755 /* The text "system-filter" is tested in transport_set_up_command() and in
4756 set_up_shell_command() in the pipe transport, to enable them to permit
4757 $recipients, so don't change it here without also changing it there. */
4759 address_item *p = addr_new;
4760 address_item *parent = deliver_make_addr(US"system-filter", FALSE);
4762 parent->domain = string_copylc(qualify_domain_recipient);
4763 parent->local_part = US"system-filter";
4765 /* As part of this loop, we arrange for addr_last to end up pointing
4766 at the final address. This is used if we go on to add addresses for the
4767 original recipients. */
4771 parent->child_count++;
4774 if (testflag(p, af_pfr))
4780 setflag(p, af_uid_set |
4786 /* Find the name of the system filter's appropriate pfr transport */
4788 if (p->address[0] == '|')
4791 tpname = system_filter_pipe_transport;
4792 address_pipe = p->address;
4794 else if (p->address[0] == '>')
4797 tpname = system_filter_reply_transport;
4801 if (p->address[Ustrlen(p->address)-1] == '/')
4803 type = US"directory";
4804 tpname = system_filter_directory_transport;
4809 tpname = system_filter_file_transport;
4811 address_file = p->address;
4814 /* Now find the actual transport, first expanding the name. We have
4815 set address_file or address_pipe above. */
4819 uschar *tmp = expand_string(tpname);
4820 address_file = address_pipe = NULL;
4822 p->message = string_sprintf("failed to expand \"%s\" as a "
4823 "system filter transport name", tpname);
4828 p->message = string_sprintf("system_filter_%s_transport is unset",
4834 transport_instance *tp;
4835 for (tp = transports; tp != NULL; tp = tp->next)
4837 if (Ustrcmp(tp->name, tpname) == 0)
4844 p->message = string_sprintf("failed to find \"%s\" transport "
4845 "for system filter delivery", tpname);
4848 /* If we couldn't set up a transport, defer the delivery, putting the
4849 error on the panic log as well as the main log. */
4851 if (p->transport == NULL)
4853 address_item *badp = p;
4855 if (addr_last == NULL) addr_new = p; else addr_last->next = p;
4856 badp->local_part = badp->address; /* Needed for log line */
4857 post_process_one(badp, DEFER, LOG_MAIN|LOG_PANIC, DTYPE_ROUTER, 0);
4860 } /* End of pfr handling */
4862 /* Either a non-pfr delivery, or we found a transport */
4864 DEBUG(D_deliver|D_filter)
4865 debug_printf("system filter added %s\n", p->address);
4869 } /* Loop through all addr_new addresses */
4874 /* Scan the recipients list, and for every one that is not in the non-
4875 recipients tree, add an addr item to the chain of new addresses. If the pno
4876 value is non-negative, we must set the onetime parent from it. This which
4877 points to the relevant entry in the recipients list.
4879 This processing can be altered by the setting of the process_recipients
4880 variable, which is changed if recipients are to be ignored, failed, or
4881 deferred. This can happen as a result of system filter activity, or if the -Mg
4882 option is used to fail all of them.
4884 Duplicate addresses are handled later by a different tree structure; we can't
4885 just extend the non-recipients tree, because that will be re-written to the
4886 spool if the message is deferred, and in any case there are casing
4887 complications for local addresses. */
4889 if (process_recipients != RECIP_IGNORE)
4891 for (i = 0; i < recipients_count; i++)
4893 if (tree_search(tree_nonrecipients, recipients_list[i].address) == NULL)
4895 recipient_item *r = recipients_list + i;
4896 address_item *new = deliver_make_addr(r->address, FALSE);
4897 new->p.errors_address = r->errors_to;
4900 new->onetime_parent = recipients_list[r->pno].address;
4902 switch (process_recipients)
4904 /* RECIP_DEFER is set when a system filter freezes a message. */
4907 new->next = addr_defer;
4912 /* RECIP_FAIL_FILTER is set when a system filter has obeyed a "fail"
4915 case RECIP_FAIL_FILTER:
4917 (filter_message == NULL)? US"delivery cancelled" : filter_message;
4918 goto RECIP_QUEUE_FAILED; /* below */
4921 /* RECIP_FAIL_TIMEOUT is set when a message is frozen, but is older
4922 than the value in timeout_frozen_after. Treat non-bounce messages
4923 similarly to -Mg; for bounce messages we just want to discard, so
4924 don't put the address on the failed list. The timeout has already
4927 case RECIP_FAIL_TIMEOUT:
4928 new->message = US"delivery cancelled; message timed out";
4929 goto RECIP_QUEUE_FAILED; /* below */
4932 /* RECIP_FAIL is set when -Mg has been used. */
4935 new->message = US"delivery cancelled by administrator";
4938 /* Common code for the failure cases above. If this is not a bounce
4939 message, put the address on the failed list so that it is used to
4940 create a bounce. Otherwise do nothing - this just discards the address.
4941 The incident has already been logged. */
4944 if (sender_address[0] != 0)
4946 new->next = addr_failed;
4952 /* RECIP_FAIL_LOOP is set when there are too many Received: headers
4953 in the message. Process each address as a routing failure; if this
4954 is a bounce message, it will get frozen. */
4956 case RECIP_FAIL_LOOP:
4957 new->message = US"Too many \"Received\" headers - suspected mail loop";
4958 post_process_one(new, FAIL, LOG_MAIN, DTYPE_ROUTER, 0);
4962 /* Value should be RECIP_ACCEPT; take this as the safe default. */
4965 if (addr_new == NULL) addr_new = new; else addr_last->next = new;
4975 address_item *p = addr_new;
4976 debug_printf("Delivery address list:\n");
4979 debug_printf(" %s %s\n", p->address, (p->onetime_parent == NULL)? US"" :
4985 /* Set up the buffers used for copying over the file when delivering. */
4987 deliver_in_buffer = store_malloc(DELIVER_IN_BUFFER_SIZE);
4988 deliver_out_buffer = store_malloc(DELIVER_OUT_BUFFER_SIZE);
4992 /* Until there are no more new addresses, handle each one as follows:
4994 . If this is a generated address (indicated by the presence of a parent
4995 pointer) then check to see whether it is a pipe, file, or autoreply, and
4996 if so, handle it directly here. The router that produced the address will
4997 have set the allow flags into the address, and also set the uid/gid required.
4998 Having the routers generate new addresses and then checking them here at
4999 the outer level is tidier than making each router do the checking, and
5000 means that routers don't need access to the failed address queue.
5002 . Break up the address into local part and domain, and make lowercased
5003 versions of these strings. We also make unquoted versions of the local part.
5005 . Handle the percent hack for those domains for which it is valid.
5007 . For child addresses, determine if any of the parents have the same address.
5008 If so, generate a different string for previous delivery checking. Without
5009 this code, if the address spqr generates spqr via a forward or alias file,
5010 delivery of the generated spqr stops further attempts at the top level spqr,
5011 which is not what is wanted - it may have generated other addresses.
5013 . Check on the retry database to see if routing was previously deferred, but
5014 only if in a queue run. Addresses that are to be routed are put on the
5015 addr_route chain. Addresses that are to be deferred are put on the
5016 addr_defer chain. We do all the checking first, so as not to keep the
5017 retry database open any longer than necessary.
5019 . Now we run the addresses through the routers. A router may put the address
5020 on either the addr_local or the addr_remote chain for local or remote
5021 delivery, respectively, or put it on the addr_failed chain if it is
5022 undeliveable, or it may generate child addresses and put them on the
5023 addr_new chain, or it may defer an address. All the chain anchors are
5024 passed as arguments so that the routers can be called for verification
5027 . If new addresses have been generated by the routers, da capo.
5030 header_rewritten = FALSE; /* No headers rewritten yet */
5031 while (addr_new != NULL) /* Loop until all addresses dealt with */
5033 address_item *addr, *parent;
5034 dbm_file = dbfn_open(US"retry", O_RDONLY, &dbblock, FALSE);
5036 /* Failure to open the retry database is treated the same as if it does
5037 not exist. In both cases, dbm_file is NULL. */
5039 if (dbm_file == NULL)
5041 DEBUG(D_deliver|D_retry|D_route|D_hints_lookup)
5042 debug_printf("no retry data available\n");
5045 /* Scan the current batch of new addresses, to handle pipes, files and
5046 autoreplies, and determine which others are ready for routing. */
5048 while (addr_new != NULL)
5053 dbdata_retry *domain_retry_record;
5054 dbdata_retry *address_retry_record;
5057 addr_new = addr->next;
5059 DEBUG(D_deliver|D_retry|D_route)
5061 debug_printf(">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>\n");
5062 debug_printf("Considering: %s\n", addr->address);
5065 /* Handle generated address that is a pipe or a file or an autoreply. */
5067 if (testflag(addr, af_pfr))
5069 int offset = testflag(addr->parent, af_homonym)? 3:0;
5071 /* If two different users specify delivery to the same pipe or file or
5072 autoreply, there should be two different deliveries, so build a unique
5073 string that incorporates the original address, and use this for
5074 duplicate testing and recording delivery, and also for retrying. */
5077 string_sprintf("%s:%s", addr->address, addr->parent->unique + offset);
5079 addr->address_retry_key = addr->domain_retry_key =
5080 string_sprintf("T:%s", addr->unique);
5082 /* If a filter file specifies two deliveries to the same pipe or file,
5083 we want to de-duplicate, but this is probably not wanted for two mail
5084 commands to the same address, where probably both should be delivered.
5085 So, we have to invent a different unique string in that case. Just
5086 keep piling '>' characters on the front. */
5088 if (addr->address[0] == '>')
5090 while (tree_search(tree_duplicates, addr->unique) != NULL)
5091 addr->unique = string_sprintf(">%s", addr->unique);
5094 else if ((tnode = tree_search(tree_duplicates, addr->unique)) != NULL)
5096 DEBUG(D_deliver|D_route)
5097 debug_printf("%s is a duplicate address: discarded\n", addr->address);
5098 addr->dupof = tnode->data.ptr;
5099 addr->next = addr_duplicate;
5100 addr_duplicate = addr;
5104 DEBUG(D_deliver|D_route) debug_printf("unique = %s\n", addr->unique);
5106 /* Check for previous delivery */
5108 if (tree_search(tree_nonrecipients, addr->unique) != NULL)
5110 DEBUG(D_deliver|D_route)
5111 debug_printf("%s was previously delivered: discarded\n", addr->address);
5112 child_done(addr, tod_stamp(tod_log));
5116 /* Save for checking future duplicates */
5118 tree_add_duplicate(addr->unique, addr);
5120 /* Set local part and domain */
5122 addr->local_part = addr->address;
5123 addr->domain = addr->parent->domain;
5125 /* Ensure that the delivery is permitted. */
5127 if (testflag(addr, af_file))
5129 if (!testflag(addr, af_allow_file))
5131 addr->basic_errno = ERRNO_FORBIDFILE;
5132 addr->message = US"delivery to file forbidden";
5133 (void)post_process_one(addr, FAIL, LOG_MAIN, DTYPE_ROUTER, 0);
5134 continue; /* with the next new address */
5137 else if (addr->address[0] == '|')
5139 if (!testflag(addr, af_allow_pipe))
5141 addr->basic_errno = ERRNO_FORBIDPIPE;
5142 addr->message = US"delivery to pipe forbidden";
5143 (void)post_process_one(addr, FAIL, LOG_MAIN, DTYPE_ROUTER, 0);
5144 continue; /* with the next new address */
5147 else if (!testflag(addr, af_allow_reply))
5149 addr->basic_errno = ERRNO_FORBIDREPLY;
5150 addr->message = US"autoreply forbidden";
5151 (void)post_process_one(addr, FAIL, LOG_MAIN, DTYPE_ROUTER, 0);
5152 continue; /* with the next new address */
5155 /* If the errno field is already set to BADTRANSPORT, it indicates
5156 failure to expand a transport string, or find the associated transport,
5157 or an unset transport when one is required. Leave this test till now so
5158 that the forbid errors are given in preference. */
5160 if (addr->basic_errno == ERRNO_BADTRANSPORT)
5162 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_ROUTER, 0);
5166 /* Treat /dev/null as a special case and abandon the delivery. This
5167 avoids having to specify a uid on the transport just for this case.
5168 Arrange for the transport name to be logged as "**bypassed**". */
5170 if (Ustrcmp(addr->address, "/dev/null") == 0)
5172 uschar *save = addr->transport->name;
5173 addr->transport->name = US"**bypassed**";
5174 (void)post_process_one(addr, OK, LOG_MAIN, DTYPE_TRANSPORT, '=');
5175 addr->transport->name = save;
5176 continue; /* with the next new address */
5179 /* Pipe, file, or autoreply delivery is to go ahead as a normal local
5182 DEBUG(D_deliver|D_route)
5183 debug_printf("queued for %s transport\n", addr->transport->name);
5184 addr->next = addr_local;
5186 continue; /* with the next new address */
5189 /* Handle normal addresses. First, split up into local part and domain,
5190 handling the %-hack if necessary. There is the possibility of a defer from
5191 a lookup in percent_hack_domains. */
5193 if ((rc = deliver_split_address(addr)) == DEFER)
5195 addr->message = US"cannot check percent_hack_domains";
5196 addr->basic_errno = ERRNO_LISTDEFER;
5197 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_NONE, 0);
5201 /* Check to see if the domain is held. If so, proceed only if the
5202 delivery was forced by hand. */
5204 deliver_domain = addr->domain; /* set $domain */
5205 if (!forced && hold_domains != NULL &&
5206 (rc = match_isinlist(addr->domain, &hold_domains, 0,
5207 &domainlist_anchor, addr->domain_cache, MCL_DOMAIN, TRUE,
5212 addr->message = US"hold_domains lookup deferred";
5213 addr->basic_errno = ERRNO_LISTDEFER;
5217 addr->message = US"domain is held";
5218 addr->basic_errno = ERRNO_HELD;
5220 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_NONE, 0);
5224 /* Now we can check for duplicates and previously delivered addresses. In
5225 order to do this, we have to generate a "unique" value for each address,
5226 because there may be identical actual addresses in a line of descendents.
5227 The "unique" field is initialized to the same value as the "address" field,
5228 but gets changed here to cope with identically-named descendents. */
5230 for (parent = addr->parent; parent != NULL; parent = parent->parent)
5231 if (strcmpic(addr->address, parent->address) == 0) break;
5233 /* If there's an ancestor with the same name, set the homonym flag. This
5234 influences how deliveries are recorded. Then add a prefix on the front of
5235 the unique address. We use \n\ where n starts at 0 and increases each time.
5236 It is unlikely to pass 9, but if it does, it may look odd but will still
5237 work. This means that siblings or cousins with the same names are treated
5238 as duplicates, which is what we want. */
5242 setflag(addr, af_homonym);
5243 if (parent->unique[0] != '\\')
5244 addr->unique = string_sprintf("\\0\\%s", addr->address);
5246 addr->unique = string_sprintf("\\%c\\%s", parent->unique[1] + 1,
5250 /* Ensure that the domain in the unique field is lower cased, because
5251 domains are always handled caselessly. */
5253 p = Ustrrchr(addr->unique, '@');
5254 while (*p != 0) { *p = tolower(*p); p++; }
5256 DEBUG(D_deliver|D_route) debug_printf("unique = %s\n", addr->unique);
5258 if (tree_search(tree_nonrecipients, addr->unique) != NULL)
5260 DEBUG(D_deliver|D_route)
5261 debug_printf("%s was previously delivered: discarded\n", addr->unique);
5262 child_done(addr, tod_stamp(tod_log));
5266 /* If it's a duplicate, remember what it's a duplicate of */
5268 if ((tnode = tree_search(tree_duplicates, addr->unique)) != NULL)
5270 DEBUG(D_deliver|D_route)
5271 debug_printf("%s is a duplicate address: discarded\n", addr->unique);
5272 addr->dupof = tnode->data.ptr;
5273 addr->next = addr_duplicate;
5274 addr_duplicate = addr;
5278 /* Record this address, so subsequent duplicates get picked up. */
5280 tree_add_duplicate(addr->unique, addr);
5282 /* Get the routing retry status, saving the two retry keys (with and
5283 without the local part) for subsequent use. Ignore retry records that
5286 addr->domain_retry_key = string_sprintf("R:%s", addr->domain);
5287 addr->address_retry_key = string_sprintf("R:%s@%s", addr->local_part,
5290 if (dbm_file == NULL)
5291 domain_retry_record = address_retry_record = NULL;
5294 domain_retry_record = dbfn_read(dbm_file, addr->domain_retry_key);
5295 if (domain_retry_record != NULL &&
5296 now - domain_retry_record->time_stamp > retry_data_expire)
5297 domain_retry_record = NULL;
5299 address_retry_record = dbfn_read(dbm_file, addr->address_retry_key);
5300 if (address_retry_record != NULL &&
5301 now - address_retry_record->time_stamp > retry_data_expire)
5302 address_retry_record = NULL;
5305 DEBUG(D_deliver|D_retry)
5307 if (domain_retry_record == NULL)
5308 debug_printf("no domain retry record\n");
5309 if (address_retry_record == NULL)
5310 debug_printf("no address retry record\n");
5313 /* If we are sending a message down an existing SMTP connection, we must
5314 assume that the message which created the connection managed to route
5315 an address to that connection. We do not want to run the risk of taking
5316 a long time over routing here, because if we do, the server at the other
5317 end of the connection may time it out. This is especially true for messages
5318 with lots of addresses. For this kind of delivery, queue_running is not
5319 set, so we would normally route all addresses. We take a pragmatic approach
5320 and defer routing any addresses that have any kind of domain retry record.
5321 That is, we don't even look at their retry times. It doesn't matter if this
5322 doesn't work occasionally. This is all just an optimization, after all.
5324 The reason for not doing the same for address retries is that they normally
5325 arise from 4xx responses, not DNS timeouts. */
5327 if (continue_hostname != NULL && domain_retry_record != NULL)
5329 addr->message = US"reusing SMTP connection skips previous routing defer";
5330 addr->basic_errno = ERRNO_RRETRY;
5331 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_ROUTER, 0);
5334 /* If queue_running, defer routing unless no retry data or we've
5335 passed the next retry time, or this message is forced. However,
5336 if the retry time has expired, allow the routing attempt.
5337 If it fails again, the address will be failed. This ensures that
5338 each address is routed at least once, even after long-term routing
5341 If there is an address retry, check that too; just wait for the next
5342 retry time. This helps with the case when the temporary error on the
5343 address was really message-specific rather than address specific, since
5344 it allows other messages through. */
5346 else if (!deliver_force && queue_running &&
5347 ((domain_retry_record != NULL &&
5348 now < domain_retry_record->next_try &&
5349 !domain_retry_record->expired)
5351 (address_retry_record != NULL &&
5352 now < address_retry_record->next_try))
5355 addr->message = US"retry time not reached";
5356 addr->basic_errno = ERRNO_RRETRY;
5357 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_ROUTER, 0);
5360 /* The domain is OK for routing. Remember if retry data exists so it
5361 can be cleaned up after a successful delivery. */
5365 if (domain_retry_record != NULL || address_retry_record != NULL)
5366 setflag(addr, af_dr_retry_exists);
5367 addr->next = addr_route;
5369 DEBUG(D_deliver|D_route)
5370 debug_printf("%s: queued for routing\n", addr->address);
5374 /* The database is closed while routing is actually happening. Requests to
5375 update it are put on a chain and all processed together at the end. */
5377 if (dbm_file != NULL) dbfn_close(dbm_file);
5379 /* If queue_domains is set, we don't even want to try routing addresses in
5380 those domains. During queue runs, queue_domains is forced to be unset.
5381 Optimize by skipping this pass through the addresses if nothing is set. */
5383 if (!deliver_force && queue_domains != NULL)
5385 address_item *okaddr = NULL;
5386 while (addr_route != NULL)
5388 address_item *addr = addr_route;
5389 addr_route = addr->next;
5391 deliver_domain = addr->domain; /* set $domain */
5392 if ((rc = match_isinlist(addr->domain, &queue_domains, 0,
5393 &domainlist_anchor, addr->domain_cache, MCL_DOMAIN, TRUE, NULL))
5398 addr->basic_errno = ERRNO_LISTDEFER;
5399 addr->message = US"queue_domains lookup deferred";
5400 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_ROUTER, 0);
5404 addr->next = okaddr;
5410 addr->basic_errno = ERRNO_QUEUE_DOMAIN;
5411 addr->message = US"domain is in queue_domains";
5412 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_ROUTER, 0);
5416 addr_route = okaddr;
5419 /* Now route those addresses that are not deferred. */
5421 while (addr_route != NULL)
5424 address_item *addr = addr_route;
5425 uschar *old_domain = addr->domain;
5426 uschar *old_unique = addr->unique;
5427 addr_route = addr->next;
5430 /* Just in case some router parameter refers to it. */
5432 return_path = (addr->p.errors_address != NULL)?
5433 addr->p.errors_address : sender_address;
5435 /* If a router defers an address, add a retry item. Whether or not to
5436 use the local part in the key is a property of the router. */
5438 if ((rc = route_address(addr, &addr_local, &addr_remote, &addr_new,
5439 &addr_succeed, v_none)) == DEFER)
5440 retry_add_item(addr, (addr->router->retry_use_local_part)?
5441 string_sprintf("R:%s@%s", addr->local_part, addr->domain) :
5442 string_sprintf("R:%s", addr->domain), 0);
5444 /* Otherwise, if there is an existing retry record in the database, add
5445 retry items to delete both forms. Since the domain might have been
5446 rewritten (expanded to fully qualified) as a result of routing, ensure
5447 that the rewritten form is also deleted. */
5449 else if (testflag(addr, af_dr_retry_exists))
5451 retry_add_item(addr, addr->address_retry_key, rf_delete);
5452 retry_add_item(addr, addr->domain_retry_key, rf_delete);
5453 if (Ustrcmp(addr->domain, old_domain) != 0)
5454 retry_add_item(addr, string_sprintf("R:%s", old_domain), rf_delete);
5457 /* DISCARD is given for :blackhole: and "seen finish". The event has been
5458 logged, but we need to ensure the address (and maybe parents) is marked
5463 address_done(addr, tod_stamp(tod_log));
5464 continue; /* route next address */
5467 /* The address is finished with (failed or deferred). */
5471 (void)post_process_one(addr, rc, LOG_MAIN, DTYPE_ROUTER, 0);
5472 continue; /* route next address */
5475 /* The address has been routed. If the router changed the domain, it will
5476 also have changed the unique address. We have to test whether this address
5477 has already been delivered, because it's the unique address that finally
5480 if (addr->unique != old_unique &&
5481 tree_search(tree_nonrecipients, addr->unique) != 0)
5483 DEBUG(D_deliver|D_route) debug_printf("%s was previously delivered: "
5484 "discarded\n", addr->address);
5485 if (addr_remote == addr) addr_remote = addr->next;
5486 else if (addr_local == addr) addr_local = addr->next;
5489 /* If the router has same_domain_copy_routing set, we are permitted to copy
5490 the routing for any other addresses with the same domain. This is an
5491 optimisation to save repeated DNS lookups for "standard" remote domain
5492 routing. The option is settable only on routers that generate host lists.
5493 We play it very safe, and do the optimization only if the address is routed
5494 to a remote transport, there are no header changes, and the domain was not
5495 modified by the router. */
5497 if (addr_remote == addr &&
5498 addr->router->same_domain_copy_routing &&
5499 addr->p.extra_headers == NULL &&
5500 addr->p.remove_headers == NULL &&
5501 old_domain == addr->domain)
5503 address_item **chain = &addr_route;
5504 while (*chain != NULL)
5506 address_item *addr2 = *chain;
5507 if (Ustrcmp(addr2->domain, addr->domain) != 0)
5509 chain = &(addr2->next);
5513 /* Found a suitable address; take it off the routing list and add it to
5514 the remote delivery list. */
5516 *chain = addr2->next;
5517 addr2->next = addr_remote;
5518 addr_remote = addr2;
5520 /* Copy the routing data */
5522 addr2->domain = addr->domain;
5523 addr2->router = addr->router;
5524 addr2->transport = addr->transport;
5525 addr2->host_list = addr->host_list;
5526 addr2->fallback_hosts = addr->fallback_hosts;
5527 addr2->p.errors_address = addr->p.errors_address;
5528 copyflag(addr2, addr, af_hide_child | af_local_host_removed);
5530 DEBUG(D_deliver|D_route)
5532 debug_printf(">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>\n"
5534 "Routing for %s copied from %s\n",
5535 addr2->address, addr2->address, addr->address);
5539 } /* Continue with routing the next address. */
5540 } /* Loop to process any child addresses that the routers created, and
5541 any rerouted addresses that got put back on the new chain. */
5544 /* Debugging: show the results of the routing */
5546 DEBUG(D_deliver|D_retry|D_route)
5548 address_item *p = addr_local;
5549 debug_printf(">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>\n");
5550 debug_printf("After routing:\n Local deliveries:\n");
5553 debug_printf(" %s\n", p->address);
5558 debug_printf(" Remote deliveries:\n");
5561 debug_printf(" %s\n", p->address);
5566 debug_printf(" Failed addresses:\n");
5569 debug_printf(" %s\n", p->address);
5574 debug_printf(" Deferred addresses:\n");
5577 debug_printf(" %s\n", p->address);
5582 /* Free any resources that were cached during routing. */
5587 /* These two variables are set only during routing, after check_local_user.
5588 Ensure they are not set in transports. */
5590 local_user_gid = (gid_t)(-1);
5591 local_user_uid = (uid_t)(-1);
5593 /* When acting as an MUA wrapper, we proceed only if all addresses route to a
5594 remote transport. The check that they all end up in one transaction happens in
5595 the do_remote_deliveries() function. */
5597 if (mua_wrapper && (addr_local != NULL || addr_failed != NULL ||
5598 addr_defer != NULL))
5601 uschar *which, *colon, *msg;
5603 if (addr_local != NULL)
5608 else if (addr_defer != NULL)
5611 which = US"deferred";
5619 while (addr->parent != NULL) addr = addr->parent;
5621 if (addr->message != NULL)
5624 msg = addr->message;
5626 else colon = msg = US"";
5628 /* We don't need to log here for a forced failure as it will already
5629 have been logged. Defer will also have been logged, but as a defer, so we do
5630 need to do the failure logging. */
5632 if (addr != addr_failed)
5633 log_write(0, LOG_MAIN, "** %s routing yielded a %s delivery",
5634 addr->address, which);
5636 /* Always write an error to the caller */
5638 fprintf(stderr, "routing %s yielded a %s delivery%s%s\n", addr->address,
5641 final_yield = DELIVER_MUA_FAILED;
5642 addr_failed = addr_defer = NULL; /* So that we remove the message */
5643 goto DELIVERY_TIDYUP;
5647 /* If this is a run to continue deliveries to an external channel that is
5648 already set up, defer any local deliveries. */
5650 if (continue_transport != NULL)
5652 if (addr_defer == NULL) addr_defer = addr_local; else
5654 address_item *addr = addr_defer;
5655 while (addr->next != NULL) addr = addr->next;
5656 addr->next = addr_local;
5662 /* Because address rewriting can happen in the routers, we should not really do
5663 ANY deliveries until all addresses have been routed, so that all recipients of
5664 the message get the same headers. However, this is in practice not always
5665 possible, since sometimes remote addresses give DNS timeouts for days on end.
5666 The pragmatic approach is to deliver what we can now, saving any rewritten
5667 headers so that at least the next lot of recipients benefit from the rewriting
5668 that has already been done.
5670 If any headers have been rewritten during routing, update the spool file to
5671 remember them for all subsequent deliveries. This can be delayed till later if
5672 there is only address to be delivered - if it succeeds the spool write need not
5675 if (header_rewritten &&
5676 ((addr_local != NULL &&
5677 (addr_local->next != NULL || addr_remote != NULL)) ||
5678 (addr_remote != NULL && addr_remote->next != NULL)))
5680 /* Panic-dies on error */
5681 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
5682 header_rewritten = FALSE;
5686 /* If there are any deliveries to be done, open the journal file. This is used
5687 to record successful deliveries as soon as possible after each delivery is
5688 known to be complete. A file opened with O_APPEND is used so that several
5689 processes can run simultaneously.
5691 The journal is just insurance against crashes. When the spool file is
5692 ultimately updated at the end of processing, the journal is deleted. If a
5693 journal is found to exist at the start of delivery, the addresses listed
5694 therein are added to the non-recipients. */
5696 if (addr_local != NULL || addr_remote != NULL)
5698 sprintf(CS spoolname, "%s/input/%s/%s-J", spool_directory, message_subdir, id);
5699 journal_fd = Uopen(spoolname, O_WRONLY|O_APPEND|O_CREAT, SPOOL_MODE);
5703 log_write(0, LOG_MAIN|LOG_PANIC, "Couldn't open journal file %s: %s",
5704 spoolname, strerror(errno));
5705 return DELIVER_NOT_ATTEMPTED;
5708 /* Set the close-on-exec flag, make the file owned by Exim, and ensure
5709 that the mode is correct - the group setting doesn't always seem to get
5710 set automatically. */
5712 fcntl(journal_fd, F_SETFD, fcntl(journal_fd, F_GETFD) | FD_CLOEXEC);
5713 fchown(journal_fd, exim_uid, exim_gid);
5714 fchmod(journal_fd, SPOOL_MODE);
5718 /* Now we can get down to the business of actually doing deliveries. Local
5719 deliveries are done first, then remote ones. If ever the problems of how to
5720 handle fallback transports are figured out, this section can be put into a loop
5721 for handling fallbacks, though the uid switching will have to be revised. */
5723 if (addr_local != NULL)
5725 DEBUG(D_deliver|D_transport)
5726 debug_printf(">>>>>>>>>>>>>>>> Local deliveries >>>>>>>>>>>>>>>>\n");
5727 do_local_deliveries();
5728 disable_logging = FALSE;
5731 /* If queue_run_local is set, we do not want to attempt any remote deliveries,
5732 so just queue them all. */
5734 if (queue_run_local)
5736 while (addr_remote != NULL)
5738 address_item *addr = addr_remote;
5739 addr_remote = addr->next;
5741 addr->basic_errno = ERRNO_LOCAL_ONLY;
5742 addr->message = US"remote deliveries suppressed";
5743 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_TRANSPORT, 0);
5747 /* Handle remote deliveries */
5749 if (addr_remote != NULL)
5751 DEBUG(D_deliver|D_transport)
5752 debug_printf(">>>>>>>>>>>>>>>> Remote deliveries >>>>>>>>>>>>>>>>\n");
5754 /* Precompile some regex that are used to recognize parameters in response
5755 to an EHLO command, if they aren't already compiled. */
5757 if (regex_PIPELINING == NULL) regex_PIPELINING =
5758 regex_must_compile(US"\\n250[\\s\\-]PIPELINING(\\s|\\n|$)", FALSE, TRUE);
5760 if (regex_SIZE == NULL) regex_SIZE =
5761 regex_must_compile(US"\\n250[\\s\\-]SIZE(\\s|\\n|$)", FALSE, TRUE);
5763 if (regex_AUTH == NULL) regex_AUTH =
5764 regex_must_compile(US"\\n250[\\s\\-]AUTH\\s+([\\-\\w\\s]+)(?:\\n|$)",
5768 if (regex_STARTTLS == NULL) regex_STARTTLS =
5769 regex_must_compile(US"\\n250[\\s\\-]STARTTLS(\\s|\\n|$)", FALSE, TRUE);
5772 /* Now sort the addresses if required, and do the deliveries. The yield of
5773 do_remote_deliveries is FALSE when mua_wrapper is set and all addresses
5774 cannot be delivered in one transaction. */
5776 if (remote_sort_domains != NULL) sort_remote_deliveries();
5777 if (!do_remote_deliveries(FALSE))
5779 log_write(0, LOG_MAIN, "** mua_wrapper is set but recipients cannot all "
5780 "be delivered in one transaction");
5781 fprintf(stderr, "delivery to smarthost failed (configuration problem)\n");
5783 final_yield = DELIVER_MUA_FAILED;
5784 addr_failed = addr_defer = NULL; /* So that we remove the message */
5785 goto DELIVERY_TIDYUP;
5788 /* See if any of the addresses that failed got put on the queue for delivery
5789 to their fallback hosts. We do it this way because often the same fallback
5790 host is used for many domains, so all can be sent in a single transaction
5791 (if appropriately configured). */
5793 if (addr_fallback != NULL && !mua_wrapper)
5795 DEBUG(D_deliver) debug_printf("Delivering to fallback hosts\n");
5796 addr_remote = addr_fallback;
5797 addr_fallback = NULL;
5798 if (remote_sort_domains != NULL) sort_remote_deliveries();
5799 do_remote_deliveries(TRUE);
5801 disable_logging = FALSE;
5805 /* All deliveries are now complete. Ignore SIGTERM during this tidying up
5806 phase, to minimize cases of half-done things. */
5809 debug_printf(">>>>>>>>>>>>>>>> deliveries are done >>>>>>>>>>>>>>>>\n");
5811 /* Root privilege is no longer needed */
5813 exim_setugid(exim_uid, exim_gid, FALSE, US"post-delivery tidying");
5815 set_process_info("tidying up after delivering %s", message_id);
5816 signal(SIGTERM, SIG_IGN);
5818 /* When we are acting as an MUA wrapper, the smtp transport will either have
5819 succeeded for all addresses, or failed them all. We do not ever want to retry,
5820 nor do we want to send a bounce message. */
5824 if (addr_failed == NULL) final_yield = DELIVER_MUA_SUCCEEDED; else
5826 uschar *s = (addr_failed->user_message != NULL)?
5827 addr_failed->user_message : addr_failed->message;
5829 fprintf(stderr, "Delivery failed: ");
5830 if (addr_failed->basic_errno > 0)
5832 fprintf(stderr, "%s", strerror(addr_failed->basic_errno));
5833 if (s != NULL) fprintf(stderr, ": ");
5837 if (addr_failed->basic_errno <= 0) fprintf(stderr, "unknown error");
5839 else fprintf(stderr, "%s", CS s);
5840 fprintf(stderr, "\n");
5842 final_yield = DELIVER_MUA_FAILED;
5847 /* In a normal configuration, we now update the retry database. This is done in
5848 one fell swoop at the end in order not to keep opening and closing (and
5849 locking) the database. The code for handling retries is hived off into a
5850 separate module for convenience. We pass it the addresses of the various
5851 chains, because deferred addresses can get moved onto the failed chain if the
5852 retry cutoff time has expired for all alternative destinations. Bypass the
5853 updating of the database if the -N flag is set, which is a debugging thing that
5854 prevents actual delivery. */
5856 else if (!dont_deliver) retry_update(&addr_defer, &addr_failed, &addr_succeed);
5858 /* If any addresses failed, we must send a message to somebody, unless
5859 af_ignore_error is set, in which case no action is taken. It is possible for
5860 several messages to get sent if there are addresses with different
5863 while (addr_failed != NULL)
5867 uschar *logtod = tod_stamp(tod_log);
5869 address_item *handled_addr = NULL;
5870 address_item **paddr;
5871 address_item *msgchain = NULL;
5872 address_item **pmsgchain = &msgchain;
5874 /* There are weird cases when logging is disabled in the transport. However,
5875 there may not be a transport (address failed by a router). */
5877 disable_logging = FALSE;
5878 if (addr_failed->transport != NULL)
5879 disable_logging = addr_failed->transport->disable_logging;
5882 debug_printf("processing failed address %s\n", addr_failed->address);
5884 /* There are only two ways an address in a bounce message can get here:
5886 (1) When delivery was initially deferred, but has now timed out (in the call
5887 to retry_update() above). We can detect this by testing for
5888 af_retry_timedout. If the address does not have its own errors address,
5889 we arrange to ignore the error.
5891 (2) If delivery failures for bounce messages are being ignored. We can detect
5892 this by testing for af_ignore_error. This will also be set if a bounce
5893 message has been autothawed and the ignore_bounce_errors_after time has
5894 passed. It might also be set if a router was explicitly configured to
5895 ignore errors (errors_to = "").
5897 If neither of these cases obtains, something has gone wrong. Log the
5898 incident, but then ignore the error. */
5900 if (sender_address[0] == 0 && addr_failed->p.errors_address == NULL)
5902 if (!testflag(addr_failed, af_retry_timedout) &&
5903 !testflag(addr_failed, af_ignore_error))
5905 log_write(0, LOG_MAIN|LOG_PANIC, "internal error: bounce message "
5906 "failure is neither frozen nor ignored (it's been ignored)");
5908 setflag(addr_failed, af_ignore_error);
5911 /* If the first address on the list has af_ignore_error set, just remove
5912 it from the list, throw away any saved message file, log it, and
5913 mark the recipient done. */
5915 if (testflag(addr_failed, af_ignore_error))
5918 addr_failed = addr->next;
5919 if (addr->return_filename != NULL) Uunlink(addr->return_filename);
5921 log_write(0, LOG_MAIN, "%s%s%s%s: error ignored",
5923 (addr->parent == NULL)? US"" : US" <",
5924 (addr->parent == NULL)? US"" : addr->parent->address,
5925 (addr->parent == NULL)? US"" : US">");
5927 address_done(addr, logtod);
5928 child_done(addr, logtod);
5929 /* Panic-dies on error */
5930 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
5933 /* Otherwise, handle the sending of a message. Find the error address for
5934 the first address, then send a message that includes all failed addresses
5935 that have the same error address. Note the bounce_recipient is a global so
5936 that it can be accesssed by $bounce_recipient while creating a customized
5941 bounce_recipient = (addr_failed->p.errors_address == NULL)?
5942 sender_address : addr_failed->p.errors_address;
5944 /* Make a subprocess to send a message */
5946 pid = child_open_exim(&fd);
5948 /* Creation of child failed */
5951 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Process %d (parent %d) failed to "
5952 "create child process to send failure message: %s", getpid(),
5953 getppid(), strerror(errno));
5955 /* Creation of child succeeded */
5962 uschar *bcc, *emf_text;
5963 FILE *f = fdopen(fd, "wb");
5965 BOOL to_sender = strcmpic(sender_address, bounce_recipient) == 0;
5966 int max = (bounce_return_size_limit/DELIVER_IN_BUFFER_SIZE + 1) *
5967 DELIVER_IN_BUFFER_SIZE;
5970 debug_printf("sending error message to: %s\n", bounce_recipient);
5972 /* Scan the addresses for all that have the same errors address, removing
5973 them from the addr_failed chain, and putting them on msgchain. */
5975 paddr = &addr_failed;
5976 for (addr = addr_failed; addr != NULL; addr = *paddr)
5978 if (Ustrcmp(bounce_recipient, (addr->p.errors_address == NULL)?
5979 sender_address : addr->p.errors_address) != 0)
5981 paddr = &(addr->next); /* Not the same; skip */
5983 else /* The same - dechain */
5985 *paddr = addr->next;
5988 pmsgchain = &(addr->next);
5992 /* Include X-Failed-Recipients: for automatic interpretation, but do
5993 not let any one header line get too long. We do this by starting a
5994 new header every 50 recipients. Omit any addresses for which the
5995 "hide_child" flag is set. */
5997 for (addr = msgchain; addr != NULL; addr = addr->next)
5999 if (testflag(addr, af_hide_child)) continue;
6006 (rcount++ == 0)? "X-Failed-Recipients: " : ",\n ",
6007 (testflag(addr, af_pfr) && addr->parent != NULL)?
6008 string_printing(addr->parent->address) :
6009 string_printing(addr->address));
6011 if (rcount > 0) fprintf(f, "\n");
6013 /* Output the standard headers */
6015 if (errors_reply_to != NULL)
6016 fprintf(f, "Reply-To: %s\n", errors_reply_to);
6017 fprintf(f, "Auto-Submitted: auto-generated\n");
6018 fprintf(f, "From: Mail Delivery System <Mailer-Daemon@%s>\n",
6019 qualify_domain_sender);
6020 fprintf(f, "To: %s\n", bounce_recipient);
6022 /* Open a template file if one is provided. Log failure to open, but
6023 carry on - default texts will be used. */
6025 if (bounce_message_file != NULL)
6027 emf = Ufopen(bounce_message_file, "rb");
6029 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to open %s for error "
6030 "message texts: %s", bounce_message_file, strerror(errno));
6033 /* Quietly copy to configured additional addresses if required. */
6035 bcc = moan_check_errorcopy(bounce_recipient);
6036 if (bcc != NULL) fprintf(f, "Bcc: %s\n", bcc);
6038 /* The texts for the message can be read from a template file; if there
6039 isn't one, or if it is too short, built-in texts are used. The first
6040 emf text is a Subject: and any other headers. */
6042 emf_text = next_emf(emf, US"header");
6043 if (emf_text != NULL) fprintf(f, "%s\n", emf_text); else
6045 fprintf(f, "Subject: Mail delivery failed%s\n\n",
6046 to_sender? ": returning message to sender" : "");
6049 emf_text = next_emf(emf, US"intro");
6050 if (emf_text != NULL) fprintf(f, "%s", CS emf_text); else
6053 /* This message has been reworded several times. It seems to be confusing to
6054 somebody, however it is worded. I have retreated to the original, simple
6056 "This message was created automatically by mail delivery software.\n");
6057 if (bounce_message_text != NULL) fprintf(f, "%s", CS bounce_message_text);
6061 "\nA message that you sent could not be delivered to one or more of its\n"
6062 "recipients. This is a permanent error. The following address(es) failed:\n");
6067 "\nA message sent by\n\n <%s>\n\n"
6068 "could not be delivered to one or more of its recipients. The following\n"
6069 "address(es) failed:\n", sender_address);
6074 /* Process the addresses, leaving them on the msgchain if they have a
6075 file name for a return message. (There has already been a check in
6076 post_process_one() for the existence of data in the message file.) */
6079 for (addr = msgchain; addr != NULL; addr = *paddr)
6081 if (print_address_information(addr, f, US" ", US"\n ", US""))
6083 /* A TRUE return from print_address_information() means that the
6084 address is not hidden. If there is a return file, it has already
6085 been checked to ensure it is not empty. Omit the bland "return
6086 message generated" error, but otherwise include error information. */
6088 if (addr->return_file < 0 ||
6089 addr->message == NULL ||
6090 Ustrcmp(addr->message, "return message generated") != 0)
6093 print_address_error(addr, f);
6097 /* End the final line for the address */
6101 /* Leave on msgchain if there's a return file. */
6103 if (addr->return_file >= 0)
6105 paddr = &(addr->next);
6109 /* Else save so that we can tick off the recipient when the
6114 *paddr = addr->next;
6115 addr->next = handled_addr;
6116 handled_addr = addr;
6122 /* Get the next text, whether we need it or not, so as to be
6123 positioned for the one after. */
6125 emf_text = next_emf(emf, US"generated text");
6127 /* If there were any file messages passed by the local transports,
6128 include them in the message. Then put the address on the handled chain.
6129 In the case of a batch of addresses that were all sent to the same
6130 transport, the return_file field in all of them will contain the same
6131 fd, and the return_filename field in the *last* one will be set (to the
6132 name of the file). */
6134 if (msgchain != NULL)
6136 address_item *nextaddr;
6138 if (emf_text != NULL) fprintf(f, "%s", CS emf_text); else
6140 "The following text was generated during the delivery "
6141 "attempt%s:\n", (filecount > 1)? "s" : "");
6143 for (addr = msgchain; addr != NULL; addr = nextaddr)
6146 address_item *topaddr = addr;
6148 /* List all the addresses that relate to this file */
6151 while(addr != NULL) /* Insurance */
6153 print_address_information(addr, f, US"------ ", US"\n ",
6155 if (addr->return_filename != NULL) break;
6160 /* Now copy the file */
6162 fm = Ufopen(addr->return_filename, "rb");
6165 fprintf(f, " +++ Exim error... failed to open text file: %s\n",
6169 while ((ch = fgetc(fm)) != EOF) fputc(ch, f);
6172 Uunlink(addr->return_filename);
6174 /* Can now add to handled chain, first fishing off the next
6175 address on the msgchain. */
6177 nextaddr = addr->next;
6178 addr->next = handled_addr;
6179 handled_addr = topaddr;
6184 /* Now copy the message, trying to give an intelligible comment if
6185 it is too long for it all to be copied. The limit isn't strictly
6186 applied because of the buffering. There is, however, an option
6187 to suppress copying altogether. */
6189 emf_text = next_emf(emf, US"copy");
6191 if (bounce_return_message)
6193 int topt = topt_add_return_path;
6194 if (!bounce_return_body) topt |= topt_no_body;
6196 if (emf_text != NULL) fprintf(f, "%s", CS emf_text); else
6198 if (bounce_return_body) fprintf(f,
6199 "------ This is a copy of the message, including all the headers. ------\n");
6201 "------ This is a copy of the message's headers. ------\n");
6204 /* While reading the "truncated" message, set return_size_limit to
6205 the actual max testing value, rounded. We need to read the message
6206 whether we are going to use it or not. */
6209 int temp = bounce_return_size_limit;
6210 bounce_return_size_limit = (max/1000)*1000;
6211 emf_text = next_emf(emf, US"truncated");
6212 bounce_return_size_limit = temp;
6215 if (bounce_return_body && bounce_return_size_limit > 0)
6217 struct stat statbuf;
6218 if (fstat(deliver_datafile, &statbuf) == 0 && statbuf.st_size > max)
6220 if (emf_text != NULL) fprintf(f, "%s", CS emf_text); else
6223 "------ The body of the message is %d characters long; only the first\n"
6224 "------ %d or so are included here.\n", (int)statbuf.st_size, max);
6231 transport_filter_argv = NULL; /* Just in case */
6232 return_path = sender_address; /* In case not previously set */
6233 transport_write_message(NULL, fileno(f), topt,
6234 bounce_return_size_limit, NULL, NULL, NULL, NULL, NULL, 0);
6237 /* Write final text and close the template file if one is open */
6241 emf_text = next_emf(emf, US"final");
6242 if (emf_text != NULL) fprintf(f, "%s", CS emf_text);
6246 /* Close the file, which should send an EOF to the child process
6247 that is receiving the message. Wait for it to finish. */
6250 rc = child_close(pid, 0); /* Waits for child to close, no timeout */
6252 /* In the test harness, let the child do it's thing first. */
6254 if (running_in_test_harness) millisleep(500);
6256 /* If the process failed, there was some disaster in setting up the
6257 error message. Unless the message is very old, ensure that addr_defer
6258 is non-null, which will have the effect of leaving the message on the
6259 spool. The failed addresses will get tried again next time. However, we
6260 don't really want this to happen too often, so freeze the message unless
6261 there are some genuine deferred addresses to try. To do this we have
6262 to call spool_write_header() here, because with no genuine deferred
6263 addresses the normal code below doesn't get run. */
6268 if (now - received_time < retry_maximum_timeout && addr_defer == NULL)
6270 addr_defer = (address_item *)(+1);
6271 deliver_freeze = TRUE;
6272 deliver_frozen_at = time(NULL);
6273 /* Panic-dies on error */
6274 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
6277 deliver_msglog("Process failed (%d) when writing error message "
6278 "to %s%s", rc, bounce_recipient, s);
6279 log_write(0, LOG_MAIN, "Process failed (%d) when writing error message "
6280 "to %s%s", rc, bounce_recipient, s);
6283 /* The message succeeded. Ensure that the recipients that failed are
6284 now marked finished with on the spool and their parents updated. */
6288 for (addr = handled_addr; addr != NULL; addr = addr->next)
6290 address_done(addr, logtod);
6291 child_done(addr, logtod);
6293 /* Panic-dies on error */
6294 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
6300 disable_logging = FALSE; /* In case left set */
6302 /* Come here from the mua_wrapper case if routing goes wrong */
6306 /* If there are now no deferred addresses, we are done. Preserve the
6307 message log if so configured, and we are using them. Otherwise, sling it.
6308 Then delete the message itself. */
6310 if (addr_defer == NULL)
6314 sprintf(CS spoolname, "%s/msglog/%s/%s", spool_directory, message_subdir,
6316 if (preserve_message_logs)
6319 sprintf(CS big_buffer, "%s/msglog.OLD/%s", spool_directory, id);
6320 if ((rc = Urename(spoolname, big_buffer)) < 0)
6322 (void)directory_make(spool_directory, US"msglog.OLD",
6323 MSGLOG_DIRECTORY_MODE, TRUE);
6324 rc = Urename(spoolname, big_buffer);
6327 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to move %s to the "
6328 "msglog.OLD directory", spoolname);
6332 if (Uunlink(spoolname) < 0)
6333 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s", spoolname);
6337 /* Remove the two message files. */
6339 sprintf(CS spoolname, "%s/input/%s/%s-D", spool_directory, message_subdir, id);
6340 if (Uunlink(spoolname) < 0)
6341 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s", spoolname);
6342 sprintf(CS spoolname, "%s/input/%s/%s-H", spool_directory, message_subdir, id);
6343 if (Uunlink(spoolname) < 0)
6344 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s", spoolname);
6346 /* Log the end of this message, with queue time if requested. */
6348 if ((log_extra_selector & LX_queue_time_overall) != 0)
6349 log_write(0, LOG_MAIN, "Completed QT=%s",
6350 readconf_printtime(time(NULL) - received_time));
6352 log_write(0, LOG_MAIN, "Completed");
6355 /* If there are deferred addresses, we are keeping this message because it is
6356 not yet completed. Lose any temporary files that were catching output from
6357 pipes for any of the deferred addresses, handle one-time aliases, and see if
6358 the message has been on the queue for so long that it is time to send a warning
6359 message to the sender, unless it is a mailer-daemon. If all deferred addresses
6360 have the same domain, we can set deliver_domain for the expansion of
6361 delay_warning_ condition - if any of them are pipes, files, or autoreplies, use
6362 the parent's domain.
6364 If all the deferred addresses have an error number that indicates "retry time
6365 not reached", skip sending the warning message, because it won't contain the
6366 reason for the delay. It will get sent at the next real delivery attempt.
6367 However, if at least one address has tried, we'd better include all of them in
6370 If we can't make a process to send the message, don't worry.
6372 For mailing list expansions we want to send the warning message to the
6373 mailing list manager. We can't do a perfect job here, as some addresses may
6374 have different errors addresses, but if we take the errors address from
6375 each deferred address it will probably be right in most cases.
6377 If addr_defer == +1, it means there was a problem sending an error message
6378 for failed addresses, and there were no "real" deferred addresses. The value
6379 was set just to keep the message on the spool, so there is nothing to do here.
6382 else if (addr_defer != (address_item *)(+1))
6385 uschar *recipients = US"";
6386 BOOL delivery_attempted = FALSE;
6388 deliver_domain = testflag(addr_defer, af_pfr)?
6389 addr_defer->parent->domain : addr_defer->domain;
6391 for (addr = addr_defer; addr != NULL; addr = addr->next)
6393 address_item *otaddr;
6395 if (addr->basic_errno > ERRNO_RETRY_BASE) delivery_attempted = TRUE;
6397 if (deliver_domain != NULL)
6399 uschar *d = (testflag(addr, af_pfr))? addr->parent->domain : addr->domain;
6401 /* The domain may be unset for an address that has never been routed
6402 because the system filter froze the message. */
6404 if (d == NULL || Ustrcmp(d, deliver_domain) != 0) deliver_domain = NULL;
6407 if (addr->return_filename != NULL) Uunlink(addr->return_filename);
6409 /* Handle the case of one-time aliases. If any address in the ancestry
6410 of this one is flagged, ensure it is in the recipients list, suitably
6411 flagged, and that its parent is marked delivered. */
6413 for (otaddr = addr; otaddr != NULL; otaddr = otaddr->parent)
6414 if (otaddr->onetime_parent != NULL) break;
6419 int t = recipients_count;
6421 for (i = 0; i < recipients_count; i++)
6423 uschar *r = recipients_list[i].address;
6424 if (Ustrcmp(otaddr->onetime_parent, r) == 0) t = i;
6425 if (Ustrcmp(otaddr->address, r) == 0) break;
6428 /* Didn't find the address already in the list, and did find the
6429 ultimate parent's address in the list. After adding the recipient,
6430 update the errors address in the recipients list. */
6432 if (i >= recipients_count && t < recipients_count)
6434 DEBUG(D_deliver) debug_printf("one_time: adding %s in place of %s\n",
6435 otaddr->address, otaddr->parent->address);
6436 receive_add_recipient(otaddr->address, t);
6437 recipients_list[recipients_count-1].errors_to = otaddr->p.errors_address;
6438 tree_add_nonrecipient(otaddr->parent->address);
6439 update_spool = TRUE;
6443 /* Except for error messages, ensure that either the errors address for
6444 this deferred address or, if there is none, the sender address, is on the
6445 list of recipients for a warning message. */
6447 if (sender_address[0] != 0)
6449 if (addr->p.errors_address == NULL)
6451 if (Ustrstr(recipients, sender_address) == NULL)
6452 recipients = string_sprintf("%s%s%s", recipients,
6453 (recipients[0] == 0)? "" : ",", sender_address);
6457 if (Ustrstr(recipients, addr->p.errors_address) == NULL)
6458 recipients = string_sprintf("%s%s%s", recipients,
6459 (recipients[0] == 0)? "" : ",", addr->p.errors_address);
6464 /* Send a warning message if the conditions are right. If the condition check
6465 fails because of a lookup defer, there is nothing we can do. The warning
6466 is not sent. Another attempt will be made at the next delivery attempt (if
6469 if (!queue_2stage && delivery_attempted &&
6470 delay_warning[1] > 0 && sender_address[0] != 0 &&
6471 (delay_warning_condition == NULL ||
6472 expand_check_condition(delay_warning_condition,
6473 US"delay_warning", US"option")))
6477 int queue_time = time(NULL) - received_time;
6479 /* When running in the test harness, there's an option that allows us to
6480 fudge this time so as to get repeatability of the tests. Take the first
6481 time off the list. In queue runs, the list pointer gets updated in the
6484 if (running_in_test_harness && fudged_queue_times[0] != 0)
6486 int qt = readconf_readtime(fudged_queue_times, '/', FALSE);
6489 DEBUG(D_deliver) debug_printf("fudged queue_times = %s\n",
6490 fudged_queue_times);
6495 /* See how many warnings we should have sent by now */
6497 for (count = 0; count < delay_warning[1]; count++)
6498 if (queue_time < delay_warning[count+2]) break;
6500 show_time = delay_warning[count+1];
6502 if (count >= delay_warning[1])
6505 int last_gap = show_time;
6506 if (count > 1) last_gap -= delay_warning[count];
6507 extra = (queue_time - delay_warning[count+1])/last_gap;
6508 show_time += last_gap * extra;
6514 debug_printf("time on queue = %s\n", readconf_printtime(queue_time));
6515 debug_printf("warning counts: required %d done %d\n", count,
6519 /* We have computed the number of warnings there should have been by now.
6520 If there haven't been enough, send one, and up the count to what it should
6523 if (warning_count < count)
6527 pid_t pid = child_open_exim(&fd);
6533 FILE *f = fdopen(fd, "wb");
6535 if (warn_message_file != NULL)
6537 wmf = Ufopen(warn_message_file, "rb");
6539 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to open %s for warning "
6540 "message texts: %s", warn_message_file, strerror(errno));
6543 warnmsg_recipients = recipients;
6544 warnmsg_delay = (queue_time < 120*60)?
6545 string_sprintf("%d minutes", show_time/60):
6546 string_sprintf("%d hours", show_time/3600);
6548 if (errors_reply_to != NULL)
6549 fprintf(f, "Reply-To: %s\n", errors_reply_to);
6550 fprintf(f, "Auto-Submitted: auto-generated\n");
6551 fprintf(f, "From: Mail Delivery System <Mailer-Daemon@%s>\n",
6552 qualify_domain_sender);
6553 fprintf(f, "To: %s\n", recipients);
6555 wmf_text = next_emf(wmf, US"header");
6556 if (wmf_text != NULL)
6557 fprintf(f, "%s\n", wmf_text);
6559 fprintf(f, "Subject: Warning: message %s delayed %s\n\n",
6560 message_id, warnmsg_delay);
6562 wmf_text = next_emf(wmf, US"intro");
6563 if (wmf_text != NULL) fprintf(f, "%s", CS wmf_text); else
6566 "This message was created automatically by mail delivery software.\n");
6568 if (Ustrcmp(recipients, sender_address) == 0)
6570 "A message that you sent has not yet been delivered to one or more of its\n"
6571 "recipients after more than ");
6574 "A message sent by\n\n <%s>\n\n"
6575 "has not yet been delivered to one or more of its recipients after more than \n",
6578 fprintf(f, "%s on the queue on %s.\n\n", warnmsg_delay,
6580 fprintf(f, "The message identifier is: %s\n", message_id);
6582 for (h = header_list; h != NULL; h = h->next)
6584 if (strncmpic(h->text, US"Subject:", 8) == 0)
6585 fprintf(f, "The subject of the message is: %s", h->text + 9);
6586 else if (strncmpic(h->text, US"Date:", 5) == 0)
6587 fprintf(f, "The date of the message is: %s", h->text + 6);
6591 fprintf(f, "The address%s to which the message has not yet been "
6593 (addr_defer->next == NULL)? "" : "es",
6594 (addr_defer->next == NULL)? "is": "are");
6597 /* List the addresses. For any that are hidden, don't give the delay
6598 reason, because it might expose that which is hidden. Also, do not give
6599 "retry time not reached" because that isn't helpful. */
6602 while (addr_defer != NULL)
6604 address_item *addr = addr_defer;
6605 addr_defer = addr->next;
6606 if (print_address_information(addr, f, US" ", US"\n ", US"") &&
6607 addr->basic_errno > ERRNO_RETRY_BASE)
6609 fprintf(f, "\n Delay reason: ");
6610 print_address_error(addr, f);
6620 wmf_text = next_emf(wmf, US"final");
6621 if (wmf_text != NULL) fprintf(f, "%s", CS wmf_text);
6627 "No action is required on your part. Delivery attempts will continue for\n"
6628 "some time, and this warning may be repeated at intervals if the message\n"
6629 "remains undelivered. Eventually the mail delivery software will give up,\n"
6630 "and when that happens, the message will be returned to you.\n");
6633 /* Close and wait for child process to complete, without a timeout.
6634 If there's an error, don't update the count. */
6637 if (child_close(pid, 0) == 0)
6639 warning_count = count;
6640 update_spool = TRUE; /* Ensure spool rewritten */
6646 /* Clear deliver_domain */
6648 deliver_domain = NULL;
6650 /* If this was a first delivery attempt, unset the first time flag, and
6651 ensure that the spool gets updated. */
6653 if (deliver_firsttime)
6655 deliver_firsttime = FALSE;
6656 update_spool = TRUE;
6659 /* If delivery was frozen and freeze_tell is set, generate an appropriate
6660 message, unless the message is a local error message (to avoid loops). Then
6661 log the freezing. If the text in "frozen_info" came from a system filter,
6662 it has been escaped into printing characters so as not to mess up log lines.
6663 For the "tell" message, we turn \n back into newline. Also, insert a newline
6664 near the start instead of the ": " string. */
6668 if (freeze_tell != NULL && freeze_tell[0] != 0 && !local_error_message)
6670 uschar *s = string_copy(frozen_info);
6671 uschar *ss = Ustrstr(s, " by the system filter: ");
6682 if (*ss == '\\' && ss[1] == 'n')
6689 moan_tell_someone(freeze_tell, addr_defer, US"Message frozen",
6690 "Message %s has been frozen%s.\nThe sender is <%s>.\n", message_id,
6694 /* Log freezing just before we update the -H file, to minimize the chance
6695 of a race problem. */
6697 deliver_msglog("*** Frozen%s\n", frozen_info);
6698 log_write(0, LOG_MAIN, "Frozen%s", frozen_info);
6701 /* If there have been any updates to the non-recipients list, or other things
6702 that get written to the spool, we must now update the spool header file so
6703 that it has the right information for the next delivery attempt. If there
6704 was more than one address being delivered, the header_change update is done
6705 earlier, in case one succeeds and then something crashes. */
6708 debug_printf("delivery deferred: update_spool=%d header_rewritten=%d\n",
6709 update_spool, header_rewritten);
6711 if (update_spool || header_rewritten)
6712 /* Panic-dies on error */
6713 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
6716 /* Finished with the message log. If the message is complete, it will have
6717 been unlinked or renamed above. */
6719 if (message_logs) fclose(message_log);
6721 /* Now we can close and remove the journal file. Its only purpose is to record
6722 successfully completed deliveries asap so that this information doesn't get
6723 lost if Exim (or the machine) crashes. Forgetting about a failed delivery is
6724 not serious, as trying it again is not harmful. The journal might not be open
6725 if all addresses were deferred at routing or directing. Nevertheless, we must
6726 remove it if it exists (may have been lying around from a crash during the
6727 previous delivery attempt). We don't remove the journal if a delivery
6728 subprocess failed to pass back delivery information; this is controlled by
6729 the remove_journal flag. When the journal is left, we also don't move the
6730 message off the main spool if frozen and the option is set. It should get moved
6731 at the next attempt, after the journal has been inspected. */
6733 if (journal_fd >= 0) close(journal_fd);
6737 sprintf(CS spoolname, "%s/input/%s/%s-J", spool_directory, message_subdir, id);
6738 if (Uunlink(spoolname) < 0 && errno != ENOENT)
6739 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s", spoolname,
6742 /* Move the message off the spool if reqested */
6744 #ifdef SUPPORT_MOVE_FROZEN_MESSAGES
6745 if (deliver_freeze && move_frozen_messages)
6746 (void)spool_move_message(id, message_subdir, US"", US"F");
6750 /* Closing the data file frees the lock; if the file has been unlinked it
6751 will go away. Otherwise the message becomes available for another process
6754 close(deliver_datafile);
6755 deliver_datafile = -1;
6756 DEBUG(D_deliver) debug_printf("end delivery of %s\n", id);
6758 /* It is unlikely that there will be any cached resources, since they are
6759 released after routing, and in the delivery subprocesses. However, it's
6760 possible for an expansion for something afterwards (for example,
6761 expand_check_condition) to do a lookup. We must therefore be sure everything is
6768 /* End of deliver.c */