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