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