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