1 /* $Cambridge: exim/src/src/deliver.c,v 1.30 2006/03/01 16:07:16 ph10 Exp $ */
3 /*************************************************
4 * Exim - an Internet mail transport agent *
5 *************************************************/
7 /* Copyright (c) University of Cambridge 1995 - 2006 */
8 /* See the file NOTICE for conditions of use and distribution. */
10 /* The main code for delivering a message. */
16 /* Data block for keeping track of subprocesses for parallel remote
19 typedef struct pardata {
20 address_item *addrlist; /* chain of addresses */
21 address_item *addr; /* next address data expected for */
22 pid_t pid; /* subprocess pid */
23 int fd; /* pipe fd for getting result from subprocess */
24 int transport_count; /* returned transport count value */
25 BOOL done; /* no more data needed */
26 uschar *msg; /* error message */
27 uschar *return_path; /* return_path for these addresses */
30 /* Values for the process_recipients variable */
32 enum { RECIP_ACCEPT, RECIP_IGNORE, RECIP_DEFER,
33 RECIP_FAIL, RECIP_FAIL_FILTER, RECIP_FAIL_TIMEOUT,
36 /* Mutually recursive functions for marking addresses done. */
38 static void child_done(address_item *, uschar *);
39 static void address_done(address_item *, uschar *);
41 /* Table for turning base-62 numbers into binary */
43 static uschar tab62[] =
44 {0,1,2,3,4,5,6,7,8,9,0,0,0,0,0,0, /* 0-9 */
45 0,10,11,12,13,14,15,16,17,18,19,20, /* A-K */
46 21,22,23,24,25,26,27,28,29,30,31,32, /* L-W */
47 33,34,35, 0, 0, 0, 0, 0, /* X-Z */
48 0,36,37,38,39,40,41,42,43,44,45,46, /* a-k */
49 47,48,49,50,51,52,53,54,55,56,57,58, /* l-w */
53 /*************************************************
54 * Local static variables *
55 *************************************************/
57 /* addr_duplicate is global because it needs to be seen from the Envelope-To
60 static address_item *addr_defer = NULL;
61 static address_item *addr_failed = NULL;
62 static address_item *addr_fallback = NULL;
63 static address_item *addr_local = NULL;
64 static address_item *addr_new = NULL;
65 static address_item *addr_remote = NULL;
66 static address_item *addr_route = NULL;
67 static address_item *addr_succeed = NULL;
69 static FILE *message_log = NULL;
70 static BOOL update_spool;
71 static BOOL remove_journal;
72 static int parcount = 0;
73 static pardata *parlist = NULL;
74 static int return_count;
75 static uschar *frozen_info = US"";
76 static uschar *used_return_path = NULL;
78 static uschar spoolname[PATH_MAX];
82 /*************************************************
83 * Make a new address item *
84 *************************************************/
86 /* This function gets the store and initializes with default values. The
87 transport_return value defaults to DEFER, so that any unexpected failure to
88 deliver does not wipe out the message. The default unique string is set to a
89 copy of the address, so that its domain can be lowercased.
92 address the RFC822 address string
93 copy force a copy of the address
95 Returns: a pointer to an initialized address_item
99 deliver_make_addr(uschar *address, BOOL copy)
101 address_item *addr = store_get(sizeof(address_item));
102 *addr = address_defaults;
103 if (copy) address = string_copy(address);
104 addr->address = address;
105 addr->unique = string_copy(address);
112 /*************************************************
113 * Set expansion values for an address *
114 *************************************************/
116 /* Certain expansion variables are valid only when handling an address or
117 address list. This function sets them up or clears the values, according to its
121 addr the address in question, or NULL to clear values
126 deliver_set_expansions(address_item *addr)
130 uschar ***p = address_expansions;
131 while (*p != NULL) **p++ = NULL;
135 /* Exactly what gets set depends on whether there is one or more addresses, and
136 what they contain. These first ones are always set, taking their values from
137 the first address. */
139 if (addr->host_list == NULL)
141 deliver_host = deliver_host_address = US"";
145 deliver_host = addr->host_list->name;
146 deliver_host_address = addr->host_list->address;
149 deliver_recipients = addr;
150 deliver_address_data = addr->p.address_data;
151 deliver_domain_data = addr->p.domain_data;
152 deliver_localpart_data = addr->p.localpart_data;
154 /* These may be unset for multiple addresses */
156 deliver_domain = addr->domain;
157 self_hostname = addr->self_hostname;
159 #ifdef EXPERIMENTAL_BRIGHTMAIL
160 bmi_deliver = 1; /* deliver by default */
161 bmi_alt_location = NULL;
162 bmi_base64_verdict = NULL;
163 bmi_base64_tracker_verdict = NULL;
166 /* If there's only one address we can set everything. */
168 if (addr->next == NULL)
170 address_item *addr_orig;
172 deliver_localpart = addr->local_part;
173 deliver_localpart_prefix = addr->prefix;
174 deliver_localpart_suffix = addr->suffix;
176 for (addr_orig = addr; addr_orig->parent != NULL;
177 addr_orig = addr_orig->parent);
178 deliver_domain_orig = addr_orig->domain;
180 /* Re-instate any prefix and suffix in the original local part. In all
181 normal cases, the address will have a router associated with it, and we can
182 choose the caseful or caseless version accordingly. However, when a system
183 filter sets up a pipe, file, or autoreply delivery, no router is involved.
184 In this case, though, there won't be any prefix or suffix to worry about. */
186 deliver_localpart_orig = (addr_orig->router == NULL)? addr_orig->local_part :
187 addr_orig->router->caseful_local_part?
188 addr_orig->cc_local_part : addr_orig->lc_local_part;
190 /* If there's a parent, make its domain and local part available, and if
191 delivering to a pipe or file, or sending an autoreply, get the local
192 part from the parent. For pipes and files, put the pipe or file string
193 into address_pipe and address_file. */
195 if (addr->parent != NULL)
197 deliver_domain_parent = addr->parent->domain;
198 deliver_localpart_parent = (addr->parent->router == NULL)?
199 addr->parent->local_part :
200 addr->parent->router->caseful_local_part?
201 addr->parent->cc_local_part : addr->parent->lc_local_part;
203 /* File deliveries have their own flag because they need to be picked out
204 as special more often. */
206 if (testflag(addr, af_pfr))
208 if (testflag(addr, af_file)) address_file = addr->local_part;
209 else if (deliver_localpart[0] == '|') address_pipe = addr->local_part;
210 deliver_localpart = addr->parent->local_part;
211 deliver_localpart_prefix = addr->parent->prefix;
212 deliver_localpart_suffix = addr->parent->suffix;
216 #ifdef EXPERIMENTAL_BRIGHTMAIL
217 /* Set expansion variables related to Brightmail AntiSpam */
218 bmi_base64_verdict = bmi_get_base64_verdict(deliver_localpart_orig, deliver_domain_orig);
219 bmi_base64_tracker_verdict = bmi_get_base64_tracker_verdict(bmi_base64_verdict);
220 /* get message delivery status (0 - don't deliver | 1 - deliver) */
221 bmi_deliver = bmi_get_delivery_status(bmi_base64_verdict);
222 /* if message is to be delivered, get eventual alternate location */
223 if (bmi_deliver == 1) {
224 bmi_alt_location = bmi_get_alt_location(bmi_base64_verdict);
230 /* For multiple addresses, don't set local part, and leave the domain and
231 self_hostname set only if it is the same for all of them. */
236 for (addr2 = addr->next; addr2 != NULL; addr2 = addr2->next)
238 if (deliver_domain != NULL &&
239 Ustrcmp(deliver_domain, addr2->domain) != 0)
240 deliver_domain = NULL;
241 if (self_hostname != NULL && (addr2->self_hostname == NULL ||
242 Ustrcmp(self_hostname, addr2->self_hostname) != 0))
243 self_hostname = NULL;
244 if (deliver_domain == NULL && self_hostname == NULL) break;
252 /*************************************************
253 * Open a msglog file *
254 *************************************************/
256 /* This function is used both for normal message logs, and for files in the
257 msglog directory that are used to catch output from pipes. Try to create the
258 directory if it does not exist. From release 4.21, normal message logs should
259 be created when the message is received.
262 filename the file name
263 mode the mode required
264 error used for saying what failed
266 Returns: a file descriptor, or -1 (with errno set)
270 open_msglog_file(uschar *filename, int mode, uschar **error)
272 int fd = Uopen(filename, O_WRONLY|O_APPEND|O_CREAT, mode);
274 if (fd < 0 && errno == ENOENT)
277 sprintf(CS temp, "msglog/%s", message_subdir);
278 if (message_subdir[0] == 0) temp[6] = 0;
279 (void)directory_make(spool_directory, temp, MSGLOG_DIRECTORY_MODE, TRUE);
280 fd = Uopen(filename, O_WRONLY|O_APPEND|O_CREAT, mode);
283 /* Set the close-on-exec flag and change the owner to the exim uid/gid (this
284 function is called as root). Double check the mode, because the group setting
285 doesn't always get set automatically. */
289 (void)fcntl(fd, F_SETFD, fcntl(fd, F_GETFD) | FD_CLOEXEC);
290 if (fchown(fd, exim_uid, exim_gid) < 0)
295 if (fchmod(fd, mode) < 0)
301 else *error = US"create";
309 /*************************************************
310 * Write to msglog if required *
311 *************************************************/
313 /* Write to the message log, if configured. This function may also be called
317 format a string format
323 deliver_msglog(const char *format, ...)
326 if (!message_logs) return;
327 va_start(ap, format);
328 vfprintf(message_log, format, ap);
336 /*************************************************
337 * Replicate status for batch *
338 *************************************************/
340 /* When a transport handles a batch of addresses, it may treat them
341 individually, or it may just put the status in the first one, and return FALSE,
342 requesting that the status be copied to all the others externally. This is the
343 replication function. As well as the status, it copies the transport pointer,
344 which may have changed if appendfile passed the addresses on to a different
347 Argument: pointer to the first address in a chain
352 replicate_status(address_item *addr)
355 for (addr2 = addr->next; addr2 != NULL; addr2 = addr2->next)
357 addr2->transport = addr->transport;
358 addr2->transport_return = addr->transport_return;
359 addr2->basic_errno = addr->basic_errno;
360 addr2->more_errno = addr->more_errno;
361 addr2->special_action = addr->special_action;
362 addr2->message = addr->message;
363 addr2->user_message = addr->user_message;
369 /*************************************************
370 * Compare lists of hosts *
371 *************************************************/
373 /* This function is given two pointers to chains of host items, and it yields
374 TRUE if the lists refer to the same hosts in the same order, except that
376 (1) Multiple hosts with the same non-negative MX values are permitted to appear
377 in different orders. Round-robinning nameservers can cause this to happen.
379 (2) Multiple hosts with the same negative MX values less than MX_NONE are also
380 permitted to appear in different orders. This is caused by randomizing
383 This enables Exim to use a single SMTP transaction for sending to two entirely
384 different domains that happen to end up pointing at the same hosts.
387 one points to the first host list
388 two points to the second host list
390 Returns: TRUE if the lists refer to the same host set
394 same_hosts(host_item *one, host_item *two)
396 while (one != NULL && two != NULL)
398 if (Ustrcmp(one->name, two->name) != 0)
401 host_item *end_one = one;
402 host_item *end_two = two;
404 /* Batch up only if there was no MX and the list was not randomized */
406 if (mx == MX_NONE) return FALSE;
408 /* Find the ends of the shortest sequence of identical MX values */
410 while (end_one->next != NULL && end_one->next->mx == mx &&
411 end_two->next != NULL && end_two->next->mx == mx)
413 end_one = end_one->next;
414 end_two = end_two->next;
417 /* If there aren't any duplicates, there's no match. */
419 if (end_one == one) return FALSE;
421 /* For each host in the 'one' sequence, check that it appears in the 'two'
422 sequence, returning FALSE if not. */
427 for (hi = two; hi != end_two->next; hi = hi->next)
428 if (Ustrcmp(one->name, hi->name) == 0) break;
429 if (hi == end_two->next) return FALSE;
430 if (one == end_one) break;
434 /* All the hosts in the 'one' sequence were found in the 'two' sequence.
435 Ensure both are pointing at the last host, and carry on as for equality. */
446 /* True if both are NULL */
453 /*************************************************
454 * Compare header lines *
455 *************************************************/
457 /* This function is given two pointers to chains of header items, and it yields
458 TRUE if they are the same header texts in the same order.
461 one points to the first header list
462 two points to the second header list
464 Returns: TRUE if the lists refer to the same header set
468 same_headers(header_line *one, header_line *two)
472 if (one == two) return TRUE; /* Includes the case where both NULL */
473 if (one == NULL || two == NULL) return FALSE;
474 if (Ustrcmp(one->text, two->text) != 0) return FALSE;
482 /*************************************************
483 * Compare string settings *
484 *************************************************/
486 /* This function is given two pointers to strings, and it returns
487 TRUE if they are the same pointer, or if the two strings are the same.
490 one points to the first string
491 two points to the second string
493 Returns: TRUE or FALSE
497 same_strings(uschar *one, uschar *two)
499 if (one == two) return TRUE; /* Includes the case where both NULL */
500 if (one == NULL || two == NULL) return FALSE;
501 return (Ustrcmp(one, two) == 0);
506 /*************************************************
507 * Compare uid/gid for addresses *
508 *************************************************/
510 /* This function is given a transport and two addresses. It yields TRUE if the
511 uid/gid/initgroups settings for the two addresses are going to be the same when
516 addr1 the first address
517 addr2 the second address
519 Returns: TRUE or FALSE
523 same_ugid(transport_instance *tp, address_item *addr1, address_item *addr2)
525 if (!tp->uid_set && tp->expand_uid == NULL && !tp->deliver_as_creator)
527 if (testflag(addr1, af_uid_set) != testflag(addr2, af_gid_set) ||
528 (testflag(addr1, af_uid_set) &&
529 (addr1->uid != addr2->uid ||
530 testflag(addr1, af_initgroups) != testflag(addr2, af_initgroups))))
534 if (!tp->gid_set && tp->expand_gid == NULL)
536 if (testflag(addr1, af_gid_set) != testflag(addr2, af_gid_set) ||
537 (testflag(addr1, af_gid_set) && addr1->gid != addr2->gid))
547 /*************************************************
548 * Record that an address is complete *
549 *************************************************/
551 /* This function records that an address is complete. This is straightforward
552 for most addresses, where the unique address is just the full address with the
553 domain lower cased. For homonyms (addresses that are the same as one of their
554 ancestors) their are complications. Their unique addresses have \x\ prepended
555 (where x = 0, 1, 2...), so that de-duplication works correctly for siblings and
558 Exim used to record the unique addresses of homonyms as "complete". This,
559 however, fails when the pattern of redirection varies over time (e.g. if taking
560 unseen copies at only some times of day) because the prepended numbers may vary
561 from one delivery run to the next. This problem is solved by never recording
562 prepended unique addresses as complete. Instead, when a homonymic address has
563 actually been delivered via a transport, we record its basic unique address
564 followed by the name of the transport. This is checked in subsequent delivery
565 runs whenever an address is routed to a transport.
567 If the completed address is a top-level one (has no parent, which means it
568 cannot be homonymic) we also add the original address to the non-recipients
569 tree, so that it gets recorded in the spool file and therefore appears as
570 "done" in any spool listings. The original address may differ from the unique
571 address in the case of the domain.
573 Finally, this function scans the list of duplicates, marks as done any that
574 match this address, and calls child_done() for their ancestors.
577 addr address item that has been completed
578 now current time as a string
584 address_done(address_item *addr, uschar *now)
588 update_spool = TRUE; /* Ensure spool gets updated */
590 /* Top-level address */
592 if (addr->parent == NULL)
594 tree_add_nonrecipient(addr->unique);
595 tree_add_nonrecipient(addr->address);
598 /* Homonymous child address */
600 else if (testflag(addr, af_homonym))
602 if (addr->transport != NULL)
604 tree_add_nonrecipient(
605 string_sprintf("%s/%s", addr->unique + 3, addr->transport->name));
609 /* Non-homonymous child address */
611 else tree_add_nonrecipient(addr->unique);
613 /* Check the list of duplicate addresses and ensure they are now marked
616 for (dup = addr_duplicate; dup != NULL; dup = dup->next)
618 if (Ustrcmp(addr->unique, dup->unique) == 0)
620 tree_add_nonrecipient(dup->address);
621 child_done(dup, now);
629 /*************************************************
630 * Decrease counts in parents and mark done *
631 *************************************************/
633 /* This function is called when an address is complete. If there is a parent
634 address, its count of children is decremented. If there are still other
635 children outstanding, the function exits. Otherwise, if the count has become
636 zero, address_done() is called to mark the parent and its duplicates complete.
637 Then loop for any earlier ancestors.
640 addr points to the completed address item
641 now the current time as a string, for writing to the message log
647 child_done(address_item *addr, uschar *now)
650 while (addr->parent != NULL)
653 if ((addr->child_count -= 1) > 0) return; /* Incomplete parent */
654 address_done(addr, now);
656 /* Log the completion of all descendents only when there is no ancestor with
657 the same original address. */
659 for (aa = addr->parent; aa != NULL; aa = aa->parent)
660 if (Ustrcmp(aa->address, addr->address) == 0) break;
661 if (aa != NULL) continue;
663 deliver_msglog("%s %s: children all complete\n", now, addr->address);
664 DEBUG(D_deliver) debug_printf("%s: children all complete\n", addr->address);
671 /*************************************************
672 * Actions at the end of handling an address *
673 *************************************************/
675 /* This is a function for processing a single address when all that can be done
676 with it has been done.
679 addr points to the address block
680 result the result of the delivery attempt
681 logflags flags for log_write() (LOG_MAIN and/or LOG_PANIC)
682 driver_type indicates which type of driver (transport, or router) was last
683 to process the address
684 logchar '=' or '-' for use when logging deliveries with => or ->
690 post_process_one(address_item *addr, int result, int logflags, int driver_type,
693 uschar *now = tod_stamp(tod_log);
694 uschar *driver_kind = NULL;
695 uschar *driver_name = NULL;
698 int size = 256; /* Used for a temporary, */
699 int ptr = 0; /* expanding buffer, for */
700 uschar *s; /* building log lines; */
701 void *reset_point; /* released afterwards. */
704 DEBUG(D_deliver) debug_printf("post-process %s (%d)\n", addr->address, result);
706 /* Set up driver kind and name for logging. Disable logging if the router or
707 transport has disabled it. */
709 if (driver_type == DTYPE_TRANSPORT)
711 if (addr->transport != NULL)
713 driver_name = addr->transport->name;
714 driver_kind = US" transport";
715 disable_logging = addr->transport->disable_logging;
717 else driver_kind = US"transporting";
719 else if (driver_type == DTYPE_ROUTER)
721 if (addr->router != NULL)
723 driver_name = addr->router->name;
724 driver_kind = US" router";
725 disable_logging = addr->router->disable_logging;
727 else driver_kind = US"routing";
730 /* If there's an error message set, ensure that it contains only printing
731 characters - it should, but occasionally things slip in and this at least
732 stops the log format from getting wrecked. We also scan the message for an LDAP
733 expansion item that has a password setting, and flatten the password. This is a
734 fudge, but I don't know a cleaner way of doing this. (If the item is badly
735 malformed, it won't ever have gone near LDAP.) */
737 if (addr->message != NULL)
739 addr->message = string_printing(addr->message);
740 if (Ustrstr(addr->message, "failed to expand") != NULL &&
741 (Ustrstr(addr->message, "ldap:") != NULL ||
742 Ustrstr(addr->message, "ldapdn:") != NULL ||
743 Ustrstr(addr->message, "ldapm:") != NULL))
745 uschar *p = Ustrstr(addr->message, "pass=");
749 while (*p != 0 && !isspace(*p)) *p++ = 'x';
754 /* If we used a transport that has one of the "return_output" options set, and
755 if it did in fact generate some output, then for return_output we treat the
756 message as failed if it was not already set that way, so that the output gets
757 returned to the sender, provided there is a sender to send it to. For
758 return_fail_output, do this only if the delivery failed. Otherwise we just
759 unlink the file, and remove the name so that if the delivery failed, we don't
760 try to send back an empty or unwanted file. The log_output options operate only
763 In any case, we close the message file, because we cannot afford to leave a
764 file-descriptor for one address while processing (maybe very many) others. */
766 if (addr->return_file >= 0 && addr->return_filename != NULL)
768 BOOL return_output = FALSE;
770 fsync(addr->return_file);
772 /* If there is no output, do nothing. */
774 if (fstat(addr->return_file, &statbuf) == 0 && statbuf.st_size > 0)
776 transport_instance *tb = addr->transport;
778 /* Handle logging options */
780 if (tb->log_output || (result == FAIL && tb->log_fail_output) ||
781 (result == DEFER && tb->log_defer_output))
784 FILE *f = Ufopen(addr->return_filename, "rb");
786 log_write(0, LOG_MAIN|LOG_PANIC, "failed to open %s to log output "
787 "from %s transport: %s", addr->return_filename, tb->name,
791 s = US Ufgets(big_buffer, big_buffer_size, f);
794 uschar *p = big_buffer + Ustrlen(big_buffer);
795 while (p > big_buffer && isspace(p[-1])) p--;
797 s = string_printing(big_buffer);
798 log_write(0, LOG_MAIN, "<%s>: %s transport output: %s",
799 addr->address, tb->name, s);
805 /* Handle returning options, but only if there is an address to return
808 if (sender_address[0] != 0 || addr->p.errors_address != NULL)
810 if (tb->return_output)
812 addr->transport_return = result = FAIL;
813 if (addr->basic_errno == 0 && addr->message == NULL)
814 addr->message = US"return message generated";
815 return_output = TRUE;
818 if (tb->return_fail_output && result == FAIL) return_output = TRUE;
822 /* Get rid of the file unless it might be returned, but close it in
827 Uunlink(addr->return_filename);
828 addr->return_filename = NULL;
829 addr->return_file = -1;
832 (void)close(addr->return_file);
835 /* Create the address string for logging. Must not do this earlier, because
836 an OK result may be changed to FAIL when a pipe returns text. */
838 log_address = string_log_address(addr,
839 (log_write_selector & L_all_parents) != 0, result == OK);
841 /* The sucess case happens only after delivery by a transport. */
845 addr->next = addr_succeed;
848 /* Call address_done() to ensure that we don't deliver to this address again,
849 and write appropriate things to the message log. If it is a child address, we
850 call child_done() to scan the ancestors and mark them complete if this is the
851 last child to complete. */
853 address_done(addr, now);
854 DEBUG(D_deliver) debug_printf("%s delivered\n", addr->address);
856 if (addr->parent == NULL)
858 deliver_msglog("%s %s: %s%s succeeded\n", now, addr->address,
859 driver_name, driver_kind);
863 deliver_msglog("%s %s <%s>: %s%s succeeded\n", now, addr->address,
864 addr->parent->address, driver_name, driver_kind);
865 child_done(addr, now);
868 /* Log the delivery on the main log. We use an extensible string to build up
869 the log line, and reset the store afterwards. Remote deliveries should always
870 have a pointer to the host item that succeeded; local deliveries can have a
871 pointer to a single host item in their host list, for use by the transport. */
873 s = reset_point = store_get(size);
876 s = string_append(s, &size, &ptr, 2, US"> ", log_address);
878 if ((log_extra_selector & LX_sender_on_delivery) != 0)
879 s = string_append(s, &size, &ptr, 3, US" F=<", sender_address, US">");
881 #ifdef EXPERIMENTAL_SRS
882 if(addr->p.srs_sender)
883 s = string_append(s, &size, &ptr, 3, US" SRS=<", addr->p.srs_sender, US">");
886 /* You might think that the return path must always be set for a successful
887 delivery; indeed, I did for some time, until this statement crashed. The case
888 when it is not set is for a delivery to /dev/null which is optimised by not
891 if (used_return_path != NULL &&
892 (log_extra_selector & LX_return_path_on_delivery) != 0)
893 s = string_append(s, &size, &ptr, 3, US" P=<", used_return_path, US">");
895 /* For a delivery from a system filter, there may not be a router */
897 if (addr->router != NULL)
898 s = string_append(s, &size, &ptr, 2, US" R=", addr->router->name);
900 s = string_append(s, &size, &ptr, 2, US" T=", addr->transport->name);
902 if ((log_extra_selector & LX_delivery_size) != 0)
903 s = string_append(s, &size, &ptr, 2, US" S=",
904 string_sprintf("%d", transport_count));
908 if (addr->transport->info->local)
910 if (addr->host_list != NULL)
911 s = string_append(s, &size, &ptr, 2, US" H=", addr->host_list->name);
912 if (addr->shadow_message != NULL)
913 s = string_cat(s, &size, &ptr, addr->shadow_message,
914 Ustrlen(addr->shadow_message));
917 /* Remote delivery */
921 if (addr->host_used != NULL)
923 s = string_append(s, &size, &ptr, 5, US" H=", addr->host_used->name,
924 US" [", addr->host_used->address, US"]");
925 if ((log_extra_selector & LX_outgoing_port) != 0)
926 s = string_append(s, &size, &ptr, 2, US":", string_sprintf("%d",
927 addr->host_used->port));
928 if (continue_sequence > 1)
929 s = string_cat(s, &size, &ptr, US"*", 1);
933 if ((log_extra_selector & LX_tls_cipher) != 0 && addr->cipher != NULL)
934 s = string_append(s, &size, &ptr, 2, US" X=", addr->cipher);
935 if ((log_extra_selector & LX_tls_certificate_verified) != 0 &&
936 addr->cipher != NULL)
937 s = string_append(s, &size, &ptr, 2, US" CV=",
938 testflag(addr, af_cert_verified)? "yes":"no");
939 if ((log_extra_selector & LX_tls_peerdn) != 0 && addr->peerdn != NULL)
940 s = string_append(s, &size, &ptr, 3, US" DN=\"", addr->peerdn, US"\"");
943 if ((log_extra_selector & LX_smtp_confirmation) != 0 &&
944 addr->message != NULL)
947 uschar *p = big_buffer;
948 uschar *ss = addr->message;
950 for (i = 0; i < 100 && ss[i] != 0; i++)
952 if (ss[i] == '\"' || ss[i] == '\\') *p++ = '\\';
957 s = string_append(s, &size, &ptr, 2, US" C=", big_buffer);
961 /* Time on queue and actual time taken to deliver */
963 if ((log_extra_selector & LX_queue_time) != 0)
965 s = string_append(s, &size, &ptr, 2, US" QT=",
966 readconf_printtime(time(NULL) - received_time));
969 if ((log_extra_selector & LX_deliver_time) != 0)
971 s = string_append(s, &size, &ptr, 2, US" DT=",
972 readconf_printtime(addr->more_errno));
975 /* string_cat() always leaves room for the terminator. Release the
976 store we used to build the line after writing it. */
979 log_write(0, LOG_MAIN, "%s", s);
980 store_reset(reset_point);
984 /* Soft failure, or local delivery process failed; freezing may be
987 else if (result == DEFER || result == PANIC)
989 if (result == PANIC) logflags |= LOG_PANIC;
991 /* This puts them on the chain in reverse order. Do not change this, because
992 the code for handling retries assumes that the one with the retry
993 information is last. */
995 addr->next = addr_defer;
998 /* The only currently implemented special action is to freeze the
999 message. Logging of this is done later, just before the -H file is
1002 if (addr->special_action == SPECIAL_FREEZE)
1004 deliver_freeze = TRUE;
1005 deliver_frozen_at = time(NULL);
1006 update_spool = TRUE;
1009 /* If doing a 2-stage queue run, we skip writing to either the message
1010 log or the main log for SMTP defers. */
1012 if (!queue_2stage || addr->basic_errno != 0)
1016 /* For errors of the type "retry time not reached" (also remotes skipped
1017 on queue run), logging is controlled by L_retry_defer. Note that this kind
1018 of error number is negative, and all the retry ones are less than any
1021 unsigned int use_log_selector = (addr->basic_errno <= ERRNO_RETRY_BASE)?
1024 /* Build up the line that is used for both the message log and the main
1027 s = reset_point = store_get(size);
1028 s = string_cat(s, &size, &ptr, log_address, Ustrlen(log_address));
1030 /* Either driver_name contains something and driver_kind contains
1031 " router" or " transport" (note the leading space), or driver_name is
1032 a null string and driver_kind contains "routing" without the leading
1033 space, if all routing has been deferred. When a domain has been held,
1034 so nothing has been done at all, both variables contain null strings. */
1036 if (driver_name == NULL)
1038 if (driver_kind != NULL)
1039 s = string_append(s, &size, &ptr, 2, US" ", driver_kind);
1043 if (driver_kind[1] == 't' && addr->router != NULL)
1044 s = string_append(s, &size, &ptr, 2, US" R=", addr->router->name);
1046 ss[1] = toupper(driver_kind[1]);
1047 s = string_append(s, &size, &ptr, 2, ss, driver_name);
1050 sprintf(CS ss, " defer (%d)", addr->basic_errno);
1051 s = string_cat(s, &size, &ptr, ss, Ustrlen(ss));
1053 if (addr->basic_errno > 0)
1054 s = string_append(s, &size, &ptr, 2, US": ",
1055 US strerror(addr->basic_errno));
1057 if (addr->message != NULL)
1058 s = string_append(s, &size, &ptr, 2, US": ", addr->message);
1062 /* Log the deferment in the message log, but don't clutter it
1063 up with retry-time defers after the first delivery attempt. */
1065 if (deliver_firsttime || addr->basic_errno > ERRNO_RETRY_BASE)
1066 deliver_msglog("%s %s\n", now, s);
1068 /* Write the main log and reset the store */
1070 log_write(use_log_selector, logflags, "== %s", s);
1071 store_reset(reset_point);
1076 /* Hard failure. If there is an address to which an error message can be sent,
1077 put this address on the failed list. If not, put it on the deferred list and
1078 freeze the mail message for human attention. The latter action can also be
1079 explicitly requested by a router or transport. */
1083 /* If this is a delivery error, or a message for which no replies are
1084 wanted, and the message's age is greater than ignore_bounce_errors_after,
1085 force the af_ignore_error flag. This will cause the address to be discarded
1086 later (with a log entry). */
1088 if (sender_address[0] == 0 && message_age >= ignore_bounce_errors_after)
1089 setflag(addr, af_ignore_error);
1091 /* Freeze the message if requested, or if this is a bounce message (or other
1092 message with null sender) and this address does not have its own errors
1093 address. However, don't freeze if errors are being ignored. The actual code
1094 to ignore occurs later, instead of sending a message. Logging of freezing
1095 occurs later, just before writing the -H file. */
1097 if (!testflag(addr, af_ignore_error) &&
1098 (addr->special_action == SPECIAL_FREEZE ||
1099 (sender_address[0] == 0 && addr->p.errors_address == NULL)
1102 frozen_info = (addr->special_action == SPECIAL_FREEZE)? US"" :
1103 (sender_local && !local_error_message)?
1104 US" (message created with -f <>)" : US" (delivery error message)";
1105 deliver_freeze = TRUE;
1106 deliver_frozen_at = time(NULL);
1107 update_spool = TRUE;
1109 /* The address is put on the defer rather than the failed queue, because
1110 the message is being retained. */
1112 addr->next = addr_defer;
1116 /* Don't put the address on the nonrecipients tree yet; wait until an
1117 error message has been successfully sent. */
1121 addr->next = addr_failed;
1125 /* Build up the log line for the message and main logs */
1127 s = reset_point = store_get(size);
1128 s = string_cat(s, &size, &ptr, log_address, Ustrlen(log_address));
1130 if ((log_extra_selector & LX_sender_on_delivery) != 0)
1131 s = string_append(s, &size, &ptr, 3, US" F=<", sender_address, US">");
1133 /* Return path may not be set if no delivery actually happened */
1135 if (used_return_path != NULL &&
1136 (log_extra_selector & LX_return_path_on_delivery) != 0)
1138 s = string_append(s, &size, &ptr, 3, US" P=<", used_return_path, US">");
1141 if (addr->router != NULL)
1142 s = string_append(s, &size, &ptr, 2, US" R=", addr->router->name);
1143 if (addr->transport != NULL)
1144 s = string_append(s, &size, &ptr, 2, US" T=", addr->transport->name);
1146 if (addr->host_used != NULL)
1147 s = string_append(s, &size, &ptr, 5, US" H=", addr->host_used->name,
1148 US" [", addr->host_used->address, US"]");
1150 if (addr->basic_errno > 0)
1151 s = string_append(s, &size, &ptr, 2, US": ",
1152 US strerror(addr->basic_errno));
1154 if (addr->message != NULL)
1155 s = string_append(s, &size, &ptr, 2, US": ", addr->message);
1159 /* Do the logging. For the message log, "routing failed" for those cases,
1160 just to make it clearer. */
1162 if (driver_name == NULL)
1163 deliver_msglog("%s %s failed for %s\n", now, driver_kind, s);
1165 deliver_msglog("%s %s\n", now, s);
1167 log_write(0, LOG_MAIN, "** %s", s);
1168 store_reset(reset_point);
1171 /* Ensure logging is turned on again in all cases */
1173 disable_logging = FALSE;
1179 /*************************************************
1180 * Address-independent error *
1181 *************************************************/
1183 /* This function is called when there's an error that is not dependent on a
1184 particular address, such as an expansion string failure. It puts the error into
1185 all the addresses in a batch, logs the incident on the main and panic logs, and
1186 clears the expansions. It is mostly called from local_deliver(), but can be
1187 called for a remote delivery via findugid().
1190 logit TRUE if (MAIN+PANIC) logging required
1191 addr the first of the chain of addresses
1193 format format string for error message, or NULL if already set in addr
1194 ... arguments for the format
1200 common_error(BOOL logit, address_item *addr, int code, uschar *format, ...)
1202 address_item *addr2;
1203 addr->basic_errno = code;
1209 va_start(ap, format);
1210 if (!string_vformat(buffer, sizeof(buffer), CS format, ap))
1211 log_write(0, LOG_MAIN|LOG_PANIC_DIE,
1212 "common_error expansion was longer than %d", sizeof(buffer));
1214 addr->message = string_copy(buffer);
1217 for (addr2 = addr->next; addr2 != NULL; addr2 = addr2->next)
1219 addr2->basic_errno = code;
1220 addr2->message = addr->message;
1223 if (logit) log_write(0, LOG_MAIN|LOG_PANIC, "%s", addr->message);
1224 deliver_set_expansions(NULL);
1230 /*************************************************
1231 * Check a "never users" list *
1232 *************************************************/
1234 /* This function is called to check whether a uid is on one of the two "never
1238 uid the uid to be checked
1239 nusers the list to be scanned; the first item in the list is the count
1241 Returns: TRUE if the uid is on the list
1245 check_never_users(uid_t uid, uid_t *nusers)
1248 if (nusers == NULL) return FALSE;
1249 for (i = 1; i <= (int)(nusers[0]); i++) if (nusers[i] == uid) return TRUE;
1255 /*************************************************
1256 * Find uid and gid for a transport *
1257 *************************************************/
1259 /* This function is called for both local and remote deliveries, to find the
1260 uid/gid under which to run the delivery. The values are taken preferentially
1261 from the transport (either explicit or deliver_as_creator), then from the
1262 address (i.e. the router), and if nothing is set, the exim uid/gid are used. If
1263 the resulting uid is on the "never_users" or the "fixed_never_users" list, a
1264 panic error is logged, and the function fails (which normally leads to delivery
1268 addr the address (possibly a chain)
1270 uidp pointer to uid field
1271 gidp pointer to gid field
1272 igfp pointer to the use_initgroups field
1274 Returns: FALSE if failed - error has been set in address(es)
1278 findugid(address_item *addr, transport_instance *tp, uid_t *uidp, gid_t *gidp,
1281 uschar *nuname = NULL;
1282 BOOL gid_set = FALSE;
1284 /* Default initgroups flag comes from the transport */
1286 *igfp = tp->initgroups;
1288 /* First see if there's a gid on the transport, either fixed or expandable.
1289 The expanding function always logs failure itself. */
1296 else if (tp->expand_gid != NULL)
1298 if (route_find_expanded_group(tp->expand_gid, tp->name, US"transport", gidp,
1299 &(addr->message))) gid_set = TRUE;
1302 common_error(FALSE, addr, ERRNO_GIDFAIL, NULL);
1307 /* If the transport did not set a group, see if the router did. */
1309 if (!gid_set && testflag(addr, af_gid_set))
1315 /* Pick up a uid from the transport if one is set. */
1317 if (tp->uid_set) *uidp = tp->uid;
1319 /* Otherwise, try for an expandable uid field. If it ends up as a numeric id,
1320 it does not provide a passwd value from which a gid can be taken. */
1322 else if (tp->expand_uid != NULL)
1325 if (!route_find_expanded_user(tp->expand_uid, tp->name, US"transport", &pw,
1326 uidp, &(addr->message)))
1328 common_error(FALSE, addr, ERRNO_UIDFAIL, NULL);
1331 if (!gid_set && pw != NULL)
1338 /* If the transport doesn't set the uid, test the deliver_as_creator flag. */
1340 else if (tp->deliver_as_creator)
1342 *uidp = originator_uid;
1345 *gidp = originator_gid;
1350 /* Otherwise see if the address specifies the uid and if so, take it and its
1353 else if (testflag(addr, af_uid_set))
1356 *igfp = testflag(addr, af_initgroups);
1359 /* Nothing has specified the uid - default to the Exim user, and group if the
1372 /* If no gid is set, it is a disaster. We default to the Exim gid only if
1373 defaulting to the Exim uid. In other words, if the configuration has specified
1374 a uid, it must also provide a gid. */
1378 common_error(TRUE, addr, ERRNO_GIDFAIL, US"User set without group for "
1379 "%s transport", tp->name);
1383 /* Check that the uid is not on the lists of banned uids that may not be used
1384 for delivery processes. */
1386 if (check_never_users(*uidp, never_users))
1387 nuname = US"never_users";
1388 else if (check_never_users(*uidp, fixed_never_users))
1389 nuname = US"fixed_never_users";
1393 common_error(TRUE, addr, ERRNO_UIDFAIL, US"User %ld set for %s transport "
1394 "is on the %s list", (long int)(*uidp), tp->name, nuname);
1406 /*************************************************
1407 * Check the size of a message for a transport *
1408 *************************************************/
1410 /* Checks that the message isn't too big for the selected transport.
1411 This is called only when it is known that the limit is set.
1415 addr the (first) address being delivered
1418 DEFER expansion failed or did not yield an integer
1419 FAIL message too big
1423 check_message_size(transport_instance *tp, address_item *addr)
1428 deliver_set_expansions(addr);
1429 size_limit = expand_string_integer(tp->message_size_limit);
1430 deliver_set_expansions(NULL);
1435 if (size_limit == -1)
1436 addr->message = string_sprintf("failed to expand message_size_limit "
1437 "in %s transport: %s", tp->name, expand_string_message);
1439 addr->message = string_sprintf("invalid message_size_limit "
1440 "in %s transport: %s", tp->name, expand_string_message);
1442 else if (size_limit > 0 && message_size > size_limit)
1446 string_sprintf("message is too big (transport limit = %d)",
1455 /*************************************************
1456 * Transport-time check for a previous delivery *
1457 *************************************************/
1459 /* Check that this base address hasn't previously been delivered to its routed
1460 transport. If it has been delivered, mark it done. The check is necessary at
1461 delivery time in order to handle homonymic addresses correctly in cases where
1462 the pattern of redirection changes between delivery attempts (so the unique
1463 fields change). Non-homonymic previous delivery is detected earlier, at routing
1464 time (which saves unnecessary routing).
1467 addr the address item
1468 testing TRUE if testing wanted only, without side effects
1470 Returns: TRUE if previously delivered by the transport
1474 previously_transported(address_item *addr, BOOL testing)
1476 (void)string_format(big_buffer, big_buffer_size, "%s/%s",
1477 addr->unique + (testflag(addr, af_homonym)? 3:0), addr->transport->name);
1479 if (tree_search(tree_nonrecipients, big_buffer) != 0)
1481 DEBUG(D_deliver|D_route|D_transport)
1482 debug_printf("%s was previously delivered (%s transport): discarded\n",
1483 addr->address, addr->transport->name);
1484 if (!testing) child_done(addr, tod_stamp(tod_log));
1493 /******************************************************
1494 * Check for a given header in a header string *
1495 ******************************************************/
1497 /* This function is used when generating quota warnings. The configuration may
1498 specify any header lines it likes in quota_warn_message. If certain of them are
1499 missing, defaults are inserted, so we need to be able to test for the presence
1503 hdr the required header name
1504 hstring the header string
1506 Returns: TRUE the header is in the string
1507 FALSE the header is not in the string
1511 contains_header(uschar *hdr, uschar *hstring)
1513 int len = Ustrlen(hdr);
1514 uschar *p = hstring;
1517 if (strncmpic(p, hdr, len) == 0)
1520 while (*p == ' ' || *p == '\t') p++;
1521 if (*p == ':') return TRUE;
1523 while (*p != 0 && *p != '\n') p++;
1524 if (*p == '\n') p++;
1532 /*************************************************
1533 * Perform a local delivery *
1534 *************************************************/
1536 /* Each local delivery is performed in a separate process which sets its
1537 uid and gid as specified. This is a safer way than simply changing and
1538 restoring using seteuid(); there is a body of opinion that seteuid() cannot be
1539 used safely. From release 4, Exim no longer makes any use of it. Besides, not
1540 all systems have seteuid().
1542 If the uid/gid are specified in the transport_instance, they are used; the
1543 transport initialization must ensure that either both or neither are set.
1544 Otherwise, the values associated with the address are used. If neither are set,
1545 it is a configuration error.
1547 The transport or the address may specify a home directory (transport over-
1548 rides), and if they do, this is set as $home. If neither have set a working
1549 directory, this value is used for that as well. Otherwise $home is left unset
1550 and the cwd is set to "/" - a directory that should be accessible to all users.
1552 Using a separate process makes it more complicated to get error information
1553 back. We use a pipe to pass the return code and also an error code and error
1554 text string back to the parent process.
1557 addr points to an address block for this delivery; for "normal" local
1558 deliveries this is the only address to be delivered, but for
1559 pseudo-remote deliveries (e.g. by batch SMTP to a file or pipe)
1560 a number of addresses can be handled simultaneously, and in this
1561 case addr will point to a chain of addresses with the same
1564 shadowing TRUE if running a shadow transport; this causes output from pipes
1571 deliver_local(address_item *addr, BOOL shadowing)
1573 BOOL use_initgroups;
1576 int status, len, rc;
1579 uschar *working_directory;
1580 address_item *addr2;
1581 transport_instance *tp = addr->transport;
1583 /* Set up the return path from the errors or sender address. If the transport
1584 has its own return path setting, expand it and replace the existing value. */
1586 if(addr->p.errors_address != NULL)
1587 return_path = addr->p.errors_address;
1588 #ifdef EXPERIMENTAL_SRS
1589 else if(addr->p.srs_sender != NULL)
1590 return_path = addr->p.srs_sender;
1593 return_path = sender_address;
1595 if (tp->return_path != NULL)
1597 uschar *new_return_path = expand_string(tp->return_path);
1598 if (new_return_path == NULL)
1600 if (!expand_string_forcedfail)
1602 common_error(TRUE, addr, ERRNO_EXPANDFAIL,
1603 US"Failed to expand return path \"%s\" in %s transport: %s",
1604 tp->return_path, tp->name, expand_string_message);
1608 else return_path = new_return_path;
1611 /* For local deliveries, one at a time, the value used for logging can just be
1612 set directly, once and for all. */
1614 used_return_path = return_path;
1616 /* Sort out the uid, gid, and initgroups flag. If an error occurs, the message
1617 gets put into the address(es), and the expansions are unset, so we can just
1620 if (!findugid(addr, tp, &uid, &gid, &use_initgroups)) return;
1622 /* See if either the transport or the address specifies a home and/or a current
1623 working directory. Expand it if necessary. If nothing is set, use "/", for the
1624 working directory, which is assumed to be a directory to which all users have
1625 access. It is necessary to be in a visible directory for some operating systems
1626 when running pipes, as some commands (e.g. "rm" under Solaris 2.5) require
1629 deliver_home = (tp->home_dir != NULL)? tp->home_dir :
1630 (addr->home_dir != NULL)? addr->home_dir : NULL;
1632 if (deliver_home != NULL && !testflag(addr, af_home_expanded))
1634 uschar *rawhome = deliver_home;
1635 deliver_home = NULL; /* in case it contains $home */
1636 deliver_home = expand_string(rawhome);
1637 if (deliver_home == NULL)
1639 common_error(TRUE, addr, ERRNO_EXPANDFAIL, US"home directory \"%s\" failed "
1640 "to expand for %s transport: %s", rawhome, tp->name,
1641 expand_string_message);
1644 if (*deliver_home != '/')
1646 common_error(TRUE, addr, ERRNO_NOTABSOLUTE, US"home directory path \"%s\" "
1647 "is not absolute for %s transport", deliver_home, tp->name);
1652 working_directory = (tp->current_dir != NULL)? tp->current_dir :
1653 (addr->current_dir != NULL)? addr->current_dir : NULL;
1655 if (working_directory != NULL)
1657 uschar *raw = working_directory;
1658 working_directory = expand_string(raw);
1659 if (working_directory == NULL)
1661 common_error(TRUE, addr, ERRNO_EXPANDFAIL, US"current directory \"%s\" "
1662 "failed to expand for %s transport: %s", raw, tp->name,
1663 expand_string_message);
1666 if (*working_directory != '/')
1668 common_error(TRUE, addr, ERRNO_NOTABSOLUTE, US"current directory path "
1669 "\"%s\" is not absolute for %s transport", working_directory, tp->name);
1673 else working_directory = (deliver_home == NULL)? US"/" : deliver_home;
1675 /* If one of the return_output flags is set on the transport, create and open a
1676 file in the message log directory for the transport to write its output onto.
1677 This is mainly used by pipe transports. The file needs to be unique to the
1678 address. This feature is not available for shadow transports. */
1680 if (!shadowing && (tp->return_output || tp->return_fail_output ||
1681 tp->log_output || tp->log_fail_output))
1684 addr->return_filename =
1685 string_sprintf("%s/msglog/%s/%s-%d-%d", spool_directory, message_subdir,
1686 message_id, getpid(), return_count++);
1687 addr->return_file = open_msglog_file(addr->return_filename, 0400, &error);
1688 if (addr->return_file < 0)
1690 common_error(TRUE, addr, errno, US"Unable to %s file for %s transport "
1691 "to return message: %s", error, tp->name, strerror(errno));
1696 /* Create the pipe for inter-process communication. */
1700 common_error(TRUE, addr, ERRNO_PIPEFAIL, US"Creation of pipe failed: %s",
1705 /* Now fork the process to do the real work in the subprocess, but first
1706 ensure that all cached resources are freed so that the subprocess starts with
1707 a clean slate and doesn't interfere with the parent process. */
1711 if ((pid = fork()) == 0)
1713 BOOL replicate = TRUE;
1715 /* Prevent core dumps, as we don't want them in users' home directories.
1716 HP-UX doesn't have RLIMIT_CORE; I don't know how to do this in that
1717 system. Some experimental/developing systems (e.g. GNU/Hurd) may define
1718 RLIMIT_CORE but not support it in setrlimit(). For such systems, do not
1719 complain if the error is "not supported". */
1725 if (setrlimit(RLIMIT_CORE, &rl) < 0)
1727 #ifdef SETRLIMIT_NOT_SUPPORTED
1728 if (errno != ENOSYS && errno != ENOTSUP)
1730 log_write(0, LOG_MAIN|LOG_PANIC, "setrlimit(RLIMIT_CORE) failed: %s",
1735 /* Reset the random number generator, so different processes don't all
1736 have the same sequence. */
1740 /* If the transport has a setup entry, call this first, while still
1741 privileged. (Appendfile uses this to expand quota, for example, while
1742 able to read private files.) */
1744 if (addr->transport->setup != NULL)
1746 switch((addr->transport->setup)(addr->transport, addr, NULL, uid, gid,
1750 addr->transport_return = DEFER;
1754 addr->transport_return = PANIC;
1759 /* Ignore SIGINT and SIGTERM during delivery. Also ignore SIGUSR1, as
1760 when the process becomes unprivileged, it won't be able to write to the
1761 process log. SIGHUP is ignored throughout exim, except when it is being
1764 signal(SIGINT, SIG_IGN);
1765 signal(SIGTERM, SIG_IGN);
1766 signal(SIGUSR1, SIG_IGN);
1768 /* Close the unwanted half of the pipe, and set close-on-exec for the other
1769 half - for transports that exec things (e.g. pipe). Then set the required
1772 (void)close(pfd[pipe_read]);
1773 (void)fcntl(pfd[pipe_write], F_SETFD, fcntl(pfd[pipe_write], F_GETFD) |
1775 exim_setugid(uid, gid, use_initgroups,
1776 string_sprintf("local delivery to %s <%s> transport=%s", addr->local_part,
1777 addr->address, addr->transport->name));
1781 address_item *batched;
1782 debug_printf(" home=%s current=%s\n", deliver_home, working_directory);
1783 for (batched = addr->next; batched != NULL; batched = batched->next)
1784 debug_printf("additional batched address: %s\n", batched->address);
1787 /* Set an appropriate working directory. */
1789 if (Uchdir(working_directory) < 0)
1791 addr->transport_return = DEFER;
1792 addr->basic_errno = errno;
1793 addr->message = string_sprintf("failed to chdir to %s", working_directory);
1796 /* If successful, call the transport */
1801 set_process_info("delivering %s to %s using %s", message_id,
1802 addr->local_part, addr->transport->name);
1804 /* If a transport filter has been specified, set up its argument list.
1805 Any errors will get put into the address, and FALSE yielded. */
1807 if (addr->transport->filter_command != NULL)
1809 ok = transport_set_up_command(&transport_filter_argv,
1810 addr->transport->filter_command,
1811 TRUE, PANIC, addr, US"transport filter", NULL);
1812 transport_filter_timeout = addr->transport->filter_timeout;
1814 else transport_filter_argv = NULL;
1818 debug_print_string(addr->transport->debug_string);
1819 replicate = !(addr->transport->info->code)(addr->transport, addr);
1823 /* Pass the results back down the pipe. If necessary, first replicate the
1824 status in the top address to the others in the batch. The label is the
1825 subject of a goto when a call to the transport's setup function fails. We
1826 pass the pointer to the transport back in case it got changed as a result of
1827 file_format in appendfile. */
1831 if (replicate) replicate_status(addr);
1832 for (addr2 = addr; addr2 != NULL; addr2 = addr2->next)
1835 int local_part_length = Ustrlen(addr2->local_part);
1838 (void)write(pfd[pipe_write], (void *)&(addr2->transport_return), sizeof(int));
1839 (void)write(pfd[pipe_write], (void *)&transport_count, sizeof(transport_count));
1840 (void)write(pfd[pipe_write], (void *)&(addr2->flags), sizeof(addr2->flags));
1841 (void)write(pfd[pipe_write], (void *)&(addr2->basic_errno), sizeof(int));
1842 (void)write(pfd[pipe_write], (void *)&(addr2->more_errno), sizeof(int));
1843 (void)write(pfd[pipe_write], (void *)&(addr2->special_action), sizeof(int));
1844 (void)write(pfd[pipe_write], (void *)&(addr2->transport),
1845 sizeof(transport_instance *));
1847 /* For a file delivery, pass back the local part, in case the original
1848 was only part of the final delivery path. This gives more complete
1851 if (testflag(addr2, af_file))
1853 (void)write(pfd[pipe_write], (void *)&local_part_length, sizeof(int));
1854 (void)write(pfd[pipe_write], addr2->local_part, local_part_length);
1857 /* Now any messages */
1859 for (i = 0, s = addr2->message; i < 2; i++, s = addr2->user_message)
1861 int message_length = (s == NULL)? 0 : Ustrlen(s) + 1;
1862 (void)write(pfd[pipe_write], (void *)&message_length, sizeof(int));
1863 if (message_length > 0) (void)write(pfd[pipe_write], s, message_length);
1867 /* OK, this process is now done. Free any cached resources that it opened,
1868 and close the pipe we were writing down before exiting. */
1870 (void)close(pfd[pipe_write]);
1875 /* Back in the main process: panic if the fork did not succeed. This seems
1876 better than returning an error - if forking is failing it is probably best
1877 not to try other deliveries for this message. */
1880 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Fork failed for local delivery to %s",
1883 /* Read the pipe to get the delivery status codes and error messages. Our copy
1884 of the writing end must be closed first, as otherwise read() won't return zero
1885 on an empty pipe. We check that a status exists for each address before
1886 overwriting the address structure. If data is missing, the default DEFER status
1887 will remain. Afterwards, close the reading end. */
1889 (void)close(pfd[pipe_write]);
1891 for (addr2 = addr; addr2 != NULL; addr2 = addr2->next)
1893 len = read(pfd[pipe_read], (void *)&status, sizeof(int));
1899 addr2->transport_return = status;
1900 len = read(pfd[pipe_read], (void *)&transport_count,
1901 sizeof(transport_count));
1902 len = read(pfd[pipe_read], (void *)&(addr2->flags), sizeof(addr2->flags));
1903 len = read(pfd[pipe_read], (void *)&(addr2->basic_errno), sizeof(int));
1904 len = read(pfd[pipe_read], (void *)&(addr2->more_errno), sizeof(int));
1905 len = read(pfd[pipe_read], (void *)&(addr2->special_action), sizeof(int));
1906 len = read(pfd[pipe_read], (void *)&(addr2->transport),
1907 sizeof(transport_instance *));
1909 if (testflag(addr2, af_file))
1911 int local_part_length;
1912 len = read(pfd[pipe_read], (void *)&local_part_length, sizeof(int));
1913 len = read(pfd[pipe_read], (void *)big_buffer, local_part_length);
1914 big_buffer[local_part_length] = 0;
1915 addr2->local_part = string_copy(big_buffer);
1918 for (i = 0, sptr = &(addr2->message); i < 2;
1919 i++, sptr = &(addr2->user_message))
1922 len = read(pfd[pipe_read], (void *)&message_length, sizeof(int));
1923 if (message_length > 0)
1925 len = read(pfd[pipe_read], (void *)big_buffer, message_length);
1926 if (len > 0) *sptr = string_copy(big_buffer);
1933 log_write(0, LOG_MAIN|LOG_PANIC, "failed to read delivery status for %s "
1934 "from delivery subprocess", addr2->unique);
1939 (void)close(pfd[pipe_read]);
1941 /* Unless shadowing, write all successful addresses immediately to the journal
1942 file, to ensure they are recorded asap. For homonymic addresses, use the base
1943 address plus the transport name. Failure to write the journal is panic-worthy,
1944 but don't stop, as it may prove possible subsequently to update the spool file
1945 in order to record the delivery. */
1949 for (addr2 = addr; addr2 != NULL; addr2 = addr2->next)
1951 if (addr2->transport_return != OK) continue;
1953 if (testflag(addr2, af_homonym))
1954 sprintf(CS big_buffer, "%.500s/%s\n", addr2->unique + 3, tp->name);
1956 sprintf(CS big_buffer, "%.500s\n", addr2->unique);
1958 /* In the test harness, wait just a bit to let the subprocess finish off
1959 any debug output etc first. */
1961 if (running_in_test_harness) millisleep(300);
1963 DEBUG(D_deliver) debug_printf("journalling %s", big_buffer);
1964 len = Ustrlen(big_buffer);
1965 if (write(journal_fd, big_buffer, len) != len)
1966 log_write(0, LOG_MAIN|LOG_PANIC, "failed to update journal for %s: %s",
1967 big_buffer, strerror(errno));
1970 /* Ensure the journal file is pushed out to disk. */
1972 if (fsync(journal_fd) < 0)
1973 log_write(0, LOG_MAIN|LOG_PANIC, "failed to fsync journal: %s",
1977 /* Wait for the process to finish. If it terminates with a non-zero code,
1978 freeze the message (except for SIGTERM, SIGKILL and SIGQUIT), but leave the
1979 status values of all the addresses as they are. Take care to handle the case
1980 when the subprocess doesn't seem to exist. This has been seen on one system
1981 when Exim was called from an MUA that set SIGCHLD to SIG_IGN. When that
1982 happens, wait() doesn't recognize the termination of child processes. Exim now
1983 resets SIGCHLD to SIG_DFL, but this code should still be robust. */
1985 while ((rc = wait(&status)) != pid)
1987 if (rc < 0 && errno == ECHILD) /* Process has vanished */
1989 log_write(0, LOG_MAIN, "%s transport process vanished unexpectedly",
1990 addr->transport->driver_name);
1996 if ((status & 0xffff) != 0)
1998 int msb = (status >> 8) & 255;
1999 int lsb = status & 255;
2000 int code = (msb == 0)? (lsb & 0x7f) : msb;
2001 if (msb != 0 || (code != SIGTERM && code != SIGKILL && code != SIGQUIT))
2002 addr->special_action = SPECIAL_FREEZE;
2003 log_write(0, LOG_MAIN|LOG_PANIC, "%s transport process returned non-zero "
2004 "status 0x%04x: %s %d",
2005 addr->transport->driver_name,
2007 (msb == 0)? "terminated by signal" : "exit code",
2011 /* If SPECIAL_WARN is set in the top address, send a warning message. */
2013 if (addr->special_action == SPECIAL_WARN &&
2014 addr->transport->warn_message != NULL)
2017 uschar *warn_message;
2019 DEBUG(D_deliver) debug_printf("Warning message requested by transport\n");
2021 warn_message = expand_string(addr->transport->warn_message);
2022 if (warn_message == NULL)
2023 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand \"%s\" (warning "
2024 "message for %s transport): %s", addr->transport->warn_message,
2025 addr->transport->name, expand_string_message);
2028 pid_t pid = child_open_exim(&fd);
2031 FILE *f = fdopen(fd, "wb");
2032 if (errors_reply_to != NULL &&
2033 !contains_header(US"Reply-To", warn_message))
2034 fprintf(f, "Reply-To: %s\n", errors_reply_to);
2035 fprintf(f, "Auto-Submitted: auto-replied\n");
2036 if (!contains_header(US"From", warn_message))
2037 fprintf(f, "From: Mail Delivery System <Mailer-Daemon@%s>\n",
2038 qualify_domain_sender);
2039 fprintf(f, "%s", CS warn_message);
2041 /* Close and wait for child process to complete, without a timeout. */
2044 (void)child_close(pid, 0);
2048 addr->special_action = SPECIAL_NONE;
2054 /*************************************************
2055 * Do local deliveries *
2056 *************************************************/
2058 /* This function processes the list of addresses in addr_local. True local
2059 deliveries are always done one address at a time. However, local deliveries can
2060 be batched up in some cases. Typically this is when writing batched SMTP output
2061 files for use by some external transport mechanism, or when running local
2062 deliveries over LMTP.
2069 do_local_deliveries(void)
2072 open_db *dbm_file = NULL;
2073 time_t now = time(NULL);
2075 /* Loop until we have exhausted the supply of local deliveries */
2077 while (addr_local != NULL)
2079 time_t delivery_start;
2081 address_item *addr2, *addr3, *nextaddr;
2082 int logflags = LOG_MAIN;
2083 int logchar = dont_deliver? '*' : '=';
2084 transport_instance *tp;
2086 /* Pick the first undelivered address off the chain */
2088 address_item *addr = addr_local;
2089 addr_local = addr->next;
2092 DEBUG(D_deliver|D_transport)
2093 debug_printf("--------> %s <--------\n", addr->address);
2095 /* An internal disaster if there is no transport. Should not occur! */
2097 if ((tp = addr->transport) == NULL)
2099 logflags |= LOG_PANIC;
2100 disable_logging = FALSE; /* Jic */
2102 (addr->router != NULL)?
2103 string_sprintf("No transport set by %s router", addr->router->name)
2105 string_sprintf("No transport set by system filter");
2106 post_process_one(addr, DEFER, logflags, DTYPE_TRANSPORT, 0);
2110 /* Check that this base address hasn't previously been delivered to this
2111 transport. The check is necessary at this point to handle homonymic addresses
2112 correctly in cases where the pattern of redirection changes between delivery
2113 attempts. Non-homonymic previous delivery is detected earlier, at routing
2116 if (previously_transported(addr, FALSE)) continue;
2118 /* There are weird cases where logging is disabled */
2120 disable_logging = tp->disable_logging;
2122 /* Check for batched addresses and possible amalgamation. File deliveries can
2123 never be batched. Skip all the work if either batch_max <= 1 or there aren't
2124 any other addresses for local delivery. */
2126 if (!testflag(addr, af_file) && tp->batch_max > 1 && addr_local != NULL)
2128 int batch_count = 1;
2129 BOOL uses_dom = readconf_depends((driver_instance *)tp, US"domain");
2130 BOOL uses_lp = readconf_depends((driver_instance *)tp, US"local_part");
2131 uschar *batch_id = NULL;
2132 address_item **anchor = &addr_local;
2133 address_item *last = addr;
2136 /* Expand the batch_id string for comparison with other addresses.
2137 Expansion failure suppresses batching. */
2139 if (tp->batch_id != NULL)
2141 deliver_set_expansions(addr);
2142 batch_id = expand_string(tp->batch_id);
2143 deliver_set_expansions(NULL);
2144 if (batch_id == NULL)
2146 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand batch_id option "
2147 "in %s transport (%s): %s", tp->name, addr->address,
2148 expand_string_message);
2149 batch_count = tp->batch_max;
2153 /* Until we reach the batch_max limit, pick off addresses which have the
2154 same characteristics. These are:
2157 not previously delivered (see comment about 50 lines above)
2158 same local part if the transport's configuration contains $local_part
2159 same domain if the transport's configuration contains $domain
2161 same additional headers
2162 same headers to be removed
2163 same uid/gid for running the transport
2164 same first host if a host list is set
2167 while ((next = *anchor) != NULL && batch_count < tp->batch_max)
2170 tp == next->transport &&
2171 !previously_transported(next, TRUE) &&
2172 (!uses_lp || Ustrcmp(next->local_part, addr->local_part) == 0) &&
2173 (!uses_dom || Ustrcmp(next->domain, addr->domain) == 0) &&
2174 same_strings(next->p.errors_address, addr->p.errors_address) &&
2175 same_headers(next->p.extra_headers, addr->p.extra_headers) &&
2176 same_strings(next->p.remove_headers, addr->p.remove_headers) &&
2177 same_ugid(tp, addr, next) &&
2178 ((addr->host_list == NULL && next->host_list == NULL) ||
2179 (addr->host_list != NULL && next->host_list != NULL &&
2180 Ustrcmp(addr->host_list->name, next->host_list->name) == 0));
2182 /* If the transport has a batch_id setting, batch_id will be non-NULL
2183 from the expansion outside the loop. Expand for this address and compare.
2184 Expansion failure makes this address ineligible for batching. */
2186 if (ok && batch_id != NULL)
2189 address_item *save_nextnext = next->next;
2190 next->next = NULL; /* Expansion for a single address */
2191 deliver_set_expansions(next);
2192 next->next = save_nextnext;
2193 bid = expand_string(tp->batch_id);
2194 deliver_set_expansions(NULL);
2197 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand batch_id option "
2198 "in %s transport (%s): %s", tp->name, next->address,
2199 expand_string_message);
2202 else ok = (Ustrcmp(batch_id, bid) == 0);
2205 /* Take address into batch if OK. */
2209 *anchor = next->next; /* Include the address */
2215 else anchor = &(next->next); /* Skip the address */
2219 /* We now have one or more addresses that can be delivered in a batch. Check
2220 whether the transport is prepared to accept a message of this size. If not,
2221 fail them all forthwith. If the expansion fails, or does not yield an
2222 integer, defer delivery. */
2224 if (tp->message_size_limit != NULL)
2226 int rc = check_message_size(tp, addr);
2229 replicate_status(addr);
2230 while (addr != NULL)
2233 post_process_one(addr, rc, logflags, DTYPE_TRANSPORT, 0);
2236 continue; /* With next batch of addresses */
2240 /* If we are not running the queue, or if forcing, all deliveries will be
2241 attempted. Otherwise, we must respect the retry times for each address. Even
2242 when not doing this, we need to set up the retry key string, and determine
2243 whether a retry record exists, because after a successful delivery, a delete
2244 retry item must be set up. Keep the retry database open only for the duration
2245 of these checks, rather than for all local deliveries, because some local
2246 deliveries (e.g. to pipes) can take a substantial time. */
2248 dbm_file = dbfn_open(US"retry", O_RDONLY, &dbblock, FALSE);
2249 if (dbm_file == NULL)
2251 DEBUG(D_deliver|D_retry|D_hints_lookup)
2252 debug_printf("no retry data available\n");
2257 while (addr2 != NULL)
2259 BOOL ok = TRUE; /* to deliver this address */
2262 /* Set up the retry key to include the domain or not, and change its
2263 leading character from "R" to "T". Must make a copy before doing this,
2264 because the old key may be pointed to from a "delete" retry item after
2267 retry_key = string_copy(
2268 (tp->retry_use_local_part)? addr2->address_retry_key :
2269 addr2->domain_retry_key);
2272 /* Inspect the retry data. If there is no hints file, delivery happens. */
2274 if (dbm_file != NULL)
2276 dbdata_retry *retry_record = dbfn_read(dbm_file, retry_key);
2278 /* If there is no retry record, delivery happens. If there is,
2279 remember it exists so it can be deleted after a successful delivery. */
2281 if (retry_record != NULL)
2283 setflag(addr2, af_lt_retry_exists);
2285 /* A retry record exists for this address. If queue running and not
2286 forcing, inspect its contents. If the record is too old, or if its
2287 retry time has come, or if it has passed its cutoff time, delivery
2292 debug_printf("retry record exists: age=%s ",
2293 readconf_printtime(now - retry_record->time_stamp));
2294 debug_printf("(max %s)\n", readconf_printtime(retry_data_expire));
2295 debug_printf(" time to retry = %s expired = %d\n",
2296 readconf_printtime(retry_record->next_try - now),
2297 retry_record->expired);
2300 if (queue_running && !deliver_force)
2302 ok = (now - retry_record->time_stamp > retry_data_expire) ||
2303 (now >= retry_record->next_try) ||
2304 retry_record->expired;
2306 /* If we haven't reached the retry time, there is one more check
2307 to do, which is for the ultimate address timeout. */
2311 retry_config *retry =
2312 retry_find_config(retry_key+2, addr2->domain,
2313 retry_record->basic_errno,
2314 retry_record->more_errno);
2316 DEBUG(D_deliver|D_retry)
2317 debug_printf("retry time not reached for %s: "
2318 "checking ultimate address timeout\n", addr2->address);
2320 if (retry != NULL && retry->rules != NULL)
2322 retry_rule *last_rule;
2323 for (last_rule = retry->rules;
2324 last_rule->next != NULL;
2325 last_rule = last_rule->next);
2326 DEBUG(D_deliver|D_retry)
2327 debug_printf("now=%d received_time=%d diff=%d timeout=%d\n",
2328 (int)now, received_time, (int)now - received_time,
2329 last_rule->timeout);
2330 if (now - received_time > last_rule->timeout) ok = TRUE;
2334 DEBUG(D_deliver|D_retry)
2335 debug_printf("no retry rule found: assume timed out\n");
2336 ok = TRUE; /* No rule => timed out */
2339 DEBUG(D_deliver|D_retry)
2341 if (ok) debug_printf("on queue longer than maximum retry for "
2342 "address - allowing delivery\n");
2347 else DEBUG(D_retry) debug_printf("no retry record exists\n");
2350 /* This address is to be delivered. Leave it on the chain. */
2355 addr2 = addr2->next;
2358 /* This address is to be deferred. Take it out of the chain, and
2359 post-process it as complete. Must take it out of the chain first,
2360 because post processing puts it on another chain. */
2364 address_item *this = addr2;
2365 this->message = US"Retry time not yet reached";
2366 this->basic_errno = ERRNO_LRETRY;
2367 if (addr3 == NULL) addr2 = addr = addr2->next;
2368 else addr2 = addr3->next = addr2->next;
2369 post_process_one(this, DEFER, logflags, DTYPE_TRANSPORT, 0);
2373 if (dbm_file != NULL) dbfn_close(dbm_file);
2375 /* If there are no addresses left on the chain, they all deferred. Loop
2376 for the next set of addresses. */
2378 if (addr == NULL) continue;
2380 /* So, finally, we do have some addresses that can be passed to the
2381 transport. Before doing so, set up variables that are relevant to a
2384 deliver_set_expansions(addr);
2385 delivery_start = time(NULL);
2386 deliver_local(addr, FALSE);
2387 deliver_time = (int)(time(NULL) - delivery_start);
2389 /* If a shadow transport (which must perforce be another local transport), is
2390 defined, and its condition is met, we must pass the message to the shadow
2391 too, but only those addresses that succeeded. We do this by making a new
2392 chain of addresses - also to keep the original chain uncontaminated. We must
2393 use a chain rather than doing it one by one, because the shadow transport may
2396 NOTE: if the condition fails because of a lookup defer, there is nothing we
2399 if (tp->shadow != NULL &&
2400 (tp->shadow_condition == NULL ||
2401 expand_check_condition(tp->shadow_condition, tp->name, US"transport")))
2403 transport_instance *stp;
2404 address_item *shadow_addr = NULL;
2405 address_item **last = &shadow_addr;
2407 for (stp = transports; stp != NULL; stp = stp->next)
2408 if (Ustrcmp(stp->name, tp->shadow) == 0) break;
2411 log_write(0, LOG_MAIN|LOG_PANIC, "shadow transport \"%s\" not found ",
2414 /* Pick off the addresses that have succeeded, and make clones. Put into
2415 the shadow_message field a pointer to the shadow_message field of the real
2418 else for (addr2 = addr; addr2 != NULL; addr2 = addr2->next)
2420 if (addr2->transport_return != OK) continue;
2421 addr3 = store_get(sizeof(address_item));
2424 addr3->shadow_message = (uschar *)(&(addr2->shadow_message));
2425 addr3->transport = stp;
2426 addr3->transport_return = DEFER;
2427 addr3->return_filename = NULL;
2428 addr3->return_file = -1;
2430 last = &(addr3->next);
2433 /* If we found any addresses to shadow, run the delivery, and stick any
2434 message back into the shadow_message field in the original. */
2436 if (shadow_addr != NULL)
2438 int save_count = transport_count;
2440 DEBUG(D_deliver|D_transport)
2441 debug_printf(">>>>>>>>>>>>>>>> Shadow delivery >>>>>>>>>>>>>>>>\n");
2442 deliver_local(shadow_addr, TRUE);
2444 for(; shadow_addr != NULL; shadow_addr = shadow_addr->next)
2446 int sresult = shadow_addr->transport_return;
2447 *((uschar **)(shadow_addr->shadow_message)) = (sresult == OK)?
2448 string_sprintf(" ST=%s", stp->name) :
2449 string_sprintf(" ST=%s (%s%s%s)", stp->name,
2450 (shadow_addr->basic_errno <= 0)?
2451 US"" : US strerror(shadow_addr->basic_errno),
2452 (shadow_addr->basic_errno <= 0 || shadow_addr->message == NULL)?
2454 (shadow_addr->message != NULL)? shadow_addr->message :
2455 (shadow_addr->basic_errno <= 0)? US"unknown error" : US"");
2457 DEBUG(D_deliver|D_transport)
2458 debug_printf("%s shadow transport returned %s for %s\n",
2460 (sresult == OK)? "OK" :
2461 (sresult == DEFER)? "DEFER" :
2462 (sresult == FAIL)? "FAIL" :
2463 (sresult == PANIC)? "PANIC" : "?",
2464 shadow_addr->address);
2467 DEBUG(D_deliver|D_transport)
2468 debug_printf(">>>>>>>>>>>>>>>> End shadow delivery >>>>>>>>>>>>>>>>\n");
2470 transport_count = save_count; /* Restore original transport count */
2474 /* Cancel the expansions that were set up for the delivery. */
2476 deliver_set_expansions(NULL);
2478 /* Now we can process the results of the real transport. We must take each
2479 address off the chain first, because post_process_one() puts it on another
2482 for (addr2 = addr; addr2 != NULL; addr2 = nextaddr)
2484 int result = addr2->transport_return;
2485 nextaddr = addr2->next;
2487 DEBUG(D_deliver|D_transport)
2488 debug_printf("%s transport returned %s for %s\n",
2490 (result == OK)? "OK" :
2491 (result == DEFER)? "DEFER" :
2492 (result == FAIL)? "FAIL" :
2493 (result == PANIC)? "PANIC" : "?",
2496 /* If there is a retry_record, or if delivery is deferred, build a retry
2497 item for setting a new retry time or deleting the old retry record from
2498 the database. These items are handled all together after all addresses
2499 have been handled (so the database is open just for a short time for
2502 if (result == DEFER || testflag(addr2, af_lt_retry_exists))
2504 int flags = (result == DEFER)? 0 : rf_delete;
2505 uschar *retry_key = string_copy((tp->retry_use_local_part)?
2506 addr2->address_retry_key : addr2->domain_retry_key);
2508 retry_add_item(addr2, retry_key, flags);
2511 /* Done with this address */
2513 if (result == OK) addr2->more_errno = deliver_time;
2514 post_process_one(addr2, result, logflags, DTYPE_TRANSPORT, logchar);
2516 /* If a pipe delivery generated text to be sent back, the result may be
2517 changed to FAIL, and we must copy this for subsequent addresses in the
2520 if (addr2->transport_return != result)
2522 for (addr3 = nextaddr; addr3 != NULL; addr3 = addr3->next)
2524 addr3->transport_return = addr2->transport_return;
2525 addr3->basic_errno = addr2->basic_errno;
2526 addr3->message = addr2->message;
2528 result = addr2->transport_return;
2531 /* Whether or not the result was changed to FAIL, we need to copy the
2532 return_file value from the first address into all the addresses of the
2533 batch, so they are all listed in the error message. */
2535 addr2->return_file = addr->return_file;
2537 /* Change log character for recording successful deliveries. */
2539 if (result == OK) logchar = '-';
2541 } /* Loop back for next batch of addresses */
2547 /*************************************************
2548 * Sort remote deliveries *
2549 *************************************************/
2551 /* This function is called if remote_sort_domains is set. It arranges that the
2552 chain of addresses for remote deliveries is ordered according to the strings
2553 specified. Try to make this shuffling reasonably efficient by handling
2554 sequences of addresses rather than just single ones.
2561 sort_remote_deliveries(void)
2564 address_item **aptr = &addr_remote;
2565 uschar *listptr = remote_sort_domains;
2569 while (*aptr != NULL &&
2570 (pattern = string_nextinlist(&listptr, &sep, patbuf, sizeof(patbuf)))
2573 address_item *moved = NULL;
2574 address_item **bptr = &moved;
2576 while (*aptr != NULL)
2578 address_item **next;
2579 deliver_domain = (*aptr)->domain; /* set $domain */
2580 if (match_isinlist(deliver_domain, &pattern, UCHAR_MAX+1,
2581 &domainlist_anchor, NULL, MCL_DOMAIN, TRUE, NULL) == OK)
2583 aptr = &((*aptr)->next);
2587 next = &((*aptr)->next);
2588 while (*next != NULL &&
2589 (deliver_domain = (*next)->domain, /* Set $domain */
2590 match_isinlist(deliver_domain, &pattern, UCHAR_MAX+1,
2591 &domainlist_anchor, NULL, MCL_DOMAIN, TRUE, NULL)) != OK)
2592 next = &((*next)->next);
2594 /* If the batch of non-matchers is at the end, add on any that were
2595 extracted further up the chain, and end this iteration. Otherwise,
2596 extract them from the chain and hang on the moved chain. */
2608 aptr = &((*aptr)->next);
2611 /* If the loop ended because the final address matched, *aptr will
2612 be NULL. Add on to the end any extracted non-matching addresses. If
2613 *aptr is not NULL, the loop ended via "break" when *next is null, that
2614 is, there was a string of non-matching addresses at the end. In this
2615 case the extracted addresses have already been added on the end. */
2617 if (*aptr == NULL) *aptr = moved;
2623 debug_printf("remote addresses after sorting:\n");
2624 for (addr = addr_remote; addr != NULL; addr = addr->next)
2625 debug_printf(" %s\n", addr->address);
2631 /*************************************************
2632 * Read from pipe for remote delivery subprocess *
2633 *************************************************/
2635 /* This function is called when the subprocess is complete, but can also be
2636 called before it is complete, in order to empty a pipe that is full (to prevent
2637 deadlock). It must therefore keep track of its progress in the parlist data
2640 We read the pipe to get the delivery status codes and a possible error message
2641 for each address, optionally preceded by unusability data for the hosts and
2642 also by optional retry data.
2644 Read in large chunks into the big buffer and then scan through, interpreting
2645 the data therein. In most cases, only a single read will be necessary. No
2646 individual item will ever be anywhere near 2500 bytes in length, so by ensuring
2647 that we read the next chunk when there is less than 2500 bytes left in the
2648 non-final chunk, we can assume each item is complete in the buffer before
2649 handling it. Each item is written using a single write(), which is atomic for
2650 small items (less than PIPE_BUF, which seems to be at least 512 in any Unix and
2651 often bigger) so even if we are reading while the subprocess is still going, we
2652 should never have only a partial item in the buffer.
2655 poffset the offset of the parlist item
2656 eop TRUE if the process has completed
2658 Returns: TRUE if the terminating 'Z' item has been read,
2659 or there has been a disaster (i.e. no more data needed);
2664 par_read_pipe(int poffset, BOOL eop)
2667 pardata *p = parlist + poffset;
2668 address_item *addrlist = p->addrlist;
2669 address_item *addr = p->addr;
2672 uschar *endptr = big_buffer;
2673 uschar *ptr = endptr;
2674 uschar *msg = p->msg;
2675 BOOL done = p->done;
2676 BOOL unfinished = TRUE;
2678 /* Loop through all items, reading from the pipe when necessary. The pipe
2679 is set up to be non-blocking, but there are two different Unix mechanisms in
2680 use. Exim uses O_NONBLOCK if it is defined. This returns 0 for end of file,
2681 and EAGAIN for no more data. If O_NONBLOCK is not defined, Exim uses O_NDELAY,
2682 which returns 0 for both end of file and no more data. We distinguish the
2683 two cases by taking 0 as end of file only when we know the process has
2686 Each separate item is written to the pipe in a single write(), and as they are
2687 all short items, the writes will all be atomic and we should never find
2688 ourselves in the position of having read an incomplete item. "Short" in this
2689 case can mean up to about 1K in the case when there is a long error message
2690 associated with an address. */
2692 DEBUG(D_deliver) debug_printf("reading pipe for subprocess %d (%s)\n",
2693 (int)p->pid, eop? "ended" : "not ended");
2697 retry_item *r, **rp;
2698 int remaining = endptr - ptr;
2700 /* Read (first time) or top up the chars in the buffer if necessary.
2701 There will be only one read if we get all the available data (i.e. don't
2702 fill the buffer completely). */
2704 if (remaining < 2500 && unfinished)
2707 int available = big_buffer_size - remaining;
2709 if (remaining > 0) memmove(big_buffer, ptr, remaining);
2712 endptr = big_buffer + remaining;
2713 len = read(fd, endptr, available);
2715 DEBUG(D_deliver) debug_printf("read() yielded %d\n", len);
2717 /* If the result is EAGAIN and the process is not complete, just
2718 stop reading any more and process what we have already. */
2722 if (!eop && errno == EAGAIN) len = 0; else
2724 msg = string_sprintf("failed to read pipe from transport process "
2725 "%d for transport %s: %s", pid, addr->transport->driver_name,
2731 /* If the length is zero (eof or no-more-data), just process what we
2732 already have. Note that if the process is still running and we have
2733 read all the data in the pipe (but less that "available") then we
2734 won't read any more, as "unfinished" will get set FALSE. */
2737 unfinished = len == available;
2740 /* If we are at the end of the available data, exit the loop. */
2742 if (ptr >= endptr) break;
2744 /* Handle each possible type of item, assuming the complete item is
2745 available in store. */
2749 /* Host items exist only if any hosts were marked unusable. Match
2750 up by checking the IP address. */
2753 for (h = addrlist->host_list; h != NULL; h = h->next)
2755 if (h->address == NULL || Ustrcmp(h->address, ptr+2) != 0) continue;
2763 /* Retry items are sent in a preceding R item for each address. This is
2764 kept separate to keep each message short enough to guarantee it won't
2765 be split in the pipe. Hopefully, in the majority of cases, there won't in
2766 fact be any retry items at all.
2768 The complete set of retry items might include an item to delete a
2769 routing retry if there was a previous routing delay. However, routing
2770 retries are also used when a remote transport identifies an address error.
2771 In that case, there may also be an "add" item for the same key. Arrange
2772 that a "delete" item is dropped in favour of an "add" item. */
2775 if (addr == NULL) goto ADDR_MISMATCH;
2777 DEBUG(D_deliver|D_retry)
2778 debug_printf("reading retry information for %s from subprocess\n",
2781 /* Cut out any "delete" items on the list. */
2783 for (rp = &(addr->retries); (r = *rp) != NULL; rp = &(r->next))
2785 if (Ustrcmp(r->key, ptr+1) == 0) /* Found item with same key */
2787 if ((r->flags & rf_delete) == 0) break; /* It was not "delete" */
2788 *rp = r->next; /* Excise a delete item */
2789 DEBUG(D_deliver|D_retry)
2790 debug_printf(" existing delete item dropped\n");
2794 /* We want to add a delete item only if there is no non-delete item;
2795 however we still have to step ptr through the data. */
2797 if (r == NULL || (*ptr & rf_delete) == 0)
2799 r = store_get(sizeof(retry_item));
2800 r->next = addr->retries;
2803 r->key = string_copy(ptr);
2805 memcpy(&(r->basic_errno), ptr, sizeof(r->basic_errno));
2806 ptr += sizeof(r->basic_errno);
2807 memcpy(&(r->more_errno), ptr, sizeof(r->more_errno));
2808 ptr += sizeof(r->more_errno);
2809 r->message = (*ptr)? string_copy(ptr) : NULL;
2810 DEBUG(D_deliver|D_retry)
2811 debug_printf(" added %s item\n",
2812 ((r->flags & rf_delete) == 0)? "retry" : "delete");
2817 DEBUG(D_deliver|D_retry)
2818 debug_printf(" delete item not added: non-delete item exists\n");
2821 ptr += sizeof(r->basic_errno) + sizeof(r->more_errno);
2827 /* Put the amount of data written into the parlist block */
2830 memcpy(&(p->transport_count), ptr, sizeof(transport_count));
2831 ptr += sizeof(transport_count);
2834 /* Address items are in the order of items on the address chain. We
2835 remember the current address value in case this function is called
2836 several times to empty the pipe in stages. Information about delivery
2837 over TLS is sent in a preceding X item for each address. We don't put
2838 it in with the other info, in order to keep each message short enough to
2839 guarantee it won't be split in the pipe. */
2843 if (addr == NULL) goto ADDR_MISMATCH; /* Below, in 'A' handler */
2844 addr->cipher = (*ptr)? string_copy(ptr) : NULL;
2846 addr->peerdn = (*ptr)? string_copy(ptr) : NULL;
2855 msg = string_sprintf("address count mismatch for data read from pipe "
2856 "for transport process %d for transport %s", pid,
2857 addrlist->transport->driver_name);
2862 addr->transport_return = *ptr++;
2863 addr->special_action = *ptr++;
2864 memcpy(&(addr->basic_errno), ptr, sizeof(addr->basic_errno));
2865 ptr += sizeof(addr->basic_errno);
2866 memcpy(&(addr->more_errno), ptr, sizeof(addr->more_errno));
2867 ptr += sizeof(addr->more_errno);
2868 memcpy(&(addr->flags), ptr, sizeof(addr->flags));
2869 ptr += sizeof(addr->flags);
2870 addr->message = (*ptr)? string_copy(ptr) : NULL;
2872 addr->user_message = (*ptr)? string_copy(ptr) : NULL;
2875 /* Always two strings for host information, followed by the port number */
2879 h = store_get(sizeof(host_item));
2880 h->name = string_copy(ptr);
2882 h->address = string_copy(ptr);
2884 memcpy(&(h->port), ptr, sizeof(h->port));
2885 ptr += sizeof(h->port);
2886 addr->host_used = h;
2890 /* Finished with this address */
2895 /* Z marks the logical end of the data. It is followed by '0' if
2896 continue_transport was NULL at the end of transporting, otherwise '1'.
2897 We need to know when it becomes NULL during a delivery down a passed SMTP
2898 channel so that we don't try to pass anything more down it. Of course, for
2899 most normal messages it will remain NULL all the time. */
2904 continue_transport = NULL;
2905 continue_hostname = NULL;
2908 DEBUG(D_deliver) debug_printf("Z%c item read\n", *ptr);
2911 /* Anything else is a disaster. */
2914 msg = string_sprintf("malformed data (%d) read from pipe for transport "
2915 "process %d for transport %s", ptr[-1], pid,
2916 addr->transport->driver_name);
2922 /* The done flag is inspected externally, to determine whether or not to
2923 call the function again when the process finishes. */
2927 /* If the process hadn't finished, and we haven't seen the end of the data
2928 or suffered a disaster, update the rest of the state, and return FALSE to
2929 indicate "not finished". */
2938 /* Close our end of the pipe, to prevent deadlock if the far end is still
2939 pushing stuff into it. */
2944 /* If we have finished without error, but haven't had data for every address,
2945 something is wrong. */
2947 if (msg == NULL && addr != NULL)
2948 msg = string_sprintf("insufficient address data read from pipe "
2949 "for transport process %d for transport %s", pid,
2950 addr->transport->driver_name);
2952 /* If an error message is set, something has gone wrong in getting back
2953 the delivery data. Put the message into each address and freeze it. */
2957 for (addr = addrlist; addr != NULL; addr = addr->next)
2959 addr->transport_return = DEFER;
2960 addr->special_action = SPECIAL_FREEZE;
2961 addr->message = msg;
2965 /* Return TRUE to indicate we have got all we need from this process, even
2966 if it hasn't actually finished yet. */
2973 /*************************************************
2974 * Post-process a set of remote addresses *
2975 *************************************************/
2977 /* Do what has to be done immediately after a remote delivery for each set of
2978 addresses, then re-write the spool if necessary. Note that post_process_one
2979 puts the address on an appropriate queue; hence we must fish off the next
2980 one first. This function is also called if there is a problem with setting
2981 up a subprocess to do a remote delivery in parallel. In this case, the final
2982 argument contains a message, and the action must be forced to DEFER.
2985 addr pointer to chain of address items
2986 logflags flags for logging
2987 msg NULL for normal cases; -> error message for unexpected problems
2988 fallback TRUE if processing fallback hosts
2994 remote_post_process(address_item *addr, int logflags, uschar *msg,
2999 /* If any host addresses were found to be unusable, add them to the unusable
3000 tree so that subsequent deliveries don't try them. */
3002 for (h = addr->host_list; h != NULL; h = h->next)
3004 if (h->address == NULL) continue;
3005 if (h->status >= hstatus_unusable) tree_add_unusable(h);
3008 /* Now handle each address on the chain. The transport has placed '=' or '-'
3009 into the special_action field for each successful delivery. */
3011 while (addr != NULL)
3013 address_item *next = addr->next;
3015 /* If msg == NULL (normal processing) and the result is DEFER and we are
3016 processing the main hosts and there are fallback hosts available, put the
3017 address on the list for fallback delivery. */
3019 if (addr->transport_return == DEFER &&
3020 addr->fallback_hosts != NULL &&
3024 addr->host_list = addr->fallback_hosts;
3025 addr->next = addr_fallback;
3026 addr_fallback = addr;
3027 DEBUG(D_deliver) debug_printf("%s queued for fallback host(s)\n", addr->address);
3030 /* If msg is set (=> unexpected problem), set it in the address before
3031 doing the ordinary post processing. */
3037 addr->message = msg;
3038 addr->transport_return = DEFER;
3040 (void)post_process_one(addr, addr->transport_return, logflags,
3041 DTYPE_TRANSPORT, addr->special_action);
3049 /* If we have just delivered down a passed SMTP channel, and that was
3050 the last address, the channel will have been closed down. Now that
3051 we have logged that delivery, set continue_sequence to 1 so that
3052 any subsequent deliveries don't get "*" incorrectly logged. */
3054 if (continue_transport == NULL) continue_sequence = 1;
3059 /*************************************************
3060 * Wait for one remote delivery subprocess *
3061 *************************************************/
3063 /* This function is called while doing remote deliveries when either the
3064 maximum number of processes exist and we need one to complete so that another
3065 can be created, or when waiting for the last ones to complete. It must wait for
3066 the completion of one subprocess, empty the control block slot, and return a
3067 pointer to the address chain.
3070 Returns: pointer to the chain of addresses handled by the process;
3071 NULL if no subprocess found - this is an unexpected error
3074 static address_item *
3077 int poffset, status;
3078 address_item *addr, *addrlist;
3081 set_process_info("delivering %s: waiting for a remote delivery subprocess "
3082 "to finish", message_id);
3084 /* Loop until either a subprocess completes, or there are no subprocesses in
3085 existence - in which case give an error return. We cannot proceed just by
3086 waiting for a completion, because a subprocess may have filled up its pipe, and
3087 be waiting for it to be emptied. Therefore, if no processes have finished, we
3088 wait for one of the pipes to acquire some data by calling select(), with a
3089 timeout just in case.
3091 The simple approach is just to iterate after reading data from a ready pipe.
3092 This leads to non-ideal behaviour when the subprocess has written its final Z
3093 item, closed the pipe, and is in the process of exiting (the common case). A
3094 call to waitpid() yields nothing completed, but select() shows the pipe ready -
3095 reading it yields EOF, so you end up with busy-waiting until the subprocess has
3098 To avoid this, if all the data that is needed has been read from a subprocess
3099 after select(), an explicit wait() for it is done. We know that all it is doing
3100 is writing to the pipe and then exiting, so the wait should not be long.
3102 The non-blocking waitpid() is to some extent just insurance; if we could
3103 reliably detect end-of-file on the pipe, we could always know when to do a
3104 blocking wait() for a completed process. However, because some systems use
3105 NDELAY, which doesn't distinguish between EOF and pipe empty, it is easier to
3106 use code that functions without the need to recognize EOF.
3108 There's a double loop here just in case we end up with a process that is not in
3109 the list of remote delivery processes. Something has obviously gone wrong if
3110 this is the case. (For example, a process that is incorrectly left over from
3111 routing or local deliveries might be found.) The damage can be minimized by
3112 looping back and looking for another process. If there aren't any, the error
3113 return will happen. */
3115 for (;;) /* Normally we do not repeat this loop */
3117 while ((pid = waitpid(-1, &status, WNOHANG)) <= 0)
3120 fd_set select_pipes;
3121 int maxpipe, readycount;
3123 /* A return value of -1 can mean several things. If errno != ECHILD, it
3124 either means invalid options (which we discount), or that this process was
3125 interrupted by a signal. Just loop to try the waitpid() again.
3127 If errno == ECHILD, waitpid() is telling us that there are no subprocesses
3128 in existence. This should never happen, and is an unexpected error.
3129 However, there is a nasty complication when running under Linux. If "strace
3130 -f" is being used under Linux to trace this process and its children,
3131 subprocesses are "stolen" from their parents and become the children of the
3132 tracing process. A general wait such as the one we've just obeyed returns
3133 as if there are no children while subprocesses are running. Once a
3134 subprocess completes, it is restored to the parent, and waitpid(-1) finds
3135 it. Thanks to Joachim Wieland for finding all this out and suggesting a
3138 This does not happen using "truss" on Solaris, nor (I think) with other
3139 tracing facilities on other OS. It seems to be specific to Linux.
3141 What we do to get round this is to use kill() to see if any of our
3142 subprocesses are still in existence. If kill() gives an OK return, we know
3143 it must be for one of our processes - it can't be for a re-use of the pid,
3144 because if our process had finished, waitpid() would have found it. If any
3145 of our subprocesses are in existence, we proceed to use select() as if
3146 waitpid() had returned zero. I think this is safe. */
3150 if (errno != ECHILD) continue; /* Repeats the waitpid() */
3153 debug_printf("waitpid() returned -1/ECHILD: checking explicitly "
3154 "for process existence\n");
3156 for (poffset = 0; poffset < remote_max_parallel; poffset++)
3158 if ((pid = parlist[poffset].pid) != 0 && kill(pid, 0) == 0)
3160 DEBUG(D_deliver) debug_printf("process %d still exists: assume "
3161 "stolen by strace\n", (int)pid);
3162 break; /* With poffset set */
3166 if (poffset >= remote_max_parallel)
3168 DEBUG(D_deliver) debug_printf("*** no delivery children found\n");
3169 return NULL; /* This is the error return */
3173 /* A pid value greater than 0 breaks the "while" loop. A negative value has
3174 been handled above. A return value of zero means that there is at least one
3175 subprocess, but there are no completed subprocesses. See if any pipes are
3176 ready with any data for reading. */
3178 DEBUG(D_deliver) debug_printf("selecting on subprocess pipes\n");
3181 FD_ZERO(&select_pipes);
3182 for (poffset = 0; poffset < remote_max_parallel; poffset++)
3184 if (parlist[poffset].pid != 0)
3186 int fd = parlist[poffset].fd;
3187 FD_SET(fd, &select_pipes);
3188 if (fd > maxpipe) maxpipe = fd;
3192 /* Stick in a 60-second timeout, just in case. */
3197 readycount = select(maxpipe + 1, (SELECT_ARG2_TYPE *)&select_pipes,
3200 /* Scan through the pipes and read any that are ready; use the count
3201 returned by select() to stop when there are no more. Select() can return
3202 with no processes (e.g. if interrupted). This shouldn't matter.
3204 If par_read_pipe() returns TRUE, it means that either the terminating Z was
3205 read, or there was a disaster. In either case, we are finished with this
3206 process. Do an explicit wait() for the process and break the main loop if
3209 It turns out that we have to deal with the case of an interrupted system
3210 call, which can happen on some operating systems if the signal handling is
3211 set up to do that by default. */
3214 readycount > 0 && poffset < remote_max_parallel;
3217 if ((pid = parlist[poffset].pid) != 0 &&
3218 FD_ISSET(parlist[poffset].fd, &select_pipes))
3221 if (par_read_pipe(poffset, FALSE)) /* Finished with this pipe */
3223 for (;;) /* Loop for signals */
3225 pid_t endedpid = waitpid(pid, &status, 0);
3226 if (endedpid == pid) goto PROCESS_DONE;
3227 if (endedpid != (pid_t)(-1) || errno != EINTR)
3228 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Unexpected error return "
3229 "%d (errno = %d) from waitpid() for process %d",
3230 (int)endedpid, errno, (int)pid);
3236 /* Now go back and look for a completed subprocess again. */
3239 /* A completed process was detected by the non-blocking waitpid(). Find the
3240 data block that corresponds to this subprocess. */
3242 for (poffset = 0; poffset < remote_max_parallel; poffset++)
3243 if (pid == parlist[poffset].pid) break;
3245 /* Found the data block; this is a known remote delivery process. We don't
3246 need to repeat the outer loop. This should be what normally happens. */
3248 if (poffset < remote_max_parallel) break;
3250 /* This situation is an error, but it's probably better to carry on looking
3251 for another process than to give up (as we used to do). */
3253 log_write(0, LOG_MAIN|LOG_PANIC, "Process %d finished: not found in remote "
3254 "transport process list", pid);
3255 } /* End of the "for" loop */
3257 /* Come here when all the data was completely read after a select(), and
3258 the process in pid has been wait()ed for. */
3265 debug_printf("remote delivery process %d ended\n", (int)pid);
3267 debug_printf("remote delivery process %d ended: status=%04x\n", (int)pid,
3271 set_process_info("delivering %s", message_id);
3273 /* Get the chain of processed addresses */
3275 addrlist = parlist[poffset].addrlist;
3277 /* If the process did not finish cleanly, record an error and freeze (except
3278 for SIGTERM, SIGKILL and SIGQUIT), and also ensure the journal is not removed,
3279 in case the delivery did actually happen. */
3281 if ((status & 0xffff) != 0)
3284 int msb = (status >> 8) & 255;
3285 int lsb = status & 255;
3286 int code = (msb == 0)? (lsb & 0x7f) : msb;
3288 msg = string_sprintf("%s transport process returned non-zero status 0x%04x: "
3290 addrlist->transport->driver_name,
3292 (msb == 0)? "terminated by signal" : "exit code",
3295 if (msb != 0 || (code != SIGTERM && code != SIGKILL && code != SIGQUIT))
3296 addrlist->special_action = SPECIAL_FREEZE;
3298 for (addr = addrlist; addr != NULL; addr = addr->next)
3300 addr->transport_return = DEFER;
3301 addr->message = msg;
3304 remove_journal = FALSE;
3307 /* Else complete reading the pipe to get the result of the delivery, if all
3308 the data has not yet been obtained. */
3310 else if (!parlist[poffset].done) (void)par_read_pipe(poffset, TRUE);
3312 /* Put the data count and return path into globals, mark the data slot unused,
3313 decrement the count of subprocesses, and return the address chain. */
3315 transport_count = parlist[poffset].transport_count;
3316 used_return_path = parlist[poffset].return_path;
3317 parlist[poffset].pid = 0;
3324 /*************************************************
3325 * Wait for subprocesses and post-process *
3326 *************************************************/
3328 /* This function waits for subprocesses until the number that are still running
3329 is below a given threshold. For each complete subprocess, the addresses are
3330 post-processed. If we can't find a running process, there is some shambles.
3331 Better not bomb out, as that might lead to multiple copies of the message. Just
3332 log and proceed as if all done.
3335 max maximum number of subprocesses to leave running
3336 fallback TRUE if processing fallback hosts
3342 par_reduce(int max, BOOL fallback)
3344 while (parcount > max)
3346 address_item *doneaddr = par_wait();
3347 if (doneaddr == NULL)
3349 log_write(0, LOG_MAIN|LOG_PANIC,
3350 "remote delivery process count got out of step");
3353 else remote_post_process(doneaddr, LOG_MAIN, NULL, fallback);
3360 /*************************************************
3361 * Do remote deliveries *
3362 *************************************************/
3364 /* This function is called to process the addresses in addr_remote. We must
3365 pick off the queue all addresses that have the same transport, remote
3366 destination, and errors address, and hand them to the transport in one go,
3367 subject to some configured limitations. If this is a run to continue delivering
3368 to an existing delivery channel, skip all but those addresses that can go to
3369 that channel. The skipped addresses just get deferred.
3371 If mua_wrapper is set, all addresses must be able to be sent in a single
3372 transaction. If not, this function yields FALSE.
3374 In Exim 4, remote deliveries are always done in separate processes, even
3375 if remote_max_parallel = 1 or if there's only one delivery to do. The reason
3376 is so that the base process can retain privilege. This makes the
3377 implementation of fallback transports feasible (though not initially done.)
3379 We create up to the configured number of subprocesses, each of which passes
3380 back the delivery state via a pipe. (However, when sending down an existing
3381 connection, remote_max_parallel is forced to 1.)
3384 fallback TRUE if processing fallback hosts
3386 Returns: TRUE normally
3387 FALSE if mua_wrapper is set and the addresses cannot all be sent
3392 do_remote_deliveries(BOOL fallback)
3398 parcount = 0; /* Number of executing subprocesses */
3400 /* When sending down an existing channel, only do one delivery at a time.
3401 We use a local variable (parmax) to hold the maximum number of processes;
3402 this gets reduced from remote_max_parallel if we can't create enough pipes. */
3404 if (continue_transport != NULL) remote_max_parallel = 1;
3405 parmax = remote_max_parallel;
3407 /* If the data for keeping a list of processes hasn't yet been
3410 if (parlist == NULL)
3412 parlist = store_get(remote_max_parallel * sizeof(pardata));
3413 for (poffset = 0; poffset < remote_max_parallel; poffset++)
3414 parlist[poffset].pid = 0;
3417 /* Now loop for each remote delivery */
3419 for (delivery_count = 0; addr_remote != NULL; delivery_count++)
3425 int address_count = 1;
3426 int address_count_max;
3428 BOOL use_initgroups;
3429 BOOL pipe_done = FALSE;
3430 transport_instance *tp;
3431 address_item **anchor = &addr_remote;
3432 address_item *addr = addr_remote;
3433 address_item *last = addr;
3436 /* Pull the first address right off the list. */
3438 addr_remote = addr->next;
3441 DEBUG(D_deliver|D_transport)
3442 debug_printf("--------> %s <--------\n", addr->address);
3444 /* If no transport has been set, there has been a big screw-up somewhere. */
3446 if ((tp = addr->transport) == NULL)
3448 disable_logging = FALSE; /* Jic */
3449 remote_post_process(addr, LOG_MAIN|LOG_PANIC,
3450 US"No transport set by router", fallback);
3454 /* Check that this base address hasn't previously been delivered to this
3455 transport. The check is necessary at this point to handle homonymic addresses
3456 correctly in cases where the pattern of redirection changes between delivery
3457 attempts. Non-homonymic previous delivery is detected earlier, at routing
3460 if (previously_transported(addr, FALSE)) continue;
3462 /* Force failure if the message is too big. */
3464 if (tp->message_size_limit != NULL)
3466 int rc = check_message_size(tp, addr);
3469 addr->transport_return = rc;
3470 remote_post_process(addr, LOG_MAIN, NULL, fallback);
3475 /* Get the flag which specifies whether the transport can handle different
3476 domains that nevertheless resolve to the same set of hosts. */
3478 multi_domain = tp->multi_domain;
3480 /* Get the maximum it can handle in one envelope, with zero meaning
3481 unlimited, which is forced for the MUA wrapper case. */
3483 address_count_max = tp->max_addresses;
3484 if (address_count_max == 0 || mua_wrapper) address_count_max = 999999;
3487 /************************************************************************/
3488 /***** This is slightly experimental code, but should be safe. *****/
3490 /* The address_count_max value is the maximum number of addresses that the
3491 transport can send in one envelope. However, the transport must be capable of
3492 dealing with any number of addresses. If the number it gets exceeds its
3493 envelope limitation, it must send multiple copies of the message. This can be
3494 done over a single connection for SMTP, so uses less resources than making
3495 multiple connections. On the other hand, if remote_max_parallel is greater
3496 than one, it is perhaps a good idea to use parallel processing to move the
3497 message faster, even if that results in multiple simultaneous connections to
3500 How can we come to some compromise between these two ideals? What we do is to
3501 limit the number of addresses passed to a single instance of a transport to
3502 the greater of (a) its address limit (rcpt_max for SMTP) and (b) the total
3503 number of addresses routed to remote transports divided by
3504 remote_max_parallel. For example, if the message has 100 remote recipients,
3505 remote max parallel is 2, and rcpt_max is 10, we'd never send more than 50 at
3506 once. But if rcpt_max is 100, we could send up to 100.
3508 Of course, not all the remotely addresses in a message are going to go to the
3509 same set of hosts (except in smarthost configurations), so this is just a
3510 heuristic way of dividing up the work.
3512 Furthermore (1), because this may not be wanted in some cases, and also to
3513 cope with really pathological cases, there is also a limit to the number of
3514 messages that are sent over one connection. This is the same limit that is
3515 used when sending several different messages over the same connection.
3516 Continue_sequence is set when in this situation, to the number sent so
3517 far, including this message.
3519 Furthermore (2), when somebody explicitly sets the maximum value to 1, it
3520 is probably because they are using VERP, in which case they want to pass only
3521 one address at a time to the transport, in order to be able to use
3522 $local_part and $domain in constructing a new return path. We could test for
3523 the use of these variables, but as it is so likely they will be used when the
3524 maximum is 1, we don't bother. Just leave the value alone. */
3526 if (address_count_max != 1 &&
3527 address_count_max < remote_delivery_count/remote_max_parallel)
3529 int new_max = remote_delivery_count/remote_max_parallel;
3530 int message_max = tp->connection_max_messages;
3531 if (connection_max_messages >= 0) message_max = connection_max_messages;
3532 message_max -= continue_sequence - 1;
3533 if (message_max > 0 && new_max > address_count_max * message_max)
3534 new_max = address_count_max * message_max;
3535 address_count_max = new_max;
3538 /************************************************************************/
3541 /* Pick off all addresses which have the same transport, errors address,
3542 destination, and extra headers. In some cases they point to the same host
3543 list, but we also need to check for identical host lists generated from
3544 entirely different domains. The host list pointers can be NULL in the case
3545 where the hosts are defined in the transport. There is also a configured
3546 maximum limit of addresses that can be handled at once (see comments above
3547 for how it is computed). */
3549 while ((next = *anchor) != NULL && address_count < address_count_max)
3551 if ((multi_domain || Ustrcmp(next->domain, addr->domain) == 0)
3553 tp == next->transport
3555 same_hosts(next->host_list, addr->host_list)
3557 same_strings(next->p.errors_address, addr->p.errors_address)
3559 same_headers(next->p.extra_headers, addr->p.extra_headers)
3561 same_ugid(tp, next, addr)
3563 (next->p.remove_headers == addr->p.remove_headers ||
3564 (next->p.remove_headers != NULL &&
3565 addr->p.remove_headers != NULL &&
3566 Ustrcmp(next->p.remove_headers, addr->p.remove_headers) == 0)))
3568 *anchor = next->next;
3570 next->first = addr; /* remember top one (for retry processing) */
3575 else anchor = &(next->next);
3578 /* If we are acting as an MUA wrapper, all addresses must go in a single
3579 transaction. If not, put them back on the chain and yield FALSE. */
3581 if (mua_wrapper && addr_remote != NULL)
3583 last->next = addr_remote;
3588 /* Set up the expansion variables for this set of addresses */
3590 deliver_set_expansions(addr);
3592 /* Compute the return path, expanding a new one if required. The old one
3593 must be set first, as it might be referred to in the expansion. */
3595 if(addr->p.errors_address != NULL)
3596 return_path = addr->p.errors_address;
3597 #ifdef EXPERIMENTAL_SRS
3598 else if(addr->p.srs_sender != NULL)
3599 return_path = addr->p.srs_sender;
3602 return_path = sender_address;
3604 if (tp->return_path != NULL)
3606 uschar *new_return_path = expand_string(tp->return_path);
3607 if (new_return_path == NULL)
3609 if (!expand_string_forcedfail)
3611 remote_post_process(addr, LOG_MAIN|LOG_PANIC,
3612 string_sprintf("Failed to expand return path \"%s\": %s",
3613 tp->return_path, expand_string_message), fallback);
3617 else return_path = new_return_path;
3620 /* Find the uid, gid, and use_initgroups setting for this transport. Failure
3621 logs and sets up error messages, so we just post-process and continue with
3622 the next address. */
3624 if (!findugid(addr, tp, &uid, &gid, &use_initgroups))
3626 remote_post_process(addr, LOG_MAIN|LOG_PANIC, NULL, fallback);
3630 /* If this transport has a setup function, call it now so that it gets
3631 run in this process and not in any subprocess. That way, the results of
3632 any setup that are retained by the transport can be reusable. One of the
3633 things the setup does is to set the fallback host lists in the addresses.
3634 That is why it is called at this point, before the continue delivery
3635 processing, because that might use the fallback hosts. */
3637 if (tp->setup != NULL)
3638 (void)((tp->setup)(addr->transport, addr, NULL, uid, gid, NULL));
3640 /* If this is a run to continue delivery down an already-established
3641 channel, check that this set of addresses matches the transport and
3642 the channel. If it does not, defer the addresses. If a host list exists,
3643 we must check that the continue host is on the list. Otherwise, the
3644 host is set in the transport. */
3646 continue_more = FALSE; /* In case got set for the last lot */
3647 if (continue_transport != NULL)
3649 BOOL ok = Ustrcmp(continue_transport, tp->name) == 0;
3650 if (ok && addr->host_list != NULL)
3654 for (h = addr->host_list; h != NULL; h = h->next)
3656 if (Ustrcmp(h->name, continue_hostname) == 0)
3657 { ok = TRUE; break; }
3661 /* Addresses not suitable; defer or queue for fallback hosts (which
3662 might be the continue host) and skip to next address. */
3666 DEBUG(D_deliver) debug_printf("not suitable for continue_transport\n");
3669 if (addr->fallback_hosts != NULL && !fallback)
3673 next->host_list = next->fallback_hosts;
3674 DEBUG(D_deliver) debug_printf("%s queued for fallback host(s)\n", next->address);
3675 if (next->next == NULL) break;
3678 next->next = addr_fallback;
3679 addr_fallback = addr;
3684 while (next->next != NULL) next = next->next;
3685 next->next = addr_defer;
3692 /* Set a flag indicating whether there are further addresses that list
3693 the continued host. This tells the transport to leave the channel open,
3694 but not to pass it to another delivery process. */
3696 for (next = addr_remote; next != NULL; next = next->next)
3699 for (h = next->host_list; h != NULL; h = h->next)
3701 if (Ustrcmp(h->name, continue_hostname) == 0)
3702 { continue_more = TRUE; break; }
3707 /* The transports set up the process info themselves as they may connect
3708 to more than one remote machine. They also have to set up the filter
3709 arguments, if required, so that the host name and address are available
3712 transport_filter_argv = NULL;
3714 /* Create the pipe for inter-process communication. If pipe creation
3715 fails, it is probably because the value of remote_max_parallel is so
3716 large that too many file descriptors for pipes have been created. Arrange
3717 to wait for a process to finish, and then try again. If we still can't
3718 create a pipe when all processes have finished, break the retry loop. */
3722 if (pipe(pfd) == 0) pipe_done = TRUE;
3723 else if (parcount > 0) parmax = parcount;
3726 /* We need to make the reading end of the pipe non-blocking. There are
3727 two different options for this. Exim is cunningly (I hope!) coded so
3728 that it can use either of them, though it prefers O_NONBLOCK, which
3729 distinguishes between EOF and no-more-data. */
3732 (void)fcntl(pfd[pipe_read], F_SETFL, O_NONBLOCK);
3734 (void)fcntl(pfd[pipe_read], F_SETFL, O_NDELAY);
3737 /* If the maximum number of subprocesses already exist, wait for a process
3738 to finish. If we ran out of file descriptors, parmax will have been reduced
3739 from its initial value of remote_max_parallel. */
3741 par_reduce(parmax - 1, fallback);
3744 /* If we failed to create a pipe and there were no processes to wait
3745 for, we have to give up on this one. Do this outside the above loop
3746 so that we can continue the main loop. */
3750 remote_post_process(addr, LOG_MAIN|LOG_PANIC,
3751 string_sprintf("unable to create pipe: %s", strerror(errno)), fallback);
3755 /* Find a free slot in the pardata list. Must do this after the possible
3756 waiting for processes to finish, because a terminating process will free
3759 for (poffset = 0; poffset < remote_max_parallel; poffset++)
3760 if (parlist[poffset].pid == 0) break;
3762 /* If there isn't one, there has been a horrible disaster. */
3764 if (poffset >= remote_max_parallel)
3766 (void)close(pfd[pipe_write]);
3767 (void)close(pfd[pipe_read]);
3768 remote_post_process(addr, LOG_MAIN|LOG_PANIC,
3769 US"Unexpectedly no free subprocess slot", fallback);
3773 /* Now fork a subprocess to do the remote delivery, but before doing so,
3774 ensure that any cached resourses are released so as not to interfere with
3775 what happens in the subprocess. */
3779 if ((pid = fork()) == 0)
3781 int fd = pfd[pipe_write];
3784 /* There are weird circumstances in which logging is disabled */
3786 disable_logging = tp->disable_logging;
3788 /* Show pids on debug output if parallelism possible */
3790 if (parmax > 1 && (parcount > 0 || addr_remote != NULL))
3792 DEBUG(D_any|D_v) debug_selector |= D_pid;
3793 DEBUG(D_deliver) debug_printf("Remote delivery process started\n");
3796 /* Reset the random number generator, so different processes don't all
3797 have the same sequence. In the test harness we want different, but
3798 predictable settings for each delivery process, so do something explicit
3799 here rather they rely on the fixed reset in the random number function. */
3801 random_seed = running_in_test_harness? 42 + 2*delivery_count : 0;
3803 /* Set close-on-exec on the pipe so that it doesn't get passed on to
3804 a new process that may be forked to do another delivery down the same
3807 (void)fcntl(fd, F_SETFD, fcntl(fd, F_GETFD) | FD_CLOEXEC);
3809 /* Close open file descriptors for the pipes of other processes
3810 that are running in parallel. */
3812 for (poffset = 0; poffset < remote_max_parallel; poffset++)
3813 if (parlist[poffset].pid != 0) (void)close(parlist[poffset].fd);
3815 /* This process has inherited a copy of the file descriptor
3816 for the data file, but its file pointer is shared with all the
3817 other processes running in parallel. Therefore, we have to re-open
3818 the file in order to get a new file descriptor with its own
3819 file pointer. We don't need to lock it, as the lock is held by
3820 the parent process. There doesn't seem to be any way of doing
3821 a dup-with-new-file-pointer. */
3823 (void)close(deliver_datafile);
3824 sprintf(CS spoolname, "%s/input/%s/%s-D", spool_directory, message_subdir,
3826 deliver_datafile = Uopen(spoolname, O_RDWR | O_APPEND, 0);
3828 if (deliver_datafile < 0)
3829 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Failed to reopen %s for remote "
3830 "parallel delivery: %s", spoolname, strerror(errno));
3832 /* Set the close-on-exec flag */
3834 (void)fcntl(deliver_datafile, F_SETFD, fcntl(deliver_datafile, F_GETFD) |
3837 /* Set the uid/gid of this process; bombs out on failure. */
3839 exim_setugid(uid, gid, use_initgroups,
3840 string_sprintf("remote delivery to %s with transport=%s",
3841 addr->address, tp->name));
3843 /* Close the unwanted half of this process' pipe, set the process state,
3844 and run the transport. Afterwards, transport_count will contain the number
3845 of bytes written. */
3847 (void)close(pfd[pipe_read]);
3848 set_process_info("delivering %s using %s", message_id, tp->name);
3849 debug_print_string(tp->debug_string);
3850 if (!(tp->info->code)(addr->transport, addr)) replicate_status(addr);
3852 set_process_info("delivering %s (just run %s for %s%s in subprocess)",
3853 message_id, tp->name, addr->address, (addr->next == NULL)? "" : ", ...");
3855 /* Ensure any cached resources that we used are now released */
3859 /* Pass the result back down the pipe. This is a lot more information
3860 than is needed for a local delivery. We have to send back the error
3861 status for each address, the usability status for each host that is
3862 flagged as unusable, and all the retry items. When TLS is in use, we
3863 send also the cipher and peerdn information. Each type of information
3864 is flagged by an identifying byte, and is then in a fixed format (with
3865 strings terminated by zeros), and there is a final terminator at the
3866 end. The host information and retry information is all attached to
3867 the first address, so that gets sent at the start. */
3869 /* Host unusability information: for most success cases this will
3872 for (h = addr->host_list; h != NULL; h = h->next)
3874 if (h->address == NULL || h->status < hstatus_unusable) continue;
3875 sprintf(CS big_buffer, "H%c%c%s", h->status, h->why, h->address);
3876 (void)write(fd, big_buffer, Ustrlen(big_buffer+3) + 4);
3879 /* The number of bytes written. This is the same for each address. Even
3880 if we sent several copies of the message down the same connection, the
3881 size of each one is the same, and it's that value we have got because
3882 transport_count gets reset before calling transport_write_message(). */
3884 big_buffer[0] = 'S';
3885 memcpy(big_buffer+1, &transport_count, sizeof(transport_count));
3886 (void)write(fd, big_buffer, sizeof(transport_count) + 1);
3888 /* Information about what happened to each address. Three item types are
3889 used: an optional 'X' item first, for TLS information, followed by 'R'
3890 items for any retry settings, and finally an 'A' item for the remaining
3893 for(; addr != NULL; addr = addr->next)
3898 /* The certificate verification status goes into the flags */
3900 if (tls_certificate_verified) setflag(addr, af_cert_verified);
3902 /* Use an X item only if there's something to send */
3905 if (addr->cipher != NULL)
3909 sprintf(CS ptr, "%.128s", addr->cipher);
3911 if (addr->peerdn == NULL) *ptr++ = 0; else
3913 sprintf(CS ptr, "%.512s", addr->peerdn);
3916 (void)write(fd, big_buffer, ptr - big_buffer);
3920 /* Retry information: for most success cases this will be null. */
3922 for (r = addr->retries; r != NULL; r = r->next)
3925 sprintf(CS big_buffer, "R%c%.500s", r->flags, r->key);
3926 ptr = big_buffer + Ustrlen(big_buffer+2) + 3;
3927 memcpy(ptr, &(r->basic_errno), sizeof(r->basic_errno));
3928 ptr += sizeof(r->basic_errno);
3929 memcpy(ptr, &(r->more_errno), sizeof(r->more_errno));
3930 ptr += sizeof(r->more_errno);
3931 if (r->message == NULL) *ptr++ = 0; else
3933 sprintf(CS ptr, "%.512s", r->message);
3936 (void)write(fd, big_buffer, ptr - big_buffer);
3939 /* The rest of the information goes in an 'A' item. */
3941 ptr = big_buffer + 3;
3942 sprintf(CS big_buffer, "A%c%c", addr->transport_return,
3943 addr->special_action);
3944 memcpy(ptr, &(addr->basic_errno), sizeof(addr->basic_errno));
3945 ptr += sizeof(addr->basic_errno);
3946 memcpy(ptr, &(addr->more_errno), sizeof(addr->more_errno));
3947 ptr += sizeof(addr->more_errno);
3948 memcpy(ptr, &(addr->flags), sizeof(addr->flags));
3949 ptr += sizeof(addr->flags);
3951 if (addr->message == NULL) *ptr++ = 0; else
3953 sprintf(CS ptr, "%.1024s", addr->message);
3957 if (addr->user_message == NULL) *ptr++ = 0; else
3959 sprintf(CS ptr, "%.1024s", addr->user_message);
3963 if (addr->host_used == NULL) *ptr++ = 0; else
3965 sprintf(CS ptr, "%.256s", addr->host_used->name);
3967 sprintf(CS ptr, "%.64s", addr->host_used->address);
3969 memcpy(ptr, &(addr->host_used->port), sizeof(addr->host_used->port));
3970 ptr += sizeof(addr->host_used->port);
3972 (void)write(fd, big_buffer, ptr - big_buffer);
3975 /* Add termination flag, close the pipe, and that's it. The character
3976 after 'Z' indicates whether continue_transport is now NULL or not.
3977 A change from non-NULL to NULL indicates a problem with a continuing
3980 big_buffer[0] = 'Z';
3981 big_buffer[1] = (continue_transport == NULL)? '0' : '1';
3982 (void)write(fd, big_buffer, 2);
3987 /* Back in the mainline: close the unwanted half of the pipe. */
3989 (void)close(pfd[pipe_write]);
3991 /* Fork failed; defer with error message */
3995 (void)close(pfd[pipe_read]);
3996 remote_post_process(addr, LOG_MAIN|LOG_PANIC,
3997 string_sprintf("fork failed for remote delivery to %s: %s",
3998 addr->domain, strerror(errno)), fallback);
4002 /* Fork succeeded; increment the count, and remember relevant data for
4003 when the process finishes. */
4006 parlist[poffset].addrlist = parlist[poffset].addr = addr;
4007 parlist[poffset].pid = pid;
4008 parlist[poffset].fd = pfd[pipe_read];
4009 parlist[poffset].done = FALSE;
4010 parlist[poffset].msg = NULL;
4011 parlist[poffset].return_path = return_path;
4013 /* If the process we've just started is sending a message down an existing
4014 channel, wait for it now. This ensures that only one such process runs at
4015 once, whatever the value of remote_max parallel. Otherwise, we might try to
4016 send two or more messages simultaneously down the same channel. This could
4017 happen if there are different domains that include the same host in otherwise
4018 different host lists.
4020 Also, if the transport closes down the channel, this information gets back
4021 (continue_transport gets set to NULL) before we consider any other addresses
4024 if (continue_transport != NULL) par_reduce(0, fallback);
4026 /* Otherwise, if we are running in the test harness, wait a bit, to let the
4027 newly created process get going before we create another process. This should
4028 ensure repeatability in the tests. We only need to wait a tad. */
4030 else if (running_in_test_harness) millisleep(500);
4033 /* Reached the end of the list of addresses. Wait for all the subprocesses that
4034 are still running and post-process their addresses. */
4036 par_reduce(0, fallback);
4043 /*************************************************
4044 * Split an address into local part and domain *
4045 *************************************************/
4047 /* This function initializes an address for routing by splitting it up into a
4048 local part and a domain. The local part is set up twice - once in its original
4049 casing, and once in lower case, and it is dequoted. We also do the "percent
4050 hack" for configured domains. This may lead to a DEFER result if a lookup
4051 defers. When a percent-hacking takes place, we insert a copy of the original
4052 address as a new parent of this address, as if we have had a redirection.
4055 addr points to an addr_item block containing the address
4058 DEFER - could not determine if domain is %-hackable
4062 deliver_split_address(address_item *addr)
4064 uschar *address = addr->address;
4065 uschar *domain = Ustrrchr(address, '@');
4067 int len = domain - address;
4069 addr->domain = string_copylc(domain+1); /* Domains are always caseless */
4071 /* The implication in the RFCs (though I can't say I've seen it spelled out
4072 explicitly) is that quoting should be removed from local parts at the point
4073 where they are locally interpreted. [The new draft "821" is more explicit on
4074 this, Jan 1999.] We know the syntax is valid, so this can be done by simply
4075 removing quoting backslashes and any unquoted doublequotes. */
4077 t = addr->cc_local_part = store_get(len+1);
4080 register int c = *address++;
4081 if (c == '\"') continue;
4091 /* We do the percent hack only for those domains that are listed in
4092 percent_hack_domains. A loop is required, to copy with multiple %-hacks. */
4094 if (percent_hack_domains != NULL)
4097 uschar *new_address = NULL;
4098 uschar *local_part = addr->cc_local_part;
4100 deliver_domain = addr->domain; /* set $domain */
4102 while ((rc = match_isinlist(deliver_domain, &percent_hack_domains, 0,
4103 &domainlist_anchor, addr->domain_cache, MCL_DOMAIN, TRUE, NULL))
4105 (t = Ustrrchr(local_part, '%')) != NULL)
4107 new_address = string_copy(local_part);
4108 new_address[t - local_part] = '@';
4109 deliver_domain = string_copylc(t+1);
4110 local_part = string_copyn(local_part, t - local_part);
4113 if (rc == DEFER) return DEFER; /* lookup deferred */
4115 /* If hackery happened, set up new parent and alter the current address. */
4117 if (new_address != NULL)
4119 address_item *new_parent = store_get(sizeof(address_item));
4120 *new_parent = *addr;
4121 addr->parent = new_parent;
4122 addr->address = new_address;
4123 addr->unique = string_copy(new_address);
4124 addr->domain = deliver_domain;
4125 addr->cc_local_part = local_part;
4126 DEBUG(D_deliver) debug_printf("%%-hack changed address to: %s\n",
4131 /* Create the lowercased version of the final local part, and make that the
4132 default one to be used. */
4134 addr->local_part = addr->lc_local_part = string_copylc(addr->cc_local_part);
4141 /*************************************************
4142 * Get next error message text *
4143 *************************************************/
4145 /* If f is not NULL, read the next "paragraph", from a customized error message
4146 text file, terminated by a line containing ****, and expand it.
4149 f NULL or a file to read from
4150 which string indicating which string (for errors)
4152 Returns: NULL or an expanded string
4156 next_emf(FILE *f, uschar *which)
4160 uschar *para, *yield;
4163 if (f == NULL) return NULL;
4165 if (Ufgets(buffer, sizeof(buffer), f) == NULL ||
4166 Ustrcmp(buffer, "****\n") == 0) return NULL;
4168 para = store_get(size);
4171 para = string_cat(para, &size, &ptr, buffer, Ustrlen(buffer));
4172 if (Ufgets(buffer, sizeof(buffer), f) == NULL ||
4173 Ustrcmp(buffer, "****\n") == 0) break;
4177 yield = expand_string(para);
4178 if (yield != NULL) return yield;
4180 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand string from "
4181 "bounce_message_file or warn_message_file (%s): %s", which,
4182 expand_string_message);
4189 /*************************************************
4190 * Close down a passed transport channel *
4191 *************************************************/
4193 /* This function is called when a passed transport channel cannot be used.
4194 It attempts to close it down tidily. The yield is always DELIVER_NOT_ATTEMPTED
4195 so that the function call can be the argument of a "return" statement.
4198 Returns: DELIVER_NOT_ATTEMPTED
4202 continue_closedown(void)
4204 if (continue_transport != NULL)
4206 transport_instance *t;
4207 for (t = transports; t != NULL; t = t->next)
4209 if (Ustrcmp(t->name, continue_transport) == 0)
4211 if (t->info->closedown != NULL) (t->info->closedown)(t);
4216 return DELIVER_NOT_ATTEMPTED;
4222 /*************************************************
4223 * Print address information *
4224 *************************************************/
4226 /* This function is called to output an address, or information about an
4227 address, for bounce or defer messages. If the hide_child flag is set, all we
4228 output is the original ancestor address.
4231 addr points to the address
4232 f the FILE to print to
4233 si an initial string
4234 sc a continuation string for before "generated"
4237 Returns: TRUE if the address is not hidden
4241 print_address_information(address_item *addr, FILE *f, uschar *si, uschar *sc,
4245 uschar *printed = US"";
4246 address_item *ancestor = addr;
4247 while (ancestor->parent != NULL) ancestor = ancestor->parent;
4249 fprintf(f, "%s", CS si);
4251 if (addr->parent != NULL && testflag(addr, af_hide_child))
4253 printed = US"an undisclosed address";
4256 else if (!testflag(addr, af_pfr) || addr->parent == NULL)
4257 printed = addr->address;
4261 uschar *s = addr->address;
4264 if (addr->address[0] == '>') { ss = US"mail"; s++; }
4265 else if (addr->address[0] == '|') ss = US"pipe";
4268 fprintf(f, "%s to %s%sgenerated by ", ss, s, sc);
4269 printed = addr->parent->address;
4272 fprintf(f, "%s", CS string_printing(printed));
4274 if (ancestor != addr)
4276 uschar *original = (ancestor->onetime_parent == NULL)?
4277 ancestor->address : ancestor->onetime_parent;
4278 if (strcmpic(original, printed) != 0)
4279 fprintf(f, "%s(%sgenerated from %s)", sc,
4280 (ancestor != addr->parent)? "ultimately " : "",
4281 string_printing(original));
4284 fprintf(f, "%s", CS se);
4292 /*************************************************
4293 * Print error for an address *
4294 *************************************************/
4296 /* This function is called to print the error information out of an address for
4297 a bounce or a warning message. It tries to format the message reasonably by
4298 introducing newlines. All lines are indented by 4; the initial printing
4299 position must be set before calling.
4301 This function used always to print the error. Nowadays we want to restrict it
4302 to cases such as LMTP/SMTP errors from a remote host, and errors from :fail:
4303 and filter "fail". We no longer pass other information willy-nilly in bounce
4304 and warning messages. Text in user_message is always output; text in message
4305 only if the af_pass_message flag is set.
4309 f the FILE to print on
4316 print_address_error(address_item *addr, FILE *f, uschar *t)
4318 int count = Ustrlen(t);
4319 uschar *s = testflag(addr, af_pass_message)? addr->message : NULL;
4323 if (addr->user_message != NULL) s = addr->user_message; else return;
4326 fprintf(f, "\n %s", t);
4330 if (*s == '\\' && s[1] == 'n')
4340 if (*s++ == ':' && isspace(*s) && count > 45)
4342 fprintf(f, "\n "); /* sic (because space follows) */
4354 /*************************************************
4355 * Check list of addresses for duplication *
4356 *************************************************/
4358 /* This function was introduced when the test for duplicate addresses that are
4359 not pipes, files, or autoreplies was moved from the middle of routing to when
4360 routing was complete. That was to fix obscure cases when the routing history
4361 affects the subsequent routing of identical addresses. If that change has to be
4362 reversed, this function is no longer needed. For a while, the old code that was
4363 affected by this change is commented with !!!OLD-DE-DUP!!! so it can be found
4366 This function is called after routing, to check that the final routed addresses
4367 are not duplicates. If we detect a duplicate, we remember what it is a
4368 duplicate of. Note that pipe, file, and autoreply de-duplication is handled
4369 during routing, so we must leave such "addresses" alone here, as otherwise they
4370 will incorrectly be discarded.
4372 Argument: address of list anchor
4377 do_duplicate_check(address_item **anchor)
4380 while ((addr = *anchor) != NULL)
4383 if (testflag(addr, af_pfr))
4385 anchor = &(addr->next);
4387 else if ((tnode = tree_search(tree_duplicates, addr->unique)) != NULL)
4389 DEBUG(D_deliver|D_route)
4390 debug_printf("%s is a duplicate address: discarded\n", addr->unique);
4391 *anchor = addr->next;
4392 addr->dupof = tnode->data.ptr;
4393 addr->next = addr_duplicate;
4394 addr_duplicate = addr;
4398 tree_add_duplicate(addr->unique, addr);
4399 anchor = &(addr->next);
4407 /*************************************************
4408 * Deliver one message *
4409 *************************************************/
4411 /* This is the function which is called when a message is to be delivered. It
4412 is passed the id of the message. It is possible that the message no longer
4413 exists, if some other process has delivered it, and it is also possible that
4414 the message is being worked on by another process, in which case the data file
4417 If no delivery is attempted for any of the above reasons, the function returns
4418 DELIVER_NOT_ATTEMPTED.
4420 If the give_up flag is set true, do not attempt any deliveries, but instead
4421 fail all outstanding addresses and return the message to the sender (or
4424 A delivery operation has a process all to itself; we never deliver more than
4425 one message in the same process. Therefore we needn't worry too much about
4429 id the id of the message to be delivered
4430 forced TRUE if delivery was forced by an administrator; this overrides
4431 retry delays and causes a delivery to be tried regardless
4432 give_up TRUE if an administrator has requested that delivery attempts
4435 Returns: When the global variable mua_wrapper is FALSE:
4436 DELIVER_ATTEMPTED_NORMAL if a delivery attempt was made
4437 DELIVER_NOT_ATTEMPTED otherwise (see comment above)
4438 When the global variable mua_wrapper is TRUE:
4439 DELIVER_MUA_SUCCEEDED if delivery succeeded
4440 DELIVER_MUA_FAILED if delivery failed
4441 DELIVER_NOT_ATTEMPTED if not attempted (should not occur)
4445 deliver_message(uschar *id, BOOL forced, BOOL give_up)
4448 int final_yield = DELIVER_ATTEMPTED_NORMAL;
4449 time_t now = time(NULL);
4450 address_item *addr_last = NULL;
4451 uschar *filter_message = NULL;
4453 int process_recipients = RECIP_ACCEPT;
4457 uschar *info = (queue_run_pid == (pid_t)0)?
4458 string_sprintf("delivering %s", id) :
4459 string_sprintf("delivering %s (queue run pid %d)", id, queue_run_pid);
4461 /* If the D_process_info bit is on, set_process_info() will output debugging
4462 information. If not, we want to show this initial information if D_deliver or
4463 D_queue_run is set or in verbose mode. */
4465 set_process_info("%s", info);
4467 if ((debug_selector & D_process_info) == 0 &&
4468 (debug_selector & (D_deliver|D_queue_run|D_v)) != 0)
4469 debug_printf("%s\n", info);
4471 /* Ensure that we catch any subprocesses that are created. Although Exim
4472 sets SIG_DFL as its initial default, some routes through the code end up
4473 here with it set to SIG_IGN - cases where a non-synchronous delivery process
4474 has been forked, but no re-exec has been done. We use sigaction rather than
4475 plain signal() on those OS where SA_NOCLDWAIT exists, because we want to be
4476 sure it is turned off. (There was a problem on AIX with this.) */
4480 struct sigaction act;
4481 act.sa_handler = SIG_DFL;
4482 sigemptyset(&(act.sa_mask));
4484 sigaction(SIGCHLD, &act, NULL);
4487 signal(SIGCHLD, SIG_DFL);
4490 /* Make the forcing flag available for routers and transports, set up the
4491 global message id field, and initialize the count for returned files and the
4492 message size. This use of strcpy() is OK because the length id is checked when
4493 it is obtained from a command line (the -M or -q options), and otherwise it is
4494 known to be a valid message id. */
4496 Ustrcpy(message_id, id);
4497 deliver_force = forced;
4501 /* Initialize some flags */
4503 update_spool = FALSE;
4504 remove_journal = TRUE;
4506 /* Reset the random number generator, so that if several delivery processes are
4507 started from a queue runner that has already used random numbers (for sorting),
4508 they don't all get the same sequence. */
4512 /* Open and lock the message's data file. Exim locks on this one because the
4513 header file may get replaced as it is re-written during the delivery process.
4514 Any failures cause messages to be written to the log, except for missing files
4515 while queue running - another process probably completed delivery. As part of
4516 opening the data file, message_subdir gets set. */
4518 if (!spool_open_datafile(id))
4519 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
4521 /* The value of message_size at this point has been set to the data length,
4522 plus one for the blank line that notionally precedes the data. */
4524 /* Now read the contents of the header file, which will set up the headers in
4525 store, and also the list of recipients and the tree of non-recipients and
4526 assorted flags. It updates message_size. If there is a reading or format error,
4527 give up; if the message has been around for sufficiently long, remove it. */
4529 sprintf(CS spoolname, "%s-H", id);
4530 if ((rc = spool_read_header(spoolname, TRUE, TRUE)) != spool_read_OK)
4532 if (errno == ERRNO_SPOOLFORMAT)
4534 struct stat statbuf;
4535 sprintf(CS big_buffer, "%s/input/%s/%s", spool_directory, message_subdir,
4537 if (Ustat(big_buffer, &statbuf) == 0)
4538 log_write(0, LOG_MAIN, "Format error in spool file %s: "
4539 "size=" OFF_T_FMT, spoolname, statbuf.st_size);
4540 else log_write(0, LOG_MAIN, "Format error in spool file %s", spoolname);
4543 log_write(0, LOG_MAIN, "Error reading spool file %s: %s", spoolname,
4546 /* If we managed to read the envelope data, received_time contains the
4547 time the message was received. Otherwise, we can calculate it from the
4550 if (rc != spool_read_hdrerror)
4553 for (i = 0; i < 6; i++)
4554 received_time = received_time * BASE_62 + tab62[id[i] - '0'];
4557 /* If we've had this malformed message too long, sling it. */
4559 if (now - received_time > keep_malformed)
4561 sprintf(CS spoolname, "%s/msglog/%s/%s", spool_directory, message_subdir, id);
4563 sprintf(CS spoolname, "%s/input/%s/%s-D", spool_directory, message_subdir, id);
4565 sprintf(CS spoolname, "%s/input/%s/%s-H", spool_directory, message_subdir, id);
4567 sprintf(CS spoolname, "%s/input/%s/%s-J", spool_directory, message_subdir, id);
4569 log_write(0, LOG_MAIN, "Message removed because older than %s",
4570 readconf_printtime(keep_malformed));
4573 (void)close(deliver_datafile);
4574 deliver_datafile = -1;
4575 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
4578 /* The spool header file has been read. Look to see if there is an existing
4579 journal file for this message. If there is, it means that a previous delivery
4580 attempt crashed (program or host) before it could update the spool header file.
4581 Read the list of delivered addresses from the journal and add them to the
4582 nonrecipients tree. Then update the spool file. We can leave the journal in
4583 existence, as it will get further successful deliveries added to it in this
4584 run, and it will be deleted if this function gets to its end successfully.
4585 Otherwise it might be needed again. */
4587 sprintf(CS spoolname, "%s/input/%s/%s-J", spool_directory, message_subdir, id);
4588 jread = Ufopen(spoolname, "rb");
4591 while (Ufgets(big_buffer, big_buffer_size, jread) != NULL)
4593 int n = Ustrlen(big_buffer);
4594 big_buffer[n-1] = 0;
4595 tree_add_nonrecipient(big_buffer);
4596 DEBUG(D_deliver) debug_printf("Previously delivered address %s taken from "
4597 "journal file\n", big_buffer);
4599 (void)fclose(jread);
4600 /* Panic-dies on error */
4601 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
4603 else if (errno != ENOENT)
4605 log_write(0, LOG_MAIN|LOG_PANIC, "attempt to open journal for reading gave: "
4606 "%s", strerror(errno));
4607 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
4610 /* A null recipients list indicates some kind of disaster. */
4612 if (recipients_list == NULL)
4614 (void)close(deliver_datafile);
4615 deliver_datafile = -1;
4616 log_write(0, LOG_MAIN, "Spool error: no recipients for %s", spoolname);
4617 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
4621 /* Handle a message that is frozen. There are a number of different things that
4622 can happen, but in the default situation, unless forced, no delivery is
4627 #ifdef SUPPORT_MOVE_FROZEN_MESSAGES
4628 /* Moving to another directory removes the message from Exim's view. Other
4629 tools must be used to deal with it. Logging of this action happens in
4630 spool_move_message() and its subfunctions. */
4632 if (move_frozen_messages &&
4633 spool_move_message(id, message_subdir, US"", US"F"))
4634 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
4637 /* For all frozen messages (bounces or not), timeout_frozen_after sets the
4638 maximum time to keep messages that are frozen. Thaw if we reach it, with a
4639 flag causing all recipients to be failed. The time is the age of the
4640 message, not the time since freezing. */
4642 if (timeout_frozen_after > 0 && message_age >= timeout_frozen_after)
4644 log_write(0, LOG_MAIN, "cancelled by timeout_frozen_after");
4645 process_recipients = RECIP_FAIL_TIMEOUT;
4648 /* For bounce messages (and others with no sender), thaw if the error message
4649 ignore timer is exceeded. The message will be discarded if this delivery
4652 else if (sender_address[0] == 0 && message_age >= ignore_bounce_errors_after)
4654 log_write(0, LOG_MAIN, "Unfrozen by errmsg timer");
4657 /* If this is a bounce message, or there's no auto thaw, or we haven't
4658 reached the auto thaw time yet, and this delivery is not forced by an admin
4659 user, do not attempt delivery of this message. Note that forced is set for
4660 continuing messages down the same channel, in order to skip load checking and
4661 ignore hold domains, but we don't want unfreezing in that case. */
4665 if ((sender_address[0] == 0 ||
4667 now <= deliver_frozen_at + auto_thaw
4670 (!forced || !deliver_force_thaw || !admin_user ||
4671 continue_hostname != NULL
4674 (void)close(deliver_datafile);
4675 deliver_datafile = -1;
4676 log_write(L_skip_delivery, LOG_MAIN, "Message is frozen");
4677 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
4680 /* If delivery was forced (by an admin user), assume a manual thaw.
4681 Otherwise it's an auto thaw. */
4685 deliver_manual_thaw = TRUE;
4686 log_write(0, LOG_MAIN, "Unfrozen by forced delivery");
4688 else log_write(0, LOG_MAIN, "Unfrozen by auto-thaw");
4691 /* We get here if any of the rules for unfreezing have triggered. */
4693 deliver_freeze = FALSE;
4694 update_spool = TRUE;
4698 /* Open the message log file if we are using them. This records details of
4699 deliveries, deferments, and failures for the benefit of the mail administrator.
4700 The log is not used by exim itself to track the progress of a message; that is
4701 done by rewriting the header spool file. */
4708 sprintf(CS spoolname, "%s/msglog/%s/%s", spool_directory, message_subdir, id);
4709 fd = open_msglog_file(spoolname, SPOOL_MODE, &error);
4713 log_write(0, LOG_MAIN|LOG_PANIC, "Couldn't %s message log %s: %s", error,
4714 spoolname, strerror(errno));
4715 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
4718 /* Make a C stream out of it. */
4720 message_log = fdopen(fd, "a");
4721 if (message_log == NULL)
4723 log_write(0, LOG_MAIN|LOG_PANIC, "Couldn't fdopen message log %s: %s",
4724 spoolname, strerror(errno));
4725 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
4730 /* If asked to give up on a message, log who did it, and set the action for all
4735 struct passwd *pw = getpwuid(real_uid);
4736 log_write(0, LOG_MAIN, "cancelled by %s", (pw != NULL)?
4737 US pw->pw_name : string_sprintf("uid %ld", (long int)real_uid));
4738 process_recipients = RECIP_FAIL;
4741 /* Otherwise, if there are too many Received: headers, fail all recipients. */
4743 else if (received_count > received_headers_max)
4744 process_recipients = RECIP_FAIL_LOOP;
4746 /* Otherwise, if a system-wide, address-independent message filter is
4747 specified, run it now, except in the case when we are failing all recipients as
4748 a result of timeout_frozen_after. If the system filter yields "delivered", then
4749 ignore the true recipients of the message. Failure of the filter file is
4750 logged, and the delivery attempt fails. */
4752 else if (system_filter != NULL && process_recipients != RECIP_FAIL_TIMEOUT)
4757 redirect_block redirect;
4759 if (system_filter_uid_set)
4761 ugid.uid = system_filter_uid;
4762 ugid.gid = system_filter_gid;
4763 ugid.uid_set = ugid.gid_set = TRUE;
4767 ugid.uid_set = ugid.gid_set = FALSE;
4770 return_path = sender_address;
4771 enable_dollar_recipients = TRUE; /* Permit $recipients in system filter */
4772 system_filtering = TRUE;
4774 /* Any error in the filter file causes a delivery to be abandoned. */
4776 redirect.string = system_filter;
4777 redirect.isfile = TRUE;
4778 redirect.check_owner = redirect.check_group = FALSE;
4779 redirect.owners = NULL;
4780 redirect.owngroups = NULL;
4782 redirect.modemask = 0;
4784 DEBUG(D_deliver|D_filter) debug_printf("running system filter\n");
4787 &redirect, /* Where the data is */
4788 RDO_DEFER | /* Turn on all the enabling options */
4789 RDO_FAIL | /* Leave off all the disabling options */
4794 NULL, /* No :include: restriction (not used in filter) */
4795 NULL, /* No sieve vacation directory (not sieve!) */
4796 NULL, /* No sieve user address (not sieve!) */
4797 NULL, /* No sieve subaddress (not sieve!) */
4798 &ugid, /* uid/gid data */
4799 &addr_new, /* Where to hang generated addresses */
4800 &filter_message, /* Where to put error message */
4801 NULL, /* Don't skip syntax errors */
4802 &filtertype, /* Will always be set to FILTER_EXIM for this call */
4803 US"system filter"); /* For error messages */
4805 DEBUG(D_deliver|D_filter) debug_printf("system filter returned %d\n", rc);
4807 if (rc == FF_ERROR || rc == FF_NONEXIST)
4809 (void)close(deliver_datafile);
4810 deliver_datafile = -1;
4811 log_write(0, LOG_MAIN|LOG_PANIC, "Error in system filter: %s",
4812 string_printing(filter_message));
4813 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
4816 /* Reset things. If the filter message is an empty string, which can happen
4817 for a filter "fail" or "freeze" command with no text, reset it to NULL. */
4819 system_filtering = FALSE;
4820 enable_dollar_recipients = FALSE;
4821 if (filter_message != NULL && filter_message[0] == 0) filter_message = NULL;
4823 /* Save the values of the system filter variables so that user filters
4826 memcpy(filter_sn, filter_n, sizeof(filter_sn));
4828 /* The filter can request that delivery of the original addresses be
4833 process_recipients = RECIP_DEFER;
4834 deliver_msglog("Delivery deferred by system filter\n");
4835 log_write(0, LOG_MAIN, "Delivery deferred by system filter");
4838 /* The filter can request that a message be frozen, but this does not
4839 take place if the message has been manually thawed. In that case, we must
4840 unset "delivered", which is forced by the "freeze" command to make -bF
4843 else if (rc == FF_FREEZE && !deliver_manual_thaw)
4845 deliver_freeze = TRUE;
4846 deliver_frozen_at = time(NULL);
4847 process_recipients = RECIP_DEFER;
4848 frozen_info = string_sprintf(" by the system filter%s%s",
4849 (filter_message == NULL)? US"" : US": ",
4850 (filter_message == NULL)? US"" : filter_message);
4853 /* The filter can request that a message be failed. The error message may be
4854 quite long - it is sent back to the sender in the bounce - but we don't want
4855 to fill up the log with repetitions of it. If it starts with << then the text
4856 between << and >> is written to the log, with the rest left for the bounce
4859 else if (rc == FF_FAIL)
4861 uschar *colon = US"";
4862 uschar *logmsg = US"";
4865 process_recipients = RECIP_FAIL_FILTER;
4867 if (filter_message != NULL)
4871 if (filter_message[0] == '<' && filter_message[1] == '<' &&
4872 (logend = Ustrstr(filter_message, ">>")) != NULL)
4874 logmsg = filter_message + 2;
4875 loglen = logend - logmsg;
4876 filter_message = logend + 2;
4877 if (filter_message[0] == 0) filter_message = NULL;
4881 logmsg = filter_message;
4882 loglen = Ustrlen(filter_message);
4886 log_write(0, LOG_MAIN, "cancelled by system filter%s%.*s", colon, loglen,
4890 /* Delivery can be restricted only to those recipients (if any) that the
4891 filter specified. */
4893 else if (rc == FF_DELIVERED)
4895 process_recipients = RECIP_IGNORE;
4896 if (addr_new == NULL)
4897 log_write(0, LOG_MAIN, "=> discarded (system filter)");
4899 log_write(0, LOG_MAIN, "original recipients ignored (system filter)");
4902 /* If any new addresses were created by the filter, fake up a "parent"
4903 for them. This is necessary for pipes, etc., which are expected to have
4904 parents, and it also gives some sensible logging for others. Allow
4905 pipes, files, and autoreplies, and run them as the filter uid if set,
4906 otherwise as the current uid. */
4908 if (addr_new != NULL)
4910 int uid = (system_filter_uid_set)? system_filter_uid : geteuid();
4911 int gid = (system_filter_gid_set)? system_filter_gid : getegid();
4913 /* The text "system-filter" is tested in transport_set_up_command() and in
4914 set_up_shell_command() in the pipe transport, to enable them to permit
4915 $recipients, so don't change it here without also changing it there. */
4917 address_item *p = addr_new;
4918 address_item *parent = deliver_make_addr(US"system-filter", FALSE);
4920 parent->domain = string_copylc(qualify_domain_recipient);
4921 parent->local_part = US"system-filter";
4923 /* As part of this loop, we arrange for addr_last to end up pointing
4924 at the final address. This is used if we go on to add addresses for the
4925 original recipients. */
4929 parent->child_count++;
4932 if (testflag(p, af_pfr))
4938 setflag(p, af_uid_set |
4944 /* Find the name of the system filter's appropriate pfr transport */
4946 if (p->address[0] == '|')
4949 tpname = system_filter_pipe_transport;
4950 address_pipe = p->address;
4952 else if (p->address[0] == '>')
4955 tpname = system_filter_reply_transport;
4959 if (p->address[Ustrlen(p->address)-1] == '/')
4961 type = US"directory";
4962 tpname = system_filter_directory_transport;
4967 tpname = system_filter_file_transport;
4969 address_file = p->address;
4972 /* Now find the actual transport, first expanding the name. We have
4973 set address_file or address_pipe above. */
4977 uschar *tmp = expand_string(tpname);
4978 address_file = address_pipe = NULL;
4980 p->message = string_sprintf("failed to expand \"%s\" as a "
4981 "system filter transport name", tpname);
4986 p->message = string_sprintf("system_filter_%s_transport is unset",
4992 transport_instance *tp;
4993 for (tp = transports; tp != NULL; tp = tp->next)
4995 if (Ustrcmp(tp->name, tpname) == 0)
5002 p->message = string_sprintf("failed to find \"%s\" transport "
5003 "for system filter delivery", tpname);
5006 /* If we couldn't set up a transport, defer the delivery, putting the
5007 error on the panic log as well as the main log. */
5009 if (p->transport == NULL)
5011 address_item *badp = p;
5013 if (addr_last == NULL) addr_new = p; else addr_last->next = p;
5014 badp->local_part = badp->address; /* Needed for log line */
5015 post_process_one(badp, DEFER, LOG_MAIN|LOG_PANIC, DTYPE_ROUTER, 0);
5018 } /* End of pfr handling */
5020 /* Either a non-pfr delivery, or we found a transport */
5022 DEBUG(D_deliver|D_filter)
5023 debug_printf("system filter added %s\n", p->address);
5027 } /* Loop through all addr_new addresses */
5032 /* Scan the recipients list, and for every one that is not in the non-
5033 recipients tree, add an addr item to the chain of new addresses. If the pno
5034 value is non-negative, we must set the onetime parent from it. This which
5035 points to the relevant entry in the recipients list.
5037 This processing can be altered by the setting of the process_recipients
5038 variable, which is changed if recipients are to be ignored, failed, or
5039 deferred. This can happen as a result of system filter activity, or if the -Mg
5040 option is used to fail all of them.
5042 Duplicate addresses are handled later by a different tree structure; we can't
5043 just extend the non-recipients tree, because that will be re-written to the
5044 spool if the message is deferred, and in any case there are casing
5045 complications for local addresses. */
5047 if (process_recipients != RECIP_IGNORE)
5049 for (i = 0; i < recipients_count; i++)
5051 if (tree_search(tree_nonrecipients, recipients_list[i].address) == NULL)
5053 recipient_item *r = recipients_list + i;
5054 address_item *new = deliver_make_addr(r->address, FALSE);
5055 new->p.errors_address = r->errors_to;
5058 new->onetime_parent = recipients_list[r->pno].address;
5060 switch (process_recipients)
5062 /* RECIP_DEFER is set when a system filter freezes a message. */
5065 new->next = addr_defer;
5070 /* RECIP_FAIL_FILTER is set when a system filter has obeyed a "fail"
5073 case RECIP_FAIL_FILTER:
5075 (filter_message == NULL)? US"delivery cancelled" : filter_message;
5076 setflag(new, af_pass_message);
5077 goto RECIP_QUEUE_FAILED; /* below */
5080 /* RECIP_FAIL_TIMEOUT is set when a message is frozen, but is older
5081 than the value in timeout_frozen_after. Treat non-bounce messages
5082 similarly to -Mg; for bounce messages we just want to discard, so
5083 don't put the address on the failed list. The timeout has already
5086 case RECIP_FAIL_TIMEOUT:
5087 new->message = US"delivery cancelled; message timed out";
5088 goto RECIP_QUEUE_FAILED; /* below */
5091 /* RECIP_FAIL is set when -Mg has been used. */
5094 new->message = US"delivery cancelled by administrator";
5097 /* Common code for the failure cases above. If this is not a bounce
5098 message, put the address on the failed list so that it is used to
5099 create a bounce. Otherwise do nothing - this just discards the address.
5100 The incident has already been logged. */
5103 if (sender_address[0] != 0)
5105 new->next = addr_failed;
5111 /* RECIP_FAIL_LOOP is set when there are too many Received: headers
5112 in the message. Process each address as a routing failure; if this
5113 is a bounce message, it will get frozen. */
5115 case RECIP_FAIL_LOOP:
5116 new->message = US"Too many \"Received\" headers - suspected mail loop";
5117 post_process_one(new, FAIL, LOG_MAIN, DTYPE_ROUTER, 0);
5121 /* Value should be RECIP_ACCEPT; take this as the safe default. */
5124 if (addr_new == NULL) addr_new = new; else addr_last->next = new;
5134 address_item *p = addr_new;
5135 debug_printf("Delivery address list:\n");
5138 debug_printf(" %s %s\n", p->address, (p->onetime_parent == NULL)? US"" :
5144 /* Set up the buffers used for copying over the file when delivering. */
5146 deliver_in_buffer = store_malloc(DELIVER_IN_BUFFER_SIZE);
5147 deliver_out_buffer = store_malloc(DELIVER_OUT_BUFFER_SIZE);
5151 /* Until there are no more new addresses, handle each one as follows:
5153 . If this is a generated address (indicated by the presence of a parent
5154 pointer) then check to see whether it is a pipe, file, or autoreply, and
5155 if so, handle it directly here. The router that produced the address will
5156 have set the allow flags into the address, and also set the uid/gid required.
5157 Having the routers generate new addresses and then checking them here at
5158 the outer level is tidier than making each router do the checking, and
5159 means that routers don't need access to the failed address queue.
5161 . Break up the address into local part and domain, and make lowercased
5162 versions of these strings. We also make unquoted versions of the local part.
5164 . Handle the percent hack for those domains for which it is valid.
5166 . For child addresses, determine if any of the parents have the same address.
5167 If so, generate a different string for previous delivery checking. Without
5168 this code, if the address spqr generates spqr via a forward or alias file,
5169 delivery of the generated spqr stops further attempts at the top level spqr,
5170 which is not what is wanted - it may have generated other addresses.
5172 . Check on the retry database to see if routing was previously deferred, but
5173 only if in a queue run. Addresses that are to be routed are put on the
5174 addr_route chain. Addresses that are to be deferred are put on the
5175 addr_defer chain. We do all the checking first, so as not to keep the
5176 retry database open any longer than necessary.
5178 . Now we run the addresses through the routers. A router may put the address
5179 on either the addr_local or the addr_remote chain for local or remote
5180 delivery, respectively, or put it on the addr_failed chain if it is
5181 undeliveable, or it may generate child addresses and put them on the
5182 addr_new chain, or it may defer an address. All the chain anchors are
5183 passed as arguments so that the routers can be called for verification
5186 . If new addresses have been generated by the routers, da capo.
5189 header_rewritten = FALSE; /* No headers rewritten yet */
5190 while (addr_new != NULL) /* Loop until all addresses dealt with */
5192 address_item *addr, *parent;
5193 dbm_file = dbfn_open(US"retry", O_RDONLY, &dbblock, FALSE);
5195 /* Failure to open the retry database is treated the same as if it does
5196 not exist. In both cases, dbm_file is NULL. */
5198 if (dbm_file == NULL)
5200 DEBUG(D_deliver|D_retry|D_route|D_hints_lookup)
5201 debug_printf("no retry data available\n");
5204 /* Scan the current batch of new addresses, to handle pipes, files and
5205 autoreplies, and determine which others are ready for routing. */
5207 while (addr_new != NULL)
5212 dbdata_retry *domain_retry_record;
5213 dbdata_retry *address_retry_record;
5216 addr_new = addr->next;
5218 DEBUG(D_deliver|D_retry|D_route)
5220 debug_printf(">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>\n");
5221 debug_printf("Considering: %s\n", addr->address);
5224 /* Handle generated address that is a pipe or a file or an autoreply. */
5226 if (testflag(addr, af_pfr))
5228 /* If an autoreply in a filter could not generate a syntactically valid
5229 address, give up forthwith. Set af_ignore_error so that we don't try to
5230 generate a bounce. */
5232 if (testflag(addr, af_bad_reply))
5234 addr->basic_errno = ERRNO_BADADDRESS2;
5235 addr->local_part = addr->address;
5237 US"filter autoreply generated syntactically invalid recipient";
5238 setflag(addr, af_ignore_error);
5239 (void)post_process_one(addr, FAIL, LOG_MAIN, DTYPE_ROUTER, 0);
5240 continue; /* with the next new address */
5243 /* If two different users specify delivery to the same pipe or file or
5244 autoreply, there should be two different deliveries, so build a unique
5245 string that incorporates the original address, and use this for
5246 duplicate testing and recording delivery, and also for retrying. */
5249 string_sprintf("%s:%s", addr->address, addr->parent->unique +
5250 (testflag(addr->parent, af_homonym)? 3:0));
5252 addr->address_retry_key = addr->domain_retry_key =
5253 string_sprintf("T:%s", addr->unique);
5255 /* If a filter file specifies two deliveries to the same pipe or file,
5256 we want to de-duplicate, but this is probably not wanted for two mail
5257 commands to the same address, where probably both should be delivered.
5258 So, we have to invent a different unique string in that case. Just
5259 keep piling '>' characters on the front. */
5261 if (addr->address[0] == '>')
5263 while (tree_search(tree_duplicates, addr->unique) != NULL)
5264 addr->unique = string_sprintf(">%s", addr->unique);
5267 else if ((tnode = tree_search(tree_duplicates, addr->unique)) != NULL)
5269 DEBUG(D_deliver|D_route)
5270 debug_printf("%s is a duplicate address: discarded\n", addr->address);
5271 addr->dupof = tnode->data.ptr;
5272 addr->next = addr_duplicate;
5273 addr_duplicate = addr;
5277 DEBUG(D_deliver|D_route) debug_printf("unique = %s\n", addr->unique);
5279 /* Check for previous delivery */
5281 if (tree_search(tree_nonrecipients, addr->unique) != NULL)
5283 DEBUG(D_deliver|D_route)
5284 debug_printf("%s was previously delivered: discarded\n", addr->address);
5285 child_done(addr, tod_stamp(tod_log));
5289 /* Save for checking future duplicates */
5291 tree_add_duplicate(addr->unique, addr);
5293 /* Set local part and domain */
5295 addr->local_part = addr->address;
5296 addr->domain = addr->parent->domain;
5298 /* Ensure that the delivery is permitted. */
5300 if (testflag(addr, af_file))
5302 if (!testflag(addr, af_allow_file))
5304 addr->basic_errno = ERRNO_FORBIDFILE;
5305 addr->message = US"delivery to file forbidden";
5306 (void)post_process_one(addr, FAIL, LOG_MAIN, DTYPE_ROUTER, 0);
5307 continue; /* with the next new address */
5310 else if (addr->address[0] == '|')
5312 if (!testflag(addr, af_allow_pipe))
5314 addr->basic_errno = ERRNO_FORBIDPIPE;
5315 addr->message = US"delivery to pipe forbidden";
5316 (void)post_process_one(addr, FAIL, LOG_MAIN, DTYPE_ROUTER, 0);
5317 continue; /* with the next new address */
5320 else if (!testflag(addr, af_allow_reply))
5322 addr->basic_errno = ERRNO_FORBIDREPLY;
5323 addr->message = US"autoreply forbidden";
5324 (void)post_process_one(addr, FAIL, LOG_MAIN, DTYPE_ROUTER, 0);
5325 continue; /* with the next new address */
5328 /* If the errno field is already set to BADTRANSPORT, it indicates
5329 failure to expand a transport string, or find the associated transport,
5330 or an unset transport when one is required. Leave this test till now so
5331 that the forbid errors are given in preference. */
5333 if (addr->basic_errno == ERRNO_BADTRANSPORT)
5335 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_ROUTER, 0);
5339 /* Treat /dev/null as a special case and abandon the delivery. This
5340 avoids having to specify a uid on the transport just for this case.
5341 Arrange for the transport name to be logged as "**bypassed**". */
5343 if (Ustrcmp(addr->address, "/dev/null") == 0)
5345 uschar *save = addr->transport->name;
5346 addr->transport->name = US"**bypassed**";
5347 (void)post_process_one(addr, OK, LOG_MAIN, DTYPE_TRANSPORT, '=');
5348 addr->transport->name = save;
5349 continue; /* with the next new address */
5352 /* Pipe, file, or autoreply delivery is to go ahead as a normal local
5355 DEBUG(D_deliver|D_route)
5356 debug_printf("queued for %s transport\n", addr->transport->name);
5357 addr->next = addr_local;
5359 continue; /* with the next new address */
5362 /* Handle normal addresses. First, split up into local part and domain,
5363 handling the %-hack if necessary. There is the possibility of a defer from
5364 a lookup in percent_hack_domains. */
5366 if ((rc = deliver_split_address(addr)) == DEFER)
5368 addr->message = US"cannot check percent_hack_domains";
5369 addr->basic_errno = ERRNO_LISTDEFER;
5370 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_NONE, 0);
5374 /* Check to see if the domain is held. If so, proceed only if the
5375 delivery was forced by hand. */
5377 deliver_domain = addr->domain; /* set $domain */
5378 if (!forced && hold_domains != NULL &&
5379 (rc = match_isinlist(addr->domain, &hold_domains, 0,
5380 &domainlist_anchor, addr->domain_cache, MCL_DOMAIN, TRUE,
5385 addr->message = US"hold_domains lookup deferred";
5386 addr->basic_errno = ERRNO_LISTDEFER;
5390 addr->message = US"domain is held";
5391 addr->basic_errno = ERRNO_HELD;
5393 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_NONE, 0);
5397 /* Now we can check for duplicates and previously delivered addresses. In
5398 order to do this, we have to generate a "unique" value for each address,
5399 because there may be identical actual addresses in a line of descendents.
5400 The "unique" field is initialized to the same value as the "address" field,
5401 but gets changed here to cope with identically-named descendents. */
5403 for (parent = addr->parent; parent != NULL; parent = parent->parent)
5404 if (strcmpic(addr->address, parent->address) == 0) break;
5406 /* If there's an ancestor with the same name, set the homonym flag. This
5407 influences how deliveries are recorded. Then add a prefix on the front of
5408 the unique address. We use \n\ where n starts at 0 and increases each time.
5409 It is unlikely to pass 9, but if it does, it may look odd but will still
5410 work. This means that siblings or cousins with the same names are treated
5411 as duplicates, which is what we want. */
5415 setflag(addr, af_homonym);
5416 if (parent->unique[0] != '\\')
5417 addr->unique = string_sprintf("\\0\\%s", addr->address);
5419 addr->unique = string_sprintf("\\%c\\%s", parent->unique[1] + 1,
5423 /* Ensure that the domain in the unique field is lower cased, because
5424 domains are always handled caselessly. */
5426 p = Ustrrchr(addr->unique, '@');
5427 while (*p != 0) { *p = tolower(*p); p++; }
5429 DEBUG(D_deliver|D_route) debug_printf("unique = %s\n", addr->unique);
5431 if (tree_search(tree_nonrecipients, addr->unique) != NULL)
5433 DEBUG(D_deliver|D_route)
5434 debug_printf("%s was previously delivered: discarded\n", addr->unique);
5435 child_done(addr, tod_stamp(tod_log));
5440 /* !!!OLD-DE-DUP!!! We used to test for duplicates at this point, in order
5441 to save effort on routing duplicate addresses. However, facilities have
5442 been added to Exim so that now two identical addresses that are children of
5443 other addresses may be routed differently as a result of their previous
5444 routing history. For example, different redirect routers may have given
5445 them different redirect_router values, but there are other cases too.
5446 Therefore, tests for duplicates now take place when routing is complete.
5447 This is the old code, kept for a while for the record, and in case this
5448 radical change has to be backed out for some reason. */
5451 /* If it's a duplicate, remember what it's a duplicate of */
5453 if ((tnode = tree_search(tree_duplicates, addr->unique)) != NULL)
5455 DEBUG(D_deliver|D_route)
5456 debug_printf("%s is a duplicate address: discarded\n", addr->unique);
5457 addr->dupof = tnode->data.ptr;
5458 addr->next = addr_duplicate;
5459 addr_duplicate = addr;
5463 /* Record this address, so subsequent duplicates get picked up. */
5465 tree_add_duplicate(addr->unique, addr);
5470 /* Get the routing retry status, saving the two retry keys (with and
5471 without the local part) for subsequent use. Ignore retry records that
5474 addr->domain_retry_key = string_sprintf("R:%s", addr->domain);
5475 addr->address_retry_key = string_sprintf("R:%s@%s", addr->local_part,
5478 if (dbm_file == NULL)
5479 domain_retry_record = address_retry_record = NULL;
5482 domain_retry_record = dbfn_read(dbm_file, addr->domain_retry_key);
5483 if (domain_retry_record != NULL &&
5484 now - domain_retry_record->time_stamp > retry_data_expire)
5485 domain_retry_record = NULL;
5487 address_retry_record = dbfn_read(dbm_file, addr->address_retry_key);
5488 if (address_retry_record != NULL &&
5489 now - address_retry_record->time_stamp > retry_data_expire)
5490 address_retry_record = NULL;
5493 DEBUG(D_deliver|D_retry)
5495 if (domain_retry_record == NULL)
5496 debug_printf("no domain retry record\n");
5497 if (address_retry_record == NULL)
5498 debug_printf("no address retry record\n");
5501 /* If we are sending a message down an existing SMTP connection, we must
5502 assume that the message which created the connection managed to route
5503 an address to that connection. We do not want to run the risk of taking
5504 a long time over routing here, because if we do, the server at the other
5505 end of the connection may time it out. This is especially true for messages
5506 with lots of addresses. For this kind of delivery, queue_running is not
5507 set, so we would normally route all addresses. We take a pragmatic approach
5508 and defer routing any addresses that have any kind of domain retry record.
5509 That is, we don't even look at their retry times. It doesn't matter if this
5510 doesn't work occasionally. This is all just an optimization, after all.
5512 The reason for not doing the same for address retries is that they normally
5513 arise from 4xx responses, not DNS timeouts. */
5515 if (continue_hostname != NULL && domain_retry_record != NULL)
5517 addr->message = US"reusing SMTP connection skips previous routing defer";
5518 addr->basic_errno = ERRNO_RRETRY;
5519 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_ROUTER, 0);
5522 /* If queue_running, defer routing unless no retry data or we've
5523 passed the next retry time, or this message is forced. However,
5524 if the retry time has expired, allow the routing attempt.
5525 If it fails again, the address will be failed. This ensures that
5526 each address is routed at least once, even after long-term routing
5529 If there is an address retry, check that too; just wait for the next
5530 retry time. This helps with the case when the temporary error on the
5531 address was really message-specific rather than address specific, since
5532 it allows other messages through. */
5534 else if (!deliver_force && queue_running &&
5535 ((domain_retry_record != NULL &&
5536 now < domain_retry_record->next_try &&
5537 !domain_retry_record->expired)
5539 (address_retry_record != NULL &&
5540 now < address_retry_record->next_try))
5543 addr->message = US"retry time not reached";
5544 addr->basic_errno = ERRNO_RRETRY;
5545 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_ROUTER, 0);
5548 /* The domain is OK for routing. Remember if retry data exists so it
5549 can be cleaned up after a successful delivery. */
5553 if (domain_retry_record != NULL || address_retry_record != NULL)
5554 setflag(addr, af_dr_retry_exists);
5555 addr->next = addr_route;
5557 DEBUG(D_deliver|D_route)
5558 debug_printf("%s: queued for routing\n", addr->address);
5562 /* The database is closed while routing is actually happening. Requests to
5563 update it are put on a chain and all processed together at the end. */
5565 if (dbm_file != NULL) dbfn_close(dbm_file);
5567 /* If queue_domains is set, we don't even want to try routing addresses in
5568 those domains. During queue runs, queue_domains is forced to be unset.
5569 Optimize by skipping this pass through the addresses if nothing is set. */
5571 if (!deliver_force && queue_domains != NULL)
5573 address_item *okaddr = NULL;
5574 while (addr_route != NULL)
5576 address_item *addr = addr_route;
5577 addr_route = addr->next;
5579 deliver_domain = addr->domain; /* set $domain */
5580 if ((rc = match_isinlist(addr->domain, &queue_domains, 0,
5581 &domainlist_anchor, addr->domain_cache, MCL_DOMAIN, TRUE, NULL))
5586 addr->basic_errno = ERRNO_LISTDEFER;
5587 addr->message = US"queue_domains lookup deferred";
5588 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_ROUTER, 0);
5592 addr->next = okaddr;
5598 addr->basic_errno = ERRNO_QUEUE_DOMAIN;
5599 addr->message = US"domain is in queue_domains";
5600 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_ROUTER, 0);
5604 addr_route = okaddr;
5607 /* Now route those addresses that are not deferred. */
5609 while (addr_route != NULL)
5612 address_item *addr = addr_route;
5613 uschar *old_domain = addr->domain;
5614 uschar *old_unique = addr->unique;
5615 addr_route = addr->next;
5618 /* Just in case some router parameter refers to it. */
5620 return_path = (addr->p.errors_address != NULL)?
5621 addr->p.errors_address : sender_address;
5623 /* If a router defers an address, add a retry item. Whether or not to
5624 use the local part in the key is a property of the router. */
5626 if ((rc = route_address(addr, &addr_local, &addr_remote, &addr_new,
5627 &addr_succeed, v_none)) == DEFER)
5628 retry_add_item(addr, (addr->router->retry_use_local_part)?
5629 string_sprintf("R:%s@%s", addr->local_part, addr->domain) :
5630 string_sprintf("R:%s", addr->domain), 0);
5632 /* Otherwise, if there is an existing retry record in the database, add
5633 retry items to delete both forms. Since the domain might have been
5634 rewritten (expanded to fully qualified) as a result of routing, ensure
5635 that the rewritten form is also deleted. */
5637 else if (testflag(addr, af_dr_retry_exists))
5639 retry_add_item(addr, addr->address_retry_key, rf_delete);
5640 retry_add_item(addr, addr->domain_retry_key, rf_delete);
5641 if (Ustrcmp(addr->domain, old_domain) != 0)
5642 retry_add_item(addr, string_sprintf("R:%s", old_domain), rf_delete);
5645 /* DISCARD is given for :blackhole: and "seen finish". The event has been
5646 logged, but we need to ensure the address (and maybe parents) is marked
5651 address_done(addr, tod_stamp(tod_log));
5652 continue; /* route next address */
5655 /* The address is finished with (failed or deferred). */
5659 (void)post_process_one(addr, rc, LOG_MAIN, DTYPE_ROUTER, 0);
5660 continue; /* route next address */
5663 /* The address has been routed. If the router changed the domain, it will
5664 also have changed the unique address. We have to test whether this address
5665 has already been delivered, because it's the unique address that finally
5668 if (addr->unique != old_unique &&
5669 tree_search(tree_nonrecipients, addr->unique) != 0)
5671 DEBUG(D_deliver|D_route) debug_printf("%s was previously delivered: "
5672 "discarded\n", addr->address);
5673 if (addr_remote == addr) addr_remote = addr->next;
5674 else if (addr_local == addr) addr_local = addr->next;
5677 /* If the router has same_domain_copy_routing set, we are permitted to copy
5678 the routing for any other addresses with the same domain. This is an
5679 optimisation to save repeated DNS lookups for "standard" remote domain
5680 routing. The option is settable only on routers that generate host lists.
5681 We play it very safe, and do the optimization only if the address is routed
5682 to a remote transport, there are no header changes, and the domain was not
5683 modified by the router. */
5685 if (addr_remote == addr &&
5686 addr->router->same_domain_copy_routing &&
5687 addr->p.extra_headers == NULL &&
5688 addr->p.remove_headers == NULL &&
5689 old_domain == addr->domain)
5691 address_item **chain = &addr_route;
5692 while (*chain != NULL)
5694 address_item *addr2 = *chain;
5695 if (Ustrcmp(addr2->domain, addr->domain) != 0)
5697 chain = &(addr2->next);
5701 /* Found a suitable address; take it off the routing list and add it to
5702 the remote delivery list. */
5704 *chain = addr2->next;
5705 addr2->next = addr_remote;
5706 addr_remote = addr2;
5708 /* Copy the routing data */
5710 addr2->domain = addr->domain;
5711 addr2->router = addr->router;
5712 addr2->transport = addr->transport;
5713 addr2->host_list = addr->host_list;
5714 addr2->fallback_hosts = addr->fallback_hosts;
5715 addr2->p.errors_address = addr->p.errors_address;
5716 copyflag(addr2, addr, af_hide_child | af_local_host_removed);
5718 DEBUG(D_deliver|D_route)
5720 debug_printf(">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>\n"
5722 "Routing for %s copied from %s\n",
5723 addr2->address, addr2->address, addr->address);
5727 } /* Continue with routing the next address. */
5728 } /* Loop to process any child addresses that the routers created, and
5729 any rerouted addresses that got put back on the new chain. */
5732 /* Debugging: show the results of the routing */
5734 DEBUG(D_deliver|D_retry|D_route)
5736 address_item *p = addr_local;
5737 debug_printf(">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>\n");
5738 debug_printf("After routing:\n Local deliveries:\n");
5741 debug_printf(" %s\n", p->address);
5746 debug_printf(" Remote deliveries:\n");
5749 debug_printf(" %s\n", p->address);
5754 debug_printf(" Failed addresses:\n");
5757 debug_printf(" %s\n", p->address);
5762 debug_printf(" Deferred addresses:\n");
5765 debug_printf(" %s\n", p->address);
5770 /* Free any resources that were cached during routing. */
5775 /* These two variables are set only during routing, after check_local_user.
5776 Ensure they are not set in transports. */
5778 local_user_gid = (gid_t)(-1);
5779 local_user_uid = (uid_t)(-1);
5782 /* !!!OLD-DE-DUP!!! The next two statement were introduced when checking for
5783 duplicates was moved from within routing to afterwards. If that change has to
5784 be backed out, they should be removed. */
5786 /* Check for any duplicate addresses. This check is delayed until after
5787 routing, because the flexibility of the routing configuration means that
5788 identical addresses with different parentage may end up being redirected to
5789 different addresses. Checking for duplicates too early (as we previously used
5790 to) makes this kind of thing not work. */
5792 do_duplicate_check(&addr_local);
5793 do_duplicate_check(&addr_remote);
5796 /* When acting as an MUA wrapper, we proceed only if all addresses route to a
5797 remote transport. The check that they all end up in one transaction happens in
5798 the do_remote_deliveries() function. */
5800 if (mua_wrapper && (addr_local != NULL || addr_failed != NULL ||
5801 addr_defer != NULL))
5804 uschar *which, *colon, *msg;
5806 if (addr_local != NULL)
5811 else if (addr_defer != NULL)
5814 which = US"deferred";
5822 while (addr->parent != NULL) addr = addr->parent;
5824 if (addr->message != NULL)
5827 msg = addr->message;
5829 else colon = msg = US"";
5831 /* We don't need to log here for a forced failure as it will already
5832 have been logged. Defer will also have been logged, but as a defer, so we do
5833 need to do the failure logging. */
5835 if (addr != addr_failed)
5836 log_write(0, LOG_MAIN, "** %s routing yielded a %s delivery",
5837 addr->address, which);
5839 /* Always write an error to the caller */
5841 fprintf(stderr, "routing %s yielded a %s delivery%s%s\n", addr->address,
5844 final_yield = DELIVER_MUA_FAILED;
5845 addr_failed = addr_defer = NULL; /* So that we remove the message */
5846 goto DELIVERY_TIDYUP;
5850 /* If this is a run to continue deliveries to an external channel that is
5851 already set up, defer any local deliveries. */
5853 if (continue_transport != NULL)
5855 if (addr_defer == NULL) addr_defer = addr_local; else
5857 address_item *addr = addr_defer;
5858 while (addr->next != NULL) addr = addr->next;
5859 addr->next = addr_local;
5865 /* Because address rewriting can happen in the routers, we should not really do
5866 ANY deliveries until all addresses have been routed, so that all recipients of
5867 the message get the same headers. However, this is in practice not always
5868 possible, since sometimes remote addresses give DNS timeouts for days on end.
5869 The pragmatic approach is to deliver what we can now, saving any rewritten
5870 headers so that at least the next lot of recipients benefit from the rewriting
5871 that has already been done.
5873 If any headers have been rewritten during routing, update the spool file to
5874 remember them for all subsequent deliveries. This can be delayed till later if
5875 there is only address to be delivered - if it succeeds the spool write need not
5878 if (header_rewritten &&
5879 ((addr_local != NULL &&
5880 (addr_local->next != NULL || addr_remote != NULL)) ||
5881 (addr_remote != NULL && addr_remote->next != NULL)))
5883 /* Panic-dies on error */
5884 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
5885 header_rewritten = FALSE;
5889 /* If there are any deliveries to be done, open the journal file. This is used
5890 to record successful deliveries as soon as possible after each delivery is
5891 known to be complete. A file opened with O_APPEND is used so that several
5892 processes can run simultaneously.
5894 The journal is just insurance against crashes. When the spool file is
5895 ultimately updated at the end of processing, the journal is deleted. If a
5896 journal is found to exist at the start of delivery, the addresses listed
5897 therein are added to the non-recipients. */
5899 if (addr_local != NULL || addr_remote != NULL)
5901 sprintf(CS spoolname, "%s/input/%s/%s-J", spool_directory, message_subdir, id);
5902 journal_fd = Uopen(spoolname, O_WRONLY|O_APPEND|O_CREAT, SPOOL_MODE);
5906 log_write(0, LOG_MAIN|LOG_PANIC, "Couldn't open journal file %s: %s",
5907 spoolname, strerror(errno));
5908 return DELIVER_NOT_ATTEMPTED;
5911 /* Set the close-on-exec flag, make the file owned by Exim, and ensure
5912 that the mode is correct - the group setting doesn't always seem to get
5913 set automatically. */
5915 (void)fcntl(journal_fd, F_SETFD, fcntl(journal_fd, F_GETFD) | FD_CLOEXEC);
5916 (void)fchown(journal_fd, exim_uid, exim_gid);
5917 (void)fchmod(journal_fd, SPOOL_MODE);
5921 /* Now we can get down to the business of actually doing deliveries. Local
5922 deliveries are done first, then remote ones. If ever the problems of how to
5923 handle fallback transports are figured out, this section can be put into a loop
5924 for handling fallbacks, though the uid switching will have to be revised. */
5926 /* Precompile a regex that is used to recognize a parameter in response
5927 to an LHLO command, if is isn't already compiled. This may be used on both
5928 local and remote LMTP deliveries. */
5930 if (regex_IGNOREQUOTA == NULL) regex_IGNOREQUOTA =
5931 regex_must_compile(US"\\n250[\\s\\-]IGNOREQUOTA(\\s|\\n|$)", FALSE, TRUE);
5933 /* Handle local deliveries */
5935 if (addr_local != NULL)
5937 DEBUG(D_deliver|D_transport)
5938 debug_printf(">>>>>>>>>>>>>>>> Local deliveries >>>>>>>>>>>>>>>>\n");
5939 do_local_deliveries();
5940 disable_logging = FALSE;
5943 /* If queue_run_local is set, we do not want to attempt any remote deliveries,
5944 so just queue them all. */
5946 if (queue_run_local)
5948 while (addr_remote != NULL)
5950 address_item *addr = addr_remote;
5951 addr_remote = addr->next;
5953 addr->basic_errno = ERRNO_LOCAL_ONLY;
5954 addr->message = US"remote deliveries suppressed";
5955 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_TRANSPORT, 0);
5959 /* Handle remote deliveries */
5961 if (addr_remote != NULL)
5963 DEBUG(D_deliver|D_transport)
5964 debug_printf(">>>>>>>>>>>>>>>> Remote deliveries >>>>>>>>>>>>>>>>\n");
5966 /* Precompile some regex that are used to recognize parameters in response
5967 to an EHLO command, if they aren't already compiled. */
5969 if (regex_PIPELINING == NULL) regex_PIPELINING =
5970 regex_must_compile(US"\\n250[\\s\\-]PIPELINING(\\s|\\n|$)", FALSE, TRUE);
5972 if (regex_SIZE == NULL) regex_SIZE =
5973 regex_must_compile(US"\\n250[\\s\\-]SIZE(\\s|\\n|$)", FALSE, TRUE);
5975 if (regex_AUTH == NULL) regex_AUTH =
5976 regex_must_compile(US"\\n250[\\s\\-]AUTH\\s+([\\-\\w\\s]+)(?:\\n|$)",
5980 if (regex_STARTTLS == NULL) regex_STARTTLS =
5981 regex_must_compile(US"\\n250[\\s\\-]STARTTLS(\\s|\\n|$)", FALSE, TRUE);
5984 /* Now sort the addresses if required, and do the deliveries. The yield of
5985 do_remote_deliveries is FALSE when mua_wrapper is set and all addresses
5986 cannot be delivered in one transaction. */
5988 if (remote_sort_domains != NULL) sort_remote_deliveries();
5989 if (!do_remote_deliveries(FALSE))
5991 log_write(0, LOG_MAIN, "** mua_wrapper is set but recipients cannot all "
5992 "be delivered in one transaction");
5993 fprintf(stderr, "delivery to smarthost failed (configuration problem)\n");
5995 final_yield = DELIVER_MUA_FAILED;
5996 addr_failed = addr_defer = NULL; /* So that we remove the message */
5997 goto DELIVERY_TIDYUP;
6000 /* See if any of the addresses that failed got put on the queue for delivery
6001 to their fallback hosts. We do it this way because often the same fallback
6002 host is used for many domains, so all can be sent in a single transaction
6003 (if appropriately configured). */
6005 if (addr_fallback != NULL && !mua_wrapper)
6007 DEBUG(D_deliver) debug_printf("Delivering to fallback hosts\n");
6008 addr_remote = addr_fallback;
6009 addr_fallback = NULL;
6010 if (remote_sort_domains != NULL) sort_remote_deliveries();
6011 do_remote_deliveries(TRUE);
6013 disable_logging = FALSE;
6017 /* All deliveries are now complete. Ignore SIGTERM during this tidying up
6018 phase, to minimize cases of half-done things. */
6021 debug_printf(">>>>>>>>>>>>>>>> deliveries are done >>>>>>>>>>>>>>>>\n");
6023 /* Root privilege is no longer needed */
6025 exim_setugid(exim_uid, exim_gid, FALSE, US"post-delivery tidying");
6027 set_process_info("tidying up after delivering %s", message_id);
6028 signal(SIGTERM, SIG_IGN);
6030 /* When we are acting as an MUA wrapper, the smtp transport will either have
6031 succeeded for all addresses, or failed them all in normal cases. However, there
6032 are some setup situations (e.g. when a named port does not exist) that cause an
6033 immediate exit with deferral of all addresses. Convert those into failures. We
6034 do not ever want to retry, nor do we want to send a bounce message. */
6038 if (addr_defer != NULL)
6040 address_item *addr, *nextaddr;
6041 for (addr = addr_defer; addr != NULL; addr = nextaddr)
6043 log_write(0, LOG_MAIN, "** %s mua_wrapper forced failure for deferred "
6044 "delivery", addr->address);
6045 nextaddr = addr->next;
6046 addr->next = addr_failed;
6052 /* Now all should either have succeeded or failed. */
6054 if (addr_failed == NULL) final_yield = DELIVER_MUA_SUCCEEDED; else
6056 uschar *s = (addr_failed->user_message != NULL)?
6057 addr_failed->user_message : addr_failed->message;
6059 fprintf(stderr, "Delivery failed: ");
6060 if (addr_failed->basic_errno > 0)
6062 fprintf(stderr, "%s", strerror(addr_failed->basic_errno));
6063 if (s != NULL) fprintf(stderr, ": ");
6067 if (addr_failed->basic_errno <= 0) fprintf(stderr, "unknown error");
6069 else fprintf(stderr, "%s", CS s);
6070 fprintf(stderr, "\n");
6072 final_yield = DELIVER_MUA_FAILED;
6077 /* In a normal configuration, we now update the retry database. This is done in
6078 one fell swoop at the end in order not to keep opening and closing (and
6079 locking) the database. The code for handling retries is hived off into a
6080 separate module for convenience. We pass it the addresses of the various
6081 chains, because deferred addresses can get moved onto the failed chain if the
6082 retry cutoff time has expired for all alternative destinations. Bypass the
6083 updating of the database if the -N flag is set, which is a debugging thing that
6084 prevents actual delivery. */
6086 else if (!dont_deliver) retry_update(&addr_defer, &addr_failed, &addr_succeed);
6088 /* If any addresses failed, we must send a message to somebody, unless
6089 af_ignore_error is set, in which case no action is taken. It is possible for
6090 several messages to get sent if there are addresses with different
6093 while (addr_failed != NULL)
6097 uschar *logtod = tod_stamp(tod_log);
6099 address_item *handled_addr = NULL;
6100 address_item **paddr;
6101 address_item *msgchain = NULL;
6102 address_item **pmsgchain = &msgchain;
6104 /* There are weird cases when logging is disabled in the transport. However,
6105 there may not be a transport (address failed by a router). */
6107 disable_logging = FALSE;
6108 if (addr_failed->transport != NULL)
6109 disable_logging = addr_failed->transport->disable_logging;
6112 debug_printf("processing failed address %s\n", addr_failed->address);
6114 /* There are only two ways an address in a bounce message can get here:
6116 (1) When delivery was initially deferred, but has now timed out (in the call
6117 to retry_update() above). We can detect this by testing for
6118 af_retry_timedout. If the address does not have its own errors address,
6119 we arrange to ignore the error.
6121 (2) If delivery failures for bounce messages are being ignored. We can detect
6122 this by testing for af_ignore_error. This will also be set if a bounce
6123 message has been autothawed and the ignore_bounce_errors_after time has
6124 passed. It might also be set if a router was explicitly configured to
6125 ignore errors (errors_to = "").
6127 If neither of these cases obtains, something has gone wrong. Log the
6128 incident, but then ignore the error. */
6130 if (sender_address[0] == 0 && addr_failed->p.errors_address == NULL)
6132 if (!testflag(addr_failed, af_retry_timedout) &&
6133 !testflag(addr_failed, af_ignore_error))
6135 log_write(0, LOG_MAIN|LOG_PANIC, "internal error: bounce message "
6136 "failure is neither frozen nor ignored (it's been ignored)");
6138 setflag(addr_failed, af_ignore_error);
6141 /* If the first address on the list has af_ignore_error set, just remove
6142 it from the list, throw away any saved message file, log it, and
6143 mark the recipient done. */
6145 if (testflag(addr_failed, af_ignore_error))
6148 addr_failed = addr->next;
6149 if (addr->return_filename != NULL) Uunlink(addr->return_filename);
6151 log_write(0, LOG_MAIN, "%s%s%s%s: error ignored",
6153 (addr->parent == NULL)? US"" : US" <",
6154 (addr->parent == NULL)? US"" : addr->parent->address,
6155 (addr->parent == NULL)? US"" : US">");
6157 address_done(addr, logtod);
6158 child_done(addr, logtod);
6159 /* Panic-dies on error */
6160 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
6163 /* Otherwise, handle the sending of a message. Find the error address for
6164 the first address, then send a message that includes all failed addresses
6165 that have the same error address. Note the bounce_recipient is a global so
6166 that it can be accesssed by $bounce_recipient while creating a customized
6171 bounce_recipient = (addr_failed->p.errors_address == NULL)?
6172 sender_address : addr_failed->p.errors_address;
6174 /* Make a subprocess to send a message */
6176 pid = child_open_exim(&fd);
6178 /* Creation of child failed */
6181 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Process %d (parent %d) failed to "
6182 "create child process to send failure message: %s", getpid(),
6183 getppid(), strerror(errno));
6185 /* Creation of child succeeded */
6192 uschar *bcc, *emf_text;
6193 FILE *f = fdopen(fd, "wb");
6195 BOOL to_sender = strcmpic(sender_address, bounce_recipient) == 0;
6196 int max = (bounce_return_size_limit/DELIVER_IN_BUFFER_SIZE + 1) *
6197 DELIVER_IN_BUFFER_SIZE;
6200 debug_printf("sending error message to: %s\n", bounce_recipient);
6202 /* Scan the addresses for all that have the same errors address, removing
6203 them from the addr_failed chain, and putting them on msgchain. */
6205 paddr = &addr_failed;
6206 for (addr = addr_failed; addr != NULL; addr = *paddr)
6208 if (Ustrcmp(bounce_recipient, (addr->p.errors_address == NULL)?
6209 sender_address : addr->p.errors_address) != 0)
6211 paddr = &(addr->next); /* Not the same; skip */
6213 else /* The same - dechain */
6215 *paddr = addr->next;
6218 pmsgchain = &(addr->next);
6222 /* Include X-Failed-Recipients: for automatic interpretation, but do
6223 not let any one header line get too long. We do this by starting a
6224 new header every 50 recipients. Omit any addresses for which the
6225 "hide_child" flag is set. */
6227 for (addr = msgchain; addr != NULL; addr = addr->next)
6229 if (testflag(addr, af_hide_child)) continue;
6236 (rcount++ == 0)? "X-Failed-Recipients: " : ",\n ",
6237 (testflag(addr, af_pfr) && addr->parent != NULL)?
6238 string_printing(addr->parent->address) :
6239 string_printing(addr->address));
6241 if (rcount > 0) fprintf(f, "\n");
6243 /* Output the standard headers */
6245 if (errors_reply_to != NULL)
6246 fprintf(f, "Reply-To: %s\n", errors_reply_to);
6247 fprintf(f, "Auto-Submitted: auto-replied\n");
6248 fprintf(f, "From: Mail Delivery System <Mailer-Daemon@%s>\n",
6249 qualify_domain_sender);
6250 fprintf(f, "To: %s\n", bounce_recipient);
6252 /* Open a template file if one is provided. Log failure to open, but
6253 carry on - default texts will be used. */
6255 if (bounce_message_file != NULL)
6257 emf = Ufopen(bounce_message_file, "rb");
6259 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to open %s for error "
6260 "message texts: %s", bounce_message_file, strerror(errno));
6263 /* Quietly copy to configured additional addresses if required. */
6265 bcc = moan_check_errorcopy(bounce_recipient);
6266 if (bcc != NULL) fprintf(f, "Bcc: %s\n", bcc);
6268 /* The texts for the message can be read from a template file; if there
6269 isn't one, or if it is too short, built-in texts are used. The first
6270 emf text is a Subject: and any other headers. */
6272 emf_text = next_emf(emf, US"header");
6273 if (emf_text != NULL) fprintf(f, "%s\n", emf_text); else
6275 fprintf(f, "Subject: Mail delivery failed%s\n\n",
6276 to_sender? ": returning message to sender" : "");
6279 emf_text = next_emf(emf, US"intro");
6280 if (emf_text != NULL) fprintf(f, "%s", CS emf_text); else
6283 /* This message has been reworded several times. It seems to be confusing to
6284 somebody, however it is worded. I have retreated to the original, simple
6286 "This message was created automatically by mail delivery software.\n");
6287 if (bounce_message_text != NULL) fprintf(f, "%s", CS bounce_message_text);
6291 "\nA message that you sent could not be delivered to one or more of its\n"
6292 "recipients. This is a permanent error. The following address(es) failed:\n");
6297 "\nA message sent by\n\n <%s>\n\n"
6298 "could not be delivered to one or more of its recipients. The following\n"
6299 "address(es) failed:\n", sender_address);
6304 /* Process the addresses, leaving them on the msgchain if they have a
6305 file name for a return message. (There has already been a check in
6306 post_process_one() for the existence of data in the message file.) A TRUE
6307 return from print_address_information() means that the address is not
6311 for (addr = msgchain; addr != NULL; addr = *paddr)
6313 if (print_address_information(addr, f, US" ", US"\n ", US""))
6314 print_address_error(addr, f, US"");
6316 /* End the final line for the address */
6320 /* Leave on msgchain if there's a return file. */
6322 if (addr->return_file >= 0)
6324 paddr = &(addr->next);
6328 /* Else save so that we can tick off the recipient when the
6333 *paddr = addr->next;
6334 addr->next = handled_addr;
6335 handled_addr = addr;
6341 /* Get the next text, whether we need it or not, so as to be
6342 positioned for the one after. */
6344 emf_text = next_emf(emf, US"generated text");
6346 /* If there were any file messages passed by the local transports,
6347 include them in the message. Then put the address on the handled chain.
6348 In the case of a batch of addresses that were all sent to the same
6349 transport, the return_file field in all of them will contain the same
6350 fd, and the return_filename field in the *last* one will be set (to the
6351 name of the file). */
6353 if (msgchain != NULL)
6355 address_item *nextaddr;
6357 if (emf_text != NULL) fprintf(f, "%s", CS emf_text); else
6359 "The following text was generated during the delivery "
6360 "attempt%s:\n", (filecount > 1)? "s" : "");
6362 for (addr = msgchain; addr != NULL; addr = nextaddr)
6365 address_item *topaddr = addr;
6367 /* List all the addresses that relate to this file */
6370 while(addr != NULL) /* Insurance */
6372 print_address_information(addr, f, US"------ ", US"\n ",
6374 if (addr->return_filename != NULL) break;
6379 /* Now copy the file */
6381 fm = Ufopen(addr->return_filename, "rb");
6384 fprintf(f, " +++ Exim error... failed to open text file: %s\n",
6388 while ((ch = fgetc(fm)) != EOF) fputc(ch, f);
6391 Uunlink(addr->return_filename);
6393 /* Can now add to handled chain, first fishing off the next
6394 address on the msgchain. */
6396 nextaddr = addr->next;
6397 addr->next = handled_addr;
6398 handled_addr = topaddr;
6403 /* Now copy the message, trying to give an intelligible comment if
6404 it is too long for it all to be copied. The limit isn't strictly
6405 applied because of the buffering. There is, however, an option
6406 to suppress copying altogether. */
6408 emf_text = next_emf(emf, US"copy");
6410 if (bounce_return_message)
6412 int topt = topt_add_return_path;
6413 if (!bounce_return_body) topt |= topt_no_body;
6415 if (emf_text != NULL) fprintf(f, "%s", CS emf_text); else
6417 if (bounce_return_body) fprintf(f,
6418 "------ This is a copy of the message, including all the headers. ------\n");
6420 "------ This is a copy of the message's headers. ------\n");
6423 /* While reading the "truncated" message, set return_size_limit to
6424 the actual max testing value, rounded. We need to read the message
6425 whether we are going to use it or not. */
6428 int temp = bounce_return_size_limit;
6429 bounce_return_size_limit = (max/1000)*1000;
6430 emf_text = next_emf(emf, US"truncated");
6431 bounce_return_size_limit = temp;
6434 if (bounce_return_body && bounce_return_size_limit > 0)
6436 struct stat statbuf;
6437 if (fstat(deliver_datafile, &statbuf) == 0 && statbuf.st_size > max)
6439 if (emf_text != NULL) fprintf(f, "%s", CS emf_text); else
6442 "------ The body of the message is " OFF_T_FMT " characters long; only the first\n"
6443 "------ %d or so are included here.\n", statbuf.st_size, max);
6450 transport_filter_argv = NULL; /* Just in case */
6451 return_path = sender_address; /* In case not previously set */
6452 transport_write_message(NULL, fileno(f), topt,
6453 bounce_return_size_limit, NULL, NULL, NULL, NULL, NULL, 0);
6456 /* Write final text and close the template file if one is open */
6460 emf_text = next_emf(emf, US"final");
6461 if (emf_text != NULL) fprintf(f, "%s", CS emf_text);
6465 /* Close the file, which should send an EOF to the child process
6466 that is receiving the message. Wait for it to finish. */
6469 rc = child_close(pid, 0); /* Waits for child to close, no timeout */
6471 /* In the test harness, let the child do it's thing first. */
6473 if (running_in_test_harness) millisleep(500);
6475 /* If the process failed, there was some disaster in setting up the
6476 error message. Unless the message is very old, ensure that addr_defer
6477 is non-null, which will have the effect of leaving the message on the
6478 spool. The failed addresses will get tried again next time. However, we
6479 don't really want this to happen too often, so freeze the message unless
6480 there are some genuine deferred addresses to try. To do this we have
6481 to call spool_write_header() here, because with no genuine deferred
6482 addresses the normal code below doesn't get run. */
6487 if (now - received_time < retry_maximum_timeout && addr_defer == NULL)
6489 addr_defer = (address_item *)(+1);
6490 deliver_freeze = TRUE;
6491 deliver_frozen_at = time(NULL);
6492 /* Panic-dies on error */
6493 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
6496 deliver_msglog("Process failed (%d) when writing error message "
6497 "to %s%s", rc, bounce_recipient, s);
6498 log_write(0, LOG_MAIN, "Process failed (%d) when writing error message "
6499 "to %s%s", rc, bounce_recipient, s);
6502 /* The message succeeded. Ensure that the recipients that failed are
6503 now marked finished with on the spool and their parents updated. */
6507 for (addr = handled_addr; addr != NULL; addr = addr->next)
6509 address_done(addr, logtod);
6510 child_done(addr, logtod);
6512 /* Panic-dies on error */
6513 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
6519 disable_logging = FALSE; /* In case left set */
6521 /* Come here from the mua_wrapper case if routing goes wrong */
6525 /* If there are now no deferred addresses, we are done. Preserve the
6526 message log if so configured, and we are using them. Otherwise, sling it.
6527 Then delete the message itself. */
6529 if (addr_defer == NULL)
6533 sprintf(CS spoolname, "%s/msglog/%s/%s", spool_directory, message_subdir,
6535 if (preserve_message_logs)
6538 sprintf(CS big_buffer, "%s/msglog.OLD/%s", spool_directory, id);
6539 if ((rc = Urename(spoolname, big_buffer)) < 0)
6541 (void)directory_make(spool_directory, US"msglog.OLD",
6542 MSGLOG_DIRECTORY_MODE, TRUE);
6543 rc = Urename(spoolname, big_buffer);
6546 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to move %s to the "
6547 "msglog.OLD directory", spoolname);
6551 if (Uunlink(spoolname) < 0)
6552 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s", spoolname);
6556 /* Remove the two message files. */
6558 sprintf(CS spoolname, "%s/input/%s/%s-D", spool_directory, message_subdir, id);
6559 if (Uunlink(spoolname) < 0)
6560 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s", spoolname);
6561 sprintf(CS spoolname, "%s/input/%s/%s-H", spool_directory, message_subdir, id);
6562 if (Uunlink(spoolname) < 0)
6563 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s", spoolname);
6565 /* Log the end of this message, with queue time if requested. */
6567 if ((log_extra_selector & LX_queue_time_overall) != 0)
6568 log_write(0, LOG_MAIN, "Completed QT=%s",
6569 readconf_printtime(time(NULL) - received_time));
6571 log_write(0, LOG_MAIN, "Completed");
6574 /* If there are deferred addresses, we are keeping this message because it is
6575 not yet completed. Lose any temporary files that were catching output from
6576 pipes for any of the deferred addresses, handle one-time aliases, and see if
6577 the message has been on the queue for so long that it is time to send a warning
6578 message to the sender, unless it is a mailer-daemon. If all deferred addresses
6579 have the same domain, we can set deliver_domain for the expansion of
6580 delay_warning_ condition - if any of them are pipes, files, or autoreplies, use
6581 the parent's domain.
6583 If all the deferred addresses have an error number that indicates "retry time
6584 not reached", skip sending the warning message, because it won't contain the
6585 reason for the delay. It will get sent at the next real delivery attempt.
6586 However, if at least one address has tried, we'd better include all of them in
6589 If we can't make a process to send the message, don't worry.
6591 For mailing list expansions we want to send the warning message to the
6592 mailing list manager. We can't do a perfect job here, as some addresses may
6593 have different errors addresses, but if we take the errors address from
6594 each deferred address it will probably be right in most cases.
6596 If addr_defer == +1, it means there was a problem sending an error message
6597 for failed addresses, and there were no "real" deferred addresses. The value
6598 was set just to keep the message on the spool, so there is nothing to do here.
6601 else if (addr_defer != (address_item *)(+1))
6604 uschar *recipients = US"";
6605 BOOL delivery_attempted = FALSE;
6607 deliver_domain = testflag(addr_defer, af_pfr)?
6608 addr_defer->parent->domain : addr_defer->domain;
6610 for (addr = addr_defer; addr != NULL; addr = addr->next)
6612 address_item *otaddr;
6614 if (addr->basic_errno > ERRNO_RETRY_BASE) delivery_attempted = TRUE;
6616 if (deliver_domain != NULL)
6618 uschar *d = (testflag(addr, af_pfr))? addr->parent->domain : addr->domain;
6620 /* The domain may be unset for an address that has never been routed
6621 because the system filter froze the message. */
6623 if (d == NULL || Ustrcmp(d, deliver_domain) != 0) deliver_domain = NULL;
6626 if (addr->return_filename != NULL) Uunlink(addr->return_filename);
6628 /* Handle the case of one-time aliases. If any address in the ancestry
6629 of this one is flagged, ensure it is in the recipients list, suitably
6630 flagged, and that its parent is marked delivered. */
6632 for (otaddr = addr; otaddr != NULL; otaddr = otaddr->parent)
6633 if (otaddr->onetime_parent != NULL) break;
6638 int t = recipients_count;
6640 for (i = 0; i < recipients_count; i++)
6642 uschar *r = recipients_list[i].address;
6643 if (Ustrcmp(otaddr->onetime_parent, r) == 0) t = i;
6644 if (Ustrcmp(otaddr->address, r) == 0) break;
6647 /* Didn't find the address already in the list, and did find the
6648 ultimate parent's address in the list. After adding the recipient,
6649 update the errors address in the recipients list. */
6651 if (i >= recipients_count && t < recipients_count)
6653 DEBUG(D_deliver) debug_printf("one_time: adding %s in place of %s\n",
6654 otaddr->address, otaddr->parent->address);
6655 receive_add_recipient(otaddr->address, t);
6656 recipients_list[recipients_count-1].errors_to = otaddr->p.errors_address;
6657 tree_add_nonrecipient(otaddr->parent->address);
6658 update_spool = TRUE;
6662 /* Except for error messages, ensure that either the errors address for
6663 this deferred address or, if there is none, the sender address, is on the
6664 list of recipients for a warning message. */
6666 if (sender_address[0] != 0)
6668 if (addr->p.errors_address == NULL)
6670 if (Ustrstr(recipients, sender_address) == NULL)
6671 recipients = string_sprintf("%s%s%s", recipients,
6672 (recipients[0] == 0)? "" : ",", sender_address);
6676 if (Ustrstr(recipients, addr->p.errors_address) == NULL)
6677 recipients = string_sprintf("%s%s%s", recipients,
6678 (recipients[0] == 0)? "" : ",", addr->p.errors_address);
6683 /* Send a warning message if the conditions are right. If the condition check
6684 fails because of a lookup defer, there is nothing we can do. The warning
6685 is not sent. Another attempt will be made at the next delivery attempt (if
6688 if (!queue_2stage && delivery_attempted &&
6689 delay_warning[1] > 0 && sender_address[0] != 0 &&
6690 (delay_warning_condition == NULL ||
6691 expand_check_condition(delay_warning_condition,
6692 US"delay_warning", US"option")))
6696 int queue_time = time(NULL) - received_time;
6698 /* When running in the test harness, there's an option that allows us to
6699 fudge this time so as to get repeatability of the tests. Take the first
6700 time off the list. In queue runs, the list pointer gets updated in the
6703 if (running_in_test_harness && fudged_queue_times[0] != 0)
6705 int qt = readconf_readtime(fudged_queue_times, '/', FALSE);
6708 DEBUG(D_deliver) debug_printf("fudged queue_times = %s\n",
6709 fudged_queue_times);
6714 /* See how many warnings we should have sent by now */
6716 for (count = 0; count < delay_warning[1]; count++)
6717 if (queue_time < delay_warning[count+2]) break;
6719 show_time = delay_warning[count+1];
6721 if (count >= delay_warning[1])
6724 int last_gap = show_time;
6725 if (count > 1) last_gap -= delay_warning[count];
6726 extra = (queue_time - delay_warning[count+1])/last_gap;
6727 show_time += last_gap * extra;
6733 debug_printf("time on queue = %s\n", readconf_printtime(queue_time));
6734 debug_printf("warning counts: required %d done %d\n", count,
6738 /* We have computed the number of warnings there should have been by now.
6739 If there haven't been enough, send one, and up the count to what it should
6742 if (warning_count < count)
6746 pid_t pid = child_open_exim(&fd);
6752 FILE *f = fdopen(fd, "wb");
6754 if (warn_message_file != NULL)
6756 wmf = Ufopen(warn_message_file, "rb");
6758 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to open %s for warning "
6759 "message texts: %s", warn_message_file, strerror(errno));
6762 warnmsg_recipients = recipients;
6763 warnmsg_delay = (queue_time < 120*60)?
6764 string_sprintf("%d minutes", show_time/60):
6765 string_sprintf("%d hours", show_time/3600);
6767 if (errors_reply_to != NULL)
6768 fprintf(f, "Reply-To: %s\n", errors_reply_to);
6769 fprintf(f, "Auto-Submitted: auto-replied\n");
6770 fprintf(f, "From: Mail Delivery System <Mailer-Daemon@%s>\n",
6771 qualify_domain_sender);
6772 fprintf(f, "To: %s\n", recipients);
6774 wmf_text = next_emf(wmf, US"header");
6775 if (wmf_text != NULL)
6776 fprintf(f, "%s\n", wmf_text);
6778 fprintf(f, "Subject: Warning: message %s delayed %s\n\n",
6779 message_id, warnmsg_delay);
6781 wmf_text = next_emf(wmf, US"intro");
6782 if (wmf_text != NULL) fprintf(f, "%s", CS wmf_text); else
6785 "This message was created automatically by mail delivery software.\n");
6787 if (Ustrcmp(recipients, sender_address) == 0)
6789 "A message that you sent has not yet been delivered to one or more of its\n"
6790 "recipients after more than ");
6793 "A message sent by\n\n <%s>\n\n"
6794 "has not yet been delivered to one or more of its recipients after more than \n",
6797 fprintf(f, "%s on the queue on %s.\n\n", warnmsg_delay,
6799 fprintf(f, "The message identifier is: %s\n", message_id);
6801 for (h = header_list; h != NULL; h = h->next)
6803 if (strncmpic(h->text, US"Subject:", 8) == 0)
6804 fprintf(f, "The subject of the message is: %s", h->text + 9);
6805 else if (strncmpic(h->text, US"Date:", 5) == 0)
6806 fprintf(f, "The date of the message is: %s", h->text + 6);
6810 fprintf(f, "The address%s to which the message has not yet been "
6812 (addr_defer->next == NULL)? "" : "es",
6813 (addr_defer->next == NULL)? "is": "are");
6816 /* List the addresses, with error information if allowed */
6819 while (addr_defer != NULL)
6821 address_item *addr = addr_defer;
6822 addr_defer = addr->next;
6823 if (print_address_information(addr, f, US" ", US"\n ", US""))
6824 print_address_error(addr, f, US"Delay reason: ");
6833 wmf_text = next_emf(wmf, US"final");
6834 if (wmf_text != NULL) fprintf(f, "%s", CS wmf_text);
6840 "No action is required on your part. Delivery attempts will continue for\n"
6841 "some time, and this warning may be repeated at intervals if the message\n"
6842 "remains undelivered. Eventually the mail delivery software will give up,\n"
6843 "and when that happens, the message will be returned to you.\n");
6846 /* Close and wait for child process to complete, without a timeout.
6847 If there's an error, don't update the count. */
6850 if (child_close(pid, 0) == 0)
6852 warning_count = count;
6853 update_spool = TRUE; /* Ensure spool rewritten */
6859 /* Clear deliver_domain */
6861 deliver_domain = NULL;
6863 /* If this was a first delivery attempt, unset the first time flag, and
6864 ensure that the spool gets updated. */
6866 if (deliver_firsttime)
6868 deliver_firsttime = FALSE;
6869 update_spool = TRUE;
6872 /* If delivery was frozen and freeze_tell is set, generate an appropriate
6873 message, unless the message is a local error message (to avoid loops). Then
6874 log the freezing. If the text in "frozen_info" came from a system filter,
6875 it has been escaped into printing characters so as not to mess up log lines.
6876 For the "tell" message, we turn \n back into newline. Also, insert a newline
6877 near the start instead of the ": " string. */
6881 if (freeze_tell != NULL && freeze_tell[0] != 0 && !local_error_message)
6883 uschar *s = string_copy(frozen_info);
6884 uschar *ss = Ustrstr(s, " by the system filter: ");
6895 if (*ss == '\\' && ss[1] == 'n')
6902 moan_tell_someone(freeze_tell, addr_defer, US"Message frozen",
6903 "Message %s has been frozen%s.\nThe sender is <%s>.\n", message_id,
6907 /* Log freezing just before we update the -H file, to minimize the chance
6908 of a race problem. */
6910 deliver_msglog("*** Frozen%s\n", frozen_info);
6911 log_write(0, LOG_MAIN, "Frozen%s", frozen_info);
6914 /* If there have been any updates to the non-recipients list, or other things
6915 that get written to the spool, we must now update the spool header file so
6916 that it has the right information for the next delivery attempt. If there
6917 was more than one address being delivered, the header_change update is done
6918 earlier, in case one succeeds and then something crashes. */
6921 debug_printf("delivery deferred: update_spool=%d header_rewritten=%d\n",
6922 update_spool, header_rewritten);
6924 if (update_spool || header_rewritten)
6925 /* Panic-dies on error */
6926 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
6929 /* Finished with the message log. If the message is complete, it will have
6930 been unlinked or renamed above. */
6932 if (message_logs) (void)fclose(message_log);
6934 /* Now we can close and remove the journal file. Its only purpose is to record
6935 successfully completed deliveries asap so that this information doesn't get
6936 lost if Exim (or the machine) crashes. Forgetting about a failed delivery is
6937 not serious, as trying it again is not harmful. The journal might not be open
6938 if all addresses were deferred at routing or directing. Nevertheless, we must
6939 remove it if it exists (may have been lying around from a crash during the
6940 previous delivery attempt). We don't remove the journal if a delivery
6941 subprocess failed to pass back delivery information; this is controlled by
6942 the remove_journal flag. When the journal is left, we also don't move the
6943 message off the main spool if frozen and the option is set. It should get moved
6944 at the next attempt, after the journal has been inspected. */
6946 if (journal_fd >= 0) (void)close(journal_fd);
6950 sprintf(CS spoolname, "%s/input/%s/%s-J", spool_directory, message_subdir, id);
6951 if (Uunlink(spoolname) < 0 && errno != ENOENT)
6952 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s", spoolname,
6955 /* Move the message off the spool if reqested */
6957 #ifdef SUPPORT_MOVE_FROZEN_MESSAGES
6958 if (deliver_freeze && move_frozen_messages)
6959 (void)spool_move_message(id, message_subdir, US"", US"F");
6963 /* Closing the data file frees the lock; if the file has been unlinked it
6964 will go away. Otherwise the message becomes available for another process
6967 (void)close(deliver_datafile);
6968 deliver_datafile = -1;
6969 DEBUG(D_deliver) debug_printf("end delivery of %s\n", id);
6971 /* It is unlikely that there will be any cached resources, since they are
6972 released after routing, and in the delivery subprocesses. However, it's
6973 possible for an expansion for something afterwards (for example,
6974 expand_check_condition) to do a lookup. We must therefore be sure everything is
6981 /* End of deliver.c */