1 /*************************************************
2 * Exim - an Internet mail transport agent *
3 *************************************************/
5 /* Copyright (c) University of Cambridge 1995 - 2009 */
6 /* See the file NOTICE for conditions of use and distribution. */
8 /* The main code for delivering a message. */
14 /* Data block for keeping track of subprocesses for parallel remote
17 typedef struct pardata {
18 address_item *addrlist; /* chain of addresses */
19 address_item *addr; /* next address data expected for */
20 pid_t pid; /* subprocess pid */
21 int fd; /* pipe fd for getting result from subprocess */
22 int transport_count; /* returned transport count value */
23 BOOL done; /* no more data needed */
24 uschar *msg; /* error message */
25 uschar *return_path; /* return_path for these addresses */
28 /* Values for the process_recipients variable */
30 enum { RECIP_ACCEPT, RECIP_IGNORE, RECIP_DEFER,
31 RECIP_FAIL, RECIP_FAIL_FILTER, RECIP_FAIL_TIMEOUT,
34 /* Mutually recursive functions for marking addresses done. */
36 static void child_done(address_item *, uschar *);
37 static void address_done(address_item *, uschar *);
39 /* Table for turning base-62 numbers into binary */
41 static uschar tab62[] =
42 {0,1,2,3,4,5,6,7,8,9,0,0,0,0,0,0, /* 0-9 */
43 0,10,11,12,13,14,15,16,17,18,19,20, /* A-K */
44 21,22,23,24,25,26,27,28,29,30,31,32, /* L-W */
45 33,34,35, 0, 0, 0, 0, 0, /* X-Z */
46 0,36,37,38,39,40,41,42,43,44,45,46, /* a-k */
47 47,48,49,50,51,52,53,54,55,56,57,58, /* l-w */
51 /*************************************************
52 * Local static variables *
53 *************************************************/
55 /* addr_duplicate is global because it needs to be seen from the Envelope-To
58 static address_item *addr_defer = NULL;
59 static address_item *addr_failed = NULL;
60 static address_item *addr_fallback = NULL;
61 static address_item *addr_local = NULL;
62 static address_item *addr_new = NULL;
63 static address_item *addr_remote = NULL;
64 static address_item *addr_route = NULL;
65 static address_item *addr_succeed = NULL;
67 static FILE *message_log = NULL;
68 static BOOL update_spool;
69 static BOOL remove_journal;
70 static int parcount = 0;
71 static pardata *parlist = NULL;
72 static int return_count;
73 static uschar *frozen_info = US"";
74 static uschar *used_return_path = NULL;
76 static uschar spoolname[PATH_MAX];
80 /*************************************************
81 * Make a new address item *
82 *************************************************/
84 /* This function gets the store and initializes with default values. The
85 transport_return value defaults to DEFER, so that any unexpected failure to
86 deliver does not wipe out the message. The default unique string is set to a
87 copy of the address, so that its domain can be lowercased.
90 address the RFC822 address string
91 copy force a copy of the address
93 Returns: a pointer to an initialized address_item
97 deliver_make_addr(uschar *address, BOOL copy)
99 address_item *addr = store_get(sizeof(address_item));
100 *addr = address_defaults;
101 if (copy) address = string_copy(address);
102 addr->address = address;
103 addr->unique = string_copy(address);
110 /*************************************************
111 * Set expansion values for an address *
112 *************************************************/
114 /* Certain expansion variables are valid only when handling an address or
115 address list. This function sets them up or clears the values, according to its
119 addr the address in question, or NULL to clear values
124 deliver_set_expansions(address_item *addr)
128 uschar ***p = address_expansions;
129 while (*p != NULL) **p++ = NULL;
133 /* Exactly what gets set depends on whether there is one or more addresses, and
134 what they contain. These first ones are always set, taking their values from
135 the first address. */
137 if (addr->host_list == NULL)
139 deliver_host = deliver_host_address = US"";
143 deliver_host = addr->host_list->name;
144 deliver_host_address = addr->host_list->address;
147 deliver_recipients = addr;
148 deliver_address_data = addr->p.address_data;
149 deliver_domain_data = addr->p.domain_data;
150 deliver_localpart_data = addr->p.localpart_data;
152 /* These may be unset for multiple addresses */
154 deliver_domain = addr->domain;
155 self_hostname = addr->self_hostname;
157 #ifdef EXPERIMENTAL_BRIGHTMAIL
158 bmi_deliver = 1; /* deliver by default */
159 bmi_alt_location = NULL;
160 bmi_base64_verdict = NULL;
161 bmi_base64_tracker_verdict = NULL;
164 /* If there's only one address we can set everything. */
166 if (addr->next == NULL)
168 address_item *addr_orig;
170 deliver_localpart = addr->local_part;
171 deliver_localpart_prefix = addr->prefix;
172 deliver_localpart_suffix = addr->suffix;
174 for (addr_orig = addr; addr_orig->parent != NULL;
175 addr_orig = addr_orig->parent);
176 deliver_domain_orig = addr_orig->domain;
178 /* Re-instate any prefix and suffix in the original local part. In all
179 normal cases, the address will have a router associated with it, and we can
180 choose the caseful or caseless version accordingly. However, when a system
181 filter sets up a pipe, file, or autoreply delivery, no router is involved.
182 In this case, though, there won't be any prefix or suffix to worry about. */
184 deliver_localpart_orig = (addr_orig->router == NULL)? addr_orig->local_part :
185 addr_orig->router->caseful_local_part?
186 addr_orig->cc_local_part : addr_orig->lc_local_part;
188 /* If there's a parent, make its domain and local part available, and if
189 delivering to a pipe or file, or sending an autoreply, get the local
190 part from the parent. For pipes and files, put the pipe or file string
191 into address_pipe and address_file. */
193 if (addr->parent != NULL)
195 deliver_domain_parent = addr->parent->domain;
196 deliver_localpart_parent = (addr->parent->router == NULL)?
197 addr->parent->local_part :
198 addr->parent->router->caseful_local_part?
199 addr->parent->cc_local_part : addr->parent->lc_local_part;
201 /* File deliveries have their own flag because they need to be picked out
202 as special more often. */
204 if (testflag(addr, af_pfr))
206 if (testflag(addr, af_file)) address_file = addr->local_part;
207 else if (deliver_localpart[0] == '|') address_pipe = addr->local_part;
208 deliver_localpart = addr->parent->local_part;
209 deliver_localpart_prefix = addr->parent->prefix;
210 deliver_localpart_suffix = addr->parent->suffix;
214 #ifdef EXPERIMENTAL_BRIGHTMAIL
215 /* Set expansion variables related to Brightmail AntiSpam */
216 bmi_base64_verdict = bmi_get_base64_verdict(deliver_localpart_orig, deliver_domain_orig);
217 bmi_base64_tracker_verdict = bmi_get_base64_tracker_verdict(bmi_base64_verdict);
218 /* get message delivery status (0 - don't deliver | 1 - deliver) */
219 bmi_deliver = bmi_get_delivery_status(bmi_base64_verdict);
220 /* if message is to be delivered, get eventual alternate location */
221 if (bmi_deliver == 1) {
222 bmi_alt_location = bmi_get_alt_location(bmi_base64_verdict);
228 /* For multiple addresses, don't set local part, and leave the domain and
229 self_hostname set only if it is the same for all of them. It is possible to
230 have multiple pipe and file addresses, but only when all addresses have routed
231 to the same pipe or file. */
236 if (testflag(addr, af_pfr))
238 if (testflag(addr, af_file)) address_file = addr->local_part;
239 else if (addr->local_part[0] == '|') address_pipe = addr->local_part;
241 for (addr2 = addr->next; addr2 != NULL; addr2 = addr2->next)
243 if (deliver_domain != NULL &&
244 Ustrcmp(deliver_domain, addr2->domain) != 0)
245 deliver_domain = NULL;
246 if (self_hostname != NULL && (addr2->self_hostname == NULL ||
247 Ustrcmp(self_hostname, addr2->self_hostname) != 0))
248 self_hostname = NULL;
249 if (deliver_domain == NULL && self_hostname == NULL) break;
257 /*************************************************
258 * Open a msglog file *
259 *************************************************/
261 /* This function is used both for normal message logs, and for files in the
262 msglog directory that are used to catch output from pipes. Try to create the
263 directory if it does not exist. From release 4.21, normal message logs should
264 be created when the message is received.
267 filename the file name
268 mode the mode required
269 error used for saying what failed
271 Returns: a file descriptor, or -1 (with errno set)
275 open_msglog_file(uschar *filename, int mode, uschar **error)
277 int fd = Uopen(filename, O_WRONLY|O_APPEND|O_CREAT, mode);
279 if (fd < 0 && errno == ENOENT)
282 sprintf(CS temp, "msglog/%s", message_subdir);
283 if (message_subdir[0] == 0) temp[6] = 0;
284 (void)directory_make(spool_directory, temp, MSGLOG_DIRECTORY_MODE, TRUE);
285 fd = Uopen(filename, O_WRONLY|O_APPEND|O_CREAT, mode);
288 /* Set the close-on-exec flag and change the owner to the exim uid/gid (this
289 function is called as root). Double check the mode, because the group setting
290 doesn't always get set automatically. */
294 (void)fcntl(fd, F_SETFD, fcntl(fd, F_GETFD) | FD_CLOEXEC);
295 if (fchown(fd, exim_uid, exim_gid) < 0)
300 if (fchmod(fd, mode) < 0)
306 else *error = US"create";
314 /*************************************************
315 * Write to msglog if required *
316 *************************************************/
318 /* Write to the message log, if configured. This function may also be called
322 format a string format
328 deliver_msglog(const char *format, ...)
331 if (!message_logs) return;
332 va_start(ap, format);
333 vfprintf(message_log, format, ap);
341 /*************************************************
342 * Replicate status for batch *
343 *************************************************/
345 /* When a transport handles a batch of addresses, it may treat them
346 individually, or it may just put the status in the first one, and return FALSE,
347 requesting that the status be copied to all the others externally. This is the
348 replication function. As well as the status, it copies the transport pointer,
349 which may have changed if appendfile passed the addresses on to a different
352 Argument: pointer to the first address in a chain
357 replicate_status(address_item *addr)
360 for (addr2 = addr->next; addr2 != NULL; addr2 = addr2->next)
362 addr2->transport = addr->transport;
363 addr2->transport_return = addr->transport_return;
364 addr2->basic_errno = addr->basic_errno;
365 addr2->more_errno = addr->more_errno;
366 addr2->special_action = addr->special_action;
367 addr2->message = addr->message;
368 addr2->user_message = addr->user_message;
374 /*************************************************
375 * Compare lists of hosts *
376 *************************************************/
378 /* This function is given two pointers to chains of host items, and it yields
379 TRUE if the lists refer to the same hosts in the same order, except that
381 (1) Multiple hosts with the same non-negative MX values are permitted to appear
382 in different orders. Round-robinning nameservers can cause this to happen.
384 (2) Multiple hosts with the same negative MX values less than MX_NONE are also
385 permitted to appear in different orders. This is caused by randomizing
388 This enables Exim to use a single SMTP transaction for sending to two entirely
389 different domains that happen to end up pointing at the same hosts.
392 one points to the first host list
393 two points to the second host list
395 Returns: TRUE if the lists refer to the same host set
399 same_hosts(host_item *one, host_item *two)
401 while (one != NULL && two != NULL)
403 if (Ustrcmp(one->name, two->name) != 0)
406 host_item *end_one = one;
407 host_item *end_two = two;
409 /* Batch up only if there was no MX and the list was not randomized */
411 if (mx == MX_NONE) return FALSE;
413 /* Find the ends of the shortest sequence of identical MX values */
415 while (end_one->next != NULL && end_one->next->mx == mx &&
416 end_two->next != NULL && end_two->next->mx == mx)
418 end_one = end_one->next;
419 end_two = end_two->next;
422 /* If there aren't any duplicates, there's no match. */
424 if (end_one == one) return FALSE;
426 /* For each host in the 'one' sequence, check that it appears in the 'two'
427 sequence, returning FALSE if not. */
432 for (hi = two; hi != end_two->next; hi = hi->next)
433 if (Ustrcmp(one->name, hi->name) == 0) break;
434 if (hi == end_two->next) return FALSE;
435 if (one == end_one) break;
439 /* All the hosts in the 'one' sequence were found in the 'two' sequence.
440 Ensure both are pointing at the last host, and carry on as for equality. */
451 /* True if both are NULL */
458 /*************************************************
459 * Compare header lines *
460 *************************************************/
462 /* This function is given two pointers to chains of header items, and it yields
463 TRUE if they are the same header texts in the same order.
466 one points to the first header list
467 two points to the second header list
469 Returns: TRUE if the lists refer to the same header set
473 same_headers(header_line *one, header_line *two)
477 if (one == two) return TRUE; /* Includes the case where both NULL */
478 if (one == NULL || two == NULL) return FALSE;
479 if (Ustrcmp(one->text, two->text) != 0) return FALSE;
487 /*************************************************
488 * Compare string settings *
489 *************************************************/
491 /* This function is given two pointers to strings, and it returns
492 TRUE if they are the same pointer, or if the two strings are the same.
495 one points to the first string
496 two points to the second string
498 Returns: TRUE or FALSE
502 same_strings(uschar *one, uschar *two)
504 if (one == two) return TRUE; /* Includes the case where both NULL */
505 if (one == NULL || two == NULL) return FALSE;
506 return (Ustrcmp(one, two) == 0);
511 /*************************************************
512 * Compare uid/gid for addresses *
513 *************************************************/
515 /* This function is given a transport and two addresses. It yields TRUE if the
516 uid/gid/initgroups settings for the two addresses are going to be the same when
521 addr1 the first address
522 addr2 the second address
524 Returns: TRUE or FALSE
528 same_ugid(transport_instance *tp, address_item *addr1, address_item *addr2)
530 if (!tp->uid_set && tp->expand_uid == NULL && !tp->deliver_as_creator)
532 if (testflag(addr1, af_uid_set) != testflag(addr2, af_gid_set) ||
533 (testflag(addr1, af_uid_set) &&
534 (addr1->uid != addr2->uid ||
535 testflag(addr1, af_initgroups) != testflag(addr2, af_initgroups))))
539 if (!tp->gid_set && tp->expand_gid == NULL)
541 if (testflag(addr1, af_gid_set) != testflag(addr2, af_gid_set) ||
542 (testflag(addr1, af_gid_set) && addr1->gid != addr2->gid))
552 /*************************************************
553 * Record that an address is complete *
554 *************************************************/
556 /* This function records that an address is complete. This is straightforward
557 for most addresses, where the unique address is just the full address with the
558 domain lower cased. For homonyms (addresses that are the same as one of their
559 ancestors) their are complications. Their unique addresses have \x\ prepended
560 (where x = 0, 1, 2...), so that de-duplication works correctly for siblings and
563 Exim used to record the unique addresses of homonyms as "complete". This,
564 however, fails when the pattern of redirection varies over time (e.g. if taking
565 unseen copies at only some times of day) because the prepended numbers may vary
566 from one delivery run to the next. This problem is solved by never recording
567 prepended unique addresses as complete. Instead, when a homonymic address has
568 actually been delivered via a transport, we record its basic unique address
569 followed by the name of the transport. This is checked in subsequent delivery
570 runs whenever an address is routed to a transport.
572 If the completed address is a top-level one (has no parent, which means it
573 cannot be homonymic) we also add the original address to the non-recipients
574 tree, so that it gets recorded in the spool file and therefore appears as
575 "done" in any spool listings. The original address may differ from the unique
576 address in the case of the domain.
578 Finally, this function scans the list of duplicates, marks as done any that
579 match this address, and calls child_done() for their ancestors.
582 addr address item that has been completed
583 now current time as a string
589 address_done(address_item *addr, uschar *now)
593 update_spool = TRUE; /* Ensure spool gets updated */
595 /* Top-level address */
597 if (addr->parent == NULL)
599 tree_add_nonrecipient(addr->unique);
600 tree_add_nonrecipient(addr->address);
603 /* Homonymous child address */
605 else if (testflag(addr, af_homonym))
607 if (addr->transport != NULL)
609 tree_add_nonrecipient(
610 string_sprintf("%s/%s", addr->unique + 3, addr->transport->name));
614 /* Non-homonymous child address */
616 else tree_add_nonrecipient(addr->unique);
618 /* Check the list of duplicate addresses and ensure they are now marked
621 for (dup = addr_duplicate; dup != NULL; dup = dup->next)
623 if (Ustrcmp(addr->unique, dup->unique) == 0)
625 tree_add_nonrecipient(dup->unique);
626 child_done(dup, now);
634 /*************************************************
635 * Decrease counts in parents and mark done *
636 *************************************************/
638 /* This function is called when an address is complete. If there is a parent
639 address, its count of children is decremented. If there are still other
640 children outstanding, the function exits. Otherwise, if the count has become
641 zero, address_done() is called to mark the parent and its duplicates complete.
642 Then loop for any earlier ancestors.
645 addr points to the completed address item
646 now the current time as a string, for writing to the message log
652 child_done(address_item *addr, uschar *now)
655 while (addr->parent != NULL)
658 if ((addr->child_count -= 1) > 0) return; /* Incomplete parent */
659 address_done(addr, now);
661 /* Log the completion of all descendents only when there is no ancestor with
662 the same original address. */
664 for (aa = addr->parent; aa != NULL; aa = aa->parent)
665 if (Ustrcmp(aa->address, addr->address) == 0) break;
666 if (aa != NULL) continue;
668 deliver_msglog("%s %s: children all complete\n", now, addr->address);
669 DEBUG(D_deliver) debug_printf("%s: children all complete\n", addr->address);
676 /* If msg is NULL this is a delivery log and logchar is used. Otherwise
677 this is a nonstandard call; no two-characher delivery flag is written
678 but sender-host and sender are prefixed and "msg" is inserted in the log line.
681 flags passed to log_write()
684 delivery_log(int flags, address_item * addr, int logchar, uschar * msg)
687 int size = 256; /* Used for a temporary, */
688 int ptr = 0; /* expanding buffer, for */
689 uschar *s; /* building log lines; */
690 void *reset_point; /* released afterwards. */
693 /* Log the delivery on the main log. We use an extensible string to build up
694 the log line, and reset the store afterwards. Remote deliveries should always
695 have a pointer to the host item that succeeded; local deliveries can have a
696 pointer to a single host item in their host list, for use by the transport. */
698 s = reset_point = store_get(size);
700 log_address = string_log_address(addr, (log_write_selector & L_all_parents) != 0, TRUE);
702 s = string_append(s, &size, &ptr, 3, host_and_ident(TRUE), US" ", log_address);
706 s = string_append(s, &size, &ptr, 2, US"> ", log_address);
709 if ((log_extra_selector & LX_sender_on_delivery) != 0 || msg)
710 s = string_append(s, &size, &ptr, 3, US" F=<", sender_address, US">");
712 #ifdef EXPERIMENTAL_SRS
713 if(addr->p.srs_sender)
714 s = string_append(s, &size, &ptr, 3, US" SRS=<", addr->p.srs_sender, US">");
716 #ifdef EXPERIMENTAL_DBL
717 dbl_delivery_ip = NULL; /* presume no successful remote delivery */
720 /* You might think that the return path must always be set for a successful
721 delivery; indeed, I did for some time, until this statement crashed. The case
722 when it is not set is for a delivery to /dev/null which is optimised by not
725 if (used_return_path != NULL &&
726 (log_extra_selector & LX_return_path_on_delivery) != 0)
727 s = string_append(s, &size, &ptr, 3, US" P=<", used_return_path, US">");
730 s = string_append(s, &size, &ptr, 2, US" ", msg);
732 /* For a delivery from a system filter, there may not be a router */
733 if (addr->router != NULL)
734 s = string_append(s, &size, &ptr, 2, US" R=", addr->router->name);
736 s = string_append(s, &size, &ptr, 2, US" T=", addr->transport->name);
738 if ((log_extra_selector & LX_delivery_size) != 0)
739 s = string_append(s, &size, &ptr, 2, US" S=",
740 string_sprintf("%d", transport_count));
744 if (addr->transport->info->local)
746 if (addr->host_list != NULL)
747 s = string_append(s, &size, &ptr, 2, US" H=", addr->host_list->name);
748 if (addr->shadow_message != NULL)
749 s = string_cat(s, &size, &ptr, addr->shadow_message,
750 Ustrlen(addr->shadow_message));
753 /* Remote delivery */
757 if (addr->host_used != NULL)
759 s = string_append(s, &size, &ptr, 5, US" H=", addr->host_used->name,
760 US" [", addr->host_used->address, US"]");
761 if ((log_extra_selector & LX_outgoing_port) != 0)
762 s = string_append(s, &size, &ptr, 2, US":", string_sprintf("%d",
763 addr->host_used->port));
764 if (continue_sequence > 1)
765 s = string_cat(s, &size, &ptr, US"*", 1);
767 #ifdef EXPERIMENTAL_DBL
768 dbl_delivery_ip = string_copy(addr->host_used->address);
769 dbl_delivery_port = addr->host_used->port;
770 dbl_delivery_fqdn = string_copy(addr->host_used->name);
771 dbl_delivery_local_part = string_copy(addr->local_part);
772 dbl_delivery_domain = string_copy(addr->domain);
773 dbl_delivery_confirmation = string_copy(addr->message);
778 if ((log_extra_selector & LX_tls_cipher) != 0 && addr->cipher != NULL)
779 s = string_append(s, &size, &ptr, 2, US" X=", addr->cipher);
780 if ((log_extra_selector & LX_tls_certificate_verified) != 0 &&
781 addr->cipher != NULL)
782 s = string_append(s, &size, &ptr, 2, US" CV=",
783 testflag(addr, af_cert_verified)? "yes":"no");
784 if ((log_extra_selector & LX_tls_peerdn) != 0 && addr->peerdn != NULL)
785 s = string_append(s, &size, &ptr, 3, US" DN=\"",
786 string_printing(addr->peerdn), US"\"");
789 if (addr->authenticator)
791 s = string_append(s, &size, &ptr, 2, US" A=", addr->authenticator);
794 s = string_append(s, &size, &ptr, 2, US":", addr->auth_id);
795 if (log_extra_selector & LX_smtp_mailauth && addr->auth_sndr)
796 s = string_append(s, &size, &ptr, 2, US":", addr->auth_sndr);
800 #ifdef EXPERIMENTAL_PRDR
801 if (addr->flags & af_prdr_used)
802 s = string_append(s, &size, &ptr, 1, US" PRDR");
805 if ((log_extra_selector & LX_smtp_confirmation) != 0 &&
806 addr->message != NULL)
809 uschar *p = big_buffer;
810 uschar *ss = addr->message;
812 for (i = 0; i < 100 && ss[i] != 0; i++)
814 if (ss[i] == '\"' || ss[i] == '\\') *p++ = '\\';
819 s = string_append(s, &size, &ptr, 2, US" C=", big_buffer);
823 /* Time on queue and actual time taken to deliver */
825 if ((log_extra_selector & LX_queue_time) != 0)
827 s = string_append(s, &size, &ptr, 2, US" QT=",
828 readconf_printtime(time(NULL) - received_time));
831 if ((log_extra_selector & LX_deliver_time) != 0)
833 s = string_append(s, &size, &ptr, 2, US" DT=",
834 readconf_printtime(addr->more_errno));
837 /* string_cat() always leaves room for the terminator. Release the
838 store we used to build the line after writing it. */
841 log_write(0, flags, "%s", s);
842 #ifdef EXPERIMENTAL_DBL
845 debug_printf(" DBL(Delivery): dbl_delivery_query=|%s| dbl_delivery_IP=%s\n", dbl_delivery_query, dbl_delivery_ip);
847 if (dbl_delivery_ip != NULL && dbl_delivery_query != NULL)
848 expand_string(dbl_delivery_query);
850 store_reset(reset_point);
856 /*************************************************
857 * Actions at the end of handling an address *
858 *************************************************/
860 /* This is a function for processing a single address when all that can be done
861 with it has been done.
864 addr points to the address block
865 result the result of the delivery attempt
866 logflags flags for log_write() (LOG_MAIN and/or LOG_PANIC)
867 driver_type indicates which type of driver (transport, or router) was last
868 to process the address
869 logchar '=' or '-' for use when logging deliveries with => or ->
875 post_process_one(address_item *addr, int result, int logflags, int driver_type,
878 uschar *now = tod_stamp(tod_log);
879 uschar *driver_kind = NULL;
880 uschar *driver_name = NULL;
883 int size = 256; /* Used for a temporary, */
884 int ptr = 0; /* expanding buffer, for */
885 uschar *s; /* building log lines; */
886 void *reset_point; /* released afterwards. */
889 DEBUG(D_deliver) debug_printf("post-process %s (%d)\n", addr->address, result);
891 /* Set up driver kind and name for logging. Disable logging if the router or
892 transport has disabled it. */
894 if (driver_type == DTYPE_TRANSPORT)
896 if (addr->transport != NULL)
898 driver_name = addr->transport->name;
899 driver_kind = US" transport";
900 disable_logging = addr->transport->disable_logging;
902 else driver_kind = US"transporting";
904 else if (driver_type == DTYPE_ROUTER)
906 if (addr->router != NULL)
908 driver_name = addr->router->name;
909 driver_kind = US" router";
910 disable_logging = addr->router->disable_logging;
912 else driver_kind = US"routing";
915 /* If there's an error message set, ensure that it contains only printing
916 characters - it should, but occasionally things slip in and this at least
917 stops the log format from getting wrecked. We also scan the message for an LDAP
918 expansion item that has a password setting, and flatten the password. This is a
919 fudge, but I don't know a cleaner way of doing this. (If the item is badly
920 malformed, it won't ever have gone near LDAP.) */
922 if (addr->message != NULL)
924 addr->message = string_printing(addr->message);
925 if (((Ustrstr(addr->message, "failed to expand") != NULL) || (Ustrstr(addr->message, "expansion of ") != NULL)) &&
926 (Ustrstr(addr->message, "mysql") != NULL ||
927 Ustrstr(addr->message, "pgsql") != NULL ||
928 Ustrstr(addr->message, "sqlite") != NULL ||
929 Ustrstr(addr->message, "ldap:") != NULL ||
930 Ustrstr(addr->message, "ldapdn:") != NULL ||
931 Ustrstr(addr->message, "ldapm:") != NULL))
933 addr->message = string_sprintf("Temporary internal error");
937 /* If we used a transport that has one of the "return_output" options set, and
938 if it did in fact generate some output, then for return_output we treat the
939 message as failed if it was not already set that way, so that the output gets
940 returned to the sender, provided there is a sender to send it to. For
941 return_fail_output, do this only if the delivery failed. Otherwise we just
942 unlink the file, and remove the name so that if the delivery failed, we don't
943 try to send back an empty or unwanted file. The log_output options operate only
946 In any case, we close the message file, because we cannot afford to leave a
947 file-descriptor for one address while processing (maybe very many) others. */
949 if (addr->return_file >= 0 && addr->return_filename != NULL)
951 BOOL return_output = FALSE;
953 (void)EXIMfsync(addr->return_file);
955 /* If there is no output, do nothing. */
957 if (fstat(addr->return_file, &statbuf) == 0 && statbuf.st_size > 0)
959 transport_instance *tb = addr->transport;
961 /* Handle logging options */
963 if (tb->log_output || (result == FAIL && tb->log_fail_output) ||
964 (result == DEFER && tb->log_defer_output))
967 FILE *f = Ufopen(addr->return_filename, "rb");
969 log_write(0, LOG_MAIN|LOG_PANIC, "failed to open %s to log output "
970 "from %s transport: %s", addr->return_filename, tb->name,
974 s = US Ufgets(big_buffer, big_buffer_size, f);
977 uschar *p = big_buffer + Ustrlen(big_buffer);
978 while (p > big_buffer && isspace(p[-1])) p--;
980 s = string_printing(big_buffer);
981 log_write(0, LOG_MAIN, "<%s>: %s transport output: %s",
982 addr->address, tb->name, s);
988 /* Handle returning options, but only if there is an address to return
991 if (sender_address[0] != 0 || addr->p.errors_address != NULL)
993 if (tb->return_output)
995 addr->transport_return = result = FAIL;
996 if (addr->basic_errno == 0 && addr->message == NULL)
997 addr->message = US"return message generated";
998 return_output = TRUE;
1001 if (tb->return_fail_output && result == FAIL) return_output = TRUE;
1005 /* Get rid of the file unless it might be returned, but close it in
1010 Uunlink(addr->return_filename);
1011 addr->return_filename = NULL;
1012 addr->return_file = -1;
1015 (void)close(addr->return_file);
1018 /* The sucess case happens only after delivery by a transport. */
1022 addr->next = addr_succeed;
1023 addr_succeed = addr;
1025 /* Call address_done() to ensure that we don't deliver to this address again,
1026 and write appropriate things to the message log. If it is a child address, we
1027 call child_done() to scan the ancestors and mark them complete if this is the
1028 last child to complete. */
1030 address_done(addr, now);
1031 DEBUG(D_deliver) debug_printf("%s delivered\n", addr->address);
1033 if (addr->parent == NULL)
1035 deliver_msglog("%s %s: %s%s succeeded\n", now, addr->address,
1036 driver_name, driver_kind);
1040 deliver_msglog("%s %s <%s>: %s%s succeeded\n", now, addr->address,
1041 addr->parent->address, driver_name, driver_kind);
1042 child_done(addr, now);
1045 delivery_log(LOG_MAIN, addr, logchar, NULL);
1049 /* Soft failure, or local delivery process failed; freezing may be
1052 else if (result == DEFER || result == PANIC)
1054 if (result == PANIC) logflags |= LOG_PANIC;
1056 /* This puts them on the chain in reverse order. Do not change this, because
1057 the code for handling retries assumes that the one with the retry
1058 information is last. */
1060 addr->next = addr_defer;
1063 /* The only currently implemented special action is to freeze the
1064 message. Logging of this is done later, just before the -H file is
1067 if (addr->special_action == SPECIAL_FREEZE)
1069 deliver_freeze = TRUE;
1070 deliver_frozen_at = time(NULL);
1071 update_spool = TRUE;
1074 /* If doing a 2-stage queue run, we skip writing to either the message
1075 log or the main log for SMTP defers. */
1077 if (!queue_2stage || addr->basic_errno != 0)
1081 /* For errors of the type "retry time not reached" (also remotes skipped
1082 on queue run), logging is controlled by L_retry_defer. Note that this kind
1083 of error number is negative, and all the retry ones are less than any
1086 unsigned int use_log_selector = (addr->basic_errno <= ERRNO_RETRY_BASE)?
1089 /* Build up the line that is used for both the message log and the main
1092 s = reset_point = store_get(size);
1094 /* Create the address string for logging. Must not do this earlier, because
1095 an OK result may be changed to FAIL when a pipe returns text. */
1097 log_address = string_log_address(addr,
1098 (log_write_selector & L_all_parents) != 0, result == OK);
1100 s = string_cat(s, &size, &ptr, log_address, Ustrlen(log_address));
1102 /* Either driver_name contains something and driver_kind contains
1103 " router" or " transport" (note the leading space), or driver_name is
1104 a null string and driver_kind contains "routing" without the leading
1105 space, if all routing has been deferred. When a domain has been held,
1106 so nothing has been done at all, both variables contain null strings. */
1108 if (driver_name == NULL)
1110 if (driver_kind != NULL)
1111 s = string_append(s, &size, &ptr, 2, US" ", driver_kind);
1115 if (driver_kind[1] == 't' && addr->router != NULL)
1116 s = string_append(s, &size, &ptr, 2, US" R=", addr->router->name);
1118 ss[1] = toupper(driver_kind[1]);
1119 s = string_append(s, &size, &ptr, 2, ss, driver_name);
1122 sprintf(CS ss, " defer (%d)", addr->basic_errno);
1123 s = string_cat(s, &size, &ptr, ss, Ustrlen(ss));
1125 if (addr->basic_errno > 0)
1126 s = string_append(s, &size, &ptr, 2, US": ",
1127 US strerror(addr->basic_errno));
1129 if (addr->message != NULL)
1130 s = string_append(s, &size, &ptr, 2, US": ", addr->message);
1134 /* Log the deferment in the message log, but don't clutter it
1135 up with retry-time defers after the first delivery attempt. */
1137 if (deliver_firsttime || addr->basic_errno > ERRNO_RETRY_BASE)
1138 deliver_msglog("%s %s\n", now, s);
1140 /* Write the main log and reset the store */
1142 log_write(use_log_selector, logflags, "== %s", s);
1143 store_reset(reset_point);
1148 /* Hard failure. If there is an address to which an error message can be sent,
1149 put this address on the failed list. If not, put it on the deferred list and
1150 freeze the mail message for human attention. The latter action can also be
1151 explicitly requested by a router or transport. */
1155 /* If this is a delivery error, or a message for which no replies are
1156 wanted, and the message's age is greater than ignore_bounce_errors_after,
1157 force the af_ignore_error flag. This will cause the address to be discarded
1158 later (with a log entry). */
1160 if (sender_address[0] == 0 && message_age >= ignore_bounce_errors_after)
1161 setflag(addr, af_ignore_error);
1163 /* Freeze the message if requested, or if this is a bounce message (or other
1164 message with null sender) and this address does not have its own errors
1165 address. However, don't freeze if errors are being ignored. The actual code
1166 to ignore occurs later, instead of sending a message. Logging of freezing
1167 occurs later, just before writing the -H file. */
1169 if (!testflag(addr, af_ignore_error) &&
1170 (addr->special_action == SPECIAL_FREEZE ||
1171 (sender_address[0] == 0 && addr->p.errors_address == NULL)
1174 frozen_info = (addr->special_action == SPECIAL_FREEZE)? US"" :
1175 (sender_local && !local_error_message)?
1176 US" (message created with -f <>)" : US" (delivery error message)";
1177 deliver_freeze = TRUE;
1178 deliver_frozen_at = time(NULL);
1179 update_spool = TRUE;
1181 /* The address is put on the defer rather than the failed queue, because
1182 the message is being retained. */
1184 addr->next = addr_defer;
1188 /* Don't put the address on the nonrecipients tree yet; wait until an
1189 error message has been successfully sent. */
1193 addr->next = addr_failed;
1197 /* Build up the log line for the message and main logs */
1199 s = reset_point = store_get(size);
1201 /* Create the address string for logging. Must not do this earlier, because
1202 an OK result may be changed to FAIL when a pipe returns text. */
1204 log_address = string_log_address(addr,
1205 (log_write_selector & L_all_parents) != 0, result == OK);
1207 s = string_cat(s, &size, &ptr, log_address, Ustrlen(log_address));
1209 if ((log_extra_selector & LX_sender_on_delivery) != 0)
1210 s = string_append(s, &size, &ptr, 3, US" F=<", sender_address, US">");
1212 /* Return path may not be set if no delivery actually happened */
1214 if (used_return_path != NULL &&
1215 (log_extra_selector & LX_return_path_on_delivery) != 0)
1217 s = string_append(s, &size, &ptr, 3, US" P=<", used_return_path, US">");
1220 if (addr->router != NULL)
1221 s = string_append(s, &size, &ptr, 2, US" R=", addr->router->name);
1222 if (addr->transport != NULL)
1223 s = string_append(s, &size, &ptr, 2, US" T=", addr->transport->name);
1225 if (addr->host_used != NULL)
1226 s = string_append(s, &size, &ptr, 5, US" H=", addr->host_used->name,
1227 US" [", addr->host_used->address, US"]");
1229 if (addr->basic_errno > 0)
1230 s = string_append(s, &size, &ptr, 2, US": ",
1231 US strerror(addr->basic_errno));
1233 if (addr->message != NULL)
1234 s = string_append(s, &size, &ptr, 2, US": ", addr->message);
1238 /* Do the logging. For the message log, "routing failed" for those cases,
1239 just to make it clearer. */
1241 if (driver_name == NULL)
1242 deliver_msglog("%s %s failed for %s\n", now, driver_kind, s);
1244 deliver_msglog("%s %s\n", now, s);
1246 log_write(0, LOG_MAIN, "** %s", s);
1247 store_reset(reset_point);
1250 /* Ensure logging is turned on again in all cases */
1252 disable_logging = FALSE;
1258 /*************************************************
1259 * Address-independent error *
1260 *************************************************/
1262 /* This function is called when there's an error that is not dependent on a
1263 particular address, such as an expansion string failure. It puts the error into
1264 all the addresses in a batch, logs the incident on the main and panic logs, and
1265 clears the expansions. It is mostly called from local_deliver(), but can be
1266 called for a remote delivery via findugid().
1269 logit TRUE if (MAIN+PANIC) logging required
1270 addr the first of the chain of addresses
1272 format format string for error message, or NULL if already set in addr
1273 ... arguments for the format
1279 common_error(BOOL logit, address_item *addr, int code, uschar *format, ...)
1281 address_item *addr2;
1282 addr->basic_errno = code;
1288 va_start(ap, format);
1289 if (!string_vformat(buffer, sizeof(buffer), CS format, ap))
1290 log_write(0, LOG_MAIN|LOG_PANIC_DIE,
1291 "common_error expansion was longer than " SIZE_T_FMT, sizeof(buffer));
1293 addr->message = string_copy(buffer);
1296 for (addr2 = addr->next; addr2 != NULL; addr2 = addr2->next)
1298 addr2->basic_errno = code;
1299 addr2->message = addr->message;
1302 if (logit) log_write(0, LOG_MAIN|LOG_PANIC, "%s", addr->message);
1303 deliver_set_expansions(NULL);
1309 /*************************************************
1310 * Check a "never users" list *
1311 *************************************************/
1313 /* This function is called to check whether a uid is on one of the two "never
1317 uid the uid to be checked
1318 nusers the list to be scanned; the first item in the list is the count
1320 Returns: TRUE if the uid is on the list
1324 check_never_users(uid_t uid, uid_t *nusers)
1327 if (nusers == NULL) return FALSE;
1328 for (i = 1; i <= (int)(nusers[0]); i++) if (nusers[i] == uid) return TRUE;
1334 /*************************************************
1335 * Find uid and gid for a transport *
1336 *************************************************/
1338 /* This function is called for both local and remote deliveries, to find the
1339 uid/gid under which to run the delivery. The values are taken preferentially
1340 from the transport (either explicit or deliver_as_creator), then from the
1341 address (i.e. the router), and if nothing is set, the exim uid/gid are used. If
1342 the resulting uid is on the "never_users" or the "fixed_never_users" list, a
1343 panic error is logged, and the function fails (which normally leads to delivery
1347 addr the address (possibly a chain)
1349 uidp pointer to uid field
1350 gidp pointer to gid field
1351 igfp pointer to the use_initgroups field
1353 Returns: FALSE if failed - error has been set in address(es)
1357 findugid(address_item *addr, transport_instance *tp, uid_t *uidp, gid_t *gidp,
1360 uschar *nuname = NULL;
1361 BOOL gid_set = FALSE;
1363 /* Default initgroups flag comes from the transport */
1365 *igfp = tp->initgroups;
1367 /* First see if there's a gid on the transport, either fixed or expandable.
1368 The expanding function always logs failure itself. */
1375 else if (tp->expand_gid != NULL)
1377 if (route_find_expanded_group(tp->expand_gid, tp->name, US"transport", gidp,
1378 &(addr->message))) gid_set = TRUE;
1381 common_error(FALSE, addr, ERRNO_GIDFAIL, NULL);
1386 /* If the transport did not set a group, see if the router did. */
1388 if (!gid_set && testflag(addr, af_gid_set))
1394 /* Pick up a uid from the transport if one is set. */
1396 if (tp->uid_set) *uidp = tp->uid;
1398 /* Otherwise, try for an expandable uid field. If it ends up as a numeric id,
1399 it does not provide a passwd value from which a gid can be taken. */
1401 else if (tp->expand_uid != NULL)
1404 if (!route_find_expanded_user(tp->expand_uid, tp->name, US"transport", &pw,
1405 uidp, &(addr->message)))
1407 common_error(FALSE, addr, ERRNO_UIDFAIL, NULL);
1410 if (!gid_set && pw != NULL)
1417 /* If the transport doesn't set the uid, test the deliver_as_creator flag. */
1419 else if (tp->deliver_as_creator)
1421 *uidp = originator_uid;
1424 *gidp = originator_gid;
1429 /* Otherwise see if the address specifies the uid and if so, take it and its
1432 else if (testflag(addr, af_uid_set))
1435 *igfp = testflag(addr, af_initgroups);
1438 /* Nothing has specified the uid - default to the Exim user, and group if the
1451 /* If no gid is set, it is a disaster. We default to the Exim gid only if
1452 defaulting to the Exim uid. In other words, if the configuration has specified
1453 a uid, it must also provide a gid. */
1457 common_error(TRUE, addr, ERRNO_GIDFAIL, US"User set without group for "
1458 "%s transport", tp->name);
1462 /* Check that the uid is not on the lists of banned uids that may not be used
1463 for delivery processes. */
1465 if (check_never_users(*uidp, never_users))
1466 nuname = US"never_users";
1467 else if (check_never_users(*uidp, fixed_never_users))
1468 nuname = US"fixed_never_users";
1472 common_error(TRUE, addr, ERRNO_UIDFAIL, US"User %ld set for %s transport "
1473 "is on the %s list", (long int)(*uidp), tp->name, nuname);
1485 /*************************************************
1486 * Check the size of a message for a transport *
1487 *************************************************/
1489 /* Checks that the message isn't too big for the selected transport.
1490 This is called only when it is known that the limit is set.
1494 addr the (first) address being delivered
1497 DEFER expansion failed or did not yield an integer
1498 FAIL message too big
1502 check_message_size(transport_instance *tp, address_item *addr)
1507 deliver_set_expansions(addr);
1508 size_limit = expand_string_integer(tp->message_size_limit, TRUE);
1509 deliver_set_expansions(NULL);
1511 if (expand_string_message != NULL)
1514 if (size_limit == -1)
1515 addr->message = string_sprintf("failed to expand message_size_limit "
1516 "in %s transport: %s", tp->name, expand_string_message);
1518 addr->message = string_sprintf("invalid message_size_limit "
1519 "in %s transport: %s", tp->name, expand_string_message);
1521 else if (size_limit > 0 && message_size > size_limit)
1525 string_sprintf("message is too big (transport limit = %d)",
1534 /*************************************************
1535 * Transport-time check for a previous delivery *
1536 *************************************************/
1538 /* Check that this base address hasn't previously been delivered to its routed
1539 transport. If it has been delivered, mark it done. The check is necessary at
1540 delivery time in order to handle homonymic addresses correctly in cases where
1541 the pattern of redirection changes between delivery attempts (so the unique
1542 fields change). Non-homonymic previous delivery is detected earlier, at routing
1543 time (which saves unnecessary routing).
1546 addr the address item
1547 testing TRUE if testing wanted only, without side effects
1549 Returns: TRUE if previously delivered by the transport
1553 previously_transported(address_item *addr, BOOL testing)
1555 (void)string_format(big_buffer, big_buffer_size, "%s/%s",
1556 addr->unique + (testflag(addr, af_homonym)? 3:0), addr->transport->name);
1558 if (tree_search(tree_nonrecipients, big_buffer) != 0)
1560 DEBUG(D_deliver|D_route|D_transport)
1561 debug_printf("%s was previously delivered (%s transport): discarded\n",
1562 addr->address, addr->transport->name);
1563 if (!testing) child_done(addr, tod_stamp(tod_log));
1572 /******************************************************
1573 * Check for a given header in a header string *
1574 ******************************************************/
1576 /* This function is used when generating quota warnings. The configuration may
1577 specify any header lines it likes in quota_warn_message. If certain of them are
1578 missing, defaults are inserted, so we need to be able to test for the presence
1582 hdr the required header name
1583 hstring the header string
1585 Returns: TRUE the header is in the string
1586 FALSE the header is not in the string
1590 contains_header(uschar *hdr, uschar *hstring)
1592 int len = Ustrlen(hdr);
1593 uschar *p = hstring;
1596 if (strncmpic(p, hdr, len) == 0)
1599 while (*p == ' ' || *p == '\t') p++;
1600 if (*p == ':') return TRUE;
1602 while (*p != 0 && *p != '\n') p++;
1603 if (*p == '\n') p++;
1611 /*************************************************
1612 * Perform a local delivery *
1613 *************************************************/
1615 /* Each local delivery is performed in a separate process which sets its
1616 uid and gid as specified. This is a safer way than simply changing and
1617 restoring using seteuid(); there is a body of opinion that seteuid() cannot be
1618 used safely. From release 4, Exim no longer makes any use of it. Besides, not
1619 all systems have seteuid().
1621 If the uid/gid are specified in the transport_instance, they are used; the
1622 transport initialization must ensure that either both or neither are set.
1623 Otherwise, the values associated with the address are used. If neither are set,
1624 it is a configuration error.
1626 The transport or the address may specify a home directory (transport over-
1627 rides), and if they do, this is set as $home. If neither have set a working
1628 directory, this value is used for that as well. Otherwise $home is left unset
1629 and the cwd is set to "/" - a directory that should be accessible to all users.
1631 Using a separate process makes it more complicated to get error information
1632 back. We use a pipe to pass the return code and also an error code and error
1633 text string back to the parent process.
1636 addr points to an address block for this delivery; for "normal" local
1637 deliveries this is the only address to be delivered, but for
1638 pseudo-remote deliveries (e.g. by batch SMTP to a file or pipe)
1639 a number of addresses can be handled simultaneously, and in this
1640 case addr will point to a chain of addresses with the same
1643 shadowing TRUE if running a shadow transport; this causes output from pipes
1650 deliver_local(address_item *addr, BOOL shadowing)
1652 BOOL use_initgroups;
1655 int status, len, rc;
1658 uschar *working_directory;
1659 address_item *addr2;
1660 transport_instance *tp = addr->transport;
1662 /* Set up the return path from the errors or sender address. If the transport
1663 has its own return path setting, expand it and replace the existing value. */
1665 if(addr->p.errors_address != NULL)
1666 return_path = addr->p.errors_address;
1667 #ifdef EXPERIMENTAL_SRS
1668 else if(addr->p.srs_sender != NULL)
1669 return_path = addr->p.srs_sender;
1672 return_path = sender_address;
1674 if (tp->return_path != NULL)
1676 uschar *new_return_path = expand_string(tp->return_path);
1677 if (new_return_path == NULL)
1679 if (!expand_string_forcedfail)
1681 common_error(TRUE, addr, ERRNO_EXPANDFAIL,
1682 US"Failed to expand return path \"%s\" in %s transport: %s",
1683 tp->return_path, tp->name, expand_string_message);
1687 else return_path = new_return_path;
1690 /* For local deliveries, one at a time, the value used for logging can just be
1691 set directly, once and for all. */
1693 used_return_path = return_path;
1695 /* Sort out the uid, gid, and initgroups flag. If an error occurs, the message
1696 gets put into the address(es), and the expansions are unset, so we can just
1699 if (!findugid(addr, tp, &uid, &gid, &use_initgroups)) return;
1701 /* See if either the transport or the address specifies a home directory. A
1702 home directory set in the address may already be expanded; a flag is set to
1703 indicate that. In other cases we must expand it. */
1705 if ((deliver_home = tp->home_dir) != NULL || /* Set in transport, or */
1706 ((deliver_home = addr->home_dir) != NULL && /* Set in address and */
1707 !testflag(addr, af_home_expanded))) /* not expanded */
1709 uschar *rawhome = deliver_home;
1710 deliver_home = NULL; /* in case it contains $home */
1711 deliver_home = expand_string(rawhome);
1712 if (deliver_home == NULL)
1714 common_error(TRUE, addr, ERRNO_EXPANDFAIL, US"home directory \"%s\" failed "
1715 "to expand for %s transport: %s", rawhome, tp->name,
1716 expand_string_message);
1719 if (*deliver_home != '/')
1721 common_error(TRUE, addr, ERRNO_NOTABSOLUTE, US"home directory path \"%s\" "
1722 "is not absolute for %s transport", deliver_home, tp->name);
1727 /* See if either the transport or the address specifies a current directory,
1728 and if so, expand it. If nothing is set, use the home directory, unless it is
1729 also unset in which case use "/", which is assumed to be a directory to which
1730 all users have access. It is necessary to be in a visible directory for some
1731 operating systems when running pipes, as some commands (e.g. "rm" under Solaris
1732 2.5) require this. */
1734 working_directory = (tp->current_dir != NULL)?
1735 tp->current_dir : addr->current_dir;
1737 if (working_directory != NULL)
1739 uschar *raw = working_directory;
1740 working_directory = expand_string(raw);
1741 if (working_directory == NULL)
1743 common_error(TRUE, addr, ERRNO_EXPANDFAIL, US"current directory \"%s\" "
1744 "failed to expand for %s transport: %s", raw, tp->name,
1745 expand_string_message);
1748 if (*working_directory != '/')
1750 common_error(TRUE, addr, ERRNO_NOTABSOLUTE, US"current directory path "
1751 "\"%s\" is not absolute for %s transport", working_directory, tp->name);
1755 else working_directory = (deliver_home == NULL)? US"/" : deliver_home;
1757 /* If one of the return_output flags is set on the transport, create and open a
1758 file in the message log directory for the transport to write its output onto.
1759 This is mainly used by pipe transports. The file needs to be unique to the
1760 address. This feature is not available for shadow transports. */
1762 if (!shadowing && (tp->return_output || tp->return_fail_output ||
1763 tp->log_output || tp->log_fail_output))
1766 addr->return_filename =
1767 string_sprintf("%s/msglog/%s/%s-%d-%d", spool_directory, message_subdir,
1768 message_id, getpid(), return_count++);
1769 addr->return_file = open_msglog_file(addr->return_filename, 0400, &error);
1770 if (addr->return_file < 0)
1772 common_error(TRUE, addr, errno, US"Unable to %s file for %s transport "
1773 "to return message: %s", error, tp->name, strerror(errno));
1778 /* Create the pipe for inter-process communication. */
1782 common_error(TRUE, addr, ERRNO_PIPEFAIL, US"Creation of pipe failed: %s",
1787 /* Now fork the process to do the real work in the subprocess, but first
1788 ensure that all cached resources are freed so that the subprocess starts with
1789 a clean slate and doesn't interfere with the parent process. */
1793 if ((pid = fork()) == 0)
1795 BOOL replicate = TRUE;
1797 /* Prevent core dumps, as we don't want them in users' home directories.
1798 HP-UX doesn't have RLIMIT_CORE; I don't know how to do this in that
1799 system. Some experimental/developing systems (e.g. GNU/Hurd) may define
1800 RLIMIT_CORE but not support it in setrlimit(). For such systems, do not
1801 complain if the error is "not supported".
1803 There are two scenarios where changing the max limit has an effect. In one,
1804 the user is using a .forward and invoking a command of their choice via pipe;
1805 for these, we do need the max limit to be 0 unless the admin chooses to
1806 permit an increased limit. In the other, the command is invoked directly by
1807 the transport and is under administrator control, thus being able to raise
1808 the limit aids in debugging. So there's no general always-right answer.
1810 Thus we inhibit core-dumps completely but let individual transports, while
1811 still root, re-raise the limits back up to aid debugging. We make the
1812 default be no core-dumps -- few enough people can use core dumps in
1813 diagnosis that it's reasonable to make them something that has to be explicitly requested.
1820 if (setrlimit(RLIMIT_CORE, &rl) < 0)
1822 #ifdef SETRLIMIT_NOT_SUPPORTED
1823 if (errno != ENOSYS && errno != ENOTSUP)
1825 log_write(0, LOG_MAIN|LOG_PANIC, "setrlimit(RLIMIT_CORE) failed: %s",
1830 /* Reset the random number generator, so different processes don't all
1831 have the same sequence. */
1835 /* If the transport has a setup entry, call this first, while still
1836 privileged. (Appendfile uses this to expand quota, for example, while
1837 able to read private files.) */
1839 if (addr->transport->setup != NULL)
1841 switch((addr->transport->setup)(addr->transport, addr, NULL, uid, gid,
1845 addr->transport_return = DEFER;
1849 addr->transport_return = PANIC;
1854 /* Ignore SIGINT and SIGTERM during delivery. Also ignore SIGUSR1, as
1855 when the process becomes unprivileged, it won't be able to write to the
1856 process log. SIGHUP is ignored throughout exim, except when it is being
1859 signal(SIGINT, SIG_IGN);
1860 signal(SIGTERM, SIG_IGN);
1861 signal(SIGUSR1, SIG_IGN);
1863 /* Close the unwanted half of the pipe, and set close-on-exec for the other
1864 half - for transports that exec things (e.g. pipe). Then set the required
1867 (void)close(pfd[pipe_read]);
1868 (void)fcntl(pfd[pipe_write], F_SETFD, fcntl(pfd[pipe_write], F_GETFD) |
1870 exim_setugid(uid, gid, use_initgroups,
1871 string_sprintf("local delivery to %s <%s> transport=%s", addr->local_part,
1872 addr->address, addr->transport->name));
1876 address_item *batched;
1877 debug_printf(" home=%s current=%s\n", deliver_home, working_directory);
1878 for (batched = addr->next; batched != NULL; batched = batched->next)
1879 debug_printf("additional batched address: %s\n", batched->address);
1882 /* Set an appropriate working directory. */
1884 if (Uchdir(working_directory) < 0)
1886 addr->transport_return = DEFER;
1887 addr->basic_errno = errno;
1888 addr->message = string_sprintf("failed to chdir to %s", working_directory);
1891 /* If successful, call the transport */
1896 set_process_info("delivering %s to %s using %s", message_id,
1897 addr->local_part, addr->transport->name);
1899 /* Setting this global in the subprocess means we need never clear it */
1900 transport_name = addr->transport->name;
1902 /* If a transport filter has been specified, set up its argument list.
1903 Any errors will get put into the address, and FALSE yielded. */
1905 if (addr->transport->filter_command != NULL)
1907 ok = transport_set_up_command(&transport_filter_argv,
1908 addr->transport->filter_command,
1909 TRUE, PANIC, addr, US"transport filter", NULL);
1910 transport_filter_timeout = addr->transport->filter_timeout;
1912 else transport_filter_argv = NULL;
1916 debug_print_string(addr->transport->debug_string);
1917 replicate = !(addr->transport->info->code)(addr->transport, addr);
1921 /* Pass the results back down the pipe. If necessary, first replicate the
1922 status in the top address to the others in the batch. The label is the
1923 subject of a goto when a call to the transport's setup function fails. We
1924 pass the pointer to the transport back in case it got changed as a result of
1925 file_format in appendfile. */
1929 if (replicate) replicate_status(addr);
1930 for (addr2 = addr; addr2 != NULL; addr2 = addr2->next)
1933 int local_part_length = Ustrlen(addr2->local_part);
1937 if( (ret = write(pfd[pipe_write], (void *)&(addr2->transport_return), sizeof(int))) != sizeof(int)
1938 || (ret = write(pfd[pipe_write], (void *)&transport_count, sizeof(transport_count))) != sizeof(transport_count)
1939 || (ret = write(pfd[pipe_write], (void *)&(addr2->flags), sizeof(addr2->flags))) != sizeof(addr2->flags)
1940 || (ret = write(pfd[pipe_write], (void *)&(addr2->basic_errno), sizeof(int))) != sizeof(int)
1941 || (ret = write(pfd[pipe_write], (void *)&(addr2->more_errno), sizeof(int))) != sizeof(int)
1942 || (ret = write(pfd[pipe_write], (void *)&(addr2->special_action), sizeof(int))) != sizeof(int)
1943 || (ret = write(pfd[pipe_write], (void *)&(addr2->transport),
1944 sizeof(transport_instance *))) != sizeof(transport_instance *)
1946 /* For a file delivery, pass back the local part, in case the original
1947 was only part of the final delivery path. This gives more complete
1950 || (testflag(addr2, af_file)
1951 && ( (ret = write(pfd[pipe_write], (void *)&local_part_length, sizeof(int))) != sizeof(int)
1952 || (ret = write(pfd[pipe_write], addr2->local_part, local_part_length)) != local_part_length
1956 log_write(0, LOG_MAIN|LOG_PANIC, "Failed writing transport results to pipe: %s\n",
1957 ret == -1 ? strerror(errno) : "short write");
1959 /* Now any messages */
1961 for (i = 0, s = addr2->message; i < 2; i++, s = addr2->user_message)
1963 int message_length = (s == NULL)? 0 : Ustrlen(s) + 1;
1964 if( (ret = write(pfd[pipe_write], (void *)&message_length, sizeof(int))) != sizeof(int)
1965 || (message_length > 0 && (ret = write(pfd[pipe_write], s, message_length)) != message_length)
1967 log_write(0, LOG_MAIN|LOG_PANIC, "Failed writing transport results to pipe: %s\n",
1968 ret == -1 ? strerror(errno) : "short write");
1972 /* OK, this process is now done. Free any cached resources that it opened,
1973 and close the pipe we were writing down before exiting. */
1975 (void)close(pfd[pipe_write]);
1980 /* Back in the main process: panic if the fork did not succeed. This seems
1981 better than returning an error - if forking is failing it is probably best
1982 not to try other deliveries for this message. */
1985 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Fork failed for local delivery to %s",
1988 /* Read the pipe to get the delivery status codes and error messages. Our copy
1989 of the writing end must be closed first, as otherwise read() won't return zero
1990 on an empty pipe. We check that a status exists for each address before
1991 overwriting the address structure. If data is missing, the default DEFER status
1992 will remain. Afterwards, close the reading end. */
1994 (void)close(pfd[pipe_write]);
1996 for (addr2 = addr; addr2 != NULL; addr2 = addr2->next)
1998 len = read(pfd[pipe_read], (void *)&status, sizeof(int));
2004 addr2->transport_return = status;
2005 len = read(pfd[pipe_read], (void *)&transport_count,
2006 sizeof(transport_count));
2007 len = read(pfd[pipe_read], (void *)&(addr2->flags), sizeof(addr2->flags));
2008 len = read(pfd[pipe_read], (void *)&(addr2->basic_errno), sizeof(int));
2009 len = read(pfd[pipe_read], (void *)&(addr2->more_errno), sizeof(int));
2010 len = read(pfd[pipe_read], (void *)&(addr2->special_action), sizeof(int));
2011 len = read(pfd[pipe_read], (void *)&(addr2->transport),
2012 sizeof(transport_instance *));
2014 if (testflag(addr2, af_file))
2016 int local_part_length;
2017 len = read(pfd[pipe_read], (void *)&local_part_length, sizeof(int));
2018 len = read(pfd[pipe_read], (void *)big_buffer, local_part_length);
2019 big_buffer[local_part_length] = 0;
2020 addr2->local_part = string_copy(big_buffer);
2023 for (i = 0, sptr = &(addr2->message); i < 2;
2024 i++, sptr = &(addr2->user_message))
2027 len = read(pfd[pipe_read], (void *)&message_length, sizeof(int));
2028 if (message_length > 0)
2030 len = read(pfd[pipe_read], (void *)big_buffer, message_length);
2031 if (len > 0) *sptr = string_copy(big_buffer);
2038 log_write(0, LOG_MAIN|LOG_PANIC, "failed to read delivery status for %s "
2039 "from delivery subprocess", addr2->unique);
2044 (void)close(pfd[pipe_read]);
2046 /* Unless shadowing, write all successful addresses immediately to the journal
2047 file, to ensure they are recorded asap. For homonymic addresses, use the base
2048 address plus the transport name. Failure to write the journal is panic-worthy,
2049 but don't stop, as it may prove possible subsequently to update the spool file
2050 in order to record the delivery. */
2054 for (addr2 = addr; addr2 != NULL; addr2 = addr2->next)
2056 if (addr2->transport_return != OK) continue;
2058 if (testflag(addr2, af_homonym))
2059 sprintf(CS big_buffer, "%.500s/%s\n", addr2->unique + 3, tp->name);
2061 sprintf(CS big_buffer, "%.500s\n", addr2->unique);
2063 /* In the test harness, wait just a bit to let the subprocess finish off
2064 any debug output etc first. */
2066 if (running_in_test_harness) millisleep(300);
2068 DEBUG(D_deliver) debug_printf("journalling %s", big_buffer);
2069 len = Ustrlen(big_buffer);
2070 if (write(journal_fd, big_buffer, len) != len)
2071 log_write(0, LOG_MAIN|LOG_PANIC, "failed to update journal for %s: %s",
2072 big_buffer, strerror(errno));
2075 /* Ensure the journal file is pushed out to disk. */
2077 if (EXIMfsync(journal_fd) < 0)
2078 log_write(0, LOG_MAIN|LOG_PANIC, "failed to fsync journal: %s",
2082 /* Wait for the process to finish. If it terminates with a non-zero code,
2083 freeze the message (except for SIGTERM, SIGKILL and SIGQUIT), but leave the
2084 status values of all the addresses as they are. Take care to handle the case
2085 when the subprocess doesn't seem to exist. This has been seen on one system
2086 when Exim was called from an MUA that set SIGCHLD to SIG_IGN. When that
2087 happens, wait() doesn't recognize the termination of child processes. Exim now
2088 resets SIGCHLD to SIG_DFL, but this code should still be robust. */
2090 while ((rc = wait(&status)) != pid)
2092 if (rc < 0 && errno == ECHILD) /* Process has vanished */
2094 log_write(0, LOG_MAIN, "%s transport process vanished unexpectedly",
2095 addr->transport->driver_name);
2101 if ((status & 0xffff) != 0)
2103 int msb = (status >> 8) & 255;
2104 int lsb = status & 255;
2105 int code = (msb == 0)? (lsb & 0x7f) : msb;
2106 if (msb != 0 || (code != SIGTERM && code != SIGKILL && code != SIGQUIT))
2107 addr->special_action = SPECIAL_FREEZE;
2108 log_write(0, LOG_MAIN|LOG_PANIC, "%s transport process returned non-zero "
2109 "status 0x%04x: %s %d",
2110 addr->transport->driver_name,
2112 (msb == 0)? "terminated by signal" : "exit code",
2116 /* If SPECIAL_WARN is set in the top address, send a warning message. */
2118 if (addr->special_action == SPECIAL_WARN &&
2119 addr->transport->warn_message != NULL)
2122 uschar *warn_message;
2124 DEBUG(D_deliver) debug_printf("Warning message requested by transport\n");
2126 warn_message = expand_string(addr->transport->warn_message);
2127 if (warn_message == NULL)
2128 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand \"%s\" (warning "
2129 "message for %s transport): %s", addr->transport->warn_message,
2130 addr->transport->name, expand_string_message);
2133 pid_t pid = child_open_exim(&fd);
2136 FILE *f = fdopen(fd, "wb");
2137 if (errors_reply_to != NULL &&
2138 !contains_header(US"Reply-To", warn_message))
2139 fprintf(f, "Reply-To: %s\n", errors_reply_to);
2140 fprintf(f, "Auto-Submitted: auto-replied\n");
2141 if (!contains_header(US"From", warn_message)) moan_write_from(f);
2142 fprintf(f, "%s", CS warn_message);
2144 /* Close and wait for child process to complete, without a timeout. */
2147 (void)child_close(pid, 0);
2151 addr->special_action = SPECIAL_NONE;
2157 /*************************************************
2158 * Do local deliveries *
2159 *************************************************/
2161 /* This function processes the list of addresses in addr_local. True local
2162 deliveries are always done one address at a time. However, local deliveries can
2163 be batched up in some cases. Typically this is when writing batched SMTP output
2164 files for use by some external transport mechanism, or when running local
2165 deliveries over LMTP.
2172 do_local_deliveries(void)
2175 open_db *dbm_file = NULL;
2176 time_t now = time(NULL);
2178 /* Loop until we have exhausted the supply of local deliveries */
2180 while (addr_local != NULL)
2182 time_t delivery_start;
2184 address_item *addr2, *addr3, *nextaddr;
2185 int logflags = LOG_MAIN;
2186 int logchar = dont_deliver? '*' : '=';
2187 transport_instance *tp;
2189 /* Pick the first undelivered address off the chain */
2191 address_item *addr = addr_local;
2192 addr_local = addr->next;
2195 DEBUG(D_deliver|D_transport)
2196 debug_printf("--------> %s <--------\n", addr->address);
2198 /* An internal disaster if there is no transport. Should not occur! */
2200 if ((tp = addr->transport) == NULL)
2202 logflags |= LOG_PANIC;
2203 disable_logging = FALSE; /* Jic */
2205 (addr->router != NULL)?
2206 string_sprintf("No transport set by %s router", addr->router->name)
2208 string_sprintf("No transport set by system filter");
2209 post_process_one(addr, DEFER, logflags, DTYPE_TRANSPORT, 0);
2213 /* Check that this base address hasn't previously been delivered to this
2214 transport. The check is necessary at this point to handle homonymic addresses
2215 correctly in cases where the pattern of redirection changes between delivery
2216 attempts. Non-homonymic previous delivery is detected earlier, at routing
2219 if (previously_transported(addr, FALSE)) continue;
2221 /* There are weird cases where logging is disabled */
2223 disable_logging = tp->disable_logging;
2225 /* Check for batched addresses and possible amalgamation. Skip all the work
2226 if either batch_max <= 1 or there aren't any other addresses for local
2229 if (tp->batch_max > 1 && addr_local != NULL)
2231 int batch_count = 1;
2232 BOOL uses_dom = readconf_depends((driver_instance *)tp, US"domain");
2233 BOOL uses_lp = (testflag(addr, af_pfr) &&
2234 (testflag(addr, af_file) || addr->local_part[0] == '|')) ||
2235 readconf_depends((driver_instance *)tp, US"local_part");
2236 uschar *batch_id = NULL;
2237 address_item **anchor = &addr_local;
2238 address_item *last = addr;
2241 /* Expand the batch_id string for comparison with other addresses.
2242 Expansion failure suppresses batching. */
2244 if (tp->batch_id != NULL)
2246 deliver_set_expansions(addr);
2247 batch_id = expand_string(tp->batch_id);
2248 deliver_set_expansions(NULL);
2249 if (batch_id == NULL)
2251 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand batch_id option "
2252 "in %s transport (%s): %s", tp->name, addr->address,
2253 expand_string_message);
2254 batch_count = tp->batch_max;
2258 /* Until we reach the batch_max limit, pick off addresses which have the
2259 same characteristics. These are:
2262 not previously delivered (see comment about 50 lines above)
2263 same local part if the transport's configuration contains $local_part
2264 or if this is a file or pipe delivery from a redirection
2265 same domain if the transport's configuration contains $domain
2267 same additional headers
2268 same headers to be removed
2269 same uid/gid for running the transport
2270 same first host if a host list is set
2273 while ((next = *anchor) != NULL && batch_count < tp->batch_max)
2276 tp == next->transport &&
2277 !previously_transported(next, TRUE) &&
2278 (addr->flags & (af_pfr|af_file)) == (next->flags & (af_pfr|af_file)) &&
2279 (!uses_lp || Ustrcmp(next->local_part, addr->local_part) == 0) &&
2280 (!uses_dom || Ustrcmp(next->domain, addr->domain) == 0) &&
2281 same_strings(next->p.errors_address, addr->p.errors_address) &&
2282 same_headers(next->p.extra_headers, addr->p.extra_headers) &&
2283 same_strings(next->p.remove_headers, addr->p.remove_headers) &&
2284 same_ugid(tp, addr, next) &&
2285 ((addr->host_list == NULL && next->host_list == NULL) ||
2286 (addr->host_list != NULL && next->host_list != NULL &&
2287 Ustrcmp(addr->host_list->name, next->host_list->name) == 0));
2289 /* If the transport has a batch_id setting, batch_id will be non-NULL
2290 from the expansion outside the loop. Expand for this address and compare.
2291 Expansion failure makes this address ineligible for batching. */
2293 if (ok && batch_id != NULL)
2296 address_item *save_nextnext = next->next;
2297 next->next = NULL; /* Expansion for a single address */
2298 deliver_set_expansions(next);
2299 next->next = save_nextnext;
2300 bid = expand_string(tp->batch_id);
2301 deliver_set_expansions(NULL);
2304 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand batch_id option "
2305 "in %s transport (%s): %s", tp->name, next->address,
2306 expand_string_message);
2309 else ok = (Ustrcmp(batch_id, bid) == 0);
2312 /* Take address into batch if OK. */
2316 *anchor = next->next; /* Include the address */
2322 else anchor = &(next->next); /* Skip the address */
2326 /* We now have one or more addresses that can be delivered in a batch. Check
2327 whether the transport is prepared to accept a message of this size. If not,
2328 fail them all forthwith. If the expansion fails, or does not yield an
2329 integer, defer delivery. */
2331 if (tp->message_size_limit != NULL)
2333 int rc = check_message_size(tp, addr);
2336 replicate_status(addr);
2337 while (addr != NULL)
2340 post_process_one(addr, rc, logflags, DTYPE_TRANSPORT, 0);
2343 continue; /* With next batch of addresses */
2347 /* If we are not running the queue, or if forcing, all deliveries will be
2348 attempted. Otherwise, we must respect the retry times for each address. Even
2349 when not doing this, we need to set up the retry key string, and determine
2350 whether a retry record exists, because after a successful delivery, a delete
2351 retry item must be set up. Keep the retry database open only for the duration
2352 of these checks, rather than for all local deliveries, because some local
2353 deliveries (e.g. to pipes) can take a substantial time. */
2355 dbm_file = dbfn_open(US"retry", O_RDONLY, &dbblock, FALSE);
2356 if (dbm_file == NULL)
2358 DEBUG(D_deliver|D_retry|D_hints_lookup)
2359 debug_printf("no retry data available\n");
2364 while (addr2 != NULL)
2366 BOOL ok = TRUE; /* to deliver this address */
2369 /* Set up the retry key to include the domain or not, and change its
2370 leading character from "R" to "T". Must make a copy before doing this,
2371 because the old key may be pointed to from a "delete" retry item after
2374 retry_key = string_copy(
2375 (tp->retry_use_local_part)? addr2->address_retry_key :
2376 addr2->domain_retry_key);
2379 /* Inspect the retry data. If there is no hints file, delivery happens. */
2381 if (dbm_file != NULL)
2383 dbdata_retry *retry_record = dbfn_read(dbm_file, retry_key);
2385 /* If there is no retry record, delivery happens. If there is,
2386 remember it exists so it can be deleted after a successful delivery. */
2388 if (retry_record != NULL)
2390 setflag(addr2, af_lt_retry_exists);
2392 /* A retry record exists for this address. If queue running and not
2393 forcing, inspect its contents. If the record is too old, or if its
2394 retry time has come, or if it has passed its cutoff time, delivery
2399 debug_printf("retry record exists: age=%s ",
2400 readconf_printtime(now - retry_record->time_stamp));
2401 debug_printf("(max %s)\n", readconf_printtime(retry_data_expire));
2402 debug_printf(" time to retry = %s expired = %d\n",
2403 readconf_printtime(retry_record->next_try - now),
2404 retry_record->expired);
2407 if (queue_running && !deliver_force)
2409 ok = (now - retry_record->time_stamp > retry_data_expire) ||
2410 (now >= retry_record->next_try) ||
2411 retry_record->expired;
2413 /* If we haven't reached the retry time, there is one more check
2414 to do, which is for the ultimate address timeout. */
2417 ok = retry_ultimate_address_timeout(retry_key, addr2->domain,
2421 else DEBUG(D_retry) debug_printf("no retry record exists\n");
2424 /* This address is to be delivered. Leave it on the chain. */
2429 addr2 = addr2->next;
2432 /* This address is to be deferred. Take it out of the chain, and
2433 post-process it as complete. Must take it out of the chain first,
2434 because post processing puts it on another chain. */
2438 address_item *this = addr2;
2439 this->message = US"Retry time not yet reached";
2440 this->basic_errno = ERRNO_LRETRY;
2441 if (addr3 == NULL) addr2 = addr = addr2->next;
2442 else addr2 = addr3->next = addr2->next;
2443 post_process_one(this, DEFER, logflags, DTYPE_TRANSPORT, 0);
2447 if (dbm_file != NULL) dbfn_close(dbm_file);
2449 /* If there are no addresses left on the chain, they all deferred. Loop
2450 for the next set of addresses. */
2452 if (addr == NULL) continue;
2454 /* So, finally, we do have some addresses that can be passed to the
2455 transport. Before doing so, set up variables that are relevant to a
2458 deliver_set_expansions(addr);
2459 delivery_start = time(NULL);
2460 deliver_local(addr, FALSE);
2461 deliver_time = (int)(time(NULL) - delivery_start);
2463 /* If a shadow transport (which must perforce be another local transport), is
2464 defined, and its condition is met, we must pass the message to the shadow
2465 too, but only those addresses that succeeded. We do this by making a new
2466 chain of addresses - also to keep the original chain uncontaminated. We must
2467 use a chain rather than doing it one by one, because the shadow transport may
2470 NOTE: if the condition fails because of a lookup defer, there is nothing we
2473 if (tp->shadow != NULL &&
2474 (tp->shadow_condition == NULL ||
2475 expand_check_condition(tp->shadow_condition, tp->name, US"transport")))
2477 transport_instance *stp;
2478 address_item *shadow_addr = NULL;
2479 address_item **last = &shadow_addr;
2481 for (stp = transports; stp != NULL; stp = stp->next)
2482 if (Ustrcmp(stp->name, tp->shadow) == 0) break;
2485 log_write(0, LOG_MAIN|LOG_PANIC, "shadow transport \"%s\" not found ",
2488 /* Pick off the addresses that have succeeded, and make clones. Put into
2489 the shadow_message field a pointer to the shadow_message field of the real
2492 else for (addr2 = addr; addr2 != NULL; addr2 = addr2->next)
2494 if (addr2->transport_return != OK) continue;
2495 addr3 = store_get(sizeof(address_item));
2498 addr3->shadow_message = (uschar *)(&(addr2->shadow_message));
2499 addr3->transport = stp;
2500 addr3->transport_return = DEFER;
2501 addr3->return_filename = NULL;
2502 addr3->return_file = -1;
2504 last = &(addr3->next);
2507 /* If we found any addresses to shadow, run the delivery, and stick any
2508 message back into the shadow_message field in the original. */
2510 if (shadow_addr != NULL)
2512 int save_count = transport_count;
2514 DEBUG(D_deliver|D_transport)
2515 debug_printf(">>>>>>>>>>>>>>>> Shadow delivery >>>>>>>>>>>>>>>>\n");
2516 deliver_local(shadow_addr, TRUE);
2518 for(; shadow_addr != NULL; shadow_addr = shadow_addr->next)
2520 int sresult = shadow_addr->transport_return;
2521 *((uschar **)(shadow_addr->shadow_message)) = (sresult == OK)?
2522 string_sprintf(" ST=%s", stp->name) :
2523 string_sprintf(" ST=%s (%s%s%s)", stp->name,
2524 (shadow_addr->basic_errno <= 0)?
2525 US"" : US strerror(shadow_addr->basic_errno),
2526 (shadow_addr->basic_errno <= 0 || shadow_addr->message == NULL)?
2528 (shadow_addr->message != NULL)? shadow_addr->message :
2529 (shadow_addr->basic_errno <= 0)? US"unknown error" : US"");
2531 DEBUG(D_deliver|D_transport)
2532 debug_printf("%s shadow transport returned %s for %s\n",
2534 (sresult == OK)? "OK" :
2535 (sresult == DEFER)? "DEFER" :
2536 (sresult == FAIL)? "FAIL" :
2537 (sresult == PANIC)? "PANIC" : "?",
2538 shadow_addr->address);
2541 DEBUG(D_deliver|D_transport)
2542 debug_printf(">>>>>>>>>>>>>>>> End shadow delivery >>>>>>>>>>>>>>>>\n");
2544 transport_count = save_count; /* Restore original transport count */
2548 /* Cancel the expansions that were set up for the delivery. */
2550 deliver_set_expansions(NULL);
2552 /* Now we can process the results of the real transport. We must take each
2553 address off the chain first, because post_process_one() puts it on another
2556 for (addr2 = addr; addr2 != NULL; addr2 = nextaddr)
2558 int result = addr2->transport_return;
2559 nextaddr = addr2->next;
2561 DEBUG(D_deliver|D_transport)
2562 debug_printf("%s transport returned %s for %s\n",
2564 (result == OK)? "OK" :
2565 (result == DEFER)? "DEFER" :
2566 (result == FAIL)? "FAIL" :
2567 (result == PANIC)? "PANIC" : "?",
2570 /* If there is a retry_record, or if delivery is deferred, build a retry
2571 item for setting a new retry time or deleting the old retry record from
2572 the database. These items are handled all together after all addresses
2573 have been handled (so the database is open just for a short time for
2576 if (result == DEFER || testflag(addr2, af_lt_retry_exists))
2578 int flags = (result == DEFER)? 0 : rf_delete;
2579 uschar *retry_key = string_copy((tp->retry_use_local_part)?
2580 addr2->address_retry_key : addr2->domain_retry_key);
2582 retry_add_item(addr2, retry_key, flags);
2585 /* Done with this address */
2587 if (result == OK) addr2->more_errno = deliver_time;
2588 post_process_one(addr2, result, logflags, DTYPE_TRANSPORT, logchar);
2590 /* If a pipe delivery generated text to be sent back, the result may be
2591 changed to FAIL, and we must copy this for subsequent addresses in the
2594 if (addr2->transport_return != result)
2596 for (addr3 = nextaddr; addr3 != NULL; addr3 = addr3->next)
2598 addr3->transport_return = addr2->transport_return;
2599 addr3->basic_errno = addr2->basic_errno;
2600 addr3->message = addr2->message;
2602 result = addr2->transport_return;
2605 /* Whether or not the result was changed to FAIL, we need to copy the
2606 return_file value from the first address into all the addresses of the
2607 batch, so they are all listed in the error message. */
2609 addr2->return_file = addr->return_file;
2611 /* Change log character for recording successful deliveries. */
2613 if (result == OK) logchar = '-';
2615 } /* Loop back for next batch of addresses */
2621 /*************************************************
2622 * Sort remote deliveries *
2623 *************************************************/
2625 /* This function is called if remote_sort_domains is set. It arranges that the
2626 chain of addresses for remote deliveries is ordered according to the strings
2627 specified. Try to make this shuffling reasonably efficient by handling
2628 sequences of addresses rather than just single ones.
2635 sort_remote_deliveries(void)
2638 address_item **aptr = &addr_remote;
2639 uschar *listptr = remote_sort_domains;
2643 while (*aptr != NULL &&
2644 (pattern = string_nextinlist(&listptr, &sep, patbuf, sizeof(patbuf)))
2647 address_item *moved = NULL;
2648 address_item **bptr = &moved;
2650 while (*aptr != NULL)
2652 address_item **next;
2653 deliver_domain = (*aptr)->domain; /* set $domain */
2654 if (match_isinlist(deliver_domain, &pattern, UCHAR_MAX+1,
2655 &domainlist_anchor, NULL, MCL_DOMAIN, TRUE, NULL) == OK)
2657 aptr = &((*aptr)->next);
2661 next = &((*aptr)->next);
2662 while (*next != NULL &&
2663 (deliver_domain = (*next)->domain, /* Set $domain */
2664 match_isinlist(deliver_domain, &pattern, UCHAR_MAX+1,
2665 &domainlist_anchor, NULL, MCL_DOMAIN, TRUE, NULL)) != OK)
2666 next = &((*next)->next);
2668 /* If the batch of non-matchers is at the end, add on any that were
2669 extracted further up the chain, and end this iteration. Otherwise,
2670 extract them from the chain and hang on the moved chain. */
2682 aptr = &((*aptr)->next);
2685 /* If the loop ended because the final address matched, *aptr will
2686 be NULL. Add on to the end any extracted non-matching addresses. If
2687 *aptr is not NULL, the loop ended via "break" when *next is null, that
2688 is, there was a string of non-matching addresses at the end. In this
2689 case the extracted addresses have already been added on the end. */
2691 if (*aptr == NULL) *aptr = moved;
2697 debug_printf("remote addresses after sorting:\n");
2698 for (addr = addr_remote; addr != NULL; addr = addr->next)
2699 debug_printf(" %s\n", addr->address);
2705 /*************************************************
2706 * Read from pipe for remote delivery subprocess *
2707 *************************************************/
2709 /* This function is called when the subprocess is complete, but can also be
2710 called before it is complete, in order to empty a pipe that is full (to prevent
2711 deadlock). It must therefore keep track of its progress in the parlist data
2714 We read the pipe to get the delivery status codes and a possible error message
2715 for each address, optionally preceded by unusability data for the hosts and
2716 also by optional retry data.
2718 Read in large chunks into the big buffer and then scan through, interpreting
2719 the data therein. In most cases, only a single read will be necessary. No
2720 individual item will ever be anywhere near 2500 bytes in length, so by ensuring
2721 that we read the next chunk when there is less than 2500 bytes left in the
2722 non-final chunk, we can assume each item is complete in the buffer before
2723 handling it. Each item is written using a single write(), which is atomic for
2724 small items (less than PIPE_BUF, which seems to be at least 512 in any Unix and
2725 often bigger) so even if we are reading while the subprocess is still going, we
2726 should never have only a partial item in the buffer.
2729 poffset the offset of the parlist item
2730 eop TRUE if the process has completed
2732 Returns: TRUE if the terminating 'Z' item has been read,
2733 or there has been a disaster (i.e. no more data needed);
2738 par_read_pipe(int poffset, BOOL eop)
2741 pardata *p = parlist + poffset;
2742 address_item *addrlist = p->addrlist;
2743 address_item *addr = p->addr;
2746 uschar *endptr = big_buffer;
2747 uschar *ptr = endptr;
2748 uschar *msg = p->msg;
2749 BOOL done = p->done;
2750 BOOL unfinished = TRUE;
2752 /* Loop through all items, reading from the pipe when necessary. The pipe
2753 is set up to be non-blocking, but there are two different Unix mechanisms in
2754 use. Exim uses O_NONBLOCK if it is defined. This returns 0 for end of file,
2755 and EAGAIN for no more data. If O_NONBLOCK is not defined, Exim uses O_NDELAY,
2756 which returns 0 for both end of file and no more data. We distinguish the
2757 two cases by taking 0 as end of file only when we know the process has
2760 Each separate item is written to the pipe in a single write(), and as they are
2761 all short items, the writes will all be atomic and we should never find
2762 ourselves in the position of having read an incomplete item. "Short" in this
2763 case can mean up to about 1K in the case when there is a long error message
2764 associated with an address. */
2766 DEBUG(D_deliver) debug_printf("reading pipe for subprocess %d (%s)\n",
2767 (int)p->pid, eop? "ended" : "not ended");
2771 retry_item *r, **rp;
2772 int remaining = endptr - ptr;
2774 /* Read (first time) or top up the chars in the buffer if necessary.
2775 There will be only one read if we get all the available data (i.e. don't
2776 fill the buffer completely). */
2778 if (remaining < 2500 && unfinished)
2781 int available = big_buffer_size - remaining;
2783 if (remaining > 0) memmove(big_buffer, ptr, remaining);
2786 endptr = big_buffer + remaining;
2787 len = read(fd, endptr, available);
2789 DEBUG(D_deliver) debug_printf("read() yielded %d\n", len);
2791 /* If the result is EAGAIN and the process is not complete, just
2792 stop reading any more and process what we have already. */
2796 if (!eop && errno == EAGAIN) len = 0; else
2798 msg = string_sprintf("failed to read pipe from transport process "
2799 "%d for transport %s: %s", pid, addr->transport->driver_name,
2805 /* If the length is zero (eof or no-more-data), just process what we
2806 already have. Note that if the process is still running and we have
2807 read all the data in the pipe (but less that "available") then we
2808 won't read any more, as "unfinished" will get set FALSE. */
2811 unfinished = len == available;
2814 /* If we are at the end of the available data, exit the loop. */
2816 if (ptr >= endptr) break;
2818 /* Handle each possible type of item, assuming the complete item is
2819 available in store. */
2823 /* Host items exist only if any hosts were marked unusable. Match
2824 up by checking the IP address. */
2827 for (h = addrlist->host_list; h != NULL; h = h->next)
2829 if (h->address == NULL || Ustrcmp(h->address, ptr+2) != 0) continue;
2837 /* Retry items are sent in a preceding R item for each address. This is
2838 kept separate to keep each message short enough to guarantee it won't
2839 be split in the pipe. Hopefully, in the majority of cases, there won't in
2840 fact be any retry items at all.
2842 The complete set of retry items might include an item to delete a
2843 routing retry if there was a previous routing delay. However, routing
2844 retries are also used when a remote transport identifies an address error.
2845 In that case, there may also be an "add" item for the same key. Arrange
2846 that a "delete" item is dropped in favour of an "add" item. */
2849 if (addr == NULL) goto ADDR_MISMATCH;
2851 DEBUG(D_deliver|D_retry)
2852 debug_printf("reading retry information for %s from subprocess\n",
2855 /* Cut out any "delete" items on the list. */
2857 for (rp = &(addr->retries); (r = *rp) != NULL; rp = &(r->next))
2859 if (Ustrcmp(r->key, ptr+1) == 0) /* Found item with same key */
2861 if ((r->flags & rf_delete) == 0) break; /* It was not "delete" */
2862 *rp = r->next; /* Excise a delete item */
2863 DEBUG(D_deliver|D_retry)
2864 debug_printf(" existing delete item dropped\n");
2868 /* We want to add a delete item only if there is no non-delete item;
2869 however we still have to step ptr through the data. */
2871 if (r == NULL || (*ptr & rf_delete) == 0)
2873 r = store_get(sizeof(retry_item));
2874 r->next = addr->retries;
2877 r->key = string_copy(ptr);
2879 memcpy(&(r->basic_errno), ptr, sizeof(r->basic_errno));
2880 ptr += sizeof(r->basic_errno);
2881 memcpy(&(r->more_errno), ptr, sizeof(r->more_errno));
2882 ptr += sizeof(r->more_errno);
2883 r->message = (*ptr)? string_copy(ptr) : NULL;
2884 DEBUG(D_deliver|D_retry)
2885 debug_printf(" added %s item\n",
2886 ((r->flags & rf_delete) == 0)? "retry" : "delete");
2891 DEBUG(D_deliver|D_retry)
2892 debug_printf(" delete item not added: non-delete item exists\n");
2895 ptr += sizeof(r->basic_errno) + sizeof(r->more_errno);
2901 /* Put the amount of data written into the parlist block */
2904 memcpy(&(p->transport_count), ptr, sizeof(transport_count));
2905 ptr += sizeof(transport_count);
2908 /* Address items are in the order of items on the address chain. We
2909 remember the current address value in case this function is called
2910 several times to empty the pipe in stages. Information about delivery
2911 over TLS is sent in a preceding X item for each address. We don't put
2912 it in with the other info, in order to keep each message short enough to
2913 guarantee it won't be split in the pipe. */
2917 if (addr == NULL) goto ADDR_MISMATCH; /* Below, in 'A' handler */
2918 addr->cipher = (*ptr)? string_copy(ptr) : NULL;
2920 addr->peerdn = (*ptr)? string_copy(ptr) : NULL;
2925 case 'C': /* client authenticator information */
2929 addr->authenticator = (*ptr)? string_copy(ptr) : NULL;
2932 addr->auth_id = (*ptr)? string_copy(ptr) : NULL;
2935 addr->auth_sndr = (*ptr)? string_copy(ptr) : NULL;
2941 #ifdef EXPERIMENTAL_PRDR
2943 addr->flags |= af_prdr_used; break;
2950 msg = string_sprintf("address count mismatch for data read from pipe "
2951 "for transport process %d for transport %s", pid,
2952 addrlist->transport->driver_name);
2957 addr->transport_return = *ptr++;
2958 addr->special_action = *ptr++;
2959 memcpy(&(addr->basic_errno), ptr, sizeof(addr->basic_errno));
2960 ptr += sizeof(addr->basic_errno);
2961 memcpy(&(addr->more_errno), ptr, sizeof(addr->more_errno));
2962 ptr += sizeof(addr->more_errno);
2963 memcpy(&(addr->flags), ptr, sizeof(addr->flags));
2964 ptr += sizeof(addr->flags);
2965 addr->message = (*ptr)? string_copy(ptr) : NULL;
2967 addr->user_message = (*ptr)? string_copy(ptr) : NULL;
2970 /* Always two strings for host information, followed by the port number */
2974 h = store_get(sizeof(host_item));
2975 h->name = string_copy(ptr);
2977 h->address = string_copy(ptr);
2979 memcpy(&(h->port), ptr, sizeof(h->port));
2980 ptr += sizeof(h->port);
2981 addr->host_used = h;
2985 /* Finished with this address */
2990 /* Z marks the logical end of the data. It is followed by '0' if
2991 continue_transport was NULL at the end of transporting, otherwise '1'.
2992 We need to know when it becomes NULL during a delivery down a passed SMTP
2993 channel so that we don't try to pass anything more down it. Of course, for
2994 most normal messages it will remain NULL all the time. */
2999 continue_transport = NULL;
3000 continue_hostname = NULL;
3003 DEBUG(D_deliver) debug_printf("Z%c item read\n", *ptr);
3006 /* Anything else is a disaster. */
3009 msg = string_sprintf("malformed data (%d) read from pipe for transport "
3010 "process %d for transport %s", ptr[-1], pid,
3011 addr->transport->driver_name);
3017 /* The done flag is inspected externally, to determine whether or not to
3018 call the function again when the process finishes. */
3022 /* If the process hadn't finished, and we haven't seen the end of the data
3023 or suffered a disaster, update the rest of the state, and return FALSE to
3024 indicate "not finished". */
3033 /* Close our end of the pipe, to prevent deadlock if the far end is still
3034 pushing stuff into it. */
3039 /* If we have finished without error, but haven't had data for every address,
3040 something is wrong. */
3042 if (msg == NULL && addr != NULL)
3043 msg = string_sprintf("insufficient address data read from pipe "
3044 "for transport process %d for transport %s", pid,
3045 addr->transport->driver_name);
3047 /* If an error message is set, something has gone wrong in getting back
3048 the delivery data. Put the message into each address and freeze it. */
3052 for (addr = addrlist; addr != NULL; addr = addr->next)
3054 addr->transport_return = DEFER;
3055 addr->special_action = SPECIAL_FREEZE;
3056 addr->message = msg;
3060 /* Return TRUE to indicate we have got all we need from this process, even
3061 if it hasn't actually finished yet. */
3068 /*************************************************
3069 * Post-process a set of remote addresses *
3070 *************************************************/
3072 /* Do what has to be done immediately after a remote delivery for each set of
3073 addresses, then re-write the spool if necessary. Note that post_process_one
3074 puts the address on an appropriate queue; hence we must fish off the next
3075 one first. This function is also called if there is a problem with setting
3076 up a subprocess to do a remote delivery in parallel. In this case, the final
3077 argument contains a message, and the action must be forced to DEFER.
3080 addr pointer to chain of address items
3081 logflags flags for logging
3082 msg NULL for normal cases; -> error message for unexpected problems
3083 fallback TRUE if processing fallback hosts
3089 remote_post_process(address_item *addr, int logflags, uschar *msg,
3094 /* If any host addresses were found to be unusable, add them to the unusable
3095 tree so that subsequent deliveries don't try them. */
3097 for (h = addr->host_list; h != NULL; h = h->next)
3099 if (h->address == NULL) continue;
3100 if (h->status >= hstatus_unusable) tree_add_unusable(h);
3103 /* Now handle each address on the chain. The transport has placed '=' or '-'
3104 into the special_action field for each successful delivery. */
3106 while (addr != NULL)
3108 address_item *next = addr->next;
3110 /* If msg == NULL (normal processing) and the result is DEFER and we are
3111 processing the main hosts and there are fallback hosts available, put the
3112 address on the list for fallback delivery. */
3114 if (addr->transport_return == DEFER &&
3115 addr->fallback_hosts != NULL &&
3119 addr->host_list = addr->fallback_hosts;
3120 addr->next = addr_fallback;
3121 addr_fallback = addr;
3122 DEBUG(D_deliver) debug_printf("%s queued for fallback host(s)\n", addr->address);
3125 /* If msg is set (=> unexpected problem), set it in the address before
3126 doing the ordinary post processing. */
3132 addr->message = msg;
3133 addr->transport_return = DEFER;
3135 (void)post_process_one(addr, addr->transport_return, logflags,
3136 DTYPE_TRANSPORT, addr->special_action);
3144 /* If we have just delivered down a passed SMTP channel, and that was
3145 the last address, the channel will have been closed down. Now that
3146 we have logged that delivery, set continue_sequence to 1 so that
3147 any subsequent deliveries don't get "*" incorrectly logged. */
3149 if (continue_transport == NULL) continue_sequence = 1;
3154 /*************************************************
3155 * Wait for one remote delivery subprocess *
3156 *************************************************/
3158 /* This function is called while doing remote deliveries when either the
3159 maximum number of processes exist and we need one to complete so that another
3160 can be created, or when waiting for the last ones to complete. It must wait for
3161 the completion of one subprocess, empty the control block slot, and return a
3162 pointer to the address chain.
3165 Returns: pointer to the chain of addresses handled by the process;
3166 NULL if no subprocess found - this is an unexpected error
3169 static address_item *
3172 int poffset, status;
3173 address_item *addr, *addrlist;
3176 set_process_info("delivering %s: waiting for a remote delivery subprocess "
3177 "to finish", message_id);
3179 /* Loop until either a subprocess completes, or there are no subprocesses in
3180 existence - in which case give an error return. We cannot proceed just by
3181 waiting for a completion, because a subprocess may have filled up its pipe, and
3182 be waiting for it to be emptied. Therefore, if no processes have finished, we
3183 wait for one of the pipes to acquire some data by calling select(), with a
3184 timeout just in case.
3186 The simple approach is just to iterate after reading data from a ready pipe.
3187 This leads to non-ideal behaviour when the subprocess has written its final Z
3188 item, closed the pipe, and is in the process of exiting (the common case). A
3189 call to waitpid() yields nothing completed, but select() shows the pipe ready -
3190 reading it yields EOF, so you end up with busy-waiting until the subprocess has
3193 To avoid this, if all the data that is needed has been read from a subprocess
3194 after select(), an explicit wait() for it is done. We know that all it is doing
3195 is writing to the pipe and then exiting, so the wait should not be long.
3197 The non-blocking waitpid() is to some extent just insurance; if we could
3198 reliably detect end-of-file on the pipe, we could always know when to do a
3199 blocking wait() for a completed process. However, because some systems use
3200 NDELAY, which doesn't distinguish between EOF and pipe empty, it is easier to
3201 use code that functions without the need to recognize EOF.
3203 There's a double loop here just in case we end up with a process that is not in
3204 the list of remote delivery processes. Something has obviously gone wrong if
3205 this is the case. (For example, a process that is incorrectly left over from
3206 routing or local deliveries might be found.) The damage can be minimized by
3207 looping back and looking for another process. If there aren't any, the error
3208 return will happen. */
3210 for (;;) /* Normally we do not repeat this loop */
3212 while ((pid = waitpid(-1, &status, WNOHANG)) <= 0)
3215 fd_set select_pipes;
3216 int maxpipe, readycount;
3218 /* A return value of -1 can mean several things. If errno != ECHILD, it
3219 either means invalid options (which we discount), or that this process was
3220 interrupted by a signal. Just loop to try the waitpid() again.
3222 If errno == ECHILD, waitpid() is telling us that there are no subprocesses
3223 in existence. This should never happen, and is an unexpected error.
3224 However, there is a nasty complication when running under Linux. If "strace
3225 -f" is being used under Linux to trace this process and its children,
3226 subprocesses are "stolen" from their parents and become the children of the
3227 tracing process. A general wait such as the one we've just obeyed returns
3228 as if there are no children while subprocesses are running. Once a
3229 subprocess completes, it is restored to the parent, and waitpid(-1) finds
3230 it. Thanks to Joachim Wieland for finding all this out and suggesting a
3233 This does not happen using "truss" on Solaris, nor (I think) with other
3234 tracing facilities on other OS. It seems to be specific to Linux.
3236 What we do to get round this is to use kill() to see if any of our
3237 subprocesses are still in existence. If kill() gives an OK return, we know
3238 it must be for one of our processes - it can't be for a re-use of the pid,
3239 because if our process had finished, waitpid() would have found it. If any
3240 of our subprocesses are in existence, we proceed to use select() as if
3241 waitpid() had returned zero. I think this is safe. */
3245 if (errno != ECHILD) continue; /* Repeats the waitpid() */
3248 debug_printf("waitpid() returned -1/ECHILD: checking explicitly "
3249 "for process existence\n");
3251 for (poffset = 0; poffset < remote_max_parallel; poffset++)
3253 if ((pid = parlist[poffset].pid) != 0 && kill(pid, 0) == 0)
3255 DEBUG(D_deliver) debug_printf("process %d still exists: assume "
3256 "stolen by strace\n", (int)pid);
3257 break; /* With poffset set */
3261 if (poffset >= remote_max_parallel)
3263 DEBUG(D_deliver) debug_printf("*** no delivery children found\n");
3264 return NULL; /* This is the error return */
3268 /* A pid value greater than 0 breaks the "while" loop. A negative value has
3269 been handled above. A return value of zero means that there is at least one
3270 subprocess, but there are no completed subprocesses. See if any pipes are
3271 ready with any data for reading. */
3273 DEBUG(D_deliver) debug_printf("selecting on subprocess pipes\n");
3276 FD_ZERO(&select_pipes);
3277 for (poffset = 0; poffset < remote_max_parallel; poffset++)
3279 if (parlist[poffset].pid != 0)
3281 int fd = parlist[poffset].fd;
3282 FD_SET(fd, &select_pipes);
3283 if (fd > maxpipe) maxpipe = fd;
3287 /* Stick in a 60-second timeout, just in case. */
3292 readycount = select(maxpipe + 1, (SELECT_ARG2_TYPE *)&select_pipes,
3295 /* Scan through the pipes and read any that are ready; use the count
3296 returned by select() to stop when there are no more. Select() can return
3297 with no processes (e.g. if interrupted). This shouldn't matter.
3299 If par_read_pipe() returns TRUE, it means that either the terminating Z was
3300 read, or there was a disaster. In either case, we are finished with this
3301 process. Do an explicit wait() for the process and break the main loop if
3304 It turns out that we have to deal with the case of an interrupted system
3305 call, which can happen on some operating systems if the signal handling is
3306 set up to do that by default. */
3309 readycount > 0 && poffset < remote_max_parallel;
3312 if ((pid = parlist[poffset].pid) != 0 &&
3313 FD_ISSET(parlist[poffset].fd, &select_pipes))
3316 if (par_read_pipe(poffset, FALSE)) /* Finished with this pipe */
3318 for (;;) /* Loop for signals */
3320 pid_t endedpid = waitpid(pid, &status, 0);
3321 if (endedpid == pid) goto PROCESS_DONE;
3322 if (endedpid != (pid_t)(-1) || errno != EINTR)
3323 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Unexpected error return "
3324 "%d (errno = %d) from waitpid() for process %d",
3325 (int)endedpid, errno, (int)pid);
3331 /* Now go back and look for a completed subprocess again. */
3334 /* A completed process was detected by the non-blocking waitpid(). Find the
3335 data block that corresponds to this subprocess. */
3337 for (poffset = 0; poffset < remote_max_parallel; poffset++)
3338 if (pid == parlist[poffset].pid) break;
3340 /* Found the data block; this is a known remote delivery process. We don't
3341 need to repeat the outer loop. This should be what normally happens. */
3343 if (poffset < remote_max_parallel) break;
3345 /* This situation is an error, but it's probably better to carry on looking
3346 for another process than to give up (as we used to do). */
3348 log_write(0, LOG_MAIN|LOG_PANIC, "Process %d finished: not found in remote "
3349 "transport process list", pid);
3350 } /* End of the "for" loop */
3352 /* Come here when all the data was completely read after a select(), and
3353 the process in pid has been wait()ed for. */
3360 debug_printf("remote delivery process %d ended\n", (int)pid);
3362 debug_printf("remote delivery process %d ended: status=%04x\n", (int)pid,
3366 set_process_info("delivering %s", message_id);
3368 /* Get the chain of processed addresses */
3370 addrlist = parlist[poffset].addrlist;
3372 /* If the process did not finish cleanly, record an error and freeze (except
3373 for SIGTERM, SIGKILL and SIGQUIT), and also ensure the journal is not removed,
3374 in case the delivery did actually happen. */
3376 if ((status & 0xffff) != 0)
3379 int msb = (status >> 8) & 255;
3380 int lsb = status & 255;
3381 int code = (msb == 0)? (lsb & 0x7f) : msb;
3383 msg = string_sprintf("%s transport process returned non-zero status 0x%04x: "
3385 addrlist->transport->driver_name,
3387 (msb == 0)? "terminated by signal" : "exit code",
3390 if (msb != 0 || (code != SIGTERM && code != SIGKILL && code != SIGQUIT))
3391 addrlist->special_action = SPECIAL_FREEZE;
3393 for (addr = addrlist; addr != NULL; addr = addr->next)
3395 addr->transport_return = DEFER;
3396 addr->message = msg;
3399 remove_journal = FALSE;
3402 /* Else complete reading the pipe to get the result of the delivery, if all
3403 the data has not yet been obtained. */
3405 else if (!parlist[poffset].done) (void)par_read_pipe(poffset, TRUE);
3407 /* Put the data count and return path into globals, mark the data slot unused,
3408 decrement the count of subprocesses, and return the address chain. */
3410 transport_count = parlist[poffset].transport_count;
3411 used_return_path = parlist[poffset].return_path;
3412 parlist[poffset].pid = 0;
3419 /*************************************************
3420 * Wait for subprocesses and post-process *
3421 *************************************************/
3423 /* This function waits for subprocesses until the number that are still running
3424 is below a given threshold. For each complete subprocess, the addresses are
3425 post-processed. If we can't find a running process, there is some shambles.
3426 Better not bomb out, as that might lead to multiple copies of the message. Just
3427 log and proceed as if all done.
3430 max maximum number of subprocesses to leave running
3431 fallback TRUE if processing fallback hosts
3437 par_reduce(int max, BOOL fallback)
3439 while (parcount > max)
3441 address_item *doneaddr = par_wait();
3442 if (doneaddr == NULL)
3444 log_write(0, LOG_MAIN|LOG_PANIC,
3445 "remote delivery process count got out of step");
3448 else remote_post_process(doneaddr, LOG_MAIN, NULL, fallback);
3456 rmt_dlv_checked_write(int fd, void * buf, int size)
3458 int ret = write(fd, buf, size);
3460 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Failed writing transport result to pipe: %s\n",
3461 ret == -1 ? strerror(errno) : "short write");
3464 /*************************************************
3465 * Do remote deliveries *
3466 *************************************************/
3468 /* This function is called to process the addresses in addr_remote. We must
3469 pick off the queue all addresses that have the same transport, remote
3470 destination, and errors address, and hand them to the transport in one go,
3471 subject to some configured limitations. If this is a run to continue delivering
3472 to an existing delivery channel, skip all but those addresses that can go to
3473 that channel. The skipped addresses just get deferred.
3475 If mua_wrapper is set, all addresses must be able to be sent in a single
3476 transaction. If not, this function yields FALSE.
3478 In Exim 4, remote deliveries are always done in separate processes, even
3479 if remote_max_parallel = 1 or if there's only one delivery to do. The reason
3480 is so that the base process can retain privilege. This makes the
3481 implementation of fallback transports feasible (though not initially done.)
3483 We create up to the configured number of subprocesses, each of which passes
3484 back the delivery state via a pipe. (However, when sending down an existing
3485 connection, remote_max_parallel is forced to 1.)
3488 fallback TRUE if processing fallback hosts
3490 Returns: TRUE normally
3491 FALSE if mua_wrapper is set and the addresses cannot all be sent
3496 do_remote_deliveries(BOOL fallback)
3502 parcount = 0; /* Number of executing subprocesses */
3504 /* When sending down an existing channel, only do one delivery at a time.
3505 We use a local variable (parmax) to hold the maximum number of processes;
3506 this gets reduced from remote_max_parallel if we can't create enough pipes. */
3508 if (continue_transport != NULL) remote_max_parallel = 1;
3509 parmax = remote_max_parallel;
3511 /* If the data for keeping a list of processes hasn't yet been
3514 if (parlist == NULL)
3516 parlist = store_get(remote_max_parallel * sizeof(pardata));
3517 for (poffset = 0; poffset < remote_max_parallel; poffset++)
3518 parlist[poffset].pid = 0;
3521 /* Now loop for each remote delivery */
3523 for (delivery_count = 0; addr_remote != NULL; delivery_count++)
3529 int address_count = 1;
3530 int address_count_max;
3532 BOOL use_initgroups;
3533 BOOL pipe_done = FALSE;
3534 transport_instance *tp;
3535 address_item **anchor = &addr_remote;
3536 address_item *addr = addr_remote;
3537 address_item *last = addr;
3540 /* Pull the first address right off the list. */
3542 addr_remote = addr->next;
3545 DEBUG(D_deliver|D_transport)
3546 debug_printf("--------> %s <--------\n", addr->address);
3548 /* If no transport has been set, there has been a big screw-up somewhere. */
3550 if ((tp = addr->transport) == NULL)
3552 disable_logging = FALSE; /* Jic */
3553 remote_post_process(addr, LOG_MAIN|LOG_PANIC,
3554 US"No transport set by router", fallback);
3558 /* Check that this base address hasn't previously been delivered to this
3559 transport. The check is necessary at this point to handle homonymic addresses
3560 correctly in cases where the pattern of redirection changes between delivery
3561 attempts. Non-homonymic previous delivery is detected earlier, at routing
3564 if (previously_transported(addr, FALSE)) continue;
3566 /* Force failure if the message is too big. */
3568 if (tp->message_size_limit != NULL)
3570 int rc = check_message_size(tp, addr);
3573 addr->transport_return = rc;
3574 remote_post_process(addr, LOG_MAIN, NULL, fallback);
3579 /* Get the flag which specifies whether the transport can handle different
3580 domains that nevertheless resolve to the same set of hosts. */
3582 multi_domain = tp->multi_domain;
3584 /* Get the maximum it can handle in one envelope, with zero meaning
3585 unlimited, which is forced for the MUA wrapper case. */
3587 address_count_max = tp->max_addresses;
3588 if (address_count_max == 0 || mua_wrapper) address_count_max = 999999;
3591 /************************************************************************/
3592 /***** This is slightly experimental code, but should be safe. *****/
3594 /* The address_count_max value is the maximum number of addresses that the
3595 transport can send in one envelope. However, the transport must be capable of
3596 dealing with any number of addresses. If the number it gets exceeds its
3597 envelope limitation, it must send multiple copies of the message. This can be
3598 done over a single connection for SMTP, so uses less resources than making
3599 multiple connections. On the other hand, if remote_max_parallel is greater
3600 than one, it is perhaps a good idea to use parallel processing to move the
3601 message faster, even if that results in multiple simultaneous connections to
3604 How can we come to some compromise between these two ideals? What we do is to
3605 limit the number of addresses passed to a single instance of a transport to
3606 the greater of (a) its address limit (rcpt_max for SMTP) and (b) the total
3607 number of addresses routed to remote transports divided by
3608 remote_max_parallel. For example, if the message has 100 remote recipients,
3609 remote max parallel is 2, and rcpt_max is 10, we'd never send more than 50 at
3610 once. But if rcpt_max is 100, we could send up to 100.
3612 Of course, not all the remotely addresses in a message are going to go to the
3613 same set of hosts (except in smarthost configurations), so this is just a
3614 heuristic way of dividing up the work.
3616 Furthermore (1), because this may not be wanted in some cases, and also to
3617 cope with really pathological cases, there is also a limit to the number of
3618 messages that are sent over one connection. This is the same limit that is
3619 used when sending several different messages over the same connection.
3620 Continue_sequence is set when in this situation, to the number sent so
3621 far, including this message.
3623 Furthermore (2), when somebody explicitly sets the maximum value to 1, it
3624 is probably because they are using VERP, in which case they want to pass only
3625 one address at a time to the transport, in order to be able to use
3626 $local_part and $domain in constructing a new return path. We could test for
3627 the use of these variables, but as it is so likely they will be used when the
3628 maximum is 1, we don't bother. Just leave the value alone. */
3630 if (address_count_max != 1 &&
3631 address_count_max < remote_delivery_count/remote_max_parallel)
3633 int new_max = remote_delivery_count/remote_max_parallel;
3634 int message_max = tp->connection_max_messages;
3635 if (connection_max_messages >= 0) message_max = connection_max_messages;
3636 message_max -= continue_sequence - 1;
3637 if (message_max > 0 && new_max > address_count_max * message_max)
3638 new_max = address_count_max * message_max;
3639 address_count_max = new_max;
3642 /************************************************************************/
3645 /* Pick off all addresses which have the same transport, errors address,
3646 destination, and extra headers. In some cases they point to the same host
3647 list, but we also need to check for identical host lists generated from
3648 entirely different domains. The host list pointers can be NULL in the case
3649 where the hosts are defined in the transport. There is also a configured
3650 maximum limit of addresses that can be handled at once (see comments above
3651 for how it is computed). */
3653 while ((next = *anchor) != NULL && address_count < address_count_max)
3655 if ((multi_domain || Ustrcmp(next->domain, addr->domain) == 0)
3657 tp == next->transport
3659 same_hosts(next->host_list, addr->host_list)
3661 same_strings(next->p.errors_address, addr->p.errors_address)
3663 same_headers(next->p.extra_headers, addr->p.extra_headers)
3665 same_ugid(tp, next, addr)
3667 (next->p.remove_headers == addr->p.remove_headers ||
3668 (next->p.remove_headers != NULL &&
3669 addr->p.remove_headers != NULL &&
3670 Ustrcmp(next->p.remove_headers, addr->p.remove_headers) == 0)))
3672 *anchor = next->next;
3674 next->first = addr; /* remember top one (for retry processing) */
3679 else anchor = &(next->next);
3682 /* If we are acting as an MUA wrapper, all addresses must go in a single
3683 transaction. If not, put them back on the chain and yield FALSE. */
3685 if (mua_wrapper && addr_remote != NULL)
3687 last->next = addr_remote;
3692 /* Set up the expansion variables for this set of addresses */
3694 deliver_set_expansions(addr);
3696 /* Ensure any transport-set auth info is fresh */
3697 addr->authenticator = addr->auth_id = addr->auth_sndr = NULL;
3699 /* Compute the return path, expanding a new one if required. The old one
3700 must be set first, as it might be referred to in the expansion. */
3702 if(addr->p.errors_address != NULL)
3703 return_path = addr->p.errors_address;
3704 #ifdef EXPERIMENTAL_SRS
3705 else if(addr->p.srs_sender != NULL)
3706 return_path = addr->p.srs_sender;
3709 return_path = sender_address;
3711 if (tp->return_path != NULL)
3713 uschar *new_return_path = expand_string(tp->return_path);
3714 if (new_return_path == NULL)
3716 if (!expand_string_forcedfail)
3718 remote_post_process(addr, LOG_MAIN|LOG_PANIC,
3719 string_sprintf("Failed to expand return path \"%s\": %s",
3720 tp->return_path, expand_string_message), fallback);
3724 else return_path = new_return_path;
3727 /* Find the uid, gid, and use_initgroups setting for this transport. Failure
3728 logs and sets up error messages, so we just post-process and continue with
3729 the next address. */
3731 if (!findugid(addr, tp, &uid, &gid, &use_initgroups))
3733 remote_post_process(addr, LOG_MAIN|LOG_PANIC, NULL, fallback);
3737 /* If this transport has a setup function, call it now so that it gets
3738 run in this process and not in any subprocess. That way, the results of
3739 any setup that are retained by the transport can be reusable. One of the
3740 things the setup does is to set the fallback host lists in the addresses.
3741 That is why it is called at this point, before the continue delivery
3742 processing, because that might use the fallback hosts. */
3744 if (tp->setup != NULL)
3745 (void)((tp->setup)(addr->transport, addr, NULL, uid, gid, NULL));
3747 /* If this is a run to continue delivery down an already-established
3748 channel, check that this set of addresses matches the transport and
3749 the channel. If it does not, defer the addresses. If a host list exists,
3750 we must check that the continue host is on the list. Otherwise, the
3751 host is set in the transport. */
3753 continue_more = FALSE; /* In case got set for the last lot */
3754 if (continue_transport != NULL)
3756 BOOL ok = Ustrcmp(continue_transport, tp->name) == 0;
3757 if (ok && addr->host_list != NULL)
3761 for (h = addr->host_list; h != NULL; h = h->next)
3763 if (Ustrcmp(h->name, continue_hostname) == 0)
3764 { ok = TRUE; break; }
3768 /* Addresses not suitable; defer or queue for fallback hosts (which
3769 might be the continue host) and skip to next address. */
3773 DEBUG(D_deliver) debug_printf("not suitable for continue_transport\n");
3776 if (addr->fallback_hosts != NULL && !fallback)
3780 next->host_list = next->fallback_hosts;
3781 DEBUG(D_deliver) debug_printf("%s queued for fallback host(s)\n", next->address);
3782 if (next->next == NULL) break;
3785 next->next = addr_fallback;
3786 addr_fallback = addr;
3791 while (next->next != NULL) next = next->next;
3792 next->next = addr_defer;
3799 /* Set a flag indicating whether there are further addresses that list
3800 the continued host. This tells the transport to leave the channel open,
3801 but not to pass it to another delivery process. */
3803 for (next = addr_remote; next != NULL; next = next->next)
3806 for (h = next->host_list; h != NULL; h = h->next)
3808 if (Ustrcmp(h->name, continue_hostname) == 0)
3809 { continue_more = TRUE; break; }
3814 /* The transports set up the process info themselves as they may connect
3815 to more than one remote machine. They also have to set up the filter
3816 arguments, if required, so that the host name and address are available
3819 transport_filter_argv = NULL;
3821 /* Create the pipe for inter-process communication. If pipe creation
3822 fails, it is probably because the value of remote_max_parallel is so
3823 large that too many file descriptors for pipes have been created. Arrange
3824 to wait for a process to finish, and then try again. If we still can't
3825 create a pipe when all processes have finished, break the retry loop. */
3829 if (pipe(pfd) == 0) pipe_done = TRUE;
3830 else if (parcount > 0) parmax = parcount;
3833 /* We need to make the reading end of the pipe non-blocking. There are
3834 two different options for this. Exim is cunningly (I hope!) coded so
3835 that it can use either of them, though it prefers O_NONBLOCK, which
3836 distinguishes between EOF and no-more-data. */
3839 (void)fcntl(pfd[pipe_read], F_SETFL, O_NONBLOCK);
3841 (void)fcntl(pfd[pipe_read], F_SETFL, O_NDELAY);
3844 /* If the maximum number of subprocesses already exist, wait for a process
3845 to finish. If we ran out of file descriptors, parmax will have been reduced
3846 from its initial value of remote_max_parallel. */
3848 par_reduce(parmax - 1, fallback);
3851 /* If we failed to create a pipe and there were no processes to wait
3852 for, we have to give up on this one. Do this outside the above loop
3853 so that we can continue the main loop. */
3857 remote_post_process(addr, LOG_MAIN|LOG_PANIC,
3858 string_sprintf("unable to create pipe: %s", strerror(errno)), fallback);
3862 /* Find a free slot in the pardata list. Must do this after the possible
3863 waiting for processes to finish, because a terminating process will free
3866 for (poffset = 0; poffset < remote_max_parallel; poffset++)
3867 if (parlist[poffset].pid == 0) break;
3869 /* If there isn't one, there has been a horrible disaster. */
3871 if (poffset >= remote_max_parallel)
3873 (void)close(pfd[pipe_write]);
3874 (void)close(pfd[pipe_read]);
3875 remote_post_process(addr, LOG_MAIN|LOG_PANIC,
3876 US"Unexpectedly no free subprocess slot", fallback);
3880 /* Now fork a subprocess to do the remote delivery, but before doing so,
3881 ensure that any cached resourses are released so as not to interfere with
3882 what happens in the subprocess. */
3886 if ((pid = fork()) == 0)
3888 int fd = pfd[pipe_write];
3891 /* Setting this global in the subprocess means we need never clear it */
3892 transport_name = tp->name;
3894 /* There are weird circumstances in which logging is disabled */
3895 disable_logging = tp->disable_logging;
3897 /* Show pids on debug output if parallelism possible */
3899 if (parmax > 1 && (parcount > 0 || addr_remote != NULL))
3901 DEBUG(D_any|D_v) debug_selector |= D_pid;
3902 DEBUG(D_deliver) debug_printf("Remote delivery process started\n");
3905 /* Reset the random number generator, so different processes don't all
3906 have the same sequence. In the test harness we want different, but
3907 predictable settings for each delivery process, so do something explicit
3908 here rather they rely on the fixed reset in the random number function. */
3910 random_seed = running_in_test_harness? 42 + 2*delivery_count : 0;
3912 /* Set close-on-exec on the pipe so that it doesn't get passed on to
3913 a new process that may be forked to do another delivery down the same
3916 (void)fcntl(fd, F_SETFD, fcntl(fd, F_GETFD) | FD_CLOEXEC);
3918 /* Close open file descriptors for the pipes of other processes
3919 that are running in parallel. */
3921 for (poffset = 0; poffset < remote_max_parallel; poffset++)
3922 if (parlist[poffset].pid != 0) (void)close(parlist[poffset].fd);
3924 /* This process has inherited a copy of the file descriptor
3925 for the data file, but its file pointer is shared with all the
3926 other processes running in parallel. Therefore, we have to re-open
3927 the file in order to get a new file descriptor with its own
3928 file pointer. We don't need to lock it, as the lock is held by
3929 the parent process. There doesn't seem to be any way of doing
3930 a dup-with-new-file-pointer. */
3932 (void)close(deliver_datafile);
3933 sprintf(CS spoolname, "%s/input/%s/%s-D", spool_directory, message_subdir,
3935 deliver_datafile = Uopen(spoolname, O_RDWR | O_APPEND, 0);
3937 if (deliver_datafile < 0)
3938 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Failed to reopen %s for remote "
3939 "parallel delivery: %s", spoolname, strerror(errno));
3941 /* Set the close-on-exec flag */
3943 (void)fcntl(deliver_datafile, F_SETFD, fcntl(deliver_datafile, F_GETFD) |
3946 /* Set the uid/gid of this process; bombs out on failure. */
3948 exim_setugid(uid, gid, use_initgroups,
3949 string_sprintf("remote delivery to %s with transport=%s",
3950 addr->address, tp->name));
3952 /* Close the unwanted half of this process' pipe, set the process state,
3953 and run the transport. Afterwards, transport_count will contain the number
3954 of bytes written. */
3956 (void)close(pfd[pipe_read]);
3957 set_process_info("delivering %s using %s", message_id, tp->name);
3958 debug_print_string(tp->debug_string);
3959 if (!(tp->info->code)(addr->transport, addr)) replicate_status(addr);
3961 set_process_info("delivering %s (just run %s for %s%s in subprocess)",
3962 message_id, tp->name, addr->address, (addr->next == NULL)? "" : ", ...");
3964 /* Ensure any cached resources that we used are now released */
3968 /* Pass the result back down the pipe. This is a lot more information
3969 than is needed for a local delivery. We have to send back the error
3970 status for each address, the usability status for each host that is
3971 flagged as unusable, and all the retry items. When TLS is in use, we
3972 send also the cipher and peerdn information. Each type of information
3973 is flagged by an identifying byte, and is then in a fixed format (with
3974 strings terminated by zeros), and there is a final terminator at the
3975 end. The host information and retry information is all attached to
3976 the first address, so that gets sent at the start. */
3978 /* Host unusability information: for most success cases this will
3981 for (h = addr->host_list; h != NULL; h = h->next)
3983 if (h->address == NULL || h->status < hstatus_unusable) continue;
3984 sprintf(CS big_buffer, "H%c%c%s", h->status, h->why, h->address);
3985 rmt_dlv_checked_write(fd, big_buffer, Ustrlen(big_buffer+3) + 4);
3988 /* The number of bytes written. This is the same for each address. Even
3989 if we sent several copies of the message down the same connection, the
3990 size of each one is the same, and it's that value we have got because
3991 transport_count gets reset before calling transport_write_message(). */
3993 big_buffer[0] = 'S';
3994 memcpy(big_buffer+1, &transport_count, sizeof(transport_count));
3995 rmt_dlv_checked_write(fd, big_buffer, sizeof(transport_count) + 1);
3997 /* Information about what happened to each address. Four item types are
3998 used: an optional 'X' item first, for TLS information, then an optional "C"
3999 item for any client-auth info followed by 'R' items for any retry settings,
4000 and finally an 'A' item for the remaining data. */
4002 for(; addr != NULL; addr = addr->next)
4007 /* The certificate verification status goes into the flags */
4009 if (tls_out.certificate_verified) setflag(addr, af_cert_verified);
4011 /* Use an X item only if there's something to send */
4014 if (addr->cipher != NULL)
4017 sprintf(CS ptr, "X%.128s", addr->cipher);
4019 if (addr->peerdn == NULL) *ptr++ = 0; else
4021 sprintf(CS ptr, "%.512s", addr->peerdn);
4024 rmt_dlv_checked_write(fd, big_buffer, ptr - big_buffer);
4028 if (client_authenticator)
4031 sprintf(CS big_buffer, "C1%.64s", client_authenticator);
4033 rmt_dlv_checked_write(fd, big_buffer, ptr - big_buffer);
4035 if (client_authenticated_id)
4038 sprintf(CS big_buffer, "C2%.64s", client_authenticated_id);
4040 rmt_dlv_checked_write(fd, big_buffer, ptr - big_buffer);
4042 if (client_authenticated_sender)
4045 sprintf(CS big_buffer, "C3%.64s", client_authenticated_sender);
4047 rmt_dlv_checked_write(fd, big_buffer, ptr - big_buffer);
4050 #ifdef EXPERIMENTAL_PRDR
4051 if (addr->flags & af_prdr_used) rmt_dlv_checked_write(fd, "P", 1);
4054 /* Retry information: for most success cases this will be null. */
4056 for (r = addr->retries; r != NULL; r = r->next)
4059 sprintf(CS big_buffer, "R%c%.500s", r->flags, r->key);
4060 ptr = big_buffer + Ustrlen(big_buffer+2) + 3;
4061 memcpy(ptr, &(r->basic_errno), sizeof(r->basic_errno));
4062 ptr += sizeof(r->basic_errno);
4063 memcpy(ptr, &(r->more_errno), sizeof(r->more_errno));
4064 ptr += sizeof(r->more_errno);
4065 if (r->message == NULL) *ptr++ = 0; else
4067 sprintf(CS ptr, "%.512s", r->message);
4070 rmt_dlv_checked_write(fd, big_buffer, ptr - big_buffer);
4073 /* The rest of the information goes in an 'A' item. */
4075 ptr = big_buffer + 3;
4076 sprintf(CS big_buffer, "A%c%c", addr->transport_return,
4077 addr->special_action);
4078 memcpy(ptr, &(addr->basic_errno), sizeof(addr->basic_errno));
4079 ptr += sizeof(addr->basic_errno);
4080 memcpy(ptr, &(addr->more_errno), sizeof(addr->more_errno));
4081 ptr += sizeof(addr->more_errno);
4082 memcpy(ptr, &(addr->flags), sizeof(addr->flags));
4083 ptr += sizeof(addr->flags);
4085 if (addr->message == NULL) *ptr++ = 0; else
4087 sprintf(CS ptr, "%.1024s", addr->message);
4091 if (addr->user_message == NULL) *ptr++ = 0; else
4093 sprintf(CS ptr, "%.1024s", addr->user_message);
4097 if (addr->host_used == NULL) *ptr++ = 0; else
4099 sprintf(CS ptr, "%.256s", addr->host_used->name);
4101 sprintf(CS ptr, "%.64s", addr->host_used->address);
4103 memcpy(ptr, &(addr->host_used->port), sizeof(addr->host_used->port));
4104 ptr += sizeof(addr->host_used->port);
4106 rmt_dlv_checked_write(fd, big_buffer, ptr - big_buffer);
4109 /* Add termination flag, close the pipe, and that's it. The character
4110 after 'Z' indicates whether continue_transport is now NULL or not.
4111 A change from non-NULL to NULL indicates a problem with a continuing
4114 big_buffer[0] = 'Z';
4115 big_buffer[1] = (continue_transport == NULL)? '0' : '1';
4116 rmt_dlv_checked_write(fd, big_buffer, 2);
4121 /* Back in the mainline: close the unwanted half of the pipe. */
4123 (void)close(pfd[pipe_write]);
4125 /* Fork failed; defer with error message */
4129 (void)close(pfd[pipe_read]);
4130 remote_post_process(addr, LOG_MAIN|LOG_PANIC,
4131 string_sprintf("fork failed for remote delivery to %s: %s",
4132 addr->domain, strerror(errno)), fallback);
4136 /* Fork succeeded; increment the count, and remember relevant data for
4137 when the process finishes. */
4140 parlist[poffset].addrlist = parlist[poffset].addr = addr;
4141 parlist[poffset].pid = pid;
4142 parlist[poffset].fd = pfd[pipe_read];
4143 parlist[poffset].done = FALSE;
4144 parlist[poffset].msg = NULL;
4145 parlist[poffset].return_path = return_path;
4147 /* If the process we've just started is sending a message down an existing
4148 channel, wait for it now. This ensures that only one such process runs at
4149 once, whatever the value of remote_max parallel. Otherwise, we might try to
4150 send two or more messages simultaneously down the same channel. This could
4151 happen if there are different domains that include the same host in otherwise
4152 different host lists.
4154 Also, if the transport closes down the channel, this information gets back
4155 (continue_transport gets set to NULL) before we consider any other addresses
4158 if (continue_transport != NULL) par_reduce(0, fallback);
4160 /* Otherwise, if we are running in the test harness, wait a bit, to let the
4161 newly created process get going before we create another process. This should
4162 ensure repeatability in the tests. We only need to wait a tad. */
4164 else if (running_in_test_harness) millisleep(500);
4167 /* Reached the end of the list of addresses. Wait for all the subprocesses that
4168 are still running and post-process their addresses. */
4170 par_reduce(0, fallback);
4177 /*************************************************
4178 * Split an address into local part and domain *
4179 *************************************************/
4181 /* This function initializes an address for routing by splitting it up into a
4182 local part and a domain. The local part is set up twice - once in its original
4183 casing, and once in lower case, and it is dequoted. We also do the "percent
4184 hack" for configured domains. This may lead to a DEFER result if a lookup
4185 defers. When a percent-hacking takes place, we insert a copy of the original
4186 address as a new parent of this address, as if we have had a redirection.
4189 addr points to an addr_item block containing the address
4192 DEFER - could not determine if domain is %-hackable
4196 deliver_split_address(address_item *addr)
4198 uschar *address = addr->address;
4199 uschar *domain = Ustrrchr(address, '@');
4201 int len = domain - address;
4203 addr->domain = string_copylc(domain+1); /* Domains are always caseless */
4205 /* The implication in the RFCs (though I can't say I've seen it spelled out
4206 explicitly) is that quoting should be removed from local parts at the point
4207 where they are locally interpreted. [The new draft "821" is more explicit on
4208 this, Jan 1999.] We know the syntax is valid, so this can be done by simply
4209 removing quoting backslashes and any unquoted doublequotes. */
4211 t = addr->cc_local_part = store_get(len+1);
4214 register int c = *address++;
4215 if (c == '\"') continue;
4225 /* We do the percent hack only for those domains that are listed in
4226 percent_hack_domains. A loop is required, to copy with multiple %-hacks. */
4228 if (percent_hack_domains != NULL)
4231 uschar *new_address = NULL;
4232 uschar *local_part = addr->cc_local_part;
4234 deliver_domain = addr->domain; /* set $domain */
4236 while ((rc = match_isinlist(deliver_domain, &percent_hack_domains, 0,
4237 &domainlist_anchor, addr->domain_cache, MCL_DOMAIN, TRUE, NULL))
4239 (t = Ustrrchr(local_part, '%')) != NULL)
4241 new_address = string_copy(local_part);
4242 new_address[t - local_part] = '@';
4243 deliver_domain = string_copylc(t+1);
4244 local_part = string_copyn(local_part, t - local_part);
4247 if (rc == DEFER) return DEFER; /* lookup deferred */
4249 /* If hackery happened, set up new parent and alter the current address. */
4251 if (new_address != NULL)
4253 address_item *new_parent = store_get(sizeof(address_item));
4254 *new_parent = *addr;
4255 addr->parent = new_parent;
4256 addr->address = new_address;
4257 addr->unique = string_copy(new_address);
4258 addr->domain = deliver_domain;
4259 addr->cc_local_part = local_part;
4260 DEBUG(D_deliver) debug_printf("%%-hack changed address to: %s\n",
4265 /* Create the lowercased version of the final local part, and make that the
4266 default one to be used. */
4268 addr->local_part = addr->lc_local_part = string_copylc(addr->cc_local_part);
4275 /*************************************************
4276 * Get next error message text *
4277 *************************************************/
4279 /* If f is not NULL, read the next "paragraph", from a customized error message
4280 text file, terminated by a line containing ****, and expand it.
4283 f NULL or a file to read from
4284 which string indicating which string (for errors)
4286 Returns: NULL or an expanded string
4290 next_emf(FILE *f, uschar *which)
4294 uschar *para, *yield;
4297 if (f == NULL) return NULL;
4299 if (Ufgets(buffer, sizeof(buffer), f) == NULL ||
4300 Ustrcmp(buffer, "****\n") == 0) return NULL;
4302 para = store_get(size);
4305 para = string_cat(para, &size, &ptr, buffer, Ustrlen(buffer));
4306 if (Ufgets(buffer, sizeof(buffer), f) == NULL ||
4307 Ustrcmp(buffer, "****\n") == 0) break;
4311 yield = expand_string(para);
4312 if (yield != NULL) return yield;
4314 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand string from "
4315 "bounce_message_file or warn_message_file (%s): %s", which,
4316 expand_string_message);
4323 /*************************************************
4324 * Close down a passed transport channel *
4325 *************************************************/
4327 /* This function is called when a passed transport channel cannot be used.
4328 It attempts to close it down tidily. The yield is always DELIVER_NOT_ATTEMPTED
4329 so that the function call can be the argument of a "return" statement.
4332 Returns: DELIVER_NOT_ATTEMPTED
4336 continue_closedown(void)
4338 if (continue_transport != NULL)
4340 transport_instance *t;
4341 for (t = transports; t != NULL; t = t->next)
4343 if (Ustrcmp(t->name, continue_transport) == 0)
4345 if (t->info->closedown != NULL) (t->info->closedown)(t);
4350 return DELIVER_NOT_ATTEMPTED;
4356 /*************************************************
4357 * Print address information *
4358 *************************************************/
4360 /* This function is called to output an address, or information about an
4361 address, for bounce or defer messages. If the hide_child flag is set, all we
4362 output is the original ancestor address.
4365 addr points to the address
4366 f the FILE to print to
4367 si an initial string
4368 sc a continuation string for before "generated"
4371 Returns: TRUE if the address is not hidden
4375 print_address_information(address_item *addr, FILE *f, uschar *si, uschar *sc,
4379 uschar *printed = US"";
4380 address_item *ancestor = addr;
4381 while (ancestor->parent != NULL) ancestor = ancestor->parent;
4383 fprintf(f, "%s", CS si);
4385 if (addr->parent != NULL && testflag(addr, af_hide_child))
4387 printed = US"an undisclosed address";
4390 else if (!testflag(addr, af_pfr) || addr->parent == NULL)
4391 printed = addr->address;
4395 uschar *s = addr->address;
4398 if (addr->address[0] == '>') { ss = US"mail"; s++; }
4399 else if (addr->address[0] == '|') ss = US"pipe";
4402 fprintf(f, "%s to %s%sgenerated by ", ss, s, sc);
4403 printed = addr->parent->address;
4406 fprintf(f, "%s", CS string_printing(printed));
4408 if (ancestor != addr)
4410 uschar *original = (ancestor->onetime_parent == NULL)?
4411 ancestor->address : ancestor->onetime_parent;
4412 if (strcmpic(original, printed) != 0)
4413 fprintf(f, "%s(%sgenerated from %s)", sc,
4414 (ancestor != addr->parent)? "ultimately " : "",
4415 string_printing(original));
4418 fprintf(f, "%s", CS se);
4426 /*************************************************
4427 * Print error for an address *
4428 *************************************************/
4430 /* This function is called to print the error information out of an address for
4431 a bounce or a warning message. It tries to format the message reasonably by
4432 introducing newlines. All lines are indented by 4; the initial printing
4433 position must be set before calling.
4435 This function used always to print the error. Nowadays we want to restrict it
4436 to cases such as LMTP/SMTP errors from a remote host, and errors from :fail:
4437 and filter "fail". We no longer pass other information willy-nilly in bounce
4438 and warning messages. Text in user_message is always output; text in message
4439 only if the af_pass_message flag is set.
4443 f the FILE to print on
4450 print_address_error(address_item *addr, FILE *f, uschar *t)
4452 int count = Ustrlen(t);
4453 uschar *s = testflag(addr, af_pass_message)? addr->message : NULL;
4457 if (addr->user_message != NULL) s = addr->user_message; else return;
4460 fprintf(f, "\n %s", t);
4464 if (*s == '\\' && s[1] == 'n')
4474 if (*s++ == ':' && isspace(*s) && count > 45)
4476 fprintf(f, "\n "); /* sic (because space follows) */
4488 /*************************************************
4489 * Check list of addresses for duplication *
4490 *************************************************/
4492 /* This function was introduced when the test for duplicate addresses that are
4493 not pipes, files, or autoreplies was moved from the middle of routing to when
4494 routing was complete. That was to fix obscure cases when the routing history
4495 affects the subsequent routing of identical addresses. This function is called
4496 after routing, to check that the final routed addresses are not duplicates.
4498 If we detect a duplicate, we remember what it is a duplicate of. Note that
4499 pipe, file, and autoreply de-duplication is handled during routing, so we must
4500 leave such "addresses" alone here, as otherwise they will incorrectly be
4503 Argument: address of list anchor
4508 do_duplicate_check(address_item **anchor)
4511 while ((addr = *anchor) != NULL)
4514 if (testflag(addr, af_pfr))
4516 anchor = &(addr->next);
4518 else if ((tnode = tree_search(tree_duplicates, addr->unique)) != NULL)
4520 DEBUG(D_deliver|D_route)
4521 debug_printf("%s is a duplicate address: discarded\n", addr->unique);
4522 *anchor = addr->next;
4523 addr->dupof = tnode->data.ptr;
4524 addr->next = addr_duplicate;
4525 addr_duplicate = addr;
4529 tree_add_duplicate(addr->unique, addr);
4530 anchor = &(addr->next);
4538 /*************************************************
4539 * Deliver one message *
4540 *************************************************/
4542 /* This is the function which is called when a message is to be delivered. It
4543 is passed the id of the message. It is possible that the message no longer
4544 exists, if some other process has delivered it, and it is also possible that
4545 the message is being worked on by another process, in which case the data file
4548 If no delivery is attempted for any of the above reasons, the function returns
4549 DELIVER_NOT_ATTEMPTED.
4551 If the give_up flag is set true, do not attempt any deliveries, but instead
4552 fail all outstanding addresses and return the message to the sender (or
4555 A delivery operation has a process all to itself; we never deliver more than
4556 one message in the same process. Therefore we needn't worry too much about
4560 id the id of the message to be delivered
4561 forced TRUE if delivery was forced by an administrator; this overrides
4562 retry delays and causes a delivery to be tried regardless
4563 give_up TRUE if an administrator has requested that delivery attempts
4566 Returns: When the global variable mua_wrapper is FALSE:
4567 DELIVER_ATTEMPTED_NORMAL if a delivery attempt was made
4568 DELIVER_NOT_ATTEMPTED otherwise (see comment above)
4569 When the global variable mua_wrapper is TRUE:
4570 DELIVER_MUA_SUCCEEDED if delivery succeeded
4571 DELIVER_MUA_FAILED if delivery failed
4572 DELIVER_NOT_ATTEMPTED if not attempted (should not occur)
4576 deliver_message(uschar *id, BOOL forced, BOOL give_up)
4579 int final_yield = DELIVER_ATTEMPTED_NORMAL;
4580 time_t now = time(NULL);
4581 address_item *addr_last = NULL;
4582 uschar *filter_message = NULL;
4584 int process_recipients = RECIP_ACCEPT;
4587 extern int acl_where;
4589 uschar *info = (queue_run_pid == (pid_t)0)?
4590 string_sprintf("delivering %s", id) :
4591 string_sprintf("delivering %s (queue run pid %d)", id, queue_run_pid);
4593 /* If the D_process_info bit is on, set_process_info() will output debugging
4594 information. If not, we want to show this initial information if D_deliver or
4595 D_queue_run is set or in verbose mode. */
4597 set_process_info("%s", info);
4599 if ((debug_selector & D_process_info) == 0 &&
4600 (debug_selector & (D_deliver|D_queue_run|D_v)) != 0)
4601 debug_printf("%s\n", info);
4603 /* Ensure that we catch any subprocesses that are created. Although Exim
4604 sets SIG_DFL as its initial default, some routes through the code end up
4605 here with it set to SIG_IGN - cases where a non-synchronous delivery process
4606 has been forked, but no re-exec has been done. We use sigaction rather than
4607 plain signal() on those OS where SA_NOCLDWAIT exists, because we want to be
4608 sure it is turned off. (There was a problem on AIX with this.) */
4612 struct sigaction act;
4613 act.sa_handler = SIG_DFL;
4614 sigemptyset(&(act.sa_mask));
4616 sigaction(SIGCHLD, &act, NULL);
4619 signal(SIGCHLD, SIG_DFL);
4622 /* Make the forcing flag available for routers and transports, set up the
4623 global message id field, and initialize the count for returned files and the
4624 message size. This use of strcpy() is OK because the length id is checked when
4625 it is obtained from a command line (the -M or -q options), and otherwise it is
4626 known to be a valid message id. */
4628 Ustrcpy(message_id, id);
4629 deliver_force = forced;
4633 /* Initialize some flags */
4635 update_spool = FALSE;
4636 remove_journal = TRUE;
4638 /* Set a known context for any ACLs we call via expansions */
4639 acl_where = ACL_WHERE_DELIVERY;
4641 /* Reset the random number generator, so that if several delivery processes are
4642 started from a queue runner that has already used random numbers (for sorting),
4643 they don't all get the same sequence. */
4647 /* Open and lock the message's data file. Exim locks on this one because the
4648 header file may get replaced as it is re-written during the delivery process.
4649 Any failures cause messages to be written to the log, except for missing files
4650 while queue running - another process probably completed delivery. As part of
4651 opening the data file, message_subdir gets set. */
4653 if (!spool_open_datafile(id))
4654 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
4656 /* The value of message_size at this point has been set to the data length,
4657 plus one for the blank line that notionally precedes the data. */
4659 /* Now read the contents of the header file, which will set up the headers in
4660 store, and also the list of recipients and the tree of non-recipients and
4661 assorted flags. It updates message_size. If there is a reading or format error,
4662 give up; if the message has been around for sufficiently long, remove it. */
4664 sprintf(CS spoolname, "%s-H", id);
4665 if ((rc = spool_read_header(spoolname, TRUE, TRUE)) != spool_read_OK)
4667 if (errno == ERRNO_SPOOLFORMAT)
4669 struct stat statbuf;
4670 sprintf(CS big_buffer, "%s/input/%s/%s", spool_directory, message_subdir,
4672 if (Ustat(big_buffer, &statbuf) == 0)
4673 log_write(0, LOG_MAIN, "Format error in spool file %s: "
4674 "size=" OFF_T_FMT, spoolname, statbuf.st_size);
4675 else log_write(0, LOG_MAIN, "Format error in spool file %s", spoolname);
4678 log_write(0, LOG_MAIN, "Error reading spool file %s: %s", spoolname,
4681 /* If we managed to read the envelope data, received_time contains the
4682 time the message was received. Otherwise, we can calculate it from the
4685 if (rc != spool_read_hdrerror)
4688 for (i = 0; i < 6; i++)
4689 received_time = received_time * BASE_62 + tab62[id[i] - '0'];
4692 /* If we've had this malformed message too long, sling it. */
4694 if (now - received_time > keep_malformed)
4696 sprintf(CS spoolname, "%s/msglog/%s/%s", spool_directory, message_subdir, id);
4698 sprintf(CS spoolname, "%s/input/%s/%s-D", spool_directory, message_subdir, id);
4700 sprintf(CS spoolname, "%s/input/%s/%s-H", spool_directory, message_subdir, id);
4702 sprintf(CS spoolname, "%s/input/%s/%s-J", spool_directory, message_subdir, id);
4704 log_write(0, LOG_MAIN, "Message removed because older than %s",
4705 readconf_printtime(keep_malformed));
4708 (void)close(deliver_datafile);
4709 deliver_datafile = -1;
4710 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
4713 /* The spool header file has been read. Look to see if there is an existing
4714 journal file for this message. If there is, it means that a previous delivery
4715 attempt crashed (program or host) before it could update the spool header file.
4716 Read the list of delivered addresses from the journal and add them to the
4717 nonrecipients tree. Then update the spool file. We can leave the journal in
4718 existence, as it will get further successful deliveries added to it in this
4719 run, and it will be deleted if this function gets to its end successfully.
4720 Otherwise it might be needed again. */
4722 sprintf(CS spoolname, "%s/input/%s/%s-J", spool_directory, message_subdir, id);
4723 jread = Ufopen(spoolname, "rb");
4726 while (Ufgets(big_buffer, big_buffer_size, jread) != NULL)
4728 int n = Ustrlen(big_buffer);
4729 big_buffer[n-1] = 0;
4730 tree_add_nonrecipient(big_buffer);
4731 DEBUG(D_deliver) debug_printf("Previously delivered address %s taken from "
4732 "journal file\n", big_buffer);
4734 (void)fclose(jread);
4735 /* Panic-dies on error */
4736 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
4738 else if (errno != ENOENT)
4740 log_write(0, LOG_MAIN|LOG_PANIC, "attempt to open journal for reading gave: "
4741 "%s", strerror(errno));
4742 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
4745 /* A null recipients list indicates some kind of disaster. */
4747 if (recipients_list == NULL)
4749 (void)close(deliver_datafile);
4750 deliver_datafile = -1;
4751 log_write(0, LOG_MAIN, "Spool error: no recipients for %s", spoolname);
4752 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
4756 /* Handle a message that is frozen. There are a number of different things that
4757 can happen, but in the default situation, unless forced, no delivery is
4762 #ifdef SUPPORT_MOVE_FROZEN_MESSAGES
4763 /* Moving to another directory removes the message from Exim's view. Other
4764 tools must be used to deal with it. Logging of this action happens in
4765 spool_move_message() and its subfunctions. */
4767 if (move_frozen_messages &&
4768 spool_move_message(id, message_subdir, US"", US"F"))
4769 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
4772 /* For all frozen messages (bounces or not), timeout_frozen_after sets the
4773 maximum time to keep messages that are frozen. Thaw if we reach it, with a
4774 flag causing all recipients to be failed. The time is the age of the
4775 message, not the time since freezing. */
4777 if (timeout_frozen_after > 0 && message_age >= timeout_frozen_after)
4779 log_write(0, LOG_MAIN, "cancelled by timeout_frozen_after");
4780 process_recipients = RECIP_FAIL_TIMEOUT;
4783 /* For bounce messages (and others with no sender), thaw if the error message
4784 ignore timer is exceeded. The message will be discarded if this delivery
4787 else if (sender_address[0] == 0 && message_age >= ignore_bounce_errors_after)
4789 log_write(0, LOG_MAIN, "Unfrozen by errmsg timer");
4792 /* If this is a bounce message, or there's no auto thaw, or we haven't
4793 reached the auto thaw time yet, and this delivery is not forced by an admin
4794 user, do not attempt delivery of this message. Note that forced is set for
4795 continuing messages down the same channel, in order to skip load checking and
4796 ignore hold domains, but we don't want unfreezing in that case. */
4800 if ((sender_address[0] == 0 ||
4802 now <= deliver_frozen_at + auto_thaw
4805 (!forced || !deliver_force_thaw || !admin_user ||
4806 continue_hostname != NULL
4809 (void)close(deliver_datafile);
4810 deliver_datafile = -1;
4811 log_write(L_skip_delivery, LOG_MAIN, "Message is frozen");
4812 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
4815 /* If delivery was forced (by an admin user), assume a manual thaw.
4816 Otherwise it's an auto thaw. */
4820 deliver_manual_thaw = TRUE;
4821 log_write(0, LOG_MAIN, "Unfrozen by forced delivery");
4823 else log_write(0, LOG_MAIN, "Unfrozen by auto-thaw");
4826 /* We get here if any of the rules for unfreezing have triggered. */
4828 deliver_freeze = FALSE;
4829 update_spool = TRUE;
4833 /* Open the message log file if we are using them. This records details of
4834 deliveries, deferments, and failures for the benefit of the mail administrator.
4835 The log is not used by exim itself to track the progress of a message; that is
4836 done by rewriting the header spool file. */
4843 sprintf(CS spoolname, "%s/msglog/%s/%s", spool_directory, message_subdir, id);
4844 fd = open_msglog_file(spoolname, SPOOL_MODE, &error);
4848 log_write(0, LOG_MAIN|LOG_PANIC, "Couldn't %s message log %s: %s", error,
4849 spoolname, strerror(errno));
4850 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
4853 /* Make a C stream out of it. */
4855 message_log = fdopen(fd, "a");
4856 if (message_log == NULL)
4858 log_write(0, LOG_MAIN|LOG_PANIC, "Couldn't fdopen message log %s: %s",
4859 spoolname, strerror(errno));
4860 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
4865 /* If asked to give up on a message, log who did it, and set the action for all
4870 struct passwd *pw = getpwuid(real_uid);
4871 log_write(0, LOG_MAIN, "cancelled by %s", (pw != NULL)?
4872 US pw->pw_name : string_sprintf("uid %ld", (long int)real_uid));
4873 process_recipients = RECIP_FAIL;
4876 /* Otherwise, if there are too many Received: headers, fail all recipients. */
4878 else if (received_count > received_headers_max)
4879 process_recipients = RECIP_FAIL_LOOP;
4881 /* Otherwise, if a system-wide, address-independent message filter is
4882 specified, run it now, except in the case when we are failing all recipients as
4883 a result of timeout_frozen_after. If the system filter yields "delivered", then
4884 ignore the true recipients of the message. Failure of the filter file is
4885 logged, and the delivery attempt fails. */
4887 else if (system_filter != NULL && process_recipients != RECIP_FAIL_TIMEOUT)
4892 redirect_block redirect;
4894 if (system_filter_uid_set)
4896 ugid.uid = system_filter_uid;
4897 ugid.gid = system_filter_gid;
4898 ugid.uid_set = ugid.gid_set = TRUE;
4902 ugid.uid_set = ugid.gid_set = FALSE;
4905 return_path = sender_address;
4906 enable_dollar_recipients = TRUE; /* Permit $recipients in system filter */
4907 system_filtering = TRUE;
4909 /* Any error in the filter file causes a delivery to be abandoned. */
4911 redirect.string = system_filter;
4912 redirect.isfile = TRUE;
4913 redirect.check_owner = redirect.check_group = FALSE;
4914 redirect.owners = NULL;
4915 redirect.owngroups = NULL;
4917 redirect.modemask = 0;
4919 DEBUG(D_deliver|D_filter) debug_printf("running system filter\n");
4922 &redirect, /* Where the data is */
4923 RDO_DEFER | /* Turn on all the enabling options */
4924 RDO_FAIL | /* Leave off all the disabling options */
4929 NULL, /* No :include: restriction (not used in filter) */
4930 NULL, /* No sieve vacation directory (not sieve!) */
4931 NULL, /* No sieve enotify mailto owner (not sieve!) */
4932 NULL, /* No sieve user address (not sieve!) */
4933 NULL, /* No sieve subaddress (not sieve!) */
4934 &ugid, /* uid/gid data */
4935 &addr_new, /* Where to hang generated addresses */
4936 &filter_message, /* Where to put error message */
4937 NULL, /* Don't skip syntax errors */
4938 &filtertype, /* Will always be set to FILTER_EXIM for this call */
4939 US"system filter"); /* For error messages */
4941 DEBUG(D_deliver|D_filter) debug_printf("system filter returned %d\n", rc);
4943 if (rc == FF_ERROR || rc == FF_NONEXIST)
4945 (void)close(deliver_datafile);
4946 deliver_datafile = -1;
4947 log_write(0, LOG_MAIN|LOG_PANIC, "Error in system filter: %s",
4948 string_printing(filter_message));
4949 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
4952 /* Reset things. If the filter message is an empty string, which can happen
4953 for a filter "fail" or "freeze" command with no text, reset it to NULL. */
4955 system_filtering = FALSE;
4956 enable_dollar_recipients = FALSE;
4957 if (filter_message != NULL && filter_message[0] == 0) filter_message = NULL;
4959 /* Save the values of the system filter variables so that user filters
4962 memcpy(filter_sn, filter_n, sizeof(filter_sn));
4964 /* The filter can request that delivery of the original addresses be
4969 process_recipients = RECIP_DEFER;
4970 deliver_msglog("Delivery deferred by system filter\n");
4971 log_write(0, LOG_MAIN, "Delivery deferred by system filter");
4974 /* The filter can request that a message be frozen, but this does not
4975 take place if the message has been manually thawed. In that case, we must
4976 unset "delivered", which is forced by the "freeze" command to make -bF
4979 else if (rc == FF_FREEZE && !deliver_manual_thaw)
4981 deliver_freeze = TRUE;
4982 deliver_frozen_at = time(NULL);
4983 process_recipients = RECIP_DEFER;
4984 frozen_info = string_sprintf(" by the system filter%s%s",
4985 (filter_message == NULL)? US"" : US": ",
4986 (filter_message == NULL)? US"" : filter_message);
4989 /* The filter can request that a message be failed. The error message may be
4990 quite long - it is sent back to the sender in the bounce - but we don't want
4991 to fill up the log with repetitions of it. If it starts with << then the text
4992 between << and >> is written to the log, with the rest left for the bounce
4995 else if (rc == FF_FAIL)
4997 uschar *colon = US"";
4998 uschar *logmsg = US"";
5001 process_recipients = RECIP_FAIL_FILTER;
5003 if (filter_message != NULL)
5007 if (filter_message[0] == '<' && filter_message[1] == '<' &&
5008 (logend = Ustrstr(filter_message, ">>")) != NULL)
5010 logmsg = filter_message + 2;
5011 loglen = logend - logmsg;
5012 filter_message = logend + 2;
5013 if (filter_message[0] == 0) filter_message = NULL;
5017 logmsg = filter_message;
5018 loglen = Ustrlen(filter_message);
5022 log_write(0, LOG_MAIN, "cancelled by system filter%s%.*s", colon, loglen,
5026 /* Delivery can be restricted only to those recipients (if any) that the
5027 filter specified. */
5029 else if (rc == FF_DELIVERED)
5031 process_recipients = RECIP_IGNORE;
5032 if (addr_new == NULL)
5033 log_write(0, LOG_MAIN, "=> discarded (system filter)");
5035 log_write(0, LOG_MAIN, "original recipients ignored (system filter)");
5038 /* If any new addresses were created by the filter, fake up a "parent"
5039 for them. This is necessary for pipes, etc., which are expected to have
5040 parents, and it also gives some sensible logging for others. Allow
5041 pipes, files, and autoreplies, and run them as the filter uid if set,
5042 otherwise as the current uid. */
5044 if (addr_new != NULL)
5046 int uid = (system_filter_uid_set)? system_filter_uid : geteuid();
5047 int gid = (system_filter_gid_set)? system_filter_gid : getegid();
5049 /* The text "system-filter" is tested in transport_set_up_command() and in
5050 set_up_shell_command() in the pipe transport, to enable them to permit
5051 $recipients, so don't change it here without also changing it there. */
5053 address_item *p = addr_new;
5054 address_item *parent = deliver_make_addr(US"system-filter", FALSE);
5056 parent->domain = string_copylc(qualify_domain_recipient);
5057 parent->local_part = US"system-filter";
5059 /* As part of this loop, we arrange for addr_last to end up pointing
5060 at the final address. This is used if we go on to add addresses for the
5061 original recipients. */
5065 if (parent->child_count == SHRT_MAX)
5066 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "system filter generated more "
5067 "than %d delivery addresses", SHRT_MAX);
5068 parent->child_count++;
5071 if (testflag(p, af_pfr))
5077 setflag(p, af_uid_set |
5083 /* Find the name of the system filter's appropriate pfr transport */
5085 if (p->address[0] == '|')
5088 tpname = system_filter_pipe_transport;
5089 address_pipe = p->address;
5091 else if (p->address[0] == '>')
5094 tpname = system_filter_reply_transport;
5098 if (p->address[Ustrlen(p->address)-1] == '/')
5100 type = US"directory";
5101 tpname = system_filter_directory_transport;
5106 tpname = system_filter_file_transport;
5108 address_file = p->address;
5111 /* Now find the actual transport, first expanding the name. We have
5112 set address_file or address_pipe above. */
5116 uschar *tmp = expand_string(tpname);
5117 address_file = address_pipe = NULL;
5119 p->message = string_sprintf("failed to expand \"%s\" as a "
5120 "system filter transport name", tpname);
5125 p->message = string_sprintf("system_filter_%s_transport is unset",
5131 transport_instance *tp;
5132 for (tp = transports; tp != NULL; tp = tp->next)
5134 if (Ustrcmp(tp->name, tpname) == 0)
5141 p->message = string_sprintf("failed to find \"%s\" transport "
5142 "for system filter delivery", tpname);
5145 /* If we couldn't set up a transport, defer the delivery, putting the
5146 error on the panic log as well as the main log. */
5148 if (p->transport == NULL)
5150 address_item *badp = p;
5152 if (addr_last == NULL) addr_new = p; else addr_last->next = p;
5153 badp->local_part = badp->address; /* Needed for log line */
5154 post_process_one(badp, DEFER, LOG_MAIN|LOG_PANIC, DTYPE_ROUTER, 0);
5157 } /* End of pfr handling */
5159 /* Either a non-pfr delivery, or we found a transport */
5161 DEBUG(D_deliver|D_filter)
5162 debug_printf("system filter added %s\n", p->address);
5166 } /* Loop through all addr_new addresses */
5171 /* Scan the recipients list, and for every one that is not in the non-
5172 recipients tree, add an addr item to the chain of new addresses. If the pno
5173 value is non-negative, we must set the onetime parent from it. This which
5174 points to the relevant entry in the recipients list.
5176 This processing can be altered by the setting of the process_recipients
5177 variable, which is changed if recipients are to be ignored, failed, or
5178 deferred. This can happen as a result of system filter activity, or if the -Mg
5179 option is used to fail all of them.
5181 Duplicate addresses are handled later by a different tree structure; we can't
5182 just extend the non-recipients tree, because that will be re-written to the
5183 spool if the message is deferred, and in any case there are casing
5184 complications for local addresses. */
5186 if (process_recipients != RECIP_IGNORE)
5188 for (i = 0; i < recipients_count; i++)
5190 if (tree_search(tree_nonrecipients, recipients_list[i].address) == NULL)
5192 recipient_item *r = recipients_list + i;
5193 address_item *new = deliver_make_addr(r->address, FALSE);
5194 new->p.errors_address = r->errors_to;
5197 new->onetime_parent = recipients_list[r->pno].address;
5199 switch (process_recipients)
5201 /* RECIP_DEFER is set when a system filter freezes a message. */
5204 new->next = addr_defer;
5209 /* RECIP_FAIL_FILTER is set when a system filter has obeyed a "fail"
5212 case RECIP_FAIL_FILTER:
5214 (filter_message == NULL)? US"delivery cancelled" : filter_message;
5215 setflag(new, af_pass_message);
5216 goto RECIP_QUEUE_FAILED; /* below */
5219 /* RECIP_FAIL_TIMEOUT is set when a message is frozen, but is older
5220 than the value in timeout_frozen_after. Treat non-bounce messages
5221 similarly to -Mg; for bounce messages we just want to discard, so
5222 don't put the address on the failed list. The timeout has already
5225 case RECIP_FAIL_TIMEOUT:
5226 new->message = US"delivery cancelled; message timed out";
5227 goto RECIP_QUEUE_FAILED; /* below */
5230 /* RECIP_FAIL is set when -Mg has been used. */
5233 new->message = US"delivery cancelled by administrator";
5236 /* Common code for the failure cases above. If this is not a bounce
5237 message, put the address on the failed list so that it is used to
5238 create a bounce. Otherwise do nothing - this just discards the address.
5239 The incident has already been logged. */
5242 if (sender_address[0] != 0)
5244 new->next = addr_failed;
5250 /* RECIP_FAIL_LOOP is set when there are too many Received: headers
5251 in the message. Process each address as a routing failure; if this
5252 is a bounce message, it will get frozen. */
5254 case RECIP_FAIL_LOOP:
5255 new->message = US"Too many \"Received\" headers - suspected mail loop";
5256 post_process_one(new, FAIL, LOG_MAIN, DTYPE_ROUTER, 0);
5260 /* Value should be RECIP_ACCEPT; take this as the safe default. */
5263 if (addr_new == NULL) addr_new = new; else addr_last->next = new;
5273 address_item *p = addr_new;
5274 debug_printf("Delivery address list:\n");
5277 debug_printf(" %s %s\n", p->address, (p->onetime_parent == NULL)? US"" :
5283 /* Set up the buffers used for copying over the file when delivering. */
5285 deliver_in_buffer = store_malloc(DELIVER_IN_BUFFER_SIZE);
5286 deliver_out_buffer = store_malloc(DELIVER_OUT_BUFFER_SIZE);
5290 /* Until there are no more new addresses, handle each one as follows:
5292 . If this is a generated address (indicated by the presence of a parent
5293 pointer) then check to see whether it is a pipe, file, or autoreply, and
5294 if so, handle it directly here. The router that produced the address will
5295 have set the allow flags into the address, and also set the uid/gid required.
5296 Having the routers generate new addresses and then checking them here at
5297 the outer level is tidier than making each router do the checking, and
5298 means that routers don't need access to the failed address queue.
5300 . Break up the address into local part and domain, and make lowercased
5301 versions of these strings. We also make unquoted versions of the local part.
5303 . Handle the percent hack for those domains for which it is valid.
5305 . For child addresses, determine if any of the parents have the same address.
5306 If so, generate a different string for previous delivery checking. Without
5307 this code, if the address spqr generates spqr via a forward or alias file,
5308 delivery of the generated spqr stops further attempts at the top level spqr,
5309 which is not what is wanted - it may have generated other addresses.
5311 . Check on the retry database to see if routing was previously deferred, but
5312 only if in a queue run. Addresses that are to be routed are put on the
5313 addr_route chain. Addresses that are to be deferred are put on the
5314 addr_defer chain. We do all the checking first, so as not to keep the
5315 retry database open any longer than necessary.
5317 . Now we run the addresses through the routers. A router may put the address
5318 on either the addr_local or the addr_remote chain for local or remote
5319 delivery, respectively, or put it on the addr_failed chain if it is
5320 undeliveable, or it may generate child addresses and put them on the
5321 addr_new chain, or it may defer an address. All the chain anchors are
5322 passed as arguments so that the routers can be called for verification
5325 . If new addresses have been generated by the routers, da capo.
5328 header_rewritten = FALSE; /* No headers rewritten yet */
5329 while (addr_new != NULL) /* Loop until all addresses dealt with */
5331 address_item *addr, *parent;
5332 dbm_file = dbfn_open(US"retry", O_RDONLY, &dbblock, FALSE);
5334 /* Failure to open the retry database is treated the same as if it does
5335 not exist. In both cases, dbm_file is NULL. */
5337 if (dbm_file == NULL)
5339 DEBUG(D_deliver|D_retry|D_route|D_hints_lookup)
5340 debug_printf("no retry data available\n");
5343 /* Scan the current batch of new addresses, to handle pipes, files and
5344 autoreplies, and determine which others are ready for routing. */
5346 while (addr_new != NULL)
5351 dbdata_retry *domain_retry_record;
5352 dbdata_retry *address_retry_record;
5355 addr_new = addr->next;
5357 DEBUG(D_deliver|D_retry|D_route)
5359 debug_printf(">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>\n");
5360 debug_printf("Considering: %s\n", addr->address);
5363 /* Handle generated address that is a pipe or a file or an autoreply. */
5365 if (testflag(addr, af_pfr))
5367 /* If an autoreply in a filter could not generate a syntactically valid
5368 address, give up forthwith. Set af_ignore_error so that we don't try to
5369 generate a bounce. */
5371 if (testflag(addr, af_bad_reply))
5373 addr->basic_errno = ERRNO_BADADDRESS2;
5374 addr->local_part = addr->address;
5376 US"filter autoreply generated syntactically invalid recipient";
5377 setflag(addr, af_ignore_error);
5378 (void)post_process_one(addr, FAIL, LOG_MAIN, DTYPE_ROUTER, 0);
5379 continue; /* with the next new address */
5382 /* If two different users specify delivery to the same pipe or file or
5383 autoreply, there should be two different deliveries, so build a unique
5384 string that incorporates the original address, and use this for
5385 duplicate testing and recording delivery, and also for retrying. */
5388 string_sprintf("%s:%s", addr->address, addr->parent->unique +
5389 (testflag(addr->parent, af_homonym)? 3:0));
5391 addr->address_retry_key = addr->domain_retry_key =
5392 string_sprintf("T:%s", addr->unique);
5394 /* If a filter file specifies two deliveries to the same pipe or file,
5395 we want to de-duplicate, but this is probably not wanted for two mail
5396 commands to the same address, where probably both should be delivered.
5397 So, we have to invent a different unique string in that case. Just
5398 keep piling '>' characters on the front. */
5400 if (addr->address[0] == '>')
5402 while (tree_search(tree_duplicates, addr->unique) != NULL)
5403 addr->unique = string_sprintf(">%s", addr->unique);
5406 else if ((tnode = tree_search(tree_duplicates, addr->unique)) != NULL)
5408 DEBUG(D_deliver|D_route)
5409 debug_printf("%s is a duplicate address: discarded\n", addr->address);
5410 addr->dupof = tnode->data.ptr;
5411 addr->next = addr_duplicate;
5412 addr_duplicate = addr;
5416 DEBUG(D_deliver|D_route) debug_printf("unique = %s\n", addr->unique);
5418 /* Check for previous delivery */
5420 if (tree_search(tree_nonrecipients, addr->unique) != NULL)
5422 DEBUG(D_deliver|D_route)
5423 debug_printf("%s was previously delivered: discarded\n", addr->address);
5424 child_done(addr, tod_stamp(tod_log));
5428 /* Save for checking future duplicates */
5430 tree_add_duplicate(addr->unique, addr);
5432 /* Set local part and domain */
5434 addr->local_part = addr->address;
5435 addr->domain = addr->parent->domain;
5437 /* Ensure that the delivery is permitted. */
5439 if (testflag(addr, af_file))
5441 if (!testflag(addr, af_allow_file))
5443 addr->basic_errno = ERRNO_FORBIDFILE;
5444 addr->message = US"delivery to file forbidden";
5445 (void)post_process_one(addr, FAIL, LOG_MAIN, DTYPE_ROUTER, 0);
5446 continue; /* with the next new address */
5449 else if (addr->address[0] == '|')
5451 if (!testflag(addr, af_allow_pipe))
5453 addr->basic_errno = ERRNO_FORBIDPIPE;
5454 addr->message = US"delivery to pipe forbidden";
5455 (void)post_process_one(addr, FAIL, LOG_MAIN, DTYPE_ROUTER, 0);
5456 continue; /* with the next new address */
5459 else if (!testflag(addr, af_allow_reply))
5461 addr->basic_errno = ERRNO_FORBIDREPLY;
5462 addr->message = US"autoreply forbidden";
5463 (void)post_process_one(addr, FAIL, LOG_MAIN, DTYPE_ROUTER, 0);
5464 continue; /* with the next new address */
5467 /* If the errno field is already set to BADTRANSPORT, it indicates
5468 failure to expand a transport string, or find the associated transport,
5469 or an unset transport when one is required. Leave this test till now so
5470 that the forbid errors are given in preference. */
5472 if (addr->basic_errno == ERRNO_BADTRANSPORT)
5474 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_ROUTER, 0);
5478 /* Treat /dev/null as a special case and abandon the delivery. This
5479 avoids having to specify a uid on the transport just for this case.
5480 Arrange for the transport name to be logged as "**bypassed**". */
5482 if (Ustrcmp(addr->address, "/dev/null") == 0)
5484 uschar *save = addr->transport->name;
5485 addr->transport->name = US"**bypassed**";
5486 (void)post_process_one(addr, OK, LOG_MAIN, DTYPE_TRANSPORT, '=');
5487 addr->transport->name = save;
5488 continue; /* with the next new address */
5491 /* Pipe, file, or autoreply delivery is to go ahead as a normal local
5494 DEBUG(D_deliver|D_route)
5495 debug_printf("queued for %s transport\n", addr->transport->name);
5496 addr->next = addr_local;
5498 continue; /* with the next new address */
5501 /* Handle normal addresses. First, split up into local part and domain,
5502 handling the %-hack if necessary. There is the possibility of a defer from
5503 a lookup in percent_hack_domains. */
5505 if ((rc = deliver_split_address(addr)) == DEFER)
5507 addr->message = US"cannot check percent_hack_domains";
5508 addr->basic_errno = ERRNO_LISTDEFER;
5509 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_NONE, 0);
5513 /* Check to see if the domain is held. If so, proceed only if the
5514 delivery was forced by hand. */
5516 deliver_domain = addr->domain; /* set $domain */
5517 if (!forced && hold_domains != NULL &&
5518 (rc = match_isinlist(addr->domain, &hold_domains, 0,
5519 &domainlist_anchor, addr->domain_cache, MCL_DOMAIN, TRUE,
5524 addr->message = US"hold_domains lookup deferred";
5525 addr->basic_errno = ERRNO_LISTDEFER;
5529 addr->message = US"domain is held";
5530 addr->basic_errno = ERRNO_HELD;
5532 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_NONE, 0);
5536 /* Now we can check for duplicates and previously delivered addresses. In
5537 order to do this, we have to generate a "unique" value for each address,
5538 because there may be identical actual addresses in a line of descendents.
5539 The "unique" field is initialized to the same value as the "address" field,
5540 but gets changed here to cope with identically-named descendents. */
5542 for (parent = addr->parent; parent != NULL; parent = parent->parent)
5543 if (strcmpic(addr->address, parent->address) == 0) break;
5545 /* If there's an ancestor with the same name, set the homonym flag. This
5546 influences how deliveries are recorded. Then add a prefix on the front of
5547 the unique address. We use \n\ where n starts at 0 and increases each time.
5548 It is unlikely to pass 9, but if it does, it may look odd but will still
5549 work. This means that siblings or cousins with the same names are treated
5550 as duplicates, which is what we want. */
5554 setflag(addr, af_homonym);
5555 if (parent->unique[0] != '\\')
5556 addr->unique = string_sprintf("\\0\\%s", addr->address);
5558 addr->unique = string_sprintf("\\%c\\%s", parent->unique[1] + 1,
5562 /* Ensure that the domain in the unique field is lower cased, because
5563 domains are always handled caselessly. */
5565 p = Ustrrchr(addr->unique, '@');
5566 while (*p != 0) { *p = tolower(*p); p++; }
5568 DEBUG(D_deliver|D_route) debug_printf("unique = %s\n", addr->unique);
5570 if (tree_search(tree_nonrecipients, addr->unique) != NULL)
5572 DEBUG(D_deliver|D_route)
5573 debug_printf("%s was previously delivered: discarded\n", addr->unique);
5574 child_done(addr, tod_stamp(tod_log));
5578 /* Get the routing retry status, saving the two retry keys (with and
5579 without the local part) for subsequent use. If there is no retry record for
5580 the standard address routing retry key, we look for the same key with the
5581 sender attached, because this form is used by the smtp transport after a
5582 4xx response to RCPT when address_retry_include_sender is true. */
5584 addr->domain_retry_key = string_sprintf("R:%s", addr->domain);
5585 addr->address_retry_key = string_sprintf("R:%s@%s", addr->local_part,
5588 if (dbm_file == NULL)
5589 domain_retry_record = address_retry_record = NULL;
5592 domain_retry_record = dbfn_read(dbm_file, addr->domain_retry_key);
5593 if (domain_retry_record != NULL &&
5594 now - domain_retry_record->time_stamp > retry_data_expire)
5595 domain_retry_record = NULL; /* Ignore if too old */
5597 address_retry_record = dbfn_read(dbm_file, addr->address_retry_key);
5598 if (address_retry_record != NULL &&
5599 now - address_retry_record->time_stamp > retry_data_expire)
5600 address_retry_record = NULL; /* Ignore if too old */
5602 if (address_retry_record == NULL)
5604 uschar *altkey = string_sprintf("%s:<%s>", addr->address_retry_key,
5606 address_retry_record = dbfn_read(dbm_file, altkey);
5607 if (address_retry_record != NULL &&
5608 now - address_retry_record->time_stamp > retry_data_expire)
5609 address_retry_record = NULL; /* Ignore if too old */
5613 DEBUG(D_deliver|D_retry)
5615 if (domain_retry_record == NULL)
5616 debug_printf("no domain retry record\n");
5617 if (address_retry_record == NULL)
5618 debug_printf("no address retry record\n");
5621 /* If we are sending a message down an existing SMTP connection, we must
5622 assume that the message which created the connection managed to route
5623 an address to that connection. We do not want to run the risk of taking
5624 a long time over routing here, because if we do, the server at the other
5625 end of the connection may time it out. This is especially true for messages
5626 with lots of addresses. For this kind of delivery, queue_running is not
5627 set, so we would normally route all addresses. We take a pragmatic approach
5628 and defer routing any addresses that have any kind of domain retry record.
5629 That is, we don't even look at their retry times. It doesn't matter if this
5630 doesn't work occasionally. This is all just an optimization, after all.
5632 The reason for not doing the same for address retries is that they normally
5633 arise from 4xx responses, not DNS timeouts. */
5635 if (continue_hostname != NULL && domain_retry_record != NULL)
5637 addr->message = US"reusing SMTP connection skips previous routing defer";
5638 addr->basic_errno = ERRNO_RRETRY;
5639 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_ROUTER, 0);
5642 /* If we are in a queue run, defer routing unless there is no retry data or
5643 we've passed the next retry time, or this message is forced. In other
5644 words, ignore retry data when not in a queue run.
5646 However, if the domain retry time has expired, always allow the routing
5647 attempt. If it fails again, the address will be failed. This ensures that
5648 each address is routed at least once, even after long-term routing
5651 If there is an address retry, check that too; just wait for the next
5652 retry time. This helps with the case when the temporary error on the
5653 address was really message-specific rather than address specific, since
5654 it allows other messages through.
5656 We also wait for the next retry time if this is a message sent down an
5657 existing SMTP connection (even though that will be forced). Otherwise there
5658 will be far too many attempts for an address that gets a 4xx error. In
5659 fact, after such an error, we should not get here because, the host should
5660 not be remembered as one this message needs. However, there was a bug that
5661 used to cause this to happen, so it is best to be on the safe side.
5663 Even if we haven't reached the retry time in the hints, there is one more
5664 check to do, which is for the ultimate address timeout. We only do this
5665 check if there is an address retry record and there is not a domain retry
5666 record; this implies that previous attempts to handle the address had the
5667 retry_use_local_parts option turned on. We use this as an approximation
5668 for the destination being like a local delivery, for example delivery over
5669 LMTP to an IMAP message store. In this situation users are liable to bump
5670 into their quota and thereby have intermittently successful deliveries,
5671 which keep the retry record fresh, which can lead to us perpetually
5672 deferring messages. */
5674 else if (((queue_running && !deliver_force) || continue_hostname != NULL)
5676 ((domain_retry_record != NULL &&
5677 now < domain_retry_record->next_try &&
5678 !domain_retry_record->expired)
5680 (address_retry_record != NULL &&
5681 now < address_retry_record->next_try))
5683 (domain_retry_record != NULL ||
5684 address_retry_record == NULL ||
5685 !retry_ultimate_address_timeout(addr->address_retry_key,
5686 addr->domain, address_retry_record, now)))
5688 addr->message = US"retry time not reached";
5689 addr->basic_errno = ERRNO_RRETRY;
5690 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_ROUTER, 0);
5693 /* The domain is OK for routing. Remember if retry data exists so it
5694 can be cleaned up after a successful delivery. */
5698 if (domain_retry_record != NULL || address_retry_record != NULL)
5699 setflag(addr, af_dr_retry_exists);
5700 addr->next = addr_route;
5702 DEBUG(D_deliver|D_route)
5703 debug_printf("%s: queued for routing\n", addr->address);
5707 /* The database is closed while routing is actually happening. Requests to
5708 update it are put on a chain and all processed together at the end. */
5710 if (dbm_file != NULL) dbfn_close(dbm_file);
5712 /* If queue_domains is set, we don't even want to try routing addresses in
5713 those domains. During queue runs, queue_domains is forced to be unset.
5714 Optimize by skipping this pass through the addresses if nothing is set. */
5716 if (!deliver_force && queue_domains != NULL)
5718 address_item *okaddr = NULL;
5719 while (addr_route != NULL)
5721 address_item *addr = addr_route;
5722 addr_route = addr->next;
5724 deliver_domain = addr->domain; /* set $domain */
5725 if ((rc = match_isinlist(addr->domain, &queue_domains, 0,
5726 &domainlist_anchor, addr->domain_cache, MCL_DOMAIN, TRUE, NULL))
5731 addr->basic_errno = ERRNO_LISTDEFER;
5732 addr->message = US"queue_domains lookup deferred";
5733 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_ROUTER, 0);
5737 addr->next = okaddr;
5743 addr->basic_errno = ERRNO_QUEUE_DOMAIN;
5744 addr->message = US"domain is in queue_domains";
5745 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_ROUTER, 0);
5749 addr_route = okaddr;
5752 /* Now route those addresses that are not deferred. */
5754 while (addr_route != NULL)
5757 address_item *addr = addr_route;
5758 uschar *old_domain = addr->domain;
5759 uschar *old_unique = addr->unique;
5760 addr_route = addr->next;
5763 /* Just in case some router parameter refers to it. */
5765 return_path = (addr->p.errors_address != NULL)?
5766 addr->p.errors_address : sender_address;
5768 /* If a router defers an address, add a retry item. Whether or not to
5769 use the local part in the key is a property of the router. */
5771 if ((rc = route_address(addr, &addr_local, &addr_remote, &addr_new,
5772 &addr_succeed, v_none)) == DEFER)
5773 retry_add_item(addr, (addr->router->retry_use_local_part)?
5774 string_sprintf("R:%s@%s", addr->local_part, addr->domain) :
5775 string_sprintf("R:%s", addr->domain), 0);
5777 /* Otherwise, if there is an existing retry record in the database, add
5778 retry items to delete both forms. We must also allow for the possibility
5779 of a routing retry that includes the sender address. Since the domain might
5780 have been rewritten (expanded to fully qualified) as a result of routing,
5781 ensure that the rewritten form is also deleted. */
5783 else if (testflag(addr, af_dr_retry_exists))
5785 uschar *altkey = string_sprintf("%s:<%s>", addr->address_retry_key,
5787 retry_add_item(addr, altkey, rf_delete);
5788 retry_add_item(addr, addr->address_retry_key, rf_delete);
5789 retry_add_item(addr, addr->domain_retry_key, rf_delete);
5790 if (Ustrcmp(addr->domain, old_domain) != 0)
5791 retry_add_item(addr, string_sprintf("R:%s", old_domain), rf_delete);
5794 /* DISCARD is given for :blackhole: and "seen finish". The event has been
5795 logged, but we need to ensure the address (and maybe parents) is marked
5800 address_done(addr, tod_stamp(tod_log));
5801 continue; /* route next address */
5804 /* The address is finished with (failed or deferred). */
5808 (void)post_process_one(addr, rc, LOG_MAIN, DTYPE_ROUTER, 0);
5809 continue; /* route next address */
5812 /* The address has been routed. If the router changed the domain, it will
5813 also have changed the unique address. We have to test whether this address
5814 has already been delivered, because it's the unique address that finally
5817 if (addr->unique != old_unique &&
5818 tree_search(tree_nonrecipients, addr->unique) != 0)
5820 DEBUG(D_deliver|D_route) debug_printf("%s was previously delivered: "
5821 "discarded\n", addr->address);
5822 if (addr_remote == addr) addr_remote = addr->next;
5823 else if (addr_local == addr) addr_local = addr->next;
5826 /* If the router has same_domain_copy_routing set, we are permitted to copy
5827 the routing for any other addresses with the same domain. This is an
5828 optimisation to save repeated DNS lookups for "standard" remote domain
5829 routing. The option is settable only on routers that generate host lists.
5830 We play it very safe, and do the optimization only if the address is routed
5831 to a remote transport, there are no header changes, and the domain was not
5832 modified by the router. */
5834 if (addr_remote == addr &&
5835 addr->router->same_domain_copy_routing &&
5836 addr->p.extra_headers == NULL &&
5837 addr->p.remove_headers == NULL &&
5838 old_domain == addr->domain)
5840 address_item **chain = &addr_route;
5841 while (*chain != NULL)
5843 address_item *addr2 = *chain;
5844 if (Ustrcmp(addr2->domain, addr->domain) != 0)
5846 chain = &(addr2->next);
5850 /* Found a suitable address; take it off the routing list and add it to
5851 the remote delivery list. */
5853 *chain = addr2->next;
5854 addr2->next = addr_remote;
5855 addr_remote = addr2;
5857 /* Copy the routing data */
5859 addr2->domain = addr->domain;
5860 addr2->router = addr->router;
5861 addr2->transport = addr->transport;
5862 addr2->host_list = addr->host_list;
5863 addr2->fallback_hosts = addr->fallback_hosts;
5864 addr2->p.errors_address = addr->p.errors_address;
5865 copyflag(addr2, addr, af_hide_child | af_local_host_removed);
5867 DEBUG(D_deliver|D_route)
5869 debug_printf(">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>\n"
5871 "Routing for %s copied from %s\n",
5872 addr2->address, addr2->address, addr->address);
5876 } /* Continue with routing the next address. */
5877 } /* Loop to process any child addresses that the routers created, and
5878 any rerouted addresses that got put back on the new chain. */
5881 /* Debugging: show the results of the routing */
5883 DEBUG(D_deliver|D_retry|D_route)
5885 address_item *p = addr_local;
5886 debug_printf(">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>\n");
5887 debug_printf("After routing:\n Local deliveries:\n");
5890 debug_printf(" %s\n", p->address);
5895 debug_printf(" Remote deliveries:\n");
5898 debug_printf(" %s\n", p->address);
5903 debug_printf(" Failed addresses:\n");
5906 debug_printf(" %s\n", p->address);
5911 debug_printf(" Deferred addresses:\n");
5914 debug_printf(" %s\n", p->address);
5919 /* Free any resources that were cached during routing. */
5924 /* These two variables are set only during routing, after check_local_user.
5925 Ensure they are not set in transports. */
5927 local_user_gid = (gid_t)(-1);
5928 local_user_uid = (uid_t)(-1);
5930 /* Check for any duplicate addresses. This check is delayed until after
5931 routing, because the flexibility of the routing configuration means that
5932 identical addresses with different parentage may end up being redirected to
5933 different addresses. Checking for duplicates too early (as we previously used
5934 to) makes this kind of thing not work. */
5936 do_duplicate_check(&addr_local);
5937 do_duplicate_check(&addr_remote);
5939 /* When acting as an MUA wrapper, we proceed only if all addresses route to a
5940 remote transport. The check that they all end up in one transaction happens in
5941 the do_remote_deliveries() function. */
5943 if (mua_wrapper && (addr_local != NULL || addr_failed != NULL ||
5944 addr_defer != NULL))
5947 uschar *which, *colon, *msg;
5949 if (addr_local != NULL)
5954 else if (addr_defer != NULL)
5957 which = US"deferred";
5965 while (addr->parent != NULL) addr = addr->parent;
5967 if (addr->message != NULL)
5970 msg = addr->message;
5972 else colon = msg = US"";
5974 /* We don't need to log here for a forced failure as it will already
5975 have been logged. Defer will also have been logged, but as a defer, so we do
5976 need to do the failure logging. */
5978 if (addr != addr_failed)
5979 log_write(0, LOG_MAIN, "** %s routing yielded a %s delivery",
5980 addr->address, which);
5982 /* Always write an error to the caller */
5984 fprintf(stderr, "routing %s yielded a %s delivery%s%s\n", addr->address,
5987 final_yield = DELIVER_MUA_FAILED;
5988 addr_failed = addr_defer = NULL; /* So that we remove the message */
5989 goto DELIVERY_TIDYUP;
5993 /* If this is a run to continue deliveries to an external channel that is
5994 already set up, defer any local deliveries. */
5996 if (continue_transport != NULL)
5998 if (addr_defer == NULL) addr_defer = addr_local; else
6000 address_item *addr = addr_defer;
6001 while (addr->next != NULL) addr = addr->next;
6002 addr->next = addr_local;
6008 /* Because address rewriting can happen in the routers, we should not really do
6009 ANY deliveries until all addresses have been routed, so that all recipients of
6010 the message get the same headers. However, this is in practice not always
6011 possible, since sometimes remote addresses give DNS timeouts for days on end.
6012 The pragmatic approach is to deliver what we can now, saving any rewritten
6013 headers so that at least the next lot of recipients benefit from the rewriting
6014 that has already been done.
6016 If any headers have been rewritten during routing, update the spool file to
6017 remember them for all subsequent deliveries. This can be delayed till later if
6018 there is only address to be delivered - if it succeeds the spool write need not
6021 if (header_rewritten &&
6022 ((addr_local != NULL &&
6023 (addr_local->next != NULL || addr_remote != NULL)) ||
6024 (addr_remote != NULL && addr_remote->next != NULL)))
6026 /* Panic-dies on error */
6027 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
6028 header_rewritten = FALSE;
6032 /* If there are any deliveries to be done, open the journal file. This is used
6033 to record successful deliveries as soon as possible after each delivery is
6034 known to be complete. A file opened with O_APPEND is used so that several
6035 processes can run simultaneously.
6037 The journal is just insurance against crashes. When the spool file is
6038 ultimately updated at the end of processing, the journal is deleted. If a
6039 journal is found to exist at the start of delivery, the addresses listed
6040 therein are added to the non-recipients. */
6042 if (addr_local != NULL || addr_remote != NULL)
6044 sprintf(CS spoolname, "%s/input/%s/%s-J", spool_directory, message_subdir, id);
6045 journal_fd = Uopen(spoolname, O_WRONLY|O_APPEND|O_CREAT, SPOOL_MODE);
6049 log_write(0, LOG_MAIN|LOG_PANIC, "Couldn't open journal file %s: %s",
6050 spoolname, strerror(errno));
6051 return DELIVER_NOT_ATTEMPTED;
6054 /* Set the close-on-exec flag, make the file owned by Exim, and ensure
6055 that the mode is correct - the group setting doesn't always seem to get
6056 set automatically. */
6058 if( fcntl(journal_fd, F_SETFD, fcntl(journal_fd, F_GETFD) | FD_CLOEXEC)
6059 || fchown(journal_fd, exim_uid, exim_gid)
6060 || fchmod(journal_fd, SPOOL_MODE)
6063 int ret = Uunlink(spoolname);
6064 log_write(0, LOG_MAIN|LOG_PANIC, "Couldn't set perms on journal file %s: %s",
6065 spoolname, strerror(errno));
6066 if(ret && errno != ENOENT)
6067 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s",
6068 spoolname, strerror(errno));
6069 return DELIVER_NOT_ATTEMPTED;
6075 /* Now we can get down to the business of actually doing deliveries. Local
6076 deliveries are done first, then remote ones. If ever the problems of how to
6077 handle fallback transports are figured out, this section can be put into a loop
6078 for handling fallbacks, though the uid switching will have to be revised. */
6080 /* Precompile a regex that is used to recognize a parameter in response
6081 to an LHLO command, if is isn't already compiled. This may be used on both
6082 local and remote LMTP deliveries. */
6084 if (regex_IGNOREQUOTA == NULL) regex_IGNOREQUOTA =
6085 regex_must_compile(US"\\n250[\\s\\-]IGNOREQUOTA(\\s|\\n|$)", FALSE, TRUE);
6087 /* Handle local deliveries */
6089 if (addr_local != NULL)
6091 DEBUG(D_deliver|D_transport)
6092 debug_printf(">>>>>>>>>>>>>>>> Local deliveries >>>>>>>>>>>>>>>>\n");
6093 do_local_deliveries();
6094 disable_logging = FALSE;
6097 /* If queue_run_local is set, we do not want to attempt any remote deliveries,
6098 so just queue them all. */
6100 if (queue_run_local)
6102 while (addr_remote != NULL)
6104 address_item *addr = addr_remote;
6105 addr_remote = addr->next;
6107 addr->basic_errno = ERRNO_LOCAL_ONLY;
6108 addr->message = US"remote deliveries suppressed";
6109 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_TRANSPORT, 0);
6113 /* Handle remote deliveries */
6115 if (addr_remote != NULL)
6117 DEBUG(D_deliver|D_transport)
6118 debug_printf(">>>>>>>>>>>>>>>> Remote deliveries >>>>>>>>>>>>>>>>\n");
6120 /* Precompile some regex that are used to recognize parameters in response
6121 to an EHLO command, if they aren't already compiled. */
6123 if (regex_PIPELINING == NULL) regex_PIPELINING =
6124 regex_must_compile(US"\\n250[\\s\\-]PIPELINING(\\s|\\n|$)", FALSE, TRUE);
6126 if (regex_SIZE == NULL) regex_SIZE =
6127 regex_must_compile(US"\\n250[\\s\\-]SIZE(\\s|\\n|$)", FALSE, TRUE);
6129 if (regex_AUTH == NULL) regex_AUTH =
6130 regex_must_compile(US"\\n250[\\s\\-]AUTH\\s+([\\-\\w\\s]+)(?:\\n|$)",
6134 if (regex_STARTTLS == NULL) regex_STARTTLS =
6135 regex_must_compile(US"\\n250[\\s\\-]STARTTLS(\\s|\\n|$)", FALSE, TRUE);
6138 #ifdef EXPERIMENTAL_PRDR
6139 if (regex_PRDR == NULL) regex_PRDR =
6140 regex_must_compile(US"\\n250[\\s\\-]PRDR(\\s|\\n|$)", FALSE, TRUE);
6143 /* Now sort the addresses if required, and do the deliveries. The yield of
6144 do_remote_deliveries is FALSE when mua_wrapper is set and all addresses
6145 cannot be delivered in one transaction. */
6147 if (remote_sort_domains != NULL) sort_remote_deliveries();
6148 if (!do_remote_deliveries(FALSE))
6150 log_write(0, LOG_MAIN, "** mua_wrapper is set but recipients cannot all "
6151 "be delivered in one transaction");
6152 fprintf(stderr, "delivery to smarthost failed (configuration problem)\n");
6154 final_yield = DELIVER_MUA_FAILED;
6155 addr_failed = addr_defer = NULL; /* So that we remove the message */
6156 goto DELIVERY_TIDYUP;
6159 /* See if any of the addresses that failed got put on the queue for delivery
6160 to their fallback hosts. We do it this way because often the same fallback
6161 host is used for many domains, so all can be sent in a single transaction
6162 (if appropriately configured). */
6164 if (addr_fallback != NULL && !mua_wrapper)
6166 DEBUG(D_deliver) debug_printf("Delivering to fallback hosts\n");
6167 addr_remote = addr_fallback;
6168 addr_fallback = NULL;
6169 if (remote_sort_domains != NULL) sort_remote_deliveries();
6170 do_remote_deliveries(TRUE);
6172 disable_logging = FALSE;
6176 /* All deliveries are now complete. Ignore SIGTERM during this tidying up
6177 phase, to minimize cases of half-done things. */
6180 debug_printf(">>>>>>>>>>>>>>>> deliveries are done >>>>>>>>>>>>>>>>\n");
6182 /* Root privilege is no longer needed */
6184 exim_setugid(exim_uid, exim_gid, FALSE, US"post-delivery tidying");
6186 set_process_info("tidying up after delivering %s", message_id);
6187 signal(SIGTERM, SIG_IGN);
6189 /* When we are acting as an MUA wrapper, the smtp transport will either have
6190 succeeded for all addresses, or failed them all in normal cases. However, there
6191 are some setup situations (e.g. when a named port does not exist) that cause an
6192 immediate exit with deferral of all addresses. Convert those into failures. We
6193 do not ever want to retry, nor do we want to send a bounce message. */
6197 if (addr_defer != NULL)
6199 address_item *addr, *nextaddr;
6200 for (addr = addr_defer; addr != NULL; addr = nextaddr)
6202 log_write(0, LOG_MAIN, "** %s mua_wrapper forced failure for deferred "
6203 "delivery", addr->address);
6204 nextaddr = addr->next;
6205 addr->next = addr_failed;
6211 /* Now all should either have succeeded or failed. */
6213 if (addr_failed == NULL) final_yield = DELIVER_MUA_SUCCEEDED; else
6215 uschar *s = (addr_failed->user_message != NULL)?
6216 addr_failed->user_message : addr_failed->message;
6218 fprintf(stderr, "Delivery failed: ");
6219 if (addr_failed->basic_errno > 0)
6221 fprintf(stderr, "%s", strerror(addr_failed->basic_errno));
6222 if (s != NULL) fprintf(stderr, ": ");
6226 if (addr_failed->basic_errno <= 0) fprintf(stderr, "unknown error");
6228 else fprintf(stderr, "%s", CS s);
6229 fprintf(stderr, "\n");
6231 final_yield = DELIVER_MUA_FAILED;
6236 /* In a normal configuration, we now update the retry database. This is done in
6237 one fell swoop at the end in order not to keep opening and closing (and
6238 locking) the database. The code for handling retries is hived off into a
6239 separate module for convenience. We pass it the addresses of the various
6240 chains, because deferred addresses can get moved onto the failed chain if the
6241 retry cutoff time has expired for all alternative destinations. Bypass the
6242 updating of the database if the -N flag is set, which is a debugging thing that
6243 prevents actual delivery. */
6245 else if (!dont_deliver) retry_update(&addr_defer, &addr_failed, &addr_succeed);
6247 /* If any addresses failed, we must send a message to somebody, unless
6248 af_ignore_error is set, in which case no action is taken. It is possible for
6249 several messages to get sent if there are addresses with different
6252 while (addr_failed != NULL)
6256 uschar *logtod = tod_stamp(tod_log);
6258 address_item *handled_addr = NULL;
6259 address_item **paddr;
6260 address_item *msgchain = NULL;
6261 address_item **pmsgchain = &msgchain;
6263 /* There are weird cases when logging is disabled in the transport. However,
6264 there may not be a transport (address failed by a router). */
6266 disable_logging = FALSE;
6267 if (addr_failed->transport != NULL)
6268 disable_logging = addr_failed->transport->disable_logging;
6271 debug_printf("processing failed address %s\n", addr_failed->address);
6273 /* There are only two ways an address in a bounce message can get here:
6275 (1) When delivery was initially deferred, but has now timed out (in the call
6276 to retry_update() above). We can detect this by testing for
6277 af_retry_timedout. If the address does not have its own errors address,
6278 we arrange to ignore the error.
6280 (2) If delivery failures for bounce messages are being ignored. We can detect
6281 this by testing for af_ignore_error. This will also be set if a bounce
6282 message has been autothawed and the ignore_bounce_errors_after time has
6283 passed. It might also be set if a router was explicitly configured to
6284 ignore errors (errors_to = "").
6286 If neither of these cases obtains, something has gone wrong. Log the
6287 incident, but then ignore the error. */
6289 if (sender_address[0] == 0 && addr_failed->p.errors_address == NULL)
6291 if (!testflag(addr_failed, af_retry_timedout) &&
6292 !testflag(addr_failed, af_ignore_error))
6294 log_write(0, LOG_MAIN|LOG_PANIC, "internal error: bounce message "
6295 "failure is neither frozen nor ignored (it's been ignored)");
6297 setflag(addr_failed, af_ignore_error);
6300 /* If the first address on the list has af_ignore_error set, just remove
6301 it from the list, throw away any saved message file, log it, and
6302 mark the recipient done. */
6304 if (testflag(addr_failed, af_ignore_error))
6307 addr_failed = addr->next;
6308 if (addr->return_filename != NULL) Uunlink(addr->return_filename);
6310 log_write(0, LOG_MAIN, "%s%s%s%s: error ignored",
6312 (addr->parent == NULL)? US"" : US" <",
6313 (addr->parent == NULL)? US"" : addr->parent->address,
6314 (addr->parent == NULL)? US"" : US">");
6316 address_done(addr, logtod);
6317 child_done(addr, logtod);
6318 /* Panic-dies on error */
6319 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
6322 /* Otherwise, handle the sending of a message. Find the error address for
6323 the first address, then send a message that includes all failed addresses
6324 that have the same error address. Note the bounce_recipient is a global so
6325 that it can be accesssed by $bounce_recipient while creating a customized
6330 bounce_recipient = (addr_failed->p.errors_address == NULL)?
6331 sender_address : addr_failed->p.errors_address;
6333 /* Make a subprocess to send a message */
6335 pid = child_open_exim(&fd);
6337 /* Creation of child failed */
6340 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Process %d (parent %d) failed to "
6341 "create child process to send failure message: %s", getpid(),
6342 getppid(), strerror(errno));
6344 /* Creation of child succeeded */
6351 uschar *bcc, *emf_text;
6352 FILE *f = fdopen(fd, "wb");
6354 BOOL to_sender = strcmpic(sender_address, bounce_recipient) == 0;
6355 int max = (bounce_return_size_limit/DELIVER_IN_BUFFER_SIZE + 1) *
6356 DELIVER_IN_BUFFER_SIZE;
6359 debug_printf("sending error message to: %s\n", bounce_recipient);
6361 /* Scan the addresses for all that have the same errors address, removing
6362 them from the addr_failed chain, and putting them on msgchain. */
6364 paddr = &addr_failed;
6365 for (addr = addr_failed; addr != NULL; addr = *paddr)
6367 if (Ustrcmp(bounce_recipient, (addr->p.errors_address == NULL)?
6368 sender_address : addr->p.errors_address) != 0)
6370 paddr = &(addr->next); /* Not the same; skip */
6372 else /* The same - dechain */
6374 *paddr = addr->next;
6377 pmsgchain = &(addr->next);
6381 /* Include X-Failed-Recipients: for automatic interpretation, but do
6382 not let any one header line get too long. We do this by starting a
6383 new header every 50 recipients. Omit any addresses for which the
6384 "hide_child" flag is set. */
6386 for (addr = msgchain; addr != NULL; addr = addr->next)
6388 if (testflag(addr, af_hide_child)) continue;
6395 (rcount++ == 0)? "X-Failed-Recipients: " : ",\n ",
6396 (testflag(addr, af_pfr) && addr->parent != NULL)?
6397 string_printing(addr->parent->address) :
6398 string_printing(addr->address));
6400 if (rcount > 0) fprintf(f, "\n");
6402 /* Output the standard headers */
6404 if (errors_reply_to != NULL)
6405 fprintf(f, "Reply-To: %s\n", errors_reply_to);
6406 fprintf(f, "Auto-Submitted: auto-replied\n");
6408 fprintf(f, "To: %s\n", bounce_recipient);
6410 /* Open a template file if one is provided. Log failure to open, but
6411 carry on - default texts will be used. */
6413 if (bounce_message_file != NULL)
6415 emf = Ufopen(bounce_message_file, "rb");
6417 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to open %s for error "
6418 "message texts: %s", bounce_message_file, strerror(errno));
6421 /* Quietly copy to configured additional addresses if required. */
6423 bcc = moan_check_errorcopy(bounce_recipient);
6424 if (bcc != NULL) fprintf(f, "Bcc: %s\n", bcc);
6426 /* The texts for the message can be read from a template file; if there
6427 isn't one, or if it is too short, built-in texts are used. The first
6428 emf text is a Subject: and any other headers. */
6430 emf_text = next_emf(emf, US"header");
6431 if (emf_text != NULL) fprintf(f, "%s\n", emf_text); else
6433 fprintf(f, "Subject: Mail delivery failed%s\n\n",
6434 to_sender? ": returning message to sender" : "");
6437 emf_text = next_emf(emf, US"intro");
6438 if (emf_text != NULL) fprintf(f, "%s", CS emf_text); else
6441 /* This message has been reworded several times. It seems to be confusing to
6442 somebody, however it is worded. I have retreated to the original, simple
6444 "This message was created automatically by mail delivery software.\n");
6445 if (bounce_message_text != NULL) fprintf(f, "%s", CS bounce_message_text);
6449 "\nA message that you sent could not be delivered to one or more of its\n"
6450 "recipients. This is a permanent error. The following address(es) failed:\n");
6455 "\nA message sent by\n\n <%s>\n\n"
6456 "could not be delivered to one or more of its recipients. The following\n"
6457 "address(es) failed:\n", sender_address);
6462 /* Process the addresses, leaving them on the msgchain if they have a
6463 file name for a return message. (There has already been a check in
6464 post_process_one() for the existence of data in the message file.) A TRUE
6465 return from print_address_information() means that the address is not
6469 for (addr = msgchain; addr != NULL; addr = *paddr)
6471 if (print_address_information(addr, f, US" ", US"\n ", US""))
6472 print_address_error(addr, f, US"");
6474 /* End the final line for the address */
6478 /* Leave on msgchain if there's a return file. */
6480 if (addr->return_file >= 0)
6482 paddr = &(addr->next);
6486 /* Else save so that we can tick off the recipient when the
6491 *paddr = addr->next;
6492 addr->next = handled_addr;
6493 handled_addr = addr;
6499 /* Get the next text, whether we need it or not, so as to be
6500 positioned for the one after. */
6502 emf_text = next_emf(emf, US"generated text");
6504 /* If there were any file messages passed by the local transports,
6505 include them in the message. Then put the address on the handled chain.
6506 In the case of a batch of addresses that were all sent to the same
6507 transport, the return_file field in all of them will contain the same
6508 fd, and the return_filename field in the *last* one will be set (to the
6509 name of the file). */
6511 if (msgchain != NULL)
6513 address_item *nextaddr;
6515 if (emf_text != NULL) fprintf(f, "%s", CS emf_text); else
6517 "The following text was generated during the delivery "
6518 "attempt%s:\n", (filecount > 1)? "s" : "");
6520 for (addr = msgchain; addr != NULL; addr = nextaddr)
6523 address_item *topaddr = addr;
6525 /* List all the addresses that relate to this file */
6528 while(addr != NULL) /* Insurance */
6530 print_address_information(addr, f, US"------ ", US"\n ",
6532 if (addr->return_filename != NULL) break;
6537 /* Now copy the file */
6539 fm = Ufopen(addr->return_filename, "rb");
6542 fprintf(f, " +++ Exim error... failed to open text file: %s\n",
6546 while ((ch = fgetc(fm)) != EOF) fputc(ch, f);
6549 Uunlink(addr->return_filename);
6551 /* Can now add to handled chain, first fishing off the next
6552 address on the msgchain. */
6554 nextaddr = addr->next;
6555 addr->next = handled_addr;
6556 handled_addr = topaddr;
6561 /* Now copy the message, trying to give an intelligible comment if
6562 it is too long for it all to be copied. The limit isn't strictly
6563 applied because of the buffering. There is, however, an option
6564 to suppress copying altogether. */
6566 emf_text = next_emf(emf, US"copy");
6568 if (bounce_return_message)
6570 int topt = topt_add_return_path;
6571 if (!bounce_return_body) topt |= topt_no_body;
6573 if (emf_text != NULL) fprintf(f, "%s", CS emf_text); else
6575 if (bounce_return_body) fprintf(f,
6576 "------ This is a copy of the message, including all the headers. ------\n");
6578 "------ This is a copy of the message's headers. ------\n");
6581 /* While reading the "truncated" message, set return_size_limit to
6582 the actual max testing value, rounded. We need to read the message
6583 whether we are going to use it or not. */
6586 int temp = bounce_return_size_limit;
6587 bounce_return_size_limit = (max/1000)*1000;
6588 emf_text = next_emf(emf, US"truncated");
6589 bounce_return_size_limit = temp;
6592 if (bounce_return_body && bounce_return_size_limit > 0)
6594 struct stat statbuf;
6595 if (fstat(deliver_datafile, &statbuf) == 0 && statbuf.st_size > max)
6597 if (emf_text != NULL) fprintf(f, "%s", CS emf_text); else
6600 "------ The body of the message is " OFF_T_FMT " characters long; only the first\n"
6601 "------ %d or so are included here.\n", statbuf.st_size, max);
6608 transport_filter_argv = NULL; /* Just in case */
6609 return_path = sender_address; /* In case not previously set */
6610 transport_write_message(NULL, fileno(f), topt,
6611 bounce_return_size_limit, NULL, NULL, NULL, NULL, NULL, 0);
6614 /* Write final text and close the template file if one is open */
6618 emf_text = next_emf(emf, US"final");
6619 if (emf_text != NULL) fprintf(f, "%s", CS emf_text);
6623 /* Close the file, which should send an EOF to the child process
6624 that is receiving the message. Wait for it to finish. */
6627 rc = child_close(pid, 0); /* Waits for child to close, no timeout */
6629 /* In the test harness, let the child do it's thing first. */
6631 if (running_in_test_harness) millisleep(500);
6633 /* If the process failed, there was some disaster in setting up the
6634 error message. Unless the message is very old, ensure that addr_defer
6635 is non-null, which will have the effect of leaving the message on the
6636 spool. The failed addresses will get tried again next time. However, we
6637 don't really want this to happen too often, so freeze the message unless
6638 there are some genuine deferred addresses to try. To do this we have
6639 to call spool_write_header() here, because with no genuine deferred
6640 addresses the normal code below doesn't get run. */
6645 if (now - received_time < retry_maximum_timeout && addr_defer == NULL)
6647 addr_defer = (address_item *)(+1);
6648 deliver_freeze = TRUE;
6649 deliver_frozen_at = time(NULL);
6650 /* Panic-dies on error */
6651 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
6654 deliver_msglog("Process failed (%d) when writing error message "
6655 "to %s%s", rc, bounce_recipient, s);
6656 log_write(0, LOG_MAIN, "Process failed (%d) when writing error message "
6657 "to %s%s", rc, bounce_recipient, s);
6660 /* The message succeeded. Ensure that the recipients that failed are
6661 now marked finished with on the spool and their parents updated. */
6665 for (addr = handled_addr; addr != NULL; addr = addr->next)
6667 address_done(addr, logtod);
6668 child_done(addr, logtod);
6670 /* Panic-dies on error */
6671 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
6677 disable_logging = FALSE; /* In case left set */
6679 /* Come here from the mua_wrapper case if routing goes wrong */
6683 /* If there are now no deferred addresses, we are done. Preserve the
6684 message log if so configured, and we are using them. Otherwise, sling it.
6685 Then delete the message itself. */
6687 if (addr_defer == NULL)
6691 sprintf(CS spoolname, "%s/msglog/%s/%s", spool_directory, message_subdir,
6693 if (preserve_message_logs)
6696 sprintf(CS big_buffer, "%s/msglog.OLD/%s", spool_directory, id);
6697 if ((rc = Urename(spoolname, big_buffer)) < 0)
6699 (void)directory_make(spool_directory, US"msglog.OLD",
6700 MSGLOG_DIRECTORY_MODE, TRUE);
6701 rc = Urename(spoolname, big_buffer);
6704 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to move %s to the "
6705 "msglog.OLD directory", spoolname);
6709 if (Uunlink(spoolname) < 0)
6710 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s",
6711 spoolname, strerror(errno));
6715 /* Remove the two message files. */
6717 sprintf(CS spoolname, "%s/input/%s/%s-D", spool_directory, message_subdir, id);
6718 if (Uunlink(spoolname) < 0)
6719 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s",
6720 spoolname, strerror(errno));
6721 sprintf(CS spoolname, "%s/input/%s/%s-H", spool_directory, message_subdir, id);
6722 if (Uunlink(spoolname) < 0)
6723 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s",
6724 spoolname, strerror(errno));
6726 /* Log the end of this message, with queue time if requested. */
6728 if ((log_extra_selector & LX_queue_time_overall) != 0)
6729 log_write(0, LOG_MAIN, "Completed QT=%s",
6730 readconf_printtime(time(NULL) - received_time));
6732 log_write(0, LOG_MAIN, "Completed");
6734 /* Unset deliver_freeze so that we won't try to move the spool files further down */
6735 deliver_freeze = FALSE;
6738 /* If there are deferred addresses, we are keeping this message because it is
6739 not yet completed. Lose any temporary files that were catching output from
6740 pipes for any of the deferred addresses, handle one-time aliases, and see if
6741 the message has been on the queue for so long that it is time to send a warning
6742 message to the sender, unless it is a mailer-daemon. If all deferred addresses
6743 have the same domain, we can set deliver_domain for the expansion of
6744 delay_warning_ condition - if any of them are pipes, files, or autoreplies, use
6745 the parent's domain.
6747 If all the deferred addresses have an error number that indicates "retry time
6748 not reached", skip sending the warning message, because it won't contain the
6749 reason for the delay. It will get sent at the next real delivery attempt.
6750 However, if at least one address has tried, we'd better include all of them in
6753 If we can't make a process to send the message, don't worry.
6755 For mailing list expansions we want to send the warning message to the
6756 mailing list manager. We can't do a perfect job here, as some addresses may
6757 have different errors addresses, but if we take the errors address from
6758 each deferred address it will probably be right in most cases.
6760 If addr_defer == +1, it means there was a problem sending an error message
6761 for failed addresses, and there were no "real" deferred addresses. The value
6762 was set just to keep the message on the spool, so there is nothing to do here.
6765 else if (addr_defer != (address_item *)(+1))
6768 uschar *recipients = US"";
6769 BOOL delivery_attempted = FALSE;
6771 deliver_domain = testflag(addr_defer, af_pfr)?
6772 addr_defer->parent->domain : addr_defer->domain;
6774 for (addr = addr_defer; addr != NULL; addr = addr->next)
6776 address_item *otaddr;
6778 if (addr->basic_errno > ERRNO_RETRY_BASE) delivery_attempted = TRUE;
6780 if (deliver_domain != NULL)
6782 uschar *d = (testflag(addr, af_pfr))? addr->parent->domain : addr->domain;
6784 /* The domain may be unset for an address that has never been routed
6785 because the system filter froze the message. */
6787 if (d == NULL || Ustrcmp(d, deliver_domain) != 0) deliver_domain = NULL;
6790 if (addr->return_filename != NULL) Uunlink(addr->return_filename);
6792 /* Handle the case of one-time aliases. If any address in the ancestry
6793 of this one is flagged, ensure it is in the recipients list, suitably
6794 flagged, and that its parent is marked delivered. */
6796 for (otaddr = addr; otaddr != NULL; otaddr = otaddr->parent)
6797 if (otaddr->onetime_parent != NULL) break;
6802 int t = recipients_count;
6804 for (i = 0; i < recipients_count; i++)
6806 uschar *r = recipients_list[i].address;
6807 if (Ustrcmp(otaddr->onetime_parent, r) == 0) t = i;
6808 if (Ustrcmp(otaddr->address, r) == 0) break;
6811 /* Didn't find the address already in the list, and did find the
6812 ultimate parent's address in the list. After adding the recipient,
6813 update the errors address in the recipients list. */
6815 if (i >= recipients_count && t < recipients_count)
6817 DEBUG(D_deliver) debug_printf("one_time: adding %s in place of %s\n",
6818 otaddr->address, otaddr->parent->address);
6819 receive_add_recipient(otaddr->address, t);
6820 recipients_list[recipients_count-1].errors_to = otaddr->p.errors_address;
6821 tree_add_nonrecipient(otaddr->parent->address);
6822 update_spool = TRUE;
6826 /* Except for error messages, ensure that either the errors address for
6827 this deferred address or, if there is none, the sender address, is on the
6828 list of recipients for a warning message. */
6830 if (sender_address[0] != 0)
6832 if (addr->p.errors_address == NULL)
6834 if (Ustrstr(recipients, sender_address) == NULL)
6835 recipients = string_sprintf("%s%s%s", recipients,
6836 (recipients[0] == 0)? "" : ",", sender_address);
6840 if (Ustrstr(recipients, addr->p.errors_address) == NULL)
6841 recipients = string_sprintf("%s%s%s", recipients,
6842 (recipients[0] == 0)? "" : ",", addr->p.errors_address);
6847 /* Send a warning message if the conditions are right. If the condition check
6848 fails because of a lookup defer, there is nothing we can do. The warning
6849 is not sent. Another attempt will be made at the next delivery attempt (if
6852 if (!queue_2stage && delivery_attempted &&
6853 delay_warning[1] > 0 && sender_address[0] != 0 &&
6854 (delay_warning_condition == NULL ||
6855 expand_check_condition(delay_warning_condition,
6856 US"delay_warning", US"option")))
6860 int queue_time = time(NULL) - received_time;
6862 /* When running in the test harness, there's an option that allows us to
6863 fudge this time so as to get repeatability of the tests. Take the first
6864 time off the list. In queue runs, the list pointer gets updated in the
6867 if (running_in_test_harness && fudged_queue_times[0] != 0)
6869 int qt = readconf_readtime(fudged_queue_times, '/', FALSE);
6872 DEBUG(D_deliver) debug_printf("fudged queue_times = %s\n",
6873 fudged_queue_times);
6878 /* See how many warnings we should have sent by now */
6880 for (count = 0; count < delay_warning[1]; count++)
6881 if (queue_time < delay_warning[count+2]) break;
6883 show_time = delay_warning[count+1];
6885 if (count >= delay_warning[1])
6888 int last_gap = show_time;
6889 if (count > 1) last_gap -= delay_warning[count];
6890 extra = (queue_time - delay_warning[count+1])/last_gap;
6891 show_time += last_gap * extra;
6897 debug_printf("time on queue = %s\n", readconf_printtime(queue_time));
6898 debug_printf("warning counts: required %d done %d\n", count,
6902 /* We have computed the number of warnings there should have been by now.
6903 If there haven't been enough, send one, and up the count to what it should
6906 if (warning_count < count)
6910 pid_t pid = child_open_exim(&fd);
6916 FILE *f = fdopen(fd, "wb");
6918 if (warn_message_file != NULL)
6920 wmf = Ufopen(warn_message_file, "rb");
6922 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to open %s for warning "
6923 "message texts: %s", warn_message_file, strerror(errno));
6926 warnmsg_recipients = recipients;
6927 warnmsg_delay = (queue_time < 120*60)?
6928 string_sprintf("%d minutes", show_time/60):
6929 string_sprintf("%d hours", show_time/3600);
6931 if (errors_reply_to != NULL)
6932 fprintf(f, "Reply-To: %s\n", errors_reply_to);
6933 fprintf(f, "Auto-Submitted: auto-replied\n");
6935 fprintf(f, "To: %s\n", recipients);
6937 wmf_text = next_emf(wmf, US"header");
6938 if (wmf_text != NULL)
6939 fprintf(f, "%s\n", wmf_text);
6941 fprintf(f, "Subject: Warning: message %s delayed %s\n\n",
6942 message_id, warnmsg_delay);
6944 wmf_text = next_emf(wmf, US"intro");
6945 if (wmf_text != NULL) fprintf(f, "%s", CS wmf_text); else
6948 "This message was created automatically by mail delivery software.\n");
6950 if (Ustrcmp(recipients, sender_address) == 0)
6952 "A message that you sent has not yet been delivered to one or more of its\n"
6953 "recipients after more than ");
6956 "A message sent by\n\n <%s>\n\n"
6957 "has not yet been delivered to one or more of its recipients after more than \n",
6960 fprintf(f, "%s on the queue on %s.\n\n", warnmsg_delay,
6962 fprintf(f, "The message identifier is: %s\n", message_id);
6964 for (h = header_list; h != NULL; h = h->next)
6966 if (strncmpic(h->text, US"Subject:", 8) == 0)
6967 fprintf(f, "The subject of the message is: %s", h->text + 9);
6968 else if (strncmpic(h->text, US"Date:", 5) == 0)
6969 fprintf(f, "The date of the message is: %s", h->text + 6);
6973 fprintf(f, "The address%s to which the message has not yet been "
6975 (addr_defer->next == NULL)? "" : "es",
6976 (addr_defer->next == NULL)? "is": "are");
6979 /* List the addresses, with error information if allowed */
6982 while (addr_defer != NULL)
6984 address_item *addr = addr_defer;
6985 addr_defer = addr->next;
6986 if (print_address_information(addr, f, US" ", US"\n ", US""))
6987 print_address_error(addr, f, US"Delay reason: ");
6996 wmf_text = next_emf(wmf, US"final");
6997 if (wmf_text != NULL) fprintf(f, "%s", CS wmf_text);
7003 "No action is required on your part. Delivery attempts will continue for\n"
7004 "some time, and this warning may be repeated at intervals if the message\n"
7005 "remains undelivered. Eventually the mail delivery software will give up,\n"
7006 "and when that happens, the message will be returned to you.\n");
7009 /* Close and wait for child process to complete, without a timeout.
7010 If there's an error, don't update the count. */
7013 if (child_close(pid, 0) == 0)
7015 warning_count = count;
7016 update_spool = TRUE; /* Ensure spool rewritten */
7022 /* Clear deliver_domain */
7024 deliver_domain = NULL;
7026 /* If this was a first delivery attempt, unset the first time flag, and
7027 ensure that the spool gets updated. */
7029 if (deliver_firsttime)
7031 deliver_firsttime = FALSE;
7032 update_spool = TRUE;
7035 /* If delivery was frozen and freeze_tell is set, generate an appropriate
7036 message, unless the message is a local error message (to avoid loops). Then
7037 log the freezing. If the text in "frozen_info" came from a system filter,
7038 it has been escaped into printing characters so as not to mess up log lines.
7039 For the "tell" message, we turn \n back into newline. Also, insert a newline
7040 near the start instead of the ": " string. */
7044 if (freeze_tell != NULL && freeze_tell[0] != 0 && !local_error_message)
7046 uschar *s = string_copy(frozen_info);
7047 uschar *ss = Ustrstr(s, " by the system filter: ");
7058 if (*ss == '\\' && ss[1] == 'n')
7065 moan_tell_someone(freeze_tell, addr_defer, US"Message frozen",
7066 "Message %s has been frozen%s.\nThe sender is <%s>.\n", message_id,
7070 /* Log freezing just before we update the -H file, to minimize the chance
7071 of a race problem. */
7073 deliver_msglog("*** Frozen%s\n", frozen_info);
7074 log_write(0, LOG_MAIN, "Frozen%s", frozen_info);
7077 /* If there have been any updates to the non-recipients list, or other things
7078 that get written to the spool, we must now update the spool header file so
7079 that it has the right information for the next delivery attempt. If there
7080 was more than one address being delivered, the header_change update is done
7081 earlier, in case one succeeds and then something crashes. */
7084 debug_printf("delivery deferred: update_spool=%d header_rewritten=%d\n",
7085 update_spool, header_rewritten);
7087 if (update_spool || header_rewritten)
7088 /* Panic-dies on error */
7089 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
7092 /* Finished with the message log. If the message is complete, it will have
7093 been unlinked or renamed above. */
7095 if (message_logs) (void)fclose(message_log);
7097 /* Now we can close and remove the journal file. Its only purpose is to record
7098 successfully completed deliveries asap so that this information doesn't get
7099 lost if Exim (or the machine) crashes. Forgetting about a failed delivery is
7100 not serious, as trying it again is not harmful. The journal might not be open
7101 if all addresses were deferred at routing or directing. Nevertheless, we must
7102 remove it if it exists (may have been lying around from a crash during the
7103 previous delivery attempt). We don't remove the journal if a delivery
7104 subprocess failed to pass back delivery information; this is controlled by
7105 the remove_journal flag. When the journal is left, we also don't move the
7106 message off the main spool if frozen and the option is set. It should get moved
7107 at the next attempt, after the journal has been inspected. */
7109 if (journal_fd >= 0) (void)close(journal_fd);
7113 sprintf(CS spoolname, "%s/input/%s/%s-J", spool_directory, message_subdir, id);
7114 if (Uunlink(spoolname) < 0 && errno != ENOENT)
7115 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s", spoolname,
7118 /* Move the message off the spool if reqested */
7120 #ifdef SUPPORT_MOVE_FROZEN_MESSAGES
7121 if (deliver_freeze && move_frozen_messages)
7122 (void)spool_move_message(id, message_subdir, US"", US"F");
7126 /* Closing the data file frees the lock; if the file has been unlinked it
7127 will go away. Otherwise the message becomes available for another process
7130 (void)close(deliver_datafile);
7131 deliver_datafile = -1;
7132 DEBUG(D_deliver) debug_printf("end delivery of %s\n", id);
7134 /* It is unlikely that there will be any cached resources, since they are
7135 released after routing, and in the delivery subprocesses. However, it's
7136 possible for an expansion for something afterwards (for example,
7137 expand_check_condition) to do a lookup. We must therefore be sure everything is
7141 acl_where = ACL_WHERE_UNKNOWN;
7145 /* End of deliver.c */