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