1 /*************************************************
2 * Exim - an Internet mail transport agent *
3 *************************************************/
5 /* Copyright (c) University of Cambridge 1995 - 2013 */
6 /* See the file NOTICE for conditions of use and distribution. */
8 /* The main code for delivering a message. */
14 /* Data block for keeping track of subprocesses for parallel remote
17 typedef struct pardata {
18 address_item *addrlist; /* chain of addresses */
19 address_item *addr; /* next address data expected for */
20 pid_t pid; /* subprocess pid */
21 int fd; /* pipe fd for getting result from subprocess */
22 int transport_count; /* returned transport count value */
23 BOOL done; /* no more data needed */
24 uschar *msg; /* error message */
25 uschar *return_path; /* return_path for these addresses */
28 /* Values for the process_recipients variable */
30 enum { RECIP_ACCEPT, RECIP_IGNORE, RECIP_DEFER,
31 RECIP_FAIL, RECIP_FAIL_FILTER, RECIP_FAIL_TIMEOUT,
34 /* Mutually recursive functions for marking addresses done. */
36 static void child_done(address_item *, uschar *);
37 static void address_done(address_item *, uschar *);
39 /* Table for turning base-62 numbers into binary */
41 static uschar tab62[] =
42 {0,1,2,3,4,5,6,7,8,9,0,0,0,0,0,0, /* 0-9 */
43 0,10,11,12,13,14,15,16,17,18,19,20, /* A-K */
44 21,22,23,24,25,26,27,28,29,30,31,32, /* L-W */
45 33,34,35, 0, 0, 0, 0, 0, /* X-Z */
46 0,36,37,38,39,40,41,42,43,44,45,46, /* a-k */
47 47,48,49,50,51,52,53,54,55,56,57,58, /* l-w */
51 /*************************************************
52 * Local static variables *
53 *************************************************/
55 /* addr_duplicate is global because it needs to be seen from the Envelope-To
58 static address_item *addr_defer = NULL;
59 static address_item *addr_failed = NULL;
60 static address_item *addr_fallback = NULL;
61 static address_item *addr_local = NULL;
62 static address_item *addr_new = NULL;
63 static address_item *addr_remote = NULL;
64 static address_item *addr_route = NULL;
65 static address_item *addr_succeed = NULL;
67 static FILE *message_log = NULL;
68 static BOOL update_spool;
69 static BOOL remove_journal;
70 static int parcount = 0;
71 static pardata *parlist = NULL;
72 static int return_count;
73 static uschar *frozen_info = US"";
74 static uschar *used_return_path = NULL;
76 static uschar spoolname[PATH_MAX];
80 /*************************************************
81 * Make a new address item *
82 *************************************************/
84 /* This function gets the store and initializes with default values. The
85 transport_return value defaults to DEFER, so that any unexpected failure to
86 deliver does not wipe out the message. The default unique string is set to a
87 copy of the address, so that its domain can be lowercased.
90 address the RFC822 address string
91 copy force a copy of the address
93 Returns: a pointer to an initialized address_item
97 deliver_make_addr(uschar *address, BOOL copy)
99 address_item *addr = store_get(sizeof(address_item));
100 *addr = address_defaults;
101 if (copy) address = string_copy(address);
102 addr->address = address;
103 addr->unique = string_copy(address);
110 /*************************************************
111 * Set expansion values for an address *
112 *************************************************/
114 /* Certain expansion variables are valid only when handling an address or
115 address list. This function sets them up or clears the values, according to its
119 addr the address in question, or NULL to clear values
124 deliver_set_expansions(address_item *addr)
128 uschar ***p = address_expansions;
129 while (*p != NULL) **p++ = NULL;
133 /* Exactly what gets set depends on whether there is one or more addresses, and
134 what they contain. These first ones are always set, taking their values from
135 the first address. */
137 if (addr->host_list == NULL)
139 deliver_host = deliver_host_address = US"";
143 deliver_host = addr->host_list->name;
144 deliver_host_address = addr->host_list->address;
147 deliver_recipients = addr;
148 deliver_address_data = addr->p.address_data;
149 deliver_domain_data = addr->p.domain_data;
150 deliver_localpart_data = addr->p.localpart_data;
152 /* These may be unset for multiple addresses */
154 deliver_domain = addr->domain;
155 self_hostname = addr->self_hostname;
157 #ifdef EXPERIMENTAL_BRIGHTMAIL
158 bmi_deliver = 1; /* deliver by default */
159 bmi_alt_location = NULL;
160 bmi_base64_verdict = NULL;
161 bmi_base64_tracker_verdict = NULL;
164 /* If there's only one address we can set everything. */
166 if (addr->next == NULL)
168 address_item *addr_orig;
170 deliver_localpart = addr->local_part;
171 deliver_localpart_prefix = addr->prefix;
172 deliver_localpart_suffix = addr->suffix;
174 for (addr_orig = addr; addr_orig->parent != NULL;
175 addr_orig = addr_orig->parent);
176 deliver_domain_orig = addr_orig->domain;
178 /* Re-instate any prefix and suffix in the original local part. In all
179 normal cases, the address will have a router associated with it, and we can
180 choose the caseful or caseless version accordingly. However, when a system
181 filter sets up a pipe, file, or autoreply delivery, no router is involved.
182 In this case, though, there won't be any prefix or suffix to worry about. */
184 deliver_localpart_orig = (addr_orig->router == NULL)? addr_orig->local_part :
185 addr_orig->router->caseful_local_part?
186 addr_orig->cc_local_part : addr_orig->lc_local_part;
188 /* If there's a parent, make its domain and local part available, and if
189 delivering to a pipe or file, or sending an autoreply, get the local
190 part from the parent. For pipes and files, put the pipe or file string
191 into address_pipe and address_file. */
193 if (addr->parent != NULL)
195 deliver_domain_parent = addr->parent->domain;
196 deliver_localpart_parent = (addr->parent->router == NULL)?
197 addr->parent->local_part :
198 addr->parent->router->caseful_local_part?
199 addr->parent->cc_local_part : addr->parent->lc_local_part;
201 /* File deliveries have their own flag because they need to be picked out
202 as special more often. */
204 if (testflag(addr, af_pfr))
206 if (testflag(addr, af_file)) address_file = addr->local_part;
207 else if (deliver_localpart[0] == '|') address_pipe = addr->local_part;
208 deliver_localpart = addr->parent->local_part;
209 deliver_localpart_prefix = addr->parent->prefix;
210 deliver_localpart_suffix = addr->parent->suffix;
214 #ifdef EXPERIMENTAL_BRIGHTMAIL
215 /* Set expansion variables related to Brightmail AntiSpam */
216 bmi_base64_verdict = bmi_get_base64_verdict(deliver_localpart_orig, deliver_domain_orig);
217 bmi_base64_tracker_verdict = bmi_get_base64_tracker_verdict(bmi_base64_verdict);
218 /* get message delivery status (0 - don't deliver | 1 - deliver) */
219 bmi_deliver = bmi_get_delivery_status(bmi_base64_verdict);
220 /* if message is to be delivered, get eventual alternate location */
221 if (bmi_deliver == 1) {
222 bmi_alt_location = bmi_get_alt_location(bmi_base64_verdict);
228 /* For multiple addresses, don't set local part, and leave the domain and
229 self_hostname set only if it is the same for all of them. It is possible to
230 have multiple pipe and file addresses, but only when all addresses have routed
231 to the same pipe or file. */
236 if (testflag(addr, af_pfr))
238 if (testflag(addr, af_file)) address_file = addr->local_part;
239 else if (addr->local_part[0] == '|') address_pipe = addr->local_part;
241 for (addr2 = addr->next; addr2 != NULL; addr2 = addr2->next)
243 if (deliver_domain != NULL &&
244 Ustrcmp(deliver_domain, addr2->domain) != 0)
245 deliver_domain = NULL;
246 if (self_hostname != NULL && (addr2->self_hostname == NULL ||
247 Ustrcmp(self_hostname, addr2->self_hostname) != 0))
248 self_hostname = NULL;
249 if (deliver_domain == NULL && self_hostname == NULL) break;
257 /*************************************************
258 * Open a msglog file *
259 *************************************************/
261 /* This function is used both for normal message logs, and for files in the
262 msglog directory that are used to catch output from pipes. Try to create the
263 directory if it does not exist. From release 4.21, normal message logs should
264 be created when the message is received.
267 filename the file name
268 mode the mode required
269 error used for saying what failed
271 Returns: a file descriptor, or -1 (with errno set)
275 open_msglog_file(uschar *filename, int mode, uschar **error)
277 int fd = Uopen(filename, O_WRONLY|O_APPEND|O_CREAT, mode);
279 if (fd < 0 && errno == ENOENT)
282 sprintf(CS temp, "msglog/%s", message_subdir);
283 if (message_subdir[0] == 0) temp[6] = 0;
284 (void)directory_make(spool_directory, temp, MSGLOG_DIRECTORY_MODE, TRUE);
285 fd = Uopen(filename, O_WRONLY|O_APPEND|O_CREAT, mode);
288 /* Set the close-on-exec flag and change the owner to the exim uid/gid (this
289 function is called as root). Double check the mode, because the group setting
290 doesn't always get set automatically. */
294 (void)fcntl(fd, F_SETFD, fcntl(fd, F_GETFD) | FD_CLOEXEC);
295 if (fchown(fd, exim_uid, exim_gid) < 0)
300 if (fchmod(fd, mode) < 0)
306 else *error = US"create";
314 /*************************************************
315 * Write to msglog if required *
316 *************************************************/
318 /* Write to the message log, if configured. This function may also be called
322 format a string format
328 deliver_msglog(const char *format, ...)
331 if (!message_logs) return;
332 va_start(ap, format);
333 vfprintf(message_log, format, ap);
341 /*************************************************
342 * Replicate status for batch *
343 *************************************************/
345 /* When a transport handles a batch of addresses, it may treat them
346 individually, or it may just put the status in the first one, and return FALSE,
347 requesting that the status be copied to all the others externally. This is the
348 replication function. As well as the status, it copies the transport pointer,
349 which may have changed if appendfile passed the addresses on to a different
352 Argument: pointer to the first address in a chain
357 replicate_status(address_item *addr)
360 for (addr2 = addr->next; addr2 != NULL; addr2 = addr2->next)
362 addr2->transport = addr->transport;
363 addr2->transport_return = addr->transport_return;
364 addr2->basic_errno = addr->basic_errno;
365 addr2->more_errno = addr->more_errno;
366 addr2->special_action = addr->special_action;
367 addr2->message = addr->message;
368 addr2->user_message = addr->user_message;
374 /*************************************************
375 * Compare lists of hosts *
376 *************************************************/
378 /* This function is given two pointers to chains of host items, and it yields
379 TRUE if the lists refer to the same hosts in the same order, except that
381 (1) Multiple hosts with the same non-negative MX values are permitted to appear
382 in different orders. Round-robinning nameservers can cause this to happen.
384 (2) Multiple hosts with the same negative MX values less than MX_NONE are also
385 permitted to appear in different orders. This is caused by randomizing
388 This enables Exim to use a single SMTP transaction for sending to two entirely
389 different domains that happen to end up pointing at the same hosts.
392 one points to the first host list
393 two points to the second host list
395 Returns: TRUE if the lists refer to the same host set
399 same_hosts(host_item *one, host_item *two)
401 while (one != NULL && two != NULL)
403 if (Ustrcmp(one->name, two->name) != 0)
406 host_item *end_one = one;
407 host_item *end_two = two;
409 /* Batch up only if there was no MX and the list was not randomized */
411 if (mx == MX_NONE) return FALSE;
413 /* Find the ends of the shortest sequence of identical MX values */
415 while (end_one->next != NULL && end_one->next->mx == mx &&
416 end_two->next != NULL && end_two->next->mx == mx)
418 end_one = end_one->next;
419 end_two = end_two->next;
422 /* If there aren't any duplicates, there's no match. */
424 if (end_one == one) return FALSE;
426 /* For each host in the 'one' sequence, check that it appears in the 'two'
427 sequence, returning FALSE if not. */
432 for (hi = two; hi != end_two->next; hi = hi->next)
433 if (Ustrcmp(one->name, hi->name) == 0) break;
434 if (hi == end_two->next) return FALSE;
435 if (one == end_one) break;
439 /* All the hosts in the 'one' sequence were found in the 'two' sequence.
440 Ensure both are pointing at the last host, and carry on as for equality. */
451 /* True if both are NULL */
458 /*************************************************
459 * Compare header lines *
460 *************************************************/
462 /* This function is given two pointers to chains of header items, and it yields
463 TRUE if they are the same header texts in the same order.
466 one points to the first header list
467 two points to the second header list
469 Returns: TRUE if the lists refer to the same header set
473 same_headers(header_line *one, header_line *two)
477 if (one == two) return TRUE; /* Includes the case where both NULL */
478 if (one == NULL || two == NULL) return FALSE;
479 if (Ustrcmp(one->text, two->text) != 0) return FALSE;
487 /*************************************************
488 * Compare string settings *
489 *************************************************/
491 /* This function is given two pointers to strings, and it returns
492 TRUE if they are the same pointer, or if the two strings are the same.
495 one points to the first string
496 two points to the second string
498 Returns: TRUE or FALSE
502 same_strings(uschar *one, uschar *two)
504 if (one == two) return TRUE; /* Includes the case where both NULL */
505 if (one == NULL || two == NULL) return FALSE;
506 return (Ustrcmp(one, two) == 0);
511 /*************************************************
512 * Compare uid/gid for addresses *
513 *************************************************/
515 /* This function is given a transport and two addresses. It yields TRUE if the
516 uid/gid/initgroups settings for the two addresses are going to be the same when
521 addr1 the first address
522 addr2 the second address
524 Returns: TRUE or FALSE
528 same_ugid(transport_instance *tp, address_item *addr1, address_item *addr2)
530 if (!tp->uid_set && tp->expand_uid == NULL && !tp->deliver_as_creator)
532 if (testflag(addr1, af_uid_set) != testflag(addr2, af_gid_set) ||
533 (testflag(addr1, af_uid_set) &&
534 (addr1->uid != addr2->uid ||
535 testflag(addr1, af_initgroups) != testflag(addr2, af_initgroups))))
539 if (!tp->gid_set && tp->expand_gid == NULL)
541 if (testflag(addr1, af_gid_set) != testflag(addr2, af_gid_set) ||
542 (testflag(addr1, af_gid_set) && addr1->gid != addr2->gid))
552 /*************************************************
553 * Record that an address is complete *
554 *************************************************/
556 /* This function records that an address is complete. This is straightforward
557 for most addresses, where the unique address is just the full address with the
558 domain lower cased. For homonyms (addresses that are the same as one of their
559 ancestors) their are complications. Their unique addresses have \x\ prepended
560 (where x = 0, 1, 2...), so that de-duplication works correctly for siblings and
563 Exim used to record the unique addresses of homonyms as "complete". This,
564 however, fails when the pattern of redirection varies over time (e.g. if taking
565 unseen copies at only some times of day) because the prepended numbers may vary
566 from one delivery run to the next. This problem is solved by never recording
567 prepended unique addresses as complete. Instead, when a homonymic address has
568 actually been delivered via a transport, we record its basic unique address
569 followed by the name of the transport. This is checked in subsequent delivery
570 runs whenever an address is routed to a transport.
572 If the completed address is a top-level one (has no parent, which means it
573 cannot be homonymic) we also add the original address to the non-recipients
574 tree, so that it gets recorded in the spool file and therefore appears as
575 "done" in any spool listings. The original address may differ from the unique
576 address in the case of the domain.
578 Finally, this function scans the list of duplicates, marks as done any that
579 match this address, and calls child_done() for their ancestors.
582 addr address item that has been completed
583 now current time as a string
589 address_done(address_item *addr, uschar *now)
593 update_spool = TRUE; /* Ensure spool gets updated */
595 /* Top-level address */
597 if (addr->parent == NULL)
599 tree_add_nonrecipient(addr->unique);
600 tree_add_nonrecipient(addr->address);
603 /* Homonymous child address */
605 else if (testflag(addr, af_homonym))
607 if (addr->transport != NULL)
609 tree_add_nonrecipient(
610 string_sprintf("%s/%s", addr->unique + 3, addr->transport->name));
614 /* Non-homonymous child address */
616 else tree_add_nonrecipient(addr->unique);
618 /* Check the list of duplicate addresses and ensure they are now marked
621 for (dup = addr_duplicate; dup != NULL; dup = dup->next)
623 if (Ustrcmp(addr->unique, dup->unique) == 0)
625 tree_add_nonrecipient(dup->unique);
626 child_done(dup, now);
634 /*************************************************
635 * Decrease counts in parents and mark done *
636 *************************************************/
638 /* This function is called when an address is complete. If there is a parent
639 address, its count of children is decremented. If there are still other
640 children outstanding, the function exits. Otherwise, if the count has become
641 zero, address_done() is called to mark the parent and its duplicates complete.
642 Then loop for any earlier ancestors.
645 addr points to the completed address item
646 now the current time as a string, for writing to the message log
652 child_done(address_item *addr, uschar *now)
655 while (addr->parent != NULL)
658 if ((addr->child_count -= 1) > 0) return; /* Incomplete parent */
659 address_done(addr, now);
661 /* Log the completion of all descendents only when there is no ancestor with
662 the same original address. */
664 for (aa = addr->parent; aa != NULL; aa = aa->parent)
665 if (Ustrcmp(aa->address, addr->address) == 0) break;
666 if (aa != NULL) continue;
668 deliver_msglog("%s %s: children all complete\n", now, addr->address);
669 DEBUG(D_deliver) debug_printf("%s: children all complete\n", addr->address);
676 /* If msg is NULL this is a delivery log and logchar is used. Otherwise
677 this is a nonstandard call; no two-characher delivery flag is written
678 but sender-host and sender are prefixed and "msg" is inserted in the log line.
681 flags passed to log_write()
684 delivery_log(int flags, address_item * addr, int logchar, uschar * msg)
687 int size = 256; /* Used for a temporary, */
688 int ptr = 0; /* expanding buffer, for */
689 uschar *s; /* building log lines; */
690 void *reset_point; /* released afterwards. */
693 /* Log the delivery on the main log. We use an extensible string to build up
694 the log line, and reset the store afterwards. Remote deliveries should always
695 have a pointer to the host item that succeeded; local deliveries can have a
696 pointer to a single host item in their host list, for use by the transport. */
698 #ifdef EXPERIMENTAL_TPDA
699 tpda_delivery_ip = NULL; /* presume no successful remote delivery */
700 tpda_delivery_port = 0;
701 tpda_delivery_fqdn = NULL;
702 tpda_delivery_local_part = NULL;
703 tpda_delivery_domain = NULL;
704 tpda_delivery_confirmation = NULL;
707 s = reset_point = store_get(size);
709 log_address = string_log_address(addr, (log_write_selector & L_all_parents) != 0, TRUE);
711 s = string_append(s, &size, &ptr, 3, host_and_ident(TRUE), US" ", log_address);
715 s = string_append(s, &size, &ptr, 2, US"> ", log_address);
718 if ((log_extra_selector & LX_sender_on_delivery) != 0 || msg)
719 s = string_append(s, &size, &ptr, 3, US" F=<", sender_address, US">");
721 #ifdef EXPERIMENTAL_SRS
722 if(addr->p.srs_sender)
723 s = string_append(s, &size, &ptr, 3, US" SRS=<", addr->p.srs_sender, US">");
726 /* You might think that the return path must always be set for a successful
727 delivery; indeed, I did for some time, until this statement crashed. The case
728 when it is not set is for a delivery to /dev/null which is optimised by not
731 if (used_return_path != NULL &&
732 (log_extra_selector & LX_return_path_on_delivery) != 0)
733 s = string_append(s, &size, &ptr, 3, US" P=<", used_return_path, US">");
736 s = string_append(s, &size, &ptr, 2, US" ", msg);
738 /* For a delivery from a system filter, there may not be a router */
739 if (addr->router != NULL)
740 s = string_append(s, &size, &ptr, 2, US" R=", addr->router->name);
742 s = string_append(s, &size, &ptr, 2, US" T=", addr->transport->name);
744 if ((log_extra_selector & LX_delivery_size) != 0)
745 s = string_append(s, &size, &ptr, 2, US" S=",
746 string_sprintf("%d", transport_count));
750 if (addr->transport->info->local)
752 if (addr->host_list != NULL)
754 s = string_append(s, &size, &ptr, 2, US" H=", addr->host_list->name);
755 #ifdef EXPERIMENTAL_TPDA
756 tpda_delivery_fqdn = addr->host_list->name;
759 if (addr->shadow_message != NULL)
760 s = string_cat(s, &size, &ptr, addr->shadow_message,
761 Ustrlen(addr->shadow_message));
764 /* Remote delivery */
768 if (addr->host_used != NULL)
770 s = string_append(s, &size, &ptr, 5, US" H=", addr->host_used->name,
771 US" [", addr->host_used->address, US"]");
772 if ((log_extra_selector & LX_outgoing_port) != 0)
773 s = string_append(s, &size, &ptr, 2, US":", string_sprintf("%d",
774 addr->host_used->port));
775 if (continue_sequence > 1)
776 s = string_cat(s, &size, &ptr, US"*", 1);
778 #ifdef EXPERIMENTAL_TPDA
779 tpda_delivery_ip = addr->host_used->address;
780 tpda_delivery_port = addr->host_used->port;
781 tpda_delivery_fqdn = addr->host_used->name;
782 tpda_delivery_local_part = addr->local_part;
783 tpda_delivery_domain = addr->domain;
784 tpda_delivery_confirmation = addr->message;
789 if ((log_extra_selector & LX_tls_cipher) != 0 && addr->cipher != NULL)
790 s = string_append(s, &size, &ptr, 2, US" X=", addr->cipher);
791 if ((log_extra_selector & LX_tls_certificate_verified) != 0 &&
792 addr->cipher != NULL)
793 s = string_append(s, &size, &ptr, 2, US" CV=",
794 testflag(addr, af_cert_verified)? "yes":"no");
795 if ((log_extra_selector & LX_tls_peerdn) != 0 && addr->peerdn != NULL)
796 s = string_append(s, &size, &ptr, 3, US" DN=\"",
797 string_printing(addr->peerdn), US"\"");
800 if (addr->authenticator)
802 s = string_append(s, &size, &ptr, 2, US" A=", addr->authenticator);
805 s = string_append(s, &size, &ptr, 2, US":", addr->auth_id);
806 if (log_extra_selector & LX_smtp_mailauth && addr->auth_sndr)
807 s = string_append(s, &size, &ptr, 2, US":", addr->auth_sndr);
811 #ifdef EXPERIMENTAL_PRDR
812 if (addr->flags & af_prdr_used)
813 s = string_append(s, &size, &ptr, 1, US" PRDR");
817 /* confirmation message (SMTP (host_used) and LMTP (driver_name)) */
819 if ((log_extra_selector & LX_smtp_confirmation) != 0 &&
820 addr->message != NULL &&
821 ((addr->host_used != NULL) || (Ustrcmp(addr->transport->driver_name, "lmtp") == 0)))
824 uschar *p = big_buffer;
825 uschar *ss = addr->message;
827 for (i = 0; i < 100 && ss[i] != 0; i++)
829 if (ss[i] == '\"' || ss[i] == '\\') *p++ = '\\';
834 s = string_append(s, &size, &ptr, 2, US" C=", big_buffer);
837 /* Time on queue and actual time taken to deliver */
839 if ((log_extra_selector & LX_queue_time) != 0)
841 s = string_append(s, &size, &ptr, 2, US" QT=",
842 readconf_printtime(time(NULL) - received_time));
845 if ((log_extra_selector & LX_deliver_time) != 0)
847 s = string_append(s, &size, &ptr, 2, US" DT=",
848 readconf_printtime(addr->more_errno));
851 /* string_cat() always leaves room for the terminator. Release the
852 store we used to build the line after writing it. */
855 log_write(0, flags, "%s", s);
857 #ifdef EXPERIMENTAL_TPDA
858 if (addr->transport->tpda_delivery_action)
861 debug_printf(" TPDA(Delivery): tpda_deliver_action=|%s| tpda_delivery_IP=%s\n",
862 addr->transport->tpda_delivery_action, tpda_delivery_ip);
864 router_name = addr->router->name;
865 transport_name = addr->transport->name;
866 if (!expand_string(addr->transport->tpda_delivery_action) && *expand_string_message)
867 log_write(0, LOG_MAIN|LOG_PANIC, "failed to expand tpda_deliver_action in %s: %s\n",
868 transport_name, expand_string_message);
870 transport_name = NULL;
873 store_reset(reset_point);
879 /*************************************************
880 * Actions at the end of handling an address *
881 *************************************************/
883 /* This is a function for processing a single address when all that can be done
884 with it has been done.
887 addr points to the address block
888 result the result of the delivery attempt
889 logflags flags for log_write() (LOG_MAIN and/or LOG_PANIC)
890 driver_type indicates which type of driver (transport, or router) was last
891 to process the address
892 logchar '=' or '-' for use when logging deliveries with => or ->
898 post_process_one(address_item *addr, int result, int logflags, int driver_type,
901 uschar *now = tod_stamp(tod_log);
902 uschar *driver_kind = NULL;
903 uschar *driver_name = NULL;
906 int size = 256; /* Used for a temporary, */
907 int ptr = 0; /* expanding buffer, for */
908 uschar *s; /* building log lines; */
909 void *reset_point; /* released afterwards. */
912 DEBUG(D_deliver) debug_printf("post-process %s (%d)\n", addr->address, result);
914 /* Set up driver kind and name for logging. Disable logging if the router or
915 transport has disabled it. */
917 if (driver_type == DTYPE_TRANSPORT)
919 if (addr->transport != NULL)
921 driver_name = addr->transport->name;
922 driver_kind = US" transport";
923 disable_logging = addr->transport->disable_logging;
925 else driver_kind = US"transporting";
927 else if (driver_type == DTYPE_ROUTER)
929 if (addr->router != NULL)
931 driver_name = addr->router->name;
932 driver_kind = US" router";
933 disable_logging = addr->router->disable_logging;
935 else driver_kind = US"routing";
938 /* If there's an error message set, ensure that it contains only printing
939 characters - it should, but occasionally things slip in and this at least
940 stops the log format from getting wrecked. We also scan the message for an LDAP
941 expansion item that has a password setting, and flatten the password. This is a
942 fudge, but I don't know a cleaner way of doing this. (If the item is badly
943 malformed, it won't ever have gone near LDAP.) */
945 if (addr->message != NULL)
947 addr->message = string_printing(addr->message);
948 if (((Ustrstr(addr->message, "failed to expand") != NULL) || (Ustrstr(addr->message, "expansion of ") != NULL)) &&
949 (Ustrstr(addr->message, "mysql") != NULL ||
950 Ustrstr(addr->message, "pgsql") != NULL ||
951 #ifdef EXPERIMENTAL_REDIS
952 Ustrstr(addr->message, "redis") != NULL ||
954 Ustrstr(addr->message, "sqlite") != NULL ||
955 Ustrstr(addr->message, "ldap:") != NULL ||
956 Ustrstr(addr->message, "ldapdn:") != NULL ||
957 Ustrstr(addr->message, "ldapm:") != NULL))
959 addr->message = string_sprintf("Temporary internal error");
963 /* If we used a transport that has one of the "return_output" options set, and
964 if it did in fact generate some output, then for return_output we treat the
965 message as failed if it was not already set that way, so that the output gets
966 returned to the sender, provided there is a sender to send it to. For
967 return_fail_output, do this only if the delivery failed. Otherwise we just
968 unlink the file, and remove the name so that if the delivery failed, we don't
969 try to send back an empty or unwanted file. The log_output options operate only
972 In any case, we close the message file, because we cannot afford to leave a
973 file-descriptor for one address while processing (maybe very many) others. */
975 if (addr->return_file >= 0 && addr->return_filename != NULL)
977 BOOL return_output = FALSE;
979 (void)EXIMfsync(addr->return_file);
981 /* If there is no output, do nothing. */
983 if (fstat(addr->return_file, &statbuf) == 0 && statbuf.st_size > 0)
985 transport_instance *tb = addr->transport;
987 /* Handle logging options */
989 if (tb->log_output || (result == FAIL && tb->log_fail_output) ||
990 (result == DEFER && tb->log_defer_output))
993 FILE *f = Ufopen(addr->return_filename, "rb");
995 log_write(0, LOG_MAIN|LOG_PANIC, "failed to open %s to log output "
996 "from %s transport: %s", addr->return_filename, tb->name,
1000 s = US Ufgets(big_buffer, big_buffer_size, f);
1003 uschar *p = big_buffer + Ustrlen(big_buffer);
1004 while (p > big_buffer && isspace(p[-1])) p--;
1006 s = string_printing(big_buffer);
1007 log_write(0, LOG_MAIN, "<%s>: %s transport output: %s",
1008 addr->address, tb->name, s);
1014 /* Handle returning options, but only if there is an address to return
1017 if (sender_address[0] != 0 || addr->p.errors_address != NULL)
1019 if (tb->return_output)
1021 addr->transport_return = result = FAIL;
1022 if (addr->basic_errno == 0 && addr->message == NULL)
1023 addr->message = US"return message generated";
1024 return_output = TRUE;
1027 if (tb->return_fail_output && result == FAIL) return_output = TRUE;
1031 /* Get rid of the file unless it might be returned, but close it in
1036 Uunlink(addr->return_filename);
1037 addr->return_filename = NULL;
1038 addr->return_file = -1;
1041 (void)close(addr->return_file);
1044 /* The sucess case happens only after delivery by a transport. */
1048 addr->next = addr_succeed;
1049 addr_succeed = addr;
1051 /* Call address_done() to ensure that we don't deliver to this address again,
1052 and write appropriate things to the message log. If it is a child address, we
1053 call child_done() to scan the ancestors and mark them complete if this is the
1054 last child to complete. */
1056 address_done(addr, now);
1057 DEBUG(D_deliver) debug_printf("%s delivered\n", addr->address);
1059 if (addr->parent == NULL)
1061 deliver_msglog("%s %s: %s%s succeeded\n", now, addr->address,
1062 driver_name, driver_kind);
1066 deliver_msglog("%s %s <%s>: %s%s succeeded\n", now, addr->address,
1067 addr->parent->address, driver_name, driver_kind);
1068 child_done(addr, now);
1071 delivery_log(LOG_MAIN, addr, logchar, NULL);
1075 /* Soft failure, or local delivery process failed; freezing may be
1078 else if (result == DEFER || result == PANIC)
1080 if (result == PANIC) logflags |= LOG_PANIC;
1082 /* This puts them on the chain in reverse order. Do not change this, because
1083 the code for handling retries assumes that the one with the retry
1084 information is last. */
1086 addr->next = addr_defer;
1089 /* The only currently implemented special action is to freeze the
1090 message. Logging of this is done later, just before the -H file is
1093 if (addr->special_action == SPECIAL_FREEZE)
1095 deliver_freeze = TRUE;
1096 deliver_frozen_at = time(NULL);
1097 update_spool = TRUE;
1100 /* If doing a 2-stage queue run, we skip writing to either the message
1101 log or the main log for SMTP defers. */
1103 if (!queue_2stage || addr->basic_errno != 0)
1107 /* For errors of the type "retry time not reached" (also remotes skipped
1108 on queue run), logging is controlled by L_retry_defer. Note that this kind
1109 of error number is negative, and all the retry ones are less than any
1112 unsigned int use_log_selector = (addr->basic_errno <= ERRNO_RETRY_BASE)?
1115 /* Build up the line that is used for both the message log and the main
1118 s = reset_point = store_get(size);
1120 /* Create the address string for logging. Must not do this earlier, because
1121 an OK result may be changed to FAIL when a pipe returns text. */
1123 log_address = string_log_address(addr,
1124 (log_write_selector & L_all_parents) != 0, result == OK);
1126 s = string_cat(s, &size, &ptr, log_address, Ustrlen(log_address));
1128 /* Either driver_name contains something and driver_kind contains
1129 " router" or " transport" (note the leading space), or driver_name is
1130 a null string and driver_kind contains "routing" without the leading
1131 space, if all routing has been deferred. When a domain has been held,
1132 so nothing has been done at all, both variables contain null strings. */
1134 if (driver_name == NULL)
1136 if (driver_kind != NULL)
1137 s = string_append(s, &size, &ptr, 2, US" ", driver_kind);
1141 if (driver_kind[1] == 't' && addr->router != NULL)
1142 s = string_append(s, &size, &ptr, 2, US" R=", addr->router->name);
1144 ss[1] = toupper(driver_kind[1]);
1145 s = string_append(s, &size, &ptr, 2, ss, driver_name);
1148 sprintf(CS ss, " defer (%d)", addr->basic_errno);
1149 s = string_cat(s, &size, &ptr, ss, Ustrlen(ss));
1151 if (addr->basic_errno > 0)
1152 s = string_append(s, &size, &ptr, 2, US": ",
1153 US strerror(addr->basic_errno));
1155 if (addr->message != NULL)
1156 s = string_append(s, &size, &ptr, 2, US": ", addr->message);
1160 /* Log the deferment in the message log, but don't clutter it
1161 up with retry-time defers after the first delivery attempt. */
1163 if (deliver_firsttime || addr->basic_errno > ERRNO_RETRY_BASE)
1164 deliver_msglog("%s %s\n", now, s);
1166 /* Write the main log and reset the store */
1168 log_write(use_log_selector, logflags, "== %s", s);
1169 store_reset(reset_point);
1174 /* Hard failure. If there is an address to which an error message can be sent,
1175 put this address on the failed list. If not, put it on the deferred list and
1176 freeze the mail message for human attention. The latter action can also be
1177 explicitly requested by a router or transport. */
1181 /* If this is a delivery error, or a message for which no replies are
1182 wanted, and the message's age is greater than ignore_bounce_errors_after,
1183 force the af_ignore_error flag. This will cause the address to be discarded
1184 later (with a log entry). */
1186 if (sender_address[0] == 0 && message_age >= ignore_bounce_errors_after)
1187 setflag(addr, af_ignore_error);
1189 /* Freeze the message if requested, or if this is a bounce message (or other
1190 message with null sender) and this address does not have its own errors
1191 address. However, don't freeze if errors are being ignored. The actual code
1192 to ignore occurs later, instead of sending a message. Logging of freezing
1193 occurs later, just before writing the -H file. */
1195 if (!testflag(addr, af_ignore_error) &&
1196 (addr->special_action == SPECIAL_FREEZE ||
1197 (sender_address[0] == 0 && addr->p.errors_address == NULL)
1200 frozen_info = (addr->special_action == SPECIAL_FREEZE)? US"" :
1201 (sender_local && !local_error_message)?
1202 US" (message created with -f <>)" : US" (delivery error message)";
1203 deliver_freeze = TRUE;
1204 deliver_frozen_at = time(NULL);
1205 update_spool = TRUE;
1207 /* The address is put on the defer rather than the failed queue, because
1208 the message is being retained. */
1210 addr->next = addr_defer;
1214 /* Don't put the address on the nonrecipients tree yet; wait until an
1215 error message has been successfully sent. */
1219 addr->next = addr_failed;
1223 /* Build up the log line for the message and main logs */
1225 s = reset_point = store_get(size);
1227 /* Create the address string for logging. Must not do this earlier, because
1228 an OK result may be changed to FAIL when a pipe returns text. */
1230 log_address = string_log_address(addr,
1231 (log_write_selector & L_all_parents) != 0, result == OK);
1233 s = string_cat(s, &size, &ptr, log_address, Ustrlen(log_address));
1235 if ((log_extra_selector & LX_sender_on_delivery) != 0)
1236 s = string_append(s, &size, &ptr, 3, US" F=<", sender_address, US">");
1238 /* Return path may not be set if no delivery actually happened */
1240 if (used_return_path != NULL &&
1241 (log_extra_selector & LX_return_path_on_delivery) != 0)
1243 s = string_append(s, &size, &ptr, 3, US" P=<", used_return_path, US">");
1246 if (addr->router != NULL)
1247 s = string_append(s, &size, &ptr, 2, US" R=", addr->router->name);
1248 if (addr->transport != NULL)
1249 s = string_append(s, &size, &ptr, 2, US" T=", addr->transport->name);
1251 if (addr->host_used != NULL)
1252 s = string_append(s, &size, &ptr, 5, US" H=", addr->host_used->name,
1253 US" [", addr->host_used->address, US"]");
1255 if (addr->basic_errno > 0)
1256 s = string_append(s, &size, &ptr, 2, US": ",
1257 US strerror(addr->basic_errno));
1259 if (addr->message != NULL)
1260 s = string_append(s, &size, &ptr, 2, US": ", addr->message);
1264 /* Do the logging. For the message log, "routing failed" for those cases,
1265 just to make it clearer. */
1267 if (driver_name == NULL)
1268 deliver_msglog("%s %s failed for %s\n", now, driver_kind, s);
1270 deliver_msglog("%s %s\n", now, s);
1272 log_write(0, LOG_MAIN, "** %s", s);
1273 store_reset(reset_point);
1276 /* Ensure logging is turned on again in all cases */
1278 disable_logging = FALSE;
1284 /*************************************************
1285 * Address-independent error *
1286 *************************************************/
1288 /* This function is called when there's an error that is not dependent on a
1289 particular address, such as an expansion string failure. It puts the error into
1290 all the addresses in a batch, logs the incident on the main and panic logs, and
1291 clears the expansions. It is mostly called from local_deliver(), but can be
1292 called for a remote delivery via findugid().
1295 logit TRUE if (MAIN+PANIC) logging required
1296 addr the first of the chain of addresses
1298 format format string for error message, or NULL if already set in addr
1299 ... arguments for the format
1305 common_error(BOOL logit, address_item *addr, int code, uschar *format, ...)
1307 address_item *addr2;
1308 addr->basic_errno = code;
1314 va_start(ap, format);
1315 if (!string_vformat(buffer, sizeof(buffer), CS format, ap))
1316 log_write(0, LOG_MAIN|LOG_PANIC_DIE,
1317 "common_error expansion was longer than " SIZE_T_FMT, sizeof(buffer));
1319 addr->message = string_copy(buffer);
1322 for (addr2 = addr->next; addr2 != NULL; addr2 = addr2->next)
1324 addr2->basic_errno = code;
1325 addr2->message = addr->message;
1328 if (logit) log_write(0, LOG_MAIN|LOG_PANIC, "%s", addr->message);
1329 deliver_set_expansions(NULL);
1335 /*************************************************
1336 * Check a "never users" list *
1337 *************************************************/
1339 /* This function is called to check whether a uid is on one of the two "never
1343 uid the uid to be checked
1344 nusers the list to be scanned; the first item in the list is the count
1346 Returns: TRUE if the uid is on the list
1350 check_never_users(uid_t uid, uid_t *nusers)
1353 if (nusers == NULL) return FALSE;
1354 for (i = 1; i <= (int)(nusers[0]); i++) if (nusers[i] == uid) return TRUE;
1360 /*************************************************
1361 * Find uid and gid for a transport *
1362 *************************************************/
1364 /* This function is called for both local and remote deliveries, to find the
1365 uid/gid under which to run the delivery. The values are taken preferentially
1366 from the transport (either explicit or deliver_as_creator), then from the
1367 address (i.e. the router), and if nothing is set, the exim uid/gid are used. If
1368 the resulting uid is on the "never_users" or the "fixed_never_users" list, a
1369 panic error is logged, and the function fails (which normally leads to delivery
1373 addr the address (possibly a chain)
1375 uidp pointer to uid field
1376 gidp pointer to gid field
1377 igfp pointer to the use_initgroups field
1379 Returns: FALSE if failed - error has been set in address(es)
1383 findugid(address_item *addr, transport_instance *tp, uid_t *uidp, gid_t *gidp,
1386 uschar *nuname = NULL;
1387 BOOL gid_set = FALSE;
1389 /* Default initgroups flag comes from the transport */
1391 *igfp = tp->initgroups;
1393 /* First see if there's a gid on the transport, either fixed or expandable.
1394 The expanding function always logs failure itself. */
1401 else if (tp->expand_gid != NULL)
1403 if (route_find_expanded_group(tp->expand_gid, tp->name, US"transport", gidp,
1404 &(addr->message))) gid_set = TRUE;
1407 common_error(FALSE, addr, ERRNO_GIDFAIL, NULL);
1412 /* If the transport did not set a group, see if the router did. */
1414 if (!gid_set && testflag(addr, af_gid_set))
1420 /* Pick up a uid from the transport if one is set. */
1422 if (tp->uid_set) *uidp = tp->uid;
1424 /* Otherwise, try for an expandable uid field. If it ends up as a numeric id,
1425 it does not provide a passwd value from which a gid can be taken. */
1427 else if (tp->expand_uid != NULL)
1430 if (!route_find_expanded_user(tp->expand_uid, tp->name, US"transport", &pw,
1431 uidp, &(addr->message)))
1433 common_error(FALSE, addr, ERRNO_UIDFAIL, NULL);
1436 if (!gid_set && pw != NULL)
1443 /* If the transport doesn't set the uid, test the deliver_as_creator flag. */
1445 else if (tp->deliver_as_creator)
1447 *uidp = originator_uid;
1450 *gidp = originator_gid;
1455 /* Otherwise see if the address specifies the uid and if so, take it and its
1458 else if (testflag(addr, af_uid_set))
1461 *igfp = testflag(addr, af_initgroups);
1464 /* Nothing has specified the uid - default to the Exim user, and group if the
1477 /* If no gid is set, it is a disaster. We default to the Exim gid only if
1478 defaulting to the Exim uid. In other words, if the configuration has specified
1479 a uid, it must also provide a gid. */
1483 common_error(TRUE, addr, ERRNO_GIDFAIL, US"User set without group for "
1484 "%s transport", tp->name);
1488 /* Check that the uid is not on the lists of banned uids that may not be used
1489 for delivery processes. */
1491 if (check_never_users(*uidp, never_users))
1492 nuname = US"never_users";
1493 else if (check_never_users(*uidp, fixed_never_users))
1494 nuname = US"fixed_never_users";
1498 common_error(TRUE, addr, ERRNO_UIDFAIL, US"User %ld set for %s transport "
1499 "is on the %s list", (long int)(*uidp), tp->name, nuname);
1511 /*************************************************
1512 * Check the size of a message for a transport *
1513 *************************************************/
1515 /* Checks that the message isn't too big for the selected transport.
1516 This is called only when it is known that the limit is set.
1520 addr the (first) address being delivered
1523 DEFER expansion failed or did not yield an integer
1524 FAIL message too big
1528 check_message_size(transport_instance *tp, address_item *addr)
1533 deliver_set_expansions(addr);
1534 size_limit = expand_string_integer(tp->message_size_limit, TRUE);
1535 deliver_set_expansions(NULL);
1537 if (expand_string_message != NULL)
1540 if (size_limit == -1)
1541 addr->message = string_sprintf("failed to expand message_size_limit "
1542 "in %s transport: %s", tp->name, expand_string_message);
1544 addr->message = string_sprintf("invalid message_size_limit "
1545 "in %s transport: %s", tp->name, expand_string_message);
1547 else if (size_limit > 0 && message_size > size_limit)
1551 string_sprintf("message is too big (transport limit = %d)",
1560 /*************************************************
1561 * Transport-time check for a previous delivery *
1562 *************************************************/
1564 /* Check that this base address hasn't previously been delivered to its routed
1565 transport. If it has been delivered, mark it done. The check is necessary at
1566 delivery time in order to handle homonymic addresses correctly in cases where
1567 the pattern of redirection changes between delivery attempts (so the unique
1568 fields change). Non-homonymic previous delivery is detected earlier, at routing
1569 time (which saves unnecessary routing).
1572 addr the address item
1573 testing TRUE if testing wanted only, without side effects
1575 Returns: TRUE if previously delivered by the transport
1579 previously_transported(address_item *addr, BOOL testing)
1581 (void)string_format(big_buffer, big_buffer_size, "%s/%s",
1582 addr->unique + (testflag(addr, af_homonym)? 3:0), addr->transport->name);
1584 if (tree_search(tree_nonrecipients, big_buffer) != 0)
1586 DEBUG(D_deliver|D_route|D_transport)
1587 debug_printf("%s was previously delivered (%s transport): discarded\n",
1588 addr->address, addr->transport->name);
1589 if (!testing) child_done(addr, tod_stamp(tod_log));
1598 /******************************************************
1599 * Check for a given header in a header string *
1600 ******************************************************/
1602 /* This function is used when generating quota warnings. The configuration may
1603 specify any header lines it likes in quota_warn_message. If certain of them are
1604 missing, defaults are inserted, so we need to be able to test for the presence
1608 hdr the required header name
1609 hstring the header string
1611 Returns: TRUE the header is in the string
1612 FALSE the header is not in the string
1616 contains_header(uschar *hdr, uschar *hstring)
1618 int len = Ustrlen(hdr);
1619 uschar *p = hstring;
1622 if (strncmpic(p, hdr, len) == 0)
1625 while (*p == ' ' || *p == '\t') p++;
1626 if (*p == ':') return TRUE;
1628 while (*p != 0 && *p != '\n') p++;
1629 if (*p == '\n') p++;
1637 /*************************************************
1638 * Perform a local delivery *
1639 *************************************************/
1641 /* Each local delivery is performed in a separate process which sets its
1642 uid and gid as specified. This is a safer way than simply changing and
1643 restoring using seteuid(); there is a body of opinion that seteuid() cannot be
1644 used safely. From release 4, Exim no longer makes any use of it. Besides, not
1645 all systems have seteuid().
1647 If the uid/gid are specified in the transport_instance, they are used; the
1648 transport initialization must ensure that either both or neither are set.
1649 Otherwise, the values associated with the address are used. If neither are set,
1650 it is a configuration error.
1652 The transport or the address may specify a home directory (transport over-
1653 rides), and if they do, this is set as $home. If neither have set a working
1654 directory, this value is used for that as well. Otherwise $home is left unset
1655 and the cwd is set to "/" - a directory that should be accessible to all users.
1657 Using a separate process makes it more complicated to get error information
1658 back. We use a pipe to pass the return code and also an error code and error
1659 text string back to the parent process.
1662 addr points to an address block for this delivery; for "normal" local
1663 deliveries this is the only address to be delivered, but for
1664 pseudo-remote deliveries (e.g. by batch SMTP to a file or pipe)
1665 a number of addresses can be handled simultaneously, and in this
1666 case addr will point to a chain of addresses with the same
1669 shadowing TRUE if running a shadow transport; this causes output from pipes
1676 deliver_local(address_item *addr, BOOL shadowing)
1678 BOOL use_initgroups;
1681 int status, len, rc;
1684 uschar *working_directory;
1685 address_item *addr2;
1686 transport_instance *tp = addr->transport;
1688 /* Set up the return path from the errors or sender address. If the transport
1689 has its own return path setting, expand it and replace the existing value. */
1691 if(addr->p.errors_address != NULL)
1692 return_path = addr->p.errors_address;
1693 #ifdef EXPERIMENTAL_SRS
1694 else if(addr->p.srs_sender != NULL)
1695 return_path = addr->p.srs_sender;
1698 return_path = sender_address;
1700 if (tp->return_path != NULL)
1702 uschar *new_return_path = expand_string(tp->return_path);
1703 if (new_return_path == NULL)
1705 if (!expand_string_forcedfail)
1707 common_error(TRUE, addr, ERRNO_EXPANDFAIL,
1708 US"Failed to expand return path \"%s\" in %s transport: %s",
1709 tp->return_path, tp->name, expand_string_message);
1713 else return_path = new_return_path;
1716 /* For local deliveries, one at a time, the value used for logging can just be
1717 set directly, once and for all. */
1719 used_return_path = return_path;
1721 /* Sort out the uid, gid, and initgroups flag. If an error occurs, the message
1722 gets put into the address(es), and the expansions are unset, so we can just
1725 if (!findugid(addr, tp, &uid, &gid, &use_initgroups)) return;
1727 /* See if either the transport or the address specifies a home directory. A
1728 home directory set in the address may already be expanded; a flag is set to
1729 indicate that. In other cases we must expand it. */
1731 if ((deliver_home = tp->home_dir) != NULL || /* Set in transport, or */
1732 ((deliver_home = addr->home_dir) != NULL && /* Set in address and */
1733 !testflag(addr, af_home_expanded))) /* not expanded */
1735 uschar *rawhome = deliver_home;
1736 deliver_home = NULL; /* in case it contains $home */
1737 deliver_home = expand_string(rawhome);
1738 if (deliver_home == NULL)
1740 common_error(TRUE, addr, ERRNO_EXPANDFAIL, US"home directory \"%s\" failed "
1741 "to expand for %s transport: %s", rawhome, tp->name,
1742 expand_string_message);
1745 if (*deliver_home != '/')
1747 common_error(TRUE, addr, ERRNO_NOTABSOLUTE, US"home directory path \"%s\" "
1748 "is not absolute for %s transport", deliver_home, tp->name);
1753 /* See if either the transport or the address specifies a current directory,
1754 and if so, expand it. If nothing is set, use the home directory, unless it is
1755 also unset in which case use "/", which is assumed to be a directory to which
1756 all users have access. It is necessary to be in a visible directory for some
1757 operating systems when running pipes, as some commands (e.g. "rm" under Solaris
1758 2.5) require this. */
1760 working_directory = (tp->current_dir != NULL)?
1761 tp->current_dir : addr->current_dir;
1763 if (working_directory != NULL)
1765 uschar *raw = working_directory;
1766 working_directory = expand_string(raw);
1767 if (working_directory == NULL)
1769 common_error(TRUE, addr, ERRNO_EXPANDFAIL, US"current directory \"%s\" "
1770 "failed to expand for %s transport: %s", raw, tp->name,
1771 expand_string_message);
1774 if (*working_directory != '/')
1776 common_error(TRUE, addr, ERRNO_NOTABSOLUTE, US"current directory path "
1777 "\"%s\" is not absolute for %s transport", working_directory, tp->name);
1781 else working_directory = (deliver_home == NULL)? US"/" : deliver_home;
1783 /* If one of the return_output flags is set on the transport, create and open a
1784 file in the message log directory for the transport to write its output onto.
1785 This is mainly used by pipe transports. The file needs to be unique to the
1786 address. This feature is not available for shadow transports. */
1788 if (!shadowing && (tp->return_output || tp->return_fail_output ||
1789 tp->log_output || tp->log_fail_output))
1792 addr->return_filename =
1793 string_sprintf("%s/msglog/%s/%s-%d-%d", spool_directory, message_subdir,
1794 message_id, getpid(), return_count++);
1795 addr->return_file = open_msglog_file(addr->return_filename, 0400, &error);
1796 if (addr->return_file < 0)
1798 common_error(TRUE, addr, errno, US"Unable to %s file for %s transport "
1799 "to return message: %s", error, tp->name, strerror(errno));
1804 /* Create the pipe for inter-process communication. */
1808 common_error(TRUE, addr, ERRNO_PIPEFAIL, US"Creation of pipe failed: %s",
1813 /* Now fork the process to do the real work in the subprocess, but first
1814 ensure that all cached resources are freed so that the subprocess starts with
1815 a clean slate and doesn't interfere with the parent process. */
1819 if ((pid = fork()) == 0)
1821 BOOL replicate = TRUE;
1823 /* Prevent core dumps, as we don't want them in users' home directories.
1824 HP-UX doesn't have RLIMIT_CORE; I don't know how to do this in that
1825 system. Some experimental/developing systems (e.g. GNU/Hurd) may define
1826 RLIMIT_CORE but not support it in setrlimit(). For such systems, do not
1827 complain if the error is "not supported".
1829 There are two scenarios where changing the max limit has an effect. In one,
1830 the user is using a .forward and invoking a command of their choice via pipe;
1831 for these, we do need the max limit to be 0 unless the admin chooses to
1832 permit an increased limit. In the other, the command is invoked directly by
1833 the transport and is under administrator control, thus being able to raise
1834 the limit aids in debugging. So there's no general always-right answer.
1836 Thus we inhibit core-dumps completely but let individual transports, while
1837 still root, re-raise the limits back up to aid debugging. We make the
1838 default be no core-dumps -- few enough people can use core dumps in
1839 diagnosis that it's reasonable to make them something that has to be explicitly requested.
1846 if (setrlimit(RLIMIT_CORE, &rl) < 0)
1848 #ifdef SETRLIMIT_NOT_SUPPORTED
1849 if (errno != ENOSYS && errno != ENOTSUP)
1851 log_write(0, LOG_MAIN|LOG_PANIC, "setrlimit(RLIMIT_CORE) failed: %s",
1856 /* Reset the random number generator, so different processes don't all
1857 have the same sequence. */
1861 /* If the transport has a setup entry, call this first, while still
1862 privileged. (Appendfile uses this to expand quota, for example, while
1863 able to read private files.) */
1865 if (addr->transport->setup != NULL)
1867 switch((addr->transport->setup)(addr->transport, addr, NULL, uid, gid,
1871 addr->transport_return = DEFER;
1875 addr->transport_return = PANIC;
1880 /* Ignore SIGINT and SIGTERM during delivery. Also ignore SIGUSR1, as
1881 when the process becomes unprivileged, it won't be able to write to the
1882 process log. SIGHUP is ignored throughout exim, except when it is being
1885 signal(SIGINT, SIG_IGN);
1886 signal(SIGTERM, SIG_IGN);
1887 signal(SIGUSR1, SIG_IGN);
1889 /* Close the unwanted half of the pipe, and set close-on-exec for the other
1890 half - for transports that exec things (e.g. pipe). Then set the required
1893 (void)close(pfd[pipe_read]);
1894 (void)fcntl(pfd[pipe_write], F_SETFD, fcntl(pfd[pipe_write], F_GETFD) |
1896 exim_setugid(uid, gid, use_initgroups,
1897 string_sprintf("local delivery to %s <%s> transport=%s", addr->local_part,
1898 addr->address, addr->transport->name));
1902 address_item *batched;
1903 debug_printf(" home=%s current=%s\n", deliver_home, working_directory);
1904 for (batched = addr->next; batched != NULL; batched = batched->next)
1905 debug_printf("additional batched address: %s\n", batched->address);
1908 /* Set an appropriate working directory. */
1910 if (Uchdir(working_directory) < 0)
1912 addr->transport_return = DEFER;
1913 addr->basic_errno = errno;
1914 addr->message = string_sprintf("failed to chdir to %s", working_directory);
1917 /* If successful, call the transport */
1922 set_process_info("delivering %s to %s using %s", message_id,
1923 addr->local_part, addr->transport->name);
1925 /* Setting this global in the subprocess means we need never clear it */
1926 transport_name = addr->transport->name;
1928 /* If a transport filter has been specified, set up its argument list.
1929 Any errors will get put into the address, and FALSE yielded. */
1931 if (addr->transport->filter_command != NULL)
1933 ok = transport_set_up_command(&transport_filter_argv,
1934 addr->transport->filter_command,
1935 TRUE, PANIC, addr, US"transport filter", NULL);
1936 transport_filter_timeout = addr->transport->filter_timeout;
1938 else transport_filter_argv = NULL;
1942 debug_print_string(addr->transport->debug_string);
1943 replicate = !(addr->transport->info->code)(addr->transport, addr);
1947 /* Pass the results back down the pipe. If necessary, first replicate the
1948 status in the top address to the others in the batch. The label is the
1949 subject of a goto when a call to the transport's setup function fails. We
1950 pass the pointer to the transport back in case it got changed as a result of
1951 file_format in appendfile. */
1955 if (replicate) replicate_status(addr);
1956 for (addr2 = addr; addr2 != NULL; addr2 = addr2->next)
1959 int local_part_length = Ustrlen(addr2->local_part);
1963 if( (ret = write(pfd[pipe_write], (void *)&(addr2->transport_return), sizeof(int))) != sizeof(int)
1964 || (ret = write(pfd[pipe_write], (void *)&transport_count, sizeof(transport_count))) != sizeof(transport_count)
1965 || (ret = write(pfd[pipe_write], (void *)&(addr2->flags), sizeof(addr2->flags))) != sizeof(addr2->flags)
1966 || (ret = write(pfd[pipe_write], (void *)&(addr2->basic_errno), sizeof(int))) != sizeof(int)
1967 || (ret = write(pfd[pipe_write], (void *)&(addr2->more_errno), sizeof(int))) != sizeof(int)
1968 || (ret = write(pfd[pipe_write], (void *)&(addr2->special_action), sizeof(int))) != sizeof(int)
1969 || (ret = write(pfd[pipe_write], (void *)&(addr2->transport),
1970 sizeof(transport_instance *))) != sizeof(transport_instance *)
1972 /* For a file delivery, pass back the local part, in case the original
1973 was only part of the final delivery path. This gives more complete
1976 || (testflag(addr2, af_file)
1977 && ( (ret = write(pfd[pipe_write], (void *)&local_part_length, sizeof(int))) != sizeof(int)
1978 || (ret = write(pfd[pipe_write], addr2->local_part, local_part_length)) != local_part_length
1982 log_write(0, LOG_MAIN|LOG_PANIC, "Failed writing transport results to pipe: %s\n",
1983 ret == -1 ? strerror(errno) : "short write");
1985 /* Now any messages */
1987 for (i = 0, s = addr2->message; i < 2; i++, s = addr2->user_message)
1989 int message_length = (s == NULL)? 0 : Ustrlen(s) + 1;
1990 if( (ret = write(pfd[pipe_write], (void *)&message_length, sizeof(int))) != sizeof(int)
1991 || (message_length > 0 && (ret = write(pfd[pipe_write], s, message_length)) != message_length)
1993 log_write(0, LOG_MAIN|LOG_PANIC, "Failed writing transport results to pipe: %s\n",
1994 ret == -1 ? strerror(errno) : "short write");
1998 /* OK, this process is now done. Free any cached resources that it opened,
1999 and close the pipe we were writing down before exiting. */
2001 (void)close(pfd[pipe_write]);
2006 /* Back in the main process: panic if the fork did not succeed. This seems
2007 better than returning an error - if forking is failing it is probably best
2008 not to try other deliveries for this message. */
2011 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Fork failed for local delivery to %s",
2014 /* Read the pipe to get the delivery status codes and error messages. Our copy
2015 of the writing end must be closed first, as otherwise read() won't return zero
2016 on an empty pipe. We check that a status exists for each address before
2017 overwriting the address structure. If data is missing, the default DEFER status
2018 will remain. Afterwards, close the reading end. */
2020 (void)close(pfd[pipe_write]);
2022 for (addr2 = addr; addr2 != NULL; addr2 = addr2->next)
2024 len = read(pfd[pipe_read], (void *)&status, sizeof(int));
2030 addr2->transport_return = status;
2031 len = read(pfd[pipe_read], (void *)&transport_count,
2032 sizeof(transport_count));
2033 len = read(pfd[pipe_read], (void *)&(addr2->flags), sizeof(addr2->flags));
2034 len = read(pfd[pipe_read], (void *)&(addr2->basic_errno), sizeof(int));
2035 len = read(pfd[pipe_read], (void *)&(addr2->more_errno), sizeof(int));
2036 len = read(pfd[pipe_read], (void *)&(addr2->special_action), sizeof(int));
2037 len = read(pfd[pipe_read], (void *)&(addr2->transport),
2038 sizeof(transport_instance *));
2040 if (testflag(addr2, af_file))
2042 int local_part_length;
2043 len = read(pfd[pipe_read], (void *)&local_part_length, sizeof(int));
2044 len = read(pfd[pipe_read], (void *)big_buffer, local_part_length);
2045 big_buffer[local_part_length] = 0;
2046 addr2->local_part = string_copy(big_buffer);
2049 for (i = 0, sptr = &(addr2->message); i < 2;
2050 i++, sptr = &(addr2->user_message))
2053 len = read(pfd[pipe_read], (void *)&message_length, sizeof(int));
2054 if (message_length > 0)
2056 len = read(pfd[pipe_read], (void *)big_buffer, message_length);
2057 if (len > 0) *sptr = string_copy(big_buffer);
2064 log_write(0, LOG_MAIN|LOG_PANIC, "failed to read delivery status for %s "
2065 "from delivery subprocess", addr2->unique);
2070 (void)close(pfd[pipe_read]);
2072 /* Unless shadowing, write all successful addresses immediately to the journal
2073 file, to ensure they are recorded asap. For homonymic addresses, use the base
2074 address plus the transport name. Failure to write the journal is panic-worthy,
2075 but don't stop, as it may prove possible subsequently to update the spool file
2076 in order to record the delivery. */
2080 for (addr2 = addr; addr2 != NULL; addr2 = addr2->next)
2082 if (addr2->transport_return != OK) continue;
2084 if (testflag(addr2, af_homonym))
2085 sprintf(CS big_buffer, "%.500s/%s\n", addr2->unique + 3, tp->name);
2087 sprintf(CS big_buffer, "%.500s\n", addr2->unique);
2089 /* In the test harness, wait just a bit to let the subprocess finish off
2090 any debug output etc first. */
2092 if (running_in_test_harness) millisleep(300);
2094 DEBUG(D_deliver) debug_printf("journalling %s", big_buffer);
2095 len = Ustrlen(big_buffer);
2096 if (write(journal_fd, big_buffer, len) != len)
2097 log_write(0, LOG_MAIN|LOG_PANIC, "failed to update journal for %s: %s",
2098 big_buffer, strerror(errno));
2101 /* Ensure the journal file is pushed out to disk. */
2103 if (EXIMfsync(journal_fd) < 0)
2104 log_write(0, LOG_MAIN|LOG_PANIC, "failed to fsync journal: %s",
2108 /* Wait for the process to finish. If it terminates with a non-zero code,
2109 freeze the message (except for SIGTERM, SIGKILL and SIGQUIT), but leave the
2110 status values of all the addresses as they are. Take care to handle the case
2111 when the subprocess doesn't seem to exist. This has been seen on one system
2112 when Exim was called from an MUA that set SIGCHLD to SIG_IGN. When that
2113 happens, wait() doesn't recognize the termination of child processes. Exim now
2114 resets SIGCHLD to SIG_DFL, but this code should still be robust. */
2116 while ((rc = wait(&status)) != pid)
2118 if (rc < 0 && errno == ECHILD) /* Process has vanished */
2120 log_write(0, LOG_MAIN, "%s transport process vanished unexpectedly",
2121 addr->transport->driver_name);
2127 if ((status & 0xffff) != 0)
2129 int msb = (status >> 8) & 255;
2130 int lsb = status & 255;
2131 int code = (msb == 0)? (lsb & 0x7f) : msb;
2132 if (msb != 0 || (code != SIGTERM && code != SIGKILL && code != SIGQUIT))
2133 addr->special_action = SPECIAL_FREEZE;
2134 log_write(0, LOG_MAIN|LOG_PANIC, "%s transport process returned non-zero "
2135 "status 0x%04x: %s %d",
2136 addr->transport->driver_name,
2138 (msb == 0)? "terminated by signal" : "exit code",
2142 /* If SPECIAL_WARN is set in the top address, send a warning message. */
2144 if (addr->special_action == SPECIAL_WARN &&
2145 addr->transport->warn_message != NULL)
2148 uschar *warn_message;
2150 DEBUG(D_deliver) debug_printf("Warning message requested by transport\n");
2152 warn_message = expand_string(addr->transport->warn_message);
2153 if (warn_message == NULL)
2154 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand \"%s\" (warning "
2155 "message for %s transport): %s", addr->transport->warn_message,
2156 addr->transport->name, expand_string_message);
2159 pid_t pid = child_open_exim(&fd);
2162 FILE *f = fdopen(fd, "wb");
2163 if (errors_reply_to != NULL &&
2164 !contains_header(US"Reply-To", warn_message))
2165 fprintf(f, "Reply-To: %s\n", errors_reply_to);
2166 fprintf(f, "Auto-Submitted: auto-replied\n");
2167 if (!contains_header(US"From", warn_message)) moan_write_from(f);
2168 fprintf(f, "%s", CS warn_message);
2170 /* Close and wait for child process to complete, without a timeout. */
2173 (void)child_close(pid, 0);
2177 addr->special_action = SPECIAL_NONE;
2183 /*************************************************
2184 * Do local deliveries *
2185 *************************************************/
2187 /* This function processes the list of addresses in addr_local. True local
2188 deliveries are always done one address at a time. However, local deliveries can
2189 be batched up in some cases. Typically this is when writing batched SMTP output
2190 files for use by some external transport mechanism, or when running local
2191 deliveries over LMTP.
2198 do_local_deliveries(void)
2201 open_db *dbm_file = NULL;
2202 time_t now = time(NULL);
2204 /* Loop until we have exhausted the supply of local deliveries */
2206 while (addr_local != NULL)
2208 time_t delivery_start;
2210 address_item *addr2, *addr3, *nextaddr;
2211 int logflags = LOG_MAIN;
2212 int logchar = dont_deliver? '*' : '=';
2213 transport_instance *tp;
2215 /* Pick the first undelivered address off the chain */
2217 address_item *addr = addr_local;
2218 addr_local = addr->next;
2221 DEBUG(D_deliver|D_transport)
2222 debug_printf("--------> %s <--------\n", addr->address);
2224 /* An internal disaster if there is no transport. Should not occur! */
2226 if ((tp = addr->transport) == NULL)
2228 logflags |= LOG_PANIC;
2229 disable_logging = FALSE; /* Jic */
2231 (addr->router != NULL)?
2232 string_sprintf("No transport set by %s router", addr->router->name)
2234 string_sprintf("No transport set by system filter");
2235 post_process_one(addr, DEFER, logflags, DTYPE_TRANSPORT, 0);
2239 /* Check that this base address hasn't previously been delivered to this
2240 transport. The check is necessary at this point to handle homonymic addresses
2241 correctly in cases where the pattern of redirection changes between delivery
2242 attempts. Non-homonymic previous delivery is detected earlier, at routing
2245 if (previously_transported(addr, FALSE)) continue;
2247 /* There are weird cases where logging is disabled */
2249 disable_logging = tp->disable_logging;
2251 /* Check for batched addresses and possible amalgamation. Skip all the work
2252 if either batch_max <= 1 or there aren't any other addresses for local
2255 if (tp->batch_max > 1 && addr_local != NULL)
2257 int batch_count = 1;
2258 BOOL uses_dom = readconf_depends((driver_instance *)tp, US"domain");
2259 BOOL uses_lp = (testflag(addr, af_pfr) &&
2260 (testflag(addr, af_file) || addr->local_part[0] == '|')) ||
2261 readconf_depends((driver_instance *)tp, US"local_part");
2262 uschar *batch_id = NULL;
2263 address_item **anchor = &addr_local;
2264 address_item *last = addr;
2267 /* Expand the batch_id string for comparison with other addresses.
2268 Expansion failure suppresses batching. */
2270 if (tp->batch_id != NULL)
2272 deliver_set_expansions(addr);
2273 batch_id = expand_string(tp->batch_id);
2274 deliver_set_expansions(NULL);
2275 if (batch_id == NULL)
2277 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand batch_id option "
2278 "in %s transport (%s): %s", tp->name, addr->address,
2279 expand_string_message);
2280 batch_count = tp->batch_max;
2284 /* Until we reach the batch_max limit, pick off addresses which have the
2285 same characteristics. These are:
2288 not previously delivered (see comment about 50 lines above)
2289 same local part if the transport's configuration contains $local_part
2290 or if this is a file or pipe delivery from a redirection
2291 same domain if the transport's configuration contains $domain
2293 same additional headers
2294 same headers to be removed
2295 same uid/gid for running the transport
2296 same first host if a host list is set
2299 while ((next = *anchor) != NULL && batch_count < tp->batch_max)
2302 tp == next->transport &&
2303 !previously_transported(next, TRUE) &&
2304 (addr->flags & (af_pfr|af_file)) == (next->flags & (af_pfr|af_file)) &&
2305 (!uses_lp || Ustrcmp(next->local_part, addr->local_part) == 0) &&
2306 (!uses_dom || Ustrcmp(next->domain, addr->domain) == 0) &&
2307 same_strings(next->p.errors_address, addr->p.errors_address) &&
2308 same_headers(next->p.extra_headers, addr->p.extra_headers) &&
2309 same_strings(next->p.remove_headers, addr->p.remove_headers) &&
2310 same_ugid(tp, addr, next) &&
2311 ((addr->host_list == NULL && next->host_list == NULL) ||
2312 (addr->host_list != NULL && next->host_list != NULL &&
2313 Ustrcmp(addr->host_list->name, next->host_list->name) == 0));
2315 /* If the transport has a batch_id setting, batch_id will be non-NULL
2316 from the expansion outside the loop. Expand for this address and compare.
2317 Expansion failure makes this address ineligible for batching. */
2319 if (ok && batch_id != NULL)
2322 address_item *save_nextnext = next->next;
2323 next->next = NULL; /* Expansion for a single address */
2324 deliver_set_expansions(next);
2325 next->next = save_nextnext;
2326 bid = expand_string(tp->batch_id);
2327 deliver_set_expansions(NULL);
2330 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand batch_id option "
2331 "in %s transport (%s): %s", tp->name, next->address,
2332 expand_string_message);
2335 else ok = (Ustrcmp(batch_id, bid) == 0);
2338 /* Take address into batch if OK. */
2342 *anchor = next->next; /* Include the address */
2348 else anchor = &(next->next); /* Skip the address */
2352 /* We now have one or more addresses that can be delivered in a batch. Check
2353 whether the transport is prepared to accept a message of this size. If not,
2354 fail them all forthwith. If the expansion fails, or does not yield an
2355 integer, defer delivery. */
2357 if (tp->message_size_limit != NULL)
2359 int rc = check_message_size(tp, addr);
2362 replicate_status(addr);
2363 while (addr != NULL)
2366 post_process_one(addr, rc, logflags, DTYPE_TRANSPORT, 0);
2369 continue; /* With next batch of addresses */
2373 /* If we are not running the queue, or if forcing, all deliveries will be
2374 attempted. Otherwise, we must respect the retry times for each address. Even
2375 when not doing this, we need to set up the retry key string, and determine
2376 whether a retry record exists, because after a successful delivery, a delete
2377 retry item must be set up. Keep the retry database open only for the duration
2378 of these checks, rather than for all local deliveries, because some local
2379 deliveries (e.g. to pipes) can take a substantial time. */
2381 dbm_file = dbfn_open(US"retry", O_RDONLY, &dbblock, FALSE);
2382 if (dbm_file == NULL)
2384 DEBUG(D_deliver|D_retry|D_hints_lookup)
2385 debug_printf("no retry data available\n");
2390 while (addr2 != NULL)
2392 BOOL ok = TRUE; /* to deliver this address */
2395 /* Set up the retry key to include the domain or not, and change its
2396 leading character from "R" to "T". Must make a copy before doing this,
2397 because the old key may be pointed to from a "delete" retry item after
2400 retry_key = string_copy(
2401 (tp->retry_use_local_part)? addr2->address_retry_key :
2402 addr2->domain_retry_key);
2405 /* Inspect the retry data. If there is no hints file, delivery happens. */
2407 if (dbm_file != NULL)
2409 dbdata_retry *retry_record = dbfn_read(dbm_file, retry_key);
2411 /* If there is no retry record, delivery happens. If there is,
2412 remember it exists so it can be deleted after a successful delivery. */
2414 if (retry_record != NULL)
2416 setflag(addr2, af_lt_retry_exists);
2418 /* A retry record exists for this address. If queue running and not
2419 forcing, inspect its contents. If the record is too old, or if its
2420 retry time has come, or if it has passed its cutoff time, delivery
2425 debug_printf("retry record exists: age=%s ",
2426 readconf_printtime(now - retry_record->time_stamp));
2427 debug_printf("(max %s)\n", readconf_printtime(retry_data_expire));
2428 debug_printf(" time to retry = %s expired = %d\n",
2429 readconf_printtime(retry_record->next_try - now),
2430 retry_record->expired);
2433 if (queue_running && !deliver_force)
2435 ok = (now - retry_record->time_stamp > retry_data_expire) ||
2436 (now >= retry_record->next_try) ||
2437 retry_record->expired;
2439 /* If we haven't reached the retry time, there is one more check
2440 to do, which is for the ultimate address timeout. */
2443 ok = retry_ultimate_address_timeout(retry_key, addr2->domain,
2447 else DEBUG(D_retry) debug_printf("no retry record exists\n");
2450 /* This address is to be delivered. Leave it on the chain. */
2455 addr2 = addr2->next;
2458 /* This address is to be deferred. Take it out of the chain, and
2459 post-process it as complete. Must take it out of the chain first,
2460 because post processing puts it on another chain. */
2464 address_item *this = addr2;
2465 this->message = US"Retry time not yet reached";
2466 this->basic_errno = ERRNO_LRETRY;
2467 if (addr3 == NULL) addr2 = addr = addr2->next;
2468 else addr2 = addr3->next = addr2->next;
2469 post_process_one(this, DEFER, logflags, DTYPE_TRANSPORT, 0);
2473 if (dbm_file != NULL) dbfn_close(dbm_file);
2475 /* If there are no addresses left on the chain, they all deferred. Loop
2476 for the next set of addresses. */
2478 if (addr == NULL) continue;
2480 /* So, finally, we do have some addresses that can be passed to the
2481 transport. Before doing so, set up variables that are relevant to a
2484 deliver_set_expansions(addr);
2485 delivery_start = time(NULL);
2486 deliver_local(addr, FALSE);
2487 deliver_time = (int)(time(NULL) - delivery_start);
2489 /* If a shadow transport (which must perforce be another local transport), is
2490 defined, and its condition is met, we must pass the message to the shadow
2491 too, but only those addresses that succeeded. We do this by making a new
2492 chain of addresses - also to keep the original chain uncontaminated. We must
2493 use a chain rather than doing it one by one, because the shadow transport may
2496 NOTE: if the condition fails because of a lookup defer, there is nothing we
2499 if (tp->shadow != NULL &&
2500 (tp->shadow_condition == NULL ||
2501 expand_check_condition(tp->shadow_condition, tp->name, US"transport")))
2503 transport_instance *stp;
2504 address_item *shadow_addr = NULL;
2505 address_item **last = &shadow_addr;
2507 for (stp = transports; stp != NULL; stp = stp->next)
2508 if (Ustrcmp(stp->name, tp->shadow) == 0) break;
2511 log_write(0, LOG_MAIN|LOG_PANIC, "shadow transport \"%s\" not found ",
2514 /* Pick off the addresses that have succeeded, and make clones. Put into
2515 the shadow_message field a pointer to the shadow_message field of the real
2518 else for (addr2 = addr; addr2 != NULL; addr2 = addr2->next)
2520 if (addr2->transport_return != OK) continue;
2521 addr3 = store_get(sizeof(address_item));
2524 addr3->shadow_message = (uschar *)(&(addr2->shadow_message));
2525 addr3->transport = stp;
2526 addr3->transport_return = DEFER;
2527 addr3->return_filename = NULL;
2528 addr3->return_file = -1;
2530 last = &(addr3->next);
2533 /* If we found any addresses to shadow, run the delivery, and stick any
2534 message back into the shadow_message field in the original. */
2536 if (shadow_addr != NULL)
2538 int save_count = transport_count;
2540 DEBUG(D_deliver|D_transport)
2541 debug_printf(">>>>>>>>>>>>>>>> Shadow delivery >>>>>>>>>>>>>>>>\n");
2542 deliver_local(shadow_addr, TRUE);
2544 for(; shadow_addr != NULL; shadow_addr = shadow_addr->next)
2546 int sresult = shadow_addr->transport_return;
2547 *((uschar **)(shadow_addr->shadow_message)) = (sresult == OK)?
2548 string_sprintf(" ST=%s", stp->name) :
2549 string_sprintf(" ST=%s (%s%s%s)", stp->name,
2550 (shadow_addr->basic_errno <= 0)?
2551 US"" : US strerror(shadow_addr->basic_errno),
2552 (shadow_addr->basic_errno <= 0 || shadow_addr->message == NULL)?
2554 (shadow_addr->message != NULL)? shadow_addr->message :
2555 (shadow_addr->basic_errno <= 0)? US"unknown error" : US"");
2557 DEBUG(D_deliver|D_transport)
2558 debug_printf("%s shadow transport returned %s for %s\n",
2560 (sresult == OK)? "OK" :
2561 (sresult == DEFER)? "DEFER" :
2562 (sresult == FAIL)? "FAIL" :
2563 (sresult == PANIC)? "PANIC" : "?",
2564 shadow_addr->address);
2567 DEBUG(D_deliver|D_transport)
2568 debug_printf(">>>>>>>>>>>>>>>> End shadow delivery >>>>>>>>>>>>>>>>\n");
2570 transport_count = save_count; /* Restore original transport count */
2574 /* Cancel the expansions that were set up for the delivery. */
2576 deliver_set_expansions(NULL);
2578 /* Now we can process the results of the real transport. We must take each
2579 address off the chain first, because post_process_one() puts it on another
2582 for (addr2 = addr; addr2 != NULL; addr2 = nextaddr)
2584 int result = addr2->transport_return;
2585 nextaddr = addr2->next;
2587 DEBUG(D_deliver|D_transport)
2588 debug_printf("%s transport returned %s for %s\n",
2590 (result == OK)? "OK" :
2591 (result == DEFER)? "DEFER" :
2592 (result == FAIL)? "FAIL" :
2593 (result == PANIC)? "PANIC" : "?",
2596 /* If there is a retry_record, or if delivery is deferred, build a retry
2597 item for setting a new retry time or deleting the old retry record from
2598 the database. These items are handled all together after all addresses
2599 have been handled (so the database is open just for a short time for
2602 if (result == DEFER || testflag(addr2, af_lt_retry_exists))
2604 int flags = (result == DEFER)? 0 : rf_delete;
2605 uschar *retry_key = string_copy((tp->retry_use_local_part)?
2606 addr2->address_retry_key : addr2->domain_retry_key);
2608 retry_add_item(addr2, retry_key, flags);
2611 /* Done with this address */
2613 if (result == OK) addr2->more_errno = deliver_time;
2614 post_process_one(addr2, result, logflags, DTYPE_TRANSPORT, logchar);
2616 /* If a pipe delivery generated text to be sent back, the result may be
2617 changed to FAIL, and we must copy this for subsequent addresses in the
2620 if (addr2->transport_return != result)
2622 for (addr3 = nextaddr; addr3 != NULL; addr3 = addr3->next)
2624 addr3->transport_return = addr2->transport_return;
2625 addr3->basic_errno = addr2->basic_errno;
2626 addr3->message = addr2->message;
2628 result = addr2->transport_return;
2631 /* Whether or not the result was changed to FAIL, we need to copy the
2632 return_file value from the first address into all the addresses of the
2633 batch, so they are all listed in the error message. */
2635 addr2->return_file = addr->return_file;
2637 /* Change log character for recording successful deliveries. */
2639 if (result == OK) logchar = '-';
2641 } /* Loop back for next batch of addresses */
2647 /*************************************************
2648 * Sort remote deliveries *
2649 *************************************************/
2651 /* This function is called if remote_sort_domains is set. It arranges that the
2652 chain of addresses for remote deliveries is ordered according to the strings
2653 specified. Try to make this shuffling reasonably efficient by handling
2654 sequences of addresses rather than just single ones.
2661 sort_remote_deliveries(void)
2664 address_item **aptr = &addr_remote;
2665 uschar *listptr = remote_sort_domains;
2669 while (*aptr != NULL &&
2670 (pattern = string_nextinlist(&listptr, &sep, patbuf, sizeof(patbuf)))
2673 address_item *moved = NULL;
2674 address_item **bptr = &moved;
2676 while (*aptr != NULL)
2678 address_item **next;
2679 deliver_domain = (*aptr)->domain; /* set $domain */
2680 if (match_isinlist(deliver_domain, &pattern, UCHAR_MAX+1,
2681 &domainlist_anchor, NULL, MCL_DOMAIN, TRUE, NULL) == OK)
2683 aptr = &((*aptr)->next);
2687 next = &((*aptr)->next);
2688 while (*next != NULL &&
2689 (deliver_domain = (*next)->domain, /* Set $domain */
2690 match_isinlist(deliver_domain, &pattern, UCHAR_MAX+1,
2691 &domainlist_anchor, NULL, MCL_DOMAIN, TRUE, NULL)) != OK)
2692 next = &((*next)->next);
2694 /* If the batch of non-matchers is at the end, add on any that were
2695 extracted further up the chain, and end this iteration. Otherwise,
2696 extract them from the chain and hang on the moved chain. */
2708 aptr = &((*aptr)->next);
2711 /* If the loop ended because the final address matched, *aptr will
2712 be NULL. Add on to the end any extracted non-matching addresses. If
2713 *aptr is not NULL, the loop ended via "break" when *next is null, that
2714 is, there was a string of non-matching addresses at the end. In this
2715 case the extracted addresses have already been added on the end. */
2717 if (*aptr == NULL) *aptr = moved;
2723 debug_printf("remote addresses after sorting:\n");
2724 for (addr = addr_remote; addr != NULL; addr = addr->next)
2725 debug_printf(" %s\n", addr->address);
2731 /*************************************************
2732 * Read from pipe for remote delivery subprocess *
2733 *************************************************/
2735 /* This function is called when the subprocess is complete, but can also be
2736 called before it is complete, in order to empty a pipe that is full (to prevent
2737 deadlock). It must therefore keep track of its progress in the parlist data
2740 We read the pipe to get the delivery status codes and a possible error message
2741 for each address, optionally preceded by unusability data for the hosts and
2742 also by optional retry data.
2744 Read in large chunks into the big buffer and then scan through, interpreting
2745 the data therein. In most cases, only a single read will be necessary. No
2746 individual item will ever be anywhere near 2500 bytes in length, so by ensuring
2747 that we read the next chunk when there is less than 2500 bytes left in the
2748 non-final chunk, we can assume each item is complete in the buffer before
2749 handling it. Each item is written using a single write(), which is atomic for
2750 small items (less than PIPE_BUF, which seems to be at least 512 in any Unix and
2751 often bigger) so even if we are reading while the subprocess is still going, we
2752 should never have only a partial item in the buffer.
2755 poffset the offset of the parlist item
2756 eop TRUE if the process has completed
2758 Returns: TRUE if the terminating 'Z' item has been read,
2759 or there has been a disaster (i.e. no more data needed);
2764 par_read_pipe(int poffset, BOOL eop)
2767 pardata *p = parlist + poffset;
2768 address_item *addrlist = p->addrlist;
2769 address_item *addr = p->addr;
2772 uschar *endptr = big_buffer;
2773 uschar *ptr = endptr;
2774 uschar *msg = p->msg;
2775 BOOL done = p->done;
2776 BOOL unfinished = TRUE;
2778 /* Loop through all items, reading from the pipe when necessary. The pipe
2779 is set up to be non-blocking, but there are two different Unix mechanisms in
2780 use. Exim uses O_NONBLOCK if it is defined. This returns 0 for end of file,
2781 and EAGAIN for no more data. If O_NONBLOCK is not defined, Exim uses O_NDELAY,
2782 which returns 0 for both end of file and no more data. We distinguish the
2783 two cases by taking 0 as end of file only when we know the process has
2786 Each separate item is written to the pipe in a single write(), and as they are
2787 all short items, the writes will all be atomic and we should never find
2788 ourselves in the position of having read an incomplete item. "Short" in this
2789 case can mean up to about 1K in the case when there is a long error message
2790 associated with an address. */
2792 DEBUG(D_deliver) debug_printf("reading pipe for subprocess %d (%s)\n",
2793 (int)p->pid, eop? "ended" : "not ended");
2797 retry_item *r, **rp;
2798 int remaining = endptr - ptr;
2800 /* Read (first time) or top up the chars in the buffer if necessary.
2801 There will be only one read if we get all the available data (i.e. don't
2802 fill the buffer completely). */
2804 if (remaining < 2500 && unfinished)
2807 int available = big_buffer_size - remaining;
2809 if (remaining > 0) memmove(big_buffer, ptr, remaining);
2812 endptr = big_buffer + remaining;
2813 len = read(fd, endptr, available);
2815 DEBUG(D_deliver) debug_printf("read() yielded %d\n", len);
2817 /* If the result is EAGAIN and the process is not complete, just
2818 stop reading any more and process what we have already. */
2822 if (!eop && errno == EAGAIN) len = 0; else
2824 msg = string_sprintf("failed to read pipe from transport process "
2825 "%d for transport %s: %s", pid, addr->transport->driver_name,
2831 /* If the length is zero (eof or no-more-data), just process what we
2832 already have. Note that if the process is still running and we have
2833 read all the data in the pipe (but less that "available") then we
2834 won't read any more, as "unfinished" will get set FALSE. */
2837 unfinished = len == available;
2840 /* If we are at the end of the available data, exit the loop. */
2842 if (ptr >= endptr) break;
2844 /* Handle each possible type of item, assuming the complete item is
2845 available in store. */
2849 /* Host items exist only if any hosts were marked unusable. Match
2850 up by checking the IP address. */
2853 for (h = addrlist->host_list; h != NULL; h = h->next)
2855 if (h->address == NULL || Ustrcmp(h->address, ptr+2) != 0) continue;
2863 /* Retry items are sent in a preceding R item for each address. This is
2864 kept separate to keep each message short enough to guarantee it won't
2865 be split in the pipe. Hopefully, in the majority of cases, there won't in
2866 fact be any retry items at all.
2868 The complete set of retry items might include an item to delete a
2869 routing retry if there was a previous routing delay. However, routing
2870 retries are also used when a remote transport identifies an address error.
2871 In that case, there may also be an "add" item for the same key. Arrange
2872 that a "delete" item is dropped in favour of an "add" item. */
2875 if (addr == NULL) goto ADDR_MISMATCH;
2877 DEBUG(D_deliver|D_retry)
2878 debug_printf("reading retry information for %s from subprocess\n",
2881 /* Cut out any "delete" items on the list. */
2883 for (rp = &(addr->retries); (r = *rp) != NULL; rp = &(r->next))
2885 if (Ustrcmp(r->key, ptr+1) == 0) /* Found item with same key */
2887 if ((r->flags & rf_delete) == 0) break; /* It was not "delete" */
2888 *rp = r->next; /* Excise a delete item */
2889 DEBUG(D_deliver|D_retry)
2890 debug_printf(" existing delete item dropped\n");
2894 /* We want to add a delete item only if there is no non-delete item;
2895 however we still have to step ptr through the data. */
2897 if (r == NULL || (*ptr & rf_delete) == 0)
2899 r = store_get(sizeof(retry_item));
2900 r->next = addr->retries;
2903 r->key = string_copy(ptr);
2905 memcpy(&(r->basic_errno), ptr, sizeof(r->basic_errno));
2906 ptr += sizeof(r->basic_errno);
2907 memcpy(&(r->more_errno), ptr, sizeof(r->more_errno));
2908 ptr += sizeof(r->more_errno);
2909 r->message = (*ptr)? string_copy(ptr) : NULL;
2910 DEBUG(D_deliver|D_retry)
2911 debug_printf(" added %s item\n",
2912 ((r->flags & rf_delete) == 0)? "retry" : "delete");
2917 DEBUG(D_deliver|D_retry)
2918 debug_printf(" delete item not added: non-delete item exists\n");
2921 ptr += sizeof(r->basic_errno) + sizeof(r->more_errno);
2927 /* Put the amount of data written into the parlist block */
2930 memcpy(&(p->transport_count), ptr, sizeof(transport_count));
2931 ptr += sizeof(transport_count);
2934 /* Address items are in the order of items on the address chain. We
2935 remember the current address value in case this function is called
2936 several times to empty the pipe in stages. Information about delivery
2937 over TLS is sent in a preceding X item for each address. We don't put
2938 it in with the other info, in order to keep each message short enough to
2939 guarantee it won't be split in the pipe. */
2943 if (addr == NULL) goto ADDR_MISMATCH; /* Below, in 'A' handler */
2944 addr->cipher = (*ptr)? string_copy(ptr) : NULL;
2946 addr->peerdn = (*ptr)? string_copy(ptr) : NULL;
2951 case 'C': /* client authenticator information */
2955 addr->authenticator = (*ptr)? string_copy(ptr) : NULL;
2958 addr->auth_id = (*ptr)? string_copy(ptr) : NULL;
2961 addr->auth_sndr = (*ptr)? string_copy(ptr) : NULL;
2967 #ifdef EXPERIMENTAL_PRDR
2969 addr->flags |= af_prdr_used; break;
2976 msg = string_sprintf("address count mismatch for data read from pipe "
2977 "for transport process %d for transport %s", pid,
2978 addrlist->transport->driver_name);
2983 addr->transport_return = *ptr++;
2984 addr->special_action = *ptr++;
2985 memcpy(&(addr->basic_errno), ptr, sizeof(addr->basic_errno));
2986 ptr += sizeof(addr->basic_errno);
2987 memcpy(&(addr->more_errno), ptr, sizeof(addr->more_errno));
2988 ptr += sizeof(addr->more_errno);
2989 memcpy(&(addr->flags), ptr, sizeof(addr->flags));
2990 ptr += sizeof(addr->flags);
2991 addr->message = (*ptr)? string_copy(ptr) : NULL;
2993 addr->user_message = (*ptr)? string_copy(ptr) : NULL;
2996 /* Always two strings for host information, followed by the port number */
3000 h = store_get(sizeof(host_item));
3001 h->name = string_copy(ptr);
3003 h->address = string_copy(ptr);
3005 memcpy(&(h->port), ptr, sizeof(h->port));
3006 ptr += sizeof(h->port);
3007 addr->host_used = h;
3011 /* Finished with this address */
3016 /* Z marks the logical end of the data. It is followed by '0' if
3017 continue_transport was NULL at the end of transporting, otherwise '1'.
3018 We need to know when it becomes NULL during a delivery down a passed SMTP
3019 channel so that we don't try to pass anything more down it. Of course, for
3020 most normal messages it will remain NULL all the time. */
3025 continue_transport = NULL;
3026 continue_hostname = NULL;
3029 DEBUG(D_deliver) debug_printf("Z%c item read\n", *ptr);
3032 /* Anything else is a disaster. */
3035 msg = string_sprintf("malformed data (%d) read from pipe for transport "
3036 "process %d for transport %s", ptr[-1], pid,
3037 addr->transport->driver_name);
3043 /* The done flag is inspected externally, to determine whether or not to
3044 call the function again when the process finishes. */
3048 /* If the process hadn't finished, and we haven't seen the end of the data
3049 or suffered a disaster, update the rest of the state, and return FALSE to
3050 indicate "not finished". */
3059 /* Close our end of the pipe, to prevent deadlock if the far end is still
3060 pushing stuff into it. */
3065 /* If we have finished without error, but haven't had data for every address,
3066 something is wrong. */
3068 if (msg == NULL && addr != NULL)
3069 msg = string_sprintf("insufficient address data read from pipe "
3070 "for transport process %d for transport %s", pid,
3071 addr->transport->driver_name);
3073 /* If an error message is set, something has gone wrong in getting back
3074 the delivery data. Put the message into each address and freeze it. */
3078 for (addr = addrlist; addr != NULL; addr = addr->next)
3080 addr->transport_return = DEFER;
3081 addr->special_action = SPECIAL_FREEZE;
3082 addr->message = msg;
3086 /* Return TRUE to indicate we have got all we need from this process, even
3087 if it hasn't actually finished yet. */
3094 /*************************************************
3095 * Post-process a set of remote addresses *
3096 *************************************************/
3098 /* Do what has to be done immediately after a remote delivery for each set of
3099 addresses, then re-write the spool if necessary. Note that post_process_one
3100 puts the address on an appropriate queue; hence we must fish off the next
3101 one first. This function is also called if there is a problem with setting
3102 up a subprocess to do a remote delivery in parallel. In this case, the final
3103 argument contains a message, and the action must be forced to DEFER.
3106 addr pointer to chain of address items
3107 logflags flags for logging
3108 msg NULL for normal cases; -> error message for unexpected problems
3109 fallback TRUE if processing fallback hosts
3115 remote_post_process(address_item *addr, int logflags, uschar *msg,
3120 /* If any host addresses were found to be unusable, add them to the unusable
3121 tree so that subsequent deliveries don't try them. */
3123 for (h = addr->host_list; h != NULL; h = h->next)
3125 if (h->address == NULL) continue;
3126 if (h->status >= hstatus_unusable) tree_add_unusable(h);
3129 /* Now handle each address on the chain. The transport has placed '=' or '-'
3130 into the special_action field for each successful delivery. */
3132 while (addr != NULL)
3134 address_item *next = addr->next;
3136 /* If msg == NULL (normal processing) and the result is DEFER and we are
3137 processing the main hosts and there are fallback hosts available, put the
3138 address on the list for fallback delivery. */
3140 if (addr->transport_return == DEFER &&
3141 addr->fallback_hosts != NULL &&
3145 addr->host_list = addr->fallback_hosts;
3146 addr->next = addr_fallback;
3147 addr_fallback = addr;
3148 DEBUG(D_deliver) debug_printf("%s queued for fallback host(s)\n", addr->address);
3151 /* If msg is set (=> unexpected problem), set it in the address before
3152 doing the ordinary post processing. */
3158 addr->message = msg;
3159 addr->transport_return = DEFER;
3161 (void)post_process_one(addr, addr->transport_return, logflags,
3162 DTYPE_TRANSPORT, addr->special_action);
3170 /* If we have just delivered down a passed SMTP channel, and that was
3171 the last address, the channel will have been closed down. Now that
3172 we have logged that delivery, set continue_sequence to 1 so that
3173 any subsequent deliveries don't get "*" incorrectly logged. */
3175 if (continue_transport == NULL) continue_sequence = 1;
3180 /*************************************************
3181 * Wait for one remote delivery subprocess *
3182 *************************************************/
3184 /* This function is called while doing remote deliveries when either the
3185 maximum number of processes exist and we need one to complete so that another
3186 can be created, or when waiting for the last ones to complete. It must wait for
3187 the completion of one subprocess, empty the control block slot, and return a
3188 pointer to the address chain.
3191 Returns: pointer to the chain of addresses handled by the process;
3192 NULL if no subprocess found - this is an unexpected error
3195 static address_item *
3198 int poffset, status;
3199 address_item *addr, *addrlist;
3202 set_process_info("delivering %s: waiting for a remote delivery subprocess "
3203 "to finish", message_id);
3205 /* Loop until either a subprocess completes, or there are no subprocesses in
3206 existence - in which case give an error return. We cannot proceed just by
3207 waiting for a completion, because a subprocess may have filled up its pipe, and
3208 be waiting for it to be emptied. Therefore, if no processes have finished, we
3209 wait for one of the pipes to acquire some data by calling select(), with a
3210 timeout just in case.
3212 The simple approach is just to iterate after reading data from a ready pipe.
3213 This leads to non-ideal behaviour when the subprocess has written its final Z
3214 item, closed the pipe, and is in the process of exiting (the common case). A
3215 call to waitpid() yields nothing completed, but select() shows the pipe ready -
3216 reading it yields EOF, so you end up with busy-waiting until the subprocess has
3219 To avoid this, if all the data that is needed has been read from a subprocess
3220 after select(), an explicit wait() for it is done. We know that all it is doing
3221 is writing to the pipe and then exiting, so the wait should not be long.
3223 The non-blocking waitpid() is to some extent just insurance; if we could
3224 reliably detect end-of-file on the pipe, we could always know when to do a
3225 blocking wait() for a completed process. However, because some systems use
3226 NDELAY, which doesn't distinguish between EOF and pipe empty, it is easier to
3227 use code that functions without the need to recognize EOF.
3229 There's a double loop here just in case we end up with a process that is not in
3230 the list of remote delivery processes. Something has obviously gone wrong if
3231 this is the case. (For example, a process that is incorrectly left over from
3232 routing or local deliveries might be found.) The damage can be minimized by
3233 looping back and looking for another process. If there aren't any, the error
3234 return will happen. */
3236 for (;;) /* Normally we do not repeat this loop */
3238 while ((pid = waitpid(-1, &status, WNOHANG)) <= 0)
3241 fd_set select_pipes;
3242 int maxpipe, readycount;
3244 /* A return value of -1 can mean several things. If errno != ECHILD, it
3245 either means invalid options (which we discount), or that this process was
3246 interrupted by a signal. Just loop to try the waitpid() again.
3248 If errno == ECHILD, waitpid() is telling us that there are no subprocesses
3249 in existence. This should never happen, and is an unexpected error.
3250 However, there is a nasty complication when running under Linux. If "strace
3251 -f" is being used under Linux to trace this process and its children,
3252 subprocesses are "stolen" from their parents and become the children of the
3253 tracing process. A general wait such as the one we've just obeyed returns
3254 as if there are no children while subprocesses are running. Once a
3255 subprocess completes, it is restored to the parent, and waitpid(-1) finds
3256 it. Thanks to Joachim Wieland for finding all this out and suggesting a
3259 This does not happen using "truss" on Solaris, nor (I think) with other
3260 tracing facilities on other OS. It seems to be specific to Linux.
3262 What we do to get round this is to use kill() to see if any of our
3263 subprocesses are still in existence. If kill() gives an OK return, we know
3264 it must be for one of our processes - it can't be for a re-use of the pid,
3265 because if our process had finished, waitpid() would have found it. If any
3266 of our subprocesses are in existence, we proceed to use select() as if
3267 waitpid() had returned zero. I think this is safe. */
3271 if (errno != ECHILD) continue; /* Repeats the waitpid() */
3274 debug_printf("waitpid() returned -1/ECHILD: checking explicitly "
3275 "for process existence\n");
3277 for (poffset = 0; poffset < remote_max_parallel; poffset++)
3279 if ((pid = parlist[poffset].pid) != 0 && kill(pid, 0) == 0)
3281 DEBUG(D_deliver) debug_printf("process %d still exists: assume "
3282 "stolen by strace\n", (int)pid);
3283 break; /* With poffset set */
3287 if (poffset >= remote_max_parallel)
3289 DEBUG(D_deliver) debug_printf("*** no delivery children found\n");
3290 return NULL; /* This is the error return */
3294 /* A pid value greater than 0 breaks the "while" loop. A negative value has
3295 been handled above. A return value of zero means that there is at least one
3296 subprocess, but there are no completed subprocesses. See if any pipes are
3297 ready with any data for reading. */
3299 DEBUG(D_deliver) debug_printf("selecting on subprocess pipes\n");
3302 FD_ZERO(&select_pipes);
3303 for (poffset = 0; poffset < remote_max_parallel; poffset++)
3305 if (parlist[poffset].pid != 0)
3307 int fd = parlist[poffset].fd;
3308 FD_SET(fd, &select_pipes);
3309 if (fd > maxpipe) maxpipe = fd;
3313 /* Stick in a 60-second timeout, just in case. */
3318 readycount = select(maxpipe + 1, (SELECT_ARG2_TYPE *)&select_pipes,
3321 /* Scan through the pipes and read any that are ready; use the count
3322 returned by select() to stop when there are no more. Select() can return
3323 with no processes (e.g. if interrupted). This shouldn't matter.
3325 If par_read_pipe() returns TRUE, it means that either the terminating Z was
3326 read, or there was a disaster. In either case, we are finished with this
3327 process. Do an explicit wait() for the process and break the main loop if
3330 It turns out that we have to deal with the case of an interrupted system
3331 call, which can happen on some operating systems if the signal handling is
3332 set up to do that by default. */
3335 readycount > 0 && poffset < remote_max_parallel;
3338 if ((pid = parlist[poffset].pid) != 0 &&
3339 FD_ISSET(parlist[poffset].fd, &select_pipes))
3342 if (par_read_pipe(poffset, FALSE)) /* Finished with this pipe */
3344 for (;;) /* Loop for signals */
3346 pid_t endedpid = waitpid(pid, &status, 0);
3347 if (endedpid == pid) goto PROCESS_DONE;
3348 if (endedpid != (pid_t)(-1) || errno != EINTR)
3349 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Unexpected error return "
3350 "%d (errno = %d) from waitpid() for process %d",
3351 (int)endedpid, errno, (int)pid);
3357 /* Now go back and look for a completed subprocess again. */
3360 /* A completed process was detected by the non-blocking waitpid(). Find the
3361 data block that corresponds to this subprocess. */
3363 for (poffset = 0; poffset < remote_max_parallel; poffset++)
3364 if (pid == parlist[poffset].pid) break;
3366 /* Found the data block; this is a known remote delivery process. We don't
3367 need to repeat the outer loop. This should be what normally happens. */
3369 if (poffset < remote_max_parallel) break;
3371 /* This situation is an error, but it's probably better to carry on looking
3372 for another process than to give up (as we used to do). */
3374 log_write(0, LOG_MAIN|LOG_PANIC, "Process %d finished: not found in remote "
3375 "transport process list", pid);
3376 } /* End of the "for" loop */
3378 /* Come here when all the data was completely read after a select(), and
3379 the process in pid has been wait()ed for. */
3386 debug_printf("remote delivery process %d ended\n", (int)pid);
3388 debug_printf("remote delivery process %d ended: status=%04x\n", (int)pid,
3392 set_process_info("delivering %s", message_id);
3394 /* Get the chain of processed addresses */
3396 addrlist = parlist[poffset].addrlist;
3398 /* If the process did not finish cleanly, record an error and freeze (except
3399 for SIGTERM, SIGKILL and SIGQUIT), and also ensure the journal is not removed,
3400 in case the delivery did actually happen. */
3402 if ((status & 0xffff) != 0)
3405 int msb = (status >> 8) & 255;
3406 int lsb = status & 255;
3407 int code = (msb == 0)? (lsb & 0x7f) : msb;
3409 msg = string_sprintf("%s transport process returned non-zero status 0x%04x: "
3411 addrlist->transport->driver_name,
3413 (msb == 0)? "terminated by signal" : "exit code",
3416 if (msb != 0 || (code != SIGTERM && code != SIGKILL && code != SIGQUIT))
3417 addrlist->special_action = SPECIAL_FREEZE;
3419 for (addr = addrlist; addr != NULL; addr = addr->next)
3421 addr->transport_return = DEFER;
3422 addr->message = msg;
3425 remove_journal = FALSE;
3428 /* Else complete reading the pipe to get the result of the delivery, if all
3429 the data has not yet been obtained. */
3431 else if (!parlist[poffset].done) (void)par_read_pipe(poffset, TRUE);
3433 /* Put the data count and return path into globals, mark the data slot unused,
3434 decrement the count of subprocesses, and return the address chain. */
3436 transport_count = parlist[poffset].transport_count;
3437 used_return_path = parlist[poffset].return_path;
3438 parlist[poffset].pid = 0;
3445 /*************************************************
3446 * Wait for subprocesses and post-process *
3447 *************************************************/
3449 /* This function waits for subprocesses until the number that are still running
3450 is below a given threshold. For each complete subprocess, the addresses are
3451 post-processed. If we can't find a running process, there is some shambles.
3452 Better not bomb out, as that might lead to multiple copies of the message. Just
3453 log and proceed as if all done.
3456 max maximum number of subprocesses to leave running
3457 fallback TRUE if processing fallback hosts
3463 par_reduce(int max, BOOL fallback)
3465 while (parcount > max)
3467 address_item *doneaddr = par_wait();
3468 if (doneaddr == NULL)
3470 log_write(0, LOG_MAIN|LOG_PANIC,
3471 "remote delivery process count got out of step");
3474 else remote_post_process(doneaddr, LOG_MAIN, NULL, fallback);
3482 rmt_dlv_checked_write(int fd, void * buf, int size)
3484 int ret = write(fd, buf, size);
3486 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Failed writing transport result to pipe: %s\n",
3487 ret == -1 ? strerror(errno) : "short write");
3490 /*************************************************
3491 * Do remote deliveries *
3492 *************************************************/
3494 /* This function is called to process the addresses in addr_remote. We must
3495 pick off the queue all addresses that have the same transport, remote
3496 destination, and errors address, and hand them to the transport in one go,
3497 subject to some configured limitations. If this is a run to continue delivering
3498 to an existing delivery channel, skip all but those addresses that can go to
3499 that channel. The skipped addresses just get deferred.
3501 If mua_wrapper is set, all addresses must be able to be sent in a single
3502 transaction. If not, this function yields FALSE.
3504 In Exim 4, remote deliveries are always done in separate processes, even
3505 if remote_max_parallel = 1 or if there's only one delivery to do. The reason
3506 is so that the base process can retain privilege. This makes the
3507 implementation of fallback transports feasible (though not initially done.)
3509 We create up to the configured number of subprocesses, each of which passes
3510 back the delivery state via a pipe. (However, when sending down an existing
3511 connection, remote_max_parallel is forced to 1.)
3514 fallback TRUE if processing fallback hosts
3516 Returns: TRUE normally
3517 FALSE if mua_wrapper is set and the addresses cannot all be sent
3522 do_remote_deliveries(BOOL fallback)
3528 parcount = 0; /* Number of executing subprocesses */
3530 /* When sending down an existing channel, only do one delivery at a time.
3531 We use a local variable (parmax) to hold the maximum number of processes;
3532 this gets reduced from remote_max_parallel if we can't create enough pipes. */
3534 if (continue_transport != NULL) remote_max_parallel = 1;
3535 parmax = remote_max_parallel;
3537 /* If the data for keeping a list of processes hasn't yet been
3540 if (parlist == NULL)
3542 parlist = store_get(remote_max_parallel * sizeof(pardata));
3543 for (poffset = 0; poffset < remote_max_parallel; poffset++)
3544 parlist[poffset].pid = 0;
3547 /* Now loop for each remote delivery */
3549 for (delivery_count = 0; addr_remote != NULL; delivery_count++)
3555 int address_count = 1;
3556 int address_count_max;
3558 BOOL use_initgroups;
3559 BOOL pipe_done = FALSE;
3560 transport_instance *tp;
3561 address_item **anchor = &addr_remote;
3562 address_item *addr = addr_remote;
3563 address_item *last = addr;
3566 /* Pull the first address right off the list. */
3568 addr_remote = addr->next;
3571 DEBUG(D_deliver|D_transport)
3572 debug_printf("--------> %s <--------\n", addr->address);
3574 /* If no transport has been set, there has been a big screw-up somewhere. */
3576 if ((tp = addr->transport) == NULL)
3578 disable_logging = FALSE; /* Jic */
3579 remote_post_process(addr, LOG_MAIN|LOG_PANIC,
3580 US"No transport set by router", fallback);
3584 /* Check that this base address hasn't previously been delivered to this
3585 transport. The check is necessary at this point to handle homonymic addresses
3586 correctly in cases where the pattern of redirection changes between delivery
3587 attempts. Non-homonymic previous delivery is detected earlier, at routing
3590 if (previously_transported(addr, FALSE)) continue;
3592 /* Force failure if the message is too big. */
3594 if (tp->message_size_limit != NULL)
3596 int rc = check_message_size(tp, addr);
3599 addr->transport_return = rc;
3600 remote_post_process(addr, LOG_MAIN, NULL, fallback);
3605 /* Get the flag which specifies whether the transport can handle different
3606 domains that nevertheless resolve to the same set of hosts. */
3608 multi_domain = tp->multi_domain;
3610 /* Get the maximum it can handle in one envelope, with zero meaning
3611 unlimited, which is forced for the MUA wrapper case. */
3613 address_count_max = tp->max_addresses;
3614 if (address_count_max == 0 || mua_wrapper) address_count_max = 999999;
3617 /************************************************************************/
3618 /***** This is slightly experimental code, but should be safe. *****/
3620 /* The address_count_max value is the maximum number of addresses that the
3621 transport can send in one envelope. However, the transport must be capable of
3622 dealing with any number of addresses. If the number it gets exceeds its
3623 envelope limitation, it must send multiple copies of the message. This can be
3624 done over a single connection for SMTP, so uses less resources than making
3625 multiple connections. On the other hand, if remote_max_parallel is greater
3626 than one, it is perhaps a good idea to use parallel processing to move the
3627 message faster, even if that results in multiple simultaneous connections to
3630 How can we come to some compromise between these two ideals? What we do is to
3631 limit the number of addresses passed to a single instance of a transport to
3632 the greater of (a) its address limit (rcpt_max for SMTP) and (b) the total
3633 number of addresses routed to remote transports divided by
3634 remote_max_parallel. For example, if the message has 100 remote recipients,
3635 remote max parallel is 2, and rcpt_max is 10, we'd never send more than 50 at
3636 once. But if rcpt_max is 100, we could send up to 100.
3638 Of course, not all the remotely addresses in a message are going to go to the
3639 same set of hosts (except in smarthost configurations), so this is just a
3640 heuristic way of dividing up the work.
3642 Furthermore (1), because this may not be wanted in some cases, and also to
3643 cope with really pathological cases, there is also a limit to the number of
3644 messages that are sent over one connection. This is the same limit that is
3645 used when sending several different messages over the same connection.
3646 Continue_sequence is set when in this situation, to the number sent so
3647 far, including this message.
3649 Furthermore (2), when somebody explicitly sets the maximum value to 1, it
3650 is probably because they are using VERP, in which case they want to pass only
3651 one address at a time to the transport, in order to be able to use
3652 $local_part and $domain in constructing a new return path. We could test for
3653 the use of these variables, but as it is so likely they will be used when the
3654 maximum is 1, we don't bother. Just leave the value alone. */
3656 if (address_count_max != 1 &&
3657 address_count_max < remote_delivery_count/remote_max_parallel)
3659 int new_max = remote_delivery_count/remote_max_parallel;
3660 int message_max = tp->connection_max_messages;
3661 if (connection_max_messages >= 0) message_max = connection_max_messages;
3662 message_max -= continue_sequence - 1;
3663 if (message_max > 0 && new_max > address_count_max * message_max)
3664 new_max = address_count_max * message_max;
3665 address_count_max = new_max;
3668 /************************************************************************/
3671 /* Pick off all addresses which have the same transport, errors address,
3672 destination, and extra headers. In some cases they point to the same host
3673 list, but we also need to check for identical host lists generated from
3674 entirely different domains. The host list pointers can be NULL in the case
3675 where the hosts are defined in the transport. There is also a configured
3676 maximum limit of addresses that can be handled at once (see comments above
3677 for how it is computed). */
3679 while ((next = *anchor) != NULL && address_count < address_count_max)
3681 if ((multi_domain || Ustrcmp(next->domain, addr->domain) == 0)
3683 tp == next->transport
3685 same_hosts(next->host_list, addr->host_list)
3687 same_strings(next->p.errors_address, addr->p.errors_address)
3689 same_headers(next->p.extra_headers, addr->p.extra_headers)
3691 same_ugid(tp, next, addr)
3693 (next->p.remove_headers == addr->p.remove_headers ||
3694 (next->p.remove_headers != NULL &&
3695 addr->p.remove_headers != NULL &&
3696 Ustrcmp(next->p.remove_headers, addr->p.remove_headers) == 0)))
3698 *anchor = next->next;
3700 next->first = addr; /* remember top one (for retry processing) */
3705 else anchor = &(next->next);
3708 /* If we are acting as an MUA wrapper, all addresses must go in a single
3709 transaction. If not, put them back on the chain and yield FALSE. */
3711 if (mua_wrapper && addr_remote != NULL)
3713 last->next = addr_remote;
3718 /* Set up the expansion variables for this set of addresses */
3720 deliver_set_expansions(addr);
3722 /* Ensure any transport-set auth info is fresh */
3723 addr->authenticator = addr->auth_id = addr->auth_sndr = NULL;
3725 /* Compute the return path, expanding a new one if required. The old one
3726 must be set first, as it might be referred to in the expansion. */
3728 if(addr->p.errors_address != NULL)
3729 return_path = addr->p.errors_address;
3730 #ifdef EXPERIMENTAL_SRS
3731 else if(addr->p.srs_sender != NULL)
3732 return_path = addr->p.srs_sender;
3735 return_path = sender_address;
3737 if (tp->return_path != NULL)
3739 uschar *new_return_path = expand_string(tp->return_path);
3740 if (new_return_path == NULL)
3742 if (!expand_string_forcedfail)
3744 remote_post_process(addr, LOG_MAIN|LOG_PANIC,
3745 string_sprintf("Failed to expand return path \"%s\": %s",
3746 tp->return_path, expand_string_message), fallback);
3750 else return_path = new_return_path;
3753 /* Find the uid, gid, and use_initgroups setting for this transport. Failure
3754 logs and sets up error messages, so we just post-process and continue with
3755 the next address. */
3757 if (!findugid(addr, tp, &uid, &gid, &use_initgroups))
3759 remote_post_process(addr, LOG_MAIN|LOG_PANIC, NULL, fallback);
3763 /* If this transport has a setup function, call it now so that it gets
3764 run in this process and not in any subprocess. That way, the results of
3765 any setup that are retained by the transport can be reusable. One of the
3766 things the setup does is to set the fallback host lists in the addresses.
3767 That is why it is called at this point, before the continue delivery
3768 processing, because that might use the fallback hosts. */
3770 if (tp->setup != NULL)
3771 (void)((tp->setup)(addr->transport, addr, NULL, uid, gid, NULL));
3773 /* If this is a run to continue delivery down an already-established
3774 channel, check that this set of addresses matches the transport and
3775 the channel. If it does not, defer the addresses. If a host list exists,
3776 we must check that the continue host is on the list. Otherwise, the
3777 host is set in the transport. */
3779 continue_more = FALSE; /* In case got set for the last lot */
3780 if (continue_transport != NULL)
3782 BOOL ok = Ustrcmp(continue_transport, tp->name) == 0;
3783 if (ok && addr->host_list != NULL)
3787 for (h = addr->host_list; h != NULL; h = h->next)
3789 if (Ustrcmp(h->name, continue_hostname) == 0)
3790 { ok = TRUE; break; }
3794 /* Addresses not suitable; defer or queue for fallback hosts (which
3795 might be the continue host) and skip to next address. */
3799 DEBUG(D_deliver) debug_printf("not suitable for continue_transport\n");
3802 if (addr->fallback_hosts != NULL && !fallback)
3806 next->host_list = next->fallback_hosts;
3807 DEBUG(D_deliver) debug_printf("%s queued for fallback host(s)\n", next->address);
3808 if (next->next == NULL) break;
3811 next->next = addr_fallback;
3812 addr_fallback = addr;
3817 while (next->next != NULL) next = next->next;
3818 next->next = addr_defer;
3825 /* Set a flag indicating whether there are further addresses that list
3826 the continued host. This tells the transport to leave the channel open,
3827 but not to pass it to another delivery process. */
3829 for (next = addr_remote; next != NULL; next = next->next)
3832 for (h = next->host_list; h != NULL; h = h->next)
3834 if (Ustrcmp(h->name, continue_hostname) == 0)
3835 { continue_more = TRUE; break; }
3840 /* The transports set up the process info themselves as they may connect
3841 to more than one remote machine. They also have to set up the filter
3842 arguments, if required, so that the host name and address are available
3845 transport_filter_argv = NULL;
3847 /* Create the pipe for inter-process communication. If pipe creation
3848 fails, it is probably because the value of remote_max_parallel is so
3849 large that too many file descriptors for pipes have been created. Arrange
3850 to wait for a process to finish, and then try again. If we still can't
3851 create a pipe when all processes have finished, break the retry loop. */
3855 if (pipe(pfd) == 0) pipe_done = TRUE;
3856 else if (parcount > 0) parmax = parcount;
3859 /* We need to make the reading end of the pipe non-blocking. There are
3860 two different options for this. Exim is cunningly (I hope!) coded so
3861 that it can use either of them, though it prefers O_NONBLOCK, which
3862 distinguishes between EOF and no-more-data. */
3865 (void)fcntl(pfd[pipe_read], F_SETFL, O_NONBLOCK);
3867 (void)fcntl(pfd[pipe_read], F_SETFL, O_NDELAY);
3870 /* If the maximum number of subprocesses already exist, wait for a process
3871 to finish. If we ran out of file descriptors, parmax will have been reduced
3872 from its initial value of remote_max_parallel. */
3874 par_reduce(parmax - 1, fallback);
3877 /* If we failed to create a pipe and there were no processes to wait
3878 for, we have to give up on this one. Do this outside the above loop
3879 so that we can continue the main loop. */
3883 remote_post_process(addr, LOG_MAIN|LOG_PANIC,
3884 string_sprintf("unable to create pipe: %s", strerror(errno)), fallback);
3888 /* Find a free slot in the pardata list. Must do this after the possible
3889 waiting for processes to finish, because a terminating process will free
3892 for (poffset = 0; poffset < remote_max_parallel; poffset++)
3893 if (parlist[poffset].pid == 0) break;
3895 /* If there isn't one, there has been a horrible disaster. */
3897 if (poffset >= remote_max_parallel)
3899 (void)close(pfd[pipe_write]);
3900 (void)close(pfd[pipe_read]);
3901 remote_post_process(addr, LOG_MAIN|LOG_PANIC,
3902 US"Unexpectedly no free subprocess slot", fallback);
3906 /* Now fork a subprocess to do the remote delivery, but before doing so,
3907 ensure that any cached resourses are released so as not to interfere with
3908 what happens in the subprocess. */
3912 if ((pid = fork()) == 0)
3914 int fd = pfd[pipe_write];
3917 /* Setting this global in the subprocess means we need never clear it */
3918 transport_name = tp->name;
3920 /* There are weird circumstances in which logging is disabled */
3921 disable_logging = tp->disable_logging;
3923 /* Show pids on debug output if parallelism possible */
3925 if (parmax > 1 && (parcount > 0 || addr_remote != NULL))
3927 DEBUG(D_any|D_v) debug_selector |= D_pid;
3928 DEBUG(D_deliver) debug_printf("Remote delivery process started\n");
3931 /* Reset the random number generator, so different processes don't all
3932 have the same sequence. In the test harness we want different, but
3933 predictable settings for each delivery process, so do something explicit
3934 here rather they rely on the fixed reset in the random number function. */
3936 random_seed = running_in_test_harness? 42 + 2*delivery_count : 0;
3938 /* Set close-on-exec on the pipe so that it doesn't get passed on to
3939 a new process that may be forked to do another delivery down the same
3942 (void)fcntl(fd, F_SETFD, fcntl(fd, F_GETFD) | FD_CLOEXEC);
3944 /* Close open file descriptors for the pipes of other processes
3945 that are running in parallel. */
3947 for (poffset = 0; poffset < remote_max_parallel; poffset++)
3948 if (parlist[poffset].pid != 0) (void)close(parlist[poffset].fd);
3950 /* This process has inherited a copy of the file descriptor
3951 for the data file, but its file pointer is shared with all the
3952 other processes running in parallel. Therefore, we have to re-open
3953 the file in order to get a new file descriptor with its own
3954 file pointer. We don't need to lock it, as the lock is held by
3955 the parent process. There doesn't seem to be any way of doing
3956 a dup-with-new-file-pointer. */
3958 (void)close(deliver_datafile);
3959 sprintf(CS spoolname, "%s/input/%s/%s-D", spool_directory, message_subdir,
3961 deliver_datafile = Uopen(spoolname, O_RDWR | O_APPEND, 0);
3963 if (deliver_datafile < 0)
3964 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Failed to reopen %s for remote "
3965 "parallel delivery: %s", spoolname, strerror(errno));
3967 /* Set the close-on-exec flag */
3969 (void)fcntl(deliver_datafile, F_SETFD, fcntl(deliver_datafile, F_GETFD) |
3972 /* Set the uid/gid of this process; bombs out on failure. */
3974 exim_setugid(uid, gid, use_initgroups,
3975 string_sprintf("remote delivery to %s with transport=%s",
3976 addr->address, tp->name));
3978 /* Close the unwanted half of this process' pipe, set the process state,
3979 and run the transport. Afterwards, transport_count will contain the number
3980 of bytes written. */
3982 (void)close(pfd[pipe_read]);
3983 set_process_info("delivering %s using %s", message_id, tp->name);
3984 debug_print_string(tp->debug_string);
3985 if (!(tp->info->code)(addr->transport, addr)) replicate_status(addr);
3987 set_process_info("delivering %s (just run %s for %s%s in subprocess)",
3988 message_id, tp->name, addr->address, (addr->next == NULL)? "" : ", ...");
3990 /* Ensure any cached resources that we used are now released */
3994 /* Pass the result back down the pipe. This is a lot more information
3995 than is needed for a local delivery. We have to send back the error
3996 status for each address, the usability status for each host that is
3997 flagged as unusable, and all the retry items. When TLS is in use, we
3998 send also the cipher and peerdn information. Each type of information
3999 is flagged by an identifying byte, and is then in a fixed format (with
4000 strings terminated by zeros), and there is a final terminator at the
4001 end. The host information and retry information is all attached to
4002 the first address, so that gets sent at the start. */
4004 /* Host unusability information: for most success cases this will
4007 for (h = addr->host_list; h != NULL; h = h->next)
4009 if (h->address == NULL || h->status < hstatus_unusable) continue;
4010 sprintf(CS big_buffer, "H%c%c%s", h->status, h->why, h->address);
4011 rmt_dlv_checked_write(fd, big_buffer, Ustrlen(big_buffer+3) + 4);
4014 /* The number of bytes written. This is the same for each address. Even
4015 if we sent several copies of the message down the same connection, the
4016 size of each one is the same, and it's that value we have got because
4017 transport_count gets reset before calling transport_write_message(). */
4019 big_buffer[0] = 'S';
4020 memcpy(big_buffer+1, &transport_count, sizeof(transport_count));
4021 rmt_dlv_checked_write(fd, big_buffer, sizeof(transport_count) + 1);
4023 /* Information about what happened to each address. Four item types are
4024 used: an optional 'X' item first, for TLS information, then an optional "C"
4025 item for any client-auth info followed by 'R' items for any retry settings,
4026 and finally an 'A' item for the remaining data. */
4028 for(; addr != NULL; addr = addr->next)
4033 /* The certificate verification status goes into the flags */
4035 if (tls_out.certificate_verified) setflag(addr, af_cert_verified);
4037 /* Use an X item only if there's something to send */
4040 if (addr->cipher != NULL)
4043 sprintf(CS ptr, "X%.128s", addr->cipher);
4045 if (addr->peerdn == NULL) *ptr++ = 0; else
4047 sprintf(CS ptr, "%.512s", addr->peerdn);
4050 rmt_dlv_checked_write(fd, big_buffer, ptr - big_buffer);
4054 if (client_authenticator)
4057 sprintf(CS big_buffer, "C1%.64s", client_authenticator);
4059 rmt_dlv_checked_write(fd, big_buffer, ptr - big_buffer);
4061 if (client_authenticated_id)
4064 sprintf(CS big_buffer, "C2%.64s", client_authenticated_id);
4066 rmt_dlv_checked_write(fd, big_buffer, ptr - big_buffer);
4068 if (client_authenticated_sender)
4071 sprintf(CS big_buffer, "C3%.64s", client_authenticated_sender);
4073 rmt_dlv_checked_write(fd, big_buffer, ptr - big_buffer);
4076 #ifdef EXPERIMENTAL_PRDR
4077 if (addr->flags & af_prdr_used) rmt_dlv_checked_write(fd, "P", 1);
4080 /* Retry information: for most success cases this will be null. */
4082 for (r = addr->retries; r != NULL; r = r->next)
4085 sprintf(CS big_buffer, "R%c%.500s", r->flags, r->key);
4086 ptr = big_buffer + Ustrlen(big_buffer+2) + 3;
4087 memcpy(ptr, &(r->basic_errno), sizeof(r->basic_errno));
4088 ptr += sizeof(r->basic_errno);
4089 memcpy(ptr, &(r->more_errno), sizeof(r->more_errno));
4090 ptr += sizeof(r->more_errno);
4091 if (r->message == NULL) *ptr++ = 0; else
4093 sprintf(CS ptr, "%.512s", r->message);
4096 rmt_dlv_checked_write(fd, big_buffer, ptr - big_buffer);
4099 /* The rest of the information goes in an 'A' item. */
4101 ptr = big_buffer + 3;
4102 sprintf(CS big_buffer, "A%c%c", addr->transport_return,
4103 addr->special_action);
4104 memcpy(ptr, &(addr->basic_errno), sizeof(addr->basic_errno));
4105 ptr += sizeof(addr->basic_errno);
4106 memcpy(ptr, &(addr->more_errno), sizeof(addr->more_errno));
4107 ptr += sizeof(addr->more_errno);
4108 memcpy(ptr, &(addr->flags), sizeof(addr->flags));
4109 ptr += sizeof(addr->flags);
4111 if (addr->message == NULL) *ptr++ = 0; else
4113 sprintf(CS ptr, "%.1024s", addr->message);
4117 if (addr->user_message == NULL) *ptr++ = 0; else
4119 sprintf(CS ptr, "%.1024s", addr->user_message);
4123 if (addr->host_used == NULL) *ptr++ = 0; else
4125 sprintf(CS ptr, "%.256s", addr->host_used->name);
4127 sprintf(CS ptr, "%.64s", addr->host_used->address);
4129 memcpy(ptr, &(addr->host_used->port), sizeof(addr->host_used->port));
4130 ptr += sizeof(addr->host_used->port);
4132 rmt_dlv_checked_write(fd, big_buffer, ptr - big_buffer);
4135 /* Add termination flag, close the pipe, and that's it. The character
4136 after 'Z' indicates whether continue_transport is now NULL or not.
4137 A change from non-NULL to NULL indicates a problem with a continuing
4140 big_buffer[0] = 'Z';
4141 big_buffer[1] = (continue_transport == NULL)? '0' : '1';
4142 rmt_dlv_checked_write(fd, big_buffer, 2);
4147 /* Back in the mainline: close the unwanted half of the pipe. */
4149 (void)close(pfd[pipe_write]);
4151 /* Fork failed; defer with error message */
4155 (void)close(pfd[pipe_read]);
4156 remote_post_process(addr, LOG_MAIN|LOG_PANIC,
4157 string_sprintf("fork failed for remote delivery to %s: %s",
4158 addr->domain, strerror(errno)), fallback);
4162 /* Fork succeeded; increment the count, and remember relevant data for
4163 when the process finishes. */
4166 parlist[poffset].addrlist = parlist[poffset].addr = addr;
4167 parlist[poffset].pid = pid;
4168 parlist[poffset].fd = pfd[pipe_read];
4169 parlist[poffset].done = FALSE;
4170 parlist[poffset].msg = NULL;
4171 parlist[poffset].return_path = return_path;
4173 /* If the process we've just started is sending a message down an existing
4174 channel, wait for it now. This ensures that only one such process runs at
4175 once, whatever the value of remote_max parallel. Otherwise, we might try to
4176 send two or more messages simultaneously down the same channel. This could
4177 happen if there are different domains that include the same host in otherwise
4178 different host lists.
4180 Also, if the transport closes down the channel, this information gets back
4181 (continue_transport gets set to NULL) before we consider any other addresses
4184 if (continue_transport != NULL) par_reduce(0, fallback);
4186 /* Otherwise, if we are running in the test harness, wait a bit, to let the
4187 newly created process get going before we create another process. This should
4188 ensure repeatability in the tests. We only need to wait a tad. */
4190 else if (running_in_test_harness) millisleep(500);
4193 /* Reached the end of the list of addresses. Wait for all the subprocesses that
4194 are still running and post-process their addresses. */
4196 par_reduce(0, fallback);
4203 /*************************************************
4204 * Split an address into local part and domain *
4205 *************************************************/
4207 /* This function initializes an address for routing by splitting it up into a
4208 local part and a domain. The local part is set up twice - once in its original
4209 casing, and once in lower case, and it is dequoted. We also do the "percent
4210 hack" for configured domains. This may lead to a DEFER result if a lookup
4211 defers. When a percent-hacking takes place, we insert a copy of the original
4212 address as a new parent of this address, as if we have had a redirection.
4215 addr points to an addr_item block containing the address
4218 DEFER - could not determine if domain is %-hackable
4222 deliver_split_address(address_item *addr)
4224 uschar *address = addr->address;
4225 uschar *domain = Ustrrchr(address, '@');
4227 int len = domain - address;
4229 addr->domain = string_copylc(domain+1); /* Domains are always caseless */
4231 /* The implication in the RFCs (though I can't say I've seen it spelled out
4232 explicitly) is that quoting should be removed from local parts at the point
4233 where they are locally interpreted. [The new draft "821" is more explicit on
4234 this, Jan 1999.] We know the syntax is valid, so this can be done by simply
4235 removing quoting backslashes and any unquoted doublequotes. */
4237 t = addr->cc_local_part = store_get(len+1);
4240 register int c = *address++;
4241 if (c == '\"') continue;
4251 /* We do the percent hack only for those domains that are listed in
4252 percent_hack_domains. A loop is required, to copy with multiple %-hacks. */
4254 if (percent_hack_domains != NULL)
4257 uschar *new_address = NULL;
4258 uschar *local_part = addr->cc_local_part;
4260 deliver_domain = addr->domain; /* set $domain */
4262 while ((rc = match_isinlist(deliver_domain, &percent_hack_domains, 0,
4263 &domainlist_anchor, addr->domain_cache, MCL_DOMAIN, TRUE, NULL))
4265 (t = Ustrrchr(local_part, '%')) != NULL)
4267 new_address = string_copy(local_part);
4268 new_address[t - local_part] = '@';
4269 deliver_domain = string_copylc(t+1);
4270 local_part = string_copyn(local_part, t - local_part);
4273 if (rc == DEFER) return DEFER; /* lookup deferred */
4275 /* If hackery happened, set up new parent and alter the current address. */
4277 if (new_address != NULL)
4279 address_item *new_parent = store_get(sizeof(address_item));
4280 *new_parent = *addr;
4281 addr->parent = new_parent;
4282 addr->address = new_address;
4283 addr->unique = string_copy(new_address);
4284 addr->domain = deliver_domain;
4285 addr->cc_local_part = local_part;
4286 DEBUG(D_deliver) debug_printf("%%-hack changed address to: %s\n",
4291 /* Create the lowercased version of the final local part, and make that the
4292 default one to be used. */
4294 addr->local_part = addr->lc_local_part = string_copylc(addr->cc_local_part);
4301 /*************************************************
4302 * Get next error message text *
4303 *************************************************/
4305 /* If f is not NULL, read the next "paragraph", from a customized error message
4306 text file, terminated by a line containing ****, and expand it.
4309 f NULL or a file to read from
4310 which string indicating which string (for errors)
4312 Returns: NULL or an expanded string
4316 next_emf(FILE *f, uschar *which)
4320 uschar *para, *yield;
4323 if (f == NULL) return NULL;
4325 if (Ufgets(buffer, sizeof(buffer), f) == NULL ||
4326 Ustrcmp(buffer, "****\n") == 0) return NULL;
4328 para = store_get(size);
4331 para = string_cat(para, &size, &ptr, buffer, Ustrlen(buffer));
4332 if (Ufgets(buffer, sizeof(buffer), f) == NULL ||
4333 Ustrcmp(buffer, "****\n") == 0) break;
4337 yield = expand_string(para);
4338 if (yield != NULL) return yield;
4340 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand string from "
4341 "bounce_message_file or warn_message_file (%s): %s", which,
4342 expand_string_message);
4349 /*************************************************
4350 * Close down a passed transport channel *
4351 *************************************************/
4353 /* This function is called when a passed transport channel cannot be used.
4354 It attempts to close it down tidily. The yield is always DELIVER_NOT_ATTEMPTED
4355 so that the function call can be the argument of a "return" statement.
4358 Returns: DELIVER_NOT_ATTEMPTED
4362 continue_closedown(void)
4364 if (continue_transport != NULL)
4366 transport_instance *t;
4367 for (t = transports; t != NULL; t = t->next)
4369 if (Ustrcmp(t->name, continue_transport) == 0)
4371 if (t->info->closedown != NULL) (t->info->closedown)(t);
4376 return DELIVER_NOT_ATTEMPTED;
4382 /*************************************************
4383 * Print address information *
4384 *************************************************/
4386 /* This function is called to output an address, or information about an
4387 address, for bounce or defer messages. If the hide_child flag is set, all we
4388 output is the original ancestor address.
4391 addr points to the address
4392 f the FILE to print to
4393 si an initial string
4394 sc a continuation string for before "generated"
4397 Returns: TRUE if the address is not hidden
4401 print_address_information(address_item *addr, FILE *f, uschar *si, uschar *sc,
4405 uschar *printed = US"";
4406 address_item *ancestor = addr;
4407 while (ancestor->parent != NULL) ancestor = ancestor->parent;
4409 fprintf(f, "%s", CS si);
4411 if (addr->parent != NULL && testflag(addr, af_hide_child))
4413 printed = US"an undisclosed address";
4416 else if (!testflag(addr, af_pfr) || addr->parent == NULL)
4417 printed = addr->address;
4421 uschar *s = addr->address;
4424 if (addr->address[0] == '>') { ss = US"mail"; s++; }
4425 else if (addr->address[0] == '|') ss = US"pipe";
4428 fprintf(f, "%s to %s%sgenerated by ", ss, s, sc);
4429 printed = addr->parent->address;
4432 fprintf(f, "%s", CS string_printing(printed));
4434 if (ancestor != addr)
4436 uschar *original = (ancestor->onetime_parent == NULL)?
4437 ancestor->address : ancestor->onetime_parent;
4438 if (strcmpic(original, printed) != 0)
4439 fprintf(f, "%s(%sgenerated from %s)", sc,
4440 (ancestor != addr->parent)? "ultimately " : "",
4441 string_printing(original));
4444 fprintf(f, "%s", CS se);
4452 /*************************************************
4453 * Print error for an address *
4454 *************************************************/
4456 /* This function is called to print the error information out of an address for
4457 a bounce or a warning message. It tries to format the message reasonably by
4458 introducing newlines. All lines are indented by 4; the initial printing
4459 position must be set before calling.
4461 This function used always to print the error. Nowadays we want to restrict it
4462 to cases such as LMTP/SMTP errors from a remote host, and errors from :fail:
4463 and filter "fail". We no longer pass other information willy-nilly in bounce
4464 and warning messages. Text in user_message is always output; text in message
4465 only if the af_pass_message flag is set.
4469 f the FILE to print on
4476 print_address_error(address_item *addr, FILE *f, uschar *t)
4478 int count = Ustrlen(t);
4479 uschar *s = testflag(addr, af_pass_message)? addr->message : NULL;
4483 if (addr->user_message != NULL) s = addr->user_message; else return;
4486 fprintf(f, "\n %s", t);
4490 if (*s == '\\' && s[1] == 'n')
4500 if (*s++ == ':' && isspace(*s) && count > 45)
4502 fprintf(f, "\n "); /* sic (because space follows) */
4514 /*************************************************
4515 * Check list of addresses for duplication *
4516 *************************************************/
4518 /* This function was introduced when the test for duplicate addresses that are
4519 not pipes, files, or autoreplies was moved from the middle of routing to when
4520 routing was complete. That was to fix obscure cases when the routing history
4521 affects the subsequent routing of identical addresses. This function is called
4522 after routing, to check that the final routed addresses are not duplicates.
4524 If we detect a duplicate, we remember what it is a duplicate of. Note that
4525 pipe, file, and autoreply de-duplication is handled during routing, so we must
4526 leave such "addresses" alone here, as otherwise they will incorrectly be
4529 Argument: address of list anchor
4534 do_duplicate_check(address_item **anchor)
4537 while ((addr = *anchor) != NULL)
4540 if (testflag(addr, af_pfr))
4542 anchor = &(addr->next);
4544 else if ((tnode = tree_search(tree_duplicates, addr->unique)) != NULL)
4546 DEBUG(D_deliver|D_route)
4547 debug_printf("%s is a duplicate address: discarded\n", addr->unique);
4548 *anchor = addr->next;
4549 addr->dupof = tnode->data.ptr;
4550 addr->next = addr_duplicate;
4551 addr_duplicate = addr;
4555 tree_add_duplicate(addr->unique, addr);
4556 anchor = &(addr->next);
4564 /*************************************************
4565 * Deliver one message *
4566 *************************************************/
4568 /* This is the function which is called when a message is to be delivered. It
4569 is passed the id of the message. It is possible that the message no longer
4570 exists, if some other process has delivered it, and it is also possible that
4571 the message is being worked on by another process, in which case the data file
4574 If no delivery is attempted for any of the above reasons, the function returns
4575 DELIVER_NOT_ATTEMPTED.
4577 If the give_up flag is set true, do not attempt any deliveries, but instead
4578 fail all outstanding addresses and return the message to the sender (or
4581 A delivery operation has a process all to itself; we never deliver more than
4582 one message in the same process. Therefore we needn't worry too much about
4586 id the id of the message to be delivered
4587 forced TRUE if delivery was forced by an administrator; this overrides
4588 retry delays and causes a delivery to be tried regardless
4589 give_up TRUE if an administrator has requested that delivery attempts
4592 Returns: When the global variable mua_wrapper is FALSE:
4593 DELIVER_ATTEMPTED_NORMAL if a delivery attempt was made
4594 DELIVER_NOT_ATTEMPTED otherwise (see comment above)
4595 When the global variable mua_wrapper is TRUE:
4596 DELIVER_MUA_SUCCEEDED if delivery succeeded
4597 DELIVER_MUA_FAILED if delivery failed
4598 DELIVER_NOT_ATTEMPTED if not attempted (should not occur)
4602 deliver_message(uschar *id, BOOL forced, BOOL give_up)
4605 int final_yield = DELIVER_ATTEMPTED_NORMAL;
4606 time_t now = time(NULL);
4607 address_item *addr_last = NULL;
4608 uschar *filter_message = NULL;
4610 int process_recipients = RECIP_ACCEPT;
4613 extern int acl_where;
4615 uschar *info = (queue_run_pid == (pid_t)0)?
4616 string_sprintf("delivering %s", id) :
4617 string_sprintf("delivering %s (queue run pid %d)", id, queue_run_pid);
4619 /* If the D_process_info bit is on, set_process_info() will output debugging
4620 information. If not, we want to show this initial information if D_deliver or
4621 D_queue_run is set or in verbose mode. */
4623 set_process_info("%s", info);
4625 if ((debug_selector & D_process_info) == 0 &&
4626 (debug_selector & (D_deliver|D_queue_run|D_v)) != 0)
4627 debug_printf("%s\n", info);
4629 /* Ensure that we catch any subprocesses that are created. Although Exim
4630 sets SIG_DFL as its initial default, some routes through the code end up
4631 here with it set to SIG_IGN - cases where a non-synchronous delivery process
4632 has been forked, but no re-exec has been done. We use sigaction rather than
4633 plain signal() on those OS where SA_NOCLDWAIT exists, because we want to be
4634 sure it is turned off. (There was a problem on AIX with this.) */
4638 struct sigaction act;
4639 act.sa_handler = SIG_DFL;
4640 sigemptyset(&(act.sa_mask));
4642 sigaction(SIGCHLD, &act, NULL);
4645 signal(SIGCHLD, SIG_DFL);
4648 /* Make the forcing flag available for routers and transports, set up the
4649 global message id field, and initialize the count for returned files and the
4650 message size. This use of strcpy() is OK because the length id is checked when
4651 it is obtained from a command line (the -M or -q options), and otherwise it is
4652 known to be a valid message id. */
4654 Ustrcpy(message_id, id);
4655 deliver_force = forced;
4659 /* Initialize some flags */
4661 update_spool = FALSE;
4662 remove_journal = TRUE;
4664 /* Set a known context for any ACLs we call via expansions */
4665 acl_where = ACL_WHERE_DELIVERY;
4667 /* Reset the random number generator, so that if several delivery processes are
4668 started from a queue runner that has already used random numbers (for sorting),
4669 they don't all get the same sequence. */
4673 /* Open and lock the message's data file. Exim locks on this one because the
4674 header file may get replaced as it is re-written during the delivery process.
4675 Any failures cause messages to be written to the log, except for missing files
4676 while queue running - another process probably completed delivery. As part of
4677 opening the data file, message_subdir gets set. */
4679 if (!spool_open_datafile(id))
4680 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
4682 /* The value of message_size at this point has been set to the data length,
4683 plus one for the blank line that notionally precedes the data. */
4685 /* Now read the contents of the header file, which will set up the headers in
4686 store, and also the list of recipients and the tree of non-recipients and
4687 assorted flags. It updates message_size. If there is a reading or format error,
4688 give up; if the message has been around for sufficiently long, remove it. */
4690 sprintf(CS spoolname, "%s-H", id);
4691 if ((rc = spool_read_header(spoolname, TRUE, TRUE)) != spool_read_OK)
4693 if (errno == ERRNO_SPOOLFORMAT)
4695 struct stat statbuf;
4696 sprintf(CS big_buffer, "%s/input/%s/%s", spool_directory, message_subdir,
4698 if (Ustat(big_buffer, &statbuf) == 0)
4699 log_write(0, LOG_MAIN, "Format error in spool file %s: "
4700 "size=" OFF_T_FMT, spoolname, statbuf.st_size);
4701 else log_write(0, LOG_MAIN, "Format error in spool file %s", spoolname);
4704 log_write(0, LOG_MAIN, "Error reading spool file %s: %s", spoolname,
4707 /* If we managed to read the envelope data, received_time contains the
4708 time the message was received. Otherwise, we can calculate it from the
4711 if (rc != spool_read_hdrerror)
4714 for (i = 0; i < 6; i++)
4715 received_time = received_time * BASE_62 + tab62[id[i] - '0'];
4718 /* If we've had this malformed message too long, sling it. */
4720 if (now - received_time > keep_malformed)
4722 sprintf(CS spoolname, "%s/msglog/%s/%s", spool_directory, message_subdir, id);
4724 sprintf(CS spoolname, "%s/input/%s/%s-D", spool_directory, message_subdir, id);
4726 sprintf(CS spoolname, "%s/input/%s/%s-H", spool_directory, message_subdir, id);
4728 sprintf(CS spoolname, "%s/input/%s/%s-J", spool_directory, message_subdir, id);
4730 log_write(0, LOG_MAIN, "Message removed because older than %s",
4731 readconf_printtime(keep_malformed));
4734 (void)close(deliver_datafile);
4735 deliver_datafile = -1;
4736 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
4739 /* The spool header file has been read. Look to see if there is an existing
4740 journal file for this message. If there is, it means that a previous delivery
4741 attempt crashed (program or host) before it could update the spool header file.
4742 Read the list of delivered addresses from the journal and add them to the
4743 nonrecipients tree. Then update the spool file. We can leave the journal in
4744 existence, as it will get further successful deliveries added to it in this
4745 run, and it will be deleted if this function gets to its end successfully.
4746 Otherwise it might be needed again. */
4748 sprintf(CS spoolname, "%s/input/%s/%s-J", spool_directory, message_subdir, id);
4749 jread = Ufopen(spoolname, "rb");
4752 while (Ufgets(big_buffer, big_buffer_size, jread) != NULL)
4754 int n = Ustrlen(big_buffer);
4755 big_buffer[n-1] = 0;
4756 tree_add_nonrecipient(big_buffer);
4757 DEBUG(D_deliver) debug_printf("Previously delivered address %s taken from "
4758 "journal file\n", big_buffer);
4760 (void)fclose(jread);
4761 /* Panic-dies on error */
4762 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
4764 else if (errno != ENOENT)
4766 log_write(0, LOG_MAIN|LOG_PANIC, "attempt to open journal for reading gave: "
4767 "%s", strerror(errno));
4768 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
4771 /* A null recipients list indicates some kind of disaster. */
4773 if (recipients_list == NULL)
4775 (void)close(deliver_datafile);
4776 deliver_datafile = -1;
4777 log_write(0, LOG_MAIN, "Spool error: no recipients for %s", spoolname);
4778 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
4782 /* Handle a message that is frozen. There are a number of different things that
4783 can happen, but in the default situation, unless forced, no delivery is
4788 #ifdef SUPPORT_MOVE_FROZEN_MESSAGES
4789 /* Moving to another directory removes the message from Exim's view. Other
4790 tools must be used to deal with it. Logging of this action happens in
4791 spool_move_message() and its subfunctions. */
4793 if (move_frozen_messages &&
4794 spool_move_message(id, message_subdir, US"", US"F"))
4795 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
4798 /* For all frozen messages (bounces or not), timeout_frozen_after sets the
4799 maximum time to keep messages that are frozen. Thaw if we reach it, with a
4800 flag causing all recipients to be failed. The time is the age of the
4801 message, not the time since freezing. */
4803 if (timeout_frozen_after > 0 && message_age >= timeout_frozen_after)
4805 log_write(0, LOG_MAIN, "cancelled by timeout_frozen_after");
4806 process_recipients = RECIP_FAIL_TIMEOUT;
4809 /* For bounce messages (and others with no sender), thaw if the error message
4810 ignore timer is exceeded. The message will be discarded if this delivery
4813 else if (sender_address[0] == 0 && message_age >= ignore_bounce_errors_after)
4815 log_write(0, LOG_MAIN, "Unfrozen by errmsg timer");
4818 /* If this is a bounce message, or there's no auto thaw, or we haven't
4819 reached the auto thaw time yet, and this delivery is not forced by an admin
4820 user, do not attempt delivery of this message. Note that forced is set for
4821 continuing messages down the same channel, in order to skip load checking and
4822 ignore hold domains, but we don't want unfreezing in that case. */
4826 if ((sender_address[0] == 0 ||
4828 now <= deliver_frozen_at + auto_thaw
4831 (!forced || !deliver_force_thaw || !admin_user ||
4832 continue_hostname != NULL
4835 (void)close(deliver_datafile);
4836 deliver_datafile = -1;
4837 log_write(L_skip_delivery, LOG_MAIN, "Message is frozen");
4838 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
4841 /* If delivery was forced (by an admin user), assume a manual thaw.
4842 Otherwise it's an auto thaw. */
4846 deliver_manual_thaw = TRUE;
4847 log_write(0, LOG_MAIN, "Unfrozen by forced delivery");
4849 else log_write(0, LOG_MAIN, "Unfrozen by auto-thaw");
4852 /* We get here if any of the rules for unfreezing have triggered. */
4854 deliver_freeze = FALSE;
4855 update_spool = TRUE;
4859 /* Open the message log file if we are using them. This records details of
4860 deliveries, deferments, and failures for the benefit of the mail administrator.
4861 The log is not used by exim itself to track the progress of a message; that is
4862 done by rewriting the header spool file. */
4869 sprintf(CS spoolname, "%s/msglog/%s/%s", spool_directory, message_subdir, id);
4870 fd = open_msglog_file(spoolname, SPOOL_MODE, &error);
4874 log_write(0, LOG_MAIN|LOG_PANIC, "Couldn't %s message log %s: %s", error,
4875 spoolname, strerror(errno));
4876 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
4879 /* Make a C stream out of it. */
4881 message_log = fdopen(fd, "a");
4882 if (message_log == NULL)
4884 log_write(0, LOG_MAIN|LOG_PANIC, "Couldn't fdopen message log %s: %s",
4885 spoolname, strerror(errno));
4886 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
4891 /* If asked to give up on a message, log who did it, and set the action for all
4896 struct passwd *pw = getpwuid(real_uid);
4897 log_write(0, LOG_MAIN, "cancelled by %s", (pw != NULL)?
4898 US pw->pw_name : string_sprintf("uid %ld", (long int)real_uid));
4899 process_recipients = RECIP_FAIL;
4902 /* Otherwise, if there are too many Received: headers, fail all recipients. */
4904 else if (received_count > received_headers_max)
4905 process_recipients = RECIP_FAIL_LOOP;
4907 /* Otherwise, if a system-wide, address-independent message filter is
4908 specified, run it now, except in the case when we are failing all recipients as
4909 a result of timeout_frozen_after. If the system filter yields "delivered", then
4910 ignore the true recipients of the message. Failure of the filter file is
4911 logged, and the delivery attempt fails. */
4913 else if (system_filter != NULL && process_recipients != RECIP_FAIL_TIMEOUT)
4918 redirect_block redirect;
4920 if (system_filter_uid_set)
4922 ugid.uid = system_filter_uid;
4923 ugid.gid = system_filter_gid;
4924 ugid.uid_set = ugid.gid_set = TRUE;
4928 ugid.uid_set = ugid.gid_set = FALSE;
4931 return_path = sender_address;
4932 enable_dollar_recipients = TRUE; /* Permit $recipients in system filter */
4933 system_filtering = TRUE;
4935 /* Any error in the filter file causes a delivery to be abandoned. */
4937 redirect.string = system_filter;
4938 redirect.isfile = TRUE;
4939 redirect.check_owner = redirect.check_group = FALSE;
4940 redirect.owners = NULL;
4941 redirect.owngroups = NULL;
4943 redirect.modemask = 0;
4945 DEBUG(D_deliver|D_filter) debug_printf("running system filter\n");
4948 &redirect, /* Where the data is */
4949 RDO_DEFER | /* Turn on all the enabling options */
4950 RDO_FAIL | /* Leave off all the disabling options */
4955 NULL, /* No :include: restriction (not used in filter) */
4956 NULL, /* No sieve vacation directory (not sieve!) */
4957 NULL, /* No sieve enotify mailto owner (not sieve!) */
4958 NULL, /* No sieve user address (not sieve!) */
4959 NULL, /* No sieve subaddress (not sieve!) */
4960 &ugid, /* uid/gid data */
4961 &addr_new, /* Where to hang generated addresses */
4962 &filter_message, /* Where to put error message */
4963 NULL, /* Don't skip syntax errors */
4964 &filtertype, /* Will always be set to FILTER_EXIM for this call */
4965 US"system filter"); /* For error messages */
4967 DEBUG(D_deliver|D_filter) debug_printf("system filter returned %d\n", rc);
4969 if (rc == FF_ERROR || rc == FF_NONEXIST)
4971 (void)close(deliver_datafile);
4972 deliver_datafile = -1;
4973 log_write(0, LOG_MAIN|LOG_PANIC, "Error in system filter: %s",
4974 string_printing(filter_message));
4975 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
4978 /* Reset things. If the filter message is an empty string, which can happen
4979 for a filter "fail" or "freeze" command with no text, reset it to NULL. */
4981 system_filtering = FALSE;
4982 enable_dollar_recipients = FALSE;
4983 if (filter_message != NULL && filter_message[0] == 0) filter_message = NULL;
4985 /* Save the values of the system filter variables so that user filters
4988 memcpy(filter_sn, filter_n, sizeof(filter_sn));
4990 /* The filter can request that delivery of the original addresses be
4995 process_recipients = RECIP_DEFER;
4996 deliver_msglog("Delivery deferred by system filter\n");
4997 log_write(0, LOG_MAIN, "Delivery deferred by system filter");
5000 /* The filter can request that a message be frozen, but this does not
5001 take place if the message has been manually thawed. In that case, we must
5002 unset "delivered", which is forced by the "freeze" command to make -bF
5005 else if (rc == FF_FREEZE && !deliver_manual_thaw)
5007 deliver_freeze = TRUE;
5008 deliver_frozen_at = time(NULL);
5009 process_recipients = RECIP_DEFER;
5010 frozen_info = string_sprintf(" by the system filter%s%s",
5011 (filter_message == NULL)? US"" : US": ",
5012 (filter_message == NULL)? US"" : filter_message);
5015 /* The filter can request that a message be failed. The error message may be
5016 quite long - it is sent back to the sender in the bounce - but we don't want
5017 to fill up the log with repetitions of it. If it starts with << then the text
5018 between << and >> is written to the log, with the rest left for the bounce
5021 else if (rc == FF_FAIL)
5023 uschar *colon = US"";
5024 uschar *logmsg = US"";
5027 process_recipients = RECIP_FAIL_FILTER;
5029 if (filter_message != NULL)
5033 if (filter_message[0] == '<' && filter_message[1] == '<' &&
5034 (logend = Ustrstr(filter_message, ">>")) != NULL)
5036 logmsg = filter_message + 2;
5037 loglen = logend - logmsg;
5038 filter_message = logend + 2;
5039 if (filter_message[0] == 0) filter_message = NULL;
5043 logmsg = filter_message;
5044 loglen = Ustrlen(filter_message);
5048 log_write(0, LOG_MAIN, "cancelled by system filter%s%.*s", colon, loglen,
5052 /* Delivery can be restricted only to those recipients (if any) that the
5053 filter specified. */
5055 else if (rc == FF_DELIVERED)
5057 process_recipients = RECIP_IGNORE;
5058 if (addr_new == NULL)
5059 log_write(0, LOG_MAIN, "=> discarded (system filter)");
5061 log_write(0, LOG_MAIN, "original recipients ignored (system filter)");
5064 /* If any new addresses were created by the filter, fake up a "parent"
5065 for them. This is necessary for pipes, etc., which are expected to have
5066 parents, and it also gives some sensible logging for others. Allow
5067 pipes, files, and autoreplies, and run them as the filter uid if set,
5068 otherwise as the current uid. */
5070 if (addr_new != NULL)
5072 int uid = (system_filter_uid_set)? system_filter_uid : geteuid();
5073 int gid = (system_filter_gid_set)? system_filter_gid : getegid();
5075 /* The text "system-filter" is tested in transport_set_up_command() and in
5076 set_up_shell_command() in the pipe transport, to enable them to permit
5077 $recipients, so don't change it here without also changing it there. */
5079 address_item *p = addr_new;
5080 address_item *parent = deliver_make_addr(US"system-filter", FALSE);
5082 parent->domain = string_copylc(qualify_domain_recipient);
5083 parent->local_part = US"system-filter";
5085 /* As part of this loop, we arrange for addr_last to end up pointing
5086 at the final address. This is used if we go on to add addresses for the
5087 original recipients. */
5091 if (parent->child_count == SHRT_MAX)
5092 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "system filter generated more "
5093 "than %d delivery addresses", SHRT_MAX);
5094 parent->child_count++;
5097 if (testflag(p, af_pfr))
5103 setflag(p, af_uid_set |
5109 /* Find the name of the system filter's appropriate pfr transport */
5111 if (p->address[0] == '|')
5114 tpname = system_filter_pipe_transport;
5115 address_pipe = p->address;
5117 else if (p->address[0] == '>')
5120 tpname = system_filter_reply_transport;
5124 if (p->address[Ustrlen(p->address)-1] == '/')
5126 type = US"directory";
5127 tpname = system_filter_directory_transport;
5132 tpname = system_filter_file_transport;
5134 address_file = p->address;
5137 /* Now find the actual transport, first expanding the name. We have
5138 set address_file or address_pipe above. */
5142 uschar *tmp = expand_string(tpname);
5143 address_file = address_pipe = NULL;
5145 p->message = string_sprintf("failed to expand \"%s\" as a "
5146 "system filter transport name", tpname);
5151 p->message = string_sprintf("system_filter_%s_transport is unset",
5157 transport_instance *tp;
5158 for (tp = transports; tp != NULL; tp = tp->next)
5160 if (Ustrcmp(tp->name, tpname) == 0)
5167 p->message = string_sprintf("failed to find \"%s\" transport "
5168 "for system filter delivery", tpname);
5171 /* If we couldn't set up a transport, defer the delivery, putting the
5172 error on the panic log as well as the main log. */
5174 if (p->transport == NULL)
5176 address_item *badp = p;
5178 if (addr_last == NULL) addr_new = p; else addr_last->next = p;
5179 badp->local_part = badp->address; /* Needed for log line */
5180 post_process_one(badp, DEFER, LOG_MAIN|LOG_PANIC, DTYPE_ROUTER, 0);
5183 } /* End of pfr handling */
5185 /* Either a non-pfr delivery, or we found a transport */
5187 DEBUG(D_deliver|D_filter)
5188 debug_printf("system filter added %s\n", p->address);
5192 } /* Loop through all addr_new addresses */
5197 /* Scan the recipients list, and for every one that is not in the non-
5198 recipients tree, add an addr item to the chain of new addresses. If the pno
5199 value is non-negative, we must set the onetime parent from it. This which
5200 points to the relevant entry in the recipients list.
5202 This processing can be altered by the setting of the process_recipients
5203 variable, which is changed if recipients are to be ignored, failed, or
5204 deferred. This can happen as a result of system filter activity, or if the -Mg
5205 option is used to fail all of them.
5207 Duplicate addresses are handled later by a different tree structure; we can't
5208 just extend the non-recipients tree, because that will be re-written to the
5209 spool if the message is deferred, and in any case there are casing
5210 complications for local addresses. */
5212 if (process_recipients != RECIP_IGNORE)
5214 for (i = 0; i < recipients_count; i++)
5216 if (tree_search(tree_nonrecipients, recipients_list[i].address) == NULL)
5218 recipient_item *r = recipients_list + i;
5219 address_item *new = deliver_make_addr(r->address, FALSE);
5220 new->p.errors_address = r->errors_to;
5223 new->onetime_parent = recipients_list[r->pno].address;
5225 switch (process_recipients)
5227 /* RECIP_DEFER is set when a system filter freezes a message. */
5230 new->next = addr_defer;
5235 /* RECIP_FAIL_FILTER is set when a system filter has obeyed a "fail"
5238 case RECIP_FAIL_FILTER:
5240 (filter_message == NULL)? US"delivery cancelled" : filter_message;
5241 setflag(new, af_pass_message);
5242 goto RECIP_QUEUE_FAILED; /* below */
5245 /* RECIP_FAIL_TIMEOUT is set when a message is frozen, but is older
5246 than the value in timeout_frozen_after. Treat non-bounce messages
5247 similarly to -Mg; for bounce messages we just want to discard, so
5248 don't put the address on the failed list. The timeout has already
5251 case RECIP_FAIL_TIMEOUT:
5252 new->message = US"delivery cancelled; message timed out";
5253 goto RECIP_QUEUE_FAILED; /* below */
5256 /* RECIP_FAIL is set when -Mg has been used. */
5259 new->message = US"delivery cancelled by administrator";
5262 /* Common code for the failure cases above. If this is not a bounce
5263 message, put the address on the failed list so that it is used to
5264 create a bounce. Otherwise do nothing - this just discards the address.
5265 The incident has already been logged. */
5268 if (sender_address[0] != 0)
5270 new->next = addr_failed;
5276 /* RECIP_FAIL_LOOP is set when there are too many Received: headers
5277 in the message. Process each address as a routing failure; if this
5278 is a bounce message, it will get frozen. */
5280 case RECIP_FAIL_LOOP:
5281 new->message = US"Too many \"Received\" headers - suspected mail loop";
5282 post_process_one(new, FAIL, LOG_MAIN, DTYPE_ROUTER, 0);
5286 /* Value should be RECIP_ACCEPT; take this as the safe default. */
5289 if (addr_new == NULL) addr_new = new; else addr_last->next = new;
5299 address_item *p = addr_new;
5300 debug_printf("Delivery address list:\n");
5303 debug_printf(" %s %s\n", p->address, (p->onetime_parent == NULL)? US"" :
5309 /* Set up the buffers used for copying over the file when delivering. */
5311 deliver_in_buffer = store_malloc(DELIVER_IN_BUFFER_SIZE);
5312 deliver_out_buffer = store_malloc(DELIVER_OUT_BUFFER_SIZE);
5316 /* Until there are no more new addresses, handle each one as follows:
5318 . If this is a generated address (indicated by the presence of a parent
5319 pointer) then check to see whether it is a pipe, file, or autoreply, and
5320 if so, handle it directly here. The router that produced the address will
5321 have set the allow flags into the address, and also set the uid/gid required.
5322 Having the routers generate new addresses and then checking them here at
5323 the outer level is tidier than making each router do the checking, and
5324 means that routers don't need access to the failed address queue.
5326 . Break up the address into local part and domain, and make lowercased
5327 versions of these strings. We also make unquoted versions of the local part.
5329 . Handle the percent hack for those domains for which it is valid.
5331 . For child addresses, determine if any of the parents have the same address.
5332 If so, generate a different string for previous delivery checking. Without
5333 this code, if the address spqr generates spqr via a forward or alias file,
5334 delivery of the generated spqr stops further attempts at the top level spqr,
5335 which is not what is wanted - it may have generated other addresses.
5337 . Check on the retry database to see if routing was previously deferred, but
5338 only if in a queue run. Addresses that are to be routed are put on the
5339 addr_route chain. Addresses that are to be deferred are put on the
5340 addr_defer chain. We do all the checking first, so as not to keep the
5341 retry database open any longer than necessary.
5343 . Now we run the addresses through the routers. A router may put the address
5344 on either the addr_local or the addr_remote chain for local or remote
5345 delivery, respectively, or put it on the addr_failed chain if it is
5346 undeliveable, or it may generate child addresses and put them on the
5347 addr_new chain, or it may defer an address. All the chain anchors are
5348 passed as arguments so that the routers can be called for verification
5351 . If new addresses have been generated by the routers, da capo.
5354 header_rewritten = FALSE; /* No headers rewritten yet */
5355 while (addr_new != NULL) /* Loop until all addresses dealt with */
5357 address_item *addr, *parent;
5358 dbm_file = dbfn_open(US"retry", O_RDONLY, &dbblock, FALSE);
5360 /* Failure to open the retry database is treated the same as if it does
5361 not exist. In both cases, dbm_file is NULL. */
5363 if (dbm_file == NULL)
5365 DEBUG(D_deliver|D_retry|D_route|D_hints_lookup)
5366 debug_printf("no retry data available\n");
5369 /* Scan the current batch of new addresses, to handle pipes, files and
5370 autoreplies, and determine which others are ready for routing. */
5372 while (addr_new != NULL)
5377 dbdata_retry *domain_retry_record;
5378 dbdata_retry *address_retry_record;
5381 addr_new = addr->next;
5383 DEBUG(D_deliver|D_retry|D_route)
5385 debug_printf(">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>\n");
5386 debug_printf("Considering: %s\n", addr->address);
5389 /* Handle generated address that is a pipe or a file or an autoreply. */
5391 if (testflag(addr, af_pfr))
5393 /* If an autoreply in a filter could not generate a syntactically valid
5394 address, give up forthwith. Set af_ignore_error so that we don't try to
5395 generate a bounce. */
5397 if (testflag(addr, af_bad_reply))
5399 addr->basic_errno = ERRNO_BADADDRESS2;
5400 addr->local_part = addr->address;
5402 US"filter autoreply generated syntactically invalid recipient";
5403 setflag(addr, af_ignore_error);
5404 (void)post_process_one(addr, FAIL, LOG_MAIN, DTYPE_ROUTER, 0);
5405 continue; /* with the next new address */
5408 /* If two different users specify delivery to the same pipe or file or
5409 autoreply, there should be two different deliveries, so build a unique
5410 string that incorporates the original address, and use this for
5411 duplicate testing and recording delivery, and also for retrying. */
5414 string_sprintf("%s:%s", addr->address, addr->parent->unique +
5415 (testflag(addr->parent, af_homonym)? 3:0));
5417 addr->address_retry_key = addr->domain_retry_key =
5418 string_sprintf("T:%s", addr->unique);
5420 /* If a filter file specifies two deliveries to the same pipe or file,
5421 we want to de-duplicate, but this is probably not wanted for two mail
5422 commands to the same address, where probably both should be delivered.
5423 So, we have to invent a different unique string in that case. Just
5424 keep piling '>' characters on the front. */
5426 if (addr->address[0] == '>')
5428 while (tree_search(tree_duplicates, addr->unique) != NULL)
5429 addr->unique = string_sprintf(">%s", addr->unique);
5432 else if ((tnode = tree_search(tree_duplicates, addr->unique)) != NULL)
5434 DEBUG(D_deliver|D_route)
5435 debug_printf("%s is a duplicate address: discarded\n", addr->address);
5436 addr->dupof = tnode->data.ptr;
5437 addr->next = addr_duplicate;
5438 addr_duplicate = addr;
5442 DEBUG(D_deliver|D_route) debug_printf("unique = %s\n", addr->unique);
5444 /* Check for previous delivery */
5446 if (tree_search(tree_nonrecipients, addr->unique) != NULL)
5448 DEBUG(D_deliver|D_route)
5449 debug_printf("%s was previously delivered: discarded\n", addr->address);
5450 child_done(addr, tod_stamp(tod_log));
5454 /* Save for checking future duplicates */
5456 tree_add_duplicate(addr->unique, addr);
5458 /* Set local part and domain */
5460 addr->local_part = addr->address;
5461 addr->domain = addr->parent->domain;
5463 /* Ensure that the delivery is permitted. */
5465 if (testflag(addr, af_file))
5467 if (!testflag(addr, af_allow_file))
5469 addr->basic_errno = ERRNO_FORBIDFILE;
5470 addr->message = US"delivery to file forbidden";
5471 (void)post_process_one(addr, FAIL, LOG_MAIN, DTYPE_ROUTER, 0);
5472 continue; /* with the next new address */
5475 else if (addr->address[0] == '|')
5477 if (!testflag(addr, af_allow_pipe))
5479 addr->basic_errno = ERRNO_FORBIDPIPE;
5480 addr->message = US"delivery to pipe forbidden";
5481 (void)post_process_one(addr, FAIL, LOG_MAIN, DTYPE_ROUTER, 0);
5482 continue; /* with the next new address */
5485 else if (!testflag(addr, af_allow_reply))
5487 addr->basic_errno = ERRNO_FORBIDREPLY;
5488 addr->message = US"autoreply forbidden";
5489 (void)post_process_one(addr, FAIL, LOG_MAIN, DTYPE_ROUTER, 0);
5490 continue; /* with the next new address */
5493 /* If the errno field is already set to BADTRANSPORT, it indicates
5494 failure to expand a transport string, or find the associated transport,
5495 or an unset transport when one is required. Leave this test till now so
5496 that the forbid errors are given in preference. */
5498 if (addr->basic_errno == ERRNO_BADTRANSPORT)
5500 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_ROUTER, 0);
5504 /* Treat /dev/null as a special case and abandon the delivery. This
5505 avoids having to specify a uid on the transport just for this case.
5506 Arrange for the transport name to be logged as "**bypassed**". */
5508 if (Ustrcmp(addr->address, "/dev/null") == 0)
5510 uschar *save = addr->transport->name;
5511 addr->transport->name = US"**bypassed**";
5512 (void)post_process_one(addr, OK, LOG_MAIN, DTYPE_TRANSPORT, '=');
5513 addr->transport->name = save;
5514 continue; /* with the next new address */
5517 /* Pipe, file, or autoreply delivery is to go ahead as a normal local
5520 DEBUG(D_deliver|D_route)
5521 debug_printf("queued for %s transport\n", addr->transport->name);
5522 addr->next = addr_local;
5524 continue; /* with the next new address */
5527 /* Handle normal addresses. First, split up into local part and domain,
5528 handling the %-hack if necessary. There is the possibility of a defer from
5529 a lookup in percent_hack_domains. */
5531 if ((rc = deliver_split_address(addr)) == DEFER)
5533 addr->message = US"cannot check percent_hack_domains";
5534 addr->basic_errno = ERRNO_LISTDEFER;
5535 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_NONE, 0);
5539 /* Check to see if the domain is held. If so, proceed only if the
5540 delivery was forced by hand. */
5542 deliver_domain = addr->domain; /* set $domain */
5543 if (!forced && hold_domains != NULL &&
5544 (rc = match_isinlist(addr->domain, &hold_domains, 0,
5545 &domainlist_anchor, addr->domain_cache, MCL_DOMAIN, TRUE,
5550 addr->message = US"hold_domains lookup deferred";
5551 addr->basic_errno = ERRNO_LISTDEFER;
5555 addr->message = US"domain is held";
5556 addr->basic_errno = ERRNO_HELD;
5558 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_NONE, 0);
5562 /* Now we can check for duplicates and previously delivered addresses. In
5563 order to do this, we have to generate a "unique" value for each address,
5564 because there may be identical actual addresses in a line of descendents.
5565 The "unique" field is initialized to the same value as the "address" field,
5566 but gets changed here to cope with identically-named descendents. */
5568 for (parent = addr->parent; parent != NULL; parent = parent->parent)
5569 if (strcmpic(addr->address, parent->address) == 0) break;
5571 /* If there's an ancestor with the same name, set the homonym flag. This
5572 influences how deliveries are recorded. Then add a prefix on the front of
5573 the unique address. We use \n\ where n starts at 0 and increases each time.
5574 It is unlikely to pass 9, but if it does, it may look odd but will still
5575 work. This means that siblings or cousins with the same names are treated
5576 as duplicates, which is what we want. */
5580 setflag(addr, af_homonym);
5581 if (parent->unique[0] != '\\')
5582 addr->unique = string_sprintf("\\0\\%s", addr->address);
5584 addr->unique = string_sprintf("\\%c\\%s", parent->unique[1] + 1,
5588 /* Ensure that the domain in the unique field is lower cased, because
5589 domains are always handled caselessly. */
5591 p = Ustrrchr(addr->unique, '@');
5592 while (*p != 0) { *p = tolower(*p); p++; }
5594 DEBUG(D_deliver|D_route) debug_printf("unique = %s\n", addr->unique);
5596 if (tree_search(tree_nonrecipients, addr->unique) != NULL)
5598 DEBUG(D_deliver|D_route)
5599 debug_printf("%s was previously delivered: discarded\n", addr->unique);
5600 child_done(addr, tod_stamp(tod_log));
5604 /* Get the routing retry status, saving the two retry keys (with and
5605 without the local part) for subsequent use. If there is no retry record for
5606 the standard address routing retry key, we look for the same key with the
5607 sender attached, because this form is used by the smtp transport after a
5608 4xx response to RCPT when address_retry_include_sender is true. */
5610 addr->domain_retry_key = string_sprintf("R:%s", addr->domain);
5611 addr->address_retry_key = string_sprintf("R:%s@%s", addr->local_part,
5614 if (dbm_file == NULL)
5615 domain_retry_record = address_retry_record = NULL;
5618 domain_retry_record = dbfn_read(dbm_file, addr->domain_retry_key);
5619 if (domain_retry_record != NULL &&
5620 now - domain_retry_record->time_stamp > retry_data_expire)
5621 domain_retry_record = NULL; /* Ignore if too old */
5623 address_retry_record = dbfn_read(dbm_file, addr->address_retry_key);
5624 if (address_retry_record != NULL &&
5625 now - address_retry_record->time_stamp > retry_data_expire)
5626 address_retry_record = NULL; /* Ignore if too old */
5628 if (address_retry_record == NULL)
5630 uschar *altkey = string_sprintf("%s:<%s>", addr->address_retry_key,
5632 address_retry_record = dbfn_read(dbm_file, altkey);
5633 if (address_retry_record != NULL &&
5634 now - address_retry_record->time_stamp > retry_data_expire)
5635 address_retry_record = NULL; /* Ignore if too old */
5639 DEBUG(D_deliver|D_retry)
5641 if (domain_retry_record == NULL)
5642 debug_printf("no domain retry record\n");
5643 if (address_retry_record == NULL)
5644 debug_printf("no address retry record\n");
5647 /* If we are sending a message down an existing SMTP connection, we must
5648 assume that the message which created the connection managed to route
5649 an address to that connection. We do not want to run the risk of taking
5650 a long time over routing here, because if we do, the server at the other
5651 end of the connection may time it out. This is especially true for messages
5652 with lots of addresses. For this kind of delivery, queue_running is not
5653 set, so we would normally route all addresses. We take a pragmatic approach
5654 and defer routing any addresses that have any kind of domain retry record.
5655 That is, we don't even look at their retry times. It doesn't matter if this
5656 doesn't work occasionally. This is all just an optimization, after all.
5658 The reason for not doing the same for address retries is that they normally
5659 arise from 4xx responses, not DNS timeouts. */
5661 if (continue_hostname != NULL && domain_retry_record != NULL)
5663 addr->message = US"reusing SMTP connection skips previous routing defer";
5664 addr->basic_errno = ERRNO_RRETRY;
5665 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_ROUTER, 0);
5668 /* If we are in a queue run, defer routing unless there is no retry data or
5669 we've passed the next retry time, or this message is forced. In other
5670 words, ignore retry data when not in a queue run.
5672 However, if the domain retry time has expired, always allow the routing
5673 attempt. If it fails again, the address will be failed. This ensures that
5674 each address is routed at least once, even after long-term routing
5677 If there is an address retry, check that too; just wait for the next
5678 retry time. This helps with the case when the temporary error on the
5679 address was really message-specific rather than address specific, since
5680 it allows other messages through.
5682 We also wait for the next retry time if this is a message sent down an
5683 existing SMTP connection (even though that will be forced). Otherwise there
5684 will be far too many attempts for an address that gets a 4xx error. In
5685 fact, after such an error, we should not get here because, the host should
5686 not be remembered as one this message needs. However, there was a bug that
5687 used to cause this to happen, so it is best to be on the safe side.
5689 Even if we haven't reached the retry time in the hints, there is one more
5690 check to do, which is for the ultimate address timeout. We only do this
5691 check if there is an address retry record and there is not a domain retry
5692 record; this implies that previous attempts to handle the address had the
5693 retry_use_local_parts option turned on. We use this as an approximation
5694 for the destination being like a local delivery, for example delivery over
5695 LMTP to an IMAP message store. In this situation users are liable to bump
5696 into their quota and thereby have intermittently successful deliveries,
5697 which keep the retry record fresh, which can lead to us perpetually
5698 deferring messages. */
5700 else if (((queue_running && !deliver_force) || continue_hostname != NULL)
5702 ((domain_retry_record != NULL &&
5703 now < domain_retry_record->next_try &&
5704 !domain_retry_record->expired)
5706 (address_retry_record != NULL &&
5707 now < address_retry_record->next_try))
5709 (domain_retry_record != NULL ||
5710 address_retry_record == NULL ||
5711 !retry_ultimate_address_timeout(addr->address_retry_key,
5712 addr->domain, address_retry_record, now)))
5714 addr->message = US"retry time not reached";
5715 addr->basic_errno = ERRNO_RRETRY;
5716 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_ROUTER, 0);
5719 /* The domain is OK for routing. Remember if retry data exists so it
5720 can be cleaned up after a successful delivery. */
5724 if (domain_retry_record != NULL || address_retry_record != NULL)
5725 setflag(addr, af_dr_retry_exists);
5726 addr->next = addr_route;
5728 DEBUG(D_deliver|D_route)
5729 debug_printf("%s: queued for routing\n", addr->address);
5733 /* The database is closed while routing is actually happening. Requests to
5734 update it are put on a chain and all processed together at the end. */
5736 if (dbm_file != NULL) dbfn_close(dbm_file);
5738 /* If queue_domains is set, we don't even want to try routing addresses in
5739 those domains. During queue runs, queue_domains is forced to be unset.
5740 Optimize by skipping this pass through the addresses if nothing is set. */
5742 if (!deliver_force && queue_domains != NULL)
5744 address_item *okaddr = NULL;
5745 while (addr_route != NULL)
5747 address_item *addr = addr_route;
5748 addr_route = addr->next;
5750 deliver_domain = addr->domain; /* set $domain */
5751 if ((rc = match_isinlist(addr->domain, &queue_domains, 0,
5752 &domainlist_anchor, addr->domain_cache, MCL_DOMAIN, TRUE, NULL))
5757 addr->basic_errno = ERRNO_LISTDEFER;
5758 addr->message = US"queue_domains lookup deferred";
5759 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_ROUTER, 0);
5763 addr->next = okaddr;
5769 addr->basic_errno = ERRNO_QUEUE_DOMAIN;
5770 addr->message = US"domain is in queue_domains";
5771 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_ROUTER, 0);
5775 addr_route = okaddr;
5778 /* Now route those addresses that are not deferred. */
5780 while (addr_route != NULL)
5783 address_item *addr = addr_route;
5784 uschar *old_domain = addr->domain;
5785 uschar *old_unique = addr->unique;
5786 addr_route = addr->next;
5789 /* Just in case some router parameter refers to it. */
5791 return_path = (addr->p.errors_address != NULL)?
5792 addr->p.errors_address : sender_address;
5794 /* If a router defers an address, add a retry item. Whether or not to
5795 use the local part in the key is a property of the router. */
5797 if ((rc = route_address(addr, &addr_local, &addr_remote, &addr_new,
5798 &addr_succeed, v_none)) == DEFER)
5799 retry_add_item(addr, (addr->router->retry_use_local_part)?
5800 string_sprintf("R:%s@%s", addr->local_part, addr->domain) :
5801 string_sprintf("R:%s", addr->domain), 0);
5803 /* Otherwise, if there is an existing retry record in the database, add
5804 retry items to delete both forms. We must also allow for the possibility
5805 of a routing retry that includes the sender address. Since the domain might
5806 have been rewritten (expanded to fully qualified) as a result of routing,
5807 ensure that the rewritten form is also deleted. */
5809 else if (testflag(addr, af_dr_retry_exists))
5811 uschar *altkey = string_sprintf("%s:<%s>", addr->address_retry_key,
5813 retry_add_item(addr, altkey, rf_delete);
5814 retry_add_item(addr, addr->address_retry_key, rf_delete);
5815 retry_add_item(addr, addr->domain_retry_key, rf_delete);
5816 if (Ustrcmp(addr->domain, old_domain) != 0)
5817 retry_add_item(addr, string_sprintf("R:%s", old_domain), rf_delete);
5820 /* DISCARD is given for :blackhole: and "seen finish". The event has been
5821 logged, but we need to ensure the address (and maybe parents) is marked
5826 address_done(addr, tod_stamp(tod_log));
5827 continue; /* route next address */
5830 /* The address is finished with (failed or deferred). */
5834 (void)post_process_one(addr, rc, LOG_MAIN, DTYPE_ROUTER, 0);
5835 continue; /* route next address */
5838 /* The address has been routed. If the router changed the domain, it will
5839 also have changed the unique address. We have to test whether this address
5840 has already been delivered, because it's the unique address that finally
5843 if (addr->unique != old_unique &&
5844 tree_search(tree_nonrecipients, addr->unique) != 0)
5846 DEBUG(D_deliver|D_route) debug_printf("%s was previously delivered: "
5847 "discarded\n", addr->address);
5848 if (addr_remote == addr) addr_remote = addr->next;
5849 else if (addr_local == addr) addr_local = addr->next;
5852 /* If the router has same_domain_copy_routing set, we are permitted to copy
5853 the routing for any other addresses with the same domain. This is an
5854 optimisation to save repeated DNS lookups for "standard" remote domain
5855 routing. The option is settable only on routers that generate host lists.
5856 We play it very safe, and do the optimization only if the address is routed
5857 to a remote transport, there are no header changes, and the domain was not
5858 modified by the router. */
5860 if (addr_remote == addr &&
5861 addr->router->same_domain_copy_routing &&
5862 addr->p.extra_headers == NULL &&
5863 addr->p.remove_headers == NULL &&
5864 old_domain == addr->domain)
5866 address_item **chain = &addr_route;
5867 while (*chain != NULL)
5869 address_item *addr2 = *chain;
5870 if (Ustrcmp(addr2->domain, addr->domain) != 0)
5872 chain = &(addr2->next);
5876 /* Found a suitable address; take it off the routing list and add it to
5877 the remote delivery list. */
5879 *chain = addr2->next;
5880 addr2->next = addr_remote;
5881 addr_remote = addr2;
5883 /* Copy the routing data */
5885 addr2->domain = addr->domain;
5886 addr2->router = addr->router;
5887 addr2->transport = addr->transport;
5888 addr2->host_list = addr->host_list;
5889 addr2->fallback_hosts = addr->fallback_hosts;
5890 addr2->p.errors_address = addr->p.errors_address;
5891 copyflag(addr2, addr, af_hide_child | af_local_host_removed);
5893 DEBUG(D_deliver|D_route)
5895 debug_printf(">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>\n"
5897 "Routing for %s copied from %s\n",
5898 addr2->address, addr2->address, addr->address);
5902 } /* Continue with routing the next address. */
5903 } /* Loop to process any child addresses that the routers created, and
5904 any rerouted addresses that got put back on the new chain. */
5907 /* Debugging: show the results of the routing */
5909 DEBUG(D_deliver|D_retry|D_route)
5911 address_item *p = addr_local;
5912 debug_printf(">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>\n");
5913 debug_printf("After routing:\n Local deliveries:\n");
5916 debug_printf(" %s\n", p->address);
5921 debug_printf(" Remote deliveries:\n");
5924 debug_printf(" %s\n", p->address);
5929 debug_printf(" Failed addresses:\n");
5932 debug_printf(" %s\n", p->address);
5937 debug_printf(" Deferred addresses:\n");
5940 debug_printf(" %s\n", p->address);
5945 /* Free any resources that were cached during routing. */
5950 /* These two variables are set only during routing, after check_local_user.
5951 Ensure they are not set in transports. */
5953 local_user_gid = (gid_t)(-1);
5954 local_user_uid = (uid_t)(-1);
5956 /* Check for any duplicate addresses. This check is delayed until after
5957 routing, because the flexibility of the routing configuration means that
5958 identical addresses with different parentage may end up being redirected to
5959 different addresses. Checking for duplicates too early (as we previously used
5960 to) makes this kind of thing not work. */
5962 do_duplicate_check(&addr_local);
5963 do_duplicate_check(&addr_remote);
5965 /* When acting as an MUA wrapper, we proceed only if all addresses route to a
5966 remote transport. The check that they all end up in one transaction happens in
5967 the do_remote_deliveries() function. */
5969 if (mua_wrapper && (addr_local != NULL || addr_failed != NULL ||
5970 addr_defer != NULL))
5973 uschar *which, *colon, *msg;
5975 if (addr_local != NULL)
5980 else if (addr_defer != NULL)
5983 which = US"deferred";
5991 while (addr->parent != NULL) addr = addr->parent;
5993 if (addr->message != NULL)
5996 msg = addr->message;
5998 else colon = msg = US"";
6000 /* We don't need to log here for a forced failure as it will already
6001 have been logged. Defer will also have been logged, but as a defer, so we do
6002 need to do the failure logging. */
6004 if (addr != addr_failed)
6005 log_write(0, LOG_MAIN, "** %s routing yielded a %s delivery",
6006 addr->address, which);
6008 /* Always write an error to the caller */
6010 fprintf(stderr, "routing %s yielded a %s delivery%s%s\n", addr->address,
6013 final_yield = DELIVER_MUA_FAILED;
6014 addr_failed = addr_defer = NULL; /* So that we remove the message */
6015 goto DELIVERY_TIDYUP;
6019 /* If this is a run to continue deliveries to an external channel that is
6020 already set up, defer any local deliveries. */
6022 if (continue_transport != NULL)
6024 if (addr_defer == NULL) addr_defer = addr_local; else
6026 address_item *addr = addr_defer;
6027 while (addr->next != NULL) addr = addr->next;
6028 addr->next = addr_local;
6034 /* Because address rewriting can happen in the routers, we should not really do
6035 ANY deliveries until all addresses have been routed, so that all recipients of
6036 the message get the same headers. However, this is in practice not always
6037 possible, since sometimes remote addresses give DNS timeouts for days on end.
6038 The pragmatic approach is to deliver what we can now, saving any rewritten
6039 headers so that at least the next lot of recipients benefit from the rewriting
6040 that has already been done.
6042 If any headers have been rewritten during routing, update the spool file to
6043 remember them for all subsequent deliveries. This can be delayed till later if
6044 there is only address to be delivered - if it succeeds the spool write need not
6047 if (header_rewritten &&
6048 ((addr_local != NULL &&
6049 (addr_local->next != NULL || addr_remote != NULL)) ||
6050 (addr_remote != NULL && addr_remote->next != NULL)))
6052 /* Panic-dies on error */
6053 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
6054 header_rewritten = FALSE;
6058 /* If there are any deliveries to be done, open the journal file. This is used
6059 to record successful deliveries as soon as possible after each delivery is
6060 known to be complete. A file opened with O_APPEND is used so that several
6061 processes can run simultaneously.
6063 The journal is just insurance against crashes. When the spool file is
6064 ultimately updated at the end of processing, the journal is deleted. If a
6065 journal is found to exist at the start of delivery, the addresses listed
6066 therein are added to the non-recipients. */
6068 if (addr_local != NULL || addr_remote != NULL)
6070 sprintf(CS spoolname, "%s/input/%s/%s-J", spool_directory, message_subdir, id);
6071 journal_fd = Uopen(spoolname, O_WRONLY|O_APPEND|O_CREAT, SPOOL_MODE);
6075 log_write(0, LOG_MAIN|LOG_PANIC, "Couldn't open journal file %s: %s",
6076 spoolname, strerror(errno));
6077 return DELIVER_NOT_ATTEMPTED;
6080 /* Set the close-on-exec flag, make the file owned by Exim, and ensure
6081 that the mode is correct - the group setting doesn't always seem to get
6082 set automatically. */
6084 if( fcntl(journal_fd, F_SETFD, fcntl(journal_fd, F_GETFD) | FD_CLOEXEC)
6085 || fchown(journal_fd, exim_uid, exim_gid)
6086 || fchmod(journal_fd, SPOOL_MODE)
6089 int ret = Uunlink(spoolname);
6090 log_write(0, LOG_MAIN|LOG_PANIC, "Couldn't set perms on journal file %s: %s",
6091 spoolname, strerror(errno));
6092 if(ret && errno != ENOENT)
6093 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s",
6094 spoolname, strerror(errno));
6095 return DELIVER_NOT_ATTEMPTED;
6101 /* Now we can get down to the business of actually doing deliveries. Local
6102 deliveries are done first, then remote ones. If ever the problems of how to
6103 handle fallback transports are figured out, this section can be put into a loop
6104 for handling fallbacks, though the uid switching will have to be revised. */
6106 /* Precompile a regex that is used to recognize a parameter in response
6107 to an LHLO command, if is isn't already compiled. This may be used on both
6108 local and remote LMTP deliveries. */
6110 if (regex_IGNOREQUOTA == NULL) regex_IGNOREQUOTA =
6111 regex_must_compile(US"\\n250[\\s\\-]IGNOREQUOTA(\\s|\\n|$)", FALSE, TRUE);
6113 /* Handle local deliveries */
6115 if (addr_local != NULL)
6117 DEBUG(D_deliver|D_transport)
6118 debug_printf(">>>>>>>>>>>>>>>> Local deliveries >>>>>>>>>>>>>>>>\n");
6119 do_local_deliveries();
6120 disable_logging = FALSE;
6123 /* If queue_run_local is set, we do not want to attempt any remote deliveries,
6124 so just queue them all. */
6126 if (queue_run_local)
6128 while (addr_remote != NULL)
6130 address_item *addr = addr_remote;
6131 addr_remote = addr->next;
6133 addr->basic_errno = ERRNO_LOCAL_ONLY;
6134 addr->message = US"remote deliveries suppressed";
6135 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_TRANSPORT, 0);
6139 /* Handle remote deliveries */
6141 if (addr_remote != NULL)
6143 DEBUG(D_deliver|D_transport)
6144 debug_printf(">>>>>>>>>>>>>>>> Remote deliveries >>>>>>>>>>>>>>>>\n");
6146 /* Precompile some regex that are used to recognize parameters in response
6147 to an EHLO command, if they aren't already compiled. */
6149 if (regex_PIPELINING == NULL) regex_PIPELINING =
6150 regex_must_compile(US"\\n250[\\s\\-]PIPELINING(\\s|\\n|$)", FALSE, TRUE);
6152 if (regex_SIZE == NULL) regex_SIZE =
6153 regex_must_compile(US"\\n250[\\s\\-]SIZE(\\s|\\n|$)", FALSE, TRUE);
6155 if (regex_AUTH == NULL) regex_AUTH =
6156 regex_must_compile(US"\\n250[\\s\\-]AUTH\\s+([\\-\\w\\s]+)(?:\\n|$)",
6160 if (regex_STARTTLS == NULL) regex_STARTTLS =
6161 regex_must_compile(US"\\n250[\\s\\-]STARTTLS(\\s|\\n|$)", FALSE, TRUE);
6164 #ifdef EXPERIMENTAL_PRDR
6165 if (regex_PRDR == NULL) regex_PRDR =
6166 regex_must_compile(US"\\n250[\\s\\-]PRDR(\\s|\\n|$)", FALSE, TRUE);
6169 /* Now sort the addresses if required, and do the deliveries. The yield of
6170 do_remote_deliveries is FALSE when mua_wrapper is set and all addresses
6171 cannot be delivered in one transaction. */
6173 if (remote_sort_domains != NULL) sort_remote_deliveries();
6174 if (!do_remote_deliveries(FALSE))
6176 log_write(0, LOG_MAIN, "** mua_wrapper is set but recipients cannot all "
6177 "be delivered in one transaction");
6178 fprintf(stderr, "delivery to smarthost failed (configuration problem)\n");
6180 final_yield = DELIVER_MUA_FAILED;
6181 addr_failed = addr_defer = NULL; /* So that we remove the message */
6182 goto DELIVERY_TIDYUP;
6185 /* See if any of the addresses that failed got put on the queue for delivery
6186 to their fallback hosts. We do it this way because often the same fallback
6187 host is used for many domains, so all can be sent in a single transaction
6188 (if appropriately configured). */
6190 if (addr_fallback != NULL && !mua_wrapper)
6192 DEBUG(D_deliver) debug_printf("Delivering to fallback hosts\n");
6193 addr_remote = addr_fallback;
6194 addr_fallback = NULL;
6195 if (remote_sort_domains != NULL) sort_remote_deliveries();
6196 do_remote_deliveries(TRUE);
6198 disable_logging = FALSE;
6202 /* All deliveries are now complete. Ignore SIGTERM during this tidying up
6203 phase, to minimize cases of half-done things. */
6206 debug_printf(">>>>>>>>>>>>>>>> deliveries are done >>>>>>>>>>>>>>>>\n");
6208 /* Root privilege is no longer needed */
6210 exim_setugid(exim_uid, exim_gid, FALSE, US"post-delivery tidying");
6212 set_process_info("tidying up after delivering %s", message_id);
6213 signal(SIGTERM, SIG_IGN);
6215 /* When we are acting as an MUA wrapper, the smtp transport will either have
6216 succeeded for all addresses, or failed them all in normal cases. However, there
6217 are some setup situations (e.g. when a named port does not exist) that cause an
6218 immediate exit with deferral of all addresses. Convert those into failures. We
6219 do not ever want to retry, nor do we want to send a bounce message. */
6223 if (addr_defer != NULL)
6225 address_item *addr, *nextaddr;
6226 for (addr = addr_defer; addr != NULL; addr = nextaddr)
6228 log_write(0, LOG_MAIN, "** %s mua_wrapper forced failure for deferred "
6229 "delivery", addr->address);
6230 nextaddr = addr->next;
6231 addr->next = addr_failed;
6237 /* Now all should either have succeeded or failed. */
6239 if (addr_failed == NULL) final_yield = DELIVER_MUA_SUCCEEDED; else
6241 uschar *s = (addr_failed->user_message != NULL)?
6242 addr_failed->user_message : addr_failed->message;
6244 fprintf(stderr, "Delivery failed: ");
6245 if (addr_failed->basic_errno > 0)
6247 fprintf(stderr, "%s", strerror(addr_failed->basic_errno));
6248 if (s != NULL) fprintf(stderr, ": ");
6252 if (addr_failed->basic_errno <= 0) fprintf(stderr, "unknown error");
6254 else fprintf(stderr, "%s", CS s);
6255 fprintf(stderr, "\n");
6257 final_yield = DELIVER_MUA_FAILED;
6262 /* In a normal configuration, we now update the retry database. This is done in
6263 one fell swoop at the end in order not to keep opening and closing (and
6264 locking) the database. The code for handling retries is hived off into a
6265 separate module for convenience. We pass it the addresses of the various
6266 chains, because deferred addresses can get moved onto the failed chain if the
6267 retry cutoff time has expired for all alternative destinations. Bypass the
6268 updating of the database if the -N flag is set, which is a debugging thing that
6269 prevents actual delivery. */
6271 else if (!dont_deliver) retry_update(&addr_defer, &addr_failed, &addr_succeed);
6273 /* If any addresses failed, we must send a message to somebody, unless
6274 af_ignore_error is set, in which case no action is taken. It is possible for
6275 several messages to get sent if there are addresses with different
6278 while (addr_failed != NULL)
6282 uschar *logtod = tod_stamp(tod_log);
6284 address_item *handled_addr = NULL;
6285 address_item **paddr;
6286 address_item *msgchain = NULL;
6287 address_item **pmsgchain = &msgchain;
6289 /* There are weird cases when logging is disabled in the transport. However,
6290 there may not be a transport (address failed by a router). */
6292 disable_logging = FALSE;
6293 if (addr_failed->transport != NULL)
6294 disable_logging = addr_failed->transport->disable_logging;
6297 debug_printf("processing failed address %s\n", addr_failed->address);
6299 /* There are only two ways an address in a bounce message can get here:
6301 (1) When delivery was initially deferred, but has now timed out (in the call
6302 to retry_update() above). We can detect this by testing for
6303 af_retry_timedout. If the address does not have its own errors address,
6304 we arrange to ignore the error.
6306 (2) If delivery failures for bounce messages are being ignored. We can detect
6307 this by testing for af_ignore_error. This will also be set if a bounce
6308 message has been autothawed and the ignore_bounce_errors_after time has
6309 passed. It might also be set if a router was explicitly configured to
6310 ignore errors (errors_to = "").
6312 If neither of these cases obtains, something has gone wrong. Log the
6313 incident, but then ignore the error. */
6315 if (sender_address[0] == 0 && addr_failed->p.errors_address == NULL)
6317 if (!testflag(addr_failed, af_retry_timedout) &&
6318 !testflag(addr_failed, af_ignore_error))
6320 log_write(0, LOG_MAIN|LOG_PANIC, "internal error: bounce message "
6321 "failure is neither frozen nor ignored (it's been ignored)");
6323 setflag(addr_failed, af_ignore_error);
6326 /* If the first address on the list has af_ignore_error set, just remove
6327 it from the list, throw away any saved message file, log it, and
6328 mark the recipient done. */
6330 if (testflag(addr_failed, af_ignore_error))
6333 addr_failed = addr->next;
6334 if (addr->return_filename != NULL) Uunlink(addr->return_filename);
6336 log_write(0, LOG_MAIN, "%s%s%s%s: error ignored",
6338 (addr->parent == NULL)? US"" : US" <",
6339 (addr->parent == NULL)? US"" : addr->parent->address,
6340 (addr->parent == NULL)? US"" : US">");
6342 address_done(addr, logtod);
6343 child_done(addr, logtod);
6344 /* Panic-dies on error */
6345 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
6348 /* Otherwise, handle the sending of a message. Find the error address for
6349 the first address, then send a message that includes all failed addresses
6350 that have the same error address. Note the bounce_recipient is a global so
6351 that it can be accesssed by $bounce_recipient while creating a customized
6356 bounce_recipient = (addr_failed->p.errors_address == NULL)?
6357 sender_address : addr_failed->p.errors_address;
6359 /* Make a subprocess to send a message */
6361 pid = child_open_exim(&fd);
6363 /* Creation of child failed */
6366 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Process %d (parent %d) failed to "
6367 "create child process to send failure message: %s", getpid(),
6368 getppid(), strerror(errno));
6370 /* Creation of child succeeded */
6377 uschar *bcc, *emf_text;
6378 FILE *f = fdopen(fd, "wb");
6380 BOOL to_sender = strcmpic(sender_address, bounce_recipient) == 0;
6381 int max = (bounce_return_size_limit/DELIVER_IN_BUFFER_SIZE + 1) *
6382 DELIVER_IN_BUFFER_SIZE;
6385 debug_printf("sending error message to: %s\n", bounce_recipient);
6387 /* Scan the addresses for all that have the same errors address, removing
6388 them from the addr_failed chain, and putting them on msgchain. */
6390 paddr = &addr_failed;
6391 for (addr = addr_failed; addr != NULL; addr = *paddr)
6393 if (Ustrcmp(bounce_recipient, (addr->p.errors_address == NULL)?
6394 sender_address : addr->p.errors_address) != 0)
6396 paddr = &(addr->next); /* Not the same; skip */
6398 else /* The same - dechain */
6400 *paddr = addr->next;
6403 pmsgchain = &(addr->next);
6407 /* Include X-Failed-Recipients: for automatic interpretation, but do
6408 not let any one header line get too long. We do this by starting a
6409 new header every 50 recipients. Omit any addresses for which the
6410 "hide_child" flag is set. */
6412 for (addr = msgchain; addr != NULL; addr = addr->next)
6414 if (testflag(addr, af_hide_child)) continue;
6421 (rcount++ == 0)? "X-Failed-Recipients: " : ",\n ",
6422 (testflag(addr, af_pfr) && addr->parent != NULL)?
6423 string_printing(addr->parent->address) :
6424 string_printing(addr->address));
6426 if (rcount > 0) fprintf(f, "\n");
6428 /* Output the standard headers */
6430 if (errors_reply_to != NULL)
6431 fprintf(f, "Reply-To: %s\n", errors_reply_to);
6432 fprintf(f, "Auto-Submitted: auto-replied\n");
6434 fprintf(f, "To: %s\n", bounce_recipient);
6436 /* Open a template file if one is provided. Log failure to open, but
6437 carry on - default texts will be used. */
6439 if (bounce_message_file != NULL)
6441 emf = Ufopen(bounce_message_file, "rb");
6443 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to open %s for error "
6444 "message texts: %s", bounce_message_file, strerror(errno));
6447 /* Quietly copy to configured additional addresses if required. */
6449 bcc = moan_check_errorcopy(bounce_recipient);
6450 if (bcc != NULL) fprintf(f, "Bcc: %s\n", bcc);
6452 /* The texts for the message can be read from a template file; if there
6453 isn't one, or if it is too short, built-in texts are used. The first
6454 emf text is a Subject: and any other headers. */
6456 emf_text = next_emf(emf, US"header");
6457 if (emf_text != NULL) fprintf(f, "%s\n", emf_text); else
6459 fprintf(f, "Subject: Mail delivery failed%s\n\n",
6460 to_sender? ": returning message to sender" : "");
6463 emf_text = next_emf(emf, US"intro");
6464 if (emf_text != NULL) fprintf(f, "%s", CS emf_text); else
6467 /* This message has been reworded several times. It seems to be confusing to
6468 somebody, however it is worded. I have retreated to the original, simple
6470 "This message was created automatically by mail delivery software.\n");
6471 if (bounce_message_text != NULL) fprintf(f, "%s", CS bounce_message_text);
6475 "\nA message that you sent could not be delivered to one or more of its\n"
6476 "recipients. This is a permanent error. The following address(es) failed:\n");
6481 "\nA message sent by\n\n <%s>\n\n"
6482 "could not be delivered to one or more of its recipients. The following\n"
6483 "address(es) failed:\n", sender_address);
6488 /* Process the addresses, leaving them on the msgchain if they have a
6489 file name for a return message. (There has already been a check in
6490 post_process_one() for the existence of data in the message file.) A TRUE
6491 return from print_address_information() means that the address is not
6495 for (addr = msgchain; addr != NULL; addr = *paddr)
6497 if (print_address_information(addr, f, US" ", US"\n ", US""))
6498 print_address_error(addr, f, US"");
6500 /* End the final line for the address */
6504 /* Leave on msgchain if there's a return file. */
6506 if (addr->return_file >= 0)
6508 paddr = &(addr->next);
6512 /* Else save so that we can tick off the recipient when the
6517 *paddr = addr->next;
6518 addr->next = handled_addr;
6519 handled_addr = addr;
6525 /* Get the next text, whether we need it or not, so as to be
6526 positioned for the one after. */
6528 emf_text = next_emf(emf, US"generated text");
6530 /* If there were any file messages passed by the local transports,
6531 include them in the message. Then put the address on the handled chain.
6532 In the case of a batch of addresses that were all sent to the same
6533 transport, the return_file field in all of them will contain the same
6534 fd, and the return_filename field in the *last* one will be set (to the
6535 name of the file). */
6537 if (msgchain != NULL)
6539 address_item *nextaddr;
6541 if (emf_text != NULL) fprintf(f, "%s", CS emf_text); else
6543 "The following text was generated during the delivery "
6544 "attempt%s:\n", (filecount > 1)? "s" : "");
6546 for (addr = msgchain; addr != NULL; addr = nextaddr)
6549 address_item *topaddr = addr;
6551 /* List all the addresses that relate to this file */
6554 while(addr != NULL) /* Insurance */
6556 print_address_information(addr, f, US"------ ", US"\n ",
6558 if (addr->return_filename != NULL) break;
6563 /* Now copy the file */
6565 fm = Ufopen(addr->return_filename, "rb");
6568 fprintf(f, " +++ Exim error... failed to open text file: %s\n",
6572 while ((ch = fgetc(fm)) != EOF) fputc(ch, f);
6575 Uunlink(addr->return_filename);
6577 /* Can now add to handled chain, first fishing off the next
6578 address on the msgchain. */
6580 nextaddr = addr->next;
6581 addr->next = handled_addr;
6582 handled_addr = topaddr;
6587 /* Now copy the message, trying to give an intelligible comment if
6588 it is too long for it all to be copied. The limit isn't strictly
6589 applied because of the buffering. There is, however, an option
6590 to suppress copying altogether. */
6592 emf_text = next_emf(emf, US"copy");
6594 if (bounce_return_message)
6596 int topt = topt_add_return_path;
6597 if (!bounce_return_body) topt |= topt_no_body;
6599 if (emf_text != NULL) fprintf(f, "%s", CS emf_text); else
6601 if (bounce_return_body) fprintf(f,
6602 "------ This is a copy of the message, including all the headers. ------\n");
6604 "------ This is a copy of the message's headers. ------\n");
6607 /* While reading the "truncated" message, set return_size_limit to
6608 the actual max testing value, rounded. We need to read the message
6609 whether we are going to use it or not. */
6612 int temp = bounce_return_size_limit;
6613 bounce_return_size_limit = (max/1000)*1000;
6614 emf_text = next_emf(emf, US"truncated");
6615 bounce_return_size_limit = temp;
6618 if (bounce_return_body && bounce_return_size_limit > 0)
6620 struct stat statbuf;
6621 if (fstat(deliver_datafile, &statbuf) == 0 && statbuf.st_size > max)
6623 if (emf_text != NULL) fprintf(f, "%s", CS emf_text); else
6626 "------ The body of the message is " OFF_T_FMT " characters long; only the first\n"
6627 "------ %d or so are included here.\n", statbuf.st_size, max);
6634 transport_filter_argv = NULL; /* Just in case */
6635 return_path = sender_address; /* In case not previously set */
6636 transport_write_message(NULL, fileno(f), topt,
6637 bounce_return_size_limit, NULL, NULL, NULL, NULL, NULL, 0);
6640 /* Write final text and close the template file if one is open */
6644 emf_text = next_emf(emf, US"final");
6645 if (emf_text != NULL) fprintf(f, "%s", CS emf_text);
6649 /* Close the file, which should send an EOF to the child process
6650 that is receiving the message. Wait for it to finish. */
6653 rc = child_close(pid, 0); /* Waits for child to close, no timeout */
6655 /* In the test harness, let the child do it's thing first. */
6657 if (running_in_test_harness) millisleep(500);
6659 /* If the process failed, there was some disaster in setting up the
6660 error message. Unless the message is very old, ensure that addr_defer
6661 is non-null, which will have the effect of leaving the message on the
6662 spool. The failed addresses will get tried again next time. However, we
6663 don't really want this to happen too often, so freeze the message unless
6664 there are some genuine deferred addresses to try. To do this we have
6665 to call spool_write_header() here, because with no genuine deferred
6666 addresses the normal code below doesn't get run. */
6671 if (now - received_time < retry_maximum_timeout && addr_defer == NULL)
6673 addr_defer = (address_item *)(+1);
6674 deliver_freeze = TRUE;
6675 deliver_frozen_at = time(NULL);
6676 /* Panic-dies on error */
6677 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
6680 deliver_msglog("Process failed (%d) when writing error message "
6681 "to %s%s", rc, bounce_recipient, s);
6682 log_write(0, LOG_MAIN, "Process failed (%d) when writing error message "
6683 "to %s%s", rc, bounce_recipient, s);
6686 /* The message succeeded. Ensure that the recipients that failed are
6687 now marked finished with on the spool and their parents updated. */
6691 for (addr = handled_addr; addr != NULL; addr = addr->next)
6693 address_done(addr, logtod);
6694 child_done(addr, logtod);
6696 /* Panic-dies on error */
6697 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
6703 disable_logging = FALSE; /* In case left set */
6705 /* Come here from the mua_wrapper case if routing goes wrong */
6709 /* If there are now no deferred addresses, we are done. Preserve the
6710 message log if so configured, and we are using them. Otherwise, sling it.
6711 Then delete the message itself. */
6713 if (addr_defer == NULL)
6717 sprintf(CS spoolname, "%s/msglog/%s/%s", spool_directory, message_subdir,
6719 if (preserve_message_logs)
6722 sprintf(CS big_buffer, "%s/msglog.OLD/%s", spool_directory, id);
6723 if ((rc = Urename(spoolname, big_buffer)) < 0)
6725 (void)directory_make(spool_directory, US"msglog.OLD",
6726 MSGLOG_DIRECTORY_MODE, TRUE);
6727 rc = Urename(spoolname, big_buffer);
6730 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to move %s to the "
6731 "msglog.OLD directory", spoolname);
6735 if (Uunlink(spoolname) < 0)
6736 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s",
6737 spoolname, strerror(errno));
6741 /* Remove the two message files. */
6743 sprintf(CS spoolname, "%s/input/%s/%s-D", spool_directory, message_subdir, id);
6744 if (Uunlink(spoolname) < 0)
6745 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s",
6746 spoolname, strerror(errno));
6747 sprintf(CS spoolname, "%s/input/%s/%s-H", spool_directory, message_subdir, id);
6748 if (Uunlink(spoolname) < 0)
6749 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s",
6750 spoolname, strerror(errno));
6752 /* Log the end of this message, with queue time if requested. */
6754 if ((log_extra_selector & LX_queue_time_overall) != 0)
6755 log_write(0, LOG_MAIN, "Completed QT=%s",
6756 readconf_printtime(time(NULL) - received_time));
6758 log_write(0, LOG_MAIN, "Completed");
6760 /* Unset deliver_freeze so that we won't try to move the spool files further down */
6761 deliver_freeze = FALSE;
6764 /* If there are deferred addresses, we are keeping this message because it is
6765 not yet completed. Lose any temporary files that were catching output from
6766 pipes for any of the deferred addresses, handle one-time aliases, and see if
6767 the message has been on the queue for so long that it is time to send a warning
6768 message to the sender, unless it is a mailer-daemon. If all deferred addresses
6769 have the same domain, we can set deliver_domain for the expansion of
6770 delay_warning_ condition - if any of them are pipes, files, or autoreplies, use
6771 the parent's domain.
6773 If all the deferred addresses have an error number that indicates "retry time
6774 not reached", skip sending the warning message, because it won't contain the
6775 reason for the delay. It will get sent at the next real delivery attempt.
6776 However, if at least one address has tried, we'd better include all of them in
6779 If we can't make a process to send the message, don't worry.
6781 For mailing list expansions we want to send the warning message to the
6782 mailing list manager. We can't do a perfect job here, as some addresses may
6783 have different errors addresses, but if we take the errors address from
6784 each deferred address it will probably be right in most cases.
6786 If addr_defer == +1, it means there was a problem sending an error message
6787 for failed addresses, and there were no "real" deferred addresses. The value
6788 was set just to keep the message on the spool, so there is nothing to do here.
6791 else if (addr_defer != (address_item *)(+1))
6794 uschar *recipients = US"";
6795 BOOL delivery_attempted = FALSE;
6797 deliver_domain = testflag(addr_defer, af_pfr)?
6798 addr_defer->parent->domain : addr_defer->domain;
6800 for (addr = addr_defer; addr != NULL; addr = addr->next)
6802 address_item *otaddr;
6804 if (addr->basic_errno > ERRNO_RETRY_BASE) delivery_attempted = TRUE;
6806 if (deliver_domain != NULL)
6808 uschar *d = (testflag(addr, af_pfr))? addr->parent->domain : addr->domain;
6810 /* The domain may be unset for an address that has never been routed
6811 because the system filter froze the message. */
6813 if (d == NULL || Ustrcmp(d, deliver_domain) != 0) deliver_domain = NULL;
6816 if (addr->return_filename != NULL) Uunlink(addr->return_filename);
6818 /* Handle the case of one-time aliases. If any address in the ancestry
6819 of this one is flagged, ensure it is in the recipients list, suitably
6820 flagged, and that its parent is marked delivered. */
6822 for (otaddr = addr; otaddr != NULL; otaddr = otaddr->parent)
6823 if (otaddr->onetime_parent != NULL) break;
6828 int t = recipients_count;
6830 for (i = 0; i < recipients_count; i++)
6832 uschar *r = recipients_list[i].address;
6833 if (Ustrcmp(otaddr->onetime_parent, r) == 0) t = i;
6834 if (Ustrcmp(otaddr->address, r) == 0) break;
6837 /* Didn't find the address already in the list, and did find the
6838 ultimate parent's address in the list. After adding the recipient,
6839 update the errors address in the recipients list. */
6841 if (i >= recipients_count && t < recipients_count)
6843 DEBUG(D_deliver) debug_printf("one_time: adding %s in place of %s\n",
6844 otaddr->address, otaddr->parent->address);
6845 receive_add_recipient(otaddr->address, t);
6846 recipients_list[recipients_count-1].errors_to = otaddr->p.errors_address;
6847 tree_add_nonrecipient(otaddr->parent->address);
6848 update_spool = TRUE;
6852 /* Except for error messages, ensure that either the errors address for
6853 this deferred address or, if there is none, the sender address, is on the
6854 list of recipients for a warning message. */
6856 if (sender_address[0] != 0)
6858 if (addr->p.errors_address == NULL)
6860 if (Ustrstr(recipients, sender_address) == NULL)
6861 recipients = string_sprintf("%s%s%s", recipients,
6862 (recipients[0] == 0)? "" : ",", sender_address);
6866 if (Ustrstr(recipients, addr->p.errors_address) == NULL)
6867 recipients = string_sprintf("%s%s%s", recipients,
6868 (recipients[0] == 0)? "" : ",", addr->p.errors_address);
6873 /* Send a warning message if the conditions are right. If the condition check
6874 fails because of a lookup defer, there is nothing we can do. The warning
6875 is not sent. Another attempt will be made at the next delivery attempt (if
6878 if (!queue_2stage && delivery_attempted &&
6879 delay_warning[1] > 0 && sender_address[0] != 0 &&
6880 (delay_warning_condition == NULL ||
6881 expand_check_condition(delay_warning_condition,
6882 US"delay_warning", US"option")))
6886 int queue_time = time(NULL) - received_time;
6888 /* When running in the test harness, there's an option that allows us to
6889 fudge this time so as to get repeatability of the tests. Take the first
6890 time off the list. In queue runs, the list pointer gets updated in the
6893 if (running_in_test_harness && fudged_queue_times[0] != 0)
6895 int qt = readconf_readtime(fudged_queue_times, '/', FALSE);
6898 DEBUG(D_deliver) debug_printf("fudged queue_times = %s\n",
6899 fudged_queue_times);
6904 /* See how many warnings we should have sent by now */
6906 for (count = 0; count < delay_warning[1]; count++)
6907 if (queue_time < delay_warning[count+2]) break;
6909 show_time = delay_warning[count+1];
6911 if (count >= delay_warning[1])
6914 int last_gap = show_time;
6915 if (count > 1) last_gap -= delay_warning[count];
6916 extra = (queue_time - delay_warning[count+1])/last_gap;
6917 show_time += last_gap * extra;
6923 debug_printf("time on queue = %s\n", readconf_printtime(queue_time));
6924 debug_printf("warning counts: required %d done %d\n", count,
6928 /* We have computed the number of warnings there should have been by now.
6929 If there haven't been enough, send one, and up the count to what it should
6932 if (warning_count < count)
6936 pid_t pid = child_open_exim(&fd);
6942 FILE *f = fdopen(fd, "wb");
6944 if (warn_message_file != NULL)
6946 wmf = Ufopen(warn_message_file, "rb");
6948 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to open %s for warning "
6949 "message texts: %s", warn_message_file, strerror(errno));
6952 warnmsg_recipients = recipients;
6953 warnmsg_delay = (queue_time < 120*60)?
6954 string_sprintf("%d minutes", show_time/60):
6955 string_sprintf("%d hours", show_time/3600);
6957 if (errors_reply_to != NULL)
6958 fprintf(f, "Reply-To: %s\n", errors_reply_to);
6959 fprintf(f, "Auto-Submitted: auto-replied\n");
6961 fprintf(f, "To: %s\n", recipients);
6963 wmf_text = next_emf(wmf, US"header");
6964 if (wmf_text != NULL)
6965 fprintf(f, "%s\n", wmf_text);
6967 fprintf(f, "Subject: Warning: message %s delayed %s\n\n",
6968 message_id, warnmsg_delay);
6970 wmf_text = next_emf(wmf, US"intro");
6971 if (wmf_text != NULL) fprintf(f, "%s", CS wmf_text); else
6974 "This message was created automatically by mail delivery software.\n");
6976 if (Ustrcmp(recipients, sender_address) == 0)
6978 "A message that you sent has not yet been delivered to one or more of its\n"
6979 "recipients after more than ");
6982 "A message sent by\n\n <%s>\n\n"
6983 "has not yet been delivered to one or more of its recipients after more than \n",
6986 fprintf(f, "%s on the queue on %s.\n\n", warnmsg_delay,
6988 fprintf(f, "The message identifier is: %s\n", message_id);
6990 for (h = header_list; h != NULL; h = h->next)
6992 if (strncmpic(h->text, US"Subject:", 8) == 0)
6993 fprintf(f, "The subject of the message is: %s", h->text + 9);
6994 else if (strncmpic(h->text, US"Date:", 5) == 0)
6995 fprintf(f, "The date of the message is: %s", h->text + 6);
6999 fprintf(f, "The address%s to which the message has not yet been "
7001 (addr_defer->next == NULL)? "" : "es",
7002 (addr_defer->next == NULL)? "is": "are");
7005 /* List the addresses, with error information if allowed */
7008 while (addr_defer != NULL)
7010 address_item *addr = addr_defer;
7011 addr_defer = addr->next;
7012 if (print_address_information(addr, f, US" ", US"\n ", US""))
7013 print_address_error(addr, f, US"Delay reason: ");
7022 wmf_text = next_emf(wmf, US"final");
7023 if (wmf_text != NULL) fprintf(f, "%s", CS wmf_text);
7029 "No action is required on your part. Delivery attempts will continue for\n"
7030 "some time, and this warning may be repeated at intervals if the message\n"
7031 "remains undelivered. Eventually the mail delivery software will give up,\n"
7032 "and when that happens, the message will be returned to you.\n");
7035 /* Close and wait for child process to complete, without a timeout.
7036 If there's an error, don't update the count. */
7039 if (child_close(pid, 0) == 0)
7041 warning_count = count;
7042 update_spool = TRUE; /* Ensure spool rewritten */
7048 /* Clear deliver_domain */
7050 deliver_domain = NULL;
7052 /* If this was a first delivery attempt, unset the first time flag, and
7053 ensure that the spool gets updated. */
7055 if (deliver_firsttime)
7057 deliver_firsttime = FALSE;
7058 update_spool = TRUE;
7061 /* If delivery was frozen and freeze_tell is set, generate an appropriate
7062 message, unless the message is a local error message (to avoid loops). Then
7063 log the freezing. If the text in "frozen_info" came from a system filter,
7064 it has been escaped into printing characters so as not to mess up log lines.
7065 For the "tell" message, we turn \n back into newline. Also, insert a newline
7066 near the start instead of the ": " string. */
7070 if (freeze_tell != NULL && freeze_tell[0] != 0 && !local_error_message)
7072 uschar *s = string_copy(frozen_info);
7073 uschar *ss = Ustrstr(s, " by the system filter: ");
7084 if (*ss == '\\' && ss[1] == 'n')
7091 moan_tell_someone(freeze_tell, addr_defer, US"Message frozen",
7092 "Message %s has been frozen%s.\nThe sender is <%s>.\n", message_id,
7096 /* Log freezing just before we update the -H file, to minimize the chance
7097 of a race problem. */
7099 deliver_msglog("*** Frozen%s\n", frozen_info);
7100 log_write(0, LOG_MAIN, "Frozen%s", frozen_info);
7103 /* If there have been any updates to the non-recipients list, or other things
7104 that get written to the spool, we must now update the spool header file so
7105 that it has the right information for the next delivery attempt. If there
7106 was more than one address being delivered, the header_change update is done
7107 earlier, in case one succeeds and then something crashes. */
7110 debug_printf("delivery deferred: update_spool=%d header_rewritten=%d\n",
7111 update_spool, header_rewritten);
7113 if (update_spool || header_rewritten)
7114 /* Panic-dies on error */
7115 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
7118 /* Finished with the message log. If the message is complete, it will have
7119 been unlinked or renamed above. */
7121 if (message_logs) (void)fclose(message_log);
7123 /* Now we can close and remove the journal file. Its only purpose is to record
7124 successfully completed deliveries asap so that this information doesn't get
7125 lost if Exim (or the machine) crashes. Forgetting about a failed delivery is
7126 not serious, as trying it again is not harmful. The journal might not be open
7127 if all addresses were deferred at routing or directing. Nevertheless, we must
7128 remove it if it exists (may have been lying around from a crash during the
7129 previous delivery attempt). We don't remove the journal if a delivery
7130 subprocess failed to pass back delivery information; this is controlled by
7131 the remove_journal flag. When the journal is left, we also don't move the
7132 message off the main spool if frozen and the option is set. It should get moved
7133 at the next attempt, after the journal has been inspected. */
7135 if (journal_fd >= 0) (void)close(journal_fd);
7139 sprintf(CS spoolname, "%s/input/%s/%s-J", spool_directory, message_subdir, id);
7140 if (Uunlink(spoolname) < 0 && errno != ENOENT)
7141 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s", spoolname,
7144 /* Move the message off the spool if reqested */
7146 #ifdef SUPPORT_MOVE_FROZEN_MESSAGES
7147 if (deliver_freeze && move_frozen_messages)
7148 (void)spool_move_message(id, message_subdir, US"", US"F");
7152 /* Closing the data file frees the lock; if the file has been unlinked it
7153 will go away. Otherwise the message becomes available for another process
7156 (void)close(deliver_datafile);
7157 deliver_datafile = -1;
7158 DEBUG(D_deliver) debug_printf("end delivery of %s\n", id);
7160 /* It is unlikely that there will be any cached resources, since they are
7161 released after routing, and in the delivery subprocesses. However, it's
7162 possible for an expansion for something afterwards (for example,
7163 expand_check_condition) to do a lookup. We must therefore be sure everything is
7167 acl_where = ACL_WHERE_UNKNOWN;
7171 /* End of deliver.c */