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_DBL
699 dbl_delivery_ip = NULL; /* presume no successful remote delivery */
700 dbl_delivery_port = 0;
701 dbl_delivery_fqdn = NULL;
702 dbl_delivery_local_part = NULL;
703 dbl_delivery_domain = NULL;
704 dbl_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_DBL
756 dbl_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_DBL
779 dbl_delivery_ip = addr->host_used->address;
780 dbl_delivery_port = addr->host_used->port;
781 dbl_delivery_fqdn = addr->host_used->name;
782 dbl_delivery_local_part = addr->local_part;
783 dbl_delivery_domain = addr->domain;
784 dbl_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_DBL
855 if (addr->transport->dbl_delivery_query)
859 debug_printf(" DBL(Delivery): dbl_delivery_query=|%s| dbl_delivery_IP=%s\n",
860 addr->transport->dbl_delivery_query, dbl_delivery_ip);
862 router_name = addr->router->name;
863 transport_name = addr->transport->name;
864 expand_string(addr->transport->dbl_delivery_query);
866 transport_name = NULL;
869 store_reset(reset_point);
875 /*************************************************
876 * Actions at the end of handling an address *
877 *************************************************/
879 /* This is a function for processing a single address when all that can be done
880 with it has been done.
883 addr points to the address block
884 result the result of the delivery attempt
885 logflags flags for log_write() (LOG_MAIN and/or LOG_PANIC)
886 driver_type indicates which type of driver (transport, or router) was last
887 to process the address
888 logchar '=' or '-' for use when logging deliveries with => or ->
894 post_process_one(address_item *addr, int result, int logflags, int driver_type,
897 uschar *now = tod_stamp(tod_log);
898 uschar *driver_kind = NULL;
899 uschar *driver_name = NULL;
902 int size = 256; /* Used for a temporary, */
903 int ptr = 0; /* expanding buffer, for */
904 uschar *s; /* building log lines; */
905 void *reset_point; /* released afterwards. */
908 DEBUG(D_deliver) debug_printf("post-process %s (%d)\n", addr->address, result);
910 /* Set up driver kind and name for logging. Disable logging if the router or
911 transport has disabled it. */
913 if (driver_type == DTYPE_TRANSPORT)
915 if (addr->transport != NULL)
917 driver_name = addr->transport->name;
918 driver_kind = US" transport";
919 disable_logging = addr->transport->disable_logging;
921 else driver_kind = US"transporting";
923 else if (driver_type == DTYPE_ROUTER)
925 if (addr->router != NULL)
927 driver_name = addr->router->name;
928 driver_kind = US" router";
929 disable_logging = addr->router->disable_logging;
931 else driver_kind = US"routing";
934 /* If there's an error message set, ensure that it contains only printing
935 characters - it should, but occasionally things slip in and this at least
936 stops the log format from getting wrecked. We also scan the message for an LDAP
937 expansion item that has a password setting, and flatten the password. This is a
938 fudge, but I don't know a cleaner way of doing this. (If the item is badly
939 malformed, it won't ever have gone near LDAP.) */
941 if (addr->message != NULL)
943 addr->message = string_printing(addr->message);
944 if (((Ustrstr(addr->message, "failed to expand") != NULL) || (Ustrstr(addr->message, "expansion of ") != NULL)) &&
945 (Ustrstr(addr->message, "mysql") != NULL ||
946 Ustrstr(addr->message, "pgsql") != NULL ||
947 Ustrstr(addr->message, "sqlite") != NULL ||
948 Ustrstr(addr->message, "ldap:") != NULL ||
949 Ustrstr(addr->message, "ldapdn:") != NULL ||
950 Ustrstr(addr->message, "ldapm:") != NULL))
952 addr->message = string_sprintf("Temporary internal error");
956 /* If we used a transport that has one of the "return_output" options set, and
957 if it did in fact generate some output, then for return_output we treat the
958 message as failed if it was not already set that way, so that the output gets
959 returned to the sender, provided there is a sender to send it to. For
960 return_fail_output, do this only if the delivery failed. Otherwise we just
961 unlink the file, and remove the name so that if the delivery failed, we don't
962 try to send back an empty or unwanted file. The log_output options operate only
965 In any case, we close the message file, because we cannot afford to leave a
966 file-descriptor for one address while processing (maybe very many) others. */
968 if (addr->return_file >= 0 && addr->return_filename != NULL)
970 BOOL return_output = FALSE;
972 (void)EXIMfsync(addr->return_file);
974 /* If there is no output, do nothing. */
976 if (fstat(addr->return_file, &statbuf) == 0 && statbuf.st_size > 0)
978 transport_instance *tb = addr->transport;
980 /* Handle logging options */
982 if (tb->log_output || (result == FAIL && tb->log_fail_output) ||
983 (result == DEFER && tb->log_defer_output))
986 FILE *f = Ufopen(addr->return_filename, "rb");
988 log_write(0, LOG_MAIN|LOG_PANIC, "failed to open %s to log output "
989 "from %s transport: %s", addr->return_filename, tb->name,
993 s = US Ufgets(big_buffer, big_buffer_size, f);
996 uschar *p = big_buffer + Ustrlen(big_buffer);
997 while (p > big_buffer && isspace(p[-1])) p--;
999 s = string_printing(big_buffer);
1000 log_write(0, LOG_MAIN, "<%s>: %s transport output: %s",
1001 addr->address, tb->name, s);
1007 /* Handle returning options, but only if there is an address to return
1010 if (sender_address[0] != 0 || addr->p.errors_address != NULL)
1012 if (tb->return_output)
1014 addr->transport_return = result = FAIL;
1015 if (addr->basic_errno == 0 && addr->message == NULL)
1016 addr->message = US"return message generated";
1017 return_output = TRUE;
1020 if (tb->return_fail_output && result == FAIL) return_output = TRUE;
1024 /* Get rid of the file unless it might be returned, but close it in
1029 Uunlink(addr->return_filename);
1030 addr->return_filename = NULL;
1031 addr->return_file = -1;
1034 (void)close(addr->return_file);
1037 /* The sucess case happens only after delivery by a transport. */
1041 addr->next = addr_succeed;
1042 addr_succeed = addr;
1044 /* Call address_done() to ensure that we don't deliver to this address again,
1045 and write appropriate things to the message log. If it is a child address, we
1046 call child_done() to scan the ancestors and mark them complete if this is the
1047 last child to complete. */
1049 address_done(addr, now);
1050 DEBUG(D_deliver) debug_printf("%s delivered\n", addr->address);
1052 if (addr->parent == NULL)
1054 deliver_msglog("%s %s: %s%s succeeded\n", now, addr->address,
1055 driver_name, driver_kind);
1059 deliver_msglog("%s %s <%s>: %s%s succeeded\n", now, addr->address,
1060 addr->parent->address, driver_name, driver_kind);
1061 child_done(addr, now);
1064 delivery_log(LOG_MAIN, addr, logchar, NULL);
1068 /* Soft failure, or local delivery process failed; freezing may be
1071 else if (result == DEFER || result == PANIC)
1073 if (result == PANIC) logflags |= LOG_PANIC;
1075 /* This puts them on the chain in reverse order. Do not change this, because
1076 the code for handling retries assumes that the one with the retry
1077 information is last. */
1079 addr->next = addr_defer;
1082 /* The only currently implemented special action is to freeze the
1083 message. Logging of this is done later, just before the -H file is
1086 if (addr->special_action == SPECIAL_FREEZE)
1088 deliver_freeze = TRUE;
1089 deliver_frozen_at = time(NULL);
1090 update_spool = TRUE;
1093 /* If doing a 2-stage queue run, we skip writing to either the message
1094 log or the main log for SMTP defers. */
1096 if (!queue_2stage || addr->basic_errno != 0)
1100 /* For errors of the type "retry time not reached" (also remotes skipped
1101 on queue run), logging is controlled by L_retry_defer. Note that this kind
1102 of error number is negative, and all the retry ones are less than any
1105 unsigned int use_log_selector = (addr->basic_errno <= ERRNO_RETRY_BASE)?
1108 /* Build up the line that is used for both the message log and the main
1111 s = reset_point = store_get(size);
1113 /* Create the address string for logging. Must not do this earlier, because
1114 an OK result may be changed to FAIL when a pipe returns text. */
1116 log_address = string_log_address(addr,
1117 (log_write_selector & L_all_parents) != 0, result == OK);
1119 s = string_cat(s, &size, &ptr, log_address, Ustrlen(log_address));
1121 /* Either driver_name contains something and driver_kind contains
1122 " router" or " transport" (note the leading space), or driver_name is
1123 a null string and driver_kind contains "routing" without the leading
1124 space, if all routing has been deferred. When a domain has been held,
1125 so nothing has been done at all, both variables contain null strings. */
1127 if (driver_name == NULL)
1129 if (driver_kind != NULL)
1130 s = string_append(s, &size, &ptr, 2, US" ", driver_kind);
1134 if (driver_kind[1] == 't' && addr->router != NULL)
1135 s = string_append(s, &size, &ptr, 2, US" R=", addr->router->name);
1137 ss[1] = toupper(driver_kind[1]);
1138 s = string_append(s, &size, &ptr, 2, ss, driver_name);
1141 sprintf(CS ss, " defer (%d)", addr->basic_errno);
1142 s = string_cat(s, &size, &ptr, ss, Ustrlen(ss));
1144 if (addr->basic_errno > 0)
1145 s = string_append(s, &size, &ptr, 2, US": ",
1146 US strerror(addr->basic_errno));
1148 if (addr->message != NULL)
1149 s = string_append(s, &size, &ptr, 2, US": ", addr->message);
1153 /* Log the deferment in the message log, but don't clutter it
1154 up with retry-time defers after the first delivery attempt. */
1156 if (deliver_firsttime || addr->basic_errno > ERRNO_RETRY_BASE)
1157 deliver_msglog("%s %s\n", now, s);
1159 /* Write the main log and reset the store */
1161 log_write(use_log_selector, logflags, "== %s", s);
1162 store_reset(reset_point);
1167 /* Hard failure. If there is an address to which an error message can be sent,
1168 put this address on the failed list. If not, put it on the deferred list and
1169 freeze the mail message for human attention. The latter action can also be
1170 explicitly requested by a router or transport. */
1174 /* If this is a delivery error, or a message for which no replies are
1175 wanted, and the message's age is greater than ignore_bounce_errors_after,
1176 force the af_ignore_error flag. This will cause the address to be discarded
1177 later (with a log entry). */
1179 if (sender_address[0] == 0 && message_age >= ignore_bounce_errors_after)
1180 setflag(addr, af_ignore_error);
1182 /* Freeze the message if requested, or if this is a bounce message (or other
1183 message with null sender) and this address does not have its own errors
1184 address. However, don't freeze if errors are being ignored. The actual code
1185 to ignore occurs later, instead of sending a message. Logging of freezing
1186 occurs later, just before writing the -H file. */
1188 if (!testflag(addr, af_ignore_error) &&
1189 (addr->special_action == SPECIAL_FREEZE ||
1190 (sender_address[0] == 0 && addr->p.errors_address == NULL)
1193 frozen_info = (addr->special_action == SPECIAL_FREEZE)? US"" :
1194 (sender_local && !local_error_message)?
1195 US" (message created with -f <>)" : US" (delivery error message)";
1196 deliver_freeze = TRUE;
1197 deliver_frozen_at = time(NULL);
1198 update_spool = TRUE;
1200 /* The address is put on the defer rather than the failed queue, because
1201 the message is being retained. */
1203 addr->next = addr_defer;
1207 /* Don't put the address on the nonrecipients tree yet; wait until an
1208 error message has been successfully sent. */
1212 addr->next = addr_failed;
1216 /* Build up the log line for the message and main logs */
1218 s = reset_point = store_get(size);
1220 /* Create the address string for logging. Must not do this earlier, because
1221 an OK result may be changed to FAIL when a pipe returns text. */
1223 log_address = string_log_address(addr,
1224 (log_write_selector & L_all_parents) != 0, result == OK);
1226 s = string_cat(s, &size, &ptr, log_address, Ustrlen(log_address));
1228 if ((log_extra_selector & LX_sender_on_delivery) != 0)
1229 s = string_append(s, &size, &ptr, 3, US" F=<", sender_address, US">");
1231 /* Return path may not be set if no delivery actually happened */
1233 if (used_return_path != NULL &&
1234 (log_extra_selector & LX_return_path_on_delivery) != 0)
1236 s = string_append(s, &size, &ptr, 3, US" P=<", used_return_path, US">");
1239 if (addr->router != NULL)
1240 s = string_append(s, &size, &ptr, 2, US" R=", addr->router->name);
1241 if (addr->transport != NULL)
1242 s = string_append(s, &size, &ptr, 2, US" T=", addr->transport->name);
1244 if (addr->host_used != NULL)
1245 s = string_append(s, &size, &ptr, 5, US" H=", addr->host_used->name,
1246 US" [", addr->host_used->address, US"]");
1248 if (addr->basic_errno > 0)
1249 s = string_append(s, &size, &ptr, 2, US": ",
1250 US strerror(addr->basic_errno));
1252 if (addr->message != NULL)
1253 s = string_append(s, &size, &ptr, 2, US": ", addr->message);
1257 /* Do the logging. For the message log, "routing failed" for those cases,
1258 just to make it clearer. */
1260 if (driver_name == NULL)
1261 deliver_msglog("%s %s failed for %s\n", now, driver_kind, s);
1263 deliver_msglog("%s %s\n", now, s);
1265 log_write(0, LOG_MAIN, "** %s", s);
1266 store_reset(reset_point);
1269 /* Ensure logging is turned on again in all cases */
1271 disable_logging = FALSE;
1277 /*************************************************
1278 * Address-independent error *
1279 *************************************************/
1281 /* This function is called when there's an error that is not dependent on a
1282 particular address, such as an expansion string failure. It puts the error into
1283 all the addresses in a batch, logs the incident on the main and panic logs, and
1284 clears the expansions. It is mostly called from local_deliver(), but can be
1285 called for a remote delivery via findugid().
1288 logit TRUE if (MAIN+PANIC) logging required
1289 addr the first of the chain of addresses
1291 format format string for error message, or NULL if already set in addr
1292 ... arguments for the format
1298 common_error(BOOL logit, address_item *addr, int code, uschar *format, ...)
1300 address_item *addr2;
1301 addr->basic_errno = code;
1307 va_start(ap, format);
1308 if (!string_vformat(buffer, sizeof(buffer), CS format, ap))
1309 log_write(0, LOG_MAIN|LOG_PANIC_DIE,
1310 "common_error expansion was longer than " SIZE_T_FMT, sizeof(buffer));
1312 addr->message = string_copy(buffer);
1315 for (addr2 = addr->next; addr2 != NULL; addr2 = addr2->next)
1317 addr2->basic_errno = code;
1318 addr2->message = addr->message;
1321 if (logit) log_write(0, LOG_MAIN|LOG_PANIC, "%s", addr->message);
1322 deliver_set_expansions(NULL);
1328 /*************************************************
1329 * Check a "never users" list *
1330 *************************************************/
1332 /* This function is called to check whether a uid is on one of the two "never
1336 uid the uid to be checked
1337 nusers the list to be scanned; the first item in the list is the count
1339 Returns: TRUE if the uid is on the list
1343 check_never_users(uid_t uid, uid_t *nusers)
1346 if (nusers == NULL) return FALSE;
1347 for (i = 1; i <= (int)(nusers[0]); i++) if (nusers[i] == uid) return TRUE;
1353 /*************************************************
1354 * Find uid and gid for a transport *
1355 *************************************************/
1357 /* This function is called for both local and remote deliveries, to find the
1358 uid/gid under which to run the delivery. The values are taken preferentially
1359 from the transport (either explicit or deliver_as_creator), then from the
1360 address (i.e. the router), and if nothing is set, the exim uid/gid are used. If
1361 the resulting uid is on the "never_users" or the "fixed_never_users" list, a
1362 panic error is logged, and the function fails (which normally leads to delivery
1366 addr the address (possibly a chain)
1368 uidp pointer to uid field
1369 gidp pointer to gid field
1370 igfp pointer to the use_initgroups field
1372 Returns: FALSE if failed - error has been set in address(es)
1376 findugid(address_item *addr, transport_instance *tp, uid_t *uidp, gid_t *gidp,
1379 uschar *nuname = NULL;
1380 BOOL gid_set = FALSE;
1382 /* Default initgroups flag comes from the transport */
1384 *igfp = tp->initgroups;
1386 /* First see if there's a gid on the transport, either fixed or expandable.
1387 The expanding function always logs failure itself. */
1394 else if (tp->expand_gid != NULL)
1396 if (route_find_expanded_group(tp->expand_gid, tp->name, US"transport", gidp,
1397 &(addr->message))) gid_set = TRUE;
1400 common_error(FALSE, addr, ERRNO_GIDFAIL, NULL);
1405 /* If the transport did not set a group, see if the router did. */
1407 if (!gid_set && testflag(addr, af_gid_set))
1413 /* Pick up a uid from the transport if one is set. */
1415 if (tp->uid_set) *uidp = tp->uid;
1417 /* Otherwise, try for an expandable uid field. If it ends up as a numeric id,
1418 it does not provide a passwd value from which a gid can be taken. */
1420 else if (tp->expand_uid != NULL)
1423 if (!route_find_expanded_user(tp->expand_uid, tp->name, US"transport", &pw,
1424 uidp, &(addr->message)))
1426 common_error(FALSE, addr, ERRNO_UIDFAIL, NULL);
1429 if (!gid_set && pw != NULL)
1436 /* If the transport doesn't set the uid, test the deliver_as_creator flag. */
1438 else if (tp->deliver_as_creator)
1440 *uidp = originator_uid;
1443 *gidp = originator_gid;
1448 /* Otherwise see if the address specifies the uid and if so, take it and its
1451 else if (testflag(addr, af_uid_set))
1454 *igfp = testflag(addr, af_initgroups);
1457 /* Nothing has specified the uid - default to the Exim user, and group if the
1470 /* If no gid is set, it is a disaster. We default to the Exim gid only if
1471 defaulting to the Exim uid. In other words, if the configuration has specified
1472 a uid, it must also provide a gid. */
1476 common_error(TRUE, addr, ERRNO_GIDFAIL, US"User set without group for "
1477 "%s transport", tp->name);
1481 /* Check that the uid is not on the lists of banned uids that may not be used
1482 for delivery processes. */
1484 if (check_never_users(*uidp, never_users))
1485 nuname = US"never_users";
1486 else if (check_never_users(*uidp, fixed_never_users))
1487 nuname = US"fixed_never_users";
1491 common_error(TRUE, addr, ERRNO_UIDFAIL, US"User %ld set for %s transport "
1492 "is on the %s list", (long int)(*uidp), tp->name, nuname);
1504 /*************************************************
1505 * Check the size of a message for a transport *
1506 *************************************************/
1508 /* Checks that the message isn't too big for the selected transport.
1509 This is called only when it is known that the limit is set.
1513 addr the (first) address being delivered
1516 DEFER expansion failed or did not yield an integer
1517 FAIL message too big
1521 check_message_size(transport_instance *tp, address_item *addr)
1526 deliver_set_expansions(addr);
1527 size_limit = expand_string_integer(tp->message_size_limit, TRUE);
1528 deliver_set_expansions(NULL);
1530 if (expand_string_message != NULL)
1533 if (size_limit == -1)
1534 addr->message = string_sprintf("failed to expand message_size_limit "
1535 "in %s transport: %s", tp->name, expand_string_message);
1537 addr->message = string_sprintf("invalid message_size_limit "
1538 "in %s transport: %s", tp->name, expand_string_message);
1540 else if (size_limit > 0 && message_size > size_limit)
1544 string_sprintf("message is too big (transport limit = %d)",
1553 /*************************************************
1554 * Transport-time check for a previous delivery *
1555 *************************************************/
1557 /* Check that this base address hasn't previously been delivered to its routed
1558 transport. If it has been delivered, mark it done. The check is necessary at
1559 delivery time in order to handle homonymic addresses correctly in cases where
1560 the pattern of redirection changes between delivery attempts (so the unique
1561 fields change). Non-homonymic previous delivery is detected earlier, at routing
1562 time (which saves unnecessary routing).
1565 addr the address item
1566 testing TRUE if testing wanted only, without side effects
1568 Returns: TRUE if previously delivered by the transport
1572 previously_transported(address_item *addr, BOOL testing)
1574 (void)string_format(big_buffer, big_buffer_size, "%s/%s",
1575 addr->unique + (testflag(addr, af_homonym)? 3:0), addr->transport->name);
1577 if (tree_search(tree_nonrecipients, big_buffer) != 0)
1579 DEBUG(D_deliver|D_route|D_transport)
1580 debug_printf("%s was previously delivered (%s transport): discarded\n",
1581 addr->address, addr->transport->name);
1582 if (!testing) child_done(addr, tod_stamp(tod_log));
1591 /******************************************************
1592 * Check for a given header in a header string *
1593 ******************************************************/
1595 /* This function is used when generating quota warnings. The configuration may
1596 specify any header lines it likes in quota_warn_message. If certain of them are
1597 missing, defaults are inserted, so we need to be able to test for the presence
1601 hdr the required header name
1602 hstring the header string
1604 Returns: TRUE the header is in the string
1605 FALSE the header is not in the string
1609 contains_header(uschar *hdr, uschar *hstring)
1611 int len = Ustrlen(hdr);
1612 uschar *p = hstring;
1615 if (strncmpic(p, hdr, len) == 0)
1618 while (*p == ' ' || *p == '\t') p++;
1619 if (*p == ':') return TRUE;
1621 while (*p != 0 && *p != '\n') p++;
1622 if (*p == '\n') p++;
1630 /*************************************************
1631 * Perform a local delivery *
1632 *************************************************/
1634 /* Each local delivery is performed in a separate process which sets its
1635 uid and gid as specified. This is a safer way than simply changing and
1636 restoring using seteuid(); there is a body of opinion that seteuid() cannot be
1637 used safely. From release 4, Exim no longer makes any use of it. Besides, not
1638 all systems have seteuid().
1640 If the uid/gid are specified in the transport_instance, they are used; the
1641 transport initialization must ensure that either both or neither are set.
1642 Otherwise, the values associated with the address are used. If neither are set,
1643 it is a configuration error.
1645 The transport or the address may specify a home directory (transport over-
1646 rides), and if they do, this is set as $home. If neither have set a working
1647 directory, this value is used for that as well. Otherwise $home is left unset
1648 and the cwd is set to "/" - a directory that should be accessible to all users.
1650 Using a separate process makes it more complicated to get error information
1651 back. We use a pipe to pass the return code and also an error code and error
1652 text string back to the parent process.
1655 addr points to an address block for this delivery; for "normal" local
1656 deliveries this is the only address to be delivered, but for
1657 pseudo-remote deliveries (e.g. by batch SMTP to a file or pipe)
1658 a number of addresses can be handled simultaneously, and in this
1659 case addr will point to a chain of addresses with the same
1662 shadowing TRUE if running a shadow transport; this causes output from pipes
1669 deliver_local(address_item *addr, BOOL shadowing)
1671 BOOL use_initgroups;
1674 int status, len, rc;
1677 uschar *working_directory;
1678 address_item *addr2;
1679 transport_instance *tp = addr->transport;
1681 /* Set up the return path from the errors or sender address. If the transport
1682 has its own return path setting, expand it and replace the existing value. */
1684 if(addr->p.errors_address != NULL)
1685 return_path = addr->p.errors_address;
1686 #ifdef EXPERIMENTAL_SRS
1687 else if(addr->p.srs_sender != NULL)
1688 return_path = addr->p.srs_sender;
1691 return_path = sender_address;
1693 if (tp->return_path != NULL)
1695 uschar *new_return_path = expand_string(tp->return_path);
1696 if (new_return_path == NULL)
1698 if (!expand_string_forcedfail)
1700 common_error(TRUE, addr, ERRNO_EXPANDFAIL,
1701 US"Failed to expand return path \"%s\" in %s transport: %s",
1702 tp->return_path, tp->name, expand_string_message);
1706 else return_path = new_return_path;
1709 /* For local deliveries, one at a time, the value used for logging can just be
1710 set directly, once and for all. */
1712 used_return_path = return_path;
1714 /* Sort out the uid, gid, and initgroups flag. If an error occurs, the message
1715 gets put into the address(es), and the expansions are unset, so we can just
1718 if (!findugid(addr, tp, &uid, &gid, &use_initgroups)) return;
1720 /* See if either the transport or the address specifies a home directory. A
1721 home directory set in the address may already be expanded; a flag is set to
1722 indicate that. In other cases we must expand it. */
1724 if ((deliver_home = tp->home_dir) != NULL || /* Set in transport, or */
1725 ((deliver_home = addr->home_dir) != NULL && /* Set in address and */
1726 !testflag(addr, af_home_expanded))) /* not expanded */
1728 uschar *rawhome = deliver_home;
1729 deliver_home = NULL; /* in case it contains $home */
1730 deliver_home = expand_string(rawhome);
1731 if (deliver_home == NULL)
1733 common_error(TRUE, addr, ERRNO_EXPANDFAIL, US"home directory \"%s\" failed "
1734 "to expand for %s transport: %s", rawhome, tp->name,
1735 expand_string_message);
1738 if (*deliver_home != '/')
1740 common_error(TRUE, addr, ERRNO_NOTABSOLUTE, US"home directory path \"%s\" "
1741 "is not absolute for %s transport", deliver_home, tp->name);
1746 /* See if either the transport or the address specifies a current directory,
1747 and if so, expand it. If nothing is set, use the home directory, unless it is
1748 also unset in which case use "/", which is assumed to be a directory to which
1749 all users have access. It is necessary to be in a visible directory for some
1750 operating systems when running pipes, as some commands (e.g. "rm" under Solaris
1751 2.5) require this. */
1753 working_directory = (tp->current_dir != NULL)?
1754 tp->current_dir : addr->current_dir;
1756 if (working_directory != NULL)
1758 uschar *raw = working_directory;
1759 working_directory = expand_string(raw);
1760 if (working_directory == NULL)
1762 common_error(TRUE, addr, ERRNO_EXPANDFAIL, US"current directory \"%s\" "
1763 "failed to expand for %s transport: %s", raw, tp->name,
1764 expand_string_message);
1767 if (*working_directory != '/')
1769 common_error(TRUE, addr, ERRNO_NOTABSOLUTE, US"current directory path "
1770 "\"%s\" is not absolute for %s transport", working_directory, tp->name);
1774 else working_directory = (deliver_home == NULL)? US"/" : deliver_home;
1776 /* If one of the return_output flags is set on the transport, create and open a
1777 file in the message log directory for the transport to write its output onto.
1778 This is mainly used by pipe transports. The file needs to be unique to the
1779 address. This feature is not available for shadow transports. */
1781 if (!shadowing && (tp->return_output || tp->return_fail_output ||
1782 tp->log_output || tp->log_fail_output))
1785 addr->return_filename =
1786 string_sprintf("%s/msglog/%s/%s-%d-%d", spool_directory, message_subdir,
1787 message_id, getpid(), return_count++);
1788 addr->return_file = open_msglog_file(addr->return_filename, 0400, &error);
1789 if (addr->return_file < 0)
1791 common_error(TRUE, addr, errno, US"Unable to %s file for %s transport "
1792 "to return message: %s", error, tp->name, strerror(errno));
1797 /* Create the pipe for inter-process communication. */
1801 common_error(TRUE, addr, ERRNO_PIPEFAIL, US"Creation of pipe failed: %s",
1806 /* Now fork the process to do the real work in the subprocess, but first
1807 ensure that all cached resources are freed so that the subprocess starts with
1808 a clean slate and doesn't interfere with the parent process. */
1812 if ((pid = fork()) == 0)
1814 BOOL replicate = TRUE;
1816 /* Prevent core dumps, as we don't want them in users' home directories.
1817 HP-UX doesn't have RLIMIT_CORE; I don't know how to do this in that
1818 system. Some experimental/developing systems (e.g. GNU/Hurd) may define
1819 RLIMIT_CORE but not support it in setrlimit(). For such systems, do not
1820 complain if the error is "not supported".
1822 There are two scenarios where changing the max limit has an effect. In one,
1823 the user is using a .forward and invoking a command of their choice via pipe;
1824 for these, we do need the max limit to be 0 unless the admin chooses to
1825 permit an increased limit. In the other, the command is invoked directly by
1826 the transport and is under administrator control, thus being able to raise
1827 the limit aids in debugging. So there's no general always-right answer.
1829 Thus we inhibit core-dumps completely but let individual transports, while
1830 still root, re-raise the limits back up to aid debugging. We make the
1831 default be no core-dumps -- few enough people can use core dumps in
1832 diagnosis that it's reasonable to make them something that has to be explicitly requested.
1839 if (setrlimit(RLIMIT_CORE, &rl) < 0)
1841 #ifdef SETRLIMIT_NOT_SUPPORTED
1842 if (errno != ENOSYS && errno != ENOTSUP)
1844 log_write(0, LOG_MAIN|LOG_PANIC, "setrlimit(RLIMIT_CORE) failed: %s",
1849 /* Reset the random number generator, so different processes don't all
1850 have the same sequence. */
1854 /* If the transport has a setup entry, call this first, while still
1855 privileged. (Appendfile uses this to expand quota, for example, while
1856 able to read private files.) */
1858 if (addr->transport->setup != NULL)
1860 switch((addr->transport->setup)(addr->transport, addr, NULL, uid, gid,
1864 addr->transport_return = DEFER;
1868 addr->transport_return = PANIC;
1873 /* Ignore SIGINT and SIGTERM during delivery. Also ignore SIGUSR1, as
1874 when the process becomes unprivileged, it won't be able to write to the
1875 process log. SIGHUP is ignored throughout exim, except when it is being
1878 signal(SIGINT, SIG_IGN);
1879 signal(SIGTERM, SIG_IGN);
1880 signal(SIGUSR1, SIG_IGN);
1882 /* Close the unwanted half of the pipe, and set close-on-exec for the other
1883 half - for transports that exec things (e.g. pipe). Then set the required
1886 (void)close(pfd[pipe_read]);
1887 (void)fcntl(pfd[pipe_write], F_SETFD, fcntl(pfd[pipe_write], F_GETFD) |
1889 exim_setugid(uid, gid, use_initgroups,
1890 string_sprintf("local delivery to %s <%s> transport=%s", addr->local_part,
1891 addr->address, addr->transport->name));
1895 address_item *batched;
1896 debug_printf(" home=%s current=%s\n", deliver_home, working_directory);
1897 for (batched = addr->next; batched != NULL; batched = batched->next)
1898 debug_printf("additional batched address: %s\n", batched->address);
1901 /* Set an appropriate working directory. */
1903 if (Uchdir(working_directory) < 0)
1905 addr->transport_return = DEFER;
1906 addr->basic_errno = errno;
1907 addr->message = string_sprintf("failed to chdir to %s", working_directory);
1910 /* If successful, call the transport */
1915 set_process_info("delivering %s to %s using %s", message_id,
1916 addr->local_part, addr->transport->name);
1918 /* Setting this global in the subprocess means we need never clear it */
1919 transport_name = addr->transport->name;
1921 /* If a transport filter has been specified, set up its argument list.
1922 Any errors will get put into the address, and FALSE yielded. */
1924 if (addr->transport->filter_command != NULL)
1926 ok = transport_set_up_command(&transport_filter_argv,
1927 addr->transport->filter_command,
1928 TRUE, PANIC, addr, US"transport filter", NULL);
1929 transport_filter_timeout = addr->transport->filter_timeout;
1931 else transport_filter_argv = NULL;
1935 debug_print_string(addr->transport->debug_string);
1936 replicate = !(addr->transport->info->code)(addr->transport, addr);
1940 /* Pass the results back down the pipe. If necessary, first replicate the
1941 status in the top address to the others in the batch. The label is the
1942 subject of a goto when a call to the transport's setup function fails. We
1943 pass the pointer to the transport back in case it got changed as a result of
1944 file_format in appendfile. */
1948 if (replicate) replicate_status(addr);
1949 for (addr2 = addr; addr2 != NULL; addr2 = addr2->next)
1952 int local_part_length = Ustrlen(addr2->local_part);
1956 if( (ret = write(pfd[pipe_write], (void *)&(addr2->transport_return), sizeof(int))) != sizeof(int)
1957 || (ret = write(pfd[pipe_write], (void *)&transport_count, sizeof(transport_count))) != sizeof(transport_count)
1958 || (ret = write(pfd[pipe_write], (void *)&(addr2->flags), sizeof(addr2->flags))) != sizeof(addr2->flags)
1959 || (ret = write(pfd[pipe_write], (void *)&(addr2->basic_errno), sizeof(int))) != sizeof(int)
1960 || (ret = write(pfd[pipe_write], (void *)&(addr2->more_errno), sizeof(int))) != sizeof(int)
1961 || (ret = write(pfd[pipe_write], (void *)&(addr2->special_action), sizeof(int))) != sizeof(int)
1962 || (ret = write(pfd[pipe_write], (void *)&(addr2->transport),
1963 sizeof(transport_instance *))) != sizeof(transport_instance *)
1965 /* For a file delivery, pass back the local part, in case the original
1966 was only part of the final delivery path. This gives more complete
1969 || (testflag(addr2, af_file)
1970 && ( (ret = write(pfd[pipe_write], (void *)&local_part_length, sizeof(int))) != sizeof(int)
1971 || (ret = write(pfd[pipe_write], addr2->local_part, local_part_length)) != local_part_length
1975 log_write(0, LOG_MAIN|LOG_PANIC, "Failed writing transport results to pipe: %s\n",
1976 ret == -1 ? strerror(errno) : "short write");
1978 /* Now any messages */
1980 for (i = 0, s = addr2->message; i < 2; i++, s = addr2->user_message)
1982 int message_length = (s == NULL)? 0 : Ustrlen(s) + 1;
1983 if( (ret = write(pfd[pipe_write], (void *)&message_length, sizeof(int))) != sizeof(int)
1984 || (message_length > 0 && (ret = write(pfd[pipe_write], s, message_length)) != message_length)
1986 log_write(0, LOG_MAIN|LOG_PANIC, "Failed writing transport results to pipe: %s\n",
1987 ret == -1 ? strerror(errno) : "short write");
1991 /* OK, this process is now done. Free any cached resources that it opened,
1992 and close the pipe we were writing down before exiting. */
1994 (void)close(pfd[pipe_write]);
1999 /* Back in the main process: panic if the fork did not succeed. This seems
2000 better than returning an error - if forking is failing it is probably best
2001 not to try other deliveries for this message. */
2004 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Fork failed for local delivery to %s",
2007 /* Read the pipe to get the delivery status codes and error messages. Our copy
2008 of the writing end must be closed first, as otherwise read() won't return zero
2009 on an empty pipe. We check that a status exists for each address before
2010 overwriting the address structure. If data is missing, the default DEFER status
2011 will remain. Afterwards, close the reading end. */
2013 (void)close(pfd[pipe_write]);
2015 for (addr2 = addr; addr2 != NULL; addr2 = addr2->next)
2017 len = read(pfd[pipe_read], (void *)&status, sizeof(int));
2023 addr2->transport_return = status;
2024 len = read(pfd[pipe_read], (void *)&transport_count,
2025 sizeof(transport_count));
2026 len = read(pfd[pipe_read], (void *)&(addr2->flags), sizeof(addr2->flags));
2027 len = read(pfd[pipe_read], (void *)&(addr2->basic_errno), sizeof(int));
2028 len = read(pfd[pipe_read], (void *)&(addr2->more_errno), sizeof(int));
2029 len = read(pfd[pipe_read], (void *)&(addr2->special_action), sizeof(int));
2030 len = read(pfd[pipe_read], (void *)&(addr2->transport),
2031 sizeof(transport_instance *));
2033 if (testflag(addr2, af_file))
2035 int local_part_length;
2036 len = read(pfd[pipe_read], (void *)&local_part_length, sizeof(int));
2037 len = read(pfd[pipe_read], (void *)big_buffer, local_part_length);
2038 big_buffer[local_part_length] = 0;
2039 addr2->local_part = string_copy(big_buffer);
2042 for (i = 0, sptr = &(addr2->message); i < 2;
2043 i++, sptr = &(addr2->user_message))
2046 len = read(pfd[pipe_read], (void *)&message_length, sizeof(int));
2047 if (message_length > 0)
2049 len = read(pfd[pipe_read], (void *)big_buffer, message_length);
2050 if (len > 0) *sptr = string_copy(big_buffer);
2057 log_write(0, LOG_MAIN|LOG_PANIC, "failed to read delivery status for %s "
2058 "from delivery subprocess", addr2->unique);
2063 (void)close(pfd[pipe_read]);
2065 /* Unless shadowing, write all successful addresses immediately to the journal
2066 file, to ensure they are recorded asap. For homonymic addresses, use the base
2067 address plus the transport name. Failure to write the journal is panic-worthy,
2068 but don't stop, as it may prove possible subsequently to update the spool file
2069 in order to record the delivery. */
2073 for (addr2 = addr; addr2 != NULL; addr2 = addr2->next)
2075 if (addr2->transport_return != OK) continue;
2077 if (testflag(addr2, af_homonym))
2078 sprintf(CS big_buffer, "%.500s/%s\n", addr2->unique + 3, tp->name);
2080 sprintf(CS big_buffer, "%.500s\n", addr2->unique);
2082 /* In the test harness, wait just a bit to let the subprocess finish off
2083 any debug output etc first. */
2085 if (running_in_test_harness) millisleep(300);
2087 DEBUG(D_deliver) debug_printf("journalling %s", big_buffer);
2088 len = Ustrlen(big_buffer);
2089 if (write(journal_fd, big_buffer, len) != len)
2090 log_write(0, LOG_MAIN|LOG_PANIC, "failed to update journal for %s: %s",
2091 big_buffer, strerror(errno));
2094 /* Ensure the journal file is pushed out to disk. */
2096 if (EXIMfsync(journal_fd) < 0)
2097 log_write(0, LOG_MAIN|LOG_PANIC, "failed to fsync journal: %s",
2101 /* Wait for the process to finish. If it terminates with a non-zero code,
2102 freeze the message (except for SIGTERM, SIGKILL and SIGQUIT), but leave the
2103 status values of all the addresses as they are. Take care to handle the case
2104 when the subprocess doesn't seem to exist. This has been seen on one system
2105 when Exim was called from an MUA that set SIGCHLD to SIG_IGN. When that
2106 happens, wait() doesn't recognize the termination of child processes. Exim now
2107 resets SIGCHLD to SIG_DFL, but this code should still be robust. */
2109 while ((rc = wait(&status)) != pid)
2111 if (rc < 0 && errno == ECHILD) /* Process has vanished */
2113 log_write(0, LOG_MAIN, "%s transport process vanished unexpectedly",
2114 addr->transport->driver_name);
2120 if ((status & 0xffff) != 0)
2122 int msb = (status >> 8) & 255;
2123 int lsb = status & 255;
2124 int code = (msb == 0)? (lsb & 0x7f) : msb;
2125 if (msb != 0 || (code != SIGTERM && code != SIGKILL && code != SIGQUIT))
2126 addr->special_action = SPECIAL_FREEZE;
2127 log_write(0, LOG_MAIN|LOG_PANIC, "%s transport process returned non-zero "
2128 "status 0x%04x: %s %d",
2129 addr->transport->driver_name,
2131 (msb == 0)? "terminated by signal" : "exit code",
2135 /* If SPECIAL_WARN is set in the top address, send a warning message. */
2137 if (addr->special_action == SPECIAL_WARN &&
2138 addr->transport->warn_message != NULL)
2141 uschar *warn_message;
2143 DEBUG(D_deliver) debug_printf("Warning message requested by transport\n");
2145 warn_message = expand_string(addr->transport->warn_message);
2146 if (warn_message == NULL)
2147 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand \"%s\" (warning "
2148 "message for %s transport): %s", addr->transport->warn_message,
2149 addr->transport->name, expand_string_message);
2152 pid_t pid = child_open_exim(&fd);
2155 FILE *f = fdopen(fd, "wb");
2156 if (errors_reply_to != NULL &&
2157 !contains_header(US"Reply-To", warn_message))
2158 fprintf(f, "Reply-To: %s\n", errors_reply_to);
2159 fprintf(f, "Auto-Submitted: auto-replied\n");
2160 if (!contains_header(US"From", warn_message)) moan_write_from(f);
2161 fprintf(f, "%s", CS warn_message);
2163 /* Close and wait for child process to complete, without a timeout. */
2166 (void)child_close(pid, 0);
2170 addr->special_action = SPECIAL_NONE;
2176 /*************************************************
2177 * Do local deliveries *
2178 *************************************************/
2180 /* This function processes the list of addresses in addr_local. True local
2181 deliveries are always done one address at a time. However, local deliveries can
2182 be batched up in some cases. Typically this is when writing batched SMTP output
2183 files for use by some external transport mechanism, or when running local
2184 deliveries over LMTP.
2191 do_local_deliveries(void)
2194 open_db *dbm_file = NULL;
2195 time_t now = time(NULL);
2197 /* Loop until we have exhausted the supply of local deliveries */
2199 while (addr_local != NULL)
2201 time_t delivery_start;
2203 address_item *addr2, *addr3, *nextaddr;
2204 int logflags = LOG_MAIN;
2205 int logchar = dont_deliver? '*' : '=';
2206 transport_instance *tp;
2208 /* Pick the first undelivered address off the chain */
2210 address_item *addr = addr_local;
2211 addr_local = addr->next;
2214 DEBUG(D_deliver|D_transport)
2215 debug_printf("--------> %s <--------\n", addr->address);
2217 /* An internal disaster if there is no transport. Should not occur! */
2219 if ((tp = addr->transport) == NULL)
2221 logflags |= LOG_PANIC;
2222 disable_logging = FALSE; /* Jic */
2224 (addr->router != NULL)?
2225 string_sprintf("No transport set by %s router", addr->router->name)
2227 string_sprintf("No transport set by system filter");
2228 post_process_one(addr, DEFER, logflags, DTYPE_TRANSPORT, 0);
2232 /* Check that this base address hasn't previously been delivered to this
2233 transport. The check is necessary at this point to handle homonymic addresses
2234 correctly in cases where the pattern of redirection changes between delivery
2235 attempts. Non-homonymic previous delivery is detected earlier, at routing
2238 if (previously_transported(addr, FALSE)) continue;
2240 /* There are weird cases where logging is disabled */
2242 disable_logging = tp->disable_logging;
2244 /* Check for batched addresses and possible amalgamation. Skip all the work
2245 if either batch_max <= 1 or there aren't any other addresses for local
2248 if (tp->batch_max > 1 && addr_local != NULL)
2250 int batch_count = 1;
2251 BOOL uses_dom = readconf_depends((driver_instance *)tp, US"domain");
2252 BOOL uses_lp = (testflag(addr, af_pfr) &&
2253 (testflag(addr, af_file) || addr->local_part[0] == '|')) ||
2254 readconf_depends((driver_instance *)tp, US"local_part");
2255 uschar *batch_id = NULL;
2256 address_item **anchor = &addr_local;
2257 address_item *last = addr;
2260 /* Expand the batch_id string for comparison with other addresses.
2261 Expansion failure suppresses batching. */
2263 if (tp->batch_id != NULL)
2265 deliver_set_expansions(addr);
2266 batch_id = expand_string(tp->batch_id);
2267 deliver_set_expansions(NULL);
2268 if (batch_id == NULL)
2270 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand batch_id option "
2271 "in %s transport (%s): %s", tp->name, addr->address,
2272 expand_string_message);
2273 batch_count = tp->batch_max;
2277 /* Until we reach the batch_max limit, pick off addresses which have the
2278 same characteristics. These are:
2281 not previously delivered (see comment about 50 lines above)
2282 same local part if the transport's configuration contains $local_part
2283 or if this is a file or pipe delivery from a redirection
2284 same domain if the transport's configuration contains $domain
2286 same additional headers
2287 same headers to be removed
2288 same uid/gid for running the transport
2289 same first host if a host list is set
2292 while ((next = *anchor) != NULL && batch_count < tp->batch_max)
2295 tp == next->transport &&
2296 !previously_transported(next, TRUE) &&
2297 (addr->flags & (af_pfr|af_file)) == (next->flags & (af_pfr|af_file)) &&
2298 (!uses_lp || Ustrcmp(next->local_part, addr->local_part) == 0) &&
2299 (!uses_dom || Ustrcmp(next->domain, addr->domain) == 0) &&
2300 same_strings(next->p.errors_address, addr->p.errors_address) &&
2301 same_headers(next->p.extra_headers, addr->p.extra_headers) &&
2302 same_strings(next->p.remove_headers, addr->p.remove_headers) &&
2303 same_ugid(tp, addr, next) &&
2304 ((addr->host_list == NULL && next->host_list == NULL) ||
2305 (addr->host_list != NULL && next->host_list != NULL &&
2306 Ustrcmp(addr->host_list->name, next->host_list->name) == 0));
2308 /* If the transport has a batch_id setting, batch_id will be non-NULL
2309 from the expansion outside the loop. Expand for this address and compare.
2310 Expansion failure makes this address ineligible for batching. */
2312 if (ok && batch_id != NULL)
2315 address_item *save_nextnext = next->next;
2316 next->next = NULL; /* Expansion for a single address */
2317 deliver_set_expansions(next);
2318 next->next = save_nextnext;
2319 bid = expand_string(tp->batch_id);
2320 deliver_set_expansions(NULL);
2323 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand batch_id option "
2324 "in %s transport (%s): %s", tp->name, next->address,
2325 expand_string_message);
2328 else ok = (Ustrcmp(batch_id, bid) == 0);
2331 /* Take address into batch if OK. */
2335 *anchor = next->next; /* Include the address */
2341 else anchor = &(next->next); /* Skip the address */
2345 /* We now have one or more addresses that can be delivered in a batch. Check
2346 whether the transport is prepared to accept a message of this size. If not,
2347 fail them all forthwith. If the expansion fails, or does not yield an
2348 integer, defer delivery. */
2350 if (tp->message_size_limit != NULL)
2352 int rc = check_message_size(tp, addr);
2355 replicate_status(addr);
2356 while (addr != NULL)
2359 post_process_one(addr, rc, logflags, DTYPE_TRANSPORT, 0);
2362 continue; /* With next batch of addresses */
2366 /* If we are not running the queue, or if forcing, all deliveries will be
2367 attempted. Otherwise, we must respect the retry times for each address. Even
2368 when not doing this, we need to set up the retry key string, and determine
2369 whether a retry record exists, because after a successful delivery, a delete
2370 retry item must be set up. Keep the retry database open only for the duration
2371 of these checks, rather than for all local deliveries, because some local
2372 deliveries (e.g. to pipes) can take a substantial time. */
2374 dbm_file = dbfn_open(US"retry", O_RDONLY, &dbblock, FALSE);
2375 if (dbm_file == NULL)
2377 DEBUG(D_deliver|D_retry|D_hints_lookup)
2378 debug_printf("no retry data available\n");
2383 while (addr2 != NULL)
2385 BOOL ok = TRUE; /* to deliver this address */
2388 /* Set up the retry key to include the domain or not, and change its
2389 leading character from "R" to "T". Must make a copy before doing this,
2390 because the old key may be pointed to from a "delete" retry item after
2393 retry_key = string_copy(
2394 (tp->retry_use_local_part)? addr2->address_retry_key :
2395 addr2->domain_retry_key);
2398 /* Inspect the retry data. If there is no hints file, delivery happens. */
2400 if (dbm_file != NULL)
2402 dbdata_retry *retry_record = dbfn_read(dbm_file, retry_key);
2404 /* If there is no retry record, delivery happens. If there is,
2405 remember it exists so it can be deleted after a successful delivery. */
2407 if (retry_record != NULL)
2409 setflag(addr2, af_lt_retry_exists);
2411 /* A retry record exists for this address. If queue running and not
2412 forcing, inspect its contents. If the record is too old, or if its
2413 retry time has come, or if it has passed its cutoff time, delivery
2418 debug_printf("retry record exists: age=%s ",
2419 readconf_printtime(now - retry_record->time_stamp));
2420 debug_printf("(max %s)\n", readconf_printtime(retry_data_expire));
2421 debug_printf(" time to retry = %s expired = %d\n",
2422 readconf_printtime(retry_record->next_try - now),
2423 retry_record->expired);
2426 if (queue_running && !deliver_force)
2428 ok = (now - retry_record->time_stamp > retry_data_expire) ||
2429 (now >= retry_record->next_try) ||
2430 retry_record->expired;
2432 /* If we haven't reached the retry time, there is one more check
2433 to do, which is for the ultimate address timeout. */
2436 ok = retry_ultimate_address_timeout(retry_key, addr2->domain,
2440 else DEBUG(D_retry) debug_printf("no retry record exists\n");
2443 /* This address is to be delivered. Leave it on the chain. */
2448 addr2 = addr2->next;
2451 /* This address is to be deferred. Take it out of the chain, and
2452 post-process it as complete. Must take it out of the chain first,
2453 because post processing puts it on another chain. */
2457 address_item *this = addr2;
2458 this->message = US"Retry time not yet reached";
2459 this->basic_errno = ERRNO_LRETRY;
2460 if (addr3 == NULL) addr2 = addr = addr2->next;
2461 else addr2 = addr3->next = addr2->next;
2462 post_process_one(this, DEFER, logflags, DTYPE_TRANSPORT, 0);
2466 if (dbm_file != NULL) dbfn_close(dbm_file);
2468 /* If there are no addresses left on the chain, they all deferred. Loop
2469 for the next set of addresses. */
2471 if (addr == NULL) continue;
2473 /* So, finally, we do have some addresses that can be passed to the
2474 transport. Before doing so, set up variables that are relevant to a
2477 deliver_set_expansions(addr);
2478 delivery_start = time(NULL);
2479 deliver_local(addr, FALSE);
2480 deliver_time = (int)(time(NULL) - delivery_start);
2482 /* If a shadow transport (which must perforce be another local transport), is
2483 defined, and its condition is met, we must pass the message to the shadow
2484 too, but only those addresses that succeeded. We do this by making a new
2485 chain of addresses - also to keep the original chain uncontaminated. We must
2486 use a chain rather than doing it one by one, because the shadow transport may
2489 NOTE: if the condition fails because of a lookup defer, there is nothing we
2492 if (tp->shadow != NULL &&
2493 (tp->shadow_condition == NULL ||
2494 expand_check_condition(tp->shadow_condition, tp->name, US"transport")))
2496 transport_instance *stp;
2497 address_item *shadow_addr = NULL;
2498 address_item **last = &shadow_addr;
2500 for (stp = transports; stp != NULL; stp = stp->next)
2501 if (Ustrcmp(stp->name, tp->shadow) == 0) break;
2504 log_write(0, LOG_MAIN|LOG_PANIC, "shadow transport \"%s\" not found ",
2507 /* Pick off the addresses that have succeeded, and make clones. Put into
2508 the shadow_message field a pointer to the shadow_message field of the real
2511 else for (addr2 = addr; addr2 != NULL; addr2 = addr2->next)
2513 if (addr2->transport_return != OK) continue;
2514 addr3 = store_get(sizeof(address_item));
2517 addr3->shadow_message = (uschar *)(&(addr2->shadow_message));
2518 addr3->transport = stp;
2519 addr3->transport_return = DEFER;
2520 addr3->return_filename = NULL;
2521 addr3->return_file = -1;
2523 last = &(addr3->next);
2526 /* If we found any addresses to shadow, run the delivery, and stick any
2527 message back into the shadow_message field in the original. */
2529 if (shadow_addr != NULL)
2531 int save_count = transport_count;
2533 DEBUG(D_deliver|D_transport)
2534 debug_printf(">>>>>>>>>>>>>>>> Shadow delivery >>>>>>>>>>>>>>>>\n");
2535 deliver_local(shadow_addr, TRUE);
2537 for(; shadow_addr != NULL; shadow_addr = shadow_addr->next)
2539 int sresult = shadow_addr->transport_return;
2540 *((uschar **)(shadow_addr->shadow_message)) = (sresult == OK)?
2541 string_sprintf(" ST=%s", stp->name) :
2542 string_sprintf(" ST=%s (%s%s%s)", stp->name,
2543 (shadow_addr->basic_errno <= 0)?
2544 US"" : US strerror(shadow_addr->basic_errno),
2545 (shadow_addr->basic_errno <= 0 || shadow_addr->message == NULL)?
2547 (shadow_addr->message != NULL)? shadow_addr->message :
2548 (shadow_addr->basic_errno <= 0)? US"unknown error" : US"");
2550 DEBUG(D_deliver|D_transport)
2551 debug_printf("%s shadow transport returned %s for %s\n",
2553 (sresult == OK)? "OK" :
2554 (sresult == DEFER)? "DEFER" :
2555 (sresult == FAIL)? "FAIL" :
2556 (sresult == PANIC)? "PANIC" : "?",
2557 shadow_addr->address);
2560 DEBUG(D_deliver|D_transport)
2561 debug_printf(">>>>>>>>>>>>>>>> End shadow delivery >>>>>>>>>>>>>>>>\n");
2563 transport_count = save_count; /* Restore original transport count */
2567 /* Cancel the expansions that were set up for the delivery. */
2569 deliver_set_expansions(NULL);
2571 /* Now we can process the results of the real transport. We must take each
2572 address off the chain first, because post_process_one() puts it on another
2575 for (addr2 = addr; addr2 != NULL; addr2 = nextaddr)
2577 int result = addr2->transport_return;
2578 nextaddr = addr2->next;
2580 DEBUG(D_deliver|D_transport)
2581 debug_printf("%s transport returned %s for %s\n",
2583 (result == OK)? "OK" :
2584 (result == DEFER)? "DEFER" :
2585 (result == FAIL)? "FAIL" :
2586 (result == PANIC)? "PANIC" : "?",
2589 /* If there is a retry_record, or if delivery is deferred, build a retry
2590 item for setting a new retry time or deleting the old retry record from
2591 the database. These items are handled all together after all addresses
2592 have been handled (so the database is open just for a short time for
2595 if (result == DEFER || testflag(addr2, af_lt_retry_exists))
2597 int flags = (result == DEFER)? 0 : rf_delete;
2598 uschar *retry_key = string_copy((tp->retry_use_local_part)?
2599 addr2->address_retry_key : addr2->domain_retry_key);
2601 retry_add_item(addr2, retry_key, flags);
2604 /* Done with this address */
2606 if (result == OK) addr2->more_errno = deliver_time;
2607 post_process_one(addr2, result, logflags, DTYPE_TRANSPORT, logchar);
2609 /* If a pipe delivery generated text to be sent back, the result may be
2610 changed to FAIL, and we must copy this for subsequent addresses in the
2613 if (addr2->transport_return != result)
2615 for (addr3 = nextaddr; addr3 != NULL; addr3 = addr3->next)
2617 addr3->transport_return = addr2->transport_return;
2618 addr3->basic_errno = addr2->basic_errno;
2619 addr3->message = addr2->message;
2621 result = addr2->transport_return;
2624 /* Whether or not the result was changed to FAIL, we need to copy the
2625 return_file value from the first address into all the addresses of the
2626 batch, so they are all listed in the error message. */
2628 addr2->return_file = addr->return_file;
2630 /* Change log character for recording successful deliveries. */
2632 if (result == OK) logchar = '-';
2634 } /* Loop back for next batch of addresses */
2640 /*************************************************
2641 * Sort remote deliveries *
2642 *************************************************/
2644 /* This function is called if remote_sort_domains is set. It arranges that the
2645 chain of addresses for remote deliveries is ordered according to the strings
2646 specified. Try to make this shuffling reasonably efficient by handling
2647 sequences of addresses rather than just single ones.
2654 sort_remote_deliveries(void)
2657 address_item **aptr = &addr_remote;
2658 uschar *listptr = remote_sort_domains;
2662 while (*aptr != NULL &&
2663 (pattern = string_nextinlist(&listptr, &sep, patbuf, sizeof(patbuf)))
2666 address_item *moved = NULL;
2667 address_item **bptr = &moved;
2669 while (*aptr != NULL)
2671 address_item **next;
2672 deliver_domain = (*aptr)->domain; /* set $domain */
2673 if (match_isinlist(deliver_domain, &pattern, UCHAR_MAX+1,
2674 &domainlist_anchor, NULL, MCL_DOMAIN, TRUE, NULL) == OK)
2676 aptr = &((*aptr)->next);
2680 next = &((*aptr)->next);
2681 while (*next != NULL &&
2682 (deliver_domain = (*next)->domain, /* Set $domain */
2683 match_isinlist(deliver_domain, &pattern, UCHAR_MAX+1,
2684 &domainlist_anchor, NULL, MCL_DOMAIN, TRUE, NULL)) != OK)
2685 next = &((*next)->next);
2687 /* If the batch of non-matchers is at the end, add on any that were
2688 extracted further up the chain, and end this iteration. Otherwise,
2689 extract them from the chain and hang on the moved chain. */
2701 aptr = &((*aptr)->next);
2704 /* If the loop ended because the final address matched, *aptr will
2705 be NULL. Add on to the end any extracted non-matching addresses. If
2706 *aptr is not NULL, the loop ended via "break" when *next is null, that
2707 is, there was a string of non-matching addresses at the end. In this
2708 case the extracted addresses have already been added on the end. */
2710 if (*aptr == NULL) *aptr = moved;
2716 debug_printf("remote addresses after sorting:\n");
2717 for (addr = addr_remote; addr != NULL; addr = addr->next)
2718 debug_printf(" %s\n", addr->address);
2724 /*************************************************
2725 * Read from pipe for remote delivery subprocess *
2726 *************************************************/
2728 /* This function is called when the subprocess is complete, but can also be
2729 called before it is complete, in order to empty a pipe that is full (to prevent
2730 deadlock). It must therefore keep track of its progress in the parlist data
2733 We read the pipe to get the delivery status codes and a possible error message
2734 for each address, optionally preceded by unusability data for the hosts and
2735 also by optional retry data.
2737 Read in large chunks into the big buffer and then scan through, interpreting
2738 the data therein. In most cases, only a single read will be necessary. No
2739 individual item will ever be anywhere near 2500 bytes in length, so by ensuring
2740 that we read the next chunk when there is less than 2500 bytes left in the
2741 non-final chunk, we can assume each item is complete in the buffer before
2742 handling it. Each item is written using a single write(), which is atomic for
2743 small items (less than PIPE_BUF, which seems to be at least 512 in any Unix and
2744 often bigger) so even if we are reading while the subprocess is still going, we
2745 should never have only a partial item in the buffer.
2748 poffset the offset of the parlist item
2749 eop TRUE if the process has completed
2751 Returns: TRUE if the terminating 'Z' item has been read,
2752 or there has been a disaster (i.e. no more data needed);
2757 par_read_pipe(int poffset, BOOL eop)
2760 pardata *p = parlist + poffset;
2761 address_item *addrlist = p->addrlist;
2762 address_item *addr = p->addr;
2765 uschar *endptr = big_buffer;
2766 uschar *ptr = endptr;
2767 uschar *msg = p->msg;
2768 BOOL done = p->done;
2769 BOOL unfinished = TRUE;
2771 /* Loop through all items, reading from the pipe when necessary. The pipe
2772 is set up to be non-blocking, but there are two different Unix mechanisms in
2773 use. Exim uses O_NONBLOCK if it is defined. This returns 0 for end of file,
2774 and EAGAIN for no more data. If O_NONBLOCK is not defined, Exim uses O_NDELAY,
2775 which returns 0 for both end of file and no more data. We distinguish the
2776 two cases by taking 0 as end of file only when we know the process has
2779 Each separate item is written to the pipe in a single write(), and as they are
2780 all short items, the writes will all be atomic and we should never find
2781 ourselves in the position of having read an incomplete item. "Short" in this
2782 case can mean up to about 1K in the case when there is a long error message
2783 associated with an address. */
2785 DEBUG(D_deliver) debug_printf("reading pipe for subprocess %d (%s)\n",
2786 (int)p->pid, eop? "ended" : "not ended");
2790 retry_item *r, **rp;
2791 int remaining = endptr - ptr;
2793 /* Read (first time) or top up the chars in the buffer if necessary.
2794 There will be only one read if we get all the available data (i.e. don't
2795 fill the buffer completely). */
2797 if (remaining < 2500 && unfinished)
2800 int available = big_buffer_size - remaining;
2802 if (remaining > 0) memmove(big_buffer, ptr, remaining);
2805 endptr = big_buffer + remaining;
2806 len = read(fd, endptr, available);
2808 DEBUG(D_deliver) debug_printf("read() yielded %d\n", len);
2810 /* If the result is EAGAIN and the process is not complete, just
2811 stop reading any more and process what we have already. */
2815 if (!eop && errno == EAGAIN) len = 0; else
2817 msg = string_sprintf("failed to read pipe from transport process "
2818 "%d for transport %s: %s", pid, addr->transport->driver_name,
2824 /* If the length is zero (eof or no-more-data), just process what we
2825 already have. Note that if the process is still running and we have
2826 read all the data in the pipe (but less that "available") then we
2827 won't read any more, as "unfinished" will get set FALSE. */
2830 unfinished = len == available;
2833 /* If we are at the end of the available data, exit the loop. */
2835 if (ptr >= endptr) break;
2837 /* Handle each possible type of item, assuming the complete item is
2838 available in store. */
2842 /* Host items exist only if any hosts were marked unusable. Match
2843 up by checking the IP address. */
2846 for (h = addrlist->host_list; h != NULL; h = h->next)
2848 if (h->address == NULL || Ustrcmp(h->address, ptr+2) != 0) continue;
2856 /* Retry items are sent in a preceding R item for each address. This is
2857 kept separate to keep each message short enough to guarantee it won't
2858 be split in the pipe. Hopefully, in the majority of cases, there won't in
2859 fact be any retry items at all.
2861 The complete set of retry items might include an item to delete a
2862 routing retry if there was a previous routing delay. However, routing
2863 retries are also used when a remote transport identifies an address error.
2864 In that case, there may also be an "add" item for the same key. Arrange
2865 that a "delete" item is dropped in favour of an "add" item. */
2868 if (addr == NULL) goto ADDR_MISMATCH;
2870 DEBUG(D_deliver|D_retry)
2871 debug_printf("reading retry information for %s from subprocess\n",
2874 /* Cut out any "delete" items on the list. */
2876 for (rp = &(addr->retries); (r = *rp) != NULL; rp = &(r->next))
2878 if (Ustrcmp(r->key, ptr+1) == 0) /* Found item with same key */
2880 if ((r->flags & rf_delete) == 0) break; /* It was not "delete" */
2881 *rp = r->next; /* Excise a delete item */
2882 DEBUG(D_deliver|D_retry)
2883 debug_printf(" existing delete item dropped\n");
2887 /* We want to add a delete item only if there is no non-delete item;
2888 however we still have to step ptr through the data. */
2890 if (r == NULL || (*ptr & rf_delete) == 0)
2892 r = store_get(sizeof(retry_item));
2893 r->next = addr->retries;
2896 r->key = string_copy(ptr);
2898 memcpy(&(r->basic_errno), ptr, sizeof(r->basic_errno));
2899 ptr += sizeof(r->basic_errno);
2900 memcpy(&(r->more_errno), ptr, sizeof(r->more_errno));
2901 ptr += sizeof(r->more_errno);
2902 r->message = (*ptr)? string_copy(ptr) : NULL;
2903 DEBUG(D_deliver|D_retry)
2904 debug_printf(" added %s item\n",
2905 ((r->flags & rf_delete) == 0)? "retry" : "delete");
2910 DEBUG(D_deliver|D_retry)
2911 debug_printf(" delete item not added: non-delete item exists\n");
2914 ptr += sizeof(r->basic_errno) + sizeof(r->more_errno);
2920 /* Put the amount of data written into the parlist block */
2923 memcpy(&(p->transport_count), ptr, sizeof(transport_count));
2924 ptr += sizeof(transport_count);
2927 /* Address items are in the order of items on the address chain. We
2928 remember the current address value in case this function is called
2929 several times to empty the pipe in stages. Information about delivery
2930 over TLS is sent in a preceding X item for each address. We don't put
2931 it in with the other info, in order to keep each message short enough to
2932 guarantee it won't be split in the pipe. */
2936 if (addr == NULL) goto ADDR_MISMATCH; /* Below, in 'A' handler */
2937 addr->cipher = (*ptr)? string_copy(ptr) : NULL;
2939 addr->peerdn = (*ptr)? string_copy(ptr) : NULL;
2944 case 'C': /* client authenticator information */
2948 addr->authenticator = (*ptr)? string_copy(ptr) : NULL;
2951 addr->auth_id = (*ptr)? string_copy(ptr) : NULL;
2954 addr->auth_sndr = (*ptr)? string_copy(ptr) : NULL;
2960 #ifdef EXPERIMENTAL_PRDR
2962 addr->flags |= af_prdr_used; break;
2969 msg = string_sprintf("address count mismatch for data read from pipe "
2970 "for transport process %d for transport %s", pid,
2971 addrlist->transport->driver_name);
2976 addr->transport_return = *ptr++;
2977 addr->special_action = *ptr++;
2978 memcpy(&(addr->basic_errno), ptr, sizeof(addr->basic_errno));
2979 ptr += sizeof(addr->basic_errno);
2980 memcpy(&(addr->more_errno), ptr, sizeof(addr->more_errno));
2981 ptr += sizeof(addr->more_errno);
2982 memcpy(&(addr->flags), ptr, sizeof(addr->flags));
2983 ptr += sizeof(addr->flags);
2984 addr->message = (*ptr)? string_copy(ptr) : NULL;
2986 addr->user_message = (*ptr)? string_copy(ptr) : NULL;
2989 /* Always two strings for host information, followed by the port number */
2993 h = store_get(sizeof(host_item));
2994 h->name = string_copy(ptr);
2996 h->address = string_copy(ptr);
2998 memcpy(&(h->port), ptr, sizeof(h->port));
2999 ptr += sizeof(h->port);
3000 addr->host_used = h;
3004 /* Finished with this address */
3009 /* Z marks the logical end of the data. It is followed by '0' if
3010 continue_transport was NULL at the end of transporting, otherwise '1'.
3011 We need to know when it becomes NULL during a delivery down a passed SMTP
3012 channel so that we don't try to pass anything more down it. Of course, for
3013 most normal messages it will remain NULL all the time. */
3018 continue_transport = NULL;
3019 continue_hostname = NULL;
3022 DEBUG(D_deliver) debug_printf("Z%c item read\n", *ptr);
3025 /* Anything else is a disaster. */
3028 msg = string_sprintf("malformed data (%d) read from pipe for transport "
3029 "process %d for transport %s", ptr[-1], pid,
3030 addr->transport->driver_name);
3036 /* The done flag is inspected externally, to determine whether or not to
3037 call the function again when the process finishes. */
3041 /* If the process hadn't finished, and we haven't seen the end of the data
3042 or suffered a disaster, update the rest of the state, and return FALSE to
3043 indicate "not finished". */
3052 /* Close our end of the pipe, to prevent deadlock if the far end is still
3053 pushing stuff into it. */
3058 /* If we have finished without error, but haven't had data for every address,
3059 something is wrong. */
3061 if (msg == NULL && addr != NULL)
3062 msg = string_sprintf("insufficient address data read from pipe "
3063 "for transport process %d for transport %s", pid,
3064 addr->transport->driver_name);
3066 /* If an error message is set, something has gone wrong in getting back
3067 the delivery data. Put the message into each address and freeze it. */
3071 for (addr = addrlist; addr != NULL; addr = addr->next)
3073 addr->transport_return = DEFER;
3074 addr->special_action = SPECIAL_FREEZE;
3075 addr->message = msg;
3079 /* Return TRUE to indicate we have got all we need from this process, even
3080 if it hasn't actually finished yet. */
3087 /*************************************************
3088 * Post-process a set of remote addresses *
3089 *************************************************/
3091 /* Do what has to be done immediately after a remote delivery for each set of
3092 addresses, then re-write the spool if necessary. Note that post_process_one
3093 puts the address on an appropriate queue; hence we must fish off the next
3094 one first. This function is also called if there is a problem with setting
3095 up a subprocess to do a remote delivery in parallel. In this case, the final
3096 argument contains a message, and the action must be forced to DEFER.
3099 addr pointer to chain of address items
3100 logflags flags for logging
3101 msg NULL for normal cases; -> error message for unexpected problems
3102 fallback TRUE if processing fallback hosts
3108 remote_post_process(address_item *addr, int logflags, uschar *msg,
3113 /* If any host addresses were found to be unusable, add them to the unusable
3114 tree so that subsequent deliveries don't try them. */
3116 for (h = addr->host_list; h != NULL; h = h->next)
3118 if (h->address == NULL) continue;
3119 if (h->status >= hstatus_unusable) tree_add_unusable(h);
3122 /* Now handle each address on the chain. The transport has placed '=' or '-'
3123 into the special_action field for each successful delivery. */
3125 while (addr != NULL)
3127 address_item *next = addr->next;
3129 /* If msg == NULL (normal processing) and the result is DEFER and we are
3130 processing the main hosts and there are fallback hosts available, put the
3131 address on the list for fallback delivery. */
3133 if (addr->transport_return == DEFER &&
3134 addr->fallback_hosts != NULL &&
3138 addr->host_list = addr->fallback_hosts;
3139 addr->next = addr_fallback;
3140 addr_fallback = addr;
3141 DEBUG(D_deliver) debug_printf("%s queued for fallback host(s)\n", addr->address);
3144 /* If msg is set (=> unexpected problem), set it in the address before
3145 doing the ordinary post processing. */
3151 addr->message = msg;
3152 addr->transport_return = DEFER;
3154 (void)post_process_one(addr, addr->transport_return, logflags,
3155 DTYPE_TRANSPORT, addr->special_action);
3163 /* If we have just delivered down a passed SMTP channel, and that was
3164 the last address, the channel will have been closed down. Now that
3165 we have logged that delivery, set continue_sequence to 1 so that
3166 any subsequent deliveries don't get "*" incorrectly logged. */
3168 if (continue_transport == NULL) continue_sequence = 1;
3173 /*************************************************
3174 * Wait for one remote delivery subprocess *
3175 *************************************************/
3177 /* This function is called while doing remote deliveries when either the
3178 maximum number of processes exist and we need one to complete so that another
3179 can be created, or when waiting for the last ones to complete. It must wait for
3180 the completion of one subprocess, empty the control block slot, and return a
3181 pointer to the address chain.
3184 Returns: pointer to the chain of addresses handled by the process;
3185 NULL if no subprocess found - this is an unexpected error
3188 static address_item *
3191 int poffset, status;
3192 address_item *addr, *addrlist;
3195 set_process_info("delivering %s: waiting for a remote delivery subprocess "
3196 "to finish", message_id);
3198 /* Loop until either a subprocess completes, or there are no subprocesses in
3199 existence - in which case give an error return. We cannot proceed just by
3200 waiting for a completion, because a subprocess may have filled up its pipe, and
3201 be waiting for it to be emptied. Therefore, if no processes have finished, we
3202 wait for one of the pipes to acquire some data by calling select(), with a
3203 timeout just in case.
3205 The simple approach is just to iterate after reading data from a ready pipe.
3206 This leads to non-ideal behaviour when the subprocess has written its final Z
3207 item, closed the pipe, and is in the process of exiting (the common case). A
3208 call to waitpid() yields nothing completed, but select() shows the pipe ready -
3209 reading it yields EOF, so you end up with busy-waiting until the subprocess has
3212 To avoid this, if all the data that is needed has been read from a subprocess
3213 after select(), an explicit wait() for it is done. We know that all it is doing
3214 is writing to the pipe and then exiting, so the wait should not be long.
3216 The non-blocking waitpid() is to some extent just insurance; if we could
3217 reliably detect end-of-file on the pipe, we could always know when to do a
3218 blocking wait() for a completed process. However, because some systems use
3219 NDELAY, which doesn't distinguish between EOF and pipe empty, it is easier to
3220 use code that functions without the need to recognize EOF.
3222 There's a double loop here just in case we end up with a process that is not in
3223 the list of remote delivery processes. Something has obviously gone wrong if
3224 this is the case. (For example, a process that is incorrectly left over from
3225 routing or local deliveries might be found.) The damage can be minimized by
3226 looping back and looking for another process. If there aren't any, the error
3227 return will happen. */
3229 for (;;) /* Normally we do not repeat this loop */
3231 while ((pid = waitpid(-1, &status, WNOHANG)) <= 0)
3234 fd_set select_pipes;
3235 int maxpipe, readycount;
3237 /* A return value of -1 can mean several things. If errno != ECHILD, it
3238 either means invalid options (which we discount), or that this process was
3239 interrupted by a signal. Just loop to try the waitpid() again.
3241 If errno == ECHILD, waitpid() is telling us that there are no subprocesses
3242 in existence. This should never happen, and is an unexpected error.
3243 However, there is a nasty complication when running under Linux. If "strace
3244 -f" is being used under Linux to trace this process and its children,
3245 subprocesses are "stolen" from their parents and become the children of the
3246 tracing process. A general wait such as the one we've just obeyed returns
3247 as if there are no children while subprocesses are running. Once a
3248 subprocess completes, it is restored to the parent, and waitpid(-1) finds
3249 it. Thanks to Joachim Wieland for finding all this out and suggesting a
3252 This does not happen using "truss" on Solaris, nor (I think) with other
3253 tracing facilities on other OS. It seems to be specific to Linux.
3255 What we do to get round this is to use kill() to see if any of our
3256 subprocesses are still in existence. If kill() gives an OK return, we know
3257 it must be for one of our processes - it can't be for a re-use of the pid,
3258 because if our process had finished, waitpid() would have found it. If any
3259 of our subprocesses are in existence, we proceed to use select() as if
3260 waitpid() had returned zero. I think this is safe. */
3264 if (errno != ECHILD) continue; /* Repeats the waitpid() */
3267 debug_printf("waitpid() returned -1/ECHILD: checking explicitly "
3268 "for process existence\n");
3270 for (poffset = 0; poffset < remote_max_parallel; poffset++)
3272 if ((pid = parlist[poffset].pid) != 0 && kill(pid, 0) == 0)
3274 DEBUG(D_deliver) debug_printf("process %d still exists: assume "
3275 "stolen by strace\n", (int)pid);
3276 break; /* With poffset set */
3280 if (poffset >= remote_max_parallel)
3282 DEBUG(D_deliver) debug_printf("*** no delivery children found\n");
3283 return NULL; /* This is the error return */
3287 /* A pid value greater than 0 breaks the "while" loop. A negative value has
3288 been handled above. A return value of zero means that there is at least one
3289 subprocess, but there are no completed subprocesses. See if any pipes are
3290 ready with any data for reading. */
3292 DEBUG(D_deliver) debug_printf("selecting on subprocess pipes\n");
3295 FD_ZERO(&select_pipes);
3296 for (poffset = 0; poffset < remote_max_parallel; poffset++)
3298 if (parlist[poffset].pid != 0)
3300 int fd = parlist[poffset].fd;
3301 FD_SET(fd, &select_pipes);
3302 if (fd > maxpipe) maxpipe = fd;
3306 /* Stick in a 60-second timeout, just in case. */
3311 readycount = select(maxpipe + 1, (SELECT_ARG2_TYPE *)&select_pipes,
3314 /* Scan through the pipes and read any that are ready; use the count
3315 returned by select() to stop when there are no more. Select() can return
3316 with no processes (e.g. if interrupted). This shouldn't matter.
3318 If par_read_pipe() returns TRUE, it means that either the terminating Z was
3319 read, or there was a disaster. In either case, we are finished with this
3320 process. Do an explicit wait() for the process and break the main loop if
3323 It turns out that we have to deal with the case of an interrupted system
3324 call, which can happen on some operating systems if the signal handling is
3325 set up to do that by default. */
3328 readycount > 0 && poffset < remote_max_parallel;
3331 if ((pid = parlist[poffset].pid) != 0 &&
3332 FD_ISSET(parlist[poffset].fd, &select_pipes))
3335 if (par_read_pipe(poffset, FALSE)) /* Finished with this pipe */
3337 for (;;) /* Loop for signals */
3339 pid_t endedpid = waitpid(pid, &status, 0);
3340 if (endedpid == pid) goto PROCESS_DONE;
3341 if (endedpid != (pid_t)(-1) || errno != EINTR)
3342 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Unexpected error return "
3343 "%d (errno = %d) from waitpid() for process %d",
3344 (int)endedpid, errno, (int)pid);
3350 /* Now go back and look for a completed subprocess again. */
3353 /* A completed process was detected by the non-blocking waitpid(). Find the
3354 data block that corresponds to this subprocess. */
3356 for (poffset = 0; poffset < remote_max_parallel; poffset++)
3357 if (pid == parlist[poffset].pid) break;
3359 /* Found the data block; this is a known remote delivery process. We don't
3360 need to repeat the outer loop. This should be what normally happens. */
3362 if (poffset < remote_max_parallel) break;
3364 /* This situation is an error, but it's probably better to carry on looking
3365 for another process than to give up (as we used to do). */
3367 log_write(0, LOG_MAIN|LOG_PANIC, "Process %d finished: not found in remote "
3368 "transport process list", pid);
3369 } /* End of the "for" loop */
3371 /* Come here when all the data was completely read after a select(), and
3372 the process in pid has been wait()ed for. */
3379 debug_printf("remote delivery process %d ended\n", (int)pid);
3381 debug_printf("remote delivery process %d ended: status=%04x\n", (int)pid,
3385 set_process_info("delivering %s", message_id);
3387 /* Get the chain of processed addresses */
3389 addrlist = parlist[poffset].addrlist;
3391 /* If the process did not finish cleanly, record an error and freeze (except
3392 for SIGTERM, SIGKILL and SIGQUIT), and also ensure the journal is not removed,
3393 in case the delivery did actually happen. */
3395 if ((status & 0xffff) != 0)
3398 int msb = (status >> 8) & 255;
3399 int lsb = status & 255;
3400 int code = (msb == 0)? (lsb & 0x7f) : msb;
3402 msg = string_sprintf("%s transport process returned non-zero status 0x%04x: "
3404 addrlist->transport->driver_name,
3406 (msb == 0)? "terminated by signal" : "exit code",
3409 if (msb != 0 || (code != SIGTERM && code != SIGKILL && code != SIGQUIT))
3410 addrlist->special_action = SPECIAL_FREEZE;
3412 for (addr = addrlist; addr != NULL; addr = addr->next)
3414 addr->transport_return = DEFER;
3415 addr->message = msg;
3418 remove_journal = FALSE;
3421 /* Else complete reading the pipe to get the result of the delivery, if all
3422 the data has not yet been obtained. */
3424 else if (!parlist[poffset].done) (void)par_read_pipe(poffset, TRUE);
3426 /* Put the data count and return path into globals, mark the data slot unused,
3427 decrement the count of subprocesses, and return the address chain. */
3429 transport_count = parlist[poffset].transport_count;
3430 used_return_path = parlist[poffset].return_path;
3431 parlist[poffset].pid = 0;
3438 /*************************************************
3439 * Wait for subprocesses and post-process *
3440 *************************************************/
3442 /* This function waits for subprocesses until the number that are still running
3443 is below a given threshold. For each complete subprocess, the addresses are
3444 post-processed. If we can't find a running process, there is some shambles.
3445 Better not bomb out, as that might lead to multiple copies of the message. Just
3446 log and proceed as if all done.
3449 max maximum number of subprocesses to leave running
3450 fallback TRUE if processing fallback hosts
3456 par_reduce(int max, BOOL fallback)
3458 while (parcount > max)
3460 address_item *doneaddr = par_wait();
3461 if (doneaddr == NULL)
3463 log_write(0, LOG_MAIN|LOG_PANIC,
3464 "remote delivery process count got out of step");
3467 else remote_post_process(doneaddr, LOG_MAIN, NULL, fallback);
3475 rmt_dlv_checked_write(int fd, void * buf, int size)
3477 int ret = write(fd, buf, size);
3479 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Failed writing transport result to pipe: %s\n",
3480 ret == -1 ? strerror(errno) : "short write");
3483 /*************************************************
3484 * Do remote deliveries *
3485 *************************************************/
3487 /* This function is called to process the addresses in addr_remote. We must
3488 pick off the queue all addresses that have the same transport, remote
3489 destination, and errors address, and hand them to the transport in one go,
3490 subject to some configured limitations. If this is a run to continue delivering
3491 to an existing delivery channel, skip all but those addresses that can go to
3492 that channel. The skipped addresses just get deferred.
3494 If mua_wrapper is set, all addresses must be able to be sent in a single
3495 transaction. If not, this function yields FALSE.
3497 In Exim 4, remote deliveries are always done in separate processes, even
3498 if remote_max_parallel = 1 or if there's only one delivery to do. The reason
3499 is so that the base process can retain privilege. This makes the
3500 implementation of fallback transports feasible (though not initially done.)
3502 We create up to the configured number of subprocesses, each of which passes
3503 back the delivery state via a pipe. (However, when sending down an existing
3504 connection, remote_max_parallel is forced to 1.)
3507 fallback TRUE if processing fallback hosts
3509 Returns: TRUE normally
3510 FALSE if mua_wrapper is set and the addresses cannot all be sent
3515 do_remote_deliveries(BOOL fallback)
3521 parcount = 0; /* Number of executing subprocesses */
3523 /* When sending down an existing channel, only do one delivery at a time.
3524 We use a local variable (parmax) to hold the maximum number of processes;
3525 this gets reduced from remote_max_parallel if we can't create enough pipes. */
3527 if (continue_transport != NULL) remote_max_parallel = 1;
3528 parmax = remote_max_parallel;
3530 /* If the data for keeping a list of processes hasn't yet been
3533 if (parlist == NULL)
3535 parlist = store_get(remote_max_parallel * sizeof(pardata));
3536 for (poffset = 0; poffset < remote_max_parallel; poffset++)
3537 parlist[poffset].pid = 0;
3540 /* Now loop for each remote delivery */
3542 for (delivery_count = 0; addr_remote != NULL; delivery_count++)
3548 int address_count = 1;
3549 int address_count_max;
3551 BOOL use_initgroups;
3552 BOOL pipe_done = FALSE;
3553 transport_instance *tp;
3554 address_item **anchor = &addr_remote;
3555 address_item *addr = addr_remote;
3556 address_item *last = addr;
3559 /* Pull the first address right off the list. */
3561 addr_remote = addr->next;
3564 DEBUG(D_deliver|D_transport)
3565 debug_printf("--------> %s <--------\n", addr->address);
3567 /* If no transport has been set, there has been a big screw-up somewhere. */
3569 if ((tp = addr->transport) == NULL)
3571 disable_logging = FALSE; /* Jic */
3572 remote_post_process(addr, LOG_MAIN|LOG_PANIC,
3573 US"No transport set by router", fallback);
3577 /* Check that this base address hasn't previously been delivered to this
3578 transport. The check is necessary at this point to handle homonymic addresses
3579 correctly in cases where the pattern of redirection changes between delivery
3580 attempts. Non-homonymic previous delivery is detected earlier, at routing
3583 if (previously_transported(addr, FALSE)) continue;
3585 /* Force failure if the message is too big. */
3587 if (tp->message_size_limit != NULL)
3589 int rc = check_message_size(tp, addr);
3592 addr->transport_return = rc;
3593 remote_post_process(addr, LOG_MAIN, NULL, fallback);
3598 /* Get the flag which specifies whether the transport can handle different
3599 domains that nevertheless resolve to the same set of hosts. */
3601 multi_domain = tp->multi_domain;
3603 /* Get the maximum it can handle in one envelope, with zero meaning
3604 unlimited, which is forced for the MUA wrapper case. */
3606 address_count_max = tp->max_addresses;
3607 if (address_count_max == 0 || mua_wrapper) address_count_max = 999999;
3610 /************************************************************************/
3611 /***** This is slightly experimental code, but should be safe. *****/
3613 /* The address_count_max value is the maximum number of addresses that the
3614 transport can send in one envelope. However, the transport must be capable of
3615 dealing with any number of addresses. If the number it gets exceeds its
3616 envelope limitation, it must send multiple copies of the message. This can be
3617 done over a single connection for SMTP, so uses less resources than making
3618 multiple connections. On the other hand, if remote_max_parallel is greater
3619 than one, it is perhaps a good idea to use parallel processing to move the
3620 message faster, even if that results in multiple simultaneous connections to
3623 How can we come to some compromise between these two ideals? What we do is to
3624 limit the number of addresses passed to a single instance of a transport to
3625 the greater of (a) its address limit (rcpt_max for SMTP) and (b) the total
3626 number of addresses routed to remote transports divided by
3627 remote_max_parallel. For example, if the message has 100 remote recipients,
3628 remote max parallel is 2, and rcpt_max is 10, we'd never send more than 50 at
3629 once. But if rcpt_max is 100, we could send up to 100.
3631 Of course, not all the remotely addresses in a message are going to go to the
3632 same set of hosts (except in smarthost configurations), so this is just a
3633 heuristic way of dividing up the work.
3635 Furthermore (1), because this may not be wanted in some cases, and also to
3636 cope with really pathological cases, there is also a limit to the number of
3637 messages that are sent over one connection. This is the same limit that is
3638 used when sending several different messages over the same connection.
3639 Continue_sequence is set when in this situation, to the number sent so
3640 far, including this message.
3642 Furthermore (2), when somebody explicitly sets the maximum value to 1, it
3643 is probably because they are using VERP, in which case they want to pass only
3644 one address at a time to the transport, in order to be able to use
3645 $local_part and $domain in constructing a new return path. We could test for
3646 the use of these variables, but as it is so likely they will be used when the
3647 maximum is 1, we don't bother. Just leave the value alone. */
3649 if (address_count_max != 1 &&
3650 address_count_max < remote_delivery_count/remote_max_parallel)
3652 int new_max = remote_delivery_count/remote_max_parallel;
3653 int message_max = tp->connection_max_messages;
3654 if (connection_max_messages >= 0) message_max = connection_max_messages;
3655 message_max -= continue_sequence - 1;
3656 if (message_max > 0 && new_max > address_count_max * message_max)
3657 new_max = address_count_max * message_max;
3658 address_count_max = new_max;
3661 /************************************************************************/
3664 /* Pick off all addresses which have the same transport, errors address,
3665 destination, and extra headers. In some cases they point to the same host
3666 list, but we also need to check for identical host lists generated from
3667 entirely different domains. The host list pointers can be NULL in the case
3668 where the hosts are defined in the transport. There is also a configured
3669 maximum limit of addresses that can be handled at once (see comments above
3670 for how it is computed). */
3672 while ((next = *anchor) != NULL && address_count < address_count_max)
3674 if ((multi_domain || Ustrcmp(next->domain, addr->domain) == 0)
3676 tp == next->transport
3678 same_hosts(next->host_list, addr->host_list)
3680 same_strings(next->p.errors_address, addr->p.errors_address)
3682 same_headers(next->p.extra_headers, addr->p.extra_headers)
3684 same_ugid(tp, next, addr)
3686 (next->p.remove_headers == addr->p.remove_headers ||
3687 (next->p.remove_headers != NULL &&
3688 addr->p.remove_headers != NULL &&
3689 Ustrcmp(next->p.remove_headers, addr->p.remove_headers) == 0)))
3691 *anchor = next->next;
3693 next->first = addr; /* remember top one (for retry processing) */
3698 else anchor = &(next->next);
3701 /* If we are acting as an MUA wrapper, all addresses must go in a single
3702 transaction. If not, put them back on the chain and yield FALSE. */
3704 if (mua_wrapper && addr_remote != NULL)
3706 last->next = addr_remote;
3711 /* Set up the expansion variables for this set of addresses */
3713 deliver_set_expansions(addr);
3715 /* Ensure any transport-set auth info is fresh */
3716 addr->authenticator = addr->auth_id = addr->auth_sndr = NULL;
3718 /* Compute the return path, expanding a new one if required. The old one
3719 must be set first, as it might be referred to in the expansion. */
3721 if(addr->p.errors_address != NULL)
3722 return_path = addr->p.errors_address;
3723 #ifdef EXPERIMENTAL_SRS
3724 else if(addr->p.srs_sender != NULL)
3725 return_path = addr->p.srs_sender;
3728 return_path = sender_address;
3730 if (tp->return_path != NULL)
3732 uschar *new_return_path = expand_string(tp->return_path);
3733 if (new_return_path == NULL)
3735 if (!expand_string_forcedfail)
3737 remote_post_process(addr, LOG_MAIN|LOG_PANIC,
3738 string_sprintf("Failed to expand return path \"%s\": %s",
3739 tp->return_path, expand_string_message), fallback);
3743 else return_path = new_return_path;
3746 /* Find the uid, gid, and use_initgroups setting for this transport. Failure
3747 logs and sets up error messages, so we just post-process and continue with
3748 the next address. */
3750 if (!findugid(addr, tp, &uid, &gid, &use_initgroups))
3752 remote_post_process(addr, LOG_MAIN|LOG_PANIC, NULL, fallback);
3756 /* If this transport has a setup function, call it now so that it gets
3757 run in this process and not in any subprocess. That way, the results of
3758 any setup that are retained by the transport can be reusable. One of the
3759 things the setup does is to set the fallback host lists in the addresses.
3760 That is why it is called at this point, before the continue delivery
3761 processing, because that might use the fallback hosts. */
3763 if (tp->setup != NULL)
3764 (void)((tp->setup)(addr->transport, addr, NULL, uid, gid, NULL));
3766 /* If this is a run to continue delivery down an already-established
3767 channel, check that this set of addresses matches the transport and
3768 the channel. If it does not, defer the addresses. If a host list exists,
3769 we must check that the continue host is on the list. Otherwise, the
3770 host is set in the transport. */
3772 continue_more = FALSE; /* In case got set for the last lot */
3773 if (continue_transport != NULL)
3775 BOOL ok = Ustrcmp(continue_transport, tp->name) == 0;
3776 if (ok && addr->host_list != NULL)
3780 for (h = addr->host_list; h != NULL; h = h->next)
3782 if (Ustrcmp(h->name, continue_hostname) == 0)
3783 { ok = TRUE; break; }
3787 /* Addresses not suitable; defer or queue for fallback hosts (which
3788 might be the continue host) and skip to next address. */
3792 DEBUG(D_deliver) debug_printf("not suitable for continue_transport\n");
3795 if (addr->fallback_hosts != NULL && !fallback)
3799 next->host_list = next->fallback_hosts;
3800 DEBUG(D_deliver) debug_printf("%s queued for fallback host(s)\n", next->address);
3801 if (next->next == NULL) break;
3804 next->next = addr_fallback;
3805 addr_fallback = addr;
3810 while (next->next != NULL) next = next->next;
3811 next->next = addr_defer;
3818 /* Set a flag indicating whether there are further addresses that list
3819 the continued host. This tells the transport to leave the channel open,
3820 but not to pass it to another delivery process. */
3822 for (next = addr_remote; next != NULL; next = next->next)
3825 for (h = next->host_list; h != NULL; h = h->next)
3827 if (Ustrcmp(h->name, continue_hostname) == 0)
3828 { continue_more = TRUE; break; }
3833 /* The transports set up the process info themselves as they may connect
3834 to more than one remote machine. They also have to set up the filter
3835 arguments, if required, so that the host name and address are available
3838 transport_filter_argv = NULL;
3840 /* Create the pipe for inter-process communication. If pipe creation
3841 fails, it is probably because the value of remote_max_parallel is so
3842 large that too many file descriptors for pipes have been created. Arrange
3843 to wait for a process to finish, and then try again. If we still can't
3844 create a pipe when all processes have finished, break the retry loop. */
3848 if (pipe(pfd) == 0) pipe_done = TRUE;
3849 else if (parcount > 0) parmax = parcount;
3852 /* We need to make the reading end of the pipe non-blocking. There are
3853 two different options for this. Exim is cunningly (I hope!) coded so
3854 that it can use either of them, though it prefers O_NONBLOCK, which
3855 distinguishes between EOF and no-more-data. */
3858 (void)fcntl(pfd[pipe_read], F_SETFL, O_NONBLOCK);
3860 (void)fcntl(pfd[pipe_read], F_SETFL, O_NDELAY);
3863 /* If the maximum number of subprocesses already exist, wait for a process
3864 to finish. If we ran out of file descriptors, parmax will have been reduced
3865 from its initial value of remote_max_parallel. */
3867 par_reduce(parmax - 1, fallback);
3870 /* If we failed to create a pipe and there were no processes to wait
3871 for, we have to give up on this one. Do this outside the above loop
3872 so that we can continue the main loop. */
3876 remote_post_process(addr, LOG_MAIN|LOG_PANIC,
3877 string_sprintf("unable to create pipe: %s", strerror(errno)), fallback);
3881 /* Find a free slot in the pardata list. Must do this after the possible
3882 waiting for processes to finish, because a terminating process will free
3885 for (poffset = 0; poffset < remote_max_parallel; poffset++)
3886 if (parlist[poffset].pid == 0) break;
3888 /* If there isn't one, there has been a horrible disaster. */
3890 if (poffset >= remote_max_parallel)
3892 (void)close(pfd[pipe_write]);
3893 (void)close(pfd[pipe_read]);
3894 remote_post_process(addr, LOG_MAIN|LOG_PANIC,
3895 US"Unexpectedly no free subprocess slot", fallback);
3899 /* Now fork a subprocess to do the remote delivery, but before doing so,
3900 ensure that any cached resourses are released so as not to interfere with
3901 what happens in the subprocess. */
3905 if ((pid = fork()) == 0)
3907 int fd = pfd[pipe_write];
3910 /* Setting this global in the subprocess means we need never clear it */
3911 transport_name = tp->name;
3913 /* There are weird circumstances in which logging is disabled */
3914 disable_logging = tp->disable_logging;
3916 /* Show pids on debug output if parallelism possible */
3918 if (parmax > 1 && (parcount > 0 || addr_remote != NULL))
3920 DEBUG(D_any|D_v) debug_selector |= D_pid;
3921 DEBUG(D_deliver) debug_printf("Remote delivery process started\n");
3924 /* Reset the random number generator, so different processes don't all
3925 have the same sequence. In the test harness we want different, but
3926 predictable settings for each delivery process, so do something explicit
3927 here rather they rely on the fixed reset in the random number function. */
3929 random_seed = running_in_test_harness? 42 + 2*delivery_count : 0;
3931 /* Set close-on-exec on the pipe so that it doesn't get passed on to
3932 a new process that may be forked to do another delivery down the same
3935 (void)fcntl(fd, F_SETFD, fcntl(fd, F_GETFD) | FD_CLOEXEC);
3937 /* Close open file descriptors for the pipes of other processes
3938 that are running in parallel. */
3940 for (poffset = 0; poffset < remote_max_parallel; poffset++)
3941 if (parlist[poffset].pid != 0) (void)close(parlist[poffset].fd);
3943 /* This process has inherited a copy of the file descriptor
3944 for the data file, but its file pointer is shared with all the
3945 other processes running in parallel. Therefore, we have to re-open
3946 the file in order to get a new file descriptor with its own
3947 file pointer. We don't need to lock it, as the lock is held by
3948 the parent process. There doesn't seem to be any way of doing
3949 a dup-with-new-file-pointer. */
3951 (void)close(deliver_datafile);
3952 sprintf(CS spoolname, "%s/input/%s/%s-D", spool_directory, message_subdir,
3954 deliver_datafile = Uopen(spoolname, O_RDWR | O_APPEND, 0);
3956 if (deliver_datafile < 0)
3957 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Failed to reopen %s for remote "
3958 "parallel delivery: %s", spoolname, strerror(errno));
3960 /* Set the close-on-exec flag */
3962 (void)fcntl(deliver_datafile, F_SETFD, fcntl(deliver_datafile, F_GETFD) |
3965 /* Set the uid/gid of this process; bombs out on failure. */
3967 exim_setugid(uid, gid, use_initgroups,
3968 string_sprintf("remote delivery to %s with transport=%s",
3969 addr->address, tp->name));
3971 /* Close the unwanted half of this process' pipe, set the process state,
3972 and run the transport. Afterwards, transport_count will contain the number
3973 of bytes written. */
3975 (void)close(pfd[pipe_read]);
3976 set_process_info("delivering %s using %s", message_id, tp->name);
3977 debug_print_string(tp->debug_string);
3978 if (!(tp->info->code)(addr->transport, addr)) replicate_status(addr);
3980 set_process_info("delivering %s (just run %s for %s%s in subprocess)",
3981 message_id, tp->name, addr->address, (addr->next == NULL)? "" : ", ...");
3983 /* Ensure any cached resources that we used are now released */
3987 /* Pass the result back down the pipe. This is a lot more information
3988 than is needed for a local delivery. We have to send back the error
3989 status for each address, the usability status for each host that is
3990 flagged as unusable, and all the retry items. When TLS is in use, we
3991 send also the cipher and peerdn information. Each type of information
3992 is flagged by an identifying byte, and is then in a fixed format (with
3993 strings terminated by zeros), and there is a final terminator at the
3994 end. The host information and retry information is all attached to
3995 the first address, so that gets sent at the start. */
3997 /* Host unusability information: for most success cases this will
4000 for (h = addr->host_list; h != NULL; h = h->next)
4002 if (h->address == NULL || h->status < hstatus_unusable) continue;
4003 sprintf(CS big_buffer, "H%c%c%s", h->status, h->why, h->address);
4004 rmt_dlv_checked_write(fd, big_buffer, Ustrlen(big_buffer+3) + 4);
4007 /* The number of bytes written. This is the same for each address. Even
4008 if we sent several copies of the message down the same connection, the
4009 size of each one is the same, and it's that value we have got because
4010 transport_count gets reset before calling transport_write_message(). */
4012 big_buffer[0] = 'S';
4013 memcpy(big_buffer+1, &transport_count, sizeof(transport_count));
4014 rmt_dlv_checked_write(fd, big_buffer, sizeof(transport_count) + 1);
4016 /* Information about what happened to each address. Four item types are
4017 used: an optional 'X' item first, for TLS information, then an optional "C"
4018 item for any client-auth info followed by 'R' items for any retry settings,
4019 and finally an 'A' item for the remaining data. */
4021 for(; addr != NULL; addr = addr->next)
4026 /* The certificate verification status goes into the flags */
4028 if (tls_out.certificate_verified) setflag(addr, af_cert_verified);
4030 /* Use an X item only if there's something to send */
4033 if (addr->cipher != NULL)
4036 sprintf(CS ptr, "X%.128s", addr->cipher);
4038 if (addr->peerdn == NULL) *ptr++ = 0; else
4040 sprintf(CS ptr, "%.512s", addr->peerdn);
4043 rmt_dlv_checked_write(fd, big_buffer, ptr - big_buffer);
4047 if (client_authenticator)
4050 sprintf(CS big_buffer, "C1%.64s", client_authenticator);
4052 rmt_dlv_checked_write(fd, big_buffer, ptr - big_buffer);
4054 if (client_authenticated_id)
4057 sprintf(CS big_buffer, "C2%.64s", client_authenticated_id);
4059 rmt_dlv_checked_write(fd, big_buffer, ptr - big_buffer);
4061 if (client_authenticated_sender)
4064 sprintf(CS big_buffer, "C3%.64s", client_authenticated_sender);
4066 rmt_dlv_checked_write(fd, big_buffer, ptr - big_buffer);
4069 #ifdef EXPERIMENTAL_PRDR
4070 if (addr->flags & af_prdr_used) rmt_dlv_checked_write(fd, "P", 1);
4073 /* Retry information: for most success cases this will be null. */
4075 for (r = addr->retries; r != NULL; r = r->next)
4078 sprintf(CS big_buffer, "R%c%.500s", r->flags, r->key);
4079 ptr = big_buffer + Ustrlen(big_buffer+2) + 3;
4080 memcpy(ptr, &(r->basic_errno), sizeof(r->basic_errno));
4081 ptr += sizeof(r->basic_errno);
4082 memcpy(ptr, &(r->more_errno), sizeof(r->more_errno));
4083 ptr += sizeof(r->more_errno);
4084 if (r->message == NULL) *ptr++ = 0; else
4086 sprintf(CS ptr, "%.512s", r->message);
4089 rmt_dlv_checked_write(fd, big_buffer, ptr - big_buffer);
4092 /* The rest of the information goes in an 'A' item. */
4094 ptr = big_buffer + 3;
4095 sprintf(CS big_buffer, "A%c%c", addr->transport_return,
4096 addr->special_action);
4097 memcpy(ptr, &(addr->basic_errno), sizeof(addr->basic_errno));
4098 ptr += sizeof(addr->basic_errno);
4099 memcpy(ptr, &(addr->more_errno), sizeof(addr->more_errno));
4100 ptr += sizeof(addr->more_errno);
4101 memcpy(ptr, &(addr->flags), sizeof(addr->flags));
4102 ptr += sizeof(addr->flags);
4104 if (addr->message == NULL) *ptr++ = 0; else
4106 sprintf(CS ptr, "%.1024s", addr->message);
4110 if (addr->user_message == NULL) *ptr++ = 0; else
4112 sprintf(CS ptr, "%.1024s", addr->user_message);
4116 if (addr->host_used == NULL) *ptr++ = 0; else
4118 sprintf(CS ptr, "%.256s", addr->host_used->name);
4120 sprintf(CS ptr, "%.64s", addr->host_used->address);
4122 memcpy(ptr, &(addr->host_used->port), sizeof(addr->host_used->port));
4123 ptr += sizeof(addr->host_used->port);
4125 rmt_dlv_checked_write(fd, big_buffer, ptr - big_buffer);
4128 /* Add termination flag, close the pipe, and that's it. The character
4129 after 'Z' indicates whether continue_transport is now NULL or not.
4130 A change from non-NULL to NULL indicates a problem with a continuing
4133 big_buffer[0] = 'Z';
4134 big_buffer[1] = (continue_transport == NULL)? '0' : '1';
4135 rmt_dlv_checked_write(fd, big_buffer, 2);
4140 /* Back in the mainline: close the unwanted half of the pipe. */
4142 (void)close(pfd[pipe_write]);
4144 /* Fork failed; defer with error message */
4148 (void)close(pfd[pipe_read]);
4149 remote_post_process(addr, LOG_MAIN|LOG_PANIC,
4150 string_sprintf("fork failed for remote delivery to %s: %s",
4151 addr->domain, strerror(errno)), fallback);
4155 /* Fork succeeded; increment the count, and remember relevant data for
4156 when the process finishes. */
4159 parlist[poffset].addrlist = parlist[poffset].addr = addr;
4160 parlist[poffset].pid = pid;
4161 parlist[poffset].fd = pfd[pipe_read];
4162 parlist[poffset].done = FALSE;
4163 parlist[poffset].msg = NULL;
4164 parlist[poffset].return_path = return_path;
4166 /* If the process we've just started is sending a message down an existing
4167 channel, wait for it now. This ensures that only one such process runs at
4168 once, whatever the value of remote_max parallel. Otherwise, we might try to
4169 send two or more messages simultaneously down the same channel. This could
4170 happen if there are different domains that include the same host in otherwise
4171 different host lists.
4173 Also, if the transport closes down the channel, this information gets back
4174 (continue_transport gets set to NULL) before we consider any other addresses
4177 if (continue_transport != NULL) par_reduce(0, fallback);
4179 /* Otherwise, if we are running in the test harness, wait a bit, to let the
4180 newly created process get going before we create another process. This should
4181 ensure repeatability in the tests. We only need to wait a tad. */
4183 else if (running_in_test_harness) millisleep(500);
4186 /* Reached the end of the list of addresses. Wait for all the subprocesses that
4187 are still running and post-process their addresses. */
4189 par_reduce(0, fallback);
4196 /*************************************************
4197 * Split an address into local part and domain *
4198 *************************************************/
4200 /* This function initializes an address for routing by splitting it up into a
4201 local part and a domain. The local part is set up twice - once in its original
4202 casing, and once in lower case, and it is dequoted. We also do the "percent
4203 hack" for configured domains. This may lead to a DEFER result if a lookup
4204 defers. When a percent-hacking takes place, we insert a copy of the original
4205 address as a new parent of this address, as if we have had a redirection.
4208 addr points to an addr_item block containing the address
4211 DEFER - could not determine if domain is %-hackable
4215 deliver_split_address(address_item *addr)
4217 uschar *address = addr->address;
4218 uschar *domain = Ustrrchr(address, '@');
4220 int len = domain - address;
4222 addr->domain = string_copylc(domain+1); /* Domains are always caseless */
4224 /* The implication in the RFCs (though I can't say I've seen it spelled out
4225 explicitly) is that quoting should be removed from local parts at the point
4226 where they are locally interpreted. [The new draft "821" is more explicit on
4227 this, Jan 1999.] We know the syntax is valid, so this can be done by simply
4228 removing quoting backslashes and any unquoted doublequotes. */
4230 t = addr->cc_local_part = store_get(len+1);
4233 register int c = *address++;
4234 if (c == '\"') continue;
4244 /* We do the percent hack only for those domains that are listed in
4245 percent_hack_domains. A loop is required, to copy with multiple %-hacks. */
4247 if (percent_hack_domains != NULL)
4250 uschar *new_address = NULL;
4251 uschar *local_part = addr->cc_local_part;
4253 deliver_domain = addr->domain; /* set $domain */
4255 while ((rc = match_isinlist(deliver_domain, &percent_hack_domains, 0,
4256 &domainlist_anchor, addr->domain_cache, MCL_DOMAIN, TRUE, NULL))
4258 (t = Ustrrchr(local_part, '%')) != NULL)
4260 new_address = string_copy(local_part);
4261 new_address[t - local_part] = '@';
4262 deliver_domain = string_copylc(t+1);
4263 local_part = string_copyn(local_part, t - local_part);
4266 if (rc == DEFER) return DEFER; /* lookup deferred */
4268 /* If hackery happened, set up new parent and alter the current address. */
4270 if (new_address != NULL)
4272 address_item *new_parent = store_get(sizeof(address_item));
4273 *new_parent = *addr;
4274 addr->parent = new_parent;
4275 addr->address = new_address;
4276 addr->unique = string_copy(new_address);
4277 addr->domain = deliver_domain;
4278 addr->cc_local_part = local_part;
4279 DEBUG(D_deliver) debug_printf("%%-hack changed address to: %s\n",
4284 /* Create the lowercased version of the final local part, and make that the
4285 default one to be used. */
4287 addr->local_part = addr->lc_local_part = string_copylc(addr->cc_local_part);
4294 /*************************************************
4295 * Get next error message text *
4296 *************************************************/
4298 /* If f is not NULL, read the next "paragraph", from a customized error message
4299 text file, terminated by a line containing ****, and expand it.
4302 f NULL or a file to read from
4303 which string indicating which string (for errors)
4305 Returns: NULL or an expanded string
4309 next_emf(FILE *f, uschar *which)
4313 uschar *para, *yield;
4316 if (f == NULL) return NULL;
4318 if (Ufgets(buffer, sizeof(buffer), f) == NULL ||
4319 Ustrcmp(buffer, "****\n") == 0) return NULL;
4321 para = store_get(size);
4324 para = string_cat(para, &size, &ptr, buffer, Ustrlen(buffer));
4325 if (Ufgets(buffer, sizeof(buffer), f) == NULL ||
4326 Ustrcmp(buffer, "****\n") == 0) break;
4330 yield = expand_string(para);
4331 if (yield != NULL) return yield;
4333 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand string from "
4334 "bounce_message_file or warn_message_file (%s): %s", which,
4335 expand_string_message);
4342 /*************************************************
4343 * Close down a passed transport channel *
4344 *************************************************/
4346 /* This function is called when a passed transport channel cannot be used.
4347 It attempts to close it down tidily. The yield is always DELIVER_NOT_ATTEMPTED
4348 so that the function call can be the argument of a "return" statement.
4351 Returns: DELIVER_NOT_ATTEMPTED
4355 continue_closedown(void)
4357 if (continue_transport != NULL)
4359 transport_instance *t;
4360 for (t = transports; t != NULL; t = t->next)
4362 if (Ustrcmp(t->name, continue_transport) == 0)
4364 if (t->info->closedown != NULL) (t->info->closedown)(t);
4369 return DELIVER_NOT_ATTEMPTED;
4375 /*************************************************
4376 * Print address information *
4377 *************************************************/
4379 /* This function is called to output an address, or information about an
4380 address, for bounce or defer messages. If the hide_child flag is set, all we
4381 output is the original ancestor address.
4384 addr points to the address
4385 f the FILE to print to
4386 si an initial string
4387 sc a continuation string for before "generated"
4390 Returns: TRUE if the address is not hidden
4394 print_address_information(address_item *addr, FILE *f, uschar *si, uschar *sc,
4398 uschar *printed = US"";
4399 address_item *ancestor = addr;
4400 while (ancestor->parent != NULL) ancestor = ancestor->parent;
4402 fprintf(f, "%s", CS si);
4404 if (addr->parent != NULL && testflag(addr, af_hide_child))
4406 printed = US"an undisclosed address";
4409 else if (!testflag(addr, af_pfr) || addr->parent == NULL)
4410 printed = addr->address;
4414 uschar *s = addr->address;
4417 if (addr->address[0] == '>') { ss = US"mail"; s++; }
4418 else if (addr->address[0] == '|') ss = US"pipe";
4421 fprintf(f, "%s to %s%sgenerated by ", ss, s, sc);
4422 printed = addr->parent->address;
4425 fprintf(f, "%s", CS string_printing(printed));
4427 if (ancestor != addr)
4429 uschar *original = (ancestor->onetime_parent == NULL)?
4430 ancestor->address : ancestor->onetime_parent;
4431 if (strcmpic(original, printed) != 0)
4432 fprintf(f, "%s(%sgenerated from %s)", sc,
4433 (ancestor != addr->parent)? "ultimately " : "",
4434 string_printing(original));
4437 fprintf(f, "%s", CS se);
4445 /*************************************************
4446 * Print error for an address *
4447 *************************************************/
4449 /* This function is called to print the error information out of an address for
4450 a bounce or a warning message. It tries to format the message reasonably by
4451 introducing newlines. All lines are indented by 4; the initial printing
4452 position must be set before calling.
4454 This function used always to print the error. Nowadays we want to restrict it
4455 to cases such as LMTP/SMTP errors from a remote host, and errors from :fail:
4456 and filter "fail". We no longer pass other information willy-nilly in bounce
4457 and warning messages. Text in user_message is always output; text in message
4458 only if the af_pass_message flag is set.
4462 f the FILE to print on
4469 print_address_error(address_item *addr, FILE *f, uschar *t)
4471 int count = Ustrlen(t);
4472 uschar *s = testflag(addr, af_pass_message)? addr->message : NULL;
4476 if (addr->user_message != NULL) s = addr->user_message; else return;
4479 fprintf(f, "\n %s", t);
4483 if (*s == '\\' && s[1] == 'n')
4493 if (*s++ == ':' && isspace(*s) && count > 45)
4495 fprintf(f, "\n "); /* sic (because space follows) */
4507 /*************************************************
4508 * Check list of addresses for duplication *
4509 *************************************************/
4511 /* This function was introduced when the test for duplicate addresses that are
4512 not pipes, files, or autoreplies was moved from the middle of routing to when
4513 routing was complete. That was to fix obscure cases when the routing history
4514 affects the subsequent routing of identical addresses. This function is called
4515 after routing, to check that the final routed addresses are not duplicates.
4517 If we detect a duplicate, we remember what it is a duplicate of. Note that
4518 pipe, file, and autoreply de-duplication is handled during routing, so we must
4519 leave such "addresses" alone here, as otherwise they will incorrectly be
4522 Argument: address of list anchor
4527 do_duplicate_check(address_item **anchor)
4530 while ((addr = *anchor) != NULL)
4533 if (testflag(addr, af_pfr))
4535 anchor = &(addr->next);
4537 else if ((tnode = tree_search(tree_duplicates, addr->unique)) != NULL)
4539 DEBUG(D_deliver|D_route)
4540 debug_printf("%s is a duplicate address: discarded\n", addr->unique);
4541 *anchor = addr->next;
4542 addr->dupof = tnode->data.ptr;
4543 addr->next = addr_duplicate;
4544 addr_duplicate = addr;
4548 tree_add_duplicate(addr->unique, addr);
4549 anchor = &(addr->next);
4557 /*************************************************
4558 * Deliver one message *
4559 *************************************************/
4561 /* This is the function which is called when a message is to be delivered. It
4562 is passed the id of the message. It is possible that the message no longer
4563 exists, if some other process has delivered it, and it is also possible that
4564 the message is being worked on by another process, in which case the data file
4567 If no delivery is attempted for any of the above reasons, the function returns
4568 DELIVER_NOT_ATTEMPTED.
4570 If the give_up flag is set true, do not attempt any deliveries, but instead
4571 fail all outstanding addresses and return the message to the sender (or
4574 A delivery operation has a process all to itself; we never deliver more than
4575 one message in the same process. Therefore we needn't worry too much about
4579 id the id of the message to be delivered
4580 forced TRUE if delivery was forced by an administrator; this overrides
4581 retry delays and causes a delivery to be tried regardless
4582 give_up TRUE if an administrator has requested that delivery attempts
4585 Returns: When the global variable mua_wrapper is FALSE:
4586 DELIVER_ATTEMPTED_NORMAL if a delivery attempt was made
4587 DELIVER_NOT_ATTEMPTED otherwise (see comment above)
4588 When the global variable mua_wrapper is TRUE:
4589 DELIVER_MUA_SUCCEEDED if delivery succeeded
4590 DELIVER_MUA_FAILED if delivery failed
4591 DELIVER_NOT_ATTEMPTED if not attempted (should not occur)
4595 deliver_message(uschar *id, BOOL forced, BOOL give_up)
4598 int final_yield = DELIVER_ATTEMPTED_NORMAL;
4599 time_t now = time(NULL);
4600 address_item *addr_last = NULL;
4601 uschar *filter_message = NULL;
4603 int process_recipients = RECIP_ACCEPT;
4606 extern int acl_where;
4608 uschar *info = (queue_run_pid == (pid_t)0)?
4609 string_sprintf("delivering %s", id) :
4610 string_sprintf("delivering %s (queue run pid %d)", id, queue_run_pid);
4612 /* If the D_process_info bit is on, set_process_info() will output debugging
4613 information. If not, we want to show this initial information if D_deliver or
4614 D_queue_run is set or in verbose mode. */
4616 set_process_info("%s", info);
4618 if ((debug_selector & D_process_info) == 0 &&
4619 (debug_selector & (D_deliver|D_queue_run|D_v)) != 0)
4620 debug_printf("%s\n", info);
4622 /* Ensure that we catch any subprocesses that are created. Although Exim
4623 sets SIG_DFL as its initial default, some routes through the code end up
4624 here with it set to SIG_IGN - cases where a non-synchronous delivery process
4625 has been forked, but no re-exec has been done. We use sigaction rather than
4626 plain signal() on those OS where SA_NOCLDWAIT exists, because we want to be
4627 sure it is turned off. (There was a problem on AIX with this.) */
4631 struct sigaction act;
4632 act.sa_handler = SIG_DFL;
4633 sigemptyset(&(act.sa_mask));
4635 sigaction(SIGCHLD, &act, NULL);
4638 signal(SIGCHLD, SIG_DFL);
4641 /* Make the forcing flag available for routers and transports, set up the
4642 global message id field, and initialize the count for returned files and the
4643 message size. This use of strcpy() is OK because the length id is checked when
4644 it is obtained from a command line (the -M or -q options), and otherwise it is
4645 known to be a valid message id. */
4647 Ustrcpy(message_id, id);
4648 deliver_force = forced;
4652 /* Initialize some flags */
4654 update_spool = FALSE;
4655 remove_journal = TRUE;
4657 /* Set a known context for any ACLs we call via expansions */
4658 acl_where = ACL_WHERE_DELIVERY;
4660 /* Reset the random number generator, so that if several delivery processes are
4661 started from a queue runner that has already used random numbers (for sorting),
4662 they don't all get the same sequence. */
4666 /* Open and lock the message's data file. Exim locks on this one because the
4667 header file may get replaced as it is re-written during the delivery process.
4668 Any failures cause messages to be written to the log, except for missing files
4669 while queue running - another process probably completed delivery. As part of
4670 opening the data file, message_subdir gets set. */
4672 if (!spool_open_datafile(id))
4673 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
4675 /* The value of message_size at this point has been set to the data length,
4676 plus one for the blank line that notionally precedes the data. */
4678 /* Now read the contents of the header file, which will set up the headers in
4679 store, and also the list of recipients and the tree of non-recipients and
4680 assorted flags. It updates message_size. If there is a reading or format error,
4681 give up; if the message has been around for sufficiently long, remove it. */
4683 sprintf(CS spoolname, "%s-H", id);
4684 if ((rc = spool_read_header(spoolname, TRUE, TRUE)) != spool_read_OK)
4686 if (errno == ERRNO_SPOOLFORMAT)
4688 struct stat statbuf;
4689 sprintf(CS big_buffer, "%s/input/%s/%s", spool_directory, message_subdir,
4691 if (Ustat(big_buffer, &statbuf) == 0)
4692 log_write(0, LOG_MAIN, "Format error in spool file %s: "
4693 "size=" OFF_T_FMT, spoolname, statbuf.st_size);
4694 else log_write(0, LOG_MAIN, "Format error in spool file %s", spoolname);
4697 log_write(0, LOG_MAIN, "Error reading spool file %s: %s", spoolname,
4700 /* If we managed to read the envelope data, received_time contains the
4701 time the message was received. Otherwise, we can calculate it from the
4704 if (rc != spool_read_hdrerror)
4707 for (i = 0; i < 6; i++)
4708 received_time = received_time * BASE_62 + tab62[id[i] - '0'];
4711 /* If we've had this malformed message too long, sling it. */
4713 if (now - received_time > keep_malformed)
4715 sprintf(CS spoolname, "%s/msglog/%s/%s", spool_directory, message_subdir, id);
4717 sprintf(CS spoolname, "%s/input/%s/%s-D", spool_directory, message_subdir, id);
4719 sprintf(CS spoolname, "%s/input/%s/%s-H", spool_directory, message_subdir, id);
4721 sprintf(CS spoolname, "%s/input/%s/%s-J", spool_directory, message_subdir, id);
4723 log_write(0, LOG_MAIN, "Message removed because older than %s",
4724 readconf_printtime(keep_malformed));
4727 (void)close(deliver_datafile);
4728 deliver_datafile = -1;
4729 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
4732 /* The spool header file has been read. Look to see if there is an existing
4733 journal file for this message. If there is, it means that a previous delivery
4734 attempt crashed (program or host) before it could update the spool header file.
4735 Read the list of delivered addresses from the journal and add them to the
4736 nonrecipients tree. Then update the spool file. We can leave the journal in
4737 existence, as it will get further successful deliveries added to it in this
4738 run, and it will be deleted if this function gets to its end successfully.
4739 Otherwise it might be needed again. */
4741 sprintf(CS spoolname, "%s/input/%s/%s-J", spool_directory, message_subdir, id);
4742 jread = Ufopen(spoolname, "rb");
4745 while (Ufgets(big_buffer, big_buffer_size, jread) != NULL)
4747 int n = Ustrlen(big_buffer);
4748 big_buffer[n-1] = 0;
4749 tree_add_nonrecipient(big_buffer);
4750 DEBUG(D_deliver) debug_printf("Previously delivered address %s taken from "
4751 "journal file\n", big_buffer);
4753 (void)fclose(jread);
4754 /* Panic-dies on error */
4755 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
4757 else if (errno != ENOENT)
4759 log_write(0, LOG_MAIN|LOG_PANIC, "attempt to open journal for reading gave: "
4760 "%s", strerror(errno));
4761 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
4764 /* A null recipients list indicates some kind of disaster. */
4766 if (recipients_list == NULL)
4768 (void)close(deliver_datafile);
4769 deliver_datafile = -1;
4770 log_write(0, LOG_MAIN, "Spool error: no recipients for %s", spoolname);
4771 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
4775 /* Handle a message that is frozen. There are a number of different things that
4776 can happen, but in the default situation, unless forced, no delivery is
4781 #ifdef SUPPORT_MOVE_FROZEN_MESSAGES
4782 /* Moving to another directory removes the message from Exim's view. Other
4783 tools must be used to deal with it. Logging of this action happens in
4784 spool_move_message() and its subfunctions. */
4786 if (move_frozen_messages &&
4787 spool_move_message(id, message_subdir, US"", US"F"))
4788 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
4791 /* For all frozen messages (bounces or not), timeout_frozen_after sets the
4792 maximum time to keep messages that are frozen. Thaw if we reach it, with a
4793 flag causing all recipients to be failed. The time is the age of the
4794 message, not the time since freezing. */
4796 if (timeout_frozen_after > 0 && message_age >= timeout_frozen_after)
4798 log_write(0, LOG_MAIN, "cancelled by timeout_frozen_after");
4799 process_recipients = RECIP_FAIL_TIMEOUT;
4802 /* For bounce messages (and others with no sender), thaw if the error message
4803 ignore timer is exceeded. The message will be discarded if this delivery
4806 else if (sender_address[0] == 0 && message_age >= ignore_bounce_errors_after)
4808 log_write(0, LOG_MAIN, "Unfrozen by errmsg timer");
4811 /* If this is a bounce message, or there's no auto thaw, or we haven't
4812 reached the auto thaw time yet, and this delivery is not forced by an admin
4813 user, do not attempt delivery of this message. Note that forced is set for
4814 continuing messages down the same channel, in order to skip load checking and
4815 ignore hold domains, but we don't want unfreezing in that case. */
4819 if ((sender_address[0] == 0 ||
4821 now <= deliver_frozen_at + auto_thaw
4824 (!forced || !deliver_force_thaw || !admin_user ||
4825 continue_hostname != NULL
4828 (void)close(deliver_datafile);
4829 deliver_datafile = -1;
4830 log_write(L_skip_delivery, LOG_MAIN, "Message is frozen");
4831 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
4834 /* If delivery was forced (by an admin user), assume a manual thaw.
4835 Otherwise it's an auto thaw. */
4839 deliver_manual_thaw = TRUE;
4840 log_write(0, LOG_MAIN, "Unfrozen by forced delivery");
4842 else log_write(0, LOG_MAIN, "Unfrozen by auto-thaw");
4845 /* We get here if any of the rules for unfreezing have triggered. */
4847 deliver_freeze = FALSE;
4848 update_spool = TRUE;
4852 /* Open the message log file if we are using them. This records details of
4853 deliveries, deferments, and failures for the benefit of the mail administrator.
4854 The log is not used by exim itself to track the progress of a message; that is
4855 done by rewriting the header spool file. */
4862 sprintf(CS spoolname, "%s/msglog/%s/%s", spool_directory, message_subdir, id);
4863 fd = open_msglog_file(spoolname, SPOOL_MODE, &error);
4867 log_write(0, LOG_MAIN|LOG_PANIC, "Couldn't %s message log %s: %s", error,
4868 spoolname, strerror(errno));
4869 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
4872 /* Make a C stream out of it. */
4874 message_log = fdopen(fd, "a");
4875 if (message_log == NULL)
4877 log_write(0, LOG_MAIN|LOG_PANIC, "Couldn't fdopen message log %s: %s",
4878 spoolname, strerror(errno));
4879 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
4884 /* If asked to give up on a message, log who did it, and set the action for all
4889 struct passwd *pw = getpwuid(real_uid);
4890 log_write(0, LOG_MAIN, "cancelled by %s", (pw != NULL)?
4891 US pw->pw_name : string_sprintf("uid %ld", (long int)real_uid));
4892 process_recipients = RECIP_FAIL;
4895 /* Otherwise, if there are too many Received: headers, fail all recipients. */
4897 else if (received_count > received_headers_max)
4898 process_recipients = RECIP_FAIL_LOOP;
4900 /* Otherwise, if a system-wide, address-independent message filter is
4901 specified, run it now, except in the case when we are failing all recipients as
4902 a result of timeout_frozen_after. If the system filter yields "delivered", then
4903 ignore the true recipients of the message. Failure of the filter file is
4904 logged, and the delivery attempt fails. */
4906 else if (system_filter != NULL && process_recipients != RECIP_FAIL_TIMEOUT)
4911 redirect_block redirect;
4913 if (system_filter_uid_set)
4915 ugid.uid = system_filter_uid;
4916 ugid.gid = system_filter_gid;
4917 ugid.uid_set = ugid.gid_set = TRUE;
4921 ugid.uid_set = ugid.gid_set = FALSE;
4924 return_path = sender_address;
4925 enable_dollar_recipients = TRUE; /* Permit $recipients in system filter */
4926 system_filtering = TRUE;
4928 /* Any error in the filter file causes a delivery to be abandoned. */
4930 redirect.string = system_filter;
4931 redirect.isfile = TRUE;
4932 redirect.check_owner = redirect.check_group = FALSE;
4933 redirect.owners = NULL;
4934 redirect.owngroups = NULL;
4936 redirect.modemask = 0;
4938 DEBUG(D_deliver|D_filter) debug_printf("running system filter\n");
4941 &redirect, /* Where the data is */
4942 RDO_DEFER | /* Turn on all the enabling options */
4943 RDO_FAIL | /* Leave off all the disabling options */
4948 NULL, /* No :include: restriction (not used in filter) */
4949 NULL, /* No sieve vacation directory (not sieve!) */
4950 NULL, /* No sieve enotify mailto owner (not sieve!) */
4951 NULL, /* No sieve user address (not sieve!) */
4952 NULL, /* No sieve subaddress (not sieve!) */
4953 &ugid, /* uid/gid data */
4954 &addr_new, /* Where to hang generated addresses */
4955 &filter_message, /* Where to put error message */
4956 NULL, /* Don't skip syntax errors */
4957 &filtertype, /* Will always be set to FILTER_EXIM for this call */
4958 US"system filter"); /* For error messages */
4960 DEBUG(D_deliver|D_filter) debug_printf("system filter returned %d\n", rc);
4962 if (rc == FF_ERROR || rc == FF_NONEXIST)
4964 (void)close(deliver_datafile);
4965 deliver_datafile = -1;
4966 log_write(0, LOG_MAIN|LOG_PANIC, "Error in system filter: %s",
4967 string_printing(filter_message));
4968 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
4971 /* Reset things. If the filter message is an empty string, which can happen
4972 for a filter "fail" or "freeze" command with no text, reset it to NULL. */
4974 system_filtering = FALSE;
4975 enable_dollar_recipients = FALSE;
4976 if (filter_message != NULL && filter_message[0] == 0) filter_message = NULL;
4978 /* Save the values of the system filter variables so that user filters
4981 memcpy(filter_sn, filter_n, sizeof(filter_sn));
4983 /* The filter can request that delivery of the original addresses be
4988 process_recipients = RECIP_DEFER;
4989 deliver_msglog("Delivery deferred by system filter\n");
4990 log_write(0, LOG_MAIN, "Delivery deferred by system filter");
4993 /* The filter can request that a message be frozen, but this does not
4994 take place if the message has been manually thawed. In that case, we must
4995 unset "delivered", which is forced by the "freeze" command to make -bF
4998 else if (rc == FF_FREEZE && !deliver_manual_thaw)
5000 deliver_freeze = TRUE;
5001 deliver_frozen_at = time(NULL);
5002 process_recipients = RECIP_DEFER;
5003 frozen_info = string_sprintf(" by the system filter%s%s",
5004 (filter_message == NULL)? US"" : US": ",
5005 (filter_message == NULL)? US"" : filter_message);
5008 /* The filter can request that a message be failed. The error message may be
5009 quite long - it is sent back to the sender in the bounce - but we don't want
5010 to fill up the log with repetitions of it. If it starts with << then the text
5011 between << and >> is written to the log, with the rest left for the bounce
5014 else if (rc == FF_FAIL)
5016 uschar *colon = US"";
5017 uschar *logmsg = US"";
5020 process_recipients = RECIP_FAIL_FILTER;
5022 if (filter_message != NULL)
5026 if (filter_message[0] == '<' && filter_message[1] == '<' &&
5027 (logend = Ustrstr(filter_message, ">>")) != NULL)
5029 logmsg = filter_message + 2;
5030 loglen = logend - logmsg;
5031 filter_message = logend + 2;
5032 if (filter_message[0] == 0) filter_message = NULL;
5036 logmsg = filter_message;
5037 loglen = Ustrlen(filter_message);
5041 log_write(0, LOG_MAIN, "cancelled by system filter%s%.*s", colon, loglen,
5045 /* Delivery can be restricted only to those recipients (if any) that the
5046 filter specified. */
5048 else if (rc == FF_DELIVERED)
5050 process_recipients = RECIP_IGNORE;
5051 if (addr_new == NULL)
5052 log_write(0, LOG_MAIN, "=> discarded (system filter)");
5054 log_write(0, LOG_MAIN, "original recipients ignored (system filter)");
5057 /* If any new addresses were created by the filter, fake up a "parent"
5058 for them. This is necessary for pipes, etc., which are expected to have
5059 parents, and it also gives some sensible logging for others. Allow
5060 pipes, files, and autoreplies, and run them as the filter uid if set,
5061 otherwise as the current uid. */
5063 if (addr_new != NULL)
5065 int uid = (system_filter_uid_set)? system_filter_uid : geteuid();
5066 int gid = (system_filter_gid_set)? system_filter_gid : getegid();
5068 /* The text "system-filter" is tested in transport_set_up_command() and in
5069 set_up_shell_command() in the pipe transport, to enable them to permit
5070 $recipients, so don't change it here without also changing it there. */
5072 address_item *p = addr_new;
5073 address_item *parent = deliver_make_addr(US"system-filter", FALSE);
5075 parent->domain = string_copylc(qualify_domain_recipient);
5076 parent->local_part = US"system-filter";
5078 /* As part of this loop, we arrange for addr_last to end up pointing
5079 at the final address. This is used if we go on to add addresses for the
5080 original recipients. */
5084 if (parent->child_count == SHRT_MAX)
5085 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "system filter generated more "
5086 "than %d delivery addresses", SHRT_MAX);
5087 parent->child_count++;
5090 if (testflag(p, af_pfr))
5096 setflag(p, af_uid_set |
5102 /* Find the name of the system filter's appropriate pfr transport */
5104 if (p->address[0] == '|')
5107 tpname = system_filter_pipe_transport;
5108 address_pipe = p->address;
5110 else if (p->address[0] == '>')
5113 tpname = system_filter_reply_transport;
5117 if (p->address[Ustrlen(p->address)-1] == '/')
5119 type = US"directory";
5120 tpname = system_filter_directory_transport;
5125 tpname = system_filter_file_transport;
5127 address_file = p->address;
5130 /* Now find the actual transport, first expanding the name. We have
5131 set address_file or address_pipe above. */
5135 uschar *tmp = expand_string(tpname);
5136 address_file = address_pipe = NULL;
5138 p->message = string_sprintf("failed to expand \"%s\" as a "
5139 "system filter transport name", tpname);
5144 p->message = string_sprintf("system_filter_%s_transport is unset",
5150 transport_instance *tp;
5151 for (tp = transports; tp != NULL; tp = tp->next)
5153 if (Ustrcmp(tp->name, tpname) == 0)
5160 p->message = string_sprintf("failed to find \"%s\" transport "
5161 "for system filter delivery", tpname);
5164 /* If we couldn't set up a transport, defer the delivery, putting the
5165 error on the panic log as well as the main log. */
5167 if (p->transport == NULL)
5169 address_item *badp = p;
5171 if (addr_last == NULL) addr_new = p; else addr_last->next = p;
5172 badp->local_part = badp->address; /* Needed for log line */
5173 post_process_one(badp, DEFER, LOG_MAIN|LOG_PANIC, DTYPE_ROUTER, 0);
5176 } /* End of pfr handling */
5178 /* Either a non-pfr delivery, or we found a transport */
5180 DEBUG(D_deliver|D_filter)
5181 debug_printf("system filter added %s\n", p->address);
5185 } /* Loop through all addr_new addresses */
5190 /* Scan the recipients list, and for every one that is not in the non-
5191 recipients tree, add an addr item to the chain of new addresses. If the pno
5192 value is non-negative, we must set the onetime parent from it. This which
5193 points to the relevant entry in the recipients list.
5195 This processing can be altered by the setting of the process_recipients
5196 variable, which is changed if recipients are to be ignored, failed, or
5197 deferred. This can happen as a result of system filter activity, or if the -Mg
5198 option is used to fail all of them.
5200 Duplicate addresses are handled later by a different tree structure; we can't
5201 just extend the non-recipients tree, because that will be re-written to the
5202 spool if the message is deferred, and in any case there are casing
5203 complications for local addresses. */
5205 if (process_recipients != RECIP_IGNORE)
5207 for (i = 0; i < recipients_count; i++)
5209 if (tree_search(tree_nonrecipients, recipients_list[i].address) == NULL)
5211 recipient_item *r = recipients_list + i;
5212 address_item *new = deliver_make_addr(r->address, FALSE);
5213 new->p.errors_address = r->errors_to;
5216 new->onetime_parent = recipients_list[r->pno].address;
5218 switch (process_recipients)
5220 /* RECIP_DEFER is set when a system filter freezes a message. */
5223 new->next = addr_defer;
5228 /* RECIP_FAIL_FILTER is set when a system filter has obeyed a "fail"
5231 case RECIP_FAIL_FILTER:
5233 (filter_message == NULL)? US"delivery cancelled" : filter_message;
5234 setflag(new, af_pass_message);
5235 goto RECIP_QUEUE_FAILED; /* below */
5238 /* RECIP_FAIL_TIMEOUT is set when a message is frozen, but is older
5239 than the value in timeout_frozen_after. Treat non-bounce messages
5240 similarly to -Mg; for bounce messages we just want to discard, so
5241 don't put the address on the failed list. The timeout has already
5244 case RECIP_FAIL_TIMEOUT:
5245 new->message = US"delivery cancelled; message timed out";
5246 goto RECIP_QUEUE_FAILED; /* below */
5249 /* RECIP_FAIL is set when -Mg has been used. */
5252 new->message = US"delivery cancelled by administrator";
5255 /* Common code for the failure cases above. If this is not a bounce
5256 message, put the address on the failed list so that it is used to
5257 create a bounce. Otherwise do nothing - this just discards the address.
5258 The incident has already been logged. */
5261 if (sender_address[0] != 0)
5263 new->next = addr_failed;
5269 /* RECIP_FAIL_LOOP is set when there are too many Received: headers
5270 in the message. Process each address as a routing failure; if this
5271 is a bounce message, it will get frozen. */
5273 case RECIP_FAIL_LOOP:
5274 new->message = US"Too many \"Received\" headers - suspected mail loop";
5275 post_process_one(new, FAIL, LOG_MAIN, DTYPE_ROUTER, 0);
5279 /* Value should be RECIP_ACCEPT; take this as the safe default. */
5282 if (addr_new == NULL) addr_new = new; else addr_last->next = new;
5292 address_item *p = addr_new;
5293 debug_printf("Delivery address list:\n");
5296 debug_printf(" %s %s\n", p->address, (p->onetime_parent == NULL)? US"" :
5302 /* Set up the buffers used for copying over the file when delivering. */
5304 deliver_in_buffer = store_malloc(DELIVER_IN_BUFFER_SIZE);
5305 deliver_out_buffer = store_malloc(DELIVER_OUT_BUFFER_SIZE);
5309 /* Until there are no more new addresses, handle each one as follows:
5311 . If this is a generated address (indicated by the presence of a parent
5312 pointer) then check to see whether it is a pipe, file, or autoreply, and
5313 if so, handle it directly here. The router that produced the address will
5314 have set the allow flags into the address, and also set the uid/gid required.
5315 Having the routers generate new addresses and then checking them here at
5316 the outer level is tidier than making each router do the checking, and
5317 means that routers don't need access to the failed address queue.
5319 . Break up the address into local part and domain, and make lowercased
5320 versions of these strings. We also make unquoted versions of the local part.
5322 . Handle the percent hack for those domains for which it is valid.
5324 . For child addresses, determine if any of the parents have the same address.
5325 If so, generate a different string for previous delivery checking. Without
5326 this code, if the address spqr generates spqr via a forward or alias file,
5327 delivery of the generated spqr stops further attempts at the top level spqr,
5328 which is not what is wanted - it may have generated other addresses.
5330 . Check on the retry database to see if routing was previously deferred, but
5331 only if in a queue run. Addresses that are to be routed are put on the
5332 addr_route chain. Addresses that are to be deferred are put on the
5333 addr_defer chain. We do all the checking first, so as not to keep the
5334 retry database open any longer than necessary.
5336 . Now we run the addresses through the routers. A router may put the address
5337 on either the addr_local or the addr_remote chain for local or remote
5338 delivery, respectively, or put it on the addr_failed chain if it is
5339 undeliveable, or it may generate child addresses and put them on the
5340 addr_new chain, or it may defer an address. All the chain anchors are
5341 passed as arguments so that the routers can be called for verification
5344 . If new addresses have been generated by the routers, da capo.
5347 header_rewritten = FALSE; /* No headers rewritten yet */
5348 while (addr_new != NULL) /* Loop until all addresses dealt with */
5350 address_item *addr, *parent;
5351 dbm_file = dbfn_open(US"retry", O_RDONLY, &dbblock, FALSE);
5353 /* Failure to open the retry database is treated the same as if it does
5354 not exist. In both cases, dbm_file is NULL. */
5356 if (dbm_file == NULL)
5358 DEBUG(D_deliver|D_retry|D_route|D_hints_lookup)
5359 debug_printf("no retry data available\n");
5362 /* Scan the current batch of new addresses, to handle pipes, files and
5363 autoreplies, and determine which others are ready for routing. */
5365 while (addr_new != NULL)
5370 dbdata_retry *domain_retry_record;
5371 dbdata_retry *address_retry_record;
5374 addr_new = addr->next;
5376 DEBUG(D_deliver|D_retry|D_route)
5378 debug_printf(">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>\n");
5379 debug_printf("Considering: %s\n", addr->address);
5382 /* Handle generated address that is a pipe or a file or an autoreply. */
5384 if (testflag(addr, af_pfr))
5386 /* If an autoreply in a filter could not generate a syntactically valid
5387 address, give up forthwith. Set af_ignore_error so that we don't try to
5388 generate a bounce. */
5390 if (testflag(addr, af_bad_reply))
5392 addr->basic_errno = ERRNO_BADADDRESS2;
5393 addr->local_part = addr->address;
5395 US"filter autoreply generated syntactically invalid recipient";
5396 setflag(addr, af_ignore_error);
5397 (void)post_process_one(addr, FAIL, LOG_MAIN, DTYPE_ROUTER, 0);
5398 continue; /* with the next new address */
5401 /* If two different users specify delivery to the same pipe or file or
5402 autoreply, there should be two different deliveries, so build a unique
5403 string that incorporates the original address, and use this for
5404 duplicate testing and recording delivery, and also for retrying. */
5407 string_sprintf("%s:%s", addr->address, addr->parent->unique +
5408 (testflag(addr->parent, af_homonym)? 3:0));
5410 addr->address_retry_key = addr->domain_retry_key =
5411 string_sprintf("T:%s", addr->unique);
5413 /* If a filter file specifies two deliveries to the same pipe or file,
5414 we want to de-duplicate, but this is probably not wanted for two mail
5415 commands to the same address, where probably both should be delivered.
5416 So, we have to invent a different unique string in that case. Just
5417 keep piling '>' characters on the front. */
5419 if (addr->address[0] == '>')
5421 while (tree_search(tree_duplicates, addr->unique) != NULL)
5422 addr->unique = string_sprintf(">%s", addr->unique);
5425 else if ((tnode = tree_search(tree_duplicates, addr->unique)) != NULL)
5427 DEBUG(D_deliver|D_route)
5428 debug_printf("%s is a duplicate address: discarded\n", addr->address);
5429 addr->dupof = tnode->data.ptr;
5430 addr->next = addr_duplicate;
5431 addr_duplicate = addr;
5435 DEBUG(D_deliver|D_route) debug_printf("unique = %s\n", addr->unique);
5437 /* Check for previous delivery */
5439 if (tree_search(tree_nonrecipients, addr->unique) != NULL)
5441 DEBUG(D_deliver|D_route)
5442 debug_printf("%s was previously delivered: discarded\n", addr->address);
5443 child_done(addr, tod_stamp(tod_log));
5447 /* Save for checking future duplicates */
5449 tree_add_duplicate(addr->unique, addr);
5451 /* Set local part and domain */
5453 addr->local_part = addr->address;
5454 addr->domain = addr->parent->domain;
5456 /* Ensure that the delivery is permitted. */
5458 if (testflag(addr, af_file))
5460 if (!testflag(addr, af_allow_file))
5462 addr->basic_errno = ERRNO_FORBIDFILE;
5463 addr->message = US"delivery to file forbidden";
5464 (void)post_process_one(addr, FAIL, LOG_MAIN, DTYPE_ROUTER, 0);
5465 continue; /* with the next new address */
5468 else if (addr->address[0] == '|')
5470 if (!testflag(addr, af_allow_pipe))
5472 addr->basic_errno = ERRNO_FORBIDPIPE;
5473 addr->message = US"delivery to pipe forbidden";
5474 (void)post_process_one(addr, FAIL, LOG_MAIN, DTYPE_ROUTER, 0);
5475 continue; /* with the next new address */
5478 else if (!testflag(addr, af_allow_reply))
5480 addr->basic_errno = ERRNO_FORBIDREPLY;
5481 addr->message = US"autoreply forbidden";
5482 (void)post_process_one(addr, FAIL, LOG_MAIN, DTYPE_ROUTER, 0);
5483 continue; /* with the next new address */
5486 /* If the errno field is already set to BADTRANSPORT, it indicates
5487 failure to expand a transport string, or find the associated transport,
5488 or an unset transport when one is required. Leave this test till now so
5489 that the forbid errors are given in preference. */
5491 if (addr->basic_errno == ERRNO_BADTRANSPORT)
5493 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_ROUTER, 0);
5497 /* Treat /dev/null as a special case and abandon the delivery. This
5498 avoids having to specify a uid on the transport just for this case.
5499 Arrange for the transport name to be logged as "**bypassed**". */
5501 if (Ustrcmp(addr->address, "/dev/null") == 0)
5503 uschar *save = addr->transport->name;
5504 addr->transport->name = US"**bypassed**";
5505 (void)post_process_one(addr, OK, LOG_MAIN, DTYPE_TRANSPORT, '=');
5506 addr->transport->name = save;
5507 continue; /* with the next new address */
5510 /* Pipe, file, or autoreply delivery is to go ahead as a normal local
5513 DEBUG(D_deliver|D_route)
5514 debug_printf("queued for %s transport\n", addr->transport->name);
5515 addr->next = addr_local;
5517 continue; /* with the next new address */
5520 /* Handle normal addresses. First, split up into local part and domain,
5521 handling the %-hack if necessary. There is the possibility of a defer from
5522 a lookup in percent_hack_domains. */
5524 if ((rc = deliver_split_address(addr)) == DEFER)
5526 addr->message = US"cannot check percent_hack_domains";
5527 addr->basic_errno = ERRNO_LISTDEFER;
5528 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_NONE, 0);
5532 /* Check to see if the domain is held. If so, proceed only if the
5533 delivery was forced by hand. */
5535 deliver_domain = addr->domain; /* set $domain */
5536 if (!forced && hold_domains != NULL &&
5537 (rc = match_isinlist(addr->domain, &hold_domains, 0,
5538 &domainlist_anchor, addr->domain_cache, MCL_DOMAIN, TRUE,
5543 addr->message = US"hold_domains lookup deferred";
5544 addr->basic_errno = ERRNO_LISTDEFER;
5548 addr->message = US"domain is held";
5549 addr->basic_errno = ERRNO_HELD;
5551 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_NONE, 0);
5555 /* Now we can check for duplicates and previously delivered addresses. In
5556 order to do this, we have to generate a "unique" value for each address,
5557 because there may be identical actual addresses in a line of descendents.
5558 The "unique" field is initialized to the same value as the "address" field,
5559 but gets changed here to cope with identically-named descendents. */
5561 for (parent = addr->parent; parent != NULL; parent = parent->parent)
5562 if (strcmpic(addr->address, parent->address) == 0) break;
5564 /* If there's an ancestor with the same name, set the homonym flag. This
5565 influences how deliveries are recorded. Then add a prefix on the front of
5566 the unique address. We use \n\ where n starts at 0 and increases each time.
5567 It is unlikely to pass 9, but if it does, it may look odd but will still
5568 work. This means that siblings or cousins with the same names are treated
5569 as duplicates, which is what we want. */
5573 setflag(addr, af_homonym);
5574 if (parent->unique[0] != '\\')
5575 addr->unique = string_sprintf("\\0\\%s", addr->address);
5577 addr->unique = string_sprintf("\\%c\\%s", parent->unique[1] + 1,
5581 /* Ensure that the domain in the unique field is lower cased, because
5582 domains are always handled caselessly. */
5584 p = Ustrrchr(addr->unique, '@');
5585 while (*p != 0) { *p = tolower(*p); p++; }
5587 DEBUG(D_deliver|D_route) debug_printf("unique = %s\n", addr->unique);
5589 if (tree_search(tree_nonrecipients, addr->unique) != NULL)
5591 DEBUG(D_deliver|D_route)
5592 debug_printf("%s was previously delivered: discarded\n", addr->unique);
5593 child_done(addr, tod_stamp(tod_log));
5597 /* Get the routing retry status, saving the two retry keys (with and
5598 without the local part) for subsequent use. If there is no retry record for
5599 the standard address routing retry key, we look for the same key with the
5600 sender attached, because this form is used by the smtp transport after a
5601 4xx response to RCPT when address_retry_include_sender is true. */
5603 addr->domain_retry_key = string_sprintf("R:%s", addr->domain);
5604 addr->address_retry_key = string_sprintf("R:%s@%s", addr->local_part,
5607 if (dbm_file == NULL)
5608 domain_retry_record = address_retry_record = NULL;
5611 domain_retry_record = dbfn_read(dbm_file, addr->domain_retry_key);
5612 if (domain_retry_record != NULL &&
5613 now - domain_retry_record->time_stamp > retry_data_expire)
5614 domain_retry_record = NULL; /* Ignore if too old */
5616 address_retry_record = dbfn_read(dbm_file, addr->address_retry_key);
5617 if (address_retry_record != NULL &&
5618 now - address_retry_record->time_stamp > retry_data_expire)
5619 address_retry_record = NULL; /* Ignore if too old */
5621 if (address_retry_record == NULL)
5623 uschar *altkey = string_sprintf("%s:<%s>", addr->address_retry_key,
5625 address_retry_record = dbfn_read(dbm_file, altkey);
5626 if (address_retry_record != NULL &&
5627 now - address_retry_record->time_stamp > retry_data_expire)
5628 address_retry_record = NULL; /* Ignore if too old */
5632 DEBUG(D_deliver|D_retry)
5634 if (domain_retry_record == NULL)
5635 debug_printf("no domain retry record\n");
5636 if (address_retry_record == NULL)
5637 debug_printf("no address retry record\n");
5640 /* If we are sending a message down an existing SMTP connection, we must
5641 assume that the message which created the connection managed to route
5642 an address to that connection. We do not want to run the risk of taking
5643 a long time over routing here, because if we do, the server at the other
5644 end of the connection may time it out. This is especially true for messages
5645 with lots of addresses. For this kind of delivery, queue_running is not
5646 set, so we would normally route all addresses. We take a pragmatic approach
5647 and defer routing any addresses that have any kind of domain retry record.
5648 That is, we don't even look at their retry times. It doesn't matter if this
5649 doesn't work occasionally. This is all just an optimization, after all.
5651 The reason for not doing the same for address retries is that they normally
5652 arise from 4xx responses, not DNS timeouts. */
5654 if (continue_hostname != NULL && domain_retry_record != NULL)
5656 addr->message = US"reusing SMTP connection skips previous routing defer";
5657 addr->basic_errno = ERRNO_RRETRY;
5658 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_ROUTER, 0);
5661 /* If we are in a queue run, defer routing unless there is no retry data or
5662 we've passed the next retry time, or this message is forced. In other
5663 words, ignore retry data when not in a queue run.
5665 However, if the domain retry time has expired, always allow the routing
5666 attempt. If it fails again, the address will be failed. This ensures that
5667 each address is routed at least once, even after long-term routing
5670 If there is an address retry, check that too; just wait for the next
5671 retry time. This helps with the case when the temporary error on the
5672 address was really message-specific rather than address specific, since
5673 it allows other messages through.
5675 We also wait for the next retry time if this is a message sent down an
5676 existing SMTP connection (even though that will be forced). Otherwise there
5677 will be far too many attempts for an address that gets a 4xx error. In
5678 fact, after such an error, we should not get here because, the host should
5679 not be remembered as one this message needs. However, there was a bug that
5680 used to cause this to happen, so it is best to be on the safe side.
5682 Even if we haven't reached the retry time in the hints, there is one more
5683 check to do, which is for the ultimate address timeout. We only do this
5684 check if there is an address retry record and there is not a domain retry
5685 record; this implies that previous attempts to handle the address had the
5686 retry_use_local_parts option turned on. We use this as an approximation
5687 for the destination being like a local delivery, for example delivery over
5688 LMTP to an IMAP message store. In this situation users are liable to bump
5689 into their quota and thereby have intermittently successful deliveries,
5690 which keep the retry record fresh, which can lead to us perpetually
5691 deferring messages. */
5693 else if (((queue_running && !deliver_force) || continue_hostname != NULL)
5695 ((domain_retry_record != NULL &&
5696 now < domain_retry_record->next_try &&
5697 !domain_retry_record->expired)
5699 (address_retry_record != NULL &&
5700 now < address_retry_record->next_try))
5702 (domain_retry_record != NULL ||
5703 address_retry_record == NULL ||
5704 !retry_ultimate_address_timeout(addr->address_retry_key,
5705 addr->domain, address_retry_record, now)))
5707 addr->message = US"retry time not reached";
5708 addr->basic_errno = ERRNO_RRETRY;
5709 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_ROUTER, 0);
5712 /* The domain is OK for routing. Remember if retry data exists so it
5713 can be cleaned up after a successful delivery. */
5717 if (domain_retry_record != NULL || address_retry_record != NULL)
5718 setflag(addr, af_dr_retry_exists);
5719 addr->next = addr_route;
5721 DEBUG(D_deliver|D_route)
5722 debug_printf("%s: queued for routing\n", addr->address);
5726 /* The database is closed while routing is actually happening. Requests to
5727 update it are put on a chain and all processed together at the end. */
5729 if (dbm_file != NULL) dbfn_close(dbm_file);
5731 /* If queue_domains is set, we don't even want to try routing addresses in
5732 those domains. During queue runs, queue_domains is forced to be unset.
5733 Optimize by skipping this pass through the addresses if nothing is set. */
5735 if (!deliver_force && queue_domains != NULL)
5737 address_item *okaddr = NULL;
5738 while (addr_route != NULL)
5740 address_item *addr = addr_route;
5741 addr_route = addr->next;
5743 deliver_domain = addr->domain; /* set $domain */
5744 if ((rc = match_isinlist(addr->domain, &queue_domains, 0,
5745 &domainlist_anchor, addr->domain_cache, MCL_DOMAIN, TRUE, NULL))
5750 addr->basic_errno = ERRNO_LISTDEFER;
5751 addr->message = US"queue_domains lookup deferred";
5752 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_ROUTER, 0);
5756 addr->next = okaddr;
5762 addr->basic_errno = ERRNO_QUEUE_DOMAIN;
5763 addr->message = US"domain is in queue_domains";
5764 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_ROUTER, 0);
5768 addr_route = okaddr;
5771 /* Now route those addresses that are not deferred. */
5773 while (addr_route != NULL)
5776 address_item *addr = addr_route;
5777 uschar *old_domain = addr->domain;
5778 uschar *old_unique = addr->unique;
5779 addr_route = addr->next;
5782 /* Just in case some router parameter refers to it. */
5784 return_path = (addr->p.errors_address != NULL)?
5785 addr->p.errors_address : sender_address;
5787 /* If a router defers an address, add a retry item. Whether or not to
5788 use the local part in the key is a property of the router. */
5790 if ((rc = route_address(addr, &addr_local, &addr_remote, &addr_new,
5791 &addr_succeed, v_none)) == DEFER)
5792 retry_add_item(addr, (addr->router->retry_use_local_part)?
5793 string_sprintf("R:%s@%s", addr->local_part, addr->domain) :
5794 string_sprintf("R:%s", addr->domain), 0);
5796 /* Otherwise, if there is an existing retry record in the database, add
5797 retry items to delete both forms. We must also allow for the possibility
5798 of a routing retry that includes the sender address. Since the domain might
5799 have been rewritten (expanded to fully qualified) as a result of routing,
5800 ensure that the rewritten form is also deleted. */
5802 else if (testflag(addr, af_dr_retry_exists))
5804 uschar *altkey = string_sprintf("%s:<%s>", addr->address_retry_key,
5806 retry_add_item(addr, altkey, rf_delete);
5807 retry_add_item(addr, addr->address_retry_key, rf_delete);
5808 retry_add_item(addr, addr->domain_retry_key, rf_delete);
5809 if (Ustrcmp(addr->domain, old_domain) != 0)
5810 retry_add_item(addr, string_sprintf("R:%s", old_domain), rf_delete);
5813 /* DISCARD is given for :blackhole: and "seen finish". The event has been
5814 logged, but we need to ensure the address (and maybe parents) is marked
5819 address_done(addr, tod_stamp(tod_log));
5820 continue; /* route next address */
5823 /* The address is finished with (failed or deferred). */
5827 (void)post_process_one(addr, rc, LOG_MAIN, DTYPE_ROUTER, 0);
5828 continue; /* route next address */
5831 /* The address has been routed. If the router changed the domain, it will
5832 also have changed the unique address. We have to test whether this address
5833 has already been delivered, because it's the unique address that finally
5836 if (addr->unique != old_unique &&
5837 tree_search(tree_nonrecipients, addr->unique) != 0)
5839 DEBUG(D_deliver|D_route) debug_printf("%s was previously delivered: "
5840 "discarded\n", addr->address);
5841 if (addr_remote == addr) addr_remote = addr->next;
5842 else if (addr_local == addr) addr_local = addr->next;
5845 /* If the router has same_domain_copy_routing set, we are permitted to copy
5846 the routing for any other addresses with the same domain. This is an
5847 optimisation to save repeated DNS lookups for "standard" remote domain
5848 routing. The option is settable only on routers that generate host lists.
5849 We play it very safe, and do the optimization only if the address is routed
5850 to a remote transport, there are no header changes, and the domain was not
5851 modified by the router. */
5853 if (addr_remote == addr &&
5854 addr->router->same_domain_copy_routing &&
5855 addr->p.extra_headers == NULL &&
5856 addr->p.remove_headers == NULL &&
5857 old_domain == addr->domain)
5859 address_item **chain = &addr_route;
5860 while (*chain != NULL)
5862 address_item *addr2 = *chain;
5863 if (Ustrcmp(addr2->domain, addr->domain) != 0)
5865 chain = &(addr2->next);
5869 /* Found a suitable address; take it off the routing list and add it to
5870 the remote delivery list. */
5872 *chain = addr2->next;
5873 addr2->next = addr_remote;
5874 addr_remote = addr2;
5876 /* Copy the routing data */
5878 addr2->domain = addr->domain;
5879 addr2->router = addr->router;
5880 addr2->transport = addr->transport;
5881 addr2->host_list = addr->host_list;
5882 addr2->fallback_hosts = addr->fallback_hosts;
5883 addr2->p.errors_address = addr->p.errors_address;
5884 copyflag(addr2, addr, af_hide_child | af_local_host_removed);
5886 DEBUG(D_deliver|D_route)
5888 debug_printf(">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>\n"
5890 "Routing for %s copied from %s\n",
5891 addr2->address, addr2->address, addr->address);
5895 } /* Continue with routing the next address. */
5896 } /* Loop to process any child addresses that the routers created, and
5897 any rerouted addresses that got put back on the new chain. */
5900 /* Debugging: show the results of the routing */
5902 DEBUG(D_deliver|D_retry|D_route)
5904 address_item *p = addr_local;
5905 debug_printf(">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>\n");
5906 debug_printf("After routing:\n Local deliveries:\n");
5909 debug_printf(" %s\n", p->address);
5914 debug_printf(" Remote deliveries:\n");
5917 debug_printf(" %s\n", p->address);
5922 debug_printf(" Failed addresses:\n");
5925 debug_printf(" %s\n", p->address);
5930 debug_printf(" Deferred addresses:\n");
5933 debug_printf(" %s\n", p->address);
5938 /* Free any resources that were cached during routing. */
5943 /* These two variables are set only during routing, after check_local_user.
5944 Ensure they are not set in transports. */
5946 local_user_gid = (gid_t)(-1);
5947 local_user_uid = (uid_t)(-1);
5949 /* Check for any duplicate addresses. This check is delayed until after
5950 routing, because the flexibility of the routing configuration means that
5951 identical addresses with different parentage may end up being redirected to
5952 different addresses. Checking for duplicates too early (as we previously used
5953 to) makes this kind of thing not work. */
5955 do_duplicate_check(&addr_local);
5956 do_duplicate_check(&addr_remote);
5958 /* When acting as an MUA wrapper, we proceed only if all addresses route to a
5959 remote transport. The check that they all end up in one transaction happens in
5960 the do_remote_deliveries() function. */
5962 if (mua_wrapper && (addr_local != NULL || addr_failed != NULL ||
5963 addr_defer != NULL))
5966 uschar *which, *colon, *msg;
5968 if (addr_local != NULL)
5973 else if (addr_defer != NULL)
5976 which = US"deferred";
5984 while (addr->parent != NULL) addr = addr->parent;
5986 if (addr->message != NULL)
5989 msg = addr->message;
5991 else colon = msg = US"";
5993 /* We don't need to log here for a forced failure as it will already
5994 have been logged. Defer will also have been logged, but as a defer, so we do
5995 need to do the failure logging. */
5997 if (addr != addr_failed)
5998 log_write(0, LOG_MAIN, "** %s routing yielded a %s delivery",
5999 addr->address, which);
6001 /* Always write an error to the caller */
6003 fprintf(stderr, "routing %s yielded a %s delivery%s%s\n", addr->address,
6006 final_yield = DELIVER_MUA_FAILED;
6007 addr_failed = addr_defer = NULL; /* So that we remove the message */
6008 goto DELIVERY_TIDYUP;
6012 /* If this is a run to continue deliveries to an external channel that is
6013 already set up, defer any local deliveries. */
6015 if (continue_transport != NULL)
6017 if (addr_defer == NULL) addr_defer = addr_local; else
6019 address_item *addr = addr_defer;
6020 while (addr->next != NULL) addr = addr->next;
6021 addr->next = addr_local;
6027 /* Because address rewriting can happen in the routers, we should not really do
6028 ANY deliveries until all addresses have been routed, so that all recipients of
6029 the message get the same headers. However, this is in practice not always
6030 possible, since sometimes remote addresses give DNS timeouts for days on end.
6031 The pragmatic approach is to deliver what we can now, saving any rewritten
6032 headers so that at least the next lot of recipients benefit from the rewriting
6033 that has already been done.
6035 If any headers have been rewritten during routing, update the spool file to
6036 remember them for all subsequent deliveries. This can be delayed till later if
6037 there is only address to be delivered - if it succeeds the spool write need not
6040 if (header_rewritten &&
6041 ((addr_local != NULL &&
6042 (addr_local->next != NULL || addr_remote != NULL)) ||
6043 (addr_remote != NULL && addr_remote->next != NULL)))
6045 /* Panic-dies on error */
6046 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
6047 header_rewritten = FALSE;
6051 /* If there are any deliveries to be done, open the journal file. This is used
6052 to record successful deliveries as soon as possible after each delivery is
6053 known to be complete. A file opened with O_APPEND is used so that several
6054 processes can run simultaneously.
6056 The journal is just insurance against crashes. When the spool file is
6057 ultimately updated at the end of processing, the journal is deleted. If a
6058 journal is found to exist at the start of delivery, the addresses listed
6059 therein are added to the non-recipients. */
6061 if (addr_local != NULL || addr_remote != NULL)
6063 sprintf(CS spoolname, "%s/input/%s/%s-J", spool_directory, message_subdir, id);
6064 journal_fd = Uopen(spoolname, O_WRONLY|O_APPEND|O_CREAT, SPOOL_MODE);
6068 log_write(0, LOG_MAIN|LOG_PANIC, "Couldn't open journal file %s: %s",
6069 spoolname, strerror(errno));
6070 return DELIVER_NOT_ATTEMPTED;
6073 /* Set the close-on-exec flag, make the file owned by Exim, and ensure
6074 that the mode is correct - the group setting doesn't always seem to get
6075 set automatically. */
6077 if( fcntl(journal_fd, F_SETFD, fcntl(journal_fd, F_GETFD) | FD_CLOEXEC)
6078 || fchown(journal_fd, exim_uid, exim_gid)
6079 || fchmod(journal_fd, SPOOL_MODE)
6082 int ret = Uunlink(spoolname);
6083 log_write(0, LOG_MAIN|LOG_PANIC, "Couldn't set perms on journal file %s: %s",
6084 spoolname, strerror(errno));
6085 if(ret && errno != ENOENT)
6086 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s",
6087 spoolname, strerror(errno));
6088 return DELIVER_NOT_ATTEMPTED;
6094 /* Now we can get down to the business of actually doing deliveries. Local
6095 deliveries are done first, then remote ones. If ever the problems of how to
6096 handle fallback transports are figured out, this section can be put into a loop
6097 for handling fallbacks, though the uid switching will have to be revised. */
6099 /* Precompile a regex that is used to recognize a parameter in response
6100 to an LHLO command, if is isn't already compiled. This may be used on both
6101 local and remote LMTP deliveries. */
6103 if (regex_IGNOREQUOTA == NULL) regex_IGNOREQUOTA =
6104 regex_must_compile(US"\\n250[\\s\\-]IGNOREQUOTA(\\s|\\n|$)", FALSE, TRUE);
6106 /* Handle local deliveries */
6108 if (addr_local != NULL)
6110 DEBUG(D_deliver|D_transport)
6111 debug_printf(">>>>>>>>>>>>>>>> Local deliveries >>>>>>>>>>>>>>>>\n");
6112 do_local_deliveries();
6113 disable_logging = FALSE;
6116 /* If queue_run_local is set, we do not want to attempt any remote deliveries,
6117 so just queue them all. */
6119 if (queue_run_local)
6121 while (addr_remote != NULL)
6123 address_item *addr = addr_remote;
6124 addr_remote = addr->next;
6126 addr->basic_errno = ERRNO_LOCAL_ONLY;
6127 addr->message = US"remote deliveries suppressed";
6128 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_TRANSPORT, 0);
6132 /* Handle remote deliveries */
6134 if (addr_remote != NULL)
6136 DEBUG(D_deliver|D_transport)
6137 debug_printf(">>>>>>>>>>>>>>>> Remote deliveries >>>>>>>>>>>>>>>>\n");
6139 /* Precompile some regex that are used to recognize parameters in response
6140 to an EHLO command, if they aren't already compiled. */
6142 if (regex_PIPELINING == NULL) regex_PIPELINING =
6143 regex_must_compile(US"\\n250[\\s\\-]PIPELINING(\\s|\\n|$)", FALSE, TRUE);
6145 if (regex_SIZE == NULL) regex_SIZE =
6146 regex_must_compile(US"\\n250[\\s\\-]SIZE(\\s|\\n|$)", FALSE, TRUE);
6148 if (regex_AUTH == NULL) regex_AUTH =
6149 regex_must_compile(US"\\n250[\\s\\-]AUTH\\s+([\\-\\w\\s]+)(?:\\n|$)",
6153 if (regex_STARTTLS == NULL) regex_STARTTLS =
6154 regex_must_compile(US"\\n250[\\s\\-]STARTTLS(\\s|\\n|$)", FALSE, TRUE);
6157 #ifdef EXPERIMENTAL_PRDR
6158 if (regex_PRDR == NULL) regex_PRDR =
6159 regex_must_compile(US"\\n250[\\s\\-]PRDR(\\s|\\n|$)", FALSE, TRUE);
6162 /* Now sort the addresses if required, and do the deliveries. The yield of
6163 do_remote_deliveries is FALSE when mua_wrapper is set and all addresses
6164 cannot be delivered in one transaction. */
6166 if (remote_sort_domains != NULL) sort_remote_deliveries();
6167 if (!do_remote_deliveries(FALSE))
6169 log_write(0, LOG_MAIN, "** mua_wrapper is set but recipients cannot all "
6170 "be delivered in one transaction");
6171 fprintf(stderr, "delivery to smarthost failed (configuration problem)\n");
6173 final_yield = DELIVER_MUA_FAILED;
6174 addr_failed = addr_defer = NULL; /* So that we remove the message */
6175 goto DELIVERY_TIDYUP;
6178 /* See if any of the addresses that failed got put on the queue for delivery
6179 to their fallback hosts. We do it this way because often the same fallback
6180 host is used for many domains, so all can be sent in a single transaction
6181 (if appropriately configured). */
6183 if (addr_fallback != NULL && !mua_wrapper)
6185 DEBUG(D_deliver) debug_printf("Delivering to fallback hosts\n");
6186 addr_remote = addr_fallback;
6187 addr_fallback = NULL;
6188 if (remote_sort_domains != NULL) sort_remote_deliveries();
6189 do_remote_deliveries(TRUE);
6191 disable_logging = FALSE;
6195 /* All deliveries are now complete. Ignore SIGTERM during this tidying up
6196 phase, to minimize cases of half-done things. */
6199 debug_printf(">>>>>>>>>>>>>>>> deliveries are done >>>>>>>>>>>>>>>>\n");
6201 /* Root privilege is no longer needed */
6203 exim_setugid(exim_uid, exim_gid, FALSE, US"post-delivery tidying");
6205 set_process_info("tidying up after delivering %s", message_id);
6206 signal(SIGTERM, SIG_IGN);
6208 /* When we are acting as an MUA wrapper, the smtp transport will either have
6209 succeeded for all addresses, or failed them all in normal cases. However, there
6210 are some setup situations (e.g. when a named port does not exist) that cause an
6211 immediate exit with deferral of all addresses. Convert those into failures. We
6212 do not ever want to retry, nor do we want to send a bounce message. */
6216 if (addr_defer != NULL)
6218 address_item *addr, *nextaddr;
6219 for (addr = addr_defer; addr != NULL; addr = nextaddr)
6221 log_write(0, LOG_MAIN, "** %s mua_wrapper forced failure for deferred "
6222 "delivery", addr->address);
6223 nextaddr = addr->next;
6224 addr->next = addr_failed;
6230 /* Now all should either have succeeded or failed. */
6232 if (addr_failed == NULL) final_yield = DELIVER_MUA_SUCCEEDED; else
6234 uschar *s = (addr_failed->user_message != NULL)?
6235 addr_failed->user_message : addr_failed->message;
6237 fprintf(stderr, "Delivery failed: ");
6238 if (addr_failed->basic_errno > 0)
6240 fprintf(stderr, "%s", strerror(addr_failed->basic_errno));
6241 if (s != NULL) fprintf(stderr, ": ");
6245 if (addr_failed->basic_errno <= 0) fprintf(stderr, "unknown error");
6247 else fprintf(stderr, "%s", CS s);
6248 fprintf(stderr, "\n");
6250 final_yield = DELIVER_MUA_FAILED;
6255 /* In a normal configuration, we now update the retry database. This is done in
6256 one fell swoop at the end in order not to keep opening and closing (and
6257 locking) the database. The code for handling retries is hived off into a
6258 separate module for convenience. We pass it the addresses of the various
6259 chains, because deferred addresses can get moved onto the failed chain if the
6260 retry cutoff time has expired for all alternative destinations. Bypass the
6261 updating of the database if the -N flag is set, which is a debugging thing that
6262 prevents actual delivery. */
6264 else if (!dont_deliver) retry_update(&addr_defer, &addr_failed, &addr_succeed);
6266 /* If any addresses failed, we must send a message to somebody, unless
6267 af_ignore_error is set, in which case no action is taken. It is possible for
6268 several messages to get sent if there are addresses with different
6271 while (addr_failed != NULL)
6275 uschar *logtod = tod_stamp(tod_log);
6277 address_item *handled_addr = NULL;
6278 address_item **paddr;
6279 address_item *msgchain = NULL;
6280 address_item **pmsgchain = &msgchain;
6282 /* There are weird cases when logging is disabled in the transport. However,
6283 there may not be a transport (address failed by a router). */
6285 disable_logging = FALSE;
6286 if (addr_failed->transport != NULL)
6287 disable_logging = addr_failed->transport->disable_logging;
6290 debug_printf("processing failed address %s\n", addr_failed->address);
6292 /* There are only two ways an address in a bounce message can get here:
6294 (1) When delivery was initially deferred, but has now timed out (in the call
6295 to retry_update() above). We can detect this by testing for
6296 af_retry_timedout. If the address does not have its own errors address,
6297 we arrange to ignore the error.
6299 (2) If delivery failures for bounce messages are being ignored. We can detect
6300 this by testing for af_ignore_error. This will also be set if a bounce
6301 message has been autothawed and the ignore_bounce_errors_after time has
6302 passed. It might also be set if a router was explicitly configured to
6303 ignore errors (errors_to = "").
6305 If neither of these cases obtains, something has gone wrong. Log the
6306 incident, but then ignore the error. */
6308 if (sender_address[0] == 0 && addr_failed->p.errors_address == NULL)
6310 if (!testflag(addr_failed, af_retry_timedout) &&
6311 !testflag(addr_failed, af_ignore_error))
6313 log_write(0, LOG_MAIN|LOG_PANIC, "internal error: bounce message "
6314 "failure is neither frozen nor ignored (it's been ignored)");
6316 setflag(addr_failed, af_ignore_error);
6319 /* If the first address on the list has af_ignore_error set, just remove
6320 it from the list, throw away any saved message file, log it, and
6321 mark the recipient done. */
6323 if (testflag(addr_failed, af_ignore_error))
6326 addr_failed = addr->next;
6327 if (addr->return_filename != NULL) Uunlink(addr->return_filename);
6329 log_write(0, LOG_MAIN, "%s%s%s%s: error ignored",
6331 (addr->parent == NULL)? US"" : US" <",
6332 (addr->parent == NULL)? US"" : addr->parent->address,
6333 (addr->parent == NULL)? US"" : US">");
6335 address_done(addr, logtod);
6336 child_done(addr, logtod);
6337 /* Panic-dies on error */
6338 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
6341 /* Otherwise, handle the sending of a message. Find the error address for
6342 the first address, then send a message that includes all failed addresses
6343 that have the same error address. Note the bounce_recipient is a global so
6344 that it can be accesssed by $bounce_recipient while creating a customized
6349 bounce_recipient = (addr_failed->p.errors_address == NULL)?
6350 sender_address : addr_failed->p.errors_address;
6352 /* Make a subprocess to send a message */
6354 pid = child_open_exim(&fd);
6356 /* Creation of child failed */
6359 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Process %d (parent %d) failed to "
6360 "create child process to send failure message: %s", getpid(),
6361 getppid(), strerror(errno));
6363 /* Creation of child succeeded */
6370 uschar *bcc, *emf_text;
6371 FILE *f = fdopen(fd, "wb");
6373 BOOL to_sender = strcmpic(sender_address, bounce_recipient) == 0;
6374 int max = (bounce_return_size_limit/DELIVER_IN_BUFFER_SIZE + 1) *
6375 DELIVER_IN_BUFFER_SIZE;
6378 debug_printf("sending error message to: %s\n", bounce_recipient);
6380 /* Scan the addresses for all that have the same errors address, removing
6381 them from the addr_failed chain, and putting them on msgchain. */
6383 paddr = &addr_failed;
6384 for (addr = addr_failed; addr != NULL; addr = *paddr)
6386 if (Ustrcmp(bounce_recipient, (addr->p.errors_address == NULL)?
6387 sender_address : addr->p.errors_address) != 0)
6389 paddr = &(addr->next); /* Not the same; skip */
6391 else /* The same - dechain */
6393 *paddr = addr->next;
6396 pmsgchain = &(addr->next);
6400 /* Include X-Failed-Recipients: for automatic interpretation, but do
6401 not let any one header line get too long. We do this by starting a
6402 new header every 50 recipients. Omit any addresses for which the
6403 "hide_child" flag is set. */
6405 for (addr = msgchain; addr != NULL; addr = addr->next)
6407 if (testflag(addr, af_hide_child)) continue;
6414 (rcount++ == 0)? "X-Failed-Recipients: " : ",\n ",
6415 (testflag(addr, af_pfr) && addr->parent != NULL)?
6416 string_printing(addr->parent->address) :
6417 string_printing(addr->address));
6419 if (rcount > 0) fprintf(f, "\n");
6421 /* Output the standard headers */
6423 if (errors_reply_to != NULL)
6424 fprintf(f, "Reply-To: %s\n", errors_reply_to);
6425 fprintf(f, "Auto-Submitted: auto-replied\n");
6427 fprintf(f, "To: %s\n", bounce_recipient);
6429 /* Open a template file if one is provided. Log failure to open, but
6430 carry on - default texts will be used. */
6432 if (bounce_message_file != NULL)
6434 emf = Ufopen(bounce_message_file, "rb");
6436 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to open %s for error "
6437 "message texts: %s", bounce_message_file, strerror(errno));
6440 /* Quietly copy to configured additional addresses if required. */
6442 bcc = moan_check_errorcopy(bounce_recipient);
6443 if (bcc != NULL) fprintf(f, "Bcc: %s\n", bcc);
6445 /* The texts for the message can be read from a template file; if there
6446 isn't one, or if it is too short, built-in texts are used. The first
6447 emf text is a Subject: and any other headers. */
6449 emf_text = next_emf(emf, US"header");
6450 if (emf_text != NULL) fprintf(f, "%s\n", emf_text); else
6452 fprintf(f, "Subject: Mail delivery failed%s\n\n",
6453 to_sender? ": returning message to sender" : "");
6456 emf_text = next_emf(emf, US"intro");
6457 if (emf_text != NULL) fprintf(f, "%s", CS emf_text); else
6460 /* This message has been reworded several times. It seems to be confusing to
6461 somebody, however it is worded. I have retreated to the original, simple
6463 "This message was created automatically by mail delivery software.\n");
6464 if (bounce_message_text != NULL) fprintf(f, "%s", CS bounce_message_text);
6468 "\nA message that you sent could not be delivered to one or more of its\n"
6469 "recipients. This is a permanent error. The following address(es) failed:\n");
6474 "\nA message sent by\n\n <%s>\n\n"
6475 "could not be delivered to one or more of its recipients. The following\n"
6476 "address(es) failed:\n", sender_address);
6481 /* Process the addresses, leaving them on the msgchain if they have a
6482 file name for a return message. (There has already been a check in
6483 post_process_one() for the existence of data in the message file.) A TRUE
6484 return from print_address_information() means that the address is not
6488 for (addr = msgchain; addr != NULL; addr = *paddr)
6490 if (print_address_information(addr, f, US" ", US"\n ", US""))
6491 print_address_error(addr, f, US"");
6493 /* End the final line for the address */
6497 /* Leave on msgchain if there's a return file. */
6499 if (addr->return_file >= 0)
6501 paddr = &(addr->next);
6505 /* Else save so that we can tick off the recipient when the
6510 *paddr = addr->next;
6511 addr->next = handled_addr;
6512 handled_addr = addr;
6518 /* Get the next text, whether we need it or not, so as to be
6519 positioned for the one after. */
6521 emf_text = next_emf(emf, US"generated text");
6523 /* If there were any file messages passed by the local transports,
6524 include them in the message. Then put the address on the handled chain.
6525 In the case of a batch of addresses that were all sent to the same
6526 transport, the return_file field in all of them will contain the same
6527 fd, and the return_filename field in the *last* one will be set (to the
6528 name of the file). */
6530 if (msgchain != NULL)
6532 address_item *nextaddr;
6534 if (emf_text != NULL) fprintf(f, "%s", CS emf_text); else
6536 "The following text was generated during the delivery "
6537 "attempt%s:\n", (filecount > 1)? "s" : "");
6539 for (addr = msgchain; addr != NULL; addr = nextaddr)
6542 address_item *topaddr = addr;
6544 /* List all the addresses that relate to this file */
6547 while(addr != NULL) /* Insurance */
6549 print_address_information(addr, f, US"------ ", US"\n ",
6551 if (addr->return_filename != NULL) break;
6556 /* Now copy the file */
6558 fm = Ufopen(addr->return_filename, "rb");
6561 fprintf(f, " +++ Exim error... failed to open text file: %s\n",
6565 while ((ch = fgetc(fm)) != EOF) fputc(ch, f);
6568 Uunlink(addr->return_filename);
6570 /* Can now add to handled chain, first fishing off the next
6571 address on the msgchain. */
6573 nextaddr = addr->next;
6574 addr->next = handled_addr;
6575 handled_addr = topaddr;
6580 /* Now copy the message, trying to give an intelligible comment if
6581 it is too long for it all to be copied. The limit isn't strictly
6582 applied because of the buffering. There is, however, an option
6583 to suppress copying altogether. */
6585 emf_text = next_emf(emf, US"copy");
6587 if (bounce_return_message)
6589 int topt = topt_add_return_path;
6590 if (!bounce_return_body) topt |= topt_no_body;
6592 if (emf_text != NULL) fprintf(f, "%s", CS emf_text); else
6594 if (bounce_return_body) fprintf(f,
6595 "------ This is a copy of the message, including all the headers. ------\n");
6597 "------ This is a copy of the message's headers. ------\n");
6600 /* While reading the "truncated" message, set return_size_limit to
6601 the actual max testing value, rounded. We need to read the message
6602 whether we are going to use it or not. */
6605 int temp = bounce_return_size_limit;
6606 bounce_return_size_limit = (max/1000)*1000;
6607 emf_text = next_emf(emf, US"truncated");
6608 bounce_return_size_limit = temp;
6611 if (bounce_return_body && bounce_return_size_limit > 0)
6613 struct stat statbuf;
6614 if (fstat(deliver_datafile, &statbuf) == 0 && statbuf.st_size > max)
6616 if (emf_text != NULL) fprintf(f, "%s", CS emf_text); else
6619 "------ The body of the message is " OFF_T_FMT " characters long; only the first\n"
6620 "------ %d or so are included here.\n", statbuf.st_size, max);
6627 transport_filter_argv = NULL; /* Just in case */
6628 return_path = sender_address; /* In case not previously set */
6629 transport_write_message(NULL, fileno(f), topt,
6630 bounce_return_size_limit, NULL, NULL, NULL, NULL, NULL, 0);
6633 /* Write final text and close the template file if one is open */
6637 emf_text = next_emf(emf, US"final");
6638 if (emf_text != NULL) fprintf(f, "%s", CS emf_text);
6642 /* Close the file, which should send an EOF to the child process
6643 that is receiving the message. Wait for it to finish. */
6646 rc = child_close(pid, 0); /* Waits for child to close, no timeout */
6648 /* In the test harness, let the child do it's thing first. */
6650 if (running_in_test_harness) millisleep(500);
6652 /* If the process failed, there was some disaster in setting up the
6653 error message. Unless the message is very old, ensure that addr_defer
6654 is non-null, which will have the effect of leaving the message on the
6655 spool. The failed addresses will get tried again next time. However, we
6656 don't really want this to happen too often, so freeze the message unless
6657 there are some genuine deferred addresses to try. To do this we have
6658 to call spool_write_header() here, because with no genuine deferred
6659 addresses the normal code below doesn't get run. */
6664 if (now - received_time < retry_maximum_timeout && addr_defer == NULL)
6666 addr_defer = (address_item *)(+1);
6667 deliver_freeze = TRUE;
6668 deliver_frozen_at = time(NULL);
6669 /* Panic-dies on error */
6670 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
6673 deliver_msglog("Process failed (%d) when writing error message "
6674 "to %s%s", rc, bounce_recipient, s);
6675 log_write(0, LOG_MAIN, "Process failed (%d) when writing error message "
6676 "to %s%s", rc, bounce_recipient, s);
6679 /* The message succeeded. Ensure that the recipients that failed are
6680 now marked finished with on the spool and their parents updated. */
6684 for (addr = handled_addr; addr != NULL; addr = addr->next)
6686 address_done(addr, logtod);
6687 child_done(addr, logtod);
6689 /* Panic-dies on error */
6690 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
6696 disable_logging = FALSE; /* In case left set */
6698 /* Come here from the mua_wrapper case if routing goes wrong */
6702 /* If there are now no deferred addresses, we are done. Preserve the
6703 message log if so configured, and we are using them. Otherwise, sling it.
6704 Then delete the message itself. */
6706 if (addr_defer == NULL)
6710 sprintf(CS spoolname, "%s/msglog/%s/%s", spool_directory, message_subdir,
6712 if (preserve_message_logs)
6715 sprintf(CS big_buffer, "%s/msglog.OLD/%s", spool_directory, id);
6716 if ((rc = Urename(spoolname, big_buffer)) < 0)
6718 (void)directory_make(spool_directory, US"msglog.OLD",
6719 MSGLOG_DIRECTORY_MODE, TRUE);
6720 rc = Urename(spoolname, big_buffer);
6723 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to move %s to the "
6724 "msglog.OLD directory", spoolname);
6728 if (Uunlink(spoolname) < 0)
6729 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s",
6730 spoolname, strerror(errno));
6734 /* Remove the two message files. */
6736 sprintf(CS spoolname, "%s/input/%s/%s-D", spool_directory, message_subdir, id);
6737 if (Uunlink(spoolname) < 0)
6738 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s",
6739 spoolname, strerror(errno));
6740 sprintf(CS spoolname, "%s/input/%s/%s-H", spool_directory, message_subdir, id);
6741 if (Uunlink(spoolname) < 0)
6742 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s",
6743 spoolname, strerror(errno));
6745 /* Log the end of this message, with queue time if requested. */
6747 if ((log_extra_selector & LX_queue_time_overall) != 0)
6748 log_write(0, LOG_MAIN, "Completed QT=%s",
6749 readconf_printtime(time(NULL) - received_time));
6751 log_write(0, LOG_MAIN, "Completed");
6753 /* Unset deliver_freeze so that we won't try to move the spool files further down */
6754 deliver_freeze = FALSE;
6757 /* If there are deferred addresses, we are keeping this message because it is
6758 not yet completed. Lose any temporary files that were catching output from
6759 pipes for any of the deferred addresses, handle one-time aliases, and see if
6760 the message has been on the queue for so long that it is time to send a warning
6761 message to the sender, unless it is a mailer-daemon. If all deferred addresses
6762 have the same domain, we can set deliver_domain for the expansion of
6763 delay_warning_ condition - if any of them are pipes, files, or autoreplies, use
6764 the parent's domain.
6766 If all the deferred addresses have an error number that indicates "retry time
6767 not reached", skip sending the warning message, because it won't contain the
6768 reason for the delay. It will get sent at the next real delivery attempt.
6769 However, if at least one address has tried, we'd better include all of them in
6772 If we can't make a process to send the message, don't worry.
6774 For mailing list expansions we want to send the warning message to the
6775 mailing list manager. We can't do a perfect job here, as some addresses may
6776 have different errors addresses, but if we take the errors address from
6777 each deferred address it will probably be right in most cases.
6779 If addr_defer == +1, it means there was a problem sending an error message
6780 for failed addresses, and there were no "real" deferred addresses. The value
6781 was set just to keep the message on the spool, so there is nothing to do here.
6784 else if (addr_defer != (address_item *)(+1))
6787 uschar *recipients = US"";
6788 BOOL delivery_attempted = FALSE;
6790 deliver_domain = testflag(addr_defer, af_pfr)?
6791 addr_defer->parent->domain : addr_defer->domain;
6793 for (addr = addr_defer; addr != NULL; addr = addr->next)
6795 address_item *otaddr;
6797 if (addr->basic_errno > ERRNO_RETRY_BASE) delivery_attempted = TRUE;
6799 if (deliver_domain != NULL)
6801 uschar *d = (testflag(addr, af_pfr))? addr->parent->domain : addr->domain;
6803 /* The domain may be unset for an address that has never been routed
6804 because the system filter froze the message. */
6806 if (d == NULL || Ustrcmp(d, deliver_domain) != 0) deliver_domain = NULL;
6809 if (addr->return_filename != NULL) Uunlink(addr->return_filename);
6811 /* Handle the case of one-time aliases. If any address in the ancestry
6812 of this one is flagged, ensure it is in the recipients list, suitably
6813 flagged, and that its parent is marked delivered. */
6815 for (otaddr = addr; otaddr != NULL; otaddr = otaddr->parent)
6816 if (otaddr->onetime_parent != NULL) break;
6821 int t = recipients_count;
6823 for (i = 0; i < recipients_count; i++)
6825 uschar *r = recipients_list[i].address;
6826 if (Ustrcmp(otaddr->onetime_parent, r) == 0) t = i;
6827 if (Ustrcmp(otaddr->address, r) == 0) break;
6830 /* Didn't find the address already in the list, and did find the
6831 ultimate parent's address in the list. After adding the recipient,
6832 update the errors address in the recipients list. */
6834 if (i >= recipients_count && t < recipients_count)
6836 DEBUG(D_deliver) debug_printf("one_time: adding %s in place of %s\n",
6837 otaddr->address, otaddr->parent->address);
6838 receive_add_recipient(otaddr->address, t);
6839 recipients_list[recipients_count-1].errors_to = otaddr->p.errors_address;
6840 tree_add_nonrecipient(otaddr->parent->address);
6841 update_spool = TRUE;
6845 /* Except for error messages, ensure that either the errors address for
6846 this deferred address or, if there is none, the sender address, is on the
6847 list of recipients for a warning message. */
6849 if (sender_address[0] != 0)
6851 if (addr->p.errors_address == NULL)
6853 if (Ustrstr(recipients, sender_address) == NULL)
6854 recipients = string_sprintf("%s%s%s", recipients,
6855 (recipients[0] == 0)? "" : ",", sender_address);
6859 if (Ustrstr(recipients, addr->p.errors_address) == NULL)
6860 recipients = string_sprintf("%s%s%s", recipients,
6861 (recipients[0] == 0)? "" : ",", addr->p.errors_address);
6866 /* Send a warning message if the conditions are right. If the condition check
6867 fails because of a lookup defer, there is nothing we can do. The warning
6868 is not sent. Another attempt will be made at the next delivery attempt (if
6871 if (!queue_2stage && delivery_attempted &&
6872 delay_warning[1] > 0 && sender_address[0] != 0 &&
6873 (delay_warning_condition == NULL ||
6874 expand_check_condition(delay_warning_condition,
6875 US"delay_warning", US"option")))
6879 int queue_time = time(NULL) - received_time;
6881 /* When running in the test harness, there's an option that allows us to
6882 fudge this time so as to get repeatability of the tests. Take the first
6883 time off the list. In queue runs, the list pointer gets updated in the
6886 if (running_in_test_harness && fudged_queue_times[0] != 0)
6888 int qt = readconf_readtime(fudged_queue_times, '/', FALSE);
6891 DEBUG(D_deliver) debug_printf("fudged queue_times = %s\n",
6892 fudged_queue_times);
6897 /* See how many warnings we should have sent by now */
6899 for (count = 0; count < delay_warning[1]; count++)
6900 if (queue_time < delay_warning[count+2]) break;
6902 show_time = delay_warning[count+1];
6904 if (count >= delay_warning[1])
6907 int last_gap = show_time;
6908 if (count > 1) last_gap -= delay_warning[count];
6909 extra = (queue_time - delay_warning[count+1])/last_gap;
6910 show_time += last_gap * extra;
6916 debug_printf("time on queue = %s\n", readconf_printtime(queue_time));
6917 debug_printf("warning counts: required %d done %d\n", count,
6921 /* We have computed the number of warnings there should have been by now.
6922 If there haven't been enough, send one, and up the count to what it should
6925 if (warning_count < count)
6929 pid_t pid = child_open_exim(&fd);
6935 FILE *f = fdopen(fd, "wb");
6937 if (warn_message_file != NULL)
6939 wmf = Ufopen(warn_message_file, "rb");
6941 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to open %s for warning "
6942 "message texts: %s", warn_message_file, strerror(errno));
6945 warnmsg_recipients = recipients;
6946 warnmsg_delay = (queue_time < 120*60)?
6947 string_sprintf("%d minutes", show_time/60):
6948 string_sprintf("%d hours", show_time/3600);
6950 if (errors_reply_to != NULL)
6951 fprintf(f, "Reply-To: %s\n", errors_reply_to);
6952 fprintf(f, "Auto-Submitted: auto-replied\n");
6954 fprintf(f, "To: %s\n", recipients);
6956 wmf_text = next_emf(wmf, US"header");
6957 if (wmf_text != NULL)
6958 fprintf(f, "%s\n", wmf_text);
6960 fprintf(f, "Subject: Warning: message %s delayed %s\n\n",
6961 message_id, warnmsg_delay);
6963 wmf_text = next_emf(wmf, US"intro");
6964 if (wmf_text != NULL) fprintf(f, "%s", CS wmf_text); else
6967 "This message was created automatically by mail delivery software.\n");
6969 if (Ustrcmp(recipients, sender_address) == 0)
6971 "A message that you sent has not yet been delivered to one or more of its\n"
6972 "recipients after more than ");
6975 "A message sent by\n\n <%s>\n\n"
6976 "has not yet been delivered to one or more of its recipients after more than \n",
6979 fprintf(f, "%s on the queue on %s.\n\n", warnmsg_delay,
6981 fprintf(f, "The message identifier is: %s\n", message_id);
6983 for (h = header_list; h != NULL; h = h->next)
6985 if (strncmpic(h->text, US"Subject:", 8) == 0)
6986 fprintf(f, "The subject of the message is: %s", h->text + 9);
6987 else if (strncmpic(h->text, US"Date:", 5) == 0)
6988 fprintf(f, "The date of the message is: %s", h->text + 6);
6992 fprintf(f, "The address%s to which the message has not yet been "
6994 (addr_defer->next == NULL)? "" : "es",
6995 (addr_defer->next == NULL)? "is": "are");
6998 /* List the addresses, with error information if allowed */
7001 while (addr_defer != NULL)
7003 address_item *addr = addr_defer;
7004 addr_defer = addr->next;
7005 if (print_address_information(addr, f, US" ", US"\n ", US""))
7006 print_address_error(addr, f, US"Delay reason: ");
7015 wmf_text = next_emf(wmf, US"final");
7016 if (wmf_text != NULL) fprintf(f, "%s", CS wmf_text);
7022 "No action is required on your part. Delivery attempts will continue for\n"
7023 "some time, and this warning may be repeated at intervals if the message\n"
7024 "remains undelivered. Eventually the mail delivery software will give up,\n"
7025 "and when that happens, the message will be returned to you.\n");
7028 /* Close and wait for child process to complete, without a timeout.
7029 If there's an error, don't update the count. */
7032 if (child_close(pid, 0) == 0)
7034 warning_count = count;
7035 update_spool = TRUE; /* Ensure spool rewritten */
7041 /* Clear deliver_domain */
7043 deliver_domain = NULL;
7045 /* If this was a first delivery attempt, unset the first time flag, and
7046 ensure that the spool gets updated. */
7048 if (deliver_firsttime)
7050 deliver_firsttime = FALSE;
7051 update_spool = TRUE;
7054 /* If delivery was frozen and freeze_tell is set, generate an appropriate
7055 message, unless the message is a local error message (to avoid loops). Then
7056 log the freezing. If the text in "frozen_info" came from a system filter,
7057 it has been escaped into printing characters so as not to mess up log lines.
7058 For the "tell" message, we turn \n back into newline. Also, insert a newline
7059 near the start instead of the ": " string. */
7063 if (freeze_tell != NULL && freeze_tell[0] != 0 && !local_error_message)
7065 uschar *s = string_copy(frozen_info);
7066 uschar *ss = Ustrstr(s, " by the system filter: ");
7077 if (*ss == '\\' && ss[1] == 'n')
7084 moan_tell_someone(freeze_tell, addr_defer, US"Message frozen",
7085 "Message %s has been frozen%s.\nThe sender is <%s>.\n", message_id,
7089 /* Log freezing just before we update the -H file, to minimize the chance
7090 of a race problem. */
7092 deliver_msglog("*** Frozen%s\n", frozen_info);
7093 log_write(0, LOG_MAIN, "Frozen%s", frozen_info);
7096 /* If there have been any updates to the non-recipients list, or other things
7097 that get written to the spool, we must now update the spool header file so
7098 that it has the right information for the next delivery attempt. If there
7099 was more than one address being delivered, the header_change update is done
7100 earlier, in case one succeeds and then something crashes. */
7103 debug_printf("delivery deferred: update_spool=%d header_rewritten=%d\n",
7104 update_spool, header_rewritten);
7106 if (update_spool || header_rewritten)
7107 /* Panic-dies on error */
7108 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
7111 /* Finished with the message log. If the message is complete, it will have
7112 been unlinked or renamed above. */
7114 if (message_logs) (void)fclose(message_log);
7116 /* Now we can close and remove the journal file. Its only purpose is to record
7117 successfully completed deliveries asap so that this information doesn't get
7118 lost if Exim (or the machine) crashes. Forgetting about a failed delivery is
7119 not serious, as trying it again is not harmful. The journal might not be open
7120 if all addresses were deferred at routing or directing. Nevertheless, we must
7121 remove it if it exists (may have been lying around from a crash during the
7122 previous delivery attempt). We don't remove the journal if a delivery
7123 subprocess failed to pass back delivery information; this is controlled by
7124 the remove_journal flag. When the journal is left, we also don't move the
7125 message off the main spool if frozen and the option is set. It should get moved
7126 at the next attempt, after the journal has been inspected. */
7128 if (journal_fd >= 0) (void)close(journal_fd);
7132 sprintf(CS spoolname, "%s/input/%s/%s-J", spool_directory, message_subdir, id);
7133 if (Uunlink(spoolname) < 0 && errno != ENOENT)
7134 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s", spoolname,
7137 /* Move the message off the spool if reqested */
7139 #ifdef SUPPORT_MOVE_FROZEN_MESSAGES
7140 if (deliver_freeze && move_frozen_messages)
7141 (void)spool_move_message(id, message_subdir, US"", US"F");
7145 /* Closing the data file frees the lock; if the file has been unlinked it
7146 will go away. Otherwise the message becomes available for another process
7149 (void)close(deliver_datafile);
7150 deliver_datafile = -1;
7151 DEBUG(D_deliver) debug_printf("end delivery of %s\n", id);
7153 /* It is unlikely that there will be any cached resources, since they are
7154 released after routing, and in the delivery subprocesses. However, it's
7155 possible for an expansion for something afterwards (for example,
7156 expand_check_condition) to do a lookup. We must therefore be sure everything is
7160 acl_where = ACL_WHERE_UNKNOWN;
7164 /* End of deliver.c */