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