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