Retire old libsrs_alt -based SRS support. Bug 1649
[exim.git] / src / src / deliver.c
1 /*************************************************
2 *     Exim - an Internet mail transport agent    *
3 *************************************************/
4
5 /* Copyright (c) University of Cambridge 1995 - 2018 */
6 /* Copyright (c) The Exim Maintainers 2020 - 2021 */
7 /* See the file NOTICE for conditions of use and distribution. */
8
9 /* The main code for delivering a message. */
10
11
12 #include "exim.h"
13 #include "transports/smtp.h"
14 #include <sys/uio.h>
15 #include <assert.h>
16
17
18 /* Data block for keeping track of subprocesses for parallel remote
19 delivery. */
20
21 typedef struct pardata {
22   address_item *addrlist;      /* chain of addresses */
23   address_item *addr;          /* next address data expected for */
24   pid_t pid;                   /* subprocess pid */
25   int fd;                      /* pipe fd for getting result from subprocess */
26   int transport_count;         /* returned transport count value */
27   BOOL done;                   /* no more data needed */
28   uschar *msg;                 /* error message */
29   uschar *return_path;         /* return_path for these addresses */
30 } pardata;
31
32 /* Values for the process_recipients variable */
33
34 enum { RECIP_ACCEPT, RECIP_IGNORE, RECIP_DEFER,
35        RECIP_FAIL, RECIP_FAIL_FILTER, RECIP_FAIL_TIMEOUT,
36        RECIP_FAIL_LOOP};
37
38 /* Mutually recursive functions for marking addresses done. */
39
40 static void child_done(address_item *, uschar *);
41 static void address_done(address_item *, uschar *);
42
43 /* Table for turning base-62 numbers into binary */
44
45 static uschar tab62[] =
46           {0,1,2,3,4,5,6,7,8,9,0,0,0,0,0,0,     /* 0-9 */
47            0,10,11,12,13,14,15,16,17,18,19,20,  /* A-K */
48           21,22,23,24,25,26,27,28,29,30,31,32,  /* L-W */
49           33,34,35, 0, 0, 0, 0, 0,              /* X-Z */
50            0,36,37,38,39,40,41,42,43,44,45,46,  /* a-k */
51           47,48,49,50,51,52,53,54,55,56,57,58,  /* l-w */
52           59,60,61};                            /* x-z */
53
54
55 /*************************************************
56 *            Local static variables              *
57 *************************************************/
58
59 /* addr_duplicate is global because it needs to be seen from the Envelope-To
60 writing code. */
61
62 static address_item *addr_defer = NULL;
63 static address_item *addr_failed = NULL;
64 static address_item *addr_fallback = NULL;
65 static address_item *addr_local = NULL;
66 static address_item *addr_new = NULL;
67 static address_item *addr_remote = NULL;
68 static address_item *addr_route = NULL;
69 static address_item *addr_succeed = NULL;
70 static address_item *addr_senddsn = NULL;
71
72 static FILE *message_log = NULL;
73 static BOOL update_spool;
74 static BOOL remove_journal;
75 static int  parcount = 0;
76 static pardata *parlist = NULL;
77 static struct pollfd *parpoll;
78 static int  return_count;
79 static uschar *frozen_info = US"";
80 static uschar *used_return_path = NULL;
81
82
83
84 /*************************************************
85 *          read as much as requested             *
86 *************************************************/
87
88 /* The syscall read(2) doesn't always returns as much as we want. For
89 several reasons it might get less. (Not talking about signals, as syscalls
90 are restartable). When reading from a network or pipe connection the sender
91 might send in smaller chunks, with delays between these chunks. The read(2)
92 may return such a chunk.
93
94 The more the writer writes and the smaller the pipe between write and read is,
95 the more we get the chance of reading leass than requested. (See bug 2130)
96
97 This function read(2)s until we got all the data we *requested*.
98
99 Note: This function may block. Use it only if you're sure about the
100 amount of data you will get.
101
102 Argument:
103   fd          the file descriptor to read from
104   buffer      pointer to a buffer of size len
105   len         the requested(!) amount of bytes
106
107 Returns:      the amount of bytes read
108 */
109 static ssize_t
110 readn(int fd, void * buffer, size_t len)
111 {
112 uschar * next = buffer;
113 uschar * end = next + len;
114
115 while (next < end)
116   {
117   ssize_t got = read(fd, next, end - next);
118
119   /* I'm not sure if there are signals that can interrupt us,
120   for now I assume the worst */
121   if (got == -1 && errno == EINTR) continue;
122   if (got <= 0) return next - US buffer;
123   next += got;
124   }
125
126 return len;
127 }
128
129
130 /*************************************************
131 *             Make a new address item            *
132 *************************************************/
133
134 /* This function gets the store and initializes with default values. The
135 transport_return value defaults to DEFER, so that any unexpected failure to
136 deliver does not wipe out the message. The default unique string is set to a
137 copy of the address, so that its domain can be lowercased.
138
139 Argument:
140   address     the RFC822 address string
141   copy        force a copy of the address
142
143 Returns:      a pointer to an initialized address_item
144 */
145
146 address_item *
147 deliver_make_addr(uschar *address, BOOL copy)
148 {
149 address_item *addr = store_get(sizeof(address_item), FALSE);
150 *addr = address_defaults;
151 if (copy) address = string_copy(address);
152 addr->address = address;
153 addr->unique = string_copy(address);
154 return addr;
155 }
156
157
158
159
160 /*************************************************
161 *     Set expansion values for an address        *
162 *************************************************/
163
164 /* Certain expansion variables are valid only when handling an address or
165 address list. This function sets them up or clears the values, according to its
166 argument.
167
168 Arguments:
169   addr          the address in question, or NULL to clear values
170 Returns:        nothing
171 */
172
173 void
174 deliver_set_expansions(address_item *addr)
175 {
176 if (!addr)
177   {
178   const uschar ***p = address_expansions;
179   while (*p) **p++ = NULL;
180   return;
181   }
182
183 /* Exactly what gets set depends on whether there is one or more addresses, and
184 what they contain. These first ones are always set, taking their values from
185 the first address. */
186
187 if (!addr->host_list)
188   {
189   deliver_host = deliver_host_address = US"";
190   deliver_host_port = 0;
191   }
192 else
193   {
194   deliver_host = addr->host_list->name;
195   deliver_host_address = addr->host_list->address;
196   deliver_host_port = addr->host_list->port;
197   }
198
199 deliver_recipients = addr;
200 deliver_address_data = addr->prop.address_data;
201 deliver_domain_data = addr->prop.domain_data;
202 deliver_localpart_data = addr->prop.localpart_data;
203 router_var = addr->prop.variables;
204
205 /* These may be unset for multiple addresses */
206
207 deliver_domain = addr->domain;
208 self_hostname = addr->self_hostname;
209
210 #ifdef EXPERIMENTAL_BRIGHTMAIL
211 bmi_deliver = 1;    /* deliver by default */
212 bmi_alt_location = NULL;
213 bmi_base64_verdict = NULL;
214 bmi_base64_tracker_verdict = NULL;
215 #endif
216
217 /* If there's only one address we can set everything. */
218
219 if (!addr->next)
220   {
221   address_item *addr_orig;
222
223   deliver_localpart = addr->local_part;
224   deliver_localpart_prefix = addr->prefix;
225   deliver_localpart_prefix_v = addr->prefix_v;
226   deliver_localpart_suffix = addr->suffix;
227   deliver_localpart_suffix_v = addr->suffix_v;
228
229   for (addr_orig = addr; addr_orig->parent; addr_orig = addr_orig->parent) ;
230   deliver_domain_orig = addr_orig->domain;
231
232   /* Re-instate any prefix and suffix in the original local part. In all
233   normal cases, the address will have a router associated with it, and we can
234   choose the caseful or caseless version accordingly. However, when a system
235   filter sets up a pipe, file, or autoreply delivery, no router is involved.
236   In this case, though, there won't be any prefix or suffix to worry about. */
237
238   deliver_localpart_orig = !addr_orig->router
239     ? addr_orig->local_part
240     : addr_orig->router->caseful_local_part
241     ? addr_orig->cc_local_part
242     : addr_orig->lc_local_part;
243
244   /* If there's a parent, make its domain and local part available, and if
245   delivering to a pipe or file, or sending an autoreply, get the local
246   part from the parent. For pipes and files, put the pipe or file string
247   into address_pipe and address_file. */
248
249   if (addr->parent)
250     {
251     deliver_domain_parent = addr->parent->domain;
252     deliver_localpart_parent = !addr->parent->router
253       ? addr->parent->local_part
254       : addr->parent->router->caseful_local_part
255       ? addr->parent->cc_local_part
256       : addr->parent->lc_local_part;
257
258     /* File deliveries have their own flag because they need to be picked out
259     as special more often. */
260
261     if (testflag(addr, af_pfr))
262       {
263       if (testflag(addr, af_file))          address_file = addr->local_part;
264       else if (deliver_localpart[0] == '|') address_pipe = addr->local_part;
265       deliver_localpart = addr->parent->local_part;
266       deliver_localpart_prefix = addr->parent->prefix;
267       deliver_localpart_prefix_v = addr->parent->prefix_v;
268       deliver_localpart_suffix = addr->parent->suffix;
269       deliver_localpart_suffix_v = addr->parent->suffix_v;
270       }
271     }
272
273 #ifdef EXPERIMENTAL_BRIGHTMAIL
274     /* Set expansion variables related to Brightmail AntiSpam */
275     bmi_base64_verdict = bmi_get_base64_verdict(deliver_localpart_orig, deliver_domain_orig);
276     bmi_base64_tracker_verdict = bmi_get_base64_tracker_verdict(bmi_base64_verdict);
277     /* get message delivery status (0 - don't deliver | 1 - deliver) */
278     bmi_deliver = bmi_get_delivery_status(bmi_base64_verdict);
279     /* if message is to be delivered, get eventual alternate location */
280     if (bmi_deliver == 1)
281       bmi_alt_location = bmi_get_alt_location(bmi_base64_verdict);
282 #endif
283
284   }
285
286 /* For multiple addresses, don't set local part, and leave the domain and
287 self_hostname set only if it is the same for all of them. It is possible to
288 have multiple pipe and file addresses, but only when all addresses have routed
289 to the same pipe or file. */
290
291 else
292   {
293   if (testflag(addr, af_pfr))
294     {
295     if (testflag(addr, af_file))         address_file = addr->local_part;
296     else if (addr->local_part[0] == '|') address_pipe = addr->local_part;
297     }
298   for (address_item * addr2 = addr->next; addr2; addr2 = addr2->next)
299     {
300     if (deliver_domain && Ustrcmp(deliver_domain, addr2->domain) != 0)
301       deliver_domain = NULL;
302     if (  self_hostname
303        && (  !addr2->self_hostname
304           || Ustrcmp(self_hostname, addr2->self_hostname) != 0
305        )  )
306       self_hostname = NULL;
307     if (!deliver_domain && !self_hostname) break;
308     }
309   }
310 }
311
312
313
314
315 /*************************************************
316 *                Open a msglog file              *
317 *************************************************/
318
319 /* This function is used both for normal message logs, and for files in the
320 msglog directory that are used to catch output from pipes. Try to create the
321 directory if it does not exist. From release 4.21, normal message logs should
322 be created when the message is received.
323
324 Called from deliver_message(), can be operating as root.
325
326 Argument:
327   filename  the file name
328   mode      the mode required
329   error     used for saying what failed
330
331 Returns:    a file descriptor, or -1 (with errno set)
332 */
333
334 static int
335 open_msglog_file(uschar *filename, int mode, uschar **error)
336 {
337 if (Ustrstr(filename, US"/../"))
338   log_write(0, LOG_MAIN|LOG_PANIC_DIE,
339     "Attempt to open msglog file path with upward-traversal: '%s'\n", filename);
340
341 for (int i = 2; i > 0; i--)
342   {
343   int fd = Uopen(filename,
344 #ifdef O_CLOEXEC
345     O_CLOEXEC |
346 #endif
347 #ifdef O_NOFOLLOW
348     O_NOFOLLOW |
349 #endif
350                 O_WRONLY|O_APPEND|O_CREAT, mode);
351   if (fd >= 0)
352     {
353     /* Set the close-on-exec flag and change the owner to the exim uid/gid (this
354     function is called as root). Double check the mode, because the group setting
355     doesn't always get set automatically. */
356
357 #ifndef O_CLOEXEC
358     (void)fcntl(fd, F_SETFD, fcntl(fd, F_GETFD) | FD_CLOEXEC);
359 #endif
360     if (exim_fchown(fd, exim_uid, exim_gid, filename) < 0)
361       {
362       *error = US"chown";
363       return -1;
364       }
365     if (fchmod(fd, mode) < 0)
366       {
367       *error = US"chmod";
368       return -1;
369       }
370     return fd;
371     }
372   if (errno != ENOENT)
373     break;
374
375   (void)directory_make(spool_directory,
376                         spool_sname(US"msglog", message_subdir),
377                         MSGLOG_DIRECTORY_MODE, TRUE);
378   }
379
380 *error = US"create or open";
381 return -1;
382 }
383
384
385
386
387 /*************************************************
388 *           Write to msglog if required          *
389 *************************************************/
390
391 /* Write to the message log, if configured. This function may also be called
392 from transports.
393
394 Arguments:
395   format       a string format
396
397 Returns:       nothing
398 */
399
400 void
401 deliver_msglog(const char *format, ...)
402 {
403 va_list ap;
404 if (!message_logs) return;
405 va_start(ap, format);
406 vfprintf(message_log, format, ap);
407 fflush(message_log);
408 va_end(ap);
409 }
410
411
412
413
414 /*************************************************
415 *            Replicate status for batch          *
416 *************************************************/
417
418 /* When a transport handles a batch of addresses, it may treat them
419 individually, or it may just put the status in the first one, and return FALSE,
420 requesting that the status be copied to all the others externally. This is the
421 replication function. As well as the status, it copies the transport pointer,
422 which may have changed if appendfile passed the addresses on to a different
423 transport.
424
425 Argument:    pointer to the first address in a chain
426 Returns:     nothing
427 */
428
429 static void
430 replicate_status(address_item *addr)
431 {
432 for (address_item * addr2 = addr->next; addr2; addr2 = addr2->next)
433   {
434   addr2->transport =        addr->transport;
435   addr2->transport_return = addr->transport_return;
436   addr2->basic_errno =      addr->basic_errno;
437   addr2->more_errno =       addr->more_errno;
438   addr2->delivery_time =    addr->delivery_time;
439   addr2->special_action =   addr->special_action;
440   addr2->message =          addr->message;
441   addr2->user_message =     addr->user_message;
442   }
443 }
444
445
446
447 /*************************************************
448 *              Compare lists of hosts            *
449 *************************************************/
450
451 /* This function is given two pointers to chains of host items, and it yields
452 TRUE if the lists refer to the same hosts in the same order, except that
453
454 (1) Multiple hosts with the same non-negative MX values are permitted to appear
455     in different orders. Round-robinning nameservers can cause this to happen.
456
457 (2) Multiple hosts with the same negative MX values less than MX_NONE are also
458     permitted to appear in different orders. This is caused by randomizing
459     hosts lists.
460
461 This enables Exim to use a single SMTP transaction for sending to two entirely
462 different domains that happen to end up pointing at the same hosts.
463
464 We do not try to batch up different A-record host names that refer to the
465 same IP.
466
467 Arguments:
468   one       points to the first host list
469   two       points to the second host list
470
471 Returns:    TRUE if the lists refer to the same host set
472 */
473
474 static BOOL
475 same_hosts(host_item *one, host_item *two)
476 {
477 while (one && two)
478   {
479   if (Ustrcmp(one->name, two->name) != 0)
480     {
481     int mx = one->mx;
482     host_item *end_one = one;
483     host_item *end_two = two;
484
485     /* Batch up only if there was no MX and the list was not randomized */
486
487     if (mx == MX_NONE) return FALSE;
488
489     /* Find the ends of the shortest sequence of identical MX values */
490
491     while (  end_one->next && end_one->next->mx == mx
492           && end_two->next && end_two->next->mx == mx)
493       {
494       end_one = end_one->next;
495       end_two = end_two->next;
496       }
497
498     /* If there aren't any duplicates, there's no match. */
499
500     if (end_one == one) return FALSE;
501
502     /* For each host in the 'one' sequence, check that it appears in the 'two'
503     sequence, returning FALSE if not. */
504
505     for (;;)
506       {
507       host_item *hi;
508       for (hi = two; hi != end_two->next; hi = hi->next)
509         if (Ustrcmp(one->name, hi->name) == 0) break;
510       if (hi == end_two->next) return FALSE;
511       if (one == end_one) break;
512       one = one->next;
513       }
514
515     /* All the hosts in the 'one' sequence were found in the 'two' sequence.
516     Ensure both are pointing at the last host, and carry on as for equality. */
517
518     two = end_two;
519     }
520
521   /* if the names matched but ports do not, mismatch */
522   else if (one->port != two->port)
523     return FALSE;
524
525 #ifdef SUPPORT_DANE
526   /* DNSSEC equality */
527   if (one->dnssec != two->dnssec) return FALSE;
528 #endif
529
530   /* Hosts matched */
531   one = one->next;
532   two = two->next;
533   }
534
535 /* True if both are NULL */
536
537 return (one == two);
538 }
539
540
541
542 /*************************************************
543 *              Compare header lines              *
544 *************************************************/
545
546 /* This function is given two pointers to chains of header items, and it yields
547 TRUE if they are the same header texts in the same order.
548
549 Arguments:
550   one       points to the first header list
551   two       points to the second header list
552
553 Returns:    TRUE if the lists refer to the same header set
554 */
555
556 static BOOL
557 same_headers(header_line *one, header_line *two)
558 {
559 for (;; one = one->next, two = two->next)
560   {
561   if (one == two) return TRUE;   /* Includes the case where both NULL */
562   if (!one || !two) return FALSE;
563   if (Ustrcmp(one->text, two->text) != 0) return FALSE;
564   }
565 }
566
567
568
569 /*************************************************
570 *            Compare string settings             *
571 *************************************************/
572
573 /* This function is given two pointers to strings, and it returns
574 TRUE if they are the same pointer, or if the two strings are the same.
575
576 Arguments:
577   one       points to the first string
578   two       points to the second string
579
580 Returns:    TRUE or FALSE
581 */
582
583 static BOOL
584 same_strings(uschar *one, uschar *two)
585 {
586 if (one == two) return TRUE;   /* Includes the case where both NULL */
587 if (!one || !two) return FALSE;
588 return (Ustrcmp(one, two) == 0);
589 }
590
591
592
593 /*************************************************
594 *        Compare uid/gid for addresses           *
595 *************************************************/
596
597 /* This function is given a transport and two addresses. It yields TRUE if the
598 uid/gid/initgroups settings for the two addresses are going to be the same when
599 they are delivered.
600
601 Arguments:
602   tp            the transort
603   addr1         the first address
604   addr2         the second address
605
606 Returns:        TRUE or FALSE
607 */
608
609 static BOOL
610 same_ugid(transport_instance *tp, address_item *addr1, address_item *addr2)
611 {
612 if (  !tp->uid_set && !tp->expand_uid
613    && !tp->deliver_as_creator
614    && (  testflag(addr1, af_uid_set) != testflag(addr2, af_gid_set)
615       || (  testflag(addr1, af_uid_set)
616          && (  addr1->uid != addr2->uid
617             || testflag(addr1, af_initgroups) != testflag(addr2, af_initgroups)
618    )  )  )  )
619   return FALSE;
620
621 if (  !tp->gid_set && !tp->expand_gid
622    && (  testflag(addr1, af_gid_set) != testflag(addr2, af_gid_set)
623       || (  testflag(addr1, af_gid_set)
624          && addr1->gid != addr2->gid
625    )  )  )
626   return FALSE;
627
628 return TRUE;
629 }
630
631
632
633
634 /*************************************************
635 *      Record that an address is complete        *
636 *************************************************/
637
638 /* This function records that an address is complete. This is straightforward
639 for most addresses, where the unique address is just the full address with the
640 domain lower cased. For homonyms (addresses that are the same as one of their
641 ancestors) their are complications. Their unique addresses have \x\ prepended
642 (where x = 0, 1, 2...), so that de-duplication works correctly for siblings and
643 cousins.
644
645 Exim used to record the unique addresses of homonyms as "complete". This,
646 however, fails when the pattern of redirection varies over time (e.g. if taking
647 unseen copies at only some times of day) because the prepended numbers may vary
648 from one delivery run to the next. This problem is solved by never recording
649 prepended unique addresses as complete. Instead, when a homonymic address has
650 actually been delivered via a transport, we record its basic unique address
651 followed by the name of the transport. This is checked in subsequent delivery
652 runs whenever an address is routed to a transport.
653
654 If the completed address is a top-level one (has no parent, which means it
655 cannot be homonymic) we also add the original address to the non-recipients
656 tree, so that it gets recorded in the spool file and therefore appears as
657 "done" in any spool listings. The original address may differ from the unique
658 address in the case of the domain.
659
660 Finally, this function scans the list of duplicates, marks as done any that
661 match this address, and calls child_done() for their ancestors.
662
663 Arguments:
664   addr        address item that has been completed
665   now         current time as a string
666
667 Returns:      nothing
668 */
669
670 static void
671 address_done(address_item *addr, uschar *now)
672 {
673 update_spool = TRUE;        /* Ensure spool gets updated */
674
675 /* Top-level address */
676
677 if (!addr->parent)
678   {
679   tree_add_nonrecipient(addr->unique);
680   tree_add_nonrecipient(addr->address);
681   }
682
683 /* Homonymous child address */
684
685 else if (testflag(addr, af_homonym))
686   {
687   if (addr->transport)
688     tree_add_nonrecipient(
689       string_sprintf("%s/%s", addr->unique + 3, addr->transport->name));
690   }
691
692 /* Non-homonymous child address */
693
694 else tree_add_nonrecipient(addr->unique);
695
696 /* Check the list of duplicate addresses and ensure they are now marked
697 done as well. */
698
699 for (address_item * dup = addr_duplicate; dup; dup = dup->next)
700   if (Ustrcmp(addr->unique, dup->unique) == 0)
701     {
702     tree_add_nonrecipient(dup->unique);
703     child_done(dup, now);
704     }
705 }
706
707
708
709
710 /*************************************************
711 *      Decrease counts in parents and mark done  *
712 *************************************************/
713
714 /* This function is called when an address is complete. If there is a parent
715 address, its count of children is decremented. If there are still other
716 children outstanding, the function exits. Otherwise, if the count has become
717 zero, address_done() is called to mark the parent and its duplicates complete.
718 Then loop for any earlier ancestors.
719
720 Arguments:
721   addr      points to the completed address item
722   now       the current time as a string, for writing to the message log
723
724 Returns:    nothing
725 */
726
727 static void
728 child_done(address_item *addr, uschar *now)
729 {
730 while (addr->parent)
731   {
732   address_item *aa;
733
734   addr = addr->parent;
735   if (--addr->child_count > 0) return;   /* Incomplete parent */
736   address_done(addr, now);
737
738   /* Log the completion of all descendents only when there is no ancestor with
739   the same original address. */
740
741   for (aa = addr->parent; aa; aa = aa->parent)
742     if (Ustrcmp(aa->address, addr->address) == 0) break;
743   if (aa) continue;
744
745   deliver_msglog("%s %s: children all complete\n", now, addr->address);
746   DEBUG(D_deliver) debug_printf("%s: children all complete\n", addr->address);
747   }
748 }
749
750
751
752 /*************************************************
753 *      Delivery logging support functions        *
754 *************************************************/
755
756 /* The LOGGING() checks in d_log_interface() are complicated for backwards
757 compatibility. When outgoing interface logging was originally added, it was
758 conditional on just incoming_interface (which is off by default). The
759 outgoing_interface option is on by default to preserve this behaviour, but
760 you can enable incoming_interface and disable outgoing_interface to get I=
761 fields on incoming lines only.
762
763 Arguments:
764   g         The log line
765   addr      The address to be logged
766
767 Returns:    New value for s
768 */
769
770 static gstring *
771 d_log_interface(gstring * g)
772 {
773 if (LOGGING(incoming_interface) && LOGGING(outgoing_interface)
774     && sending_ip_address)
775   {
776   g = string_fmt_append(g, " I=[%s]", sending_ip_address);
777   if (LOGGING(outgoing_port))
778     g = string_fmt_append(g, ":%d", sending_port);
779   }
780 return g;
781 }
782
783
784
785 static gstring *
786 d_hostlog(gstring * g, address_item * addr)
787 {
788 host_item * h = addr->host_used;
789
790 g = string_append(g, 2, US" H=", h->name);
791
792 if (LOGGING(dnssec) && h->dnssec == DS_YES)
793   g = string_catn(g, US" DS", 3);
794
795 g = string_append(g, 3, US" [", h->address, US"]");
796
797 if (LOGGING(outgoing_port))
798   g = string_fmt_append(g, ":%d", h->port);
799
800 if (continue_sequence > 1)              /*XXX this is wrong for a dropped proxyconn.  Would have to pass back from transport */
801   g = string_catn(g, US"*", 1);
802
803 #ifdef SUPPORT_SOCKS
804 if (LOGGING(proxy) && proxy_local_address)
805   {
806   g = string_append(g, 3, US" PRX=[", proxy_local_address, US"]");
807   if (LOGGING(outgoing_port))
808     g = string_fmt_append(g, ":%d", proxy_local_port);
809   }
810 #endif
811
812 g = d_log_interface(g);
813
814 if (testflag(addr, af_tcp_fastopen))
815   g = string_catn(g, US" TFO*", testflag(addr, af_tcp_fastopen_data) ? 5 : 4);
816
817 return g;
818 }
819
820
821
822
823
824 #ifndef DISABLE_TLS
825 static gstring *
826 d_tlslog(gstring * g, address_item * addr)
827 {
828 if (LOGGING(tls_cipher) && addr->cipher)
829   {
830   g = string_append(g, 2, US" X=", addr->cipher);
831 #ifndef DISABLE_TLS_RESUME
832   if (LOGGING(tls_resumption) && testflag(addr, af_tls_resume))
833     g = string_catn(g, US"*", 1);
834 #endif
835   }
836 if (LOGGING(tls_certificate_verified) && addr->cipher)
837   g = string_append(g, 2, US" CV=",
838     testflag(addr, af_cert_verified)
839     ?
840 #ifdef SUPPORT_DANE
841       testflag(addr, af_dane_verified)
842     ? "dane"
843     :
844 #endif
845       "yes"
846     : "no");
847 if (LOGGING(tls_peerdn) && addr->peerdn)
848   g = string_append(g, 3, US" DN=\"", string_printing(addr->peerdn), US"\"");
849 return g;
850 }
851 #endif
852
853
854
855
856 #ifndef DISABLE_EVENT
857 /* Distribute a named event to any listeners.
858
859 Args:   action  config option specifying listener
860         event   name of the event
861         ev_data associated data for the event
862         errnop  pointer to errno for modification, or null
863
864 Return: string expansion from listener, or NULL
865 */
866
867 uschar *
868 event_raise(uschar * action, const uschar * event, uschar * ev_data, int * errnop)
869 {
870 uschar * s;
871 if (action)
872   {
873   DEBUG(D_deliver)
874     debug_printf("Event(%s): event_action=|%s| delivery_IP=%s\n",
875       event,
876       action, deliver_host_address);
877
878   event_name = event;
879   event_data = ev_data;
880
881   if (!(s = expand_string(action)) && *expand_string_message)
882     log_write(0, LOG_MAIN|LOG_PANIC,
883       "failed to expand event_action %s in %s: %s\n",
884       event, transport_name ? transport_name : US"main", expand_string_message);
885
886   event_name = event_data = NULL;
887
888   /* If the expansion returns anything but an empty string, flag for
889   the caller to modify his normal processing
890   */
891   if (s && *s)
892     {
893     DEBUG(D_deliver)
894       debug_printf("Event(%s): event_action returned \"%s\"\n", event, s);
895     if (errnop)
896       *errnop = ERRNO_EVENT;
897     return s;
898     }
899   }
900 return NULL;
901 }
902
903 void
904 msg_event_raise(const uschar * event, const address_item * addr)
905 {
906 const uschar * save_domain = deliver_domain;
907 uschar * save_local =  deliver_localpart;
908 const uschar * save_host = deliver_host;
909 const uschar * save_address = deliver_host_address;
910 const int      save_port =   deliver_host_port;
911
912 router_name =    addr->router ? addr->router->name : NULL;
913 deliver_domain = addr->domain;
914 deliver_localpart = addr->local_part;
915 deliver_host =   addr->host_used ? addr->host_used->name : NULL;
916
917 if (!addr->transport)
918   {
919   if (Ustrcmp(event, "msg:fail:delivery") == 0)
920     {
921      /* An address failed with no transport involved. This happens when
922      a filter was used which triggered a fail command (in such a case
923      a transport isn't needed).  Convert it to an internal fail event. */
924
925     (void) event_raise(event_action, US"msg:fail:internal", addr->message, NULL);
926     }
927   }
928 else
929   {
930   transport_name = addr->transport->name;
931
932   (void) event_raise(addr->transport->event_action, event,
933             addr->host_used
934             || Ustrcmp(addr->transport->driver_name, "smtp") == 0
935             || Ustrcmp(addr->transport->driver_name, "lmtp") == 0
936             || Ustrcmp(addr->transport->driver_name, "autoreply") == 0
937            ? addr->message : NULL,
938            NULL);
939   }
940
941 deliver_host_port =    save_port;
942 deliver_host_address = save_address;
943 deliver_host =      save_host;
944 deliver_localpart = save_local;
945 deliver_domain =    save_domain;
946 router_name = transport_name = NULL;
947 }
948 #endif  /*DISABLE_EVENT*/
949
950
951
952 /******************************************************************************/
953
954
955 /*************************************************
956 *        Generate local prt for logging          *
957 *************************************************/
958
959 /* This function is a subroutine for use in string_log_address() below.
960
961 Arguments:
962   addr        the address being logged
963   yield       the current dynamic buffer pointer
964
965 Returns:      the new value of the buffer pointer
966 */
967
968 static gstring *
969 string_get_localpart(address_item * addr, gstring * yield)
970 {
971 uschar * s;
972
973 s = addr->prefix;
974 if (testflag(addr, af_include_affixes) && s)
975   {
976 #ifdef SUPPORT_I18N
977   if (testflag(addr, af_utf8_downcvt))
978     s = string_localpart_utf8_to_alabel(s, NULL);
979 #endif
980   yield = string_cat(yield, s);
981   }
982
983 s = addr->local_part;
984 #ifdef SUPPORT_I18N
985 if (testflag(addr, af_utf8_downcvt))
986   s = string_localpart_utf8_to_alabel(s, NULL);
987 #endif
988 yield = string_cat(yield, s);
989
990 s = addr->suffix;
991 if (testflag(addr, af_include_affixes) && s)
992   {
993 #ifdef SUPPORT_I18N
994   if (testflag(addr, af_utf8_downcvt))
995     s = string_localpart_utf8_to_alabel(s, NULL);
996 #endif
997   yield = string_cat(yield, s);
998   }
999
1000 return yield;
1001 }
1002
1003
1004 /*************************************************
1005 *          Generate log address list             *
1006 *************************************************/
1007
1008 /* This function generates a list consisting of an address and its parents, for
1009 use in logging lines. For saved onetime aliased addresses, the onetime parent
1010 field is used. If the address was delivered by a transport with rcpt_include_
1011 affixes set, the af_include_affixes bit will be set in the address. In that
1012 case, we include the affixes here too.
1013
1014 Arguments:
1015   g             points to growing-string struct
1016   addr          bottom (ultimate) address
1017   all_parents   if TRUE, include all parents
1018   success       TRUE for successful delivery
1019
1020 Returns:        a growable string in dynamic store
1021 */
1022
1023 static gstring *
1024 string_log_address(gstring * g,
1025   address_item *addr, BOOL all_parents, BOOL success)
1026 {
1027 BOOL add_topaddr = TRUE;
1028 address_item *topaddr;
1029
1030 /* Find the ultimate parent */
1031
1032 for (topaddr = addr; topaddr->parent; topaddr = topaddr->parent) ;
1033
1034 /* We start with just the local part for pipe, file, and reply deliveries, and
1035 for successful local deliveries from routers that have the log_as_local flag
1036 set. File deliveries from filters can be specified as non-absolute paths in
1037 cases where the transport is going to complete the path. If there is an error
1038 before this happens (expansion failure) the local part will not be updated, and
1039 so won't necessarily look like a path. Add extra text for this case. */
1040
1041 if (  testflag(addr, af_pfr)
1042    || (  success
1043       && addr->router && addr->router->log_as_local
1044       && addr->transport && addr->transport->info->local
1045    )  )
1046   {
1047   if (testflag(addr, af_file) && addr->local_part[0] != '/')
1048     g = string_catn(g, CUS"save ", 5);
1049   g = string_get_localpart(addr, g);
1050   }
1051
1052 /* Other deliveries start with the full address. It we have split it into local
1053 part and domain, use those fields. Some early failures can happen before the
1054 splitting is done; in those cases use the original field. */
1055
1056 else
1057   {
1058   uschar * cmp;
1059   int off = g->ptr;     /* start of the "full address" */
1060
1061   if (addr->local_part)
1062     {
1063     const uschar * s;
1064     g = string_get_localpart(addr, g);
1065     g = string_catn(g, US"@", 1);
1066     s = addr->domain;
1067 #ifdef SUPPORT_I18N
1068     if (testflag(addr, af_utf8_downcvt))
1069       s = string_localpart_utf8_to_alabel(s, NULL);
1070 #endif
1071     g = string_cat(g, s);
1072     }
1073   else
1074     g = string_cat(g, addr->address);
1075
1076   /* If the address we are going to print is the same as the top address,
1077   and all parents are not being included, don't add on the top address. First
1078   of all, do a caseless comparison; if this succeeds, do a caseful comparison
1079   on the local parts. */
1080
1081   cmp = g->s + off;             /* only now, as rebuffer likely done */
1082   string_from_gstring(g);       /* ensure nul-terminated */
1083   if (  strcmpic(cmp, topaddr->address) == 0
1084      && Ustrncmp(cmp, topaddr->address, Ustrchr(cmp, '@') - cmp) == 0
1085      && !addr->onetime_parent
1086      && (!all_parents || !addr->parent || addr->parent == topaddr)
1087      )
1088     add_topaddr = FALSE;
1089   }
1090
1091 /* If all parents are requested, or this is a local pipe/file/reply, and
1092 there is at least one intermediate parent, show it in brackets, and continue
1093 with all of them if all are wanted. */
1094
1095 if (  (all_parents || testflag(addr, af_pfr))
1096    && addr->parent
1097    && addr->parent != topaddr)
1098   {
1099   uschar *s = US" (";
1100   for (address_item * addr2 = addr->parent; addr2 != topaddr; addr2 = addr2->parent)
1101     {
1102     g = string_catn(g, s, 2);
1103     g = string_cat (g, addr2->address);
1104     if (!all_parents) break;
1105     s = US", ";
1106     }
1107   g = string_catn(g, US")", 1);
1108   }
1109
1110 /* Add the top address if it is required */
1111
1112 if (add_topaddr)
1113   g = string_append(g, 3,
1114     US" <",
1115     addr->onetime_parent ? addr->onetime_parent : topaddr->address,
1116     US">");
1117
1118 return g;
1119 }
1120
1121
1122
1123 /******************************************************************************/
1124
1125
1126
1127 /* If msg is NULL this is a delivery log and logchar is used. Otherwise
1128 this is a nonstandard call; no two-character delivery flag is written
1129 but sender-host and sender are prefixed and "msg" is inserted in the log line.
1130
1131 Arguments:
1132   flags         passed to log_write()
1133 */
1134 void
1135 delivery_log(int flags, address_item * addr, int logchar, uschar * msg)
1136 {
1137 gstring * g; /* Used for a temporary, expanding buffer, for building log lines  */
1138 rmark reset_point;
1139
1140 /* Log the delivery on the main log. We use an extensible string to build up
1141 the log line, and reset the store afterwards. Remote deliveries should always
1142 have a pointer to the host item that succeeded; local deliveries can have a
1143 pointer to a single host item in their host list, for use by the transport. */
1144
1145 #ifndef DISABLE_EVENT
1146   /* presume no successful remote delivery */
1147   lookup_dnssec_authenticated = NULL;
1148 #endif
1149
1150 reset_point = store_mark();
1151 g = string_get_tainted(256, TRUE);      /* addrs will be tainted, so avoid copy */
1152
1153 if (msg)
1154   g = string_append(g, 2, host_and_ident(TRUE), US" ");
1155 else
1156   {
1157   g->s[0] = logchar; g->ptr = 1;
1158   g = string_catn(g, US"> ", 2);
1159   }
1160 g = string_log_address(g, addr, LOGGING(all_parents), TRUE);
1161
1162 if (LOGGING(sender_on_delivery) || msg)
1163   g = string_append(g, 3, US" F=<",
1164 #ifdef SUPPORT_I18N
1165     testflag(addr, af_utf8_downcvt)
1166     ? string_address_utf8_to_alabel(sender_address, NULL)
1167     :
1168 #endif
1169       sender_address,
1170   US">");
1171
1172 if (*queue_name)
1173   g = string_append(g, 2, US" Q=", queue_name);
1174
1175 /* You might think that the return path must always be set for a successful
1176 delivery; indeed, I did for some time, until this statement crashed. The case
1177 when it is not set is for a delivery to /dev/null which is optimised by not
1178 being run at all. */
1179
1180 if (used_return_path && LOGGING(return_path_on_delivery))
1181   g = string_append(g, 3, US" P=<", used_return_path, US">");
1182
1183 if (msg)
1184   g = string_append(g, 2, US" ", msg);
1185
1186 /* For a delivery from a system filter, there may not be a router */
1187 if (addr->router)
1188   g = string_append(g, 2, US" R=", addr->router->name);
1189
1190 g = string_append(g, 2, US" T=", addr->transport->name);
1191
1192 if (LOGGING(delivery_size))
1193   g = string_fmt_append(g, " S=%d", transport_count);
1194
1195 /* Local delivery */
1196
1197 if (addr->transport->info->local)
1198   {
1199   if (addr->host_list)
1200     g = string_append(g, 2, US" H=", addr->host_list->name);
1201   g = d_log_interface(g);
1202   if (addr->shadow_message)
1203     g = string_cat(g, addr->shadow_message);
1204   }
1205
1206 /* Remote delivery */
1207
1208 else
1209   {
1210   if (addr->host_used)
1211     {
1212     g = d_hostlog(g, addr);
1213
1214 #ifndef DISABLE_EVENT
1215     deliver_host_address = addr->host_used->address;
1216     deliver_host_port =    addr->host_used->port;
1217     deliver_host =         addr->host_used->name;
1218
1219     /* DNS lookup status */
1220     lookup_dnssec_authenticated = addr->host_used->dnssec==DS_YES ? US"yes"
1221                               : addr->host_used->dnssec==DS_NO ? US"no"
1222                               : NULL;
1223 #endif
1224     }
1225
1226 #ifndef DISABLE_TLS
1227   g = d_tlslog(g, addr);
1228 #endif
1229
1230   if (addr->authenticator)
1231     {
1232     g = string_append(g, 2, US" A=", addr->authenticator);
1233     if (addr->auth_id)
1234       {
1235       g = string_append(g, 2, US":", addr->auth_id);
1236       if (LOGGING(smtp_mailauth) && addr->auth_sndr)
1237         g = string_append(g, 2, US":", addr->auth_sndr);
1238       }
1239     }
1240
1241   if (LOGGING(pipelining))
1242     {
1243     if (testflag(addr, af_pipelining))
1244       g = string_catn(g, US" L", 2);
1245 #ifndef DISABLE_PIPE_CONNECT
1246     if (testflag(addr, af_early_pipe))
1247       g = string_catn(g, US"*", 1);
1248 #endif
1249     }
1250
1251 #ifndef DISABLE_PRDR
1252   if (testflag(addr, af_prdr_used))
1253     g = string_catn(g, US" PRDR", 5);
1254 #endif
1255
1256   if (testflag(addr, af_chunking_used))
1257     g = string_catn(g, US" K", 2);
1258   }
1259
1260 /* confirmation message (SMTP (host_used) and LMTP (driver_name)) */
1261
1262 if (  LOGGING(smtp_confirmation)
1263    && addr->message
1264    && (addr->host_used || Ustrcmp(addr->transport->driver_name, "lmtp") == 0)
1265    )
1266   {
1267   unsigned lim = big_buffer_size < 1024 ? big_buffer_size : 1024;
1268   uschar *p = big_buffer;
1269   uschar *ss = addr->message;
1270   *p++ = '\"';
1271   for (int i = 0; i < lim && ss[i] != 0; i++)   /* limit logged amount */
1272     {
1273     if (ss[i] == '\"' || ss[i] == '\\') *p++ = '\\'; /* quote \ and " */
1274     *p++ = ss[i];
1275     }
1276   *p++ = '\"';
1277   *p = 0;
1278   g = string_append(g, 2, US" C=", big_buffer);
1279   }
1280
1281 /* Time on queue and actual time taken to deliver */
1282
1283 if (LOGGING(queue_time))
1284   g = string_append(g, 2, US" QT=", string_timesince(
1285     LOGGING(queue_time_exclusive) ? &received_time_complete : &received_time));
1286
1287 if (LOGGING(deliver_time))
1288   g = string_append(g, 2, US" DT=", string_timediff(&addr->delivery_time));
1289
1290 /* string_cat() always leaves room for the terminator. Release the
1291 store we used to build the line after writing it. */
1292
1293 log_write(0, flags, "%s", string_from_gstring(g));
1294
1295 #ifndef DISABLE_EVENT
1296 if (!msg) msg_event_raise(US"msg:delivery", addr);
1297 #endif
1298
1299 store_reset(reset_point);
1300 return;
1301 }
1302
1303
1304
1305 static void
1306 deferral_log(address_item * addr, uschar * now,
1307   int logflags, uschar * driver_name, uschar * driver_kind)
1308 {
1309 rmark reset_point = store_mark();
1310 gstring * g = string_get(256);
1311
1312 /* Build up the line that is used for both the message log and the main
1313 log. */
1314
1315 /* Create the address string for logging. Must not do this earlier, because
1316 an OK result may be changed to FAIL when a pipe returns text. */
1317
1318 g = string_log_address(g, addr, LOGGING(all_parents), FALSE);
1319
1320 if (*queue_name)
1321   g = string_append(g, 2, US" Q=", queue_name);
1322
1323 /* Either driver_name contains something and driver_kind contains
1324 " router" or " transport" (note the leading space), or driver_name is
1325 a null string and driver_kind contains "routing" without the leading
1326 space, if all routing has been deferred. When a domain has been held,
1327 so nothing has been done at all, both variables contain null strings. */
1328
1329 if (driver_name)
1330   {
1331   if (driver_kind[1] == 't' && addr->router)
1332     g = string_append(g, 2, US" R=", addr->router->name);
1333   g = string_fmt_append(g, " %c=%s", toupper(driver_kind[1]), driver_name);
1334   }
1335 else if (driver_kind)
1336   g = string_append(g, 2, US" ", driver_kind);
1337
1338 g = string_fmt_append(g, " defer (%d)", addr->basic_errno);
1339
1340 if (addr->basic_errno > 0)
1341   g = string_append(g, 2, US": ", US strerror(addr->basic_errno));
1342
1343 if (addr->host_used)
1344   g = d_hostlog(g, addr);
1345
1346 if (LOGGING(deliver_time))
1347   g = string_append(g, 2, US" DT=", string_timediff(&addr->delivery_time));
1348
1349 if (addr->message)
1350   g = string_append(g, 2, US": ", addr->message);
1351
1352 (void) string_from_gstring(g);
1353
1354 /* Log the deferment in the message log, but don't clutter it
1355 up with retry-time defers after the first delivery attempt. */
1356
1357 if (f.deliver_firsttime || addr->basic_errno > ERRNO_RETRY_BASE)
1358   deliver_msglog("%s %s\n", now, g->s);
1359
1360 /* Write the main log and reset the store.
1361 For errors of the type "retry time not reached" (also remotes skipped
1362 on queue run), logging is controlled by L_retry_defer. Note that this kind
1363 of error number is negative, and all the retry ones are less than any
1364 others. */
1365
1366
1367 log_write(addr->basic_errno <= ERRNO_RETRY_BASE ? L_retry_defer : 0, logflags,
1368   "== %s", g->s);
1369
1370 store_reset(reset_point);
1371 return;
1372 }
1373
1374
1375
1376 static void
1377 failure_log(address_item * addr, uschar * driver_kind, uschar * now)
1378 {
1379 rmark reset_point = store_mark();
1380 gstring * g = string_get(256);
1381
1382 #ifndef DISABLE_EVENT
1383 /* Message failures for which we will send a DSN get their event raised
1384 later so avoid doing it here. */
1385
1386 if (  !addr->prop.ignore_error
1387    && !(addr->dsn_flags & (rf_dsnflags & ~rf_notify_failure))
1388    )
1389   msg_event_raise(US"msg:fail:delivery", addr);
1390 #endif
1391
1392 /* Build up the log line for the message and main logs */
1393
1394 /* Create the address string for logging. Must not do this earlier, because
1395 an OK result may be changed to FAIL when a pipe returns text. */
1396
1397 g = string_log_address(g, addr, LOGGING(all_parents), FALSE);
1398
1399 if (LOGGING(sender_on_delivery))
1400   g = string_append(g, 3, US" F=<", sender_address, US">");
1401
1402 if (*queue_name)
1403   g = string_append(g, 2, US" Q=", queue_name);
1404
1405 /* Return path may not be set if no delivery actually happened */
1406
1407 if (used_return_path && LOGGING(return_path_on_delivery))
1408   g = string_append(g, 3, US" P=<", used_return_path, US">");
1409
1410 if (addr->router)
1411   g = string_append(g, 2, US" R=", addr->router->name);
1412 if (addr->transport)
1413   g = string_append(g, 2, US" T=", addr->transport->name);
1414
1415 if (addr->host_used)
1416   g = d_hostlog(g, addr);
1417
1418 #ifndef DISABLE_TLS
1419 g = d_tlslog(g, addr);
1420 #endif
1421
1422 if (addr->basic_errno > 0)
1423   g = string_append(g, 2, US": ", US strerror(addr->basic_errno));
1424
1425 if (addr->message)
1426   g = string_append(g, 2, US": ", addr->message);
1427
1428 if (LOGGING(deliver_time))
1429   g = string_append(g, 2, US" DT=", string_timediff(&addr->delivery_time));
1430
1431 (void) string_from_gstring(g);
1432
1433 /* Do the logging. For the message log, "routing failed" for those cases,
1434 just to make it clearer. */
1435
1436 if (driver_kind)
1437   deliver_msglog("%s %s failed for %s\n", now, driver_kind, g->s);
1438 else
1439   deliver_msglog("%s %s\n", now, g->s);
1440
1441 log_write(0, LOG_MAIN, "** %s", g->s);
1442
1443 store_reset(reset_point);
1444 return;
1445 }
1446
1447
1448
1449 /*************************************************
1450 *    Actions at the end of handling an address   *
1451 *************************************************/
1452
1453 /* This is a function for processing a single address when all that can be done
1454 with it has been done.
1455
1456 Arguments:
1457   addr         points to the address block
1458   result       the result of the delivery attempt
1459   logflags     flags for log_write() (LOG_MAIN and/or LOG_PANIC)
1460   driver_type  indicates which type of driver (transport, or router) was last
1461                  to process the address
1462   logchar      '=' or '-' for use when logging deliveries with => or ->
1463
1464 Returns:       nothing
1465 */
1466
1467 static void
1468 post_process_one(address_item *addr, int result, int logflags, int driver_type,
1469   int logchar)
1470 {
1471 uschar *now = tod_stamp(tod_log);
1472 uschar *driver_kind = NULL;
1473 uschar *driver_name = NULL;
1474
1475 DEBUG(D_deliver) debug_printf("post-process %s (%d)\n", addr->address, result);
1476
1477 /* Set up driver kind and name for logging. Disable logging if the router or
1478 transport has disabled it. */
1479
1480 if (driver_type == EXIM_DTYPE_TRANSPORT)
1481   {
1482   if (addr->transport)
1483     {
1484     driver_name = addr->transport->name;
1485     driver_kind = US" transport";
1486     f.disable_logging = addr->transport->disable_logging;
1487     }
1488   else driver_kind = US"transporting";
1489   }
1490 else if (driver_type == EXIM_DTYPE_ROUTER)
1491   {
1492   if (addr->router)
1493     {
1494     driver_name = addr->router->name;
1495     driver_kind = US" router";
1496     f.disable_logging = addr->router->disable_logging;
1497     }
1498   else driver_kind = US"routing";
1499   }
1500
1501 /* If there's an error message set, ensure that it contains only printing
1502 characters - it should, but occasionally things slip in and this at least
1503 stops the log format from getting wrecked. We also scan the message for an LDAP
1504 expansion item that has a password setting, and flatten the password. This is a
1505 fudge, but I don't know a cleaner way of doing this. (If the item is badly
1506 malformed, it won't ever have gone near LDAP.) */
1507
1508 if (addr->message)
1509   {
1510   const uschar * s = string_printing(addr->message);
1511
1512   /* deconst cast ok as string_printing known to have alloc'n'copied */
1513   addr->message = expand_hide_passwords(US s);
1514   }
1515
1516 /* If we used a transport that has one of the "return_output" options set, and
1517 if it did in fact generate some output, then for return_output we treat the
1518 message as failed if it was not already set that way, so that the output gets
1519 returned to the sender, provided there is a sender to send it to. For
1520 return_fail_output, do this only if the delivery failed. Otherwise we just
1521 unlink the file, and remove the name so that if the delivery failed, we don't
1522 try to send back an empty or unwanted file. The log_output options operate only
1523 on a non-empty file.
1524
1525 In any case, we close the message file, because we cannot afford to leave a
1526 file-descriptor for one address while processing (maybe very many) others. */
1527
1528 if (addr->return_file >= 0 && addr->return_filename)
1529   {
1530   BOOL return_output = FALSE;
1531   struct stat statbuf;
1532   (void)EXIMfsync(addr->return_file);
1533
1534   /* If there is no output, do nothing. */
1535
1536   if (fstat(addr->return_file, &statbuf) == 0 && statbuf.st_size > 0)
1537     {
1538     transport_instance *tb = addr->transport;
1539
1540     /* Handle logging options */
1541
1542     if (  tb->log_output
1543        || result == FAIL  && tb->log_fail_output
1544        || result == DEFER && tb->log_defer_output
1545        )
1546       {
1547       uschar *s;
1548       FILE *f = Ufopen(addr->return_filename, "rb");
1549       if (!f)
1550         log_write(0, LOG_MAIN|LOG_PANIC, "failed to open %s to log output "
1551           "from %s transport: %s", addr->return_filename, tb->name,
1552           strerror(errno));
1553       else
1554         if ((s = US Ufgets(big_buffer, big_buffer_size, f)))
1555           {
1556           uschar *p = big_buffer + Ustrlen(big_buffer);
1557           const uschar * sp;
1558           while (p > big_buffer && isspace(p[-1])) p--;
1559           *p = 0;
1560           sp = string_printing(big_buffer);
1561           log_write(0, LOG_MAIN, "<%s>: %s transport output: %s",
1562             addr->address, tb->name, sp);
1563           }
1564       (void)fclose(f);
1565       }
1566
1567     /* Handle returning options, but only if there is an address to return
1568     the text to. */
1569
1570     if (sender_address[0] != 0 || addr->prop.errors_address)
1571       if (tb->return_output)
1572         {
1573         addr->transport_return = result = FAIL;
1574         if (addr->basic_errno == 0 && !addr->message)
1575           addr->message = US"return message generated";
1576         return_output = TRUE;
1577         }
1578       else
1579         if (tb->return_fail_output && result == FAIL) return_output = TRUE;
1580     }
1581
1582   /* Get rid of the file unless it might be returned, but close it in
1583   all cases. */
1584
1585   if (!return_output)
1586     {
1587     Uunlink(addr->return_filename);
1588     addr->return_filename = NULL;
1589     addr->return_file = -1;
1590     }
1591
1592   (void)close(addr->return_file);
1593   }
1594
1595 /* Check if the transport notifed continue-conn status explicitly, and
1596 update our knowlege. */
1597
1598 if (testflag(addr, af_new_conn))       continue_sequence = 1;
1599 else if (testflag(addr, af_cont_conn)) continue_sequence++;
1600
1601 /* The success case happens only after delivery by a transport. */
1602
1603 if (result == OK)
1604   {
1605   addr->next = addr_succeed;
1606   addr_succeed = addr;
1607
1608   /* Call address_done() to ensure that we don't deliver to this address again,
1609   and write appropriate things to the message log. If it is a child address, we
1610   call child_done() to scan the ancestors and mark them complete if this is the
1611   last child to complete. */
1612
1613   address_done(addr, now);
1614   DEBUG(D_deliver) debug_printf("%s delivered\n", addr->address);
1615
1616   if (!addr->parent)
1617     deliver_msglog("%s %s: %s%s succeeded\n", now, addr->address,
1618       driver_name, driver_kind);
1619   else
1620     {
1621     deliver_msglog("%s %s <%s>: %s%s succeeded\n", now, addr->address,
1622       addr->parent->address, driver_name, driver_kind);
1623     child_done(addr, now);
1624     }
1625
1626   /* Certificates for logging (via events) */
1627 #ifndef DISABLE_TLS
1628   tls_out.ourcert = addr->ourcert;
1629   addr->ourcert = NULL;
1630   tls_out.peercert = addr->peercert;
1631   addr->peercert = NULL;
1632
1633   tls_out.ver = addr->tlsver;
1634   tls_out.cipher = addr->cipher;
1635   tls_out.peerdn = addr->peerdn;
1636   tls_out.ocsp = addr->ocsp;
1637 # ifdef SUPPORT_DANE
1638   tls_out.dane_verified = testflag(addr, af_dane_verified);
1639 # endif
1640 #endif
1641
1642   delivery_log(LOG_MAIN, addr, logchar, NULL);
1643
1644 #ifndef DISABLE_TLS
1645   tls_free_cert(&tls_out.ourcert);
1646   tls_free_cert(&tls_out.peercert);
1647   tls_out.ver = NULL;
1648   tls_out.cipher = NULL;
1649   tls_out.peerdn = NULL;
1650   tls_out.ocsp = OCSP_NOT_REQ;
1651 # ifdef SUPPORT_DANE
1652   tls_out.dane_verified = FALSE;
1653 # endif
1654 #endif
1655   }
1656
1657
1658 /* Soft failure, or local delivery process failed; freezing may be
1659 requested. */
1660
1661 else if (result == DEFER || result == PANIC)
1662   {
1663   if (result == PANIC) logflags |= LOG_PANIC;
1664
1665   /* This puts them on the chain in reverse order. Do not change this, because
1666   the code for handling retries assumes that the one with the retry
1667   information is last. */
1668
1669   addr->next = addr_defer;
1670   addr_defer = addr;
1671
1672   /* The only currently implemented special action is to freeze the
1673   message. Logging of this is done later, just before the -H file is
1674   updated. */
1675
1676   if (addr->special_action == SPECIAL_FREEZE)
1677     {
1678     f.deliver_freeze = TRUE;
1679     deliver_frozen_at = time(NULL);
1680     update_spool = TRUE;
1681     }
1682
1683   /* If doing a 2-stage queue run, we skip writing to either the message
1684   log or the main log for SMTP defers. */
1685
1686   if (!f.queue_2stage || addr->basic_errno != 0)
1687     deferral_log(addr, now, logflags, driver_name, driver_kind);
1688   }
1689
1690
1691 /* Hard failure. If there is an address to which an error message can be sent,
1692 put this address on the failed list. If not, put it on the deferred list and
1693 freeze the mail message for human attention. The latter action can also be
1694 explicitly requested by a router or transport. */
1695
1696 else
1697   {
1698   /* If this is a delivery error, or a message for which no replies are
1699   wanted, and the message's age is greater than ignore_bounce_errors_after,
1700   force the af_ignore_error flag. This will cause the address to be discarded
1701   later (with a log entry). */
1702
1703   if (!*sender_address && message_age >= ignore_bounce_errors_after)
1704     addr->prop.ignore_error = TRUE;
1705
1706   /* Freeze the message if requested, or if this is a bounce message (or other
1707   message with null sender) and this address does not have its own errors
1708   address. However, don't freeze if errors are being ignored. The actual code
1709   to ignore occurs later, instead of sending a message. Logging of freezing
1710   occurs later, just before writing the -H file. */
1711
1712   if (  !addr->prop.ignore_error
1713      && (  addr->special_action == SPECIAL_FREEZE
1714         || (sender_address[0] == 0 && !addr->prop.errors_address)
1715      )  )
1716     {
1717     frozen_info = addr->special_action == SPECIAL_FREEZE
1718       ? US""
1719       : f.sender_local && !f.local_error_message
1720       ? US" (message created with -f <>)"
1721       : US" (delivery error message)";
1722     f.deliver_freeze = TRUE;
1723     deliver_frozen_at = time(NULL);
1724     update_spool = TRUE;
1725
1726     /* The address is put on the defer rather than the failed queue, because
1727     the message is being retained. */
1728
1729     addr->next = addr_defer;
1730     addr_defer = addr;
1731     }
1732
1733   /* Don't put the address on the nonrecipients tree yet; wait until an
1734   error message has been successfully sent. */
1735
1736   else
1737     {
1738     addr->next = addr_failed;
1739     addr_failed = addr;
1740     }
1741
1742   failure_log(addr, driver_name ? NULL : driver_kind, now);
1743   }
1744
1745 /* Ensure logging is turned on again in all cases */
1746
1747 f.disable_logging = FALSE;
1748 }
1749
1750
1751
1752
1753 /*************************************************
1754 *            Address-independent error           *
1755 *************************************************/
1756
1757 /* This function is called when there's an error that is not dependent on a
1758 particular address, such as an expansion string failure. It puts the error into
1759 all the addresses in a batch, logs the incident on the main and panic logs, and
1760 clears the expansions. It is mostly called from local_deliver(), but can be
1761 called for a remote delivery via findugid().
1762
1763 Arguments:
1764   logit        TRUE if (MAIN+PANIC) logging required
1765   addr         the first of the chain of addresses
1766   code         the error code
1767   format       format string for error message, or NULL if already set in addr
1768   ...          arguments for the format
1769
1770 Returns:       nothing
1771 */
1772
1773 static void
1774 common_error(BOOL logit, address_item *addr, int code, uschar *format, ...)
1775 {
1776 addr->basic_errno = code;
1777
1778 if (format)
1779   {
1780   va_list ap;
1781   gstring * g;
1782
1783   va_start(ap, format);
1784   g = string_vformat(NULL, SVFMT_EXTEND|SVFMT_REBUFFER, CS format, ap);
1785   va_end(ap);
1786   addr->message = string_from_gstring(g);
1787   }
1788
1789 for (address_item * addr2 = addr->next; addr2; addr2 = addr2->next)
1790   {
1791   addr2->basic_errno = code;
1792   addr2->message = addr->message;
1793   }
1794
1795 if (logit) log_write(0, LOG_MAIN|LOG_PANIC, "%s", addr->message);
1796 deliver_set_expansions(NULL);
1797 }
1798
1799
1800
1801
1802 /*************************************************
1803 *         Check a "never users" list             *
1804 *************************************************/
1805
1806 /* This function is called to check whether a uid is on one of the two "never
1807 users" lists.
1808
1809 Arguments:
1810   uid         the uid to be checked
1811   nusers      the list to be scanned; the first item in the list is the count
1812
1813 Returns:      TRUE if the uid is on the list
1814 */
1815
1816 static BOOL
1817 check_never_users(uid_t uid, uid_t *nusers)
1818 {
1819 if (!nusers) return FALSE;
1820 for (int i = 1; i <= (int)(nusers[0]); i++) if (nusers[i] == uid) return TRUE;
1821 return FALSE;
1822 }
1823
1824
1825
1826 /*************************************************
1827 *          Find uid and gid for a transport      *
1828 *************************************************/
1829
1830 /* This function is called for both local and remote deliveries, to find the
1831 uid/gid under which to run the delivery. The values are taken preferentially
1832 from the transport (either explicit or deliver_as_creator), then from the
1833 address (i.e. the router), and if nothing is set, the exim uid/gid are used. If
1834 the resulting uid is on the "never_users" or the "fixed_never_users" list, a
1835 panic error is logged, and the function fails (which normally leads to delivery
1836 deferral).
1837
1838 Arguments:
1839   addr         the address (possibly a chain)
1840   tp           the transport
1841   uidp         pointer to uid field
1842   gidp         pointer to gid field
1843   igfp         pointer to the use_initgroups field
1844
1845 Returns:       FALSE if failed - error has been set in address(es)
1846 */
1847
1848 static BOOL
1849 findugid(address_item *addr, transport_instance *tp, uid_t *uidp, gid_t *gidp,
1850   BOOL *igfp)
1851 {
1852 uschar *nuname;
1853 BOOL gid_set = FALSE;
1854
1855 /* Default initgroups flag comes from the transport */
1856
1857 *igfp = tp->initgroups;
1858
1859 /* First see if there's a gid on the transport, either fixed or expandable.
1860 The expanding function always logs failure itself. */
1861
1862 if (tp->gid_set)
1863   {
1864   *gidp = tp->gid;
1865   gid_set = TRUE;
1866   }
1867 else if (tp->expand_gid)
1868   {
1869   if (!route_find_expanded_group(tp->expand_gid, tp->name, US"transport", gidp,
1870     &(addr->message)))
1871     {
1872     common_error(FALSE, addr, ERRNO_GIDFAIL, NULL);
1873     return FALSE;
1874     }
1875   gid_set = TRUE;
1876   }
1877
1878 /* If the transport did not set a group, see if the router did. */
1879
1880 if (!gid_set && testflag(addr, af_gid_set))
1881   {
1882   *gidp = addr->gid;
1883   gid_set = TRUE;
1884   }
1885
1886 /* Pick up a uid from the transport if one is set. */
1887
1888 if (tp->uid_set) *uidp = tp->uid;
1889
1890 /* Otherwise, try for an expandable uid field. If it ends up as a numeric id,
1891 it does not provide a passwd value from which a gid can be taken. */
1892
1893 else if (tp->expand_uid)
1894   {
1895   struct passwd *pw;
1896   if (!route_find_expanded_user(tp->expand_uid, tp->name, US"transport", &pw,
1897        uidp, &(addr->message)))
1898     {
1899     common_error(FALSE, addr, ERRNO_UIDFAIL, NULL);
1900     return FALSE;
1901     }
1902   if (!gid_set && pw)
1903     {
1904     *gidp = pw->pw_gid;
1905     gid_set = TRUE;
1906     }
1907   }
1908
1909 /* If the transport doesn't set the uid, test the deliver_as_creator flag. */
1910
1911 else if (tp->deliver_as_creator)
1912   {
1913   *uidp = originator_uid;
1914   if (!gid_set)
1915     {
1916     *gidp = originator_gid;
1917     gid_set = TRUE;
1918     }
1919   }
1920
1921 /* Otherwise see if the address specifies the uid and if so, take it and its
1922 initgroups flag. */
1923
1924 else if (testflag(addr, af_uid_set))
1925   {
1926   *uidp = addr->uid;
1927   *igfp = testflag(addr, af_initgroups);
1928   }
1929
1930 /* Nothing has specified the uid - default to the Exim user, and group if the
1931 gid is not set. */
1932
1933 else
1934   {
1935   *uidp = exim_uid;
1936   if (!gid_set)
1937     {
1938     *gidp = exim_gid;
1939     gid_set = TRUE;
1940     }
1941   }
1942
1943 /* If no gid is set, it is a disaster. We default to the Exim gid only if
1944 defaulting to the Exim uid. In other words, if the configuration has specified
1945 a uid, it must also provide a gid. */
1946
1947 if (!gid_set)
1948   {
1949   common_error(TRUE, addr, ERRNO_GIDFAIL, US"User set without group for "
1950     "%s transport", tp->name);
1951   return FALSE;
1952   }
1953
1954 /* Check that the uid is not on the lists of banned uids that may not be used
1955 for delivery processes. */
1956
1957 nuname = check_never_users(*uidp, never_users)
1958   ? US"never_users"
1959   : check_never_users(*uidp, fixed_never_users)
1960   ? US"fixed_never_users"
1961   : NULL;
1962 if (nuname)
1963   {
1964   common_error(TRUE, addr, ERRNO_UIDFAIL, US"User %ld set for %s transport "
1965     "is on the %s list", (long int)(*uidp), tp->name, nuname);
1966   return FALSE;
1967   }
1968
1969 /* All is well */
1970
1971 return TRUE;
1972 }
1973
1974
1975
1976
1977 /*************************************************
1978 *   Check the size of a message for a transport  *
1979 *************************************************/
1980
1981 /* Checks that the message isn't too big for the selected transport.
1982 This is called only when it is known that the limit is set.
1983
1984 Arguments:
1985   tp          the transport
1986   addr        the (first) address being delivered
1987
1988 Returns:      OK
1989               DEFER   expansion failed or did not yield an integer
1990               FAIL    message too big
1991 */
1992
1993 int
1994 check_message_size(transport_instance *tp, address_item *addr)
1995 {
1996 int rc = OK;
1997 int size_limit;
1998
1999 deliver_set_expansions(addr);
2000 size_limit = expand_string_integer(tp->message_size_limit, TRUE);
2001 deliver_set_expansions(NULL);
2002
2003 if (expand_string_message)
2004   {
2005   rc = DEFER;
2006   addr->message = size_limit == -1
2007     ? string_sprintf("failed to expand message_size_limit "
2008       "in %s transport: %s", tp->name, expand_string_message)
2009     : string_sprintf("invalid message_size_limit "
2010       "in %s transport: %s", tp->name, expand_string_message);
2011   }
2012 else if (size_limit > 0 && message_size > size_limit)
2013   {
2014   rc = FAIL;
2015   addr->message =
2016     string_sprintf("message is too big (transport limit = %d)",
2017       size_limit);
2018   }
2019
2020 return rc;
2021 }
2022
2023
2024
2025 /*************************************************
2026 *  Transport-time check for a previous delivery  *
2027 *************************************************/
2028
2029 /* Check that this base address hasn't previously been delivered to its routed
2030 transport. If it has been delivered, mark it done. The check is necessary at
2031 delivery time in order to handle homonymic addresses correctly in cases where
2032 the pattern of redirection changes between delivery attempts (so the unique
2033 fields change). Non-homonymic previous delivery is detected earlier, at routing
2034 time (which saves unnecessary routing).
2035
2036 Arguments:
2037   addr      the address item
2038   testing   TRUE if testing wanted only, without side effects
2039
2040 Returns:    TRUE if previously delivered by the transport
2041 */
2042
2043 static BOOL
2044 previously_transported(address_item *addr, BOOL testing)
2045 {
2046 uschar * s = string_sprintf("%s/%s",
2047   addr->unique + (testflag(addr, af_homonym)? 3:0), addr->transport->name);
2048
2049 if (tree_search(tree_nonrecipients, s) != 0)
2050   {
2051   DEBUG(D_deliver|D_route|D_transport)
2052     debug_printf("%s was previously delivered (%s transport): discarded\n",
2053     addr->address, addr->transport->name);
2054   if (!testing) child_done(addr, tod_stamp(tod_log));
2055   return TRUE;
2056   }
2057
2058 return FALSE;
2059 }
2060
2061
2062
2063 /******************************************************
2064 *      Check for a given header in a header string    *
2065 ******************************************************/
2066
2067 /* This function is used when generating quota warnings. The configuration may
2068 specify any header lines it likes in quota_warn_message. If certain of them are
2069 missing, defaults are inserted, so we need to be able to test for the presence
2070 of a given header.
2071
2072 Arguments:
2073   hdr         the required header name
2074   hstring     the header string
2075
2076 Returns:      TRUE  the header is in the string
2077               FALSE the header is not in the string
2078 */
2079
2080 static BOOL
2081 contains_header(uschar *hdr, uschar *hstring)
2082 {
2083 int len = Ustrlen(hdr);
2084 uschar *p = hstring;
2085 while (*p != 0)
2086   {
2087   if (strncmpic(p, hdr, len) == 0)
2088     {
2089     p += len;
2090     while (*p == ' ' || *p == '\t') p++;
2091     if (*p == ':') return TRUE;
2092     }
2093   while (*p != 0 && *p != '\n') p++;
2094   if (*p == '\n') p++;
2095   }
2096 return FALSE;
2097 }
2098
2099
2100
2101
2102 /*************************************************
2103 *           Perform a local delivery             *
2104 *************************************************/
2105
2106 /* Each local delivery is performed in a separate process which sets its
2107 uid and gid as specified. This is a safer way than simply changing and
2108 restoring using seteuid(); there is a body of opinion that seteuid()
2109 cannot be used safely. From release 4, Exim no longer makes any use of
2110 it for delivery. Besides, not all systems have seteuid().
2111
2112 If the uid/gid are specified in the transport_instance, they are used; the
2113 transport initialization must ensure that either both or neither are set.
2114 Otherwise, the values associated with the address are used. If neither are set,
2115 it is a configuration error.
2116
2117 The transport or the address may specify a home directory (transport over-
2118 rides), and if they do, this is set as $home. If neither have set a working
2119 directory, this value is used for that as well. Otherwise $home is left unset
2120 and the cwd is set to "/" - a directory that should be accessible to all users.
2121
2122 Using a separate process makes it more complicated to get error information
2123 back. We use a pipe to pass the return code and also an error code and error
2124 text string back to the parent process.
2125
2126 Arguments:
2127   addr       points to an address block for this delivery; for "normal" local
2128              deliveries this is the only address to be delivered, but for
2129              pseudo-remote deliveries (e.g. by batch SMTP to a file or pipe)
2130              a number of addresses can be handled simultaneously, and in this
2131              case addr will point to a chain of addresses with the same
2132              characteristics.
2133
2134   shadowing  TRUE if running a shadow transport; this causes output from pipes
2135              to be ignored.
2136
2137 Returns:     nothing
2138 */
2139
2140 void
2141 deliver_local(address_item *addr, BOOL shadowing)
2142 {
2143 BOOL use_initgroups;
2144 uid_t uid;
2145 gid_t gid;
2146 int status, len, rc;
2147 int pfd[2];
2148 pid_t pid;
2149 uschar *working_directory;
2150 address_item *addr2;
2151 transport_instance *tp = addr->transport;
2152
2153 /* Set up the return path from the errors or sender address. If the transport
2154 has its own return path setting, expand it and replace the existing value. */
2155
2156 if(addr->prop.errors_address)
2157   return_path = addr->prop.errors_address;
2158 else
2159   return_path = sender_address;
2160
2161 if (tp->return_path)
2162   {
2163   uschar * new_return_path = expand_string(tp->return_path);
2164   if (new_return_path)
2165     return_path = new_return_path;
2166   else if (!f.expand_string_forcedfail)
2167     {
2168     common_error(TRUE, addr, ERRNO_EXPANDFAIL,
2169       US"Failed to expand return path \"%s\" in %s transport: %s",
2170       tp->return_path, tp->name, expand_string_message);
2171     return;
2172     }
2173   }
2174
2175 /* For local deliveries, one at a time, the value used for logging can just be
2176 set directly, once and for all. */
2177
2178 used_return_path = return_path;
2179
2180 /* Sort out the uid, gid, and initgroups flag. If an error occurs, the message
2181 gets put into the address(es), and the expansions are unset, so we can just
2182 return. */
2183
2184 if (!findugid(addr, tp, &uid, &gid, &use_initgroups)) return;
2185
2186 /* See if either the transport or the address specifies a home directory. A
2187 home directory set in the address may already be expanded; a flag is set to
2188 indicate that. In other cases we must expand it. */
2189
2190 if (  (deliver_home = tp->home_dir)             /* Set in transport, or */
2191    || (  (deliver_home = addr->home_dir)        /* Set in address and */
2192       && !testflag(addr, af_home_expanded)      /*   not expanded */
2193    )  )
2194   {
2195   uschar *rawhome = deliver_home;
2196   deliver_home = NULL;                      /* in case it contains $home */
2197   if (!(deliver_home = expand_string(rawhome)))
2198     {
2199     common_error(TRUE, addr, ERRNO_EXPANDFAIL, US"home directory \"%s\" failed "
2200       "to expand for %s transport: %s", rawhome, tp->name,
2201       expand_string_message);
2202     return;
2203     }
2204   if (*deliver_home != '/')
2205     {
2206     common_error(TRUE, addr, ERRNO_NOTABSOLUTE, US"home directory path \"%s\" "
2207       "is not absolute for %s transport", deliver_home, tp->name);
2208     return;
2209     }
2210   }
2211
2212 /* See if either the transport or the address specifies a current directory,
2213 and if so, expand it. If nothing is set, use the home directory, unless it is
2214 also unset in which case use "/", which is assumed to be a directory to which
2215 all users have access. It is necessary to be in a visible directory for some
2216 operating systems when running pipes, as some commands (e.g. "rm" under Solaris
2217 2.5) require this. */
2218
2219 working_directory = tp->current_dir ? tp->current_dir : addr->current_dir;
2220 if (working_directory)
2221   {
2222   uschar *raw = working_directory;
2223   if (!(working_directory = expand_string(raw)))
2224     {
2225     common_error(TRUE, addr, ERRNO_EXPANDFAIL, US"current directory \"%s\" "
2226       "failed to expand for %s transport: %s", raw, tp->name,
2227       expand_string_message);
2228     return;
2229     }
2230   if (*working_directory != '/')
2231     {
2232     common_error(TRUE, addr, ERRNO_NOTABSOLUTE, US"current directory path "
2233       "\"%s\" is not absolute for %s transport", working_directory, tp->name);
2234     return;
2235     }
2236   }
2237 else working_directory = deliver_home ? deliver_home : US"/";
2238
2239 /* If one of the return_output flags is set on the transport, create and open a
2240 file in the message log directory for the transport to write its output onto.
2241 This is mainly used by pipe transports. The file needs to be unique to the
2242 address. This feature is not available for shadow transports. */
2243
2244 if (  !shadowing
2245    && (  tp->return_output || tp->return_fail_output
2246       || tp->log_output || tp->log_fail_output || tp->log_defer_output
2247    )  )
2248   {
2249   uschar * error;
2250
2251   addr->return_filename =
2252     spool_fname(US"msglog", message_subdir, message_id,
2253       string_sprintf("-%d-%d", getpid(), return_count++));
2254
2255   if ((addr->return_file = open_msglog_file(addr->return_filename, 0400, &error)) < 0)
2256     {
2257     common_error(TRUE, addr, errno, US"Unable to %s file for %s transport "
2258       "to return message: %s", error, tp->name, strerror(errno));
2259     return;
2260     }
2261   }
2262
2263 /* Create the pipe for inter-process communication. */
2264
2265 if (pipe(pfd) != 0)
2266   {
2267   common_error(TRUE, addr, ERRNO_PIPEFAIL, US"Creation of pipe failed: %s",
2268     strerror(errno));
2269   return;
2270   }
2271
2272 /* Now fork the process to do the real work in the subprocess, but first
2273 ensure that all cached resources are freed so that the subprocess starts with
2274 a clean slate and doesn't interfere with the parent process. */
2275
2276 search_tidyup();
2277
2278 if ((pid = exim_fork(US"delivery-local")) == 0)
2279   {
2280   BOOL replicate = TRUE;
2281
2282   /* Prevent core dumps, as we don't want them in users' home directories.
2283   HP-UX doesn't have RLIMIT_CORE; I don't know how to do this in that
2284   system. Some experimental/developing systems (e.g. GNU/Hurd) may define
2285   RLIMIT_CORE but not support it in setrlimit(). For such systems, do not
2286   complain if the error is "not supported".
2287
2288   There are two scenarios where changing the max limit has an effect.  In one,
2289   the user is using a .forward and invoking a command of their choice via pipe;
2290   for these, we do need the max limit to be 0 unless the admin chooses to
2291   permit an increased limit.  In the other, the command is invoked directly by
2292   the transport and is under administrator control, thus being able to raise
2293   the limit aids in debugging.  So there's no general always-right answer.
2294
2295   Thus we inhibit core-dumps completely but let individual transports, while
2296   still root, re-raise the limits back up to aid debugging.  We make the
2297   default be no core-dumps -- few enough people can use core dumps in
2298   diagnosis that it's reasonable to make them something that has to be explicitly requested.
2299   */
2300
2301 #ifdef RLIMIT_CORE
2302   struct rlimit rl;
2303   rl.rlim_cur = 0;
2304   rl.rlim_max = 0;
2305   if (setrlimit(RLIMIT_CORE, &rl) < 0)
2306     {
2307 # ifdef SETRLIMIT_NOT_SUPPORTED
2308     if (errno != ENOSYS && errno != ENOTSUP)
2309 # endif
2310       log_write(0, LOG_MAIN|LOG_PANIC, "setrlimit(RLIMIT_CORE) failed: %s",
2311         strerror(errno));
2312     }
2313 #endif
2314
2315   /* Reset the random number generator, so different processes don't all
2316   have the same sequence. */
2317
2318   random_seed = 0;
2319
2320   /* If the transport has a setup entry, call this first, while still
2321   privileged. (Appendfile uses this to expand quota, for example, while
2322   able to read private files.) */
2323
2324   if (addr->transport->setup)
2325     switch((addr->transport->setup)(addr->transport, addr, NULL, uid, gid,
2326            &(addr->message)))
2327       {
2328       case DEFER:
2329         addr->transport_return = DEFER;
2330         goto PASS_BACK;
2331
2332       case FAIL:
2333         addr->transport_return = PANIC;
2334         goto PASS_BACK;
2335       }
2336
2337   /* Ignore SIGINT and SIGTERM during delivery. Also ignore SIGUSR1, as
2338   when the process becomes unprivileged, it won't be able to write to the
2339   process log. SIGHUP is ignored throughout exim, except when it is being
2340   run as a daemon. */
2341
2342   signal(SIGINT, SIG_IGN);
2343   signal(SIGTERM, SIG_IGN);
2344   signal(SIGUSR1, SIG_IGN);
2345
2346   /* Close the unwanted half of the pipe, and set close-on-exec for the other
2347   half - for transports that exec things (e.g. pipe). Then set the required
2348   gid/uid. */
2349
2350   (void)close(pfd[pipe_read]);
2351   (void)fcntl(pfd[pipe_write], F_SETFD, fcntl(pfd[pipe_write], F_GETFD) |
2352     FD_CLOEXEC);
2353   exim_setugid(uid, gid, use_initgroups,
2354     string_sprintf("local delivery to %s <%s> transport=%s", addr->local_part,
2355       addr->address, addr->transport->name));
2356
2357   DEBUG(D_deliver)
2358     {
2359     debug_printf("  home=%s current=%s\n", deliver_home, working_directory);
2360     for (address_item * batched = addr->next; batched; batched = batched->next)
2361       debug_printf("additional batched address: %s\n", batched->address);
2362     }
2363
2364   /* Set an appropriate working directory. */
2365
2366   if (Uchdir(working_directory) < 0)
2367     {
2368     addr->transport_return = DEFER;
2369     addr->basic_errno = errno;
2370     addr->message = string_sprintf("failed to chdir to %s", working_directory);
2371     }
2372
2373   /* If successful, call the transport */
2374
2375   else
2376     {
2377     BOOL ok = TRUE;
2378     set_process_info("delivering %s to %s using %s", message_id,
2379      addr->local_part, addr->transport->name);
2380
2381     /* Setting this global in the subprocess means we need never clear it */
2382     transport_name = addr->transport->name;
2383
2384     /* If a transport filter has been specified, set up its argument list.
2385     Any errors will get put into the address, and FALSE yielded. */
2386
2387     if (addr->transport->filter_command)
2388       {
2389       ok = transport_set_up_command(&transport_filter_argv,
2390         addr->transport->filter_command,
2391         TRUE, PANIC, addr, US"transport filter", NULL);
2392       transport_filter_timeout = addr->transport->filter_timeout;
2393       }
2394     else transport_filter_argv = NULL;
2395
2396     if (ok)
2397       {
2398       debug_print_string(addr->transport->debug_string);
2399       replicate = !(addr->transport->info->code)(addr->transport, addr);
2400       }
2401     }
2402
2403   /* Pass the results back down the pipe. If necessary, first replicate the
2404   status in the top address to the others in the batch. The label is the
2405   subject of a goto when a call to the transport's setup function fails. We
2406   pass the pointer to the transport back in case it got changed as a result of
2407   file_format in appendfile. */
2408
2409   PASS_BACK:
2410
2411   if (replicate) replicate_status(addr);
2412   for (addr2 = addr; addr2; addr2 = addr2->next)
2413     {
2414     int i;
2415     int local_part_length = Ustrlen(addr2->local_part);
2416     uschar *s;
2417     int ret;
2418
2419     if(  (i = addr2->transport_return, (ret = write(pfd[pipe_write], &i, sizeof(int))) != sizeof(int))
2420       || (ret = write(pfd[pipe_write], &transport_count, sizeof(transport_count))) != sizeof(transport_count)
2421       || (ret = write(pfd[pipe_write], &addr2->flags, sizeof(addr2->flags))) != sizeof(addr2->flags)
2422       || (ret = write(pfd[pipe_write], &addr2->basic_errno,    sizeof(int))) != sizeof(int)
2423       || (ret = write(pfd[pipe_write], &addr2->more_errno,     sizeof(int))) != sizeof(int)
2424       || (ret = write(pfd[pipe_write], &addr2->delivery_time,  sizeof(struct timeval))) != sizeof(struct timeval)
2425       || (i = addr2->special_action, (ret = write(pfd[pipe_write], &i, sizeof(int))) != sizeof(int))
2426       || (ret = write(pfd[pipe_write], &addr2->transport,
2427         sizeof(transport_instance *))) != sizeof(transport_instance *)
2428
2429     /* For a file delivery, pass back the local part, in case the original
2430     was only part of the final delivery path. This gives more complete
2431     logging. */
2432
2433       || (testflag(addr2, af_file)
2434           && (  (ret = write(pfd[pipe_write], &local_part_length, sizeof(int))) != sizeof(int)
2435              || (ret = write(pfd[pipe_write], addr2->local_part, local_part_length)) != local_part_length
2436              )
2437          )
2438       )
2439       log_write(0, LOG_MAIN|LOG_PANIC, "Failed writing transport results to pipe: %s",
2440         ret == -1 ? strerror(errno) : "short write");
2441
2442     /* Now any messages */
2443
2444     for (i = 0, s = addr2->message; i < 2; i++, s = addr2->user_message)
2445       {
2446       int message_length = s ? Ustrlen(s) + 1 : 0;
2447       if(  (ret = write(pfd[pipe_write], &message_length, sizeof(int))) != sizeof(int)
2448         || message_length > 0  && (ret = write(pfd[pipe_write], s, message_length)) != message_length
2449         )
2450         log_write(0, LOG_MAIN|LOG_PANIC, "Failed writing transport results to pipe: %s",
2451           ret == -1 ? strerror(errno) : "short write");
2452       }
2453     }
2454
2455   /* OK, this process is now done. Free any cached resources that it opened,
2456   and close the pipe we were writing down before exiting. */
2457
2458   (void)close(pfd[pipe_write]);
2459   search_tidyup();
2460   exit(EXIT_SUCCESS);
2461   }
2462
2463 /* Back in the main process: panic if the fork did not succeed. This seems
2464 better than returning an error - if forking is failing it is probably best
2465 not to try other deliveries for this message. */
2466
2467 if (pid < 0)
2468   log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Fork failed for local delivery to %s",
2469     addr->address);
2470
2471 /* Read the pipe to get the delivery status codes and error messages. Our copy
2472 of the writing end must be closed first, as otherwise read() won't return zero
2473 on an empty pipe. We check that a status exists for each address before
2474 overwriting the address structure. If data is missing, the default DEFER status
2475 will remain. Afterwards, close the reading end. */
2476
2477 (void)close(pfd[pipe_write]);
2478
2479 for (addr2 = addr; addr2; addr2 = addr2->next)
2480   {
2481   if ((len = read(pfd[pipe_read], &status, sizeof(int))) > 0)
2482     {
2483     int i;
2484     uschar **sptr;
2485
2486     addr2->transport_return = status;
2487     len = read(pfd[pipe_read], &transport_count,
2488       sizeof(transport_count));
2489     len = read(pfd[pipe_read], &addr2->flags, sizeof(addr2->flags));
2490     len = read(pfd[pipe_read], &addr2->basic_errno,    sizeof(int));
2491     len = read(pfd[pipe_read], &addr2->more_errno,     sizeof(int));
2492     len = read(pfd[pipe_read], &addr2->delivery_time,  sizeof(struct timeval));
2493     len = read(pfd[pipe_read], &i, sizeof(int)); addr2->special_action = i;
2494     len = read(pfd[pipe_read], &addr2->transport,
2495       sizeof(transport_instance *));
2496
2497     if (testflag(addr2, af_file))
2498       {
2499       int llen;
2500       if (  read(pfd[pipe_read], &llen, sizeof(int)) != sizeof(int)
2501          || llen > 64*4 /* limit from rfc 5821, times I18N factor */
2502          )
2503         {
2504         log_write(0, LOG_MAIN|LOG_PANIC, "bad local_part length read"
2505           " from delivery subprocess");
2506         break;
2507         }
2508       /* sanity-checked llen so disable the Coverity error */
2509       /* coverity[tainted_data] */
2510       if (read(pfd[pipe_read], big_buffer, llen) != llen)
2511         {
2512         log_write(0, LOG_MAIN|LOG_PANIC, "bad local_part read"
2513           " from delivery subprocess");
2514         break;
2515         }
2516       big_buffer[llen] = 0;
2517       addr2->local_part = string_copy(big_buffer);
2518       }
2519
2520     for (i = 0, sptr = &addr2->message; i < 2; i++, sptr = &addr2->user_message)
2521       {
2522       int message_length;
2523       len = read(pfd[pipe_read], &message_length, sizeof(int));
2524       if (message_length > 0)
2525         {
2526         len = read(pfd[pipe_read], big_buffer, message_length);
2527         big_buffer[big_buffer_size-1] = '\0';           /* guard byte */
2528         if (len > 0) *sptr = string_copy(big_buffer);
2529         }
2530       }
2531     }
2532
2533   else
2534     {
2535     log_write(0, LOG_MAIN|LOG_PANIC, "failed to read delivery status for %s "
2536       "from delivery subprocess", addr2->unique);
2537     break;
2538     }
2539   }
2540
2541 (void)close(pfd[pipe_read]);
2542
2543 /* Unless shadowing, write all successful addresses immediately to the journal
2544 file, to ensure they are recorded asap. For homonymic addresses, use the base
2545 address plus the transport name. Failure to write the journal is panic-worthy,
2546 but don't stop, as it may prove possible subsequently to update the spool file
2547 in order to record the delivery. */
2548
2549 if (!shadowing)
2550   {
2551   for (addr2 = addr; addr2; addr2 = addr2->next)
2552     if (addr2->transport_return == OK)
2553       {
2554       if (testflag(addr2, af_homonym))
2555         sprintf(CS big_buffer, "%.500s/%s\n", addr2->unique + 3, tp->name);
2556       else
2557         sprintf(CS big_buffer, "%.500s\n", addr2->unique);
2558
2559       /* In the test harness, wait just a bit to let the subprocess finish off
2560       any debug output etc first. */
2561
2562       testharness_pause_ms(300);
2563
2564       DEBUG(D_deliver) debug_printf("journalling %s", big_buffer);
2565       len = Ustrlen(big_buffer);
2566       if (write(journal_fd, big_buffer, len) != len)
2567         log_write(0, LOG_MAIN|LOG_PANIC, "failed to update journal for %s: %s",
2568           big_buffer, strerror(errno));
2569       }
2570
2571   /* Ensure the journal file is pushed out to disk. */
2572
2573   if (EXIMfsync(journal_fd) < 0)
2574     log_write(0, LOG_MAIN|LOG_PANIC, "failed to fsync journal: %s",
2575       strerror(errno));
2576   }
2577
2578 /* Wait for the process to finish. If it terminates with a non-zero code,
2579 freeze the message (except for SIGTERM, SIGKILL and SIGQUIT), but leave the
2580 status values of all the addresses as they are. Take care to handle the case
2581 when the subprocess doesn't seem to exist. This has been seen on one system
2582 when Exim was called from an MUA that set SIGCHLD to SIG_IGN. When that
2583 happens, wait() doesn't recognize the termination of child processes. Exim now
2584 resets SIGCHLD to SIG_DFL, but this code should still be robust. */
2585
2586 while ((rc = wait(&status)) != pid)
2587   if (rc < 0 && errno == ECHILD)      /* Process has vanished */
2588     {
2589     log_write(0, LOG_MAIN, "%s transport process vanished unexpectedly",
2590       addr->transport->driver_name);
2591     status = 0;
2592     break;
2593     }
2594
2595 if ((status & 0xffff) != 0)
2596   {
2597   int msb = (status >> 8) & 255;
2598   int lsb = status & 255;
2599   int code = (msb == 0)? (lsb & 0x7f) : msb;
2600   if (msb != 0 || (code != SIGTERM && code != SIGKILL && code != SIGQUIT))
2601     addr->special_action = SPECIAL_FREEZE;
2602   log_write(0, LOG_MAIN|LOG_PANIC, "%s transport process returned non-zero "
2603     "status 0x%04x: %s %d",
2604     addr->transport->driver_name,
2605     status,
2606     msb == 0 ? "terminated by signal" : "exit code",
2607     code);
2608   }
2609
2610 /* If SPECIAL_WARN is set in the top address, send a warning message. */
2611
2612 if (addr->special_action == SPECIAL_WARN && addr->transport->warn_message)
2613   {
2614   int fd;
2615   uschar *warn_message;
2616   pid_t pid;
2617
2618   DEBUG(D_deliver) debug_printf("Warning message requested by transport\n");
2619
2620   if (!(warn_message = expand_string(addr->transport->warn_message)))
2621     log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand \"%s\" (warning "
2622       "message for %s transport): %s", addr->transport->warn_message,
2623       addr->transport->name, expand_string_message);
2624
2625   else if ((pid = child_open_exim(&fd, US"tpt-warning-message")) > 0)
2626     {
2627     FILE *f = fdopen(fd, "wb");
2628     if (errors_reply_to && !contains_header(US"Reply-To", warn_message))
2629       fprintf(f, "Reply-To: %s\n", errors_reply_to);
2630     fprintf(f, "Auto-Submitted: auto-replied\n");
2631     if (!contains_header(US"From", warn_message))
2632       moan_write_from(f);
2633     fprintf(f, "%s", CS warn_message);
2634
2635     /* Close and wait for child process to complete, without a timeout. */
2636
2637     (void)fclose(f);
2638     (void)child_close(pid, 0);
2639     }
2640
2641   addr->special_action = SPECIAL_NONE;
2642   }
2643 }
2644
2645
2646
2647
2648 /* Check transport for the given concurrency limit.  Return TRUE if over
2649 the limit (or an expansion failure), else FALSE and if there was a limit,
2650 the key for the hints database used for the concurrency count. */
2651
2652 static BOOL
2653 tpt_parallel_check(transport_instance * tp, address_item * addr, uschar ** key)
2654 {
2655 unsigned max_parallel;
2656
2657 if (!tp->max_parallel) return FALSE;
2658
2659 max_parallel = (unsigned) expand_string_integer(tp->max_parallel, TRUE);
2660 if (expand_string_message)
2661   {
2662   log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand max_parallel option "
2663         "in %s transport (%s): %s", tp->name, addr->address,
2664         expand_string_message);
2665   return TRUE;
2666   }
2667
2668 if (max_parallel > 0)
2669   {
2670   uschar * serialize_key = string_sprintf("tpt-serialize-%s", tp->name);
2671   if (!enq_start(serialize_key, max_parallel))
2672     {
2673     address_item * next;
2674     DEBUG(D_transport)
2675       debug_printf("skipping tpt %s because concurrency limit %u reached\n",
2676                   tp->name, max_parallel);
2677     do
2678       {
2679       next = addr->next;
2680       addr->message = US"concurrency limit reached for transport";
2681       addr->basic_errno = ERRNO_TRETRY;
2682       post_process_one(addr, DEFER, LOG_MAIN, EXIM_DTYPE_TRANSPORT, 0);
2683       } while ((addr = next));
2684     return TRUE;
2685     }
2686   *key = serialize_key;
2687   }
2688 return FALSE;
2689 }
2690
2691
2692
2693 /*************************************************
2694 *              Do local deliveries               *
2695 *************************************************/
2696
2697 /* This function processes the list of addresses in addr_local. True local
2698 deliveries are always done one address at a time. However, local deliveries can
2699 be batched up in some cases. Typically this is when writing batched SMTP output
2700 files for use by some external transport mechanism, or when running local
2701 deliveries over LMTP.
2702
2703 Arguments:   None
2704 Returns:     Nothing
2705 */
2706
2707 static void
2708 do_local_deliveries(void)
2709 {
2710 open_db dbblock;
2711 open_db *dbm_file = NULL;
2712 time_t now = time(NULL);
2713
2714 /* Loop until we have exhausted the supply of local deliveries */
2715
2716 while (addr_local)
2717   {
2718   struct timeval delivery_start;
2719   struct timeval deliver_time;
2720   address_item *addr2, *addr3, *nextaddr;
2721   int logflags = LOG_MAIN;
2722   int logchar = f.dont_deliver? '*' : '=';
2723   transport_instance *tp;
2724   uschar * serialize_key = NULL;
2725
2726   /* Pick the first undelivered address off the chain */
2727
2728   address_item *addr = addr_local;
2729   addr_local = addr->next;
2730   addr->next = NULL;
2731
2732   DEBUG(D_deliver|D_transport)
2733     debug_printf("--------> %s <--------\n", addr->address);
2734
2735   /* An internal disaster if there is no transport. Should not occur! */
2736
2737   if (!(tp = addr->transport))
2738     {
2739     logflags |= LOG_PANIC;
2740     f.disable_logging = FALSE;  /* Jic */
2741     addr->message = addr->router
2742       ? string_sprintf("No transport set by %s router", addr->router->name)
2743       : US"No transport set by system filter";
2744     post_process_one(addr, DEFER, logflags, EXIM_DTYPE_TRANSPORT, 0);
2745     continue;
2746     }
2747
2748   /* Check that this base address hasn't previously been delivered to this
2749   transport. The check is necessary at this point to handle homonymic addresses
2750   correctly in cases where the pattern of redirection changes between delivery
2751   attempts. Non-homonymic previous delivery is detected earlier, at routing
2752   time. */
2753
2754   if (previously_transported(addr, FALSE)) continue;
2755
2756   /* There are weird cases where logging is disabled */
2757
2758   f.disable_logging = tp->disable_logging;
2759
2760   /* Check for batched addresses and possible amalgamation. Skip all the work
2761   if either batch_max <= 1 or there aren't any other addresses for local
2762   delivery. */
2763
2764   if (tp->batch_max > 1 && addr_local)
2765     {
2766     int batch_count = 1;
2767     BOOL uses_dom = readconf_depends((driver_instance *)tp, US"domain");
2768     BOOL uses_lp = (  testflag(addr, af_pfr)
2769                    && (testflag(addr, af_file) || addr->local_part[0] == '|')
2770                    )
2771                 || readconf_depends((driver_instance *)tp, US"local_part");
2772     uschar *batch_id = NULL;
2773     address_item **anchor = &addr_local;
2774     address_item *last = addr;
2775     address_item *next;
2776
2777     /* Expand the batch_id string for comparison with other addresses.
2778     Expansion failure suppresses batching. */
2779
2780     if (tp->batch_id)
2781       {
2782       deliver_set_expansions(addr);
2783       batch_id = expand_string(tp->batch_id);
2784       deliver_set_expansions(NULL);
2785       if (!batch_id)
2786         {
2787         log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand batch_id option "
2788           "in %s transport (%s): %s", tp->name, addr->address,
2789           expand_string_message);
2790         batch_count = tp->batch_max;
2791         }
2792       }
2793
2794     /* Until we reach the batch_max limit, pick off addresses which have the
2795     same characteristics. These are:
2796
2797       same transport
2798       not previously delivered (see comment about 50 lines above)
2799       same local part if the transport's configuration contains $local_part
2800         or if this is a file or pipe delivery from a redirection
2801       same domain if the transport's configuration contains $domain
2802       same errors address
2803       same additional headers
2804       same headers to be removed
2805       same uid/gid for running the transport
2806       same first host if a host list is set
2807     */
2808
2809     while ((next = *anchor) && batch_count < tp->batch_max)
2810       {
2811       BOOL ok =
2812            tp == next->transport
2813         && !previously_transported(next, TRUE)
2814         && testflag(addr, af_pfr) == testflag(next, af_pfr)
2815         && testflag(addr, af_file) == testflag(next, af_file)
2816         && (!uses_lp  || Ustrcmp(next->local_part, addr->local_part) == 0)
2817         && (!uses_dom || Ustrcmp(next->domain, addr->domain) == 0)
2818         && same_strings(next->prop.errors_address, addr->prop.errors_address)
2819         && same_headers(next->prop.extra_headers, addr->prop.extra_headers)
2820         && same_strings(next->prop.remove_headers, addr->prop.remove_headers)
2821         && same_ugid(tp, addr, next)
2822         && (  !addr->host_list && !next->host_list
2823            ||    addr->host_list
2824               && next->host_list
2825               && Ustrcmp(addr->host_list->name, next->host_list->name) == 0
2826            );
2827
2828       /* If the transport has a batch_id setting, batch_id will be non-NULL
2829       from the expansion outside the loop. Expand for this address and compare.
2830       Expansion failure makes this address ineligible for batching. */
2831
2832       if (ok && batch_id)
2833         {
2834         uschar *bid;
2835         address_item *save_nextnext = next->next;
2836         next->next = NULL;            /* Expansion for a single address */
2837         deliver_set_expansions(next);
2838         next->next = save_nextnext;
2839         bid = expand_string(tp->batch_id);
2840         deliver_set_expansions(NULL);
2841         if (!bid)
2842           {
2843           log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand batch_id option "
2844             "in %s transport (%s): %s", tp->name, next->address,
2845             expand_string_message);
2846           ok = FALSE;
2847           }
2848         else ok = (Ustrcmp(batch_id, bid) == 0);
2849         }
2850
2851       /* Take address into batch if OK. */
2852
2853       if (ok)
2854         {
2855         *anchor = next->next;           /* Include the address */
2856         next->next = NULL;
2857         last->next = next;
2858         last = next;
2859         batch_count++;
2860         }
2861       else anchor = &next->next;        /* Skip the address */
2862       }
2863     }
2864
2865   /* We now have one or more addresses that can be delivered in a batch. Check
2866   whether the transport is prepared to accept a message of this size. If not,
2867   fail them all forthwith. If the expansion fails, or does not yield an
2868   integer, defer delivery. */
2869
2870   if (tp->message_size_limit)
2871     {
2872     int rc = check_message_size(tp, addr);
2873     if (rc != OK)
2874       {
2875       replicate_status(addr);
2876       while (addr)
2877         {
2878         addr2 = addr->next;
2879         post_process_one(addr, rc, logflags, EXIM_DTYPE_TRANSPORT, 0);
2880         addr = addr2;
2881         }
2882       continue;    /* With next batch of addresses */
2883       }
2884     }
2885
2886   /* If we are not running the queue, or if forcing, all deliveries will be
2887   attempted. Otherwise, we must respect the retry times for each address. Even
2888   when not doing this, we need to set up the retry key string, and determine
2889   whether a retry record exists, because after a successful delivery, a delete
2890   retry item must be set up. Keep the retry database open only for the duration
2891   of these checks, rather than for all local deliveries, because some local
2892   deliveries (e.g. to pipes) can take a substantial time. */
2893
2894   if (!(dbm_file = dbfn_open(US"retry", O_RDONLY, &dbblock, FALSE, TRUE)))
2895     DEBUG(D_deliver|D_retry|D_hints_lookup)
2896       debug_printf("no retry data available\n");
2897
2898   addr2 = addr;
2899   addr3 = NULL;
2900   while (addr2)
2901     {
2902     BOOL ok = TRUE;   /* to deliver this address */
2903     uschar *retry_key;
2904
2905     /* Set up the retry key to include the domain or not, and change its
2906     leading character from "R" to "T". Must make a copy before doing this,
2907     because the old key may be pointed to from a "delete" retry item after
2908     a routing delay. */
2909
2910     retry_key = string_copy(
2911       tp->retry_use_local_part ? addr2->address_retry_key :
2912         addr2->domain_retry_key);
2913     *retry_key = 'T';
2914
2915     /* Inspect the retry data. If there is no hints file, delivery happens. */
2916
2917     if (dbm_file)
2918       {
2919       dbdata_retry *retry_record = dbfn_read(dbm_file, retry_key);
2920
2921       /* If there is no retry record, delivery happens. If there is,
2922       remember it exists so it can be deleted after a successful delivery. */
2923
2924       if (retry_record)
2925         {
2926         setflag(addr2, af_lt_retry_exists);
2927
2928         /* A retry record exists for this address. If queue running and not
2929         forcing, inspect its contents. If the record is too old, or if its
2930         retry time has come, or if it has passed its cutoff time, delivery
2931         will go ahead. */
2932
2933         DEBUG(D_retry)
2934           {
2935           debug_printf("retry record exists: age=%s ",
2936             readconf_printtime(now - retry_record->time_stamp));
2937           debug_printf("(max %s)\n", readconf_printtime(retry_data_expire));
2938           debug_printf("  time to retry = %s expired = %d\n",
2939             readconf_printtime(retry_record->next_try - now),
2940             retry_record->expired);
2941           }
2942
2943         if (f.queue_running && !f.deliver_force)
2944           {
2945           ok = (now - retry_record->time_stamp > retry_data_expire)
2946             || (now >= retry_record->next_try)
2947             || retry_record->expired;
2948
2949           /* If we haven't reached the retry time, there is one more check
2950           to do, which is for the ultimate address timeout. */
2951
2952           if (!ok)
2953             ok = retry_ultimate_address_timeout(retry_key, addr2->domain,
2954                 retry_record, now);
2955           }
2956         }
2957       else DEBUG(D_retry) debug_printf("no retry record exists\n");
2958       }
2959
2960     /* This address is to be delivered. Leave it on the chain. */
2961
2962     if (ok)
2963       {
2964       addr3 = addr2;
2965       addr2 = addr2->next;
2966       }
2967
2968     /* This address is to be deferred. Take it out of the chain, and
2969     post-process it as complete. Must take it out of the chain first,
2970     because post processing puts it on another chain. */
2971
2972     else
2973       {
2974       address_item *this = addr2;
2975       this->message = US"Retry time not yet reached";
2976       this->basic_errno = ERRNO_LRETRY;
2977       addr2 = addr3 ? (addr3->next = addr2->next)
2978                     : (addr = addr2->next);
2979       post_process_one(this, DEFER, logflags, EXIM_DTYPE_TRANSPORT, 0);
2980       }
2981     }
2982
2983   if (dbm_file) dbfn_close(dbm_file);
2984
2985   /* If there are no addresses left on the chain, they all deferred. Loop
2986   for the next set of addresses. */
2987
2988   if (!addr) continue;
2989
2990   /* If the transport is limited for parallellism, enforce that here.
2991   We use a hints DB entry, incremented here and decremented after
2992   the transport (and any shadow transport) completes. */
2993
2994   if (tpt_parallel_check(tp, addr, &serialize_key))
2995     {
2996     if (expand_string_message)
2997       {
2998       logflags |= LOG_PANIC;
2999       do
3000         {
3001         addr = addr->next;
3002         post_process_one(addr, DEFER, logflags, EXIM_DTYPE_TRANSPORT, 0);
3003         } while ((addr = addr2));
3004       }
3005     continue;                   /* Loop for the next set of addresses. */
3006     }
3007
3008
3009   /* So, finally, we do have some addresses that can be passed to the
3010   transport. Before doing so, set up variables that are relevant to a
3011   single delivery. */
3012
3013   deliver_set_expansions(addr);
3014
3015   gettimeofday(&delivery_start, NULL);
3016   deliver_local(addr, FALSE);
3017   timesince(&deliver_time, &delivery_start);
3018
3019   /* If a shadow transport (which must perforce be another local transport), is
3020   defined, and its condition is met, we must pass the message to the shadow
3021   too, but only those addresses that succeeded. We do this by making a new
3022   chain of addresses - also to keep the original chain uncontaminated. We must
3023   use a chain rather than doing it one by one, because the shadow transport may
3024   batch.
3025
3026   NOTE: if the condition fails because of a lookup defer, there is nothing we
3027   can do! */
3028
3029   if (  tp->shadow
3030      && (  !tp->shadow_condition
3031         || expand_check_condition(tp->shadow_condition, tp->name, US"transport")
3032      )  )
3033     {
3034     transport_instance *stp;
3035     address_item *shadow_addr = NULL;
3036     address_item **last = &shadow_addr;
3037
3038     for (stp = transports; stp; stp = stp->next)
3039       if (Ustrcmp(stp->name, tp->shadow) == 0) break;
3040
3041     if (!stp)
3042       log_write(0, LOG_MAIN|LOG_PANIC, "shadow transport \"%s\" not found ",
3043         tp->shadow);
3044
3045     /* Pick off the addresses that have succeeded, and make clones. Put into
3046     the shadow_message field a pointer to the shadow_message field of the real
3047     address. */
3048
3049     else for (addr2 = addr; addr2; addr2 = addr2->next)
3050       if (addr2->transport_return == OK)
3051         {
3052         addr3 = store_get(sizeof(address_item), FALSE);
3053         *addr3 = *addr2;
3054         addr3->next = NULL;
3055         addr3->shadow_message = US &addr2->shadow_message;
3056         addr3->transport = stp;
3057         addr3->transport_return = DEFER;
3058         addr3->return_filename = NULL;
3059         addr3->return_file = -1;
3060         *last = addr3;
3061         last = &addr3->next;
3062         }
3063
3064     /* If we found any addresses to shadow, run the delivery, and stick any
3065     message back into the shadow_message field in the original. */
3066
3067     if (shadow_addr)
3068       {
3069       int save_count = transport_count;
3070
3071       DEBUG(D_deliver|D_transport)
3072         debug_printf(">>>>>>>>>>>>>>>> Shadow delivery >>>>>>>>>>>>>>>>\n");
3073       deliver_local(shadow_addr, TRUE);
3074
3075       for(; shadow_addr; shadow_addr = shadow_addr->next)
3076         {
3077         int sresult = shadow_addr->transport_return;
3078         *(uschar **)shadow_addr->shadow_message =
3079           sresult == OK
3080           ? string_sprintf(" ST=%s", stp->name)
3081           : string_sprintf(" ST=%s (%s%s%s)", stp->name,
3082               shadow_addr->basic_errno <= 0
3083               ? US""
3084               : US strerror(shadow_addr->basic_errno),
3085               shadow_addr->basic_errno <= 0 || !shadow_addr->message
3086               ? US""
3087               : US": ",
3088               shadow_addr->message
3089               ? shadow_addr->message
3090               : shadow_addr->basic_errno <= 0
3091               ? US"unknown error"
3092               : US"");
3093
3094         DEBUG(D_deliver|D_transport)
3095           debug_printf("%s shadow transport returned %s for %s\n",
3096             stp->name, rc_to_string(sresult), shadow_addr->address);
3097         }
3098
3099       DEBUG(D_deliver|D_transport)
3100         debug_printf(">>>>>>>>>>>>>>>> End shadow delivery >>>>>>>>>>>>>>>>\n");
3101
3102       transport_count = save_count;   /* Restore original transport count */
3103       }
3104     }
3105
3106   /* Cancel the expansions that were set up for the delivery. */
3107
3108   deliver_set_expansions(NULL);
3109
3110   /* If the transport was parallelism-limited, decrement the hints DB record. */
3111
3112   if (serialize_key) enq_end(serialize_key);
3113
3114   /* Now we can process the results of the real transport. We must take each
3115   address off the chain first, because post_process_one() puts it on another
3116   chain. */
3117
3118   for (addr2 = addr; addr2; addr2 = nextaddr)
3119     {
3120     int result = addr2->transport_return;
3121     nextaddr = addr2->next;
3122
3123     DEBUG(D_deliver|D_transport)
3124       debug_printf("%s transport returned %s for %s\n",
3125         tp->name, rc_to_string(result), addr2->address);
3126
3127     /* If there is a retry_record, or if delivery is deferred, build a retry
3128     item for setting a new retry time or deleting the old retry record from
3129     the database. These items are handled all together after all addresses
3130     have been handled (so the database is open just for a short time for
3131     updating). */
3132
3133     if (result == DEFER || testflag(addr2, af_lt_retry_exists))
3134       {
3135       int flags = result == DEFER ? 0 : rf_delete;
3136       uschar *retry_key = string_copy(tp->retry_use_local_part
3137         ? addr2->address_retry_key : addr2->domain_retry_key);
3138       *retry_key = 'T';
3139       retry_add_item(addr2, retry_key, flags);
3140       }
3141
3142     /* Done with this address */
3143
3144     addr2->delivery_time = deliver_time;
3145     post_process_one(addr2, result, logflags, EXIM_DTYPE_TRANSPORT, logchar);
3146
3147     /* If a pipe delivery generated text to be sent back, the result may be
3148     changed to FAIL, and we must copy this for subsequent addresses in the
3149     batch. */
3150
3151     if (addr2->transport_return != result)
3152       {
3153       for (addr3 = nextaddr; addr3; addr3 = addr3->next)
3154         {
3155         addr3->transport_return = addr2->transport_return;
3156         addr3->basic_errno = addr2->basic_errno;
3157         addr3->message = addr2->message;
3158         }
3159       result = addr2->transport_return;
3160       }
3161
3162     /* Whether or not the result was changed to FAIL, we need to copy the
3163     return_file value from the first address into all the addresses of the
3164     batch, so they are all listed in the error message. */
3165
3166     addr2->return_file = addr->return_file;
3167
3168     /* Change log character for recording successful deliveries. */
3169
3170     if (result == OK) logchar = '-';
3171     }
3172   }        /* Loop back for next batch of addresses */
3173 }
3174
3175
3176
3177
3178 /*************************************************
3179 *           Sort remote deliveries               *
3180 *************************************************/
3181
3182 /* This function is called if remote_sort_domains is set. It arranges that the
3183 chain of addresses for remote deliveries is ordered according to the strings
3184 specified. Try to make this shuffling reasonably efficient by handling
3185 sequences of addresses rather than just single ones.
3186
3187 Arguments:  None
3188 Returns:    Nothing
3189 */
3190
3191 static void
3192 sort_remote_deliveries(void)
3193 {
3194 int sep = 0;
3195 address_item **aptr = &addr_remote;
3196 const uschar *listptr = remote_sort_domains;
3197 uschar *pattern;
3198 uschar patbuf[256];
3199
3200 /*XXX The list is used before expansion. Not sure how that ties up with the docs */
3201 while (  *aptr
3202       && (pattern = string_nextinlist(&listptr, &sep, patbuf, sizeof(patbuf)))
3203       )
3204   {
3205   address_item *moved = NULL;
3206   address_item **bptr = &moved;
3207
3208   while (*aptr)
3209     {
3210     address_item **next;
3211     deliver_domain = (*aptr)->domain;   /* set $domain */
3212     if (match_isinlist(deliver_domain, (const uschar **)&pattern, UCHAR_MAX+1,
3213           &domainlist_anchor, NULL, MCL_DOMAIN, TRUE, NULL) == OK)
3214       {
3215       aptr = &(*aptr)->next;
3216       continue;
3217       }
3218
3219     next = &(*aptr)->next;
3220     while (  *next
3221           && (deliver_domain = (*next)->domain,  /* Set $domain */
3222             match_isinlist(deliver_domain, (const uschar **)&pattern, UCHAR_MAX+1,
3223               &domainlist_anchor, NULL, MCL_DOMAIN, TRUE, NULL)) != OK
3224           )
3225       next = &(*next)->next;
3226
3227     /* If the batch of non-matchers is at the end, add on any that were
3228     extracted further up the chain, and end this iteration. Otherwise,
3229     extract them from the chain and hang on the moved chain. */
3230
3231     if (!*next)
3232       {
3233       *next = moved;
3234       break;
3235       }
3236
3237     *bptr = *aptr;
3238     *aptr = *next;
3239     *next = NULL;
3240     bptr = next;
3241     aptr = &(*aptr)->next;
3242     }
3243
3244   /* If the loop ended because the final address matched, *aptr will
3245   be NULL. Add on to the end any extracted non-matching addresses. If
3246   *aptr is not NULL, the loop ended via "break" when *next is null, that
3247   is, there was a string of non-matching addresses at the end. In this
3248   case the extracted addresses have already been added on the end. */
3249
3250   if (!*aptr) *aptr = moved;
3251   }
3252
3253 DEBUG(D_deliver)
3254   {
3255   debug_printf("remote addresses after sorting:\n");
3256   for (address_item * addr = addr_remote; addr; addr = addr->next)
3257     debug_printf("  %s\n", addr->address);
3258   }
3259 }
3260
3261
3262
3263 /*************************************************
3264 *  Read from pipe for remote delivery subprocess *
3265 *************************************************/
3266
3267 /* This function is called when the subprocess is complete, but can also be
3268 called before it is complete, in order to empty a pipe that is full (to prevent
3269 deadlock). It must therefore keep track of its progress in the parlist data
3270 block.
3271
3272 We read the pipe to get the delivery status codes and a possible error message
3273 for each address, optionally preceded by unusability data for the hosts and
3274 also by optional retry data.
3275
3276 Read in large chunks into the big buffer and then scan through, interpreting
3277 the data therein. In most cases, only a single read will be necessary. No
3278 individual item will ever be anywhere near 2500 bytes in length, so by ensuring
3279 that we read the next chunk when there is less than 2500 bytes left in the
3280 non-final chunk, we can assume each item is complete in the buffer before
3281 handling it. Each item is written using a single write(), which is atomic for
3282 small items (less than PIPE_BUF, which seems to be at least 512 in any Unix and
3283 often bigger) so even if we are reading while the subprocess is still going, we
3284 should never have only a partial item in the buffer.
3285
3286 hs12: This assumption is not true anymore, since we get quite large items (certificate
3287 information and such).
3288
3289 Argument:
3290   poffset     the offset of the parlist item
3291   eop         TRUE if the process has completed
3292
3293 Returns:      TRUE if the terminating 'Z' item has been read,
3294               or there has been a disaster (i.e. no more data needed);
3295               FALSE otherwise
3296 */
3297
3298 static BOOL
3299 par_read_pipe(int poffset, BOOL eop)
3300 {
3301 host_item *h;
3302 pardata *p = parlist + poffset;
3303 address_item *addrlist = p->addrlist;
3304 address_item *addr = p->addr;
3305 pid_t pid = p->pid;
3306 int fd = p->fd;
3307
3308 uschar *msg = p->msg;
3309 BOOL done = p->done;
3310
3311 /* Loop through all items, reading from the pipe when necessary. The pipe
3312 used to be non-blocking. But I do not see a reason for using non-blocking I/O
3313 here, as the preceding poll() tells us, if data is available for reading.
3314
3315 A read() on a "selected" handle should never block, but(!) it may return
3316 less data then we expected. (The buffer size we pass to read() shouldn't be
3317 understood as a "request", but as a "limit".)
3318
3319 Each separate item is written to the pipe in a timely manner. But, especially for
3320 larger items, the read(2) may already return partial data from the write(2).
3321
3322 The write is atomic mostly (depending on the amount written), but atomic does
3323 not imply "all or noting", it just is "not intermixed" with other writes on the
3324 same channel (pipe).
3325
3326 */
3327
3328 DEBUG(D_deliver) debug_printf("reading pipe for subprocess %d (%s)\n",
3329   (int)p->pid, eop? "ended" : "not ended yet");
3330
3331 while (!done)
3332   {
3333   retry_item *r, **rp;
3334   uschar pipeheader[PIPE_HEADER_SIZE+1];
3335   uschar *id = &pipeheader[0];
3336   uschar *subid = &pipeheader[1];
3337   uschar *ptr = big_buffer;
3338   size_t required = PIPE_HEADER_SIZE; /* first the pipehaeder, later the data */
3339   ssize_t got;
3340
3341   DEBUG(D_deliver) debug_printf(
3342     "expect %lu bytes (pipeheader) from tpt process %d\n", (u_long)required, pid);
3343
3344   /* We require(!) all the PIPE_HEADER_SIZE bytes here, as we know,
3345   they're written in a timely manner, so waiting for the write shouldn't hurt a lot.
3346   If we get less, we can assume the subprocess do be done and do not expect any further
3347   information from it. */
3348
3349   if ((got = readn(fd, pipeheader, required)) != required)
3350     {
3351     msg = string_sprintf("got " SSIZE_T_FMT " of %d bytes (pipeheader) "
3352       "from transport process %d for transport %s",
3353       got, PIPE_HEADER_SIZE, pid, addr->transport->driver_name);
3354     done = TRUE;
3355     break;
3356     }
3357
3358   pipeheader[PIPE_HEADER_SIZE] = '\0';
3359   DEBUG(D_deliver)
3360     debug_printf("got %ld bytes (pipeheader) from transport process %d\n",
3361       (long) got, pid);
3362
3363   {
3364   /* If we can't decode the pipeheader, the subprocess seems to have a
3365   problem, we do not expect any furher information from it. */
3366   char *endc;
3367   required = Ustrtol(pipeheader+2, &endc, 10);
3368   if (*endc)
3369     {
3370     msg = string_sprintf("failed to read pipe "
3371       "from transport process %d for transport %s: error decoding size from header",
3372       pid, addr->transport->driver_name);
3373     done = TRUE;
3374     break;
3375     }
3376   }
3377
3378   DEBUG(D_deliver)
3379     debug_printf("expect %lu bytes (pipedata) from transport process %d\n",
3380       (u_long)required, pid);
3381
3382   /* Same as above, the transport process will write the bytes announced
3383   in a timely manner, so we can just wait for the bytes, getting less than expected
3384   is considered a problem of the subprocess, we do not expect anything else from it. */
3385   if ((got = readn(fd, big_buffer, required)) != required)
3386     {
3387     msg = string_sprintf("got only " SSIZE_T_FMT " of " SIZE_T_FMT
3388       " bytes (pipedata) from transport process %d for transport %s",
3389       got, required, pid, addr->transport->driver_name);
3390     done = TRUE;
3391     break;
3392     }
3393
3394   /* Handle each possible type of item, assuming the complete item is
3395   available in store. */
3396
3397   switch (*id)
3398     {
3399     /* Host items exist only if any hosts were marked unusable. Match
3400     up by checking the IP address. */
3401
3402     case 'H':
3403       for (h = addrlist->host_list; h; h = h->next)
3404         {
3405         if (!h->address || Ustrcmp(h->address, ptr+2) != 0) continue;
3406         h->status = ptr[0];
3407         h->why = ptr[1];
3408         }
3409       ptr += 2;
3410       while (*ptr++);
3411       break;
3412
3413     /* Retry items are sent in a preceding R item for each address. This is
3414     kept separate to keep each message short enough to guarantee it won't
3415     be split in the pipe. Hopefully, in the majority of cases, there won't in
3416     fact be any retry items at all.
3417
3418     The complete set of retry items might include an item to delete a
3419     routing retry if there was a previous routing delay. However, routing
3420     retries are also used when a remote transport identifies an address error.
3421     In that case, there may also be an "add" item for the same key. Arrange
3422     that a "delete" item is dropped in favour of an "add" item. */
3423
3424     case 'R':
3425       if (!addr) goto ADDR_MISMATCH;
3426
3427       DEBUG(D_deliver|D_retry)
3428         debug_printf("reading retry information for %s from subprocess\n",
3429           ptr+1);
3430
3431       /* Cut out any "delete" items on the list. */
3432
3433       for (rp = &addr->retries; (r = *rp); rp = &r->next)
3434         if (Ustrcmp(r->key, ptr+1) == 0)           /* Found item with same key */
3435           {
3436           if (!(r->flags & rf_delete)) break;      /* It was not "delete" */
3437           *rp = r->next;                           /* Excise a delete item */
3438           DEBUG(D_deliver|D_retry)
3439             debug_printf("  existing delete item dropped\n");
3440           }
3441
3442       /* We want to add a delete item only if there is no non-delete item;
3443       however we still have to step ptr through the data. */
3444
3445       if (!r || !(*ptr & rf_delete))
3446         {
3447         r = store_get(sizeof(retry_item), FALSE);
3448         r->next = addr->retries;
3449         addr->retries = r;
3450         r->flags = *ptr++;
3451         r->key = string_copy(ptr);
3452         while (*ptr++);
3453         memcpy(&r->basic_errno, ptr, sizeof(r->basic_errno));
3454         ptr += sizeof(r->basic_errno);
3455         memcpy(&r->more_errno, ptr, sizeof(r->more_errno));
3456         ptr += sizeof(r->more_errno);
3457         r->message = *ptr ? string_copy(ptr) : NULL;
3458         DEBUG(D_deliver|D_retry) debug_printf("  added %s item\n",
3459             r->flags & rf_delete ? "delete" : "retry");
3460         }
3461
3462       else
3463         {
3464         DEBUG(D_deliver|D_retry)
3465           debug_printf("  delete item not added: non-delete item exists\n");
3466         ptr++;
3467         while(*ptr++);
3468         ptr += sizeof(r->basic_errno) + sizeof(r->more_errno);
3469         }
3470
3471       while(*ptr++);
3472       break;
3473
3474     /* Put the amount of data written into the parlist block */
3475
3476     case 'S':
3477       memcpy(&(p->transport_count), ptr, sizeof(transport_count));
3478       ptr += sizeof(transport_count);
3479       break;
3480
3481     /* Address items are in the order of items on the address chain. We
3482     remember the current address value in case this function is called
3483     several times to empty the pipe in stages. Information about delivery
3484     over TLS is sent in a preceding X item for each address. We don't put
3485     it in with the other info, in order to keep each message short enough to
3486     guarantee it won't be split in the pipe. */
3487
3488 #ifndef DISABLE_TLS
3489     case 'X':
3490       if (!addr) goto ADDR_MISMATCH;          /* Below, in 'A' handler */
3491       switch (*subid)
3492         {
3493         case '1':
3494           addr->tlsver = addr->cipher = addr->peerdn = NULL;
3495
3496           if (*ptr)
3497             {
3498             addr->cipher = string_copy(ptr);
3499             addr->tlsver = string_copyn(ptr, Ustrchr(ptr, ':') - ptr);
3500             }
3501           while (*ptr++);
3502           if (*ptr)
3503             addr->peerdn = string_copy(ptr);
3504           break;
3505
3506         case '2':
3507           if (*ptr)
3508             (void) tls_import_cert(ptr, &addr->peercert);
3509           else
3510             addr->peercert = NULL;
3511           break;
3512
3513         case '3':
3514           if (*ptr)
3515             (void) tls_import_cert(ptr, &addr->ourcert);
3516           else
3517             addr->ourcert = NULL;
3518           break;
3519
3520 # ifndef DISABLE_OCSP
3521         case '4':
3522           addr->ocsp = *ptr ? *ptr - '0' : OCSP_NOT_REQ;
3523           break;
3524 # endif
3525         }
3526       while (*ptr++);
3527       break;
3528 #endif  /*DISABLE_TLS*/
3529
3530     case 'C':   /* client authenticator information */
3531       switch (*subid)
3532         {
3533         case '1': addr->authenticator = *ptr ? string_copy(ptr) : NULL; break;
3534         case '2': addr->auth_id = *ptr ? string_copy(ptr) : NULL;       break;
3535         case '3': addr->auth_sndr = *ptr ? string_copy(ptr) : NULL;     break;
3536         }
3537       while (*ptr++);
3538       break;
3539
3540 #ifndef DISABLE_PRDR
3541     case 'P':
3542       setflag(addr, af_prdr_used);
3543       break;
3544 #endif
3545
3546     case 'L':
3547       switch (*subid)
3548         {
3549 #ifndef DISABLE_PIPE_CONNECT
3550         case 2: setflag(addr, af_early_pipe);   /*FALLTHROUGH*/
3551 #endif
3552         case 1: setflag(addr, af_pipelining); break;
3553         }
3554       break;
3555
3556     case 'K':
3557       setflag(addr, af_chunking_used);
3558       break;
3559
3560     case 'T':
3561       setflag(addr, af_tcp_fastopen_conn);
3562       if (*subid > '0') setflag(addr, af_tcp_fastopen);
3563       if (*subid > '1') setflag(addr, af_tcp_fastopen_data);
3564       break;
3565
3566     case 'D':
3567       if (!addr) goto ADDR_MISMATCH;
3568       memcpy(&(addr->dsn_aware), ptr, sizeof(addr->dsn_aware));
3569       ptr += sizeof(addr->dsn_aware);
3570       DEBUG(D_deliver) debug_printf("DSN read: addr->dsn_aware = %d\n", addr->dsn_aware);
3571       break;
3572
3573     case 'A':
3574       if (!addr)
3575         {
3576         ADDR_MISMATCH:
3577         msg = string_sprintf("address count mismatch for data read from pipe "
3578           "for transport process %d for transport %s", pid,
3579             addrlist->transport->driver_name);
3580         done = TRUE;
3581         break;
3582         }
3583
3584       switch (*subid)
3585         {
3586         case 3:         /* explicit notification of continued-connection (non)use;
3587                         overrides caller's knowlege. */
3588           if (*ptr & BIT(1))      setflag(addr, af_new_conn);
3589           else if (*ptr & BIT(2)) setflag(addr, af_cont_conn);
3590           break;
3591
3592 #ifdef SUPPORT_SOCKS
3593         case '2':       /* proxy information; must arrive before A0 and applies to that addr XXX oops*/
3594           proxy_session = TRUE; /*XXX should this be cleared somewhere? */
3595           if (*ptr == 0)
3596             ptr++;
3597           else
3598             {
3599             proxy_local_address = string_copy(ptr);
3600             while(*ptr++);
3601             memcpy(&proxy_local_port, ptr, sizeof(proxy_local_port));
3602             ptr += sizeof(proxy_local_port);
3603             }
3604           break;
3605 #endif
3606
3607 #ifdef EXPERIMENTAL_DSN_INFO
3608         case '1':       /* must arrive before A0, and applies to that addr */
3609                         /* Two strings: smtp_greeting and helo_response */
3610           addr->smtp_greeting = string_copy(ptr);
3611           while(*ptr++);
3612           addr->helo_response = string_copy(ptr);
3613           while(*ptr++);
3614           break;
3615 #endif
3616
3617         case '0':
3618           DEBUG(D_deliver) debug_printf("A0 %s tret %d\n", addr->address, *ptr);
3619           addr->transport_return = *ptr++;
3620           addr->special_action = *ptr++;
3621           memcpy(&addr->basic_errno, ptr, sizeof(addr->basic_errno));
3622           ptr += sizeof(addr->basic_errno);
3623           memcpy(&addr->more_errno, ptr, sizeof(addr->more_errno));
3624           ptr += sizeof(addr->more_errno);
3625           memcpy(&addr->delivery_time, ptr, sizeof(addr->delivery_time));
3626           ptr += sizeof(addr->delivery_time);
3627           memcpy(&addr->flags, ptr, sizeof(addr->flags));
3628           ptr += sizeof(addr->flags);
3629           addr->message = *ptr ? string_copy(ptr) : NULL;
3630           while(*ptr++);
3631           addr->user_message = *ptr ? string_copy(ptr) : NULL;
3632           while(*ptr++);
3633
3634           /* Always two strings for host information, followed by the port number and DNSSEC mark */
3635
3636           if (*ptr)
3637             {
3638             h = store_get(sizeof(host_item), FALSE);
3639             h->name = string_copy(ptr);
3640             while (*ptr++);
3641             h->address = string_copy(ptr);
3642             while(*ptr++);
3643             memcpy(&h->port, ptr, sizeof(h->port));
3644             ptr += sizeof(h->port);
3645             h->dnssec = *ptr == '2' ? DS_YES
3646                       : *ptr == '1' ? DS_NO
3647                       : DS_UNK;
3648             ptr++;
3649             addr->host_used = h;
3650             }
3651           else ptr++;
3652
3653           /* Finished with this address */
3654
3655           addr = addr->next;
3656           break;
3657         }
3658       break;
3659
3660     /* Local interface address/port */
3661     case 'I':
3662       if (*ptr) sending_ip_address = string_copy(ptr);
3663       while (*ptr++) ;
3664       if (*ptr) sending_port = atoi(CS ptr);
3665       while (*ptr++) ;
3666       break;
3667
3668     /* Z marks the logical end of the data. It is followed by '0' if
3669     continue_transport was NULL at the end of transporting, otherwise '1'.
3670     We need to know when it becomes NULL during a delivery down a passed SMTP
3671     channel so that we don't try to pass anything more down it. Of course, for
3672     most normal messages it will remain NULL all the time. */
3673
3674     case 'Z':
3675       if (*ptr == '0')
3676         {
3677         continue_transport = NULL;
3678         continue_hostname = NULL;
3679         }
3680       done = TRUE;
3681       DEBUG(D_deliver) debug_printf("Z0%c item read\n", *ptr);
3682       break;
3683
3684     /* Anything else is a disaster. */
3685
3686     default:
3687       msg = string_sprintf("malformed data (%d) read from pipe for transport "
3688         "process %d for transport %s", ptr[-1], pid,
3689           addr->transport->driver_name);
3690       done = TRUE;
3691       break;
3692     }
3693   }
3694
3695 /* The done flag is inspected externally, to determine whether or not to
3696 call the function again when the process finishes. */
3697
3698 p->done = done;
3699
3700 /* If the process hadn't finished, and we haven't seen the end of the data
3701 or if we suffered a disaster, update the rest of the state, and return FALSE to
3702 indicate "not finished". */
3703
3704 if (!eop && !done)
3705   {
3706   p->addr = addr;
3707   p->msg = msg;
3708   return FALSE;
3709   }
3710
3711 /* Close our end of the pipe, to prevent deadlock if the far end is still
3712 pushing stuff into it. */
3713
3714 (void)close(fd);
3715 p->fd = -1;
3716
3717 /* If we have finished without error, but haven't had data for every address,
3718 something is wrong. */
3719
3720 if (!msg && addr)
3721   msg = string_sprintf("insufficient address data read from pipe "
3722     "for transport process %d for transport %s", pid,
3723       addr->transport->driver_name);
3724
3725 /* If an error message is set, something has gone wrong in getting back
3726 the delivery data. Put the message into each address and freeze it. */
3727
3728 if (msg)
3729   for (addr = addrlist; addr; addr = addr->next)
3730     {
3731     addr->transport_return = DEFER;
3732     addr->special_action = SPECIAL_FREEZE;
3733     addr->message = msg;
3734     log_write(0, LOG_MAIN|LOG_PANIC, "Delivery status for %s: %s\n", addr->address, addr->message);
3735     }
3736
3737 /* Return TRUE to indicate we have got all we need from this process, even
3738 if it hasn't actually finished yet. */
3739
3740 return TRUE;
3741 }
3742
3743
3744
3745 /*************************************************
3746 *   Post-process a set of remote addresses       *
3747 *************************************************/
3748
3749 /* Do what has to be done immediately after a remote delivery for each set of
3750 addresses, then re-write the spool if necessary. Note that post_process_one
3751 puts the address on an appropriate queue; hence we must fish off the next
3752 one first. This function is also called if there is a problem with setting
3753 up a subprocess to do a remote delivery in parallel. In this case, the final
3754 argument contains a message, and the action must be forced to DEFER.
3755
3756 Argument:
3757    addr      pointer to chain of address items
3758    logflags  flags for logging
3759    msg       NULL for normal cases; -> error message for unexpected problems
3760    fallback  TRUE if processing fallback hosts
3761
3762 Returns:     nothing
3763 */
3764
3765 static void
3766 remote_post_process(address_item *addr, int logflags, uschar *msg,
3767   BOOL fallback)
3768 {
3769 /* If any host addresses were found to be unusable, add them to the unusable
3770 tree so that subsequent deliveries don't try them. */
3771
3772 for (host_item * h = addr->host_list; h; h = h->next)
3773   if (h->address)
3774     if (h->status >= hstatus_unusable) tree_add_unusable(h);
3775
3776 /* Now handle each address on the chain. The transport has placed '=' or '-'
3777 into the special_action field for each successful delivery. */
3778
3779 while (addr)
3780   {
3781   address_item *next = addr->next;
3782
3783   /* If msg == NULL (normal processing) and the result is DEFER and we are
3784   processing the main hosts and there are fallback hosts available, put the
3785   address on the list for fallback delivery. */
3786
3787   if (  addr->transport_return == DEFER
3788      && addr->fallback_hosts
3789      && !fallback
3790      && !msg
3791      )
3792     {
3793     addr->host_list = addr->fallback_hosts;
3794     addr->next = addr_fallback;
3795     addr_fallback = addr;
3796     DEBUG(D_deliver) debug_printf("%s queued for fallback host(s)\n", addr->address);
3797     }
3798
3799   /* If msg is set (=> unexpected problem), set it in the address before
3800   doing the ordinary post processing. */
3801
3802   else
3803     {
3804     if (msg)
3805       {
3806       addr->message = msg;
3807       addr->transport_return = DEFER;
3808       }
3809     (void)post_process_one(addr, addr->transport_return, logflags,
3810       EXIM_DTYPE_TRANSPORT, addr->special_action);
3811     }
3812
3813   /* Next address */
3814
3815   addr = next;
3816   }
3817
3818 /* If we have just delivered down a passed SMTP channel, and that was
3819 the last address, the channel will have been closed down. Now that
3820 we have logged that delivery, set continue_sequence to 1 so that
3821 any subsequent deliveries don't get "*" incorrectly logged. */
3822
3823 if (!continue_transport) continue_sequence = 1;
3824 }
3825
3826
3827
3828 /*************************************************
3829 *     Wait for one remote delivery subprocess    *
3830 *************************************************/
3831
3832 /* This function is called while doing remote deliveries when either the
3833 maximum number of processes exist and we need one to complete so that another
3834 can be created, or when waiting for the last ones to complete. It must wait for
3835 the completion of one subprocess, empty the control block slot, and return a
3836 pointer to the address chain.
3837
3838 Arguments:    none
3839 Returns:      pointer to the chain of addresses handled by the process;
3840               NULL if no subprocess found - this is an unexpected error
3841 */
3842
3843 static address_item *
3844 par_wait(void)
3845 {
3846 int poffset, status;
3847 address_item * addr, * addrlist;
3848 pid_t pid;
3849
3850 set_process_info("delivering %s: waiting for a remote delivery subprocess "
3851   "to finish", message_id);
3852
3853 /* Loop until either a subprocess completes, or there are no subprocesses in
3854 existence - in which case give an error return. We cannot proceed just by
3855 waiting for a completion, because a subprocess may have filled up its pipe, and
3856 be waiting for it to be emptied. Therefore, if no processes have finished, we
3857 wait for one of the pipes to acquire some data by calling poll(), with a
3858 timeout just in case.
3859
3860 The simple approach is just to iterate after reading data from a ready pipe.
3861 This leads to non-ideal behaviour when the subprocess has written its final Z
3862 item, closed the pipe, and is in the process of exiting (the common case). A
3863 call to waitpid() yields nothing completed, but poll() shows the pipe ready -
3864 reading it yields EOF, so you end up with busy-waiting until the subprocess has
3865 actually finished.
3866
3867 To avoid this, if all the data that is needed has been read from a subprocess
3868 after poll(), an explicit wait() for it is done. We know that all it is doing
3869 is writing to the pipe and then exiting, so the wait should not be long.
3870
3871 The non-blocking waitpid() is to some extent just insurance; if we could
3872 reliably detect end-of-file on the pipe, we could always know when to do a
3873 blocking wait() for a completed process. However, because some systems use
3874 NDELAY, which doesn't distinguish between EOF and pipe empty, it is easier to
3875 use code that functions without the need to recognize EOF.
3876
3877 There's a double loop here just in case we end up with a process that is not in
3878 the list of remote delivery processes. Something has obviously gone wrong if
3879 this is the case. (For example, a process that is incorrectly left over from
3880 routing or local deliveries might be found.) The damage can be minimized by
3881 looping back and looking for another process. If there aren't any, the error
3882 return will happen. */
3883
3884 for (;;)   /* Normally we do not repeat this loop */
3885   {
3886   while ((pid = waitpid(-1, &status, WNOHANG)) <= 0)
3887     {
3888     int readycount;
3889
3890     /* A return value of -1 can mean several things. If errno != ECHILD, it
3891     either means invalid options (which we discount), or that this process was
3892     interrupted by a signal. Just loop to try the waitpid() again.
3893
3894     If errno == ECHILD, waitpid() is telling us that there are no subprocesses
3895     in existence. This should never happen, and is an unexpected error.
3896     However, there is a nasty complication when running under Linux. If "strace
3897     -f" is being used under Linux to trace this process and its children,
3898     subprocesses are "stolen" from their parents and become the children of the
3899     tracing process. A general wait such as the one we've just obeyed returns
3900     as if there are no children while subprocesses are running. Once a
3901     subprocess completes, it is restored to the parent, and waitpid(-1) finds
3902     it. Thanks to Joachim Wieland for finding all this out and suggesting a
3903     palliative.
3904
3905     This does not happen using "truss" on Solaris, nor (I think) with other
3906     tracing facilities on other OS. It seems to be specific to Linux.
3907
3908     What we do to get round this is to use kill() to see if any of our
3909     subprocesses are still in existence. If kill() gives an OK return, we know
3910     it must be for one of our processes - it can't be for a re-use of the pid,
3911     because if our process had finished, waitpid() would have found it. If any
3912     of our subprocesses are in existence, we proceed to use poll() as if
3913     waitpid() had returned zero. I think this is safe. */
3914
3915     if (pid < 0)
3916       {
3917       if (errno != ECHILD) continue;   /* Repeats the waitpid() */
3918
3919       DEBUG(D_deliver)
3920         debug_printf("waitpid() returned -1/ECHILD: checking explicitly "
3921           "for process existence\n");
3922
3923       for (poffset = 0; poffset < remote_max_parallel; poffset++)
3924         {
3925         if ((pid = parlist[poffset].pid) != 0 && kill(pid, 0) == 0)
3926           {
3927           DEBUG(D_deliver) debug_printf("process %d still exists: assume "
3928             "stolen by strace\n", (int)pid);
3929           break;   /* With poffset set */
3930           }
3931         }
3932
3933       if (poffset >= remote_max_parallel)
3934         {
3935         DEBUG(D_deliver) debug_printf("*** no delivery children found\n");
3936         return NULL;    /* This is the error return */
3937         }
3938       }
3939
3940     /* A pid value greater than 0 breaks the "while" loop. A negative value has
3941     been handled above. A return value of zero means that there is at least one
3942     subprocess, but there are no completed subprocesses. See if any pipes are
3943     ready with any data for reading. */
3944
3945     DEBUG(D_deliver) debug_printf("polling subprocess pipes\n");
3946
3947     for (poffset = 0; poffset < remote_max_parallel; poffset++)
3948       if (parlist[poffset].pid != 0)
3949         {
3950         parpoll[poffset].fd = parlist[poffset].fd;
3951         parpoll[poffset].events = POLLIN;
3952         }
3953       else
3954         parpoll[poffset].fd = -1;
3955
3956     /* Stick in a 60-second timeout, just in case. */
3957
3958     readycount = poll(parpoll, remote_max_parallel, 60 * 1000);
3959
3960     /* Scan through the pipes and read any that are ready; use the count
3961     returned by poll() to stop when there are no more. Select() can return
3962     with no processes (e.g. if interrupted). This shouldn't matter.
3963
3964     If par_read_pipe() returns TRUE, it means that either the terminating Z was
3965     read, or there was a disaster. In either case, we are finished with this
3966     process. Do an explicit wait() for the process and break the main loop if
3967     it succeeds.
3968
3969     It turns out that we have to deal with the case of an interrupted system
3970     call, which can happen on some operating systems if the signal handling is
3971     set up to do that by default. */
3972
3973     for (poffset = 0;
3974          readycount > 0 && poffset < remote_max_parallel;
3975          poffset++)
3976       {
3977       if (  (pid = parlist[poffset].pid) != 0
3978          && parpoll[poffset].revents
3979          )
3980         {
3981         readycount--;
3982         if (par_read_pipe(poffset, FALSE))    /* Finished with this pipe */
3983           for (;;)                            /* Loop for signals */
3984             {
3985             pid_t endedpid = waitpid(pid, &status, 0);
3986             if (endedpid == pid) goto PROCESS_DONE;
3987             if (endedpid != (pid_t)(-1) || errno != EINTR)
3988               log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Unexpected error return "
3989                 "%d (errno = %d) from waitpid() for process %d",
3990                 (int)endedpid, errno, (int)pid);
3991             }
3992         }
3993       }
3994
3995     /* Now go back and look for a completed subprocess again. */
3996     }
3997
3998   /* A completed process was detected by the non-blocking waitpid(). Find the
3999   data block that corresponds to this subprocess. */
4000
4001   for (poffset = 0; poffset < remote_max_parallel; poffset++)
4002     if (pid == parlist[poffset].pid) break;
4003
4004   /* Found the data block; this is a known remote delivery process. We don't
4005   need to repeat the outer loop. This should be what normally happens. */
4006
4007   if (poffset < remote_max_parallel) break;
4008
4009   /* This situation is an error, but it's probably better to carry on looking
4010   for another process than to give up (as we used to do). */
4011
4012   log_write(0, LOG_MAIN|LOG_PANIC, "Process %d finished: not found in remote "
4013     "transport process list", pid);
4014   }  /* End of the "for" loop */
4015
4016 /* Come here when all the data was completely read after a poll(), and
4017 the process in pid has been wait()ed for. */
4018
4019 PROCESS_DONE:
4020
4021 DEBUG(D_deliver)
4022   {
4023   if (status == 0)
4024     debug_printf("remote delivery process %d ended\n", (int)pid);
4025   else
4026     debug_printf("remote delivery process %d ended: status=%04x\n", (int)pid,
4027       status);
4028   }
4029
4030 set_process_info("delivering %s", message_id);
4031
4032 /* Get the chain of processed addresses */
4033
4034 addrlist = parlist[poffset].addrlist;
4035
4036 /* If the process did not finish cleanly, record an error and freeze (except
4037 for SIGTERM, SIGKILL and SIGQUIT), and also ensure the journal is not removed,
4038 in case the delivery did actually happen. */
4039
4040 if ((status & 0xffff) != 0)
4041   {
4042   uschar *msg;
4043   int msb = (status >> 8) & 255;
4044   int lsb = status & 255;
4045   int code = (msb == 0)? (lsb & 0x7f) : msb;
4046
4047   msg = string_sprintf("%s transport process returned non-zero status 0x%04x: "
4048     "%s %d",
4049     addrlist->transport->driver_name,
4050     status,
4051     msb == 0 ? "terminated by signal" : "exit code",
4052     code);
4053
4054   if (msb != 0 || (code != SIGTERM && code != SIGKILL && code != SIGQUIT))
4055     addrlist->special_action = SPECIAL_FREEZE;
4056
4057   for (addr = addrlist; addr; addr = addr->next)
4058     {
4059     addr->transport_return = DEFER;
4060     addr->message = msg;
4061     }
4062
4063   remove_journal = FALSE;
4064   }
4065
4066 /* Else complete reading the pipe to get the result of the delivery, if all
4067 the data has not yet been obtained. */
4068
4069 else if (!parlist[poffset].done)
4070   (void) par_read_pipe(poffset, TRUE);
4071
4072 /* Put the data count and return path into globals, mark the data slot unused,
4073 decrement the count of subprocesses, and return the address chain. */
4074
4075 transport_count = parlist[poffset].transport_count;
4076 used_return_path = parlist[poffset].return_path;
4077 parlist[poffset].pid = 0;
4078 parcount--;
4079 return addrlist;
4080 }
4081
4082
4083
4084 /*************************************************
4085 *      Wait for subprocesses and post-process    *
4086 *************************************************/
4087
4088 /* This function waits for subprocesses until the number that are still running
4089 is below a given threshold. For each complete subprocess, the addresses are
4090 post-processed. If we can't find a running process, there is some shambles.
4091 Better not bomb out, as that might lead to multiple copies of the message. Just
4092 log and proceed as if all done.
4093
4094 Arguments:
4095   max         maximum number of subprocesses to leave running
4096   fallback    TRUE if processing fallback hosts
4097
4098 Returns:      nothing
4099 */
4100
4101 static void
4102 par_reduce(int max, BOOL fallback)
4103 {
4104 while (parcount > max)
4105   {
4106   address_item *doneaddr = par_wait();
4107   if (!doneaddr)
4108     {
4109     log_write(0, LOG_MAIN|LOG_PANIC,
4110       "remote delivery process count got out of step");
4111     parcount = 0;
4112     }
4113   else
4114     {
4115     transport_instance * tp = doneaddr->transport;
4116     if (tp->max_parallel)
4117       enq_end(string_sprintf("tpt-serialize-%s", tp->name));
4118
4119     remote_post_process(doneaddr, LOG_MAIN, NULL, fallback);
4120     }
4121   }
4122 }
4123
4124 static void
4125 rmt_dlv_checked_write(int fd, char id, char subid, void * buf, ssize_t size)
4126 {
4127 uschar pipe_header[PIPE_HEADER_SIZE+1];
4128 size_t total_len = PIPE_HEADER_SIZE + size;
4129
4130 struct iovec iov[2] = {
4131   { pipe_header, PIPE_HEADER_SIZE },  /* indication about the data to expect */
4132   { buf, size }                       /* *the* data */
4133 };
4134
4135 ssize_t ret;
4136
4137 /* we assume that size can't get larger then BIG_BUFFER_SIZE which currently is set to 16k */
4138 /* complain to log if someone tries with buffer sizes we can't handle*/
4139
4140 if (size > BIG_BUFFER_SIZE-1)
4141   {
4142   log_write(0, LOG_MAIN|LOG_PANIC_DIE,
4143     "Failed writing transport result to pipe: can't handle buffers > %d bytes. truncating!\n",
4144       BIG_BUFFER_SIZE-1);
4145   size = BIG_BUFFER_SIZE;
4146   }
4147
4148 /* Should we check that we do not write more than PIPE_BUF? What would
4149 that help? */
4150
4151 /* convert size to human readable string prepended by id and subid */
4152 if (PIPE_HEADER_SIZE != snprintf(CS pipe_header, PIPE_HEADER_SIZE+1, "%c%c%05ld",
4153     id, subid, (long)size))
4154   log_write(0, LOG_MAIN|LOG_PANIC_DIE, "header snprintf failed\n");
4155
4156 DEBUG(D_deliver) debug_printf("header write id:%c,subid:%c,size:%ld,final:%s\n",
4157                                  id, subid, (long)size, pipe_header);
4158
4159 if ((ret = writev(fd, iov, 2)) != total_len)
4160   log_write(0, LOG_MAIN|LOG_PANIC_DIE,
4161     "Failed writing transport result to pipe (%ld of %ld bytes): %s",
4162     (long)ret, (long)total_len, ret == -1 ? strerror(errno) : "short write");
4163 }
4164
4165 /*************************************************
4166 *           Do remote deliveries                 *
4167 *************************************************/
4168
4169 /* This function is called to process the addresses in addr_remote. We must
4170 pick off the queue all addresses that have the same transport, remote
4171 destination, and errors address, and hand them to the transport in one go,
4172 subject to some configured limitations. If this is a run to continue delivering
4173 to an existing delivery channel, skip all but those addresses that can go to
4174 that channel. The skipped addresses just get deferred.
4175
4176 If mua_wrapper is set, all addresses must be able to be sent in a single
4177 transaction. If not, this function yields FALSE.
4178
4179 In Exim 4, remote deliveries are always done in separate processes, even
4180 if remote_max_parallel = 1 or if there's only one delivery to do. The reason
4181 is so that the base process can retain privilege. This makes the
4182 implementation of fallback transports feasible (though not initially done.)
4183
4184 We create up to the configured number of subprocesses, each of which passes
4185 back the delivery state via a pipe. (However, when sending down an existing
4186 connection, remote_max_parallel is forced to 1.)
4187
4188 Arguments:
4189   fallback  TRUE if processing fallback hosts
4190
4191 Returns:    TRUE normally
4192             FALSE if mua_wrapper is set and the addresses cannot all be sent
4193               in one transaction
4194 */
4195
4196 static BOOL
4197 do_remote_deliveries(BOOL fallback)
4198 {
4199 int parmax;
4200 int poffset;
4201
4202 parcount = 0;    /* Number of executing subprocesses */
4203
4204 /* When sending down an existing channel, only do one delivery at a time.
4205 We use a local variable (parmax) to hold the maximum number of processes;
4206 this gets reduced from remote_max_parallel if we can't create enough pipes. */
4207
4208 if (continue_transport) remote_max_parallel = 1;
4209 parmax = remote_max_parallel;
4210
4211 /* If the data for keeping a list of processes hasn't yet been
4212 set up, do so. */
4213
4214 if (!parlist)
4215   {
4216   parlist = store_get(remote_max_parallel * sizeof(pardata), FALSE);
4217   for (poffset = 0; poffset < remote_max_parallel; poffset++)
4218     parlist[poffset].pid = 0;
4219   parpoll = store_get(remote_max_parallel * sizeof(struct pollfd), FALSE);
4220   }
4221
4222 /* Now loop for each remote delivery */
4223
4224 for (int delivery_count = 0; addr_remote; delivery_count++)
4225   {
4226   pid_t pid;
4227   uid_t uid;
4228   gid_t gid;
4229   int pfd[2];
4230   int address_count = 1;
4231   int address_count_max;
4232   BOOL multi_domain;
4233   BOOL use_initgroups;
4234   BOOL pipe_done = FALSE;
4235   transport_instance *tp;
4236   address_item **anchor = &addr_remote;
4237   address_item *addr = addr_remote;
4238   address_item *last = addr;
4239   address_item *next;
4240   uschar * panicmsg;
4241   uschar * serialize_key = NULL;
4242
4243   /* Pull the first address right off the list. */
4244
4245   addr_remote = addr->next;
4246   addr->next = NULL;
4247
4248   DEBUG(D_deliver|D_transport)
4249     debug_printf("--------> %s <--------\n", addr->address);
4250
4251   /* If no transport has been set, there has been a big screw-up somewhere. */
4252
4253   if (!(tp = addr->transport))
4254     {
4255     f.disable_logging = FALSE;  /* Jic */
4256     panicmsg = US"No transport set by router";
4257     goto panic_continue;
4258     }
4259
4260   /* Check that this base address hasn't previously been delivered to this
4261   transport. The check is necessary at this point to handle homonymic addresses
4262   correctly in cases where the pattern of redirection changes between delivery
4263   attempts. Non-homonymic previous delivery is detected earlier, at routing
4264   time. */
4265
4266   if (previously_transported(addr, FALSE)) continue;
4267
4268   /* Force failure if the message is too big. */
4269
4270   if (tp->message_size_limit)
4271     {
4272     int rc = check_message_size(tp, addr);
4273     if (rc != OK)
4274       {
4275       addr->transport_return = rc;
4276       remote_post_process(addr, LOG_MAIN, NULL, fallback);
4277       continue;
4278       }
4279     }
4280
4281 /*XXX need to defeat this when DANE is used - but we don't know that yet.
4282 So look out for the place it gets used.
4283 */
4284
4285   /* Get the flag which specifies whether the transport can handle different
4286   domains that nevertheless resolve to the same set of hosts. If it needs
4287   expanding, get variables set: $address_data, $domain_data, $localpart_data,
4288   $host, $host_address, $host_port. */
4289   if (tp->expand_multi_domain)
4290     deliver_set_expansions(addr);
4291
4292   if (exp_bool(addr, US"transport", tp->name, D_transport,
4293                 US"multi_domain", tp->multi_domain, tp->expand_multi_domain,
4294                 &multi_domain) != OK)
4295     {
4296     deliver_set_expansions(NULL);
4297     panicmsg = addr->message;
4298     goto panic_continue;
4299     }
4300
4301   /* Get the maximum it can handle in one envelope, with zero meaning
4302   unlimited, which is forced for the MUA wrapper case. */
4303
4304   address_count_max = tp->max_addresses;
4305   if (address_count_max == 0 || mua_wrapper) address_count_max = 999999;
4306
4307
4308   /************************************************************************/
4309   /*****    This is slightly experimental code, but should be safe.   *****/
4310
4311   /* The address_count_max value is the maximum number of addresses that the
4312   transport can send in one envelope. However, the transport must be capable of
4313   dealing with any number of addresses. If the number it gets exceeds its
4314   envelope limitation, it must send multiple copies of the message. This can be
4315   done over a single connection for SMTP, so uses less resources than making
4316   multiple connections. On the other hand, if remote_max_parallel is greater
4317   than one, it is perhaps a good idea to use parallel processing to move the
4318   message faster, even if that results in multiple simultaneous connections to
4319   the same host.
4320
4321   How can we come to some compromise between these two ideals? What we do is to
4322   limit the number of addresses passed to a single instance of a transport to
4323   the greater of (a) its address limit (rcpt_max for SMTP) and (b) the total
4324   number of addresses routed to remote transports divided by
4325   remote_max_parallel. For example, if the message has 100 remote recipients,
4326   remote max parallel is 2, and rcpt_max is 10, we'd never send more than 50 at
4327   once. But if rcpt_max is 100, we could send up to 100.
4328
4329   Of course, not all the remotely addresses in a message are going to go to the
4330   same set of hosts (except in smarthost configurations), so this is just a
4331   heuristic way of dividing up the work.
4332
4333   Furthermore (1), because this may not be wanted in some cases, and also to
4334   cope with really pathological cases, there is also a limit to the number of
4335   messages that are sent over one connection. This is the same limit that is
4336   used when sending several different messages over the same connection.
4337   Continue_sequence is set when in this situation, to the number sent so
4338   far, including this message.
4339
4340   Furthermore (2), when somebody explicitly sets the maximum value to 1, it
4341   is probably because they are using VERP, in which case they want to pass only
4342   one address at a time to the transport, in order to be able to use
4343   $local_part and $domain in constructing a new return path. We could test for
4344   the use of these variables, but as it is so likely they will be used when the
4345   maximum is 1, we don't bother. Just leave the value alone. */
4346
4347   if (  address_count_max != 1
4348      && address_count_max < remote_delivery_count/remote_max_parallel
4349      )
4350     {
4351     int new_max = remote_delivery_count/remote_max_parallel;
4352     int message_max = tp->connection_max_messages;
4353     if (connection_max_messages >= 0) message_max = connection_max_messages;
4354     message_max -= continue_sequence - 1;
4355     if (message_max > 0 && new_max > address_count_max * message_max)
4356       new_max = address_count_max * message_max;
4357     address_count_max = new_max;
4358     }
4359
4360   /************************************************************************/
4361
4362
4363 /*XXX don't know yet if DANE will be used.  So tpt will have to
4364 check at the point if gets next addr from list, and skip/defer any
4365 nonmatch domains
4366 */
4367
4368   /* Pick off all addresses which have the same transport, errors address,
4369   destination, and extra headers. In some cases they point to the same host
4370   list, but we also need to check for identical host lists generated from
4371   entirely different domains. The host list pointers can be NULL in the case
4372   where the hosts are defined in the transport. There is also a configured
4373   maximum limit of addresses that can be handled at once (see comments above
4374   for how it is computed).
4375   If the transport does not handle multiple domains, enforce that also,
4376   and if it might need a per-address check for this, re-evaluate it.
4377   */
4378
4379   while ((next = *anchor) && address_count < address_count_max)
4380     {
4381     BOOL md;
4382     if (  (multi_domain || Ustrcmp(next->domain, addr->domain) == 0)
4383        && tp == next->transport
4384        && same_hosts(next->host_list, addr->host_list)
4385        && same_strings(next->prop.errors_address, addr->prop.errors_address)
4386        && same_headers(next->prop.extra_headers, addr->prop.extra_headers)
4387        && same_ugid(tp, next, addr)
4388        && (  next->prop.remove_headers == addr->prop.remove_headers
4389           || (  next->prop.remove_headers
4390              && addr->prop.remove_headers
4391              && Ustrcmp(next->prop.remove_headers, addr->prop.remove_headers) == 0
4392           )  )
4393        && (  !multi_domain
4394           || (  (
4395                 (void)(!tp->expand_multi_domain || ((void)deliver_set_expansions(next), 1)),
4396                 exp_bool(addr,
4397                     US"transport", next->transport->name, D_transport,
4398                     US"multi_domain", next->transport->multi_domain,
4399                     next->transport->expand_multi_domain, &md) == OK
4400                 )
4401              && md
4402        )  )  )
4403       {
4404       *anchor = next->next;
4405       next->next = NULL;
4406       next->first = addr;  /* remember top one (for retry processing) */
4407       last->next = next;
4408       last = next;
4409       address_count++;
4410       }
4411     else anchor = &(next->next);
4412     deliver_set_expansions(NULL);
4413     }
4414
4415   /* If we are acting as an MUA wrapper, all addresses must go in a single
4416   transaction. If not, put them back on the chain and yield FALSE. */
4417
4418   if (mua_wrapper && addr_remote)
4419     {
4420     last->next = addr_remote;
4421     addr_remote = addr;
4422     return FALSE;
4423     }
4424
4425   /* If the transport is limited for parallellism, enforce that here.
4426   The hints DB entry is decremented in par_reduce(), when we reap the
4427   transport process. */
4428
4429   if (tpt_parallel_check(tp, addr, &serialize_key))
4430     if ((panicmsg = expand_string_message))
4431       goto panic_continue;
4432     else
4433       continue;                 /* Loop for the next set of addresses. */
4434
4435   /* Set up the expansion variables for this set of addresses */
4436
4437   deliver_set_expansions(addr);
4438
4439   /* Ensure any transport-set auth info is fresh */
4440   addr->authenticator = addr->auth_id = addr->auth_sndr = NULL;
4441
4442   /* Compute the return path, expanding a new one if required. The old one
4443   must be set first, as it might be referred to in the expansion. */
4444
4445   if(addr->prop.errors_address)
4446     return_path = addr->prop.errors_address;
4447   else
4448     return_path = sender_address;
4449
4450   if (tp->return_path)
4451     {
4452     uschar *new_return_path = expand_string(tp->return_path);
4453     if (new_return_path)
4454       return_path = new_return_path;
4455     else if (!f.expand_string_forcedfail)
4456       {
4457       panicmsg = string_sprintf("Failed to expand return path \"%s\": %s",
4458         tp->return_path, expand_string_message);
4459       goto enq_continue;
4460       }
4461     }
4462
4463   /* Find the uid, gid, and use_initgroups setting for this transport. Failure
4464   logs and sets up error messages, so we just post-process and continue with
4465   the next address. */
4466
4467   if (!findugid(addr, tp, &uid, &gid, &use_initgroups))
4468     {
4469     panicmsg = NULL;
4470     goto enq_continue;
4471     }
4472
4473   /* If this transport has a setup function, call it now so that it gets
4474   run in this process and not in any subprocess. That way, the results of
4475   any setup that are retained by the transport can be reusable. One of the
4476   things the setup does is to set the fallback host lists in the addresses.
4477   That is why it is called at this point, before the continue delivery
4478   processing, because that might use the fallback hosts. */
4479
4480   if (tp->setup)
4481     (void)((tp->setup)(addr->transport, addr, NULL, uid, gid, NULL));
4482
4483   /* If we have a connection still open from a verify stage (lazy-close)
4484   treat it as if it is a continued connection (apart from the counter used
4485   for the log line mark). */
4486
4487   if (cutthrough.cctx.sock >= 0 && cutthrough.callout_hold_only)
4488     {
4489     DEBUG(D_deliver)
4490       debug_printf("lazy-callout-close: have conn still open from verification\n");
4491     continue_transport = cutthrough.transport;
4492     continue_hostname = string_copy(cutthrough.host.name);
4493     continue_host_address = string_copy(cutthrough.host.address);
4494     continue_sequence = 1;
4495     sending_ip_address = cutthrough.snd_ip;
4496     sending_port = cutthrough.snd_port;
4497     smtp_peer_options = cutthrough.peer_options;
4498     }
4499
4500   /* If this is a run to continue delivery down an already-established
4501   channel, check that this set of addresses matches the transport and
4502   the channel. If it does not, defer the addresses. If a host list exists,
4503   we must check that the continue host is on the list. Otherwise, the
4504   host is set in the transport. */
4505
4506   f.continue_more = FALSE;           /* In case got set for the last lot */
4507   if (continue_transport)
4508     {
4509     BOOL ok = Ustrcmp(continue_transport, tp->name) == 0;
4510 /*XXX do we need to check for a DANEd conn vs. a change of domain? */
4511
4512     /* If the transport is about to override the host list do not check
4513     it here but take the cost of running the transport process to discover
4514     if the continued_hostname connection is suitable.  This is a layering
4515     violation which is unfortunate as it requires we haul in the smtp
4516     include file. */
4517
4518     if (ok)
4519       {
4520       smtp_transport_options_block * ob;
4521
4522       if (  !(  Ustrcmp(tp->info->driver_name, "smtp") == 0
4523              && (ob = (smtp_transport_options_block *)tp->options_block)
4524              && ob->hosts_override && ob->hosts
4525              )
4526          && addr->host_list
4527          )
4528         {
4529         ok = FALSE;
4530         for (host_item * h = addr->host_list; h; h = h->next)
4531           if (Ustrcmp(h->name, continue_hostname) == 0)
4532   /*XXX should also check port here */
4533             { ok = TRUE; break; }
4534         }
4535       }
4536
4537     /* Addresses not suitable; defer or queue for fallback hosts (which
4538     might be the continue host) and skip to next address. */
4539
4540     if (!ok)
4541       {
4542       DEBUG(D_deliver) debug_printf("not suitable for continue_transport (%s)\n",
4543         Ustrcmp(continue_transport, tp->name) != 0
4544         ? string_sprintf("tpt %s vs %s", continue_transport, tp->name)
4545         : string_sprintf("no host matching %s", continue_hostname));
4546       if (serialize_key) enq_end(serialize_key);
4547
4548       if (addr->fallback_hosts && !fallback)
4549         {
4550         for (next = addr; ; next = next->next)
4551           {
4552           next->host_list = next->fallback_hosts;
4553           DEBUG(D_deliver) debug_printf("%s queued for fallback host(s)\n", next->address);
4554           if (!next->next) break;
4555           }
4556         next->next = addr_fallback;
4557         addr_fallback = addr;
4558         }
4559
4560       else
4561         {
4562         for (next = addr; ; next = next->next)
4563           {
4564           DEBUG(D_deliver) debug_printf(" %s to def list\n", next->address);
4565           if (!next->next) break;
4566           }
4567         next->next = addr_defer;
4568         addr_defer = addr;
4569         }
4570
4571       continue;
4572       }
4573
4574     /* Set a flag indicating whether there are further addresses that list
4575     the continued host. This tells the transport to leave the channel open,
4576     but not to pass it to another delivery process. We'd like to do that
4577     for non-continue_transport cases too but the knowlege of which host is
4578     connected to is too hard to manage.  Perhaps we need a finer-grain
4579     interface to the transport. */
4580
4581     for (next = addr_remote; next && !f.continue_more; next = next->next)
4582       for (host_item * h = next->host_list; h; h = h->next)
4583         if (Ustrcmp(h->name, continue_hostname) == 0)
4584           { f.continue_more = TRUE; break; }
4585     }
4586
4587   /* The transports set up the process info themselves as they may connect
4588   to more than one remote machine. They also have to set up the filter
4589   arguments, if required, so that the host name and address are available
4590   for expansion. */
4591
4592   transport_filter_argv = NULL;
4593
4594   /* Create the pipe for inter-process communication. If pipe creation
4595   fails, it is probably because the value of remote_max_parallel is so
4596   large that too many file descriptors for pipes have been created. Arrange
4597   to wait for a process to finish, and then try again. If we still can't
4598   create a pipe when all processes have finished, break the retry loop. */
4599
4600   while (!pipe_done)
4601     {
4602     if (pipe(pfd) == 0) pipe_done = TRUE;
4603       else if (parcount > 0) parmax = parcount;
4604         else break;
4605
4606     /* We need to make the reading end of the pipe non-blocking. There are
4607     two different options for this. Exim is cunningly (I hope!) coded so
4608     that it can use either of them, though it prefers O_NONBLOCK, which
4609     distinguishes between EOF and no-more-data. */
4610
4611 /* The data appears in a timely manner and we already did a poll on
4612 all pipes, so I do not see a reason to use non-blocking IO here
4613
4614 #ifdef O_NONBLOCK
4615     (void)fcntl(pfd[pipe_read], F_SETFL, O_NONBLOCK);
4616 #else
4617     (void)fcntl(pfd[pipe_read], F_SETFL, O_NDELAY);
4618 #endif
4619 */
4620
4621     /* If the maximum number of subprocesses already exist, wait for a process
4622     to finish. If we ran out of file descriptors, parmax will have been reduced
4623     from its initial value of remote_max_parallel. */
4624
4625     par_reduce(parmax - 1, fallback);
4626     }
4627
4628   /* If we failed to create a pipe and there were no processes to wait
4629   for, we have to give up on this one. Do this outside the above loop
4630   so that we can continue the main loop. */
4631
4632   if (!pipe_done)
4633     {
4634     panicmsg = string_sprintf("unable to create pipe: %s", strerror(errno));
4635     goto enq_continue;
4636     }
4637
4638   /* Find a free slot in the pardata list. Must do this after the possible
4639   waiting for processes to finish, because a terminating process will free
4640   up a slot. */
4641
4642   for (poffset = 0; poffset < remote_max_parallel; poffset++)
4643     if (parlist[poffset].pid == 0)
4644       break;
4645
4646   /* If there isn't one, there has been a horrible disaster. */
4647
4648   if (poffset >= remote_max_parallel)
4649     {
4650     (void)close(pfd[pipe_write]);
4651     (void)close(pfd[pipe_read]);
4652     panicmsg = US"Unexpectedly no free subprocess slot";
4653     goto enq_continue;
4654     }
4655
4656   /* Now fork a subprocess to do the remote delivery, but before doing so,
4657   ensure that any cached resources are released so as not to interfere with
4658   what happens in the subprocess. */
4659
4660   search_tidyup();
4661
4662   if ((pid = exim_fork(US"transport")) == 0)
4663     {
4664     int fd = pfd[pipe_write];
4665     host_item *h;
4666
4667     /* Setting this global in the subprocess means we need never clear it */
4668     transport_name = tp->name;
4669
4670     /* There are weird circumstances in which logging is disabled */
4671     f.disable_logging = tp->disable_logging;
4672
4673     /* Show pids on debug output if parallelism possible */
4674
4675     if (parmax > 1 && (parcount > 0 || addr_remote))
4676       DEBUG(D_any|D_v) debug_selector |= D_pid;
4677
4678     /* Reset the random number generator, so different processes don't all
4679     have the same sequence. In the test harness we want different, but
4680     predictable settings for each delivery process, so do something explicit
4681     here rather they rely on the fixed reset in the random number function. */
4682
4683     random_seed = f.running_in_test_harness ? 42 + 2*delivery_count : 0;
4684
4685     /* Set close-on-exec on the pipe so that it doesn't get passed on to
4686     a new process that may be forked to do another delivery down the same
4687     SMTP connection. */
4688
4689     (void)fcntl(fd, F_SETFD, fcntl(fd, F_GETFD) | FD_CLOEXEC);
4690
4691     /* Close open file descriptors for the pipes of other processes
4692     that are running in parallel. */
4693
4694     for (poffset = 0; poffset < remote_max_parallel; poffset++)
4695       if (parlist[poffset].pid != 0) (void)close(parlist[poffset].fd);
4696
4697     /* This process has inherited a copy of the file descriptor
4698     for the data file, but its file pointer is shared with all the
4699     other processes running in parallel. Therefore, we have to re-open
4700     the file in order to get a new file descriptor with its own
4701     file pointer. We don't need to lock it, as the lock is held by
4702     the parent process. There doesn't seem to be any way of doing
4703     a dup-with-new-file-pointer. */
4704
4705     (void)close(deliver_datafile);
4706     {
4707     uschar * fname = spool_fname(US"input", message_subdir, message_id, US"-D");
4708
4709     if ((deliver_datafile = Uopen(fname,
4710 #ifdef O_CLOEXEC
4711                                         O_CLOEXEC |
4712 #endif
4713                                         O_RDWR | O_APPEND, 0)) < 0)
4714       log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Failed to reopen %s for remote "
4715         "parallel delivery: %s", fname, strerror(errno));
4716     }
4717
4718     /* Set the close-on-exec flag */
4719 #ifndef O_CLOEXEC
4720     (void)fcntl(deliver_datafile, F_SETFD, fcntl(deliver_datafile, F_GETFD) |
4721       FD_CLOEXEC);
4722 #endif
4723
4724     /* Set the uid/gid of this process; bombs out on failure. */
4725
4726     exim_setugid(uid, gid, use_initgroups,
4727       string_sprintf("remote delivery to %s with transport=%s",
4728         addr->address, tp->name));
4729
4730     /* Close the unwanted half of this process' pipe, set the process state,
4731     and run the transport. Afterwards, transport_count will contain the number
4732     of bytes written. */
4733
4734     (void)close(pfd[pipe_read]);
4735     set_process_info("delivering %s using %s", message_id, tp->name);
4736     debug_print_string(tp->debug_string);
4737     if (!(tp->info->code)(addr->transport, addr)) replicate_status(addr);
4738
4739     set_process_info("delivering %s (just run %s for %s%s in subprocess)",
4740       message_id, tp->name, addr->address, addr->next ? ", ..." : "");
4741
4742     /* Ensure any cached resources that we used are now released */
4743
4744     search_tidyup();
4745
4746     /* Pass the result back down the pipe. This is a lot more information
4747     than is needed for a local delivery. We have to send back the error
4748     status for each address, the usability status for each host that is
4749     flagged as unusable, and all the retry items. When TLS is in use, we
4750     send also the cipher and peerdn information. Each type of information
4751     is flagged by an identifying byte, and is then in a fixed format (with
4752     strings terminated by zeros), and there is a final terminator at the
4753     end. The host information and retry information is all attached to
4754     the first address, so that gets sent at the start. */
4755
4756     /* Host unusability information: for most success cases this will
4757     be null. */
4758
4759     for (h = addr->host_list; h; h = h->next)
4760       {
4761       if (!h->address || h->status < hstatus_unusable) continue;
4762       sprintf(CS big_buffer, "%c%c%s", h->status, h->why, h->address);
4763       rmt_dlv_checked_write(fd, 'H', '0', big_buffer, Ustrlen(big_buffer+2) + 3);
4764       }
4765
4766     /* The number of bytes written. This is the same for each address. Even
4767     if we sent several copies of the message down the same connection, the
4768     size of each one is the same, and it's that value we have got because
4769     transport_count gets reset before calling transport_write_message(). */
4770
4771     memcpy(big_buffer, &transport_count, sizeof(transport_count));
4772     rmt_dlv_checked_write(fd, 'S', '0', big_buffer, sizeof(transport_count));
4773
4774     /* Information about what happened to each address. Four item types are
4775     used: an optional 'X' item first, for TLS information, then an optional "C"
4776     item for any client-auth info followed by 'R' items for any retry settings,
4777     and finally an 'A' item for the remaining data. */
4778
4779     for(; addr; addr = addr->next)
4780       {
4781       uschar *ptr;
4782
4783       /* The certificate verification status goes into the flags */
4784       if (tls_out.certificate_verified) setflag(addr, af_cert_verified);
4785 #ifdef SUPPORT_DANE
4786       if (tls_out.dane_verified)        setflag(addr, af_dane_verified);
4787 #endif
4788 # ifndef DISABLE_TLS_RESUME
4789       if (tls_out.resumption & RESUME_USED) setflag(addr, af_tls_resume);
4790 # endif
4791
4792       /* Use an X item only if there's something to send */
4793 #ifndef DISABLE_TLS
4794       if (addr->cipher)
4795         {
4796         ptr = big_buffer + sprintf(CS big_buffer, "%.128s", addr->cipher) + 1;
4797         if (!addr->peerdn)
4798           *ptr++ = 0;
4799         else
4800           ptr += sprintf(CS ptr, "%.512s", addr->peerdn) + 1;
4801
4802         rmt_dlv_checked_write(fd, 'X', '1', big_buffer, ptr - big_buffer);
4803         }
4804       else if (continue_proxy_cipher)
4805         {
4806         ptr = big_buffer + sprintf(CS big_buffer, "%.128s", continue_proxy_cipher) + 1;
4807         *ptr++ = 0;
4808         rmt_dlv_checked_write(fd, 'X', '1', big_buffer, ptr - big_buffer);
4809         }
4810
4811       if (addr->peercert)
4812         {
4813         ptr = big_buffer;
4814         if (tls_export_cert(ptr, big_buffer_size-2, addr->peercert))
4815           while(*ptr++);
4816         else
4817           *ptr++ = 0;
4818         rmt_dlv_checked_write(fd, 'X', '2', big_buffer, ptr - big_buffer);
4819         }
4820       if (addr->ourcert)
4821         {
4822         ptr = big_buffer;
4823         if (tls_export_cert(ptr, big_buffer_size-2, addr->ourcert))
4824           while(*ptr++);
4825         else
4826           *ptr++ = 0;
4827         rmt_dlv_checked_write(fd, 'X', '3', big_buffer, ptr - big_buffer);
4828         }
4829 # ifndef DISABLE_OCSP
4830       if (addr->ocsp > OCSP_NOT_REQ)
4831         {
4832         ptr = big_buffer + sprintf(CS big_buffer, "%c", addr->ocsp + '0') + 1;
4833         rmt_dlv_checked_write(fd, 'X', '4', big_buffer, ptr - big_buffer);
4834         }
4835 # endif
4836 #endif  /*DISABLE_TLS*/
4837
4838       if (client_authenticator)
4839         {
4840         ptr = big_buffer + sprintf(CS big_buffer, "%.64s", client_authenticator) + 1;
4841         rmt_dlv_checked_write(fd, 'C', '1', big_buffer, ptr - big_buffer);
4842         }
4843       if (client_authenticated_id)
4844         {
4845         ptr = big_buffer + sprintf(CS big_buffer, "%.64s", client_authenticated_id) + 1;
4846         rmt_dlv_checked_write(fd, 'C', '2', big_buffer, ptr - big_buffer);
4847         }
4848       if (client_authenticated_sender)
4849         {
4850         ptr = big_buffer + sprintf(CS big_buffer, "%.64s", client_authenticated_sender) + 1;
4851         rmt_dlv_checked_write(fd, 'C', '3', big_buffer, ptr - big_buffer);
4852         }
4853
4854 #ifndef DISABLE_PRDR
4855       if (testflag(addr, af_prdr_used))
4856         rmt_dlv_checked_write(fd, 'P', '0', NULL, 0);
4857 #endif
4858
4859       if (testflag(addr, af_pipelining))
4860 #ifndef DISABLE_PIPE_CONNECT
4861         if (testflag(addr, af_early_pipe))
4862           rmt_dlv_checked_write(fd, 'L', '2', NULL, 0);
4863         else
4864 #endif
4865           rmt_dlv_checked_write(fd, 'L', '1', NULL, 0);
4866
4867       if (testflag(addr, af_chunking_used))
4868         rmt_dlv_checked_write(fd, 'K', '0', NULL, 0);
4869
4870       if (testflag(addr, af_tcp_fastopen_conn))
4871         rmt_dlv_checked_write(fd, 'T',
4872           testflag(addr, af_tcp_fastopen) ? testflag(addr, af_tcp_fastopen_data)
4873           ? '2' : '1' : '0',
4874           NULL, 0);
4875
4876       memcpy(big_buffer, &addr->dsn_aware, sizeof(addr->dsn_aware));
4877       rmt_dlv_checked_write(fd, 'D', '0', big_buffer, sizeof(addr->dsn_aware));
4878
4879       /* Retry information: for most success cases this will be null. */
4880
4881       for (retry_item * r = addr->retries; r; r = r->next)
4882         {
4883         sprintf(CS big_buffer, "%c%.500s", r->flags, r->key);
4884         ptr = big_buffer + Ustrlen(big_buffer+2) + 3;
4885         memcpy(ptr, &r->basic_errno, sizeof(r->basic_errno));
4886         ptr += sizeof(r->basic_errno);
4887         memcpy(ptr, &r->more_errno, sizeof(r->more_errno));
4888         ptr += sizeof(r->more_errno);
4889         if (!r->message) *ptr++ = 0; else
4890           {
4891           sprintf(CS ptr, "%.512s", r->message);
4892           while(*ptr++);
4893           }
4894         rmt_dlv_checked_write(fd, 'R', '0', big_buffer, ptr - big_buffer);
4895         }
4896
4897       if (testflag(addr, af_new_conn) || testflag(addr, af_cont_conn))
4898         {
4899         DEBUG(D_deliver) debug_printf("%scontinued-connection\n",
4900           testflag(addr, af_new_conn) ? "non-" : "");
4901         big_buffer[0] = testflag(addr, af_new_conn) ? BIT(1) : BIT(2);
4902         rmt_dlv_checked_write(fd, 'A', '3', big_buffer, 1);
4903         }
4904
4905 #ifdef SUPPORT_SOCKS
4906       if (LOGGING(proxy) && proxy_session)
4907         {
4908         ptr = big_buffer;
4909         if (proxy_local_address)
4910           {
4911           DEBUG(D_deliver) debug_printf("proxy_local_address '%s'\n", proxy_local_address);
4912           ptr = big_buffer + sprintf(CS ptr, "%.128s", proxy_local_address) + 1;
4913           DEBUG(D_deliver) debug_printf("proxy_local_port %d\n", proxy_local_port);
4914           memcpy(ptr, &proxy_local_port, sizeof(proxy_local_port));
4915           ptr += sizeof(proxy_local_port);
4916           }
4917         else
4918           *ptr++ = '\0';
4919         rmt_dlv_checked_write(fd, 'A', '2', big_buffer, ptr - big_buffer);
4920         }
4921 #endif
4922
4923 #ifdef EXPERIMENTAL_DSN_INFO
4924 /*um, are they really per-addr?  Other per-conn stuff is not (auth, tls).  But host_used is! */
4925       if (addr->smtp_greeting)
4926         {
4927         DEBUG(D_deliver) debug_printf("smtp_greeting '%s'\n", addr->smtp_greeting);
4928         ptr = big_buffer + sprintf(CS big_buffer, "%.128s", addr->smtp_greeting) + 1;
4929         if (addr->helo_response)
4930           {
4931           DEBUG(D_deliver) debug_printf("helo_response '%s'\n", addr->helo_response);
4932           ptr += sprintf(CS ptr, "%.128s", addr->helo_response) + 1;
4933           }
4934         else
4935           *ptr++ = '\0';
4936         rmt_dlv_checked_write(fd, 'A', '1', big_buffer, ptr - big_buffer);
4937         }
4938 #endif
4939
4940       /* The rest of the information goes in an 'A0' item. */
4941
4942       sprintf(CS big_buffer, "%c%c", addr->transport_return, addr->special_action);
4943       ptr = big_buffer + 2;
4944       memcpy(ptr, &addr->basic_errno, sizeof(addr->basic_errno));
4945       ptr += sizeof(addr->basic_errno);
4946       memcpy(ptr, &addr->more_errno, sizeof(addr->more_errno));
4947       ptr += sizeof(addr->more_errno);
4948       memcpy(ptr, &addr->delivery_time, sizeof(addr->delivery_time));
4949       ptr += sizeof(addr->delivery_time);
4950       memcpy(ptr, &addr->flags, sizeof(addr->flags));
4951       ptr += sizeof(addr->flags);
4952
4953       if (!addr->message) *ptr++ = 0; else
4954         ptr += sprintf(CS ptr, "%.1024s", addr->message) + 1;
4955
4956       if (!addr->user_message) *ptr++ = 0; else
4957         ptr += sprintf(CS ptr, "%.1024s", addr->user_message) + 1;
4958
4959       if (!addr->host_used) *ptr++ = 0; else
4960         {
4961         ptr += sprintf(CS ptr, "%.256s", addr->host_used->name) + 1;
4962         ptr += sprintf(CS ptr, "%.64s", addr->host_used->address) + 1;
4963         memcpy(ptr, &addr->host_used->port, sizeof(addr->host_used->port));
4964         ptr += sizeof(addr->host_used->port);
4965
4966         /* DNS lookup status */
4967         *ptr++ = addr->host_used->dnssec==DS_YES ? '2'
4968                : addr->host_used->dnssec==DS_NO ? '1' : '0';
4969
4970         }
4971       rmt_dlv_checked_write(fd, 'A', '0', big_buffer, ptr - big_buffer);
4972       }
4973
4974     /* Local interface address/port */
4975 #ifdef EXPERIMENTAL_DSN_INFO
4976     if (sending_ip_address)
4977 #else
4978     if (LOGGING(incoming_interface) && sending_ip_address)
4979 #endif
4980       {
4981       uschar * ptr;
4982       ptr = big_buffer + sprintf(CS big_buffer, "%.128s", sending_ip_address) + 1;
4983       ptr += sprintf(CS ptr, "%d", sending_port) + 1;
4984       rmt_dlv_checked_write(fd, 'I', '0', big_buffer, ptr - big_buffer);
4985       }
4986
4987     /* Add termination flag, close the pipe, and that's it. The character
4988     after 'Z' indicates whether continue_transport is now NULL or not.
4989     A change from non-NULL to NULL indicates a problem with a continuing
4990     connection. */
4991
4992     big_buffer[0] = continue_transport ? '1' : '0';
4993     rmt_dlv_checked_write(fd, 'Z', '0', big_buffer, 1);
4994     (void)close(fd);
4995     exit(EXIT_SUCCESS);
4996     }
4997
4998   /* Back in the mainline: close the unwanted half of the pipe. */
4999
5000   (void)close(pfd[pipe_write]);
5001
5002   /* If we have a connection still open from a verify stage (lazy-close)
5003   release its TLS library context (if any) as responsibility was passed to
5004   the delivery child process. */
5005
5006   if (cutthrough.cctx.sock >= 0 && cutthrough.callout_hold_only)
5007     {
5008 #ifndef DISABLE_TLS
5009     if (cutthrough.is_tls)
5010       tls_close(cutthrough.cctx.tls_ctx, TLS_NO_SHUTDOWN);
5011 #endif
5012     (void) close(cutthrough.cctx.sock);
5013     release_cutthrough_connection(US"passed to transport proc");
5014     }
5015
5016   /* Fork failed; defer with error message */
5017
5018   if (pid == -1)
5019     {
5020     (void)close(pfd[pipe_read]);
5021     panicmsg = string_sprintf("fork failed for remote delivery to %s: %s",
5022         addr->domain, strerror(errno));
5023     goto enq_continue;
5024     }
5025
5026   /* Fork succeeded; increment the count, and remember relevant data for
5027   when the process finishes. */
5028
5029   parcount++;
5030   parlist[poffset].addrlist = parlist[poffset].addr = addr;
5031   parlist[poffset].pid = pid;
5032   parlist[poffset].fd = pfd[pipe_read];
5033   parlist[poffset].done = FALSE;
5034   parlist[poffset].msg = NULL;
5035   parlist[poffset].return_path = return_path;
5036
5037   /* If the process we've just started is sending a message down an existing
5038   channel, wait for it now. This ensures that only one such process runs at
5039   once, whatever the value of remote_max parallel. Otherwise, we might try to
5040   send two or more messages simultaneously down the same channel. This could
5041   happen if there are different domains that include the same host in otherwise
5042   different host lists.
5043
5044   Also, if the transport closes down the channel, this information gets back
5045   (continue_transport gets set to NULL) before we consider any other addresses
5046   in this message. */
5047
5048   if (continue_transport) par_reduce(0, fallback);
5049
5050   /* Otherwise, if we are running in the test harness, wait a bit, to let the
5051   newly created process get going before we create another process. This should
5052   ensure repeatability in the tests. Wait long enough for most cases to complete
5053   the transport. */
5054
5055   else testharness_pause_ms(600);
5056
5057   continue;
5058
5059 enq_continue:
5060   if (serialize_key) enq_end(serialize_key);
5061 panic_continue:
5062   remote_post_process(addr, LOG_MAIN|LOG_PANIC, panicmsg, fallback);
5063   continue;
5064   }
5065
5066 /* Reached the end of the list of addresses. Wait for all the subprocesses that
5067 are still running and post-process their addresses. */
5068
5069 par_reduce(0, fallback);
5070 return TRUE;
5071 }
5072
5073
5074
5075
5076 /*************************************************
5077 *   Split an address into local part and domain  *
5078 *************************************************/
5079
5080 /* This function initializes an address for routing by splitting it up into a
5081 local part and a domain. The local part is set up twice - once in its original
5082 casing, and once in lower case, and it is dequoted. We also do the "percent
5083 hack" for configured domains. This may lead to a DEFER result if a lookup
5084 defers. When a percent-hacking takes place, we insert a copy of the original
5085 address as a new parent of this address, as if we have had a redirection.
5086
5087 Argument:
5088   addr      points to an addr_item block containing the address
5089
5090 Returns:    OK
5091             DEFER   - could not determine if domain is %-hackable
5092 */
5093
5094 int
5095 deliver_split_address(address_item * addr)
5096 {
5097 uschar * address = addr->address;
5098 uschar * domain;
5099 uschar * t;
5100 int len;
5101
5102 if (!(domain = Ustrrchr(address, '@')))
5103   return DEFER;         /* should always have a domain, but just in case... */
5104
5105 len = domain - address;
5106 addr->domain = string_copylc(domain+1);    /* Domains are always caseless */
5107
5108 /* The implication in the RFCs (though I can't say I've seen it spelled out
5109 explicitly) is that quoting should be removed from local parts at the point
5110 where they are locally interpreted. [The new draft "821" is more explicit on
5111 this, Jan 1999.] We know the syntax is valid, so this can be done by simply
5112 removing quoting backslashes and any unquoted doublequotes. */
5113
5114 t = addr->cc_local_part = store_get(len+1, is_tainted(address));
5115 while(len-- > 0)
5116   {
5117   int c = *address++;
5118   if (c == '\"') continue;
5119   if (c == '\\')
5120     {
5121     *t++ = *address++;
5122     len--;
5123     }
5124   else *t++ = c;
5125   }
5126 *t = 0;
5127
5128 /* We do the percent hack only for those domains that are listed in
5129 percent_hack_domains. A loop is required, to copy with multiple %-hacks. */
5130
5131 if (percent_hack_domains)
5132   {
5133   int rc;
5134   uschar *new_address = NULL;
5135   uschar *local_part = addr->cc_local_part;
5136
5137   deliver_domain = addr->domain;  /* set $domain */
5138
5139   while (  (rc = match_isinlist(deliver_domain, (const uschar **)&percent_hack_domains, 0,
5140                &domainlist_anchor, addr->domain_cache, MCL_DOMAIN, TRUE, NULL))
5141              == OK
5142         && (t = Ustrrchr(local_part, '%')) != NULL
5143         )
5144     {
5145     new_address = string_copy(local_part);
5146     new_address[t - local_part] = '@';
5147     deliver_domain = string_copylc(t+1);
5148     local_part = string_copyn(local_part, t - local_part);
5149     }
5150
5151   if (rc == DEFER) return DEFER;   /* lookup deferred */
5152
5153   /* If hackery happened, set up new parent and alter the current address. */
5154
5155   if (new_address)
5156     {
5157     address_item *new_parent = store_get(sizeof(address_item), FALSE);
5158     *new_parent = *addr;
5159     addr->parent = new_parent;
5160     new_parent->child_count = 1;
5161     addr->address = new_address;
5162     addr->unique = string_copy(new_address);
5163     addr->domain = deliver_domain;
5164     addr->cc_local_part = local_part;
5165     DEBUG(D_deliver) debug_printf("%%-hack changed address to: %s\n",
5166       addr->address);
5167     }
5168   }
5169
5170 /* Create the lowercased version of the final local part, and make that the
5171 default one to be used. */
5172
5173 addr->local_part = addr->lc_local_part = string_copylc(addr->cc_local_part);
5174 return OK;
5175 }
5176
5177
5178
5179
5180 /*************************************************
5181 *      Get next error message text               *
5182 *************************************************/
5183
5184 /* If f is not NULL, read the next "paragraph", from a customized error message
5185 text file, terminated by a line containing ****, and expand it.
5186
5187 Arguments:
5188   f          NULL or a file to read from
5189   which      string indicating which string (for errors)
5190
5191 Returns:     NULL or an expanded string
5192 */
5193
5194 static uschar *
5195 next_emf(FILE *f, uschar *which)
5196 {
5197 uschar *yield;
5198 gstring * para;
5199 uschar buffer[256];
5200
5201 if (!f) return NULL;
5202
5203 if (!Ufgets(buffer, sizeof(buffer), f) || Ustrcmp(buffer, "****\n") == 0)
5204   return NULL;
5205
5206 para = string_get(256);
5207 for (;;)
5208   {
5209   para = string_cat(para, buffer);
5210   if (!Ufgets(buffer, sizeof(buffer), f) || Ustrcmp(buffer, "****\n") == 0)
5211     break;
5212   }
5213 if ((yield = expand_string(string_from_gstring(para))))
5214   return yield;
5215
5216 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand string from "
5217   "bounce_message_file or warn_message_file (%s): %s", which,
5218   expand_string_message);
5219 return NULL;
5220 }
5221
5222
5223
5224
5225 /*************************************************
5226 *      Close down a passed transport channel     *
5227 *************************************************/
5228
5229 /* This function is called when a passed transport channel cannot be used.
5230 It attempts to close it down tidily. The yield is always DELIVER_NOT_ATTEMPTED
5231 so that the function call can be the argument of a "return" statement.
5232
5233 Arguments:  None
5234 Returns:    DELIVER_NOT_ATTEMPTED
5235 */
5236
5237 static int
5238 continue_closedown(void)
5239 {
5240 if (continue_transport)
5241   for (transport_instance * t = transports; t; t = t->next)
5242     if (Ustrcmp(t->name, continue_transport) == 0)
5243       {
5244       if (t->info->closedown) (t->info->closedown)(t);
5245       break;
5246       }
5247 return DELIVER_NOT_ATTEMPTED;
5248 }
5249
5250
5251
5252
5253 /*************************************************
5254 *           Print address information            *
5255 *************************************************/
5256
5257 /* This function is called to output an address, or information about an
5258 address, for bounce or defer messages. If the hide_child flag is set, all we
5259 output is the original ancestor address.
5260
5261 Arguments:
5262   addr         points to the address
5263   f            the FILE to print to
5264   si           an initial string
5265   sc           a continuation string for before "generated"
5266   se           an end string
5267
5268 Returns:       TRUE if the address is not hidden
5269 */
5270
5271 static BOOL
5272 print_address_information(address_item *addr, FILE *f, uschar *si, uschar *sc,
5273   uschar *se)
5274 {
5275 BOOL yield = TRUE;
5276 uschar *printed = US"";
5277 address_item *ancestor = addr;
5278 while (ancestor->parent) ancestor = ancestor->parent;
5279
5280 fprintf(f, "%s", CS si);
5281
5282 if (addr->parent && testflag(addr, af_hide_child))
5283   {
5284   printed = US"an undisclosed address";
5285   yield = FALSE;
5286   }
5287 else if (!testflag(addr, af_pfr) || !addr->parent)
5288   printed = addr->address;
5289
5290 else
5291   {
5292   uschar *s = addr->address;
5293   uschar *ss;
5294
5295   if (addr->address[0] == '>') { ss = US"mail"; s++; }
5296   else if (addr->address[0] == '|') ss = US"pipe";
5297   else ss = US"save";
5298
5299   fprintf(f, "%s to %s%sgenerated by ", ss, s, sc);
5300   printed = addr->parent->address;
5301   }
5302
5303 fprintf(f, "%s", CS string_printing(printed));
5304
5305 if (ancestor != addr)
5306   {
5307   uschar *original = ancestor->onetime_parent;
5308   if (!original) original= ancestor->address;
5309   if (strcmpic(original, printed) != 0)
5310     fprintf(f, "%s(%sgenerated from %s)", sc,
5311       ancestor != addr->parent ? "ultimately " : "",
5312       string_printing(original));
5313   }
5314
5315 if (addr->host_used)
5316   fprintf(f, "\n    host %s [%s]",
5317           addr->host_used->name, addr->host_used->address);
5318
5319 fprintf(f, "%s", CS se);
5320 return yield;
5321 }
5322
5323
5324
5325
5326
5327 /*************************************************
5328 *         Print error for an address             *
5329 *************************************************/
5330
5331 /* This function is called to print the error information out of an address for
5332 a bounce or a warning message. It tries to format the message reasonably by
5333 introducing newlines. All lines are indented by 4; the initial printing
5334 position must be set before calling.
5335
5336 This function used always to print the error. Nowadays we want to restrict it
5337 to cases such as LMTP/SMTP errors from a remote host, and errors from :fail:
5338 and filter "fail". We no longer pass other information willy-nilly in bounce
5339 and warning messages. Text in user_message is always output; text in message
5340 only if the af_pass_message flag is set.
5341
5342 Arguments:
5343   addr         the address
5344   f            the FILE to print on
5345   t            some leading text
5346
5347 Returns:       nothing
5348 */
5349
5350 static void
5351 print_address_error(address_item *addr, FILE *f, uschar *t)
5352 {
5353 int count = Ustrlen(t);
5354 uschar *s = testflag(addr, af_pass_message) ? addr->message : NULL;
5355
5356 if (!s && !(s = addr->user_message))
5357   return;
5358
5359 fprintf(f, "\n    %s", t);
5360
5361 while (*s)
5362   if (*s == '\\' && s[1] == 'n')
5363     {
5364     fprintf(f, "\n    ");
5365     s += 2;
5366     count = 0;
5367     }
5368   else
5369     {
5370     fputc(*s, f);
5371     count++;
5372     if (*s++ == ':' && isspace(*s) && count > 45)
5373       {
5374       fprintf(f, "\n   ");  /* sic (because space follows) */
5375       count = 0;
5376       }
5377     }
5378 }
5379
5380
5381 /***********************************************************
5382 *         Print Diagnostic-Code for an address             *
5383 ************************************************************/
5384
5385 /* This function is called to print the error information out of an address for
5386 a bounce or a warning message. It tries to format the message reasonably as
5387 required by RFC 3461 by adding a space after each newline
5388
5389 it uses the same logic as print_address_error() above. if af_pass_message is true
5390 and addr->message is set it uses the remote host answer. if not addr->user_message
5391 is used instead if available.
5392
5393 Arguments:
5394   addr         the address
5395   f            the FILE to print on
5396
5397 Returns:       nothing
5398 */
5399
5400 static void
5401 print_dsn_diagnostic_code(const address_item *addr, FILE *f)
5402 {
5403 uschar * s = testflag(addr, af_pass_message) ? addr->message : NULL;
5404 unsigned cnt;
5405
5406 /* af_pass_message and addr->message set ? print remote host answer */
5407 if (s)
5408   {
5409   DEBUG(D_deliver)
5410     debug_printf("DSN Diagnostic-Code: addr->message = %s\n", addr->message);
5411
5412   /* search first ": ". we assume to find the remote-MTA answer there */
5413   if (!(s = Ustrstr(addr->message, ": ")))
5414     return;                             /* not found, bail out */
5415   s += 2;  /* skip ": " */
5416   cnt = fprintf(f, "Diagnostic-Code: smtp; ");
5417   }
5418 /* no message available. do nothing */
5419 else return;
5420
5421 while (*s)
5422   {
5423   if (cnt > 950)        /* RFC line length limit: 998 */
5424     {
5425     DEBUG(D_deliver) debug_printf("print_dsn_diagnostic_code() truncated line\n");
5426     fputs("[truncated]", f);
5427     break;
5428     }
5429
5430   if (*s == '\\' && s[1] == 'n')
5431     {
5432     fputs("\n ", f);    /* as defined in RFC 3461 */
5433     s += 2;
5434     cnt += 2;
5435     }
5436   else
5437     {
5438     fputc(*s++, f);
5439     cnt++;
5440     }
5441   }
5442
5443 fputc('\n', f);
5444 }
5445
5446
5447 /*************************************************
5448 *     Check list of addresses for duplication    *
5449 *************************************************/
5450
5451 /* This function was introduced when the test for duplicate addresses that are
5452 not pipes, files, or autoreplies was moved from the middle of routing to when
5453 routing was complete. That was to fix obscure cases when the routing history
5454 affects the subsequent routing of identical addresses. This function is called
5455 after routing, to check that the final routed addresses are not duplicates.
5456
5457 If we detect a duplicate, we remember what it is a duplicate of. Note that
5458 pipe, file, and autoreply de-duplication is handled during routing, so we must
5459 leave such "addresses" alone here, as otherwise they will incorrectly be
5460 discarded.
5461
5462 Argument:     address of list anchor
5463 Returns:      nothing
5464 */
5465
5466 static void
5467 do_duplicate_check(address_item **anchor)
5468 {
5469 address_item *addr;
5470 while ((addr = *anchor))
5471   {
5472   tree_node *tnode;
5473   if (testflag(addr, af_pfr))
5474     {
5475     anchor = &(addr->next);
5476     }
5477   else if ((tnode = tree_search(tree_duplicates, addr->unique)))
5478     {
5479     DEBUG(D_deliver|D_route)
5480       debug_printf("%s is a duplicate address: discarded\n", addr->unique);
5481     *anchor = addr->next;
5482     addr->dupof = tnode->data.ptr;
5483     addr->next = addr_duplicate;
5484     addr_duplicate = addr;
5485     }
5486   else
5487     {
5488     tree_add_duplicate(addr->unique, addr);
5489     anchor = &(addr->next);
5490     }
5491   }
5492 }
5493
5494
5495
5496
5497 /************************************************/
5498
5499 static void
5500 print_dsn_addr_action(FILE * f, address_item * addr,
5501   uschar * action, uschar * status)
5502 {
5503 address_item * pa;
5504
5505 if (addr->dsn_orcpt)
5506   fprintf(f,"Original-Recipient: %s\n", addr->dsn_orcpt);
5507
5508 for (pa = addr; pa->parent; ) pa = pa->parent;
5509 fprintf(f, "Action: %s\n"
5510     "Final-Recipient: rfc822;%s\n"
5511     "Status: %s\n",
5512   action, pa->address, status);
5513 }
5514
5515
5516
5517 /* When running in the test harness, there's an option that allows us to
5518 fudge this time so as to get repeatability of the tests. Take the first
5519 time off the list. In queue runs, the list pointer gets updated in the
5520 calling process. */
5521
5522 int
5523 test_harness_fudged_queue_time(int actual_time)
5524 {
5525 int qt;
5526 if (  f.running_in_test_harness && *fudged_queue_times
5527    && (qt = readconf_readtime(fudged_queue_times, '/', FALSE)) >= 0)
5528   {
5529   DEBUG(D_deliver) debug_printf("fudged queue_times = %s\n",
5530     fudged_queue_times);
5531   return qt;
5532   }
5533 return actual_time;
5534 }
5535
5536 /************************************************/
5537
5538 static FILE *
5539 expand_open(const uschar * filename,
5540   const uschar * varname, const uschar * reason)
5541 {
5542 const uschar * s = expand_cstring(filename);
5543 FILE * fp = NULL;
5544
5545 if (!s || !*s)
5546   log_write(0, LOG_MAIN|LOG_PANIC,
5547     "Failed to expand %s: '%s'\n", varname, filename);
5548 else if (*s != '/')
5549   log_write(0, LOG_MAIN|LOG_PANIC, "%s is not absolute after expansion: '%s'\n",
5550     varname, s);
5551 else if (is_tainted2(s, LOG_MAIN|LOG_PANIC, "Tainted %s after expansion: '%s'\n", varname, s))
5552   ;
5553 else if (!(fp = Ufopen(s, "rb")))
5554   log_write(0, LOG_MAIN|LOG_PANIC, "Failed to open %s for %s "
5555     "message texts: %s", s, reason, strerror(errno));
5556 return fp;
5557 }
5558
5559 /*************************************************
5560 *              Deliver one message               *
5561 *************************************************/
5562
5563 /* This is the function which is called when a message is to be delivered. It
5564 is passed the id of the message. It is possible that the message no longer
5565 exists, if some other process has delivered it, and it is also possible that
5566 the message is being worked on by another process, in which case the data file
5567 will be locked.
5568
5569 If no delivery is attempted for any of the above reasons, the function returns
5570 DELIVER_NOT_ATTEMPTED.
5571
5572 If the give_up flag is set true, do not attempt any deliveries, but instead
5573 fail all outstanding addresses and return the message to the sender (or
5574 whoever).
5575
5576 A delivery operation has a process all to itself; we never deliver more than
5577 one message in the same process. Therefore we needn't worry too much about
5578 store leakage.
5579
5580 Liable to be called as root.
5581
5582 Arguments:
5583   id          the id of the message to be delivered
5584   forced      TRUE if delivery was forced by an administrator; this overrides
5585               retry delays and causes a delivery to be tried regardless
5586   give_up     TRUE if an administrator has requested that delivery attempts
5587               be abandoned
5588
5589 Returns:      When the global variable mua_wrapper is FALSE:
5590                 DELIVER_ATTEMPTED_NORMAL   if a delivery attempt was made
5591                 DELIVER_NOT_ATTEMPTED      otherwise (see comment above)
5592               When the global variable mua_wrapper is TRUE:
5593                 DELIVER_MUA_SUCCEEDED      if delivery succeeded
5594                 DELIVER_MUA_FAILED         if delivery failed
5595                 DELIVER_NOT_ATTEMPTED      if not attempted (should not occur)
5596 */
5597
5598 int
5599 deliver_message(uschar *id, BOOL forced, BOOL give_up)
5600 {
5601 int i, rc;
5602 int final_yield = DELIVER_ATTEMPTED_NORMAL;
5603 time_t now = time(NULL);
5604 address_item *addr_last = NULL;
5605 uschar *filter_message = NULL;
5606 int process_recipients = RECIP_ACCEPT;
5607 open_db dbblock;
5608 open_db *dbm_file;
5609 extern int acl_where;
5610 uschar *info;
5611
5612 #ifdef MEASURE_TIMING
5613 report_time_since(&timestamp_startup, US"delivery start");      /* testcase 0022, 2100 */
5614 #endif
5615
5616 info = queue_run_pid == (pid_t)0
5617   ? string_sprintf("delivering %s", id)
5618   : string_sprintf("delivering %s (queue run pid %d)", id, queue_run_pid);
5619
5620 /* If the D_process_info bit is on, set_process_info() will output debugging
5621 information. If not, we want to show this initial information if D_deliver or
5622 D_queue_run is set or in verbose mode. */
5623
5624 set_process_info("%s", info);
5625
5626 if (  !(debug_selector & D_process_info)
5627    && (debug_selector & (D_deliver|D_queue_run|D_v))
5628    )
5629   debug_printf("%s\n", info);
5630
5631 /* Ensure that we catch any subprocesses that are created. Although Exim
5632 sets SIG_DFL as its initial default, some routes through the code end up
5633 here with it set to SIG_IGN - cases where a non-synchronous delivery process
5634 has been forked, but no re-exec has been done. We use sigaction rather than
5635 plain signal() on those OS where SA_NOCLDWAIT exists, because we want to be
5636 sure it is turned off. (There was a problem on AIX with this.) */
5637
5638 #ifdef SA_NOCLDWAIT
5639   {
5640   struct sigaction act;
5641   act.sa_handler = SIG_DFL;
5642   sigemptyset(&(act.sa_mask));
5643   act.sa_flags = 0;
5644   sigaction(SIGCHLD, &act, NULL);
5645   }
5646 #else
5647 signal(SIGCHLD, SIG_DFL);
5648 #endif
5649
5650 /* Make the forcing flag available for routers and transports, set up the
5651 global message id field, and initialize the count for returned files and the
5652 message size. This use of strcpy() is OK because the length id is checked when
5653 it is obtained from a command line (the -M or -q options), and otherwise it is
5654 known to be a valid message id. */
5655
5656 if (id != message_id)
5657   Ustrcpy(message_id, id);
5658 f.deliver_force = forced;
5659 return_count = 0;
5660 message_size = 0;
5661
5662 /* Initialize some flags */
5663
5664 update_spool = FALSE;
5665 remove_journal = TRUE;
5666
5667 /* Set a known context for any ACLs we call via expansions */
5668 acl_where = ACL_WHERE_DELIVERY;
5669
5670 /* Reset the random number generator, so that if several delivery processes are
5671 started from a queue runner that has already used random numbers (for sorting),
5672 they don't all get the same sequence. */
5673
5674 random_seed = 0;
5675
5676 /* Open and lock the message's data file. Exim locks on this one because the
5677 header file may get replaced as it is re-written during the delivery process.
5678 Any failures cause messages to be written to the log, except for missing files
5679 while queue running - another process probably completed delivery. As part of
5680 opening the data file, message_subdir gets set. */
5681
5682 if ((deliver_datafile = spool_open_datafile(id)) < 0)
5683   return continue_closedown();  /* yields DELIVER_NOT_ATTEMPTED */
5684
5685 /* The value of message_size at this point has been set to the data length,
5686 plus one for the blank line that notionally precedes the data. */
5687
5688 /* Now read the contents of the header file, which will set up the headers in
5689 store, and also the list of recipients and the tree of non-recipients and
5690 assorted flags. It updates message_size. If there is a reading or format error,
5691 give up; if the message has been around for sufficiently long, remove it. */
5692
5693   {
5694   uschar * spoolname = string_sprintf("%s-H", id);
5695   if ((rc = spool_read_header(spoolname, TRUE, TRUE)) != spool_read_OK)
5696     {
5697     if (errno == ERRNO_SPOOLFORMAT)
5698       {
5699       struct stat statbuf;
5700       if (Ustat(spool_fname(US"input", message_subdir, spoolname, US""),
5701                 &statbuf) == 0)
5702         log_write(0, LOG_MAIN, "Format error in spool file %s: "
5703           "size=" OFF_T_FMT, spoolname, statbuf.st_size);
5704       else
5705         log_write(0, LOG_MAIN, "Format error in spool file %s", spoolname);
5706       }
5707     else
5708       log_write(0, LOG_MAIN, "Error reading spool file %s: %s", spoolname,
5709         strerror(errno));
5710
5711     /* If we managed to read the envelope data, received_time contains the
5712     time the message was received. Otherwise, we can calculate it from the
5713     message id. */
5714
5715     if (rc != spool_read_hdrerror)
5716       {
5717       received_time.tv_sec = received_time.tv_usec = 0;
5718       /*XXX subsec precision?*/
5719       for (i = 0; i < 6; i++)
5720         received_time.tv_sec = received_time.tv_sec * BASE_62 + tab62[id[i] - '0'];
5721       }
5722
5723     /* If we've had this malformed message too long, sling it. */
5724
5725     if (now - received_time.tv_sec > keep_malformed)
5726       {
5727       Uunlink(spool_fname(US"msglog", message_subdir, id, US""));
5728       Uunlink(spool_fname(US"input", message_subdir, id, US"-D"));
5729       Uunlink(spool_fname(US"input", message_subdir, id, US"-H"));
5730       Uunlink(spool_fname(US"input", message_subdir, id, US"-J"));
5731       log_write(0, LOG_MAIN, "Message removed because older than %s",
5732         readconf_printtime(keep_malformed));
5733       }
5734
5735     (void)close(deliver_datafile);
5736     deliver_datafile = -1;
5737     return continue_closedown();   /* yields DELIVER_NOT_ATTEMPTED */
5738     }
5739   }
5740
5741 /* The spool header file has been read. Look to see if there is an existing
5742 journal file for this message. If there is, it means that a previous delivery
5743 attempt crashed (program or host) before it could update the spool header file.
5744 Read the list of delivered addresses from the journal and add them to the
5745 nonrecipients tree. Then update the spool file. We can leave the journal in
5746 existence, as it will get further successful deliveries added to it in this
5747 run, and it will be deleted if this function gets to its end successfully.
5748 Otherwise it might be needed again. */
5749
5750   {
5751   uschar * fname = spool_fname(US"input", message_subdir, id, US"-J");
5752   FILE * jread;
5753
5754   if (  (journal_fd = Uopen(fname, O_RDWR|O_APPEND
5755 #ifdef O_CLOEXEC
5756                                     | O_CLOEXEC
5757 #endif
5758 #ifdef O_NOFOLLOW
5759                                     | O_NOFOLLOW
5760 #endif
5761         , SPOOL_MODE)) >= 0
5762      && lseek(journal_fd, 0, SEEK_SET) == 0
5763      && (jread = fdopen(journal_fd, "rb"))
5764      )
5765     {
5766     while (Ufgets(big_buffer, big_buffer_size, jread))
5767       {
5768       int n = Ustrlen(big_buffer);
5769       big_buffer[n-1] = 0;
5770       tree_add_nonrecipient(big_buffer);
5771       DEBUG(D_deliver) debug_printf("Previously delivered address %s taken from "
5772         "journal file\n", big_buffer);
5773       }
5774     rewind(jread);
5775     if ((journal_fd = dup(fileno(jread))) < 0)
5776       journal_fd = fileno(jread);
5777     else
5778       (void) fclose(jread);     /* Try to not leak the FILE resource */
5779
5780     /* Panic-dies on error */
5781     (void)spool_write_header(message_id, SW_DELIVERING, NULL);
5782     }
5783   else if (errno != ENOENT)
5784     {
5785     log_write(0, LOG_MAIN|LOG_PANIC, "attempt to open journal for reading gave: "
5786       "%s", strerror(errno));
5787     return continue_closedown();   /* yields DELIVER_NOT_ATTEMPTED */
5788     }
5789
5790   /* A null recipients list indicates some kind of disaster. */
5791
5792   if (!recipients_list)
5793     {
5794     (void)close(deliver_datafile);
5795     deliver_datafile = -1;
5796     log_write(0, LOG_MAIN, "Spool error: no recipients for %s", fname);
5797     return continue_closedown();   /* yields DELIVER_NOT_ATTEMPTED */
5798     }
5799   }
5800
5801
5802 /* Handle a message that is frozen. There are a number of different things that
5803 can happen, but in the default situation, unless forced, no delivery is
5804 attempted. */
5805
5806 if (f.deliver_freeze)
5807   {
5808 #ifdef SUPPORT_MOVE_FROZEN_MESSAGES
5809   /* Moving to another directory removes the message from Exim's view. Other
5810   tools must be used to deal with it. Logging of this action happens in
5811   spool_move_message() and its subfunctions. */
5812
5813   if (  move_frozen_messages
5814      && spool_move_message(id, message_subdir, US"", US"F")
5815      )
5816     return continue_closedown();   /* yields DELIVER_NOT_ATTEMPTED */
5817 #endif
5818
5819   /* For all frozen messages (bounces or not), timeout_frozen_after sets the
5820   maximum time to keep messages that are frozen. Thaw if we reach it, with a
5821   flag causing all recipients to be failed. The time is the age of the
5822   message, not the time since freezing. */
5823
5824   if (timeout_frozen_after > 0 && message_age >= timeout_frozen_after)
5825     {
5826     log_write(0, LOG_MAIN, "cancelled by timeout_frozen_after");
5827     process_recipients = RECIP_FAIL_TIMEOUT;
5828     }
5829
5830   /* For bounce messages (and others with no sender), thaw if the error message
5831   ignore timer is exceeded. The message will be discarded if this delivery
5832   fails. */
5833
5834   else if (!*sender_address && message_age >= ignore_bounce_errors_after)
5835     log_write(0, LOG_MAIN, "Unfrozen by errmsg timer");
5836
5837   /* If this is a bounce message, or there's no auto thaw, or we haven't
5838   reached the auto thaw time yet, and this delivery is not forced by an admin
5839   user, do not attempt delivery of this message. Note that forced is set for
5840   continuing messages down the same channel, in order to skip load checking and
5841   ignore hold domains, but we don't want unfreezing in that case. */
5842
5843   else
5844     {
5845     if (  (  sender_address[0] == 0
5846           || auto_thaw <= 0
5847           || now <= deliver_frozen_at + auto_thaw
5848           )
5849        && (  !forced || !f.deliver_force_thaw
5850           || !f.admin_user || continue_hostname
5851        )  )
5852       {
5853       (void)close(deliver_datafile);
5854       deliver_datafile = -1;
5855       log_write(L_skip_delivery, LOG_MAIN, "Message is frozen");
5856       return continue_closedown();   /* yields DELIVER_NOT_ATTEMPTED */
5857       }
5858
5859     /* If delivery was forced (by an admin user), assume a manual thaw.
5860     Otherwise it's an auto thaw. */
5861
5862     if (forced)
5863       {
5864       f.deliver_manual_thaw = TRUE;
5865       log_write(0, LOG_MAIN, "Unfrozen by forced delivery");
5866       }
5867     else log_write(0, LOG_MAIN, "Unfrozen by auto-thaw");
5868     }
5869
5870   /* We get here if any of the rules for unfreezing have triggered. */
5871
5872   f.deliver_freeze = FALSE;
5873   update_spool = TRUE;
5874   }
5875
5876
5877 /* Open the message log file if we are using them. This records details of
5878 deliveries, deferments, and failures for the benefit of the mail administrator.
5879 The log is not used by exim itself to track the progress of a message; that is
5880 done by rewriting the header spool file. */
5881
5882 if (message_logs)
5883   {
5884   uschar * fname = spool_fname(US"msglog", message_subdir, id, US"");
5885   uschar * error;
5886   int fd;
5887
5888   if ((fd = open_msglog_file(fname, SPOOL_MODE, &error)) < 0)
5889     {
5890     log_write(0, LOG_MAIN|LOG_PANIC, "Couldn't %s message log %s: %s", error,
5891       fname, strerror(errno));
5892     return continue_closedown();   /* yields DELIVER_NOT_ATTEMPTED */
5893     }
5894
5895   /* Make a C stream out of it. */
5896
5897   if (!(message_log = fdopen(fd, "a")))
5898     {
5899     log_write(0, LOG_MAIN|LOG_PANIC, "Couldn't fdopen message log %s: %s",
5900       fname, strerror(errno));
5901     return continue_closedown();   /* yields DELIVER_NOT_ATTEMPTED */
5902     }
5903   }
5904
5905
5906 /* If asked to give up on a message, log who did it, and set the action for all
5907 the addresses. */
5908
5909 if (give_up)
5910   {
5911   struct passwd *pw = getpwuid(real_uid);
5912   log_write(0, LOG_MAIN, "cancelled by %s",
5913       pw ? US pw->pw_name : string_sprintf("uid %ld", (long int)real_uid));
5914   process_recipients = RECIP_FAIL;
5915   }
5916
5917 /* Otherwise, if there are too many Received: headers, fail all recipients. */
5918
5919 else if (received_count > received_headers_max)
5920   process_recipients = RECIP_FAIL_LOOP;
5921
5922 /* Otherwise, if a system-wide, address-independent message filter is
5923 specified, run it now, except in the case when we are failing all recipients as
5924 a result of timeout_frozen_after. If the system filter yields "delivered", then
5925 ignore the true recipients of the message. Failure of the filter file is
5926 logged, and the delivery attempt fails. */
5927
5928 else if (system_filter && process_recipients != RECIP_FAIL_TIMEOUT)
5929   {
5930   int rc;
5931   int filtertype;
5932   ugid_block ugid;
5933   redirect_block redirect;
5934
5935   if (system_filter_uid_set)
5936     {
5937     ugid.uid = system_filter_uid;
5938     ugid.gid = system_filter_gid;
5939     ugid.uid_set = ugid.gid_set = TRUE;
5940     }
5941   else
5942     ugid.uid_set = ugid.gid_set = FALSE;
5943
5944   return_path = sender_address;
5945   f.enable_dollar_recipients = TRUE;   /* Permit $recipients in system filter */
5946   f.system_filtering = TRUE;
5947
5948   /* Any error in the filter file causes a delivery to be abandoned. */
5949
5950   redirect.string = system_filter;
5951   redirect.isfile = TRUE;
5952   redirect.check_owner = redirect.check_group = FALSE;
5953   redirect.owners = NULL;
5954   redirect.owngroups = NULL;
5955   redirect.pw = NULL;
5956   redirect.modemask = 0;
5957
5958   DEBUG(D_deliver|D_filter) debug_printf("running system filter\n");
5959
5960   rc = rda_interpret(
5961     &redirect,              /* Where the data is */
5962     RDO_DEFER |             /* Turn on all the enabling options */
5963       RDO_FAIL |            /* Leave off all the disabling options */
5964       RDO_FILTER |
5965       RDO_FREEZE |
5966       RDO_REALLOG |
5967       RDO_REWRITE,
5968     NULL,                   /* No :include: restriction (not used in filter) */
5969     NULL,                   /* No sieve vacation directory (not sieve!) */
5970     NULL,                   /* No sieve enotify mailto owner (not sieve!) */
5971     NULL,                   /* No sieve user address (not sieve!) */
5972     NULL,                   /* No sieve subaddress (not sieve!) */
5973     &ugid,                  /* uid/gid data */
5974     &addr_new,              /* Where to hang generated addresses */
5975     &filter_message,        /* Where to put error message */
5976     NULL,                   /* Don't skip syntax errors */
5977     &filtertype,            /* Will always be set to FILTER_EXIM for this call */
5978     US"system filter");     /* For error messages */
5979
5980   DEBUG(D_deliver|D_filter) debug_printf("system filter returned %d\n", rc);
5981
5982   if (rc == FF_ERROR || rc == FF_NONEXIST)
5983     {
5984     (void)close(deliver_datafile);
5985     deliver_datafile = -1;
5986     log_write(0, LOG_MAIN|LOG_PANIC, "Error in system filter: %s",
5987       string_printing(filter_message));
5988     return continue_closedown();   /* yields DELIVER_NOT_ATTEMPTED */
5989     }
5990
5991   /* Reset things. If the filter message is an empty string, which can happen
5992   for a filter "fail" or "freeze" command with no text, reset it to NULL. */
5993
5994   f.system_filtering = FALSE;
5995   f.enable_dollar_recipients = FALSE;
5996   if (filter_message && filter_message[0] == 0) filter_message = NULL;
5997
5998   /* Save the values of the system filter variables so that user filters
5999   can use them. */
6000
6001   memcpy(filter_sn, filter_n, sizeof(filter_sn));
6002
6003   /* The filter can request that delivery of the original addresses be
6004   deferred. */
6005
6006   if (rc == FF_DEFER)
6007     {
6008     process_recipients = RECIP_DEFER;
6009     deliver_msglog("Delivery deferred by system filter\n");
6010     log_write(0, LOG_MAIN, "Delivery deferred by system filter");
6011     }
6012
6013   /* The filter can request that a message be frozen, but this does not
6014   take place if the message has been manually thawed. In that case, we must
6015   unset "delivered", which is forced by the "freeze" command to make -bF
6016   work properly. */
6017
6018   else if (rc == FF_FREEZE && !f.deliver_manual_thaw)
6019     {
6020     f.deliver_freeze = TRUE;
6021     deliver_frozen_at = time(NULL);
6022     process_recipients = RECIP_DEFER;
6023     frozen_info = string_sprintf(" by the system filter%s%s",
6024       filter_message ? US": " : US"",
6025       filter_message ? filter_message : US"");
6026     }
6027
6028   /* The filter can request that a message be failed. The error message may be
6029   quite long - it is sent back to the sender in the bounce - but we don't want
6030   to fill up the log with repetitions of it. If it starts with << then the text
6031   between << and >> is written to the log, with the rest left for the bounce
6032   message. */
6033
6034   else if (rc == FF_FAIL)
6035     {
6036     uschar *colon = US"";
6037     uschar *logmsg = US"";
6038     int loglen = 0;
6039
6040     process_recipients = RECIP_FAIL_FILTER;
6041
6042     if (filter_message)
6043       {
6044       uschar *logend;
6045       colon = US": ";
6046       if (  filter_message[0] == '<'
6047          && filter_message[1] == '<'
6048          && (logend = Ustrstr(filter_message, ">>"))
6049          )
6050         {
6051         logmsg = filter_message + 2;
6052         loglen = logend - logmsg;
6053         filter_message = logend + 2;
6054         if (filter_message[0] == 0) filter_message = NULL;
6055         }
6056       else
6057         {
6058         logmsg = filter_message;
6059         loglen = Ustrlen(filter_message);
6060         }
6061       }
6062
6063     log_write(0, LOG_MAIN, "cancelled by system filter%s%.*s", colon, loglen,
6064       logmsg);
6065     }
6066
6067   /* Delivery can be restricted only to those recipients (if any) that the
6068   filter specified. */
6069
6070   else if (rc == FF_DELIVERED)
6071     {
6072     process_recipients = RECIP_IGNORE;
6073     if (addr_new)
6074       log_write(0, LOG_MAIN, "original recipients ignored (system filter)");
6075     else
6076       log_write(0, LOG_MAIN, "=> discarded (system filter)");
6077     }
6078
6079   /* If any new addresses were created by the filter, fake up a "parent"
6080   for them. This is necessary for pipes, etc., which are expected to have
6081   parents, and it also gives some sensible logging for others. Allow
6082   pipes, files, and autoreplies, and run them as the filter uid if set,
6083   otherwise as the current uid. */
6084
6085   if (addr_new)
6086     {
6087     int uid = system_filter_uid_set ? system_filter_uid : geteuid();
6088     int gid = system_filter_gid_set ? system_filter_gid : getegid();
6089
6090     /* The text "system-filter" is tested in transport_set_up_command() and in
6091     set_up_shell_command() in the pipe transport, to enable them to permit
6092     $recipients, so don't change it here without also changing it there. */
6093
6094     address_item *p = addr_new;
6095     address_item *parent = deliver_make_addr(US"system-filter", FALSE);
6096
6097     parent->domain = string_copylc(qualify_domain_recipient);
6098     parent->local_part = US"system-filter";
6099
6100     /* As part of this loop, we arrange for addr_last to end up pointing
6101     at the final address. This is used if we go on to add addresses for the
6102     original recipients. */
6103
6104     while (p)
6105       {
6106       if (parent->child_count == USHRT_MAX)
6107         log_write(0, LOG_MAIN|LOG_PANIC_DIE, "system filter generated more "
6108           "than %d delivery addresses", USHRT_MAX);
6109       parent->child_count++;
6110       p->parent = parent;
6111
6112       if (testflag(p, af_pfr))
6113         {
6114         uschar *tpname;
6115         uschar *type;
6116         p->uid = uid;
6117         p->gid = gid;
6118         setflag(p, af_uid_set);
6119         setflag(p, af_gid_set);
6120         setflag(p, af_allow_file);
6121         setflag(p, af_allow_pipe);
6122         setflag(p, af_allow_reply);
6123
6124         /* Find the name of the system filter's appropriate pfr transport */
6125
6126         if (p->address[0] == '|')
6127           {
6128           type = US"pipe";
6129           tpname = system_filter_pipe_transport;
6130           address_pipe = p->address;
6131           }
6132         else if (p->address[0] == '>')
6133           {
6134           type = US"reply";
6135           tpname = system_filter_reply_transport;
6136           }
6137         else
6138           {
6139           if (p->address[Ustrlen(p->address)-1] == '/')
6140             {
6141             type = US"directory";
6142             tpname = system_filter_directory_transport;
6143             }
6144           else
6145             {
6146             type = US"file";
6147             tpname = system_filter_file_transport;
6148             }
6149           address_file = p->address;
6150           }
6151
6152         /* Now find the actual transport, first expanding the name. We have
6153         set address_file or address_pipe above. */
6154
6155         if (tpname)
6156           {
6157           uschar *tmp = expand_string(tpname);
6158           address_file = address_pipe = NULL;
6159           if (!tmp)
6160             p->message = string_sprintf("failed to expand \"%s\" as a "
6161               "system filter transport name", tpname);
6162           { uschar *m;
6163           if ((m = is_tainted2(tmp, 0, "Tainted values '%s' " "for transport '%s' as a system filter", tmp, tpname)))
6164             p->message = m;
6165           }
6166           tpname = tmp;
6167           }
6168         else
6169           p->message = string_sprintf("system_filter_%s_transport is unset",
6170             type);
6171
6172         if (tpname)
6173           {
6174           transport_instance *tp;
6175           for (tp = transports; tp; tp = tp->next)
6176             if (Ustrcmp(tp->name, tpname) == 0)
6177               {
6178               p->transport = tp;
6179               break;
6180               }
6181           if (!tp)
6182             p->message = string_sprintf("failed to find \"%s\" transport "
6183               "for system filter delivery", tpname);
6184           }
6185
6186         /* If we couldn't set up a transport, defer the delivery, putting the
6187         error on the panic log as well as the main log. */
6188
6189         if (!p->transport)
6190           {
6191           address_item *badp = p;
6192           p = p->next;
6193           if (!addr_last) addr_new = p; else addr_last->next = p;
6194           badp->local_part = badp->address;   /* Needed for log line */
6195           post_process_one(badp, DEFER, LOG_MAIN|LOG_PANIC, EXIM_DTYPE_ROUTER, 0);
6196           continue;
6197           }
6198         }    /* End of pfr handling */
6199
6200       /* Either a non-pfr delivery, or we found a transport */
6201
6202       DEBUG(D_deliver|D_filter)
6203         debug_printf("system filter added %s\n", p->address);
6204
6205       addr_last = p;
6206       p = p->next;
6207       }    /* Loop through all addr_new addresses */
6208     }
6209   }
6210
6211
6212 /* Scan the recipients list, and for every one that is not in the non-
6213 recipients tree, add an addr item to the chain of new addresses. If the pno
6214 value is non-negative, we must set the onetime parent from it. This which
6215 points to the relevant entry in the recipients list.
6216
6217 This processing can be altered by the setting of the process_recipients
6218 variable, which is changed if recipients are to be ignored, failed, or
6219 deferred. This can happen as a result of system filter activity, or if the -Mg
6220 option is used to fail all of them.
6221
6222 Duplicate addresses are handled later by a different tree structure; we can't
6223 just extend the non-recipients tree, because that will be re-written to the
6224 spool if the message is deferred, and in any case there are casing
6225 complications for local addresses. */
6226
6227 if (process_recipients != RECIP_IGNORE)
6228   for (i = 0; i < recipients_count; i++)
6229     if (!tree_search(tree_nonrecipients, recipients_list[i].address))
6230       {
6231       recipient_item *r = recipients_list + i;
6232       address_item *new = deliver_make_addr(r->address, FALSE);
6233       new->prop.errors_address = r->errors_to;
6234 #ifdef SUPPORT_I18N
6235       if ((new->prop.utf8_msg = message_smtputf8))
6236         {
6237         new->prop.utf8_downcvt =       message_utf8_downconvert == 1;
6238         new->prop.utf8_downcvt_maybe = message_utf8_downconvert == -1;
6239         DEBUG(D_deliver) debug_printf("utf8, downconvert %s\n",
6240           new->prop.utf8_downcvt ? "yes"
6241           : new->prop.utf8_downcvt_maybe ? "ifneeded"
6242           : "no");
6243         }
6244 #endif
6245
6246       if (r->pno >= 0)
6247         new->onetime_parent = recipients_list[r->pno].address;
6248
6249       /* If DSN support is enabled, set the dsn flags and the original receipt
6250       to be passed on to other DSN enabled MTAs */
6251
6252       new->dsn_flags = r->dsn_flags & rf_dsnflags;
6253       new->dsn_orcpt = r->orcpt;
6254       DEBUG(D_deliver) debug_printf("DSN: set orcpt: %s  flags: 0x%x\n",
6255         new->dsn_orcpt ? new->dsn_orcpt : US"", new->dsn_flags);
6256
6257       switch (process_recipients)
6258         {
6259         /* RECIP_DEFER is set when a system filter freezes a message. */
6260
6261         case RECIP_DEFER:
6262           new->next = addr_defer;
6263           addr_defer = new;
6264           break;
6265
6266
6267         /* RECIP_FAIL_FILTER is set when a system filter has obeyed a "fail"
6268         command. */
6269
6270         case RECIP_FAIL_FILTER:
6271           new->message =
6272             filter_message ? filter_message : US"delivery cancelled";
6273           setflag(new, af_pass_message);
6274           goto RECIP_QUEUE_FAILED;   /* below */
6275
6276
6277         /* RECIP_FAIL_TIMEOUT is set when a message is frozen, but is older
6278         than the value in timeout_frozen_after. Treat non-bounce messages
6279         similarly to -Mg; for bounce messages we just want to discard, so
6280         don't put the address on the failed list. The timeout has already
6281         been logged. */
6282
6283         case RECIP_FAIL_TIMEOUT:
6284           new->message  = US"delivery cancelled; message timed out";
6285           goto RECIP_QUEUE_FAILED;   /* below */
6286
6287
6288         /* RECIP_FAIL is set when -Mg has been used. */
6289
6290         case RECIP_FAIL:
6291           new->message  = US"delivery cancelled by administrator";
6292           /* Fall through */
6293
6294         /* Common code for the failure cases above. If this is not a bounce
6295         message, put the address on the failed list so that it is used to
6296         create a bounce. Otherwise do nothing - this just discards the address.
6297         The incident has already been logged. */
6298
6299         RECIP_QUEUE_FAILED:
6300           if (sender_address[0])
6301             {
6302             new->next = addr_failed;
6303             addr_failed = new;
6304             }
6305         break;
6306
6307
6308         /* RECIP_FAIL_LOOP is set when there are too many Received: headers
6309         in the message. Process each address as a routing failure; if this
6310         is a bounce message, it will get frozen. */
6311
6312         case RECIP_FAIL_LOOP:
6313           new->message = US"Too many \"Received\" headers - suspected mail loop";
6314           post_process_one(new, FAIL, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
6315           break;
6316
6317
6318         /* Value should be RECIP_ACCEPT; take this as the safe default. */
6319
6320         default:
6321           if (!addr_new) addr_new = new; else addr_last->next = new;
6322           addr_last = new;
6323           break;
6324         }
6325
6326 #ifndef DISABLE_EVENT
6327       if (process_recipients != RECIP_ACCEPT && event_action)
6328         {
6329         uschar * save_local =  deliver_localpart;
6330         const uschar * save_domain = deliver_domain;
6331         uschar * addr = new->address, * errmsg = NULL;
6332         int start, end, dom;
6333
6334         if (!parse_extract_address(addr, &errmsg, &start, &end, &dom, TRUE))
6335           log_write(0, LOG_MAIN|LOG_PANIC,
6336                 "failed to parse address '%.100s': %s\n", addr, errmsg);
6337         else
6338           {
6339           deliver_localpart =
6340             string_copyn(addr+start, dom ? (dom-1) - start : end - start);
6341           deliver_domain = dom ? CUS string_copyn(addr+dom, end - dom) : CUS"";
6342
6343           (void) event_raise(event_action, US"msg:fail:internal", new->message, NULL);
6344
6345           deliver_localpart = save_local;
6346           deliver_domain = save_domain;
6347           }
6348         }
6349 #endif
6350       }
6351
6352 DEBUG(D_deliver)
6353   {
6354   debug_printf("Delivery address list:\n");
6355   for (address_item * p = addr_new; p; p = p->next)
6356     debug_printf("  %s %s\n", p->address,
6357       p->onetime_parent ? p->onetime_parent : US"");
6358   }
6359
6360 /* Set up the buffers used for copying over the file when delivering. */
6361
6362 deliver_in_buffer = store_malloc(DELIVER_IN_BUFFER_SIZE);
6363 deliver_out_buffer = store_malloc(DELIVER_OUT_BUFFER_SIZE);
6364
6365
6366
6367 /* Until there are no more new addresses, handle each one as follows:
6368
6369  . If this is a generated address (indicated by the presence of a parent
6370    pointer) then check to see whether it is a pipe, file, or autoreply, and
6371    if so, handle it directly here. The router that produced the address will
6372    have set the allow flags into the address, and also set the uid/gid required.
6373    Having the routers generate new addresses and then checking them here at
6374    the outer level is tidier than making each router do the checking, and
6375    means that routers don't need access to the failed address queue.
6376
6377  . Break up the address into local part and domain, and make lowercased
6378    versions of these strings. We also make unquoted versions of the local part.
6379
6380  . Handle the percent hack for those domains for which it is valid.
6381
6382  . For child addresses, determine if any of the parents have the same address.
6383    If so, generate a different string for previous delivery checking. Without
6384    this code, if the address spqr generates spqr via a forward or alias file,
6385    delivery of the generated spqr stops further attempts at the top level spqr,
6386    which is not what is wanted - it may have generated other addresses.
6387
6388  . Check on the retry database to see if routing was previously deferred, but
6389    only if in a queue run. Addresses that are to be routed are put on the
6390    addr_route chain. Addresses that are to be deferred are put on the
6391    addr_defer chain. We do all the checking first, so as not to keep the
6392    retry database open any longer than necessary.
6393
6394  . Now we run the addresses through the routers. A router may put the address
6395    on either the addr_local or the addr_remote chain for local or remote
6396    delivery, respectively, or put it on the addr_failed chain if it is
6397    undeliveable, or it may generate child addresses and put them on the
6398    addr_new chain, or it may defer an address. All the chain anchors are
6399    passed as arguments so that the routers can be called for verification
6400    purposes as well.
6401
6402  . If new addresses have been generated by the routers, da capo.
6403 */
6404
6405 f.header_rewritten = FALSE;          /* No headers rewritten yet */
6406 while (addr_new)           /* Loop until all addresses dealt with */
6407   {
6408   address_item *addr, *parent;
6409
6410   /* Failure to open the retry database is treated the same as if it does
6411   not exist. In both cases, dbm_file is NULL. */
6412
6413   if (!(dbm_file = dbfn_open(US"retry", O_RDONLY, &dbblock, FALSE, TRUE)))
6414     DEBUG(D_deliver|D_retry|D_route|D_hints_lookup)
6415       debug_printf("no retry data available\n");
6416
6417   /* Scan the current batch of new addresses, to handle pipes, files and
6418   autoreplies, and determine which others are ready for routing. */
6419
6420   while (addr_new)
6421     {
6422     int rc;
6423     uschar *p;
6424     tree_node *tnode;
6425     dbdata_retry *domain_retry_record;
6426     dbdata_retry *address_retry_record;
6427
6428     addr = addr_new;
6429     addr_new = addr->next;
6430
6431     DEBUG(D_deliver|D_retry|D_route)
6432       {
6433       debug_printf(">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>\n");
6434       debug_printf("Considering: %s\n", addr->address);
6435       }
6436
6437     /* Handle generated address that is a pipe or a file or an autoreply. */
6438
6439     if (testflag(addr, af_pfr))
6440       {
6441       /* If an autoreply in a filter could not generate a syntactically valid
6442       address, give up forthwith. Set af_ignore_error so that we don't try to
6443       generate a bounce. */
6444
6445       if (testflag(addr, af_bad_reply))
6446         {
6447         addr->basic_errno = ERRNO_BADADDRESS2;
6448         addr->local_part = addr->address;
6449         addr->message =
6450           US"filter autoreply generated syntactically invalid recipient";
6451         addr->prop.ignore_error = TRUE;
6452         (void) post_process_one(addr, FAIL, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
6453         continue;   /* with the next new address */
6454         }
6455
6456       /* If two different users specify delivery to the same pipe or file or
6457       autoreply, there should be two different deliveries, so build a unique
6458       string that incorporates the original address, and use this for
6459       duplicate testing and recording delivery, and also for retrying. */
6460
6461       addr->unique =
6462         string_sprintf("%s:%s", addr->address, addr->parent->unique +
6463           (testflag(addr->parent, af_homonym)? 3:0));
6464
6465       addr->address_retry_key = addr->domain_retry_key =
6466         string_sprintf("T:%s", addr->unique);
6467
6468       /* If a filter file specifies two deliveries to the same pipe or file,
6469       we want to de-duplicate, but this is probably not wanted for two mail
6470       commands to the same address, where probably both should be delivered.
6471       So, we have to invent a different unique string in that case. Just
6472       keep piling '>' characters on the front. */
6473
6474       if (addr->address[0] == '>')
6475         while (tree_search(tree_duplicates, addr->unique))
6476           addr->unique = string_sprintf(">%s", addr->unique);
6477
6478       else if ((tnode = tree_search(tree_duplicates, addr->unique)))
6479         {
6480         DEBUG(D_deliver|D_route)
6481           debug_printf("%s is a duplicate address: discarded\n", addr->address);
6482         addr->dupof = tnode->data.ptr;
6483         addr->next = addr_duplicate;
6484         addr_duplicate = addr;
6485         continue;
6486         }
6487
6488       DEBUG(D_deliver|D_route) debug_printf("unique = %s\n", addr->unique);
6489
6490       /* Check for previous delivery */
6491
6492       if (tree_search(tree_nonrecipients, addr->unique))
6493         {
6494         DEBUG(D_deliver|D_route)
6495           debug_printf("%s was previously delivered: discarded\n", addr->address);
6496         child_done(addr, tod_stamp(tod_log));
6497         continue;
6498         }
6499
6500       /* Save for checking future duplicates */
6501
6502       tree_add_duplicate(addr->unique, addr);
6503
6504       /* Set local part and domain */
6505
6506       addr->local_part = addr->address;
6507       addr->domain = addr->parent->domain;
6508
6509       /* Ensure that the delivery is permitted. */
6510
6511       if (testflag(addr, af_file))
6512         {
6513         if (!testflag(addr, af_allow_file))
6514           {
6515           addr->basic_errno = ERRNO_FORBIDFILE;
6516           addr->message = US"delivery to file forbidden";
6517           (void)post_process_one(addr, FAIL, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
6518           continue;   /* with the next new address */
6519           }
6520         }
6521       else if (addr->address[0] == '|')
6522         {
6523         if (!testflag(addr, af_allow_pipe))
6524           {
6525           addr->basic_errno = ERRNO_FORBIDPIPE;
6526           addr->message = US"delivery to pipe forbidden";
6527           (void)post_process_one(addr, FAIL, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
6528           continue;   /* with the next new address */
6529           }
6530         }
6531       else if (!testflag(addr, af_allow_reply))
6532         {
6533         addr->basic_errno = ERRNO_FORBIDREPLY;
6534         addr->message = US"autoreply forbidden";
6535         (void)post_process_one(addr, FAIL, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
6536         continue;     /* with the next new address */
6537         }
6538
6539       /* If the errno field is already set to BADTRANSPORT, it indicates
6540       failure to expand a transport string, or find the associated transport,
6541       or an unset transport when one is required. Leave this test till now so
6542       that the forbid errors are given in preference. */
6543
6544       if (addr->basic_errno == ERRNO_BADTRANSPORT)
6545         {
6546         (void)post_process_one(addr, DEFER, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
6547         continue;
6548         }
6549
6550       /* Treat /dev/null as a special case and abandon the delivery. This
6551       avoids having to specify a uid on the transport just for this case.
6552       Arrange for the transport name to be logged as "**bypassed**".
6553       Copy the transport for this fairly unusual case rather than having
6554       to make all transports mutable. */
6555
6556       if (Ustrcmp(addr->address, "/dev/null") == 0)
6557         {
6558         transport_instance * save_t = addr->transport;
6559         transport_instance * t = store_get(sizeof(*t), is_tainted(save_t));
6560         *t = *save_t;
6561         t->name = US"**bypassed**";
6562         addr->transport = t;
6563         (void)post_process_one(addr, OK, LOG_MAIN, EXIM_DTYPE_TRANSPORT, '=');
6564         addr->transport= save_t;
6565         continue;   /* with the next new address */
6566         }
6567
6568       /* Pipe, file, or autoreply delivery is to go ahead as a normal local
6569       delivery. */
6570
6571       DEBUG(D_deliver|D_route)
6572         debug_printf("queued for %s transport\n", addr->transport->name);
6573       addr->next = addr_local;
6574       addr_local = addr;
6575       continue;       /* with the next new address */
6576       }
6577
6578     /* Handle normal addresses. First, split up into local part and domain,
6579     handling the %-hack if necessary. There is the possibility of a defer from
6580     a lookup in percent_hack_domains. */
6581
6582     if ((rc = deliver_split_address(addr)) == DEFER)
6583       {
6584       addr->message = US"cannot check percent_hack_domains";
6585       addr->basic_errno = ERRNO_LISTDEFER;
6586       (void)post_process_one(addr, DEFER, LOG_MAIN, EXIM_DTYPE_NONE, 0);
6587       continue;
6588       }
6589
6590     /* Check to see if the domain is held. If so, proceed only if the
6591     delivery was forced by hand. */
6592
6593     deliver_domain = addr->domain;  /* set $domain */
6594     if (  !forced && hold_domains
6595        && (rc = match_isinlist(addr->domain, (const uschar **)&hold_domains, 0,
6596            &domainlist_anchor, addr->domain_cache, MCL_DOMAIN, TRUE,
6597            NULL)) != FAIL
6598        )
6599       {
6600       if (rc == DEFER)
6601         {
6602         addr->message = US"hold_domains lookup deferred";
6603         addr->basic_errno = ERRNO_LISTDEFER;
6604         }
6605       else
6606         {
6607         addr->message = US"domain is held";
6608         addr->basic_errno = ERRNO_HELD;
6609         }
6610       (void)post_process_one(addr, DEFER, LOG_MAIN, EXIM_DTYPE_NONE, 0);
6611       continue;
6612       }
6613
6614     /* Now we can check for duplicates and previously delivered addresses. In
6615     order to do this, we have to generate a "unique" value for each address,
6616     because there may be identical actual addresses in a line of descendents.
6617     The "unique" field is initialized to the same value as the "address" field,
6618     but gets changed here to cope with identically-named descendents. */
6619
6620     for (parent = addr->parent; parent; parent = parent->parent)
6621       if (strcmpic(addr->address, parent->address) == 0) break;
6622
6623     /* If there's an ancestor with the same name, set the homonym flag. This
6624     influences how deliveries are recorded. Then add a prefix on the front of
6625     the unique address. We use \n\ where n starts at 0 and increases each time.
6626     It is unlikely to pass 9, but if it does, it may look odd but will still
6627     work. This means that siblings or cousins with the same names are treated
6628     as duplicates, which is what we want. */
6629
6630     if (parent)
6631       {
6632       setflag(addr, af_homonym);
6633       if (parent->unique[0] != '\\')
6634         addr->unique = string_sprintf("\\0\\%s", addr->address);
6635       else
6636         addr->unique = string_sprintf("\\%c\\%s", parent->unique[1] + 1,
6637           addr->address);
6638       }
6639
6640     /* Ensure that the domain in the unique field is lower cased, because
6641     domains are always handled caselessly. */
6642
6643     p = Ustrrchr(addr->unique, '@');
6644     while (*p != 0) { *p = tolower(*p); p++; }
6645
6646     DEBUG(D_deliver|D_route) debug_printf("unique = %s\n", addr->unique);
6647
6648     if (tree_search(tree_nonrecipients, addr->unique))
6649       {
6650       DEBUG(D_deliver|D_route)
6651         debug_printf("%s was previously delivered: discarded\n", addr->unique);
6652       child_done(addr, tod_stamp(tod_log));
6653       continue;
6654       }
6655
6656     /* Get the routing retry status, saving the two retry keys (with and
6657     without the local part) for subsequent use. If there is no retry record for
6658     the standard address routing retry key, we look for the same key with the
6659     sender attached, because this form is used by the smtp transport after a
6660     4xx response to RCPT when address_retry_include_sender is true. */
6661
6662     addr->domain_retry_key = string_sprintf("R:%s", addr->domain);
6663     addr->address_retry_key = string_sprintf("R:%s@%s", addr->local_part,
6664       addr->domain);
6665
6666     if (dbm_file)
6667       {
6668       domain_retry_record = dbfn_read(dbm_file, addr->domain_retry_key);
6669       if (  domain_retry_record
6670          && now - domain_retry_record->time_stamp > retry_data_expire
6671          )
6672         {
6673         DEBUG(D_deliver|D_retry)
6674           debug_printf("domain retry record present but expired\n");
6675         domain_retry_record = NULL;    /* Ignore if too old */
6676         }
6677
6678       address_retry_record = dbfn_read(dbm_file, addr->address_retry_key);
6679       if (  address_retry_record
6680          && now - address_retry_record->time_stamp > retry_data_expire
6681          )
6682         {
6683         DEBUG(D_deliver|D_retry)
6684           debug_printf("address retry record present but expired\n");
6685         address_retry_record = NULL;   /* Ignore if too old */
6686         }
6687
6688       if (!address_retry_record)
6689         {
6690         uschar *altkey = string_sprintf("%s:<%s>", addr->address_retry_key,
6691           sender_address);
6692         address_retry_record = dbfn_read(dbm_file, altkey);
6693         if (  address_retry_record
6694            && now - address_retry_record->time_stamp > retry_data_expire)
6695           {
6696           DEBUG(D_deliver|D_retry)
6697             debug_printf("address<sender> retry record present but expired\n");
6698           address_retry_record = NULL;   /* Ignore if too old */
6699           }
6700         }
6701       }
6702     else
6703       domain_retry_record = address_retry_record = NULL;
6704
6705     DEBUG(D_deliver|D_retry)
6706       {
6707       if (!domain_retry_record)
6708         debug_printf("no   domain  retry record\n");
6709       else
6710         debug_printf("have domain  retry record; next_try = now%+d\n",
6711                       f.running_in_test_harness ? 0 :
6712                       (int)(domain_retry_record->next_try - now));
6713
6714       if (!address_retry_record)
6715         debug_printf("no   address retry record\n");
6716       else
6717         debug_printf("have address retry record; next_try = now%+d\n",
6718                       f.running_in_test_harness ? 0 :
6719                       (int)(address_retry_record->next_try - now));
6720       }
6721
6722     /* If we are sending a message down an existing SMTP connection, we must
6723     assume that the message which created the connection managed to route
6724     an address to that connection. We do not want to run the risk of taking
6725     a long time over routing here, because if we do, the server at the other
6726     end of the connection may time it out. This is especially true for messages
6727     with lots of addresses. For this kind of delivery, queue_running is not
6728     set, so we would normally route all addresses. We take a pragmatic approach
6729     and defer routing any addresses that have any kind of domain retry record.
6730     That is, we don't even look at their retry times. It doesn't matter if this
6731     doesn't work occasionally. This is all just an optimization, after all.
6732
6733     The reason for not doing the same for address retries is that they normally
6734     arise from 4xx responses, not DNS timeouts. */
6735
6736     if (continue_hostname && domain_retry_record)
6737       {
6738       addr->message = US"reusing SMTP connection skips previous routing defer";
6739       addr->basic_errno = ERRNO_RRETRY;
6740       (void)post_process_one(addr, DEFER, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
6741
6742       addr->message = domain_retry_record->text;
6743       setflag(addr, af_pass_message);
6744       }
6745
6746     /* If we are in a queue run, defer routing unless there is no retry data or
6747     we've passed the next retry time, or this message is forced. In other
6748     words, ignore retry data when not in a queue run.
6749
6750     However, if the domain retry time has expired, always allow the routing
6751     attempt. If it fails again, the address will be failed. This ensures that
6752     each address is routed at least once, even after long-term routing
6753     failures.
6754
6755     If there is an address retry, check that too; just wait for the next
6756     retry time. This helps with the case when the temporary error on the
6757     address was really message-specific rather than address specific, since
6758     it allows other messages through.
6759
6760     We also wait for the next retry time if this is a message sent down an
6761     existing SMTP connection (even though that will be forced). Otherwise there
6762     will be far too many attempts for an address that gets a 4xx error. In
6763     fact, after such an error, we should not get here because, the host should
6764     not be remembered as one this message needs. However, there was a bug that
6765     used to cause this to  happen, so it is best to be on the safe side.
6766
6767     Even if we haven't reached the retry time in the hints, there is one more
6768     check to do, which is for the ultimate address timeout. We only do this
6769     check if there is an address retry record and there is not a domain retry
6770     record; this implies that previous attempts to handle the address had the
6771     retry_use_local_parts option turned on. We use this as an approximation
6772     for the destination being like a local delivery, for example delivery over
6773     LMTP to an IMAP message store. In this situation users are liable to bump
6774     into their quota and thereby have intermittently successful deliveries,
6775     which keep the retry record fresh, which can lead to us perpetually
6776     deferring messages. */
6777
6778     else if (  (  f.queue_running && !f.deliver_force
6779                || continue_hostname
6780                )
6781             && (  (  domain_retry_record
6782                   && now < domain_retry_record->next_try
6783                   && !domain_retry_record->expired
6784                   )
6785                || (  address_retry_record
6786                   && now < address_retry_record->next_try
6787                )  )
6788             && (  domain_retry_record
6789                || !address_retry_record
6790                || !retry_ultimate_address_timeout(addr->address_retry_key,
6791                                  addr->domain, address_retry_record, now)
6792             )  )
6793       {
6794       addr->message = US"retry time not reached";
6795       addr->basic_errno = ERRNO_RRETRY;
6796       (void)post_process_one(addr, DEFER, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
6797
6798       /* For remote-retry errors (here and just above) that we've not yet
6799       hit the retry time, use the error recorded in the retry database
6800       as info in the warning message.  This lets us send a message even
6801       when we're not failing on a fresh attempt.  We assume that this
6802       info is not sensitive. */
6803
6804       addr->message = domain_retry_record
6805         ? domain_retry_record->text : address_retry_record->text;
6806       setflag(addr, af_pass_message);
6807       }
6808
6809     /* The domain is OK for routing. Remember if retry data exists so it
6810     can be cleaned up after a successful delivery. */
6811
6812     else
6813       {
6814       if (domain_retry_record || address_retry_record)
6815         setflag(addr, af_dr_retry_exists);
6816       addr->next = addr_route;
6817       addr_route = addr;
6818       DEBUG(D_deliver|D_route)
6819         debug_printf("%s: queued for routing\n", addr->address);
6820       }
6821     }
6822
6823   /* The database is closed while routing is actually happening. Requests to
6824   update it are put on a chain and all processed together at the end. */
6825
6826   if (dbm_file) dbfn_close(dbm_file);
6827
6828   /* If queue_domains is set, we don't even want to try routing addresses in
6829   those domains. During queue runs, queue_domains is forced to be unset.
6830   Optimize by skipping this pass through the addresses if nothing is set. */
6831
6832   if (!f.deliver_force && queue_domains)
6833     {
6834     address_item *okaddr = NULL;
6835     while (addr_route)
6836       {
6837       address_item *addr = addr_route;
6838       addr_route = addr->next;
6839
6840       deliver_domain = addr->domain;  /* set $domain */
6841       if ((rc = match_isinlist(addr->domain, CUSS &queue_domains, 0,
6842             &domainlist_anchor, addr->domain_cache, MCL_DOMAIN, TRUE, NULL))
6843               != OK)
6844         if (rc == DEFER)
6845           {
6846           addr->basic_errno = ERRNO_LISTDEFER;
6847           addr->message = US"queue_domains lookup deferred";
6848           (void)post_process_one(addr, DEFER, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
6849           }
6850         else
6851           {
6852           addr->next = okaddr;
6853           okaddr = addr;
6854           }
6855       else
6856         {
6857         addr->basic_errno = ERRNO_QUEUE_DOMAIN;
6858         addr->message = US"domain is in queue_domains";
6859         (void)post_process_one(addr, DEFER, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
6860         }
6861       }
6862
6863     addr_route = okaddr;
6864     }
6865
6866   /* Now route those addresses that are not deferred. */
6867
6868   while (addr_route)
6869     {
6870     int rc;
6871     address_item *addr = addr_route;
6872     const uschar *old_domain = addr->domain;
6873     uschar *old_unique = addr->unique;
6874     addr_route = addr->next;
6875     addr->next = NULL;
6876
6877     /* Just in case some router parameter refers to it. */
6878
6879     if (!(return_path = addr->prop.errors_address))
6880       return_path = sender_address;
6881
6882     /* If a router defers an address, add a retry item. Whether or not to
6883     use the local part in the key is a property of the router. */
6884
6885     if ((rc = route_address(addr, &addr_local, &addr_remote, &addr_new,
6886          &addr_succeed, v_none)) == DEFER)
6887       retry_add_item(addr,
6888         addr->router->retry_use_local_part
6889           ? string_sprintf("R:%s@%s", addr->local_part, addr->domain)
6890           : string_sprintf("R:%s", addr->domain),
6891         0);
6892
6893     /* Otherwise, if there is an existing retry record in the database, add
6894     retry items to delete both forms. We must also allow for the possibility
6895     of a routing retry that includes the sender address. Since the domain might
6896     have been rewritten (expanded to fully qualified) as a result of routing,
6897     ensure that the rewritten form is also deleted. */
6898
6899     else if (testflag(addr, af_dr_retry_exists))
6900       {
6901       uschar *altkey = string_sprintf("%s:<%s>", addr->address_retry_key,
6902         sender_address);
6903       retry_add_item(addr, altkey, rf_delete);
6904       retry_add_item(addr, addr->address_retry_key, rf_delete);
6905       retry_add_item(addr, addr->domain_retry_key, rf_delete);
6906       if (Ustrcmp(addr->domain, old_domain) != 0)
6907         retry_add_item(addr, string_sprintf("R:%s", old_domain), rf_delete);
6908       }
6909
6910     /* DISCARD is given for :blackhole: and "seen finish". The event has been
6911     logged, but we need to ensure the address (and maybe parents) is marked
6912     done. */
6913
6914     if (rc == DISCARD)
6915       {
6916       address_done(addr, tod_stamp(tod_log));
6917       continue;  /* route next address */
6918       }
6919
6920     /* The address is finished with (failed or deferred). */
6921
6922     if (rc != OK)
6923       {
6924       (void)post_process_one(addr, rc, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
6925       continue;  /* route next address */
6926       }
6927
6928     /* The address has been routed. If the router changed the domain, it will
6929     also have changed the unique address. We have to test whether this address
6930     has already been delivered, because it's the unique address that finally
6931     gets recorded. */
6932
6933     if (  addr->unique != old_unique
6934        && tree_search(tree_nonrecipients, addr->unique) != 0
6935        )
6936       {
6937       DEBUG(D_deliver|D_route) debug_printf("%s was previously delivered: "
6938         "discarded\n", addr->address);
6939       if (addr_remote == addr) addr_remote = addr->next;
6940       else if (addr_local == addr) addr_local = addr->next;
6941       }
6942
6943     /* If the router has same_domain_copy_routing set, we are permitted to copy
6944     the routing for any other addresses with the same domain. This is an
6945     optimisation to save repeated DNS lookups for "standard" remote domain
6946     routing. The option is settable only on routers that generate host lists.
6947     We play it very safe, and do the optimization only if the address is routed
6948     to a remote transport, there are no header changes, and the domain was not
6949     modified by the router. */
6950
6951     if (  addr_remote == addr
6952        && addr->router->same_domain_copy_routing
6953        && !addr->prop.extra_headers
6954        && !addr->prop.remove_headers
6955        && old_domain == addr->domain
6956        )
6957       {
6958       address_item **chain = &addr_route;
6959       while (*chain)
6960         {
6961         address_item *addr2 = *chain;
6962         if (Ustrcmp(addr2->domain, addr->domain) != 0)
6963           {
6964           chain = &(addr2->next);
6965           continue;
6966           }
6967
6968         /* Found a suitable address; take it off the routing list and add it to
6969         the remote delivery list. */
6970
6971         *chain = addr2->next;
6972         addr2->next = addr_remote;
6973         addr_remote = addr2;
6974
6975         /* Copy the routing data */
6976
6977         addr2->domain = addr->domain;
6978         addr2->router = addr->router;
6979         addr2->transport = addr->transport;
6980         addr2->host_list = addr->host_list;
6981         addr2->fallback_hosts = addr->fallback_hosts;
6982         addr2->prop.errors_address = addr->prop.errors_address;
6983         copyflag(addr2, addr, af_hide_child);
6984         copyflag(addr2, addr, af_local_host_removed);
6985
6986         DEBUG(D_deliver|D_route)
6987           debug_printf(">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>\n"
6988                        "routing %s\n"
6989                        "Routing for %s copied from %s\n",
6990             addr2->address, addr2->address, addr->address);
6991         }
6992       }
6993     }  /* Continue with routing the next address. */
6994   }    /* Loop to process any child addresses that the routers created, and
6995           any rerouted addresses that got put back on the new chain. */
6996
6997
6998 /* Debugging: show the results of the routing */
6999
7000 DEBUG(D_deliver|D_retry|D_route)
7001   {
7002   debug_printf(">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>\n");
7003   debug_printf("After routing:\n  Local deliveries:\n");
7004   for (address_item * p = addr_local; p; p = p->next)
7005     debug_printf("    %s\n", p->address);
7006
7007   debug_printf("  Remote deliveries:\n");
7008   for (address_item * p = addr_remote; p; p = p->next)
7009     debug_printf("    %s\n", p->address);
7010
7011   debug_printf("  Failed addresses:\n");
7012   for (address_item * p = addr_failed; p; p = p->next)
7013     debug_printf("    %s\n", p->address);
7014
7015   debug_printf("  Deferred addresses:\n");
7016   for (address_item * p = addr_defer; p; p = p->next)
7017     debug_printf("    %s\n", p->address);
7018   }
7019
7020 /* Free any resources that were cached during routing. */
7021
7022 search_tidyup();
7023 route_tidyup();
7024
7025 /* These two variables are set only during routing, after check_local_user.
7026 Ensure they are not set in transports. */
7027
7028 local_user_gid = (gid_t)(-1);
7029 local_user_uid = (uid_t)(-1);
7030
7031 /* Check for any duplicate addresses. This check is delayed until after
7032 routing, because the flexibility of the routing configuration means that
7033 identical addresses with different parentage may end up being redirected to
7034 different addresses. Checking for duplicates too early (as we previously used
7035 to) makes this kind of thing not work. */
7036
7037 do_duplicate_check(&addr_local);
7038 do_duplicate_check(&addr_remote);
7039
7040 /* When acting as an MUA wrapper, we proceed only if all addresses route to a
7041 remote transport. The check that they all end up in one transaction happens in
7042 the do_remote_deliveries() function. */
7043
7044 if (  mua_wrapper
7045    && (addr_local || addr_failed || addr_defer)
7046    )
7047   {
7048   address_item *addr;
7049   uschar *which, *colon, *msg;
7050
7051   if (addr_local)
7052     {
7053     addr = addr_local;
7054     which = US"local";
7055     }
7056   else if (addr_defer)
7057     {
7058     addr = addr_defer;
7059     which = US"deferred";
7060     }
7061   else
7062     {
7063     addr = addr_failed;
7064     which = US"failed";
7065     }
7066
7067   while (addr->parent) addr = addr->parent;
7068
7069   if (addr->message)
7070     {
7071     colon = US": ";
7072     msg = addr->message;
7073     }
7074   else colon = msg = US"";
7075
7076   /* We don't need to log here for a forced failure as it will already
7077   have been logged. Defer will also have been logged, but as a defer, so we do
7078   need to do the failure logging. */
7079
7080   if (addr != addr_failed)
7081     log_write(0, LOG_MAIN, "** %s routing yielded a %s delivery",
7082       addr->address, which);
7083
7084   /* Always write an error to the caller */
7085
7086   fprintf(stderr, "routing %s yielded a %s delivery%s%s\n", addr->address,
7087     which, colon, msg);
7088
7089   final_yield = DELIVER_MUA_FAILED;
7090   addr_failed = addr_defer = NULL;   /* So that we remove the message */
7091   goto DELIVERY_TIDYUP;
7092   }
7093
7094
7095 /* If this is a run to continue deliveries to an external channel that is
7096 already set up, defer any local deliveries.
7097
7098 jgh 2020/12/20: I don't see why; locals should be quick.
7099 The defer goes back to version 1.62 in 1997.  A local being still deliverable
7100 during a continued run might result from something like a defer during the
7101 original delivery, eg. in a DB lookup.  Unlikely but possible.
7102
7103 To avoid delaying a local when combined with a callout-hold for a remote
7104 delivery, test continue_sequence rather than continue_transport. */
7105
7106 if (continue_sequence > 1 && addr_local)
7107   {
7108   DEBUG(D_deliver|D_retry|D_route)
7109     debug_printf("deferring local deliveries due to continued-transport\n");
7110   if (addr_defer)
7111     {
7112     address_item * addr = addr_defer;
7113     while (addr->next) addr = addr->next;
7114     addr->next = addr_local;
7115     }
7116   else
7117     addr_defer = addr_local;
7118   addr_local = NULL;
7119   }
7120
7121
7122 /* Because address rewriting can happen in the routers, we should not really do
7123 ANY deliveries until all addresses have been routed, so that all recipients of
7124 the message get the same headers. However, this is in practice not always
7125 possible, since sometimes remote addresses give DNS timeouts for days on end.
7126 The pragmatic approach is to deliver what we can now, saving any rewritten
7127 headers so that at least the next lot of recipients benefit from the rewriting
7128 that has already been done.
7129
7130 If any headers have been rewritten during routing, update the spool file to
7131 remember them for all subsequent deliveries. This can be delayed till later if
7132 there is only address to be delivered - if it succeeds the spool write need not
7133 happen. */
7134
7135 if (  f.header_rewritten
7136    && (  addr_local && (addr_local->next || addr_remote)
7137       || addr_remote && addr_remote->next
7138    )  )
7139   {
7140   /* Panic-dies on error */
7141   (void)spool_write_header(message_id, SW_DELIVERING, NULL);
7142   f.header_rewritten = FALSE;
7143   }
7144
7145
7146 /* If there are any deliveries to do and we do not already have the journal
7147 file, create it. This is used to record successful deliveries as soon as
7148 possible after each delivery is known to be complete. A file opened with
7149 O_APPEND is used so that several processes can run simultaneously.
7150
7151 The journal is just insurance against crashes. When the spool file is
7152 ultimately updated at the end of processing, the journal is deleted. If a
7153 journal is found to exist at the start of delivery, the addresses listed
7154 therein are added to the non-recipients. */
7155
7156 if (addr_local || addr_remote)
7157   {
7158   if (journal_fd < 0)
7159     {
7160     uschar * fname = spool_fname(US"input", message_subdir, id, US"-J");
7161
7162     if ((journal_fd = Uopen(fname,
7163 #ifdef O_CLOEXEC
7164                         O_CLOEXEC |
7165 #endif
7166                         O_WRONLY|O_APPEND|O_CREAT|O_EXCL, SPOOL_MODE)) < 0)
7167       {
7168       log_write(0, LOG_MAIN|LOG_PANIC, "Couldn't open journal file %s: %s",
7169         fname, strerror(errno));
7170       return DELIVER_NOT_ATTEMPTED;
7171       }
7172
7173     /* Set the close-on-exec flag, make the file owned by Exim, and ensure
7174     that the mode is correct - the group setting doesn't always seem to get
7175     set automatically. */
7176
7177     if(  exim_fchown(journal_fd, exim_uid, exim_gid, fname)
7178       || fchmod(journal_fd, SPOOL_MODE)
7179 #ifndef O_CLOEXEC
7180       || fcntl(journal_fd, F_SETFD, fcntl(journal_fd, F_GETFD) | FD_CLOEXEC)
7181 #endif
7182       )
7183       {
7184       int ret = Uunlink(fname);
7185       log_write(0, LOG_MAIN|LOG_PANIC, "Couldn't set perms on journal file %s: %s",
7186         fname, strerror(errno));
7187       if(ret  &&  errno != ENOENT)
7188         log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s",
7189           fname, strerror(errno));
7190       return DELIVER_NOT_ATTEMPTED;
7191       }
7192     }
7193   }
7194 else if (journal_fd >= 0)
7195   {
7196   close(journal_fd);
7197   journal_fd = -1;
7198   }
7199
7200
7201
7202 /* Now we can get down to the business of actually doing deliveries. Local
7203 deliveries are done first, then remote ones. If ever the problems of how to
7204 handle fallback transports are figured out, this section can be put into a loop
7205 for handling fallbacks, though the uid switching will have to be revised. */
7206
7207 /* Precompile a regex that is used to recognize a parameter in response
7208 to an LHLO command, if is isn't already compiled. This may be used on both
7209 local and remote LMTP deliveries. */
7210
7211 if (!regex_IGNOREQUOTA)
7212   regex_IGNOREQUOTA =
7213     regex_must_compile(US"\\n250[\\s\\-]IGNOREQUOTA(\\s|\\n|$)", FALSE, TRUE);
7214
7215 /* Handle local deliveries */
7216
7217 if (addr_local)
7218   {
7219   DEBUG(D_deliver|D_transport)
7220     debug_printf(">>>>>>>>>>>>>>>> Local deliveries >>>>>>>>>>>>>>>>\n");
7221   do_local_deliveries();
7222   f.disable_logging = FALSE;
7223   }
7224
7225 /* If queue_run_local is set, we do not want to attempt any remote deliveries,
7226 so just queue them all. */
7227
7228 if (f.queue_run_local)
7229   while (addr_remote)
7230     {
7231     address_item *addr = addr_remote;
7232     addr_remote = addr->next;
7233     addr->next = NULL;
7234     addr->basic_errno = ERRNO_LOCAL_ONLY;
7235     addr->message = US"remote deliveries suppressed";
7236     (void)post_process_one(addr, DEFER, LOG_MAIN, EXIM_DTYPE_TRANSPORT, 0);
7237     }
7238
7239 /* Handle remote deliveries */
7240
7241 if (addr_remote)
7242   {
7243   DEBUG(D_deliver|D_transport)
7244     debug_printf(">>>>>>>>>>>>>>>> Remote deliveries >>>>>>>>>>>>>>>>\n");
7245
7246   /* Precompile some regex that are used to recognize parameters in response
7247   to an EHLO command, if they aren't already compiled. */
7248
7249   smtp_deliver_init();
7250
7251   /* Now sort the addresses if required, and do the deliveries. The yield of
7252   do_remote_deliveries is FALSE when mua_wrapper is set and all addresses
7253   cannot be delivered in one transaction. */
7254
7255   if (remote_sort_domains) sort_remote_deliveries();
7256   if (!do_remote_deliveries(FALSE))
7257     {
7258     log_write(0, LOG_MAIN, "** mua_wrapper is set but recipients cannot all "
7259       "be delivered in one transaction");
7260     fprintf(stderr, "delivery to smarthost failed (configuration problem)\n");
7261
7262     final_yield = DELIVER_MUA_FAILED;
7263     addr_failed = addr_defer = NULL;   /* So that we remove the message */
7264     goto DELIVERY_TIDYUP;
7265     }
7266
7267   /* See if any of the addresses that failed got put on the queue for delivery
7268   to their fallback hosts. We do it this way because often the same fallback
7269   host is used for many domains, so all can be sent in a single transaction
7270   (if appropriately configured). */
7271
7272   if (addr_fallback && !mua_wrapper)
7273     {
7274     DEBUG(D_deliver) debug_printf("Delivering to fallback hosts\n");
7275     addr_remote = addr_fallback;
7276     addr_fallback = NULL;
7277     if (remote_sort_domains) sort_remote_deliveries();
7278     do_remote_deliveries(TRUE);
7279     }
7280   f.disable_logging = FALSE;
7281   }
7282
7283
7284 /* All deliveries are now complete. Ignore SIGTERM during this tidying up
7285 phase, to minimize cases of half-done things. */
7286
7287 DEBUG(D_deliver)
7288   debug_printf(">>>>>>>>>>>>>>>> deliveries are done >>>>>>>>>>>>>>>>\n");
7289 cancel_cutthrough_connection(TRUE, US"deliveries are done");
7290
7291 /* Root privilege is no longer needed */
7292
7293 exim_setugid(exim_uid, exim_gid, FALSE, US"post-delivery tidying");
7294
7295 set_process_info("tidying up after delivering %s", message_id);
7296 signal(SIGTERM, SIG_IGN);
7297
7298 /* When we are acting as an MUA wrapper, the smtp transport will either have
7299 succeeded for all addresses, or failed them all in normal cases. However, there
7300 are some setup situations (e.g. when a named port does not exist) that cause an
7301 immediate exit with deferral of all addresses. Convert those into failures. We
7302 do not ever want to retry, nor do we want to send a bounce message. */
7303
7304 if (mua_wrapper)
7305   {
7306   if (addr_defer)
7307     {
7308     address_item * nextaddr;
7309     for (address_item * addr = addr_defer; addr; addr = nextaddr)
7310       {
7311       log_write(0, LOG_MAIN, "** %s mua_wrapper forced failure for deferred "
7312         "delivery", addr->address);
7313       nextaddr = addr->next;
7314       addr->next = addr_failed;
7315       addr_failed = addr;
7316       }
7317     addr_defer = NULL;
7318     }
7319
7320   /* Now all should either have succeeded or failed. */
7321
7322   if (!addr_failed)
7323     final_yield = DELIVER_MUA_SUCCEEDED;
7324   else
7325     {
7326     host_item * host;
7327     uschar *s = addr_failed->user_message;
7328
7329     if (!s) s = addr_failed->message;
7330
7331     fprintf(stderr, "Delivery failed: ");
7332     if (addr_failed->basic_errno > 0)
7333       {
7334       fprintf(stderr, "%s", strerror(addr_failed->basic_errno));
7335       if (s) fprintf(stderr, ": ");
7336       }
7337     if ((host = addr_failed->host_used))
7338       fprintf(stderr, "H=%s [%s]: ", host->name, host->address);
7339     if (s)
7340       fprintf(stderr, "%s", CS s);
7341     else if (addr_failed->basic_errno <= 0)
7342       fprintf(stderr, "unknown error");
7343     fprintf(stderr, "\n");
7344
7345     final_yield = DELIVER_MUA_FAILED;
7346     addr_failed = NULL;
7347     }
7348   }
7349
7350 /* In a normal configuration, we now update the retry database. This is done in
7351 one fell swoop at the end in order not to keep opening and closing (and
7352 locking) the database. The code for handling retries is hived off into a
7353 separate module for convenience. We pass it the addresses of the various
7354 chains, because deferred addresses can get moved onto the failed chain if the
7355 retry cutoff time has expired for all alternative destinations. Bypass the
7356 updating of the database if the -N flag is set, which is a debugging thing that
7357 prevents actual delivery. */
7358
7359 else if (!f.dont_deliver)
7360   retry_update(&addr_defer, &addr_failed, &addr_succeed);
7361
7362 /* Send DSN for successful messages if requested */
7363 addr_senddsn = NULL;
7364
7365 for (address_item * a = addr_succeed; a; a = a->next)
7366   {
7367   /* af_ignore_error not honored here. it's not an error */
7368   DEBUG(D_deliver) debug_printf("DSN: processing router : %s\n"
7369       "DSN: processing successful delivery address: %s\n"
7370       "DSN: Sender_address: %s\n"
7371       "DSN: orcpt: %s  flags: 0x%x\n"
7372       "DSN: envid: %s  ret: %d\n"
7373       "DSN: Final recipient: %s\n"
7374       "DSN: Remote SMTP server supports DSN: %d\n",
7375       a->router ? a->router->name : US"(unknown)",
7376       a->address,
7377       sender_address,
7378       a->dsn_orcpt ? a->dsn_orcpt : US"NULL",
7379       a->dsn_flags,
7380       dsn_envid ? dsn_envid : US"NULL", dsn_ret,
7381       a->address,
7382       a->dsn_aware
7383       );
7384
7385   /* send report if next hop not DSN aware or a router flagged "last DSN hop"
7386   and a report was requested */
7387
7388   if (  (a->dsn_aware != dsn_support_yes || a->dsn_flags & rf_dsnlasthop)
7389      && a->dsn_flags & rf_notify_success
7390      )
7391     {
7392     /* copy and relink address_item and send report with all of them at once later */
7393     address_item * addr_next = addr_senddsn;
7394     addr_senddsn = store_get(sizeof(address_item), FALSE);
7395     *addr_senddsn = *a;
7396     addr_senddsn->next = addr_next;
7397     }
7398   else
7399     DEBUG(D_deliver) debug_printf("DSN: not sending DSN success message\n");
7400   }
7401
7402 if (addr_senddsn)
7403   {
7404   pid_t pid;
7405   int fd;
7406
7407   /* create exim process to send message */
7408   pid = child_open_exim(&fd, US"DSN");
7409
7410   DEBUG(D_deliver) debug_printf("DSN: child_open_exim returns: %d\n", pid);
7411
7412   if (pid < 0)  /* Creation of child failed */
7413     {
7414     log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Process %d (parent %d) failed to "
7415       "create child process to send success-dsn message: %s", getpid(),
7416       getppid(), strerror(errno));
7417
7418     DEBUG(D_deliver) debug_printf("DSN: child_open_exim failed\n");
7419     }
7420   else  /* Creation of child succeeded */
7421     {
7422     FILE * f = fdopen(fd, "wb");
7423     /* header only as required by RFC. only failure DSN needs to honor RET=FULL */
7424     uschar * bound;
7425     transport_ctx tctx = {{0}};
7426
7427     DEBUG(D_deliver)
7428       debug_printf("sending success-dsn to: %s\n", sender_address);
7429
7430     /* build unique id for MIME boundary */
7431     bound = string_sprintf(TIME_T_FMT "-eximdsn-%d", time(NULL), rand());
7432     DEBUG(D_deliver) debug_printf("DSN: MIME boundary: %s\n", bound);
7433
7434     if (errors_reply_to)
7435       fprintf(f, "Reply-To: %s\n", errors_reply_to);
7436
7437     moan_write_from(f);
7438     fprintf(f, "Auto-Submitted: auto-generated\n"
7439         "To: %s\n"
7440         "Subject: Delivery Status Notification\n",
7441       sender_address);
7442     moan_write_references(f, NULL);
7443     fprintf(f, "Content-Type: multipart/report;"
7444                 " report-type=delivery-status; boundary=%s\n"
7445         "MIME-Version: 1.0\n\n"
7446
7447         "--%s\n"
7448         "Content-type: text/plain; charset=us-ascii\n\n"
7449
7450         "This message was created automatically by mail delivery software.\n"
7451         " ----- The following addresses had successful delivery notifications -----\n",
7452       bound, bound);
7453
7454     for (address_item * a = addr_senddsn; a; a = a->next)
7455       fprintf(f, "<%s> (relayed %s)\n\n",
7456         a->address,
7457         a->dsn_flags & rf_dsnlasthop ? "via non DSN router"
7458         : a->dsn_aware == dsn_support_no ? "to non-DSN-aware mailer"
7459         : "via non \"Remote SMTP\" router"
7460         );
7461
7462     fprintf(f, "--%s\n"
7463         "Content-type: message/delivery-status\n\n"
7464         "Reporting-MTA: dns; %s\n",
7465       bound, smtp_active_hostname);
7466
7467     if (dsn_envid)
7468       {                 /* must be decoded from xtext: see RFC 3461:6.3a */
7469       uschar *xdec_envid;
7470       if (auth_xtextdecode(dsn_envid, &xdec_envid) > 0)
7471         fprintf(f, "Original-Envelope-ID: %s\n", dsn_envid);
7472       else
7473         fprintf(f, "X-Original-Envelope-ID: error decoding xtext formatted ENVID\n");
7474       }
7475     fputc('\n', f);
7476
7477     for (address_item * a = addr_senddsn; a; a = a->next)
7478       {
7479       host_item * hu;
7480
7481       print_dsn_addr_action(f, a, US"delivered", US"2.0.0");
7482
7483       if ((hu = a->host_used) && hu->name)
7484         fprintf(f, "Remote-MTA: dns; %s\nDiagnostic-Code: smtp; 250 Ok\n\n",
7485           hu->name);
7486       else
7487         fprintf(f, "Diagnostic-Code: X-Exim; relayed via non %s router\n\n",
7488           a->dsn_flags & rf_dsnlasthop ? "DSN" : "SMTP");
7489       }
7490
7491     fprintf(f, "--%s\nContent-type: text/rfc822-headers\n\n", bound);
7492
7493     fflush(f);
7494     transport_filter_argv = NULL;   /* Just in case */
7495     return_path = sender_address;   /* In case not previously set */
7496
7497     /* Write the original email out */
7498
7499     tctx.u.fd = fd;
7500     tctx.options = topt_add_return_path | topt_no_body;
7501     /*XXX hmm, FALSE(fail) retval ignored.
7502     Could error for any number of reasons, and they are not handled. */
7503     transport_write_message(&tctx, 0);
7504     fflush(f);
7505
7506     fprintf(f,"\n--%s--\n", bound);
7507
7508     fflush(f);
7509     fclose(f);
7510     rc = child_close(pid, 0);     /* Waits for child to close, no timeout */
7511     }
7512   }
7513
7514 /* If any addresses failed, we must send a message to somebody, unless
7515 af_ignore_error is set, in which case no action is taken. It is possible for
7516 several messages to get sent if there are addresses with different
7517 requirements. */
7518
7519 while (addr_failed)
7520   {
7521   pid_t pid;
7522   int fd;
7523   uschar *logtod = tod_stamp(tod_log);
7524   address_item *addr;
7525   address_item *handled_addr = NULL;
7526   address_item **paddr;
7527   address_item *msgchain = NULL;
7528   address_item **pmsgchain = &msgchain;
7529
7530   /* There are weird cases when logging is disabled in the transport. However,
7531   there may not be a transport (address failed by a router). */
7532
7533   f.disable_logging = FALSE;
7534   if (addr_failed->transport)
7535     f.disable_logging = addr_failed->transport->disable_logging;
7536
7537   DEBUG(D_deliver)
7538     debug_printf("processing failed address %s\n", addr_failed->address);
7539
7540   /* There are only two ways an address in a bounce message can get here:
7541
7542   (1) When delivery was initially deferred, but has now timed out (in the call
7543       to retry_update() above). We can detect this by testing for
7544       af_retry_timedout. If the address does not have its own errors address,
7545       we arrange to ignore the error.
7546
7547   (2) If delivery failures for bounce messages are being ignored. We can detect
7548       this by testing for af_ignore_error. This will also be set if a bounce
7549       message has been autothawed and the ignore_bounce_errors_after time has
7550       passed. It might also be set if a router was explicitly configured to
7551       ignore errors (errors_to = "").
7552
7553   If neither of these cases obtains, something has gone wrong. Log the
7554   incident, but then ignore the error. */
7555
7556   if (sender_address[0] == 0 && !addr_failed->prop.errors_address)
7557     {
7558     if (  !testflag(addr_failed, af_retry_timedout)
7559        && !addr_failed->prop.ignore_error)
7560       log_write(0, LOG_MAIN|LOG_PANIC, "internal error: bounce message "
7561         "failure is neither frozen nor ignored (it's been ignored)");
7562
7563     addr_failed->prop.ignore_error = TRUE;
7564     }
7565
7566   /* If the first address on the list has af_ignore_error set, just remove
7567   it from the list, throw away any saved message file, log it, and
7568   mark the recipient done. */
7569
7570   if (  addr_failed->prop.ignore_error
7571      ||    addr_failed->dsn_flags & rf_dsnflags
7572         && !(addr_failed->dsn_flags & rf_notify_failure)
7573      )
7574     {
7575     addr = addr_failed;
7576     addr_failed = addr->next;
7577     if (addr->return_filename) Uunlink(addr->return_filename);
7578
7579 #ifndef DISABLE_EVENT
7580     msg_event_raise(US"msg:fail:delivery", addr);
7581 #endif
7582     log_write(0, LOG_MAIN, "%s%s%s%s: error ignored%s",
7583       addr->address,
7584       !addr->parent ? US"" : US" <",
7585       !addr->parent ? US"" : addr->parent->address,
7586       !addr->parent ? US"" : US">",
7587       addr->prop.ignore_error
7588       ? US"" : US": RFC 3461 DSN, failure notify not requested");
7589
7590     address_done(addr, logtod);
7591     child_done(addr, logtod);
7592     /* Panic-dies on error */
7593     (void)spool_write_header(message_id, SW_DELIVERING, NULL);
7594     }
7595
7596   /* Otherwise, handle the sending of a message. Find the error address for
7597   the first address, then send a message that includes all failed addresses
7598   that have the same error address. Note the bounce_recipient is a global so
7599   that it can be accessed by $bounce_recipient while creating a customized
7600   error message. */
7601
7602   else
7603     {
7604     if (!(bounce_recipient = addr_failed->prop.errors_address))
7605       bounce_recipient = sender_address;
7606
7607     /* Make a subprocess to send a message */
7608
7609     if ((pid = child_open_exim(&fd, US"bounce-message")) < 0)
7610       log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Process %d (parent %d) failed to "
7611         "create child process to send failure message: %s", getpid(),
7612         getppid(), strerror(errno));
7613
7614     /* Creation of child succeeded */
7615
7616     else
7617       {
7618       int ch, rc;
7619       int filecount = 0;
7620       int rcount = 0;
7621       uschar *bcc, *emf_text;
7622       FILE * fp = fdopen(fd, "wb");
7623       FILE * emf = NULL;
7624       BOOL to_sender = strcmpic(sender_address, bounce_recipient) == 0;
7625       int max = (bounce_return_size_limit/DELIVER_IN_BUFFER_SIZE + 1) *
7626         DELIVER_IN_BUFFER_SIZE;
7627       uschar * bound;
7628       uschar *dsnlimitmsg;
7629       uschar *dsnnotifyhdr;
7630       int topt;
7631
7632       DEBUG(D_deliver)
7633         debug_printf("sending error message to: %s\n", bounce_recipient);
7634
7635       /* Scan the addresses for all that have the same errors address, removing
7636       them from the addr_failed chain, and putting them on msgchain. */
7637
7638       paddr = &addr_failed;
7639       for (addr = addr_failed; addr; addr = *paddr)
7640         if (Ustrcmp(bounce_recipient, addr->prop.errors_address
7641               ? addr->prop.errors_address : sender_address) == 0)
7642           {                          /* The same - dechain */
7643           *paddr = addr->next;
7644           *pmsgchain = addr;
7645           addr->next = NULL;
7646           pmsgchain = &(addr->next);
7647           }
7648         else
7649           paddr = &addr->next;        /* Not the same; skip */
7650
7651       /* Include X-Failed-Recipients: for automatic interpretation, but do
7652       not let any one header line get too long. We do this by starting a
7653       new header every 50 recipients. Omit any addresses for which the
7654       "hide_child" flag is set. */
7655
7656       for (addr = msgchain; addr; addr = addr->next)
7657         {
7658         if (testflag(addr, af_hide_child)) continue;
7659         if (rcount >= 50)
7660           {
7661           fprintf(fp, "\n");
7662           rcount = 0;
7663           }
7664         fprintf(fp, "%s%s",
7665           rcount++ == 0
7666           ? "X-Failed-Recipients: "
7667           : ",\n  ",
7668           testflag(addr, af_pfr) && addr->parent
7669           ? string_printing(addr->parent->address)
7670           : string_printing(addr->address));
7671         }
7672       if (rcount > 0) fprintf(fp, "\n");
7673
7674       /* Output the standard headers */
7675
7676       if (errors_reply_to)
7677         fprintf(fp, "Reply-To: %s\n", errors_reply_to);
7678       fprintf(fp, "Auto-Submitted: auto-replied\n");
7679       moan_write_from(fp);
7680       fprintf(fp, "To: %s\n", bounce_recipient);
7681       moan_write_references(fp, NULL);
7682
7683       /* generate boundary string and output MIME-Headers */
7684       bound = string_sprintf(TIME_T_FMT "-eximdsn-%d", time(NULL), rand());
7685
7686       fprintf(fp, "Content-Type: multipart/report;"
7687             " report-type=delivery-status; boundary=%s\n"
7688           "MIME-Version: 1.0\n",
7689         bound);
7690
7691       /* Open a template file if one is provided. Log failure to open, but
7692       carry on - default texts will be used. */
7693
7694       if (bounce_message_file)
7695         emf = expand_open(bounce_message_file,
7696                 US"bounce_message_file", US"error");
7697
7698       /* Quietly copy to configured additional addresses if required. */
7699
7700       if ((bcc = moan_check_errorcopy(bounce_recipient)))
7701         fprintf(fp, "Bcc: %s\n", bcc);
7702
7703       /* The texts for the message can be read from a template file; if there
7704       isn't one, or if it is too short, built-in texts are used. The first
7705       emf text is a Subject: and any other headers. */
7706
7707       if ((emf_text = next_emf(emf, US"header")))
7708         fprintf(fp, "%s\n", emf_text);
7709       else
7710         fprintf(fp, "Subject: Mail delivery failed%s\n\n",
7711           to_sender? ": returning message to sender" : "");
7712
7713       /* output human readable part as text/plain section */
7714       fprintf(fp, "--%s\n"
7715           "Content-type: text/plain; charset=us-ascii\n\n",
7716         bound);
7717
7718       if ((emf_text = next_emf(emf, US"intro")))
7719         fprintf(fp, "%s", CS emf_text);
7720       else
7721         {
7722         fprintf(fp,
7723 /* This message has been reworded several times. It seems to be confusing to
7724 somebody, however it is worded. I have retreated to the original, simple
7725 wording. */
7726 "This message was created automatically by mail delivery software.\n");
7727
7728         if (bounce_message_text)
7729           fprintf(fp, "%s", CS bounce_message_text);
7730         if (to_sender)
7731           fprintf(fp,
7732 "\nA message that you sent could not be delivered to one or more of its\n"
7733 "recipients. This is a permanent error. The following address(es) failed:\n");
7734         else
7735           fprintf(fp,
7736 "\nA message sent by\n\n  <%s>\n\n"
7737 "could not be delivered to one or more of its recipients. The following\n"
7738 "address(es) failed:\n", sender_address);
7739         }
7740       fputc('\n', fp);
7741
7742       /* Process the addresses, leaving them on the msgchain if they have a
7743       file name for a return message. (There has already been a check in
7744       post_process_one() for the existence of data in the message file.) A TRUE
7745       return from print_address_information() means that the address is not
7746       hidden. */
7747
7748       paddr = &msgchain;
7749       for (addr = msgchain; addr; addr = *paddr)
7750         {
7751         if (print_address_information(addr, fp, US"  ", US"\n    ", US""))
7752           print_address_error(addr, fp, US"");
7753
7754         /* End the final line for the address */
7755
7756         fputc('\n', fp);
7757
7758         /* Leave on msgchain if there's a return file. */
7759
7760         if (addr->return_file >= 0)
7761           {
7762           paddr = &(addr->next);
7763           filecount++;
7764           }
7765
7766         /* Else save so that we can tick off the recipient when the
7767         message is sent. */
7768
7769         else
7770           {
7771           *paddr = addr->next;
7772           addr->next = handled_addr;
7773           handled_addr = addr;
7774           }
7775         }
7776
7777       fputc('\n', fp);
7778
7779       /* Get the next text, whether we need it or not, so as to be
7780       positioned for the one after. */
7781
7782       emf_text = next_emf(emf, US"generated text");
7783
7784       /* If there were any file messages passed by the local transports,
7785       include them in the message. Then put the address on the handled chain.
7786       In the case of a batch of addresses that were all sent to the same
7787       transport, the return_file field in all of them will contain the same
7788       fd, and the return_filename field in the *last* one will be set (to the
7789       name of the file). */
7790
7791       if (msgchain)
7792         {
7793         address_item *nextaddr;
7794
7795         if (emf_text)
7796           fprintf(fp, "%s", CS emf_text);
7797         else
7798           fprintf(fp,
7799             "The following text was generated during the delivery "
7800             "attempt%s:\n", (filecount > 1)? "s" : "");
7801
7802         for (addr = msgchain; addr; addr = nextaddr)
7803           {
7804           FILE *fm;
7805           address_item *topaddr = addr;
7806
7807           /* List all the addresses that relate to this file */
7808
7809           fputc('\n', fp);
7810           while(addr)                   /* Insurance */
7811             {
7812             print_address_information(addr, fp, US"------ ",  US"\n       ",
7813               US" ------\n");
7814             if (addr->return_filename) break;
7815             addr = addr->next;
7816             }
7817           fputc('\n', fp);
7818
7819           /* Now copy the file */
7820
7821           if (!(fm = Ufopen(addr->return_filename, "rb")))
7822             fprintf(fp, "    +++ Exim error... failed to open text file: %s\n",
7823               strerror(errno));
7824           else
7825             {
7826             while ((ch = fgetc(fm)) != EOF) fputc(ch, fp);
7827             (void)fclose(fm);
7828             }
7829           Uunlink(addr->return_filename);
7830
7831           /* Can now add to handled chain, first fishing off the next
7832           address on the msgchain. */
7833
7834           nextaddr = addr->next;
7835           addr->next = handled_addr;
7836           handled_addr = topaddr;
7837           }
7838         fputc('\n', fp);
7839         }
7840
7841       /* output machine readable part */
7842 #ifdef SUPPORT_I18N
7843       if (message_smtputf8)
7844         fprintf(fp, "--%s\n"
7845             "Content-type: message/global-delivery-status\n\n"
7846             "Reporting-MTA: dns; %s\n",
7847           bound, smtp_active_hostname);
7848       else
7849 #endif
7850         fprintf(fp, "--%s\n"
7851             "Content-type: message/delivery-status\n\n"
7852             "Reporting-MTA: dns; %s\n",
7853           bound, smtp_active_hostname);
7854
7855       if (dsn_envid)
7856         {
7857         /* must be decoded from xtext: see RFC 3461:6.3a */
7858         uschar *xdec_envid;
7859         if (auth_xtextdecode(dsn_envid, &xdec_envid) > 0)
7860           fprintf(fp, "Original-Envelope-ID: %s\n", dsn_envid);
7861         else
7862           fprintf(fp, "X-Original-Envelope-ID: error decoding xtext formatted ENVID\n");
7863         }
7864       fputc('\n', fp);
7865
7866       for (addr = handled_addr; addr; addr = addr->next)
7867         {
7868         host_item * hu;
7869
7870         print_dsn_addr_action(fp, addr, US"failed", US"5.0.0");
7871
7872         if ((hu = addr->host_used) && hu->name)
7873           {
7874           fprintf(fp, "Remote-MTA: dns; %s\n", hu->name);
7875 #ifdef EXPERIMENTAL_DSN_INFO
7876           {
7877           const uschar * s;
7878           if (hu->address)
7879             {
7880             uschar * p = hu->port == 25
7881               ? US"" : string_sprintf(":%d", hu->port);
7882             fprintf(fp, "Remote-MTA: X-ip; [%s]%s\n", hu->address, p);
7883             }
7884           if ((s = addr->smtp_greeting) && *s)
7885             fprintf(fp, "X-Remote-MTA-smtp-greeting: X-str; %.900s\n", s);
7886           if ((s = addr->helo_response) && *s)
7887             fprintf(fp, "X-Remote-MTA-helo-response: X-str; %.900s\n", s);
7888           if ((s = addr->message) && *s)
7889             fprintf(fp, "X-Exim-Diagnostic: X-str; %.900s\n", s);
7890           }
7891 #endif
7892           print_dsn_diagnostic_code(addr, fp);
7893           }
7894         fputc('\n', fp);
7895         }
7896
7897       /* Now copy the message, trying to give an intelligible comment if
7898       it is too long for it all to be copied. The limit isn't strictly
7899       applied because of the buffering. There is, however, an option
7900       to suppress copying altogether. */
7901
7902       emf_text = next_emf(emf, US"copy");
7903
7904       /* add message body
7905          we ignore the intro text from template and add
7906          the text for bounce_return_size_limit at the end.
7907
7908          bounce_return_message is ignored
7909          in case RET= is defined we honor these values
7910          otherwise bounce_return_body is honored.
7911
7912          bounce_return_size_limit is always honored.
7913       */
7914
7915       fprintf(fp, "--%s\n", bound);
7916
7917       dsnlimitmsg = US"X-Exim-DSN-Information: Due to administrative limits only headers are returned";
7918       dsnnotifyhdr = NULL;
7919       topt = topt_add_return_path;
7920
7921       /* RET=HDRS? top priority */
7922       if (dsn_ret == dsn_ret_hdrs)
7923         topt |= topt_no_body;
7924       else
7925         {
7926         struct stat statbuf;
7927
7928         /* no full body return at all? */
7929         if (!bounce_return_body)
7930           {
7931           topt |= topt_no_body;
7932           /* add header if we overrule RET=FULL */
7933           if (dsn_ret == dsn_ret_full)
7934             dsnnotifyhdr = dsnlimitmsg;
7935           }
7936         /* line length limited... return headers only if oversize */
7937         /* size limited ... return headers only if limit reached */
7938         else if (  max_received_linelength > bounce_return_linesize_limit
7939                 || (  bounce_return_size_limit > 0
7940                    && fstat(deliver_datafile, &statbuf) == 0
7941                    && statbuf.st_size > max
7942                 )  )
7943           {
7944           topt |= topt_no_body;
7945           dsnnotifyhdr = dsnlimitmsg;
7946           }
7947         }
7948
7949 #ifdef SUPPORT_I18N
7950       if (message_smtputf8)
7951         fputs(topt & topt_no_body ? "Content-type: message/global-headers\n\n"
7952                                   : "Content-type: message/global\n\n",
7953               fp);
7954       else
7955 #endif
7956         fputs(topt & topt_no_body ? "Content-type: text/rfc822-headers\n\n"
7957                                   : "Content-type: message/rfc822\n\n",
7958               fp);
7959
7960       fflush(fp);
7961       transport_filter_argv = NULL;   /* Just in case */
7962       return_path = sender_address;   /* In case not previously set */
7963         {                             /* Dummy transport for headers add */
7964         transport_ctx tctx = {{0}};
7965         transport_instance tb = {0};
7966
7967         tctx.u.fd = fileno(fp);
7968         tctx.tblock = &tb;
7969         tctx.options = topt;
7970         tb.add_headers = dsnnotifyhdr;
7971
7972         /*XXX no checking for failure!  buggy! */
7973         transport_write_message(&tctx, 0);
7974         }
7975       fflush(fp);
7976
7977       /* we never add the final text. close the file */
7978       if (emf)
7979         (void)fclose(emf);
7980
7981       fprintf(fp, "\n--%s--\n", bound);
7982
7983       /* Close the file, which should send an EOF to the child process
7984       that is receiving the message. Wait for it to finish. */
7985
7986       (void)fclose(fp);
7987       rc = child_close(pid, 0);     /* Waits for child to close, no timeout */
7988
7989       /* If the process failed, there was some disaster in setting up the
7990       error message. Unless the message is very old, ensure that addr_defer
7991       is non-null, which will have the effect of leaving the message on the
7992       spool. The failed addresses will get tried again next time. However, we
7993       don't really want this to happen too often, so freeze the message unless
7994       there are some genuine deferred addresses to try. To do this we have
7995       to call spool_write_header() here, because with no genuine deferred
7996       addresses the normal code below doesn't get run. */
7997
7998       if (rc != 0)
7999         {
8000         uschar *s = US"";
8001         if (now - received_time.tv_sec < retry_maximum_timeout && !addr_defer)
8002           {
8003           addr_defer = (address_item *)(+1);
8004           f.deliver_freeze = TRUE;
8005           deliver_frozen_at = time(NULL);
8006           /* Panic-dies on error */
8007           (void)spool_write_header(message_id, SW_DELIVERING, NULL);
8008           s = US" (frozen)";
8009           }
8010         deliver_msglog("Process failed (%d) when writing error message "
8011           "to %s%s", rc, bounce_recipient, s);
8012         log_write(0, LOG_MAIN, "Process failed (%d) when writing error message "
8013           "to %s%s", rc, bounce_recipient, s);
8014         }
8015
8016       /* The message succeeded. Ensure that the recipients that failed are
8017       now marked finished with on the spool and their parents updated. */
8018
8019       else
8020         {
8021         for (addr = handled_addr; addr; addr = addr->next)
8022           {
8023           address_done(addr, logtod);
8024           child_done(addr, logtod);
8025           }
8026         /* Panic-dies on error */
8027         (void)spool_write_header(message_id, SW_DELIVERING, NULL);
8028         }
8029       }
8030     }
8031   }
8032
8033 f.disable_logging = FALSE;  /* In case left set */
8034
8035 /* Come here from the mua_wrapper case if routing goes wrong */
8036
8037 DELIVERY_TIDYUP:
8038
8039 /* If there are now no deferred addresses, we are done. Preserve the
8040 message log if so configured, and we are using them. Otherwise, sling it.
8041 Then delete the message itself. */
8042
8043 if (!addr_defer)
8044   {
8045   uschar * fname;
8046
8047   if (message_logs)
8048     {
8049     fname = spool_fname(US"msglog", message_subdir, id, US"");
8050     if (preserve_message_logs)
8051       {
8052       int rc;
8053       uschar * moname = spool_fname(US"msglog.OLD", US"", id, US"");
8054
8055       if ((rc = Urename(fname, moname)) < 0)
8056         {
8057         (void)directory_make(spool_directory,
8058                               spool_sname(US"msglog.OLD", US""),
8059                               MSGLOG_DIRECTORY_MODE, TRUE);
8060         rc = Urename(fname, moname);
8061         }
8062       if (rc < 0)
8063         log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to move %s to the "
8064           "msglog.OLD directory", fname);
8065       }
8066     else
8067       if (Uunlink(fname) < 0)
8068         log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s",
8069                   fname, strerror(errno));
8070     }
8071
8072   /* Remove the two message files. */
8073
8074   fname = spool_fname(US"input", message_subdir, id, US"-D");
8075   if (Uunlink(fname) < 0)
8076     log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s",
8077       fname, strerror(errno));
8078   fname = spool_fname(US"input", message_subdir, id, US"-H");
8079   if (Uunlink(fname) < 0)
8080     log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s",
8081       fname, strerror(errno));
8082
8083   /* Log the end of this message, with queue time if requested. */
8084
8085   if (LOGGING(queue_time_overall))
8086     log_write(0, LOG_MAIN, "Completed QT=%s", string_timesince(&received_time));
8087   else
8088     log_write(0, LOG_MAIN, "Completed");
8089
8090   /* Unset deliver_freeze so that we won't try to move the spool files further down */
8091   f.deliver_freeze = FALSE;
8092
8093 #ifndef DISABLE_EVENT
8094   (void) event_raise(event_action, US"msg:complete", NULL, NULL);
8095 #endif
8096   }
8097
8098 /* If there are deferred addresses, we are keeping this message because it is
8099 not yet completed. Lose any temporary files that were catching output from
8100 pipes for any of the deferred addresses, handle one-time aliases, and see if
8101 the message has been on the queue for so long that it is time to send a warning
8102 message to the sender, unless it is a mailer-daemon. If all deferred addresses
8103 have the same domain, we can set deliver_domain for the expansion of
8104 delay_warning_ condition - if any of them are pipes, files, or autoreplies, use
8105 the parent's domain.
8106
8107 If all the deferred addresses have an error number that indicates "retry time
8108 not reached", skip sending the warning message, because it won't contain the
8109 reason for the delay. It will get sent at the next real delivery attempt.
8110   Exception: for retries caused by a remote peer we use the error message
8111   store in the retry DB as the reason.
8112 However, if at least one address has tried, we'd better include all of them in
8113 the message.
8114
8115 If we can't make a process to send the message, don't worry.
8116
8117 For mailing list expansions we want to send the warning message to the
8118 mailing list manager. We can't do a perfect job here, as some addresses may
8119 have different errors addresses, but if we take the errors address from
8120 each deferred address it will probably be right in most cases.
8121
8122 If addr_defer == +1, it means there was a problem sending an error message
8123 for failed addresses, and there were no "real" deferred addresses. The value
8124 was set just to keep the message on the spool, so there is nothing to do here.
8125 */
8126
8127 else if (addr_defer != (address_item *)(+1))
8128   {
8129   uschar *recipients = US"";
8130   BOOL want_warning_msg = FALSE;
8131
8132   deliver_domain = testflag(addr_defer, af_pfr)
8133     ? addr_defer->parent->domain : addr_defer->domain;
8134
8135   for (address_item * addr = addr_defer; addr; addr = addr->next)
8136     {
8137     address_item *otaddr;
8138
8139     if (addr->basic_errno > ERRNO_WARN_BASE) want_warning_msg = TRUE;
8140
8141     if (deliver_domain)
8142       {
8143       const uschar *d = testflag(addr, af_pfr)
8144         ? addr->parent->domain : addr->domain;
8145
8146       /* The domain may be unset for an address that has never been routed
8147       because the system filter froze the message. */
8148
8149       if (!d || Ustrcmp(d, deliver_domain) != 0)
8150         deliver_domain = NULL;
8151       }
8152
8153     if (addr->return_filename) Uunlink(addr->return_filename);
8154
8155     /* Handle the case of one-time aliases. If any address in the ancestry
8156     of this one is flagged, ensure it is in the recipients list, suitably
8157     flagged, and that its parent is marked delivered. */
8158
8159     for (otaddr = addr; otaddr; otaddr = otaddr->parent)
8160       if (otaddr->onetime_parent) break;
8161
8162     if (otaddr)
8163       {
8164       int i;
8165       int t = recipients_count;
8166
8167       for (i = 0; i < recipients_count; i++)
8168         {
8169         uschar *r = recipients_list[i].address;
8170         if (Ustrcmp(otaddr->onetime_parent, r) == 0) t = i;
8171         if (Ustrcmp(otaddr->address, r) == 0) break;
8172         }
8173
8174       /* Didn't find the address already in the list, and did find the
8175       ultimate parent's address in the list, and they really are different
8176       (i.e. not from an identity-redirect). After adding the recipient,
8177       update the errors address in the recipients list. */
8178
8179       if (  i >= recipients_count && t < recipients_count
8180          && Ustrcmp(otaddr->address, otaddr->parent->address) != 0)
8181         {
8182         DEBUG(D_deliver) debug_printf("one_time: adding %s in place of %s\n",
8183           otaddr->address, otaddr->parent->address);
8184         receive_add_recipient(otaddr->address, t);
8185         recipients_list[recipients_count-1].errors_to = otaddr->prop.errors_address;
8186         tree_add_nonrecipient(otaddr->parent->address);
8187         update_spool = TRUE;
8188         }
8189       }
8190
8191     /* Except for error messages, ensure that either the errors address for
8192     this deferred address or, if there is none, the sender address, is on the
8193     list of recipients for a warning message. */
8194
8195     if (sender_address[0])
8196       {
8197       uschar * s = addr->prop.errors_address;
8198       if (!s) s = sender_address;
8199       if (Ustrstr(recipients, s) == NULL)
8200         recipients = string_sprintf("%s%s%s", recipients,
8201           recipients[0] ? "," : "", s);
8202       }
8203     }
8204
8205   /* Send a warning message if the conditions are right. If the condition check
8206   fails because of a lookup defer, there is nothing we can do. The warning
8207   is not sent. Another attempt will be made at the next delivery attempt (if
8208   it also defers). */
8209
8210   if (  !f.queue_2stage
8211      && want_warning_msg
8212      && (  !(addr_defer->dsn_flags & rf_dsnflags)
8213         || addr_defer->dsn_flags & rf_notify_delay
8214         )
8215      && delay_warning[1] > 0
8216      && sender_address[0] != 0
8217      && (  !delay_warning_condition
8218         || expand_check_condition(delay_warning_condition,
8219             US"delay_warning", US"option")
8220         )
8221      )
8222     {
8223     int count;
8224     int show_time;
8225     int queue_time = time(NULL) - received_time.tv_sec;
8226
8227     queue_time = test_harness_fudged_queue_time(queue_time);
8228
8229     /* See how many warnings we should have sent by now */
8230
8231     for (count = 0; count < delay_warning[1]; count++)
8232       if (queue_time < delay_warning[count+2]) break;
8233
8234     show_time = delay_warning[count+1];
8235
8236     if (count >= delay_warning[1])
8237       {
8238       int extra;
8239       int last_gap = show_time;
8240       if (count > 1) last_gap -= delay_warning[count];
8241       extra = (queue_time - delay_warning[count+1])/last_gap;
8242       show_time += last_gap * extra;
8243       count += extra;
8244       }
8245
8246     DEBUG(D_deliver)
8247       {
8248       debug_printf("time on queue = %s  id %s  addr %s\n",
8249         readconf_printtime(queue_time), message_id, addr_defer->address);
8250       debug_printf("warning counts: required %d done %d\n", count,
8251         warning_count);
8252       }
8253
8254     /* We have computed the number of warnings there should have been by now.
8255     If there haven't been enough, send one, and up the count to what it should
8256     have been. */
8257
8258     if (warning_count < count)
8259       {
8260       header_line *h;
8261       int fd;
8262       pid_t pid = child_open_exim(&fd, US"delay-warning-message");
8263
8264       if (pid > 0)
8265         {
8266         uschar * wmf_text;
8267         FILE * wmf = NULL;
8268         FILE * f = fdopen(fd, "wb");
8269         uschar * bound;
8270         transport_ctx tctx = {{0}};
8271
8272         if (warn_message_file)
8273           wmf = expand_open(warn_message_file,
8274                   US"warn_message_file", US"warning");
8275
8276         warnmsg_recipients = recipients;
8277         warnmsg_delay = queue_time < 120*60
8278           ? string_sprintf("%d minutes", show_time/60)
8279           : string_sprintf("%d hours", show_time/3600);
8280
8281         if (errors_reply_to)
8282           fprintf(f, "Reply-To: %s\n", errors_reply_to);
8283         fprintf(f, "Auto-Submitted: auto-replied\n");
8284         moan_write_from(f);
8285         fprintf(f, "To: %s\n", recipients);
8286         moan_write_references(f, NULL);
8287
8288         /* generated boundary string and output MIME-Headers */
8289         bound = string_sprintf(TIME_T_FMT "-eximdsn-%d", time(NULL), rand());
8290
8291         fprintf(f, "Content-Type: multipart/report;"
8292             " report-type=delivery-status; boundary=%s\n"
8293             "MIME-Version: 1.0\n",
8294           bound);
8295
8296         if ((wmf_text = next_emf(wmf, US"header")))
8297           fprintf(f, "%s\n", wmf_text);
8298         else
8299           fprintf(f, "Subject: Warning: message %s delayed %s\n\n",
8300             message_id, warnmsg_delay);
8301
8302         /* output human readable part as text/plain section */
8303         fprintf(f, "--%s\n"
8304             "Content-type: text/plain; charset=us-ascii\n\n",
8305           bound);
8306
8307         if ((wmf_text = next_emf(wmf, US"intro")))
8308           fprintf(f, "%s", CS wmf_text);
8309         else
8310           {
8311           fprintf(f,
8312 "This message was created automatically by mail delivery software.\n");
8313
8314           if (Ustrcmp(recipients, sender_address) == 0)
8315             fprintf(f,
8316 "A message that you sent has not yet been delivered to one or more of its\n"
8317 "recipients after more than ");
8318
8319           else
8320             fprintf(f,
8321 "A message sent by\n\n  <%s>\n\n"
8322 "has not yet been delivered to one or more of its recipients after more than \n",
8323               sender_address);
8324
8325           fprintf(f, "%s on the queue on %s.\n\n"
8326               "The message identifier is:     %s\n",
8327             warnmsg_delay, primary_hostname, message_id);
8328
8329           for (h = header_list; h; h = h->next)
8330             if (strncmpic(h->text, US"Subject:", 8) == 0)
8331               fprintf(f, "The subject of the message is: %s", h->text + 9);
8332             else if (strncmpic(h->text, US"Date:", 5) == 0)
8333               fprintf(f, "The date of the message is:    %s", h->text + 6);
8334           fputc('\n', f);
8335
8336           fprintf(f, "The address%s to which the message has not yet been "
8337             "delivered %s:\n",
8338             !addr_defer->next ? "" : "es",
8339             !addr_defer->next ? "is": "are");
8340           }
8341
8342         /* List the addresses, with error information if allowed */
8343
8344         fputc('\n', f);
8345         for (address_item * addr = addr_defer; addr; addr = addr->next)
8346           {
8347           if (print_address_information(addr, f, US"  ", US"\n    ", US""))
8348             print_address_error(addr, f, US"Delay reason: ");
8349           fputc('\n', f);
8350           }
8351         fputc('\n', f);
8352
8353         /* Final text */
8354
8355         if (wmf)
8356           {
8357           if ((wmf_text = next_emf(wmf, US"final")))
8358             fprintf(f, "%s", CS wmf_text);
8359           (void)fclose(wmf);
8360           }
8361         else
8362           {
8363           fprintf(f,
8364 "No action is required on your part. Delivery attempts will continue for\n"
8365 "some time, and this warning may be repeated at intervals if the message\n"
8366 "remains undelivered. Eventually the mail delivery software will give up,\n"
8367 "and when that happens, the message will be returned to you.\n");
8368           }
8369
8370         /* output machine readable part */
8371         fprintf(f, "\n--%s\n"
8372             "Content-type: message/delivery-status\n\n"
8373             "Reporting-MTA: dns; %s\n",
8374           bound,
8375           smtp_active_hostname);
8376
8377
8378         if (dsn_envid)
8379           {
8380           /* must be decoded from xtext: see RFC 3461:6.3a */
8381           uschar *xdec_envid;
8382           if (auth_xtextdecode(dsn_envid, &xdec_envid) > 0)
8383             fprintf(f,"Original-Envelope-ID: %s\n", dsn_envid);
8384           else
8385             fprintf(f,"X-Original-Envelope-ID: error decoding xtext formatted ENVID\n");
8386           }
8387         fputc('\n', f);
8388
8389         for (address_item * addr = addr_defer; addr; addr = addr->next)
8390           {
8391           host_item * hu;
8392
8393           print_dsn_addr_action(f, addr, US"delayed", US"4.0.0");
8394
8395           if ((hu = addr->host_used) && hu->name)
8396             {
8397             fprintf(f, "Remote-MTA: dns; %s\n", hu->name);
8398             print_dsn_diagnostic_code(addr, f);
8399             }
8400           fputc('\n', f);
8401           }
8402
8403         fprintf(f, "--%s\n"
8404             "Content-type: text/rfc822-headers\n\n",
8405           bound);
8406
8407         fflush(f);
8408         /* header only as required by RFC. only failure DSN needs to honor RET=FULL */
8409         tctx.u.fd = fileno(f);
8410         tctx.options = topt_add_return_path | topt_no_body;
8411         transport_filter_argv = NULL;   /* Just in case */
8412         return_path = sender_address;   /* In case not previously set */
8413
8414         /* Write the original email out */
8415         /*XXX no checking for failure!  buggy! */
8416         transport_write_message(&tctx, 0);
8417         fflush(f);
8418
8419         fprintf(f,"\n--%s--\n", bound);
8420
8421         fflush(f);
8422
8423         /* Close and wait for child process to complete, without a timeout.
8424         If there's an error, don't update the count. */
8425
8426         (void)fclose(f);
8427         if (child_close(pid, 0) == 0)
8428           {
8429           warning_count = count;
8430           update_spool = TRUE;    /* Ensure spool rewritten */
8431           }
8432         }
8433       }
8434     }
8435
8436   /* Clear deliver_domain */
8437
8438   deliver_domain = NULL;
8439
8440   /* If this was a first delivery attempt, unset the first time flag, and
8441   ensure that the spool gets updated. */
8442
8443   if (f.deliver_firsttime && !f.queue_2stage)
8444     {
8445     f.deliver_firsttime = FALSE;
8446     update_spool = TRUE;
8447     }
8448
8449   /* If delivery was frozen and freeze_tell is set, generate an appropriate
8450   message, unless the message is a local error message (to avoid loops). Then
8451   log the freezing. If the text in "frozen_info" came from a system filter,
8452   it has been escaped into printing characters so as not to mess up log lines.
8453   For the "tell" message, we turn \n back into newline. Also, insert a newline
8454   near the start instead of the ": " string. */
8455
8456   if (f.deliver_freeze)
8457     {
8458     if (freeze_tell && freeze_tell[0] != 0 && !f.local_error_message)
8459       {
8460       uschar *s = string_copy(frozen_info);
8461       uschar *ss = Ustrstr(s, " by the system filter: ");
8462
8463       if (ss != NULL)
8464         {
8465         ss[21] = '.';
8466         ss[22] = '\n';
8467         }
8468
8469       ss = s;
8470       while (*ss != 0)
8471         {
8472         if (*ss == '\\' && ss[1] == 'n')
8473           {
8474           *ss++ = ' ';
8475           *ss++ = '\n';
8476           }
8477         else ss++;
8478         }
8479       moan_tell_someone(freeze_tell, addr_defer, US"Message frozen",
8480         "Message %s has been frozen%s.\nThe sender is <%s>.\n", message_id,
8481         s, sender_address);
8482       }
8483
8484     /* Log freezing just before we update the -H file, to minimize the chance
8485     of a race problem. */
8486
8487     deliver_msglog("*** Frozen%s\n", frozen_info);
8488     log_write(0, LOG_MAIN, "Frozen%s", frozen_info);
8489     }
8490
8491   /* If there have been any updates to the non-recipients list, or other things
8492   that get written to the spool, we must now update the spool header file so
8493   that it has the right information for the next delivery attempt. If there
8494   was more than one address being delivered, the header_change update is done
8495   earlier, in case one succeeds and then something crashes. */
8496
8497   DEBUG(D_deliver)
8498     debug_printf("delivery deferred: update_spool=%d header_rewritten=%d\n",
8499       update_spool, f.header_rewritten);
8500
8501   if (update_spool || f.header_rewritten)
8502     /* Panic-dies on error */
8503     (void)spool_write_header(message_id, SW_DELIVERING, NULL);
8504   }
8505
8506 /* Finished with the message log. If the message is complete, it will have
8507 been unlinked or renamed above. */
8508
8509 if (message_logs) (void)fclose(message_log);
8510
8511 /* Now we can close and remove the journal file. Its only purpose is to record
8512 successfully completed deliveries asap so that this information doesn't get
8513 lost if Exim (or the machine) crashes. Forgetting about a failed delivery is
8514 not serious, as trying it again is not harmful. The journal might not be open
8515 if all addresses were deferred at routing or directing. Nevertheless, we must
8516 remove it if it exists (may have been lying around from a crash during the
8517 previous delivery attempt). We don't remove the journal if a delivery
8518 subprocess failed to pass back delivery information; this is controlled by
8519 the remove_journal flag. When the journal is left, we also don't move the
8520 message off the main spool if frozen and the option is set. It should get moved
8521 at the next attempt, after the journal has been inspected. */
8522
8523 if (journal_fd >= 0) (void)close(journal_fd);
8524
8525 if (remove_journal)
8526   {
8527   uschar * fname = spool_fname(US"input", message_subdir, id, US"-J");
8528
8529   if (Uunlink(fname) < 0 && errno != ENOENT)
8530     log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s", fname,
8531       strerror(errno));
8532
8533   /* Move the message off the spool if requested */
8534
8535 #ifdef SUPPORT_MOVE_FROZEN_MESSAGES
8536   if (f.deliver_freeze && move_frozen_messages)
8537     (void)spool_move_message(id, message_subdir, US"", US"F");
8538 #endif
8539   }
8540
8541 /* Closing the data file frees the lock; if the file has been unlinked it
8542 will go away. Otherwise the message becomes available for another process
8543 to try delivery. */
8544
8545 (void)close(deliver_datafile);
8546 deliver_datafile = -1;
8547 DEBUG(D_deliver) debug_printf("end delivery of %s\n", id);
8548 #ifdef MEASURE_TIMING
8549 report_time_since(&timestamp_startup, US"delivery end"); /* testcase 0005 */
8550 #endif
8551
8552 /* It is unlikely that there will be any cached resources, since they are
8553 released after routing, and in the delivery subprocesses. However, it's
8554 possible for an expansion for something afterwards (for example,
8555 expand_check_condition) to do a lookup. We must therefore be sure everything is
8556 released. */
8557
8558 search_tidyup();
8559 acl_where = ACL_WHERE_UNKNOWN;
8560 return final_yield;
8561 }
8562
8563
8564
8565 void
8566 tcp_init(void)
8567 {
8568 #ifdef EXIM_TFO_PROBE
8569 tfo_probe();
8570 #else
8571 f.tcp_fastopen_ok = TRUE;
8572 #endif
8573 }
8574
8575
8576
8577 /* Called from a commandline, or from the daemon, to do a delivery.
8578 We need to regain privs; do this by exec of the exim binary. */
8579
8580 void
8581 delivery_re_exec(int exec_type)
8582 {
8583 uschar * where;
8584
8585 if (cutthrough.cctx.sock >= 0 && cutthrough.callout_hold_only)
8586   {
8587   int channel_fd = cutthrough.cctx.sock;
8588
8589   smtp_peer_options = cutthrough.peer_options;
8590   continue_sequence = 0;
8591
8592 #ifndef DISABLE_TLS
8593   if (cutthrough.is_tls)
8594     {
8595     int pfd[2], pid;
8596
8597     smtp_peer_options |= OPTION_TLS;
8598     sending_ip_address = cutthrough.snd_ip;
8599     sending_port = cutthrough.snd_port;
8600
8601     where = US"socketpair";
8602     if (socketpair(AF_UNIX, SOCK_STREAM, 0, pfd) != 0)
8603       goto fail;
8604
8605     where = US"fork";
8606     testharness_pause_ms(150);
8607     if ((pid = exim_fork(US"tls-proxy-interproc")) < 0)
8608       goto fail;
8609
8610     if (pid == 0)       /* child: will fork again to totally disconnect */
8611       {
8612       smtp_proxy_tls(cutthrough.cctx.tls_ctx, big_buffer, big_buffer_size,
8613                       pfd, 5*60);
8614       /* does not return */
8615       }
8616
8617     close(pfd[0]);
8618     waitpid(pid, NULL, 0);
8619     (void) close(channel_fd);   /* release the client socket */
8620     channel_fd = pfd[1];
8621     }
8622 #endif
8623
8624   transport_do_pass_socket(cutthrough.transport, cutthrough.host.name,
8625     cutthrough.host.address, message_id, channel_fd);
8626   }
8627 else
8628   {
8629   cancel_cutthrough_connection(TRUE, US"non-continued delivery");
8630   (void) child_exec_exim(exec_type, FALSE, NULL, FALSE, 2, US"-Mc", message_id);
8631   }
8632 return;         /* compiler quietening; control does not reach here. */
8633
8634 #ifndef DISABLE_TLS
8635 fail:
8636   log_write(0,
8637     LOG_MAIN | (exec_type == CEE_EXEC_EXIT ? LOG_PANIC : LOG_PANIC_DIE),
8638     "delivery re-exec %s failed: %s", where, strerror(errno));
8639
8640   /* Get here if exec_type == CEE_EXEC_EXIT.
8641   Note: this must be _exit(), not exit(). */
8642
8643   _exit(EX_EXECFAILED);
8644 #endif
8645 }
8646
8647 /* vi: aw ai sw=2
8648 */
8649 /* End of deliver.c */