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