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