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 #ifdef EXPERIMENTAL_TPDA
699 tpda_delivery_ip = NULL; /* presume no successful remote delivery */
700 tpda_delivery_port = 0;
701 tpda_delivery_fqdn = NULL;
702 tpda_delivery_local_part = NULL;
703 tpda_delivery_domain = NULL;
704 tpda_delivery_confirmation = NULL;
707 s = reset_point = store_get(size);
709 log_address = string_log_address(addr, (log_write_selector & L_all_parents) != 0, TRUE);
711 s = string_append(s, &size, &ptr, 3, host_and_ident(TRUE), US" ", log_address);
715 s = string_append(s, &size, &ptr, 2, US"> ", log_address);
718 if ((log_extra_selector & LX_sender_on_delivery) != 0 || msg)
719 s = string_append(s, &size, &ptr, 3, US" F=<", sender_address, US">");
721 #ifdef EXPERIMENTAL_SRS
722 if(addr->p.srs_sender)
723 s = string_append(s, &size, &ptr, 3, US" SRS=<", addr->p.srs_sender, US">");
726 /* You might think that the return path must always be set for a successful
727 delivery; indeed, I did for some time, until this statement crashed. The case
728 when it is not set is for a delivery to /dev/null which is optimised by not
731 if (used_return_path != NULL &&
732 (log_extra_selector & LX_return_path_on_delivery) != 0)
733 s = string_append(s, &size, &ptr, 3, US" P=<", used_return_path, US">");
736 s = string_append(s, &size, &ptr, 2, US" ", msg);
738 /* For a delivery from a system filter, there may not be a router */
739 if (addr->router != NULL)
740 s = string_append(s, &size, &ptr, 2, US" R=", addr->router->name);
742 s = string_append(s, &size, &ptr, 2, US" T=", addr->transport->name);
744 if ((log_extra_selector & LX_delivery_size) != 0)
745 s = string_append(s, &size, &ptr, 2, US" S=",
746 string_sprintf("%d", transport_count));
750 if (addr->transport->info->local)
752 if (addr->host_list != NULL)
754 s = string_append(s, &size, &ptr, 2, US" H=", addr->host_list->name);
755 #ifdef EXPERIMENTAL_TPDA
756 tpda_delivery_fqdn = addr->host_list->name;
759 if (addr->shadow_message != NULL)
760 s = string_cat(s, &size, &ptr, addr->shadow_message,
761 Ustrlen(addr->shadow_message));
764 /* Remote delivery */
768 if (addr->host_used != NULL)
770 s = string_append(s, &size, &ptr, 5, US" H=", addr->host_used->name,
771 US" [", addr->host_used->address, US"]");
772 if ((log_extra_selector & LX_outgoing_port) != 0)
773 s = string_append(s, &size, &ptr, 2, US":", string_sprintf("%d",
774 addr->host_used->port));
775 if (continue_sequence > 1)
776 s = string_cat(s, &size, &ptr, US"*", 1);
778 #ifdef EXPERIMENTAL_TPDA
779 tpda_delivery_ip = addr->host_used->address;
780 tpda_delivery_port = addr->host_used->port;
781 tpda_delivery_fqdn = addr->host_used->name;
782 tpda_delivery_local_part = addr->local_part;
783 tpda_delivery_domain = addr->domain;
784 tpda_delivery_confirmation = addr->message;
789 if ((log_extra_selector & LX_tls_cipher) != 0 && addr->cipher != NULL)
790 s = string_append(s, &size, &ptr, 2, US" X=", addr->cipher);
791 if ((log_extra_selector & LX_tls_certificate_verified) != 0 &&
792 addr->cipher != NULL)
793 s = string_append(s, &size, &ptr, 2, US" CV=",
794 testflag(addr, af_cert_verified)? "yes":"no");
795 if ((log_extra_selector & LX_tls_peerdn) != 0 && addr->peerdn != NULL)
796 s = string_append(s, &size, &ptr, 3, US" DN=\"",
797 string_printing(addr->peerdn), US"\"");
800 if (addr->authenticator)
802 s = string_append(s, &size, &ptr, 2, US" A=", addr->authenticator);
805 s = string_append(s, &size, &ptr, 2, US":", addr->auth_id);
806 if (log_extra_selector & LX_smtp_mailauth && addr->auth_sndr)
807 s = string_append(s, &size, &ptr, 2, US":", addr->auth_sndr);
811 #ifdef EXPERIMENTAL_PRDR
812 if (addr->flags & af_prdr_used)
813 s = string_append(s, &size, &ptr, 1, US" PRDR");
816 if ((log_extra_selector & LX_smtp_confirmation) != 0 &&
817 addr->message != NULL)
820 uschar *p = big_buffer;
821 uschar *ss = addr->message;
823 for (i = 0; i < 100 && ss[i] != 0; i++)
825 if (ss[i] == '\"' || ss[i] == '\\') *p++ = '\\';
830 s = string_append(s, &size, &ptr, 2, US" C=", big_buffer);
834 /* Time on queue and actual time taken to deliver */
836 if ((log_extra_selector & LX_queue_time) != 0)
838 s = string_append(s, &size, &ptr, 2, US" QT=",
839 readconf_printtime(time(NULL) - received_time));
842 if ((log_extra_selector & LX_deliver_time) != 0)
844 s = string_append(s, &size, &ptr, 2, US" DT=",
845 readconf_printtime(addr->more_errno));
848 /* string_cat() always leaves room for the terminator. Release the
849 store we used to build the line after writing it. */
852 log_write(0, flags, "%s", s);
854 #ifdef EXPERIMENTAL_TPDA
855 if (addr->transport->tpda_delivery_action)
858 debug_printf(" TPDA(Delivery): tpda_deliver_action=|%s| tpda_delivery_IP=%s\n",
859 addr->transport->tpda_delivery_action, tpda_delivery_ip);
861 router_name = addr->router->name;
862 transport_name = addr->transport->name;
863 expand_string(addr->transport->tpda_delivery_action);
865 transport_name = NULL;
868 store_reset(reset_point);
874 /*************************************************
875 * Actions at the end of handling an address *
876 *************************************************/
878 /* This is a function for processing a single address when all that can be done
879 with it has been done.
882 addr points to the address block
883 result the result of the delivery attempt
884 logflags flags for log_write() (LOG_MAIN and/or LOG_PANIC)
885 driver_type indicates which type of driver (transport, or router) was last
886 to process the address
887 logchar '=' or '-' for use when logging deliveries with => or ->
893 post_process_one(address_item *addr, int result, int logflags, int driver_type,
896 uschar *now = tod_stamp(tod_log);
897 uschar *driver_kind = NULL;
898 uschar *driver_name = NULL;
901 int size = 256; /* Used for a temporary, */
902 int ptr = 0; /* expanding buffer, for */
903 uschar *s; /* building log lines; */
904 void *reset_point; /* released afterwards. */
907 DEBUG(D_deliver) debug_printf("post-process %s (%d)\n", addr->address, result);
909 /* Set up driver kind and name for logging. Disable logging if the router or
910 transport has disabled it. */
912 if (driver_type == DTYPE_TRANSPORT)
914 if (addr->transport != NULL)
916 driver_name = addr->transport->name;
917 driver_kind = US" transport";
918 disable_logging = addr->transport->disable_logging;
920 else driver_kind = US"transporting";
922 else if (driver_type == DTYPE_ROUTER)
924 if (addr->router != NULL)
926 driver_name = addr->router->name;
927 driver_kind = US" router";
928 disable_logging = addr->router->disable_logging;
930 else driver_kind = US"routing";
933 /* If there's an error message set, ensure that it contains only printing
934 characters - it should, but occasionally things slip in and this at least
935 stops the log format from getting wrecked. We also scan the message for an LDAP
936 expansion item that has a password setting, and flatten the password. This is a
937 fudge, but I don't know a cleaner way of doing this. (If the item is badly
938 malformed, it won't ever have gone near LDAP.) */
940 if (addr->message != NULL)
942 addr->message = string_printing(addr->message);
943 if (((Ustrstr(addr->message, "failed to expand") != NULL) || (Ustrstr(addr->message, "expansion of ") != NULL)) &&
944 (Ustrstr(addr->message, "mysql") != NULL ||
945 Ustrstr(addr->message, "pgsql") != NULL ||
946 Ustrstr(addr->message, "sqlite") != NULL ||
947 Ustrstr(addr->message, "ldap:") != NULL ||
948 Ustrstr(addr->message, "ldapdn:") != NULL ||
949 Ustrstr(addr->message, "ldapm:") != NULL))
951 addr->message = string_sprintf("Temporary internal error");
955 /* If we used a transport that has one of the "return_output" options set, and
956 if it did in fact generate some output, then for return_output we treat the
957 message as failed if it was not already set that way, so that the output gets
958 returned to the sender, provided there is a sender to send it to. For
959 return_fail_output, do this only if the delivery failed. Otherwise we just
960 unlink the file, and remove the name so that if the delivery failed, we don't
961 try to send back an empty or unwanted file. The log_output options operate only
964 In any case, we close the message file, because we cannot afford to leave a
965 file-descriptor for one address while processing (maybe very many) others. */
967 if (addr->return_file >= 0 && addr->return_filename != NULL)
969 BOOL return_output = FALSE;
971 (void)EXIMfsync(addr->return_file);
973 /* If there is no output, do nothing. */
975 if (fstat(addr->return_file, &statbuf) == 0 && statbuf.st_size > 0)
977 transport_instance *tb = addr->transport;
979 /* Handle logging options */
981 if (tb->log_output || (result == FAIL && tb->log_fail_output) ||
982 (result == DEFER && tb->log_defer_output))
985 FILE *f = Ufopen(addr->return_filename, "rb");
987 log_write(0, LOG_MAIN|LOG_PANIC, "failed to open %s to log output "
988 "from %s transport: %s", addr->return_filename, tb->name,
992 s = US Ufgets(big_buffer, big_buffer_size, f);
995 uschar *p = big_buffer + Ustrlen(big_buffer);
996 while (p > big_buffer && isspace(p[-1])) p--;
998 s = string_printing(big_buffer);
999 log_write(0, LOG_MAIN, "<%s>: %s transport output: %s",
1000 addr->address, tb->name, s);
1006 /* Handle returning options, but only if there is an address to return
1009 if (sender_address[0] != 0 || addr->p.errors_address != NULL)
1011 if (tb->return_output)
1013 addr->transport_return = result = FAIL;
1014 if (addr->basic_errno == 0 && addr->message == NULL)
1015 addr->message = US"return message generated";
1016 return_output = TRUE;
1019 if (tb->return_fail_output && result == FAIL) return_output = TRUE;
1023 /* Get rid of the file unless it might be returned, but close it in
1028 Uunlink(addr->return_filename);
1029 addr->return_filename = NULL;
1030 addr->return_file = -1;
1033 (void)close(addr->return_file);
1036 /* The sucess case happens only after delivery by a transport. */
1040 addr->next = addr_succeed;
1041 addr_succeed = addr;
1043 /* Call address_done() to ensure that we don't deliver to this address again,
1044 and write appropriate things to the message log. If it is a child address, we
1045 call child_done() to scan the ancestors and mark them complete if this is the
1046 last child to complete. */
1048 address_done(addr, now);
1049 DEBUG(D_deliver) debug_printf("%s delivered\n", addr->address);
1051 if (addr->parent == NULL)
1053 deliver_msglog("%s %s: %s%s succeeded\n", now, addr->address,
1054 driver_name, driver_kind);
1058 deliver_msglog("%s %s <%s>: %s%s succeeded\n", now, addr->address,
1059 addr->parent->address, driver_name, driver_kind);
1060 child_done(addr, now);
1063 delivery_log(LOG_MAIN, addr, logchar, NULL);
1067 /* Soft failure, or local delivery process failed; freezing may be
1070 else if (result == DEFER || result == PANIC)
1072 if (result == PANIC) logflags |= LOG_PANIC;
1074 /* This puts them on the chain in reverse order. Do not change this, because
1075 the code for handling retries assumes that the one with the retry
1076 information is last. */
1078 addr->next = addr_defer;
1081 /* The only currently implemented special action is to freeze the
1082 message. Logging of this is done later, just before the -H file is
1085 if (addr->special_action == SPECIAL_FREEZE)
1087 deliver_freeze = TRUE;
1088 deliver_frozen_at = time(NULL);
1089 update_spool = TRUE;
1092 /* If doing a 2-stage queue run, we skip writing to either the message
1093 log or the main log for SMTP defers. */
1095 if (!queue_2stage || addr->basic_errno != 0)
1099 /* For errors of the type "retry time not reached" (also remotes skipped
1100 on queue run), logging is controlled by L_retry_defer. Note that this kind
1101 of error number is negative, and all the retry ones are less than any
1104 unsigned int use_log_selector = (addr->basic_errno <= ERRNO_RETRY_BASE)?
1107 /* Build up the line that is used for both the message log and the main
1110 s = reset_point = store_get(size);
1112 /* Create the address string for logging. Must not do this earlier, because
1113 an OK result may be changed to FAIL when a pipe returns text. */
1115 log_address = string_log_address(addr,
1116 (log_write_selector & L_all_parents) != 0, result == OK);
1118 s = string_cat(s, &size, &ptr, log_address, Ustrlen(log_address));
1120 /* Either driver_name contains something and driver_kind contains
1121 " router" or " transport" (note the leading space), or driver_name is
1122 a null string and driver_kind contains "routing" without the leading
1123 space, if all routing has been deferred. When a domain has been held,
1124 so nothing has been done at all, both variables contain null strings. */
1126 if (driver_name == NULL)
1128 if (driver_kind != NULL)
1129 s = string_append(s, &size, &ptr, 2, US" ", driver_kind);
1133 if (driver_kind[1] == 't' && addr->router != NULL)
1134 s = string_append(s, &size, &ptr, 2, US" R=", addr->router->name);
1136 ss[1] = toupper(driver_kind[1]);
1137 s = string_append(s, &size, &ptr, 2, ss, driver_name);
1140 sprintf(CS ss, " defer (%d)", addr->basic_errno);
1141 s = string_cat(s, &size, &ptr, ss, Ustrlen(ss));
1143 if (addr->basic_errno > 0)
1144 s = string_append(s, &size, &ptr, 2, US": ",
1145 US strerror(addr->basic_errno));
1147 if (addr->message != NULL)
1148 s = string_append(s, &size, &ptr, 2, US": ", addr->message);
1152 /* Log the deferment in the message log, but don't clutter it
1153 up with retry-time defers after the first delivery attempt. */
1155 if (deliver_firsttime || addr->basic_errno > ERRNO_RETRY_BASE)
1156 deliver_msglog("%s %s\n", now, s);
1158 /* Write the main log and reset the store */
1160 log_write(use_log_selector, logflags, "== %s", s);
1161 store_reset(reset_point);
1166 /* Hard failure. If there is an address to which an error message can be sent,
1167 put this address on the failed list. If not, put it on the deferred list and
1168 freeze the mail message for human attention. The latter action can also be
1169 explicitly requested by a router or transport. */
1173 /* If this is a delivery error, or a message for which no replies are
1174 wanted, and the message's age is greater than ignore_bounce_errors_after,
1175 force the af_ignore_error flag. This will cause the address to be discarded
1176 later (with a log entry). */
1178 if (sender_address[0] == 0 && message_age >= ignore_bounce_errors_after)
1179 setflag(addr, af_ignore_error);
1181 /* Freeze the message if requested, or if this is a bounce message (or other
1182 message with null sender) and this address does not have its own errors
1183 address. However, don't freeze if errors are being ignored. The actual code
1184 to ignore occurs later, instead of sending a message. Logging of freezing
1185 occurs later, just before writing the -H file. */
1187 if (!testflag(addr, af_ignore_error) &&
1188 (addr->special_action == SPECIAL_FREEZE ||
1189 (sender_address[0] == 0 && addr->p.errors_address == NULL)
1192 frozen_info = (addr->special_action == SPECIAL_FREEZE)? US"" :
1193 (sender_local && !local_error_message)?
1194 US" (message created with -f <>)" : US" (delivery error message)";
1195 deliver_freeze = TRUE;
1196 deliver_frozen_at = time(NULL);
1197 update_spool = TRUE;
1199 /* The address is put on the defer rather than the failed queue, because
1200 the message is being retained. */
1202 addr->next = addr_defer;
1206 /* Don't put the address on the nonrecipients tree yet; wait until an
1207 error message has been successfully sent. */
1211 addr->next = addr_failed;
1215 /* Build up the log line for the message and main logs */
1217 s = reset_point = store_get(size);
1219 /* Create the address string for logging. Must not do this earlier, because
1220 an OK result may be changed to FAIL when a pipe returns text. */
1222 log_address = string_log_address(addr,
1223 (log_write_selector & L_all_parents) != 0, result == OK);
1225 s = string_cat(s, &size, &ptr, log_address, Ustrlen(log_address));
1227 if ((log_extra_selector & LX_sender_on_delivery) != 0)
1228 s = string_append(s, &size, &ptr, 3, US" F=<", sender_address, US">");
1230 /* Return path may not be set if no delivery actually happened */
1232 if (used_return_path != NULL &&
1233 (log_extra_selector & LX_return_path_on_delivery) != 0)
1235 s = string_append(s, &size, &ptr, 3, US" P=<", used_return_path, US">");
1238 if (addr->router != NULL)
1239 s = string_append(s, &size, &ptr, 2, US" R=", addr->router->name);
1240 if (addr->transport != NULL)
1241 s = string_append(s, &size, &ptr, 2, US" T=", addr->transport->name);
1243 if (addr->host_used != NULL)
1244 s = string_append(s, &size, &ptr, 5, US" H=", addr->host_used->name,
1245 US" [", addr->host_used->address, US"]");
1247 if (addr->basic_errno > 0)
1248 s = string_append(s, &size, &ptr, 2, US": ",
1249 US strerror(addr->basic_errno));
1251 if (addr->message != NULL)
1252 s = string_append(s, &size, &ptr, 2, US": ", addr->message);
1256 /* Do the logging. For the message log, "routing failed" for those cases,
1257 just to make it clearer. */
1259 if (driver_name == NULL)
1260 deliver_msglog("%s %s failed for %s\n", now, driver_kind, s);
1262 deliver_msglog("%s %s\n", now, s);
1264 log_write(0, LOG_MAIN, "** %s", s);
1265 store_reset(reset_point);
1268 /* Ensure logging is turned on again in all cases */
1270 disable_logging = FALSE;
1276 /*************************************************
1277 * Address-independent error *
1278 *************************************************/
1280 /* This function is called when there's an error that is not dependent on a
1281 particular address, such as an expansion string failure. It puts the error into
1282 all the addresses in a batch, logs the incident on the main and panic logs, and
1283 clears the expansions. It is mostly called from local_deliver(), but can be
1284 called for a remote delivery via findugid().
1287 logit TRUE if (MAIN+PANIC) logging required
1288 addr the first of the chain of addresses
1290 format format string for error message, or NULL if already set in addr
1291 ... arguments for the format
1297 common_error(BOOL logit, address_item *addr, int code, uschar *format, ...)
1299 address_item *addr2;
1300 addr->basic_errno = code;
1306 va_start(ap, format);
1307 if (!string_vformat(buffer, sizeof(buffer), CS format, ap))
1308 log_write(0, LOG_MAIN|LOG_PANIC_DIE,
1309 "common_error expansion was longer than " SIZE_T_FMT, sizeof(buffer));
1311 addr->message = string_copy(buffer);
1314 for (addr2 = addr->next; addr2 != NULL; addr2 = addr2->next)
1316 addr2->basic_errno = code;
1317 addr2->message = addr->message;
1320 if (logit) log_write(0, LOG_MAIN|LOG_PANIC, "%s", addr->message);
1321 deliver_set_expansions(NULL);
1327 /*************************************************
1328 * Check a "never users" list *
1329 *************************************************/
1331 /* This function is called to check whether a uid is on one of the two "never
1335 uid the uid to be checked
1336 nusers the list to be scanned; the first item in the list is the count
1338 Returns: TRUE if the uid is on the list
1342 check_never_users(uid_t uid, uid_t *nusers)
1345 if (nusers == NULL) return FALSE;
1346 for (i = 1; i <= (int)(nusers[0]); i++) if (nusers[i] == uid) return TRUE;
1352 /*************************************************
1353 * Find uid and gid for a transport *
1354 *************************************************/
1356 /* This function is called for both local and remote deliveries, to find the
1357 uid/gid under which to run the delivery. The values are taken preferentially
1358 from the transport (either explicit or deliver_as_creator), then from the
1359 address (i.e. the router), and if nothing is set, the exim uid/gid are used. If
1360 the resulting uid is on the "never_users" or the "fixed_never_users" list, a
1361 panic error is logged, and the function fails (which normally leads to delivery
1365 addr the address (possibly a chain)
1367 uidp pointer to uid field
1368 gidp pointer to gid field
1369 igfp pointer to the use_initgroups field
1371 Returns: FALSE if failed - error has been set in address(es)
1375 findugid(address_item *addr, transport_instance *tp, uid_t *uidp, gid_t *gidp,
1378 uschar *nuname = NULL;
1379 BOOL gid_set = FALSE;
1381 /* Default initgroups flag comes from the transport */
1383 *igfp = tp->initgroups;
1385 /* First see if there's a gid on the transport, either fixed or expandable.
1386 The expanding function always logs failure itself. */
1393 else if (tp->expand_gid != NULL)
1395 if (route_find_expanded_group(tp->expand_gid, tp->name, US"transport", gidp,
1396 &(addr->message))) gid_set = TRUE;
1399 common_error(FALSE, addr, ERRNO_GIDFAIL, NULL);
1404 /* If the transport did not set a group, see if the router did. */
1406 if (!gid_set && testflag(addr, af_gid_set))
1412 /* Pick up a uid from the transport if one is set. */
1414 if (tp->uid_set) *uidp = tp->uid;
1416 /* Otherwise, try for an expandable uid field. If it ends up as a numeric id,
1417 it does not provide a passwd value from which a gid can be taken. */
1419 else if (tp->expand_uid != NULL)
1422 if (!route_find_expanded_user(tp->expand_uid, tp->name, US"transport", &pw,
1423 uidp, &(addr->message)))
1425 common_error(FALSE, addr, ERRNO_UIDFAIL, NULL);
1428 if (!gid_set && pw != NULL)
1435 /* If the transport doesn't set the uid, test the deliver_as_creator flag. */
1437 else if (tp->deliver_as_creator)
1439 *uidp = originator_uid;
1442 *gidp = originator_gid;
1447 /* Otherwise see if the address specifies the uid and if so, take it and its
1450 else if (testflag(addr, af_uid_set))
1453 *igfp = testflag(addr, af_initgroups);
1456 /* Nothing has specified the uid - default to the Exim user, and group if the
1469 /* If no gid is set, it is a disaster. We default to the Exim gid only if
1470 defaulting to the Exim uid. In other words, if the configuration has specified
1471 a uid, it must also provide a gid. */
1475 common_error(TRUE, addr, ERRNO_GIDFAIL, US"User set without group for "
1476 "%s transport", tp->name);
1480 /* Check that the uid is not on the lists of banned uids that may not be used
1481 for delivery processes. */
1483 if (check_never_users(*uidp, never_users))
1484 nuname = US"never_users";
1485 else if (check_never_users(*uidp, fixed_never_users))
1486 nuname = US"fixed_never_users";
1490 common_error(TRUE, addr, ERRNO_UIDFAIL, US"User %ld set for %s transport "
1491 "is on the %s list", (long int)(*uidp), tp->name, nuname);
1503 /*************************************************
1504 * Check the size of a message for a transport *
1505 *************************************************/
1507 /* Checks that the message isn't too big for the selected transport.
1508 This is called only when it is known that the limit is set.
1512 addr the (first) address being delivered
1515 DEFER expansion failed or did not yield an integer
1516 FAIL message too big
1520 check_message_size(transport_instance *tp, address_item *addr)
1525 deliver_set_expansions(addr);
1526 size_limit = expand_string_integer(tp->message_size_limit, TRUE);
1527 deliver_set_expansions(NULL);
1529 if (expand_string_message != NULL)
1532 if (size_limit == -1)
1533 addr->message = string_sprintf("failed to expand message_size_limit "
1534 "in %s transport: %s", tp->name, expand_string_message);
1536 addr->message = string_sprintf("invalid message_size_limit "
1537 "in %s transport: %s", tp->name, expand_string_message);
1539 else if (size_limit > 0 && message_size > size_limit)
1543 string_sprintf("message is too big (transport limit = %d)",
1552 /*************************************************
1553 * Transport-time check for a previous delivery *
1554 *************************************************/
1556 /* Check that this base address hasn't previously been delivered to its routed
1557 transport. If it has been delivered, mark it done. The check is necessary at
1558 delivery time in order to handle homonymic addresses correctly in cases where
1559 the pattern of redirection changes between delivery attempts (so the unique
1560 fields change). Non-homonymic previous delivery is detected earlier, at routing
1561 time (which saves unnecessary routing).
1564 addr the address item
1565 testing TRUE if testing wanted only, without side effects
1567 Returns: TRUE if previously delivered by the transport
1571 previously_transported(address_item *addr, BOOL testing)
1573 (void)string_format(big_buffer, big_buffer_size, "%s/%s",
1574 addr->unique + (testflag(addr, af_homonym)? 3:0), addr->transport->name);
1576 if (tree_search(tree_nonrecipients, big_buffer) != 0)
1578 DEBUG(D_deliver|D_route|D_transport)
1579 debug_printf("%s was previously delivered (%s transport): discarded\n",
1580 addr->address, addr->transport->name);
1581 if (!testing) child_done(addr, tod_stamp(tod_log));
1590 /******************************************************
1591 * Check for a given header in a header string *
1592 ******************************************************/
1594 /* This function is used when generating quota warnings. The configuration may
1595 specify any header lines it likes in quota_warn_message. If certain of them are
1596 missing, defaults are inserted, so we need to be able to test for the presence
1600 hdr the required header name
1601 hstring the header string
1603 Returns: TRUE the header is in the string
1604 FALSE the header is not in the string
1608 contains_header(uschar *hdr, uschar *hstring)
1610 int len = Ustrlen(hdr);
1611 uschar *p = hstring;
1614 if (strncmpic(p, hdr, len) == 0)
1617 while (*p == ' ' || *p == '\t') p++;
1618 if (*p == ':') return TRUE;
1620 while (*p != 0 && *p != '\n') p++;
1621 if (*p == '\n') p++;
1629 /*************************************************
1630 * Perform a local delivery *
1631 *************************************************/
1633 /* Each local delivery is performed in a separate process which sets its
1634 uid and gid as specified. This is a safer way than simply changing and
1635 restoring using seteuid(); there is a body of opinion that seteuid() cannot be
1636 used safely. From release 4, Exim no longer makes any use of it. Besides, not
1637 all systems have seteuid().
1639 If the uid/gid are specified in the transport_instance, they are used; the
1640 transport initialization must ensure that either both or neither are set.
1641 Otherwise, the values associated with the address are used. If neither are set,
1642 it is a configuration error.
1644 The transport or the address may specify a home directory (transport over-
1645 rides), and if they do, this is set as $home. If neither have set a working
1646 directory, this value is used for that as well. Otherwise $home is left unset
1647 and the cwd is set to "/" - a directory that should be accessible to all users.
1649 Using a separate process makes it more complicated to get error information
1650 back. We use a pipe to pass the return code and also an error code and error
1651 text string back to the parent process.
1654 addr points to an address block for this delivery; for "normal" local
1655 deliveries this is the only address to be delivered, but for
1656 pseudo-remote deliveries (e.g. by batch SMTP to a file or pipe)
1657 a number of addresses can be handled simultaneously, and in this
1658 case addr will point to a chain of addresses with the same
1661 shadowing TRUE if running a shadow transport; this causes output from pipes
1668 deliver_local(address_item *addr, BOOL shadowing)
1670 BOOL use_initgroups;
1673 int status, len, rc;
1676 uschar *working_directory;
1677 address_item *addr2;
1678 transport_instance *tp = addr->transport;
1680 /* Set up the return path from the errors or sender address. If the transport
1681 has its own return path setting, expand it and replace the existing value. */
1683 if(addr->p.errors_address != NULL)
1684 return_path = addr->p.errors_address;
1685 #ifdef EXPERIMENTAL_SRS
1686 else if(addr->p.srs_sender != NULL)
1687 return_path = addr->p.srs_sender;
1690 return_path = sender_address;
1692 if (tp->return_path != NULL)
1694 uschar *new_return_path = expand_string(tp->return_path);
1695 if (new_return_path == NULL)
1697 if (!expand_string_forcedfail)
1699 common_error(TRUE, addr, ERRNO_EXPANDFAIL,
1700 US"Failed to expand return path \"%s\" in %s transport: %s",
1701 tp->return_path, tp->name, expand_string_message);
1705 else return_path = new_return_path;
1708 /* For local deliveries, one at a time, the value used for logging can just be
1709 set directly, once and for all. */
1711 used_return_path = return_path;
1713 /* Sort out the uid, gid, and initgroups flag. If an error occurs, the message
1714 gets put into the address(es), and the expansions are unset, so we can just
1717 if (!findugid(addr, tp, &uid, &gid, &use_initgroups)) return;
1719 /* See if either the transport or the address specifies a home directory. A
1720 home directory set in the address may already be expanded; a flag is set to
1721 indicate that. In other cases we must expand it. */
1723 if ((deliver_home = tp->home_dir) != NULL || /* Set in transport, or */
1724 ((deliver_home = addr->home_dir) != NULL && /* Set in address and */
1725 !testflag(addr, af_home_expanded))) /* not expanded */
1727 uschar *rawhome = deliver_home;
1728 deliver_home = NULL; /* in case it contains $home */
1729 deliver_home = expand_string(rawhome);
1730 if (deliver_home == NULL)
1732 common_error(TRUE, addr, ERRNO_EXPANDFAIL, US"home directory \"%s\" failed "
1733 "to expand for %s transport: %s", rawhome, tp->name,
1734 expand_string_message);
1737 if (*deliver_home != '/')
1739 common_error(TRUE, addr, ERRNO_NOTABSOLUTE, US"home directory path \"%s\" "
1740 "is not absolute for %s transport", deliver_home, tp->name);
1745 /* See if either the transport or the address specifies a current directory,
1746 and if so, expand it. If nothing is set, use the home directory, unless it is
1747 also unset in which case use "/", which is assumed to be a directory to which
1748 all users have access. It is necessary to be in a visible directory for some
1749 operating systems when running pipes, as some commands (e.g. "rm" under Solaris
1750 2.5) require this. */
1752 working_directory = (tp->current_dir != NULL)?
1753 tp->current_dir : addr->current_dir;
1755 if (working_directory != NULL)
1757 uschar *raw = working_directory;
1758 working_directory = expand_string(raw);
1759 if (working_directory == NULL)
1761 common_error(TRUE, addr, ERRNO_EXPANDFAIL, US"current directory \"%s\" "
1762 "failed to expand for %s transport: %s", raw, tp->name,
1763 expand_string_message);
1766 if (*working_directory != '/')
1768 common_error(TRUE, addr, ERRNO_NOTABSOLUTE, US"current directory path "
1769 "\"%s\" is not absolute for %s transport", working_directory, tp->name);
1773 else working_directory = (deliver_home == NULL)? US"/" : deliver_home;
1775 /* If one of the return_output flags is set on the transport, create and open a
1776 file in the message log directory for the transport to write its output onto.
1777 This is mainly used by pipe transports. The file needs to be unique to the
1778 address. This feature is not available for shadow transports. */
1780 if (!shadowing && (tp->return_output || tp->return_fail_output ||
1781 tp->log_output || tp->log_fail_output))
1784 addr->return_filename =
1785 string_sprintf("%s/msglog/%s/%s-%d-%d", spool_directory, message_subdir,
1786 message_id, getpid(), return_count++);
1787 addr->return_file = open_msglog_file(addr->return_filename, 0400, &error);
1788 if (addr->return_file < 0)
1790 common_error(TRUE, addr, errno, US"Unable to %s file for %s transport "
1791 "to return message: %s", error, tp->name, strerror(errno));
1796 /* Create the pipe for inter-process communication. */
1800 common_error(TRUE, addr, ERRNO_PIPEFAIL, US"Creation of pipe failed: %s",
1805 /* Now fork the process to do the real work in the subprocess, but first
1806 ensure that all cached resources are freed so that the subprocess starts with
1807 a clean slate and doesn't interfere with the parent process. */
1811 if ((pid = fork()) == 0)
1813 BOOL replicate = TRUE;
1815 /* Prevent core dumps, as we don't want them in users' home directories.
1816 HP-UX doesn't have RLIMIT_CORE; I don't know how to do this in that
1817 system. Some experimental/developing systems (e.g. GNU/Hurd) may define
1818 RLIMIT_CORE but not support it in setrlimit(). For such systems, do not
1819 complain if the error is "not supported".
1821 There are two scenarios where changing the max limit has an effect. In one,
1822 the user is using a .forward and invoking a command of their choice via pipe;
1823 for these, we do need the max limit to be 0 unless the admin chooses to
1824 permit an increased limit. In the other, the command is invoked directly by
1825 the transport and is under administrator control, thus being able to raise
1826 the limit aids in debugging. So there's no general always-right answer.
1828 Thus we inhibit core-dumps completely but let individual transports, while
1829 still root, re-raise the limits back up to aid debugging. We make the
1830 default be no core-dumps -- few enough people can use core dumps in
1831 diagnosis that it's reasonable to make them something that has to be explicitly requested.
1838 if (setrlimit(RLIMIT_CORE, &rl) < 0)
1840 #ifdef SETRLIMIT_NOT_SUPPORTED
1841 if (errno != ENOSYS && errno != ENOTSUP)
1843 log_write(0, LOG_MAIN|LOG_PANIC, "setrlimit(RLIMIT_CORE) failed: %s",
1848 /* Reset the random number generator, so different processes don't all
1849 have the same sequence. */
1853 /* If the transport has a setup entry, call this first, while still
1854 privileged. (Appendfile uses this to expand quota, for example, while
1855 able to read private files.) */
1857 if (addr->transport->setup != NULL)
1859 switch((addr->transport->setup)(addr->transport, addr, NULL, uid, gid,
1863 addr->transport_return = DEFER;
1867 addr->transport_return = PANIC;
1872 /* Ignore SIGINT and SIGTERM during delivery. Also ignore SIGUSR1, as
1873 when the process becomes unprivileged, it won't be able to write to the
1874 process log. SIGHUP is ignored throughout exim, except when it is being
1877 signal(SIGINT, SIG_IGN);
1878 signal(SIGTERM, SIG_IGN);
1879 signal(SIGUSR1, SIG_IGN);
1881 /* Close the unwanted half of the pipe, and set close-on-exec for the other
1882 half - for transports that exec things (e.g. pipe). Then set the required
1885 (void)close(pfd[pipe_read]);
1886 (void)fcntl(pfd[pipe_write], F_SETFD, fcntl(pfd[pipe_write], F_GETFD) |
1888 exim_setugid(uid, gid, use_initgroups,
1889 string_sprintf("local delivery to %s <%s> transport=%s", addr->local_part,
1890 addr->address, addr->transport->name));
1894 address_item *batched;
1895 debug_printf(" home=%s current=%s\n", deliver_home, working_directory);
1896 for (batched = addr->next; batched != NULL; batched = batched->next)
1897 debug_printf("additional batched address: %s\n", batched->address);
1900 /* Set an appropriate working directory. */
1902 if (Uchdir(working_directory) < 0)
1904 addr->transport_return = DEFER;
1905 addr->basic_errno = errno;
1906 addr->message = string_sprintf("failed to chdir to %s", working_directory);
1909 /* If successful, call the transport */
1914 set_process_info("delivering %s to %s using %s", message_id,
1915 addr->local_part, addr->transport->name);
1917 /* Setting this global in the subprocess means we need never clear it */
1918 transport_name = addr->transport->name;
1920 /* If a transport filter has been specified, set up its argument list.
1921 Any errors will get put into the address, and FALSE yielded. */
1923 if (addr->transport->filter_command != NULL)
1925 ok = transport_set_up_command(&transport_filter_argv,
1926 addr->transport->filter_command,
1927 TRUE, PANIC, addr, US"transport filter", NULL);
1928 transport_filter_timeout = addr->transport->filter_timeout;
1930 else transport_filter_argv = NULL;
1934 debug_print_string(addr->transport->debug_string);
1935 replicate = !(addr->transport->info->code)(addr->transport, addr);
1939 /* Pass the results back down the pipe. If necessary, first replicate the
1940 status in the top address to the others in the batch. The label is the
1941 subject of a goto when a call to the transport's setup function fails. We
1942 pass the pointer to the transport back in case it got changed as a result of
1943 file_format in appendfile. */
1947 if (replicate) replicate_status(addr);
1948 for (addr2 = addr; addr2 != NULL; addr2 = addr2->next)
1951 int local_part_length = Ustrlen(addr2->local_part);
1955 if( (ret = write(pfd[pipe_write], (void *)&(addr2->transport_return), sizeof(int))) != sizeof(int)
1956 || (ret = write(pfd[pipe_write], (void *)&transport_count, sizeof(transport_count))) != sizeof(transport_count)
1957 || (ret = write(pfd[pipe_write], (void *)&(addr2->flags), sizeof(addr2->flags))) != sizeof(addr2->flags)
1958 || (ret = write(pfd[pipe_write], (void *)&(addr2->basic_errno), sizeof(int))) != sizeof(int)
1959 || (ret = write(pfd[pipe_write], (void *)&(addr2->more_errno), sizeof(int))) != sizeof(int)
1960 || (ret = write(pfd[pipe_write], (void *)&(addr2->special_action), sizeof(int))) != sizeof(int)
1961 || (ret = write(pfd[pipe_write], (void *)&(addr2->transport),
1962 sizeof(transport_instance *))) != sizeof(transport_instance *)
1964 /* For a file delivery, pass back the local part, in case the original
1965 was only part of the final delivery path. This gives more complete
1968 || (testflag(addr2, af_file)
1969 && ( (ret = write(pfd[pipe_write], (void *)&local_part_length, sizeof(int))) != sizeof(int)
1970 || (ret = write(pfd[pipe_write], addr2->local_part, local_part_length)) != local_part_length
1974 log_write(0, LOG_MAIN|LOG_PANIC, "Failed writing transport results to pipe: %s\n",
1975 ret == -1 ? strerror(errno) : "short write");
1977 /* Now any messages */
1979 for (i = 0, s = addr2->message; i < 2; i++, s = addr2->user_message)
1981 int message_length = (s == NULL)? 0 : Ustrlen(s) + 1;
1982 if( (ret = write(pfd[pipe_write], (void *)&message_length, sizeof(int))) != sizeof(int)
1983 || (message_length > 0 && (ret = write(pfd[pipe_write], s, message_length)) != message_length)
1985 log_write(0, LOG_MAIN|LOG_PANIC, "Failed writing transport results to pipe: %s\n",
1986 ret == -1 ? strerror(errno) : "short write");
1990 /* OK, this process is now done. Free any cached resources that it opened,
1991 and close the pipe we were writing down before exiting. */
1993 (void)close(pfd[pipe_write]);
1998 /* Back in the main process: panic if the fork did not succeed. This seems
1999 better than returning an error - if forking is failing it is probably best
2000 not to try other deliveries for this message. */
2003 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Fork failed for local delivery to %s",
2006 /* Read the pipe to get the delivery status codes and error messages. Our copy
2007 of the writing end must be closed first, as otherwise read() won't return zero
2008 on an empty pipe. We check that a status exists for each address before
2009 overwriting the address structure. If data is missing, the default DEFER status
2010 will remain. Afterwards, close the reading end. */
2012 (void)close(pfd[pipe_write]);
2014 for (addr2 = addr; addr2 != NULL; addr2 = addr2->next)
2016 len = read(pfd[pipe_read], (void *)&status, sizeof(int));
2022 addr2->transport_return = status;
2023 len = read(pfd[pipe_read], (void *)&transport_count,
2024 sizeof(transport_count));
2025 len = read(pfd[pipe_read], (void *)&(addr2->flags), sizeof(addr2->flags));
2026 len = read(pfd[pipe_read], (void *)&(addr2->basic_errno), sizeof(int));
2027 len = read(pfd[pipe_read], (void *)&(addr2->more_errno), sizeof(int));
2028 len = read(pfd[pipe_read], (void *)&(addr2->special_action), sizeof(int));
2029 len = read(pfd[pipe_read], (void *)&(addr2->transport),
2030 sizeof(transport_instance *));
2032 if (testflag(addr2, af_file))
2034 int local_part_length;
2035 len = read(pfd[pipe_read], (void *)&local_part_length, sizeof(int));
2036 len = read(pfd[pipe_read], (void *)big_buffer, local_part_length);
2037 big_buffer[local_part_length] = 0;
2038 addr2->local_part = string_copy(big_buffer);
2041 for (i = 0, sptr = &(addr2->message); i < 2;
2042 i++, sptr = &(addr2->user_message))
2045 len = read(pfd[pipe_read], (void *)&message_length, sizeof(int));
2046 if (message_length > 0)
2048 len = read(pfd[pipe_read], (void *)big_buffer, message_length);
2049 if (len > 0) *sptr = string_copy(big_buffer);
2056 log_write(0, LOG_MAIN|LOG_PANIC, "failed to read delivery status for %s "
2057 "from delivery subprocess", addr2->unique);
2062 (void)close(pfd[pipe_read]);
2064 /* Unless shadowing, write all successful addresses immediately to the journal
2065 file, to ensure they are recorded asap. For homonymic addresses, use the base
2066 address plus the transport name. Failure to write the journal is panic-worthy,
2067 but don't stop, as it may prove possible subsequently to update the spool file
2068 in order to record the delivery. */
2072 for (addr2 = addr; addr2 != NULL; addr2 = addr2->next)
2074 if (addr2->transport_return != OK) continue;
2076 if (testflag(addr2, af_homonym))
2077 sprintf(CS big_buffer, "%.500s/%s\n", addr2->unique + 3, tp->name);
2079 sprintf(CS big_buffer, "%.500s\n", addr2->unique);
2081 /* In the test harness, wait just a bit to let the subprocess finish off
2082 any debug output etc first. */
2084 if (running_in_test_harness) millisleep(300);
2086 DEBUG(D_deliver) debug_printf("journalling %s", big_buffer);
2087 len = Ustrlen(big_buffer);
2088 if (write(journal_fd, big_buffer, len) != len)
2089 log_write(0, LOG_MAIN|LOG_PANIC, "failed to update journal for %s: %s",
2090 big_buffer, strerror(errno));
2093 /* Ensure the journal file is pushed out to disk. */
2095 if (EXIMfsync(journal_fd) < 0)
2096 log_write(0, LOG_MAIN|LOG_PANIC, "failed to fsync journal: %s",
2100 /* Wait for the process to finish. If it terminates with a non-zero code,
2101 freeze the message (except for SIGTERM, SIGKILL and SIGQUIT), but leave the
2102 status values of all the addresses as they are. Take care to handle the case
2103 when the subprocess doesn't seem to exist. This has been seen on one system
2104 when Exim was called from an MUA that set SIGCHLD to SIG_IGN. When that
2105 happens, wait() doesn't recognize the termination of child processes. Exim now
2106 resets SIGCHLD to SIG_DFL, but this code should still be robust. */
2108 while ((rc = wait(&status)) != pid)
2110 if (rc < 0 && errno == ECHILD) /* Process has vanished */
2112 log_write(0, LOG_MAIN, "%s transport process vanished unexpectedly",
2113 addr->transport->driver_name);
2119 if ((status & 0xffff) != 0)
2121 int msb = (status >> 8) & 255;
2122 int lsb = status & 255;
2123 int code = (msb == 0)? (lsb & 0x7f) : msb;
2124 if (msb != 0 || (code != SIGTERM && code != SIGKILL && code != SIGQUIT))
2125 addr->special_action = SPECIAL_FREEZE;
2126 log_write(0, LOG_MAIN|LOG_PANIC, "%s transport process returned non-zero "
2127 "status 0x%04x: %s %d",
2128 addr->transport->driver_name,
2130 (msb == 0)? "terminated by signal" : "exit code",
2134 /* If SPECIAL_WARN is set in the top address, send a warning message. */
2136 if (addr->special_action == SPECIAL_WARN &&
2137 addr->transport->warn_message != NULL)
2140 uschar *warn_message;
2142 DEBUG(D_deliver) debug_printf("Warning message requested by transport\n");
2144 warn_message = expand_string(addr->transport->warn_message);
2145 if (warn_message == NULL)
2146 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand \"%s\" (warning "
2147 "message for %s transport): %s", addr->transport->warn_message,
2148 addr->transport->name, expand_string_message);
2151 pid_t pid = child_open_exim(&fd);
2154 FILE *f = fdopen(fd, "wb");
2155 if (errors_reply_to != NULL &&
2156 !contains_header(US"Reply-To", warn_message))
2157 fprintf(f, "Reply-To: %s\n", errors_reply_to);
2158 fprintf(f, "Auto-Submitted: auto-replied\n");
2159 if (!contains_header(US"From", warn_message)) moan_write_from(f);
2160 fprintf(f, "%s", CS warn_message);
2162 /* Close and wait for child process to complete, without a timeout. */
2165 (void)child_close(pid, 0);
2169 addr->special_action = SPECIAL_NONE;
2175 /*************************************************
2176 * Do local deliveries *
2177 *************************************************/
2179 /* This function processes the list of addresses in addr_local. True local
2180 deliveries are always done one address at a time. However, local deliveries can
2181 be batched up in some cases. Typically this is when writing batched SMTP output
2182 files for use by some external transport mechanism, or when running local
2183 deliveries over LMTP.
2190 do_local_deliveries(void)
2193 open_db *dbm_file = NULL;
2194 time_t now = time(NULL);
2196 /* Loop until we have exhausted the supply of local deliveries */
2198 while (addr_local != NULL)
2200 time_t delivery_start;
2202 address_item *addr2, *addr3, *nextaddr;
2203 int logflags = LOG_MAIN;
2204 int logchar = dont_deliver? '*' : '=';
2205 transport_instance *tp;
2207 /* Pick the first undelivered address off the chain */
2209 address_item *addr = addr_local;
2210 addr_local = addr->next;
2213 DEBUG(D_deliver|D_transport)
2214 debug_printf("--------> %s <--------\n", addr->address);
2216 /* An internal disaster if there is no transport. Should not occur! */
2218 if ((tp = addr->transport) == NULL)
2220 logflags |= LOG_PANIC;
2221 disable_logging = FALSE; /* Jic */
2223 (addr->router != NULL)?
2224 string_sprintf("No transport set by %s router", addr->router->name)
2226 string_sprintf("No transport set by system filter");
2227 post_process_one(addr, DEFER, logflags, DTYPE_TRANSPORT, 0);
2231 /* Check that this base address hasn't previously been delivered to this
2232 transport. The check is necessary at this point to handle homonymic addresses
2233 correctly in cases where the pattern of redirection changes between delivery
2234 attempts. Non-homonymic previous delivery is detected earlier, at routing
2237 if (previously_transported(addr, FALSE)) continue;
2239 /* There are weird cases where logging is disabled */
2241 disable_logging = tp->disable_logging;
2243 /* Check for batched addresses and possible amalgamation. Skip all the work
2244 if either batch_max <= 1 or there aren't any other addresses for local
2247 if (tp->batch_max > 1 && addr_local != NULL)
2249 int batch_count = 1;
2250 BOOL uses_dom = readconf_depends((driver_instance *)tp, US"domain");
2251 BOOL uses_lp = (testflag(addr, af_pfr) &&
2252 (testflag(addr, af_file) || addr->local_part[0] == '|')) ||
2253 readconf_depends((driver_instance *)tp, US"local_part");
2254 uschar *batch_id = NULL;
2255 address_item **anchor = &addr_local;
2256 address_item *last = addr;
2259 /* Expand the batch_id string for comparison with other addresses.
2260 Expansion failure suppresses batching. */
2262 if (tp->batch_id != NULL)
2264 deliver_set_expansions(addr);
2265 batch_id = expand_string(tp->batch_id);
2266 deliver_set_expansions(NULL);
2267 if (batch_id == NULL)
2269 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand batch_id option "
2270 "in %s transport (%s): %s", tp->name, addr->address,
2271 expand_string_message);
2272 batch_count = tp->batch_max;
2276 /* Until we reach the batch_max limit, pick off addresses which have the
2277 same characteristics. These are:
2280 not previously delivered (see comment about 50 lines above)
2281 same local part if the transport's configuration contains $local_part
2282 or if this is a file or pipe delivery from a redirection
2283 same domain if the transport's configuration contains $domain
2285 same additional headers
2286 same headers to be removed
2287 same uid/gid for running the transport
2288 same first host if a host list is set
2291 while ((next = *anchor) != NULL && batch_count < tp->batch_max)
2294 tp == next->transport &&
2295 !previously_transported(next, TRUE) &&
2296 (addr->flags & (af_pfr|af_file)) == (next->flags & (af_pfr|af_file)) &&
2297 (!uses_lp || Ustrcmp(next->local_part, addr->local_part) == 0) &&
2298 (!uses_dom || Ustrcmp(next->domain, addr->domain) == 0) &&
2299 same_strings(next->p.errors_address, addr->p.errors_address) &&
2300 same_headers(next->p.extra_headers, addr->p.extra_headers) &&
2301 same_strings(next->p.remove_headers, addr->p.remove_headers) &&
2302 same_ugid(tp, addr, next) &&
2303 ((addr->host_list == NULL && next->host_list == NULL) ||
2304 (addr->host_list != NULL && next->host_list != NULL &&
2305 Ustrcmp(addr->host_list->name, next->host_list->name) == 0));
2307 /* If the transport has a batch_id setting, batch_id will be non-NULL
2308 from the expansion outside the loop. Expand for this address and compare.
2309 Expansion failure makes this address ineligible for batching. */
2311 if (ok && batch_id != NULL)
2314 address_item *save_nextnext = next->next;
2315 next->next = NULL; /* Expansion for a single address */
2316 deliver_set_expansions(next);
2317 next->next = save_nextnext;
2318 bid = expand_string(tp->batch_id);
2319 deliver_set_expansions(NULL);
2322 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand batch_id option "
2323 "in %s transport (%s): %s", tp->name, next->address,
2324 expand_string_message);
2327 else ok = (Ustrcmp(batch_id, bid) == 0);
2330 /* Take address into batch if OK. */
2334 *anchor = next->next; /* Include the address */
2340 else anchor = &(next->next); /* Skip the address */
2344 /* We now have one or more addresses that can be delivered in a batch. Check
2345 whether the transport is prepared to accept a message of this size. If not,
2346 fail them all forthwith. If the expansion fails, or does not yield an
2347 integer, defer delivery. */
2349 if (tp->message_size_limit != NULL)
2351 int rc = check_message_size(tp, addr);
2354 replicate_status(addr);
2355 while (addr != NULL)
2358 post_process_one(addr, rc, logflags, DTYPE_TRANSPORT, 0);
2361 continue; /* With next batch of addresses */
2365 /* If we are not running the queue, or if forcing, all deliveries will be
2366 attempted. Otherwise, we must respect the retry times for each address. Even
2367 when not doing this, we need to set up the retry key string, and determine
2368 whether a retry record exists, because after a successful delivery, a delete
2369 retry item must be set up. Keep the retry database open only for the duration
2370 of these checks, rather than for all local deliveries, because some local
2371 deliveries (e.g. to pipes) can take a substantial time. */
2373 dbm_file = dbfn_open(US"retry", O_RDONLY, &dbblock, FALSE);
2374 if (dbm_file == NULL)
2376 DEBUG(D_deliver|D_retry|D_hints_lookup)
2377 debug_printf("no retry data available\n");
2382 while (addr2 != NULL)
2384 BOOL ok = TRUE; /* to deliver this address */
2387 /* Set up the retry key to include the domain or not, and change its
2388 leading character from "R" to "T". Must make a copy before doing this,
2389 because the old key may be pointed to from a "delete" retry item after
2392 retry_key = string_copy(
2393 (tp->retry_use_local_part)? addr2->address_retry_key :
2394 addr2->domain_retry_key);
2397 /* Inspect the retry data. If there is no hints file, delivery happens. */
2399 if (dbm_file != NULL)
2401 dbdata_retry *retry_record = dbfn_read(dbm_file, retry_key);
2403 /* If there is no retry record, delivery happens. If there is,
2404 remember it exists so it can be deleted after a successful delivery. */
2406 if (retry_record != NULL)
2408 setflag(addr2, af_lt_retry_exists);
2410 /* A retry record exists for this address. If queue running and not
2411 forcing, inspect its contents. If the record is too old, or if its
2412 retry time has come, or if it has passed its cutoff time, delivery
2417 debug_printf("retry record exists: age=%s ",
2418 readconf_printtime(now - retry_record->time_stamp));
2419 debug_printf("(max %s)\n", readconf_printtime(retry_data_expire));
2420 debug_printf(" time to retry = %s expired = %d\n",
2421 readconf_printtime(retry_record->next_try - now),
2422 retry_record->expired);
2425 if (queue_running && !deliver_force)
2427 ok = (now - retry_record->time_stamp > retry_data_expire) ||
2428 (now >= retry_record->next_try) ||
2429 retry_record->expired;
2431 /* If we haven't reached the retry time, there is one more check
2432 to do, which is for the ultimate address timeout. */
2435 ok = retry_ultimate_address_timeout(retry_key, addr2->domain,
2439 else DEBUG(D_retry) debug_printf("no retry record exists\n");
2442 /* This address is to be delivered. Leave it on the chain. */
2447 addr2 = addr2->next;
2450 /* This address is to be deferred. Take it out of the chain, and
2451 post-process it as complete. Must take it out of the chain first,
2452 because post processing puts it on another chain. */
2456 address_item *this = addr2;
2457 this->message = US"Retry time not yet reached";
2458 this->basic_errno = ERRNO_LRETRY;
2459 if (addr3 == NULL) addr2 = addr = addr2->next;
2460 else addr2 = addr3->next = addr2->next;
2461 post_process_one(this, DEFER, logflags, DTYPE_TRANSPORT, 0);
2465 if (dbm_file != NULL) dbfn_close(dbm_file);
2467 /* If there are no addresses left on the chain, they all deferred. Loop
2468 for the next set of addresses. */
2470 if (addr == NULL) continue;
2472 /* So, finally, we do have some addresses that can be passed to the
2473 transport. Before doing so, set up variables that are relevant to a
2476 deliver_set_expansions(addr);
2477 delivery_start = time(NULL);
2478 deliver_local(addr, FALSE);
2479 deliver_time = (int)(time(NULL) - delivery_start);
2481 /* If a shadow transport (which must perforce be another local transport), is
2482 defined, and its condition is met, we must pass the message to the shadow
2483 too, but only those addresses that succeeded. We do this by making a new
2484 chain of addresses - also to keep the original chain uncontaminated. We must
2485 use a chain rather than doing it one by one, because the shadow transport may
2488 NOTE: if the condition fails because of a lookup defer, there is nothing we
2491 if (tp->shadow != NULL &&
2492 (tp->shadow_condition == NULL ||
2493 expand_check_condition(tp->shadow_condition, tp->name, US"transport")))
2495 transport_instance *stp;
2496 address_item *shadow_addr = NULL;
2497 address_item **last = &shadow_addr;
2499 for (stp = transports; stp != NULL; stp = stp->next)
2500 if (Ustrcmp(stp->name, tp->shadow) == 0) break;
2503 log_write(0, LOG_MAIN|LOG_PANIC, "shadow transport \"%s\" not found ",
2506 /* Pick off the addresses that have succeeded, and make clones. Put into
2507 the shadow_message field a pointer to the shadow_message field of the real
2510 else for (addr2 = addr; addr2 != NULL; addr2 = addr2->next)
2512 if (addr2->transport_return != OK) continue;
2513 addr3 = store_get(sizeof(address_item));
2516 addr3->shadow_message = (uschar *)(&(addr2->shadow_message));
2517 addr3->transport = stp;
2518 addr3->transport_return = DEFER;
2519 addr3->return_filename = NULL;
2520 addr3->return_file = -1;
2522 last = &(addr3->next);
2525 /* If we found any addresses to shadow, run the delivery, and stick any
2526 message back into the shadow_message field in the original. */
2528 if (shadow_addr != NULL)
2530 int save_count = transport_count;
2532 DEBUG(D_deliver|D_transport)
2533 debug_printf(">>>>>>>>>>>>>>>> Shadow delivery >>>>>>>>>>>>>>>>\n");
2534 deliver_local(shadow_addr, TRUE);
2536 for(; shadow_addr != NULL; shadow_addr = shadow_addr->next)
2538 int sresult = shadow_addr->transport_return;
2539 *((uschar **)(shadow_addr->shadow_message)) = (sresult == OK)?
2540 string_sprintf(" ST=%s", stp->name) :
2541 string_sprintf(" ST=%s (%s%s%s)", stp->name,
2542 (shadow_addr->basic_errno <= 0)?
2543 US"" : US strerror(shadow_addr->basic_errno),
2544 (shadow_addr->basic_errno <= 0 || shadow_addr->message == NULL)?
2546 (shadow_addr->message != NULL)? shadow_addr->message :
2547 (shadow_addr->basic_errno <= 0)? US"unknown error" : US"");
2549 DEBUG(D_deliver|D_transport)
2550 debug_printf("%s shadow transport returned %s for %s\n",
2552 (sresult == OK)? "OK" :
2553 (sresult == DEFER)? "DEFER" :
2554 (sresult == FAIL)? "FAIL" :
2555 (sresult == PANIC)? "PANIC" : "?",
2556 shadow_addr->address);
2559 DEBUG(D_deliver|D_transport)
2560 debug_printf(">>>>>>>>>>>>>>>> End shadow delivery >>>>>>>>>>>>>>>>\n");
2562 transport_count = save_count; /* Restore original transport count */
2566 /* Cancel the expansions that were set up for the delivery. */
2568 deliver_set_expansions(NULL);
2570 /* Now we can process the results of the real transport. We must take each
2571 address off the chain first, because post_process_one() puts it on another
2574 for (addr2 = addr; addr2 != NULL; addr2 = nextaddr)
2576 int result = addr2->transport_return;
2577 nextaddr = addr2->next;
2579 DEBUG(D_deliver|D_transport)
2580 debug_printf("%s transport returned %s for %s\n",
2582 (result == OK)? "OK" :
2583 (result == DEFER)? "DEFER" :
2584 (result == FAIL)? "FAIL" :
2585 (result == PANIC)? "PANIC" : "?",
2588 /* If there is a retry_record, or if delivery is deferred, build a retry
2589 item for setting a new retry time or deleting the old retry record from
2590 the database. These items are handled all together after all addresses
2591 have been handled (so the database is open just for a short time for
2594 if (result == DEFER || testflag(addr2, af_lt_retry_exists))
2596 int flags = (result == DEFER)? 0 : rf_delete;
2597 uschar *retry_key = string_copy((tp->retry_use_local_part)?
2598 addr2->address_retry_key : addr2->domain_retry_key);
2600 retry_add_item(addr2, retry_key, flags);
2603 /* Done with this address */
2605 if (result == OK) addr2->more_errno = deliver_time;
2606 post_process_one(addr2, result, logflags, DTYPE_TRANSPORT, logchar);
2608 /* If a pipe delivery generated text to be sent back, the result may be
2609 changed to FAIL, and we must copy this for subsequent addresses in the
2612 if (addr2->transport_return != result)
2614 for (addr3 = nextaddr; addr3 != NULL; addr3 = addr3->next)
2616 addr3->transport_return = addr2->transport_return;
2617 addr3->basic_errno = addr2->basic_errno;
2618 addr3->message = addr2->message;
2620 result = addr2->transport_return;
2623 /* Whether or not the result was changed to FAIL, we need to copy the
2624 return_file value from the first address into all the addresses of the
2625 batch, so they are all listed in the error message. */
2627 addr2->return_file = addr->return_file;
2629 /* Change log character for recording successful deliveries. */
2631 if (result == OK) logchar = '-';
2633 } /* Loop back for next batch of addresses */
2639 /*************************************************
2640 * Sort remote deliveries *
2641 *************************************************/
2643 /* This function is called if remote_sort_domains is set. It arranges that the
2644 chain of addresses for remote deliveries is ordered according to the strings
2645 specified. Try to make this shuffling reasonably efficient by handling
2646 sequences of addresses rather than just single ones.
2653 sort_remote_deliveries(void)
2656 address_item **aptr = &addr_remote;
2657 uschar *listptr = remote_sort_domains;
2661 while (*aptr != NULL &&
2662 (pattern = string_nextinlist(&listptr, &sep, patbuf, sizeof(patbuf)))
2665 address_item *moved = NULL;
2666 address_item **bptr = &moved;
2668 while (*aptr != NULL)
2670 address_item **next;
2671 deliver_domain = (*aptr)->domain; /* set $domain */
2672 if (match_isinlist(deliver_domain, &pattern, UCHAR_MAX+1,
2673 &domainlist_anchor, NULL, MCL_DOMAIN, TRUE, NULL) == OK)
2675 aptr = &((*aptr)->next);
2679 next = &((*aptr)->next);
2680 while (*next != NULL &&
2681 (deliver_domain = (*next)->domain, /* Set $domain */
2682 match_isinlist(deliver_domain, &pattern, UCHAR_MAX+1,
2683 &domainlist_anchor, NULL, MCL_DOMAIN, TRUE, NULL)) != OK)
2684 next = &((*next)->next);
2686 /* If the batch of non-matchers is at the end, add on any that were
2687 extracted further up the chain, and end this iteration. Otherwise,
2688 extract them from the chain and hang on the moved chain. */
2700 aptr = &((*aptr)->next);
2703 /* If the loop ended because the final address matched, *aptr will
2704 be NULL. Add on to the end any extracted non-matching addresses. If
2705 *aptr is not NULL, the loop ended via "break" when *next is null, that
2706 is, there was a string of non-matching addresses at the end. In this
2707 case the extracted addresses have already been added on the end. */
2709 if (*aptr == NULL) *aptr = moved;
2715 debug_printf("remote addresses after sorting:\n");
2716 for (addr = addr_remote; addr != NULL; addr = addr->next)
2717 debug_printf(" %s\n", addr->address);
2723 /*************************************************
2724 * Read from pipe for remote delivery subprocess *
2725 *************************************************/
2727 /* This function is called when the subprocess is complete, but can also be
2728 called before it is complete, in order to empty a pipe that is full (to prevent
2729 deadlock). It must therefore keep track of its progress in the parlist data
2732 We read the pipe to get the delivery status codes and a possible error message
2733 for each address, optionally preceded by unusability data for the hosts and
2734 also by optional retry data.
2736 Read in large chunks into the big buffer and then scan through, interpreting
2737 the data therein. In most cases, only a single read will be necessary. No
2738 individual item will ever be anywhere near 2500 bytes in length, so by ensuring
2739 that we read the next chunk when there is less than 2500 bytes left in the
2740 non-final chunk, we can assume each item is complete in the buffer before
2741 handling it. Each item is written using a single write(), which is atomic for
2742 small items (less than PIPE_BUF, which seems to be at least 512 in any Unix and
2743 often bigger) so even if we are reading while the subprocess is still going, we
2744 should never have only a partial item in the buffer.
2747 poffset the offset of the parlist item
2748 eop TRUE if the process has completed
2750 Returns: TRUE if the terminating 'Z' item has been read,
2751 or there has been a disaster (i.e. no more data needed);
2756 par_read_pipe(int poffset, BOOL eop)
2759 pardata *p = parlist + poffset;
2760 address_item *addrlist = p->addrlist;
2761 address_item *addr = p->addr;
2764 uschar *endptr = big_buffer;
2765 uschar *ptr = endptr;
2766 uschar *msg = p->msg;
2767 BOOL done = p->done;
2768 BOOL unfinished = TRUE;
2770 /* Loop through all items, reading from the pipe when necessary. The pipe
2771 is set up to be non-blocking, but there are two different Unix mechanisms in
2772 use. Exim uses O_NONBLOCK if it is defined. This returns 0 for end of file,
2773 and EAGAIN for no more data. If O_NONBLOCK is not defined, Exim uses O_NDELAY,
2774 which returns 0 for both end of file and no more data. We distinguish the
2775 two cases by taking 0 as end of file only when we know the process has
2778 Each separate item is written to the pipe in a single write(), and as they are
2779 all short items, the writes will all be atomic and we should never find
2780 ourselves in the position of having read an incomplete item. "Short" in this
2781 case can mean up to about 1K in the case when there is a long error message
2782 associated with an address. */
2784 DEBUG(D_deliver) debug_printf("reading pipe for subprocess %d (%s)\n",
2785 (int)p->pid, eop? "ended" : "not ended");
2789 retry_item *r, **rp;
2790 int remaining = endptr - ptr;
2792 /* Read (first time) or top up the chars in the buffer if necessary.
2793 There will be only one read if we get all the available data (i.e. don't
2794 fill the buffer completely). */
2796 if (remaining < 2500 && unfinished)
2799 int available = big_buffer_size - remaining;
2801 if (remaining > 0) memmove(big_buffer, ptr, remaining);
2804 endptr = big_buffer + remaining;
2805 len = read(fd, endptr, available);
2807 DEBUG(D_deliver) debug_printf("read() yielded %d\n", len);
2809 /* If the result is EAGAIN and the process is not complete, just
2810 stop reading any more and process what we have already. */
2814 if (!eop && errno == EAGAIN) len = 0; else
2816 msg = string_sprintf("failed to read pipe from transport process "
2817 "%d for transport %s: %s", pid, addr->transport->driver_name,
2823 /* If the length is zero (eof or no-more-data), just process what we
2824 already have. Note that if the process is still running and we have
2825 read all the data in the pipe (but less that "available") then we
2826 won't read any more, as "unfinished" will get set FALSE. */
2829 unfinished = len == available;
2832 /* If we are at the end of the available data, exit the loop. */
2834 if (ptr >= endptr) break;
2836 /* Handle each possible type of item, assuming the complete item is
2837 available in store. */
2841 /* Host items exist only if any hosts were marked unusable. Match
2842 up by checking the IP address. */
2845 for (h = addrlist->host_list; h != NULL; h = h->next)
2847 if (h->address == NULL || Ustrcmp(h->address, ptr+2) != 0) continue;
2855 /* Retry items are sent in a preceding R item for each address. This is
2856 kept separate to keep each message short enough to guarantee it won't
2857 be split in the pipe. Hopefully, in the majority of cases, there won't in
2858 fact be any retry items at all.
2860 The complete set of retry items might include an item to delete a
2861 routing retry if there was a previous routing delay. However, routing
2862 retries are also used when a remote transport identifies an address error.
2863 In that case, there may also be an "add" item for the same key. Arrange
2864 that a "delete" item is dropped in favour of an "add" item. */
2867 if (addr == NULL) goto ADDR_MISMATCH;
2869 DEBUG(D_deliver|D_retry)
2870 debug_printf("reading retry information for %s from subprocess\n",
2873 /* Cut out any "delete" items on the list. */
2875 for (rp = &(addr->retries); (r = *rp) != NULL; rp = &(r->next))
2877 if (Ustrcmp(r->key, ptr+1) == 0) /* Found item with same key */
2879 if ((r->flags & rf_delete) == 0) break; /* It was not "delete" */
2880 *rp = r->next; /* Excise a delete item */
2881 DEBUG(D_deliver|D_retry)
2882 debug_printf(" existing delete item dropped\n");
2886 /* We want to add a delete item only if there is no non-delete item;
2887 however we still have to step ptr through the data. */
2889 if (r == NULL || (*ptr & rf_delete) == 0)
2891 r = store_get(sizeof(retry_item));
2892 r->next = addr->retries;
2895 r->key = string_copy(ptr);
2897 memcpy(&(r->basic_errno), ptr, sizeof(r->basic_errno));
2898 ptr += sizeof(r->basic_errno);
2899 memcpy(&(r->more_errno), ptr, sizeof(r->more_errno));
2900 ptr += sizeof(r->more_errno);
2901 r->message = (*ptr)? string_copy(ptr) : NULL;
2902 DEBUG(D_deliver|D_retry)
2903 debug_printf(" added %s item\n",
2904 ((r->flags & rf_delete) == 0)? "retry" : "delete");
2909 DEBUG(D_deliver|D_retry)
2910 debug_printf(" delete item not added: non-delete item exists\n");
2913 ptr += sizeof(r->basic_errno) + sizeof(r->more_errno);
2919 /* Put the amount of data written into the parlist block */
2922 memcpy(&(p->transport_count), ptr, sizeof(transport_count));
2923 ptr += sizeof(transport_count);
2926 /* Address items are in the order of items on the address chain. We
2927 remember the current address value in case this function is called
2928 several times to empty the pipe in stages. Information about delivery
2929 over TLS is sent in a preceding X item for each address. We don't put
2930 it in with the other info, in order to keep each message short enough to
2931 guarantee it won't be split in the pipe. */
2935 if (addr == NULL) goto ADDR_MISMATCH; /* Below, in 'A' handler */
2936 addr->cipher = (*ptr)? string_copy(ptr) : NULL;
2938 addr->peerdn = (*ptr)? string_copy(ptr) : NULL;
2943 case 'C': /* client authenticator information */
2947 addr->authenticator = (*ptr)? string_copy(ptr) : NULL;
2950 addr->auth_id = (*ptr)? string_copy(ptr) : NULL;
2953 addr->auth_sndr = (*ptr)? string_copy(ptr) : NULL;
2959 #ifdef EXPERIMENTAL_PRDR
2961 addr->flags |= af_prdr_used; break;
2968 msg = string_sprintf("address count mismatch for data read from pipe "
2969 "for transport process %d for transport %s", pid,
2970 addrlist->transport->driver_name);
2975 addr->transport_return = *ptr++;
2976 addr->special_action = *ptr++;
2977 memcpy(&(addr->basic_errno), ptr, sizeof(addr->basic_errno));
2978 ptr += sizeof(addr->basic_errno);
2979 memcpy(&(addr->more_errno), ptr, sizeof(addr->more_errno));
2980 ptr += sizeof(addr->more_errno);
2981 memcpy(&(addr->flags), ptr, sizeof(addr->flags));
2982 ptr += sizeof(addr->flags);
2983 addr->message = (*ptr)? string_copy(ptr) : NULL;
2985 addr->user_message = (*ptr)? string_copy(ptr) : NULL;
2988 /* Always two strings for host information, followed by the port number */
2992 h = store_get(sizeof(host_item));
2993 h->name = string_copy(ptr);
2995 h->address = string_copy(ptr);
2997 memcpy(&(h->port), ptr, sizeof(h->port));
2998 ptr += sizeof(h->port);
2999 addr->host_used = h;
3003 /* Finished with this address */
3008 /* Z marks the logical end of the data. It is followed by '0' if
3009 continue_transport was NULL at the end of transporting, otherwise '1'.
3010 We need to know when it becomes NULL during a delivery down a passed SMTP
3011 channel so that we don't try to pass anything more down it. Of course, for
3012 most normal messages it will remain NULL all the time. */
3017 continue_transport = NULL;
3018 continue_hostname = NULL;
3021 DEBUG(D_deliver) debug_printf("Z%c item read\n", *ptr);
3024 /* Anything else is a disaster. */
3027 msg = string_sprintf("malformed data (%d) read from pipe for transport "
3028 "process %d for transport %s", ptr[-1], pid,
3029 addr->transport->driver_name);
3035 /* The done flag is inspected externally, to determine whether or not to
3036 call the function again when the process finishes. */
3040 /* If the process hadn't finished, and we haven't seen the end of the data
3041 or suffered a disaster, update the rest of the state, and return FALSE to
3042 indicate "not finished". */
3051 /* Close our end of the pipe, to prevent deadlock if the far end is still
3052 pushing stuff into it. */
3057 /* If we have finished without error, but haven't had data for every address,
3058 something is wrong. */
3060 if (msg == NULL && addr != NULL)
3061 msg = string_sprintf("insufficient address data read from pipe "
3062 "for transport process %d for transport %s", pid,
3063 addr->transport->driver_name);
3065 /* If an error message is set, something has gone wrong in getting back
3066 the delivery data. Put the message into each address and freeze it. */
3070 for (addr = addrlist; addr != NULL; addr = addr->next)
3072 addr->transport_return = DEFER;
3073 addr->special_action = SPECIAL_FREEZE;
3074 addr->message = msg;
3078 /* Return TRUE to indicate we have got all we need from this process, even
3079 if it hasn't actually finished yet. */
3086 /*************************************************
3087 * Post-process a set of remote addresses *
3088 *************************************************/
3090 /* Do what has to be done immediately after a remote delivery for each set of
3091 addresses, then re-write the spool if necessary. Note that post_process_one
3092 puts the address on an appropriate queue; hence we must fish off the next
3093 one first. This function is also called if there is a problem with setting
3094 up a subprocess to do a remote delivery in parallel. In this case, the final
3095 argument contains a message, and the action must be forced to DEFER.
3098 addr pointer to chain of address items
3099 logflags flags for logging
3100 msg NULL for normal cases; -> error message for unexpected problems
3101 fallback TRUE if processing fallback hosts
3107 remote_post_process(address_item *addr, int logflags, uschar *msg,
3112 /* If any host addresses were found to be unusable, add them to the unusable
3113 tree so that subsequent deliveries don't try them. */
3115 for (h = addr->host_list; h != NULL; h = h->next)
3117 if (h->address == NULL) continue;
3118 if (h->status >= hstatus_unusable) tree_add_unusable(h);
3121 /* Now handle each address on the chain. The transport has placed '=' or '-'
3122 into the special_action field for each successful delivery. */
3124 while (addr != NULL)
3126 address_item *next = addr->next;
3128 /* If msg == NULL (normal processing) and the result is DEFER and we are
3129 processing the main hosts and there are fallback hosts available, put the
3130 address on the list for fallback delivery. */
3132 if (addr->transport_return == DEFER &&
3133 addr->fallback_hosts != NULL &&
3137 addr->host_list = addr->fallback_hosts;
3138 addr->next = addr_fallback;
3139 addr_fallback = addr;
3140 DEBUG(D_deliver) debug_printf("%s queued for fallback host(s)\n", addr->address);
3143 /* If msg is set (=> unexpected problem), set it in the address before
3144 doing the ordinary post processing. */
3150 addr->message = msg;
3151 addr->transport_return = DEFER;
3153 (void)post_process_one(addr, addr->transport_return, logflags,
3154 DTYPE_TRANSPORT, addr->special_action);
3162 /* If we have just delivered down a passed SMTP channel, and that was
3163 the last address, the channel will have been closed down. Now that
3164 we have logged that delivery, set continue_sequence to 1 so that
3165 any subsequent deliveries don't get "*" incorrectly logged. */
3167 if (continue_transport == NULL) continue_sequence = 1;
3172 /*************************************************
3173 * Wait for one remote delivery subprocess *
3174 *************************************************/
3176 /* This function is called while doing remote deliveries when either the
3177 maximum number of processes exist and we need one to complete so that another
3178 can be created, or when waiting for the last ones to complete. It must wait for
3179 the completion of one subprocess, empty the control block slot, and return a
3180 pointer to the address chain.
3183 Returns: pointer to the chain of addresses handled by the process;
3184 NULL if no subprocess found - this is an unexpected error
3187 static address_item *
3190 int poffset, status;
3191 address_item *addr, *addrlist;
3194 set_process_info("delivering %s: waiting for a remote delivery subprocess "
3195 "to finish", message_id);
3197 /* Loop until either a subprocess completes, or there are no subprocesses in
3198 existence - in which case give an error return. We cannot proceed just by
3199 waiting for a completion, because a subprocess may have filled up its pipe, and
3200 be waiting for it to be emptied. Therefore, if no processes have finished, we
3201 wait for one of the pipes to acquire some data by calling select(), with a
3202 timeout just in case.
3204 The simple approach is just to iterate after reading data from a ready pipe.
3205 This leads to non-ideal behaviour when the subprocess has written its final Z
3206 item, closed the pipe, and is in the process of exiting (the common case). A
3207 call to waitpid() yields nothing completed, but select() shows the pipe ready -
3208 reading it yields EOF, so you end up with busy-waiting until the subprocess has
3211 To avoid this, if all the data that is needed has been read from a subprocess
3212 after select(), an explicit wait() for it is done. We know that all it is doing
3213 is writing to the pipe and then exiting, so the wait should not be long.
3215 The non-blocking waitpid() is to some extent just insurance; if we could
3216 reliably detect end-of-file on the pipe, we could always know when to do a
3217 blocking wait() for a completed process. However, because some systems use
3218 NDELAY, which doesn't distinguish between EOF and pipe empty, it is easier to
3219 use code that functions without the need to recognize EOF.
3221 There's a double loop here just in case we end up with a process that is not in
3222 the list of remote delivery processes. Something has obviously gone wrong if
3223 this is the case. (For example, a process that is incorrectly left over from
3224 routing or local deliveries might be found.) The damage can be minimized by
3225 looping back and looking for another process. If there aren't any, the error
3226 return will happen. */
3228 for (;;) /* Normally we do not repeat this loop */
3230 while ((pid = waitpid(-1, &status, WNOHANG)) <= 0)
3233 fd_set select_pipes;
3234 int maxpipe, readycount;
3236 /* A return value of -1 can mean several things. If errno != ECHILD, it
3237 either means invalid options (which we discount), or that this process was
3238 interrupted by a signal. Just loop to try the waitpid() again.
3240 If errno == ECHILD, waitpid() is telling us that there are no subprocesses
3241 in existence. This should never happen, and is an unexpected error.
3242 However, there is a nasty complication when running under Linux. If "strace
3243 -f" is being used under Linux to trace this process and its children,
3244 subprocesses are "stolen" from their parents and become the children of the
3245 tracing process. A general wait such as the one we've just obeyed returns
3246 as if there are no children while subprocesses are running. Once a
3247 subprocess completes, it is restored to the parent, and waitpid(-1) finds
3248 it. Thanks to Joachim Wieland for finding all this out and suggesting a
3251 This does not happen using "truss" on Solaris, nor (I think) with other
3252 tracing facilities on other OS. It seems to be specific to Linux.
3254 What we do to get round this is to use kill() to see if any of our
3255 subprocesses are still in existence. If kill() gives an OK return, we know
3256 it must be for one of our processes - it can't be for a re-use of the pid,
3257 because if our process had finished, waitpid() would have found it. If any
3258 of our subprocesses are in existence, we proceed to use select() as if
3259 waitpid() had returned zero. I think this is safe. */
3263 if (errno != ECHILD) continue; /* Repeats the waitpid() */
3266 debug_printf("waitpid() returned -1/ECHILD: checking explicitly "
3267 "for process existence\n");
3269 for (poffset = 0; poffset < remote_max_parallel; poffset++)
3271 if ((pid = parlist[poffset].pid) != 0 && kill(pid, 0) == 0)
3273 DEBUG(D_deliver) debug_printf("process %d still exists: assume "
3274 "stolen by strace\n", (int)pid);
3275 break; /* With poffset set */
3279 if (poffset >= remote_max_parallel)
3281 DEBUG(D_deliver) debug_printf("*** no delivery children found\n");
3282 return NULL; /* This is the error return */
3286 /* A pid value greater than 0 breaks the "while" loop. A negative value has
3287 been handled above. A return value of zero means that there is at least one
3288 subprocess, but there are no completed subprocesses. See if any pipes are
3289 ready with any data for reading. */
3291 DEBUG(D_deliver) debug_printf("selecting on subprocess pipes\n");
3294 FD_ZERO(&select_pipes);
3295 for (poffset = 0; poffset < remote_max_parallel; poffset++)
3297 if (parlist[poffset].pid != 0)
3299 int fd = parlist[poffset].fd;
3300 FD_SET(fd, &select_pipes);
3301 if (fd > maxpipe) maxpipe = fd;
3305 /* Stick in a 60-second timeout, just in case. */
3310 readycount = select(maxpipe + 1, (SELECT_ARG2_TYPE *)&select_pipes,
3313 /* Scan through the pipes and read any that are ready; use the count
3314 returned by select() to stop when there are no more. Select() can return
3315 with no processes (e.g. if interrupted). This shouldn't matter.
3317 If par_read_pipe() returns TRUE, it means that either the terminating Z was
3318 read, or there was a disaster. In either case, we are finished with this
3319 process. Do an explicit wait() for the process and break the main loop if
3322 It turns out that we have to deal with the case of an interrupted system
3323 call, which can happen on some operating systems if the signal handling is
3324 set up to do that by default. */
3327 readycount > 0 && poffset < remote_max_parallel;
3330 if ((pid = parlist[poffset].pid) != 0 &&
3331 FD_ISSET(parlist[poffset].fd, &select_pipes))
3334 if (par_read_pipe(poffset, FALSE)) /* Finished with this pipe */
3336 for (;;) /* Loop for signals */
3338 pid_t endedpid = waitpid(pid, &status, 0);
3339 if (endedpid == pid) goto PROCESS_DONE;
3340 if (endedpid != (pid_t)(-1) || errno != EINTR)
3341 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Unexpected error return "
3342 "%d (errno = %d) from waitpid() for process %d",
3343 (int)endedpid, errno, (int)pid);
3349 /* Now go back and look for a completed subprocess again. */
3352 /* A completed process was detected by the non-blocking waitpid(). Find the
3353 data block that corresponds to this subprocess. */
3355 for (poffset = 0; poffset < remote_max_parallel; poffset++)
3356 if (pid == parlist[poffset].pid) break;
3358 /* Found the data block; this is a known remote delivery process. We don't
3359 need to repeat the outer loop. This should be what normally happens. */
3361 if (poffset < remote_max_parallel) break;
3363 /* This situation is an error, but it's probably better to carry on looking
3364 for another process than to give up (as we used to do). */
3366 log_write(0, LOG_MAIN|LOG_PANIC, "Process %d finished: not found in remote "
3367 "transport process list", pid);
3368 } /* End of the "for" loop */
3370 /* Come here when all the data was completely read after a select(), and
3371 the process in pid has been wait()ed for. */
3378 debug_printf("remote delivery process %d ended\n", (int)pid);
3380 debug_printf("remote delivery process %d ended: status=%04x\n", (int)pid,
3384 set_process_info("delivering %s", message_id);
3386 /* Get the chain of processed addresses */
3388 addrlist = parlist[poffset].addrlist;
3390 /* If the process did not finish cleanly, record an error and freeze (except
3391 for SIGTERM, SIGKILL and SIGQUIT), and also ensure the journal is not removed,
3392 in case the delivery did actually happen. */
3394 if ((status & 0xffff) != 0)
3397 int msb = (status >> 8) & 255;
3398 int lsb = status & 255;
3399 int code = (msb == 0)? (lsb & 0x7f) : msb;
3401 msg = string_sprintf("%s transport process returned non-zero status 0x%04x: "
3403 addrlist->transport->driver_name,
3405 (msb == 0)? "terminated by signal" : "exit code",
3408 if (msb != 0 || (code != SIGTERM && code != SIGKILL && code != SIGQUIT))
3409 addrlist->special_action = SPECIAL_FREEZE;
3411 for (addr = addrlist; addr != NULL; addr = addr->next)
3413 addr->transport_return = DEFER;
3414 addr->message = msg;
3417 remove_journal = FALSE;
3420 /* Else complete reading the pipe to get the result of the delivery, if all
3421 the data has not yet been obtained. */
3423 else if (!parlist[poffset].done) (void)par_read_pipe(poffset, TRUE);
3425 /* Put the data count and return path into globals, mark the data slot unused,
3426 decrement the count of subprocesses, and return the address chain. */
3428 transport_count = parlist[poffset].transport_count;
3429 used_return_path = parlist[poffset].return_path;
3430 parlist[poffset].pid = 0;
3437 /*************************************************
3438 * Wait for subprocesses and post-process *
3439 *************************************************/
3441 /* This function waits for subprocesses until the number that are still running
3442 is below a given threshold. For each complete subprocess, the addresses are
3443 post-processed. If we can't find a running process, there is some shambles.
3444 Better not bomb out, as that might lead to multiple copies of the message. Just
3445 log and proceed as if all done.
3448 max maximum number of subprocesses to leave running
3449 fallback TRUE if processing fallback hosts
3455 par_reduce(int max, BOOL fallback)
3457 while (parcount > max)
3459 address_item *doneaddr = par_wait();
3460 if (doneaddr == NULL)
3462 log_write(0, LOG_MAIN|LOG_PANIC,
3463 "remote delivery process count got out of step");
3466 else remote_post_process(doneaddr, LOG_MAIN, NULL, fallback);
3474 rmt_dlv_checked_write(int fd, void * buf, int size)
3476 int ret = write(fd, buf, size);
3478 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Failed writing transport result to pipe: %s\n",
3479 ret == -1 ? strerror(errno) : "short write");
3482 /*************************************************
3483 * Do remote deliveries *
3484 *************************************************/
3486 /* This function is called to process the addresses in addr_remote. We must
3487 pick off the queue all addresses that have the same transport, remote
3488 destination, and errors address, and hand them to the transport in one go,
3489 subject to some configured limitations. If this is a run to continue delivering
3490 to an existing delivery channel, skip all but those addresses that can go to
3491 that channel. The skipped addresses just get deferred.
3493 If mua_wrapper is set, all addresses must be able to be sent in a single
3494 transaction. If not, this function yields FALSE.
3496 In Exim 4, remote deliveries are always done in separate processes, even
3497 if remote_max_parallel = 1 or if there's only one delivery to do. The reason
3498 is so that the base process can retain privilege. This makes the
3499 implementation of fallback transports feasible (though not initially done.)
3501 We create up to the configured number of subprocesses, each of which passes
3502 back the delivery state via a pipe. (However, when sending down an existing
3503 connection, remote_max_parallel is forced to 1.)
3506 fallback TRUE if processing fallback hosts
3508 Returns: TRUE normally
3509 FALSE if mua_wrapper is set and the addresses cannot all be sent
3514 do_remote_deliveries(BOOL fallback)
3520 parcount = 0; /* Number of executing subprocesses */
3522 /* When sending down an existing channel, only do one delivery at a time.
3523 We use a local variable (parmax) to hold the maximum number of processes;
3524 this gets reduced from remote_max_parallel if we can't create enough pipes. */
3526 if (continue_transport != NULL) remote_max_parallel = 1;
3527 parmax = remote_max_parallel;
3529 /* If the data for keeping a list of processes hasn't yet been
3532 if (parlist == NULL)
3534 parlist = store_get(remote_max_parallel * sizeof(pardata));
3535 for (poffset = 0; poffset < remote_max_parallel; poffset++)
3536 parlist[poffset].pid = 0;
3539 /* Now loop for each remote delivery */
3541 for (delivery_count = 0; addr_remote != NULL; delivery_count++)
3547 int address_count = 1;
3548 int address_count_max;
3550 BOOL use_initgroups;
3551 BOOL pipe_done = FALSE;
3552 transport_instance *tp;
3553 address_item **anchor = &addr_remote;
3554 address_item *addr = addr_remote;
3555 address_item *last = addr;
3558 /* Pull the first address right off the list. */
3560 addr_remote = addr->next;
3563 DEBUG(D_deliver|D_transport)
3564 debug_printf("--------> %s <--------\n", addr->address);
3566 /* If no transport has been set, there has been a big screw-up somewhere. */
3568 if ((tp = addr->transport) == NULL)
3570 disable_logging = FALSE; /* Jic */
3571 remote_post_process(addr, LOG_MAIN|LOG_PANIC,
3572 US"No transport set by router", fallback);
3576 /* Check that this base address hasn't previously been delivered to this
3577 transport. The check is necessary at this point to handle homonymic addresses
3578 correctly in cases where the pattern of redirection changes between delivery
3579 attempts. Non-homonymic previous delivery is detected earlier, at routing
3582 if (previously_transported(addr, FALSE)) continue;
3584 /* Force failure if the message is too big. */
3586 if (tp->message_size_limit != NULL)
3588 int rc = check_message_size(tp, addr);
3591 addr->transport_return = rc;
3592 remote_post_process(addr, LOG_MAIN, NULL, fallback);
3597 /* Get the flag which specifies whether the transport can handle different
3598 domains that nevertheless resolve to the same set of hosts. */
3600 multi_domain = tp->multi_domain;
3602 /* Get the maximum it can handle in one envelope, with zero meaning
3603 unlimited, which is forced for the MUA wrapper case. */
3605 address_count_max = tp->max_addresses;
3606 if (address_count_max == 0 || mua_wrapper) address_count_max = 999999;
3609 /************************************************************************/
3610 /***** This is slightly experimental code, but should be safe. *****/
3612 /* The address_count_max value is the maximum number of addresses that the
3613 transport can send in one envelope. However, the transport must be capable of
3614 dealing with any number of addresses. If the number it gets exceeds its
3615 envelope limitation, it must send multiple copies of the message. This can be
3616 done over a single connection for SMTP, so uses less resources than making
3617 multiple connections. On the other hand, if remote_max_parallel is greater
3618 than one, it is perhaps a good idea to use parallel processing to move the
3619 message faster, even if that results in multiple simultaneous connections to
3622 How can we come to some compromise between these two ideals? What we do is to
3623 limit the number of addresses passed to a single instance of a transport to
3624 the greater of (a) its address limit (rcpt_max for SMTP) and (b) the total
3625 number of addresses routed to remote transports divided by
3626 remote_max_parallel. For example, if the message has 100 remote recipients,
3627 remote max parallel is 2, and rcpt_max is 10, we'd never send more than 50 at
3628 once. But if rcpt_max is 100, we could send up to 100.
3630 Of course, not all the remotely addresses in a message are going to go to the
3631 same set of hosts (except in smarthost configurations), so this is just a
3632 heuristic way of dividing up the work.
3634 Furthermore (1), because this may not be wanted in some cases, and also to
3635 cope with really pathological cases, there is also a limit to the number of
3636 messages that are sent over one connection. This is the same limit that is
3637 used when sending several different messages over the same connection.
3638 Continue_sequence is set when in this situation, to the number sent so
3639 far, including this message.
3641 Furthermore (2), when somebody explicitly sets the maximum value to 1, it
3642 is probably because they are using VERP, in which case they want to pass only
3643 one address at a time to the transport, in order to be able to use
3644 $local_part and $domain in constructing a new return path. We could test for
3645 the use of these variables, but as it is so likely they will be used when the
3646 maximum is 1, we don't bother. Just leave the value alone. */
3648 if (address_count_max != 1 &&
3649 address_count_max < remote_delivery_count/remote_max_parallel)
3651 int new_max = remote_delivery_count/remote_max_parallel;
3652 int message_max = tp->connection_max_messages;
3653 if (connection_max_messages >= 0) message_max = connection_max_messages;
3654 message_max -= continue_sequence - 1;
3655 if (message_max > 0 && new_max > address_count_max * message_max)
3656 new_max = address_count_max * message_max;
3657 address_count_max = new_max;
3660 /************************************************************************/
3663 /* Pick off all addresses which have the same transport, errors address,
3664 destination, and extra headers. In some cases they point to the same host
3665 list, but we also need to check for identical host lists generated from
3666 entirely different domains. The host list pointers can be NULL in the case
3667 where the hosts are defined in the transport. There is also a configured
3668 maximum limit of addresses that can be handled at once (see comments above
3669 for how it is computed). */
3671 while ((next = *anchor) != NULL && address_count < address_count_max)
3673 if ((multi_domain || Ustrcmp(next->domain, addr->domain) == 0)
3675 tp == next->transport
3677 same_hosts(next->host_list, addr->host_list)
3679 same_strings(next->p.errors_address, addr->p.errors_address)
3681 same_headers(next->p.extra_headers, addr->p.extra_headers)
3683 same_ugid(tp, next, addr)
3685 (next->p.remove_headers == addr->p.remove_headers ||
3686 (next->p.remove_headers != NULL &&
3687 addr->p.remove_headers != NULL &&
3688 Ustrcmp(next->p.remove_headers, addr->p.remove_headers) == 0)))
3690 *anchor = next->next;
3692 next->first = addr; /* remember top one (for retry processing) */
3697 else anchor = &(next->next);
3700 /* If we are acting as an MUA wrapper, all addresses must go in a single
3701 transaction. If not, put them back on the chain and yield FALSE. */
3703 if (mua_wrapper && addr_remote != NULL)
3705 last->next = addr_remote;
3710 /* Set up the expansion variables for this set of addresses */
3712 deliver_set_expansions(addr);
3714 /* Ensure any transport-set auth info is fresh */
3715 addr->authenticator = addr->auth_id = addr->auth_sndr = NULL;
3717 /* Compute the return path, expanding a new one if required. The old one
3718 must be set first, as it might be referred to in the expansion. */
3720 if(addr->p.errors_address != NULL)
3721 return_path = addr->p.errors_address;
3722 #ifdef EXPERIMENTAL_SRS
3723 else if(addr->p.srs_sender != NULL)
3724 return_path = addr->p.srs_sender;
3727 return_path = sender_address;
3729 if (tp->return_path != NULL)
3731 uschar *new_return_path = expand_string(tp->return_path);
3732 if (new_return_path == NULL)
3734 if (!expand_string_forcedfail)
3736 remote_post_process(addr, LOG_MAIN|LOG_PANIC,
3737 string_sprintf("Failed to expand return path \"%s\": %s",
3738 tp->return_path, expand_string_message), fallback);
3742 else return_path = new_return_path;
3745 /* Find the uid, gid, and use_initgroups setting for this transport. Failure
3746 logs and sets up error messages, so we just post-process and continue with
3747 the next address. */
3749 if (!findugid(addr, tp, &uid, &gid, &use_initgroups))
3751 remote_post_process(addr, LOG_MAIN|LOG_PANIC, NULL, fallback);
3755 /* If this transport has a setup function, call it now so that it gets
3756 run in this process and not in any subprocess. That way, the results of
3757 any setup that are retained by the transport can be reusable. One of the
3758 things the setup does is to set the fallback host lists in the addresses.
3759 That is why it is called at this point, before the continue delivery
3760 processing, because that might use the fallback hosts. */
3762 if (tp->setup != NULL)
3763 (void)((tp->setup)(addr->transport, addr, NULL, uid, gid, NULL));
3765 /* If this is a run to continue delivery down an already-established
3766 channel, check that this set of addresses matches the transport and
3767 the channel. If it does not, defer the addresses. If a host list exists,
3768 we must check that the continue host is on the list. Otherwise, the
3769 host is set in the transport. */
3771 continue_more = FALSE; /* In case got set for the last lot */
3772 if (continue_transport != NULL)
3774 BOOL ok = Ustrcmp(continue_transport, tp->name) == 0;
3775 if (ok && addr->host_list != NULL)
3779 for (h = addr->host_list; h != NULL; h = h->next)
3781 if (Ustrcmp(h->name, continue_hostname) == 0)
3782 { ok = TRUE; break; }
3786 /* Addresses not suitable; defer or queue for fallback hosts (which
3787 might be the continue host) and skip to next address. */
3791 DEBUG(D_deliver) debug_printf("not suitable for continue_transport\n");
3794 if (addr->fallback_hosts != NULL && !fallback)
3798 next->host_list = next->fallback_hosts;
3799 DEBUG(D_deliver) debug_printf("%s queued for fallback host(s)\n", next->address);
3800 if (next->next == NULL) break;
3803 next->next = addr_fallback;
3804 addr_fallback = addr;
3809 while (next->next != NULL) next = next->next;
3810 next->next = addr_defer;
3817 /* Set a flag indicating whether there are further addresses that list
3818 the continued host. This tells the transport to leave the channel open,
3819 but not to pass it to another delivery process. */
3821 for (next = addr_remote; next != NULL; next = next->next)
3824 for (h = next->host_list; h != NULL; h = h->next)
3826 if (Ustrcmp(h->name, continue_hostname) == 0)
3827 { continue_more = TRUE; break; }
3832 /* The transports set up the process info themselves as they may connect
3833 to more than one remote machine. They also have to set up the filter
3834 arguments, if required, so that the host name and address are available
3837 transport_filter_argv = NULL;
3839 /* Create the pipe for inter-process communication. If pipe creation
3840 fails, it is probably because the value of remote_max_parallel is so
3841 large that too many file descriptors for pipes have been created. Arrange
3842 to wait for a process to finish, and then try again. If we still can't
3843 create a pipe when all processes have finished, break the retry loop. */
3847 if (pipe(pfd) == 0) pipe_done = TRUE;
3848 else if (parcount > 0) parmax = parcount;
3851 /* We need to make the reading end of the pipe non-blocking. There are
3852 two different options for this. Exim is cunningly (I hope!) coded so
3853 that it can use either of them, though it prefers O_NONBLOCK, which
3854 distinguishes between EOF and no-more-data. */
3857 (void)fcntl(pfd[pipe_read], F_SETFL, O_NONBLOCK);
3859 (void)fcntl(pfd[pipe_read], F_SETFL, O_NDELAY);
3862 /* If the maximum number of subprocesses already exist, wait for a process
3863 to finish. If we ran out of file descriptors, parmax will have been reduced
3864 from its initial value of remote_max_parallel. */
3866 par_reduce(parmax - 1, fallback);
3869 /* If we failed to create a pipe and there were no processes to wait
3870 for, we have to give up on this one. Do this outside the above loop
3871 so that we can continue the main loop. */
3875 remote_post_process(addr, LOG_MAIN|LOG_PANIC,
3876 string_sprintf("unable to create pipe: %s", strerror(errno)), fallback);
3880 /* Find a free slot in the pardata list. Must do this after the possible
3881 waiting for processes to finish, because a terminating process will free
3884 for (poffset = 0; poffset < remote_max_parallel; poffset++)
3885 if (parlist[poffset].pid == 0) break;
3887 /* If there isn't one, there has been a horrible disaster. */
3889 if (poffset >= remote_max_parallel)
3891 (void)close(pfd[pipe_write]);
3892 (void)close(pfd[pipe_read]);
3893 remote_post_process(addr, LOG_MAIN|LOG_PANIC,
3894 US"Unexpectedly no free subprocess slot", fallback);
3898 /* Now fork a subprocess to do the remote delivery, but before doing so,
3899 ensure that any cached resourses are released so as not to interfere with
3900 what happens in the subprocess. */
3904 if ((pid = fork()) == 0)
3906 int fd = pfd[pipe_write];
3909 /* Setting this global in the subprocess means we need never clear it */
3910 transport_name = tp->name;
3912 /* There are weird circumstances in which logging is disabled */
3913 disable_logging = tp->disable_logging;
3915 /* Show pids on debug output if parallelism possible */
3917 if (parmax > 1 && (parcount > 0 || addr_remote != NULL))
3919 DEBUG(D_any|D_v) debug_selector |= D_pid;
3920 DEBUG(D_deliver) debug_printf("Remote delivery process started\n");
3923 /* Reset the random number generator, so different processes don't all
3924 have the same sequence. In the test harness we want different, but
3925 predictable settings for each delivery process, so do something explicit
3926 here rather they rely on the fixed reset in the random number function. */
3928 random_seed = running_in_test_harness? 42 + 2*delivery_count : 0;
3930 /* Set close-on-exec on the pipe so that it doesn't get passed on to
3931 a new process that may be forked to do another delivery down the same
3934 (void)fcntl(fd, F_SETFD, fcntl(fd, F_GETFD) | FD_CLOEXEC);
3936 /* Close open file descriptors for the pipes of other processes
3937 that are running in parallel. */
3939 for (poffset = 0; poffset < remote_max_parallel; poffset++)
3940 if (parlist[poffset].pid != 0) (void)close(parlist[poffset].fd);
3942 /* This process has inherited a copy of the file descriptor
3943 for the data file, but its file pointer is shared with all the
3944 other processes running in parallel. Therefore, we have to re-open
3945 the file in order to get a new file descriptor with its own
3946 file pointer. We don't need to lock it, as the lock is held by
3947 the parent process. There doesn't seem to be any way of doing
3948 a dup-with-new-file-pointer. */
3950 (void)close(deliver_datafile);
3951 sprintf(CS spoolname, "%s/input/%s/%s-D", spool_directory, message_subdir,
3953 deliver_datafile = Uopen(spoolname, O_RDWR | O_APPEND, 0);
3955 if (deliver_datafile < 0)
3956 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Failed to reopen %s for remote "
3957 "parallel delivery: %s", spoolname, strerror(errno));
3959 /* Set the close-on-exec flag */
3961 (void)fcntl(deliver_datafile, F_SETFD, fcntl(deliver_datafile, F_GETFD) |
3964 /* Set the uid/gid of this process; bombs out on failure. */
3966 exim_setugid(uid, gid, use_initgroups,
3967 string_sprintf("remote delivery to %s with transport=%s",
3968 addr->address, tp->name));
3970 /* Close the unwanted half of this process' pipe, set the process state,
3971 and run the transport. Afterwards, transport_count will contain the number
3972 of bytes written. */
3974 (void)close(pfd[pipe_read]);
3975 set_process_info("delivering %s using %s", message_id, tp->name);
3976 debug_print_string(tp->debug_string);
3977 if (!(tp->info->code)(addr->transport, addr)) replicate_status(addr);
3979 set_process_info("delivering %s (just run %s for %s%s in subprocess)",
3980 message_id, tp->name, addr->address, (addr->next == NULL)? "" : ", ...");
3982 /* Ensure any cached resources that we used are now released */
3986 /* Pass the result back down the pipe. This is a lot more information
3987 than is needed for a local delivery. We have to send back the error
3988 status for each address, the usability status for each host that is
3989 flagged as unusable, and all the retry items. When TLS is in use, we
3990 send also the cipher and peerdn information. Each type of information
3991 is flagged by an identifying byte, and is then in a fixed format (with
3992 strings terminated by zeros), and there is a final terminator at the
3993 end. The host information and retry information is all attached to
3994 the first address, so that gets sent at the start. */
3996 /* Host unusability information: for most success cases this will
3999 for (h = addr->host_list; h != NULL; h = h->next)
4001 if (h->address == NULL || h->status < hstatus_unusable) continue;
4002 sprintf(CS big_buffer, "H%c%c%s", h->status, h->why, h->address);
4003 rmt_dlv_checked_write(fd, big_buffer, Ustrlen(big_buffer+3) + 4);
4006 /* The number of bytes written. This is the same for each address. Even
4007 if we sent several copies of the message down the same connection, the
4008 size of each one is the same, and it's that value we have got because
4009 transport_count gets reset before calling transport_write_message(). */
4011 big_buffer[0] = 'S';
4012 memcpy(big_buffer+1, &transport_count, sizeof(transport_count));
4013 rmt_dlv_checked_write(fd, big_buffer, sizeof(transport_count) + 1);
4015 /* Information about what happened to each address. Four item types are
4016 used: an optional 'X' item first, for TLS information, then an optional "C"
4017 item for any client-auth info followed by 'R' items for any retry settings,
4018 and finally an 'A' item for the remaining data. */
4020 for(; addr != NULL; addr = addr->next)
4025 /* The certificate verification status goes into the flags */
4027 if (tls_out.certificate_verified) setflag(addr, af_cert_verified);
4029 /* Use an X item only if there's something to send */
4032 if (addr->cipher != NULL)
4035 sprintf(CS ptr, "X%.128s", addr->cipher);
4037 if (addr->peerdn == NULL) *ptr++ = 0; else
4039 sprintf(CS ptr, "%.512s", addr->peerdn);
4042 rmt_dlv_checked_write(fd, big_buffer, ptr - big_buffer);
4046 if (client_authenticator)
4049 sprintf(CS big_buffer, "C1%.64s", client_authenticator);
4051 rmt_dlv_checked_write(fd, big_buffer, ptr - big_buffer);
4053 if (client_authenticated_id)
4056 sprintf(CS big_buffer, "C2%.64s", client_authenticated_id);
4058 rmt_dlv_checked_write(fd, big_buffer, ptr - big_buffer);
4060 if (client_authenticated_sender)
4063 sprintf(CS big_buffer, "C3%.64s", client_authenticated_sender);
4065 rmt_dlv_checked_write(fd, big_buffer, ptr - big_buffer);
4068 #ifdef EXPERIMENTAL_PRDR
4069 if (addr->flags & af_prdr_used) rmt_dlv_checked_write(fd, "P", 1);
4072 /* Retry information: for most success cases this will be null. */
4074 for (r = addr->retries; r != NULL; r = r->next)
4077 sprintf(CS big_buffer, "R%c%.500s", r->flags, r->key);
4078 ptr = big_buffer + Ustrlen(big_buffer+2) + 3;
4079 memcpy(ptr, &(r->basic_errno), sizeof(r->basic_errno));
4080 ptr += sizeof(r->basic_errno);
4081 memcpy(ptr, &(r->more_errno), sizeof(r->more_errno));
4082 ptr += sizeof(r->more_errno);
4083 if (r->message == NULL) *ptr++ = 0; else
4085 sprintf(CS ptr, "%.512s", r->message);
4088 rmt_dlv_checked_write(fd, big_buffer, ptr - big_buffer);
4091 /* The rest of the information goes in an 'A' item. */
4093 ptr = big_buffer + 3;
4094 sprintf(CS big_buffer, "A%c%c", addr->transport_return,
4095 addr->special_action);
4096 memcpy(ptr, &(addr->basic_errno), sizeof(addr->basic_errno));
4097 ptr += sizeof(addr->basic_errno);
4098 memcpy(ptr, &(addr->more_errno), sizeof(addr->more_errno));
4099 ptr += sizeof(addr->more_errno);
4100 memcpy(ptr, &(addr->flags), sizeof(addr->flags));
4101 ptr += sizeof(addr->flags);
4103 if (addr->message == NULL) *ptr++ = 0; else
4105 sprintf(CS ptr, "%.1024s", addr->message);
4109 if (addr->user_message == NULL) *ptr++ = 0; else
4111 sprintf(CS ptr, "%.1024s", addr->user_message);
4115 if (addr->host_used == NULL) *ptr++ = 0; else
4117 sprintf(CS ptr, "%.256s", addr->host_used->name);
4119 sprintf(CS ptr, "%.64s", addr->host_used->address);
4121 memcpy(ptr, &(addr->host_used->port), sizeof(addr->host_used->port));
4122 ptr += sizeof(addr->host_used->port);
4124 rmt_dlv_checked_write(fd, big_buffer, ptr - big_buffer);
4127 /* Add termination flag, close the pipe, and that's it. The character
4128 after 'Z' indicates whether continue_transport is now NULL or not.
4129 A change from non-NULL to NULL indicates a problem with a continuing
4132 big_buffer[0] = 'Z';
4133 big_buffer[1] = (continue_transport == NULL)? '0' : '1';
4134 rmt_dlv_checked_write(fd, big_buffer, 2);
4139 /* Back in the mainline: close the unwanted half of the pipe. */
4141 (void)close(pfd[pipe_write]);
4143 /* Fork failed; defer with error message */
4147 (void)close(pfd[pipe_read]);
4148 remote_post_process(addr, LOG_MAIN|LOG_PANIC,
4149 string_sprintf("fork failed for remote delivery to %s: %s",
4150 addr->domain, strerror(errno)), fallback);
4154 /* Fork succeeded; increment the count, and remember relevant data for
4155 when the process finishes. */
4158 parlist[poffset].addrlist = parlist[poffset].addr = addr;
4159 parlist[poffset].pid = pid;
4160 parlist[poffset].fd = pfd[pipe_read];
4161 parlist[poffset].done = FALSE;
4162 parlist[poffset].msg = NULL;
4163 parlist[poffset].return_path = return_path;
4165 /* If the process we've just started is sending a message down an existing
4166 channel, wait for it now. This ensures that only one such process runs at
4167 once, whatever the value of remote_max parallel. Otherwise, we might try to
4168 send two or more messages simultaneously down the same channel. This could
4169 happen if there are different domains that include the same host in otherwise
4170 different host lists.
4172 Also, if the transport closes down the channel, this information gets back
4173 (continue_transport gets set to NULL) before we consider any other addresses
4176 if (continue_transport != NULL) par_reduce(0, fallback);
4178 /* Otherwise, if we are running in the test harness, wait a bit, to let the
4179 newly created process get going before we create another process. This should
4180 ensure repeatability in the tests. We only need to wait a tad. */
4182 else if (running_in_test_harness) millisleep(500);
4185 /* Reached the end of the list of addresses. Wait for all the subprocesses that
4186 are still running and post-process their addresses. */
4188 par_reduce(0, fallback);
4195 /*************************************************
4196 * Split an address into local part and domain *
4197 *************************************************/
4199 /* This function initializes an address for routing by splitting it up into a
4200 local part and a domain. The local part is set up twice - once in its original
4201 casing, and once in lower case, and it is dequoted. We also do the "percent
4202 hack" for configured domains. This may lead to a DEFER result if a lookup
4203 defers. When a percent-hacking takes place, we insert a copy of the original
4204 address as a new parent of this address, as if we have had a redirection.
4207 addr points to an addr_item block containing the address
4210 DEFER - could not determine if domain is %-hackable
4214 deliver_split_address(address_item *addr)
4216 uschar *address = addr->address;
4217 uschar *domain = Ustrrchr(address, '@');
4219 int len = domain - address;
4221 addr->domain = string_copylc(domain+1); /* Domains are always caseless */
4223 /* The implication in the RFCs (though I can't say I've seen it spelled out
4224 explicitly) is that quoting should be removed from local parts at the point
4225 where they are locally interpreted. [The new draft "821" is more explicit on
4226 this, Jan 1999.] We know the syntax is valid, so this can be done by simply
4227 removing quoting backslashes and any unquoted doublequotes. */
4229 t = addr->cc_local_part = store_get(len+1);
4232 register int c = *address++;
4233 if (c == '\"') continue;
4243 /* We do the percent hack only for those domains that are listed in
4244 percent_hack_domains. A loop is required, to copy with multiple %-hacks. */
4246 if (percent_hack_domains != NULL)
4249 uschar *new_address = NULL;
4250 uschar *local_part = addr->cc_local_part;
4252 deliver_domain = addr->domain; /* set $domain */
4254 while ((rc = match_isinlist(deliver_domain, &percent_hack_domains, 0,
4255 &domainlist_anchor, addr->domain_cache, MCL_DOMAIN, TRUE, NULL))
4257 (t = Ustrrchr(local_part, '%')) != NULL)
4259 new_address = string_copy(local_part);
4260 new_address[t - local_part] = '@';
4261 deliver_domain = string_copylc(t+1);
4262 local_part = string_copyn(local_part, t - local_part);
4265 if (rc == DEFER) return DEFER; /* lookup deferred */
4267 /* If hackery happened, set up new parent and alter the current address. */
4269 if (new_address != NULL)
4271 address_item *new_parent = store_get(sizeof(address_item));
4272 *new_parent = *addr;
4273 addr->parent = new_parent;
4274 addr->address = new_address;
4275 addr->unique = string_copy(new_address);
4276 addr->domain = deliver_domain;
4277 addr->cc_local_part = local_part;
4278 DEBUG(D_deliver) debug_printf("%%-hack changed address to: %s\n",
4283 /* Create the lowercased version of the final local part, and make that the
4284 default one to be used. */
4286 addr->local_part = addr->lc_local_part = string_copylc(addr->cc_local_part);
4293 /*************************************************
4294 * Get next error message text *
4295 *************************************************/
4297 /* If f is not NULL, read the next "paragraph", from a customized error message
4298 text file, terminated by a line containing ****, and expand it.
4301 f NULL or a file to read from
4302 which string indicating which string (for errors)
4304 Returns: NULL or an expanded string
4308 next_emf(FILE *f, uschar *which)
4312 uschar *para, *yield;
4315 if (f == NULL) return NULL;
4317 if (Ufgets(buffer, sizeof(buffer), f) == NULL ||
4318 Ustrcmp(buffer, "****\n") == 0) return NULL;
4320 para = store_get(size);
4323 para = string_cat(para, &size, &ptr, buffer, Ustrlen(buffer));
4324 if (Ufgets(buffer, sizeof(buffer), f) == NULL ||
4325 Ustrcmp(buffer, "****\n") == 0) break;
4329 yield = expand_string(para);
4330 if (yield != NULL) return yield;
4332 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand string from "
4333 "bounce_message_file or warn_message_file (%s): %s", which,
4334 expand_string_message);
4341 /*************************************************
4342 * Close down a passed transport channel *
4343 *************************************************/
4345 /* This function is called when a passed transport channel cannot be used.
4346 It attempts to close it down tidily. The yield is always DELIVER_NOT_ATTEMPTED
4347 so that the function call can be the argument of a "return" statement.
4350 Returns: DELIVER_NOT_ATTEMPTED
4354 continue_closedown(void)
4356 if (continue_transport != NULL)
4358 transport_instance *t;
4359 for (t = transports; t != NULL; t = t->next)
4361 if (Ustrcmp(t->name, continue_transport) == 0)
4363 if (t->info->closedown != NULL) (t->info->closedown)(t);
4368 return DELIVER_NOT_ATTEMPTED;
4374 /*************************************************
4375 * Print address information *
4376 *************************************************/
4378 /* This function is called to output an address, or information about an
4379 address, for bounce or defer messages. If the hide_child flag is set, all we
4380 output is the original ancestor address.
4383 addr points to the address
4384 f the FILE to print to
4385 si an initial string
4386 sc a continuation string for before "generated"
4389 Returns: TRUE if the address is not hidden
4393 print_address_information(address_item *addr, FILE *f, uschar *si, uschar *sc,
4397 uschar *printed = US"";
4398 address_item *ancestor = addr;
4399 while (ancestor->parent != NULL) ancestor = ancestor->parent;
4401 fprintf(f, "%s", CS si);
4403 if (addr->parent != NULL && testflag(addr, af_hide_child))
4405 printed = US"an undisclosed address";
4408 else if (!testflag(addr, af_pfr) || addr->parent == NULL)
4409 printed = addr->address;
4413 uschar *s = addr->address;
4416 if (addr->address[0] == '>') { ss = US"mail"; s++; }
4417 else if (addr->address[0] == '|') ss = US"pipe";
4420 fprintf(f, "%s to %s%sgenerated by ", ss, s, sc);
4421 printed = addr->parent->address;
4424 fprintf(f, "%s", CS string_printing(printed));
4426 if (ancestor != addr)
4428 uschar *original = (ancestor->onetime_parent == NULL)?
4429 ancestor->address : ancestor->onetime_parent;
4430 if (strcmpic(original, printed) != 0)
4431 fprintf(f, "%s(%sgenerated from %s)", sc,
4432 (ancestor != addr->parent)? "ultimately " : "",
4433 string_printing(original));
4436 fprintf(f, "%s", CS se);
4444 /*************************************************
4445 * Print error for an address *
4446 *************************************************/
4448 /* This function is called to print the error information out of an address for
4449 a bounce or a warning message. It tries to format the message reasonably by
4450 introducing newlines. All lines are indented by 4; the initial printing
4451 position must be set before calling.
4453 This function used always to print the error. Nowadays we want to restrict it
4454 to cases such as LMTP/SMTP errors from a remote host, and errors from :fail:
4455 and filter "fail". We no longer pass other information willy-nilly in bounce
4456 and warning messages. Text in user_message is always output; text in message
4457 only if the af_pass_message flag is set.
4461 f the FILE to print on
4468 print_address_error(address_item *addr, FILE *f, uschar *t)
4470 int count = Ustrlen(t);
4471 uschar *s = testflag(addr, af_pass_message)? addr->message : NULL;
4475 if (addr->user_message != NULL) s = addr->user_message; else return;
4478 fprintf(f, "\n %s", t);
4482 if (*s == '\\' && s[1] == 'n')
4492 if (*s++ == ':' && isspace(*s) && count > 45)
4494 fprintf(f, "\n "); /* sic (because space follows) */
4506 /*************************************************
4507 * Check list of addresses for duplication *
4508 *************************************************/
4510 /* This function was introduced when the test for duplicate addresses that are
4511 not pipes, files, or autoreplies was moved from the middle of routing to when
4512 routing was complete. That was to fix obscure cases when the routing history
4513 affects the subsequent routing of identical addresses. This function is called
4514 after routing, to check that the final routed addresses are not duplicates.
4516 If we detect a duplicate, we remember what it is a duplicate of. Note that
4517 pipe, file, and autoreply de-duplication is handled during routing, so we must
4518 leave such "addresses" alone here, as otherwise they will incorrectly be
4521 Argument: address of list anchor
4526 do_duplicate_check(address_item **anchor)
4529 while ((addr = *anchor) != NULL)
4532 if (testflag(addr, af_pfr))
4534 anchor = &(addr->next);
4536 else if ((tnode = tree_search(tree_duplicates, addr->unique)) != NULL)
4538 DEBUG(D_deliver|D_route)
4539 debug_printf("%s is a duplicate address: discarded\n", addr->unique);
4540 *anchor = addr->next;
4541 addr->dupof = tnode->data.ptr;
4542 addr->next = addr_duplicate;
4543 addr_duplicate = addr;
4547 tree_add_duplicate(addr->unique, addr);
4548 anchor = &(addr->next);
4556 /*************************************************
4557 * Deliver one message *
4558 *************************************************/
4560 /* This is the function which is called when a message is to be delivered. It
4561 is passed the id of the message. It is possible that the message no longer
4562 exists, if some other process has delivered it, and it is also possible that
4563 the message is being worked on by another process, in which case the data file
4566 If no delivery is attempted for any of the above reasons, the function returns
4567 DELIVER_NOT_ATTEMPTED.
4569 If the give_up flag is set true, do not attempt any deliveries, but instead
4570 fail all outstanding addresses and return the message to the sender (or
4573 A delivery operation has a process all to itself; we never deliver more than
4574 one message in the same process. Therefore we needn't worry too much about
4578 id the id of the message to be delivered
4579 forced TRUE if delivery was forced by an administrator; this overrides
4580 retry delays and causes a delivery to be tried regardless
4581 give_up TRUE if an administrator has requested that delivery attempts
4584 Returns: When the global variable mua_wrapper is FALSE:
4585 DELIVER_ATTEMPTED_NORMAL if a delivery attempt was made
4586 DELIVER_NOT_ATTEMPTED otherwise (see comment above)
4587 When the global variable mua_wrapper is TRUE:
4588 DELIVER_MUA_SUCCEEDED if delivery succeeded
4589 DELIVER_MUA_FAILED if delivery failed
4590 DELIVER_NOT_ATTEMPTED if not attempted (should not occur)
4594 deliver_message(uschar *id, BOOL forced, BOOL give_up)
4597 int final_yield = DELIVER_ATTEMPTED_NORMAL;
4598 time_t now = time(NULL);
4599 address_item *addr_last = NULL;
4600 uschar *filter_message = NULL;
4602 int process_recipients = RECIP_ACCEPT;
4605 extern int acl_where;
4607 uschar *info = (queue_run_pid == (pid_t)0)?
4608 string_sprintf("delivering %s", id) :
4609 string_sprintf("delivering %s (queue run pid %d)", id, queue_run_pid);
4611 /* If the D_process_info bit is on, set_process_info() will output debugging
4612 information. If not, we want to show this initial information if D_deliver or
4613 D_queue_run is set or in verbose mode. */
4615 set_process_info("%s", info);
4617 if ((debug_selector & D_process_info) == 0 &&
4618 (debug_selector & (D_deliver|D_queue_run|D_v)) != 0)
4619 debug_printf("%s\n", info);
4621 /* Ensure that we catch any subprocesses that are created. Although Exim
4622 sets SIG_DFL as its initial default, some routes through the code end up
4623 here with it set to SIG_IGN - cases where a non-synchronous delivery process
4624 has been forked, but no re-exec has been done. We use sigaction rather than
4625 plain signal() on those OS where SA_NOCLDWAIT exists, because we want to be
4626 sure it is turned off. (There was a problem on AIX with this.) */
4630 struct sigaction act;
4631 act.sa_handler = SIG_DFL;
4632 sigemptyset(&(act.sa_mask));
4634 sigaction(SIGCHLD, &act, NULL);
4637 signal(SIGCHLD, SIG_DFL);
4640 /* Make the forcing flag available for routers and transports, set up the
4641 global message id field, and initialize the count for returned files and the
4642 message size. This use of strcpy() is OK because the length id is checked when
4643 it is obtained from a command line (the -M or -q options), and otherwise it is
4644 known to be a valid message id. */
4646 Ustrcpy(message_id, id);
4647 deliver_force = forced;
4651 /* Initialize some flags */
4653 update_spool = FALSE;
4654 remove_journal = TRUE;
4656 /* Set a known context for any ACLs we call via expansions */
4657 acl_where = ACL_WHERE_DELIVERY;
4659 /* Reset the random number generator, so that if several delivery processes are
4660 started from a queue runner that has already used random numbers (for sorting),
4661 they don't all get the same sequence. */
4665 /* Open and lock the message's data file. Exim locks on this one because the
4666 header file may get replaced as it is re-written during the delivery process.
4667 Any failures cause messages to be written to the log, except for missing files
4668 while queue running - another process probably completed delivery. As part of
4669 opening the data file, message_subdir gets set. */
4671 if (!spool_open_datafile(id))
4672 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
4674 /* The value of message_size at this point has been set to the data length,
4675 plus one for the blank line that notionally precedes the data. */
4677 /* Now read the contents of the header file, which will set up the headers in
4678 store, and also the list of recipients and the tree of non-recipients and
4679 assorted flags. It updates message_size. If there is a reading or format error,
4680 give up; if the message has been around for sufficiently long, remove it. */
4682 sprintf(CS spoolname, "%s-H", id);
4683 if ((rc = spool_read_header(spoolname, TRUE, TRUE)) != spool_read_OK)
4685 if (errno == ERRNO_SPOOLFORMAT)
4687 struct stat statbuf;
4688 sprintf(CS big_buffer, "%s/input/%s/%s", spool_directory, message_subdir,
4690 if (Ustat(big_buffer, &statbuf) == 0)
4691 log_write(0, LOG_MAIN, "Format error in spool file %s: "
4692 "size=" OFF_T_FMT, spoolname, statbuf.st_size);
4693 else log_write(0, LOG_MAIN, "Format error in spool file %s", spoolname);
4696 log_write(0, LOG_MAIN, "Error reading spool file %s: %s", spoolname,
4699 /* If we managed to read the envelope data, received_time contains the
4700 time the message was received. Otherwise, we can calculate it from the
4703 if (rc != spool_read_hdrerror)
4706 for (i = 0; i < 6; i++)
4707 received_time = received_time * BASE_62 + tab62[id[i] - '0'];
4710 /* If we've had this malformed message too long, sling it. */
4712 if (now - received_time > keep_malformed)
4714 sprintf(CS spoolname, "%s/msglog/%s/%s", spool_directory, message_subdir, id);
4716 sprintf(CS spoolname, "%s/input/%s/%s-D", spool_directory, message_subdir, id);
4718 sprintf(CS spoolname, "%s/input/%s/%s-H", spool_directory, message_subdir, id);
4720 sprintf(CS spoolname, "%s/input/%s/%s-J", spool_directory, message_subdir, id);
4722 log_write(0, LOG_MAIN, "Message removed because older than %s",
4723 readconf_printtime(keep_malformed));
4726 (void)close(deliver_datafile);
4727 deliver_datafile = -1;
4728 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
4731 /* The spool header file has been read. Look to see if there is an existing
4732 journal file for this message. If there is, it means that a previous delivery
4733 attempt crashed (program or host) before it could update the spool header file.
4734 Read the list of delivered addresses from the journal and add them to the
4735 nonrecipients tree. Then update the spool file. We can leave the journal in
4736 existence, as it will get further successful deliveries added to it in this
4737 run, and it will be deleted if this function gets to its end successfully.
4738 Otherwise it might be needed again. */
4740 sprintf(CS spoolname, "%s/input/%s/%s-J", spool_directory, message_subdir, id);
4741 jread = Ufopen(spoolname, "rb");
4744 while (Ufgets(big_buffer, big_buffer_size, jread) != NULL)
4746 int n = Ustrlen(big_buffer);
4747 big_buffer[n-1] = 0;
4748 tree_add_nonrecipient(big_buffer);
4749 DEBUG(D_deliver) debug_printf("Previously delivered address %s taken from "
4750 "journal file\n", big_buffer);
4752 (void)fclose(jread);
4753 /* Panic-dies on error */
4754 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
4756 else if (errno != ENOENT)
4758 log_write(0, LOG_MAIN|LOG_PANIC, "attempt to open journal for reading gave: "
4759 "%s", strerror(errno));
4760 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
4763 /* A null recipients list indicates some kind of disaster. */
4765 if (recipients_list == NULL)
4767 (void)close(deliver_datafile);
4768 deliver_datafile = -1;
4769 log_write(0, LOG_MAIN, "Spool error: no recipients for %s", spoolname);
4770 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
4774 /* Handle a message that is frozen. There are a number of different things that
4775 can happen, but in the default situation, unless forced, no delivery is
4780 #ifdef SUPPORT_MOVE_FROZEN_MESSAGES
4781 /* Moving to another directory removes the message from Exim's view. Other
4782 tools must be used to deal with it. Logging of this action happens in
4783 spool_move_message() and its subfunctions. */
4785 if (move_frozen_messages &&
4786 spool_move_message(id, message_subdir, US"", US"F"))
4787 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
4790 /* For all frozen messages (bounces or not), timeout_frozen_after sets the
4791 maximum time to keep messages that are frozen. Thaw if we reach it, with a
4792 flag causing all recipients to be failed. The time is the age of the
4793 message, not the time since freezing. */
4795 if (timeout_frozen_after > 0 && message_age >= timeout_frozen_after)
4797 log_write(0, LOG_MAIN, "cancelled by timeout_frozen_after");
4798 process_recipients = RECIP_FAIL_TIMEOUT;
4801 /* For bounce messages (and others with no sender), thaw if the error message
4802 ignore timer is exceeded. The message will be discarded if this delivery
4805 else if (sender_address[0] == 0 && message_age >= ignore_bounce_errors_after)
4807 log_write(0, LOG_MAIN, "Unfrozen by errmsg timer");
4810 /* If this is a bounce message, or there's no auto thaw, or we haven't
4811 reached the auto thaw time yet, and this delivery is not forced by an admin
4812 user, do not attempt delivery of this message. Note that forced is set for
4813 continuing messages down the same channel, in order to skip load checking and
4814 ignore hold domains, but we don't want unfreezing in that case. */
4818 if ((sender_address[0] == 0 ||
4820 now <= deliver_frozen_at + auto_thaw
4823 (!forced || !deliver_force_thaw || !admin_user ||
4824 continue_hostname != NULL
4827 (void)close(deliver_datafile);
4828 deliver_datafile = -1;
4829 log_write(L_skip_delivery, LOG_MAIN, "Message is frozen");
4830 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
4833 /* If delivery was forced (by an admin user), assume a manual thaw.
4834 Otherwise it's an auto thaw. */
4838 deliver_manual_thaw = TRUE;
4839 log_write(0, LOG_MAIN, "Unfrozen by forced delivery");
4841 else log_write(0, LOG_MAIN, "Unfrozen by auto-thaw");
4844 /* We get here if any of the rules for unfreezing have triggered. */
4846 deliver_freeze = FALSE;
4847 update_spool = TRUE;
4851 /* Open the message log file if we are using them. This records details of
4852 deliveries, deferments, and failures for the benefit of the mail administrator.
4853 The log is not used by exim itself to track the progress of a message; that is
4854 done by rewriting the header spool file. */
4861 sprintf(CS spoolname, "%s/msglog/%s/%s", spool_directory, message_subdir, id);
4862 fd = open_msglog_file(spoolname, SPOOL_MODE, &error);
4866 log_write(0, LOG_MAIN|LOG_PANIC, "Couldn't %s message log %s: %s", error,
4867 spoolname, strerror(errno));
4868 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
4871 /* Make a C stream out of it. */
4873 message_log = fdopen(fd, "a");
4874 if (message_log == NULL)
4876 log_write(0, LOG_MAIN|LOG_PANIC, "Couldn't fdopen message log %s: %s",
4877 spoolname, strerror(errno));
4878 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
4883 /* If asked to give up on a message, log who did it, and set the action for all
4888 struct passwd *pw = getpwuid(real_uid);
4889 log_write(0, LOG_MAIN, "cancelled by %s", (pw != NULL)?
4890 US pw->pw_name : string_sprintf("uid %ld", (long int)real_uid));
4891 process_recipients = RECIP_FAIL;
4894 /* Otherwise, if there are too many Received: headers, fail all recipients. */
4896 else if (received_count > received_headers_max)
4897 process_recipients = RECIP_FAIL_LOOP;
4899 /* Otherwise, if a system-wide, address-independent message filter is
4900 specified, run it now, except in the case when we are failing all recipients as
4901 a result of timeout_frozen_after. If the system filter yields "delivered", then
4902 ignore the true recipients of the message. Failure of the filter file is
4903 logged, and the delivery attempt fails. */
4905 else if (system_filter != NULL && process_recipients != RECIP_FAIL_TIMEOUT)
4910 redirect_block redirect;
4912 if (system_filter_uid_set)
4914 ugid.uid = system_filter_uid;
4915 ugid.gid = system_filter_gid;
4916 ugid.uid_set = ugid.gid_set = TRUE;
4920 ugid.uid_set = ugid.gid_set = FALSE;
4923 return_path = sender_address;
4924 enable_dollar_recipients = TRUE; /* Permit $recipients in system filter */
4925 system_filtering = TRUE;
4927 /* Any error in the filter file causes a delivery to be abandoned. */
4929 redirect.string = system_filter;
4930 redirect.isfile = TRUE;
4931 redirect.check_owner = redirect.check_group = FALSE;
4932 redirect.owners = NULL;
4933 redirect.owngroups = NULL;
4935 redirect.modemask = 0;
4937 DEBUG(D_deliver|D_filter) debug_printf("running system filter\n");
4940 &redirect, /* Where the data is */
4941 RDO_DEFER | /* Turn on all the enabling options */
4942 RDO_FAIL | /* Leave off all the disabling options */
4947 NULL, /* No :include: restriction (not used in filter) */
4948 NULL, /* No sieve vacation directory (not sieve!) */
4949 NULL, /* No sieve enotify mailto owner (not sieve!) */
4950 NULL, /* No sieve user address (not sieve!) */
4951 NULL, /* No sieve subaddress (not sieve!) */
4952 &ugid, /* uid/gid data */
4953 &addr_new, /* Where to hang generated addresses */
4954 &filter_message, /* Where to put error message */
4955 NULL, /* Don't skip syntax errors */
4956 &filtertype, /* Will always be set to FILTER_EXIM for this call */
4957 US"system filter"); /* For error messages */
4959 DEBUG(D_deliver|D_filter) debug_printf("system filter returned %d\n", rc);
4961 if (rc == FF_ERROR || rc == FF_NONEXIST)
4963 (void)close(deliver_datafile);
4964 deliver_datafile = -1;
4965 log_write(0, LOG_MAIN|LOG_PANIC, "Error in system filter: %s",
4966 string_printing(filter_message));
4967 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
4970 /* Reset things. If the filter message is an empty string, which can happen
4971 for a filter "fail" or "freeze" command with no text, reset it to NULL. */
4973 system_filtering = FALSE;
4974 enable_dollar_recipients = FALSE;
4975 if (filter_message != NULL && filter_message[0] == 0) filter_message = NULL;
4977 /* Save the values of the system filter variables so that user filters
4980 memcpy(filter_sn, filter_n, sizeof(filter_sn));
4982 /* The filter can request that delivery of the original addresses be
4987 process_recipients = RECIP_DEFER;
4988 deliver_msglog("Delivery deferred by system filter\n");
4989 log_write(0, LOG_MAIN, "Delivery deferred by system filter");
4992 /* The filter can request that a message be frozen, but this does not
4993 take place if the message has been manually thawed. In that case, we must
4994 unset "delivered", which is forced by the "freeze" command to make -bF
4997 else if (rc == FF_FREEZE && !deliver_manual_thaw)
4999 deliver_freeze = TRUE;
5000 deliver_frozen_at = time(NULL);
5001 process_recipients = RECIP_DEFER;
5002 frozen_info = string_sprintf(" by the system filter%s%s",
5003 (filter_message == NULL)? US"" : US": ",
5004 (filter_message == NULL)? US"" : filter_message);
5007 /* The filter can request that a message be failed. The error message may be
5008 quite long - it is sent back to the sender in the bounce - but we don't want
5009 to fill up the log with repetitions of it. If it starts with << then the text
5010 between << and >> is written to the log, with the rest left for the bounce
5013 else if (rc == FF_FAIL)
5015 uschar *colon = US"";
5016 uschar *logmsg = US"";
5019 process_recipients = RECIP_FAIL_FILTER;
5021 if (filter_message != NULL)
5025 if (filter_message[0] == '<' && filter_message[1] == '<' &&
5026 (logend = Ustrstr(filter_message, ">>")) != NULL)
5028 logmsg = filter_message + 2;
5029 loglen = logend - logmsg;
5030 filter_message = logend + 2;
5031 if (filter_message[0] == 0) filter_message = NULL;
5035 logmsg = filter_message;
5036 loglen = Ustrlen(filter_message);
5040 log_write(0, LOG_MAIN, "cancelled by system filter%s%.*s", colon, loglen,
5044 /* Delivery can be restricted only to those recipients (if any) that the
5045 filter specified. */
5047 else if (rc == FF_DELIVERED)
5049 process_recipients = RECIP_IGNORE;
5050 if (addr_new == NULL)
5051 log_write(0, LOG_MAIN, "=> discarded (system filter)");
5053 log_write(0, LOG_MAIN, "original recipients ignored (system filter)");
5056 /* If any new addresses were created by the filter, fake up a "parent"
5057 for them. This is necessary for pipes, etc., which are expected to have
5058 parents, and it also gives some sensible logging for others. Allow
5059 pipes, files, and autoreplies, and run them as the filter uid if set,
5060 otherwise as the current uid. */
5062 if (addr_new != NULL)
5064 int uid = (system_filter_uid_set)? system_filter_uid : geteuid();
5065 int gid = (system_filter_gid_set)? system_filter_gid : getegid();
5067 /* The text "system-filter" is tested in transport_set_up_command() and in
5068 set_up_shell_command() in the pipe transport, to enable them to permit
5069 $recipients, so don't change it here without also changing it there. */
5071 address_item *p = addr_new;
5072 address_item *parent = deliver_make_addr(US"system-filter", FALSE);
5074 parent->domain = string_copylc(qualify_domain_recipient);
5075 parent->local_part = US"system-filter";
5077 /* As part of this loop, we arrange for addr_last to end up pointing
5078 at the final address. This is used if we go on to add addresses for the
5079 original recipients. */
5083 if (parent->child_count == SHRT_MAX)
5084 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "system filter generated more "
5085 "than %d delivery addresses", SHRT_MAX);
5086 parent->child_count++;
5089 if (testflag(p, af_pfr))
5095 setflag(p, af_uid_set |
5101 /* Find the name of the system filter's appropriate pfr transport */
5103 if (p->address[0] == '|')
5106 tpname = system_filter_pipe_transport;
5107 address_pipe = p->address;
5109 else if (p->address[0] == '>')
5112 tpname = system_filter_reply_transport;
5116 if (p->address[Ustrlen(p->address)-1] == '/')
5118 type = US"directory";
5119 tpname = system_filter_directory_transport;
5124 tpname = system_filter_file_transport;
5126 address_file = p->address;
5129 /* Now find the actual transport, first expanding the name. We have
5130 set address_file or address_pipe above. */
5134 uschar *tmp = expand_string(tpname);
5135 address_file = address_pipe = NULL;
5137 p->message = string_sprintf("failed to expand \"%s\" as a "
5138 "system filter transport name", tpname);
5143 p->message = string_sprintf("system_filter_%s_transport is unset",
5149 transport_instance *tp;
5150 for (tp = transports; tp != NULL; tp = tp->next)
5152 if (Ustrcmp(tp->name, tpname) == 0)
5159 p->message = string_sprintf("failed to find \"%s\" transport "
5160 "for system filter delivery", tpname);
5163 /* If we couldn't set up a transport, defer the delivery, putting the
5164 error on the panic log as well as the main log. */
5166 if (p->transport == NULL)
5168 address_item *badp = p;
5170 if (addr_last == NULL) addr_new = p; else addr_last->next = p;
5171 badp->local_part = badp->address; /* Needed for log line */
5172 post_process_one(badp, DEFER, LOG_MAIN|LOG_PANIC, DTYPE_ROUTER, 0);
5175 } /* End of pfr handling */
5177 /* Either a non-pfr delivery, or we found a transport */
5179 DEBUG(D_deliver|D_filter)
5180 debug_printf("system filter added %s\n", p->address);
5184 } /* Loop through all addr_new addresses */
5189 /* Scan the recipients list, and for every one that is not in the non-
5190 recipients tree, add an addr item to the chain of new addresses. If the pno
5191 value is non-negative, we must set the onetime parent from it. This which
5192 points to the relevant entry in the recipients list.
5194 This processing can be altered by the setting of the process_recipients
5195 variable, which is changed if recipients are to be ignored, failed, or
5196 deferred. This can happen as a result of system filter activity, or if the -Mg
5197 option is used to fail all of them.
5199 Duplicate addresses are handled later by a different tree structure; we can't
5200 just extend the non-recipients tree, because that will be re-written to the
5201 spool if the message is deferred, and in any case there are casing
5202 complications for local addresses. */
5204 if (process_recipients != RECIP_IGNORE)
5206 for (i = 0; i < recipients_count; i++)
5208 if (tree_search(tree_nonrecipients, recipients_list[i].address) == NULL)
5210 recipient_item *r = recipients_list + i;
5211 address_item *new = deliver_make_addr(r->address, FALSE);
5212 new->p.errors_address = r->errors_to;
5215 new->onetime_parent = recipients_list[r->pno].address;
5217 switch (process_recipients)
5219 /* RECIP_DEFER is set when a system filter freezes a message. */
5222 new->next = addr_defer;
5227 /* RECIP_FAIL_FILTER is set when a system filter has obeyed a "fail"
5230 case RECIP_FAIL_FILTER:
5232 (filter_message == NULL)? US"delivery cancelled" : filter_message;
5233 setflag(new, af_pass_message);
5234 goto RECIP_QUEUE_FAILED; /* below */
5237 /* RECIP_FAIL_TIMEOUT is set when a message is frozen, but is older
5238 than the value in timeout_frozen_after. Treat non-bounce messages
5239 similarly to -Mg; for bounce messages we just want to discard, so
5240 don't put the address on the failed list. The timeout has already
5243 case RECIP_FAIL_TIMEOUT:
5244 new->message = US"delivery cancelled; message timed out";
5245 goto RECIP_QUEUE_FAILED; /* below */
5248 /* RECIP_FAIL is set when -Mg has been used. */
5251 new->message = US"delivery cancelled by administrator";
5254 /* Common code for the failure cases above. If this is not a bounce
5255 message, put the address on the failed list so that it is used to
5256 create a bounce. Otherwise do nothing - this just discards the address.
5257 The incident has already been logged. */
5260 if (sender_address[0] != 0)
5262 new->next = addr_failed;
5268 /* RECIP_FAIL_LOOP is set when there are too many Received: headers
5269 in the message. Process each address as a routing failure; if this
5270 is a bounce message, it will get frozen. */
5272 case RECIP_FAIL_LOOP:
5273 new->message = US"Too many \"Received\" headers - suspected mail loop";
5274 post_process_one(new, FAIL, LOG_MAIN, DTYPE_ROUTER, 0);
5278 /* Value should be RECIP_ACCEPT; take this as the safe default. */
5281 if (addr_new == NULL) addr_new = new; else addr_last->next = new;
5291 address_item *p = addr_new;
5292 debug_printf("Delivery address list:\n");
5295 debug_printf(" %s %s\n", p->address, (p->onetime_parent == NULL)? US"" :
5301 /* Set up the buffers used for copying over the file when delivering. */
5303 deliver_in_buffer = store_malloc(DELIVER_IN_BUFFER_SIZE);
5304 deliver_out_buffer = store_malloc(DELIVER_OUT_BUFFER_SIZE);
5308 /* Until there are no more new addresses, handle each one as follows:
5310 . If this is a generated address (indicated by the presence of a parent
5311 pointer) then check to see whether it is a pipe, file, or autoreply, and
5312 if so, handle it directly here. The router that produced the address will
5313 have set the allow flags into the address, and also set the uid/gid required.
5314 Having the routers generate new addresses and then checking them here at
5315 the outer level is tidier than making each router do the checking, and
5316 means that routers don't need access to the failed address queue.
5318 . Break up the address into local part and domain, and make lowercased
5319 versions of these strings. We also make unquoted versions of the local part.
5321 . Handle the percent hack for those domains for which it is valid.
5323 . For child addresses, determine if any of the parents have the same address.
5324 If so, generate a different string for previous delivery checking. Without
5325 this code, if the address spqr generates spqr via a forward or alias file,
5326 delivery of the generated spqr stops further attempts at the top level spqr,
5327 which is not what is wanted - it may have generated other addresses.
5329 . Check on the retry database to see if routing was previously deferred, but
5330 only if in a queue run. Addresses that are to be routed are put on the
5331 addr_route chain. Addresses that are to be deferred are put on the
5332 addr_defer chain. We do all the checking first, so as not to keep the
5333 retry database open any longer than necessary.
5335 . Now we run the addresses through the routers. A router may put the address
5336 on either the addr_local or the addr_remote chain for local or remote
5337 delivery, respectively, or put it on the addr_failed chain if it is
5338 undeliveable, or it may generate child addresses and put them on the
5339 addr_new chain, or it may defer an address. All the chain anchors are
5340 passed as arguments so that the routers can be called for verification
5343 . If new addresses have been generated by the routers, da capo.
5346 header_rewritten = FALSE; /* No headers rewritten yet */
5347 while (addr_new != NULL) /* Loop until all addresses dealt with */
5349 address_item *addr, *parent;
5350 dbm_file = dbfn_open(US"retry", O_RDONLY, &dbblock, FALSE);
5352 /* Failure to open the retry database is treated the same as if it does
5353 not exist. In both cases, dbm_file is NULL. */
5355 if (dbm_file == NULL)
5357 DEBUG(D_deliver|D_retry|D_route|D_hints_lookup)
5358 debug_printf("no retry data available\n");
5361 /* Scan the current batch of new addresses, to handle pipes, files and
5362 autoreplies, and determine which others are ready for routing. */
5364 while (addr_new != NULL)
5369 dbdata_retry *domain_retry_record;
5370 dbdata_retry *address_retry_record;
5373 addr_new = addr->next;
5375 DEBUG(D_deliver|D_retry|D_route)
5377 debug_printf(">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>\n");
5378 debug_printf("Considering: %s\n", addr->address);
5381 /* Handle generated address that is a pipe or a file or an autoreply. */
5383 if (testflag(addr, af_pfr))
5385 /* If an autoreply in a filter could not generate a syntactically valid
5386 address, give up forthwith. Set af_ignore_error so that we don't try to
5387 generate a bounce. */
5389 if (testflag(addr, af_bad_reply))
5391 addr->basic_errno = ERRNO_BADADDRESS2;
5392 addr->local_part = addr->address;
5394 US"filter autoreply generated syntactically invalid recipient";
5395 setflag(addr, af_ignore_error);
5396 (void)post_process_one(addr, FAIL, LOG_MAIN, DTYPE_ROUTER, 0);
5397 continue; /* with the next new address */
5400 /* If two different users specify delivery to the same pipe or file or
5401 autoreply, there should be two different deliveries, so build a unique
5402 string that incorporates the original address, and use this for
5403 duplicate testing and recording delivery, and also for retrying. */
5406 string_sprintf("%s:%s", addr->address, addr->parent->unique +
5407 (testflag(addr->parent, af_homonym)? 3:0));
5409 addr->address_retry_key = addr->domain_retry_key =
5410 string_sprintf("T:%s", addr->unique);
5412 /* If a filter file specifies two deliveries to the same pipe or file,
5413 we want to de-duplicate, but this is probably not wanted for two mail
5414 commands to the same address, where probably both should be delivered.
5415 So, we have to invent a different unique string in that case. Just
5416 keep piling '>' characters on the front. */
5418 if (addr->address[0] == '>')
5420 while (tree_search(tree_duplicates, addr->unique) != NULL)
5421 addr->unique = string_sprintf(">%s", addr->unique);
5424 else if ((tnode = tree_search(tree_duplicates, addr->unique)) != NULL)
5426 DEBUG(D_deliver|D_route)
5427 debug_printf("%s is a duplicate address: discarded\n", addr->address);
5428 addr->dupof = tnode->data.ptr;
5429 addr->next = addr_duplicate;
5430 addr_duplicate = addr;
5434 DEBUG(D_deliver|D_route) debug_printf("unique = %s\n", addr->unique);
5436 /* Check for previous delivery */
5438 if (tree_search(tree_nonrecipients, addr->unique) != NULL)
5440 DEBUG(D_deliver|D_route)
5441 debug_printf("%s was previously delivered: discarded\n", addr->address);
5442 child_done(addr, tod_stamp(tod_log));
5446 /* Save for checking future duplicates */
5448 tree_add_duplicate(addr->unique, addr);
5450 /* Set local part and domain */
5452 addr->local_part = addr->address;
5453 addr->domain = addr->parent->domain;
5455 /* Ensure that the delivery is permitted. */
5457 if (testflag(addr, af_file))
5459 if (!testflag(addr, af_allow_file))
5461 addr->basic_errno = ERRNO_FORBIDFILE;
5462 addr->message = US"delivery to file forbidden";
5463 (void)post_process_one(addr, FAIL, LOG_MAIN, DTYPE_ROUTER, 0);
5464 continue; /* with the next new address */
5467 else if (addr->address[0] == '|')
5469 if (!testflag(addr, af_allow_pipe))
5471 addr->basic_errno = ERRNO_FORBIDPIPE;
5472 addr->message = US"delivery to pipe forbidden";
5473 (void)post_process_one(addr, FAIL, LOG_MAIN, DTYPE_ROUTER, 0);
5474 continue; /* with the next new address */
5477 else if (!testflag(addr, af_allow_reply))
5479 addr->basic_errno = ERRNO_FORBIDREPLY;
5480 addr->message = US"autoreply forbidden";
5481 (void)post_process_one(addr, FAIL, LOG_MAIN, DTYPE_ROUTER, 0);
5482 continue; /* with the next new address */
5485 /* If the errno field is already set to BADTRANSPORT, it indicates
5486 failure to expand a transport string, or find the associated transport,
5487 or an unset transport when one is required. Leave this test till now so
5488 that the forbid errors are given in preference. */
5490 if (addr->basic_errno == ERRNO_BADTRANSPORT)
5492 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_ROUTER, 0);
5496 /* Treat /dev/null as a special case and abandon the delivery. This
5497 avoids having to specify a uid on the transport just for this case.
5498 Arrange for the transport name to be logged as "**bypassed**". */
5500 if (Ustrcmp(addr->address, "/dev/null") == 0)
5502 uschar *save = addr->transport->name;
5503 addr->transport->name = US"**bypassed**";
5504 (void)post_process_one(addr, OK, LOG_MAIN, DTYPE_TRANSPORT, '=');
5505 addr->transport->name = save;
5506 continue; /* with the next new address */
5509 /* Pipe, file, or autoreply delivery is to go ahead as a normal local
5512 DEBUG(D_deliver|D_route)
5513 debug_printf("queued for %s transport\n", addr->transport->name);
5514 addr->next = addr_local;
5516 continue; /* with the next new address */
5519 /* Handle normal addresses. First, split up into local part and domain,
5520 handling the %-hack if necessary. There is the possibility of a defer from
5521 a lookup in percent_hack_domains. */
5523 if ((rc = deliver_split_address(addr)) == DEFER)
5525 addr->message = US"cannot check percent_hack_domains";
5526 addr->basic_errno = ERRNO_LISTDEFER;
5527 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_NONE, 0);
5531 /* Check to see if the domain is held. If so, proceed only if the
5532 delivery was forced by hand. */
5534 deliver_domain = addr->domain; /* set $domain */
5535 if (!forced && hold_domains != NULL &&
5536 (rc = match_isinlist(addr->domain, &hold_domains, 0,
5537 &domainlist_anchor, addr->domain_cache, MCL_DOMAIN, TRUE,
5542 addr->message = US"hold_domains lookup deferred";
5543 addr->basic_errno = ERRNO_LISTDEFER;
5547 addr->message = US"domain is held";
5548 addr->basic_errno = ERRNO_HELD;
5550 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_NONE, 0);
5554 /* Now we can check for duplicates and previously delivered addresses. In
5555 order to do this, we have to generate a "unique" value for each address,
5556 because there may be identical actual addresses in a line of descendents.
5557 The "unique" field is initialized to the same value as the "address" field,
5558 but gets changed here to cope with identically-named descendents. */
5560 for (parent = addr->parent; parent != NULL; parent = parent->parent)
5561 if (strcmpic(addr->address, parent->address) == 0) break;
5563 /* If there's an ancestor with the same name, set the homonym flag. This
5564 influences how deliveries are recorded. Then add a prefix on the front of
5565 the unique address. We use \n\ where n starts at 0 and increases each time.
5566 It is unlikely to pass 9, but if it does, it may look odd but will still
5567 work. This means that siblings or cousins with the same names are treated
5568 as duplicates, which is what we want. */
5572 setflag(addr, af_homonym);
5573 if (parent->unique[0] != '\\')
5574 addr->unique = string_sprintf("\\0\\%s", addr->address);
5576 addr->unique = string_sprintf("\\%c\\%s", parent->unique[1] + 1,
5580 /* Ensure that the domain in the unique field is lower cased, because
5581 domains are always handled caselessly. */
5583 p = Ustrrchr(addr->unique, '@');
5584 while (*p != 0) { *p = tolower(*p); p++; }
5586 DEBUG(D_deliver|D_route) debug_printf("unique = %s\n", addr->unique);
5588 if (tree_search(tree_nonrecipients, addr->unique) != NULL)
5590 DEBUG(D_deliver|D_route)
5591 debug_printf("%s was previously delivered: discarded\n", addr->unique);
5592 child_done(addr, tod_stamp(tod_log));
5596 /* Get the routing retry status, saving the two retry keys (with and
5597 without the local part) for subsequent use. If there is no retry record for
5598 the standard address routing retry key, we look for the same key with the
5599 sender attached, because this form is used by the smtp transport after a
5600 4xx response to RCPT when address_retry_include_sender is true. */
5602 addr->domain_retry_key = string_sprintf("R:%s", addr->domain);
5603 addr->address_retry_key = string_sprintf("R:%s@%s", addr->local_part,
5606 if (dbm_file == NULL)
5607 domain_retry_record = address_retry_record = NULL;
5610 domain_retry_record = dbfn_read(dbm_file, addr->domain_retry_key);
5611 if (domain_retry_record != NULL &&
5612 now - domain_retry_record->time_stamp > retry_data_expire)
5613 domain_retry_record = NULL; /* Ignore if too old */
5615 address_retry_record = dbfn_read(dbm_file, addr->address_retry_key);
5616 if (address_retry_record != NULL &&
5617 now - address_retry_record->time_stamp > retry_data_expire)
5618 address_retry_record = NULL; /* Ignore if too old */
5620 if (address_retry_record == NULL)
5622 uschar *altkey = string_sprintf("%s:<%s>", addr->address_retry_key,
5624 address_retry_record = dbfn_read(dbm_file, altkey);
5625 if (address_retry_record != NULL &&
5626 now - address_retry_record->time_stamp > retry_data_expire)
5627 address_retry_record = NULL; /* Ignore if too old */
5631 DEBUG(D_deliver|D_retry)
5633 if (domain_retry_record == NULL)
5634 debug_printf("no domain retry record\n");
5635 if (address_retry_record == NULL)
5636 debug_printf("no address retry record\n");
5639 /* If we are sending a message down an existing SMTP connection, we must
5640 assume that the message which created the connection managed to route
5641 an address to that connection. We do not want to run the risk of taking
5642 a long time over routing here, because if we do, the server at the other
5643 end of the connection may time it out. This is especially true for messages
5644 with lots of addresses. For this kind of delivery, queue_running is not
5645 set, so we would normally route all addresses. We take a pragmatic approach
5646 and defer routing any addresses that have any kind of domain retry record.
5647 That is, we don't even look at their retry times. It doesn't matter if this
5648 doesn't work occasionally. This is all just an optimization, after all.
5650 The reason for not doing the same for address retries is that they normally
5651 arise from 4xx responses, not DNS timeouts. */
5653 if (continue_hostname != NULL && domain_retry_record != NULL)
5655 addr->message = US"reusing SMTP connection skips previous routing defer";
5656 addr->basic_errno = ERRNO_RRETRY;
5657 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_ROUTER, 0);
5660 /* If we are in a queue run, defer routing unless there is no retry data or
5661 we've passed the next retry time, or this message is forced. In other
5662 words, ignore retry data when not in a queue run.
5664 However, if the domain retry time has expired, always allow the routing
5665 attempt. If it fails again, the address will be failed. This ensures that
5666 each address is routed at least once, even after long-term routing
5669 If there is an address retry, check that too; just wait for the next
5670 retry time. This helps with the case when the temporary error on the
5671 address was really message-specific rather than address specific, since
5672 it allows other messages through.
5674 We also wait for the next retry time if this is a message sent down an
5675 existing SMTP connection (even though that will be forced). Otherwise there
5676 will be far too many attempts for an address that gets a 4xx error. In
5677 fact, after such an error, we should not get here because, the host should
5678 not be remembered as one this message needs. However, there was a bug that
5679 used to cause this to happen, so it is best to be on the safe side.
5681 Even if we haven't reached the retry time in the hints, there is one more
5682 check to do, which is for the ultimate address timeout. We only do this
5683 check if there is an address retry record and there is not a domain retry
5684 record; this implies that previous attempts to handle the address had the
5685 retry_use_local_parts option turned on. We use this as an approximation
5686 for the destination being like a local delivery, for example delivery over
5687 LMTP to an IMAP message store. In this situation users are liable to bump
5688 into their quota and thereby have intermittently successful deliveries,
5689 which keep the retry record fresh, which can lead to us perpetually
5690 deferring messages. */
5692 else if (((queue_running && !deliver_force) || continue_hostname != NULL)
5694 ((domain_retry_record != NULL &&
5695 now < domain_retry_record->next_try &&
5696 !domain_retry_record->expired)
5698 (address_retry_record != NULL &&
5699 now < address_retry_record->next_try))
5701 (domain_retry_record != NULL ||
5702 address_retry_record == NULL ||
5703 !retry_ultimate_address_timeout(addr->address_retry_key,
5704 addr->domain, address_retry_record, now)))
5706 addr->message = US"retry time not reached";
5707 addr->basic_errno = ERRNO_RRETRY;
5708 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_ROUTER, 0);
5711 /* The domain is OK for routing. Remember if retry data exists so it
5712 can be cleaned up after a successful delivery. */
5716 if (domain_retry_record != NULL || address_retry_record != NULL)
5717 setflag(addr, af_dr_retry_exists);
5718 addr->next = addr_route;
5720 DEBUG(D_deliver|D_route)
5721 debug_printf("%s: queued for routing\n", addr->address);
5725 /* The database is closed while routing is actually happening. Requests to
5726 update it are put on a chain and all processed together at the end. */
5728 if (dbm_file != NULL) dbfn_close(dbm_file);
5730 /* If queue_domains is set, we don't even want to try routing addresses in
5731 those domains. During queue runs, queue_domains is forced to be unset.
5732 Optimize by skipping this pass through the addresses if nothing is set. */
5734 if (!deliver_force && queue_domains != NULL)
5736 address_item *okaddr = NULL;
5737 while (addr_route != NULL)
5739 address_item *addr = addr_route;
5740 addr_route = addr->next;
5742 deliver_domain = addr->domain; /* set $domain */
5743 if ((rc = match_isinlist(addr->domain, &queue_domains, 0,
5744 &domainlist_anchor, addr->domain_cache, MCL_DOMAIN, TRUE, NULL))
5749 addr->basic_errno = ERRNO_LISTDEFER;
5750 addr->message = US"queue_domains lookup deferred";
5751 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_ROUTER, 0);
5755 addr->next = okaddr;
5761 addr->basic_errno = ERRNO_QUEUE_DOMAIN;
5762 addr->message = US"domain is in queue_domains";
5763 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_ROUTER, 0);
5767 addr_route = okaddr;
5770 /* Now route those addresses that are not deferred. */
5772 while (addr_route != NULL)
5775 address_item *addr = addr_route;
5776 uschar *old_domain = addr->domain;
5777 uschar *old_unique = addr->unique;
5778 addr_route = addr->next;
5781 /* Just in case some router parameter refers to it. */
5783 return_path = (addr->p.errors_address != NULL)?
5784 addr->p.errors_address : sender_address;
5786 /* If a router defers an address, add a retry item. Whether or not to
5787 use the local part in the key is a property of the router. */
5789 if ((rc = route_address(addr, &addr_local, &addr_remote, &addr_new,
5790 &addr_succeed, v_none)) == DEFER)
5791 retry_add_item(addr, (addr->router->retry_use_local_part)?
5792 string_sprintf("R:%s@%s", addr->local_part, addr->domain) :
5793 string_sprintf("R:%s", addr->domain), 0);
5795 /* Otherwise, if there is an existing retry record in the database, add
5796 retry items to delete both forms. We must also allow for the possibility
5797 of a routing retry that includes the sender address. Since the domain might
5798 have been rewritten (expanded to fully qualified) as a result of routing,
5799 ensure that the rewritten form is also deleted. */
5801 else if (testflag(addr, af_dr_retry_exists))
5803 uschar *altkey = string_sprintf("%s:<%s>", addr->address_retry_key,
5805 retry_add_item(addr, altkey, rf_delete);
5806 retry_add_item(addr, addr->address_retry_key, rf_delete);
5807 retry_add_item(addr, addr->domain_retry_key, rf_delete);
5808 if (Ustrcmp(addr->domain, old_domain) != 0)
5809 retry_add_item(addr, string_sprintf("R:%s", old_domain), rf_delete);
5812 /* DISCARD is given for :blackhole: and "seen finish". The event has been
5813 logged, but we need to ensure the address (and maybe parents) is marked
5818 address_done(addr, tod_stamp(tod_log));
5819 continue; /* route next address */
5822 /* The address is finished with (failed or deferred). */
5826 (void)post_process_one(addr, rc, LOG_MAIN, DTYPE_ROUTER, 0);
5827 continue; /* route next address */
5830 /* The address has been routed. If the router changed the domain, it will
5831 also have changed the unique address. We have to test whether this address
5832 has already been delivered, because it's the unique address that finally
5835 if (addr->unique != old_unique &&
5836 tree_search(tree_nonrecipients, addr->unique) != 0)
5838 DEBUG(D_deliver|D_route) debug_printf("%s was previously delivered: "
5839 "discarded\n", addr->address);
5840 if (addr_remote == addr) addr_remote = addr->next;
5841 else if (addr_local == addr) addr_local = addr->next;
5844 /* If the router has same_domain_copy_routing set, we are permitted to copy
5845 the routing for any other addresses with the same domain. This is an
5846 optimisation to save repeated DNS lookups for "standard" remote domain
5847 routing. The option is settable only on routers that generate host lists.
5848 We play it very safe, and do the optimization only if the address is routed
5849 to a remote transport, there are no header changes, and the domain was not
5850 modified by the router. */
5852 if (addr_remote == addr &&
5853 addr->router->same_domain_copy_routing &&
5854 addr->p.extra_headers == NULL &&
5855 addr->p.remove_headers == NULL &&
5856 old_domain == addr->domain)
5858 address_item **chain = &addr_route;
5859 while (*chain != NULL)
5861 address_item *addr2 = *chain;
5862 if (Ustrcmp(addr2->domain, addr->domain) != 0)
5864 chain = &(addr2->next);
5868 /* Found a suitable address; take it off the routing list and add it to
5869 the remote delivery list. */
5871 *chain = addr2->next;
5872 addr2->next = addr_remote;
5873 addr_remote = addr2;
5875 /* Copy the routing data */
5877 addr2->domain = addr->domain;
5878 addr2->router = addr->router;
5879 addr2->transport = addr->transport;
5880 addr2->host_list = addr->host_list;
5881 addr2->fallback_hosts = addr->fallback_hosts;
5882 addr2->p.errors_address = addr->p.errors_address;
5883 copyflag(addr2, addr, af_hide_child | af_local_host_removed);
5885 DEBUG(D_deliver|D_route)
5887 debug_printf(">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>\n"
5889 "Routing for %s copied from %s\n",
5890 addr2->address, addr2->address, addr->address);
5894 } /* Continue with routing the next address. */
5895 } /* Loop to process any child addresses that the routers created, and
5896 any rerouted addresses that got put back on the new chain. */
5899 /* Debugging: show the results of the routing */
5901 DEBUG(D_deliver|D_retry|D_route)
5903 address_item *p = addr_local;
5904 debug_printf(">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>\n");
5905 debug_printf("After routing:\n Local deliveries:\n");
5908 debug_printf(" %s\n", p->address);
5913 debug_printf(" Remote deliveries:\n");
5916 debug_printf(" %s\n", p->address);
5921 debug_printf(" Failed addresses:\n");
5924 debug_printf(" %s\n", p->address);
5929 debug_printf(" Deferred addresses:\n");
5932 debug_printf(" %s\n", p->address);
5937 /* Free any resources that were cached during routing. */
5942 /* These two variables are set only during routing, after check_local_user.
5943 Ensure they are not set in transports. */
5945 local_user_gid = (gid_t)(-1);
5946 local_user_uid = (uid_t)(-1);
5948 /* Check for any duplicate addresses. This check is delayed until after
5949 routing, because the flexibility of the routing configuration means that
5950 identical addresses with different parentage may end up being redirected to
5951 different addresses. Checking for duplicates too early (as we previously used
5952 to) makes this kind of thing not work. */
5954 do_duplicate_check(&addr_local);
5955 do_duplicate_check(&addr_remote);
5957 /* When acting as an MUA wrapper, we proceed only if all addresses route to a
5958 remote transport. The check that they all end up in one transaction happens in
5959 the do_remote_deliveries() function. */
5961 if (mua_wrapper && (addr_local != NULL || addr_failed != NULL ||
5962 addr_defer != NULL))
5965 uschar *which, *colon, *msg;
5967 if (addr_local != NULL)
5972 else if (addr_defer != NULL)
5975 which = US"deferred";
5983 while (addr->parent != NULL) addr = addr->parent;
5985 if (addr->message != NULL)
5988 msg = addr->message;
5990 else colon = msg = US"";
5992 /* We don't need to log here for a forced failure as it will already
5993 have been logged. Defer will also have been logged, but as a defer, so we do
5994 need to do the failure logging. */
5996 if (addr != addr_failed)
5997 log_write(0, LOG_MAIN, "** %s routing yielded a %s delivery",
5998 addr->address, which);
6000 /* Always write an error to the caller */
6002 fprintf(stderr, "routing %s yielded a %s delivery%s%s\n", addr->address,
6005 final_yield = DELIVER_MUA_FAILED;
6006 addr_failed = addr_defer = NULL; /* So that we remove the message */
6007 goto DELIVERY_TIDYUP;
6011 /* If this is a run to continue deliveries to an external channel that is
6012 already set up, defer any local deliveries. */
6014 if (continue_transport != NULL)
6016 if (addr_defer == NULL) addr_defer = addr_local; else
6018 address_item *addr = addr_defer;
6019 while (addr->next != NULL) addr = addr->next;
6020 addr->next = addr_local;
6026 /* Because address rewriting can happen in the routers, we should not really do
6027 ANY deliveries until all addresses have been routed, so that all recipients of
6028 the message get the same headers. However, this is in practice not always
6029 possible, since sometimes remote addresses give DNS timeouts for days on end.
6030 The pragmatic approach is to deliver what we can now, saving any rewritten
6031 headers so that at least the next lot of recipients benefit from the rewriting
6032 that has already been done.
6034 If any headers have been rewritten during routing, update the spool file to
6035 remember them for all subsequent deliveries. This can be delayed till later if
6036 there is only address to be delivered - if it succeeds the spool write need not
6039 if (header_rewritten &&
6040 ((addr_local != NULL &&
6041 (addr_local->next != NULL || addr_remote != NULL)) ||
6042 (addr_remote != NULL && addr_remote->next != NULL)))
6044 /* Panic-dies on error */
6045 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
6046 header_rewritten = FALSE;
6050 /* If there are any deliveries to be done, open the journal file. This is used
6051 to record successful deliveries as soon as possible after each delivery is
6052 known to be complete. A file opened with O_APPEND is used so that several
6053 processes can run simultaneously.
6055 The journal is just insurance against crashes. When the spool file is
6056 ultimately updated at the end of processing, the journal is deleted. If a
6057 journal is found to exist at the start of delivery, the addresses listed
6058 therein are added to the non-recipients. */
6060 if (addr_local != NULL || addr_remote != NULL)
6062 sprintf(CS spoolname, "%s/input/%s/%s-J", spool_directory, message_subdir, id);
6063 journal_fd = Uopen(spoolname, O_WRONLY|O_APPEND|O_CREAT, SPOOL_MODE);
6067 log_write(0, LOG_MAIN|LOG_PANIC, "Couldn't open journal file %s: %s",
6068 spoolname, strerror(errno));
6069 return DELIVER_NOT_ATTEMPTED;
6072 /* Set the close-on-exec flag, make the file owned by Exim, and ensure
6073 that the mode is correct - the group setting doesn't always seem to get
6074 set automatically. */
6076 if( fcntl(journal_fd, F_SETFD, fcntl(journal_fd, F_GETFD) | FD_CLOEXEC)
6077 || fchown(journal_fd, exim_uid, exim_gid)
6078 || fchmod(journal_fd, SPOOL_MODE)
6081 int ret = Uunlink(spoolname);
6082 log_write(0, LOG_MAIN|LOG_PANIC, "Couldn't set perms on journal file %s: %s",
6083 spoolname, strerror(errno));
6084 if(ret && errno != ENOENT)
6085 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s",
6086 spoolname, strerror(errno));
6087 return DELIVER_NOT_ATTEMPTED;
6093 /* Now we can get down to the business of actually doing deliveries. Local
6094 deliveries are done first, then remote ones. If ever the problems of how to
6095 handle fallback transports are figured out, this section can be put into a loop
6096 for handling fallbacks, though the uid switching will have to be revised. */
6098 /* Precompile a regex that is used to recognize a parameter in response
6099 to an LHLO command, if is isn't already compiled. This may be used on both
6100 local and remote LMTP deliveries. */
6102 if (regex_IGNOREQUOTA == NULL) regex_IGNOREQUOTA =
6103 regex_must_compile(US"\\n250[\\s\\-]IGNOREQUOTA(\\s|\\n|$)", FALSE, TRUE);
6105 /* Handle local deliveries */
6107 if (addr_local != NULL)
6109 DEBUG(D_deliver|D_transport)
6110 debug_printf(">>>>>>>>>>>>>>>> Local deliveries >>>>>>>>>>>>>>>>\n");
6111 do_local_deliveries();
6112 disable_logging = FALSE;
6115 /* If queue_run_local is set, we do not want to attempt any remote deliveries,
6116 so just queue them all. */
6118 if (queue_run_local)
6120 while (addr_remote != NULL)
6122 address_item *addr = addr_remote;
6123 addr_remote = addr->next;
6125 addr->basic_errno = ERRNO_LOCAL_ONLY;
6126 addr->message = US"remote deliveries suppressed";
6127 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_TRANSPORT, 0);
6131 /* Handle remote deliveries */
6133 if (addr_remote != NULL)
6135 DEBUG(D_deliver|D_transport)
6136 debug_printf(">>>>>>>>>>>>>>>> Remote deliveries >>>>>>>>>>>>>>>>\n");
6138 /* Precompile some regex that are used to recognize parameters in response
6139 to an EHLO command, if they aren't already compiled. */
6141 if (regex_PIPELINING == NULL) regex_PIPELINING =
6142 regex_must_compile(US"\\n250[\\s\\-]PIPELINING(\\s|\\n|$)", FALSE, TRUE);
6144 if (regex_SIZE == NULL) regex_SIZE =
6145 regex_must_compile(US"\\n250[\\s\\-]SIZE(\\s|\\n|$)", FALSE, TRUE);
6147 if (regex_AUTH == NULL) regex_AUTH =
6148 regex_must_compile(US"\\n250[\\s\\-]AUTH\\s+([\\-\\w\\s]+)(?:\\n|$)",
6152 if (regex_STARTTLS == NULL) regex_STARTTLS =
6153 regex_must_compile(US"\\n250[\\s\\-]STARTTLS(\\s|\\n|$)", FALSE, TRUE);
6156 #ifdef EXPERIMENTAL_PRDR
6157 if (regex_PRDR == NULL) regex_PRDR =
6158 regex_must_compile(US"\\n250[\\s\\-]PRDR(\\s|\\n|$)", FALSE, TRUE);
6161 /* Now sort the addresses if required, and do the deliveries. The yield of
6162 do_remote_deliveries is FALSE when mua_wrapper is set and all addresses
6163 cannot be delivered in one transaction. */
6165 if (remote_sort_domains != NULL) sort_remote_deliveries();
6166 if (!do_remote_deliveries(FALSE))
6168 log_write(0, LOG_MAIN, "** mua_wrapper is set but recipients cannot all "
6169 "be delivered in one transaction");
6170 fprintf(stderr, "delivery to smarthost failed (configuration problem)\n");
6172 final_yield = DELIVER_MUA_FAILED;
6173 addr_failed = addr_defer = NULL; /* So that we remove the message */
6174 goto DELIVERY_TIDYUP;
6177 /* See if any of the addresses that failed got put on the queue for delivery
6178 to their fallback hosts. We do it this way because often the same fallback
6179 host is used for many domains, so all can be sent in a single transaction
6180 (if appropriately configured). */
6182 if (addr_fallback != NULL && !mua_wrapper)
6184 DEBUG(D_deliver) debug_printf("Delivering to fallback hosts\n");
6185 addr_remote = addr_fallback;
6186 addr_fallback = NULL;
6187 if (remote_sort_domains != NULL) sort_remote_deliveries();
6188 do_remote_deliveries(TRUE);
6190 disable_logging = FALSE;
6194 /* All deliveries are now complete. Ignore SIGTERM during this tidying up
6195 phase, to minimize cases of half-done things. */
6198 debug_printf(">>>>>>>>>>>>>>>> deliveries are done >>>>>>>>>>>>>>>>\n");
6200 /* Root privilege is no longer needed */
6202 exim_setugid(exim_uid, exim_gid, FALSE, US"post-delivery tidying");
6204 set_process_info("tidying up after delivering %s", message_id);
6205 signal(SIGTERM, SIG_IGN);
6207 /* When we are acting as an MUA wrapper, the smtp transport will either have
6208 succeeded for all addresses, or failed them all in normal cases. However, there
6209 are some setup situations (e.g. when a named port does not exist) that cause an
6210 immediate exit with deferral of all addresses. Convert those into failures. We
6211 do not ever want to retry, nor do we want to send a bounce message. */
6215 if (addr_defer != NULL)
6217 address_item *addr, *nextaddr;
6218 for (addr = addr_defer; addr != NULL; addr = nextaddr)
6220 log_write(0, LOG_MAIN, "** %s mua_wrapper forced failure for deferred "
6221 "delivery", addr->address);
6222 nextaddr = addr->next;
6223 addr->next = addr_failed;
6229 /* Now all should either have succeeded or failed. */
6231 if (addr_failed == NULL) final_yield = DELIVER_MUA_SUCCEEDED; else
6233 uschar *s = (addr_failed->user_message != NULL)?
6234 addr_failed->user_message : addr_failed->message;
6236 fprintf(stderr, "Delivery failed: ");
6237 if (addr_failed->basic_errno > 0)
6239 fprintf(stderr, "%s", strerror(addr_failed->basic_errno));
6240 if (s != NULL) fprintf(stderr, ": ");
6244 if (addr_failed->basic_errno <= 0) fprintf(stderr, "unknown error");
6246 else fprintf(stderr, "%s", CS s);
6247 fprintf(stderr, "\n");
6249 final_yield = DELIVER_MUA_FAILED;
6254 /* In a normal configuration, we now update the retry database. This is done in
6255 one fell swoop at the end in order not to keep opening and closing (and
6256 locking) the database. The code for handling retries is hived off into a
6257 separate module for convenience. We pass it the addresses of the various
6258 chains, because deferred addresses can get moved onto the failed chain if the
6259 retry cutoff time has expired for all alternative destinations. Bypass the
6260 updating of the database if the -N flag is set, which is a debugging thing that
6261 prevents actual delivery. */
6263 else if (!dont_deliver) retry_update(&addr_defer, &addr_failed, &addr_succeed);
6265 /* If any addresses failed, we must send a message to somebody, unless
6266 af_ignore_error is set, in which case no action is taken. It is possible for
6267 several messages to get sent if there are addresses with different
6270 while (addr_failed != NULL)
6274 uschar *logtod = tod_stamp(tod_log);
6276 address_item *handled_addr = NULL;
6277 address_item **paddr;
6278 address_item *msgchain = NULL;
6279 address_item **pmsgchain = &msgchain;
6281 /* There are weird cases when logging is disabled in the transport. However,
6282 there may not be a transport (address failed by a router). */
6284 disable_logging = FALSE;
6285 if (addr_failed->transport != NULL)
6286 disable_logging = addr_failed->transport->disable_logging;
6289 debug_printf("processing failed address %s\n", addr_failed->address);
6291 /* There are only two ways an address in a bounce message can get here:
6293 (1) When delivery was initially deferred, but has now timed out (in the call
6294 to retry_update() above). We can detect this by testing for
6295 af_retry_timedout. If the address does not have its own errors address,
6296 we arrange to ignore the error.
6298 (2) If delivery failures for bounce messages are being ignored. We can detect
6299 this by testing for af_ignore_error. This will also be set if a bounce
6300 message has been autothawed and the ignore_bounce_errors_after time has
6301 passed. It might also be set if a router was explicitly configured to
6302 ignore errors (errors_to = "").
6304 If neither of these cases obtains, something has gone wrong. Log the
6305 incident, but then ignore the error. */
6307 if (sender_address[0] == 0 && addr_failed->p.errors_address == NULL)
6309 if (!testflag(addr_failed, af_retry_timedout) &&
6310 !testflag(addr_failed, af_ignore_error))
6312 log_write(0, LOG_MAIN|LOG_PANIC, "internal error: bounce message "
6313 "failure is neither frozen nor ignored (it's been ignored)");
6315 setflag(addr_failed, af_ignore_error);
6318 /* If the first address on the list has af_ignore_error set, just remove
6319 it from the list, throw away any saved message file, log it, and
6320 mark the recipient done. */
6322 if (testflag(addr_failed, af_ignore_error))
6325 addr_failed = addr->next;
6326 if (addr->return_filename != NULL) Uunlink(addr->return_filename);
6328 log_write(0, LOG_MAIN, "%s%s%s%s: error ignored",
6330 (addr->parent == NULL)? US"" : US" <",
6331 (addr->parent == NULL)? US"" : addr->parent->address,
6332 (addr->parent == NULL)? US"" : US">");
6334 address_done(addr, logtod);
6335 child_done(addr, logtod);
6336 /* Panic-dies on error */
6337 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
6340 /* Otherwise, handle the sending of a message. Find the error address for
6341 the first address, then send a message that includes all failed addresses
6342 that have the same error address. Note the bounce_recipient is a global so
6343 that it can be accesssed by $bounce_recipient while creating a customized
6348 bounce_recipient = (addr_failed->p.errors_address == NULL)?
6349 sender_address : addr_failed->p.errors_address;
6351 /* Make a subprocess to send a message */
6353 pid = child_open_exim(&fd);
6355 /* Creation of child failed */
6358 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Process %d (parent %d) failed to "
6359 "create child process to send failure message: %s", getpid(),
6360 getppid(), strerror(errno));
6362 /* Creation of child succeeded */
6369 uschar *bcc, *emf_text;
6370 FILE *f = fdopen(fd, "wb");
6372 BOOL to_sender = strcmpic(sender_address, bounce_recipient) == 0;
6373 int max = (bounce_return_size_limit/DELIVER_IN_BUFFER_SIZE + 1) *
6374 DELIVER_IN_BUFFER_SIZE;
6377 debug_printf("sending error message to: %s\n", bounce_recipient);
6379 /* Scan the addresses for all that have the same errors address, removing
6380 them from the addr_failed chain, and putting them on msgchain. */
6382 paddr = &addr_failed;
6383 for (addr = addr_failed; addr != NULL; addr = *paddr)
6385 if (Ustrcmp(bounce_recipient, (addr->p.errors_address == NULL)?
6386 sender_address : addr->p.errors_address) != 0)
6388 paddr = &(addr->next); /* Not the same; skip */
6390 else /* The same - dechain */
6392 *paddr = addr->next;
6395 pmsgchain = &(addr->next);
6399 /* Include X-Failed-Recipients: for automatic interpretation, but do
6400 not let any one header line get too long. We do this by starting a
6401 new header every 50 recipients. Omit any addresses for which the
6402 "hide_child" flag is set. */
6404 for (addr = msgchain; addr != NULL; addr = addr->next)
6406 if (testflag(addr, af_hide_child)) continue;
6413 (rcount++ == 0)? "X-Failed-Recipients: " : ",\n ",
6414 (testflag(addr, af_pfr) && addr->parent != NULL)?
6415 string_printing(addr->parent->address) :
6416 string_printing(addr->address));
6418 if (rcount > 0) fprintf(f, "\n");
6420 /* Output the standard headers */
6422 if (errors_reply_to != NULL)
6423 fprintf(f, "Reply-To: %s\n", errors_reply_to);
6424 fprintf(f, "Auto-Submitted: auto-replied\n");
6426 fprintf(f, "To: %s\n", bounce_recipient);
6428 /* Open a template file if one is provided. Log failure to open, but
6429 carry on - default texts will be used. */
6431 if (bounce_message_file != NULL)
6433 emf = Ufopen(bounce_message_file, "rb");
6435 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to open %s for error "
6436 "message texts: %s", bounce_message_file, strerror(errno));
6439 /* Quietly copy to configured additional addresses if required. */
6441 bcc = moan_check_errorcopy(bounce_recipient);
6442 if (bcc != NULL) fprintf(f, "Bcc: %s\n", bcc);
6444 /* The texts for the message can be read from a template file; if there
6445 isn't one, or if it is too short, built-in texts are used. The first
6446 emf text is a Subject: and any other headers. */
6448 emf_text = next_emf(emf, US"header");
6449 if (emf_text != NULL) fprintf(f, "%s\n", emf_text); else
6451 fprintf(f, "Subject: Mail delivery failed%s\n\n",
6452 to_sender? ": returning message to sender" : "");
6455 emf_text = next_emf(emf, US"intro");
6456 if (emf_text != NULL) fprintf(f, "%s", CS emf_text); else
6459 /* This message has been reworded several times. It seems to be confusing to
6460 somebody, however it is worded. I have retreated to the original, simple
6462 "This message was created automatically by mail delivery software.\n");
6463 if (bounce_message_text != NULL) fprintf(f, "%s", CS bounce_message_text);
6467 "\nA message that you sent could not be delivered to one or more of its\n"
6468 "recipients. This is a permanent error. The following address(es) failed:\n");
6473 "\nA message sent by\n\n <%s>\n\n"
6474 "could not be delivered to one or more of its recipients. The following\n"
6475 "address(es) failed:\n", sender_address);
6480 /* Process the addresses, leaving them on the msgchain if they have a
6481 file name for a return message. (There has already been a check in
6482 post_process_one() for the existence of data in the message file.) A TRUE
6483 return from print_address_information() means that the address is not
6487 for (addr = msgchain; addr != NULL; addr = *paddr)
6489 if (print_address_information(addr, f, US" ", US"\n ", US""))
6490 print_address_error(addr, f, US"");
6492 /* End the final line for the address */
6496 /* Leave on msgchain if there's a return file. */
6498 if (addr->return_file >= 0)
6500 paddr = &(addr->next);
6504 /* Else save so that we can tick off the recipient when the
6509 *paddr = addr->next;
6510 addr->next = handled_addr;
6511 handled_addr = addr;
6517 /* Get the next text, whether we need it or not, so as to be
6518 positioned for the one after. */
6520 emf_text = next_emf(emf, US"generated text");
6522 /* If there were any file messages passed by the local transports,
6523 include them in the message. Then put the address on the handled chain.
6524 In the case of a batch of addresses that were all sent to the same
6525 transport, the return_file field in all of them will contain the same
6526 fd, and the return_filename field in the *last* one will be set (to the
6527 name of the file). */
6529 if (msgchain != NULL)
6531 address_item *nextaddr;
6533 if (emf_text != NULL) fprintf(f, "%s", CS emf_text); else
6535 "The following text was generated during the delivery "
6536 "attempt%s:\n", (filecount > 1)? "s" : "");
6538 for (addr = msgchain; addr != NULL; addr = nextaddr)
6541 address_item *topaddr = addr;
6543 /* List all the addresses that relate to this file */
6546 while(addr != NULL) /* Insurance */
6548 print_address_information(addr, f, US"------ ", US"\n ",
6550 if (addr->return_filename != NULL) break;
6555 /* Now copy the file */
6557 fm = Ufopen(addr->return_filename, "rb");
6560 fprintf(f, " +++ Exim error... failed to open text file: %s\n",
6564 while ((ch = fgetc(fm)) != EOF) fputc(ch, f);
6567 Uunlink(addr->return_filename);
6569 /* Can now add to handled chain, first fishing off the next
6570 address on the msgchain. */
6572 nextaddr = addr->next;
6573 addr->next = handled_addr;
6574 handled_addr = topaddr;
6579 /* Now copy the message, trying to give an intelligible comment if
6580 it is too long for it all to be copied. The limit isn't strictly
6581 applied because of the buffering. There is, however, an option
6582 to suppress copying altogether. */
6584 emf_text = next_emf(emf, US"copy");
6586 if (bounce_return_message)
6588 int topt = topt_add_return_path;
6589 if (!bounce_return_body) topt |= topt_no_body;
6591 if (emf_text != NULL) fprintf(f, "%s", CS emf_text); else
6593 if (bounce_return_body) fprintf(f,
6594 "------ This is a copy of the message, including all the headers. ------\n");
6596 "------ This is a copy of the message's headers. ------\n");
6599 /* While reading the "truncated" message, set return_size_limit to
6600 the actual max testing value, rounded. We need to read the message
6601 whether we are going to use it or not. */
6604 int temp = bounce_return_size_limit;
6605 bounce_return_size_limit = (max/1000)*1000;
6606 emf_text = next_emf(emf, US"truncated");
6607 bounce_return_size_limit = temp;
6610 if (bounce_return_body && bounce_return_size_limit > 0)
6612 struct stat statbuf;
6613 if (fstat(deliver_datafile, &statbuf) == 0 && statbuf.st_size > max)
6615 if (emf_text != NULL) fprintf(f, "%s", CS emf_text); else
6618 "------ The body of the message is " OFF_T_FMT " characters long; only the first\n"
6619 "------ %d or so are included here.\n", statbuf.st_size, max);
6626 transport_filter_argv = NULL; /* Just in case */
6627 return_path = sender_address; /* In case not previously set */
6628 transport_write_message(NULL, fileno(f), topt,
6629 bounce_return_size_limit, NULL, NULL, NULL, NULL, NULL, 0);
6632 /* Write final text and close the template file if one is open */
6636 emf_text = next_emf(emf, US"final");
6637 if (emf_text != NULL) fprintf(f, "%s", CS emf_text);
6641 /* Close the file, which should send an EOF to the child process
6642 that is receiving the message. Wait for it to finish. */
6645 rc = child_close(pid, 0); /* Waits for child to close, no timeout */
6647 /* In the test harness, let the child do it's thing first. */
6649 if (running_in_test_harness) millisleep(500);
6651 /* If the process failed, there was some disaster in setting up the
6652 error message. Unless the message is very old, ensure that addr_defer
6653 is non-null, which will have the effect of leaving the message on the
6654 spool. The failed addresses will get tried again next time. However, we
6655 don't really want this to happen too often, so freeze the message unless
6656 there are some genuine deferred addresses to try. To do this we have
6657 to call spool_write_header() here, because with no genuine deferred
6658 addresses the normal code below doesn't get run. */
6663 if (now - received_time < retry_maximum_timeout && addr_defer == NULL)
6665 addr_defer = (address_item *)(+1);
6666 deliver_freeze = TRUE;
6667 deliver_frozen_at = time(NULL);
6668 /* Panic-dies on error */
6669 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
6672 deliver_msglog("Process failed (%d) when writing error message "
6673 "to %s%s", rc, bounce_recipient, s);
6674 log_write(0, LOG_MAIN, "Process failed (%d) when writing error message "
6675 "to %s%s", rc, bounce_recipient, s);
6678 /* The message succeeded. Ensure that the recipients that failed are
6679 now marked finished with on the spool and their parents updated. */
6683 for (addr = handled_addr; addr != NULL; addr = addr->next)
6685 address_done(addr, logtod);
6686 child_done(addr, logtod);
6688 /* Panic-dies on error */
6689 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
6695 disable_logging = FALSE; /* In case left set */
6697 /* Come here from the mua_wrapper case if routing goes wrong */
6701 /* If there are now no deferred addresses, we are done. Preserve the
6702 message log if so configured, and we are using them. Otherwise, sling it.
6703 Then delete the message itself. */
6705 if (addr_defer == NULL)
6709 sprintf(CS spoolname, "%s/msglog/%s/%s", spool_directory, message_subdir,
6711 if (preserve_message_logs)
6714 sprintf(CS big_buffer, "%s/msglog.OLD/%s", spool_directory, id);
6715 if ((rc = Urename(spoolname, big_buffer)) < 0)
6717 (void)directory_make(spool_directory, US"msglog.OLD",
6718 MSGLOG_DIRECTORY_MODE, TRUE);
6719 rc = Urename(spoolname, big_buffer);
6722 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to move %s to the "
6723 "msglog.OLD directory", spoolname);
6727 if (Uunlink(spoolname) < 0)
6728 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s",
6729 spoolname, strerror(errno));
6733 /* Remove the two message files. */
6735 sprintf(CS spoolname, "%s/input/%s/%s-D", spool_directory, message_subdir, id);
6736 if (Uunlink(spoolname) < 0)
6737 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s",
6738 spoolname, strerror(errno));
6739 sprintf(CS spoolname, "%s/input/%s/%s-H", spool_directory, message_subdir, id);
6740 if (Uunlink(spoolname) < 0)
6741 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s",
6742 spoolname, strerror(errno));
6744 /* Log the end of this message, with queue time if requested. */
6746 if ((log_extra_selector & LX_queue_time_overall) != 0)
6747 log_write(0, LOG_MAIN, "Completed QT=%s",
6748 readconf_printtime(time(NULL) - received_time));
6750 log_write(0, LOG_MAIN, "Completed");
6752 /* Unset deliver_freeze so that we won't try to move the spool files further down */
6753 deliver_freeze = FALSE;
6756 /* If there are deferred addresses, we are keeping this message because it is
6757 not yet completed. Lose any temporary files that were catching output from
6758 pipes for any of the deferred addresses, handle one-time aliases, and see if
6759 the message has been on the queue for so long that it is time to send a warning
6760 message to the sender, unless it is a mailer-daemon. If all deferred addresses
6761 have the same domain, we can set deliver_domain for the expansion of
6762 delay_warning_ condition - if any of them are pipes, files, or autoreplies, use
6763 the parent's domain.
6765 If all the deferred addresses have an error number that indicates "retry time
6766 not reached", skip sending the warning message, because it won't contain the
6767 reason for the delay. It will get sent at the next real delivery attempt.
6768 However, if at least one address has tried, we'd better include all of them in
6771 If we can't make a process to send the message, don't worry.
6773 For mailing list expansions we want to send the warning message to the
6774 mailing list manager. We can't do a perfect job here, as some addresses may
6775 have different errors addresses, but if we take the errors address from
6776 each deferred address it will probably be right in most cases.
6778 If addr_defer == +1, it means there was a problem sending an error message
6779 for failed addresses, and there were no "real" deferred addresses. The value
6780 was set just to keep the message on the spool, so there is nothing to do here.
6783 else if (addr_defer != (address_item *)(+1))
6786 uschar *recipients = US"";
6787 BOOL delivery_attempted = FALSE;
6789 deliver_domain = testflag(addr_defer, af_pfr)?
6790 addr_defer->parent->domain : addr_defer->domain;
6792 for (addr = addr_defer; addr != NULL; addr = addr->next)
6794 address_item *otaddr;
6796 if (addr->basic_errno > ERRNO_RETRY_BASE) delivery_attempted = TRUE;
6798 if (deliver_domain != NULL)
6800 uschar *d = (testflag(addr, af_pfr))? addr->parent->domain : addr->domain;
6802 /* The domain may be unset for an address that has never been routed
6803 because the system filter froze the message. */
6805 if (d == NULL || Ustrcmp(d, deliver_domain) != 0) deliver_domain = NULL;
6808 if (addr->return_filename != NULL) Uunlink(addr->return_filename);
6810 /* Handle the case of one-time aliases. If any address in the ancestry
6811 of this one is flagged, ensure it is in the recipients list, suitably
6812 flagged, and that its parent is marked delivered. */
6814 for (otaddr = addr; otaddr != NULL; otaddr = otaddr->parent)
6815 if (otaddr->onetime_parent != NULL) break;
6820 int t = recipients_count;
6822 for (i = 0; i < recipients_count; i++)
6824 uschar *r = recipients_list[i].address;
6825 if (Ustrcmp(otaddr->onetime_parent, r) == 0) t = i;
6826 if (Ustrcmp(otaddr->address, r) == 0) break;
6829 /* Didn't find the address already in the list, and did find the
6830 ultimate parent's address in the list. After adding the recipient,
6831 update the errors address in the recipients list. */
6833 if (i >= recipients_count && t < recipients_count)
6835 DEBUG(D_deliver) debug_printf("one_time: adding %s in place of %s\n",
6836 otaddr->address, otaddr->parent->address);
6837 receive_add_recipient(otaddr->address, t);
6838 recipients_list[recipients_count-1].errors_to = otaddr->p.errors_address;
6839 tree_add_nonrecipient(otaddr->parent->address);
6840 update_spool = TRUE;
6844 /* Except for error messages, ensure that either the errors address for
6845 this deferred address or, if there is none, the sender address, is on the
6846 list of recipients for a warning message. */
6848 if (sender_address[0] != 0)
6850 if (addr->p.errors_address == NULL)
6852 if (Ustrstr(recipients, sender_address) == NULL)
6853 recipients = string_sprintf("%s%s%s", recipients,
6854 (recipients[0] == 0)? "" : ",", sender_address);
6858 if (Ustrstr(recipients, addr->p.errors_address) == NULL)
6859 recipients = string_sprintf("%s%s%s", recipients,
6860 (recipients[0] == 0)? "" : ",", addr->p.errors_address);
6865 /* Send a warning message if the conditions are right. If the condition check
6866 fails because of a lookup defer, there is nothing we can do. The warning
6867 is not sent. Another attempt will be made at the next delivery attempt (if
6870 if (!queue_2stage && delivery_attempted &&
6871 delay_warning[1] > 0 && sender_address[0] != 0 &&
6872 (delay_warning_condition == NULL ||
6873 expand_check_condition(delay_warning_condition,
6874 US"delay_warning", US"option")))
6878 int queue_time = time(NULL) - received_time;
6880 /* When running in the test harness, there's an option that allows us to
6881 fudge this time so as to get repeatability of the tests. Take the first
6882 time off the list. In queue runs, the list pointer gets updated in the
6885 if (running_in_test_harness && fudged_queue_times[0] != 0)
6887 int qt = readconf_readtime(fudged_queue_times, '/', FALSE);
6890 DEBUG(D_deliver) debug_printf("fudged queue_times = %s\n",
6891 fudged_queue_times);
6896 /* See how many warnings we should have sent by now */
6898 for (count = 0; count < delay_warning[1]; count++)
6899 if (queue_time < delay_warning[count+2]) break;
6901 show_time = delay_warning[count+1];
6903 if (count >= delay_warning[1])
6906 int last_gap = show_time;
6907 if (count > 1) last_gap -= delay_warning[count];
6908 extra = (queue_time - delay_warning[count+1])/last_gap;
6909 show_time += last_gap * extra;
6915 debug_printf("time on queue = %s\n", readconf_printtime(queue_time));
6916 debug_printf("warning counts: required %d done %d\n", count,
6920 /* We have computed the number of warnings there should have been by now.
6921 If there haven't been enough, send one, and up the count to what it should
6924 if (warning_count < count)
6928 pid_t pid = child_open_exim(&fd);
6934 FILE *f = fdopen(fd, "wb");
6936 if (warn_message_file != NULL)
6938 wmf = Ufopen(warn_message_file, "rb");
6940 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to open %s for warning "
6941 "message texts: %s", warn_message_file, strerror(errno));
6944 warnmsg_recipients = recipients;
6945 warnmsg_delay = (queue_time < 120*60)?
6946 string_sprintf("%d minutes", show_time/60):
6947 string_sprintf("%d hours", show_time/3600);
6949 if (errors_reply_to != NULL)
6950 fprintf(f, "Reply-To: %s\n", errors_reply_to);
6951 fprintf(f, "Auto-Submitted: auto-replied\n");
6953 fprintf(f, "To: %s\n", recipients);
6955 wmf_text = next_emf(wmf, US"header");
6956 if (wmf_text != NULL)
6957 fprintf(f, "%s\n", wmf_text);
6959 fprintf(f, "Subject: Warning: message %s delayed %s\n\n",
6960 message_id, warnmsg_delay);
6962 wmf_text = next_emf(wmf, US"intro");
6963 if (wmf_text != NULL) fprintf(f, "%s", CS wmf_text); else
6966 "This message was created automatically by mail delivery software.\n");
6968 if (Ustrcmp(recipients, sender_address) == 0)
6970 "A message that you sent has not yet been delivered to one or more of its\n"
6971 "recipients after more than ");
6974 "A message sent by\n\n <%s>\n\n"
6975 "has not yet been delivered to one or more of its recipients after more than \n",
6978 fprintf(f, "%s on the queue on %s.\n\n", warnmsg_delay,
6980 fprintf(f, "The message identifier is: %s\n", message_id);
6982 for (h = header_list; h != NULL; h = h->next)
6984 if (strncmpic(h->text, US"Subject:", 8) == 0)
6985 fprintf(f, "The subject of the message is: %s", h->text + 9);
6986 else if (strncmpic(h->text, US"Date:", 5) == 0)
6987 fprintf(f, "The date of the message is: %s", h->text + 6);
6991 fprintf(f, "The address%s to which the message has not yet been "
6993 (addr_defer->next == NULL)? "" : "es",
6994 (addr_defer->next == NULL)? "is": "are");
6997 /* List the addresses, with error information if allowed */
7000 while (addr_defer != NULL)
7002 address_item *addr = addr_defer;
7003 addr_defer = addr->next;
7004 if (print_address_information(addr, f, US" ", US"\n ", US""))
7005 print_address_error(addr, f, US"Delay reason: ");
7014 wmf_text = next_emf(wmf, US"final");
7015 if (wmf_text != NULL) fprintf(f, "%s", CS wmf_text);
7021 "No action is required on your part. Delivery attempts will continue for\n"
7022 "some time, and this warning may be repeated at intervals if the message\n"
7023 "remains undelivered. Eventually the mail delivery software will give up,\n"
7024 "and when that happens, the message will be returned to you.\n");
7027 /* Close and wait for child process to complete, without a timeout.
7028 If there's an error, don't update the count. */
7031 if (child_close(pid, 0) == 0)
7033 warning_count = count;
7034 update_spool = TRUE; /* Ensure spool rewritten */
7040 /* Clear deliver_domain */
7042 deliver_domain = NULL;
7044 /* If this was a first delivery attempt, unset the first time flag, and
7045 ensure that the spool gets updated. */
7047 if (deliver_firsttime)
7049 deliver_firsttime = FALSE;
7050 update_spool = TRUE;
7053 /* If delivery was frozen and freeze_tell is set, generate an appropriate
7054 message, unless the message is a local error message (to avoid loops). Then
7055 log the freezing. If the text in "frozen_info" came from a system filter,
7056 it has been escaped into printing characters so as not to mess up log lines.
7057 For the "tell" message, we turn \n back into newline. Also, insert a newline
7058 near the start instead of the ": " string. */
7062 if (freeze_tell != NULL && freeze_tell[0] != 0 && !local_error_message)
7064 uschar *s = string_copy(frozen_info);
7065 uschar *ss = Ustrstr(s, " by the system filter: ");
7076 if (*ss == '\\' && ss[1] == 'n')
7083 moan_tell_someone(freeze_tell, addr_defer, US"Message frozen",
7084 "Message %s has been frozen%s.\nThe sender is <%s>.\n", message_id,
7088 /* Log freezing just before we update the -H file, to minimize the chance
7089 of a race problem. */
7091 deliver_msglog("*** Frozen%s\n", frozen_info);
7092 log_write(0, LOG_MAIN, "Frozen%s", frozen_info);
7095 /* If there have been any updates to the non-recipients list, or other things
7096 that get written to the spool, we must now update the spool header file so
7097 that it has the right information for the next delivery attempt. If there
7098 was more than one address being delivered, the header_change update is done
7099 earlier, in case one succeeds and then something crashes. */
7102 debug_printf("delivery deferred: update_spool=%d header_rewritten=%d\n",
7103 update_spool, header_rewritten);
7105 if (update_spool || header_rewritten)
7106 /* Panic-dies on error */
7107 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
7110 /* Finished with the message log. If the message is complete, it will have
7111 been unlinked or renamed above. */
7113 if (message_logs) (void)fclose(message_log);
7115 /* Now we can close and remove the journal file. Its only purpose is to record
7116 successfully completed deliveries asap so that this information doesn't get
7117 lost if Exim (or the machine) crashes. Forgetting about a failed delivery is
7118 not serious, as trying it again is not harmful. The journal might not be open
7119 if all addresses were deferred at routing or directing. Nevertheless, we must
7120 remove it if it exists (may have been lying around from a crash during the
7121 previous delivery attempt). We don't remove the journal if a delivery
7122 subprocess failed to pass back delivery information; this is controlled by
7123 the remove_journal flag. When the journal is left, we also don't move the
7124 message off the main spool if frozen and the option is set. It should get moved
7125 at the next attempt, after the journal has been inspected. */
7127 if (journal_fd >= 0) (void)close(journal_fd);
7131 sprintf(CS spoolname, "%s/input/%s/%s-J", spool_directory, message_subdir, id);
7132 if (Uunlink(spoolname) < 0 && errno != ENOENT)
7133 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s", spoolname,
7136 /* Move the message off the spool if reqested */
7138 #ifdef SUPPORT_MOVE_FROZEN_MESSAGES
7139 if (deliver_freeze && move_frozen_messages)
7140 (void)spool_move_message(id, message_subdir, US"", US"F");
7144 /* Closing the data file frees the lock; if the file has been unlinked it
7145 will go away. Otherwise the message becomes available for another process
7148 (void)close(deliver_datafile);
7149 deliver_datafile = -1;
7150 DEBUG(D_deliver) debug_printf("end delivery of %s\n", id);
7152 /* It is unlikely that there will be any cached resources, since they are
7153 released after routing, and in the delivery subprocesses. However, it's
7154 possible for an expansion for something afterwards (for example,
7155 expand_check_condition) to do a lookup. We must therefore be sure everything is
7159 acl_where = ACL_WHERE_UNKNOWN;
7163 /* End of deliver.c */