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