1 /*************************************************
2 * Exim - an Internet mail transport agent *
3 *************************************************/
5 /* Copyright (c) University of Cambridge 1995 - 2009 */
6 /* See the file NOTICE for conditions of use and distribution. */
8 /* The main code for delivering a message. */
14 /* Data block for keeping track of subprocesses for parallel remote
17 typedef struct pardata {
18 address_item *addrlist; /* chain of addresses */
19 address_item *addr; /* next address data expected for */
20 pid_t pid; /* subprocess pid */
21 int fd; /* pipe fd for getting result from subprocess */
22 int transport_count; /* returned transport count value */
23 BOOL done; /* no more data needed */
24 uschar *msg; /* error message */
25 uschar *return_path; /* return_path for these addresses */
28 /* Values for the process_recipients variable */
30 enum { RECIP_ACCEPT, RECIP_IGNORE, RECIP_DEFER,
31 RECIP_FAIL, RECIP_FAIL_FILTER, RECIP_FAIL_TIMEOUT,
34 /* Mutually recursive functions for marking addresses done. */
36 static void child_done(address_item *, uschar *);
37 static void address_done(address_item *, uschar *);
39 /* Table for turning base-62 numbers into binary */
41 static uschar tab62[] =
42 {0,1,2,3,4,5,6,7,8,9,0,0,0,0,0,0, /* 0-9 */
43 0,10,11,12,13,14,15,16,17,18,19,20, /* A-K */
44 21,22,23,24,25,26,27,28,29,30,31,32, /* L-W */
45 33,34,35, 0, 0, 0, 0, 0, /* X-Z */
46 0,36,37,38,39,40,41,42,43,44,45,46, /* a-k */
47 47,48,49,50,51,52,53,54,55,56,57,58, /* l-w */
51 /*************************************************
52 * Local static variables *
53 *************************************************/
55 /* addr_duplicate is global because it needs to be seen from the Envelope-To
58 static address_item *addr_defer = NULL;
59 static address_item *addr_failed = NULL;
60 static address_item *addr_fallback = NULL;
61 static address_item *addr_local = NULL;
62 static address_item *addr_new = NULL;
63 static address_item *addr_remote = NULL;
64 static address_item *addr_route = NULL;
65 static address_item *addr_succeed = NULL;
67 static FILE *message_log = NULL;
68 static BOOL update_spool;
69 static BOOL remove_journal;
70 static int parcount = 0;
71 static pardata *parlist = NULL;
72 static int return_count;
73 static uschar *frozen_info = US"";
74 static uschar *used_return_path = NULL;
76 static uschar spoolname[PATH_MAX];
80 /*************************************************
81 * Make a new address item *
82 *************************************************/
84 /* This function gets the store and initializes with default values. The
85 transport_return value defaults to DEFER, so that any unexpected failure to
86 deliver does not wipe out the message. The default unique string is set to a
87 copy of the address, so that its domain can be lowercased.
90 address the RFC822 address string
91 copy force a copy of the address
93 Returns: a pointer to an initialized address_item
97 deliver_make_addr(uschar *address, BOOL copy)
99 address_item *addr = store_get(sizeof(address_item));
100 *addr = address_defaults;
101 if (copy) address = string_copy(address);
102 addr->address = address;
103 addr->unique = string_copy(address);
110 /*************************************************
111 * Set expansion values for an address *
112 *************************************************/
114 /* Certain expansion variables are valid only when handling an address or
115 address list. This function sets them up or clears the values, according to its
119 addr the address in question, or NULL to clear values
124 deliver_set_expansions(address_item *addr)
128 uschar ***p = address_expansions;
129 while (*p != NULL) **p++ = NULL;
133 /* Exactly what gets set depends on whether there is one or more addresses, and
134 what they contain. These first ones are always set, taking their values from
135 the first address. */
137 if (addr->host_list == NULL)
139 deliver_host = deliver_host_address = US"";
143 deliver_host = addr->host_list->name;
144 deliver_host_address = addr->host_list->address;
147 deliver_recipients = addr;
148 deliver_address_data = addr->p.address_data;
149 deliver_domain_data = addr->p.domain_data;
150 deliver_localpart_data = addr->p.localpart_data;
152 /* These may be unset for multiple addresses */
154 deliver_domain = addr->domain;
155 self_hostname = addr->self_hostname;
157 #ifdef EXPERIMENTAL_BRIGHTMAIL
158 bmi_deliver = 1; /* deliver by default */
159 bmi_alt_location = NULL;
160 bmi_base64_verdict = NULL;
161 bmi_base64_tracker_verdict = NULL;
164 /* If there's only one address we can set everything. */
166 if (addr->next == NULL)
168 address_item *addr_orig;
170 deliver_localpart = addr->local_part;
171 deliver_localpart_prefix = addr->prefix;
172 deliver_localpart_suffix = addr->suffix;
174 for (addr_orig = addr; addr_orig->parent != NULL;
175 addr_orig = addr_orig->parent);
176 deliver_domain_orig = addr_orig->domain;
178 /* Re-instate any prefix and suffix in the original local part. In all
179 normal cases, the address will have a router associated with it, and we can
180 choose the caseful or caseless version accordingly. However, when a system
181 filter sets up a pipe, file, or autoreply delivery, no router is involved.
182 In this case, though, there won't be any prefix or suffix to worry about. */
184 deliver_localpart_orig = (addr_orig->router == NULL)? addr_orig->local_part :
185 addr_orig->router->caseful_local_part?
186 addr_orig->cc_local_part : addr_orig->lc_local_part;
188 /* If there's a parent, make its domain and local part available, and if
189 delivering to a pipe or file, or sending an autoreply, get the local
190 part from the parent. For pipes and files, put the pipe or file string
191 into address_pipe and address_file. */
193 if (addr->parent != NULL)
195 deliver_domain_parent = addr->parent->domain;
196 deliver_localpart_parent = (addr->parent->router == NULL)?
197 addr->parent->local_part :
198 addr->parent->router->caseful_local_part?
199 addr->parent->cc_local_part : addr->parent->lc_local_part;
201 /* File deliveries have their own flag because they need to be picked out
202 as special more often. */
204 if (testflag(addr, af_pfr))
206 if (testflag(addr, af_file)) address_file = addr->local_part;
207 else if (deliver_localpart[0] == '|') address_pipe = addr->local_part;
208 deliver_localpart = addr->parent->local_part;
209 deliver_localpart_prefix = addr->parent->prefix;
210 deliver_localpart_suffix = addr->parent->suffix;
214 #ifdef EXPERIMENTAL_BRIGHTMAIL
215 /* Set expansion variables related to Brightmail AntiSpam */
216 bmi_base64_verdict = bmi_get_base64_verdict(deliver_localpart_orig, deliver_domain_orig);
217 bmi_base64_tracker_verdict = bmi_get_base64_tracker_verdict(bmi_base64_verdict);
218 /* get message delivery status (0 - don't deliver | 1 - deliver) */
219 bmi_deliver = bmi_get_delivery_status(bmi_base64_verdict);
220 /* if message is to be delivered, get eventual alternate location */
221 if (bmi_deliver == 1) {
222 bmi_alt_location = bmi_get_alt_location(bmi_base64_verdict);
228 /* For multiple addresses, don't set local part, and leave the domain and
229 self_hostname set only if it is the same for all of them. It is possible to
230 have multiple pipe and file addresses, but only when all addresses have routed
231 to the same pipe or file. */
236 if (testflag(addr, af_pfr))
238 if (testflag(addr, af_file)) address_file = addr->local_part;
239 else if (addr->local_part[0] == '|') address_pipe = addr->local_part;
241 for (addr2 = addr->next; addr2 != NULL; addr2 = addr2->next)
243 if (deliver_domain != NULL &&
244 Ustrcmp(deliver_domain, addr2->domain) != 0)
245 deliver_domain = NULL;
246 if (self_hostname != NULL && (addr2->self_hostname == NULL ||
247 Ustrcmp(self_hostname, addr2->self_hostname) != 0))
248 self_hostname = NULL;
249 if (deliver_domain == NULL && self_hostname == NULL) break;
257 /*************************************************
258 * Open a msglog file *
259 *************************************************/
261 /* This function is used both for normal message logs, and for files in the
262 msglog directory that are used to catch output from pipes. Try to create the
263 directory if it does not exist. From release 4.21, normal message logs should
264 be created when the message is received.
267 filename the file name
268 mode the mode required
269 error used for saying what failed
271 Returns: a file descriptor, or -1 (with errno set)
275 open_msglog_file(uschar *filename, int mode, uschar **error)
277 int fd = Uopen(filename, O_WRONLY|O_APPEND|O_CREAT, mode);
279 if (fd < 0 && errno == ENOENT)
282 sprintf(CS temp, "msglog/%s", message_subdir);
283 if (message_subdir[0] == 0) temp[6] = 0;
284 (void)directory_make(spool_directory, temp, MSGLOG_DIRECTORY_MODE, TRUE);
285 fd = Uopen(filename, O_WRONLY|O_APPEND|O_CREAT, mode);
288 /* Set the close-on-exec flag and change the owner to the exim uid/gid (this
289 function is called as root). Double check the mode, because the group setting
290 doesn't always get set automatically. */
294 (void)fcntl(fd, F_SETFD, fcntl(fd, F_GETFD) | FD_CLOEXEC);
295 if (fchown(fd, exim_uid, exim_gid) < 0)
300 if (fchmod(fd, mode) < 0)
306 else *error = US"create";
314 /*************************************************
315 * Write to msglog if required *
316 *************************************************/
318 /* Write to the message log, if configured. This function may also be called
322 format a string format
328 deliver_msglog(const char *format, ...)
331 if (!message_logs) return;
332 va_start(ap, format);
333 vfprintf(message_log, format, ap);
341 /*************************************************
342 * Replicate status for batch *
343 *************************************************/
345 /* When a transport handles a batch of addresses, it may treat them
346 individually, or it may just put the status in the first one, and return FALSE,
347 requesting that the status be copied to all the others externally. This is the
348 replication function. As well as the status, it copies the transport pointer,
349 which may have changed if appendfile passed the addresses on to a different
352 Argument: pointer to the first address in a chain
357 replicate_status(address_item *addr)
360 for (addr2 = addr->next; addr2 != NULL; addr2 = addr2->next)
362 addr2->transport = addr->transport;
363 addr2->transport_return = addr->transport_return;
364 addr2->basic_errno = addr->basic_errno;
365 addr2->more_errno = addr->more_errno;
366 addr2->special_action = addr->special_action;
367 addr2->message = addr->message;
368 addr2->user_message = addr->user_message;
374 /*************************************************
375 * Compare lists of hosts *
376 *************************************************/
378 /* This function is given two pointers to chains of host items, and it yields
379 TRUE if the lists refer to the same hosts in the same order, except that
381 (1) Multiple hosts with the same non-negative MX values are permitted to appear
382 in different orders. Round-robinning nameservers can cause this to happen.
384 (2) Multiple hosts with the same negative MX values less than MX_NONE are also
385 permitted to appear in different orders. This is caused by randomizing
388 This enables Exim to use a single SMTP transaction for sending to two entirely
389 different domains that happen to end up pointing at the same hosts.
392 one points to the first host list
393 two points to the second host list
395 Returns: TRUE if the lists refer to the same host set
399 same_hosts(host_item *one, host_item *two)
401 while (one != NULL && two != NULL)
403 if (Ustrcmp(one->name, two->name) != 0)
406 host_item *end_one = one;
407 host_item *end_two = two;
409 /* Batch up only if there was no MX and the list was not randomized */
411 if (mx == MX_NONE) return FALSE;
413 /* Find the ends of the shortest sequence of identical MX values */
415 while (end_one->next != NULL && end_one->next->mx == mx &&
416 end_two->next != NULL && end_two->next->mx == mx)
418 end_one = end_one->next;
419 end_two = end_two->next;
422 /* If there aren't any duplicates, there's no match. */
424 if (end_one == one) return FALSE;
426 /* For each host in the 'one' sequence, check that it appears in the 'two'
427 sequence, returning FALSE if not. */
432 for (hi = two; hi != end_two->next; hi = hi->next)
433 if (Ustrcmp(one->name, hi->name) == 0) break;
434 if (hi == end_two->next) return FALSE;
435 if (one == end_one) break;
439 /* All the hosts in the 'one' sequence were found in the 'two' sequence.
440 Ensure both are pointing at the last host, and carry on as for equality. */
451 /* True if both are NULL */
458 /*************************************************
459 * Compare header lines *
460 *************************************************/
462 /* This function is given two pointers to chains of header items, and it yields
463 TRUE if they are the same header texts in the same order.
466 one points to the first header list
467 two points to the second header list
469 Returns: TRUE if the lists refer to the same header set
473 same_headers(header_line *one, header_line *two)
477 if (one == two) return TRUE; /* Includes the case where both NULL */
478 if (one == NULL || two == NULL) return FALSE;
479 if (Ustrcmp(one->text, two->text) != 0) return FALSE;
487 /*************************************************
488 * Compare string settings *
489 *************************************************/
491 /* This function is given two pointers to strings, and it returns
492 TRUE if they are the same pointer, or if the two strings are the same.
495 one points to the first string
496 two points to the second string
498 Returns: TRUE or FALSE
502 same_strings(uschar *one, uschar *two)
504 if (one == two) return TRUE; /* Includes the case where both NULL */
505 if (one == NULL || two == NULL) return FALSE;
506 return (Ustrcmp(one, two) == 0);
511 /*************************************************
512 * Compare uid/gid for addresses *
513 *************************************************/
515 /* This function is given a transport and two addresses. It yields TRUE if the
516 uid/gid/initgroups settings for the two addresses are going to be the same when
521 addr1 the first address
522 addr2 the second address
524 Returns: TRUE or FALSE
528 same_ugid(transport_instance *tp, address_item *addr1, address_item *addr2)
530 if (!tp->uid_set && tp->expand_uid == NULL && !tp->deliver_as_creator)
532 if (testflag(addr1, af_uid_set) != testflag(addr2, af_gid_set) ||
533 (testflag(addr1, af_uid_set) &&
534 (addr1->uid != addr2->uid ||
535 testflag(addr1, af_initgroups) != testflag(addr2, af_initgroups))))
539 if (!tp->gid_set && tp->expand_gid == NULL)
541 if (testflag(addr1, af_gid_set) != testflag(addr2, af_gid_set) ||
542 (testflag(addr1, af_gid_set) && addr1->gid != addr2->gid))
552 /*************************************************
553 * Record that an address is complete *
554 *************************************************/
556 /* This function records that an address is complete. This is straightforward
557 for most addresses, where the unique address is just the full address with the
558 domain lower cased. For homonyms (addresses that are the same as one of their
559 ancestors) their are complications. Their unique addresses have \x\ prepended
560 (where x = 0, 1, 2...), so that de-duplication works correctly for siblings and
563 Exim used to record the unique addresses of homonyms as "complete". This,
564 however, fails when the pattern of redirection varies over time (e.g. if taking
565 unseen copies at only some times of day) because the prepended numbers may vary
566 from one delivery run to the next. This problem is solved by never recording
567 prepended unique addresses as complete. Instead, when a homonymic address has
568 actually been delivered via a transport, we record its basic unique address
569 followed by the name of the transport. This is checked in subsequent delivery
570 runs whenever an address is routed to a transport.
572 If the completed address is a top-level one (has no parent, which means it
573 cannot be homonymic) we also add the original address to the non-recipients
574 tree, so that it gets recorded in the spool file and therefore appears as
575 "done" in any spool listings. The original address may differ from the unique
576 address in the case of the domain.
578 Finally, this function scans the list of duplicates, marks as done any that
579 match this address, and calls child_done() for their ancestors.
582 addr address item that has been completed
583 now current time as a string
589 address_done(address_item *addr, uschar *now)
593 update_spool = TRUE; /* Ensure spool gets updated */
595 /* Top-level address */
597 if (addr->parent == NULL)
599 tree_add_nonrecipient(addr->unique);
600 tree_add_nonrecipient(addr->address);
603 /* Homonymous child address */
605 else if (testflag(addr, af_homonym))
607 if (addr->transport != NULL)
609 tree_add_nonrecipient(
610 string_sprintf("%s/%s", addr->unique + 3, addr->transport->name));
614 /* Non-homonymous child address */
616 else tree_add_nonrecipient(addr->unique);
618 /* Check the list of duplicate addresses and ensure they are now marked
621 for (dup = addr_duplicate; dup != NULL; dup = dup->next)
623 if (Ustrcmp(addr->unique, dup->unique) == 0)
625 tree_add_nonrecipient(dup->unique);
626 child_done(dup, now);
634 /*************************************************
635 * Decrease counts in parents and mark done *
636 *************************************************/
638 /* This function is called when an address is complete. If there is a parent
639 address, its count of children is decremented. If there are still other
640 children outstanding, the function exits. Otherwise, if the count has become
641 zero, address_done() is called to mark the parent and its duplicates complete.
642 Then loop for any earlier ancestors.
645 addr points to the completed address item
646 now the current time as a string, for writing to the message log
652 child_done(address_item *addr, uschar *now)
655 while (addr->parent != NULL)
658 if ((addr->child_count -= 1) > 0) return; /* Incomplete parent */
659 address_done(addr, now);
661 /* Log the completion of all descendents only when there is no ancestor with
662 the same original address. */
664 for (aa = addr->parent; aa != NULL; aa = aa->parent)
665 if (Ustrcmp(aa->address, addr->address) == 0) break;
666 if (aa != NULL) continue;
668 deliver_msglog("%s %s: children all complete\n", now, addr->address);
669 DEBUG(D_deliver) debug_printf("%s: children all complete\n", addr->address);
676 /* If msg is NULL this is a delivery log and logchar is used. Otherwise
677 this is a nonstandard call; no two-characher delivery flag is written
678 but sender-host and sender are prefixed and "msg" is inserted in the log line.
681 flags passed to log_write()
684 delivery_log(int flags, address_item * addr, int logchar, uschar * msg)
687 int size = 256; /* Used for a temporary, */
688 int ptr = 0; /* expanding buffer, for */
689 uschar *s; /* building log lines; */
690 void *reset_point; /* released afterwards. */
693 /* Log the delivery on the main log. We use an extensible string to build up
694 the log line, and reset the store afterwards. Remote deliveries should always
695 have a pointer to the host item that succeeded; local deliveries can have a
696 pointer to a single host item in their host list, for use by the transport. */
698 s = reset_point = store_get(size);
700 log_address = string_log_address(addr, (log_write_selector & L_all_parents) != 0, TRUE);
702 s = string_append(s, &size, &ptr, 3, host_and_ident(TRUE), US" ", log_address);
706 s = string_append(s, &size, &ptr, 2, US"> ", log_address);
709 if ((log_extra_selector & LX_sender_on_delivery) != 0 || msg)
710 s = string_append(s, &size, &ptr, 3, US" F=<", sender_address, US">");
712 #ifdef EXPERIMENTAL_SRS
713 if(addr->p.srs_sender)
714 s = string_append(s, &size, &ptr, 3, US" SRS=<", addr->p.srs_sender, US">");
717 /* You might think that the return path must always be set for a successful
718 delivery; indeed, I did for some time, until this statement crashed. The case
719 when it is not set is for a delivery to /dev/null which is optimised by not
722 if (used_return_path != NULL &&
723 (log_extra_selector & LX_return_path_on_delivery) != 0)
724 s = string_append(s, &size, &ptr, 3, US" P=<", used_return_path, US">");
727 s = string_append(s, &size, &ptr, 2, US" ", msg);
729 /* For a delivery from a system filter, there may not be a router */
730 if (addr->router != NULL)
731 s = string_append(s, &size, &ptr, 2, US" R=", addr->router->name);
733 s = string_append(s, &size, &ptr, 2, US" T=", addr->transport->name);
735 if ((log_extra_selector & LX_delivery_size) != 0)
736 s = string_append(s, &size, &ptr, 2, US" S=",
737 string_sprintf("%d", transport_count));
741 if (addr->transport->info->local)
743 if (addr->host_list != NULL)
744 s = string_append(s, &size, &ptr, 2, US" H=", addr->host_list->name);
745 if (addr->shadow_message != NULL)
746 s = string_cat(s, &size, &ptr, addr->shadow_message,
747 Ustrlen(addr->shadow_message));
750 /* Remote delivery */
754 if (addr->host_used != NULL)
756 s = string_append(s, &size, &ptr, 5, US" H=", addr->host_used->name,
757 US" [", addr->host_used->address, US"]");
758 if ((log_extra_selector & LX_outgoing_port) != 0)
759 s = string_append(s, &size, &ptr, 2, US":", string_sprintf("%d",
760 addr->host_used->port));
761 if (continue_sequence > 1)
762 s = string_cat(s, &size, &ptr, US"*", 1);
766 if ((log_extra_selector & LX_tls_cipher) != 0 && addr->cipher != NULL)
767 s = string_append(s, &size, &ptr, 2, US" X=", addr->cipher);
768 if ((log_extra_selector & LX_tls_certificate_verified) != 0 &&
769 addr->cipher != NULL)
770 s = string_append(s, &size, &ptr, 2, US" CV=",
771 testflag(addr, af_cert_verified)? "yes":"no");
772 if ((log_extra_selector & LX_tls_peerdn) != 0 && addr->peerdn != NULL)
773 s = string_append(s, &size, &ptr, 3, US" DN=\"",
774 string_printing(addr->peerdn), US"\"");
777 if ((log_extra_selector & LX_smtp_confirmation) != 0 &&
778 addr->message != NULL)
781 uschar *p = big_buffer;
782 uschar *ss = addr->message;
784 for (i = 0; i < 100 && ss[i] != 0; i++)
786 if (ss[i] == '\"' || ss[i] == '\\') *p++ = '\\';
791 s = string_append(s, &size, &ptr, 2, US" C=", big_buffer);
795 /* Time on queue and actual time taken to deliver */
797 if ((log_extra_selector & LX_queue_time) != 0)
799 s = string_append(s, &size, &ptr, 2, US" QT=",
800 readconf_printtime(time(NULL) - received_time));
803 if ((log_extra_selector & LX_deliver_time) != 0)
805 s = string_append(s, &size, &ptr, 2, US" DT=",
806 readconf_printtime(addr->more_errno));
809 /* string_cat() always leaves room for the terminator. Release the
810 store we used to build the line after writing it. */
813 log_write(0, flags, "%s", s);
814 store_reset(reset_point);
820 /*************************************************
821 * Actions at the end of handling an address *
822 *************************************************/
824 /* This is a function for processing a single address when all that can be done
825 with it has been done.
828 addr points to the address block
829 result the result of the delivery attempt
830 logflags flags for log_write() (LOG_MAIN and/or LOG_PANIC)
831 driver_type indicates which type of driver (transport, or router) was last
832 to process the address
833 logchar '=' or '-' for use when logging deliveries with => or ->
839 post_process_one(address_item *addr, int result, int logflags, int driver_type,
842 uschar *now = tod_stamp(tod_log);
843 uschar *driver_kind = NULL;
844 uschar *driver_name = NULL;
847 int size = 256; /* Used for a temporary, */
848 int ptr = 0; /* expanding buffer, for */
849 uschar *s; /* building log lines; */
850 void *reset_point; /* released afterwards. */
853 DEBUG(D_deliver) debug_printf("post-process %s (%d)\n", addr->address, result);
855 /* Set up driver kind and name for logging. Disable logging if the router or
856 transport has disabled it. */
858 if (driver_type == DTYPE_TRANSPORT)
860 if (addr->transport != NULL)
862 driver_name = addr->transport->name;
863 driver_kind = US" transport";
864 disable_logging = addr->transport->disable_logging;
866 else driver_kind = US"transporting";
868 else if (driver_type == DTYPE_ROUTER)
870 if (addr->router != NULL)
872 driver_name = addr->router->name;
873 driver_kind = US" router";
874 disable_logging = addr->router->disable_logging;
876 else driver_kind = US"routing";
879 /* If there's an error message set, ensure that it contains only printing
880 characters - it should, but occasionally things slip in and this at least
881 stops the log format from getting wrecked. We also scan the message for an LDAP
882 expansion item that has a password setting, and flatten the password. This is a
883 fudge, but I don't know a cleaner way of doing this. (If the item is badly
884 malformed, it won't ever have gone near LDAP.) */
886 if (addr->message != NULL)
888 addr->message = string_printing(addr->message);
889 if (((Ustrstr(addr->message, "failed to expand") != NULL) || (Ustrstr(addr->message, "expansion of ") != NULL)) &&
890 (Ustrstr(addr->message, "mysql") != NULL ||
891 Ustrstr(addr->message, "pgsql") != NULL ||
892 Ustrstr(addr->message, "sqlite") != NULL ||
893 Ustrstr(addr->message, "ldap:") != NULL ||
894 Ustrstr(addr->message, "ldapdn:") != NULL ||
895 Ustrstr(addr->message, "ldapm:") != NULL))
897 addr->message = string_sprintf("Temporary internal error");
901 /* If we used a transport that has one of the "return_output" options set, and
902 if it did in fact generate some output, then for return_output we treat the
903 message as failed if it was not already set that way, so that the output gets
904 returned to the sender, provided there is a sender to send it to. For
905 return_fail_output, do this only if the delivery failed. Otherwise we just
906 unlink the file, and remove the name so that if the delivery failed, we don't
907 try to send back an empty or unwanted file. The log_output options operate only
910 In any case, we close the message file, because we cannot afford to leave a
911 file-descriptor for one address while processing (maybe very many) others. */
913 if (addr->return_file >= 0 && addr->return_filename != NULL)
915 BOOL return_output = FALSE;
917 (void)EXIMfsync(addr->return_file);
919 /* If there is no output, do nothing. */
921 if (fstat(addr->return_file, &statbuf) == 0 && statbuf.st_size > 0)
923 transport_instance *tb = addr->transport;
925 /* Handle logging options */
927 if (tb->log_output || (result == FAIL && tb->log_fail_output) ||
928 (result == DEFER && tb->log_defer_output))
931 FILE *f = Ufopen(addr->return_filename, "rb");
933 log_write(0, LOG_MAIN|LOG_PANIC, "failed to open %s to log output "
934 "from %s transport: %s", addr->return_filename, tb->name,
938 s = US Ufgets(big_buffer, big_buffer_size, f);
941 uschar *p = big_buffer + Ustrlen(big_buffer);
942 while (p > big_buffer && isspace(p[-1])) p--;
944 s = string_printing(big_buffer);
945 log_write(0, LOG_MAIN, "<%s>: %s transport output: %s",
946 addr->address, tb->name, s);
952 /* Handle returning options, but only if there is an address to return
955 if (sender_address[0] != 0 || addr->p.errors_address != NULL)
957 if (tb->return_output)
959 addr->transport_return = result = FAIL;
960 if (addr->basic_errno == 0 && addr->message == NULL)
961 addr->message = US"return message generated";
962 return_output = TRUE;
965 if (tb->return_fail_output && result == FAIL) return_output = TRUE;
969 /* Get rid of the file unless it might be returned, but close it in
974 Uunlink(addr->return_filename);
975 addr->return_filename = NULL;
976 addr->return_file = -1;
979 (void)close(addr->return_file);
982 /* The sucess case happens only after delivery by a transport. */
986 addr->next = addr_succeed;
989 /* Call address_done() to ensure that we don't deliver to this address again,
990 and write appropriate things to the message log. If it is a child address, we
991 call child_done() to scan the ancestors and mark them complete if this is the
992 last child to complete. */
994 address_done(addr, now);
995 DEBUG(D_deliver) debug_printf("%s delivered\n", addr->address);
997 if (addr->parent == NULL)
999 deliver_msglog("%s %s: %s%s succeeded\n", now, addr->address,
1000 driver_name, driver_kind);
1004 deliver_msglog("%s %s <%s>: %s%s succeeded\n", now, addr->address,
1005 addr->parent->address, driver_name, driver_kind);
1006 child_done(addr, now);
1009 delivery_log(LOG_MAIN, addr, logchar, NULL);
1013 /* Soft failure, or local delivery process failed; freezing may be
1016 else if (result == DEFER || result == PANIC)
1018 if (result == PANIC) logflags |= LOG_PANIC;
1020 /* This puts them on the chain in reverse order. Do not change this, because
1021 the code for handling retries assumes that the one with the retry
1022 information is last. */
1024 addr->next = addr_defer;
1027 /* The only currently implemented special action is to freeze the
1028 message. Logging of this is done later, just before the -H file is
1031 if (addr->special_action == SPECIAL_FREEZE)
1033 deliver_freeze = TRUE;
1034 deliver_frozen_at = time(NULL);
1035 update_spool = TRUE;
1038 /* If doing a 2-stage queue run, we skip writing to either the message
1039 log or the main log for SMTP defers. */
1041 if (!queue_2stage || addr->basic_errno != 0)
1045 /* For errors of the type "retry time not reached" (also remotes skipped
1046 on queue run), logging is controlled by L_retry_defer. Note that this kind
1047 of error number is negative, and all the retry ones are less than any
1050 unsigned int use_log_selector = (addr->basic_errno <= ERRNO_RETRY_BASE)?
1053 /* Build up the line that is used for both the message log and the main
1056 s = reset_point = store_get(size);
1058 /* Create the address string for logging. Must not do this earlier, because
1059 an OK result may be changed to FAIL when a pipe returns text. */
1061 log_address = string_log_address(addr,
1062 (log_write_selector & L_all_parents) != 0, result == OK);
1064 s = string_cat(s, &size, &ptr, log_address, Ustrlen(log_address));
1066 /* Either driver_name contains something and driver_kind contains
1067 " router" or " transport" (note the leading space), or driver_name is
1068 a null string and driver_kind contains "routing" without the leading
1069 space, if all routing has been deferred. When a domain has been held,
1070 so nothing has been done at all, both variables contain null strings. */
1072 if (driver_name == NULL)
1074 if (driver_kind != NULL)
1075 s = string_append(s, &size, &ptr, 2, US" ", driver_kind);
1079 if (driver_kind[1] == 't' && addr->router != NULL)
1080 s = string_append(s, &size, &ptr, 2, US" R=", addr->router->name);
1082 ss[1] = toupper(driver_kind[1]);
1083 s = string_append(s, &size, &ptr, 2, ss, driver_name);
1086 sprintf(CS ss, " defer (%d)", addr->basic_errno);
1087 s = string_cat(s, &size, &ptr, ss, Ustrlen(ss));
1089 if (addr->basic_errno > 0)
1090 s = string_append(s, &size, &ptr, 2, US": ",
1091 US strerror(addr->basic_errno));
1093 if (addr->message != NULL)
1094 s = string_append(s, &size, &ptr, 2, US": ", addr->message);
1098 /* Log the deferment in the message log, but don't clutter it
1099 up with retry-time defers after the first delivery attempt. */
1101 if (deliver_firsttime || addr->basic_errno > ERRNO_RETRY_BASE)
1102 deliver_msglog("%s %s\n", now, s);
1104 /* Write the main log and reset the store */
1106 log_write(use_log_selector, logflags, "== %s", s);
1107 store_reset(reset_point);
1112 /* Hard failure. If there is an address to which an error message can be sent,
1113 put this address on the failed list. If not, put it on the deferred list and
1114 freeze the mail message for human attention. The latter action can also be
1115 explicitly requested by a router or transport. */
1119 /* If this is a delivery error, or a message for which no replies are
1120 wanted, and the message's age is greater than ignore_bounce_errors_after,
1121 force the af_ignore_error flag. This will cause the address to be discarded
1122 later (with a log entry). */
1124 if (sender_address[0] == 0 && message_age >= ignore_bounce_errors_after)
1125 setflag(addr, af_ignore_error);
1127 /* Freeze the message if requested, or if this is a bounce message (or other
1128 message with null sender) and this address does not have its own errors
1129 address. However, don't freeze if errors are being ignored. The actual code
1130 to ignore occurs later, instead of sending a message. Logging of freezing
1131 occurs later, just before writing the -H file. */
1133 if (!testflag(addr, af_ignore_error) &&
1134 (addr->special_action == SPECIAL_FREEZE ||
1135 (sender_address[0] == 0 && addr->p.errors_address == NULL)
1138 frozen_info = (addr->special_action == SPECIAL_FREEZE)? US"" :
1139 (sender_local && !local_error_message)?
1140 US" (message created with -f <>)" : US" (delivery error message)";
1141 deliver_freeze = TRUE;
1142 deliver_frozen_at = time(NULL);
1143 update_spool = TRUE;
1145 /* The address is put on the defer rather than the failed queue, because
1146 the message is being retained. */
1148 addr->next = addr_defer;
1152 /* Don't put the address on the nonrecipients tree yet; wait until an
1153 error message has been successfully sent. */
1157 addr->next = addr_failed;
1161 /* Build up the log line for the message and main logs */
1163 s = reset_point = store_get(size);
1165 /* Create the address string for logging. Must not do this earlier, because
1166 an OK result may be changed to FAIL when a pipe returns text. */
1168 log_address = string_log_address(addr,
1169 (log_write_selector & L_all_parents) != 0, result == OK);
1171 s = string_cat(s, &size, &ptr, log_address, Ustrlen(log_address));
1173 if ((log_extra_selector & LX_sender_on_delivery) != 0)
1174 s = string_append(s, &size, &ptr, 3, US" F=<", sender_address, US">");
1176 /* Return path may not be set if no delivery actually happened */
1178 if (used_return_path != NULL &&
1179 (log_extra_selector & LX_return_path_on_delivery) != 0)
1181 s = string_append(s, &size, &ptr, 3, US" P=<", used_return_path, US">");
1184 if (addr->router != NULL)
1185 s = string_append(s, &size, &ptr, 2, US" R=", addr->router->name);
1186 if (addr->transport != NULL)
1187 s = string_append(s, &size, &ptr, 2, US" T=", addr->transport->name);
1189 if (addr->host_used != NULL)
1190 s = string_append(s, &size, &ptr, 5, US" H=", addr->host_used->name,
1191 US" [", addr->host_used->address, US"]");
1193 if (addr->basic_errno > 0)
1194 s = string_append(s, &size, &ptr, 2, US": ",
1195 US strerror(addr->basic_errno));
1197 if (addr->message != NULL)
1198 s = string_append(s, &size, &ptr, 2, US": ", addr->message);
1202 /* Do the logging. For the message log, "routing failed" for those cases,
1203 just to make it clearer. */
1205 if (driver_name == NULL)
1206 deliver_msglog("%s %s failed for %s\n", now, driver_kind, s);
1208 deliver_msglog("%s %s\n", now, s);
1210 log_write(0, LOG_MAIN, "** %s", s);
1211 store_reset(reset_point);
1214 /* Ensure logging is turned on again in all cases */
1216 disable_logging = FALSE;
1222 /*************************************************
1223 * Address-independent error *
1224 *************************************************/
1226 /* This function is called when there's an error that is not dependent on a
1227 particular address, such as an expansion string failure. It puts the error into
1228 all the addresses in a batch, logs the incident on the main and panic logs, and
1229 clears the expansions. It is mostly called from local_deliver(), but can be
1230 called for a remote delivery via findugid().
1233 logit TRUE if (MAIN+PANIC) logging required
1234 addr the first of the chain of addresses
1236 format format string for error message, or NULL if already set in addr
1237 ... arguments for the format
1243 common_error(BOOL logit, address_item *addr, int code, uschar *format, ...)
1245 address_item *addr2;
1246 addr->basic_errno = code;
1252 va_start(ap, format);
1253 if (!string_vformat(buffer, sizeof(buffer), CS format, ap))
1254 log_write(0, LOG_MAIN|LOG_PANIC_DIE,
1255 "common_error expansion was longer than " SIZE_T_FMT, sizeof(buffer));
1257 addr->message = string_copy(buffer);
1260 for (addr2 = addr->next; addr2 != NULL; addr2 = addr2->next)
1262 addr2->basic_errno = code;
1263 addr2->message = addr->message;
1266 if (logit) log_write(0, LOG_MAIN|LOG_PANIC, "%s", addr->message);
1267 deliver_set_expansions(NULL);
1273 /*************************************************
1274 * Check a "never users" list *
1275 *************************************************/
1277 /* This function is called to check whether a uid is on one of the two "never
1281 uid the uid to be checked
1282 nusers the list to be scanned; the first item in the list is the count
1284 Returns: TRUE if the uid is on the list
1288 check_never_users(uid_t uid, uid_t *nusers)
1291 if (nusers == NULL) return FALSE;
1292 for (i = 1; i <= (int)(nusers[0]); i++) if (nusers[i] == uid) return TRUE;
1298 /*************************************************
1299 * Find uid and gid for a transport *
1300 *************************************************/
1302 /* This function is called for both local and remote deliveries, to find the
1303 uid/gid under which to run the delivery. The values are taken preferentially
1304 from the transport (either explicit or deliver_as_creator), then from the
1305 address (i.e. the router), and if nothing is set, the exim uid/gid are used. If
1306 the resulting uid is on the "never_users" or the "fixed_never_users" list, a
1307 panic error is logged, and the function fails (which normally leads to delivery
1311 addr the address (possibly a chain)
1313 uidp pointer to uid field
1314 gidp pointer to gid field
1315 igfp pointer to the use_initgroups field
1317 Returns: FALSE if failed - error has been set in address(es)
1321 findugid(address_item *addr, transport_instance *tp, uid_t *uidp, gid_t *gidp,
1324 uschar *nuname = NULL;
1325 BOOL gid_set = FALSE;
1327 /* Default initgroups flag comes from the transport */
1329 *igfp = tp->initgroups;
1331 /* First see if there's a gid on the transport, either fixed or expandable.
1332 The expanding function always logs failure itself. */
1339 else if (tp->expand_gid != NULL)
1341 if (route_find_expanded_group(tp->expand_gid, tp->name, US"transport", gidp,
1342 &(addr->message))) gid_set = TRUE;
1345 common_error(FALSE, addr, ERRNO_GIDFAIL, NULL);
1350 /* If the transport did not set a group, see if the router did. */
1352 if (!gid_set && testflag(addr, af_gid_set))
1358 /* Pick up a uid from the transport if one is set. */
1360 if (tp->uid_set) *uidp = tp->uid;
1362 /* Otherwise, try for an expandable uid field. If it ends up as a numeric id,
1363 it does not provide a passwd value from which a gid can be taken. */
1365 else if (tp->expand_uid != NULL)
1368 if (!route_find_expanded_user(tp->expand_uid, tp->name, US"transport", &pw,
1369 uidp, &(addr->message)))
1371 common_error(FALSE, addr, ERRNO_UIDFAIL, NULL);
1374 if (!gid_set && pw != NULL)
1381 /* If the transport doesn't set the uid, test the deliver_as_creator flag. */
1383 else if (tp->deliver_as_creator)
1385 *uidp = originator_uid;
1388 *gidp = originator_gid;
1393 /* Otherwise see if the address specifies the uid and if so, take it and its
1396 else if (testflag(addr, af_uid_set))
1399 *igfp = testflag(addr, af_initgroups);
1402 /* Nothing has specified the uid - default to the Exim user, and group if the
1415 /* If no gid is set, it is a disaster. We default to the Exim gid only if
1416 defaulting to the Exim uid. In other words, if the configuration has specified
1417 a uid, it must also provide a gid. */
1421 common_error(TRUE, addr, ERRNO_GIDFAIL, US"User set without group for "
1422 "%s transport", tp->name);
1426 /* Check that the uid is not on the lists of banned uids that may not be used
1427 for delivery processes. */
1429 if (check_never_users(*uidp, never_users))
1430 nuname = US"never_users";
1431 else if (check_never_users(*uidp, fixed_never_users))
1432 nuname = US"fixed_never_users";
1436 common_error(TRUE, addr, ERRNO_UIDFAIL, US"User %ld set for %s transport "
1437 "is on the %s list", (long int)(*uidp), tp->name, nuname);
1449 /*************************************************
1450 * Check the size of a message for a transport *
1451 *************************************************/
1453 /* Checks that the message isn't too big for the selected transport.
1454 This is called only when it is known that the limit is set.
1458 addr the (first) address being delivered
1461 DEFER expansion failed or did not yield an integer
1462 FAIL message too big
1466 check_message_size(transport_instance *tp, address_item *addr)
1471 deliver_set_expansions(addr);
1472 size_limit = expand_string_integer(tp->message_size_limit, TRUE);
1473 deliver_set_expansions(NULL);
1475 if (expand_string_message != NULL)
1478 if (size_limit == -1)
1479 addr->message = string_sprintf("failed to expand message_size_limit "
1480 "in %s transport: %s", tp->name, expand_string_message);
1482 addr->message = string_sprintf("invalid message_size_limit "
1483 "in %s transport: %s", tp->name, expand_string_message);
1485 else if (size_limit > 0 && message_size > size_limit)
1489 string_sprintf("message is too big (transport limit = %d)",
1498 /*************************************************
1499 * Transport-time check for a previous delivery *
1500 *************************************************/
1502 /* Check that this base address hasn't previously been delivered to its routed
1503 transport. If it has been delivered, mark it done. The check is necessary at
1504 delivery time in order to handle homonymic addresses correctly in cases where
1505 the pattern of redirection changes between delivery attempts (so the unique
1506 fields change). Non-homonymic previous delivery is detected earlier, at routing
1507 time (which saves unnecessary routing).
1510 addr the address item
1511 testing TRUE if testing wanted only, without side effects
1513 Returns: TRUE if previously delivered by the transport
1517 previously_transported(address_item *addr, BOOL testing)
1519 (void)string_format(big_buffer, big_buffer_size, "%s/%s",
1520 addr->unique + (testflag(addr, af_homonym)? 3:0), addr->transport->name);
1522 if (tree_search(tree_nonrecipients, big_buffer) != 0)
1524 DEBUG(D_deliver|D_route|D_transport)
1525 debug_printf("%s was previously delivered (%s transport): discarded\n",
1526 addr->address, addr->transport->name);
1527 if (!testing) child_done(addr, tod_stamp(tod_log));
1536 /******************************************************
1537 * Check for a given header in a header string *
1538 ******************************************************/
1540 /* This function is used when generating quota warnings. The configuration may
1541 specify any header lines it likes in quota_warn_message. If certain of them are
1542 missing, defaults are inserted, so we need to be able to test for the presence
1546 hdr the required header name
1547 hstring the header string
1549 Returns: TRUE the header is in the string
1550 FALSE the header is not in the string
1554 contains_header(uschar *hdr, uschar *hstring)
1556 int len = Ustrlen(hdr);
1557 uschar *p = hstring;
1560 if (strncmpic(p, hdr, len) == 0)
1563 while (*p == ' ' || *p == '\t') p++;
1564 if (*p == ':') return TRUE;
1566 while (*p != 0 && *p != '\n') p++;
1567 if (*p == '\n') p++;
1575 /*************************************************
1576 * Perform a local delivery *
1577 *************************************************/
1579 /* Each local delivery is performed in a separate process which sets its
1580 uid and gid as specified. This is a safer way than simply changing and
1581 restoring using seteuid(); there is a body of opinion that seteuid() cannot be
1582 used safely. From release 4, Exim no longer makes any use of it. Besides, not
1583 all systems have seteuid().
1585 If the uid/gid are specified in the transport_instance, they are used; the
1586 transport initialization must ensure that either both or neither are set.
1587 Otherwise, the values associated with the address are used. If neither are set,
1588 it is a configuration error.
1590 The transport or the address may specify a home directory (transport over-
1591 rides), and if they do, this is set as $home. If neither have set a working
1592 directory, this value is used for that as well. Otherwise $home is left unset
1593 and the cwd is set to "/" - a directory that should be accessible to all users.
1595 Using a separate process makes it more complicated to get error information
1596 back. We use a pipe to pass the return code and also an error code and error
1597 text string back to the parent process.
1600 addr points to an address block for this delivery; for "normal" local
1601 deliveries this is the only address to be delivered, but for
1602 pseudo-remote deliveries (e.g. by batch SMTP to a file or pipe)
1603 a number of addresses can be handled simultaneously, and in this
1604 case addr will point to a chain of addresses with the same
1607 shadowing TRUE if running a shadow transport; this causes output from pipes
1614 deliver_local(address_item *addr, BOOL shadowing)
1616 BOOL use_initgroups;
1619 int status, len, rc;
1622 uschar *working_directory;
1623 address_item *addr2;
1624 transport_instance *tp = addr->transport;
1626 /* Set up the return path from the errors or sender address. If the transport
1627 has its own return path setting, expand it and replace the existing value. */
1629 if(addr->p.errors_address != NULL)
1630 return_path = addr->p.errors_address;
1631 #ifdef EXPERIMENTAL_SRS
1632 else if(addr->p.srs_sender != NULL)
1633 return_path = addr->p.srs_sender;
1636 return_path = sender_address;
1638 if (tp->return_path != NULL)
1640 uschar *new_return_path = expand_string(tp->return_path);
1641 if (new_return_path == NULL)
1643 if (!expand_string_forcedfail)
1645 common_error(TRUE, addr, ERRNO_EXPANDFAIL,
1646 US"Failed to expand return path \"%s\" in %s transport: %s",
1647 tp->return_path, tp->name, expand_string_message);
1651 else return_path = new_return_path;
1654 /* For local deliveries, one at a time, the value used for logging can just be
1655 set directly, once and for all. */
1657 used_return_path = return_path;
1659 /* Sort out the uid, gid, and initgroups flag. If an error occurs, the message
1660 gets put into the address(es), and the expansions are unset, so we can just
1663 if (!findugid(addr, tp, &uid, &gid, &use_initgroups)) return;
1665 /* See if either the transport or the address specifies a home directory. A
1666 home directory set in the address may already be expanded; a flag is set to
1667 indicate that. In other cases we must expand it. */
1669 if ((deliver_home = tp->home_dir) != NULL || /* Set in transport, or */
1670 ((deliver_home = addr->home_dir) != NULL && /* Set in address and */
1671 !testflag(addr, af_home_expanded))) /* not expanded */
1673 uschar *rawhome = deliver_home;
1674 deliver_home = NULL; /* in case it contains $home */
1675 deliver_home = expand_string(rawhome);
1676 if (deliver_home == NULL)
1678 common_error(TRUE, addr, ERRNO_EXPANDFAIL, US"home directory \"%s\" failed "
1679 "to expand for %s transport: %s", rawhome, tp->name,
1680 expand_string_message);
1683 if (*deliver_home != '/')
1685 common_error(TRUE, addr, ERRNO_NOTABSOLUTE, US"home directory path \"%s\" "
1686 "is not absolute for %s transport", deliver_home, tp->name);
1691 /* See if either the transport or the address specifies a current directory,
1692 and if so, expand it. If nothing is set, use the home directory, unless it is
1693 also unset in which case use "/", which is assumed to be a directory to which
1694 all users have access. It is necessary to be in a visible directory for some
1695 operating systems when running pipes, as some commands (e.g. "rm" under Solaris
1696 2.5) require this. */
1698 working_directory = (tp->current_dir != NULL)?
1699 tp->current_dir : addr->current_dir;
1701 if (working_directory != NULL)
1703 uschar *raw = working_directory;
1704 working_directory = expand_string(raw);
1705 if (working_directory == NULL)
1707 common_error(TRUE, addr, ERRNO_EXPANDFAIL, US"current directory \"%s\" "
1708 "failed to expand for %s transport: %s", raw, tp->name,
1709 expand_string_message);
1712 if (*working_directory != '/')
1714 common_error(TRUE, addr, ERRNO_NOTABSOLUTE, US"current directory path "
1715 "\"%s\" is not absolute for %s transport", working_directory, tp->name);
1719 else working_directory = (deliver_home == NULL)? US"/" : deliver_home;
1721 /* If one of the return_output flags is set on the transport, create and open a
1722 file in the message log directory for the transport to write its output onto.
1723 This is mainly used by pipe transports. The file needs to be unique to the
1724 address. This feature is not available for shadow transports. */
1726 if (!shadowing && (tp->return_output || tp->return_fail_output ||
1727 tp->log_output || tp->log_fail_output))
1730 addr->return_filename =
1731 string_sprintf("%s/msglog/%s/%s-%d-%d", spool_directory, message_subdir,
1732 message_id, getpid(), return_count++);
1733 addr->return_file = open_msglog_file(addr->return_filename, 0400, &error);
1734 if (addr->return_file < 0)
1736 common_error(TRUE, addr, errno, US"Unable to %s file for %s transport "
1737 "to return message: %s", error, tp->name, strerror(errno));
1742 /* Create the pipe for inter-process communication. */
1746 common_error(TRUE, addr, ERRNO_PIPEFAIL, US"Creation of pipe failed: %s",
1751 /* Now fork the process to do the real work in the subprocess, but first
1752 ensure that all cached resources are freed so that the subprocess starts with
1753 a clean slate and doesn't interfere with the parent process. */
1757 if ((pid = fork()) == 0)
1759 BOOL replicate = TRUE;
1761 /* Prevent core dumps, as we don't want them in users' home directories.
1762 HP-UX doesn't have RLIMIT_CORE; I don't know how to do this in that
1763 system. Some experimental/developing systems (e.g. GNU/Hurd) may define
1764 RLIMIT_CORE but not support it in setrlimit(). For such systems, do not
1765 complain if the error is "not supported".
1767 There are two scenarios where changing the max limit has an effect. In one,
1768 the user is using a .forward and invoking a command of their choice via pipe;
1769 for these, we do need the max limit to be 0 unless the admin chooses to
1770 permit an increased limit. In the other, the command is invoked directly by
1771 the transport and is under administrator control, thus being able to raise
1772 the limit aids in debugging. So there's no general always-right answer.
1774 Thus we inhibit core-dumps completely but let individual transports, while
1775 still root, re-raise the limits back up to aid debugging. We make the
1776 default be no core-dumps -- few enough people can use core dumps in
1777 diagnosis that it's reasonable to make them something that has to be explicitly requested.
1784 if (setrlimit(RLIMIT_CORE, &rl) < 0)
1786 #ifdef SETRLIMIT_NOT_SUPPORTED
1787 if (errno != ENOSYS && errno != ENOTSUP)
1789 log_write(0, LOG_MAIN|LOG_PANIC, "setrlimit(RLIMIT_CORE) failed: %s",
1794 /* Reset the random number generator, so different processes don't all
1795 have the same sequence. */
1799 /* If the transport has a setup entry, call this first, while still
1800 privileged. (Appendfile uses this to expand quota, for example, while
1801 able to read private files.) */
1803 if (addr->transport->setup != NULL)
1805 switch((addr->transport->setup)(addr->transport, addr, NULL, uid, gid,
1809 addr->transport_return = DEFER;
1813 addr->transport_return = PANIC;
1818 /* Ignore SIGINT and SIGTERM during delivery. Also ignore SIGUSR1, as
1819 when the process becomes unprivileged, it won't be able to write to the
1820 process log. SIGHUP is ignored throughout exim, except when it is being
1823 signal(SIGINT, SIG_IGN);
1824 signal(SIGTERM, SIG_IGN);
1825 signal(SIGUSR1, SIG_IGN);
1827 /* Close the unwanted half of the pipe, and set close-on-exec for the other
1828 half - for transports that exec things (e.g. pipe). Then set the required
1831 (void)close(pfd[pipe_read]);
1832 (void)fcntl(pfd[pipe_write], F_SETFD, fcntl(pfd[pipe_write], F_GETFD) |
1834 exim_setugid(uid, gid, use_initgroups,
1835 string_sprintf("local delivery to %s <%s> transport=%s", addr->local_part,
1836 addr->address, addr->transport->name));
1840 address_item *batched;
1841 debug_printf(" home=%s current=%s\n", deliver_home, working_directory);
1842 for (batched = addr->next; batched != NULL; batched = batched->next)
1843 debug_printf("additional batched address: %s\n", batched->address);
1846 /* Set an appropriate working directory. */
1848 if (Uchdir(working_directory) < 0)
1850 addr->transport_return = DEFER;
1851 addr->basic_errno = errno;
1852 addr->message = string_sprintf("failed to chdir to %s", working_directory);
1855 /* If successful, call the transport */
1860 set_process_info("delivering %s to %s using %s", message_id,
1861 addr->local_part, addr->transport->name);
1863 /* If a transport filter has been specified, set up its argument list.
1864 Any errors will get put into the address, and FALSE yielded. */
1866 if (addr->transport->filter_command != NULL)
1868 ok = transport_set_up_command(&transport_filter_argv,
1869 addr->transport->filter_command,
1870 TRUE, PANIC, addr, US"transport filter", NULL);
1871 transport_filter_timeout = addr->transport->filter_timeout;
1873 else transport_filter_argv = NULL;
1877 debug_print_string(addr->transport->debug_string);
1878 replicate = !(addr->transport->info->code)(addr->transport, addr);
1882 /* Pass the results back down the pipe. If necessary, first replicate the
1883 status in the top address to the others in the batch. The label is the
1884 subject of a goto when a call to the transport's setup function fails. We
1885 pass the pointer to the transport back in case it got changed as a result of
1886 file_format in appendfile. */
1890 if (replicate) replicate_status(addr);
1891 for (addr2 = addr; addr2 != NULL; addr2 = addr2->next)
1894 int local_part_length = Ustrlen(addr2->local_part);
1897 (void)write(pfd[pipe_write], (void *)&(addr2->transport_return), sizeof(int));
1898 (void)write(pfd[pipe_write], (void *)&transport_count, sizeof(transport_count));
1899 (void)write(pfd[pipe_write], (void *)&(addr2->flags), sizeof(addr2->flags));
1900 (void)write(pfd[pipe_write], (void *)&(addr2->basic_errno), sizeof(int));
1901 (void)write(pfd[pipe_write], (void *)&(addr2->more_errno), sizeof(int));
1902 (void)write(pfd[pipe_write], (void *)&(addr2->special_action), sizeof(int));
1903 (void)write(pfd[pipe_write], (void *)&(addr2->transport),
1904 sizeof(transport_instance *));
1906 /* For a file delivery, pass back the local part, in case the original
1907 was only part of the final delivery path. This gives more complete
1910 if (testflag(addr2, af_file))
1912 (void)write(pfd[pipe_write], (void *)&local_part_length, sizeof(int));
1913 (void)write(pfd[pipe_write], addr2->local_part, local_part_length);
1916 /* Now any messages */
1918 for (i = 0, s = addr2->message; i < 2; i++, s = addr2->user_message)
1920 int message_length = (s == NULL)? 0 : Ustrlen(s) + 1;
1921 (void)write(pfd[pipe_write], (void *)&message_length, sizeof(int));
1922 if (message_length > 0) (void)write(pfd[pipe_write], s, message_length);
1926 /* OK, this process is now done. Free any cached resources that it opened,
1927 and close the pipe we were writing down before exiting. */
1929 (void)close(pfd[pipe_write]);
1934 /* Back in the main process: panic if the fork did not succeed. This seems
1935 better than returning an error - if forking is failing it is probably best
1936 not to try other deliveries for this message. */
1939 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Fork failed for local delivery to %s",
1942 /* Read the pipe to get the delivery status codes and error messages. Our copy
1943 of the writing end must be closed first, as otherwise read() won't return zero
1944 on an empty pipe. We check that a status exists for each address before
1945 overwriting the address structure. If data is missing, the default DEFER status
1946 will remain. Afterwards, close the reading end. */
1948 (void)close(pfd[pipe_write]);
1950 for (addr2 = addr; addr2 != NULL; addr2 = addr2->next)
1952 len = read(pfd[pipe_read], (void *)&status, sizeof(int));
1958 addr2->transport_return = status;
1959 len = read(pfd[pipe_read], (void *)&transport_count,
1960 sizeof(transport_count));
1961 len = read(pfd[pipe_read], (void *)&(addr2->flags), sizeof(addr2->flags));
1962 len = read(pfd[pipe_read], (void *)&(addr2->basic_errno), sizeof(int));
1963 len = read(pfd[pipe_read], (void *)&(addr2->more_errno), sizeof(int));
1964 len = read(pfd[pipe_read], (void *)&(addr2->special_action), sizeof(int));
1965 len = read(pfd[pipe_read], (void *)&(addr2->transport),
1966 sizeof(transport_instance *));
1968 if (testflag(addr2, af_file))
1970 int local_part_length;
1971 len = read(pfd[pipe_read], (void *)&local_part_length, sizeof(int));
1972 len = read(pfd[pipe_read], (void *)big_buffer, local_part_length);
1973 big_buffer[local_part_length] = 0;
1974 addr2->local_part = string_copy(big_buffer);
1977 for (i = 0, sptr = &(addr2->message); i < 2;
1978 i++, sptr = &(addr2->user_message))
1981 len = read(pfd[pipe_read], (void *)&message_length, sizeof(int));
1982 if (message_length > 0)
1984 len = read(pfd[pipe_read], (void *)big_buffer, message_length);
1985 if (len > 0) *sptr = string_copy(big_buffer);
1992 log_write(0, LOG_MAIN|LOG_PANIC, "failed to read delivery status for %s "
1993 "from delivery subprocess", addr2->unique);
1998 (void)close(pfd[pipe_read]);
2000 /* Unless shadowing, write all successful addresses immediately to the journal
2001 file, to ensure they are recorded asap. For homonymic addresses, use the base
2002 address plus the transport name. Failure to write the journal is panic-worthy,
2003 but don't stop, as it may prove possible subsequently to update the spool file
2004 in order to record the delivery. */
2008 for (addr2 = addr; addr2 != NULL; addr2 = addr2->next)
2010 if (addr2->transport_return != OK) continue;
2012 if (testflag(addr2, af_homonym))
2013 sprintf(CS big_buffer, "%.500s/%s\n", addr2->unique + 3, tp->name);
2015 sprintf(CS big_buffer, "%.500s\n", addr2->unique);
2017 /* In the test harness, wait just a bit to let the subprocess finish off
2018 any debug output etc first. */
2020 if (running_in_test_harness) millisleep(300);
2022 DEBUG(D_deliver) debug_printf("journalling %s", big_buffer);
2023 len = Ustrlen(big_buffer);
2024 if (write(journal_fd, big_buffer, len) != len)
2025 log_write(0, LOG_MAIN|LOG_PANIC, "failed to update journal for %s: %s",
2026 big_buffer, strerror(errno));
2029 /* Ensure the journal file is pushed out to disk. */
2031 if (EXIMfsync(journal_fd) < 0)
2032 log_write(0, LOG_MAIN|LOG_PANIC, "failed to fsync journal: %s",
2036 /* Wait for the process to finish. If it terminates with a non-zero code,
2037 freeze the message (except for SIGTERM, SIGKILL and SIGQUIT), but leave the
2038 status values of all the addresses as they are. Take care to handle the case
2039 when the subprocess doesn't seem to exist. This has been seen on one system
2040 when Exim was called from an MUA that set SIGCHLD to SIG_IGN. When that
2041 happens, wait() doesn't recognize the termination of child processes. Exim now
2042 resets SIGCHLD to SIG_DFL, but this code should still be robust. */
2044 while ((rc = wait(&status)) != pid)
2046 if (rc < 0 && errno == ECHILD) /* Process has vanished */
2048 log_write(0, LOG_MAIN, "%s transport process vanished unexpectedly",
2049 addr->transport->driver_name);
2055 if ((status & 0xffff) != 0)
2057 int msb = (status >> 8) & 255;
2058 int lsb = status & 255;
2059 int code = (msb == 0)? (lsb & 0x7f) : msb;
2060 if (msb != 0 || (code != SIGTERM && code != SIGKILL && code != SIGQUIT))
2061 addr->special_action = SPECIAL_FREEZE;
2062 log_write(0, LOG_MAIN|LOG_PANIC, "%s transport process returned non-zero "
2063 "status 0x%04x: %s %d",
2064 addr->transport->driver_name,
2066 (msb == 0)? "terminated by signal" : "exit code",
2070 /* If SPECIAL_WARN is set in the top address, send a warning message. */
2072 if (addr->special_action == SPECIAL_WARN &&
2073 addr->transport->warn_message != NULL)
2076 uschar *warn_message;
2078 DEBUG(D_deliver) debug_printf("Warning message requested by transport\n");
2080 warn_message = expand_string(addr->transport->warn_message);
2081 if (warn_message == NULL)
2082 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand \"%s\" (warning "
2083 "message for %s transport): %s", addr->transport->warn_message,
2084 addr->transport->name, expand_string_message);
2087 pid_t pid = child_open_exim(&fd);
2090 FILE *f = fdopen(fd, "wb");
2091 if (errors_reply_to != NULL &&
2092 !contains_header(US"Reply-To", warn_message))
2093 fprintf(f, "Reply-To: %s\n", errors_reply_to);
2094 fprintf(f, "Auto-Submitted: auto-replied\n");
2095 if (!contains_header(US"From", warn_message)) moan_write_from(f);
2096 fprintf(f, "%s", CS warn_message);
2098 /* Close and wait for child process to complete, without a timeout. */
2101 (void)child_close(pid, 0);
2105 addr->special_action = SPECIAL_NONE;
2111 /*************************************************
2112 * Do local deliveries *
2113 *************************************************/
2115 /* This function processes the list of addresses in addr_local. True local
2116 deliveries are always done one address at a time. However, local deliveries can
2117 be batched up in some cases. Typically this is when writing batched SMTP output
2118 files for use by some external transport mechanism, or when running local
2119 deliveries over LMTP.
2126 do_local_deliveries(void)
2129 open_db *dbm_file = NULL;
2130 time_t now = time(NULL);
2132 /* Loop until we have exhausted the supply of local deliveries */
2134 while (addr_local != NULL)
2136 time_t delivery_start;
2138 address_item *addr2, *addr3, *nextaddr;
2139 int logflags = LOG_MAIN;
2140 int logchar = dont_deliver? '*' : '=';
2141 transport_instance *tp;
2143 /* Pick the first undelivered address off the chain */
2145 address_item *addr = addr_local;
2146 addr_local = addr->next;
2149 DEBUG(D_deliver|D_transport)
2150 debug_printf("--------> %s <--------\n", addr->address);
2152 /* An internal disaster if there is no transport. Should not occur! */
2154 if ((tp = addr->transport) == NULL)
2156 logflags |= LOG_PANIC;
2157 disable_logging = FALSE; /* Jic */
2159 (addr->router != NULL)?
2160 string_sprintf("No transport set by %s router", addr->router->name)
2162 string_sprintf("No transport set by system filter");
2163 post_process_one(addr, DEFER, logflags, DTYPE_TRANSPORT, 0);
2167 /* Check that this base address hasn't previously been delivered to this
2168 transport. The check is necessary at this point to handle homonymic addresses
2169 correctly in cases where the pattern of redirection changes between delivery
2170 attempts. Non-homonymic previous delivery is detected earlier, at routing
2173 if (previously_transported(addr, FALSE)) continue;
2175 /* There are weird cases where logging is disabled */
2177 disable_logging = tp->disable_logging;
2179 /* Check for batched addresses and possible amalgamation. Skip all the work
2180 if either batch_max <= 1 or there aren't any other addresses for local
2183 if (tp->batch_max > 1 && addr_local != NULL)
2185 int batch_count = 1;
2186 BOOL uses_dom = readconf_depends((driver_instance *)tp, US"domain");
2187 BOOL uses_lp = (testflag(addr, af_pfr) &&
2188 (testflag(addr, af_file) || addr->local_part[0] == '|')) ||
2189 readconf_depends((driver_instance *)tp, US"local_part");
2190 uschar *batch_id = NULL;
2191 address_item **anchor = &addr_local;
2192 address_item *last = addr;
2195 /* Expand the batch_id string for comparison with other addresses.
2196 Expansion failure suppresses batching. */
2198 if (tp->batch_id != NULL)
2200 deliver_set_expansions(addr);
2201 batch_id = expand_string(tp->batch_id);
2202 deliver_set_expansions(NULL);
2203 if (batch_id == NULL)
2205 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand batch_id option "
2206 "in %s transport (%s): %s", tp->name, addr->address,
2207 expand_string_message);
2208 batch_count = tp->batch_max;
2212 /* Until we reach the batch_max limit, pick off addresses which have the
2213 same characteristics. These are:
2216 not previously delivered (see comment about 50 lines above)
2217 same local part if the transport's configuration contains $local_part
2218 or if this is a file or pipe delivery from a redirection
2219 same domain if the transport's configuration contains $domain
2221 same additional headers
2222 same headers to be removed
2223 same uid/gid for running the transport
2224 same first host if a host list is set
2227 while ((next = *anchor) != NULL && batch_count < tp->batch_max)
2230 tp == next->transport &&
2231 !previously_transported(next, TRUE) &&
2232 (addr->flags & (af_pfr|af_file)) == (next->flags & (af_pfr|af_file)) &&
2233 (!uses_lp || Ustrcmp(next->local_part, addr->local_part) == 0) &&
2234 (!uses_dom || Ustrcmp(next->domain, addr->domain) == 0) &&
2235 same_strings(next->p.errors_address, addr->p.errors_address) &&
2236 same_headers(next->p.extra_headers, addr->p.extra_headers) &&
2237 same_strings(next->p.remove_headers, addr->p.remove_headers) &&
2238 same_ugid(tp, addr, next) &&
2239 ((addr->host_list == NULL && next->host_list == NULL) ||
2240 (addr->host_list != NULL && next->host_list != NULL &&
2241 Ustrcmp(addr->host_list->name, next->host_list->name) == 0));
2243 /* If the transport has a batch_id setting, batch_id will be non-NULL
2244 from the expansion outside the loop. Expand for this address and compare.
2245 Expansion failure makes this address ineligible for batching. */
2247 if (ok && batch_id != NULL)
2250 address_item *save_nextnext = next->next;
2251 next->next = NULL; /* Expansion for a single address */
2252 deliver_set_expansions(next);
2253 next->next = save_nextnext;
2254 bid = expand_string(tp->batch_id);
2255 deliver_set_expansions(NULL);
2258 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand batch_id option "
2259 "in %s transport (%s): %s", tp->name, next->address,
2260 expand_string_message);
2263 else ok = (Ustrcmp(batch_id, bid) == 0);
2266 /* Take address into batch if OK. */
2270 *anchor = next->next; /* Include the address */
2276 else anchor = &(next->next); /* Skip the address */
2280 /* We now have one or more addresses that can be delivered in a batch. Check
2281 whether the transport is prepared to accept a message of this size. If not,
2282 fail them all forthwith. If the expansion fails, or does not yield an
2283 integer, defer delivery. */
2285 if (tp->message_size_limit != NULL)
2287 int rc = check_message_size(tp, addr);
2290 replicate_status(addr);
2291 while (addr != NULL)
2294 post_process_one(addr, rc, logflags, DTYPE_TRANSPORT, 0);
2297 continue; /* With next batch of addresses */
2301 /* If we are not running the queue, or if forcing, all deliveries will be
2302 attempted. Otherwise, we must respect the retry times for each address. Even
2303 when not doing this, we need to set up the retry key string, and determine
2304 whether a retry record exists, because after a successful delivery, a delete
2305 retry item must be set up. Keep the retry database open only for the duration
2306 of these checks, rather than for all local deliveries, because some local
2307 deliveries (e.g. to pipes) can take a substantial time. */
2309 dbm_file = dbfn_open(US"retry", O_RDONLY, &dbblock, FALSE);
2310 if (dbm_file == NULL)
2312 DEBUG(D_deliver|D_retry|D_hints_lookup)
2313 debug_printf("no retry data available\n");
2318 while (addr2 != NULL)
2320 BOOL ok = TRUE; /* to deliver this address */
2323 /* Set up the retry key to include the domain or not, and change its
2324 leading character from "R" to "T". Must make a copy before doing this,
2325 because the old key may be pointed to from a "delete" retry item after
2328 retry_key = string_copy(
2329 (tp->retry_use_local_part)? addr2->address_retry_key :
2330 addr2->domain_retry_key);
2333 /* Inspect the retry data. If there is no hints file, delivery happens. */
2335 if (dbm_file != NULL)
2337 dbdata_retry *retry_record = dbfn_read(dbm_file, retry_key);
2339 /* If there is no retry record, delivery happens. If there is,
2340 remember it exists so it can be deleted after a successful delivery. */
2342 if (retry_record != NULL)
2344 setflag(addr2, af_lt_retry_exists);
2346 /* A retry record exists for this address. If queue running and not
2347 forcing, inspect its contents. If the record is too old, or if its
2348 retry time has come, or if it has passed its cutoff time, delivery
2353 debug_printf("retry record exists: age=%s ",
2354 readconf_printtime(now - retry_record->time_stamp));
2355 debug_printf("(max %s)\n", readconf_printtime(retry_data_expire));
2356 debug_printf(" time to retry = %s expired = %d\n",
2357 readconf_printtime(retry_record->next_try - now),
2358 retry_record->expired);
2361 if (queue_running && !deliver_force)
2363 ok = (now - retry_record->time_stamp > retry_data_expire) ||
2364 (now >= retry_record->next_try) ||
2365 retry_record->expired;
2367 /* If we haven't reached the retry time, there is one more check
2368 to do, which is for the ultimate address timeout. */
2372 retry_config *retry =
2373 retry_find_config(retry_key+2, addr2->domain,
2374 retry_record->basic_errno,
2375 retry_record->more_errno);
2377 DEBUG(D_deliver|D_retry)
2379 debug_printf("retry time not reached for %s: "
2380 "checking ultimate address timeout\n", addr2->address);
2381 debug_printf(" now=%d first_failed=%d next_try=%d expired=%d\n",
2382 (int)now, (int)retry_record->first_failed,
2383 (int)retry_record->next_try, retry_record->expired);
2386 if (retry != NULL && retry->rules != NULL)
2388 retry_rule *last_rule;
2389 for (last_rule = retry->rules;
2390 last_rule->next != NULL;
2391 last_rule = last_rule->next);
2392 DEBUG(D_deliver|D_retry)
2393 debug_printf(" received_time=%d diff=%d timeout=%d\n",
2394 received_time, (int)now - received_time, last_rule->timeout);
2395 if (now - received_time > last_rule->timeout) ok = TRUE;
2399 DEBUG(D_deliver|D_retry)
2400 debug_printf("no retry rule found: assume timed out\n");
2401 ok = TRUE; /* No rule => timed out */
2404 DEBUG(D_deliver|D_retry)
2406 if (ok) debug_printf("on queue longer than maximum retry for "
2407 "address - allowing delivery\n");
2412 else DEBUG(D_retry) debug_printf("no retry record exists\n");
2415 /* This address is to be delivered. Leave it on the chain. */
2420 addr2 = addr2->next;
2423 /* This address is to be deferred. Take it out of the chain, and
2424 post-process it as complete. Must take it out of the chain first,
2425 because post processing puts it on another chain. */
2429 address_item *this = addr2;
2430 this->message = US"Retry time not yet reached";
2431 this->basic_errno = ERRNO_LRETRY;
2432 if (addr3 == NULL) addr2 = addr = addr2->next;
2433 else addr2 = addr3->next = addr2->next;
2434 post_process_one(this, DEFER, logflags, DTYPE_TRANSPORT, 0);
2438 if (dbm_file != NULL) dbfn_close(dbm_file);
2440 /* If there are no addresses left on the chain, they all deferred. Loop
2441 for the next set of addresses. */
2443 if (addr == NULL) continue;
2445 /* So, finally, we do have some addresses that can be passed to the
2446 transport. Before doing so, set up variables that are relevant to a
2449 deliver_set_expansions(addr);
2450 delivery_start = time(NULL);
2451 deliver_local(addr, FALSE);
2452 deliver_time = (int)(time(NULL) - delivery_start);
2454 /* If a shadow transport (which must perforce be another local transport), is
2455 defined, and its condition is met, we must pass the message to the shadow
2456 too, but only those addresses that succeeded. We do this by making a new
2457 chain of addresses - also to keep the original chain uncontaminated. We must
2458 use a chain rather than doing it one by one, because the shadow transport may
2461 NOTE: if the condition fails because of a lookup defer, there is nothing we
2464 if (tp->shadow != NULL &&
2465 (tp->shadow_condition == NULL ||
2466 expand_check_condition(tp->shadow_condition, tp->name, US"transport")))
2468 transport_instance *stp;
2469 address_item *shadow_addr = NULL;
2470 address_item **last = &shadow_addr;
2472 for (stp = transports; stp != NULL; stp = stp->next)
2473 if (Ustrcmp(stp->name, tp->shadow) == 0) break;
2476 log_write(0, LOG_MAIN|LOG_PANIC, "shadow transport \"%s\" not found ",
2479 /* Pick off the addresses that have succeeded, and make clones. Put into
2480 the shadow_message field a pointer to the shadow_message field of the real
2483 else for (addr2 = addr; addr2 != NULL; addr2 = addr2->next)
2485 if (addr2->transport_return != OK) continue;
2486 addr3 = store_get(sizeof(address_item));
2489 addr3->shadow_message = (uschar *)(&(addr2->shadow_message));
2490 addr3->transport = stp;
2491 addr3->transport_return = DEFER;
2492 addr3->return_filename = NULL;
2493 addr3->return_file = -1;
2495 last = &(addr3->next);
2498 /* If we found any addresses to shadow, run the delivery, and stick any
2499 message back into the shadow_message field in the original. */
2501 if (shadow_addr != NULL)
2503 int save_count = transport_count;
2505 DEBUG(D_deliver|D_transport)
2506 debug_printf(">>>>>>>>>>>>>>>> Shadow delivery >>>>>>>>>>>>>>>>\n");
2507 deliver_local(shadow_addr, TRUE);
2509 for(; shadow_addr != NULL; shadow_addr = shadow_addr->next)
2511 int sresult = shadow_addr->transport_return;
2512 *((uschar **)(shadow_addr->shadow_message)) = (sresult == OK)?
2513 string_sprintf(" ST=%s", stp->name) :
2514 string_sprintf(" ST=%s (%s%s%s)", stp->name,
2515 (shadow_addr->basic_errno <= 0)?
2516 US"" : US strerror(shadow_addr->basic_errno),
2517 (shadow_addr->basic_errno <= 0 || shadow_addr->message == NULL)?
2519 (shadow_addr->message != NULL)? shadow_addr->message :
2520 (shadow_addr->basic_errno <= 0)? US"unknown error" : US"");
2522 DEBUG(D_deliver|D_transport)
2523 debug_printf("%s shadow transport returned %s for %s\n",
2525 (sresult == OK)? "OK" :
2526 (sresult == DEFER)? "DEFER" :
2527 (sresult == FAIL)? "FAIL" :
2528 (sresult == PANIC)? "PANIC" : "?",
2529 shadow_addr->address);
2532 DEBUG(D_deliver|D_transport)
2533 debug_printf(">>>>>>>>>>>>>>>> End shadow delivery >>>>>>>>>>>>>>>>\n");
2535 transport_count = save_count; /* Restore original transport count */
2539 /* Cancel the expansions that were set up for the delivery. */
2541 deliver_set_expansions(NULL);
2543 /* Now we can process the results of the real transport. We must take each
2544 address off the chain first, because post_process_one() puts it on another
2547 for (addr2 = addr; addr2 != NULL; addr2 = nextaddr)
2549 int result = addr2->transport_return;
2550 nextaddr = addr2->next;
2552 DEBUG(D_deliver|D_transport)
2553 debug_printf("%s transport returned %s for %s\n",
2555 (result == OK)? "OK" :
2556 (result == DEFER)? "DEFER" :
2557 (result == FAIL)? "FAIL" :
2558 (result == PANIC)? "PANIC" : "?",
2561 /* If there is a retry_record, or if delivery is deferred, build a retry
2562 item for setting a new retry time or deleting the old retry record from
2563 the database. These items are handled all together after all addresses
2564 have been handled (so the database is open just for a short time for
2567 if (result == DEFER || testflag(addr2, af_lt_retry_exists))
2569 int flags = (result == DEFER)? 0 : rf_delete;
2570 uschar *retry_key = string_copy((tp->retry_use_local_part)?
2571 addr2->address_retry_key : addr2->domain_retry_key);
2573 retry_add_item(addr2, retry_key, flags);
2576 /* Done with this address */
2578 if (result == OK) addr2->more_errno = deliver_time;
2579 post_process_one(addr2, result, logflags, DTYPE_TRANSPORT, logchar);
2581 /* If a pipe delivery generated text to be sent back, the result may be
2582 changed to FAIL, and we must copy this for subsequent addresses in the
2585 if (addr2->transport_return != result)
2587 for (addr3 = nextaddr; addr3 != NULL; addr3 = addr3->next)
2589 addr3->transport_return = addr2->transport_return;
2590 addr3->basic_errno = addr2->basic_errno;
2591 addr3->message = addr2->message;
2593 result = addr2->transport_return;
2596 /* Whether or not the result was changed to FAIL, we need to copy the
2597 return_file value from the first address into all the addresses of the
2598 batch, so they are all listed in the error message. */
2600 addr2->return_file = addr->return_file;
2602 /* Change log character for recording successful deliveries. */
2604 if (result == OK) logchar = '-';
2606 } /* Loop back for next batch of addresses */
2612 /*************************************************
2613 * Sort remote deliveries *
2614 *************************************************/
2616 /* This function is called if remote_sort_domains is set. It arranges that the
2617 chain of addresses for remote deliveries is ordered according to the strings
2618 specified. Try to make this shuffling reasonably efficient by handling
2619 sequences of addresses rather than just single ones.
2626 sort_remote_deliveries(void)
2629 address_item **aptr = &addr_remote;
2630 uschar *listptr = remote_sort_domains;
2634 while (*aptr != NULL &&
2635 (pattern = string_nextinlist(&listptr, &sep, patbuf, sizeof(patbuf)))
2638 address_item *moved = NULL;
2639 address_item **bptr = &moved;
2641 while (*aptr != NULL)
2643 address_item **next;
2644 deliver_domain = (*aptr)->domain; /* set $domain */
2645 if (match_isinlist(deliver_domain, &pattern, UCHAR_MAX+1,
2646 &domainlist_anchor, NULL, MCL_DOMAIN, TRUE, NULL) == OK)
2648 aptr = &((*aptr)->next);
2652 next = &((*aptr)->next);
2653 while (*next != NULL &&
2654 (deliver_domain = (*next)->domain, /* Set $domain */
2655 match_isinlist(deliver_domain, &pattern, UCHAR_MAX+1,
2656 &domainlist_anchor, NULL, MCL_DOMAIN, TRUE, NULL)) != OK)
2657 next = &((*next)->next);
2659 /* If the batch of non-matchers is at the end, add on any that were
2660 extracted further up the chain, and end this iteration. Otherwise,
2661 extract them from the chain and hang on the moved chain. */
2673 aptr = &((*aptr)->next);
2676 /* If the loop ended because the final address matched, *aptr will
2677 be NULL. Add on to the end any extracted non-matching addresses. If
2678 *aptr is not NULL, the loop ended via "break" when *next is null, that
2679 is, there was a string of non-matching addresses at the end. In this
2680 case the extracted addresses have already been added on the end. */
2682 if (*aptr == NULL) *aptr = moved;
2688 debug_printf("remote addresses after sorting:\n");
2689 for (addr = addr_remote; addr != NULL; addr = addr->next)
2690 debug_printf(" %s\n", addr->address);
2696 /*************************************************
2697 * Read from pipe for remote delivery subprocess *
2698 *************************************************/
2700 /* This function is called when the subprocess is complete, but can also be
2701 called before it is complete, in order to empty a pipe that is full (to prevent
2702 deadlock). It must therefore keep track of its progress in the parlist data
2705 We read the pipe to get the delivery status codes and a possible error message
2706 for each address, optionally preceded by unusability data for the hosts and
2707 also by optional retry data.
2709 Read in large chunks into the big buffer and then scan through, interpreting
2710 the data therein. In most cases, only a single read will be necessary. No
2711 individual item will ever be anywhere near 2500 bytes in length, so by ensuring
2712 that we read the next chunk when there is less than 2500 bytes left in the
2713 non-final chunk, we can assume each item is complete in the buffer before
2714 handling it. Each item is written using a single write(), which is atomic for
2715 small items (less than PIPE_BUF, which seems to be at least 512 in any Unix and
2716 often bigger) so even if we are reading while the subprocess is still going, we
2717 should never have only a partial item in the buffer.
2720 poffset the offset of the parlist item
2721 eop TRUE if the process has completed
2723 Returns: TRUE if the terminating 'Z' item has been read,
2724 or there has been a disaster (i.e. no more data needed);
2729 par_read_pipe(int poffset, BOOL eop)
2732 pardata *p = parlist + poffset;
2733 address_item *addrlist = p->addrlist;
2734 address_item *addr = p->addr;
2737 uschar *endptr = big_buffer;
2738 uschar *ptr = endptr;
2739 uschar *msg = p->msg;
2740 BOOL done = p->done;
2741 BOOL unfinished = TRUE;
2743 /* Loop through all items, reading from the pipe when necessary. The pipe
2744 is set up to be non-blocking, but there are two different Unix mechanisms in
2745 use. Exim uses O_NONBLOCK if it is defined. This returns 0 for end of file,
2746 and EAGAIN for no more data. If O_NONBLOCK is not defined, Exim uses O_NDELAY,
2747 which returns 0 for both end of file and no more data. We distinguish the
2748 two cases by taking 0 as end of file only when we know the process has
2751 Each separate item is written to the pipe in a single write(), and as they are
2752 all short items, the writes will all be atomic and we should never find
2753 ourselves in the position of having read an incomplete item. "Short" in this
2754 case can mean up to about 1K in the case when there is a long error message
2755 associated with an address. */
2757 DEBUG(D_deliver) debug_printf("reading pipe for subprocess %d (%s)\n",
2758 (int)p->pid, eop? "ended" : "not ended");
2762 retry_item *r, **rp;
2763 int remaining = endptr - ptr;
2765 /* Read (first time) or top up the chars in the buffer if necessary.
2766 There will be only one read if we get all the available data (i.e. don't
2767 fill the buffer completely). */
2769 if (remaining < 2500 && unfinished)
2772 int available = big_buffer_size - remaining;
2774 if (remaining > 0) memmove(big_buffer, ptr, remaining);
2777 endptr = big_buffer + remaining;
2778 len = read(fd, endptr, available);
2780 DEBUG(D_deliver) debug_printf("read() yielded %d\n", len);
2782 /* If the result is EAGAIN and the process is not complete, just
2783 stop reading any more and process what we have already. */
2787 if (!eop && errno == EAGAIN) len = 0; else
2789 msg = string_sprintf("failed to read pipe from transport process "
2790 "%d for transport %s: %s", pid, addr->transport->driver_name,
2796 /* If the length is zero (eof or no-more-data), just process what we
2797 already have. Note that if the process is still running and we have
2798 read all the data in the pipe (but less that "available") then we
2799 won't read any more, as "unfinished" will get set FALSE. */
2802 unfinished = len == available;
2805 /* If we are at the end of the available data, exit the loop. */
2807 if (ptr >= endptr) break;
2809 /* Handle each possible type of item, assuming the complete item is
2810 available in store. */
2814 /* Host items exist only if any hosts were marked unusable. Match
2815 up by checking the IP address. */
2818 for (h = addrlist->host_list; h != NULL; h = h->next)
2820 if (h->address == NULL || Ustrcmp(h->address, ptr+2) != 0) continue;
2828 /* Retry items are sent in a preceding R item for each address. This is
2829 kept separate to keep each message short enough to guarantee it won't
2830 be split in the pipe. Hopefully, in the majority of cases, there won't in
2831 fact be any retry items at all.
2833 The complete set of retry items might include an item to delete a
2834 routing retry if there was a previous routing delay. However, routing
2835 retries are also used when a remote transport identifies an address error.
2836 In that case, there may also be an "add" item for the same key. Arrange
2837 that a "delete" item is dropped in favour of an "add" item. */
2840 if (addr == NULL) goto ADDR_MISMATCH;
2842 DEBUG(D_deliver|D_retry)
2843 debug_printf("reading retry information for %s from subprocess\n",
2846 /* Cut out any "delete" items on the list. */
2848 for (rp = &(addr->retries); (r = *rp) != NULL; rp = &(r->next))
2850 if (Ustrcmp(r->key, ptr+1) == 0) /* Found item with same key */
2852 if ((r->flags & rf_delete) == 0) break; /* It was not "delete" */
2853 *rp = r->next; /* Excise a delete item */
2854 DEBUG(D_deliver|D_retry)
2855 debug_printf(" existing delete item dropped\n");
2859 /* We want to add a delete item only if there is no non-delete item;
2860 however we still have to step ptr through the data. */
2862 if (r == NULL || (*ptr & rf_delete) == 0)
2864 r = store_get(sizeof(retry_item));
2865 r->next = addr->retries;
2868 r->key = string_copy(ptr);
2870 memcpy(&(r->basic_errno), ptr, sizeof(r->basic_errno));
2871 ptr += sizeof(r->basic_errno);
2872 memcpy(&(r->more_errno), ptr, sizeof(r->more_errno));
2873 ptr += sizeof(r->more_errno);
2874 r->message = (*ptr)? string_copy(ptr) : NULL;
2875 DEBUG(D_deliver|D_retry)
2876 debug_printf(" added %s item\n",
2877 ((r->flags & rf_delete) == 0)? "retry" : "delete");
2882 DEBUG(D_deliver|D_retry)
2883 debug_printf(" delete item not added: non-delete item exists\n");
2886 ptr += sizeof(r->basic_errno) + sizeof(r->more_errno);
2892 /* Put the amount of data written into the parlist block */
2895 memcpy(&(p->transport_count), ptr, sizeof(transport_count));
2896 ptr += sizeof(transport_count);
2899 /* Address items are in the order of items on the address chain. We
2900 remember the current address value in case this function is called
2901 several times to empty the pipe in stages. Information about delivery
2902 over TLS is sent in a preceding X item for each address. We don't put
2903 it in with the other info, in order to keep each message short enough to
2904 guarantee it won't be split in the pipe. */
2908 if (addr == NULL) goto ADDR_MISMATCH; /* Below, in 'A' handler */
2909 addr->cipher = (*ptr)? string_copy(ptr) : NULL;
2911 addr->peerdn = (*ptr)? string_copy(ptr) : NULL;
2920 msg = string_sprintf("address count mismatch for data read from pipe "
2921 "for transport process %d for transport %s", pid,
2922 addrlist->transport->driver_name);
2927 addr->transport_return = *ptr++;
2928 addr->special_action = *ptr++;
2929 memcpy(&(addr->basic_errno), ptr, sizeof(addr->basic_errno));
2930 ptr += sizeof(addr->basic_errno);
2931 memcpy(&(addr->more_errno), ptr, sizeof(addr->more_errno));
2932 ptr += sizeof(addr->more_errno);
2933 memcpy(&(addr->flags), ptr, sizeof(addr->flags));
2934 ptr += sizeof(addr->flags);
2935 addr->message = (*ptr)? string_copy(ptr) : NULL;
2937 addr->user_message = (*ptr)? string_copy(ptr) : NULL;
2940 /* Always two strings for host information, followed by the port number */
2944 h = store_get(sizeof(host_item));
2945 h->name = string_copy(ptr);
2947 h->address = string_copy(ptr);
2949 memcpy(&(h->port), ptr, sizeof(h->port));
2950 ptr += sizeof(h->port);
2951 addr->host_used = h;
2955 /* Finished with this address */
2960 /* Z marks the logical end of the data. It is followed by '0' if
2961 continue_transport was NULL at the end of transporting, otherwise '1'.
2962 We need to know when it becomes NULL during a delivery down a passed SMTP
2963 channel so that we don't try to pass anything more down it. Of course, for
2964 most normal messages it will remain NULL all the time. */
2969 continue_transport = NULL;
2970 continue_hostname = NULL;
2973 DEBUG(D_deliver) debug_printf("Z%c item read\n", *ptr);
2976 /* Anything else is a disaster. */
2979 msg = string_sprintf("malformed data (%d) read from pipe for transport "
2980 "process %d for transport %s", ptr[-1], pid,
2981 addr->transport->driver_name);
2987 /* The done flag is inspected externally, to determine whether or not to
2988 call the function again when the process finishes. */
2992 /* If the process hadn't finished, and we haven't seen the end of the data
2993 or suffered a disaster, update the rest of the state, and return FALSE to
2994 indicate "not finished". */
3003 /* Close our end of the pipe, to prevent deadlock if the far end is still
3004 pushing stuff into it. */
3009 /* If we have finished without error, but haven't had data for every address,
3010 something is wrong. */
3012 if (msg == NULL && addr != NULL)
3013 msg = string_sprintf("insufficient address data read from pipe "
3014 "for transport process %d for transport %s", pid,
3015 addr->transport->driver_name);
3017 /* If an error message is set, something has gone wrong in getting back
3018 the delivery data. Put the message into each address and freeze it. */
3022 for (addr = addrlist; addr != NULL; addr = addr->next)
3024 addr->transport_return = DEFER;
3025 addr->special_action = SPECIAL_FREEZE;
3026 addr->message = msg;
3030 /* Return TRUE to indicate we have got all we need from this process, even
3031 if it hasn't actually finished yet. */
3038 /*************************************************
3039 * Post-process a set of remote addresses *
3040 *************************************************/
3042 /* Do what has to be done immediately after a remote delivery for each set of
3043 addresses, then re-write the spool if necessary. Note that post_process_one
3044 puts the address on an appropriate queue; hence we must fish off the next
3045 one first. This function is also called if there is a problem with setting
3046 up a subprocess to do a remote delivery in parallel. In this case, the final
3047 argument contains a message, and the action must be forced to DEFER.
3050 addr pointer to chain of address items
3051 logflags flags for logging
3052 msg NULL for normal cases; -> error message for unexpected problems
3053 fallback TRUE if processing fallback hosts
3059 remote_post_process(address_item *addr, int logflags, uschar *msg,
3064 /* If any host addresses were found to be unusable, add them to the unusable
3065 tree so that subsequent deliveries don't try them. */
3067 for (h = addr->host_list; h != NULL; h = h->next)
3069 if (h->address == NULL) continue;
3070 if (h->status >= hstatus_unusable) tree_add_unusable(h);
3073 /* Now handle each address on the chain. The transport has placed '=' or '-'
3074 into the special_action field for each successful delivery. */
3076 while (addr != NULL)
3078 address_item *next = addr->next;
3080 /* If msg == NULL (normal processing) and the result is DEFER and we are
3081 processing the main hosts and there are fallback hosts available, put the
3082 address on the list for fallback delivery. */
3084 if (addr->transport_return == DEFER &&
3085 addr->fallback_hosts != NULL &&
3089 addr->host_list = addr->fallback_hosts;
3090 addr->next = addr_fallback;
3091 addr_fallback = addr;
3092 DEBUG(D_deliver) debug_printf("%s queued for fallback host(s)\n", addr->address);
3095 /* If msg is set (=> unexpected problem), set it in the address before
3096 doing the ordinary post processing. */
3102 addr->message = msg;
3103 addr->transport_return = DEFER;
3105 (void)post_process_one(addr, addr->transport_return, logflags,
3106 DTYPE_TRANSPORT, addr->special_action);
3114 /* If we have just delivered down a passed SMTP channel, and that was
3115 the last address, the channel will have been closed down. Now that
3116 we have logged that delivery, set continue_sequence to 1 so that
3117 any subsequent deliveries don't get "*" incorrectly logged. */
3119 if (continue_transport == NULL) continue_sequence = 1;
3124 /*************************************************
3125 * Wait for one remote delivery subprocess *
3126 *************************************************/
3128 /* This function is called while doing remote deliveries when either the
3129 maximum number of processes exist and we need one to complete so that another
3130 can be created, or when waiting for the last ones to complete. It must wait for
3131 the completion of one subprocess, empty the control block slot, and return a
3132 pointer to the address chain.
3135 Returns: pointer to the chain of addresses handled by the process;
3136 NULL if no subprocess found - this is an unexpected error
3139 static address_item *
3142 int poffset, status;
3143 address_item *addr, *addrlist;
3146 set_process_info("delivering %s: waiting for a remote delivery subprocess "
3147 "to finish", message_id);
3149 /* Loop until either a subprocess completes, or there are no subprocesses in
3150 existence - in which case give an error return. We cannot proceed just by
3151 waiting for a completion, because a subprocess may have filled up its pipe, and
3152 be waiting for it to be emptied. Therefore, if no processes have finished, we
3153 wait for one of the pipes to acquire some data by calling select(), with a
3154 timeout just in case.
3156 The simple approach is just to iterate after reading data from a ready pipe.
3157 This leads to non-ideal behaviour when the subprocess has written its final Z
3158 item, closed the pipe, and is in the process of exiting (the common case). A
3159 call to waitpid() yields nothing completed, but select() shows the pipe ready -
3160 reading it yields EOF, so you end up with busy-waiting until the subprocess has
3163 To avoid this, if all the data that is needed has been read from a subprocess
3164 after select(), an explicit wait() for it is done. We know that all it is doing
3165 is writing to the pipe and then exiting, so the wait should not be long.
3167 The non-blocking waitpid() is to some extent just insurance; if we could
3168 reliably detect end-of-file on the pipe, we could always know when to do a
3169 blocking wait() for a completed process. However, because some systems use
3170 NDELAY, which doesn't distinguish between EOF and pipe empty, it is easier to
3171 use code that functions without the need to recognize EOF.
3173 There's a double loop here just in case we end up with a process that is not in
3174 the list of remote delivery processes. Something has obviously gone wrong if
3175 this is the case. (For example, a process that is incorrectly left over from
3176 routing or local deliveries might be found.) The damage can be minimized by
3177 looping back and looking for another process. If there aren't any, the error
3178 return will happen. */
3180 for (;;) /* Normally we do not repeat this loop */
3182 while ((pid = waitpid(-1, &status, WNOHANG)) <= 0)
3185 fd_set select_pipes;
3186 int maxpipe, readycount;
3188 /* A return value of -1 can mean several things. If errno != ECHILD, it
3189 either means invalid options (which we discount), or that this process was
3190 interrupted by a signal. Just loop to try the waitpid() again.
3192 If errno == ECHILD, waitpid() is telling us that there are no subprocesses
3193 in existence. This should never happen, and is an unexpected error.
3194 However, there is a nasty complication when running under Linux. If "strace
3195 -f" is being used under Linux to trace this process and its children,
3196 subprocesses are "stolen" from their parents and become the children of the
3197 tracing process. A general wait such as the one we've just obeyed returns
3198 as if there are no children while subprocesses are running. Once a
3199 subprocess completes, it is restored to the parent, and waitpid(-1) finds
3200 it. Thanks to Joachim Wieland for finding all this out and suggesting a
3203 This does not happen using "truss" on Solaris, nor (I think) with other
3204 tracing facilities on other OS. It seems to be specific to Linux.
3206 What we do to get round this is to use kill() to see if any of our
3207 subprocesses are still in existence. If kill() gives an OK return, we know
3208 it must be for one of our processes - it can't be for a re-use of the pid,
3209 because if our process had finished, waitpid() would have found it. If any
3210 of our subprocesses are in existence, we proceed to use select() as if
3211 waitpid() had returned zero. I think this is safe. */
3215 if (errno != ECHILD) continue; /* Repeats the waitpid() */
3218 debug_printf("waitpid() returned -1/ECHILD: checking explicitly "
3219 "for process existence\n");
3221 for (poffset = 0; poffset < remote_max_parallel; poffset++)
3223 if ((pid = parlist[poffset].pid) != 0 && kill(pid, 0) == 0)
3225 DEBUG(D_deliver) debug_printf("process %d still exists: assume "
3226 "stolen by strace\n", (int)pid);
3227 break; /* With poffset set */
3231 if (poffset >= remote_max_parallel)
3233 DEBUG(D_deliver) debug_printf("*** no delivery children found\n");
3234 return NULL; /* This is the error return */
3238 /* A pid value greater than 0 breaks the "while" loop. A negative value has
3239 been handled above. A return value of zero means that there is at least one
3240 subprocess, but there are no completed subprocesses. See if any pipes are
3241 ready with any data for reading. */
3243 DEBUG(D_deliver) debug_printf("selecting on subprocess pipes\n");
3246 FD_ZERO(&select_pipes);
3247 for (poffset = 0; poffset < remote_max_parallel; poffset++)
3249 if (parlist[poffset].pid != 0)
3251 int fd = parlist[poffset].fd;
3252 FD_SET(fd, &select_pipes);
3253 if (fd > maxpipe) maxpipe = fd;
3257 /* Stick in a 60-second timeout, just in case. */
3262 readycount = select(maxpipe + 1, (SELECT_ARG2_TYPE *)&select_pipes,
3265 /* Scan through the pipes and read any that are ready; use the count
3266 returned by select() to stop when there are no more. Select() can return
3267 with no processes (e.g. if interrupted). This shouldn't matter.
3269 If par_read_pipe() returns TRUE, it means that either the terminating Z was
3270 read, or there was a disaster. In either case, we are finished with this
3271 process. Do an explicit wait() for the process and break the main loop if
3274 It turns out that we have to deal with the case of an interrupted system
3275 call, which can happen on some operating systems if the signal handling is
3276 set up to do that by default. */
3279 readycount > 0 && poffset < remote_max_parallel;
3282 if ((pid = parlist[poffset].pid) != 0 &&
3283 FD_ISSET(parlist[poffset].fd, &select_pipes))
3286 if (par_read_pipe(poffset, FALSE)) /* Finished with this pipe */
3288 for (;;) /* Loop for signals */
3290 pid_t endedpid = waitpid(pid, &status, 0);
3291 if (endedpid == pid) goto PROCESS_DONE;
3292 if (endedpid != (pid_t)(-1) || errno != EINTR)
3293 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Unexpected error return "
3294 "%d (errno = %d) from waitpid() for process %d",
3295 (int)endedpid, errno, (int)pid);
3301 /* Now go back and look for a completed subprocess again. */
3304 /* A completed process was detected by the non-blocking waitpid(). Find the
3305 data block that corresponds to this subprocess. */
3307 for (poffset = 0; poffset < remote_max_parallel; poffset++)
3308 if (pid == parlist[poffset].pid) break;
3310 /* Found the data block; this is a known remote delivery process. We don't
3311 need to repeat the outer loop. This should be what normally happens. */
3313 if (poffset < remote_max_parallel) break;
3315 /* This situation is an error, but it's probably better to carry on looking
3316 for another process than to give up (as we used to do). */
3318 log_write(0, LOG_MAIN|LOG_PANIC, "Process %d finished: not found in remote "
3319 "transport process list", pid);
3320 } /* End of the "for" loop */
3322 /* Come here when all the data was completely read after a select(), and
3323 the process in pid has been wait()ed for. */
3330 debug_printf("remote delivery process %d ended\n", (int)pid);
3332 debug_printf("remote delivery process %d ended: status=%04x\n", (int)pid,
3336 set_process_info("delivering %s", message_id);
3338 /* Get the chain of processed addresses */
3340 addrlist = parlist[poffset].addrlist;
3342 /* If the process did not finish cleanly, record an error and freeze (except
3343 for SIGTERM, SIGKILL and SIGQUIT), and also ensure the journal is not removed,
3344 in case the delivery did actually happen. */
3346 if ((status & 0xffff) != 0)
3349 int msb = (status >> 8) & 255;
3350 int lsb = status & 255;
3351 int code = (msb == 0)? (lsb & 0x7f) : msb;
3353 msg = string_sprintf("%s transport process returned non-zero status 0x%04x: "
3355 addrlist->transport->driver_name,
3357 (msb == 0)? "terminated by signal" : "exit code",
3360 if (msb != 0 || (code != SIGTERM && code != SIGKILL && code != SIGQUIT))
3361 addrlist->special_action = SPECIAL_FREEZE;
3363 for (addr = addrlist; addr != NULL; addr = addr->next)
3365 addr->transport_return = DEFER;
3366 addr->message = msg;
3369 remove_journal = FALSE;
3372 /* Else complete reading the pipe to get the result of the delivery, if all
3373 the data has not yet been obtained. */
3375 else if (!parlist[poffset].done) (void)par_read_pipe(poffset, TRUE);
3377 /* Put the data count and return path into globals, mark the data slot unused,
3378 decrement the count of subprocesses, and return the address chain. */
3380 transport_count = parlist[poffset].transport_count;
3381 used_return_path = parlist[poffset].return_path;
3382 parlist[poffset].pid = 0;
3389 /*************************************************
3390 * Wait for subprocesses and post-process *
3391 *************************************************/
3393 /* This function waits for subprocesses until the number that are still running
3394 is below a given threshold. For each complete subprocess, the addresses are
3395 post-processed. If we can't find a running process, there is some shambles.
3396 Better not bomb out, as that might lead to multiple copies of the message. Just
3397 log and proceed as if all done.
3400 max maximum number of subprocesses to leave running
3401 fallback TRUE if processing fallback hosts
3407 par_reduce(int max, BOOL fallback)
3409 while (parcount > max)
3411 address_item *doneaddr = par_wait();
3412 if (doneaddr == NULL)
3414 log_write(0, LOG_MAIN|LOG_PANIC,
3415 "remote delivery process count got out of step");
3418 else remote_post_process(doneaddr, LOG_MAIN, NULL, fallback);
3425 /*************************************************
3426 * Do remote deliveries *
3427 *************************************************/
3429 /* This function is called to process the addresses in addr_remote. We must
3430 pick off the queue all addresses that have the same transport, remote
3431 destination, and errors address, and hand them to the transport in one go,
3432 subject to some configured limitations. If this is a run to continue delivering
3433 to an existing delivery channel, skip all but those addresses that can go to
3434 that channel. The skipped addresses just get deferred.
3436 If mua_wrapper is set, all addresses must be able to be sent in a single
3437 transaction. If not, this function yields FALSE.
3439 In Exim 4, remote deliveries are always done in separate processes, even
3440 if remote_max_parallel = 1 or if there's only one delivery to do. The reason
3441 is so that the base process can retain privilege. This makes the
3442 implementation of fallback transports feasible (though not initially done.)
3444 We create up to the configured number of subprocesses, each of which passes
3445 back the delivery state via a pipe. (However, when sending down an existing
3446 connection, remote_max_parallel is forced to 1.)
3449 fallback TRUE if processing fallback hosts
3451 Returns: TRUE normally
3452 FALSE if mua_wrapper is set and the addresses cannot all be sent
3457 do_remote_deliveries(BOOL fallback)
3463 parcount = 0; /* Number of executing subprocesses */
3465 /* When sending down an existing channel, only do one delivery at a time.
3466 We use a local variable (parmax) to hold the maximum number of processes;
3467 this gets reduced from remote_max_parallel if we can't create enough pipes. */
3469 if (continue_transport != NULL) remote_max_parallel = 1;
3470 parmax = remote_max_parallel;
3472 /* If the data for keeping a list of processes hasn't yet been
3475 if (parlist == NULL)
3477 parlist = store_get(remote_max_parallel * sizeof(pardata));
3478 for (poffset = 0; poffset < remote_max_parallel; poffset++)
3479 parlist[poffset].pid = 0;
3482 /* Now loop for each remote delivery */
3484 for (delivery_count = 0; addr_remote != NULL; delivery_count++)
3490 int address_count = 1;
3491 int address_count_max;
3493 BOOL use_initgroups;
3494 BOOL pipe_done = FALSE;
3495 transport_instance *tp;
3496 address_item **anchor = &addr_remote;
3497 address_item *addr = addr_remote;
3498 address_item *last = addr;
3501 /* Pull the first address right off the list. */
3503 addr_remote = addr->next;
3506 DEBUG(D_deliver|D_transport)
3507 debug_printf("--------> %s <--------\n", addr->address);
3509 /* If no transport has been set, there has been a big screw-up somewhere. */
3511 if ((tp = addr->transport) == NULL)
3513 disable_logging = FALSE; /* Jic */
3514 remote_post_process(addr, LOG_MAIN|LOG_PANIC,
3515 US"No transport set by router", fallback);
3519 /* Check that this base address hasn't previously been delivered to this
3520 transport. The check is necessary at this point to handle homonymic addresses
3521 correctly in cases where the pattern of redirection changes between delivery
3522 attempts. Non-homonymic previous delivery is detected earlier, at routing
3525 if (previously_transported(addr, FALSE)) continue;
3527 /* Force failure if the message is too big. */
3529 if (tp->message_size_limit != NULL)
3531 int rc = check_message_size(tp, addr);
3534 addr->transport_return = rc;
3535 remote_post_process(addr, LOG_MAIN, NULL, fallback);
3540 /* Get the flag which specifies whether the transport can handle different
3541 domains that nevertheless resolve to the same set of hosts. */
3543 multi_domain = tp->multi_domain;
3545 /* Get the maximum it can handle in one envelope, with zero meaning
3546 unlimited, which is forced for the MUA wrapper case. */
3548 address_count_max = tp->max_addresses;
3549 if (address_count_max == 0 || mua_wrapper) address_count_max = 999999;
3552 /************************************************************************/
3553 /***** This is slightly experimental code, but should be safe. *****/
3555 /* The address_count_max value is the maximum number of addresses that the
3556 transport can send in one envelope. However, the transport must be capable of
3557 dealing with any number of addresses. If the number it gets exceeds its
3558 envelope limitation, it must send multiple copies of the message. This can be
3559 done over a single connection for SMTP, so uses less resources than making
3560 multiple connections. On the other hand, if remote_max_parallel is greater
3561 than one, it is perhaps a good idea to use parallel processing to move the
3562 message faster, even if that results in multiple simultaneous connections to
3565 How can we come to some compromise between these two ideals? What we do is to
3566 limit the number of addresses passed to a single instance of a transport to
3567 the greater of (a) its address limit (rcpt_max for SMTP) and (b) the total
3568 number of addresses routed to remote transports divided by
3569 remote_max_parallel. For example, if the message has 100 remote recipients,
3570 remote max parallel is 2, and rcpt_max is 10, we'd never send more than 50 at
3571 once. But if rcpt_max is 100, we could send up to 100.
3573 Of course, not all the remotely addresses in a message are going to go to the
3574 same set of hosts (except in smarthost configurations), so this is just a
3575 heuristic way of dividing up the work.
3577 Furthermore (1), because this may not be wanted in some cases, and also to
3578 cope with really pathological cases, there is also a limit to the number of
3579 messages that are sent over one connection. This is the same limit that is
3580 used when sending several different messages over the same connection.
3581 Continue_sequence is set when in this situation, to the number sent so
3582 far, including this message.
3584 Furthermore (2), when somebody explicitly sets the maximum value to 1, it
3585 is probably because they are using VERP, in which case they want to pass only
3586 one address at a time to the transport, in order to be able to use
3587 $local_part and $domain in constructing a new return path. We could test for
3588 the use of these variables, but as it is so likely they will be used when the
3589 maximum is 1, we don't bother. Just leave the value alone. */
3591 if (address_count_max != 1 &&
3592 address_count_max < remote_delivery_count/remote_max_parallel)
3594 int new_max = remote_delivery_count/remote_max_parallel;
3595 int message_max = tp->connection_max_messages;
3596 if (connection_max_messages >= 0) message_max = connection_max_messages;
3597 message_max -= continue_sequence - 1;
3598 if (message_max > 0 && new_max > address_count_max * message_max)
3599 new_max = address_count_max * message_max;
3600 address_count_max = new_max;
3603 /************************************************************************/
3606 /* Pick off all addresses which have the same transport, errors address,
3607 destination, and extra headers. In some cases they point to the same host
3608 list, but we also need to check for identical host lists generated from
3609 entirely different domains. The host list pointers can be NULL in the case
3610 where the hosts are defined in the transport. There is also a configured
3611 maximum limit of addresses that can be handled at once (see comments above
3612 for how it is computed). */
3614 while ((next = *anchor) != NULL && address_count < address_count_max)
3616 if ((multi_domain || Ustrcmp(next->domain, addr->domain) == 0)
3618 tp == next->transport
3620 same_hosts(next->host_list, addr->host_list)
3622 same_strings(next->p.errors_address, addr->p.errors_address)
3624 same_headers(next->p.extra_headers, addr->p.extra_headers)
3626 same_ugid(tp, next, addr)
3628 (next->p.remove_headers == addr->p.remove_headers ||
3629 (next->p.remove_headers != NULL &&
3630 addr->p.remove_headers != NULL &&
3631 Ustrcmp(next->p.remove_headers, addr->p.remove_headers) == 0)))
3633 *anchor = next->next;
3635 next->first = addr; /* remember top one (for retry processing) */
3640 else anchor = &(next->next);
3643 /* If we are acting as an MUA wrapper, all addresses must go in a single
3644 transaction. If not, put them back on the chain and yield FALSE. */
3646 if (mua_wrapper && addr_remote != NULL)
3648 last->next = addr_remote;
3653 /* Set up the expansion variables for this set of addresses */
3655 deliver_set_expansions(addr);
3657 /* Compute the return path, expanding a new one if required. The old one
3658 must be set first, as it might be referred to in the expansion. */
3660 if(addr->p.errors_address != NULL)
3661 return_path = addr->p.errors_address;
3662 #ifdef EXPERIMENTAL_SRS
3663 else if(addr->p.srs_sender != NULL)
3664 return_path = addr->p.srs_sender;
3667 return_path = sender_address;
3669 if (tp->return_path != NULL)
3671 uschar *new_return_path = expand_string(tp->return_path);
3672 if (new_return_path == NULL)
3674 if (!expand_string_forcedfail)
3676 remote_post_process(addr, LOG_MAIN|LOG_PANIC,
3677 string_sprintf("Failed to expand return path \"%s\": %s",
3678 tp->return_path, expand_string_message), fallback);
3682 else return_path = new_return_path;
3685 /* Find the uid, gid, and use_initgroups setting for this transport. Failure
3686 logs and sets up error messages, so we just post-process and continue with
3687 the next address. */
3689 if (!findugid(addr, tp, &uid, &gid, &use_initgroups))
3691 remote_post_process(addr, LOG_MAIN|LOG_PANIC, NULL, fallback);
3695 /* If this transport has a setup function, call it now so that it gets
3696 run in this process and not in any subprocess. That way, the results of
3697 any setup that are retained by the transport can be reusable. One of the
3698 things the setup does is to set the fallback host lists in the addresses.
3699 That is why it is called at this point, before the continue delivery
3700 processing, because that might use the fallback hosts. */
3702 if (tp->setup != NULL)
3703 (void)((tp->setup)(addr->transport, addr, NULL, uid, gid, NULL));
3705 /* If this is a run to continue delivery down an already-established
3706 channel, check that this set of addresses matches the transport and
3707 the channel. If it does not, defer the addresses. If a host list exists,
3708 we must check that the continue host is on the list. Otherwise, the
3709 host is set in the transport. */
3711 continue_more = FALSE; /* In case got set for the last lot */
3712 if (continue_transport != NULL)
3714 BOOL ok = Ustrcmp(continue_transport, tp->name) == 0;
3715 if (ok && addr->host_list != NULL)
3719 for (h = addr->host_list; h != NULL; h = h->next)
3721 if (Ustrcmp(h->name, continue_hostname) == 0)
3722 { ok = TRUE; break; }
3726 /* Addresses not suitable; defer or queue for fallback hosts (which
3727 might be the continue host) and skip to next address. */
3731 DEBUG(D_deliver) debug_printf("not suitable for continue_transport\n");
3734 if (addr->fallback_hosts != NULL && !fallback)
3738 next->host_list = next->fallback_hosts;
3739 DEBUG(D_deliver) debug_printf("%s queued for fallback host(s)\n", next->address);
3740 if (next->next == NULL) break;
3743 next->next = addr_fallback;
3744 addr_fallback = addr;
3749 while (next->next != NULL) next = next->next;
3750 next->next = addr_defer;
3757 /* Set a flag indicating whether there are further addresses that list
3758 the continued host. This tells the transport to leave the channel open,
3759 but not to pass it to another delivery process. */
3761 for (next = addr_remote; next != NULL; next = next->next)
3764 for (h = next->host_list; h != NULL; h = h->next)
3766 if (Ustrcmp(h->name, continue_hostname) == 0)
3767 { continue_more = TRUE; break; }
3772 /* The transports set up the process info themselves as they may connect
3773 to more than one remote machine. They also have to set up the filter
3774 arguments, if required, so that the host name and address are available
3777 transport_filter_argv = NULL;
3779 /* Create the pipe for inter-process communication. If pipe creation
3780 fails, it is probably because the value of remote_max_parallel is so
3781 large that too many file descriptors for pipes have been created. Arrange
3782 to wait for a process to finish, and then try again. If we still can't
3783 create a pipe when all processes have finished, break the retry loop. */
3787 if (pipe(pfd) == 0) pipe_done = TRUE;
3788 else if (parcount > 0) parmax = parcount;
3791 /* We need to make the reading end of the pipe non-blocking. There are
3792 two different options for this. Exim is cunningly (I hope!) coded so
3793 that it can use either of them, though it prefers O_NONBLOCK, which
3794 distinguishes between EOF and no-more-data. */
3797 (void)fcntl(pfd[pipe_read], F_SETFL, O_NONBLOCK);
3799 (void)fcntl(pfd[pipe_read], F_SETFL, O_NDELAY);
3802 /* If the maximum number of subprocesses already exist, wait for a process
3803 to finish. If we ran out of file descriptors, parmax will have been reduced
3804 from its initial value of remote_max_parallel. */
3806 par_reduce(parmax - 1, fallback);
3809 /* If we failed to create a pipe and there were no processes to wait
3810 for, we have to give up on this one. Do this outside the above loop
3811 so that we can continue the main loop. */
3815 remote_post_process(addr, LOG_MAIN|LOG_PANIC,
3816 string_sprintf("unable to create pipe: %s", strerror(errno)), fallback);
3820 /* Find a free slot in the pardata list. Must do this after the possible
3821 waiting for processes to finish, because a terminating process will free
3824 for (poffset = 0; poffset < remote_max_parallel; poffset++)
3825 if (parlist[poffset].pid == 0) break;
3827 /* If there isn't one, there has been a horrible disaster. */
3829 if (poffset >= remote_max_parallel)
3831 (void)close(pfd[pipe_write]);
3832 (void)close(pfd[pipe_read]);
3833 remote_post_process(addr, LOG_MAIN|LOG_PANIC,
3834 US"Unexpectedly no free subprocess slot", fallback);
3838 /* Now fork a subprocess to do the remote delivery, but before doing so,
3839 ensure that any cached resourses are released so as not to interfere with
3840 what happens in the subprocess. */
3844 if ((pid = fork()) == 0)
3846 int fd = pfd[pipe_write];
3849 /* There are weird circumstances in which logging is disabled */
3851 disable_logging = tp->disable_logging;
3853 /* Show pids on debug output if parallelism possible */
3855 if (parmax > 1 && (parcount > 0 || addr_remote != NULL))
3857 DEBUG(D_any|D_v) debug_selector |= D_pid;
3858 DEBUG(D_deliver) debug_printf("Remote delivery process started\n");
3861 /* Reset the random number generator, so different processes don't all
3862 have the same sequence. In the test harness we want different, but
3863 predictable settings for each delivery process, so do something explicit
3864 here rather they rely on the fixed reset in the random number function. */
3866 random_seed = running_in_test_harness? 42 + 2*delivery_count : 0;
3868 /* Set close-on-exec on the pipe so that it doesn't get passed on to
3869 a new process that may be forked to do another delivery down the same
3872 (void)fcntl(fd, F_SETFD, fcntl(fd, F_GETFD) | FD_CLOEXEC);
3874 /* Close open file descriptors for the pipes of other processes
3875 that are running in parallel. */
3877 for (poffset = 0; poffset < remote_max_parallel; poffset++)
3878 if (parlist[poffset].pid != 0) (void)close(parlist[poffset].fd);
3880 /* This process has inherited a copy of the file descriptor
3881 for the data file, but its file pointer is shared with all the
3882 other processes running in parallel. Therefore, we have to re-open
3883 the file in order to get a new file descriptor with its own
3884 file pointer. We don't need to lock it, as the lock is held by
3885 the parent process. There doesn't seem to be any way of doing
3886 a dup-with-new-file-pointer. */
3888 (void)close(deliver_datafile);
3889 sprintf(CS spoolname, "%s/input/%s/%s-D", spool_directory, message_subdir,
3891 deliver_datafile = Uopen(spoolname, O_RDWR | O_APPEND, 0);
3893 if (deliver_datafile < 0)
3894 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Failed to reopen %s for remote "
3895 "parallel delivery: %s", spoolname, strerror(errno));
3897 /* Set the close-on-exec flag */
3899 (void)fcntl(deliver_datafile, F_SETFD, fcntl(deliver_datafile, F_GETFD) |
3902 /* Set the uid/gid of this process; bombs out on failure. */
3904 exim_setugid(uid, gid, use_initgroups,
3905 string_sprintf("remote delivery to %s with transport=%s",
3906 addr->address, tp->name));
3908 /* Close the unwanted half of this process' pipe, set the process state,
3909 and run the transport. Afterwards, transport_count will contain the number
3910 of bytes written. */
3912 (void)close(pfd[pipe_read]);
3913 set_process_info("delivering %s using %s", message_id, tp->name);
3914 debug_print_string(tp->debug_string);
3915 if (!(tp->info->code)(addr->transport, addr)) replicate_status(addr);
3917 set_process_info("delivering %s (just run %s for %s%s in subprocess)",
3918 message_id, tp->name, addr->address, (addr->next == NULL)? "" : ", ...");
3920 /* Ensure any cached resources that we used are now released */
3924 /* Pass the result back down the pipe. This is a lot more information
3925 than is needed for a local delivery. We have to send back the error
3926 status for each address, the usability status for each host that is
3927 flagged as unusable, and all the retry items. When TLS is in use, we
3928 send also the cipher and peerdn information. Each type of information
3929 is flagged by an identifying byte, and is then in a fixed format (with
3930 strings terminated by zeros), and there is a final terminator at the
3931 end. The host information and retry information is all attached to
3932 the first address, so that gets sent at the start. */
3934 /* Host unusability information: for most success cases this will
3937 for (h = addr->host_list; h != NULL; h = h->next)
3939 if (h->address == NULL || h->status < hstatus_unusable) continue;
3940 sprintf(CS big_buffer, "H%c%c%s", h->status, h->why, h->address);
3941 (void)write(fd, big_buffer, Ustrlen(big_buffer+3) + 4);
3944 /* The number of bytes written. This is the same for each address. Even
3945 if we sent several copies of the message down the same connection, the
3946 size of each one is the same, and it's that value we have got because
3947 transport_count gets reset before calling transport_write_message(). */
3949 big_buffer[0] = 'S';
3950 memcpy(big_buffer+1, &transport_count, sizeof(transport_count));
3951 (void)write(fd, big_buffer, sizeof(transport_count) + 1);
3953 /* Information about what happened to each address. Three item types are
3954 used: an optional 'X' item first, for TLS information, followed by 'R'
3955 items for any retry settings, and finally an 'A' item for the remaining
3958 for(; addr != NULL; addr = addr->next)
3963 /* The certificate verification status goes into the flags */
3965 if (tls_out.certificate_verified) setflag(addr, af_cert_verified);
3967 /* Use an X item only if there's something to send */
3970 if (addr->cipher != NULL)
3974 sprintf(CS ptr, "%.128s", addr->cipher);
3976 if (addr->peerdn == NULL) *ptr++ = 0; else
3978 sprintf(CS ptr, "%.512s", addr->peerdn);
3981 (void)write(fd, big_buffer, ptr - big_buffer);
3985 /* Retry information: for most success cases this will be null. */
3987 for (r = addr->retries; r != NULL; r = r->next)
3990 sprintf(CS big_buffer, "R%c%.500s", r->flags, r->key);
3991 ptr = big_buffer + Ustrlen(big_buffer+2) + 3;
3992 memcpy(ptr, &(r->basic_errno), sizeof(r->basic_errno));
3993 ptr += sizeof(r->basic_errno);
3994 memcpy(ptr, &(r->more_errno), sizeof(r->more_errno));
3995 ptr += sizeof(r->more_errno);
3996 if (r->message == NULL) *ptr++ = 0; else
3998 sprintf(CS ptr, "%.512s", r->message);
4001 (void)write(fd, big_buffer, ptr - big_buffer);
4004 /* The rest of the information goes in an 'A' item. */
4006 ptr = big_buffer + 3;
4007 sprintf(CS big_buffer, "A%c%c", addr->transport_return,
4008 addr->special_action);
4009 memcpy(ptr, &(addr->basic_errno), sizeof(addr->basic_errno));
4010 ptr += sizeof(addr->basic_errno);
4011 memcpy(ptr, &(addr->more_errno), sizeof(addr->more_errno));
4012 ptr += sizeof(addr->more_errno);
4013 memcpy(ptr, &(addr->flags), sizeof(addr->flags));
4014 ptr += sizeof(addr->flags);
4016 if (addr->message == NULL) *ptr++ = 0; else
4018 sprintf(CS ptr, "%.1024s", addr->message);
4022 if (addr->user_message == NULL) *ptr++ = 0; else
4024 sprintf(CS ptr, "%.1024s", addr->user_message);
4028 if (addr->host_used == NULL) *ptr++ = 0; else
4030 sprintf(CS ptr, "%.256s", addr->host_used->name);
4032 sprintf(CS ptr, "%.64s", addr->host_used->address);
4034 memcpy(ptr, &(addr->host_used->port), sizeof(addr->host_used->port));
4035 ptr += sizeof(addr->host_used->port);
4037 (void)write(fd, big_buffer, ptr - big_buffer);
4040 /* Add termination flag, close the pipe, and that's it. The character
4041 after 'Z' indicates whether continue_transport is now NULL or not.
4042 A change from non-NULL to NULL indicates a problem with a continuing
4045 big_buffer[0] = 'Z';
4046 big_buffer[1] = (continue_transport == NULL)? '0' : '1';
4047 (void)write(fd, big_buffer, 2);
4052 /* Back in the mainline: close the unwanted half of the pipe. */
4054 (void)close(pfd[pipe_write]);
4056 /* Fork failed; defer with error message */
4060 (void)close(pfd[pipe_read]);
4061 remote_post_process(addr, LOG_MAIN|LOG_PANIC,
4062 string_sprintf("fork failed for remote delivery to %s: %s",
4063 addr->domain, strerror(errno)), fallback);
4067 /* Fork succeeded; increment the count, and remember relevant data for
4068 when the process finishes. */
4071 parlist[poffset].addrlist = parlist[poffset].addr = addr;
4072 parlist[poffset].pid = pid;
4073 parlist[poffset].fd = pfd[pipe_read];
4074 parlist[poffset].done = FALSE;
4075 parlist[poffset].msg = NULL;
4076 parlist[poffset].return_path = return_path;
4078 /* If the process we've just started is sending a message down an existing
4079 channel, wait for it now. This ensures that only one such process runs at
4080 once, whatever the value of remote_max parallel. Otherwise, we might try to
4081 send two or more messages simultaneously down the same channel. This could
4082 happen if there are different domains that include the same host in otherwise
4083 different host lists.
4085 Also, if the transport closes down the channel, this information gets back
4086 (continue_transport gets set to NULL) before we consider any other addresses
4089 if (continue_transport != NULL) par_reduce(0, fallback);
4091 /* Otherwise, if we are running in the test harness, wait a bit, to let the
4092 newly created process get going before we create another process. This should
4093 ensure repeatability in the tests. We only need to wait a tad. */
4095 else if (running_in_test_harness) millisleep(500);
4098 /* Reached the end of the list of addresses. Wait for all the subprocesses that
4099 are still running and post-process their addresses. */
4101 par_reduce(0, fallback);
4108 /*************************************************
4109 * Split an address into local part and domain *
4110 *************************************************/
4112 /* This function initializes an address for routing by splitting it up into a
4113 local part and a domain. The local part is set up twice - once in its original
4114 casing, and once in lower case, and it is dequoted. We also do the "percent
4115 hack" for configured domains. This may lead to a DEFER result if a lookup
4116 defers. When a percent-hacking takes place, we insert a copy of the original
4117 address as a new parent of this address, as if we have had a redirection.
4120 addr points to an addr_item block containing the address
4123 DEFER - could not determine if domain is %-hackable
4127 deliver_split_address(address_item *addr)
4129 uschar *address = addr->address;
4130 uschar *domain = Ustrrchr(address, '@');
4132 int len = domain - address;
4134 addr->domain = string_copylc(domain+1); /* Domains are always caseless */
4136 /* The implication in the RFCs (though I can't say I've seen it spelled out
4137 explicitly) is that quoting should be removed from local parts at the point
4138 where they are locally interpreted. [The new draft "821" is more explicit on
4139 this, Jan 1999.] We know the syntax is valid, so this can be done by simply
4140 removing quoting backslashes and any unquoted doublequotes. */
4142 t = addr->cc_local_part = store_get(len+1);
4145 register int c = *address++;
4146 if (c == '\"') continue;
4156 /* We do the percent hack only for those domains that are listed in
4157 percent_hack_domains. A loop is required, to copy with multiple %-hacks. */
4159 if (percent_hack_domains != NULL)
4162 uschar *new_address = NULL;
4163 uschar *local_part = addr->cc_local_part;
4165 deliver_domain = addr->domain; /* set $domain */
4167 while ((rc = match_isinlist(deliver_domain, &percent_hack_domains, 0,
4168 &domainlist_anchor, addr->domain_cache, MCL_DOMAIN, TRUE, NULL))
4170 (t = Ustrrchr(local_part, '%')) != NULL)
4172 new_address = string_copy(local_part);
4173 new_address[t - local_part] = '@';
4174 deliver_domain = string_copylc(t+1);
4175 local_part = string_copyn(local_part, t - local_part);
4178 if (rc == DEFER) return DEFER; /* lookup deferred */
4180 /* If hackery happened, set up new parent and alter the current address. */
4182 if (new_address != NULL)
4184 address_item *new_parent = store_get(sizeof(address_item));
4185 *new_parent = *addr;
4186 addr->parent = new_parent;
4187 addr->address = new_address;
4188 addr->unique = string_copy(new_address);
4189 addr->domain = deliver_domain;
4190 addr->cc_local_part = local_part;
4191 DEBUG(D_deliver) debug_printf("%%-hack changed address to: %s\n",
4196 /* Create the lowercased version of the final local part, and make that the
4197 default one to be used. */
4199 addr->local_part = addr->lc_local_part = string_copylc(addr->cc_local_part);
4206 /*************************************************
4207 * Get next error message text *
4208 *************************************************/
4210 /* If f is not NULL, read the next "paragraph", from a customized error message
4211 text file, terminated by a line containing ****, and expand it.
4214 f NULL or a file to read from
4215 which string indicating which string (for errors)
4217 Returns: NULL or an expanded string
4221 next_emf(FILE *f, uschar *which)
4225 uschar *para, *yield;
4228 if (f == NULL) return NULL;
4230 if (Ufgets(buffer, sizeof(buffer), f) == NULL ||
4231 Ustrcmp(buffer, "****\n") == 0) return NULL;
4233 para = store_get(size);
4236 para = string_cat(para, &size, &ptr, buffer, Ustrlen(buffer));
4237 if (Ufgets(buffer, sizeof(buffer), f) == NULL ||
4238 Ustrcmp(buffer, "****\n") == 0) break;
4242 yield = expand_string(para);
4243 if (yield != NULL) return yield;
4245 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand string from "
4246 "bounce_message_file or warn_message_file (%s): %s", which,
4247 expand_string_message);
4254 /*************************************************
4255 * Close down a passed transport channel *
4256 *************************************************/
4258 /* This function is called when a passed transport channel cannot be used.
4259 It attempts to close it down tidily. The yield is always DELIVER_NOT_ATTEMPTED
4260 so that the function call can be the argument of a "return" statement.
4263 Returns: DELIVER_NOT_ATTEMPTED
4267 continue_closedown(void)
4269 if (continue_transport != NULL)
4271 transport_instance *t;
4272 for (t = transports; t != NULL; t = t->next)
4274 if (Ustrcmp(t->name, continue_transport) == 0)
4276 if (t->info->closedown != NULL) (t->info->closedown)(t);
4281 return DELIVER_NOT_ATTEMPTED;
4287 /*************************************************
4288 * Print address information *
4289 *************************************************/
4291 /* This function is called to output an address, or information about an
4292 address, for bounce or defer messages. If the hide_child flag is set, all we
4293 output is the original ancestor address.
4296 addr points to the address
4297 f the FILE to print to
4298 si an initial string
4299 sc a continuation string for before "generated"
4302 Returns: TRUE if the address is not hidden
4306 print_address_information(address_item *addr, FILE *f, uschar *si, uschar *sc,
4310 uschar *printed = US"";
4311 address_item *ancestor = addr;
4312 while (ancestor->parent != NULL) ancestor = ancestor->parent;
4314 fprintf(f, "%s", CS si);
4316 if (addr->parent != NULL && testflag(addr, af_hide_child))
4318 printed = US"an undisclosed address";
4321 else if (!testflag(addr, af_pfr) || addr->parent == NULL)
4322 printed = addr->address;
4326 uschar *s = addr->address;
4329 if (addr->address[0] == '>') { ss = US"mail"; s++; }
4330 else if (addr->address[0] == '|') ss = US"pipe";
4333 fprintf(f, "%s to %s%sgenerated by ", ss, s, sc);
4334 printed = addr->parent->address;
4337 fprintf(f, "%s", CS string_printing(printed));
4339 if (ancestor != addr)
4341 uschar *original = (ancestor->onetime_parent == NULL)?
4342 ancestor->address : ancestor->onetime_parent;
4343 if (strcmpic(original, printed) != 0)
4344 fprintf(f, "%s(%sgenerated from %s)", sc,
4345 (ancestor != addr->parent)? "ultimately " : "",
4346 string_printing(original));
4349 fprintf(f, "%s", CS se);
4357 /*************************************************
4358 * Print error for an address *
4359 *************************************************/
4361 /* This function is called to print the error information out of an address for
4362 a bounce or a warning message. It tries to format the message reasonably by
4363 introducing newlines. All lines are indented by 4; the initial printing
4364 position must be set before calling.
4366 This function used always to print the error. Nowadays we want to restrict it
4367 to cases such as LMTP/SMTP errors from a remote host, and errors from :fail:
4368 and filter "fail". We no longer pass other information willy-nilly in bounce
4369 and warning messages. Text in user_message is always output; text in message
4370 only if the af_pass_message flag is set.
4374 f the FILE to print on
4381 print_address_error(address_item *addr, FILE *f, uschar *t)
4383 int count = Ustrlen(t);
4384 uschar *s = testflag(addr, af_pass_message)? addr->message : NULL;
4388 if (addr->user_message != NULL) s = addr->user_message; else return;
4391 fprintf(f, "\n %s", t);
4395 if (*s == '\\' && s[1] == 'n')
4405 if (*s++ == ':' && isspace(*s) && count > 45)
4407 fprintf(f, "\n "); /* sic (because space follows) */
4419 /*************************************************
4420 * Check list of addresses for duplication *
4421 *************************************************/
4423 /* This function was introduced when the test for duplicate addresses that are
4424 not pipes, files, or autoreplies was moved from the middle of routing to when
4425 routing was complete. That was to fix obscure cases when the routing history
4426 affects the subsequent routing of identical addresses. This function is called
4427 after routing, to check that the final routed addresses are not duplicates.
4429 If we detect a duplicate, we remember what it is a duplicate of. Note that
4430 pipe, file, and autoreply de-duplication is handled during routing, so we must
4431 leave such "addresses" alone here, as otherwise they will incorrectly be
4434 Argument: address of list anchor
4439 do_duplicate_check(address_item **anchor)
4442 while ((addr = *anchor) != NULL)
4445 if (testflag(addr, af_pfr))
4447 anchor = &(addr->next);
4449 else if ((tnode = tree_search(tree_duplicates, addr->unique)) != NULL)
4451 DEBUG(D_deliver|D_route)
4452 debug_printf("%s is a duplicate address: discarded\n", addr->unique);
4453 *anchor = addr->next;
4454 addr->dupof = tnode->data.ptr;
4455 addr->next = addr_duplicate;
4456 addr_duplicate = addr;
4460 tree_add_duplicate(addr->unique, addr);
4461 anchor = &(addr->next);
4469 /*************************************************
4470 * Deliver one message *
4471 *************************************************/
4473 /* This is the function which is called when a message is to be delivered. It
4474 is passed the id of the message. It is possible that the message no longer
4475 exists, if some other process has delivered it, and it is also possible that
4476 the message is being worked on by another process, in which case the data file
4479 If no delivery is attempted for any of the above reasons, the function returns
4480 DELIVER_NOT_ATTEMPTED.
4482 If the give_up flag is set true, do not attempt any deliveries, but instead
4483 fail all outstanding addresses and return the message to the sender (or
4486 A delivery operation has a process all to itself; we never deliver more than
4487 one message in the same process. Therefore we needn't worry too much about
4491 id the id of the message to be delivered
4492 forced TRUE if delivery was forced by an administrator; this overrides
4493 retry delays and causes a delivery to be tried regardless
4494 give_up TRUE if an administrator has requested that delivery attempts
4497 Returns: When the global variable mua_wrapper is FALSE:
4498 DELIVER_ATTEMPTED_NORMAL if a delivery attempt was made
4499 DELIVER_NOT_ATTEMPTED otherwise (see comment above)
4500 When the global variable mua_wrapper is TRUE:
4501 DELIVER_MUA_SUCCEEDED if delivery succeeded
4502 DELIVER_MUA_FAILED if delivery failed
4503 DELIVER_NOT_ATTEMPTED if not attempted (should not occur)
4507 deliver_message(uschar *id, BOOL forced, BOOL give_up)
4510 int final_yield = DELIVER_ATTEMPTED_NORMAL;
4511 time_t now = time(NULL);
4512 address_item *addr_last = NULL;
4513 uschar *filter_message = NULL;
4515 int process_recipients = RECIP_ACCEPT;
4518 extern int acl_where;
4520 uschar *info = (queue_run_pid == (pid_t)0)?
4521 string_sprintf("delivering %s", id) :
4522 string_sprintf("delivering %s (queue run pid %d)", id, queue_run_pid);
4524 /* If the D_process_info bit is on, set_process_info() will output debugging
4525 information. If not, we want to show this initial information if D_deliver or
4526 D_queue_run is set or in verbose mode. */
4528 set_process_info("%s", info);
4530 if ((debug_selector & D_process_info) == 0 &&
4531 (debug_selector & (D_deliver|D_queue_run|D_v)) != 0)
4532 debug_printf("%s\n", info);
4534 /* Ensure that we catch any subprocesses that are created. Although Exim
4535 sets SIG_DFL as its initial default, some routes through the code end up
4536 here with it set to SIG_IGN - cases where a non-synchronous delivery process
4537 has been forked, but no re-exec has been done. We use sigaction rather than
4538 plain signal() on those OS where SA_NOCLDWAIT exists, because we want to be
4539 sure it is turned off. (There was a problem on AIX with this.) */
4543 struct sigaction act;
4544 act.sa_handler = SIG_DFL;
4545 sigemptyset(&(act.sa_mask));
4547 sigaction(SIGCHLD, &act, NULL);
4550 signal(SIGCHLD, SIG_DFL);
4553 /* Make the forcing flag available for routers and transports, set up the
4554 global message id field, and initialize the count for returned files and the
4555 message size. This use of strcpy() is OK because the length id is checked when
4556 it is obtained from a command line (the -M or -q options), and otherwise it is
4557 known to be a valid message id. */
4559 Ustrcpy(message_id, id);
4560 deliver_force = forced;
4564 /* Initialize some flags */
4566 update_spool = FALSE;
4567 remove_journal = TRUE;
4569 /* Set a known context for any ACLs we call via expansions */
4570 acl_where = ACL_WHERE_DELIVERY;
4572 /* Reset the random number generator, so that if several delivery processes are
4573 started from a queue runner that has already used random numbers (for sorting),
4574 they don't all get the same sequence. */
4578 /* Open and lock the message's data file. Exim locks on this one because the
4579 header file may get replaced as it is re-written during the delivery process.
4580 Any failures cause messages to be written to the log, except for missing files
4581 while queue running - another process probably completed delivery. As part of
4582 opening the data file, message_subdir gets set. */
4584 if (!spool_open_datafile(id))
4585 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
4587 /* The value of message_size at this point has been set to the data length,
4588 plus one for the blank line that notionally precedes the data. */
4590 /* Now read the contents of the header file, which will set up the headers in
4591 store, and also the list of recipients and the tree of non-recipients and
4592 assorted flags. It updates message_size. If there is a reading or format error,
4593 give up; if the message has been around for sufficiently long, remove it. */
4595 sprintf(CS spoolname, "%s-H", id);
4596 if ((rc = spool_read_header(spoolname, TRUE, TRUE)) != spool_read_OK)
4598 if (errno == ERRNO_SPOOLFORMAT)
4600 struct stat statbuf;
4601 sprintf(CS big_buffer, "%s/input/%s/%s", spool_directory, message_subdir,
4603 if (Ustat(big_buffer, &statbuf) == 0)
4604 log_write(0, LOG_MAIN, "Format error in spool file %s: "
4605 "size=" OFF_T_FMT, spoolname, statbuf.st_size);
4606 else log_write(0, LOG_MAIN, "Format error in spool file %s", spoolname);
4609 log_write(0, LOG_MAIN, "Error reading spool file %s: %s", spoolname,
4612 /* If we managed to read the envelope data, received_time contains the
4613 time the message was received. Otherwise, we can calculate it from the
4616 if (rc != spool_read_hdrerror)
4619 for (i = 0; i < 6; i++)
4620 received_time = received_time * BASE_62 + tab62[id[i] - '0'];
4623 /* If we've had this malformed message too long, sling it. */
4625 if (now - received_time > keep_malformed)
4627 sprintf(CS spoolname, "%s/msglog/%s/%s", spool_directory, message_subdir, id);
4629 sprintf(CS spoolname, "%s/input/%s/%s-D", spool_directory, message_subdir, id);
4631 sprintf(CS spoolname, "%s/input/%s/%s-H", spool_directory, message_subdir, id);
4633 sprintf(CS spoolname, "%s/input/%s/%s-J", spool_directory, message_subdir, id);
4635 log_write(0, LOG_MAIN, "Message removed because older than %s",
4636 readconf_printtime(keep_malformed));
4639 (void)close(deliver_datafile);
4640 deliver_datafile = -1;
4641 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
4644 /* The spool header file has been read. Look to see if there is an existing
4645 journal file for this message. If there is, it means that a previous delivery
4646 attempt crashed (program or host) before it could update the spool header file.
4647 Read the list of delivered addresses from the journal and add them to the
4648 nonrecipients tree. Then update the spool file. We can leave the journal in
4649 existence, as it will get further successful deliveries added to it in this
4650 run, and it will be deleted if this function gets to its end successfully.
4651 Otherwise it might be needed again. */
4653 sprintf(CS spoolname, "%s/input/%s/%s-J", spool_directory, message_subdir, id);
4654 jread = Ufopen(spoolname, "rb");
4657 while (Ufgets(big_buffer, big_buffer_size, jread) != NULL)
4659 int n = Ustrlen(big_buffer);
4660 big_buffer[n-1] = 0;
4661 tree_add_nonrecipient(big_buffer);
4662 DEBUG(D_deliver) debug_printf("Previously delivered address %s taken from "
4663 "journal file\n", big_buffer);
4665 (void)fclose(jread);
4666 /* Panic-dies on error */
4667 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
4669 else if (errno != ENOENT)
4671 log_write(0, LOG_MAIN|LOG_PANIC, "attempt to open journal for reading gave: "
4672 "%s", strerror(errno));
4673 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
4676 /* A null recipients list indicates some kind of disaster. */
4678 if (recipients_list == NULL)
4680 (void)close(deliver_datafile);
4681 deliver_datafile = -1;
4682 log_write(0, LOG_MAIN, "Spool error: no recipients for %s", spoolname);
4683 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
4687 /* Handle a message that is frozen. There are a number of different things that
4688 can happen, but in the default situation, unless forced, no delivery is
4693 #ifdef SUPPORT_MOVE_FROZEN_MESSAGES
4694 /* Moving to another directory removes the message from Exim's view. Other
4695 tools must be used to deal with it. Logging of this action happens in
4696 spool_move_message() and its subfunctions. */
4698 if (move_frozen_messages &&
4699 spool_move_message(id, message_subdir, US"", US"F"))
4700 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
4703 /* For all frozen messages (bounces or not), timeout_frozen_after sets the
4704 maximum time to keep messages that are frozen. Thaw if we reach it, with a
4705 flag causing all recipients to be failed. The time is the age of the
4706 message, not the time since freezing. */
4708 if (timeout_frozen_after > 0 && message_age >= timeout_frozen_after)
4710 log_write(0, LOG_MAIN, "cancelled by timeout_frozen_after");
4711 process_recipients = RECIP_FAIL_TIMEOUT;
4714 /* For bounce messages (and others with no sender), thaw if the error message
4715 ignore timer is exceeded. The message will be discarded if this delivery
4718 else if (sender_address[0] == 0 && message_age >= ignore_bounce_errors_after)
4720 log_write(0, LOG_MAIN, "Unfrozen by errmsg timer");
4723 /* If this is a bounce message, or there's no auto thaw, or we haven't
4724 reached the auto thaw time yet, and this delivery is not forced by an admin
4725 user, do not attempt delivery of this message. Note that forced is set for
4726 continuing messages down the same channel, in order to skip load checking and
4727 ignore hold domains, but we don't want unfreezing in that case. */
4731 if ((sender_address[0] == 0 ||
4733 now <= deliver_frozen_at + auto_thaw
4736 (!forced || !deliver_force_thaw || !admin_user ||
4737 continue_hostname != NULL
4740 (void)close(deliver_datafile);
4741 deliver_datafile = -1;
4742 log_write(L_skip_delivery, LOG_MAIN, "Message is frozen");
4743 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
4746 /* If delivery was forced (by an admin user), assume a manual thaw.
4747 Otherwise it's an auto thaw. */
4751 deliver_manual_thaw = TRUE;
4752 log_write(0, LOG_MAIN, "Unfrozen by forced delivery");
4754 else log_write(0, LOG_MAIN, "Unfrozen by auto-thaw");
4757 /* We get here if any of the rules for unfreezing have triggered. */
4759 deliver_freeze = FALSE;
4760 update_spool = TRUE;
4764 /* Open the message log file if we are using them. This records details of
4765 deliveries, deferments, and failures for the benefit of the mail administrator.
4766 The log is not used by exim itself to track the progress of a message; that is
4767 done by rewriting the header spool file. */
4774 sprintf(CS spoolname, "%s/msglog/%s/%s", spool_directory, message_subdir, id);
4775 fd = open_msglog_file(spoolname, SPOOL_MODE, &error);
4779 log_write(0, LOG_MAIN|LOG_PANIC, "Couldn't %s message log %s: %s", error,
4780 spoolname, strerror(errno));
4781 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
4784 /* Make a C stream out of it. */
4786 message_log = fdopen(fd, "a");
4787 if (message_log == NULL)
4789 log_write(0, LOG_MAIN|LOG_PANIC, "Couldn't fdopen message log %s: %s",
4790 spoolname, strerror(errno));
4791 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
4796 /* If asked to give up on a message, log who did it, and set the action for all
4801 struct passwd *pw = getpwuid(real_uid);
4802 log_write(0, LOG_MAIN, "cancelled by %s", (pw != NULL)?
4803 US pw->pw_name : string_sprintf("uid %ld", (long int)real_uid));
4804 process_recipients = RECIP_FAIL;
4807 /* Otherwise, if there are too many Received: headers, fail all recipients. */
4809 else if (received_count > received_headers_max)
4810 process_recipients = RECIP_FAIL_LOOP;
4812 /* Otherwise, if a system-wide, address-independent message filter is
4813 specified, run it now, except in the case when we are failing all recipients as
4814 a result of timeout_frozen_after. If the system filter yields "delivered", then
4815 ignore the true recipients of the message. Failure of the filter file is
4816 logged, and the delivery attempt fails. */
4818 else if (system_filter != NULL && process_recipients != RECIP_FAIL_TIMEOUT)
4823 redirect_block redirect;
4825 if (system_filter_uid_set)
4827 ugid.uid = system_filter_uid;
4828 ugid.gid = system_filter_gid;
4829 ugid.uid_set = ugid.gid_set = TRUE;
4833 ugid.uid_set = ugid.gid_set = FALSE;
4836 return_path = sender_address;
4837 enable_dollar_recipients = TRUE; /* Permit $recipients in system filter */
4838 system_filtering = TRUE;
4840 /* Any error in the filter file causes a delivery to be abandoned. */
4842 redirect.string = system_filter;
4843 redirect.isfile = TRUE;
4844 redirect.check_owner = redirect.check_group = FALSE;
4845 redirect.owners = NULL;
4846 redirect.owngroups = NULL;
4848 redirect.modemask = 0;
4850 DEBUG(D_deliver|D_filter) debug_printf("running system filter\n");
4853 &redirect, /* Where the data is */
4854 RDO_DEFER | /* Turn on all the enabling options */
4855 RDO_FAIL | /* Leave off all the disabling options */
4860 NULL, /* No :include: restriction (not used in filter) */
4861 NULL, /* No sieve vacation directory (not sieve!) */
4862 NULL, /* No sieve enotify mailto owner (not sieve!) */
4863 NULL, /* No sieve user address (not sieve!) */
4864 NULL, /* No sieve subaddress (not sieve!) */
4865 &ugid, /* uid/gid data */
4866 &addr_new, /* Where to hang generated addresses */
4867 &filter_message, /* Where to put error message */
4868 NULL, /* Don't skip syntax errors */
4869 &filtertype, /* Will always be set to FILTER_EXIM for this call */
4870 US"system filter"); /* For error messages */
4872 DEBUG(D_deliver|D_filter) debug_printf("system filter returned %d\n", rc);
4874 if (rc == FF_ERROR || rc == FF_NONEXIST)
4876 (void)close(deliver_datafile);
4877 deliver_datafile = -1;
4878 log_write(0, LOG_MAIN|LOG_PANIC, "Error in system filter: %s",
4879 string_printing(filter_message));
4880 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
4883 /* Reset things. If the filter message is an empty string, which can happen
4884 for a filter "fail" or "freeze" command with no text, reset it to NULL. */
4886 system_filtering = FALSE;
4887 enable_dollar_recipients = FALSE;
4888 if (filter_message != NULL && filter_message[0] == 0) filter_message = NULL;
4890 /* Save the values of the system filter variables so that user filters
4893 memcpy(filter_sn, filter_n, sizeof(filter_sn));
4895 /* The filter can request that delivery of the original addresses be
4900 process_recipients = RECIP_DEFER;
4901 deliver_msglog("Delivery deferred by system filter\n");
4902 log_write(0, LOG_MAIN, "Delivery deferred by system filter");
4905 /* The filter can request that a message be frozen, but this does not
4906 take place if the message has been manually thawed. In that case, we must
4907 unset "delivered", which is forced by the "freeze" command to make -bF
4910 else if (rc == FF_FREEZE && !deliver_manual_thaw)
4912 deliver_freeze = TRUE;
4913 deliver_frozen_at = time(NULL);
4914 process_recipients = RECIP_DEFER;
4915 frozen_info = string_sprintf(" by the system filter%s%s",
4916 (filter_message == NULL)? US"" : US": ",
4917 (filter_message == NULL)? US"" : filter_message);
4920 /* The filter can request that a message be failed. The error message may be
4921 quite long - it is sent back to the sender in the bounce - but we don't want
4922 to fill up the log with repetitions of it. If it starts with << then the text
4923 between << and >> is written to the log, with the rest left for the bounce
4926 else if (rc == FF_FAIL)
4928 uschar *colon = US"";
4929 uschar *logmsg = US"";
4932 process_recipients = RECIP_FAIL_FILTER;
4934 if (filter_message != NULL)
4938 if (filter_message[0] == '<' && filter_message[1] == '<' &&
4939 (logend = Ustrstr(filter_message, ">>")) != NULL)
4941 logmsg = filter_message + 2;
4942 loglen = logend - logmsg;
4943 filter_message = logend + 2;
4944 if (filter_message[0] == 0) filter_message = NULL;
4948 logmsg = filter_message;
4949 loglen = Ustrlen(filter_message);
4953 log_write(0, LOG_MAIN, "cancelled by system filter%s%.*s", colon, loglen,
4957 /* Delivery can be restricted only to those recipients (if any) that the
4958 filter specified. */
4960 else if (rc == FF_DELIVERED)
4962 process_recipients = RECIP_IGNORE;
4963 if (addr_new == NULL)
4964 log_write(0, LOG_MAIN, "=> discarded (system filter)");
4966 log_write(0, LOG_MAIN, "original recipients ignored (system filter)");
4969 /* If any new addresses were created by the filter, fake up a "parent"
4970 for them. This is necessary for pipes, etc., which are expected to have
4971 parents, and it also gives some sensible logging for others. Allow
4972 pipes, files, and autoreplies, and run them as the filter uid if set,
4973 otherwise as the current uid. */
4975 if (addr_new != NULL)
4977 int uid = (system_filter_uid_set)? system_filter_uid : geteuid();
4978 int gid = (system_filter_gid_set)? system_filter_gid : getegid();
4980 /* The text "system-filter" is tested in transport_set_up_command() and in
4981 set_up_shell_command() in the pipe transport, to enable them to permit
4982 $recipients, so don't change it here without also changing it there. */
4984 address_item *p = addr_new;
4985 address_item *parent = deliver_make_addr(US"system-filter", FALSE);
4987 parent->domain = string_copylc(qualify_domain_recipient);
4988 parent->local_part = US"system-filter";
4990 /* As part of this loop, we arrange for addr_last to end up pointing
4991 at the final address. This is used if we go on to add addresses for the
4992 original recipients. */
4996 if (parent->child_count == SHRT_MAX)
4997 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "system filter generated more "
4998 "than %d delivery addresses", SHRT_MAX);
4999 parent->child_count++;
5002 if (testflag(p, af_pfr))
5008 setflag(p, af_uid_set |
5014 /* Find the name of the system filter's appropriate pfr transport */
5016 if (p->address[0] == '|')
5019 tpname = system_filter_pipe_transport;
5020 address_pipe = p->address;
5022 else if (p->address[0] == '>')
5025 tpname = system_filter_reply_transport;
5029 if (p->address[Ustrlen(p->address)-1] == '/')
5031 type = US"directory";
5032 tpname = system_filter_directory_transport;
5037 tpname = system_filter_file_transport;
5039 address_file = p->address;
5042 /* Now find the actual transport, first expanding the name. We have
5043 set address_file or address_pipe above. */
5047 uschar *tmp = expand_string(tpname);
5048 address_file = address_pipe = NULL;
5050 p->message = string_sprintf("failed to expand \"%s\" as a "
5051 "system filter transport name", tpname);
5056 p->message = string_sprintf("system_filter_%s_transport is unset",
5062 transport_instance *tp;
5063 for (tp = transports; tp != NULL; tp = tp->next)
5065 if (Ustrcmp(tp->name, tpname) == 0)
5072 p->message = string_sprintf("failed to find \"%s\" transport "
5073 "for system filter delivery", tpname);
5076 /* If we couldn't set up a transport, defer the delivery, putting the
5077 error on the panic log as well as the main log. */
5079 if (p->transport == NULL)
5081 address_item *badp = p;
5083 if (addr_last == NULL) addr_new = p; else addr_last->next = p;
5084 badp->local_part = badp->address; /* Needed for log line */
5085 post_process_one(badp, DEFER, LOG_MAIN|LOG_PANIC, DTYPE_ROUTER, 0);
5088 } /* End of pfr handling */
5090 /* Either a non-pfr delivery, or we found a transport */
5092 DEBUG(D_deliver|D_filter)
5093 debug_printf("system filter added %s\n", p->address);
5097 } /* Loop through all addr_new addresses */
5102 /* Scan the recipients list, and for every one that is not in the non-
5103 recipients tree, add an addr item to the chain of new addresses. If the pno
5104 value is non-negative, we must set the onetime parent from it. This which
5105 points to the relevant entry in the recipients list.
5107 This processing can be altered by the setting of the process_recipients
5108 variable, which is changed if recipients are to be ignored, failed, or
5109 deferred. This can happen as a result of system filter activity, or if the -Mg
5110 option is used to fail all of them.
5112 Duplicate addresses are handled later by a different tree structure; we can't
5113 just extend the non-recipients tree, because that will be re-written to the
5114 spool if the message is deferred, and in any case there are casing
5115 complications for local addresses. */
5117 if (process_recipients != RECIP_IGNORE)
5119 for (i = 0; i < recipients_count; i++)
5121 if (tree_search(tree_nonrecipients, recipients_list[i].address) == NULL)
5123 recipient_item *r = recipients_list + i;
5124 address_item *new = deliver_make_addr(r->address, FALSE);
5125 new->p.errors_address = r->errors_to;
5128 new->onetime_parent = recipients_list[r->pno].address;
5130 switch (process_recipients)
5132 /* RECIP_DEFER is set when a system filter freezes a message. */
5135 new->next = addr_defer;
5140 /* RECIP_FAIL_FILTER is set when a system filter has obeyed a "fail"
5143 case RECIP_FAIL_FILTER:
5145 (filter_message == NULL)? US"delivery cancelled" : filter_message;
5146 setflag(new, af_pass_message);
5147 goto RECIP_QUEUE_FAILED; /* below */
5150 /* RECIP_FAIL_TIMEOUT is set when a message is frozen, but is older
5151 than the value in timeout_frozen_after. Treat non-bounce messages
5152 similarly to -Mg; for bounce messages we just want to discard, so
5153 don't put the address on the failed list. The timeout has already
5156 case RECIP_FAIL_TIMEOUT:
5157 new->message = US"delivery cancelled; message timed out";
5158 goto RECIP_QUEUE_FAILED; /* below */
5161 /* RECIP_FAIL is set when -Mg has been used. */
5164 new->message = US"delivery cancelled by administrator";
5167 /* Common code for the failure cases above. If this is not a bounce
5168 message, put the address on the failed list so that it is used to
5169 create a bounce. Otherwise do nothing - this just discards the address.
5170 The incident has already been logged. */
5173 if (sender_address[0] != 0)
5175 new->next = addr_failed;
5181 /* RECIP_FAIL_LOOP is set when there are too many Received: headers
5182 in the message. Process each address as a routing failure; if this
5183 is a bounce message, it will get frozen. */
5185 case RECIP_FAIL_LOOP:
5186 new->message = US"Too many \"Received\" headers - suspected mail loop";
5187 post_process_one(new, FAIL, LOG_MAIN, DTYPE_ROUTER, 0);
5191 /* Value should be RECIP_ACCEPT; take this as the safe default. */
5194 if (addr_new == NULL) addr_new = new; else addr_last->next = new;
5204 address_item *p = addr_new;
5205 debug_printf("Delivery address list:\n");
5208 debug_printf(" %s %s\n", p->address, (p->onetime_parent == NULL)? US"" :
5214 /* Set up the buffers used for copying over the file when delivering. */
5216 deliver_in_buffer = store_malloc(DELIVER_IN_BUFFER_SIZE);
5217 deliver_out_buffer = store_malloc(DELIVER_OUT_BUFFER_SIZE);
5221 /* Until there are no more new addresses, handle each one as follows:
5223 . If this is a generated address (indicated by the presence of a parent
5224 pointer) then check to see whether it is a pipe, file, or autoreply, and
5225 if so, handle it directly here. The router that produced the address will
5226 have set the allow flags into the address, and also set the uid/gid required.
5227 Having the routers generate new addresses and then checking them here at
5228 the outer level is tidier than making each router do the checking, and
5229 means that routers don't need access to the failed address queue.
5231 . Break up the address into local part and domain, and make lowercased
5232 versions of these strings. We also make unquoted versions of the local part.
5234 . Handle the percent hack for those domains for which it is valid.
5236 . For child addresses, determine if any of the parents have the same address.
5237 If so, generate a different string for previous delivery checking. Without
5238 this code, if the address spqr generates spqr via a forward or alias file,
5239 delivery of the generated spqr stops further attempts at the top level spqr,
5240 which is not what is wanted - it may have generated other addresses.
5242 . Check on the retry database to see if routing was previously deferred, but
5243 only if in a queue run. Addresses that are to be routed are put on the
5244 addr_route chain. Addresses that are to be deferred are put on the
5245 addr_defer chain. We do all the checking first, so as not to keep the
5246 retry database open any longer than necessary.
5248 . Now we run the addresses through the routers. A router may put the address
5249 on either the addr_local or the addr_remote chain for local or remote
5250 delivery, respectively, or put it on the addr_failed chain if it is
5251 undeliveable, or it may generate child addresses and put them on the
5252 addr_new chain, or it may defer an address. All the chain anchors are
5253 passed as arguments so that the routers can be called for verification
5256 . If new addresses have been generated by the routers, da capo.
5259 header_rewritten = FALSE; /* No headers rewritten yet */
5260 while (addr_new != NULL) /* Loop until all addresses dealt with */
5262 address_item *addr, *parent;
5263 dbm_file = dbfn_open(US"retry", O_RDONLY, &dbblock, FALSE);
5265 /* Failure to open the retry database is treated the same as if it does
5266 not exist. In both cases, dbm_file is NULL. */
5268 if (dbm_file == NULL)
5270 DEBUG(D_deliver|D_retry|D_route|D_hints_lookup)
5271 debug_printf("no retry data available\n");
5274 /* Scan the current batch of new addresses, to handle pipes, files and
5275 autoreplies, and determine which others are ready for routing. */
5277 while (addr_new != NULL)
5282 dbdata_retry *domain_retry_record;
5283 dbdata_retry *address_retry_record;
5286 addr_new = addr->next;
5288 DEBUG(D_deliver|D_retry|D_route)
5290 debug_printf(">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>\n");
5291 debug_printf("Considering: %s\n", addr->address);
5294 /* Handle generated address that is a pipe or a file or an autoreply. */
5296 if (testflag(addr, af_pfr))
5298 /* If an autoreply in a filter could not generate a syntactically valid
5299 address, give up forthwith. Set af_ignore_error so that we don't try to
5300 generate a bounce. */
5302 if (testflag(addr, af_bad_reply))
5304 addr->basic_errno = ERRNO_BADADDRESS2;
5305 addr->local_part = addr->address;
5307 US"filter autoreply generated syntactically invalid recipient";
5308 setflag(addr, af_ignore_error);
5309 (void)post_process_one(addr, FAIL, LOG_MAIN, DTYPE_ROUTER, 0);
5310 continue; /* with the next new address */
5313 /* If two different users specify delivery to the same pipe or file or
5314 autoreply, there should be two different deliveries, so build a unique
5315 string that incorporates the original address, and use this for
5316 duplicate testing and recording delivery, and also for retrying. */
5319 string_sprintf("%s:%s", addr->address, addr->parent->unique +
5320 (testflag(addr->parent, af_homonym)? 3:0));
5322 addr->address_retry_key = addr->domain_retry_key =
5323 string_sprintf("T:%s", addr->unique);
5325 /* If a filter file specifies two deliveries to the same pipe or file,
5326 we want to de-duplicate, but this is probably not wanted for two mail
5327 commands to the same address, where probably both should be delivered.
5328 So, we have to invent a different unique string in that case. Just
5329 keep piling '>' characters on the front. */
5331 if (addr->address[0] == '>')
5333 while (tree_search(tree_duplicates, addr->unique) != NULL)
5334 addr->unique = string_sprintf(">%s", addr->unique);
5337 else if ((tnode = tree_search(tree_duplicates, addr->unique)) != NULL)
5339 DEBUG(D_deliver|D_route)
5340 debug_printf("%s is a duplicate address: discarded\n", addr->address);
5341 addr->dupof = tnode->data.ptr;
5342 addr->next = addr_duplicate;
5343 addr_duplicate = addr;
5347 DEBUG(D_deliver|D_route) debug_printf("unique = %s\n", addr->unique);
5349 /* Check for previous delivery */
5351 if (tree_search(tree_nonrecipients, addr->unique) != NULL)
5353 DEBUG(D_deliver|D_route)
5354 debug_printf("%s was previously delivered: discarded\n", addr->address);
5355 child_done(addr, tod_stamp(tod_log));
5359 /* Save for checking future duplicates */
5361 tree_add_duplicate(addr->unique, addr);
5363 /* Set local part and domain */
5365 addr->local_part = addr->address;
5366 addr->domain = addr->parent->domain;
5368 /* Ensure that the delivery is permitted. */
5370 if (testflag(addr, af_file))
5372 if (!testflag(addr, af_allow_file))
5374 addr->basic_errno = ERRNO_FORBIDFILE;
5375 addr->message = US"delivery to file forbidden";
5376 (void)post_process_one(addr, FAIL, LOG_MAIN, DTYPE_ROUTER, 0);
5377 continue; /* with the next new address */
5380 else if (addr->address[0] == '|')
5382 if (!testflag(addr, af_allow_pipe))
5384 addr->basic_errno = ERRNO_FORBIDPIPE;
5385 addr->message = US"delivery to pipe forbidden";
5386 (void)post_process_one(addr, FAIL, LOG_MAIN, DTYPE_ROUTER, 0);
5387 continue; /* with the next new address */
5390 else if (!testflag(addr, af_allow_reply))
5392 addr->basic_errno = ERRNO_FORBIDREPLY;
5393 addr->message = US"autoreply forbidden";
5394 (void)post_process_one(addr, FAIL, LOG_MAIN, DTYPE_ROUTER, 0);
5395 continue; /* with the next new address */
5398 /* If the errno field is already set to BADTRANSPORT, it indicates
5399 failure to expand a transport string, or find the associated transport,
5400 or an unset transport when one is required. Leave this test till now so
5401 that the forbid errors are given in preference. */
5403 if (addr->basic_errno == ERRNO_BADTRANSPORT)
5405 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_ROUTER, 0);
5409 /* Treat /dev/null as a special case and abandon the delivery. This
5410 avoids having to specify a uid on the transport just for this case.
5411 Arrange for the transport name to be logged as "**bypassed**". */
5413 if (Ustrcmp(addr->address, "/dev/null") == 0)
5415 uschar *save = addr->transport->name;
5416 addr->transport->name = US"**bypassed**";
5417 (void)post_process_one(addr, OK, LOG_MAIN, DTYPE_TRANSPORT, '=');
5418 addr->transport->name = save;
5419 continue; /* with the next new address */
5422 /* Pipe, file, or autoreply delivery is to go ahead as a normal local
5425 DEBUG(D_deliver|D_route)
5426 debug_printf("queued for %s transport\n", addr->transport->name);
5427 addr->next = addr_local;
5429 continue; /* with the next new address */
5432 /* Handle normal addresses. First, split up into local part and domain,
5433 handling the %-hack if necessary. There is the possibility of a defer from
5434 a lookup in percent_hack_domains. */
5436 if ((rc = deliver_split_address(addr)) == DEFER)
5438 addr->message = US"cannot check percent_hack_domains";
5439 addr->basic_errno = ERRNO_LISTDEFER;
5440 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_NONE, 0);
5444 /* Check to see if the domain is held. If so, proceed only if the
5445 delivery was forced by hand. */
5447 deliver_domain = addr->domain; /* set $domain */
5448 if (!forced && hold_domains != NULL &&
5449 (rc = match_isinlist(addr->domain, &hold_domains, 0,
5450 &domainlist_anchor, addr->domain_cache, MCL_DOMAIN, TRUE,
5455 addr->message = US"hold_domains lookup deferred";
5456 addr->basic_errno = ERRNO_LISTDEFER;
5460 addr->message = US"domain is held";
5461 addr->basic_errno = ERRNO_HELD;
5463 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_NONE, 0);
5467 /* Now we can check for duplicates and previously delivered addresses. In
5468 order to do this, we have to generate a "unique" value for each address,
5469 because there may be identical actual addresses in a line of descendents.
5470 The "unique" field is initialized to the same value as the "address" field,
5471 but gets changed here to cope with identically-named descendents. */
5473 for (parent = addr->parent; parent != NULL; parent = parent->parent)
5474 if (strcmpic(addr->address, parent->address) == 0) break;
5476 /* If there's an ancestor with the same name, set the homonym flag. This
5477 influences how deliveries are recorded. Then add a prefix on the front of
5478 the unique address. We use \n\ where n starts at 0 and increases each time.
5479 It is unlikely to pass 9, but if it does, it may look odd but will still
5480 work. This means that siblings or cousins with the same names are treated
5481 as duplicates, which is what we want. */
5485 setflag(addr, af_homonym);
5486 if (parent->unique[0] != '\\')
5487 addr->unique = string_sprintf("\\0\\%s", addr->address);
5489 addr->unique = string_sprintf("\\%c\\%s", parent->unique[1] + 1,
5493 /* Ensure that the domain in the unique field is lower cased, because
5494 domains are always handled caselessly. */
5496 p = Ustrrchr(addr->unique, '@');
5497 while (*p != 0) { *p = tolower(*p); p++; }
5499 DEBUG(D_deliver|D_route) debug_printf("unique = %s\n", addr->unique);
5501 if (tree_search(tree_nonrecipients, addr->unique) != NULL)
5503 DEBUG(D_deliver|D_route)
5504 debug_printf("%s was previously delivered: discarded\n", addr->unique);
5505 child_done(addr, tod_stamp(tod_log));
5509 /* Get the routing retry status, saving the two retry keys (with and
5510 without the local part) for subsequent use. If there is no retry record for
5511 the standard address routing retry key, we look for the same key with the
5512 sender attached, because this form is used by the smtp transport after a
5513 4xx response to RCPT when address_retry_include_sender is true. */
5515 addr->domain_retry_key = string_sprintf("R:%s", addr->domain);
5516 addr->address_retry_key = string_sprintf("R:%s@%s", addr->local_part,
5519 if (dbm_file == NULL)
5520 domain_retry_record = address_retry_record = NULL;
5523 domain_retry_record = dbfn_read(dbm_file, addr->domain_retry_key);
5524 if (domain_retry_record != NULL &&
5525 now - domain_retry_record->time_stamp > retry_data_expire)
5526 domain_retry_record = NULL; /* Ignore if too old */
5528 address_retry_record = dbfn_read(dbm_file, addr->address_retry_key);
5529 if (address_retry_record != NULL &&
5530 now - address_retry_record->time_stamp > retry_data_expire)
5531 address_retry_record = NULL; /* Ignore if too old */
5533 if (address_retry_record == NULL)
5535 uschar *altkey = string_sprintf("%s:<%s>", addr->address_retry_key,
5537 address_retry_record = dbfn_read(dbm_file, altkey);
5538 if (address_retry_record != NULL &&
5539 now - address_retry_record->time_stamp > retry_data_expire)
5540 address_retry_record = NULL; /* Ignore if too old */
5544 DEBUG(D_deliver|D_retry)
5546 if (domain_retry_record == NULL)
5547 debug_printf("no domain retry record\n");
5548 if (address_retry_record == NULL)
5549 debug_printf("no address retry record\n");
5552 /* If we are sending a message down an existing SMTP connection, we must
5553 assume that the message which created the connection managed to route
5554 an address to that connection. We do not want to run the risk of taking
5555 a long time over routing here, because if we do, the server at the other
5556 end of the connection may time it out. This is especially true for messages
5557 with lots of addresses. For this kind of delivery, queue_running is not
5558 set, so we would normally route all addresses. We take a pragmatic approach
5559 and defer routing any addresses that have any kind of domain retry record.
5560 That is, we don't even look at their retry times. It doesn't matter if this
5561 doesn't work occasionally. This is all just an optimization, after all.
5563 The reason for not doing the same for address retries is that they normally
5564 arise from 4xx responses, not DNS timeouts. */
5566 if (continue_hostname != NULL && domain_retry_record != NULL)
5568 addr->message = US"reusing SMTP connection skips previous routing defer";
5569 addr->basic_errno = ERRNO_RRETRY;
5570 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_ROUTER, 0);
5573 /* If we are in a queue run, defer routing unless there is no retry data or
5574 we've passed the next retry time, or this message is forced. In other
5575 words, ignore retry data when not in a queue run.
5577 However, if the domain retry time has expired, always allow the routing
5578 attempt. If it fails again, the address will be failed. This ensures that
5579 each address is routed at least once, even after long-term routing
5582 If there is an address retry, check that too; just wait for the next
5583 retry time. This helps with the case when the temporary error on the
5584 address was really message-specific rather than address specific, since
5585 it allows other messages through.
5587 We also wait for the next retry time if this is a message sent down an
5588 existing SMTP connection (even though that will be forced). Otherwise there
5589 will be far too many attempts for an address that gets a 4xx error. In
5590 fact, after such an error, we should not get here because, the host should
5591 not be remembered as one this message needs. However, there was a bug that
5592 used to cause this to happen, so it is best to be on the safe side. */
5594 else if (((queue_running && !deliver_force) || continue_hostname != NULL)
5596 ((domain_retry_record != NULL &&
5597 now < domain_retry_record->next_try &&
5598 !domain_retry_record->expired)
5600 (address_retry_record != NULL &&
5601 now < address_retry_record->next_try))
5604 addr->message = US"retry time not reached";
5605 addr->basic_errno = ERRNO_RRETRY;
5606 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_ROUTER, 0);
5609 /* The domain is OK for routing. Remember if retry data exists so it
5610 can be cleaned up after a successful delivery. */
5614 if (domain_retry_record != NULL || address_retry_record != NULL)
5615 setflag(addr, af_dr_retry_exists);
5616 addr->next = addr_route;
5618 DEBUG(D_deliver|D_route)
5619 debug_printf("%s: queued for routing\n", addr->address);
5623 /* The database is closed while routing is actually happening. Requests to
5624 update it are put on a chain and all processed together at the end. */
5626 if (dbm_file != NULL) dbfn_close(dbm_file);
5628 /* If queue_domains is set, we don't even want to try routing addresses in
5629 those domains. During queue runs, queue_domains is forced to be unset.
5630 Optimize by skipping this pass through the addresses if nothing is set. */
5632 if (!deliver_force && queue_domains != NULL)
5634 address_item *okaddr = NULL;
5635 while (addr_route != NULL)
5637 address_item *addr = addr_route;
5638 addr_route = addr->next;
5640 deliver_domain = addr->domain; /* set $domain */
5641 if ((rc = match_isinlist(addr->domain, &queue_domains, 0,
5642 &domainlist_anchor, addr->domain_cache, MCL_DOMAIN, TRUE, NULL))
5647 addr->basic_errno = ERRNO_LISTDEFER;
5648 addr->message = US"queue_domains lookup deferred";
5649 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_ROUTER, 0);
5653 addr->next = okaddr;
5659 addr->basic_errno = ERRNO_QUEUE_DOMAIN;
5660 addr->message = US"domain is in queue_domains";
5661 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_ROUTER, 0);
5665 addr_route = okaddr;
5668 /* Now route those addresses that are not deferred. */
5670 while (addr_route != NULL)
5673 address_item *addr = addr_route;
5674 uschar *old_domain = addr->domain;
5675 uschar *old_unique = addr->unique;
5676 addr_route = addr->next;
5679 /* Just in case some router parameter refers to it. */
5681 return_path = (addr->p.errors_address != NULL)?
5682 addr->p.errors_address : sender_address;
5684 /* If a router defers an address, add a retry item. Whether or not to
5685 use the local part in the key is a property of the router. */
5687 if ((rc = route_address(addr, &addr_local, &addr_remote, &addr_new,
5688 &addr_succeed, v_none)) == DEFER)
5689 retry_add_item(addr, (addr->router->retry_use_local_part)?
5690 string_sprintf("R:%s@%s", addr->local_part, addr->domain) :
5691 string_sprintf("R:%s", addr->domain), 0);
5693 /* Otherwise, if there is an existing retry record in the database, add
5694 retry items to delete both forms. We must also allow for the possibility
5695 of a routing retry that includes the sender address. Since the domain might
5696 have been rewritten (expanded to fully qualified) as a result of routing,
5697 ensure that the rewritten form is also deleted. */
5699 else if (testflag(addr, af_dr_retry_exists))
5701 uschar *altkey = string_sprintf("%s:<%s>", addr->address_retry_key,
5703 retry_add_item(addr, altkey, rf_delete);
5704 retry_add_item(addr, addr->address_retry_key, rf_delete);
5705 retry_add_item(addr, addr->domain_retry_key, rf_delete);
5706 if (Ustrcmp(addr->domain, old_domain) != 0)
5707 retry_add_item(addr, string_sprintf("R:%s", old_domain), rf_delete);
5710 /* DISCARD is given for :blackhole: and "seen finish". The event has been
5711 logged, but we need to ensure the address (and maybe parents) is marked
5716 address_done(addr, tod_stamp(tod_log));
5717 continue; /* route next address */
5720 /* The address is finished with (failed or deferred). */
5724 (void)post_process_one(addr, rc, LOG_MAIN, DTYPE_ROUTER, 0);
5725 continue; /* route next address */
5728 /* The address has been routed. If the router changed the domain, it will
5729 also have changed the unique address. We have to test whether this address
5730 has already been delivered, because it's the unique address that finally
5733 if (addr->unique != old_unique &&
5734 tree_search(tree_nonrecipients, addr->unique) != 0)
5736 DEBUG(D_deliver|D_route) debug_printf("%s was previously delivered: "
5737 "discarded\n", addr->address);
5738 if (addr_remote == addr) addr_remote = addr->next;
5739 else if (addr_local == addr) addr_local = addr->next;
5742 /* If the router has same_domain_copy_routing set, we are permitted to copy
5743 the routing for any other addresses with the same domain. This is an
5744 optimisation to save repeated DNS lookups for "standard" remote domain
5745 routing. The option is settable only on routers that generate host lists.
5746 We play it very safe, and do the optimization only if the address is routed
5747 to a remote transport, there are no header changes, and the domain was not
5748 modified by the router. */
5750 if (addr_remote == addr &&
5751 addr->router->same_domain_copy_routing &&
5752 addr->p.extra_headers == NULL &&
5753 addr->p.remove_headers == NULL &&
5754 old_domain == addr->domain)
5756 address_item **chain = &addr_route;
5757 while (*chain != NULL)
5759 address_item *addr2 = *chain;
5760 if (Ustrcmp(addr2->domain, addr->domain) != 0)
5762 chain = &(addr2->next);
5766 /* Found a suitable address; take it off the routing list and add it to
5767 the remote delivery list. */
5769 *chain = addr2->next;
5770 addr2->next = addr_remote;
5771 addr_remote = addr2;
5773 /* Copy the routing data */
5775 addr2->domain = addr->domain;
5776 addr2->router = addr->router;
5777 addr2->transport = addr->transport;
5778 addr2->host_list = addr->host_list;
5779 addr2->fallback_hosts = addr->fallback_hosts;
5780 addr2->p.errors_address = addr->p.errors_address;
5781 copyflag(addr2, addr, af_hide_child | af_local_host_removed);
5783 DEBUG(D_deliver|D_route)
5785 debug_printf(">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>\n"
5787 "Routing for %s copied from %s\n",
5788 addr2->address, addr2->address, addr->address);
5792 } /* Continue with routing the next address. */
5793 } /* Loop to process any child addresses that the routers created, and
5794 any rerouted addresses that got put back on the new chain. */
5797 /* Debugging: show the results of the routing */
5799 DEBUG(D_deliver|D_retry|D_route)
5801 address_item *p = addr_local;
5802 debug_printf(">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>\n");
5803 debug_printf("After routing:\n Local deliveries:\n");
5806 debug_printf(" %s\n", p->address);
5811 debug_printf(" Remote deliveries:\n");
5814 debug_printf(" %s\n", p->address);
5819 debug_printf(" Failed addresses:\n");
5822 debug_printf(" %s\n", p->address);
5827 debug_printf(" Deferred addresses:\n");
5830 debug_printf(" %s\n", p->address);
5835 /* Free any resources that were cached during routing. */
5840 /* These two variables are set only during routing, after check_local_user.
5841 Ensure they are not set in transports. */
5843 local_user_gid = (gid_t)(-1);
5844 local_user_uid = (uid_t)(-1);
5846 /* Check for any duplicate addresses. This check is delayed until after
5847 routing, because the flexibility of the routing configuration means that
5848 identical addresses with different parentage may end up being redirected to
5849 different addresses. Checking for duplicates too early (as we previously used
5850 to) makes this kind of thing not work. */
5852 do_duplicate_check(&addr_local);
5853 do_duplicate_check(&addr_remote);
5855 /* When acting as an MUA wrapper, we proceed only if all addresses route to a
5856 remote transport. The check that they all end up in one transaction happens in
5857 the do_remote_deliveries() function. */
5859 if (mua_wrapper && (addr_local != NULL || addr_failed != NULL ||
5860 addr_defer != NULL))
5863 uschar *which, *colon, *msg;
5865 if (addr_local != NULL)
5870 else if (addr_defer != NULL)
5873 which = US"deferred";
5881 while (addr->parent != NULL) addr = addr->parent;
5883 if (addr->message != NULL)
5886 msg = addr->message;
5888 else colon = msg = US"";
5890 /* We don't need to log here for a forced failure as it will already
5891 have been logged. Defer will also have been logged, but as a defer, so we do
5892 need to do the failure logging. */
5894 if (addr != addr_failed)
5895 log_write(0, LOG_MAIN, "** %s routing yielded a %s delivery",
5896 addr->address, which);
5898 /* Always write an error to the caller */
5900 fprintf(stderr, "routing %s yielded a %s delivery%s%s\n", addr->address,
5903 final_yield = DELIVER_MUA_FAILED;
5904 addr_failed = addr_defer = NULL; /* So that we remove the message */
5905 goto DELIVERY_TIDYUP;
5909 /* If this is a run to continue deliveries to an external channel that is
5910 already set up, defer any local deliveries. */
5912 if (continue_transport != NULL)
5914 if (addr_defer == NULL) addr_defer = addr_local; else
5916 address_item *addr = addr_defer;
5917 while (addr->next != NULL) addr = addr->next;
5918 addr->next = addr_local;
5924 /* Because address rewriting can happen in the routers, we should not really do
5925 ANY deliveries until all addresses have been routed, so that all recipients of
5926 the message get the same headers. However, this is in practice not always
5927 possible, since sometimes remote addresses give DNS timeouts for days on end.
5928 The pragmatic approach is to deliver what we can now, saving any rewritten
5929 headers so that at least the next lot of recipients benefit from the rewriting
5930 that has already been done.
5932 If any headers have been rewritten during routing, update the spool file to
5933 remember them for all subsequent deliveries. This can be delayed till later if
5934 there is only address to be delivered - if it succeeds the spool write need not
5937 if (header_rewritten &&
5938 ((addr_local != NULL &&
5939 (addr_local->next != NULL || addr_remote != NULL)) ||
5940 (addr_remote != NULL && addr_remote->next != NULL)))
5942 /* Panic-dies on error */
5943 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
5944 header_rewritten = FALSE;
5948 /* If there are any deliveries to be done, open the journal file. This is used
5949 to record successful deliveries as soon as possible after each delivery is
5950 known to be complete. A file opened with O_APPEND is used so that several
5951 processes can run simultaneously.
5953 The journal is just insurance against crashes. When the spool file is
5954 ultimately updated at the end of processing, the journal is deleted. If a
5955 journal is found to exist at the start of delivery, the addresses listed
5956 therein are added to the non-recipients. */
5958 if (addr_local != NULL || addr_remote != NULL)
5960 sprintf(CS spoolname, "%s/input/%s/%s-J", spool_directory, message_subdir, id);
5961 journal_fd = Uopen(spoolname, O_WRONLY|O_APPEND|O_CREAT, SPOOL_MODE);
5965 log_write(0, LOG_MAIN|LOG_PANIC, "Couldn't open journal file %s: %s",
5966 spoolname, strerror(errno));
5967 return DELIVER_NOT_ATTEMPTED;
5970 /* Set the close-on-exec flag, make the file owned by Exim, and ensure
5971 that the mode is correct - the group setting doesn't always seem to get
5972 set automatically. */
5974 (void)fcntl(journal_fd, F_SETFD, fcntl(journal_fd, F_GETFD) | FD_CLOEXEC);
5975 (void)fchown(journal_fd, exim_uid, exim_gid);
5976 (void)fchmod(journal_fd, SPOOL_MODE);
5980 /* Now we can get down to the business of actually doing deliveries. Local
5981 deliveries are done first, then remote ones. If ever the problems of how to
5982 handle fallback transports are figured out, this section can be put into a loop
5983 for handling fallbacks, though the uid switching will have to be revised. */
5985 /* Precompile a regex that is used to recognize a parameter in response
5986 to an LHLO command, if is isn't already compiled. This may be used on both
5987 local and remote LMTP deliveries. */
5989 if (regex_IGNOREQUOTA == NULL) regex_IGNOREQUOTA =
5990 regex_must_compile(US"\\n250[\\s\\-]IGNOREQUOTA(\\s|\\n|$)", FALSE, TRUE);
5992 /* Handle local deliveries */
5994 if (addr_local != NULL)
5996 DEBUG(D_deliver|D_transport)
5997 debug_printf(">>>>>>>>>>>>>>>> Local deliveries >>>>>>>>>>>>>>>>\n");
5998 do_local_deliveries();
5999 disable_logging = FALSE;
6002 /* If queue_run_local is set, we do not want to attempt any remote deliveries,
6003 so just queue them all. */
6005 if (queue_run_local)
6007 while (addr_remote != NULL)
6009 address_item *addr = addr_remote;
6010 addr_remote = addr->next;
6012 addr->basic_errno = ERRNO_LOCAL_ONLY;
6013 addr->message = US"remote deliveries suppressed";
6014 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_TRANSPORT, 0);
6018 /* Handle remote deliveries */
6020 if (addr_remote != NULL)
6022 DEBUG(D_deliver|D_transport)
6023 debug_printf(">>>>>>>>>>>>>>>> Remote deliveries >>>>>>>>>>>>>>>>\n");
6025 /* Precompile some regex that are used to recognize parameters in response
6026 to an EHLO command, if they aren't already compiled. */
6028 if (regex_PIPELINING == NULL) regex_PIPELINING =
6029 regex_must_compile(US"\\n250[\\s\\-]PIPELINING(\\s|\\n|$)", FALSE, TRUE);
6031 if (regex_SIZE == NULL) regex_SIZE =
6032 regex_must_compile(US"\\n250[\\s\\-]SIZE(\\s|\\n|$)", FALSE, TRUE);
6034 if (regex_AUTH == NULL) regex_AUTH =
6035 regex_must_compile(US"\\n250[\\s\\-]AUTH\\s+([\\-\\w\\s]+)(?:\\n|$)",
6039 if (regex_STARTTLS == NULL) regex_STARTTLS =
6040 regex_must_compile(US"\\n250[\\s\\-]STARTTLS(\\s|\\n|$)", FALSE, TRUE);
6043 /* Now sort the addresses if required, and do the deliveries. The yield of
6044 do_remote_deliveries is FALSE when mua_wrapper is set and all addresses
6045 cannot be delivered in one transaction. */
6047 if (remote_sort_domains != NULL) sort_remote_deliveries();
6048 if (!do_remote_deliveries(FALSE))
6050 log_write(0, LOG_MAIN, "** mua_wrapper is set but recipients cannot all "
6051 "be delivered in one transaction");
6052 fprintf(stderr, "delivery to smarthost failed (configuration problem)\n");
6054 final_yield = DELIVER_MUA_FAILED;
6055 addr_failed = addr_defer = NULL; /* So that we remove the message */
6056 goto DELIVERY_TIDYUP;
6059 /* See if any of the addresses that failed got put on the queue for delivery
6060 to their fallback hosts. We do it this way because often the same fallback
6061 host is used for many domains, so all can be sent in a single transaction
6062 (if appropriately configured). */
6064 if (addr_fallback != NULL && !mua_wrapper)
6066 DEBUG(D_deliver) debug_printf("Delivering to fallback hosts\n");
6067 addr_remote = addr_fallback;
6068 addr_fallback = NULL;
6069 if (remote_sort_domains != NULL) sort_remote_deliveries();
6070 do_remote_deliveries(TRUE);
6072 disable_logging = FALSE;
6076 /* All deliveries are now complete. Ignore SIGTERM during this tidying up
6077 phase, to minimize cases of half-done things. */
6080 debug_printf(">>>>>>>>>>>>>>>> deliveries are done >>>>>>>>>>>>>>>>\n");
6082 /* Root privilege is no longer needed */
6084 exim_setugid(exim_uid, exim_gid, FALSE, US"post-delivery tidying");
6086 set_process_info("tidying up after delivering %s", message_id);
6087 signal(SIGTERM, SIG_IGN);
6089 /* When we are acting as an MUA wrapper, the smtp transport will either have
6090 succeeded for all addresses, or failed them all in normal cases. However, there
6091 are some setup situations (e.g. when a named port does not exist) that cause an
6092 immediate exit with deferral of all addresses. Convert those into failures. We
6093 do not ever want to retry, nor do we want to send a bounce message. */
6097 if (addr_defer != NULL)
6099 address_item *addr, *nextaddr;
6100 for (addr = addr_defer; addr != NULL; addr = nextaddr)
6102 log_write(0, LOG_MAIN, "** %s mua_wrapper forced failure for deferred "
6103 "delivery", addr->address);
6104 nextaddr = addr->next;
6105 addr->next = addr_failed;
6111 /* Now all should either have succeeded or failed. */
6113 if (addr_failed == NULL) final_yield = DELIVER_MUA_SUCCEEDED; else
6115 uschar *s = (addr_failed->user_message != NULL)?
6116 addr_failed->user_message : addr_failed->message;
6118 fprintf(stderr, "Delivery failed: ");
6119 if (addr_failed->basic_errno > 0)
6121 fprintf(stderr, "%s", strerror(addr_failed->basic_errno));
6122 if (s != NULL) fprintf(stderr, ": ");
6126 if (addr_failed->basic_errno <= 0) fprintf(stderr, "unknown error");
6128 else fprintf(stderr, "%s", CS s);
6129 fprintf(stderr, "\n");
6131 final_yield = DELIVER_MUA_FAILED;
6136 /* In a normal configuration, we now update the retry database. This is done in
6137 one fell swoop at the end in order not to keep opening and closing (and
6138 locking) the database. The code for handling retries is hived off into a
6139 separate module for convenience. We pass it the addresses of the various
6140 chains, because deferred addresses can get moved onto the failed chain if the
6141 retry cutoff time has expired for all alternative destinations. Bypass the
6142 updating of the database if the -N flag is set, which is a debugging thing that
6143 prevents actual delivery. */
6145 else if (!dont_deliver) retry_update(&addr_defer, &addr_failed, &addr_succeed);
6147 /* If any addresses failed, we must send a message to somebody, unless
6148 af_ignore_error is set, in which case no action is taken. It is possible for
6149 several messages to get sent if there are addresses with different
6152 while (addr_failed != NULL)
6156 uschar *logtod = tod_stamp(tod_log);
6158 address_item *handled_addr = NULL;
6159 address_item **paddr;
6160 address_item *msgchain = NULL;
6161 address_item **pmsgchain = &msgchain;
6163 /* There are weird cases when logging is disabled in the transport. However,
6164 there may not be a transport (address failed by a router). */
6166 disable_logging = FALSE;
6167 if (addr_failed->transport != NULL)
6168 disable_logging = addr_failed->transport->disable_logging;
6171 debug_printf("processing failed address %s\n", addr_failed->address);
6173 /* There are only two ways an address in a bounce message can get here:
6175 (1) When delivery was initially deferred, but has now timed out (in the call
6176 to retry_update() above). We can detect this by testing for
6177 af_retry_timedout. If the address does not have its own errors address,
6178 we arrange to ignore the error.
6180 (2) If delivery failures for bounce messages are being ignored. We can detect
6181 this by testing for af_ignore_error. This will also be set if a bounce
6182 message has been autothawed and the ignore_bounce_errors_after time has
6183 passed. It might also be set if a router was explicitly configured to
6184 ignore errors (errors_to = "").
6186 If neither of these cases obtains, something has gone wrong. Log the
6187 incident, but then ignore the error. */
6189 if (sender_address[0] == 0 && addr_failed->p.errors_address == NULL)
6191 if (!testflag(addr_failed, af_retry_timedout) &&
6192 !testflag(addr_failed, af_ignore_error))
6194 log_write(0, LOG_MAIN|LOG_PANIC, "internal error: bounce message "
6195 "failure is neither frozen nor ignored (it's been ignored)");
6197 setflag(addr_failed, af_ignore_error);
6200 /* If the first address on the list has af_ignore_error set, just remove
6201 it from the list, throw away any saved message file, log it, and
6202 mark the recipient done. */
6204 if (testflag(addr_failed, af_ignore_error))
6207 addr_failed = addr->next;
6208 if (addr->return_filename != NULL) Uunlink(addr->return_filename);
6210 log_write(0, LOG_MAIN, "%s%s%s%s: error ignored",
6212 (addr->parent == NULL)? US"" : US" <",
6213 (addr->parent == NULL)? US"" : addr->parent->address,
6214 (addr->parent == NULL)? US"" : US">");
6216 address_done(addr, logtod);
6217 child_done(addr, logtod);
6218 /* Panic-dies on error */
6219 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
6222 /* Otherwise, handle the sending of a message. Find the error address for
6223 the first address, then send a message that includes all failed addresses
6224 that have the same error address. Note the bounce_recipient is a global so
6225 that it can be accesssed by $bounce_recipient while creating a customized
6230 bounce_recipient = (addr_failed->p.errors_address == NULL)?
6231 sender_address : addr_failed->p.errors_address;
6233 /* Make a subprocess to send a message */
6235 pid = child_open_exim(&fd);
6237 /* Creation of child failed */
6240 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Process %d (parent %d) failed to "
6241 "create child process to send failure message: %s", getpid(),
6242 getppid(), strerror(errno));
6244 /* Creation of child succeeded */
6251 uschar *bcc, *emf_text;
6252 FILE *f = fdopen(fd, "wb");
6254 BOOL to_sender = strcmpic(sender_address, bounce_recipient) == 0;
6255 int max = (bounce_return_size_limit/DELIVER_IN_BUFFER_SIZE + 1) *
6256 DELIVER_IN_BUFFER_SIZE;
6259 debug_printf("sending error message to: %s\n", bounce_recipient);
6261 /* Scan the addresses for all that have the same errors address, removing
6262 them from the addr_failed chain, and putting them on msgchain. */
6264 paddr = &addr_failed;
6265 for (addr = addr_failed; addr != NULL; addr = *paddr)
6267 if (Ustrcmp(bounce_recipient, (addr->p.errors_address == NULL)?
6268 sender_address : addr->p.errors_address) != 0)
6270 paddr = &(addr->next); /* Not the same; skip */
6272 else /* The same - dechain */
6274 *paddr = addr->next;
6277 pmsgchain = &(addr->next);
6281 /* Include X-Failed-Recipients: for automatic interpretation, but do
6282 not let any one header line get too long. We do this by starting a
6283 new header every 50 recipients. Omit any addresses for which the
6284 "hide_child" flag is set. */
6286 for (addr = msgchain; addr != NULL; addr = addr->next)
6288 if (testflag(addr, af_hide_child)) continue;
6295 (rcount++ == 0)? "X-Failed-Recipients: " : ",\n ",
6296 (testflag(addr, af_pfr) && addr->parent != NULL)?
6297 string_printing(addr->parent->address) :
6298 string_printing(addr->address));
6300 if (rcount > 0) fprintf(f, "\n");
6302 /* Output the standard headers */
6304 if (errors_reply_to != NULL)
6305 fprintf(f, "Reply-To: %s\n", errors_reply_to);
6306 fprintf(f, "Auto-Submitted: auto-replied\n");
6308 fprintf(f, "To: %s\n", bounce_recipient);
6310 /* Open a template file if one is provided. Log failure to open, but
6311 carry on - default texts will be used. */
6313 if (bounce_message_file != NULL)
6315 emf = Ufopen(bounce_message_file, "rb");
6317 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to open %s for error "
6318 "message texts: %s", bounce_message_file, strerror(errno));
6321 /* Quietly copy to configured additional addresses if required. */
6323 bcc = moan_check_errorcopy(bounce_recipient);
6324 if (bcc != NULL) fprintf(f, "Bcc: %s\n", bcc);
6326 /* The texts for the message can be read from a template file; if there
6327 isn't one, or if it is too short, built-in texts are used. The first
6328 emf text is a Subject: and any other headers. */
6330 emf_text = next_emf(emf, US"header");
6331 if (emf_text != NULL) fprintf(f, "%s\n", emf_text); else
6333 fprintf(f, "Subject: Mail delivery failed%s\n\n",
6334 to_sender? ": returning message to sender" : "");
6337 emf_text = next_emf(emf, US"intro");
6338 if (emf_text != NULL) fprintf(f, "%s", CS emf_text); else
6341 /* This message has been reworded several times. It seems to be confusing to
6342 somebody, however it is worded. I have retreated to the original, simple
6344 "This message was created automatically by mail delivery software.\n");
6345 if (bounce_message_text != NULL) fprintf(f, "%s", CS bounce_message_text);
6349 "\nA message that you sent could not be delivered to one or more of its\n"
6350 "recipients. This is a permanent error. The following address(es) failed:\n");
6355 "\nA message sent by\n\n <%s>\n\n"
6356 "could not be delivered to one or more of its recipients. The following\n"
6357 "address(es) failed:\n", sender_address);
6362 /* Process the addresses, leaving them on the msgchain if they have a
6363 file name for a return message. (There has already been a check in
6364 post_process_one() for the existence of data in the message file.) A TRUE
6365 return from print_address_information() means that the address is not
6369 for (addr = msgchain; addr != NULL; addr = *paddr)
6371 if (print_address_information(addr, f, US" ", US"\n ", US""))
6372 print_address_error(addr, f, US"");
6374 /* End the final line for the address */
6378 /* Leave on msgchain if there's a return file. */
6380 if (addr->return_file >= 0)
6382 paddr = &(addr->next);
6386 /* Else save so that we can tick off the recipient when the
6391 *paddr = addr->next;
6392 addr->next = handled_addr;
6393 handled_addr = addr;
6399 /* Get the next text, whether we need it or not, so as to be
6400 positioned for the one after. */
6402 emf_text = next_emf(emf, US"generated text");
6404 /* If there were any file messages passed by the local transports,
6405 include them in the message. Then put the address on the handled chain.
6406 In the case of a batch of addresses that were all sent to the same
6407 transport, the return_file field in all of them will contain the same
6408 fd, and the return_filename field in the *last* one will be set (to the
6409 name of the file). */
6411 if (msgchain != NULL)
6413 address_item *nextaddr;
6415 if (emf_text != NULL) fprintf(f, "%s", CS emf_text); else
6417 "The following text was generated during the delivery "
6418 "attempt%s:\n", (filecount > 1)? "s" : "");
6420 for (addr = msgchain; addr != NULL; addr = nextaddr)
6423 address_item *topaddr = addr;
6425 /* List all the addresses that relate to this file */
6428 while(addr != NULL) /* Insurance */
6430 print_address_information(addr, f, US"------ ", US"\n ",
6432 if (addr->return_filename != NULL) break;
6437 /* Now copy the file */
6439 fm = Ufopen(addr->return_filename, "rb");
6442 fprintf(f, " +++ Exim error... failed to open text file: %s\n",
6446 while ((ch = fgetc(fm)) != EOF) fputc(ch, f);
6449 Uunlink(addr->return_filename);
6451 /* Can now add to handled chain, first fishing off the next
6452 address on the msgchain. */
6454 nextaddr = addr->next;
6455 addr->next = handled_addr;
6456 handled_addr = topaddr;
6461 /* Now copy the message, trying to give an intelligible comment if
6462 it is too long for it all to be copied. The limit isn't strictly
6463 applied because of the buffering. There is, however, an option
6464 to suppress copying altogether. */
6466 emf_text = next_emf(emf, US"copy");
6468 if (bounce_return_message)
6470 int topt = topt_add_return_path;
6471 if (!bounce_return_body) topt |= topt_no_body;
6473 if (emf_text != NULL) fprintf(f, "%s", CS emf_text); else
6475 if (bounce_return_body) fprintf(f,
6476 "------ This is a copy of the message, including all the headers. ------\n");
6478 "------ This is a copy of the message's headers. ------\n");
6481 /* While reading the "truncated" message, set return_size_limit to
6482 the actual max testing value, rounded. We need to read the message
6483 whether we are going to use it or not. */
6486 int temp = bounce_return_size_limit;
6487 bounce_return_size_limit = (max/1000)*1000;
6488 emf_text = next_emf(emf, US"truncated");
6489 bounce_return_size_limit = temp;
6492 if (bounce_return_body && bounce_return_size_limit > 0)
6494 struct stat statbuf;
6495 if (fstat(deliver_datafile, &statbuf) == 0 && statbuf.st_size > max)
6497 if (emf_text != NULL) fprintf(f, "%s", CS emf_text); else
6500 "------ The body of the message is " OFF_T_FMT " characters long; only the first\n"
6501 "------ %d or so are included here.\n", statbuf.st_size, max);
6508 transport_filter_argv = NULL; /* Just in case */
6509 return_path = sender_address; /* In case not previously set */
6510 transport_write_message(NULL, fileno(f), topt,
6511 bounce_return_size_limit, NULL, NULL, NULL, NULL, NULL, 0);
6514 /* Write final text and close the template file if one is open */
6518 emf_text = next_emf(emf, US"final");
6519 if (emf_text != NULL) fprintf(f, "%s", CS emf_text);
6523 /* Close the file, which should send an EOF to the child process
6524 that is receiving the message. Wait for it to finish. */
6527 rc = child_close(pid, 0); /* Waits for child to close, no timeout */
6529 /* In the test harness, let the child do it's thing first. */
6531 if (running_in_test_harness) millisleep(500);
6533 /* If the process failed, there was some disaster in setting up the
6534 error message. Unless the message is very old, ensure that addr_defer
6535 is non-null, which will have the effect of leaving the message on the
6536 spool. The failed addresses will get tried again next time. However, we
6537 don't really want this to happen too often, so freeze the message unless
6538 there are some genuine deferred addresses to try. To do this we have
6539 to call spool_write_header() here, because with no genuine deferred
6540 addresses the normal code below doesn't get run. */
6545 if (now - received_time < retry_maximum_timeout && addr_defer == NULL)
6547 addr_defer = (address_item *)(+1);
6548 deliver_freeze = TRUE;
6549 deliver_frozen_at = time(NULL);
6550 /* Panic-dies on error */
6551 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
6554 deliver_msglog("Process failed (%d) when writing error message "
6555 "to %s%s", rc, bounce_recipient, s);
6556 log_write(0, LOG_MAIN, "Process failed (%d) when writing error message "
6557 "to %s%s", rc, bounce_recipient, s);
6560 /* The message succeeded. Ensure that the recipients that failed are
6561 now marked finished with on the spool and their parents updated. */
6565 for (addr = handled_addr; addr != NULL; addr = addr->next)
6567 address_done(addr, logtod);
6568 child_done(addr, logtod);
6570 /* Panic-dies on error */
6571 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
6577 disable_logging = FALSE; /* In case left set */
6579 /* Come here from the mua_wrapper case if routing goes wrong */
6583 /* If there are now no deferred addresses, we are done. Preserve the
6584 message log if so configured, and we are using them. Otherwise, sling it.
6585 Then delete the message itself. */
6587 if (addr_defer == NULL)
6591 sprintf(CS spoolname, "%s/msglog/%s/%s", spool_directory, message_subdir,
6593 if (preserve_message_logs)
6596 sprintf(CS big_buffer, "%s/msglog.OLD/%s", spool_directory, id);
6597 if ((rc = Urename(spoolname, big_buffer)) < 0)
6599 (void)directory_make(spool_directory, US"msglog.OLD",
6600 MSGLOG_DIRECTORY_MODE, TRUE);
6601 rc = Urename(spoolname, big_buffer);
6604 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to move %s to the "
6605 "msglog.OLD directory", spoolname);
6609 if (Uunlink(spoolname) < 0)
6610 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s",
6611 spoolname, strerror(errno));
6615 /* Remove the two message files. */
6617 sprintf(CS spoolname, "%s/input/%s/%s-D", spool_directory, message_subdir, id);
6618 if (Uunlink(spoolname) < 0)
6619 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s",
6620 spoolname, strerror(errno));
6621 sprintf(CS spoolname, "%s/input/%s/%s-H", spool_directory, message_subdir, id);
6622 if (Uunlink(spoolname) < 0)
6623 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s",
6624 spoolname, strerror(errno));
6626 /* Log the end of this message, with queue time if requested. */
6628 if ((log_extra_selector & LX_queue_time_overall) != 0)
6629 log_write(0, LOG_MAIN, "Completed QT=%s",
6630 readconf_printtime(time(NULL) - received_time));
6632 log_write(0, LOG_MAIN, "Completed");
6634 /* Unset deliver_freeze so that we won't try to move the spool files further down */
6635 deliver_freeze = FALSE;
6638 /* If there are deferred addresses, we are keeping this message because it is
6639 not yet completed. Lose any temporary files that were catching output from
6640 pipes for any of the deferred addresses, handle one-time aliases, and see if
6641 the message has been on the queue for so long that it is time to send a warning
6642 message to the sender, unless it is a mailer-daemon. If all deferred addresses
6643 have the same domain, we can set deliver_domain for the expansion of
6644 delay_warning_ condition - if any of them are pipes, files, or autoreplies, use
6645 the parent's domain.
6647 If all the deferred addresses have an error number that indicates "retry time
6648 not reached", skip sending the warning message, because it won't contain the
6649 reason for the delay. It will get sent at the next real delivery attempt.
6650 However, if at least one address has tried, we'd better include all of them in
6653 If we can't make a process to send the message, don't worry.
6655 For mailing list expansions we want to send the warning message to the
6656 mailing list manager. We can't do a perfect job here, as some addresses may
6657 have different errors addresses, but if we take the errors address from
6658 each deferred address it will probably be right in most cases.
6660 If addr_defer == +1, it means there was a problem sending an error message
6661 for failed addresses, and there were no "real" deferred addresses. The value
6662 was set just to keep the message on the spool, so there is nothing to do here.
6665 else if (addr_defer != (address_item *)(+1))
6668 uschar *recipients = US"";
6669 BOOL delivery_attempted = FALSE;
6671 deliver_domain = testflag(addr_defer, af_pfr)?
6672 addr_defer->parent->domain : addr_defer->domain;
6674 for (addr = addr_defer; addr != NULL; addr = addr->next)
6676 address_item *otaddr;
6678 if (addr->basic_errno > ERRNO_RETRY_BASE) delivery_attempted = TRUE;
6680 if (deliver_domain != NULL)
6682 uschar *d = (testflag(addr, af_pfr))? addr->parent->domain : addr->domain;
6684 /* The domain may be unset for an address that has never been routed
6685 because the system filter froze the message. */
6687 if (d == NULL || Ustrcmp(d, deliver_domain) != 0) deliver_domain = NULL;
6690 if (addr->return_filename != NULL) Uunlink(addr->return_filename);
6692 /* Handle the case of one-time aliases. If any address in the ancestry
6693 of this one is flagged, ensure it is in the recipients list, suitably
6694 flagged, and that its parent is marked delivered. */
6696 for (otaddr = addr; otaddr != NULL; otaddr = otaddr->parent)
6697 if (otaddr->onetime_parent != NULL) break;
6702 int t = recipients_count;
6704 for (i = 0; i < recipients_count; i++)
6706 uschar *r = recipients_list[i].address;
6707 if (Ustrcmp(otaddr->onetime_parent, r) == 0) t = i;
6708 if (Ustrcmp(otaddr->address, r) == 0) break;
6711 /* Didn't find the address already in the list, and did find the
6712 ultimate parent's address in the list. After adding the recipient,
6713 update the errors address in the recipients list. */
6715 if (i >= recipients_count && t < recipients_count)
6717 DEBUG(D_deliver) debug_printf("one_time: adding %s in place of %s\n",
6718 otaddr->address, otaddr->parent->address);
6719 receive_add_recipient(otaddr->address, t);
6720 recipients_list[recipients_count-1].errors_to = otaddr->p.errors_address;
6721 tree_add_nonrecipient(otaddr->parent->address);
6722 update_spool = TRUE;
6726 /* Except for error messages, ensure that either the errors address for
6727 this deferred address or, if there is none, the sender address, is on the
6728 list of recipients for a warning message. */
6730 if (sender_address[0] != 0)
6732 if (addr->p.errors_address == NULL)
6734 if (Ustrstr(recipients, sender_address) == NULL)
6735 recipients = string_sprintf("%s%s%s", recipients,
6736 (recipients[0] == 0)? "" : ",", sender_address);
6740 if (Ustrstr(recipients, addr->p.errors_address) == NULL)
6741 recipients = string_sprintf("%s%s%s", recipients,
6742 (recipients[0] == 0)? "" : ",", addr->p.errors_address);
6747 /* Send a warning message if the conditions are right. If the condition check
6748 fails because of a lookup defer, there is nothing we can do. The warning
6749 is not sent. Another attempt will be made at the next delivery attempt (if
6752 if (!queue_2stage && delivery_attempted &&
6753 delay_warning[1] > 0 && sender_address[0] != 0 &&
6754 (delay_warning_condition == NULL ||
6755 expand_check_condition(delay_warning_condition,
6756 US"delay_warning", US"option")))
6760 int queue_time = time(NULL) - received_time;
6762 /* When running in the test harness, there's an option that allows us to
6763 fudge this time so as to get repeatability of the tests. Take the first
6764 time off the list. In queue runs, the list pointer gets updated in the
6767 if (running_in_test_harness && fudged_queue_times[0] != 0)
6769 int qt = readconf_readtime(fudged_queue_times, '/', FALSE);
6772 DEBUG(D_deliver) debug_printf("fudged queue_times = %s\n",
6773 fudged_queue_times);
6778 /* See how many warnings we should have sent by now */
6780 for (count = 0; count < delay_warning[1]; count++)
6781 if (queue_time < delay_warning[count+2]) break;
6783 show_time = delay_warning[count+1];
6785 if (count >= delay_warning[1])
6788 int last_gap = show_time;
6789 if (count > 1) last_gap -= delay_warning[count];
6790 extra = (queue_time - delay_warning[count+1])/last_gap;
6791 show_time += last_gap * extra;
6797 debug_printf("time on queue = %s\n", readconf_printtime(queue_time));
6798 debug_printf("warning counts: required %d done %d\n", count,
6802 /* We have computed the number of warnings there should have been by now.
6803 If there haven't been enough, send one, and up the count to what it should
6806 if (warning_count < count)
6810 pid_t pid = child_open_exim(&fd);
6816 FILE *f = fdopen(fd, "wb");
6818 if (warn_message_file != NULL)
6820 wmf = Ufopen(warn_message_file, "rb");
6822 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to open %s for warning "
6823 "message texts: %s", warn_message_file, strerror(errno));
6826 warnmsg_recipients = recipients;
6827 warnmsg_delay = (queue_time < 120*60)?
6828 string_sprintf("%d minutes", show_time/60):
6829 string_sprintf("%d hours", show_time/3600);
6831 if (errors_reply_to != NULL)
6832 fprintf(f, "Reply-To: %s\n", errors_reply_to);
6833 fprintf(f, "Auto-Submitted: auto-replied\n");
6835 fprintf(f, "To: %s\n", recipients);
6837 wmf_text = next_emf(wmf, US"header");
6838 if (wmf_text != NULL)
6839 fprintf(f, "%s\n", wmf_text);
6841 fprintf(f, "Subject: Warning: message %s delayed %s\n\n",
6842 message_id, warnmsg_delay);
6844 wmf_text = next_emf(wmf, US"intro");
6845 if (wmf_text != NULL) fprintf(f, "%s", CS wmf_text); else
6848 "This message was created automatically by mail delivery software.\n");
6850 if (Ustrcmp(recipients, sender_address) == 0)
6852 "A message that you sent has not yet been delivered to one or more of its\n"
6853 "recipients after more than ");
6856 "A message sent by\n\n <%s>\n\n"
6857 "has not yet been delivered to one or more of its recipients after more than \n",
6860 fprintf(f, "%s on the queue on %s.\n\n", warnmsg_delay,
6862 fprintf(f, "The message identifier is: %s\n", message_id);
6864 for (h = header_list; h != NULL; h = h->next)
6866 if (strncmpic(h->text, US"Subject:", 8) == 0)
6867 fprintf(f, "The subject of the message is: %s", h->text + 9);
6868 else if (strncmpic(h->text, US"Date:", 5) == 0)
6869 fprintf(f, "The date of the message is: %s", h->text + 6);
6873 fprintf(f, "The address%s to which the message has not yet been "
6875 (addr_defer->next == NULL)? "" : "es",
6876 (addr_defer->next == NULL)? "is": "are");
6879 /* List the addresses, with error information if allowed */
6882 while (addr_defer != NULL)
6884 address_item *addr = addr_defer;
6885 addr_defer = addr->next;
6886 if (print_address_information(addr, f, US" ", US"\n ", US""))
6887 print_address_error(addr, f, US"Delay reason: ");
6896 wmf_text = next_emf(wmf, US"final");
6897 if (wmf_text != NULL) fprintf(f, "%s", CS wmf_text);
6903 "No action is required on your part. Delivery attempts will continue for\n"
6904 "some time, and this warning may be repeated at intervals if the message\n"
6905 "remains undelivered. Eventually the mail delivery software will give up,\n"
6906 "and when that happens, the message will be returned to you.\n");
6909 /* Close and wait for child process to complete, without a timeout.
6910 If there's an error, don't update the count. */
6913 if (child_close(pid, 0) == 0)
6915 warning_count = count;
6916 update_spool = TRUE; /* Ensure spool rewritten */
6922 /* Clear deliver_domain */
6924 deliver_domain = NULL;
6926 /* If this was a first delivery attempt, unset the first time flag, and
6927 ensure that the spool gets updated. */
6929 if (deliver_firsttime)
6931 deliver_firsttime = FALSE;
6932 update_spool = TRUE;
6935 /* If delivery was frozen and freeze_tell is set, generate an appropriate
6936 message, unless the message is a local error message (to avoid loops). Then
6937 log the freezing. If the text in "frozen_info" came from a system filter,
6938 it has been escaped into printing characters so as not to mess up log lines.
6939 For the "tell" message, we turn \n back into newline. Also, insert a newline
6940 near the start instead of the ": " string. */
6944 if (freeze_tell != NULL && freeze_tell[0] != 0 && !local_error_message)
6946 uschar *s = string_copy(frozen_info);
6947 uschar *ss = Ustrstr(s, " by the system filter: ");
6958 if (*ss == '\\' && ss[1] == 'n')
6965 moan_tell_someone(freeze_tell, addr_defer, US"Message frozen",
6966 "Message %s has been frozen%s.\nThe sender is <%s>.\n", message_id,
6970 /* Log freezing just before we update the -H file, to minimize the chance
6971 of a race problem. */
6973 deliver_msglog("*** Frozen%s\n", frozen_info);
6974 log_write(0, LOG_MAIN, "Frozen%s", frozen_info);
6977 /* If there have been any updates to the non-recipients list, or other things
6978 that get written to the spool, we must now update the spool header file so
6979 that it has the right information for the next delivery attempt. If there
6980 was more than one address being delivered, the header_change update is done
6981 earlier, in case one succeeds and then something crashes. */
6984 debug_printf("delivery deferred: update_spool=%d header_rewritten=%d\n",
6985 update_spool, header_rewritten);
6987 if (update_spool || header_rewritten)
6988 /* Panic-dies on error */
6989 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
6992 /* Finished with the message log. If the message is complete, it will have
6993 been unlinked or renamed above. */
6995 if (message_logs) (void)fclose(message_log);
6997 /* Now we can close and remove the journal file. Its only purpose is to record
6998 successfully completed deliveries asap so that this information doesn't get
6999 lost if Exim (or the machine) crashes. Forgetting about a failed delivery is
7000 not serious, as trying it again is not harmful. The journal might not be open
7001 if all addresses were deferred at routing or directing. Nevertheless, we must
7002 remove it if it exists (may have been lying around from a crash during the
7003 previous delivery attempt). We don't remove the journal if a delivery
7004 subprocess failed to pass back delivery information; this is controlled by
7005 the remove_journal flag. When the journal is left, we also don't move the
7006 message off the main spool if frozen and the option is set. It should get moved
7007 at the next attempt, after the journal has been inspected. */
7009 if (journal_fd >= 0) (void)close(journal_fd);
7013 sprintf(CS spoolname, "%s/input/%s/%s-J", spool_directory, message_subdir, id);
7014 if (Uunlink(spoolname) < 0 && errno != ENOENT)
7015 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s", spoolname,
7018 /* Move the message off the spool if reqested */
7020 #ifdef SUPPORT_MOVE_FROZEN_MESSAGES
7021 if (deliver_freeze && move_frozen_messages)
7022 (void)spool_move_message(id, message_subdir, US"", US"F");
7026 /* Closing the data file frees the lock; if the file has been unlinked it
7027 will go away. Otherwise the message becomes available for another process
7030 (void)close(deliver_datafile);
7031 deliver_datafile = -1;
7032 DEBUG(D_deliver) debug_printf("end delivery of %s\n", id);
7034 /* It is unlikely that there will be any cached resources, since they are
7035 released after routing, and in the delivery subprocesses. However, it's
7036 possible for an expansion for something afterwards (for example,
7037 expand_check_condition) to do a lookup. We must therefore be sure everything is
7041 acl_where = ACL_WHERE_UNKNOWN;
7045 /* End of deliver.c */