1 /* $Cambridge: exim/src/src/deliver.c,v 1.44 2007/02/06 14:19:00 ph10 Exp $ */
3 /*************************************************
4 * Exim - an Internet mail transport agent *
5 *************************************************/
7 /* Copyright (c) University of Cambridge 1995 - 2007 */
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. It is possible to
232 have multiple pipe and file addresses, but only when all addresses have routed
233 to the same pipe or file. */
238 if (testflag(addr, af_pfr))
240 if (testflag(addr, af_file)) address_file = addr->local_part;
241 else if (addr->local_part[0] == '|') address_pipe = addr->local_part;
243 for (addr2 = addr->next; addr2 != NULL; addr2 = addr2->next)
245 if (deliver_domain != NULL &&
246 Ustrcmp(deliver_domain, addr2->domain) != 0)
247 deliver_domain = NULL;
248 if (self_hostname != NULL && (addr2->self_hostname == NULL ||
249 Ustrcmp(self_hostname, addr2->self_hostname) != 0))
250 self_hostname = NULL;
251 if (deliver_domain == NULL && self_hostname == NULL) break;
259 /*************************************************
260 * Open a msglog file *
261 *************************************************/
263 /* This function is used both for normal message logs, and for files in the
264 msglog directory that are used to catch output from pipes. Try to create the
265 directory if it does not exist. From release 4.21, normal message logs should
266 be created when the message is received.
269 filename the file name
270 mode the mode required
271 error used for saying what failed
273 Returns: a file descriptor, or -1 (with errno set)
277 open_msglog_file(uschar *filename, int mode, uschar **error)
279 int fd = Uopen(filename, O_WRONLY|O_APPEND|O_CREAT, mode);
281 if (fd < 0 && errno == ENOENT)
284 sprintf(CS temp, "msglog/%s", message_subdir);
285 if (message_subdir[0] == 0) temp[6] = 0;
286 (void)directory_make(spool_directory, temp, MSGLOG_DIRECTORY_MODE, TRUE);
287 fd = Uopen(filename, O_WRONLY|O_APPEND|O_CREAT, mode);
290 /* Set the close-on-exec flag and change the owner to the exim uid/gid (this
291 function is called as root). Double check the mode, because the group setting
292 doesn't always get set automatically. */
296 (void)fcntl(fd, F_SETFD, fcntl(fd, F_GETFD) | FD_CLOEXEC);
297 if (fchown(fd, exim_uid, exim_gid) < 0)
302 if (fchmod(fd, mode) < 0)
308 else *error = US"create";
316 /*************************************************
317 * Write to msglog if required *
318 *************************************************/
320 /* Write to the message log, if configured. This function may also be called
324 format a string format
330 deliver_msglog(const char *format, ...)
333 if (!message_logs) return;
334 va_start(ap, format);
335 vfprintf(message_log, format, ap);
343 /*************************************************
344 * Replicate status for batch *
345 *************************************************/
347 /* When a transport handles a batch of addresses, it may treat them
348 individually, or it may just put the status in the first one, and return FALSE,
349 requesting that the status be copied to all the others externally. This is the
350 replication function. As well as the status, it copies the transport pointer,
351 which may have changed if appendfile passed the addresses on to a different
354 Argument: pointer to the first address in a chain
359 replicate_status(address_item *addr)
362 for (addr2 = addr->next; addr2 != NULL; addr2 = addr2->next)
364 addr2->transport = addr->transport;
365 addr2->transport_return = addr->transport_return;
366 addr2->basic_errno = addr->basic_errno;
367 addr2->more_errno = addr->more_errno;
368 addr2->special_action = addr->special_action;
369 addr2->message = addr->message;
370 addr2->user_message = addr->user_message;
376 /*************************************************
377 * Compare lists of hosts *
378 *************************************************/
380 /* This function is given two pointers to chains of host items, and it yields
381 TRUE if the lists refer to the same hosts in the same order, except that
383 (1) Multiple hosts with the same non-negative MX values are permitted to appear
384 in different orders. Round-robinning nameservers can cause this to happen.
386 (2) Multiple hosts with the same negative MX values less than MX_NONE are also
387 permitted to appear in different orders. This is caused by randomizing
390 This enables Exim to use a single SMTP transaction for sending to two entirely
391 different domains that happen to end up pointing at the same hosts.
394 one points to the first host list
395 two points to the second host list
397 Returns: TRUE if the lists refer to the same host set
401 same_hosts(host_item *one, host_item *two)
403 while (one != NULL && two != NULL)
405 if (Ustrcmp(one->name, two->name) != 0)
408 host_item *end_one = one;
409 host_item *end_two = two;
411 /* Batch up only if there was no MX and the list was not randomized */
413 if (mx == MX_NONE) return FALSE;
415 /* Find the ends of the shortest sequence of identical MX values */
417 while (end_one->next != NULL && end_one->next->mx == mx &&
418 end_two->next != NULL && end_two->next->mx == mx)
420 end_one = end_one->next;
421 end_two = end_two->next;
424 /* If there aren't any duplicates, there's no match. */
426 if (end_one == one) return FALSE;
428 /* For each host in the 'one' sequence, check that it appears in the 'two'
429 sequence, returning FALSE if not. */
434 for (hi = two; hi != end_two->next; hi = hi->next)
435 if (Ustrcmp(one->name, hi->name) == 0) break;
436 if (hi == end_two->next) return FALSE;
437 if (one == end_one) break;
441 /* All the hosts in the 'one' sequence were found in the 'two' sequence.
442 Ensure both are pointing at the last host, and carry on as for equality. */
453 /* True if both are NULL */
460 /*************************************************
461 * Compare header lines *
462 *************************************************/
464 /* This function is given two pointers to chains of header items, and it yields
465 TRUE if they are the same header texts in the same order.
468 one points to the first header list
469 two points to the second header list
471 Returns: TRUE if the lists refer to the same header set
475 same_headers(header_line *one, header_line *two)
479 if (one == two) return TRUE; /* Includes the case where both NULL */
480 if (one == NULL || two == NULL) return FALSE;
481 if (Ustrcmp(one->text, two->text) != 0) return FALSE;
489 /*************************************************
490 * Compare string settings *
491 *************************************************/
493 /* This function is given two pointers to strings, and it returns
494 TRUE if they are the same pointer, or if the two strings are the same.
497 one points to the first string
498 two points to the second string
500 Returns: TRUE or FALSE
504 same_strings(uschar *one, uschar *two)
506 if (one == two) return TRUE; /* Includes the case where both NULL */
507 if (one == NULL || two == NULL) return FALSE;
508 return (Ustrcmp(one, two) == 0);
513 /*************************************************
514 * Compare uid/gid for addresses *
515 *************************************************/
517 /* This function is given a transport and two addresses. It yields TRUE if the
518 uid/gid/initgroups settings for the two addresses are going to be the same when
523 addr1 the first address
524 addr2 the second address
526 Returns: TRUE or FALSE
530 same_ugid(transport_instance *tp, address_item *addr1, address_item *addr2)
532 if (!tp->uid_set && tp->expand_uid == NULL && !tp->deliver_as_creator)
534 if (testflag(addr1, af_uid_set) != testflag(addr2, af_gid_set) ||
535 (testflag(addr1, af_uid_set) &&
536 (addr1->uid != addr2->uid ||
537 testflag(addr1, af_initgroups) != testflag(addr2, af_initgroups))))
541 if (!tp->gid_set && tp->expand_gid == NULL)
543 if (testflag(addr1, af_gid_set) != testflag(addr2, af_gid_set) ||
544 (testflag(addr1, af_gid_set) && addr1->gid != addr2->gid))
554 /*************************************************
555 * Record that an address is complete *
556 *************************************************/
558 /* This function records that an address is complete. This is straightforward
559 for most addresses, where the unique address is just the full address with the
560 domain lower cased. For homonyms (addresses that are the same as one of their
561 ancestors) their are complications. Their unique addresses have \x\ prepended
562 (where x = 0, 1, 2...), so that de-duplication works correctly for siblings and
565 Exim used to record the unique addresses of homonyms as "complete". This,
566 however, fails when the pattern of redirection varies over time (e.g. if taking
567 unseen copies at only some times of day) because the prepended numbers may vary
568 from one delivery run to the next. This problem is solved by never recording
569 prepended unique addresses as complete. Instead, when a homonymic address has
570 actually been delivered via a transport, we record its basic unique address
571 followed by the name of the transport. This is checked in subsequent delivery
572 runs whenever an address is routed to a transport.
574 If the completed address is a top-level one (has no parent, which means it
575 cannot be homonymic) we also add the original address to the non-recipients
576 tree, so that it gets recorded in the spool file and therefore appears as
577 "done" in any spool listings. The original address may differ from the unique
578 address in the case of the domain.
580 Finally, this function scans the list of duplicates, marks as done any that
581 match this address, and calls child_done() for their ancestors.
584 addr address item that has been completed
585 now current time as a string
591 address_done(address_item *addr, uschar *now)
595 update_spool = TRUE; /* Ensure spool gets updated */
597 /* Top-level address */
599 if (addr->parent == NULL)
601 tree_add_nonrecipient(addr->unique);
602 tree_add_nonrecipient(addr->address);
605 /* Homonymous child address */
607 else if (testflag(addr, af_homonym))
609 if (addr->transport != NULL)
611 tree_add_nonrecipient(
612 string_sprintf("%s/%s", addr->unique + 3, addr->transport->name));
616 /* Non-homonymous child address */
618 else tree_add_nonrecipient(addr->unique);
620 /* Check the list of duplicate addresses and ensure they are now marked
623 for (dup = addr_duplicate; dup != NULL; dup = dup->next)
625 if (Ustrcmp(addr->unique, dup->unique) == 0)
627 tree_add_nonrecipient(dup->address);
628 child_done(dup, now);
636 /*************************************************
637 * Decrease counts in parents and mark done *
638 *************************************************/
640 /* This function is called when an address is complete. If there is a parent
641 address, its count of children is decremented. If there are still other
642 children outstanding, the function exits. Otherwise, if the count has become
643 zero, address_done() is called to mark the parent and its duplicates complete.
644 Then loop for any earlier ancestors.
647 addr points to the completed address item
648 now the current time as a string, for writing to the message log
654 child_done(address_item *addr, uschar *now)
657 while (addr->parent != NULL)
660 if ((addr->child_count -= 1) > 0) return; /* Incomplete parent */
661 address_done(addr, now);
663 /* Log the completion of all descendents only when there is no ancestor with
664 the same original address. */
666 for (aa = addr->parent; aa != NULL; aa = aa->parent)
667 if (Ustrcmp(aa->address, addr->address) == 0) break;
668 if (aa != NULL) continue;
670 deliver_msglog("%s %s: children all complete\n", now, addr->address);
671 DEBUG(D_deliver) debug_printf("%s: children all complete\n", addr->address);
678 /*************************************************
679 * Actions at the end of handling an address *
680 *************************************************/
682 /* This is a function for processing a single address when all that can be done
683 with it has been done.
686 addr points to the address block
687 result the result of the delivery attempt
688 logflags flags for log_write() (LOG_MAIN and/or LOG_PANIC)
689 driver_type indicates which type of driver (transport, or router) was last
690 to process the address
691 logchar '=' or '-' for use when logging deliveries with => or ->
697 post_process_one(address_item *addr, int result, int logflags, int driver_type,
700 uschar *now = tod_stamp(tod_log);
701 uschar *driver_kind = NULL;
702 uschar *driver_name = NULL;
705 int size = 256; /* Used for a temporary, */
706 int ptr = 0; /* expanding buffer, for */
707 uschar *s; /* building log lines; */
708 void *reset_point; /* released afterwards. */
711 DEBUG(D_deliver) debug_printf("post-process %s (%d)\n", addr->address, result);
713 /* Set up driver kind and name for logging. Disable logging if the router or
714 transport has disabled it. */
716 if (driver_type == DTYPE_TRANSPORT)
718 if (addr->transport != NULL)
720 driver_name = addr->transport->name;
721 driver_kind = US" transport";
722 disable_logging = addr->transport->disable_logging;
724 else driver_kind = US"transporting";
726 else if (driver_type == DTYPE_ROUTER)
728 if (addr->router != NULL)
730 driver_name = addr->router->name;
731 driver_kind = US" router";
732 disable_logging = addr->router->disable_logging;
734 else driver_kind = US"routing";
737 /* If there's an error message set, ensure that it contains only printing
738 characters - it should, but occasionally things slip in and this at least
739 stops the log format from getting wrecked. We also scan the message for an LDAP
740 expansion item that has a password setting, and flatten the password. This is a
741 fudge, but I don't know a cleaner way of doing this. (If the item is badly
742 malformed, it won't ever have gone near LDAP.) */
744 if (addr->message != NULL)
746 addr->message = string_printing(addr->message);
747 if (Ustrstr(addr->message, "failed to expand") != NULL &&
748 (Ustrstr(addr->message, "ldap:") != NULL ||
749 Ustrstr(addr->message, "ldapdn:") != NULL ||
750 Ustrstr(addr->message, "ldapm:") != NULL))
752 uschar *p = Ustrstr(addr->message, "pass=");
756 while (*p != 0 && !isspace(*p)) *p++ = 'x';
761 /* If we used a transport that has one of the "return_output" options set, and
762 if it did in fact generate some output, then for return_output we treat the
763 message as failed if it was not already set that way, so that the output gets
764 returned to the sender, provided there is a sender to send it to. For
765 return_fail_output, do this only if the delivery failed. Otherwise we just
766 unlink the file, and remove the name so that if the delivery failed, we don't
767 try to send back an empty or unwanted file. The log_output options operate only
770 In any case, we close the message file, because we cannot afford to leave a
771 file-descriptor for one address while processing (maybe very many) others. */
773 if (addr->return_file >= 0 && addr->return_filename != NULL)
775 BOOL return_output = FALSE;
777 (void)EXIMfsync(addr->return_file);
779 /* If there is no output, do nothing. */
781 if (fstat(addr->return_file, &statbuf) == 0 && statbuf.st_size > 0)
783 transport_instance *tb = addr->transport;
785 /* Handle logging options */
787 if (tb->log_output || (result == FAIL && tb->log_fail_output) ||
788 (result == DEFER && tb->log_defer_output))
791 FILE *f = Ufopen(addr->return_filename, "rb");
793 log_write(0, LOG_MAIN|LOG_PANIC, "failed to open %s to log output "
794 "from %s transport: %s", addr->return_filename, tb->name,
798 s = US Ufgets(big_buffer, big_buffer_size, f);
801 uschar *p = big_buffer + Ustrlen(big_buffer);
802 while (p > big_buffer && isspace(p[-1])) p--;
804 s = string_printing(big_buffer);
805 log_write(0, LOG_MAIN, "<%s>: %s transport output: %s",
806 addr->address, tb->name, s);
812 /* Handle returning options, but only if there is an address to return
815 if (sender_address[0] != 0 || addr->p.errors_address != NULL)
817 if (tb->return_output)
819 addr->transport_return = result = FAIL;
820 if (addr->basic_errno == 0 && addr->message == NULL)
821 addr->message = US"return message generated";
822 return_output = TRUE;
825 if (tb->return_fail_output && result == FAIL) return_output = TRUE;
829 /* Get rid of the file unless it might be returned, but close it in
834 Uunlink(addr->return_filename);
835 addr->return_filename = NULL;
836 addr->return_file = -1;
839 (void)close(addr->return_file);
842 /* Create the address string for logging. Must not do this earlier, because
843 an OK result may be changed to FAIL when a pipe returns text. */
845 log_address = string_log_address(addr,
846 (log_write_selector & L_all_parents) != 0, result == OK);
848 /* The sucess case happens only after delivery by a transport. */
852 addr->next = addr_succeed;
855 /* Call address_done() to ensure that we don't deliver to this address again,
856 and write appropriate things to the message log. If it is a child address, we
857 call child_done() to scan the ancestors and mark them complete if this is the
858 last child to complete. */
860 address_done(addr, now);
861 DEBUG(D_deliver) debug_printf("%s delivered\n", addr->address);
863 if (addr->parent == NULL)
865 deliver_msglog("%s %s: %s%s succeeded\n", now, addr->address,
866 driver_name, driver_kind);
870 deliver_msglog("%s %s <%s>: %s%s succeeded\n", now, addr->address,
871 addr->parent->address, driver_name, driver_kind);
872 child_done(addr, now);
875 /* Log the delivery on the main log. We use an extensible string to build up
876 the log line, and reset the store afterwards. Remote deliveries should always
877 have a pointer to the host item that succeeded; local deliveries can have a
878 pointer to a single host item in their host list, for use by the transport. */
880 s = reset_point = store_get(size);
883 s = string_append(s, &size, &ptr, 2, US"> ", log_address);
885 if ((log_extra_selector & LX_sender_on_delivery) != 0)
886 s = string_append(s, &size, &ptr, 3, US" F=<", sender_address, US">");
888 #ifdef EXPERIMENTAL_SRS
889 if(addr->p.srs_sender)
890 s = string_append(s, &size, &ptr, 3, US" SRS=<", addr->p.srs_sender, US">");
893 /* You might think that the return path must always be set for a successful
894 delivery; indeed, I did for some time, until this statement crashed. The case
895 when it is not set is for a delivery to /dev/null which is optimised by not
898 if (used_return_path != NULL &&
899 (log_extra_selector & LX_return_path_on_delivery) != 0)
900 s = string_append(s, &size, &ptr, 3, US" P=<", used_return_path, US">");
902 /* For a delivery from a system filter, there may not be a router */
904 if (addr->router != NULL)
905 s = string_append(s, &size, &ptr, 2, US" R=", addr->router->name);
907 s = string_append(s, &size, &ptr, 2, US" T=", addr->transport->name);
909 if ((log_extra_selector & LX_delivery_size) != 0)
910 s = string_append(s, &size, &ptr, 2, US" S=",
911 string_sprintf("%d", transport_count));
915 if (addr->transport->info->local)
917 if (addr->host_list != NULL)
918 s = string_append(s, &size, &ptr, 2, US" H=", addr->host_list->name);
919 if (addr->shadow_message != NULL)
920 s = string_cat(s, &size, &ptr, addr->shadow_message,
921 Ustrlen(addr->shadow_message));
924 /* Remote delivery */
928 if (addr->host_used != NULL)
930 s = string_append(s, &size, &ptr, 5, US" H=", addr->host_used->name,
931 US" [", addr->host_used->address, US"]");
932 if ((log_extra_selector & LX_outgoing_port) != 0)
933 s = string_append(s, &size, &ptr, 2, US":", string_sprintf("%d",
934 addr->host_used->port));
935 if (continue_sequence > 1)
936 s = string_cat(s, &size, &ptr, US"*", 1);
940 if ((log_extra_selector & LX_tls_cipher) != 0 && addr->cipher != NULL)
941 s = string_append(s, &size, &ptr, 2, US" X=", addr->cipher);
942 if ((log_extra_selector & LX_tls_certificate_verified) != 0 &&
943 addr->cipher != NULL)
944 s = string_append(s, &size, &ptr, 2, US" CV=",
945 testflag(addr, af_cert_verified)? "yes":"no");
946 if ((log_extra_selector & LX_tls_peerdn) != 0 && addr->peerdn != NULL)
947 s = string_append(s, &size, &ptr, 3, US" DN=\"", addr->peerdn, US"\"");
950 if ((log_extra_selector & LX_smtp_confirmation) != 0 &&
951 addr->message != NULL)
954 uschar *p = big_buffer;
955 uschar *ss = addr->message;
957 for (i = 0; i < 100 && ss[i] != 0; i++)
959 if (ss[i] == '\"' || ss[i] == '\\') *p++ = '\\';
964 s = string_append(s, &size, &ptr, 2, US" C=", big_buffer);
968 /* Time on queue and actual time taken to deliver */
970 if ((log_extra_selector & LX_queue_time) != 0)
972 s = string_append(s, &size, &ptr, 2, US" QT=",
973 readconf_printtime(time(NULL) - received_time));
976 if ((log_extra_selector & LX_deliver_time) != 0)
978 s = string_append(s, &size, &ptr, 2, US" DT=",
979 readconf_printtime(addr->more_errno));
982 /* string_cat() always leaves room for the terminator. Release the
983 store we used to build the line after writing it. */
986 log_write(0, LOG_MAIN, "%s", s);
987 store_reset(reset_point);
991 /* Soft failure, or local delivery process failed; freezing may be
994 else if (result == DEFER || result == PANIC)
996 if (result == PANIC) logflags |= LOG_PANIC;
998 /* This puts them on the chain in reverse order. Do not change this, because
999 the code for handling retries assumes that the one with the retry
1000 information is last. */
1002 addr->next = addr_defer;
1005 /* The only currently implemented special action is to freeze the
1006 message. Logging of this is done later, just before the -H file is
1009 if (addr->special_action == SPECIAL_FREEZE)
1011 deliver_freeze = TRUE;
1012 deliver_frozen_at = time(NULL);
1013 update_spool = TRUE;
1016 /* If doing a 2-stage queue run, we skip writing to either the message
1017 log or the main log for SMTP defers. */
1019 if (!queue_2stage || addr->basic_errno != 0)
1023 /* For errors of the type "retry time not reached" (also remotes skipped
1024 on queue run), logging is controlled by L_retry_defer. Note that this kind
1025 of error number is negative, and all the retry ones are less than any
1028 unsigned int use_log_selector = (addr->basic_errno <= ERRNO_RETRY_BASE)?
1031 /* Build up the line that is used for both the message log and the main
1034 s = reset_point = store_get(size);
1035 s = string_cat(s, &size, &ptr, log_address, Ustrlen(log_address));
1037 /* Either driver_name contains something and driver_kind contains
1038 " router" or " transport" (note the leading space), or driver_name is
1039 a null string and driver_kind contains "routing" without the leading
1040 space, if all routing has been deferred. When a domain has been held,
1041 so nothing has been done at all, both variables contain null strings. */
1043 if (driver_name == NULL)
1045 if (driver_kind != NULL)
1046 s = string_append(s, &size, &ptr, 2, US" ", driver_kind);
1050 if (driver_kind[1] == 't' && addr->router != NULL)
1051 s = string_append(s, &size, &ptr, 2, US" R=", addr->router->name);
1053 ss[1] = toupper(driver_kind[1]);
1054 s = string_append(s, &size, &ptr, 2, ss, driver_name);
1057 sprintf(CS ss, " defer (%d)", addr->basic_errno);
1058 s = string_cat(s, &size, &ptr, ss, Ustrlen(ss));
1060 if (addr->basic_errno > 0)
1061 s = string_append(s, &size, &ptr, 2, US": ",
1062 US strerror(addr->basic_errno));
1064 if (addr->message != NULL)
1065 s = string_append(s, &size, &ptr, 2, US": ", addr->message);
1069 /* Log the deferment in the message log, but don't clutter it
1070 up with retry-time defers after the first delivery attempt. */
1072 if (deliver_firsttime || addr->basic_errno > ERRNO_RETRY_BASE)
1073 deliver_msglog("%s %s\n", now, s);
1075 /* Write the main log and reset the store */
1077 log_write(use_log_selector, logflags, "== %s", s);
1078 store_reset(reset_point);
1083 /* Hard failure. If there is an address to which an error message can be sent,
1084 put this address on the failed list. If not, put it on the deferred list and
1085 freeze the mail message for human attention. The latter action can also be
1086 explicitly requested by a router or transport. */
1090 /* If this is a delivery error, or a message for which no replies are
1091 wanted, and the message's age is greater than ignore_bounce_errors_after,
1092 force the af_ignore_error flag. This will cause the address to be discarded
1093 later (with a log entry). */
1095 if (sender_address[0] == 0 && message_age >= ignore_bounce_errors_after)
1096 setflag(addr, af_ignore_error);
1098 /* Freeze the message if requested, or if this is a bounce message (or other
1099 message with null sender) and this address does not have its own errors
1100 address. However, don't freeze if errors are being ignored. The actual code
1101 to ignore occurs later, instead of sending a message. Logging of freezing
1102 occurs later, just before writing the -H file. */
1104 if (!testflag(addr, af_ignore_error) &&
1105 (addr->special_action == SPECIAL_FREEZE ||
1106 (sender_address[0] == 0 && addr->p.errors_address == NULL)
1109 frozen_info = (addr->special_action == SPECIAL_FREEZE)? US"" :
1110 (sender_local && !local_error_message)?
1111 US" (message created with -f <>)" : US" (delivery error message)";
1112 deliver_freeze = TRUE;
1113 deliver_frozen_at = time(NULL);
1114 update_spool = TRUE;
1116 /* The address is put on the defer rather than the failed queue, because
1117 the message is being retained. */
1119 addr->next = addr_defer;
1123 /* Don't put the address on the nonrecipients tree yet; wait until an
1124 error message has been successfully sent. */
1128 addr->next = addr_failed;
1132 /* Build up the log line for the message and main logs */
1134 s = reset_point = store_get(size);
1135 s = string_cat(s, &size, &ptr, log_address, Ustrlen(log_address));
1137 if ((log_extra_selector & LX_sender_on_delivery) != 0)
1138 s = string_append(s, &size, &ptr, 3, US" F=<", sender_address, US">");
1140 /* Return path may not be set if no delivery actually happened */
1142 if (used_return_path != NULL &&
1143 (log_extra_selector & LX_return_path_on_delivery) != 0)
1145 s = string_append(s, &size, &ptr, 3, US" P=<", used_return_path, US">");
1148 if (addr->router != NULL)
1149 s = string_append(s, &size, &ptr, 2, US" R=", addr->router->name);
1150 if (addr->transport != NULL)
1151 s = string_append(s, &size, &ptr, 2, US" T=", addr->transport->name);
1153 if (addr->host_used != NULL)
1154 s = string_append(s, &size, &ptr, 5, US" H=", addr->host_used->name,
1155 US" [", addr->host_used->address, US"]");
1157 if (addr->basic_errno > 0)
1158 s = string_append(s, &size, &ptr, 2, US": ",
1159 US strerror(addr->basic_errno));
1161 if (addr->message != NULL)
1162 s = string_append(s, &size, &ptr, 2, US": ", addr->message);
1166 /* Do the logging. For the message log, "routing failed" for those cases,
1167 just to make it clearer. */
1169 if (driver_name == NULL)
1170 deliver_msglog("%s %s failed for %s\n", now, driver_kind, s);
1172 deliver_msglog("%s %s\n", now, s);
1174 log_write(0, LOG_MAIN, "** %s", s);
1175 store_reset(reset_point);
1178 /* Ensure logging is turned on again in all cases */
1180 disable_logging = FALSE;
1186 /*************************************************
1187 * Address-independent error *
1188 *************************************************/
1190 /* This function is called when there's an error that is not dependent on a
1191 particular address, such as an expansion string failure. It puts the error into
1192 all the addresses in a batch, logs the incident on the main and panic logs, and
1193 clears the expansions. It is mostly called from local_deliver(), but can be
1194 called for a remote delivery via findugid().
1197 logit TRUE if (MAIN+PANIC) logging required
1198 addr the first of the chain of addresses
1200 format format string for error message, or NULL if already set in addr
1201 ... arguments for the format
1207 common_error(BOOL logit, address_item *addr, int code, uschar *format, ...)
1209 address_item *addr2;
1210 addr->basic_errno = code;
1216 va_start(ap, format);
1217 if (!string_vformat(buffer, sizeof(buffer), CS format, ap))
1218 log_write(0, LOG_MAIN|LOG_PANIC_DIE,
1219 "common_error expansion was longer than %d", sizeof(buffer));
1221 addr->message = string_copy(buffer);
1224 for (addr2 = addr->next; addr2 != NULL; addr2 = addr2->next)
1226 addr2->basic_errno = code;
1227 addr2->message = addr->message;
1230 if (logit) log_write(0, LOG_MAIN|LOG_PANIC, "%s", addr->message);
1231 deliver_set_expansions(NULL);
1237 /*************************************************
1238 * Check a "never users" list *
1239 *************************************************/
1241 /* This function is called to check whether a uid is on one of the two "never
1245 uid the uid to be checked
1246 nusers the list to be scanned; the first item in the list is the count
1248 Returns: TRUE if the uid is on the list
1252 check_never_users(uid_t uid, uid_t *nusers)
1255 if (nusers == NULL) return FALSE;
1256 for (i = 1; i <= (int)(nusers[0]); i++) if (nusers[i] == uid) return TRUE;
1262 /*************************************************
1263 * Find uid and gid for a transport *
1264 *************************************************/
1266 /* This function is called for both local and remote deliveries, to find the
1267 uid/gid under which to run the delivery. The values are taken preferentially
1268 from the transport (either explicit or deliver_as_creator), then from the
1269 address (i.e. the router), and if nothing is set, the exim uid/gid are used. If
1270 the resulting uid is on the "never_users" or the "fixed_never_users" list, a
1271 panic error is logged, and the function fails (which normally leads to delivery
1275 addr the address (possibly a chain)
1277 uidp pointer to uid field
1278 gidp pointer to gid field
1279 igfp pointer to the use_initgroups field
1281 Returns: FALSE if failed - error has been set in address(es)
1285 findugid(address_item *addr, transport_instance *tp, uid_t *uidp, gid_t *gidp,
1288 uschar *nuname = NULL;
1289 BOOL gid_set = FALSE;
1291 /* Default initgroups flag comes from the transport */
1293 *igfp = tp->initgroups;
1295 /* First see if there's a gid on the transport, either fixed or expandable.
1296 The expanding function always logs failure itself. */
1303 else if (tp->expand_gid != NULL)
1305 if (route_find_expanded_group(tp->expand_gid, tp->name, US"transport", gidp,
1306 &(addr->message))) gid_set = TRUE;
1309 common_error(FALSE, addr, ERRNO_GIDFAIL, NULL);
1314 /* If the transport did not set a group, see if the router did. */
1316 if (!gid_set && testflag(addr, af_gid_set))
1322 /* Pick up a uid from the transport if one is set. */
1324 if (tp->uid_set) *uidp = tp->uid;
1326 /* Otherwise, try for an expandable uid field. If it ends up as a numeric id,
1327 it does not provide a passwd value from which a gid can be taken. */
1329 else if (tp->expand_uid != NULL)
1332 if (!route_find_expanded_user(tp->expand_uid, tp->name, US"transport", &pw,
1333 uidp, &(addr->message)))
1335 common_error(FALSE, addr, ERRNO_UIDFAIL, NULL);
1338 if (!gid_set && pw != NULL)
1345 /* If the transport doesn't set the uid, test the deliver_as_creator flag. */
1347 else if (tp->deliver_as_creator)
1349 *uidp = originator_uid;
1352 *gidp = originator_gid;
1357 /* Otherwise see if the address specifies the uid and if so, take it and its
1360 else if (testflag(addr, af_uid_set))
1363 *igfp = testflag(addr, af_initgroups);
1366 /* Nothing has specified the uid - default to the Exim user, and group if the
1379 /* If no gid is set, it is a disaster. We default to the Exim gid only if
1380 defaulting to the Exim uid. In other words, if the configuration has specified
1381 a uid, it must also provide a gid. */
1385 common_error(TRUE, addr, ERRNO_GIDFAIL, US"User set without group for "
1386 "%s transport", tp->name);
1390 /* Check that the uid is not on the lists of banned uids that may not be used
1391 for delivery processes. */
1393 if (check_never_users(*uidp, never_users))
1394 nuname = US"never_users";
1395 else if (check_never_users(*uidp, fixed_never_users))
1396 nuname = US"fixed_never_users";
1400 common_error(TRUE, addr, ERRNO_UIDFAIL, US"User %ld set for %s transport "
1401 "is on the %s list", (long int)(*uidp), tp->name, nuname);
1413 /*************************************************
1414 * Check the size of a message for a transport *
1415 *************************************************/
1417 /* Checks that the message isn't too big for the selected transport.
1418 This is called only when it is known that the limit is set.
1422 addr the (first) address being delivered
1425 DEFER expansion failed or did not yield an integer
1426 FAIL message too big
1430 check_message_size(transport_instance *tp, address_item *addr)
1435 deliver_set_expansions(addr);
1436 size_limit = expand_string_integer(tp->message_size_limit, TRUE);
1437 deliver_set_expansions(NULL);
1439 if (expand_string_message != NULL)
1442 if (size_limit == -1)
1443 addr->message = string_sprintf("failed to expand message_size_limit "
1444 "in %s transport: %s", tp->name, expand_string_message);
1446 addr->message = string_sprintf("invalid message_size_limit "
1447 "in %s transport: %s", tp->name, expand_string_message);
1449 else if (size_limit > 0 && message_size > size_limit)
1453 string_sprintf("message is too big (transport limit = %d)",
1462 /*************************************************
1463 * Transport-time check for a previous delivery *
1464 *************************************************/
1466 /* Check that this base address hasn't previously been delivered to its routed
1467 transport. If it has been delivered, mark it done. The check is necessary at
1468 delivery time in order to handle homonymic addresses correctly in cases where
1469 the pattern of redirection changes between delivery attempts (so the unique
1470 fields change). Non-homonymic previous delivery is detected earlier, at routing
1471 time (which saves unnecessary routing).
1474 addr the address item
1475 testing TRUE if testing wanted only, without side effects
1477 Returns: TRUE if previously delivered by the transport
1481 previously_transported(address_item *addr, BOOL testing)
1483 (void)string_format(big_buffer, big_buffer_size, "%s/%s",
1484 addr->unique + (testflag(addr, af_homonym)? 3:0), addr->transport->name);
1486 if (tree_search(tree_nonrecipients, big_buffer) != 0)
1488 DEBUG(D_deliver|D_route|D_transport)
1489 debug_printf("%s was previously delivered (%s transport): discarded\n",
1490 addr->address, addr->transport->name);
1491 if (!testing) child_done(addr, tod_stamp(tod_log));
1500 /******************************************************
1501 * Check for a given header in a header string *
1502 ******************************************************/
1504 /* This function is used when generating quota warnings. The configuration may
1505 specify any header lines it likes in quota_warn_message. If certain of them are
1506 missing, defaults are inserted, so we need to be able to test for the presence
1510 hdr the required header name
1511 hstring the header string
1513 Returns: TRUE the header is in the string
1514 FALSE the header is not in the string
1518 contains_header(uschar *hdr, uschar *hstring)
1520 int len = Ustrlen(hdr);
1521 uschar *p = hstring;
1524 if (strncmpic(p, hdr, len) == 0)
1527 while (*p == ' ' || *p == '\t') p++;
1528 if (*p == ':') return TRUE;
1530 while (*p != 0 && *p != '\n') p++;
1531 if (*p == '\n') p++;
1539 /*************************************************
1540 * Perform a local delivery *
1541 *************************************************/
1543 /* Each local delivery is performed in a separate process which sets its
1544 uid and gid as specified. This is a safer way than simply changing and
1545 restoring using seteuid(); there is a body of opinion that seteuid() cannot be
1546 used safely. From release 4, Exim no longer makes any use of it. Besides, not
1547 all systems have seteuid().
1549 If the uid/gid are specified in the transport_instance, they are used; the
1550 transport initialization must ensure that either both or neither are set.
1551 Otherwise, the values associated with the address are used. If neither are set,
1552 it is a configuration error.
1554 The transport or the address may specify a home directory (transport over-
1555 rides), and if they do, this is set as $home. If neither have set a working
1556 directory, this value is used for that as well. Otherwise $home is left unset
1557 and the cwd is set to "/" - a directory that should be accessible to all users.
1559 Using a separate process makes it more complicated to get error information
1560 back. We use a pipe to pass the return code and also an error code and error
1561 text string back to the parent process.
1564 addr points to an address block for this delivery; for "normal" local
1565 deliveries this is the only address to be delivered, but for
1566 pseudo-remote deliveries (e.g. by batch SMTP to a file or pipe)
1567 a number of addresses can be handled simultaneously, and in this
1568 case addr will point to a chain of addresses with the same
1571 shadowing TRUE if running a shadow transport; this causes output from pipes
1578 deliver_local(address_item *addr, BOOL shadowing)
1580 BOOL use_initgroups;
1583 int status, len, rc;
1586 uschar *working_directory;
1587 address_item *addr2;
1588 transport_instance *tp = addr->transport;
1590 /* Set up the return path from the errors or sender address. If the transport
1591 has its own return path setting, expand it and replace the existing value. */
1593 if(addr->p.errors_address != NULL)
1594 return_path = addr->p.errors_address;
1595 #ifdef EXPERIMENTAL_SRS
1596 else if(addr->p.srs_sender != NULL)
1597 return_path = addr->p.srs_sender;
1600 return_path = sender_address;
1602 if (tp->return_path != NULL)
1604 uschar *new_return_path = expand_string(tp->return_path);
1605 if (new_return_path == NULL)
1607 if (!expand_string_forcedfail)
1609 common_error(TRUE, addr, ERRNO_EXPANDFAIL,
1610 US"Failed to expand return path \"%s\" in %s transport: %s",
1611 tp->return_path, tp->name, expand_string_message);
1615 else return_path = new_return_path;
1618 /* For local deliveries, one at a time, the value used for logging can just be
1619 set directly, once and for all. */
1621 used_return_path = return_path;
1623 /* Sort out the uid, gid, and initgroups flag. If an error occurs, the message
1624 gets put into the address(es), and the expansions are unset, so we can just
1627 if (!findugid(addr, tp, &uid, &gid, &use_initgroups)) return;
1629 /* See if either the transport or the address specifies a home directory. A
1630 home directory set in the address may already be expanded; a flag is set to
1631 indicate that. In other cases we must expand it. */
1633 if ((deliver_home = tp->home_dir) != NULL || /* Set in transport, or */
1634 ((deliver_home = addr->home_dir) != NULL && /* Set in address and */
1635 !testflag(addr, af_home_expanded))) /* not expanded */
1637 uschar *rawhome = deliver_home;
1638 deliver_home = NULL; /* in case it contains $home */
1639 deliver_home = expand_string(rawhome);
1640 if (deliver_home == NULL)
1642 common_error(TRUE, addr, ERRNO_EXPANDFAIL, US"home directory \"%s\" failed "
1643 "to expand for %s transport: %s", rawhome, tp->name,
1644 expand_string_message);
1647 if (*deliver_home != '/')
1649 common_error(TRUE, addr, ERRNO_NOTABSOLUTE, US"home directory path \"%s\" "
1650 "is not absolute for %s transport", deliver_home, tp->name);
1655 /* See if either the transport or the address specifies a current directory,
1656 and if so, expand it. If nothing is set, use the home directory, unless it is
1657 also unset in which case use "/", which is assumed to be a directory to which
1658 all users have access. It is necessary to be in a visible directory for some
1659 operating systems when running pipes, as some commands (e.g. "rm" under Solaris
1660 2.5) require this. */
1662 working_directory = (tp->current_dir != NULL)?
1663 tp->current_dir : addr->current_dir;
1665 if (working_directory != NULL)
1667 uschar *raw = working_directory;
1668 working_directory = expand_string(raw);
1669 if (working_directory == NULL)
1671 common_error(TRUE, addr, ERRNO_EXPANDFAIL, US"current directory \"%s\" "
1672 "failed to expand for %s transport: %s", raw, tp->name,
1673 expand_string_message);
1676 if (*working_directory != '/')
1678 common_error(TRUE, addr, ERRNO_NOTABSOLUTE, US"current directory path "
1679 "\"%s\" is not absolute for %s transport", working_directory, tp->name);
1683 else working_directory = (deliver_home == NULL)? US"/" : deliver_home;
1685 /* If one of the return_output flags is set on the transport, create and open a
1686 file in the message log directory for the transport to write its output onto.
1687 This is mainly used by pipe transports. The file needs to be unique to the
1688 address. This feature is not available for shadow transports. */
1690 if (!shadowing && (tp->return_output || tp->return_fail_output ||
1691 tp->log_output || tp->log_fail_output))
1694 addr->return_filename =
1695 string_sprintf("%s/msglog/%s/%s-%d-%d", spool_directory, message_subdir,
1696 message_id, getpid(), return_count++);
1697 addr->return_file = open_msglog_file(addr->return_filename, 0400, &error);
1698 if (addr->return_file < 0)
1700 common_error(TRUE, addr, errno, US"Unable to %s file for %s transport "
1701 "to return message: %s", error, tp->name, strerror(errno));
1706 /* Create the pipe for inter-process communication. */
1710 common_error(TRUE, addr, ERRNO_PIPEFAIL, US"Creation of pipe failed: %s",
1715 /* Now fork the process to do the real work in the subprocess, but first
1716 ensure that all cached resources are freed so that the subprocess starts with
1717 a clean slate and doesn't interfere with the parent process. */
1721 if ((pid = fork()) == 0)
1723 BOOL replicate = TRUE;
1725 /* Prevent core dumps, as we don't want them in users' home directories.
1726 HP-UX doesn't have RLIMIT_CORE; I don't know how to do this in that
1727 system. Some experimental/developing systems (e.g. GNU/Hurd) may define
1728 RLIMIT_CORE but not support it in setrlimit(). For such systems, do not
1729 complain if the error is "not supported". */
1735 if (setrlimit(RLIMIT_CORE, &rl) < 0)
1737 #ifdef SETRLIMIT_NOT_SUPPORTED
1738 if (errno != ENOSYS && errno != ENOTSUP)
1740 log_write(0, LOG_MAIN|LOG_PANIC, "setrlimit(RLIMIT_CORE) failed: %s",
1745 /* Reset the random number generator, so different processes don't all
1746 have the same sequence. */
1750 /* If the transport has a setup entry, call this first, while still
1751 privileged. (Appendfile uses this to expand quota, for example, while
1752 able to read private files.) */
1754 if (addr->transport->setup != NULL)
1756 switch((addr->transport->setup)(addr->transport, addr, NULL, uid, gid,
1760 addr->transport_return = DEFER;
1764 addr->transport_return = PANIC;
1769 /* Ignore SIGINT and SIGTERM during delivery. Also ignore SIGUSR1, as
1770 when the process becomes unprivileged, it won't be able to write to the
1771 process log. SIGHUP is ignored throughout exim, except when it is being
1774 signal(SIGINT, SIG_IGN);
1775 signal(SIGTERM, SIG_IGN);
1776 signal(SIGUSR1, SIG_IGN);
1778 /* Close the unwanted half of the pipe, and set close-on-exec for the other
1779 half - for transports that exec things (e.g. pipe). Then set the required
1782 (void)close(pfd[pipe_read]);
1783 (void)fcntl(pfd[pipe_write], F_SETFD, fcntl(pfd[pipe_write], F_GETFD) |
1785 exim_setugid(uid, gid, use_initgroups,
1786 string_sprintf("local delivery to %s <%s> transport=%s", addr->local_part,
1787 addr->address, addr->transport->name));
1791 address_item *batched;
1792 debug_printf(" home=%s current=%s\n", deliver_home, working_directory);
1793 for (batched = addr->next; batched != NULL; batched = batched->next)
1794 debug_printf("additional batched address: %s\n", batched->address);
1797 /* Set an appropriate working directory. */
1799 if (Uchdir(working_directory) < 0)
1801 addr->transport_return = DEFER;
1802 addr->basic_errno = errno;
1803 addr->message = string_sprintf("failed to chdir to %s", working_directory);
1806 /* If successful, call the transport */
1811 set_process_info("delivering %s to %s using %s", message_id,
1812 addr->local_part, addr->transport->name);
1814 /* If a transport filter has been specified, set up its argument list.
1815 Any errors will get put into the address, and FALSE yielded. */
1817 if (addr->transport->filter_command != NULL)
1819 ok = transport_set_up_command(&transport_filter_argv,
1820 addr->transport->filter_command,
1821 TRUE, PANIC, addr, US"transport filter", NULL);
1822 transport_filter_timeout = addr->transport->filter_timeout;
1824 else transport_filter_argv = NULL;
1828 debug_print_string(addr->transport->debug_string);
1829 replicate = !(addr->transport->info->code)(addr->transport, addr);
1833 /* Pass the results back down the pipe. If necessary, first replicate the
1834 status in the top address to the others in the batch. The label is the
1835 subject of a goto when a call to the transport's setup function fails. We
1836 pass the pointer to the transport back in case it got changed as a result of
1837 file_format in appendfile. */
1841 if (replicate) replicate_status(addr);
1842 for (addr2 = addr; addr2 != NULL; addr2 = addr2->next)
1845 int local_part_length = Ustrlen(addr2->local_part);
1848 (void)write(pfd[pipe_write], (void *)&(addr2->transport_return), sizeof(int));
1849 (void)write(pfd[pipe_write], (void *)&transport_count, sizeof(transport_count));
1850 (void)write(pfd[pipe_write], (void *)&(addr2->flags), sizeof(addr2->flags));
1851 (void)write(pfd[pipe_write], (void *)&(addr2->basic_errno), sizeof(int));
1852 (void)write(pfd[pipe_write], (void *)&(addr2->more_errno), sizeof(int));
1853 (void)write(pfd[pipe_write], (void *)&(addr2->special_action), sizeof(int));
1854 (void)write(pfd[pipe_write], (void *)&(addr2->transport),
1855 sizeof(transport_instance *));
1857 /* For a file delivery, pass back the local part, in case the original
1858 was only part of the final delivery path. This gives more complete
1861 if (testflag(addr2, af_file))
1863 (void)write(pfd[pipe_write], (void *)&local_part_length, sizeof(int));
1864 (void)write(pfd[pipe_write], addr2->local_part, local_part_length);
1867 /* Now any messages */
1869 for (i = 0, s = addr2->message; i < 2; i++, s = addr2->user_message)
1871 int message_length = (s == NULL)? 0 : Ustrlen(s) + 1;
1872 (void)write(pfd[pipe_write], (void *)&message_length, sizeof(int));
1873 if (message_length > 0) (void)write(pfd[pipe_write], s, message_length);
1877 /* OK, this process is now done. Free any cached resources that it opened,
1878 and close the pipe we were writing down before exiting. */
1880 (void)close(pfd[pipe_write]);
1885 /* Back in the main process: panic if the fork did not succeed. This seems
1886 better than returning an error - if forking is failing it is probably best
1887 not to try other deliveries for this message. */
1890 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Fork failed for local delivery to %s",
1893 /* Read the pipe to get the delivery status codes and error messages. Our copy
1894 of the writing end must be closed first, as otherwise read() won't return zero
1895 on an empty pipe. We check that a status exists for each address before
1896 overwriting the address structure. If data is missing, the default DEFER status
1897 will remain. Afterwards, close the reading end. */
1899 (void)close(pfd[pipe_write]);
1901 for (addr2 = addr; addr2 != NULL; addr2 = addr2->next)
1903 len = read(pfd[pipe_read], (void *)&status, sizeof(int));
1909 addr2->transport_return = status;
1910 len = read(pfd[pipe_read], (void *)&transport_count,
1911 sizeof(transport_count));
1912 len = read(pfd[pipe_read], (void *)&(addr2->flags), sizeof(addr2->flags));
1913 len = read(pfd[pipe_read], (void *)&(addr2->basic_errno), sizeof(int));
1914 len = read(pfd[pipe_read], (void *)&(addr2->more_errno), sizeof(int));
1915 len = read(pfd[pipe_read], (void *)&(addr2->special_action), sizeof(int));
1916 len = read(pfd[pipe_read], (void *)&(addr2->transport),
1917 sizeof(transport_instance *));
1919 if (testflag(addr2, af_file))
1921 int local_part_length;
1922 len = read(pfd[pipe_read], (void *)&local_part_length, sizeof(int));
1923 len = read(pfd[pipe_read], (void *)big_buffer, local_part_length);
1924 big_buffer[local_part_length] = 0;
1925 addr2->local_part = string_copy(big_buffer);
1928 for (i = 0, sptr = &(addr2->message); i < 2;
1929 i++, sptr = &(addr2->user_message))
1932 len = read(pfd[pipe_read], (void *)&message_length, sizeof(int));
1933 if (message_length > 0)
1935 len = read(pfd[pipe_read], (void *)big_buffer, message_length);
1936 if (len > 0) *sptr = string_copy(big_buffer);
1943 log_write(0, LOG_MAIN|LOG_PANIC, "failed to read delivery status for %s "
1944 "from delivery subprocess", addr2->unique);
1949 (void)close(pfd[pipe_read]);
1951 /* Unless shadowing, write all successful addresses immediately to the journal
1952 file, to ensure they are recorded asap. For homonymic addresses, use the base
1953 address plus the transport name. Failure to write the journal is panic-worthy,
1954 but don't stop, as it may prove possible subsequently to update the spool file
1955 in order to record the delivery. */
1959 for (addr2 = addr; addr2 != NULL; addr2 = addr2->next)
1961 if (addr2->transport_return != OK) continue;
1963 if (testflag(addr2, af_homonym))
1964 sprintf(CS big_buffer, "%.500s/%s\n", addr2->unique + 3, tp->name);
1966 sprintf(CS big_buffer, "%.500s\n", addr2->unique);
1968 /* In the test harness, wait just a bit to let the subprocess finish off
1969 any debug output etc first. */
1971 if (running_in_test_harness) millisleep(300);
1973 DEBUG(D_deliver) debug_printf("journalling %s", big_buffer);
1974 len = Ustrlen(big_buffer);
1975 if (write(journal_fd, big_buffer, len) != len)
1976 log_write(0, LOG_MAIN|LOG_PANIC, "failed to update journal for %s: %s",
1977 big_buffer, strerror(errno));
1980 /* Ensure the journal file is pushed out to disk. */
1982 if (EXIMfsync(journal_fd) < 0)
1983 log_write(0, LOG_MAIN|LOG_PANIC, "failed to fsync journal: %s",
1987 /* Wait for the process to finish. If it terminates with a non-zero code,
1988 freeze the message (except for SIGTERM, SIGKILL and SIGQUIT), but leave the
1989 status values of all the addresses as they are. Take care to handle the case
1990 when the subprocess doesn't seem to exist. This has been seen on one system
1991 when Exim was called from an MUA that set SIGCHLD to SIG_IGN. When that
1992 happens, wait() doesn't recognize the termination of child processes. Exim now
1993 resets SIGCHLD to SIG_DFL, but this code should still be robust. */
1995 while ((rc = wait(&status)) != pid)
1997 if (rc < 0 && errno == ECHILD) /* Process has vanished */
1999 log_write(0, LOG_MAIN, "%s transport process vanished unexpectedly",
2000 addr->transport->driver_name);
2006 if ((status & 0xffff) != 0)
2008 int msb = (status >> 8) & 255;
2009 int lsb = status & 255;
2010 int code = (msb == 0)? (lsb & 0x7f) : msb;
2011 if (msb != 0 || (code != SIGTERM && code != SIGKILL && code != SIGQUIT))
2012 addr->special_action = SPECIAL_FREEZE;
2013 log_write(0, LOG_MAIN|LOG_PANIC, "%s transport process returned non-zero "
2014 "status 0x%04x: %s %d",
2015 addr->transport->driver_name,
2017 (msb == 0)? "terminated by signal" : "exit code",
2021 /* If SPECIAL_WARN is set in the top address, send a warning message. */
2023 if (addr->special_action == SPECIAL_WARN &&
2024 addr->transport->warn_message != NULL)
2027 uschar *warn_message;
2029 DEBUG(D_deliver) debug_printf("Warning message requested by transport\n");
2031 warn_message = expand_string(addr->transport->warn_message);
2032 if (warn_message == NULL)
2033 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand \"%s\" (warning "
2034 "message for %s transport): %s", addr->transport->warn_message,
2035 addr->transport->name, expand_string_message);
2038 pid_t pid = child_open_exim(&fd);
2041 FILE *f = fdopen(fd, "wb");
2042 if (errors_reply_to != NULL &&
2043 !contains_header(US"Reply-To", warn_message))
2044 fprintf(f, "Reply-To: %s\n", errors_reply_to);
2045 fprintf(f, "Auto-Submitted: auto-replied\n");
2046 if (!contains_header(US"From", warn_message)) moan_write_from(f);
2047 fprintf(f, "%s", CS warn_message);
2049 /* Close and wait for child process to complete, without a timeout. */
2052 (void)child_close(pid, 0);
2056 addr->special_action = SPECIAL_NONE;
2062 /*************************************************
2063 * Do local deliveries *
2064 *************************************************/
2066 /* This function processes the list of addresses in addr_local. True local
2067 deliveries are always done one address at a time. However, local deliveries can
2068 be batched up in some cases. Typically this is when writing batched SMTP output
2069 files for use by some external transport mechanism, or when running local
2070 deliveries over LMTP.
2077 do_local_deliveries(void)
2080 open_db *dbm_file = NULL;
2081 time_t now = time(NULL);
2083 /* Loop until we have exhausted the supply of local deliveries */
2085 while (addr_local != NULL)
2087 time_t delivery_start;
2089 address_item *addr2, *addr3, *nextaddr;
2090 int logflags = LOG_MAIN;
2091 int logchar = dont_deliver? '*' : '=';
2092 transport_instance *tp;
2094 /* Pick the first undelivered address off the chain */
2096 address_item *addr = addr_local;
2097 addr_local = addr->next;
2100 DEBUG(D_deliver|D_transport)
2101 debug_printf("--------> %s <--------\n", addr->address);
2103 /* An internal disaster if there is no transport. Should not occur! */
2105 if ((tp = addr->transport) == NULL)
2107 logflags |= LOG_PANIC;
2108 disable_logging = FALSE; /* Jic */
2110 (addr->router != NULL)?
2111 string_sprintf("No transport set by %s router", addr->router->name)
2113 string_sprintf("No transport set by system filter");
2114 post_process_one(addr, DEFER, logflags, DTYPE_TRANSPORT, 0);
2118 /* Check that this base address hasn't previously been delivered to this
2119 transport. The check is necessary at this point to handle homonymic addresses
2120 correctly in cases where the pattern of redirection changes between delivery
2121 attempts. Non-homonymic previous delivery is detected earlier, at routing
2124 if (previously_transported(addr, FALSE)) continue;
2126 /* There are weird cases where logging is disabled */
2128 disable_logging = tp->disable_logging;
2130 /* Check for batched addresses and possible amalgamation. Skip all the work
2131 if either batch_max <= 1 or there aren't any other addresses for local
2134 if (tp->batch_max > 1 && addr_local != NULL)
2136 int batch_count = 1;
2137 BOOL uses_dom = readconf_depends((driver_instance *)tp, US"domain");
2138 BOOL uses_lp = (testflag(addr, af_pfr) &&
2139 (testflag(addr, af_file) || addr->local_part[0] == '|')) ||
2140 readconf_depends((driver_instance *)tp, US"local_part");
2141 uschar *batch_id = NULL;
2142 address_item **anchor = &addr_local;
2143 address_item *last = addr;
2146 /* Expand the batch_id string for comparison with other addresses.
2147 Expansion failure suppresses batching. */
2149 if (tp->batch_id != NULL)
2151 deliver_set_expansions(addr);
2152 batch_id = expand_string(tp->batch_id);
2153 deliver_set_expansions(NULL);
2154 if (batch_id == NULL)
2156 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand batch_id option "
2157 "in %s transport (%s): %s", tp->name, addr->address,
2158 expand_string_message);
2159 batch_count = tp->batch_max;
2163 /* Until we reach the batch_max limit, pick off addresses which have the
2164 same characteristics. These are:
2167 not previously delivered (see comment about 50 lines above)
2168 same local part if the transport's configuration contains $local_part
2169 or if this is a file or pipe delivery from a redirection
2170 same domain if the transport's configuration contains $domain
2172 same additional headers
2173 same headers to be removed
2174 same uid/gid for running the transport
2175 same first host if a host list is set
2178 while ((next = *anchor) != NULL && batch_count < tp->batch_max)
2181 tp == next->transport &&
2182 !previously_transported(next, TRUE) &&
2183 (addr->flags & (af_pfr|af_file)) == (next->flags & (af_pfr|af_file)) &&
2184 (!uses_lp || Ustrcmp(next->local_part, addr->local_part) == 0) &&
2185 (!uses_dom || Ustrcmp(next->domain, addr->domain) == 0) &&
2186 same_strings(next->p.errors_address, addr->p.errors_address) &&
2187 same_headers(next->p.extra_headers, addr->p.extra_headers) &&
2188 same_strings(next->p.remove_headers, addr->p.remove_headers) &&
2189 same_ugid(tp, addr, next) &&
2190 ((addr->host_list == NULL && next->host_list == NULL) ||
2191 (addr->host_list != NULL && next->host_list != NULL &&
2192 Ustrcmp(addr->host_list->name, next->host_list->name) == 0));
2194 /* If the transport has a batch_id setting, batch_id will be non-NULL
2195 from the expansion outside the loop. Expand for this address and compare.
2196 Expansion failure makes this address ineligible for batching. */
2198 if (ok && batch_id != NULL)
2201 address_item *save_nextnext = next->next;
2202 next->next = NULL; /* Expansion for a single address */
2203 deliver_set_expansions(next);
2204 next->next = save_nextnext;
2205 bid = expand_string(tp->batch_id);
2206 deliver_set_expansions(NULL);
2209 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand batch_id option "
2210 "in %s transport (%s): %s", tp->name, next->address,
2211 expand_string_message);
2214 else ok = (Ustrcmp(batch_id, bid) == 0);
2217 /* Take address into batch if OK. */
2221 *anchor = next->next; /* Include the address */
2227 else anchor = &(next->next); /* Skip the address */
2231 /* We now have one or more addresses that can be delivered in a batch. Check
2232 whether the transport is prepared to accept a message of this size. If not,
2233 fail them all forthwith. If the expansion fails, or does not yield an
2234 integer, defer delivery. */
2236 if (tp->message_size_limit != NULL)
2238 int rc = check_message_size(tp, addr);
2241 replicate_status(addr);
2242 while (addr != NULL)
2245 post_process_one(addr, rc, logflags, DTYPE_TRANSPORT, 0);
2248 continue; /* With next batch of addresses */
2252 /* If we are not running the queue, or if forcing, all deliveries will be
2253 attempted. Otherwise, we must respect the retry times for each address. Even
2254 when not doing this, we need to set up the retry key string, and determine
2255 whether a retry record exists, because after a successful delivery, a delete
2256 retry item must be set up. Keep the retry database open only for the duration
2257 of these checks, rather than for all local deliveries, because some local
2258 deliveries (e.g. to pipes) can take a substantial time. */
2260 dbm_file = dbfn_open(US"retry", O_RDONLY, &dbblock, FALSE);
2261 if (dbm_file == NULL)
2263 DEBUG(D_deliver|D_retry|D_hints_lookup)
2264 debug_printf("no retry data available\n");
2269 while (addr2 != NULL)
2271 BOOL ok = TRUE; /* to deliver this address */
2274 /* Set up the retry key to include the domain or not, and change its
2275 leading character from "R" to "T". Must make a copy before doing this,
2276 because the old key may be pointed to from a "delete" retry item after
2279 retry_key = string_copy(
2280 (tp->retry_use_local_part)? addr2->address_retry_key :
2281 addr2->domain_retry_key);
2284 /* Inspect the retry data. If there is no hints file, delivery happens. */
2286 if (dbm_file != NULL)
2288 dbdata_retry *retry_record = dbfn_read(dbm_file, retry_key);
2290 /* If there is no retry record, delivery happens. If there is,
2291 remember it exists so it can be deleted after a successful delivery. */
2293 if (retry_record != NULL)
2295 setflag(addr2, af_lt_retry_exists);
2297 /* A retry record exists for this address. If queue running and not
2298 forcing, inspect its contents. If the record is too old, or if its
2299 retry time has come, or if it has passed its cutoff time, delivery
2304 debug_printf("retry record exists: age=%s ",
2305 readconf_printtime(now - retry_record->time_stamp));
2306 debug_printf("(max %s)\n", readconf_printtime(retry_data_expire));
2307 debug_printf(" time to retry = %s expired = %d\n",
2308 readconf_printtime(retry_record->next_try - now),
2309 retry_record->expired);
2312 if (queue_running && !deliver_force)
2314 ok = (now - retry_record->time_stamp > retry_data_expire) ||
2315 (now >= retry_record->next_try) ||
2316 retry_record->expired;
2318 /* If we haven't reached the retry time, there is one more check
2319 to do, which is for the ultimate address timeout. */
2323 retry_config *retry =
2324 retry_find_config(retry_key+2, addr2->domain,
2325 retry_record->basic_errno,
2326 retry_record->more_errno);
2328 DEBUG(D_deliver|D_retry)
2330 debug_printf("retry time not reached for %s: "
2331 "checking ultimate address timeout\n", addr2->address);
2332 debug_printf(" now=%d first_failed=%d next_try=%d expired=%d\n",
2333 (int)now, (int)retry_record->first_failed,
2334 (int)retry_record->next_try, retry_record->expired);
2337 if (retry != NULL && retry->rules != NULL)
2339 retry_rule *last_rule;
2340 for (last_rule = retry->rules;
2341 last_rule->next != NULL;
2342 last_rule = last_rule->next);
2343 DEBUG(D_deliver|D_retry)
2344 debug_printf(" received_time=%d diff=%d timeout=%d\n",
2345 received_time, (int)now - received_time, last_rule->timeout);
2346 if (now - received_time > last_rule->timeout) ok = TRUE;
2350 DEBUG(D_deliver|D_retry)
2351 debug_printf("no retry rule found: assume timed out\n");
2352 ok = TRUE; /* No rule => timed out */
2355 DEBUG(D_deliver|D_retry)
2357 if (ok) debug_printf("on queue longer than maximum retry for "
2358 "address - allowing delivery\n");
2363 else DEBUG(D_retry) debug_printf("no retry record exists\n");
2366 /* This address is to be delivered. Leave it on the chain. */
2371 addr2 = addr2->next;
2374 /* This address is to be deferred. Take it out of the chain, and
2375 post-process it as complete. Must take it out of the chain first,
2376 because post processing puts it on another chain. */
2380 address_item *this = addr2;
2381 this->message = US"Retry time not yet reached";
2382 this->basic_errno = ERRNO_LRETRY;
2383 if (addr3 == NULL) addr2 = addr = addr2->next;
2384 else addr2 = addr3->next = addr2->next;
2385 post_process_one(this, DEFER, logflags, DTYPE_TRANSPORT, 0);
2389 if (dbm_file != NULL) dbfn_close(dbm_file);
2391 /* If there are no addresses left on the chain, they all deferred. Loop
2392 for the next set of addresses. */
2394 if (addr == NULL) continue;
2396 /* So, finally, we do have some addresses that can be passed to the
2397 transport. Before doing so, set up variables that are relevant to a
2400 deliver_set_expansions(addr);
2401 delivery_start = time(NULL);
2402 deliver_local(addr, FALSE);
2403 deliver_time = (int)(time(NULL) - delivery_start);
2405 /* If a shadow transport (which must perforce be another local transport), is
2406 defined, and its condition is met, we must pass the message to the shadow
2407 too, but only those addresses that succeeded. We do this by making a new
2408 chain of addresses - also to keep the original chain uncontaminated. We must
2409 use a chain rather than doing it one by one, because the shadow transport may
2412 NOTE: if the condition fails because of a lookup defer, there is nothing we
2415 if (tp->shadow != NULL &&
2416 (tp->shadow_condition == NULL ||
2417 expand_check_condition(tp->shadow_condition, tp->name, US"transport")))
2419 transport_instance *stp;
2420 address_item *shadow_addr = NULL;
2421 address_item **last = &shadow_addr;
2423 for (stp = transports; stp != NULL; stp = stp->next)
2424 if (Ustrcmp(stp->name, tp->shadow) == 0) break;
2427 log_write(0, LOG_MAIN|LOG_PANIC, "shadow transport \"%s\" not found ",
2430 /* Pick off the addresses that have succeeded, and make clones. Put into
2431 the shadow_message field a pointer to the shadow_message field of the real
2434 else for (addr2 = addr; addr2 != NULL; addr2 = addr2->next)
2436 if (addr2->transport_return != OK) continue;
2437 addr3 = store_get(sizeof(address_item));
2440 addr3->shadow_message = (uschar *)(&(addr2->shadow_message));
2441 addr3->transport = stp;
2442 addr3->transport_return = DEFER;
2443 addr3->return_filename = NULL;
2444 addr3->return_file = -1;
2446 last = &(addr3->next);
2449 /* If we found any addresses to shadow, run the delivery, and stick any
2450 message back into the shadow_message field in the original. */
2452 if (shadow_addr != NULL)
2454 int save_count = transport_count;
2456 DEBUG(D_deliver|D_transport)
2457 debug_printf(">>>>>>>>>>>>>>>> Shadow delivery >>>>>>>>>>>>>>>>\n");
2458 deliver_local(shadow_addr, TRUE);
2460 for(; shadow_addr != NULL; shadow_addr = shadow_addr->next)
2462 int sresult = shadow_addr->transport_return;
2463 *((uschar **)(shadow_addr->shadow_message)) = (sresult == OK)?
2464 string_sprintf(" ST=%s", stp->name) :
2465 string_sprintf(" ST=%s (%s%s%s)", stp->name,
2466 (shadow_addr->basic_errno <= 0)?
2467 US"" : US strerror(shadow_addr->basic_errno),
2468 (shadow_addr->basic_errno <= 0 || shadow_addr->message == NULL)?
2470 (shadow_addr->message != NULL)? shadow_addr->message :
2471 (shadow_addr->basic_errno <= 0)? US"unknown error" : US"");
2473 DEBUG(D_deliver|D_transport)
2474 debug_printf("%s shadow transport returned %s for %s\n",
2476 (sresult == OK)? "OK" :
2477 (sresult == DEFER)? "DEFER" :
2478 (sresult == FAIL)? "FAIL" :
2479 (sresult == PANIC)? "PANIC" : "?",
2480 shadow_addr->address);
2483 DEBUG(D_deliver|D_transport)
2484 debug_printf(">>>>>>>>>>>>>>>> End shadow delivery >>>>>>>>>>>>>>>>\n");
2486 transport_count = save_count; /* Restore original transport count */
2490 /* Cancel the expansions that were set up for the delivery. */
2492 deliver_set_expansions(NULL);
2494 /* Now we can process the results of the real transport. We must take each
2495 address off the chain first, because post_process_one() puts it on another
2498 for (addr2 = addr; addr2 != NULL; addr2 = nextaddr)
2500 int result = addr2->transport_return;
2501 nextaddr = addr2->next;
2503 DEBUG(D_deliver|D_transport)
2504 debug_printf("%s transport returned %s for %s\n",
2506 (result == OK)? "OK" :
2507 (result == DEFER)? "DEFER" :
2508 (result == FAIL)? "FAIL" :
2509 (result == PANIC)? "PANIC" : "?",
2512 /* If there is a retry_record, or if delivery is deferred, build a retry
2513 item for setting a new retry time or deleting the old retry record from
2514 the database. These items are handled all together after all addresses
2515 have been handled (so the database is open just for a short time for
2518 if (result == DEFER || testflag(addr2, af_lt_retry_exists))
2520 int flags = (result == DEFER)? 0 : rf_delete;
2521 uschar *retry_key = string_copy((tp->retry_use_local_part)?
2522 addr2->address_retry_key : addr2->domain_retry_key);
2524 retry_add_item(addr2, retry_key, flags);
2527 /* Done with this address */
2529 if (result == OK) addr2->more_errno = deliver_time;
2530 post_process_one(addr2, result, logflags, DTYPE_TRANSPORT, logchar);
2532 /* If a pipe delivery generated text to be sent back, the result may be
2533 changed to FAIL, and we must copy this for subsequent addresses in the
2536 if (addr2->transport_return != result)
2538 for (addr3 = nextaddr; addr3 != NULL; addr3 = addr3->next)
2540 addr3->transport_return = addr2->transport_return;
2541 addr3->basic_errno = addr2->basic_errno;
2542 addr3->message = addr2->message;
2544 result = addr2->transport_return;
2547 /* Whether or not the result was changed to FAIL, we need to copy the
2548 return_file value from the first address into all the addresses of the
2549 batch, so they are all listed in the error message. */
2551 addr2->return_file = addr->return_file;
2553 /* Change log character for recording successful deliveries. */
2555 if (result == OK) logchar = '-';
2557 } /* Loop back for next batch of addresses */
2563 /*************************************************
2564 * Sort remote deliveries *
2565 *************************************************/
2567 /* This function is called if remote_sort_domains is set. It arranges that the
2568 chain of addresses for remote deliveries is ordered according to the strings
2569 specified. Try to make this shuffling reasonably efficient by handling
2570 sequences of addresses rather than just single ones.
2577 sort_remote_deliveries(void)
2580 address_item **aptr = &addr_remote;
2581 uschar *listptr = remote_sort_domains;
2585 while (*aptr != NULL &&
2586 (pattern = string_nextinlist(&listptr, &sep, patbuf, sizeof(patbuf)))
2589 address_item *moved = NULL;
2590 address_item **bptr = &moved;
2592 while (*aptr != NULL)
2594 address_item **next;
2595 deliver_domain = (*aptr)->domain; /* set $domain */
2596 if (match_isinlist(deliver_domain, &pattern, UCHAR_MAX+1,
2597 &domainlist_anchor, NULL, MCL_DOMAIN, TRUE, NULL) == OK)
2599 aptr = &((*aptr)->next);
2603 next = &((*aptr)->next);
2604 while (*next != NULL &&
2605 (deliver_domain = (*next)->domain, /* Set $domain */
2606 match_isinlist(deliver_domain, &pattern, UCHAR_MAX+1,
2607 &domainlist_anchor, NULL, MCL_DOMAIN, TRUE, NULL)) != OK)
2608 next = &((*next)->next);
2610 /* If the batch of non-matchers is at the end, add on any that were
2611 extracted further up the chain, and end this iteration. Otherwise,
2612 extract them from the chain and hang on the moved chain. */
2624 aptr = &((*aptr)->next);
2627 /* If the loop ended because the final address matched, *aptr will
2628 be NULL. Add on to the end any extracted non-matching addresses. If
2629 *aptr is not NULL, the loop ended via "break" when *next is null, that
2630 is, there was a string of non-matching addresses at the end. In this
2631 case the extracted addresses have already been added on the end. */
2633 if (*aptr == NULL) *aptr = moved;
2639 debug_printf("remote addresses after sorting:\n");
2640 for (addr = addr_remote; addr != NULL; addr = addr->next)
2641 debug_printf(" %s\n", addr->address);
2647 /*************************************************
2648 * Read from pipe for remote delivery subprocess *
2649 *************************************************/
2651 /* This function is called when the subprocess is complete, but can also be
2652 called before it is complete, in order to empty a pipe that is full (to prevent
2653 deadlock). It must therefore keep track of its progress in the parlist data
2656 We read the pipe to get the delivery status codes and a possible error message
2657 for each address, optionally preceded by unusability data for the hosts and
2658 also by optional retry data.
2660 Read in large chunks into the big buffer and then scan through, interpreting
2661 the data therein. In most cases, only a single read will be necessary. No
2662 individual item will ever be anywhere near 2500 bytes in length, so by ensuring
2663 that we read the next chunk when there is less than 2500 bytes left in the
2664 non-final chunk, we can assume each item is complete in the buffer before
2665 handling it. Each item is written using a single write(), which is atomic for
2666 small items (less than PIPE_BUF, which seems to be at least 512 in any Unix and
2667 often bigger) so even if we are reading while the subprocess is still going, we
2668 should never have only a partial item in the buffer.
2671 poffset the offset of the parlist item
2672 eop TRUE if the process has completed
2674 Returns: TRUE if the terminating 'Z' item has been read,
2675 or there has been a disaster (i.e. no more data needed);
2680 par_read_pipe(int poffset, BOOL eop)
2683 pardata *p = parlist + poffset;
2684 address_item *addrlist = p->addrlist;
2685 address_item *addr = p->addr;
2688 uschar *endptr = big_buffer;
2689 uschar *ptr = endptr;
2690 uschar *msg = p->msg;
2691 BOOL done = p->done;
2692 BOOL unfinished = TRUE;
2694 /* Loop through all items, reading from the pipe when necessary. The pipe
2695 is set up to be non-blocking, but there are two different Unix mechanisms in
2696 use. Exim uses O_NONBLOCK if it is defined. This returns 0 for end of file,
2697 and EAGAIN for no more data. If O_NONBLOCK is not defined, Exim uses O_NDELAY,
2698 which returns 0 for both end of file and no more data. We distinguish the
2699 two cases by taking 0 as end of file only when we know the process has
2702 Each separate item is written to the pipe in a single write(), and as they are
2703 all short items, the writes will all be atomic and we should never find
2704 ourselves in the position of having read an incomplete item. "Short" in this
2705 case can mean up to about 1K in the case when there is a long error message
2706 associated with an address. */
2708 DEBUG(D_deliver) debug_printf("reading pipe for subprocess %d (%s)\n",
2709 (int)p->pid, eop? "ended" : "not ended");
2713 retry_item *r, **rp;
2714 int remaining = endptr - ptr;
2716 /* Read (first time) or top up the chars in the buffer if necessary.
2717 There will be only one read if we get all the available data (i.e. don't
2718 fill the buffer completely). */
2720 if (remaining < 2500 && unfinished)
2723 int available = big_buffer_size - remaining;
2725 if (remaining > 0) memmove(big_buffer, ptr, remaining);
2728 endptr = big_buffer + remaining;
2729 len = read(fd, endptr, available);
2731 DEBUG(D_deliver) debug_printf("read() yielded %d\n", len);
2733 /* If the result is EAGAIN and the process is not complete, just
2734 stop reading any more and process what we have already. */
2738 if (!eop && errno == EAGAIN) len = 0; else
2740 msg = string_sprintf("failed to read pipe from transport process "
2741 "%d for transport %s: %s", pid, addr->transport->driver_name,
2747 /* If the length is zero (eof or no-more-data), just process what we
2748 already have. Note that if the process is still running and we have
2749 read all the data in the pipe (but less that "available") then we
2750 won't read any more, as "unfinished" will get set FALSE. */
2753 unfinished = len == available;
2756 /* If we are at the end of the available data, exit the loop. */
2758 if (ptr >= endptr) break;
2760 /* Handle each possible type of item, assuming the complete item is
2761 available in store. */
2765 /* Host items exist only if any hosts were marked unusable. Match
2766 up by checking the IP address. */
2769 for (h = addrlist->host_list; h != NULL; h = h->next)
2771 if (h->address == NULL || Ustrcmp(h->address, ptr+2) != 0) continue;
2779 /* Retry items are sent in a preceding R item for each address. This is
2780 kept separate to keep each message short enough to guarantee it won't
2781 be split in the pipe. Hopefully, in the majority of cases, there won't in
2782 fact be any retry items at all.
2784 The complete set of retry items might include an item to delete a
2785 routing retry if there was a previous routing delay. However, routing
2786 retries are also used when a remote transport identifies an address error.
2787 In that case, there may also be an "add" item for the same key. Arrange
2788 that a "delete" item is dropped in favour of an "add" item. */
2791 if (addr == NULL) goto ADDR_MISMATCH;
2793 DEBUG(D_deliver|D_retry)
2794 debug_printf("reading retry information for %s from subprocess\n",
2797 /* Cut out any "delete" items on the list. */
2799 for (rp = &(addr->retries); (r = *rp) != NULL; rp = &(r->next))
2801 if (Ustrcmp(r->key, ptr+1) == 0) /* Found item with same key */
2803 if ((r->flags & rf_delete) == 0) break; /* It was not "delete" */
2804 *rp = r->next; /* Excise a delete item */
2805 DEBUG(D_deliver|D_retry)
2806 debug_printf(" existing delete item dropped\n");
2810 /* We want to add a delete item only if there is no non-delete item;
2811 however we still have to step ptr through the data. */
2813 if (r == NULL || (*ptr & rf_delete) == 0)
2815 r = store_get(sizeof(retry_item));
2816 r->next = addr->retries;
2819 r->key = string_copy(ptr);
2821 memcpy(&(r->basic_errno), ptr, sizeof(r->basic_errno));
2822 ptr += sizeof(r->basic_errno);
2823 memcpy(&(r->more_errno), ptr, sizeof(r->more_errno));
2824 ptr += sizeof(r->more_errno);
2825 r->message = (*ptr)? string_copy(ptr) : NULL;
2826 DEBUG(D_deliver|D_retry)
2827 debug_printf(" added %s item\n",
2828 ((r->flags & rf_delete) == 0)? "retry" : "delete");
2833 DEBUG(D_deliver|D_retry)
2834 debug_printf(" delete item not added: non-delete item exists\n");
2837 ptr += sizeof(r->basic_errno) + sizeof(r->more_errno);
2843 /* Put the amount of data written into the parlist block */
2846 memcpy(&(p->transport_count), ptr, sizeof(transport_count));
2847 ptr += sizeof(transport_count);
2850 /* Address items are in the order of items on the address chain. We
2851 remember the current address value in case this function is called
2852 several times to empty the pipe in stages. Information about delivery
2853 over TLS is sent in a preceding X item for each address. We don't put
2854 it in with the other info, in order to keep each message short enough to
2855 guarantee it won't be split in the pipe. */
2859 if (addr == NULL) goto ADDR_MISMATCH; /* Below, in 'A' handler */
2860 addr->cipher = (*ptr)? string_copy(ptr) : NULL;
2862 addr->peerdn = (*ptr)? string_copy(ptr) : NULL;
2871 msg = string_sprintf("address count mismatch for data read from pipe "
2872 "for transport process %d for transport %s", pid,
2873 addrlist->transport->driver_name);
2878 addr->transport_return = *ptr++;
2879 addr->special_action = *ptr++;
2880 memcpy(&(addr->basic_errno), ptr, sizeof(addr->basic_errno));
2881 ptr += sizeof(addr->basic_errno);
2882 memcpy(&(addr->more_errno), ptr, sizeof(addr->more_errno));
2883 ptr += sizeof(addr->more_errno);
2884 memcpy(&(addr->flags), ptr, sizeof(addr->flags));
2885 ptr += sizeof(addr->flags);
2886 addr->message = (*ptr)? string_copy(ptr) : NULL;
2888 addr->user_message = (*ptr)? string_copy(ptr) : NULL;
2891 /* Always two strings for host information, followed by the port number */
2895 h = store_get(sizeof(host_item));
2896 h->name = string_copy(ptr);
2898 h->address = string_copy(ptr);
2900 memcpy(&(h->port), ptr, sizeof(h->port));
2901 ptr += sizeof(h->port);
2902 addr->host_used = h;
2906 /* Finished with this address */
2911 /* Z marks the logical end of the data. It is followed by '0' if
2912 continue_transport was NULL at the end of transporting, otherwise '1'.
2913 We need to know when it becomes NULL during a delivery down a passed SMTP
2914 channel so that we don't try to pass anything more down it. Of course, for
2915 most normal messages it will remain NULL all the time. */
2920 continue_transport = NULL;
2921 continue_hostname = NULL;
2924 DEBUG(D_deliver) debug_printf("Z%c item read\n", *ptr);
2927 /* Anything else is a disaster. */
2930 msg = string_sprintf("malformed data (%d) read from pipe for transport "
2931 "process %d for transport %s", ptr[-1], pid,
2932 addr->transport->driver_name);
2938 /* The done flag is inspected externally, to determine whether or not to
2939 call the function again when the process finishes. */
2943 /* If the process hadn't finished, and we haven't seen the end of the data
2944 or suffered a disaster, update the rest of the state, and return FALSE to
2945 indicate "not finished". */
2954 /* Close our end of the pipe, to prevent deadlock if the far end is still
2955 pushing stuff into it. */
2960 /* If we have finished without error, but haven't had data for every address,
2961 something is wrong. */
2963 if (msg == NULL && addr != NULL)
2964 msg = string_sprintf("insufficient address data read from pipe "
2965 "for transport process %d for transport %s", pid,
2966 addr->transport->driver_name);
2968 /* If an error message is set, something has gone wrong in getting back
2969 the delivery data. Put the message into each address and freeze it. */
2973 for (addr = addrlist; addr != NULL; addr = addr->next)
2975 addr->transport_return = DEFER;
2976 addr->special_action = SPECIAL_FREEZE;
2977 addr->message = msg;
2981 /* Return TRUE to indicate we have got all we need from this process, even
2982 if it hasn't actually finished yet. */
2989 /*************************************************
2990 * Post-process a set of remote addresses *
2991 *************************************************/
2993 /* Do what has to be done immediately after a remote delivery for each set of
2994 addresses, then re-write the spool if necessary. Note that post_process_one
2995 puts the address on an appropriate queue; hence we must fish off the next
2996 one first. This function is also called if there is a problem with setting
2997 up a subprocess to do a remote delivery in parallel. In this case, the final
2998 argument contains a message, and the action must be forced to DEFER.
3001 addr pointer to chain of address items
3002 logflags flags for logging
3003 msg NULL for normal cases; -> error message for unexpected problems
3004 fallback TRUE if processing fallback hosts
3010 remote_post_process(address_item *addr, int logflags, uschar *msg,
3015 /* If any host addresses were found to be unusable, add them to the unusable
3016 tree so that subsequent deliveries don't try them. */
3018 for (h = addr->host_list; h != NULL; h = h->next)
3020 if (h->address == NULL) continue;
3021 if (h->status >= hstatus_unusable) tree_add_unusable(h);
3024 /* Now handle each address on the chain. The transport has placed '=' or '-'
3025 into the special_action field for each successful delivery. */
3027 while (addr != NULL)
3029 address_item *next = addr->next;
3031 /* If msg == NULL (normal processing) and the result is DEFER and we are
3032 processing the main hosts and there are fallback hosts available, put the
3033 address on the list for fallback delivery. */
3035 if (addr->transport_return == DEFER &&
3036 addr->fallback_hosts != NULL &&
3040 addr->host_list = addr->fallback_hosts;
3041 addr->next = addr_fallback;
3042 addr_fallback = addr;
3043 DEBUG(D_deliver) debug_printf("%s queued for fallback host(s)\n", addr->address);
3046 /* If msg is set (=> unexpected problem), set it in the address before
3047 doing the ordinary post processing. */
3053 addr->message = msg;
3054 addr->transport_return = DEFER;
3056 (void)post_process_one(addr, addr->transport_return, logflags,
3057 DTYPE_TRANSPORT, addr->special_action);
3065 /* If we have just delivered down a passed SMTP channel, and that was
3066 the last address, the channel will have been closed down. Now that
3067 we have logged that delivery, set continue_sequence to 1 so that
3068 any subsequent deliveries don't get "*" incorrectly logged. */
3070 if (continue_transport == NULL) continue_sequence = 1;
3075 /*************************************************
3076 * Wait for one remote delivery subprocess *
3077 *************************************************/
3079 /* This function is called while doing remote deliveries when either the
3080 maximum number of processes exist and we need one to complete so that another
3081 can be created, or when waiting for the last ones to complete. It must wait for
3082 the completion of one subprocess, empty the control block slot, and return a
3083 pointer to the address chain.
3086 Returns: pointer to the chain of addresses handled by the process;
3087 NULL if no subprocess found - this is an unexpected error
3090 static address_item *
3093 int poffset, status;
3094 address_item *addr, *addrlist;
3097 set_process_info("delivering %s: waiting for a remote delivery subprocess "
3098 "to finish", message_id);
3100 /* Loop until either a subprocess completes, or there are no subprocesses in
3101 existence - in which case give an error return. We cannot proceed just by
3102 waiting for a completion, because a subprocess may have filled up its pipe, and
3103 be waiting for it to be emptied. Therefore, if no processes have finished, we
3104 wait for one of the pipes to acquire some data by calling select(), with a
3105 timeout just in case.
3107 The simple approach is just to iterate after reading data from a ready pipe.
3108 This leads to non-ideal behaviour when the subprocess has written its final Z
3109 item, closed the pipe, and is in the process of exiting (the common case). A
3110 call to waitpid() yields nothing completed, but select() shows the pipe ready -
3111 reading it yields EOF, so you end up with busy-waiting until the subprocess has
3114 To avoid this, if all the data that is needed has been read from a subprocess
3115 after select(), an explicit wait() for it is done. We know that all it is doing
3116 is writing to the pipe and then exiting, so the wait should not be long.
3118 The non-blocking waitpid() is to some extent just insurance; if we could
3119 reliably detect end-of-file on the pipe, we could always know when to do a
3120 blocking wait() for a completed process. However, because some systems use
3121 NDELAY, which doesn't distinguish between EOF and pipe empty, it is easier to
3122 use code that functions without the need to recognize EOF.
3124 There's a double loop here just in case we end up with a process that is not in
3125 the list of remote delivery processes. Something has obviously gone wrong if
3126 this is the case. (For example, a process that is incorrectly left over from
3127 routing or local deliveries might be found.) The damage can be minimized by
3128 looping back and looking for another process. If there aren't any, the error
3129 return will happen. */
3131 for (;;) /* Normally we do not repeat this loop */
3133 while ((pid = waitpid(-1, &status, WNOHANG)) <= 0)
3136 fd_set select_pipes;
3137 int maxpipe, readycount;
3139 /* A return value of -1 can mean several things. If errno != ECHILD, it
3140 either means invalid options (which we discount), or that this process was
3141 interrupted by a signal. Just loop to try the waitpid() again.
3143 If errno == ECHILD, waitpid() is telling us that there are no subprocesses
3144 in existence. This should never happen, and is an unexpected error.
3145 However, there is a nasty complication when running under Linux. If "strace
3146 -f" is being used under Linux to trace this process and its children,
3147 subprocesses are "stolen" from their parents and become the children of the
3148 tracing process. A general wait such as the one we've just obeyed returns
3149 as if there are no children while subprocesses are running. Once a
3150 subprocess completes, it is restored to the parent, and waitpid(-1) finds
3151 it. Thanks to Joachim Wieland for finding all this out and suggesting a
3154 This does not happen using "truss" on Solaris, nor (I think) with other
3155 tracing facilities on other OS. It seems to be specific to Linux.
3157 What we do to get round this is to use kill() to see if any of our
3158 subprocesses are still in existence. If kill() gives an OK return, we know
3159 it must be for one of our processes - it can't be for a re-use of the pid,
3160 because if our process had finished, waitpid() would have found it. If any
3161 of our subprocesses are in existence, we proceed to use select() as if
3162 waitpid() had returned zero. I think this is safe. */
3166 if (errno != ECHILD) continue; /* Repeats the waitpid() */
3169 debug_printf("waitpid() returned -1/ECHILD: checking explicitly "
3170 "for process existence\n");
3172 for (poffset = 0; poffset < remote_max_parallel; poffset++)
3174 if ((pid = parlist[poffset].pid) != 0 && kill(pid, 0) == 0)
3176 DEBUG(D_deliver) debug_printf("process %d still exists: assume "
3177 "stolen by strace\n", (int)pid);
3178 break; /* With poffset set */
3182 if (poffset >= remote_max_parallel)
3184 DEBUG(D_deliver) debug_printf("*** no delivery children found\n");
3185 return NULL; /* This is the error return */
3189 /* A pid value greater than 0 breaks the "while" loop. A negative value has
3190 been handled above. A return value of zero means that there is at least one
3191 subprocess, but there are no completed subprocesses. See if any pipes are
3192 ready with any data for reading. */
3194 DEBUG(D_deliver) debug_printf("selecting on subprocess pipes\n");
3197 FD_ZERO(&select_pipes);
3198 for (poffset = 0; poffset < remote_max_parallel; poffset++)
3200 if (parlist[poffset].pid != 0)
3202 int fd = parlist[poffset].fd;
3203 FD_SET(fd, &select_pipes);
3204 if (fd > maxpipe) maxpipe = fd;
3208 /* Stick in a 60-second timeout, just in case. */
3213 readycount = select(maxpipe + 1, (SELECT_ARG2_TYPE *)&select_pipes,
3216 /* Scan through the pipes and read any that are ready; use the count
3217 returned by select() to stop when there are no more. Select() can return
3218 with no processes (e.g. if interrupted). This shouldn't matter.
3220 If par_read_pipe() returns TRUE, it means that either the terminating Z was
3221 read, or there was a disaster. In either case, we are finished with this
3222 process. Do an explicit wait() for the process and break the main loop if
3225 It turns out that we have to deal with the case of an interrupted system
3226 call, which can happen on some operating systems if the signal handling is
3227 set up to do that by default. */
3230 readycount > 0 && poffset < remote_max_parallel;
3233 if ((pid = parlist[poffset].pid) != 0 &&
3234 FD_ISSET(parlist[poffset].fd, &select_pipes))
3237 if (par_read_pipe(poffset, FALSE)) /* Finished with this pipe */
3239 for (;;) /* Loop for signals */
3241 pid_t endedpid = waitpid(pid, &status, 0);
3242 if (endedpid == pid) goto PROCESS_DONE;
3243 if (endedpid != (pid_t)(-1) || errno != EINTR)
3244 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Unexpected error return "
3245 "%d (errno = %d) from waitpid() for process %d",
3246 (int)endedpid, errno, (int)pid);
3252 /* Now go back and look for a completed subprocess again. */
3255 /* A completed process was detected by the non-blocking waitpid(). Find the
3256 data block that corresponds to this subprocess. */
3258 for (poffset = 0; poffset < remote_max_parallel; poffset++)
3259 if (pid == parlist[poffset].pid) break;
3261 /* Found the data block; this is a known remote delivery process. We don't
3262 need to repeat the outer loop. This should be what normally happens. */
3264 if (poffset < remote_max_parallel) break;
3266 /* This situation is an error, but it's probably better to carry on looking
3267 for another process than to give up (as we used to do). */
3269 log_write(0, LOG_MAIN|LOG_PANIC, "Process %d finished: not found in remote "
3270 "transport process list", pid);
3271 } /* End of the "for" loop */
3273 /* Come here when all the data was completely read after a select(), and
3274 the process in pid has been wait()ed for. */
3281 debug_printf("remote delivery process %d ended\n", (int)pid);
3283 debug_printf("remote delivery process %d ended: status=%04x\n", (int)pid,
3287 set_process_info("delivering %s", message_id);
3289 /* Get the chain of processed addresses */
3291 addrlist = parlist[poffset].addrlist;
3293 /* If the process did not finish cleanly, record an error and freeze (except
3294 for SIGTERM, SIGKILL and SIGQUIT), and also ensure the journal is not removed,
3295 in case the delivery did actually happen. */
3297 if ((status & 0xffff) != 0)
3300 int msb = (status >> 8) & 255;
3301 int lsb = status & 255;
3302 int code = (msb == 0)? (lsb & 0x7f) : msb;
3304 msg = string_sprintf("%s transport process returned non-zero status 0x%04x: "
3306 addrlist->transport->driver_name,
3308 (msb == 0)? "terminated by signal" : "exit code",
3311 if (msb != 0 || (code != SIGTERM && code != SIGKILL && code != SIGQUIT))
3312 addrlist->special_action = SPECIAL_FREEZE;
3314 for (addr = addrlist; addr != NULL; addr = addr->next)
3316 addr->transport_return = DEFER;
3317 addr->message = msg;
3320 remove_journal = FALSE;
3323 /* Else complete reading the pipe to get the result of the delivery, if all
3324 the data has not yet been obtained. */
3326 else if (!parlist[poffset].done) (void)par_read_pipe(poffset, TRUE);
3328 /* Put the data count and return path into globals, mark the data slot unused,
3329 decrement the count of subprocesses, and return the address chain. */
3331 transport_count = parlist[poffset].transport_count;
3332 used_return_path = parlist[poffset].return_path;
3333 parlist[poffset].pid = 0;
3340 /*************************************************
3341 * Wait for subprocesses and post-process *
3342 *************************************************/
3344 /* This function waits for subprocesses until the number that are still running
3345 is below a given threshold. For each complete subprocess, the addresses are
3346 post-processed. If we can't find a running process, there is some shambles.
3347 Better not bomb out, as that might lead to multiple copies of the message. Just
3348 log and proceed as if all done.
3351 max maximum number of subprocesses to leave running
3352 fallback TRUE if processing fallback hosts
3358 par_reduce(int max, BOOL fallback)
3360 while (parcount > max)
3362 address_item *doneaddr = par_wait();
3363 if (doneaddr == NULL)
3365 log_write(0, LOG_MAIN|LOG_PANIC,
3366 "remote delivery process count got out of step");
3369 else remote_post_process(doneaddr, LOG_MAIN, NULL, fallback);
3376 /*************************************************
3377 * Do remote deliveries *
3378 *************************************************/
3380 /* This function is called to process the addresses in addr_remote. We must
3381 pick off the queue all addresses that have the same transport, remote
3382 destination, and errors address, and hand them to the transport in one go,
3383 subject to some configured limitations. If this is a run to continue delivering
3384 to an existing delivery channel, skip all but those addresses that can go to
3385 that channel. The skipped addresses just get deferred.
3387 If mua_wrapper is set, all addresses must be able to be sent in a single
3388 transaction. If not, this function yields FALSE.
3390 In Exim 4, remote deliveries are always done in separate processes, even
3391 if remote_max_parallel = 1 or if there's only one delivery to do. The reason
3392 is so that the base process can retain privilege. This makes the
3393 implementation of fallback transports feasible (though not initially done.)
3395 We create up to the configured number of subprocesses, each of which passes
3396 back the delivery state via a pipe. (However, when sending down an existing
3397 connection, remote_max_parallel is forced to 1.)
3400 fallback TRUE if processing fallback hosts
3402 Returns: TRUE normally
3403 FALSE if mua_wrapper is set and the addresses cannot all be sent
3408 do_remote_deliveries(BOOL fallback)
3414 parcount = 0; /* Number of executing subprocesses */
3416 /* When sending down an existing channel, only do one delivery at a time.
3417 We use a local variable (parmax) to hold the maximum number of processes;
3418 this gets reduced from remote_max_parallel if we can't create enough pipes. */
3420 if (continue_transport != NULL) remote_max_parallel = 1;
3421 parmax = remote_max_parallel;
3423 /* If the data for keeping a list of processes hasn't yet been
3426 if (parlist == NULL)
3428 parlist = store_get(remote_max_parallel * sizeof(pardata));
3429 for (poffset = 0; poffset < remote_max_parallel; poffset++)
3430 parlist[poffset].pid = 0;
3433 /* Now loop for each remote delivery */
3435 for (delivery_count = 0; addr_remote != NULL; delivery_count++)
3441 int address_count = 1;
3442 int address_count_max;
3444 BOOL use_initgroups;
3445 BOOL pipe_done = FALSE;
3446 transport_instance *tp;
3447 address_item **anchor = &addr_remote;
3448 address_item *addr = addr_remote;
3449 address_item *last = addr;
3452 /* Pull the first address right off the list. */
3454 addr_remote = addr->next;
3457 DEBUG(D_deliver|D_transport)
3458 debug_printf("--------> %s <--------\n", addr->address);
3460 /* If no transport has been set, there has been a big screw-up somewhere. */
3462 if ((tp = addr->transport) == NULL)
3464 disable_logging = FALSE; /* Jic */
3465 remote_post_process(addr, LOG_MAIN|LOG_PANIC,
3466 US"No transport set by router", fallback);
3470 /* Check that this base address hasn't previously been delivered to this
3471 transport. The check is necessary at this point to handle homonymic addresses
3472 correctly in cases where the pattern of redirection changes between delivery
3473 attempts. Non-homonymic previous delivery is detected earlier, at routing
3476 if (previously_transported(addr, FALSE)) continue;
3478 /* Force failure if the message is too big. */
3480 if (tp->message_size_limit != NULL)
3482 int rc = check_message_size(tp, addr);
3485 addr->transport_return = rc;
3486 remote_post_process(addr, LOG_MAIN, NULL, fallback);
3491 /* Get the flag which specifies whether the transport can handle different
3492 domains that nevertheless resolve to the same set of hosts. */
3494 multi_domain = tp->multi_domain;
3496 /* Get the maximum it can handle in one envelope, with zero meaning
3497 unlimited, which is forced for the MUA wrapper case. */
3499 address_count_max = tp->max_addresses;
3500 if (address_count_max == 0 || mua_wrapper) address_count_max = 999999;
3503 /************************************************************************/
3504 /***** This is slightly experimental code, but should be safe. *****/
3506 /* The address_count_max value is the maximum number of addresses that the
3507 transport can send in one envelope. However, the transport must be capable of
3508 dealing with any number of addresses. If the number it gets exceeds its
3509 envelope limitation, it must send multiple copies of the message. This can be
3510 done over a single connection for SMTP, so uses less resources than making
3511 multiple connections. On the other hand, if remote_max_parallel is greater
3512 than one, it is perhaps a good idea to use parallel processing to move the
3513 message faster, even if that results in multiple simultaneous connections to
3516 How can we come to some compromise between these two ideals? What we do is to
3517 limit the number of addresses passed to a single instance of a transport to
3518 the greater of (a) its address limit (rcpt_max for SMTP) and (b) the total
3519 number of addresses routed to remote transports divided by
3520 remote_max_parallel. For example, if the message has 100 remote recipients,
3521 remote max parallel is 2, and rcpt_max is 10, we'd never send more than 50 at
3522 once. But if rcpt_max is 100, we could send up to 100.
3524 Of course, not all the remotely addresses in a message are going to go to the
3525 same set of hosts (except in smarthost configurations), so this is just a
3526 heuristic way of dividing up the work.
3528 Furthermore (1), because this may not be wanted in some cases, and also to
3529 cope with really pathological cases, there is also a limit to the number of
3530 messages that are sent over one connection. This is the same limit that is
3531 used when sending several different messages over the same connection.
3532 Continue_sequence is set when in this situation, to the number sent so
3533 far, including this message.
3535 Furthermore (2), when somebody explicitly sets the maximum value to 1, it
3536 is probably because they are using VERP, in which case they want to pass only
3537 one address at a time to the transport, in order to be able to use
3538 $local_part and $domain in constructing a new return path. We could test for
3539 the use of these variables, but as it is so likely they will be used when the
3540 maximum is 1, we don't bother. Just leave the value alone. */
3542 if (address_count_max != 1 &&
3543 address_count_max < remote_delivery_count/remote_max_parallel)
3545 int new_max = remote_delivery_count/remote_max_parallel;
3546 int message_max = tp->connection_max_messages;
3547 if (connection_max_messages >= 0) message_max = connection_max_messages;
3548 message_max -= continue_sequence - 1;
3549 if (message_max > 0 && new_max > address_count_max * message_max)
3550 new_max = address_count_max * message_max;
3551 address_count_max = new_max;
3554 /************************************************************************/
3557 /* Pick off all addresses which have the same transport, errors address,
3558 destination, and extra headers. In some cases they point to the same host
3559 list, but we also need to check for identical host lists generated from
3560 entirely different domains. The host list pointers can be NULL in the case
3561 where the hosts are defined in the transport. There is also a configured
3562 maximum limit of addresses that can be handled at once (see comments above
3563 for how it is computed). */
3565 while ((next = *anchor) != NULL && address_count < address_count_max)
3567 if ((multi_domain || Ustrcmp(next->domain, addr->domain) == 0)
3569 tp == next->transport
3571 same_hosts(next->host_list, addr->host_list)
3573 same_strings(next->p.errors_address, addr->p.errors_address)
3575 same_headers(next->p.extra_headers, addr->p.extra_headers)
3577 same_ugid(tp, next, addr)
3579 (next->p.remove_headers == addr->p.remove_headers ||
3580 (next->p.remove_headers != NULL &&
3581 addr->p.remove_headers != NULL &&
3582 Ustrcmp(next->p.remove_headers, addr->p.remove_headers) == 0)))
3584 *anchor = next->next;
3586 next->first = addr; /* remember top one (for retry processing) */
3591 else anchor = &(next->next);
3594 /* If we are acting as an MUA wrapper, all addresses must go in a single
3595 transaction. If not, put them back on the chain and yield FALSE. */
3597 if (mua_wrapper && addr_remote != NULL)
3599 last->next = addr_remote;
3604 /* Set up the expansion variables for this set of addresses */
3606 deliver_set_expansions(addr);
3608 /* Compute the return path, expanding a new one if required. The old one
3609 must be set first, as it might be referred to in the expansion. */
3611 if(addr->p.errors_address != NULL)
3612 return_path = addr->p.errors_address;
3613 #ifdef EXPERIMENTAL_SRS
3614 else if(addr->p.srs_sender != NULL)
3615 return_path = addr->p.srs_sender;
3618 return_path = sender_address;
3620 if (tp->return_path != NULL)
3622 uschar *new_return_path = expand_string(tp->return_path);
3623 if (new_return_path == NULL)
3625 if (!expand_string_forcedfail)
3627 remote_post_process(addr, LOG_MAIN|LOG_PANIC,
3628 string_sprintf("Failed to expand return path \"%s\": %s",
3629 tp->return_path, expand_string_message), fallback);
3633 else return_path = new_return_path;
3636 /* Find the uid, gid, and use_initgroups setting for this transport. Failure
3637 logs and sets up error messages, so we just post-process and continue with
3638 the next address. */
3640 if (!findugid(addr, tp, &uid, &gid, &use_initgroups))
3642 remote_post_process(addr, LOG_MAIN|LOG_PANIC, NULL, fallback);
3646 /* If this transport has a setup function, call it now so that it gets
3647 run in this process and not in any subprocess. That way, the results of
3648 any setup that are retained by the transport can be reusable. One of the
3649 things the setup does is to set the fallback host lists in the addresses.
3650 That is why it is called at this point, before the continue delivery
3651 processing, because that might use the fallback hosts. */
3653 if (tp->setup != NULL)
3654 (void)((tp->setup)(addr->transport, addr, NULL, uid, gid, NULL));
3656 /* If this is a run to continue delivery down an already-established
3657 channel, check that this set of addresses matches the transport and
3658 the channel. If it does not, defer the addresses. If a host list exists,
3659 we must check that the continue host is on the list. Otherwise, the
3660 host is set in the transport. */
3662 continue_more = FALSE; /* In case got set for the last lot */
3663 if (continue_transport != NULL)
3665 BOOL ok = Ustrcmp(continue_transport, tp->name) == 0;
3666 if (ok && addr->host_list != NULL)
3670 for (h = addr->host_list; h != NULL; h = h->next)
3672 if (Ustrcmp(h->name, continue_hostname) == 0)
3673 { ok = TRUE; break; }
3677 /* Addresses not suitable; defer or queue for fallback hosts (which
3678 might be the continue host) and skip to next address. */
3682 DEBUG(D_deliver) debug_printf("not suitable for continue_transport\n");
3685 if (addr->fallback_hosts != NULL && !fallback)
3689 next->host_list = next->fallback_hosts;
3690 DEBUG(D_deliver) debug_printf("%s queued for fallback host(s)\n", next->address);
3691 if (next->next == NULL) break;
3694 next->next = addr_fallback;
3695 addr_fallback = addr;
3700 while (next->next != NULL) next = next->next;
3701 next->next = addr_defer;
3708 /* Set a flag indicating whether there are further addresses that list
3709 the continued host. This tells the transport to leave the channel open,
3710 but not to pass it to another delivery process. */
3712 for (next = addr_remote; next != NULL; next = next->next)
3715 for (h = next->host_list; h != NULL; h = h->next)
3717 if (Ustrcmp(h->name, continue_hostname) == 0)
3718 { continue_more = TRUE; break; }
3723 /* The transports set up the process info themselves as they may connect
3724 to more than one remote machine. They also have to set up the filter
3725 arguments, if required, so that the host name and address are available
3728 transport_filter_argv = NULL;
3730 /* Create the pipe for inter-process communication. If pipe creation
3731 fails, it is probably because the value of remote_max_parallel is so
3732 large that too many file descriptors for pipes have been created. Arrange
3733 to wait for a process to finish, and then try again. If we still can't
3734 create a pipe when all processes have finished, break the retry loop. */
3738 if (pipe(pfd) == 0) pipe_done = TRUE;
3739 else if (parcount > 0) parmax = parcount;
3742 /* We need to make the reading end of the pipe non-blocking. There are
3743 two different options for this. Exim is cunningly (I hope!) coded so
3744 that it can use either of them, though it prefers O_NONBLOCK, which
3745 distinguishes between EOF and no-more-data. */
3748 (void)fcntl(pfd[pipe_read], F_SETFL, O_NONBLOCK);
3750 (void)fcntl(pfd[pipe_read], F_SETFL, O_NDELAY);
3753 /* If the maximum number of subprocesses already exist, wait for a process
3754 to finish. If we ran out of file descriptors, parmax will have been reduced
3755 from its initial value of remote_max_parallel. */
3757 par_reduce(parmax - 1, fallback);
3760 /* If we failed to create a pipe and there were no processes to wait
3761 for, we have to give up on this one. Do this outside the above loop
3762 so that we can continue the main loop. */
3766 remote_post_process(addr, LOG_MAIN|LOG_PANIC,
3767 string_sprintf("unable to create pipe: %s", strerror(errno)), fallback);
3771 /* Find a free slot in the pardata list. Must do this after the possible
3772 waiting for processes to finish, because a terminating process will free
3775 for (poffset = 0; poffset < remote_max_parallel; poffset++)
3776 if (parlist[poffset].pid == 0) break;
3778 /* If there isn't one, there has been a horrible disaster. */
3780 if (poffset >= remote_max_parallel)
3782 (void)close(pfd[pipe_write]);
3783 (void)close(pfd[pipe_read]);
3784 remote_post_process(addr, LOG_MAIN|LOG_PANIC,
3785 US"Unexpectedly no free subprocess slot", fallback);
3789 /* Now fork a subprocess to do the remote delivery, but before doing so,
3790 ensure that any cached resourses are released so as not to interfere with
3791 what happens in the subprocess. */
3795 if ((pid = fork()) == 0)
3797 int fd = pfd[pipe_write];
3800 /* There are weird circumstances in which logging is disabled */
3802 disable_logging = tp->disable_logging;
3804 /* Show pids on debug output if parallelism possible */
3806 if (parmax > 1 && (parcount > 0 || addr_remote != NULL))
3808 DEBUG(D_any|D_v) debug_selector |= D_pid;
3809 DEBUG(D_deliver) debug_printf("Remote delivery process started\n");
3812 /* Reset the random number generator, so different processes don't all
3813 have the same sequence. In the test harness we want different, but
3814 predictable settings for each delivery process, so do something explicit
3815 here rather they rely on the fixed reset in the random number function. */
3817 random_seed = running_in_test_harness? 42 + 2*delivery_count : 0;
3819 /* Set close-on-exec on the pipe so that it doesn't get passed on to
3820 a new process that may be forked to do another delivery down the same
3823 (void)fcntl(fd, F_SETFD, fcntl(fd, F_GETFD) | FD_CLOEXEC);
3825 /* Close open file descriptors for the pipes of other processes
3826 that are running in parallel. */
3828 for (poffset = 0; poffset < remote_max_parallel; poffset++)
3829 if (parlist[poffset].pid != 0) (void)close(parlist[poffset].fd);
3831 /* This process has inherited a copy of the file descriptor
3832 for the data file, but its file pointer is shared with all the
3833 other processes running in parallel. Therefore, we have to re-open
3834 the file in order to get a new file descriptor with its own
3835 file pointer. We don't need to lock it, as the lock is held by
3836 the parent process. There doesn't seem to be any way of doing
3837 a dup-with-new-file-pointer. */
3839 (void)close(deliver_datafile);
3840 sprintf(CS spoolname, "%s/input/%s/%s-D", spool_directory, message_subdir,
3842 deliver_datafile = Uopen(spoolname, O_RDWR | O_APPEND, 0);
3844 if (deliver_datafile < 0)
3845 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Failed to reopen %s for remote "
3846 "parallel delivery: %s", spoolname, strerror(errno));
3848 /* Set the close-on-exec flag */
3850 (void)fcntl(deliver_datafile, F_SETFD, fcntl(deliver_datafile, F_GETFD) |
3853 /* Set the uid/gid of this process; bombs out on failure. */
3855 exim_setugid(uid, gid, use_initgroups,
3856 string_sprintf("remote delivery to %s with transport=%s",
3857 addr->address, tp->name));
3859 /* Close the unwanted half of this process' pipe, set the process state,
3860 and run the transport. Afterwards, transport_count will contain the number
3861 of bytes written. */
3863 (void)close(pfd[pipe_read]);
3864 set_process_info("delivering %s using %s", message_id, tp->name);
3865 debug_print_string(tp->debug_string);
3866 if (!(tp->info->code)(addr->transport, addr)) replicate_status(addr);
3868 set_process_info("delivering %s (just run %s for %s%s in subprocess)",
3869 message_id, tp->name, addr->address, (addr->next == NULL)? "" : ", ...");
3871 /* Ensure any cached resources that we used are now released */
3875 /* Pass the result back down the pipe. This is a lot more information
3876 than is needed for a local delivery. We have to send back the error
3877 status for each address, the usability status for each host that is
3878 flagged as unusable, and all the retry items. When TLS is in use, we
3879 send also the cipher and peerdn information. Each type of information
3880 is flagged by an identifying byte, and is then in a fixed format (with
3881 strings terminated by zeros), and there is a final terminator at the
3882 end. The host information and retry information is all attached to
3883 the first address, so that gets sent at the start. */
3885 /* Host unusability information: for most success cases this will
3888 for (h = addr->host_list; h != NULL; h = h->next)
3890 if (h->address == NULL || h->status < hstatus_unusable) continue;
3891 sprintf(CS big_buffer, "H%c%c%s", h->status, h->why, h->address);
3892 (void)write(fd, big_buffer, Ustrlen(big_buffer+3) + 4);
3895 /* The number of bytes written. This is the same for each address. Even
3896 if we sent several copies of the message down the same connection, the
3897 size of each one is the same, and it's that value we have got because
3898 transport_count gets reset before calling transport_write_message(). */
3900 big_buffer[0] = 'S';
3901 memcpy(big_buffer+1, &transport_count, sizeof(transport_count));
3902 (void)write(fd, big_buffer, sizeof(transport_count) + 1);
3904 /* Information about what happened to each address. Three item types are
3905 used: an optional 'X' item first, for TLS information, followed by 'R'
3906 items for any retry settings, and finally an 'A' item for the remaining
3909 for(; addr != NULL; addr = addr->next)
3914 /* The certificate verification status goes into the flags */
3916 if (tls_certificate_verified) setflag(addr, af_cert_verified);
3918 /* Use an X item only if there's something to send */
3921 if (addr->cipher != NULL)
3925 sprintf(CS ptr, "%.128s", addr->cipher);
3927 if (addr->peerdn == NULL) *ptr++ = 0; else
3929 sprintf(CS ptr, "%.512s", addr->peerdn);
3932 (void)write(fd, big_buffer, ptr - big_buffer);
3936 /* Retry information: for most success cases this will be null. */
3938 for (r = addr->retries; r != NULL; r = r->next)
3941 sprintf(CS big_buffer, "R%c%.500s", r->flags, r->key);
3942 ptr = big_buffer + Ustrlen(big_buffer+2) + 3;
3943 memcpy(ptr, &(r->basic_errno), sizeof(r->basic_errno));
3944 ptr += sizeof(r->basic_errno);
3945 memcpy(ptr, &(r->more_errno), sizeof(r->more_errno));
3946 ptr += sizeof(r->more_errno);
3947 if (r->message == NULL) *ptr++ = 0; else
3949 sprintf(CS ptr, "%.512s", r->message);
3952 (void)write(fd, big_buffer, ptr - big_buffer);
3955 /* The rest of the information goes in an 'A' item. */
3957 ptr = big_buffer + 3;
3958 sprintf(CS big_buffer, "A%c%c", addr->transport_return,
3959 addr->special_action);
3960 memcpy(ptr, &(addr->basic_errno), sizeof(addr->basic_errno));
3961 ptr += sizeof(addr->basic_errno);
3962 memcpy(ptr, &(addr->more_errno), sizeof(addr->more_errno));
3963 ptr += sizeof(addr->more_errno);
3964 memcpy(ptr, &(addr->flags), sizeof(addr->flags));
3965 ptr += sizeof(addr->flags);
3967 if (addr->message == NULL) *ptr++ = 0; else
3969 sprintf(CS ptr, "%.1024s", addr->message);
3973 if (addr->user_message == NULL) *ptr++ = 0; else
3975 sprintf(CS ptr, "%.1024s", addr->user_message);
3979 if (addr->host_used == NULL) *ptr++ = 0; else
3981 sprintf(CS ptr, "%.256s", addr->host_used->name);
3983 sprintf(CS ptr, "%.64s", addr->host_used->address);
3985 memcpy(ptr, &(addr->host_used->port), sizeof(addr->host_used->port));
3986 ptr += sizeof(addr->host_used->port);
3988 (void)write(fd, big_buffer, ptr - big_buffer);
3991 /* Add termination flag, close the pipe, and that's it. The character
3992 after 'Z' indicates whether continue_transport is now NULL or not.
3993 A change from non-NULL to NULL indicates a problem with a continuing
3996 big_buffer[0] = 'Z';
3997 big_buffer[1] = (continue_transport == NULL)? '0' : '1';
3998 (void)write(fd, big_buffer, 2);
4003 /* Back in the mainline: close the unwanted half of the pipe. */
4005 (void)close(pfd[pipe_write]);
4007 /* Fork failed; defer with error message */
4011 (void)close(pfd[pipe_read]);
4012 remote_post_process(addr, LOG_MAIN|LOG_PANIC,
4013 string_sprintf("fork failed for remote delivery to %s: %s",
4014 addr->domain, strerror(errno)), fallback);
4018 /* Fork succeeded; increment the count, and remember relevant data for
4019 when the process finishes. */
4022 parlist[poffset].addrlist = parlist[poffset].addr = addr;
4023 parlist[poffset].pid = pid;
4024 parlist[poffset].fd = pfd[pipe_read];
4025 parlist[poffset].done = FALSE;
4026 parlist[poffset].msg = NULL;
4027 parlist[poffset].return_path = return_path;
4029 /* If the process we've just started is sending a message down an existing
4030 channel, wait for it now. This ensures that only one such process runs at
4031 once, whatever the value of remote_max parallel. Otherwise, we might try to
4032 send two or more messages simultaneously down the same channel. This could
4033 happen if there are different domains that include the same host in otherwise
4034 different host lists.
4036 Also, if the transport closes down the channel, this information gets back
4037 (continue_transport gets set to NULL) before we consider any other addresses
4040 if (continue_transport != NULL) par_reduce(0, fallback);
4042 /* Otherwise, if we are running in the test harness, wait a bit, to let the
4043 newly created process get going before we create another process. This should
4044 ensure repeatability in the tests. We only need to wait a tad. */
4046 else if (running_in_test_harness) millisleep(500);
4049 /* Reached the end of the list of addresses. Wait for all the subprocesses that
4050 are still running and post-process their addresses. */
4052 par_reduce(0, fallback);
4059 /*************************************************
4060 * Split an address into local part and domain *
4061 *************************************************/
4063 /* This function initializes an address for routing by splitting it up into a
4064 local part and a domain. The local part is set up twice - once in its original
4065 casing, and once in lower case, and it is dequoted. We also do the "percent
4066 hack" for configured domains. This may lead to a DEFER result if a lookup
4067 defers. When a percent-hacking takes place, we insert a copy of the original
4068 address as a new parent of this address, as if we have had a redirection.
4071 addr points to an addr_item block containing the address
4074 DEFER - could not determine if domain is %-hackable
4078 deliver_split_address(address_item *addr)
4080 uschar *address = addr->address;
4081 uschar *domain = Ustrrchr(address, '@');
4083 int len = domain - address;
4085 addr->domain = string_copylc(domain+1); /* Domains are always caseless */
4087 /* The implication in the RFCs (though I can't say I've seen it spelled out
4088 explicitly) is that quoting should be removed from local parts at the point
4089 where they are locally interpreted. [The new draft "821" is more explicit on
4090 this, Jan 1999.] We know the syntax is valid, so this can be done by simply
4091 removing quoting backslashes and any unquoted doublequotes. */
4093 t = addr->cc_local_part = store_get(len+1);
4096 register int c = *address++;
4097 if (c == '\"') continue;
4107 /* We do the percent hack only for those domains that are listed in
4108 percent_hack_domains. A loop is required, to copy with multiple %-hacks. */
4110 if (percent_hack_domains != NULL)
4113 uschar *new_address = NULL;
4114 uschar *local_part = addr->cc_local_part;
4116 deliver_domain = addr->domain; /* set $domain */
4118 while ((rc = match_isinlist(deliver_domain, &percent_hack_domains, 0,
4119 &domainlist_anchor, addr->domain_cache, MCL_DOMAIN, TRUE, NULL))
4121 (t = Ustrrchr(local_part, '%')) != NULL)
4123 new_address = string_copy(local_part);
4124 new_address[t - local_part] = '@';
4125 deliver_domain = string_copylc(t+1);
4126 local_part = string_copyn(local_part, t - local_part);
4129 if (rc == DEFER) return DEFER; /* lookup deferred */
4131 /* If hackery happened, set up new parent and alter the current address. */
4133 if (new_address != NULL)
4135 address_item *new_parent = store_get(sizeof(address_item));
4136 *new_parent = *addr;
4137 addr->parent = new_parent;
4138 addr->address = new_address;
4139 addr->unique = string_copy(new_address);
4140 addr->domain = deliver_domain;
4141 addr->cc_local_part = local_part;
4142 DEBUG(D_deliver) debug_printf("%%-hack changed address to: %s\n",
4147 /* Create the lowercased version of the final local part, and make that the
4148 default one to be used. */
4150 addr->local_part = addr->lc_local_part = string_copylc(addr->cc_local_part);
4157 /*************************************************
4158 * Get next error message text *
4159 *************************************************/
4161 /* If f is not NULL, read the next "paragraph", from a customized error message
4162 text file, terminated by a line containing ****, and expand it.
4165 f NULL or a file to read from
4166 which string indicating which string (for errors)
4168 Returns: NULL or an expanded string
4172 next_emf(FILE *f, uschar *which)
4176 uschar *para, *yield;
4179 if (f == NULL) return NULL;
4181 if (Ufgets(buffer, sizeof(buffer), f) == NULL ||
4182 Ustrcmp(buffer, "****\n") == 0) return NULL;
4184 para = store_get(size);
4187 para = string_cat(para, &size, &ptr, buffer, Ustrlen(buffer));
4188 if (Ufgets(buffer, sizeof(buffer), f) == NULL ||
4189 Ustrcmp(buffer, "****\n") == 0) break;
4193 yield = expand_string(para);
4194 if (yield != NULL) return yield;
4196 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand string from "
4197 "bounce_message_file or warn_message_file (%s): %s", which,
4198 expand_string_message);
4205 /*************************************************
4206 * Close down a passed transport channel *
4207 *************************************************/
4209 /* This function is called when a passed transport channel cannot be used.
4210 It attempts to close it down tidily. The yield is always DELIVER_NOT_ATTEMPTED
4211 so that the function call can be the argument of a "return" statement.
4214 Returns: DELIVER_NOT_ATTEMPTED
4218 continue_closedown(void)
4220 if (continue_transport != NULL)
4222 transport_instance *t;
4223 for (t = transports; t != NULL; t = t->next)
4225 if (Ustrcmp(t->name, continue_transport) == 0)
4227 if (t->info->closedown != NULL) (t->info->closedown)(t);
4232 return DELIVER_NOT_ATTEMPTED;
4238 /*************************************************
4239 * Print address information *
4240 *************************************************/
4242 /* This function is called to output an address, or information about an
4243 address, for bounce or defer messages. If the hide_child flag is set, all we
4244 output is the original ancestor address.
4247 addr points to the address
4248 f the FILE to print to
4249 si an initial string
4250 sc a continuation string for before "generated"
4253 Returns: TRUE if the address is not hidden
4257 print_address_information(address_item *addr, FILE *f, uschar *si, uschar *sc,
4261 uschar *printed = US"";
4262 address_item *ancestor = addr;
4263 while (ancestor->parent != NULL) ancestor = ancestor->parent;
4265 fprintf(f, "%s", CS si);
4267 if (addr->parent != NULL && testflag(addr, af_hide_child))
4269 printed = US"an undisclosed address";
4272 else if (!testflag(addr, af_pfr) || addr->parent == NULL)
4273 printed = addr->address;
4277 uschar *s = addr->address;
4280 if (addr->address[0] == '>') { ss = US"mail"; s++; }
4281 else if (addr->address[0] == '|') ss = US"pipe";
4284 fprintf(f, "%s to %s%sgenerated by ", ss, s, sc);
4285 printed = addr->parent->address;
4288 fprintf(f, "%s", CS string_printing(printed));
4290 if (ancestor != addr)
4292 uschar *original = (ancestor->onetime_parent == NULL)?
4293 ancestor->address : ancestor->onetime_parent;
4294 if (strcmpic(original, printed) != 0)
4295 fprintf(f, "%s(%sgenerated from %s)", sc,
4296 (ancestor != addr->parent)? "ultimately " : "",
4297 string_printing(original));
4300 fprintf(f, "%s", CS se);
4308 /*************************************************
4309 * Print error for an address *
4310 *************************************************/
4312 /* This function is called to print the error information out of an address for
4313 a bounce or a warning message. It tries to format the message reasonably by
4314 introducing newlines. All lines are indented by 4; the initial printing
4315 position must be set before calling.
4317 This function used always to print the error. Nowadays we want to restrict it
4318 to cases such as LMTP/SMTP errors from a remote host, and errors from :fail:
4319 and filter "fail". We no longer pass other information willy-nilly in bounce
4320 and warning messages. Text in user_message is always output; text in message
4321 only if the af_pass_message flag is set.
4325 f the FILE to print on
4332 print_address_error(address_item *addr, FILE *f, uschar *t)
4334 int count = Ustrlen(t);
4335 uschar *s = testflag(addr, af_pass_message)? addr->message : NULL;
4339 if (addr->user_message != NULL) s = addr->user_message; else return;
4342 fprintf(f, "\n %s", t);
4346 if (*s == '\\' && s[1] == 'n')
4356 if (*s++ == ':' && isspace(*s) && count > 45)
4358 fprintf(f, "\n "); /* sic (because space follows) */
4370 /*************************************************
4371 * Check list of addresses for duplication *
4372 *************************************************/
4374 /* This function was introduced when the test for duplicate addresses that are
4375 not pipes, files, or autoreplies was moved from the middle of routing to when
4376 routing was complete. That was to fix obscure cases when the routing history
4377 affects the subsequent routing of identical addresses. This function is called
4378 after routing, to check that the final routed addresses are not duplicates.
4380 If we detect a duplicate, we remember what it is a duplicate of. Note that
4381 pipe, file, and autoreply de-duplication is handled during routing, so we must
4382 leave such "addresses" alone here, as otherwise they will incorrectly be
4385 Argument: address of list anchor
4390 do_duplicate_check(address_item **anchor)
4393 while ((addr = *anchor) != NULL)
4396 if (testflag(addr, af_pfr))
4398 anchor = &(addr->next);
4400 else if ((tnode = tree_search(tree_duplicates, addr->unique)) != NULL)
4402 DEBUG(D_deliver|D_route)
4403 debug_printf("%s is a duplicate address: discarded\n", addr->unique);
4404 *anchor = addr->next;
4405 addr->dupof = tnode->data.ptr;
4406 addr->next = addr_duplicate;
4407 addr_duplicate = addr;
4411 tree_add_duplicate(addr->unique, addr);
4412 anchor = &(addr->next);
4420 /*************************************************
4421 * Deliver one message *
4422 *************************************************/
4424 /* This is the function which is called when a message is to be delivered. It
4425 is passed the id of the message. It is possible that the message no longer
4426 exists, if some other process has delivered it, and it is also possible that
4427 the message is being worked on by another process, in which case the data file
4430 If no delivery is attempted for any of the above reasons, the function returns
4431 DELIVER_NOT_ATTEMPTED.
4433 If the give_up flag is set true, do not attempt any deliveries, but instead
4434 fail all outstanding addresses and return the message to the sender (or
4437 A delivery operation has a process all to itself; we never deliver more than
4438 one message in the same process. Therefore we needn't worry too much about
4442 id the id of the message to be delivered
4443 forced TRUE if delivery was forced by an administrator; this overrides
4444 retry delays and causes a delivery to be tried regardless
4445 give_up TRUE if an administrator has requested that delivery attempts
4448 Returns: When the global variable mua_wrapper is FALSE:
4449 DELIVER_ATTEMPTED_NORMAL if a delivery attempt was made
4450 DELIVER_NOT_ATTEMPTED otherwise (see comment above)
4451 When the global variable mua_wrapper is TRUE:
4452 DELIVER_MUA_SUCCEEDED if delivery succeeded
4453 DELIVER_MUA_FAILED if delivery failed
4454 DELIVER_NOT_ATTEMPTED if not attempted (should not occur)
4458 deliver_message(uschar *id, BOOL forced, BOOL give_up)
4461 int final_yield = DELIVER_ATTEMPTED_NORMAL;
4462 time_t now = time(NULL);
4463 address_item *addr_last = NULL;
4464 uschar *filter_message = NULL;
4466 int process_recipients = RECIP_ACCEPT;
4470 uschar *info = (queue_run_pid == (pid_t)0)?
4471 string_sprintf("delivering %s", id) :
4472 string_sprintf("delivering %s (queue run pid %d)", id, queue_run_pid);
4474 /* If the D_process_info bit is on, set_process_info() will output debugging
4475 information. If not, we want to show this initial information if D_deliver or
4476 D_queue_run is set or in verbose mode. */
4478 set_process_info("%s", info);
4480 if ((debug_selector & D_process_info) == 0 &&
4481 (debug_selector & (D_deliver|D_queue_run|D_v)) != 0)
4482 debug_printf("%s\n", info);
4484 /* Ensure that we catch any subprocesses that are created. Although Exim
4485 sets SIG_DFL as its initial default, some routes through the code end up
4486 here with it set to SIG_IGN - cases where a non-synchronous delivery process
4487 has been forked, but no re-exec has been done. We use sigaction rather than
4488 plain signal() on those OS where SA_NOCLDWAIT exists, because we want to be
4489 sure it is turned off. (There was a problem on AIX with this.) */
4493 struct sigaction act;
4494 act.sa_handler = SIG_DFL;
4495 sigemptyset(&(act.sa_mask));
4497 sigaction(SIGCHLD, &act, NULL);
4500 signal(SIGCHLD, SIG_DFL);
4503 /* Make the forcing flag available for routers and transports, set up the
4504 global message id field, and initialize the count for returned files and the
4505 message size. This use of strcpy() is OK because the length id is checked when
4506 it is obtained from a command line (the -M or -q options), and otherwise it is
4507 known to be a valid message id. */
4509 Ustrcpy(message_id, id);
4510 deliver_force = forced;
4514 /* Initialize some flags */
4516 update_spool = FALSE;
4517 remove_journal = TRUE;
4519 /* Reset the random number generator, so that if several delivery processes are
4520 started from a queue runner that has already used random numbers (for sorting),
4521 they don't all get the same sequence. */
4525 /* Open and lock the message's data file. Exim locks on this one because the
4526 header file may get replaced as it is re-written during the delivery process.
4527 Any failures cause messages to be written to the log, except for missing files
4528 while queue running - another process probably completed delivery. As part of
4529 opening the data file, message_subdir gets set. */
4531 if (!spool_open_datafile(id))
4532 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
4534 /* The value of message_size at this point has been set to the data length,
4535 plus one for the blank line that notionally precedes the data. */
4537 /* Now read the contents of the header file, which will set up the headers in
4538 store, and also the list of recipients and the tree of non-recipients and
4539 assorted flags. It updates message_size. If there is a reading or format error,
4540 give up; if the message has been around for sufficiently long, remove it. */
4542 sprintf(CS spoolname, "%s-H", id);
4543 if ((rc = spool_read_header(spoolname, TRUE, TRUE)) != spool_read_OK)
4545 if (errno == ERRNO_SPOOLFORMAT)
4547 struct stat statbuf;
4548 sprintf(CS big_buffer, "%s/input/%s/%s", spool_directory, message_subdir,
4550 if (Ustat(big_buffer, &statbuf) == 0)
4551 log_write(0, LOG_MAIN, "Format error in spool file %s: "
4552 "size=" OFF_T_FMT, spoolname, statbuf.st_size);
4553 else log_write(0, LOG_MAIN, "Format error in spool file %s", spoolname);
4556 log_write(0, LOG_MAIN, "Error reading spool file %s: %s", spoolname,
4559 /* If we managed to read the envelope data, received_time contains the
4560 time the message was received. Otherwise, we can calculate it from the
4563 if (rc != spool_read_hdrerror)
4566 for (i = 0; i < 6; i++)
4567 received_time = received_time * BASE_62 + tab62[id[i] - '0'];
4570 /* If we've had this malformed message too long, sling it. */
4572 if (now - received_time > keep_malformed)
4574 sprintf(CS spoolname, "%s/msglog/%s/%s", spool_directory, message_subdir, id);
4576 sprintf(CS spoolname, "%s/input/%s/%s-D", spool_directory, message_subdir, id);
4578 sprintf(CS spoolname, "%s/input/%s/%s-H", spool_directory, message_subdir, id);
4580 sprintf(CS spoolname, "%s/input/%s/%s-J", spool_directory, message_subdir, id);
4582 log_write(0, LOG_MAIN, "Message removed because older than %s",
4583 readconf_printtime(keep_malformed));
4586 (void)close(deliver_datafile);
4587 deliver_datafile = -1;
4588 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
4591 /* The spool header file has been read. Look to see if there is an existing
4592 journal file for this message. If there is, it means that a previous delivery
4593 attempt crashed (program or host) before it could update the spool header file.
4594 Read the list of delivered addresses from the journal and add them to the
4595 nonrecipients tree. Then update the spool file. We can leave the journal in
4596 existence, as it will get further successful deliveries added to it in this
4597 run, and it will be deleted if this function gets to its end successfully.
4598 Otherwise it might be needed again. */
4600 sprintf(CS spoolname, "%s/input/%s/%s-J", spool_directory, message_subdir, id);
4601 jread = Ufopen(spoolname, "rb");
4604 while (Ufgets(big_buffer, big_buffer_size, jread) != NULL)
4606 int n = Ustrlen(big_buffer);
4607 big_buffer[n-1] = 0;
4608 tree_add_nonrecipient(big_buffer);
4609 DEBUG(D_deliver) debug_printf("Previously delivered address %s taken from "
4610 "journal file\n", big_buffer);
4612 (void)fclose(jread);
4613 /* Panic-dies on error */
4614 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
4616 else if (errno != ENOENT)
4618 log_write(0, LOG_MAIN|LOG_PANIC, "attempt to open journal for reading gave: "
4619 "%s", strerror(errno));
4620 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
4623 /* A null recipients list indicates some kind of disaster. */
4625 if (recipients_list == NULL)
4627 (void)close(deliver_datafile);
4628 deliver_datafile = -1;
4629 log_write(0, LOG_MAIN, "Spool error: no recipients for %s", spoolname);
4630 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
4634 /* Handle a message that is frozen. There are a number of different things that
4635 can happen, but in the default situation, unless forced, no delivery is
4640 #ifdef SUPPORT_MOVE_FROZEN_MESSAGES
4641 /* Moving to another directory removes the message from Exim's view. Other
4642 tools must be used to deal with it. Logging of this action happens in
4643 spool_move_message() and its subfunctions. */
4645 if (move_frozen_messages &&
4646 spool_move_message(id, message_subdir, US"", US"F"))
4647 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
4650 /* For all frozen messages (bounces or not), timeout_frozen_after sets the
4651 maximum time to keep messages that are frozen. Thaw if we reach it, with a
4652 flag causing all recipients to be failed. The time is the age of the
4653 message, not the time since freezing. */
4655 if (timeout_frozen_after > 0 && message_age >= timeout_frozen_after)
4657 log_write(0, LOG_MAIN, "cancelled by timeout_frozen_after");
4658 process_recipients = RECIP_FAIL_TIMEOUT;
4661 /* For bounce messages (and others with no sender), thaw if the error message
4662 ignore timer is exceeded. The message will be discarded if this delivery
4665 else if (sender_address[0] == 0 && message_age >= ignore_bounce_errors_after)
4667 log_write(0, LOG_MAIN, "Unfrozen by errmsg timer");
4670 /* If this is a bounce message, or there's no auto thaw, or we haven't
4671 reached the auto thaw time yet, and this delivery is not forced by an admin
4672 user, do not attempt delivery of this message. Note that forced is set for
4673 continuing messages down the same channel, in order to skip load checking and
4674 ignore hold domains, but we don't want unfreezing in that case. */
4678 if ((sender_address[0] == 0 ||
4680 now <= deliver_frozen_at + auto_thaw
4683 (!forced || !deliver_force_thaw || !admin_user ||
4684 continue_hostname != NULL
4687 (void)close(deliver_datafile);
4688 deliver_datafile = -1;
4689 log_write(L_skip_delivery, LOG_MAIN, "Message is frozen");
4690 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
4693 /* If delivery was forced (by an admin user), assume a manual thaw.
4694 Otherwise it's an auto thaw. */
4698 deliver_manual_thaw = TRUE;
4699 log_write(0, LOG_MAIN, "Unfrozen by forced delivery");
4701 else log_write(0, LOG_MAIN, "Unfrozen by auto-thaw");
4704 /* We get here if any of the rules for unfreezing have triggered. */
4706 deliver_freeze = FALSE;
4707 update_spool = TRUE;
4711 /* Open the message log file if we are using them. This records details of
4712 deliveries, deferments, and failures for the benefit of the mail administrator.
4713 The log is not used by exim itself to track the progress of a message; that is
4714 done by rewriting the header spool file. */
4721 sprintf(CS spoolname, "%s/msglog/%s/%s", spool_directory, message_subdir, id);
4722 fd = open_msglog_file(spoolname, SPOOL_MODE, &error);
4726 log_write(0, LOG_MAIN|LOG_PANIC, "Couldn't %s message log %s: %s", error,
4727 spoolname, strerror(errno));
4728 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
4731 /* Make a C stream out of it. */
4733 message_log = fdopen(fd, "a");
4734 if (message_log == NULL)
4736 log_write(0, LOG_MAIN|LOG_PANIC, "Couldn't fdopen message log %s: %s",
4737 spoolname, strerror(errno));
4738 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
4743 /* If asked to give up on a message, log who did it, and set the action for all
4748 struct passwd *pw = getpwuid(real_uid);
4749 log_write(0, LOG_MAIN, "cancelled by %s", (pw != NULL)?
4750 US pw->pw_name : string_sprintf("uid %ld", (long int)real_uid));
4751 process_recipients = RECIP_FAIL;
4754 /* Otherwise, if there are too many Received: headers, fail all recipients. */
4756 else if (received_count > received_headers_max)
4757 process_recipients = RECIP_FAIL_LOOP;
4759 /* Otherwise, if a system-wide, address-independent message filter is
4760 specified, run it now, except in the case when we are failing all recipients as
4761 a result of timeout_frozen_after. If the system filter yields "delivered", then
4762 ignore the true recipients of the message. Failure of the filter file is
4763 logged, and the delivery attempt fails. */
4765 else if (system_filter != NULL && process_recipients != RECIP_FAIL_TIMEOUT)
4770 redirect_block redirect;
4772 if (system_filter_uid_set)
4774 ugid.uid = system_filter_uid;
4775 ugid.gid = system_filter_gid;
4776 ugid.uid_set = ugid.gid_set = TRUE;
4780 ugid.uid_set = ugid.gid_set = FALSE;
4783 return_path = sender_address;
4784 enable_dollar_recipients = TRUE; /* Permit $recipients in system filter */
4785 system_filtering = TRUE;
4787 /* Any error in the filter file causes a delivery to be abandoned. */
4789 redirect.string = system_filter;
4790 redirect.isfile = TRUE;
4791 redirect.check_owner = redirect.check_group = FALSE;
4792 redirect.owners = NULL;
4793 redirect.owngroups = NULL;
4795 redirect.modemask = 0;
4797 DEBUG(D_deliver|D_filter) debug_printf("running system filter\n");
4800 &redirect, /* Where the data is */
4801 RDO_DEFER | /* Turn on all the enabling options */
4802 RDO_FAIL | /* Leave off all the disabling options */
4807 NULL, /* No :include: restriction (not used in filter) */
4808 NULL, /* No sieve vacation directory (not sieve!) */
4809 NULL, /* No sieve user address (not sieve!) */
4810 NULL, /* No sieve subaddress (not sieve!) */
4811 &ugid, /* uid/gid data */
4812 &addr_new, /* Where to hang generated addresses */
4813 &filter_message, /* Where to put error message */
4814 NULL, /* Don't skip syntax errors */
4815 &filtertype, /* Will always be set to FILTER_EXIM for this call */
4816 US"system filter"); /* For error messages */
4818 DEBUG(D_deliver|D_filter) debug_printf("system filter returned %d\n", rc);
4820 if (rc == FF_ERROR || rc == FF_NONEXIST)
4822 (void)close(deliver_datafile);
4823 deliver_datafile = -1;
4824 log_write(0, LOG_MAIN|LOG_PANIC, "Error in system filter: %s",
4825 string_printing(filter_message));
4826 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
4829 /* Reset things. If the filter message is an empty string, which can happen
4830 for a filter "fail" or "freeze" command with no text, reset it to NULL. */
4832 system_filtering = FALSE;
4833 enable_dollar_recipients = FALSE;
4834 if (filter_message != NULL && filter_message[0] == 0) filter_message = NULL;
4836 /* Save the values of the system filter variables so that user filters
4839 memcpy(filter_sn, filter_n, sizeof(filter_sn));
4841 /* The filter can request that delivery of the original addresses be
4846 process_recipients = RECIP_DEFER;
4847 deliver_msglog("Delivery deferred by system filter\n");
4848 log_write(0, LOG_MAIN, "Delivery deferred by system filter");
4851 /* The filter can request that a message be frozen, but this does not
4852 take place if the message has been manually thawed. In that case, we must
4853 unset "delivered", which is forced by the "freeze" command to make -bF
4856 else if (rc == FF_FREEZE && !deliver_manual_thaw)
4858 deliver_freeze = TRUE;
4859 deliver_frozen_at = time(NULL);
4860 process_recipients = RECIP_DEFER;
4861 frozen_info = string_sprintf(" by the system filter%s%s",
4862 (filter_message == NULL)? US"" : US": ",
4863 (filter_message == NULL)? US"" : filter_message);
4866 /* The filter can request that a message be failed. The error message may be
4867 quite long - it is sent back to the sender in the bounce - but we don't want
4868 to fill up the log with repetitions of it. If it starts with << then the text
4869 between << and >> is written to the log, with the rest left for the bounce
4872 else if (rc == FF_FAIL)
4874 uschar *colon = US"";
4875 uschar *logmsg = US"";
4878 process_recipients = RECIP_FAIL_FILTER;
4880 if (filter_message != NULL)
4884 if (filter_message[0] == '<' && filter_message[1] == '<' &&
4885 (logend = Ustrstr(filter_message, ">>")) != NULL)
4887 logmsg = filter_message + 2;
4888 loglen = logend - logmsg;
4889 filter_message = logend + 2;
4890 if (filter_message[0] == 0) filter_message = NULL;
4894 logmsg = filter_message;
4895 loglen = Ustrlen(filter_message);
4899 log_write(0, LOG_MAIN, "cancelled by system filter%s%.*s", colon, loglen,
4903 /* Delivery can be restricted only to those recipients (if any) that the
4904 filter specified. */
4906 else if (rc == FF_DELIVERED)
4908 process_recipients = RECIP_IGNORE;
4909 if (addr_new == NULL)
4910 log_write(0, LOG_MAIN, "=> discarded (system filter)");
4912 log_write(0, LOG_MAIN, "original recipients ignored (system filter)");
4915 /* If any new addresses were created by the filter, fake up a "parent"
4916 for them. This is necessary for pipes, etc., which are expected to have
4917 parents, and it also gives some sensible logging for others. Allow
4918 pipes, files, and autoreplies, and run them as the filter uid if set,
4919 otherwise as the current uid. */
4921 if (addr_new != NULL)
4923 int uid = (system_filter_uid_set)? system_filter_uid : geteuid();
4924 int gid = (system_filter_gid_set)? system_filter_gid : getegid();
4926 /* The text "system-filter" is tested in transport_set_up_command() and in
4927 set_up_shell_command() in the pipe transport, to enable them to permit
4928 $recipients, so don't change it here without also changing it there. */
4930 address_item *p = addr_new;
4931 address_item *parent = deliver_make_addr(US"system-filter", FALSE);
4933 parent->domain = string_copylc(qualify_domain_recipient);
4934 parent->local_part = US"system-filter";
4936 /* As part of this loop, we arrange for addr_last to end up pointing
4937 at the final address. This is used if we go on to add addresses for the
4938 original recipients. */
4942 if (parent->child_count == SHRT_MAX)
4943 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "system filter generated more "
4944 "than %d delivery addresses", SHRT_MAX);
4945 parent->child_count++;
4948 if (testflag(p, af_pfr))
4954 setflag(p, af_uid_set |
4960 /* Find the name of the system filter's appropriate pfr transport */
4962 if (p->address[0] == '|')
4965 tpname = system_filter_pipe_transport;
4966 address_pipe = p->address;
4968 else if (p->address[0] == '>')
4971 tpname = system_filter_reply_transport;
4975 if (p->address[Ustrlen(p->address)-1] == '/')
4977 type = US"directory";
4978 tpname = system_filter_directory_transport;
4983 tpname = system_filter_file_transport;
4985 address_file = p->address;
4988 /* Now find the actual transport, first expanding the name. We have
4989 set address_file or address_pipe above. */
4993 uschar *tmp = expand_string(tpname);
4994 address_file = address_pipe = NULL;
4996 p->message = string_sprintf("failed to expand \"%s\" as a "
4997 "system filter transport name", tpname);
5002 p->message = string_sprintf("system_filter_%s_transport is unset",
5008 transport_instance *tp;
5009 for (tp = transports; tp != NULL; tp = tp->next)
5011 if (Ustrcmp(tp->name, tpname) == 0)
5018 p->message = string_sprintf("failed to find \"%s\" transport "
5019 "for system filter delivery", tpname);
5022 /* If we couldn't set up a transport, defer the delivery, putting the
5023 error on the panic log as well as the main log. */
5025 if (p->transport == NULL)
5027 address_item *badp = p;
5029 if (addr_last == NULL) addr_new = p; else addr_last->next = p;
5030 badp->local_part = badp->address; /* Needed for log line */
5031 post_process_one(badp, DEFER, LOG_MAIN|LOG_PANIC, DTYPE_ROUTER, 0);
5034 } /* End of pfr handling */
5036 /* Either a non-pfr delivery, or we found a transport */
5038 DEBUG(D_deliver|D_filter)
5039 debug_printf("system filter added %s\n", p->address);
5043 } /* Loop through all addr_new addresses */
5048 /* Scan the recipients list, and for every one that is not in the non-
5049 recipients tree, add an addr item to the chain of new addresses. If the pno
5050 value is non-negative, we must set the onetime parent from it. This which
5051 points to the relevant entry in the recipients list.
5053 This processing can be altered by the setting of the process_recipients
5054 variable, which is changed if recipients are to be ignored, failed, or
5055 deferred. This can happen as a result of system filter activity, or if the -Mg
5056 option is used to fail all of them.
5058 Duplicate addresses are handled later by a different tree structure; we can't
5059 just extend the non-recipients tree, because that will be re-written to the
5060 spool if the message is deferred, and in any case there are casing
5061 complications for local addresses. */
5063 if (process_recipients != RECIP_IGNORE)
5065 for (i = 0; i < recipients_count; i++)
5067 if (tree_search(tree_nonrecipients, recipients_list[i].address) == NULL)
5069 recipient_item *r = recipients_list + i;
5070 address_item *new = deliver_make_addr(r->address, FALSE);
5071 new->p.errors_address = r->errors_to;
5074 new->onetime_parent = recipients_list[r->pno].address;
5076 switch (process_recipients)
5078 /* RECIP_DEFER is set when a system filter freezes a message. */
5081 new->next = addr_defer;
5086 /* RECIP_FAIL_FILTER is set when a system filter has obeyed a "fail"
5089 case RECIP_FAIL_FILTER:
5091 (filter_message == NULL)? US"delivery cancelled" : filter_message;
5092 setflag(new, af_pass_message);
5093 goto RECIP_QUEUE_FAILED; /* below */
5096 /* RECIP_FAIL_TIMEOUT is set when a message is frozen, but is older
5097 than the value in timeout_frozen_after. Treat non-bounce messages
5098 similarly to -Mg; for bounce messages we just want to discard, so
5099 don't put the address on the failed list. The timeout has already
5102 case RECIP_FAIL_TIMEOUT:
5103 new->message = US"delivery cancelled; message timed out";
5104 goto RECIP_QUEUE_FAILED; /* below */
5107 /* RECIP_FAIL is set when -Mg has been used. */
5110 new->message = US"delivery cancelled by administrator";
5113 /* Common code for the failure cases above. If this is not a bounce
5114 message, put the address on the failed list so that it is used to
5115 create a bounce. Otherwise do nothing - this just discards the address.
5116 The incident has already been logged. */
5119 if (sender_address[0] != 0)
5121 new->next = addr_failed;
5127 /* RECIP_FAIL_LOOP is set when there are too many Received: headers
5128 in the message. Process each address as a routing failure; if this
5129 is a bounce message, it will get frozen. */
5131 case RECIP_FAIL_LOOP:
5132 new->message = US"Too many \"Received\" headers - suspected mail loop";
5133 post_process_one(new, FAIL, LOG_MAIN, DTYPE_ROUTER, 0);
5137 /* Value should be RECIP_ACCEPT; take this as the safe default. */
5140 if (addr_new == NULL) addr_new = new; else addr_last->next = new;
5150 address_item *p = addr_new;
5151 debug_printf("Delivery address list:\n");
5154 debug_printf(" %s %s\n", p->address, (p->onetime_parent == NULL)? US"" :
5160 /* Set up the buffers used for copying over the file when delivering. */
5162 deliver_in_buffer = store_malloc(DELIVER_IN_BUFFER_SIZE);
5163 deliver_out_buffer = store_malloc(DELIVER_OUT_BUFFER_SIZE);
5167 /* Until there are no more new addresses, handle each one as follows:
5169 . If this is a generated address (indicated by the presence of a parent
5170 pointer) then check to see whether it is a pipe, file, or autoreply, and
5171 if so, handle it directly here. The router that produced the address will
5172 have set the allow flags into the address, and also set the uid/gid required.
5173 Having the routers generate new addresses and then checking them here at
5174 the outer level is tidier than making each router do the checking, and
5175 means that routers don't need access to the failed address queue.
5177 . Break up the address into local part and domain, and make lowercased
5178 versions of these strings. We also make unquoted versions of the local part.
5180 . Handle the percent hack for those domains for which it is valid.
5182 . For child addresses, determine if any of the parents have the same address.
5183 If so, generate a different string for previous delivery checking. Without
5184 this code, if the address spqr generates spqr via a forward or alias file,
5185 delivery of the generated spqr stops further attempts at the top level spqr,
5186 which is not what is wanted - it may have generated other addresses.
5188 . Check on the retry database to see if routing was previously deferred, but
5189 only if in a queue run. Addresses that are to be routed are put on the
5190 addr_route chain. Addresses that are to be deferred are put on the
5191 addr_defer chain. We do all the checking first, so as not to keep the
5192 retry database open any longer than necessary.
5194 . Now we run the addresses through the routers. A router may put the address
5195 on either the addr_local or the addr_remote chain for local or remote
5196 delivery, respectively, or put it on the addr_failed chain if it is
5197 undeliveable, or it may generate child addresses and put them on the
5198 addr_new chain, or it may defer an address. All the chain anchors are
5199 passed as arguments so that the routers can be called for verification
5202 . If new addresses have been generated by the routers, da capo.
5205 header_rewritten = FALSE; /* No headers rewritten yet */
5206 while (addr_new != NULL) /* Loop until all addresses dealt with */
5208 address_item *addr, *parent;
5209 dbm_file = dbfn_open(US"retry", O_RDONLY, &dbblock, FALSE);
5211 /* Failure to open the retry database is treated the same as if it does
5212 not exist. In both cases, dbm_file is NULL. */
5214 if (dbm_file == NULL)
5216 DEBUG(D_deliver|D_retry|D_route|D_hints_lookup)
5217 debug_printf("no retry data available\n");
5220 /* Scan the current batch of new addresses, to handle pipes, files and
5221 autoreplies, and determine which others are ready for routing. */
5223 while (addr_new != NULL)
5228 dbdata_retry *domain_retry_record;
5229 dbdata_retry *address_retry_record;
5232 addr_new = addr->next;
5234 DEBUG(D_deliver|D_retry|D_route)
5236 debug_printf(">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>\n");
5237 debug_printf("Considering: %s\n", addr->address);
5240 /* Handle generated address that is a pipe or a file or an autoreply. */
5242 if (testflag(addr, af_pfr))
5244 /* If an autoreply in a filter could not generate a syntactically valid
5245 address, give up forthwith. Set af_ignore_error so that we don't try to
5246 generate a bounce. */
5248 if (testflag(addr, af_bad_reply))
5250 addr->basic_errno = ERRNO_BADADDRESS2;
5251 addr->local_part = addr->address;
5253 US"filter autoreply generated syntactically invalid recipient";
5254 setflag(addr, af_ignore_error);
5255 (void)post_process_one(addr, FAIL, LOG_MAIN, DTYPE_ROUTER, 0);
5256 continue; /* with the next new address */
5259 /* If two different users specify delivery to the same pipe or file or
5260 autoreply, there should be two different deliveries, so build a unique
5261 string that incorporates the original address, and use this for
5262 duplicate testing and recording delivery, and also for retrying. */
5265 string_sprintf("%s:%s", addr->address, addr->parent->unique +
5266 (testflag(addr->parent, af_homonym)? 3:0));
5268 addr->address_retry_key = addr->domain_retry_key =
5269 string_sprintf("T:%s", addr->unique);
5271 /* If a filter file specifies two deliveries to the same pipe or file,
5272 we want to de-duplicate, but this is probably not wanted for two mail
5273 commands to the same address, where probably both should be delivered.
5274 So, we have to invent a different unique string in that case. Just
5275 keep piling '>' characters on the front. */
5277 if (addr->address[0] == '>')
5279 while (tree_search(tree_duplicates, addr->unique) != NULL)
5280 addr->unique = string_sprintf(">%s", addr->unique);
5283 else if ((tnode = tree_search(tree_duplicates, addr->unique)) != NULL)
5285 DEBUG(D_deliver|D_route)
5286 debug_printf("%s is a duplicate address: discarded\n", addr->address);
5287 addr->dupof = tnode->data.ptr;
5288 addr->next = addr_duplicate;
5289 addr_duplicate = addr;
5293 DEBUG(D_deliver|D_route) debug_printf("unique = %s\n", addr->unique);
5295 /* Check for previous delivery */
5297 if (tree_search(tree_nonrecipients, addr->unique) != NULL)
5299 DEBUG(D_deliver|D_route)
5300 debug_printf("%s was previously delivered: discarded\n", addr->address);
5301 child_done(addr, tod_stamp(tod_log));
5305 /* Save for checking future duplicates */
5307 tree_add_duplicate(addr->unique, addr);
5309 /* Set local part and domain */
5311 addr->local_part = addr->address;
5312 addr->domain = addr->parent->domain;
5314 /* Ensure that the delivery is permitted. */
5316 if (testflag(addr, af_file))
5318 if (!testflag(addr, af_allow_file))
5320 addr->basic_errno = ERRNO_FORBIDFILE;
5321 addr->message = US"delivery to file forbidden";
5322 (void)post_process_one(addr, FAIL, LOG_MAIN, DTYPE_ROUTER, 0);
5323 continue; /* with the next new address */
5326 else if (addr->address[0] == '|')
5328 if (!testflag(addr, af_allow_pipe))
5330 addr->basic_errno = ERRNO_FORBIDPIPE;
5331 addr->message = US"delivery to pipe forbidden";
5332 (void)post_process_one(addr, FAIL, LOG_MAIN, DTYPE_ROUTER, 0);
5333 continue; /* with the next new address */
5336 else if (!testflag(addr, af_allow_reply))
5338 addr->basic_errno = ERRNO_FORBIDREPLY;
5339 addr->message = US"autoreply forbidden";
5340 (void)post_process_one(addr, FAIL, LOG_MAIN, DTYPE_ROUTER, 0);
5341 continue; /* with the next new address */
5344 /* If the errno field is already set to BADTRANSPORT, it indicates
5345 failure to expand a transport string, or find the associated transport,
5346 or an unset transport when one is required. Leave this test till now so
5347 that the forbid errors are given in preference. */
5349 if (addr->basic_errno == ERRNO_BADTRANSPORT)
5351 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_ROUTER, 0);
5355 /* Treat /dev/null as a special case and abandon the delivery. This
5356 avoids having to specify a uid on the transport just for this case.
5357 Arrange for the transport name to be logged as "**bypassed**". */
5359 if (Ustrcmp(addr->address, "/dev/null") == 0)
5361 uschar *save = addr->transport->name;
5362 addr->transport->name = US"**bypassed**";
5363 (void)post_process_one(addr, OK, LOG_MAIN, DTYPE_TRANSPORT, '=');
5364 addr->transport->name = save;
5365 continue; /* with the next new address */
5368 /* Pipe, file, or autoreply delivery is to go ahead as a normal local
5371 DEBUG(D_deliver|D_route)
5372 debug_printf("queued for %s transport\n", addr->transport->name);
5373 addr->next = addr_local;
5375 continue; /* with the next new address */
5378 /* Handle normal addresses. First, split up into local part and domain,
5379 handling the %-hack if necessary. There is the possibility of a defer from
5380 a lookup in percent_hack_domains. */
5382 if ((rc = deliver_split_address(addr)) == DEFER)
5384 addr->message = US"cannot check percent_hack_domains";
5385 addr->basic_errno = ERRNO_LISTDEFER;
5386 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_NONE, 0);
5390 /* Check to see if the domain is held. If so, proceed only if the
5391 delivery was forced by hand. */
5393 deliver_domain = addr->domain; /* set $domain */
5394 if (!forced && hold_domains != NULL &&
5395 (rc = match_isinlist(addr->domain, &hold_domains, 0,
5396 &domainlist_anchor, addr->domain_cache, MCL_DOMAIN, TRUE,
5401 addr->message = US"hold_domains lookup deferred";
5402 addr->basic_errno = ERRNO_LISTDEFER;
5406 addr->message = US"domain is held";
5407 addr->basic_errno = ERRNO_HELD;
5409 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_NONE, 0);
5413 /* Now we can check for duplicates and previously delivered addresses. In
5414 order to do this, we have to generate a "unique" value for each address,
5415 because there may be identical actual addresses in a line of descendents.
5416 The "unique" field is initialized to the same value as the "address" field,
5417 but gets changed here to cope with identically-named descendents. */
5419 for (parent = addr->parent; parent != NULL; parent = parent->parent)
5420 if (strcmpic(addr->address, parent->address) == 0) break;
5422 /* If there's an ancestor with the same name, set the homonym flag. This
5423 influences how deliveries are recorded. Then add a prefix on the front of
5424 the unique address. We use \n\ where n starts at 0 and increases each time.
5425 It is unlikely to pass 9, but if it does, it may look odd but will still
5426 work. This means that siblings or cousins with the same names are treated
5427 as duplicates, which is what we want. */
5431 setflag(addr, af_homonym);
5432 if (parent->unique[0] != '\\')
5433 addr->unique = string_sprintf("\\0\\%s", addr->address);
5435 addr->unique = string_sprintf("\\%c\\%s", parent->unique[1] + 1,
5439 /* Ensure that the domain in the unique field is lower cased, because
5440 domains are always handled caselessly. */
5442 p = Ustrrchr(addr->unique, '@');
5443 while (*p != 0) { *p = tolower(*p); p++; }
5445 DEBUG(D_deliver|D_route) debug_printf("unique = %s\n", addr->unique);
5447 if (tree_search(tree_nonrecipients, addr->unique) != NULL)
5449 DEBUG(D_deliver|D_route)
5450 debug_printf("%s was previously delivered: discarded\n", addr->unique);
5451 child_done(addr, tod_stamp(tod_log));
5455 /* Get the routing retry status, saving the two retry keys (with and
5456 without the local part) for subsequent use. If there is no retry record for
5457 the standard address routing retry key, we look for the same key with the
5458 sender attached, because this form is used by the smtp transport after a
5459 4xx response to RCPT when address_retry_include_sender is true. */
5461 addr->domain_retry_key = string_sprintf("R:%s", addr->domain);
5462 addr->address_retry_key = string_sprintf("R:%s@%s", addr->local_part,
5465 if (dbm_file == NULL)
5466 domain_retry_record = address_retry_record = NULL;
5469 domain_retry_record = dbfn_read(dbm_file, addr->domain_retry_key);
5470 if (domain_retry_record != NULL &&
5471 now - domain_retry_record->time_stamp > retry_data_expire)
5472 domain_retry_record = NULL; /* Ignore if too old */
5474 address_retry_record = dbfn_read(dbm_file, addr->address_retry_key);
5475 if (address_retry_record != NULL &&
5476 now - address_retry_record->time_stamp > retry_data_expire)
5477 address_retry_record = NULL; /* Ignore if too old */
5479 if (address_retry_record == NULL)
5481 uschar *altkey = string_sprintf("%s:<%s>", addr->address_retry_key,
5483 address_retry_record = dbfn_read(dbm_file, altkey);
5484 if (address_retry_record != NULL &&
5485 now - address_retry_record->time_stamp > retry_data_expire)
5486 address_retry_record = NULL; /* Ignore if too old */
5490 DEBUG(D_deliver|D_retry)
5492 if (domain_retry_record == NULL)
5493 debug_printf("no domain retry record\n");
5494 if (address_retry_record == NULL)
5495 debug_printf("no address retry record\n");
5498 /* If we are sending a message down an existing SMTP connection, we must
5499 assume that the message which created the connection managed to route
5500 an address to that connection. We do not want to run the risk of taking
5501 a long time over routing here, because if we do, the server at the other
5502 end of the connection may time it out. This is especially true for messages
5503 with lots of addresses. For this kind of delivery, queue_running is not
5504 set, so we would normally route all addresses. We take a pragmatic approach
5505 and defer routing any addresses that have any kind of domain retry record.
5506 That is, we don't even look at their retry times. It doesn't matter if this
5507 doesn't work occasionally. This is all just an optimization, after all.
5509 The reason for not doing the same for address retries is that they normally
5510 arise from 4xx responses, not DNS timeouts. */
5512 if (continue_hostname != NULL && domain_retry_record != NULL)
5514 addr->message = US"reusing SMTP connection skips previous routing defer";
5515 addr->basic_errno = ERRNO_RRETRY;
5516 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_ROUTER, 0);
5519 /* If we are in a queue run, defer routing unless there is no retry data or
5520 we've passed the next retry time, or this message is forced. In other
5521 words, ignore retry data when not in a queue run.
5523 However, if the domain retry time has expired, always allow the routing
5524 attempt. If it fails again, the address will be failed. This ensures that
5525 each address is routed at least once, even after long-term routing
5528 If there is an address retry, check that too; just wait for the next
5529 retry time. This helps with the case when the temporary error on the
5530 address was really message-specific rather than address specific, since
5531 it allows other messages through.
5533 We also wait for the next retry time if this is a message sent down an
5534 existing SMTP connection (even though that will be forced). Otherwise there
5535 will be far too many attempts for an address that gets a 4xx error. In
5536 fact, after such an error, we should not get here because, the host should
5537 not be remembered as one this message needs. However, there was a bug that
5538 used to cause this to happen, so it is best to be on the safe side. */
5540 else if (((queue_running && !deliver_force) || continue_hostname != NULL)
5542 ((domain_retry_record != NULL &&
5543 now < domain_retry_record->next_try &&
5544 !domain_retry_record->expired)
5546 (address_retry_record != NULL &&
5547 now < address_retry_record->next_try))
5550 addr->message = US"retry time not reached";
5551 addr->basic_errno = ERRNO_RRETRY;
5552 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_ROUTER, 0);
5555 /* The domain is OK for routing. Remember if retry data exists so it
5556 can be cleaned up after a successful delivery. */
5560 if (domain_retry_record != NULL || address_retry_record != NULL)
5561 setflag(addr, af_dr_retry_exists);
5562 addr->next = addr_route;
5564 DEBUG(D_deliver|D_route)
5565 debug_printf("%s: queued for routing\n", addr->address);
5569 /* The database is closed while routing is actually happening. Requests to
5570 update it are put on a chain and all processed together at the end. */
5572 if (dbm_file != NULL) dbfn_close(dbm_file);
5574 /* If queue_domains is set, we don't even want to try routing addresses in
5575 those domains. During queue runs, queue_domains is forced to be unset.
5576 Optimize by skipping this pass through the addresses if nothing is set. */
5578 if (!deliver_force && queue_domains != NULL)
5580 address_item *okaddr = NULL;
5581 while (addr_route != NULL)
5583 address_item *addr = addr_route;
5584 addr_route = addr->next;
5586 deliver_domain = addr->domain; /* set $domain */
5587 if ((rc = match_isinlist(addr->domain, &queue_domains, 0,
5588 &domainlist_anchor, addr->domain_cache, MCL_DOMAIN, TRUE, NULL))
5593 addr->basic_errno = ERRNO_LISTDEFER;
5594 addr->message = US"queue_domains lookup deferred";
5595 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_ROUTER, 0);
5599 addr->next = okaddr;
5605 addr->basic_errno = ERRNO_QUEUE_DOMAIN;
5606 addr->message = US"domain is in queue_domains";
5607 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_ROUTER, 0);
5611 addr_route = okaddr;
5614 /* Now route those addresses that are not deferred. */
5616 while (addr_route != NULL)
5619 address_item *addr = addr_route;
5620 uschar *old_domain = addr->domain;
5621 uschar *old_unique = addr->unique;
5622 addr_route = addr->next;
5625 /* Just in case some router parameter refers to it. */
5627 return_path = (addr->p.errors_address != NULL)?
5628 addr->p.errors_address : sender_address;
5630 /* If a router defers an address, add a retry item. Whether or not to
5631 use the local part in the key is a property of the router. */
5633 if ((rc = route_address(addr, &addr_local, &addr_remote, &addr_new,
5634 &addr_succeed, v_none)) == DEFER)
5635 retry_add_item(addr, (addr->router->retry_use_local_part)?
5636 string_sprintf("R:%s@%s", addr->local_part, addr->domain) :
5637 string_sprintf("R:%s", addr->domain), 0);
5639 /* Otherwise, if there is an existing retry record in the database, add
5640 retry items to delete both forms. We must also allow for the possibility
5641 of a routing retry that includes the sender address. Since the domain might
5642 have been rewritten (expanded to fully qualified) as a result of routing,
5643 ensure that the rewritten form is also deleted. */
5645 else if (testflag(addr, af_dr_retry_exists))
5647 uschar *altkey = string_sprintf("%s:<%s>", addr->address_retry_key,
5649 retry_add_item(addr, altkey, rf_delete);
5650 retry_add_item(addr, addr->address_retry_key, rf_delete);
5651 retry_add_item(addr, addr->domain_retry_key, rf_delete);
5652 if (Ustrcmp(addr->domain, old_domain) != 0)
5653 retry_add_item(addr, string_sprintf("R:%s", old_domain), rf_delete);
5656 /* DISCARD is given for :blackhole: and "seen finish". The event has been
5657 logged, but we need to ensure the address (and maybe parents) is marked
5662 address_done(addr, tod_stamp(tod_log));
5663 continue; /* route next address */
5666 /* The address is finished with (failed or deferred). */
5670 (void)post_process_one(addr, rc, LOG_MAIN, DTYPE_ROUTER, 0);
5671 continue; /* route next address */
5674 /* The address has been routed. If the router changed the domain, it will
5675 also have changed the unique address. We have to test whether this address
5676 has already been delivered, because it's the unique address that finally
5679 if (addr->unique != old_unique &&
5680 tree_search(tree_nonrecipients, addr->unique) != 0)
5682 DEBUG(D_deliver|D_route) debug_printf("%s was previously delivered: "
5683 "discarded\n", addr->address);
5684 if (addr_remote == addr) addr_remote = addr->next;
5685 else if (addr_local == addr) addr_local = addr->next;
5688 /* If the router has same_domain_copy_routing set, we are permitted to copy
5689 the routing for any other addresses with the same domain. This is an
5690 optimisation to save repeated DNS lookups for "standard" remote domain
5691 routing. The option is settable only on routers that generate host lists.
5692 We play it very safe, and do the optimization only if the address is routed
5693 to a remote transport, there are no header changes, and the domain was not
5694 modified by the router. */
5696 if (addr_remote == addr &&
5697 addr->router->same_domain_copy_routing &&
5698 addr->p.extra_headers == NULL &&
5699 addr->p.remove_headers == NULL &&
5700 old_domain == addr->domain)
5702 address_item **chain = &addr_route;
5703 while (*chain != NULL)
5705 address_item *addr2 = *chain;
5706 if (Ustrcmp(addr2->domain, addr->domain) != 0)
5708 chain = &(addr2->next);
5712 /* Found a suitable address; take it off the routing list and add it to
5713 the remote delivery list. */
5715 *chain = addr2->next;
5716 addr2->next = addr_remote;
5717 addr_remote = addr2;
5719 /* Copy the routing data */
5721 addr2->domain = addr->domain;
5722 addr2->router = addr->router;
5723 addr2->transport = addr->transport;
5724 addr2->host_list = addr->host_list;
5725 addr2->fallback_hosts = addr->fallback_hosts;
5726 addr2->p.errors_address = addr->p.errors_address;
5727 copyflag(addr2, addr, af_hide_child | af_local_host_removed);
5729 DEBUG(D_deliver|D_route)
5731 debug_printf(">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>\n"
5733 "Routing for %s copied from %s\n",
5734 addr2->address, addr2->address, addr->address);
5738 } /* Continue with routing the next address. */
5739 } /* Loop to process any child addresses that the routers created, and
5740 any rerouted addresses that got put back on the new chain. */
5743 /* Debugging: show the results of the routing */
5745 DEBUG(D_deliver|D_retry|D_route)
5747 address_item *p = addr_local;
5748 debug_printf(">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>\n");
5749 debug_printf("After routing:\n Local deliveries:\n");
5752 debug_printf(" %s\n", p->address);
5757 debug_printf(" Remote deliveries:\n");
5760 debug_printf(" %s\n", p->address);
5765 debug_printf(" Failed addresses:\n");
5768 debug_printf(" %s\n", p->address);
5773 debug_printf(" Deferred addresses:\n");
5776 debug_printf(" %s\n", p->address);
5781 /* Free any resources that were cached during routing. */
5786 /* These two variables are set only during routing, after check_local_user.
5787 Ensure they are not set in transports. */
5789 local_user_gid = (gid_t)(-1);
5790 local_user_uid = (uid_t)(-1);
5792 /* Check for any duplicate addresses. This check is delayed until after
5793 routing, because the flexibility of the routing configuration means that
5794 identical addresses with different parentage may end up being redirected to
5795 different addresses. Checking for duplicates too early (as we previously used
5796 to) makes this kind of thing not work. */
5798 do_duplicate_check(&addr_local);
5799 do_duplicate_check(&addr_remote);
5801 /* When acting as an MUA wrapper, we proceed only if all addresses route to a
5802 remote transport. The check that they all end up in one transaction happens in
5803 the do_remote_deliveries() function. */
5805 if (mua_wrapper && (addr_local != NULL || addr_failed != NULL ||
5806 addr_defer != NULL))
5809 uschar *which, *colon, *msg;
5811 if (addr_local != NULL)
5816 else if (addr_defer != NULL)
5819 which = US"deferred";
5827 while (addr->parent != NULL) addr = addr->parent;
5829 if (addr->message != NULL)
5832 msg = addr->message;
5834 else colon = msg = US"";
5836 /* We don't need to log here for a forced failure as it will already
5837 have been logged. Defer will also have been logged, but as a defer, so we do
5838 need to do the failure logging. */
5840 if (addr != addr_failed)
5841 log_write(0, LOG_MAIN, "** %s routing yielded a %s delivery",
5842 addr->address, which);
5844 /* Always write an error to the caller */
5846 fprintf(stderr, "routing %s yielded a %s delivery%s%s\n", addr->address,
5849 final_yield = DELIVER_MUA_FAILED;
5850 addr_failed = addr_defer = NULL; /* So that we remove the message */
5851 goto DELIVERY_TIDYUP;
5855 /* If this is a run to continue deliveries to an external channel that is
5856 already set up, defer any local deliveries. */
5858 if (continue_transport != NULL)
5860 if (addr_defer == NULL) addr_defer = addr_local; else
5862 address_item *addr = addr_defer;
5863 while (addr->next != NULL) addr = addr->next;
5864 addr->next = addr_local;
5870 /* Because address rewriting can happen in the routers, we should not really do
5871 ANY deliveries until all addresses have been routed, so that all recipients of
5872 the message get the same headers. However, this is in practice not always
5873 possible, since sometimes remote addresses give DNS timeouts for days on end.
5874 The pragmatic approach is to deliver what we can now, saving any rewritten
5875 headers so that at least the next lot of recipients benefit from the rewriting
5876 that has already been done.
5878 If any headers have been rewritten during routing, update the spool file to
5879 remember them for all subsequent deliveries. This can be delayed till later if
5880 there is only address to be delivered - if it succeeds the spool write need not
5883 if (header_rewritten &&
5884 ((addr_local != NULL &&
5885 (addr_local->next != NULL || addr_remote != NULL)) ||
5886 (addr_remote != NULL && addr_remote->next != NULL)))
5888 /* Panic-dies on error */
5889 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
5890 header_rewritten = FALSE;
5894 /* If there are any deliveries to be done, open the journal file. This is used
5895 to record successful deliveries as soon as possible after each delivery is
5896 known to be complete. A file opened with O_APPEND is used so that several
5897 processes can run simultaneously.
5899 The journal is just insurance against crashes. When the spool file is
5900 ultimately updated at the end of processing, the journal is deleted. If a
5901 journal is found to exist at the start of delivery, the addresses listed
5902 therein are added to the non-recipients. */
5904 if (addr_local != NULL || addr_remote != NULL)
5906 sprintf(CS spoolname, "%s/input/%s/%s-J", spool_directory, message_subdir, id);
5907 journal_fd = Uopen(spoolname, O_WRONLY|O_APPEND|O_CREAT, SPOOL_MODE);
5911 log_write(0, LOG_MAIN|LOG_PANIC, "Couldn't open journal file %s: %s",
5912 spoolname, strerror(errno));
5913 return DELIVER_NOT_ATTEMPTED;
5916 /* Set the close-on-exec flag, make the file owned by Exim, and ensure
5917 that the mode is correct - the group setting doesn't always seem to get
5918 set automatically. */
5920 (void)fcntl(journal_fd, F_SETFD, fcntl(journal_fd, F_GETFD) | FD_CLOEXEC);
5921 (void)fchown(journal_fd, exim_uid, exim_gid);
5922 (void)fchmod(journal_fd, SPOOL_MODE);
5926 /* Now we can get down to the business of actually doing deliveries. Local
5927 deliveries are done first, then remote ones. If ever the problems of how to
5928 handle fallback transports are figured out, this section can be put into a loop
5929 for handling fallbacks, though the uid switching will have to be revised. */
5931 /* Precompile a regex that is used to recognize a parameter in response
5932 to an LHLO command, if is isn't already compiled. This may be used on both
5933 local and remote LMTP deliveries. */
5935 if (regex_IGNOREQUOTA == NULL) regex_IGNOREQUOTA =
5936 regex_must_compile(US"\\n250[\\s\\-]IGNOREQUOTA(\\s|\\n|$)", FALSE, TRUE);
5938 /* Handle local deliveries */
5940 if (addr_local != NULL)
5942 DEBUG(D_deliver|D_transport)
5943 debug_printf(">>>>>>>>>>>>>>>> Local deliveries >>>>>>>>>>>>>>>>\n");
5944 do_local_deliveries();
5945 disable_logging = FALSE;
5948 /* If queue_run_local is set, we do not want to attempt any remote deliveries,
5949 so just queue them all. */
5951 if (queue_run_local)
5953 while (addr_remote != NULL)
5955 address_item *addr = addr_remote;
5956 addr_remote = addr->next;
5958 addr->basic_errno = ERRNO_LOCAL_ONLY;
5959 addr->message = US"remote deliveries suppressed";
5960 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_TRANSPORT, 0);
5964 /* Handle remote deliveries */
5966 if (addr_remote != NULL)
5968 DEBUG(D_deliver|D_transport)
5969 debug_printf(">>>>>>>>>>>>>>>> Remote deliveries >>>>>>>>>>>>>>>>\n");
5971 /* Precompile some regex that are used to recognize parameters in response
5972 to an EHLO command, if they aren't already compiled. */
5974 if (regex_PIPELINING == NULL) regex_PIPELINING =
5975 regex_must_compile(US"\\n250[\\s\\-]PIPELINING(\\s|\\n|$)", FALSE, TRUE);
5977 if (regex_SIZE == NULL) regex_SIZE =
5978 regex_must_compile(US"\\n250[\\s\\-]SIZE(\\s|\\n|$)", FALSE, TRUE);
5980 if (regex_AUTH == NULL) regex_AUTH =
5981 regex_must_compile(US"\\n250[\\s\\-]AUTH\\s+([\\-\\w\\s]+)(?:\\n|$)",
5985 if (regex_STARTTLS == NULL) regex_STARTTLS =
5986 regex_must_compile(US"\\n250[\\s\\-]STARTTLS(\\s|\\n|$)", FALSE, TRUE);
5989 /* Now sort the addresses if required, and do the deliveries. The yield of
5990 do_remote_deliveries is FALSE when mua_wrapper is set and all addresses
5991 cannot be delivered in one transaction. */
5993 if (remote_sort_domains != NULL) sort_remote_deliveries();
5994 if (!do_remote_deliveries(FALSE))
5996 log_write(0, LOG_MAIN, "** mua_wrapper is set but recipients cannot all "
5997 "be delivered in one transaction");
5998 fprintf(stderr, "delivery to smarthost failed (configuration problem)\n");
6000 final_yield = DELIVER_MUA_FAILED;
6001 addr_failed = addr_defer = NULL; /* So that we remove the message */
6002 goto DELIVERY_TIDYUP;
6005 /* See if any of the addresses that failed got put on the queue for delivery
6006 to their fallback hosts. We do it this way because often the same fallback
6007 host is used for many domains, so all can be sent in a single transaction
6008 (if appropriately configured). */
6010 if (addr_fallback != NULL && !mua_wrapper)
6012 DEBUG(D_deliver) debug_printf("Delivering to fallback hosts\n");
6013 addr_remote = addr_fallback;
6014 addr_fallback = NULL;
6015 if (remote_sort_domains != NULL) sort_remote_deliveries();
6016 do_remote_deliveries(TRUE);
6018 disable_logging = FALSE;
6022 /* All deliveries are now complete. Ignore SIGTERM during this tidying up
6023 phase, to minimize cases of half-done things. */
6026 debug_printf(">>>>>>>>>>>>>>>> deliveries are done >>>>>>>>>>>>>>>>\n");
6028 /* Root privilege is no longer needed */
6030 exim_setugid(exim_uid, exim_gid, FALSE, US"post-delivery tidying");
6032 set_process_info("tidying up after delivering %s", message_id);
6033 signal(SIGTERM, SIG_IGN);
6035 /* When we are acting as an MUA wrapper, the smtp transport will either have
6036 succeeded for all addresses, or failed them all in normal cases. However, there
6037 are some setup situations (e.g. when a named port does not exist) that cause an
6038 immediate exit with deferral of all addresses. Convert those into failures. We
6039 do not ever want to retry, nor do we want to send a bounce message. */
6043 if (addr_defer != NULL)
6045 address_item *addr, *nextaddr;
6046 for (addr = addr_defer; addr != NULL; addr = nextaddr)
6048 log_write(0, LOG_MAIN, "** %s mua_wrapper forced failure for deferred "
6049 "delivery", addr->address);
6050 nextaddr = addr->next;
6051 addr->next = addr_failed;
6057 /* Now all should either have succeeded or failed. */
6059 if (addr_failed == NULL) final_yield = DELIVER_MUA_SUCCEEDED; else
6061 uschar *s = (addr_failed->user_message != NULL)?
6062 addr_failed->user_message : addr_failed->message;
6064 fprintf(stderr, "Delivery failed: ");
6065 if (addr_failed->basic_errno > 0)
6067 fprintf(stderr, "%s", strerror(addr_failed->basic_errno));
6068 if (s != NULL) fprintf(stderr, ": ");
6072 if (addr_failed->basic_errno <= 0) fprintf(stderr, "unknown error");
6074 else fprintf(stderr, "%s", CS s);
6075 fprintf(stderr, "\n");
6077 final_yield = DELIVER_MUA_FAILED;
6082 /* In a normal configuration, we now update the retry database. This is done in
6083 one fell swoop at the end in order not to keep opening and closing (and
6084 locking) the database. The code for handling retries is hived off into a
6085 separate module for convenience. We pass it the addresses of the various
6086 chains, because deferred addresses can get moved onto the failed chain if the
6087 retry cutoff time has expired for all alternative destinations. Bypass the
6088 updating of the database if the -N flag is set, which is a debugging thing that
6089 prevents actual delivery. */
6091 else if (!dont_deliver) retry_update(&addr_defer, &addr_failed, &addr_succeed);
6093 /* If any addresses failed, we must send a message to somebody, unless
6094 af_ignore_error is set, in which case no action is taken. It is possible for
6095 several messages to get sent if there are addresses with different
6098 while (addr_failed != NULL)
6102 uschar *logtod = tod_stamp(tod_log);
6104 address_item *handled_addr = NULL;
6105 address_item **paddr;
6106 address_item *msgchain = NULL;
6107 address_item **pmsgchain = &msgchain;
6109 /* There are weird cases when logging is disabled in the transport. However,
6110 there may not be a transport (address failed by a router). */
6112 disable_logging = FALSE;
6113 if (addr_failed->transport != NULL)
6114 disable_logging = addr_failed->transport->disable_logging;
6117 debug_printf("processing failed address %s\n", addr_failed->address);
6119 /* There are only two ways an address in a bounce message can get here:
6121 (1) When delivery was initially deferred, but has now timed out (in the call
6122 to retry_update() above). We can detect this by testing for
6123 af_retry_timedout. If the address does not have its own errors address,
6124 we arrange to ignore the error.
6126 (2) If delivery failures for bounce messages are being ignored. We can detect
6127 this by testing for af_ignore_error. This will also be set if a bounce
6128 message has been autothawed and the ignore_bounce_errors_after time has
6129 passed. It might also be set if a router was explicitly configured to
6130 ignore errors (errors_to = "").
6132 If neither of these cases obtains, something has gone wrong. Log the
6133 incident, but then ignore the error. */
6135 if (sender_address[0] == 0 && addr_failed->p.errors_address == NULL)
6137 if (!testflag(addr_failed, af_retry_timedout) &&
6138 !testflag(addr_failed, af_ignore_error))
6140 log_write(0, LOG_MAIN|LOG_PANIC, "internal error: bounce message "
6141 "failure is neither frozen nor ignored (it's been ignored)");
6143 setflag(addr_failed, af_ignore_error);
6146 /* If the first address on the list has af_ignore_error set, just remove
6147 it from the list, throw away any saved message file, log it, and
6148 mark the recipient done. */
6150 if (testflag(addr_failed, af_ignore_error))
6153 addr_failed = addr->next;
6154 if (addr->return_filename != NULL) Uunlink(addr->return_filename);
6156 log_write(0, LOG_MAIN, "%s%s%s%s: error ignored",
6158 (addr->parent == NULL)? US"" : US" <",
6159 (addr->parent == NULL)? US"" : addr->parent->address,
6160 (addr->parent == NULL)? US"" : US">");
6162 address_done(addr, logtod);
6163 child_done(addr, logtod);
6164 /* Panic-dies on error */
6165 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
6168 /* Otherwise, handle the sending of a message. Find the error address for
6169 the first address, then send a message that includes all failed addresses
6170 that have the same error address. Note the bounce_recipient is a global so
6171 that it can be accesssed by $bounce_recipient while creating a customized
6176 bounce_recipient = (addr_failed->p.errors_address == NULL)?
6177 sender_address : addr_failed->p.errors_address;
6179 /* Make a subprocess to send a message */
6181 pid = child_open_exim(&fd);
6183 /* Creation of child failed */
6186 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Process %d (parent %d) failed to "
6187 "create child process to send failure message: %s", getpid(),
6188 getppid(), strerror(errno));
6190 /* Creation of child succeeded */
6197 uschar *bcc, *emf_text;
6198 FILE *f = fdopen(fd, "wb");
6200 BOOL to_sender = strcmpic(sender_address, bounce_recipient) == 0;
6201 int max = (bounce_return_size_limit/DELIVER_IN_BUFFER_SIZE + 1) *
6202 DELIVER_IN_BUFFER_SIZE;
6205 debug_printf("sending error message to: %s\n", bounce_recipient);
6207 /* Scan the addresses for all that have the same errors address, removing
6208 them from the addr_failed chain, and putting them on msgchain. */
6210 paddr = &addr_failed;
6211 for (addr = addr_failed; addr != NULL; addr = *paddr)
6213 if (Ustrcmp(bounce_recipient, (addr->p.errors_address == NULL)?
6214 sender_address : addr->p.errors_address) != 0)
6216 paddr = &(addr->next); /* Not the same; skip */
6218 else /* The same - dechain */
6220 *paddr = addr->next;
6223 pmsgchain = &(addr->next);
6227 /* Include X-Failed-Recipients: for automatic interpretation, but do
6228 not let any one header line get too long. We do this by starting a
6229 new header every 50 recipients. Omit any addresses for which the
6230 "hide_child" flag is set. */
6232 for (addr = msgchain; addr != NULL; addr = addr->next)
6234 if (testflag(addr, af_hide_child)) continue;
6241 (rcount++ == 0)? "X-Failed-Recipients: " : ",\n ",
6242 (testflag(addr, af_pfr) && addr->parent != NULL)?
6243 string_printing(addr->parent->address) :
6244 string_printing(addr->address));
6246 if (rcount > 0) fprintf(f, "\n");
6248 /* Output the standard headers */
6250 if (errors_reply_to != NULL)
6251 fprintf(f, "Reply-To: %s\n", errors_reply_to);
6252 fprintf(f, "Auto-Submitted: auto-replied\n");
6254 fprintf(f, "To: %s\n", bounce_recipient);
6256 /* Open a template file if one is provided. Log failure to open, but
6257 carry on - default texts will be used. */
6259 if (bounce_message_file != NULL)
6261 emf = Ufopen(bounce_message_file, "rb");
6263 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to open %s for error "
6264 "message texts: %s", bounce_message_file, strerror(errno));
6267 /* Quietly copy to configured additional addresses if required. */
6269 bcc = moan_check_errorcopy(bounce_recipient);
6270 if (bcc != NULL) fprintf(f, "Bcc: %s\n", bcc);
6272 /* The texts for the message can be read from a template file; if there
6273 isn't one, or if it is too short, built-in texts are used. The first
6274 emf text is a Subject: and any other headers. */
6276 emf_text = next_emf(emf, US"header");
6277 if (emf_text != NULL) fprintf(f, "%s\n", emf_text); else
6279 fprintf(f, "Subject: Mail delivery failed%s\n\n",
6280 to_sender? ": returning message to sender" : "");
6283 emf_text = next_emf(emf, US"intro");
6284 if (emf_text != NULL) fprintf(f, "%s", CS emf_text); else
6287 /* This message has been reworded several times. It seems to be confusing to
6288 somebody, however it is worded. I have retreated to the original, simple
6290 "This message was created automatically by mail delivery software.\n");
6291 if (bounce_message_text != NULL) fprintf(f, "%s", CS bounce_message_text);
6295 "\nA message that you sent could not be delivered to one or more of its\n"
6296 "recipients. This is a permanent error. The following address(es) failed:\n");
6301 "\nA message sent by\n\n <%s>\n\n"
6302 "could not be delivered to one or more of its recipients. The following\n"
6303 "address(es) failed:\n", sender_address);
6308 /* Process the addresses, leaving them on the msgchain if they have a
6309 file name for a return message. (There has already been a check in
6310 post_process_one() for the existence of data in the message file.) A TRUE
6311 return from print_address_information() means that the address is not
6315 for (addr = msgchain; addr != NULL; addr = *paddr)
6317 if (print_address_information(addr, f, US" ", US"\n ", US""))
6318 print_address_error(addr, f, US"");
6320 /* End the final line for the address */
6324 /* Leave on msgchain if there's a return file. */
6326 if (addr->return_file >= 0)
6328 paddr = &(addr->next);
6332 /* Else save so that we can tick off the recipient when the
6337 *paddr = addr->next;
6338 addr->next = handled_addr;
6339 handled_addr = addr;
6345 /* Get the next text, whether we need it or not, so as to be
6346 positioned for the one after. */
6348 emf_text = next_emf(emf, US"generated text");
6350 /* If there were any file messages passed by the local transports,
6351 include them in the message. Then put the address on the handled chain.
6352 In the case of a batch of addresses that were all sent to the same
6353 transport, the return_file field in all of them will contain the same
6354 fd, and the return_filename field in the *last* one will be set (to the
6355 name of the file). */
6357 if (msgchain != NULL)
6359 address_item *nextaddr;
6361 if (emf_text != NULL) fprintf(f, "%s", CS emf_text); else
6363 "The following text was generated during the delivery "
6364 "attempt%s:\n", (filecount > 1)? "s" : "");
6366 for (addr = msgchain; addr != NULL; addr = nextaddr)
6369 address_item *topaddr = addr;
6371 /* List all the addresses that relate to this file */
6374 while(addr != NULL) /* Insurance */
6376 print_address_information(addr, f, US"------ ", US"\n ",
6378 if (addr->return_filename != NULL) break;
6383 /* Now copy the file */
6385 fm = Ufopen(addr->return_filename, "rb");
6388 fprintf(f, " +++ Exim error... failed to open text file: %s\n",
6392 while ((ch = fgetc(fm)) != EOF) fputc(ch, f);
6395 Uunlink(addr->return_filename);
6397 /* Can now add to handled chain, first fishing off the next
6398 address on the msgchain. */
6400 nextaddr = addr->next;
6401 addr->next = handled_addr;
6402 handled_addr = topaddr;
6407 /* Now copy the message, trying to give an intelligible comment if
6408 it is too long for it all to be copied. The limit isn't strictly
6409 applied because of the buffering. There is, however, an option
6410 to suppress copying altogether. */
6412 emf_text = next_emf(emf, US"copy");
6414 if (bounce_return_message)
6416 int topt = topt_add_return_path;
6417 if (!bounce_return_body) topt |= topt_no_body;
6419 if (emf_text != NULL) fprintf(f, "%s", CS emf_text); else
6421 if (bounce_return_body) fprintf(f,
6422 "------ This is a copy of the message, including all the headers. ------\n");
6424 "------ This is a copy of the message's headers. ------\n");
6427 /* While reading the "truncated" message, set return_size_limit to
6428 the actual max testing value, rounded. We need to read the message
6429 whether we are going to use it or not. */
6432 int temp = bounce_return_size_limit;
6433 bounce_return_size_limit = (max/1000)*1000;
6434 emf_text = next_emf(emf, US"truncated");
6435 bounce_return_size_limit = temp;
6438 if (bounce_return_body && bounce_return_size_limit > 0)
6440 struct stat statbuf;
6441 if (fstat(deliver_datafile, &statbuf) == 0 && statbuf.st_size > max)
6443 if (emf_text != NULL) fprintf(f, "%s", CS emf_text); else
6446 "------ The body of the message is " OFF_T_FMT " characters long; only the first\n"
6447 "------ %d or so are included here.\n", statbuf.st_size, max);
6454 transport_filter_argv = NULL; /* Just in case */
6455 return_path = sender_address; /* In case not previously set */
6456 transport_write_message(NULL, fileno(f), topt,
6457 bounce_return_size_limit, NULL, NULL, NULL, NULL, NULL, 0);
6460 /* Write final text and close the template file if one is open */
6464 emf_text = next_emf(emf, US"final");
6465 if (emf_text != NULL) fprintf(f, "%s", CS emf_text);
6469 /* Close the file, which should send an EOF to the child process
6470 that is receiving the message. Wait for it to finish. */
6473 rc = child_close(pid, 0); /* Waits for child to close, no timeout */
6475 /* In the test harness, let the child do it's thing first. */
6477 if (running_in_test_harness) millisleep(500);
6479 /* If the process failed, there was some disaster in setting up the
6480 error message. Unless the message is very old, ensure that addr_defer
6481 is non-null, which will have the effect of leaving the message on the
6482 spool. The failed addresses will get tried again next time. However, we
6483 don't really want this to happen too often, so freeze the message unless
6484 there are some genuine deferred addresses to try. To do this we have
6485 to call spool_write_header() here, because with no genuine deferred
6486 addresses the normal code below doesn't get run. */
6491 if (now - received_time < retry_maximum_timeout && addr_defer == NULL)
6493 addr_defer = (address_item *)(+1);
6494 deliver_freeze = TRUE;
6495 deliver_frozen_at = time(NULL);
6496 /* Panic-dies on error */
6497 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
6500 deliver_msglog("Process failed (%d) when writing error message "
6501 "to %s%s", rc, bounce_recipient, s);
6502 log_write(0, LOG_MAIN, "Process failed (%d) when writing error message "
6503 "to %s%s", rc, bounce_recipient, s);
6506 /* The message succeeded. Ensure that the recipients that failed are
6507 now marked finished with on the spool and their parents updated. */
6511 for (addr = handled_addr; addr != NULL; addr = addr->next)
6513 address_done(addr, logtod);
6514 child_done(addr, logtod);
6516 /* Panic-dies on error */
6517 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
6523 disable_logging = FALSE; /* In case left set */
6525 /* Come here from the mua_wrapper case if routing goes wrong */
6529 /* If there are now no deferred addresses, we are done. Preserve the
6530 message log if so configured, and we are using them. Otherwise, sling it.
6531 Then delete the message itself. */
6533 if (addr_defer == NULL)
6537 sprintf(CS spoolname, "%s/msglog/%s/%s", spool_directory, message_subdir,
6539 if (preserve_message_logs)
6542 sprintf(CS big_buffer, "%s/msglog.OLD/%s", spool_directory, id);
6543 if ((rc = Urename(spoolname, big_buffer)) < 0)
6545 (void)directory_make(spool_directory, US"msglog.OLD",
6546 MSGLOG_DIRECTORY_MODE, TRUE);
6547 rc = Urename(spoolname, big_buffer);
6550 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to move %s to the "
6551 "msglog.OLD directory", spoolname);
6555 if (Uunlink(spoolname) < 0)
6556 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s", spoolname);
6560 /* Remove the two message files. */
6562 sprintf(CS spoolname, "%s/input/%s/%s-D", spool_directory, message_subdir, id);
6563 if (Uunlink(spoolname) < 0)
6564 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s", spoolname);
6565 sprintf(CS spoolname, "%s/input/%s/%s-H", spool_directory, message_subdir, id);
6566 if (Uunlink(spoolname) < 0)
6567 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s", spoolname);
6569 /* Log the end of this message, with queue time if requested. */
6571 if ((log_extra_selector & LX_queue_time_overall) != 0)
6572 log_write(0, LOG_MAIN, "Completed QT=%s",
6573 readconf_printtime(time(NULL) - received_time));
6575 log_write(0, LOG_MAIN, "Completed");
6577 /* Unset deliver_freeze so that we won't try to move the spool files further down */
6578 deliver_freeze = FALSE;
6581 /* If there are deferred addresses, we are keeping this message because it is
6582 not yet completed. Lose any temporary files that were catching output from
6583 pipes for any of the deferred addresses, handle one-time aliases, and see if
6584 the message has been on the queue for so long that it is time to send a warning
6585 message to the sender, unless it is a mailer-daemon. If all deferred addresses
6586 have the same domain, we can set deliver_domain for the expansion of
6587 delay_warning_ condition - if any of them are pipes, files, or autoreplies, use
6588 the parent's domain.
6590 If all the deferred addresses have an error number that indicates "retry time
6591 not reached", skip sending the warning message, because it won't contain the
6592 reason for the delay. It will get sent at the next real delivery attempt.
6593 However, if at least one address has tried, we'd better include all of them in
6596 If we can't make a process to send the message, don't worry.
6598 For mailing list expansions we want to send the warning message to the
6599 mailing list manager. We can't do a perfect job here, as some addresses may
6600 have different errors addresses, but if we take the errors address from
6601 each deferred address it will probably be right in most cases.
6603 If addr_defer == +1, it means there was a problem sending an error message
6604 for failed addresses, and there were no "real" deferred addresses. The value
6605 was set just to keep the message on the spool, so there is nothing to do here.
6608 else if (addr_defer != (address_item *)(+1))
6611 uschar *recipients = US"";
6612 BOOL delivery_attempted = FALSE;
6614 deliver_domain = testflag(addr_defer, af_pfr)?
6615 addr_defer->parent->domain : addr_defer->domain;
6617 for (addr = addr_defer; addr != NULL; addr = addr->next)
6619 address_item *otaddr;
6621 if (addr->basic_errno > ERRNO_RETRY_BASE) delivery_attempted = TRUE;
6623 if (deliver_domain != NULL)
6625 uschar *d = (testflag(addr, af_pfr))? addr->parent->domain : addr->domain;
6627 /* The domain may be unset for an address that has never been routed
6628 because the system filter froze the message. */
6630 if (d == NULL || Ustrcmp(d, deliver_domain) != 0) deliver_domain = NULL;
6633 if (addr->return_filename != NULL) Uunlink(addr->return_filename);
6635 /* Handle the case of one-time aliases. If any address in the ancestry
6636 of this one is flagged, ensure it is in the recipients list, suitably
6637 flagged, and that its parent is marked delivered. */
6639 for (otaddr = addr; otaddr != NULL; otaddr = otaddr->parent)
6640 if (otaddr->onetime_parent != NULL) break;
6645 int t = recipients_count;
6647 for (i = 0; i < recipients_count; i++)
6649 uschar *r = recipients_list[i].address;
6650 if (Ustrcmp(otaddr->onetime_parent, r) == 0) t = i;
6651 if (Ustrcmp(otaddr->address, r) == 0) break;
6654 /* Didn't find the address already in the list, and did find the
6655 ultimate parent's address in the list. After adding the recipient,
6656 update the errors address in the recipients list. */
6658 if (i >= recipients_count && t < recipients_count)
6660 DEBUG(D_deliver) debug_printf("one_time: adding %s in place of %s\n",
6661 otaddr->address, otaddr->parent->address);
6662 receive_add_recipient(otaddr->address, t);
6663 recipients_list[recipients_count-1].errors_to = otaddr->p.errors_address;
6664 tree_add_nonrecipient(otaddr->parent->address);
6665 update_spool = TRUE;
6669 /* Except for error messages, ensure that either the errors address for
6670 this deferred address or, if there is none, the sender address, is on the
6671 list of recipients for a warning message. */
6673 if (sender_address[0] != 0)
6675 if (addr->p.errors_address == NULL)
6677 if (Ustrstr(recipients, sender_address) == NULL)
6678 recipients = string_sprintf("%s%s%s", recipients,
6679 (recipients[0] == 0)? "" : ",", sender_address);
6683 if (Ustrstr(recipients, addr->p.errors_address) == NULL)
6684 recipients = string_sprintf("%s%s%s", recipients,
6685 (recipients[0] == 0)? "" : ",", addr->p.errors_address);
6690 /* Send a warning message if the conditions are right. If the condition check
6691 fails because of a lookup defer, there is nothing we can do. The warning
6692 is not sent. Another attempt will be made at the next delivery attempt (if
6695 if (!queue_2stage && delivery_attempted &&
6696 delay_warning[1] > 0 && sender_address[0] != 0 &&
6697 (delay_warning_condition == NULL ||
6698 expand_check_condition(delay_warning_condition,
6699 US"delay_warning", US"option")))
6703 int queue_time = time(NULL) - received_time;
6705 /* When running in the test harness, there's an option that allows us to
6706 fudge this time so as to get repeatability of the tests. Take the first
6707 time off the list. In queue runs, the list pointer gets updated in the
6710 if (running_in_test_harness && fudged_queue_times[0] != 0)
6712 int qt = readconf_readtime(fudged_queue_times, '/', FALSE);
6715 DEBUG(D_deliver) debug_printf("fudged queue_times = %s\n",
6716 fudged_queue_times);
6721 /* See how many warnings we should have sent by now */
6723 for (count = 0; count < delay_warning[1]; count++)
6724 if (queue_time < delay_warning[count+2]) break;
6726 show_time = delay_warning[count+1];
6728 if (count >= delay_warning[1])
6731 int last_gap = show_time;
6732 if (count > 1) last_gap -= delay_warning[count];
6733 extra = (queue_time - delay_warning[count+1])/last_gap;
6734 show_time += last_gap * extra;
6740 debug_printf("time on queue = %s\n", readconf_printtime(queue_time));
6741 debug_printf("warning counts: required %d done %d\n", count,
6745 /* We have computed the number of warnings there should have been by now.
6746 If there haven't been enough, send one, and up the count to what it should
6749 if (warning_count < count)
6753 pid_t pid = child_open_exim(&fd);
6759 FILE *f = fdopen(fd, "wb");
6761 if (warn_message_file != NULL)
6763 wmf = Ufopen(warn_message_file, "rb");
6765 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to open %s for warning "
6766 "message texts: %s", warn_message_file, strerror(errno));
6769 warnmsg_recipients = recipients;
6770 warnmsg_delay = (queue_time < 120*60)?
6771 string_sprintf("%d minutes", show_time/60):
6772 string_sprintf("%d hours", show_time/3600);
6774 if (errors_reply_to != NULL)
6775 fprintf(f, "Reply-To: %s\n", errors_reply_to);
6776 fprintf(f, "Auto-Submitted: auto-replied\n");
6778 fprintf(f, "To: %s\n", recipients);
6780 wmf_text = next_emf(wmf, US"header");
6781 if (wmf_text != NULL)
6782 fprintf(f, "%s\n", wmf_text);
6784 fprintf(f, "Subject: Warning: message %s delayed %s\n\n",
6785 message_id, warnmsg_delay);
6787 wmf_text = next_emf(wmf, US"intro");
6788 if (wmf_text != NULL) fprintf(f, "%s", CS wmf_text); else
6791 "This message was created automatically by mail delivery software.\n");
6793 if (Ustrcmp(recipients, sender_address) == 0)
6795 "A message that you sent has not yet been delivered to one or more of its\n"
6796 "recipients after more than ");
6799 "A message sent by\n\n <%s>\n\n"
6800 "has not yet been delivered to one or more of its recipients after more than \n",
6803 fprintf(f, "%s on the queue on %s.\n\n", warnmsg_delay,
6805 fprintf(f, "The message identifier is: %s\n", message_id);
6807 for (h = header_list; h != NULL; h = h->next)
6809 if (strncmpic(h->text, US"Subject:", 8) == 0)
6810 fprintf(f, "The subject of the message is: %s", h->text + 9);
6811 else if (strncmpic(h->text, US"Date:", 5) == 0)
6812 fprintf(f, "The date of the message is: %s", h->text + 6);
6816 fprintf(f, "The address%s to which the message has not yet been "
6818 (addr_defer->next == NULL)? "" : "es",
6819 (addr_defer->next == NULL)? "is": "are");
6822 /* List the addresses, with error information if allowed */
6825 while (addr_defer != NULL)
6827 address_item *addr = addr_defer;
6828 addr_defer = addr->next;
6829 if (print_address_information(addr, f, US" ", US"\n ", US""))
6830 print_address_error(addr, f, US"Delay reason: ");
6839 wmf_text = next_emf(wmf, US"final");
6840 if (wmf_text != NULL) fprintf(f, "%s", CS wmf_text);
6846 "No action is required on your part. Delivery attempts will continue for\n"
6847 "some time, and this warning may be repeated at intervals if the message\n"
6848 "remains undelivered. Eventually the mail delivery software will give up,\n"
6849 "and when that happens, the message will be returned to you.\n");
6852 /* Close and wait for child process to complete, without a timeout.
6853 If there's an error, don't update the count. */
6856 if (child_close(pid, 0) == 0)
6858 warning_count = count;
6859 update_spool = TRUE; /* Ensure spool rewritten */
6865 /* Clear deliver_domain */
6867 deliver_domain = NULL;
6869 /* If this was a first delivery attempt, unset the first time flag, and
6870 ensure that the spool gets updated. */
6872 if (deliver_firsttime)
6874 deliver_firsttime = FALSE;
6875 update_spool = TRUE;
6878 /* If delivery was frozen and freeze_tell is set, generate an appropriate
6879 message, unless the message is a local error message (to avoid loops). Then
6880 log the freezing. If the text in "frozen_info" came from a system filter,
6881 it has been escaped into printing characters so as not to mess up log lines.
6882 For the "tell" message, we turn \n back into newline. Also, insert a newline
6883 near the start instead of the ": " string. */
6887 if (freeze_tell != NULL && freeze_tell[0] != 0 && !local_error_message)
6889 uschar *s = string_copy(frozen_info);
6890 uschar *ss = Ustrstr(s, " by the system filter: ");
6901 if (*ss == '\\' && ss[1] == 'n')
6908 moan_tell_someone(freeze_tell, addr_defer, US"Message frozen",
6909 "Message %s has been frozen%s.\nThe sender is <%s>.\n", message_id,
6913 /* Log freezing just before we update the -H file, to minimize the chance
6914 of a race problem. */
6916 deliver_msglog("*** Frozen%s\n", frozen_info);
6917 log_write(0, LOG_MAIN, "Frozen%s", frozen_info);
6920 /* If there have been any updates to the non-recipients list, or other things
6921 that get written to the spool, we must now update the spool header file so
6922 that it has the right information for the next delivery attempt. If there
6923 was more than one address being delivered, the header_change update is done
6924 earlier, in case one succeeds and then something crashes. */
6927 debug_printf("delivery deferred: update_spool=%d header_rewritten=%d\n",
6928 update_spool, header_rewritten);
6930 if (update_spool || header_rewritten)
6931 /* Panic-dies on error */
6932 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
6935 /* Finished with the message log. If the message is complete, it will have
6936 been unlinked or renamed above. */
6938 if (message_logs) (void)fclose(message_log);
6940 /* Now we can close and remove the journal file. Its only purpose is to record
6941 successfully completed deliveries asap so that this information doesn't get
6942 lost if Exim (or the machine) crashes. Forgetting about a failed delivery is
6943 not serious, as trying it again is not harmful. The journal might not be open
6944 if all addresses were deferred at routing or directing. Nevertheless, we must
6945 remove it if it exists (may have been lying around from a crash during the
6946 previous delivery attempt). We don't remove the journal if a delivery
6947 subprocess failed to pass back delivery information; this is controlled by
6948 the remove_journal flag. When the journal is left, we also don't move the
6949 message off the main spool if frozen and the option is set. It should get moved
6950 at the next attempt, after the journal has been inspected. */
6952 if (journal_fd >= 0) (void)close(journal_fd);
6956 sprintf(CS spoolname, "%s/input/%s/%s-J", spool_directory, message_subdir, id);
6957 if (Uunlink(spoolname) < 0 && errno != ENOENT)
6958 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s", spoolname,
6961 /* Move the message off the spool if reqested */
6963 #ifdef SUPPORT_MOVE_FROZEN_MESSAGES
6964 if (deliver_freeze && move_frozen_messages)
6965 (void)spool_move_message(id, message_subdir, US"", US"F");
6969 /* Closing the data file frees the lock; if the file has been unlinked it
6970 will go away. Otherwise the message becomes available for another process
6973 (void)close(deliver_datafile);
6974 deliver_datafile = -1;
6975 DEBUG(D_deliver) debug_printf("end delivery of %s\n", id);
6977 /* It is unlikely that there will be any cached resources, since they are
6978 released after routing, and in the delivery subprocesses. However, it's
6979 possible for an expansion for something afterwards (for example,
6980 expand_check_condition) to do a lookup. We must therefore be sure everything is
6987 /* End of deliver.c */