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