Coding: use specified-initialisers
[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 (addr->flags & af_prdr_used)
1199     s = string_catn(s, &size, &ptr, US" PRDR", 5);
1200 #endif
1201
1202   if (addr->flags & 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     setflag(addr, af_ignore_error);
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 (  !testflag(addr, af_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         && (addr->flags & (af_pfr|af_file)) == (next->flags & (af_pfr|af_file))
2781         && (!uses_lp  || Ustrcmp(next->local_part, addr->local_part) == 0)
2782         && (!uses_dom || Ustrcmp(next->domain, addr->domain) == 0)
2783         && same_strings(next->prop.errors_address, addr->prop.errors_address)
2784         && same_headers(next->prop.extra_headers, addr->prop.extra_headers)
2785         && same_strings(next->prop.remove_headers, addr->prop.remove_headers)
2786         && same_ugid(tp, addr, next)
2787         && (  !addr->host_list && !next->host_list
2788            ||    addr->host_list
2789               && next->host_list
2790               && Ustrcmp(addr->host_list->name, next->host_list->name) == 0
2791            );
2792
2793       /* If the transport has a batch_id setting, batch_id will be non-NULL
2794       from the expansion outside the loop. Expand for this address and compare.
2795       Expansion failure makes this address ineligible for batching. */
2796
2797       if (ok && batch_id)
2798         {
2799         uschar *bid;
2800         address_item *save_nextnext = next->next;
2801         next->next = NULL;            /* Expansion for a single address */
2802         deliver_set_expansions(next);
2803         next->next = save_nextnext;
2804         bid = expand_string(tp->batch_id);
2805         deliver_set_expansions(NULL);
2806         if (!bid)
2807           {
2808           log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand batch_id option "
2809             "in %s transport (%s): %s", tp->name, next->address,
2810             expand_string_message);
2811           ok = FALSE;
2812           }
2813         else ok = (Ustrcmp(batch_id, bid) == 0);
2814         }
2815
2816       /* Take address into batch if OK. */
2817
2818       if (ok)
2819         {
2820         *anchor = next->next;           /* Include the address */
2821         next->next = NULL;
2822         last->next = next;
2823         last = next;
2824         batch_count++;
2825         }
2826       else anchor = &next->next;        /* Skip the address */
2827       }
2828     }
2829
2830   /* We now have one or more addresses that can be delivered in a batch. Check
2831   whether the transport is prepared to accept a message of this size. If not,
2832   fail them all forthwith. If the expansion fails, or does not yield an
2833   integer, defer delivery. */
2834
2835   if (tp->message_size_limit)
2836     {
2837     int rc = check_message_size(tp, addr);
2838     if (rc != OK)
2839       {
2840       replicate_status(addr);
2841       while (addr)
2842         {
2843         addr2 = addr->next;
2844         post_process_one(addr, rc, logflags, DTYPE_TRANSPORT, 0);
2845         addr = addr2;
2846         }
2847       continue;    /* With next batch of addresses */
2848       }
2849     }
2850
2851   /* If we are not running the queue, or if forcing, all deliveries will be
2852   attempted. Otherwise, we must respect the retry times for each address. Even
2853   when not doing this, we need to set up the retry key string, and determine
2854   whether a retry record exists, because after a successful delivery, a delete
2855   retry item must be set up. Keep the retry database open only for the duration
2856   of these checks, rather than for all local deliveries, because some local
2857   deliveries (e.g. to pipes) can take a substantial time. */
2858
2859   if (!(dbm_file = dbfn_open(US"retry", O_RDONLY, &dbblock, FALSE)))
2860     {
2861     DEBUG(D_deliver|D_retry|D_hints_lookup)
2862       debug_printf("no retry data available\n");
2863     }
2864
2865   addr2 = addr;
2866   addr3 = NULL;
2867   while (addr2)
2868     {
2869     BOOL ok = TRUE;   /* to deliver this address */
2870     uschar *retry_key;
2871
2872     /* Set up the retry key to include the domain or not, and change its
2873     leading character from "R" to "T". Must make a copy before doing this,
2874     because the old key may be pointed to from a "delete" retry item after
2875     a routing delay. */
2876
2877     retry_key = string_copy(
2878       tp->retry_use_local_part ? addr2->address_retry_key :
2879         addr2->domain_retry_key);
2880     *retry_key = 'T';
2881
2882     /* Inspect the retry data. If there is no hints file, delivery happens. */
2883
2884     if (dbm_file)
2885       {
2886       dbdata_retry *retry_record = dbfn_read(dbm_file, retry_key);
2887
2888       /* If there is no retry record, delivery happens. If there is,
2889       remember it exists so it can be deleted after a successful delivery. */
2890
2891       if (retry_record)
2892         {
2893         setflag(addr2, af_lt_retry_exists);
2894
2895         /* A retry record exists for this address. If queue running and not
2896         forcing, inspect its contents. If the record is too old, or if its
2897         retry time has come, or if it has passed its cutoff time, delivery
2898         will go ahead. */
2899
2900         DEBUG(D_retry)
2901           {
2902           debug_printf("retry record exists: age=%s ",
2903             readconf_printtime(now - retry_record->time_stamp));
2904           debug_printf("(max %s)\n", readconf_printtime(retry_data_expire));
2905           debug_printf("  time to retry = %s expired = %d\n",
2906             readconf_printtime(retry_record->next_try - now),
2907             retry_record->expired);
2908           }
2909
2910         if (queue_running && !deliver_force)
2911           {
2912           ok = (now - retry_record->time_stamp > retry_data_expire)
2913             || (now >= retry_record->next_try)
2914             || retry_record->expired;
2915
2916           /* If we haven't reached the retry time, there is one more check
2917           to do, which is for the ultimate address timeout. */
2918
2919           if (!ok)
2920             ok = retry_ultimate_address_timeout(retry_key, addr2->domain,
2921                 retry_record, now);
2922           }
2923         }
2924       else DEBUG(D_retry) debug_printf("no retry record exists\n");
2925       }
2926
2927     /* This address is to be delivered. Leave it on the chain. */
2928
2929     if (ok)
2930       {
2931       addr3 = addr2;
2932       addr2 = addr2->next;
2933       }
2934
2935     /* This address is to be deferred. Take it out of the chain, and
2936     post-process it as complete. Must take it out of the chain first,
2937     because post processing puts it on another chain. */
2938
2939     else
2940       {
2941       address_item *this = addr2;
2942       this->message = US"Retry time not yet reached";
2943       this->basic_errno = ERRNO_LRETRY;
2944       addr2 = addr3 ? (addr3->next = addr2->next)
2945                     : (addr = addr2->next);
2946       post_process_one(this, DEFER, logflags, DTYPE_TRANSPORT, 0);
2947       }
2948     }
2949
2950   if (dbm_file) dbfn_close(dbm_file);
2951
2952   /* If there are no addresses left on the chain, they all deferred. Loop
2953   for the next set of addresses. */
2954
2955   if (!addr) continue;
2956
2957   /* If the transport is limited for parallellism, enforce that here.
2958   We use a hints DB entry, incremented here and decremented after
2959   the transport (and any shadow transport) completes. */
2960
2961   if (tpt_parallel_check(tp, addr, &serialize_key))
2962     {
2963     if (expand_string_message)
2964       {
2965       logflags |= LOG_PANIC;
2966       do
2967         {
2968         addr = addr->next;
2969         post_process_one(addr, DEFER, logflags, DTYPE_TRANSPORT, 0);
2970         } while ((addr = addr2));
2971       }
2972     continue;                   /* Loop for the next set of addresses. */
2973     }
2974
2975
2976   /* So, finally, we do have some addresses that can be passed to the
2977   transport. Before doing so, set up variables that are relevant to a
2978   single delivery. */
2979
2980   deliver_set_expansions(addr);
2981
2982   gettimeofday(&delivery_start, NULL);
2983   deliver_local(addr, FALSE);
2984   timesince(&deliver_time, &delivery_start);
2985
2986   /* If a shadow transport (which must perforce be another local transport), is
2987   defined, and its condition is met, we must pass the message to the shadow
2988   too, but only those addresses that succeeded. We do this by making a new
2989   chain of addresses - also to keep the original chain uncontaminated. We must
2990   use a chain rather than doing it one by one, because the shadow transport may
2991   batch.
2992
2993   NOTE: if the condition fails because of a lookup defer, there is nothing we
2994   can do! */
2995
2996   if (  tp->shadow
2997      && (  !tp->shadow_condition
2998         || expand_check_condition(tp->shadow_condition, tp->name, US"transport")
2999      )  )
3000     {
3001     transport_instance *stp;
3002     address_item *shadow_addr = NULL;
3003     address_item **last = &shadow_addr;
3004
3005     for (stp = transports; stp; stp = stp->next)
3006       if (Ustrcmp(stp->name, tp->shadow) == 0) break;
3007
3008     if (!stp)
3009       log_write(0, LOG_MAIN|LOG_PANIC, "shadow transport \"%s\" not found ",
3010         tp->shadow);
3011
3012     /* Pick off the addresses that have succeeded, and make clones. Put into
3013     the shadow_message field a pointer to the shadow_message field of the real
3014     address. */
3015
3016     else for (addr2 = addr; addr2; addr2 = addr2->next)
3017       if (addr2->transport_return == OK)
3018         {
3019         addr3 = store_get(sizeof(address_item));
3020         *addr3 = *addr2;
3021         addr3->next = NULL;
3022         addr3->shadow_message = US &addr2->shadow_message;
3023         addr3->transport = stp;
3024         addr3->transport_return = DEFER;
3025         addr3->return_filename = NULL;
3026         addr3->return_file = -1;
3027         *last = addr3;
3028         last = &addr3->next;
3029         }
3030
3031     /* If we found any addresses to shadow, run the delivery, and stick any
3032     message back into the shadow_message field in the original. */
3033
3034     if (shadow_addr)
3035       {
3036       int save_count = transport_count;
3037
3038       DEBUG(D_deliver|D_transport)
3039         debug_printf(">>>>>>>>>>>>>>>> Shadow delivery >>>>>>>>>>>>>>>>\n");
3040       deliver_local(shadow_addr, TRUE);
3041
3042       for(; shadow_addr; shadow_addr = shadow_addr->next)
3043         {
3044         int sresult = shadow_addr->transport_return;
3045         *(uschar **)shadow_addr->shadow_message =
3046           sresult == OK
3047           ? string_sprintf(" ST=%s", stp->name)
3048           : string_sprintf(" ST=%s (%s%s%s)", stp->name,
3049               shadow_addr->basic_errno <= 0
3050               ? US""
3051               : US strerror(shadow_addr->basic_errno),
3052               shadow_addr->basic_errno <= 0 || !shadow_addr->message
3053               ? US""
3054               : US": ",
3055               shadow_addr->message
3056               ? shadow_addr->message
3057               : shadow_addr->basic_errno <= 0
3058               ? US"unknown error"
3059               : US"");
3060
3061         DEBUG(D_deliver|D_transport)
3062           debug_printf("%s shadow transport returned %s for %s\n",
3063             stp->name,
3064             sresult == OK ?    "OK" :
3065             sresult == DEFER ? "DEFER" :
3066             sresult == FAIL ?  "FAIL" :
3067             sresult == PANIC ? "PANIC" : "?",
3068             shadow_addr->address);
3069         }
3070
3071       DEBUG(D_deliver|D_transport)
3072         debug_printf(">>>>>>>>>>>>>>>> End shadow delivery >>>>>>>>>>>>>>>>\n");
3073
3074       transport_count = save_count;   /* Restore original transport count */
3075       }
3076     }
3077
3078   /* Cancel the expansions that were set up for the delivery. */
3079
3080   deliver_set_expansions(NULL);
3081
3082   /* If the transport was parallelism-limited, decrement the hints DB record. */
3083
3084   if (serialize_key) enq_end(serialize_key);
3085
3086   /* Now we can process the results of the real transport. We must take each
3087   address off the chain first, because post_process_one() puts it on another
3088   chain. */
3089
3090   for (addr2 = addr; addr2; addr2 = nextaddr)
3091     {
3092     int result = addr2->transport_return;
3093     nextaddr = addr2->next;
3094
3095     DEBUG(D_deliver|D_transport)
3096       debug_printf("%s transport returned %s for %s\n",
3097         tp->name,
3098         result == OK ?    "OK" :
3099         result == DEFER ? "DEFER" :
3100         result == FAIL ?  "FAIL" :
3101         result == PANIC ? "PANIC" : "?",
3102         addr2->address);
3103
3104     /* If there is a retry_record, or if delivery is deferred, build a retry
3105     item for setting a new retry time or deleting the old retry record from
3106     the database. These items are handled all together after all addresses
3107     have been handled (so the database is open just for a short time for
3108     updating). */
3109
3110     if (result == DEFER || testflag(addr2, af_lt_retry_exists))
3111       {
3112       int flags = result == DEFER ? 0 : rf_delete;
3113       uschar *retry_key = string_copy(tp->retry_use_local_part
3114         ? addr2->address_retry_key : addr2->domain_retry_key);
3115       *retry_key = 'T';
3116       retry_add_item(addr2, retry_key, flags);
3117       }
3118
3119     /* Done with this address */
3120
3121     if (result == OK)
3122       {
3123       addr2->more_errno = deliver_time.tv_sec;
3124       addr2->delivery_usec = deliver_time.tv_usec;
3125       }
3126     post_process_one(addr2, result, logflags, DTYPE_TRANSPORT, logchar);
3127
3128     /* If a pipe delivery generated text to be sent back, the result may be
3129     changed to FAIL, and we must copy this for subsequent addresses in the
3130     batch. */
3131
3132     if (addr2->transport_return != result)
3133       {
3134       for (addr3 = nextaddr; addr3; addr3 = addr3->next)
3135         {
3136         addr3->transport_return = addr2->transport_return;
3137         addr3->basic_errno = addr2->basic_errno;
3138         addr3->message = addr2->message;
3139         }
3140       result = addr2->transport_return;
3141       }
3142
3143     /* Whether or not the result was changed to FAIL, we need to copy the
3144     return_file value from the first address into all the addresses of the
3145     batch, so they are all listed in the error message. */
3146
3147     addr2->return_file = addr->return_file;
3148
3149     /* Change log character for recording successful deliveries. */
3150
3151     if (result == OK) logchar = '-';
3152     }
3153   }        /* Loop back for next batch of addresses */
3154 }
3155
3156
3157
3158
3159 /*************************************************
3160 *           Sort remote deliveries               *
3161 *************************************************/
3162
3163 /* This function is called if remote_sort_domains is set. It arranges that the
3164 chain of addresses for remote deliveries is ordered according to the strings
3165 specified. Try to make this shuffling reasonably efficient by handling
3166 sequences of addresses rather than just single ones.
3167
3168 Arguments:  None
3169 Returns:    Nothing
3170 */
3171
3172 static void
3173 sort_remote_deliveries(void)
3174 {
3175 int sep = 0;
3176 address_item **aptr = &addr_remote;
3177 const uschar *listptr = remote_sort_domains;
3178 uschar *pattern;
3179 uschar patbuf[256];
3180
3181 while (  *aptr
3182       && (pattern = string_nextinlist(&listptr, &sep, patbuf, sizeof(patbuf)))
3183       )
3184   {
3185   address_item *moved = NULL;
3186   address_item **bptr = &moved;
3187
3188   while (*aptr)
3189     {
3190     address_item **next;
3191     deliver_domain = (*aptr)->domain;   /* set $domain */
3192     if (match_isinlist(deliver_domain, (const uschar **)&pattern, UCHAR_MAX+1,
3193           &domainlist_anchor, NULL, MCL_DOMAIN, TRUE, NULL) == OK)
3194       {
3195       aptr = &(*aptr)->next;
3196       continue;
3197       }
3198
3199     next = &(*aptr)->next;
3200     while (  *next
3201           && (deliver_domain = (*next)->domain,  /* Set $domain */
3202             match_isinlist(deliver_domain, (const uschar **)&pattern, UCHAR_MAX+1,
3203               &domainlist_anchor, NULL, MCL_DOMAIN, TRUE, NULL)) != OK
3204           )
3205       next = &(*next)->next;
3206
3207     /* If the batch of non-matchers is at the end, add on any that were
3208     extracted further up the chain, and end this iteration. Otherwise,
3209     extract them from the chain and hang on the moved chain. */
3210
3211     if (!*next)
3212       {
3213       *next = moved;
3214       break;
3215       }
3216
3217     *bptr = *aptr;
3218     *aptr = *next;
3219     *next = NULL;
3220     bptr = next;
3221     aptr = &(*aptr)->next;
3222     }
3223
3224   /* If the loop ended because the final address matched, *aptr will
3225   be NULL. Add on to the end any extracted non-matching addresses. If
3226   *aptr is not NULL, the loop ended via "break" when *next is null, that
3227   is, there was a string of non-matching addresses at the end. In this
3228   case the extracted addresses have already been added on the end. */
3229
3230   if (!*aptr) *aptr = moved;
3231   }
3232
3233 DEBUG(D_deliver)
3234   {
3235   address_item *addr;
3236   debug_printf("remote addresses after sorting:\n");
3237   for (addr = addr_remote; addr; addr = addr->next)
3238     debug_printf("  %s\n", addr->address);
3239   }
3240 }
3241
3242
3243
3244 /*************************************************
3245 *  Read from pipe for remote delivery subprocess *
3246 *************************************************/
3247
3248 /* This function is called when the subprocess is complete, but can also be
3249 called before it is complete, in order to empty a pipe that is full (to prevent
3250 deadlock). It must therefore keep track of its progress in the parlist data
3251 block.
3252
3253 We read the pipe to get the delivery status codes and a possible error message
3254 for each address, optionally preceded by unusability data for the hosts and
3255 also by optional retry data.
3256
3257 Read in large chunks into the big buffer and then scan through, interpreting
3258 the data therein. In most cases, only a single read will be necessary. No
3259 individual item will ever be anywhere near 2500 bytes in length, so by ensuring
3260 that we read the next chunk when there is less than 2500 bytes left in the
3261 non-final chunk, we can assume each item is complete in the buffer before
3262 handling it. Each item is written using a single write(), which is atomic for
3263 small items (less than PIPE_BUF, which seems to be at least 512 in any Unix and
3264 often bigger) so even if we are reading while the subprocess is still going, we
3265 should never have only a partial item in the buffer.
3266
3267 Argument:
3268   poffset     the offset of the parlist item
3269   eop         TRUE if the process has completed
3270
3271 Returns:      TRUE if the terminating 'Z' item has been read,
3272               or there has been a disaster (i.e. no more data needed);
3273               FALSE otherwise
3274 */
3275
3276 static BOOL
3277 par_read_pipe(int poffset, BOOL eop)
3278 {
3279 host_item *h;
3280 pardata *p = parlist + poffset;
3281 address_item *addrlist = p->addrlist;
3282 address_item *addr = p->addr;
3283 pid_t pid = p->pid;
3284 int fd = p->fd;
3285 uschar *endptr = big_buffer;
3286 uschar *ptr = endptr;
3287 uschar *msg = p->msg;
3288 BOOL done = p->done;
3289 BOOL finished = FALSE;
3290 /* minimum size to read is header size including id, subid and length */
3291 int required = PIPE_HEADER_SIZE;
3292
3293 /* Loop through all items, reading from the pipe when necessary. The pipe
3294 is set up to be non-blocking, but there are two different Unix mechanisms in
3295 use. Exim uses O_NONBLOCK if it is defined. This returns 0 for end of file,
3296 and EAGAIN for no more data. If O_NONBLOCK is not defined, Exim uses O_NDELAY,
3297 which returns 0 for both end of file and no more data. We distinguish the
3298 two cases by taking 0 as end of file only when we know the process has
3299 completed.
3300
3301 Each separate item is written to the pipe in a single write(), and as they are
3302 all short items, the writes will all be atomic and we should never find
3303 ourselves in the position of having read an incomplete item. "Short" in this
3304 case can mean up to about 1K in the case when there is a long error message
3305 associated with an address. */
3306
3307 DEBUG(D_deliver) debug_printf("reading pipe for subprocess %d (%s)\n",
3308   (int)p->pid, eop? "ended" : "not ended");
3309
3310 while (!done)
3311   {
3312   retry_item *r, **rp;
3313   int remaining = endptr - ptr;
3314   uschar header[PIPE_HEADER_SIZE + 1];
3315   uschar id, subid;
3316   uschar *endc;
3317
3318   /* Read (first time) or top up the chars in the buffer if necessary.
3319   There will be only one read if we get all the available data (i.e. don't
3320   fill the buffer completely). */
3321
3322   if (remaining < required && !finished)
3323     {
3324     int len;
3325     int available = big_buffer_size - remaining;
3326
3327     if (remaining > 0) memmove(big_buffer, ptr, remaining);
3328
3329     ptr = big_buffer;
3330     endptr = big_buffer + remaining;
3331     len = read(fd, endptr, available);
3332
3333     DEBUG(D_deliver) debug_printf("read() yielded %d\n", len);
3334
3335     /* If the result is EAGAIN and the process is not complete, just
3336     stop reading any more and process what we have already. */
3337
3338     if (len < 0)
3339       {
3340       if (!eop && errno == EAGAIN) len = 0; else
3341         {
3342         msg = string_sprintf("failed to read pipe from transport process "
3343           "%d for transport %s: %s", pid, addr->transport->driver_name,
3344           strerror(errno));
3345         break;
3346         }
3347       }
3348
3349     /* If the length is zero (eof or no-more-data), just process what we
3350     already have. Note that if the process is still running and we have
3351     read all the data in the pipe (but less that "available") then we
3352     won't read any more, as "finished" will get set. */
3353
3354     endptr += len;
3355     remaining += len;
3356     finished = len != available;
3357     }
3358
3359   /* If we are at the end of the available data, exit the loop. */
3360   if (ptr >= endptr) break;
3361
3362   /* copy and read header */
3363   memcpy(header, ptr, PIPE_HEADER_SIZE);
3364   header[PIPE_HEADER_SIZE] = '\0';
3365   id = header[0];
3366   subid = header[1];
3367   required = Ustrtol(header + 2, &endc, 10) + PIPE_HEADER_SIZE;     /* header + data */
3368   if (*endc)
3369     {
3370     msg = string_sprintf("failed to read pipe from transport process "
3371       "%d for transport %s: error reading size from header", pid, addr->transport->driver_name);
3372     done = TRUE;
3373     break;
3374     }
3375
3376   DEBUG(D_deliver)
3377     debug_printf("header read  id:%c,subid:%c,size:%s,required:%d,remaining:%d,finished:%d\n",
3378                     id, subid, header+2, required, remaining, finished);
3379
3380   /* is there room for the dataset we want to read ? */
3381   if (required > big_buffer_size - PIPE_HEADER_SIZE)
3382     {
3383     msg = string_sprintf("failed to read pipe from transport process "
3384       "%d for transport %s: big_buffer too small! required size=%d buffer size=%d", pid, addr->transport->driver_name,
3385       required, big_buffer_size - PIPE_HEADER_SIZE);
3386     done = TRUE;
3387     break;
3388     }
3389
3390   /* We wrote all datasets with atomic write() calls.  Remaining < required only
3391   happens if big_buffer was too small to get all available data from pipe;
3392   finished has to be false as well. */
3393
3394   if (remaining < required)
3395     {
3396     if (!finished)
3397       continue;
3398     msg = string_sprintf("failed to read pipe from transport process "
3399       "%d for transport %s: required size=%d > remaining size=%d and finished=true",
3400       pid, addr->transport->driver_name, required, remaining);
3401     done = TRUE;
3402     break;
3403     }
3404
3405   /* Step past the header */
3406   ptr += PIPE_HEADER_SIZE;
3407
3408   /* Handle each possible type of item, assuming the complete item is
3409   available in store. */
3410
3411   switch (id)
3412     {
3413     /* Host items exist only if any hosts were marked unusable. Match
3414     up by checking the IP address. */
3415
3416     case 'H':
3417       for (h = addrlist->host_list; h; h = h->next)
3418         {
3419         if (!h->address || Ustrcmp(h->address, ptr+2) != 0) continue;
3420         h->status = ptr[0];
3421         h->why = ptr[1];
3422         }
3423       ptr += 2;
3424       while (*ptr++);
3425       break;
3426
3427     /* Retry items are sent in a preceding R item for each address. This is
3428     kept separate to keep each message short enough to guarantee it won't
3429     be split in the pipe. Hopefully, in the majority of cases, there won't in
3430     fact be any retry items at all.
3431
3432     The complete set of retry items might include an item to delete a
3433     routing retry if there was a previous routing delay. However, routing
3434     retries are also used when a remote transport identifies an address error.
3435     In that case, there may also be an "add" item for the same key. Arrange
3436     that a "delete" item is dropped in favour of an "add" item. */
3437
3438     case 'R':
3439       if (!addr) goto ADDR_MISMATCH;
3440
3441       DEBUG(D_deliver|D_retry)
3442         debug_printf("reading retry information for %s from subprocess\n",
3443           ptr+1);
3444
3445       /* Cut out any "delete" items on the list. */
3446
3447       for (rp = &addr->retries; (r = *rp); rp = &r->next)
3448         if (Ustrcmp(r->key, ptr+1) == 0)           /* Found item with same key */
3449           {
3450           if (!(r->flags & rf_delete)) break;      /* It was not "delete" */
3451           *rp = r->next;                           /* Excise a delete item */
3452           DEBUG(D_deliver|D_retry)
3453             debug_printf("  existing delete item dropped\n");
3454           }
3455
3456       /* We want to add a delete item only if there is no non-delete item;
3457       however we still have to step ptr through the data. */
3458
3459       if (!r || !(*ptr & rf_delete))
3460         {
3461         r = store_get(sizeof(retry_item));
3462         r->next = addr->retries;
3463         addr->retries = r;
3464         r->flags = *ptr++;
3465         r->key = string_copy(ptr);
3466         while (*ptr++);
3467         memcpy(&r->basic_errno, ptr, sizeof(r->basic_errno));
3468         ptr += sizeof(r->basic_errno);
3469         memcpy(&r->more_errno, ptr, sizeof(r->more_errno));
3470         ptr += sizeof(r->more_errno);
3471         r->message = *ptr ? string_copy(ptr) : NULL;
3472         DEBUG(D_deliver|D_retry) debug_printf("  added %s item\n",
3473             r->flags & rf_delete ? "delete" : "retry");
3474         }
3475
3476       else
3477         {
3478         DEBUG(D_deliver|D_retry)
3479           debug_printf("  delete item not added: non-delete item exists\n");
3480         ptr++;
3481         while(*ptr++);
3482         ptr += sizeof(r->basic_errno) + sizeof(r->more_errno);
3483         }
3484
3485       while(*ptr++);
3486       break;
3487
3488     /* Put the amount of data written into the parlist block */
3489
3490     case 'S':
3491       memcpy(&(p->transport_count), ptr, sizeof(transport_count));
3492       ptr += sizeof(transport_count);
3493       break;
3494
3495     /* Address items are in the order of items on the address chain. We
3496     remember the current address value in case this function is called
3497     several times to empty the pipe in stages. Information about delivery
3498     over TLS is sent in a preceding X item for each address. We don't put
3499     it in with the other info, in order to keep each message short enough to
3500     guarantee it won't be split in the pipe. */
3501
3502 #ifdef SUPPORT_TLS
3503     case 'X':
3504       if (!addr) goto ADDR_MISMATCH;          /* Below, in 'A' handler */
3505       switch (subid)
3506         {
3507         case '1':
3508           addr->cipher = NULL;
3509           addr->peerdn = NULL;
3510
3511           if (*ptr)
3512             addr->cipher = string_copy(ptr);
3513           while (*ptr++);
3514           if (*ptr)
3515             addr->peerdn = string_copy(ptr);
3516           break;
3517
3518         case '2':
3519           if (*ptr)
3520             (void) tls_import_cert(ptr, &addr->peercert);
3521           else
3522             addr->peercert = NULL;
3523           break;
3524
3525         case '3':
3526           if (*ptr)
3527             (void) tls_import_cert(ptr, &addr->ourcert);
3528           else
3529             addr->ourcert = NULL;
3530           break;
3531
3532 # ifndef DISABLE_OCSP
3533         case '4':
3534           addr->ocsp = *ptr ? *ptr - '0' : OCSP_NOT_REQ;
3535           break;
3536 # endif
3537         }
3538       while (*ptr++);
3539       break;
3540 #endif  /*SUPPORT_TLS*/
3541
3542     case 'C':   /* client authenticator information */
3543       switch (subid)
3544         {
3545         case '1': addr->authenticator = *ptr ? string_copy(ptr) : NULL; break;
3546         case '2': addr->auth_id = *ptr ? string_copy(ptr) : NULL;       break;
3547         case '3': addr->auth_sndr = *ptr ? string_copy(ptr) : NULL;     break;
3548         }
3549       while (*ptr++);
3550       break;
3551
3552 #ifndef DISABLE_PRDR
3553     case 'P':
3554       addr->flags |= af_prdr_used;
3555       break;
3556 #endif
3557
3558     case 'K':
3559       addr->flags |= af_chunking_used;
3560       break;
3561
3562     case 'D':
3563       if (!addr) goto ADDR_MISMATCH;
3564       memcpy(&(addr->dsn_aware), ptr, sizeof(addr->dsn_aware));
3565       ptr += sizeof(addr->dsn_aware);
3566       DEBUG(D_deliver) debug_printf("DSN read: addr->dsn_aware = %d\n", addr->dsn_aware);
3567       break;
3568
3569     case 'A':
3570       if (!addr)
3571         {
3572         ADDR_MISMATCH:
3573         msg = string_sprintf("address count mismatch for data read from pipe "
3574           "for transport process %d for transport %s", pid,
3575             addrlist->transport->driver_name);
3576         done = TRUE;
3577         break;
3578         }
3579
3580       switch (subid)
3581         {
3582   #ifdef SUPPORT_SOCKS
3583         case '2':       /* proxy information; must arrive before A0 and applies to that addr XXX oops*/
3584           proxy_session = TRUE; /*XXX should this be cleared somewhere? */
3585           if (*ptr == 0)
3586             ptr++;
3587           else
3588             {
3589             proxy_local_address = string_copy(ptr);
3590             while(*ptr++);
3591             memcpy(&proxy_local_port, ptr, sizeof(proxy_local_port));
3592             ptr += sizeof(proxy_local_port);
3593             }
3594           break;
3595   #endif
3596
3597   #ifdef EXPERIMENTAL_DSN_INFO
3598         case '1':       /* must arrive before A0, and applies to that addr */
3599                         /* Two strings: smtp_greeting and helo_response */
3600           addr->smtp_greeting = string_copy(ptr);
3601           while(*ptr++);
3602           addr->helo_response = string_copy(ptr);
3603           while(*ptr++);
3604           break;
3605   #endif
3606
3607         case '0':
3608           DEBUG(D_deliver) debug_printf("A0 %s tret %d\n", addr->address, *ptr);
3609           addr->transport_return = *ptr++;
3610           addr->special_action = *ptr++;
3611           memcpy(&addr->basic_errno, ptr, sizeof(addr->basic_errno));
3612           ptr += sizeof(addr->basic_errno);
3613           memcpy(&addr->more_errno, ptr, sizeof(addr->more_errno));
3614           ptr += sizeof(addr->more_errno);
3615           memcpy(&addr->delivery_usec, ptr, sizeof(addr->delivery_usec));
3616           ptr += sizeof(addr->delivery_usec);
3617           memcpy(&addr->flags, ptr, sizeof(addr->flags));
3618           ptr += sizeof(addr->flags);
3619           addr->message = *ptr ? string_copy(ptr) : NULL;
3620           while(*ptr++);
3621           addr->user_message = *ptr ? string_copy(ptr) : NULL;
3622           while(*ptr++);
3623
3624           /* Always two strings for host information, followed by the port number and DNSSEC mark */
3625
3626           if (*ptr)
3627             {
3628             h = store_get(sizeof(host_item));
3629             h->name = string_copy(ptr);
3630             while (*ptr++);
3631             h->address = string_copy(ptr);
3632             while(*ptr++);
3633             memcpy(&h->port, ptr, sizeof(h->port));
3634             ptr += sizeof(h->port);
3635             h->dnssec = *ptr == '2' ? DS_YES
3636                       : *ptr == '1' ? DS_NO
3637                       : DS_UNK;
3638             ptr++;
3639             addr->host_used = h;
3640             }
3641           else ptr++;
3642
3643           /* Finished with this address */
3644
3645           addr = addr->next;
3646           break;
3647         }
3648       break;
3649
3650     /* Local interface address/port */
3651     case 'I':
3652       if (*ptr) sending_ip_address = string_copy(ptr);
3653       while (*ptr++) ;
3654       if (*ptr) sending_port = atoi(CS ptr);
3655       while (*ptr++) ;
3656       break;
3657
3658     /* Z marks the logical end of the data. It is followed by '0' if
3659     continue_transport was NULL at the end of transporting, otherwise '1'.
3660     We need to know when it becomes NULL during a delivery down a passed SMTP
3661     channel so that we don't try to pass anything more down it. Of course, for
3662     most normal messages it will remain NULL all the time. */
3663
3664     case 'Z':
3665       if (*ptr == '0')
3666         {
3667         continue_transport = NULL;
3668         continue_hostname = NULL;
3669         }
3670       done = TRUE;
3671       DEBUG(D_deliver) debug_printf("Z0%c item read\n", *ptr);
3672       break;
3673
3674     /* Anything else is a disaster. */
3675
3676     default:
3677       msg = string_sprintf("malformed data (%d) read from pipe for transport "
3678         "process %d for transport %s", ptr[-1], pid,
3679           addr->transport->driver_name);
3680       done = TRUE;
3681       break;
3682     }
3683   }
3684
3685 /* The done flag is inspected externally, to determine whether or not to
3686 call the function again when the process finishes. */
3687
3688 p->done = done;
3689
3690 /* If the process hadn't finished, and we haven't seen the end of the data
3691 or suffered a disaster, update the rest of the state, and return FALSE to
3692 indicate "not finished". */
3693
3694 if (!eop && !done)
3695   {
3696   p->addr = addr;
3697   p->msg = msg;
3698   return FALSE;
3699   }
3700
3701 /* Close our end of the pipe, to prevent deadlock if the far end is still
3702 pushing stuff into it. */
3703
3704 (void)close(fd);
3705 p->fd = -1;
3706
3707 /* If we have finished without error, but haven't had data for every address,
3708 something is wrong. */
3709
3710 if (!msg && addr)
3711   msg = string_sprintf("insufficient address data read from pipe "
3712     "for transport process %d for transport %s", pid,
3713       addr->transport->driver_name);
3714
3715 /* If an error message is set, something has gone wrong in getting back
3716 the delivery data. Put the message into each address and freeze it. */
3717
3718 if (msg)
3719   for (addr = addrlist; addr; addr = addr->next)
3720     {
3721     addr->transport_return = DEFER;
3722     addr->special_action = SPECIAL_FREEZE;
3723     addr->message = msg;
3724     }
3725
3726 /* Return TRUE to indicate we have got all we need from this process, even
3727 if it hasn't actually finished yet. */
3728
3729 return TRUE;
3730 }
3731
3732
3733
3734 /*************************************************
3735 *   Post-process a set of remote addresses       *
3736 *************************************************/
3737
3738 /* Do what has to be done immediately after a remote delivery for each set of
3739 addresses, then re-write the spool if necessary. Note that post_process_one
3740 puts the address on an appropriate queue; hence we must fish off the next
3741 one first. This function is also called if there is a problem with setting
3742 up a subprocess to do a remote delivery in parallel. In this case, the final
3743 argument contains a message, and the action must be forced to DEFER.
3744
3745 Argument:
3746    addr      pointer to chain of address items
3747    logflags  flags for logging
3748    msg       NULL for normal cases; -> error message for unexpected problems
3749    fallback  TRUE if processing fallback hosts
3750
3751 Returns:     nothing
3752 */
3753
3754 static void
3755 remote_post_process(address_item *addr, int logflags, uschar *msg,
3756   BOOL fallback)
3757 {
3758 host_item *h;
3759
3760 /* If any host addresses were found to be unusable, add them to the unusable
3761 tree so that subsequent deliveries don't try them. */
3762
3763 for (h = addr->host_list; h; h = h->next)
3764   if (h->address)
3765     if (h->status >= hstatus_unusable) tree_add_unusable(h);
3766
3767 /* Now handle each address on the chain. The transport has placed '=' or '-'
3768 into the special_action field for each successful delivery. */
3769
3770 while (addr)
3771   {
3772   address_item *next = addr->next;
3773
3774   /* If msg == NULL (normal processing) and the result is DEFER and we are
3775   processing the main hosts and there are fallback hosts available, put the
3776   address on the list for fallback delivery. */
3777
3778   if (  addr->transport_return == DEFER
3779      && addr->fallback_hosts
3780      && !fallback
3781      && !msg
3782      )
3783     {
3784     addr->host_list = addr->fallback_hosts;
3785     addr->next = addr_fallback;
3786     addr_fallback = addr;
3787     DEBUG(D_deliver) debug_printf("%s queued for fallback host(s)\n", addr->address);
3788     }
3789
3790   /* If msg is set (=> unexpected problem), set it in the address before
3791   doing the ordinary post processing. */
3792
3793   else
3794     {
3795     if (msg)
3796       {
3797       addr->message = msg;
3798       addr->transport_return = DEFER;
3799       }
3800     (void)post_process_one(addr, addr->transport_return, logflags,
3801       DTYPE_TRANSPORT, addr->special_action);
3802     }
3803
3804   /* Next address */
3805
3806   addr = next;
3807   }
3808
3809 /* If we have just delivered down a passed SMTP channel, and that was
3810 the last address, the channel will have been closed down. Now that
3811 we have logged that delivery, set continue_sequence to 1 so that
3812 any subsequent deliveries don't get "*" incorrectly logged. */
3813
3814 if (!continue_transport) continue_sequence = 1;
3815 }
3816
3817
3818
3819 /*************************************************
3820 *     Wait for one remote delivery subprocess    *
3821 *************************************************/
3822
3823 /* This function is called while doing remote deliveries when either the
3824 maximum number of processes exist and we need one to complete so that another
3825 can be created, or when waiting for the last ones to complete. It must wait for
3826 the completion of one subprocess, empty the control block slot, and return a
3827 pointer to the address chain.
3828
3829 Arguments:    none
3830 Returns:      pointer to the chain of addresses handled by the process;
3831               NULL if no subprocess found - this is an unexpected error
3832 */
3833
3834 static address_item *
3835 par_wait(void)
3836 {
3837 int poffset, status;
3838 address_item *addr, *addrlist;
3839 pid_t pid;
3840
3841 set_process_info("delivering %s: waiting for a remote delivery subprocess "
3842   "to finish", message_id);
3843
3844 /* Loop until either a subprocess completes, or there are no subprocesses in
3845 existence - in which case give an error return. We cannot proceed just by
3846 waiting for a completion, because a subprocess may have filled up its pipe, and
3847 be waiting for it to be emptied. Therefore, if no processes have finished, we
3848 wait for one of the pipes to acquire some data by calling select(), with a
3849 timeout just in case.
3850
3851 The simple approach is just to iterate after reading data from a ready pipe.
3852 This leads to non-ideal behaviour when the subprocess has written its final Z
3853 item, closed the pipe, and is in the process of exiting (the common case). A
3854 call to waitpid() yields nothing completed, but select() shows the pipe ready -
3855 reading it yields EOF, so you end up with busy-waiting until the subprocess has
3856 actually finished.
3857
3858 To avoid this, if all the data that is needed has been read from a subprocess
3859 after select(), an explicit wait() for it is done. We know that all it is doing
3860 is writing to the pipe and then exiting, so the wait should not be long.
3861
3862 The non-blocking waitpid() is to some extent just insurance; if we could
3863 reliably detect end-of-file on the pipe, we could always know when to do a
3864 blocking wait() for a completed process. However, because some systems use
3865 NDELAY, which doesn't distinguish between EOF and pipe empty, it is easier to
3866 use code that functions without the need to recognize EOF.
3867
3868 There's a double loop here just in case we end up with a process that is not in
3869 the list of remote delivery processes. Something has obviously gone wrong if
3870 this is the case. (For example, a process that is incorrectly left over from
3871 routing or local deliveries might be found.) The damage can be minimized by
3872 looping back and looking for another process. If there aren't any, the error
3873 return will happen. */
3874
3875 for (;;)   /* Normally we do not repeat this loop */
3876   {
3877   while ((pid = waitpid(-1, &status, WNOHANG)) <= 0)
3878     {
3879     struct timeval tv;
3880     fd_set select_pipes;
3881     int maxpipe, readycount;
3882
3883     /* A return value of -1 can mean several things. If errno != ECHILD, it
3884     either means invalid options (which we discount), or that this process was
3885     interrupted by a signal. Just loop to try the waitpid() again.
3886
3887     If errno == ECHILD, waitpid() is telling us that there are no subprocesses
3888     in existence. This should never happen, and is an unexpected error.
3889     However, there is a nasty complication when running under Linux. If "strace
3890     -f" is being used under Linux to trace this process and its children,
3891     subprocesses are "stolen" from their parents and become the children of the
3892     tracing process. A general wait such as the one we've just obeyed returns
3893     as if there are no children while subprocesses are running. Once a
3894     subprocess completes, it is restored to the parent, and waitpid(-1) finds
3895     it. Thanks to Joachim Wieland for finding all this out and suggesting a
3896     palliative.
3897
3898     This does not happen using "truss" on Solaris, nor (I think) with other
3899     tracing facilities on other OS. It seems to be specific to Linux.
3900
3901     What we do to get round this is to use kill() to see if any of our
3902     subprocesses are still in existence. If kill() gives an OK return, we know
3903     it must be for one of our processes - it can't be for a re-use of the pid,
3904     because if our process had finished, waitpid() would have found it. If any
3905     of our subprocesses are in existence, we proceed to use select() as if
3906     waitpid() had returned zero. I think this is safe. */
3907
3908     if (pid < 0)
3909       {
3910       if (errno != ECHILD) continue;   /* Repeats the waitpid() */
3911
3912       DEBUG(D_deliver)
3913         debug_printf("waitpid() returned -1/ECHILD: checking explicitly "
3914           "for process existence\n");
3915
3916       for (poffset = 0; poffset < remote_max_parallel; poffset++)
3917         {
3918         if ((pid = parlist[poffset].pid) != 0 && kill(pid, 0) == 0)
3919           {
3920           DEBUG(D_deliver) debug_printf("process %d still exists: assume "
3921             "stolen by strace\n", (int)pid);
3922           break;   /* With poffset set */
3923           }
3924         }
3925
3926       if (poffset >= remote_max_parallel)
3927         {
3928         DEBUG(D_deliver) debug_printf("*** no delivery children found\n");
3929         return NULL;   /* This is the error return */
3930         }
3931       }
3932
3933     /* A pid value greater than 0 breaks the "while" loop. A negative value has
3934     been handled above. A return value of zero means that there is at least one
3935     subprocess, but there are no completed subprocesses. See if any pipes are
3936     ready with any data for reading. */
3937
3938     DEBUG(D_deliver) debug_printf("selecting on subprocess pipes\n");
3939
3940     maxpipe = 0;
3941     FD_ZERO(&select_pipes);
3942     for (poffset = 0; poffset < remote_max_parallel; poffset++)
3943       if (parlist[poffset].pid != 0)
3944         {
3945         int fd = parlist[poffset].fd;
3946         FD_SET(fd, &select_pipes);
3947         if (fd > maxpipe) maxpipe = fd;
3948         }
3949
3950     /* Stick in a 60-second timeout, just in case. */
3951
3952     tv.tv_sec = 60;
3953     tv.tv_usec = 0;
3954
3955     readycount = select(maxpipe + 1, (SELECT_ARG2_TYPE *)&select_pipes,
3956          NULL, NULL, &tv);
3957
3958     /* Scan through the pipes and read any that are ready; use the count
3959     returned by select() to stop when there are no more. Select() can return
3960     with no processes (e.g. if interrupted). This shouldn't matter.
3961
3962     If par_read_pipe() returns TRUE, it means that either the terminating Z was
3963     read, or there was a disaster. In either case, we are finished with this
3964     process. Do an explicit wait() for the process and break the main loop if
3965     it succeeds.
3966
3967     It turns out that we have to deal with the case of an interrupted system
3968     call, which can happen on some operating systems if the signal handling is
3969     set up to do that by default. */
3970
3971     for (poffset = 0;
3972          readycount > 0 && poffset < remote_max_parallel;
3973          poffset++)
3974       {
3975       if (  (pid = parlist[poffset].pid) != 0
3976          && FD_ISSET(parlist[poffset].fd, &select_pipes)
3977          )
3978         {
3979         readycount--;
3980         if (par_read_pipe(poffset, FALSE))    /* Finished with this pipe */
3981           {
3982           for (;;)                            /* Loop for signals */
3983             {
3984             pid_t endedpid = waitpid(pid, &status, 0);
3985             if (endedpid == pid) goto PROCESS_DONE;
3986             if (endedpid != (pid_t)(-1) || errno != EINTR)
3987               log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Unexpected error return "
3988                 "%d (errno = %d) from waitpid() for process %d",
3989                 (int)endedpid, errno, (int)pid);
3990             }
3991           }
3992         }
3993       }
3994
3995     /* Now go back and look for a completed subprocess again. */
3996     }
3997
3998   /* A completed process was detected by the non-blocking waitpid(). Find the
3999   data block that corresponds to this subprocess. */
4000
4001   for (poffset = 0; poffset < remote_max_parallel; poffset++)
4002     if (pid == parlist[poffset].pid) break;
4003
4004   /* Found the data block; this is a known remote delivery process. We don't
4005   need to repeat the outer loop. This should be what normally happens. */
4006
4007   if (poffset < remote_max_parallel) break;
4008
4009   /* This situation is an error, but it's probably better to carry on looking
4010   for another process than to give up (as we used to do). */
4011
4012   log_write(0, LOG_MAIN|LOG_PANIC, "Process %d finished: not found in remote "
4013     "transport process list", pid);
4014   }  /* End of the "for" loop */
4015
4016 /* Come here when all the data was completely read after a select(), and
4017 the process in pid has been wait()ed for. */
4018
4019 PROCESS_DONE:
4020
4021 DEBUG(D_deliver)
4022   {
4023   if (status == 0)
4024     debug_printf("remote delivery process %d ended\n", (int)pid);
4025   else
4026     debug_printf("remote delivery process %d ended: status=%04x\n", (int)pid,
4027       status);
4028   }
4029
4030 set_process_info("delivering %s", message_id);
4031
4032 /* Get the chain of processed addresses */
4033
4034 addrlist = parlist[poffset].addrlist;
4035
4036 /* If the process did not finish cleanly, record an error and freeze (except
4037 for SIGTERM, SIGKILL and SIGQUIT), and also ensure the journal is not removed,
4038 in case the delivery did actually happen. */
4039
4040 if ((status & 0xffff) != 0)
4041   {
4042   uschar *msg;
4043   int msb = (status >> 8) & 255;
4044   int lsb = status & 255;
4045   int code = (msb == 0)? (lsb & 0x7f) : msb;
4046
4047   msg = string_sprintf("%s transport process returned non-zero status 0x%04x: "
4048     "%s %d",
4049     addrlist->transport->driver_name,
4050     status,
4051     (msb == 0)? "terminated by signal" : "exit code",
4052     code);
4053
4054   if (msb != 0 || (code != SIGTERM && code != SIGKILL && code != SIGQUIT))
4055     addrlist->special_action = SPECIAL_FREEZE;
4056
4057   for (addr = addrlist; addr; addr = addr->next)
4058     {
4059     addr->transport_return = DEFER;
4060     addr->message = msg;
4061     }
4062
4063   remove_journal = FALSE;
4064   }
4065
4066 /* Else complete reading the pipe to get the result of the delivery, if all
4067 the data has not yet been obtained. */
4068
4069 else if (!parlist[poffset].done) (void)par_read_pipe(poffset, TRUE);
4070
4071 /* Put the data count and return path into globals, mark the data slot unused,
4072 decrement the count of subprocesses, and return the address chain. */
4073
4074 transport_count = parlist[poffset].transport_count;
4075 used_return_path = parlist[poffset].return_path;
4076 parlist[poffset].pid = 0;
4077 parcount--;
4078 return addrlist;
4079 }
4080
4081
4082
4083 /*************************************************
4084 *      Wait for subprocesses and post-process    *
4085 *************************************************/
4086
4087 /* This function waits for subprocesses until the number that are still running
4088 is below a given threshold. For each complete subprocess, the addresses are
4089 post-processed. If we can't find a running process, there is some shambles.
4090 Better not bomb out, as that might lead to multiple copies of the message. Just
4091 log and proceed as if all done.
4092
4093 Arguments:
4094   max         maximum number of subprocesses to leave running
4095   fallback    TRUE if processing fallback hosts
4096
4097 Returns:      nothing
4098 */
4099
4100 static void
4101 par_reduce(int max, BOOL fallback)
4102 {
4103 while (parcount > max)
4104   {
4105   address_item *doneaddr = par_wait();
4106   if (!doneaddr)
4107     {
4108     log_write(0, LOG_MAIN|LOG_PANIC,
4109       "remote delivery process count got out of step");
4110     parcount = 0;
4111     }
4112   else
4113     {
4114     transport_instance * tp = doneaddr->transport;
4115     if (tp->max_parallel)
4116       enq_end(string_sprintf("tpt-serialize-%s", tp->name));
4117
4118     remote_post_process(doneaddr, LOG_MAIN, NULL, fallback);
4119     }
4120   }
4121 }
4122
4123
4124
4125
4126 static void
4127 rmt_dlv_checked_write(int fd, char id, char subid, void * buf, int size)
4128 {
4129 uschar  writebuffer[PIPE_HEADER_SIZE + BIG_BUFFER_SIZE];
4130 int header_length;
4131 int ret;
4132
4133 /* we assume that size can't get larger then BIG_BUFFER_SIZE which currently is set to 16k */
4134 /* complain to log if someone tries with buffer sizes we can't handle*/
4135
4136 if (size > 99999)
4137   {
4138   log_write(0, LOG_MAIN|LOG_PANIC_DIE,
4139     "Failed writing transport result to pipe: can't handle buffers > 99999 bytes. truncating!\n");
4140   size = 99999;
4141   }
4142
4143 /* to keep the write() atomic we build header in writebuffer and copy buf behind */
4144 /* two write() calls would increase the complexity of reading from pipe */
4145
4146 /* convert size to human readable string prepended by id and subid */
4147 header_length = snprintf(CS writebuffer, PIPE_HEADER_SIZE+1, "%c%c%05d", id, subid, size);
4148 if (header_length != PIPE_HEADER_SIZE)
4149   {
4150   log_write(0, LOG_MAIN|LOG_PANIC_DIE, "header snprintf failed\n");
4151   writebuffer[0] = '\0';
4152   }
4153
4154 DEBUG(D_deliver) debug_printf("header write id:%c,subid:%c,size:%d,final:%s\n",
4155                                  id, subid, size, writebuffer);
4156
4157 if (buf && size > 0)
4158   memcpy(writebuffer + PIPE_HEADER_SIZE, buf, size);
4159
4160 size += PIPE_HEADER_SIZE;
4161 if ((ret = write(fd, writebuffer, size)) != size)
4162   log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Failed writing transport result to pipe: %s\n",
4163     ret == -1 ? strerror(errno) : "short write");
4164 }
4165
4166 /*************************************************
4167 *           Do remote deliveries                 *
4168 *************************************************/
4169
4170 /* This function is called to process the addresses in addr_remote. We must
4171 pick off the queue all addresses that have the same transport, remote
4172 destination, and errors address, and hand them to the transport in one go,
4173 subject to some configured limitations. If this is a run to continue delivering
4174 to an existing delivery channel, skip all but those addresses that can go to
4175 that channel. The skipped addresses just get deferred.
4176
4177 If mua_wrapper is set, all addresses must be able to be sent in a single
4178 transaction. If not, this function yields FALSE.
4179
4180 In Exim 4, remote deliveries are always done in separate processes, even
4181 if remote_max_parallel = 1 or if there's only one delivery to do. The reason
4182 is so that the base process can retain privilege. This makes the
4183 implementation of fallback transports feasible (though not initially done.)
4184
4185 We create up to the configured number of subprocesses, each of which passes
4186 back the delivery state via a pipe. (However, when sending down an existing
4187 connection, remote_max_parallel is forced to 1.)
4188
4189 Arguments:
4190   fallback  TRUE if processing fallback hosts
4191
4192 Returns:    TRUE normally
4193             FALSE if mua_wrapper is set and the addresses cannot all be sent
4194               in one transaction
4195 */
4196
4197 static BOOL
4198 do_remote_deliveries(BOOL fallback)
4199 {
4200 int parmax;
4201 int delivery_count;
4202 int poffset;
4203
4204 parcount = 0;    /* Number of executing subprocesses */
4205
4206 /* When sending down an existing channel, only do one delivery at a time.
4207 We use a local variable (parmax) to hold the maximum number of processes;
4208 this gets reduced from remote_max_parallel if we can't create enough pipes. */
4209
4210 if (continue_transport) remote_max_parallel = 1;
4211 parmax = remote_max_parallel;
4212
4213 /* If the data for keeping a list of processes hasn't yet been
4214 set up, do so. */
4215
4216 if (!parlist)
4217   {
4218   parlist = store_get(remote_max_parallel * sizeof(pardata));
4219   for (poffset = 0; poffset < remote_max_parallel; poffset++)
4220     parlist[poffset].pid = 0;
4221   }
4222
4223 /* Now loop for each remote delivery */
4224
4225 for (delivery_count = 0; addr_remote; delivery_count++)
4226   {
4227   pid_t pid;
4228   uid_t uid;
4229   gid_t gid;
4230   int pfd[2];
4231   int address_count = 1;
4232   int address_count_max;
4233   BOOL multi_domain;
4234   BOOL use_initgroups;
4235   BOOL pipe_done = FALSE;
4236   transport_instance *tp;
4237   address_item **anchor = &addr_remote;
4238   address_item *addr = addr_remote;
4239   address_item *last = addr;
4240   address_item *next;
4241   uschar * panicmsg;
4242   uschar * serialize_key = NULL;
4243
4244   /* Pull the first address right off the list. */
4245
4246   addr_remote = addr->next;
4247   addr->next = NULL;
4248
4249   DEBUG(D_deliver|D_transport)
4250     debug_printf("--------> %s <--------\n", addr->address);
4251
4252   /* If no transport has been set, there has been a big screw-up somewhere. */
4253
4254   if (!(tp = addr->transport))
4255     {
4256     disable_logging = FALSE;  /* Jic */
4257     panicmsg = US"No transport set by router";
4258     goto panic_continue;
4259     }
4260
4261   /* Check that this base address hasn't previously been delivered to this
4262   transport. The check is necessary at this point to handle homonymic addresses
4263   correctly in cases where the pattern of redirection changes between delivery
4264   attempts. Non-homonymic previous delivery is detected earlier, at routing
4265   time. */
4266
4267   if (previously_transported(addr, FALSE)) continue;
4268
4269   /* Force failure if the message is too big. */
4270
4271   if (tp->message_size_limit)
4272     {
4273     int rc = check_message_size(tp, addr);
4274     if (rc != OK)
4275       {
4276       addr->transport_return = rc;
4277       remote_post_process(addr, LOG_MAIN, NULL, fallback);
4278       continue;
4279       }
4280     }
4281
4282   /* Get the flag which specifies whether the transport can handle different
4283   domains that nevertheless resolve to the same set of hosts. If it needs
4284   expanding, get variables set: $address_data, $domain_data, $localpart_data,
4285   $host, $host_address, $host_port. */
4286   if (tp->expand_multi_domain)
4287     deliver_set_expansions(addr);
4288
4289   if (exp_bool(addr, US"transport", tp->name, D_transport,
4290                 US"multi_domain", tp->multi_domain, tp->expand_multi_domain,
4291                 &multi_domain) != OK)
4292     {
4293     deliver_set_expansions(NULL);
4294     panicmsg = addr->message;
4295     goto panic_continue;
4296     }
4297
4298   /* Get the maximum it can handle in one envelope, with zero meaning
4299   unlimited, which is forced for the MUA wrapper case. */
4300
4301   address_count_max = tp->max_addresses;
4302   if (address_count_max == 0 || mua_wrapper) address_count_max = 999999;
4303
4304
4305   /************************************************************************/
4306   /*****    This is slightly experimental code, but should be safe.   *****/
4307
4308   /* The address_count_max value is the maximum number of addresses that the
4309   transport can send in one envelope. However, the transport must be capable of
4310   dealing with any number of addresses. If the number it gets exceeds its
4311   envelope limitation, it must send multiple copies of the message. This can be
4312   done over a single connection for SMTP, so uses less resources than making
4313   multiple connections. On the other hand, if remote_max_parallel is greater
4314   than one, it is perhaps a good idea to use parallel processing to move the
4315   message faster, even if that results in multiple simultaneous connections to
4316   the same host.
4317
4318   How can we come to some compromise between these two ideals? What we do is to
4319   limit the number of addresses passed to a single instance of a transport to
4320   the greater of (a) its address limit (rcpt_max for SMTP) and (b) the total
4321   number of addresses routed to remote transports divided by
4322   remote_max_parallel. For example, if the message has 100 remote recipients,
4323   remote max parallel is 2, and rcpt_max is 10, we'd never send more than 50 at
4324   once. But if rcpt_max is 100, we could send up to 100.
4325
4326   Of course, not all the remotely addresses in a message are going to go to the
4327   same set of hosts (except in smarthost configurations), so this is just a
4328   heuristic way of dividing up the work.
4329
4330   Furthermore (1), because this may not be wanted in some cases, and also to
4331   cope with really pathological cases, there is also a limit to the number of
4332   messages that are sent over one connection. This is the same limit that is
4333   used when sending several different messages over the same connection.
4334   Continue_sequence is set when in this situation, to the number sent so
4335   far, including this message.
4336
4337   Furthermore (2), when somebody explicitly sets the maximum value to 1, it
4338   is probably because they are using VERP, in which case they want to pass only
4339   one address at a time to the transport, in order to be able to use
4340   $local_part and $domain in constructing a new return path. We could test for
4341   the use of these variables, but as it is so likely they will be used when the
4342   maximum is 1, we don't bother. Just leave the value alone. */
4343
4344   if (  address_count_max != 1
4345      && address_count_max < remote_delivery_count/remote_max_parallel
4346      )
4347     {
4348     int new_max = remote_delivery_count/remote_max_parallel;
4349     int message_max = tp->connection_max_messages;
4350     if (connection_max_messages >= 0) message_max = connection_max_messages;
4351     message_max -= continue_sequence - 1;
4352     if (message_max > 0 && new_max > address_count_max * message_max)
4353       new_max = address_count_max * message_max;
4354     address_count_max = new_max;
4355     }
4356
4357   /************************************************************************/
4358
4359
4360   /* Pick off all addresses which have the same transport, errors address,
4361   destination, and extra headers. In some cases they point to the same host
4362   list, but we also need to check for identical host lists generated from
4363   entirely different domains. The host list pointers can be NULL in the case
4364   where the hosts are defined in the transport. There is also a configured
4365   maximum limit of addresses that can be handled at once (see comments above
4366   for how it is computed).
4367   If the transport does not handle multiple domains, enforce that also,
4368   and if it might need a per-address check for this, re-evaluate it.
4369   */
4370
4371   while ((next = *anchor) && address_count < address_count_max)
4372     {
4373     BOOL md;
4374     if (  (multi_domain || Ustrcmp(next->domain, addr->domain) == 0)
4375        && tp == next->transport
4376        && same_hosts(next->host_list, addr->host_list)
4377        && same_strings(next->prop.errors_address, addr->prop.errors_address)
4378        && same_headers(next->prop.extra_headers, addr->prop.extra_headers)
4379        && same_ugid(tp, next, addr)
4380        && (  next->prop.remove_headers == addr->prop.remove_headers
4381           || (  next->prop.remove_headers
4382              && addr->prop.remove_headers
4383              && Ustrcmp(next->prop.remove_headers, addr->prop.remove_headers) == 0
4384           )  )
4385        && (  !multi_domain
4386           || (  (
4387                 (void)(!tp->expand_multi_domain || ((void)deliver_set_expansions(next), 1)),
4388                 exp_bool(addr,
4389                     US"transport", next->transport->name, D_transport,
4390                     US"multi_domain", next->transport->multi_domain,
4391                     next->transport->expand_multi_domain, &md) == OK
4392                 )
4393              && md
4394        )  )  )
4395       {
4396       *anchor = next->next;
4397       next->next = NULL;
4398       next->first = addr;  /* remember top one (for retry processing) */
4399       last->next = next;
4400       last = next;
4401       address_count++;
4402       }
4403     else anchor = &(next->next);
4404     deliver_set_expansions(NULL);
4405     }
4406
4407   /* If we are acting as an MUA wrapper, all addresses must go in a single
4408   transaction. If not, put them back on the chain and yield FALSE. */
4409
4410   if (mua_wrapper && addr_remote)
4411     {
4412     last->next = addr_remote;
4413     addr_remote = addr;
4414     return FALSE;
4415     }
4416
4417   /* If the transport is limited for parallellism, enforce that here.
4418   The hints DB entry is decremented in par_reduce(), when we reap the
4419   transport process. */
4420
4421   if (tpt_parallel_check(tp, addr, &serialize_key))
4422     if ((panicmsg = expand_string_message))
4423       goto panic_continue;
4424     else
4425       continue;                 /* Loop for the next set of addresses. */
4426
4427   /* Set up the expansion variables for this set of addresses */
4428
4429   deliver_set_expansions(addr);
4430
4431   /* Ensure any transport-set auth info is fresh */
4432   addr->authenticator = addr->auth_id = addr->auth_sndr = NULL;
4433
4434   /* Compute the return path, expanding a new one if required. The old one
4435   must be set first, as it might be referred to in the expansion. */
4436
4437   if(addr->prop.errors_address)
4438     return_path = addr->prop.errors_address;
4439 #ifdef EXPERIMENTAL_SRS
4440   else if(addr->prop.srs_sender)
4441     return_path = addr->prop.srs_sender;
4442 #endif
4443   else
4444     return_path = sender_address;
4445
4446   if (tp->return_path)
4447     {
4448     uschar *new_return_path = expand_string(tp->return_path);
4449     if (new_return_path)
4450       return_path = new_return_path;
4451     else if (!expand_string_forcedfail)
4452       {
4453       panicmsg = string_sprintf("Failed to expand return path \"%s\": %s",
4454         tp->return_path, expand_string_message);
4455       goto enq_continue;
4456       }
4457     }
4458
4459   /* Find the uid, gid, and use_initgroups setting for this transport. Failure
4460   logs and sets up error messages, so we just post-process and continue with
4461   the next address. */
4462
4463   if (!findugid(addr, tp, &uid, &gid, &use_initgroups))
4464     {
4465     panicmsg = NULL;
4466     goto enq_continue;
4467     }
4468
4469   /* If this transport has a setup function, call it now so that it gets
4470   run in this process and not in any subprocess. That way, the results of
4471   any setup that are retained by the transport can be reusable. One of the
4472   things the setup does is to set the fallback host lists in the addresses.
4473   That is why it is called at this point, before the continue delivery
4474   processing, because that might use the fallback hosts. */
4475
4476   if (tp->setup)
4477     (void)((tp->setup)(addr->transport, addr, NULL, uid, gid, NULL));
4478
4479   /* If we have a connection still open from a verify stage (lazy-close)
4480   treat it as if it is a continued connection (apart from the counter used
4481   for the log line mark). */
4482
4483   if (cutthrough.fd >= 0 && cutthrough.callout_hold_only)
4484     {
4485     DEBUG(D_deliver)
4486       debug_printf("lazy-callout-close: have conn still open from verification\n");
4487     continue_transport = cutthrough.transport;
4488     continue_hostname = string_copy(cutthrough.host.name);
4489     continue_host_address = string_copy(cutthrough.host.address);
4490     continue_sequence = 1;
4491     sending_ip_address = cutthrough.snd_ip;
4492     sending_port = cutthrough.snd_port;
4493     smtp_peer_options = cutthrough.peer_options;
4494     }
4495
4496   /* If this is a run to continue delivery down an already-established
4497   channel, check that this set of addresses matches the transport and
4498   the channel. If it does not, defer the addresses. If a host list exists,
4499   we must check that the continue host is on the list. Otherwise, the
4500   host is set in the transport. */
4501
4502   continue_more = FALSE;           /* In case got set for the last lot */
4503   if (continue_transport)
4504     {
4505     BOOL ok = Ustrcmp(continue_transport, tp->name) == 0;
4506
4507     /* If the transport is about to override the host list do not check
4508     it here but take the cost of running the transport process to discover
4509     if the continued_hostname connection is suitable.  This is a layering
4510     violation which is unfortunate as it requires we haul in the smtp
4511     include file. */
4512
4513     if (ok)
4514       {
4515       smtp_transport_options_block * ob;
4516
4517       if (  !(  Ustrcmp(tp->info->driver_name, "smtp") == 0
4518              && (ob = (smtp_transport_options_block *)tp->options_block)
4519              && ob->hosts_override && ob->hosts
4520              )
4521          && addr->host_list
4522          )
4523         {
4524         host_item * h;
4525         ok = FALSE;
4526         for (h = addr->host_list; h; h = h->next)
4527           if (Ustrcmp(h->name, continue_hostname) == 0)
4528   /*XXX should also check port here */
4529             { ok = TRUE; break; }
4530         }
4531       }
4532
4533     /* Addresses not suitable; defer or queue for fallback hosts (which
4534     might be the continue host) and skip to next address. */
4535
4536     if (!ok)
4537       {
4538       DEBUG(D_deliver) debug_printf("not suitable for continue_transport (%s)\n",
4539         Ustrcmp(continue_transport, tp->name) != 0
4540         ? string_sprintf("tpt %s vs %s", continue_transport, tp->name)
4541         : string_sprintf("no host matching %s", continue_hostname));
4542       if (serialize_key) enq_end(serialize_key);
4543
4544       if (addr->fallback_hosts && !fallback)
4545         {
4546         for (next = addr; ; next = next->next)
4547           {
4548           next->host_list = next->fallback_hosts;
4549           DEBUG(D_deliver) debug_printf("%s queued for fallback host(s)\n", next->address);
4550           if (!next->next) break;
4551           }
4552         next->next = addr_fallback;
4553         addr_fallback = addr;
4554         }
4555
4556       else
4557         {
4558         for (next = addr; ; next = next->next)
4559           {
4560           DEBUG(D_deliver) debug_printf(" %s to def list\n", next->address);
4561           if (!next->next) break;
4562           }
4563         next->next = addr_defer;
4564         addr_defer = addr;
4565         }
4566
4567       continue;
4568       }
4569
4570     /* Set a flag indicating whether there are further addresses that list
4571     the continued host. This tells the transport to leave the channel open,
4572     but not to pass it to another delivery process. We'd like to do that
4573     for non-continue_transport cases too but the knowlege of which host is
4574     connected to is too hard to manage.  Perhaps we need a finer-grain
4575     interface to the transport. */
4576
4577     for (next = addr_remote; next && !continue_more; next = next->next)
4578       {
4579       host_item *h;
4580       for (h = next->host_list; h; h = h->next)
4581         if (Ustrcmp(h->name, continue_hostname) == 0)
4582           { continue_more = TRUE; break; }
4583       }
4584     }
4585
4586   /* The transports set up the process info themselves as they may connect
4587   to more than one remote machine. They also have to set up the filter
4588   arguments, if required, so that the host name and address are available
4589   for expansion. */
4590
4591   transport_filter_argv = NULL;
4592
4593   /* Create the pipe for inter-process communication. If pipe creation
4594   fails, it is probably because the value of remote_max_parallel is so
4595   large that too many file descriptors for pipes have been created. Arrange
4596   to wait for a process to finish, and then try again. If we still can't
4597   create a pipe when all processes have finished, break the retry loop. */
4598
4599   while (!pipe_done)
4600     {
4601     if (pipe(pfd) == 0) pipe_done = TRUE;
4602       else if (parcount > 0) parmax = parcount;
4603         else break;
4604
4605     /* We need to make the reading end of the pipe non-blocking. There are
4606     two different options for this. Exim is cunningly (I hope!) coded so
4607     that it can use either of them, though it prefers O_NONBLOCK, which
4608     distinguishes between EOF and no-more-data. */
4609
4610 #ifdef O_NONBLOCK
4611     (void)fcntl(pfd[pipe_read], F_SETFL, O_NONBLOCK);
4612 #else
4613     (void)fcntl(pfd[pipe_read], F_SETFL, O_NDELAY);
4614 #endif
4615
4616     /* If the maximum number of subprocesses already exist, wait for a process
4617     to finish. If we ran out of file descriptors, parmax will have been reduced
4618     from its initial value of remote_max_parallel. */
4619
4620     par_reduce(parmax - 1, fallback);
4621     }
4622
4623   /* If we failed to create a pipe and there were no processes to wait
4624   for, we have to give up on this one. Do this outside the above loop
4625   so that we can continue the main loop. */
4626
4627   if (!pipe_done)
4628     {
4629     panicmsg = string_sprintf("unable to create pipe: %s", strerror(errno));
4630     goto enq_continue;
4631     }
4632
4633   /* Find a free slot in the pardata list. Must do this after the possible
4634   waiting for processes to finish, because a terminating process will free
4635   up a slot. */
4636
4637   for (poffset = 0; poffset < remote_max_parallel; poffset++)
4638     if (parlist[poffset].pid == 0)
4639       break;
4640
4641   /* If there isn't one, there has been a horrible disaster. */
4642
4643   if (poffset >= remote_max_parallel)
4644     {
4645     (void)close(pfd[pipe_write]);
4646     (void)close(pfd[pipe_read]);
4647     panicmsg = US"Unexpectedly no free subprocess slot";
4648     goto enq_continue;
4649     }
4650
4651   /* Now fork a subprocess to do the remote delivery, but before doing so,
4652   ensure that any cached resources are released so as not to interfere with
4653   what happens in the subprocess. */
4654
4655   search_tidyup();
4656
4657   if ((pid = fork()) == 0)
4658     {
4659     int fd = pfd[pipe_write];
4660     host_item *h;
4661
4662     /* Setting this global in the subprocess means we need never clear it */
4663     transport_name = tp->name;
4664
4665     /* There are weird circumstances in which logging is disabled */
4666     disable_logging = tp->disable_logging;
4667
4668     /* Show pids on debug output if parallelism possible */
4669
4670     if (parmax > 1 && (parcount > 0 || addr_remote))
4671       {
4672       DEBUG(D_any|D_v) debug_selector |= D_pid;
4673       DEBUG(D_deliver) debug_printf("Remote delivery process started\n");
4674       }
4675
4676     /* Reset the random number generator, so different processes don't all
4677     have the same sequence. In the test harness we want different, but
4678     predictable settings for each delivery process, so do something explicit
4679     here rather they rely on the fixed reset in the random number function. */
4680
4681     random_seed = running_in_test_harness ? 42 + 2*delivery_count : 0;
4682
4683     /* Set close-on-exec on the pipe so that it doesn't get passed on to
4684     a new process that may be forked to do another delivery down the same
4685     SMTP connection. */
4686
4687     (void)fcntl(fd, F_SETFD, fcntl(fd, F_GETFD) | FD_CLOEXEC);
4688
4689     /* Close open file descriptors for the pipes of other processes
4690     that are running in parallel. */
4691
4692     for (poffset = 0; poffset < remote_max_parallel; poffset++)
4693       if (parlist[poffset].pid != 0) (void)close(parlist[poffset].fd);
4694
4695     /* This process has inherited a copy of the file descriptor
4696     for the data file, but its file pointer is shared with all the
4697     other processes running in parallel. Therefore, we have to re-open
4698     the file in order to get a new file descriptor with its own
4699     file pointer. We don't need to lock it, as the lock is held by
4700     the parent process. There doesn't seem to be any way of doing
4701     a dup-with-new-file-pointer. */
4702
4703     (void)close(deliver_datafile);
4704     {
4705     uschar * fname = spool_fname(US"input", message_subdir, message_id, US"-D");
4706
4707     if ((deliver_datafile = Uopen(fname,
4708 #ifdef O_CLOEXEC
4709                                         O_CLOEXEC |
4710 #endif
4711                                         O_RDWR | O_APPEND, 0)) < 0)
4712       log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Failed to reopen %s for remote "
4713         "parallel delivery: %s", fname, strerror(errno));
4714     }
4715
4716     /* Set the close-on-exec flag */
4717 #ifndef O_CLOEXEC
4718     (void)fcntl(deliver_datafile, F_SETFD, fcntl(deliver_datafile, F_GETFD) |
4719       FD_CLOEXEC);
4720 #endif
4721
4722     /* Set the uid/gid of this process; bombs out on failure. */
4723
4724     exim_setugid(uid, gid, use_initgroups,
4725       string_sprintf("remote delivery to %s with transport=%s",
4726         addr->address, tp->name));
4727
4728     /* Close the unwanted half of this process' pipe, set the process state,
4729     and run the transport. Afterwards, transport_count will contain the number
4730     of bytes written. */
4731
4732     (void)close(pfd[pipe_read]);
4733     set_process_info("delivering %s using %s", message_id, tp->name);
4734     debug_print_string(tp->debug_string);
4735     if (!(tp->info->code)(addr->transport, addr)) replicate_status(addr);
4736
4737     set_process_info("delivering %s (just run %s for %s%s in subprocess)",
4738       message_id, tp->name, addr->address, addr->next ? ", ..." : "");
4739
4740     /* Ensure any cached resources that we used are now released */
4741
4742     search_tidyup();
4743
4744     /* Pass the result back down the pipe. This is a lot more information
4745     than is needed for a local delivery. We have to send back the error
4746     status for each address, the usability status for each host that is
4747     flagged as unusable, and all the retry items. When TLS is in use, we
4748     send also the cipher and peerdn information. Each type of information
4749     is flagged by an identifying byte, and is then in a fixed format (with
4750     strings terminated by zeros), and there is a final terminator at the
4751     end. The host information and retry information is all attached to
4752     the first address, so that gets sent at the start. */
4753
4754     /* Host unusability information: for most success cases this will
4755     be null. */
4756
4757     for (h = addr->host_list; h; h = h->next)
4758       {
4759       if (!h->address || h->status < hstatus_unusable) continue;
4760       sprintf(CS big_buffer, "%c%c%s", h->status, h->why, h->address);
4761       rmt_dlv_checked_write(fd, 'H', '0', big_buffer, Ustrlen(big_buffer+2) + 3);
4762       }
4763
4764     /* The number of bytes written. This is the same for each address. Even
4765     if we sent several copies of the message down the same connection, the
4766     size of each one is the same, and it's that value we have got because
4767     transport_count gets reset before calling transport_write_message(). */
4768
4769     memcpy(big_buffer, &transport_count, sizeof(transport_count));
4770     rmt_dlv_checked_write(fd, 'S', '0', big_buffer, sizeof(transport_count));
4771
4772     /* Information about what happened to each address. Four item types are
4773     used: an optional 'X' item first, for TLS information, then an optional "C"
4774     item for any client-auth info followed by 'R' items for any retry settings,
4775     and finally an 'A' item for the remaining data. */
4776
4777     for(; addr; addr = addr->next)
4778       {
4779       uschar *ptr;
4780       retry_item *r;
4781
4782       /* The certificate verification status goes into the flags */
4783       if (tls_out.certificate_verified) setflag(addr, af_cert_verified);
4784 #ifdef EXPERIMENTAL_DANE
4785       if (tls_out.dane_verified)        setflag(addr, af_dane_verified);
4786 #endif
4787
4788       /* Use an X item only if there's something to send */
4789 #ifdef SUPPORT_TLS
4790       if (addr->cipher)
4791         {
4792         ptr = big_buffer + sprintf(CS big_buffer, "%.128s", addr->cipher) + 1;
4793         if (!addr->peerdn)
4794           *ptr++ = 0;
4795         else
4796           ptr += sprintf(CS ptr, "%.512s", addr->peerdn) + 1;
4797
4798         rmt_dlv_checked_write(fd, 'X', '1', big_buffer, ptr - big_buffer);
4799         }
4800       else if (continue_proxy_cipher)
4801         {
4802         ptr = big_buffer + sprintf(CS big_buffer, "%.128s", continue_proxy_cipher) + 1;
4803         *ptr++ = 0;
4804         rmt_dlv_checked_write(fd, 'X', '1', big_buffer, ptr - big_buffer);
4805         }
4806
4807       if (addr->peercert)
4808         {
4809         ptr = big_buffer;
4810         if (!tls_export_cert(ptr, big_buffer_size-2, addr->peercert))
4811           while(*ptr++);
4812         else
4813           *ptr++ = 0;
4814         rmt_dlv_checked_write(fd, 'X', '2', big_buffer, ptr - big_buffer);
4815         }
4816       if (addr->ourcert)
4817         {
4818         ptr = big_buffer;
4819         if (!tls_export_cert(ptr, big_buffer_size-2, addr->ourcert))
4820           while(*ptr++);
4821         else
4822           *ptr++ = 0;
4823         rmt_dlv_checked_write(fd, 'X', '3', big_buffer, ptr - big_buffer);
4824         }
4825 # ifndef DISABLE_OCSP
4826       if (addr->ocsp > OCSP_NOT_REQ)
4827         {
4828         ptr = big_buffer + sprintf(CS big_buffer, "%c", addr->ocsp + '0') + 1;
4829         rmt_dlv_checked_write(fd, 'X', '4', big_buffer, ptr - big_buffer);
4830         }
4831 # endif
4832 #endif  /*SUPPORT_TLS*/
4833
4834       if (client_authenticator)
4835         {
4836         ptr = big_buffer + sprintf(CS big_buffer, "%.64s", client_authenticator) + 1;
4837         rmt_dlv_checked_write(fd, 'C', '1', big_buffer, ptr - big_buffer);
4838         }
4839       if (client_authenticated_id)
4840         {
4841         ptr = big_buffer + sprintf(CS big_buffer, "%.64s", client_authenticated_id) + 1;
4842         rmt_dlv_checked_write(fd, 'C', '2', big_buffer, ptr - big_buffer);
4843         }
4844       if (client_authenticated_sender)
4845         {
4846         ptr = big_buffer + sprintf(CS big_buffer, "%.64s", client_authenticated_sender) + 1;
4847         rmt_dlv_checked_write(fd, 'C', '3', big_buffer, ptr - big_buffer);
4848         }
4849
4850 #ifndef DISABLE_PRDR
4851       if (addr->flags & af_prdr_used)
4852         rmt_dlv_checked_write(fd, 'P', '0', NULL, 0);
4853 #endif
4854
4855       if (addr->flags & af_chunking_used)
4856         rmt_dlv_checked_write(fd, 'K', '0', NULL, 0);
4857
4858       memcpy(big_buffer, &addr->dsn_aware, sizeof(addr->dsn_aware));
4859       rmt_dlv_checked_write(fd, 'D', '0', big_buffer, sizeof(addr->dsn_aware));
4860
4861       /* Retry information: for most success cases this will be null. */
4862
4863       for (r = addr->retries; r; r = r->next)
4864         {
4865         sprintf(CS big_buffer, "%c%.500s", r->flags, r->key);
4866         ptr = big_buffer + Ustrlen(big_buffer+2) + 3;
4867         memcpy(ptr, &r->basic_errno, sizeof(r->basic_errno));
4868         ptr += sizeof(r->basic_errno);
4869         memcpy(ptr, &r->more_errno, sizeof(r->more_errno));
4870         ptr += sizeof(r->more_errno);
4871         if (!r->message) *ptr++ = 0; else
4872           {
4873           sprintf(CS ptr, "%.512s", r->message);
4874           while(*ptr++);
4875           }
4876         rmt_dlv_checked_write(fd, 'R', '0', big_buffer, ptr - big_buffer);
4877         }
4878
4879 #ifdef SUPPORT_SOCKS
4880       if (LOGGING(proxy) && proxy_session)
4881         {
4882         ptr = big_buffer;
4883         if (proxy_local_address)
4884           {
4885           DEBUG(D_deliver) debug_printf("proxy_local_address '%s'\n", proxy_local_address);
4886           ptr = big_buffer + sprintf(CS ptr, "%.128s", proxy_local_address) + 1;
4887           DEBUG(D_deliver) debug_printf("proxy_local_port %d\n", proxy_local_port);
4888           memcpy(ptr, &proxy_local_port, sizeof(proxy_local_port));
4889           ptr += sizeof(proxy_local_port);
4890           }
4891         else
4892           *ptr++ = '\0';
4893         rmt_dlv_checked_write(fd, 'A', '2', big_buffer, ptr - big_buffer);
4894         }
4895 #endif
4896
4897 #ifdef EXPERIMENTAL_DSN_INFO
4898 /*um, are they really per-addr?  Other per-conn stuff is not (auth, tls).  But host_used is! */
4899       if (addr->smtp_greeting)
4900         {
4901         DEBUG(D_deliver) debug_printf("smtp_greeting '%s'\n", addr->smtp_greeting);
4902         ptr = big_buffer + sprintf(CS big_buffer, "%.128s", addr->smtp_greeting) + 1;
4903         if (addr->helo_response)
4904           {
4905           DEBUG(D_deliver) debug_printf("helo_response '%s'\n", addr->helo_response);
4906           ptr += sprintf(CS ptr, "%.128s", addr->helo_response) + 1;
4907           }
4908         else
4909           *ptr++ = '\0';
4910         rmt_dlv_checked_write(fd, 'A', '1', big_buffer, ptr - big_buffer);
4911         }
4912 #endif
4913
4914       /* The rest of the information goes in an 'A0' item. */
4915
4916       sprintf(CS big_buffer, "%c%c", addr->transport_return, addr->special_action);
4917       ptr = big_buffer + 2;
4918       memcpy(ptr, &addr->basic_errno, sizeof(addr->basic_errno));
4919       ptr += sizeof(addr->basic_errno);
4920       memcpy(ptr, &addr->more_errno, sizeof(addr->more_errno));
4921       ptr += sizeof(addr->more_errno);
4922       memcpy(ptr, &addr->delivery_usec, sizeof(addr->delivery_usec));
4923       ptr += sizeof(addr->delivery_usec);
4924       memcpy(ptr, &addr->flags, sizeof(addr->flags));
4925       ptr += sizeof(addr->flags);
4926
4927       if (!addr->message) *ptr++ = 0; else
4928         ptr += sprintf(CS ptr, "%.1024s", addr->message) + 1;
4929
4930       if (!addr->user_message) *ptr++ = 0; else
4931         ptr += sprintf(CS ptr, "%.1024s", addr->user_message) + 1;
4932
4933       if (!addr->host_used) *ptr++ = 0; else
4934         {
4935         ptr += sprintf(CS ptr, "%.256s", addr->host_used->name) + 1;
4936         ptr += sprintf(CS ptr, "%.64s", addr->host_used->address) + 1;
4937         memcpy(ptr, &addr->host_used->port, sizeof(addr->host_used->port));
4938         ptr += sizeof(addr->host_used->port);
4939
4940         /* DNS lookup status */
4941         *ptr++ = addr->host_used->dnssec==DS_YES ? '2'
4942                : addr->host_used->dnssec==DS_NO ? '1' : '0';
4943
4944         }
4945       rmt_dlv_checked_write(fd, 'A', '0', big_buffer, ptr - big_buffer);
4946       }
4947
4948     /* Local interface address/port */
4949 #ifdef EXPERIMENTAL_DSN_INFO
4950     if (sending_ip_address)
4951 #else
4952     if (LOGGING(incoming_interface) && sending_ip_address)
4953 #endif
4954       {
4955       uschar * ptr;
4956       ptr = big_buffer + sprintf(CS big_buffer, "%.128s", sending_ip_address) + 1;
4957       ptr += sprintf(CS ptr, "%d", sending_port) + 1;
4958       rmt_dlv_checked_write(fd, 'I', '0', big_buffer, ptr - big_buffer);
4959       }
4960
4961     /* Add termination flag, close the pipe, and that's it. The character
4962     after 'Z' indicates whether continue_transport is now NULL or not.
4963     A change from non-NULL to NULL indicates a problem with a continuing
4964     connection. */
4965
4966     big_buffer[0] = continue_transport ? '1' : '0';
4967     rmt_dlv_checked_write(fd, 'Z', '0', big_buffer, 1);
4968     (void)close(fd);
4969     exit(EXIT_SUCCESS);
4970     }
4971
4972   /* Back in the mainline: close the unwanted half of the pipe. */
4973
4974   (void)close(pfd[pipe_write]);
4975
4976   /* If we have a connection still open from a verify stage (lazy-close)
4977   release its TLS library context (if any) as responsibility was passed to
4978   the delivery child process. */
4979
4980   if (cutthrough.fd >= 0 && cutthrough.callout_hold_only)
4981     {
4982 #ifdef SUPPORT_TLS
4983     tls_close(FALSE, FALSE);
4984 #endif
4985     (void) close(cutthrough.fd);
4986     release_cutthrough_connection(US"passed to transport proc");
4987     }
4988
4989   /* Fork failed; defer with error message */
4990
4991   if (pid < 0)
4992     {
4993     (void)close(pfd[pipe_read]);
4994     panicmsg = string_sprintf("fork failed for remote delivery to %s: %s",
4995         addr->domain, strerror(errno));
4996     goto enq_continue;
4997     }
4998
4999   /* Fork succeeded; increment the count, and remember relevant data for
5000   when the process finishes. */
5001
5002   parcount++;
5003   parlist[poffset].addrlist = parlist[poffset].addr = addr;
5004   parlist[poffset].pid = pid;
5005   parlist[poffset].fd = pfd[pipe_read];
5006   parlist[poffset].done = FALSE;
5007   parlist[poffset].msg = NULL;
5008   parlist[poffset].return_path = return_path;
5009
5010   /* If the process we've just started is sending a message down an existing
5011   channel, wait for it now. This ensures that only one such process runs at
5012   once, whatever the value of remote_max parallel. Otherwise, we might try to
5013   send two or more messages simultaneously down the same channel. This could
5014   happen if there are different domains that include the same host in otherwise
5015   different host lists.
5016
5017   Also, if the transport closes down the channel, this information gets back
5018   (continue_transport gets set to NULL) before we consider any other addresses
5019   in this message. */
5020
5021   if (continue_transport) par_reduce(0, fallback);
5022
5023   /* Otherwise, if we are running in the test harness, wait a bit, to let the
5024   newly created process get going before we create another process. This should
5025   ensure repeatability in the tests. We only need to wait a tad. */
5026
5027   else if (running_in_test_harness) millisleep(500);
5028
5029   continue;
5030
5031 enq_continue:
5032   if (serialize_key) enq_end(serialize_key);
5033 panic_continue:
5034   remote_post_process(addr, LOG_MAIN|LOG_PANIC, panicmsg, fallback);
5035   continue;
5036   }
5037
5038 /* Reached the end of the list of addresses. Wait for all the subprocesses that
5039 are still running and post-process their addresses. */
5040
5041 par_reduce(0, fallback);
5042 return TRUE;
5043 }
5044
5045
5046
5047
5048 /*************************************************
5049 *   Split an address into local part and domain  *
5050 *************************************************/
5051
5052 /* This function initializes an address for routing by splitting it up into a
5053 local part and a domain. The local part is set up twice - once in its original
5054 casing, and once in lower case, and it is dequoted. We also do the "percent
5055 hack" for configured domains. This may lead to a DEFER result if a lookup
5056 defers. When a percent-hacking takes place, we insert a copy of the original
5057 address as a new parent of this address, as if we have had a redirection.
5058
5059 Argument:
5060   addr      points to an addr_item block containing the address
5061
5062 Returns:    OK
5063             DEFER   - could not determine if domain is %-hackable
5064 */
5065
5066 int
5067 deliver_split_address(address_item * addr)
5068 {
5069 uschar * address = addr->address;
5070 uschar * domain;
5071 uschar * t;
5072 int len;
5073
5074 if (!(domain = Ustrrchr(address, '@')))
5075   return DEFER;         /* should always have a domain, but just in case... */
5076
5077 len = domain - address;
5078 addr->domain = string_copylc(domain+1);    /* Domains are always caseless */
5079
5080 /* The implication in the RFCs (though I can't say I've seen it spelled out
5081 explicitly) is that quoting should be removed from local parts at the point
5082 where they are locally interpreted. [The new draft "821" is more explicit on
5083 this, Jan 1999.] We know the syntax is valid, so this can be done by simply
5084 removing quoting backslashes and any unquoted doublequotes. */
5085
5086 t = addr->cc_local_part = store_get(len+1);
5087 while(len-- > 0)
5088   {
5089   int c = *address++;
5090   if (c == '\"') continue;
5091   if (c == '\\')
5092     {
5093     *t++ = *address++;
5094     len--;
5095     }
5096   else *t++ = c;
5097   }
5098 *t = 0;
5099
5100 /* We do the percent hack only for those domains that are listed in
5101 percent_hack_domains. A loop is required, to copy with multiple %-hacks. */
5102
5103 if (percent_hack_domains)
5104   {
5105   int rc;
5106   uschar *new_address = NULL;
5107   uschar *local_part = addr->cc_local_part;
5108
5109   deliver_domain = addr->domain;  /* set $domain */
5110
5111   while (  (rc = match_isinlist(deliver_domain, (const uschar **)&percent_hack_domains, 0,
5112                &domainlist_anchor, addr->domain_cache, MCL_DOMAIN, TRUE, NULL))
5113              == OK
5114         && (t = Ustrrchr(local_part, '%')) != NULL
5115         )
5116     {
5117     new_address = string_copy(local_part);
5118     new_address[t - local_part] = '@';
5119     deliver_domain = string_copylc(t+1);
5120     local_part = string_copyn(local_part, t - local_part);
5121     }
5122
5123   if (rc == DEFER) return DEFER;   /* lookup deferred */
5124
5125   /* If hackery happened, set up new parent and alter the current address. */
5126
5127   if (new_address)
5128     {
5129     address_item *new_parent = store_get(sizeof(address_item));
5130     *new_parent = *addr;
5131     addr->parent = new_parent;
5132     new_parent->child_count = 1;
5133     addr->address = new_address;
5134     addr->unique = string_copy(new_address);
5135     addr->domain = deliver_domain;
5136     addr->cc_local_part = local_part;
5137     DEBUG(D_deliver) debug_printf("%%-hack changed address to: %s\n",
5138       addr->address);
5139     }
5140   }
5141
5142 /* Create the lowercased version of the final local part, and make that the
5143 default one to be used. */
5144
5145 addr->local_part = addr->lc_local_part = string_copylc(addr->cc_local_part);
5146 return OK;
5147 }
5148
5149
5150
5151
5152 /*************************************************
5153 *      Get next error message text               *
5154 *************************************************/
5155
5156 /* If f is not NULL, read the next "paragraph", from a customized error message
5157 text file, terminated by a line containing ****, and expand it.
5158
5159 Arguments:
5160   f          NULL or a file to read from
5161   which      string indicating which string (for errors)
5162
5163 Returns:     NULL or an expanded string
5164 */
5165
5166 static uschar *
5167 next_emf(FILE *f, uschar *which)
5168 {
5169 int size = 256;
5170 int ptr = 0;
5171 uschar *para, *yield;
5172 uschar buffer[256];
5173
5174 if (!f) return NULL;
5175
5176 if (!Ufgets(buffer, sizeof(buffer), f) || Ustrcmp(buffer, "****\n") == 0)
5177   return NULL;
5178
5179 para = store_get(size);
5180 for (;;)
5181   {
5182   para = string_cat(para, &size, &ptr, buffer);
5183   if (!Ufgets(buffer, sizeof(buffer), f) || Ustrcmp(buffer, "****\n") == 0)
5184     break;
5185   }
5186 para[ptr] = 0;
5187
5188 if ((yield = expand_string(para)))
5189   return yield;
5190
5191 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand string from "
5192   "bounce_message_file or warn_message_file (%s): %s", which,
5193   expand_string_message);
5194 return NULL;
5195 }
5196
5197
5198
5199
5200 /*************************************************
5201 *      Close down a passed transport channel     *
5202 *************************************************/
5203
5204 /* This function is called when a passed transport channel cannot be used.
5205 It attempts to close it down tidily. The yield is always DELIVER_NOT_ATTEMPTED
5206 so that the function call can be the argument of a "return" statement.
5207
5208 Arguments:  None
5209 Returns:    DELIVER_NOT_ATTEMPTED
5210 */
5211
5212 static int
5213 continue_closedown(void)
5214 {
5215 if (continue_transport)
5216   {
5217   transport_instance *t;
5218   for (t = transports; t; t = t->next)
5219     if (Ustrcmp(t->name, continue_transport) == 0)
5220       {
5221       if (t->info->closedown) (t->info->closedown)(t);
5222       break;
5223       }
5224   }
5225 return DELIVER_NOT_ATTEMPTED;
5226 }
5227
5228
5229
5230
5231 /*************************************************
5232 *           Print address information            *
5233 *************************************************/
5234
5235 /* This function is called to output an address, or information about an
5236 address, for bounce or defer messages. If the hide_child flag is set, all we
5237 output is the original ancestor address.
5238
5239 Arguments:
5240   addr         points to the address
5241   f            the FILE to print to
5242   si           an initial string
5243   sc           a continuation string for before "generated"
5244   se           an end string
5245
5246 Returns:       TRUE if the address is not hidden
5247 */
5248
5249 static BOOL
5250 print_address_information(address_item *addr, FILE *f, uschar *si, uschar *sc,
5251   uschar *se)
5252 {
5253 BOOL yield = TRUE;
5254 uschar *printed = US"";
5255 address_item *ancestor = addr;
5256 while (ancestor->parent) ancestor = ancestor->parent;
5257
5258 fprintf(f, "%s", CS si);
5259
5260 if (addr->parent && testflag(addr, af_hide_child))
5261   {
5262   printed = US"an undisclosed address";
5263   yield = FALSE;
5264   }
5265 else if (!testflag(addr, af_pfr) || !addr->parent)
5266   printed = addr->address;
5267
5268 else
5269   {
5270   uschar *s = addr->address;
5271   uschar *ss;
5272
5273   if (addr->address[0] == '>') { ss = US"mail"; s++; }
5274   else if (addr->address[0] == '|') ss = US"pipe";
5275   else ss = US"save";
5276
5277   fprintf(f, "%s to %s%sgenerated by ", ss, s, sc);
5278   printed = addr->parent->address;
5279   }
5280
5281 fprintf(f, "%s", CS string_printing(printed));
5282
5283 if (ancestor != addr)
5284   {
5285   uschar *original = ancestor->onetime_parent;
5286   if (!original) original= ancestor->address;
5287   if (strcmpic(original, printed) != 0)
5288     fprintf(f, "%s(%sgenerated from %s)", sc,
5289       ancestor != addr->parent ? "ultimately " : "",
5290       string_printing(original));
5291   }
5292
5293 if (addr->host_used)
5294   fprintf(f, "\n    host %s [%s]",
5295           addr->host_used->name, addr->host_used->address);
5296
5297 fprintf(f, "%s", CS se);
5298 return yield;
5299 }
5300
5301
5302
5303
5304
5305 /*************************************************
5306 *         Print error for an address             *
5307 *************************************************/
5308
5309 /* This function is called to print the error information out of an address for
5310 a bounce or a warning message. It tries to format the message reasonably by
5311 introducing newlines. All lines are indented by 4; the initial printing
5312 position must be set before calling.
5313
5314 This function used always to print the error. Nowadays we want to restrict it
5315 to cases such as LMTP/SMTP errors from a remote host, and errors from :fail:
5316 and filter "fail". We no longer pass other information willy-nilly in bounce
5317 and warning messages. Text in user_message is always output; text in message
5318 only if the af_pass_message flag is set.
5319
5320 Arguments:
5321   addr         the address
5322   f            the FILE to print on
5323   t            some leading text
5324
5325 Returns:       nothing
5326 */
5327
5328 static void
5329 print_address_error(address_item *addr, FILE *f, uschar *t)
5330 {
5331 int count = Ustrlen(t);
5332 uschar *s = testflag(addr, af_pass_message)? addr->message : NULL;
5333
5334 if (!s && !(s = addr->user_message))
5335   return;
5336
5337 fprintf(f, "\n    %s", t);
5338
5339 while (*s)
5340   if (*s == '\\' && s[1] == 'n')
5341     {
5342     fprintf(f, "\n    ");
5343     s += 2;
5344     count = 0;
5345     }
5346   else
5347     {
5348     fputc(*s, f);
5349     count++;
5350     if (*s++ == ':' && isspace(*s) && count > 45)
5351       {
5352       fprintf(f, "\n   ");  /* sic (because space follows) */
5353       count = 0;
5354       }
5355     }
5356 }
5357
5358
5359 /***********************************************************
5360 *         Print Diagnostic-Code for an address             *
5361 ************************************************************/
5362
5363 /* This function is called to print the error information out of an address for
5364 a bounce or a warning message. It tries to format the message reasonably as
5365 required by RFC 3461 by adding a space after each newline
5366
5367 it uses the same logic as print_address_error() above. if af_pass_message is true
5368 and addr->message is set it uses the remote host answer. if not addr->user_message
5369 is used instead if available.
5370
5371 Arguments:
5372   addr         the address
5373   f            the FILE to print on
5374
5375 Returns:       nothing
5376 */
5377
5378 static void
5379 print_dsn_diagnostic_code(const address_item *addr, FILE *f)
5380 {
5381 uschar *s = testflag(addr, af_pass_message) ? addr->message : NULL;
5382
5383 /* af_pass_message and addr->message set ? print remote host answer */
5384 if (s)
5385   {
5386   DEBUG(D_deliver)
5387     debug_printf("DSN Diagnostic-Code: addr->message = %s\n", addr->message);
5388
5389   /* search first ": ". we assume to find the remote-MTA answer there */
5390   if (!(s = Ustrstr(addr->message, ": ")))
5391     return;                             /* not found, bail out */
5392   s += 2;  /* skip ": " */
5393   fprintf(f, "Diagnostic-Code: smtp; ");
5394   }
5395 /* no message available. do nothing */
5396 else return;
5397
5398 while (*s)
5399   if (*s == '\\' && s[1] == 'n')
5400     {
5401     fputs("\n ", f);    /* as defined in RFC 3461 */
5402     s += 2;
5403     }
5404   else
5405     fputc(*s++, f);
5406
5407 fputc('\n', f);
5408 }
5409
5410
5411 /*************************************************
5412 *     Check list of addresses for duplication    *
5413 *************************************************/
5414
5415 /* This function was introduced when the test for duplicate addresses that are
5416 not pipes, files, or autoreplies was moved from the middle of routing to when
5417 routing was complete. That was to fix obscure cases when the routing history
5418 affects the subsequent routing of identical addresses. This function is called
5419 after routing, to check that the final routed addresses are not duplicates.
5420
5421 If we detect a duplicate, we remember what it is a duplicate of. Note that
5422 pipe, file, and autoreply de-duplication is handled during routing, so we must
5423 leave such "addresses" alone here, as otherwise they will incorrectly be
5424 discarded.
5425
5426 Argument:     address of list anchor
5427 Returns:      nothing
5428 */
5429
5430 static void
5431 do_duplicate_check(address_item **anchor)
5432 {
5433 address_item *addr;
5434 while ((addr = *anchor))
5435   {
5436   tree_node *tnode;
5437   if (testflag(addr, af_pfr))
5438     {
5439     anchor = &(addr->next);
5440     }
5441   else if ((tnode = tree_search(tree_duplicates, addr->unique)))
5442     {
5443     DEBUG(D_deliver|D_route)
5444       debug_printf("%s is a duplicate address: discarded\n", addr->unique);
5445     *anchor = addr->next;
5446     addr->dupof = tnode->data.ptr;
5447     addr->next = addr_duplicate;
5448     addr_duplicate = addr;
5449     }
5450   else
5451     {
5452     tree_add_duplicate(addr->unique, addr);
5453     anchor = &(addr->next);
5454     }
5455   }
5456 }
5457
5458
5459
5460
5461 /*************************************************
5462 *              Deliver one message               *
5463 *************************************************/
5464
5465 /* This is the function which is called when a message is to be delivered. It
5466 is passed the id of the message. It is possible that the message no longer
5467 exists, if some other process has delivered it, and it is also possible that
5468 the message is being worked on by another process, in which case the data file
5469 will be locked.
5470
5471 If no delivery is attempted for any of the above reasons, the function returns
5472 DELIVER_NOT_ATTEMPTED.
5473
5474 If the give_up flag is set true, do not attempt any deliveries, but instead
5475 fail all outstanding addresses and return the message to the sender (or
5476 whoever).
5477
5478 A delivery operation has a process all to itself; we never deliver more than
5479 one message in the same process. Therefore we needn't worry too much about
5480 store leakage.
5481
5482 Liable to be called as root.
5483
5484 Arguments:
5485   id          the id of the message to be delivered
5486   forced      TRUE if delivery was forced by an administrator; this overrides
5487               retry delays and causes a delivery to be tried regardless
5488   give_up     TRUE if an administrator has requested that delivery attempts
5489               be abandoned
5490
5491 Returns:      When the global variable mua_wrapper is FALSE:
5492                 DELIVER_ATTEMPTED_NORMAL   if a delivery attempt was made
5493                 DELIVER_NOT_ATTEMPTED      otherwise (see comment above)
5494               When the global variable mua_wrapper is TRUE:
5495                 DELIVER_MUA_SUCCEEDED      if delivery succeeded
5496                 DELIVER_MUA_FAILED         if delivery failed
5497                 DELIVER_NOT_ATTEMPTED      if not attempted (should not occur)
5498 */
5499
5500 int
5501 deliver_message(uschar *id, BOOL forced, BOOL give_up)
5502 {
5503 int i, rc;
5504 int final_yield = DELIVER_ATTEMPTED_NORMAL;
5505 time_t now = time(NULL);
5506 address_item *addr_last = NULL;
5507 uschar *filter_message = NULL;
5508 int process_recipients = RECIP_ACCEPT;
5509 open_db dbblock;
5510 open_db *dbm_file;
5511 extern int acl_where;
5512
5513 uschar *info = queue_run_pid == (pid_t)0
5514   ? string_sprintf("delivering %s", id)
5515   : string_sprintf("delivering %s (queue run pid %d)", id, queue_run_pid);
5516
5517 /* If the D_process_info bit is on, set_process_info() will output debugging
5518 information. If not, we want to show this initial information if D_deliver or
5519 D_queue_run is set or in verbose mode. */
5520
5521 set_process_info("%s", info);
5522
5523 if (  !(debug_selector & D_process_info)
5524    && (debug_selector & (D_deliver|D_queue_run|D_v))
5525    )
5526   debug_printf("%s\n", info);
5527
5528 /* Ensure that we catch any subprocesses that are created. Although Exim
5529 sets SIG_DFL as its initial default, some routes through the code end up
5530 here with it set to SIG_IGN - cases where a non-synchronous delivery process
5531 has been forked, but no re-exec has been done. We use sigaction rather than
5532 plain signal() on those OS where SA_NOCLDWAIT exists, because we want to be
5533 sure it is turned off. (There was a problem on AIX with this.) */
5534
5535 #ifdef SA_NOCLDWAIT
5536   {
5537   struct sigaction act;
5538   act.sa_handler = SIG_DFL;
5539   sigemptyset(&(act.sa_mask));
5540   act.sa_flags = 0;
5541   sigaction(SIGCHLD, &act, NULL);
5542   }
5543 #else
5544 signal(SIGCHLD, SIG_DFL);
5545 #endif
5546
5547 /* Make the forcing flag available for routers and transports, set up the
5548 global message id field, and initialize the count for returned files and the
5549 message size. This use of strcpy() is OK because the length id is checked when
5550 it is obtained from a command line (the -M or -q options), and otherwise it is
5551 known to be a valid message id. */
5552
5553 Ustrcpy(message_id, id);
5554 deliver_force = forced;
5555 return_count = 0;
5556 message_size = 0;
5557
5558 /* Initialize some flags */
5559
5560 update_spool = FALSE;
5561 remove_journal = TRUE;
5562
5563 /* Set a known context for any ACLs we call via expansions */
5564 acl_where = ACL_WHERE_DELIVERY;
5565
5566 /* Reset the random number generator, so that if several delivery processes are
5567 started from a queue runner that has already used random numbers (for sorting),
5568 they don't all get the same sequence. */
5569
5570 random_seed = 0;
5571
5572 /* Open and lock the message's data file. Exim locks on this one because the
5573 header file may get replaced as it is re-written during the delivery process.
5574 Any failures cause messages to be written to the log, except for missing files
5575 while queue running - another process probably completed delivery. As part of
5576 opening the data file, message_subdir gets set. */
5577
5578 if ((deliver_datafile = spool_open_datafile(id)) < 0)
5579   return continue_closedown();  /* yields DELIVER_NOT_ATTEMPTED */
5580
5581 /* The value of message_size at this point has been set to the data length,
5582 plus one for the blank line that notionally precedes the data. */
5583
5584 /* Now read the contents of the header file, which will set up the headers in
5585 store, and also the list of recipients and the tree of non-recipients and
5586 assorted flags. It updates message_size. If there is a reading or format error,
5587 give up; if the message has been around for sufficiently long, remove it. */
5588
5589   {
5590   uschar * spoolname = string_sprintf("%s-H", id);
5591   if ((rc = spool_read_header(spoolname, TRUE, TRUE)) != spool_read_OK)
5592     {
5593     if (errno == ERRNO_SPOOLFORMAT)
5594       {
5595       struct stat statbuf;
5596       if (Ustat(spool_fname(US"input", message_subdir, spoolname, US""),
5597                 &statbuf) == 0)
5598         log_write(0, LOG_MAIN, "Format error in spool file %s: "
5599           "size=" OFF_T_FMT, spoolname, statbuf.st_size);
5600       else
5601         log_write(0, LOG_MAIN, "Format error in spool file %s", spoolname);
5602       }
5603     else
5604       log_write(0, LOG_MAIN, "Error reading spool file %s: %s", spoolname,
5605         strerror(errno));
5606
5607     /* If we managed to read the envelope data, received_time contains the
5608     time the message was received. Otherwise, we can calculate it from the
5609     message id. */
5610
5611     if (rc != spool_read_hdrerror)
5612       {
5613       received_time.tv_sec = received_time.tv_usec = 0;
5614       /*XXX subsec precision?*/
5615       for (i = 0; i < 6; i++)
5616         received_time.tv_sec = received_time.tv_sec * BASE_62 + tab62[id[i] - '0'];
5617       }
5618
5619     /* If we've had this malformed message too long, sling it. */
5620
5621     if (now - received_time.tv_sec > keep_malformed)
5622       {
5623       Uunlink(spool_fname(US"msglog", message_subdir, id, US""));
5624       Uunlink(spool_fname(US"input", message_subdir, id, US"-D"));
5625       Uunlink(spool_fname(US"input", message_subdir, id, US"-H"));
5626       Uunlink(spool_fname(US"input", message_subdir, id, US"-J"));
5627       log_write(0, LOG_MAIN, "Message removed because older than %s",
5628         readconf_printtime(keep_malformed));
5629       }
5630
5631     (void)close(deliver_datafile);
5632     deliver_datafile = -1;
5633     return continue_closedown();   /* yields DELIVER_NOT_ATTEMPTED */
5634     }
5635   }
5636
5637 /* The spool header file has been read. Look to see if there is an existing
5638 journal file for this message. If there is, it means that a previous delivery
5639 attempt crashed (program or host) before it could update the spool header file.
5640 Read the list of delivered addresses from the journal and add them to the
5641 nonrecipients tree. Then update the spool file. We can leave the journal in
5642 existence, as it will get further successful deliveries added to it in this
5643 run, and it will be deleted if this function gets to its end successfully.
5644 Otherwise it might be needed again. */
5645
5646   {
5647   uschar * fname = spool_fname(US"input", message_subdir, id, US"-J");
5648   FILE * jread;
5649
5650   if (  (journal_fd = Uopen(fname, O_RDWR|O_APPEND
5651 #ifdef O_CLOEXEC
5652                                     | O_CLOEXEC
5653 #endif
5654 #ifdef O_NOFOLLOW
5655                                     | O_NOFOLLOW
5656 #endif
5657         , SPOOL_MODE)) >= 0
5658      && lseek(journal_fd, 0, SEEK_SET) == 0
5659      && (jread = fdopen(journal_fd, "rb"))
5660      )
5661     {
5662     while (Ufgets(big_buffer, big_buffer_size, jread))
5663       {
5664       int n = Ustrlen(big_buffer);
5665       big_buffer[n-1] = 0;
5666       tree_add_nonrecipient(big_buffer);
5667       DEBUG(D_deliver) debug_printf("Previously delivered address %s taken from "
5668         "journal file\n", big_buffer);
5669       }
5670     rewind(jread);
5671     if ((journal_fd = dup(fileno(jread))) < 0)
5672       journal_fd = fileno(jread);
5673     else
5674       (void) fclose(jread);     /* Try to not leak the FILE resource */
5675
5676     /* Panic-dies on error */
5677     (void)spool_write_header(message_id, SW_DELIVERING, NULL);
5678     }
5679   else if (errno != ENOENT)
5680     {
5681     log_write(0, LOG_MAIN|LOG_PANIC, "attempt to open journal for reading gave: "
5682       "%s", strerror(errno));
5683     return continue_closedown();   /* yields DELIVER_NOT_ATTEMPTED */
5684     }
5685
5686   /* A null recipients list indicates some kind of disaster. */
5687
5688   if (!recipients_list)
5689     {
5690     (void)close(deliver_datafile);
5691     deliver_datafile = -1;
5692     log_write(0, LOG_MAIN, "Spool error: no recipients for %s", fname);
5693     return continue_closedown();   /* yields DELIVER_NOT_ATTEMPTED */
5694     }
5695   }
5696
5697
5698 /* Handle a message that is frozen. There are a number of different things that
5699 can happen, but in the default situation, unless forced, no delivery is
5700 attempted. */
5701
5702 if (deliver_freeze)
5703   {
5704 #ifdef SUPPORT_MOVE_FROZEN_MESSAGES
5705   /* Moving to another directory removes the message from Exim's view. Other
5706   tools must be used to deal with it. Logging of this action happens in
5707   spool_move_message() and its subfunctions. */
5708
5709   if (  move_frozen_messages
5710      && spool_move_message(id, message_subdir, US"", US"F")
5711      )
5712     return continue_closedown();   /* yields DELIVER_NOT_ATTEMPTED */
5713 #endif
5714
5715   /* For all frozen messages (bounces or not), timeout_frozen_after sets the
5716   maximum time to keep messages that are frozen. Thaw if we reach it, with a
5717   flag causing all recipients to be failed. The time is the age of the
5718   message, not the time since freezing. */
5719
5720   if (timeout_frozen_after > 0 && message_age >= timeout_frozen_after)
5721     {
5722     log_write(0, LOG_MAIN, "cancelled by timeout_frozen_after");
5723     process_recipients = RECIP_FAIL_TIMEOUT;
5724     }
5725
5726   /* For bounce messages (and others with no sender), thaw if the error message
5727   ignore timer is exceeded. The message will be discarded if this delivery
5728   fails. */
5729
5730   else if (!*sender_address && message_age >= ignore_bounce_errors_after)
5731     log_write(0, LOG_MAIN, "Unfrozen by errmsg timer");
5732
5733   /* If this is a bounce message, or there's no auto thaw, or we haven't
5734   reached the auto thaw time yet, and this delivery is not forced by an admin
5735   user, do not attempt delivery of this message. Note that forced is set for
5736   continuing messages down the same channel, in order to skip load checking and
5737   ignore hold domains, but we don't want unfreezing in that case. */
5738
5739   else
5740     {
5741     if (  (  sender_address[0] == 0
5742           || auto_thaw <= 0
5743           || now <= deliver_frozen_at + auto_thaw
5744           )
5745        && (  !forced || !deliver_force_thaw
5746           || !admin_user || continue_hostname
5747        )  )
5748       {
5749       (void)close(deliver_datafile);
5750       deliver_datafile = -1;
5751       log_write(L_skip_delivery, LOG_MAIN, "Message is frozen");
5752       return continue_closedown();   /* yields DELIVER_NOT_ATTEMPTED */
5753       }
5754
5755     /* If delivery was forced (by an admin user), assume a manual thaw.
5756     Otherwise it's an auto thaw. */
5757
5758     if (forced)
5759       {
5760       deliver_manual_thaw = TRUE;
5761       log_write(0, LOG_MAIN, "Unfrozen by forced delivery");
5762       }
5763     else log_write(0, LOG_MAIN, "Unfrozen by auto-thaw");
5764     }
5765
5766   /* We get here if any of the rules for unfreezing have triggered. */
5767
5768   deliver_freeze = FALSE;
5769   update_spool = TRUE;
5770   }
5771
5772
5773 /* Open the message log file if we are using them. This records details of
5774 deliveries, deferments, and failures for the benefit of the mail administrator.
5775 The log is not used by exim itself to track the progress of a message; that is
5776 done by rewriting the header spool file. */
5777
5778 if (message_logs)
5779   {
5780   uschar * fname = spool_fname(US"msglog", message_subdir, id, US"");
5781   uschar * error;
5782   int fd;
5783
5784   if ((fd = open_msglog_file(fname, SPOOL_MODE, &error)) < 0)
5785     {
5786     log_write(0, LOG_MAIN|LOG_PANIC, "Couldn't %s message log %s: %s", error,
5787       fname, strerror(errno));
5788     return continue_closedown();   /* yields DELIVER_NOT_ATTEMPTED */
5789     }
5790
5791   /* Make a C stream out of it. */
5792
5793   if (!(message_log = fdopen(fd, "a")))
5794     {
5795     log_write(0, LOG_MAIN|LOG_PANIC, "Couldn't fdopen message log %s: %s",
5796       fname, strerror(errno));
5797     return continue_closedown();   /* yields DELIVER_NOT_ATTEMPTED */
5798     }
5799   }
5800
5801
5802 /* If asked to give up on a message, log who did it, and set the action for all
5803 the addresses. */
5804
5805 if (give_up)
5806   {
5807   struct passwd *pw = getpwuid(real_uid);
5808   log_write(0, LOG_MAIN, "cancelled by %s",
5809       pw ? US pw->pw_name : string_sprintf("uid %ld", (long int)real_uid));
5810   process_recipients = RECIP_FAIL;
5811   }
5812
5813 /* Otherwise, if there are too many Received: headers, fail all recipients. */
5814
5815 else if (received_count > received_headers_max)
5816   process_recipients = RECIP_FAIL_LOOP;
5817
5818 /* Otherwise, if a system-wide, address-independent message filter is
5819 specified, run it now, except in the case when we are failing all recipients as
5820 a result of timeout_frozen_after. If the system filter yields "delivered", then
5821 ignore the true recipients of the message. Failure of the filter file is
5822 logged, and the delivery attempt fails. */
5823
5824 else if (system_filter && process_recipients != RECIP_FAIL_TIMEOUT)
5825   {
5826   int rc;
5827   int filtertype;
5828   ugid_block ugid;
5829   redirect_block redirect;
5830
5831   if (system_filter_uid_set)
5832     {
5833     ugid.uid = system_filter_uid;
5834     ugid.gid = system_filter_gid;
5835     ugid.uid_set = ugid.gid_set = TRUE;
5836     }
5837   else
5838     {
5839     ugid.uid_set = ugid.gid_set = FALSE;
5840     }
5841
5842   return_path = sender_address;
5843   enable_dollar_recipients = TRUE;   /* Permit $recipients in system filter */
5844   system_filtering = TRUE;
5845
5846   /* Any error in the filter file causes a delivery to be abandoned. */
5847
5848   redirect.string = system_filter;
5849   redirect.isfile = TRUE;
5850   redirect.check_owner = redirect.check_group = FALSE;
5851   redirect.owners = NULL;
5852   redirect.owngroups = NULL;
5853   redirect.pw = NULL;
5854   redirect.modemask = 0;
5855
5856   DEBUG(D_deliver|D_filter) debug_printf("running system filter\n");
5857
5858   rc = rda_interpret(
5859     &redirect,              /* Where the data is */
5860     RDO_DEFER |             /* Turn on all the enabling options */
5861       RDO_FAIL |            /* Leave off all the disabling options */
5862       RDO_FILTER |
5863       RDO_FREEZE |
5864       RDO_REALLOG |
5865       RDO_REWRITE,
5866     NULL,                   /* No :include: restriction (not used in filter) */
5867     NULL,                   /* No sieve vacation directory (not sieve!) */
5868     NULL,                   /* No sieve enotify mailto owner (not sieve!) */
5869     NULL,                   /* No sieve user address (not sieve!) */
5870     NULL,                   /* No sieve subaddress (not sieve!) */
5871     &ugid,                  /* uid/gid data */
5872     &addr_new,              /* Where to hang generated addresses */
5873     &filter_message,        /* Where to put error message */
5874     NULL,                   /* Don't skip syntax errors */
5875     &filtertype,            /* Will always be set to FILTER_EXIM for this call */
5876     US"system filter");     /* For error messages */
5877
5878   DEBUG(D_deliver|D_filter) debug_printf("system filter returned %d\n", rc);
5879
5880   if (rc == FF_ERROR || rc == FF_NONEXIST)
5881     {
5882     (void)close(deliver_datafile);
5883     deliver_datafile = -1;
5884     log_write(0, LOG_MAIN|LOG_PANIC, "Error in system filter: %s",
5885       string_printing(filter_message));
5886     return continue_closedown();   /* yields DELIVER_NOT_ATTEMPTED */
5887     }
5888
5889   /* Reset things. If the filter message is an empty string, which can happen
5890   for a filter "fail" or "freeze" command with no text, reset it to NULL. */
5891
5892   system_filtering = FALSE;
5893   enable_dollar_recipients = FALSE;
5894   if (filter_message && filter_message[0] == 0) filter_message = NULL;
5895
5896   /* Save the values of the system filter variables so that user filters
5897   can use them. */
5898
5899   memcpy(filter_sn, filter_n, sizeof(filter_sn));
5900
5901   /* The filter can request that delivery of the original addresses be
5902   deferred. */
5903
5904   if (rc == FF_DEFER)
5905     {
5906     process_recipients = RECIP_DEFER;
5907     deliver_msglog("Delivery deferred by system filter\n");
5908     log_write(0, LOG_MAIN, "Delivery deferred by system filter");
5909     }
5910
5911   /* The filter can request that a message be frozen, but this does not
5912   take place if the message has been manually thawed. In that case, we must
5913   unset "delivered", which is forced by the "freeze" command to make -bF
5914   work properly. */
5915
5916   else if (rc == FF_FREEZE && !deliver_manual_thaw)
5917     {
5918     deliver_freeze = TRUE;
5919     deliver_frozen_at = time(NULL);
5920     process_recipients = RECIP_DEFER;
5921     frozen_info = string_sprintf(" by the system filter%s%s",
5922       filter_message ? US": " : US"",
5923       filter_message ? filter_message : US"");
5924     }
5925
5926   /* The filter can request that a message be failed. The error message may be
5927   quite long - it is sent back to the sender in the bounce - but we don't want
5928   to fill up the log with repetitions of it. If it starts with << then the text
5929   between << and >> is written to the log, with the rest left for the bounce
5930   message. */
5931
5932   else if (rc == FF_FAIL)
5933     {
5934     uschar *colon = US"";
5935     uschar *logmsg = US"";
5936     int loglen = 0;
5937
5938     process_recipients = RECIP_FAIL_FILTER;
5939
5940     if (filter_message)
5941       {
5942       uschar *logend;
5943       colon = US": ";
5944       if (  filter_message[0] == '<'
5945          && filter_message[1] == '<'
5946          && (logend = Ustrstr(filter_message, ">>"))
5947          )
5948         {
5949         logmsg = filter_message + 2;
5950         loglen = logend - logmsg;
5951         filter_message = logend + 2;
5952         if (filter_message[0] == 0) filter_message = NULL;
5953         }
5954       else
5955         {
5956         logmsg = filter_message;
5957         loglen = Ustrlen(filter_message);
5958         }
5959       }
5960
5961     log_write(0, LOG_MAIN, "cancelled by system filter%s%.*s", colon, loglen,
5962       logmsg);
5963     }
5964
5965   /* Delivery can be restricted only to those recipients (if any) that the
5966   filter specified. */
5967
5968   else if (rc == FF_DELIVERED)
5969     {
5970     process_recipients = RECIP_IGNORE;
5971     if (addr_new)
5972       log_write(0, LOG_MAIN, "original recipients ignored (system filter)");
5973     else
5974       log_write(0, LOG_MAIN, "=> discarded (system filter)");
5975     }
5976
5977   /* If any new addresses were created by the filter, fake up a "parent"
5978   for them. This is necessary for pipes, etc., which are expected to have
5979   parents, and it also gives some sensible logging for others. Allow
5980   pipes, files, and autoreplies, and run them as the filter uid if set,
5981   otherwise as the current uid. */
5982
5983   if (addr_new)
5984     {
5985     int uid = (system_filter_uid_set)? system_filter_uid : geteuid();
5986     int gid = (system_filter_gid_set)? system_filter_gid : getegid();
5987
5988     /* The text "system-filter" is tested in transport_set_up_command() and in
5989     set_up_shell_command() in the pipe transport, to enable them to permit
5990     $recipients, so don't change it here without also changing it there. */
5991
5992     address_item *p = addr_new;
5993     address_item *parent = deliver_make_addr(US"system-filter", FALSE);
5994
5995     parent->domain = string_copylc(qualify_domain_recipient);
5996     parent->local_part = US"system-filter";
5997
5998     /* As part of this loop, we arrange for addr_last to end up pointing
5999     at the final address. This is used if we go on to add addresses for the
6000     original recipients. */
6001
6002     while (p)
6003       {
6004       if (parent->child_count == USHRT_MAX)
6005         log_write(0, LOG_MAIN|LOG_PANIC_DIE, "system filter generated more "
6006           "than %d delivery addresses", USHRT_MAX);
6007       parent->child_count++;
6008       p->parent = parent;
6009
6010       if (testflag(p, af_pfr))
6011         {
6012         uschar *tpname;
6013         uschar *type;
6014         p->uid = uid;
6015         p->gid = gid;
6016         setflag(p, af_uid_set |
6017                    af_gid_set |
6018                    af_allow_file |
6019                    af_allow_pipe |
6020                    af_allow_reply);
6021
6022         /* Find the name of the system filter's appropriate pfr transport */
6023
6024         if (p->address[0] == '|')
6025           {
6026           type = US"pipe";
6027           tpname = system_filter_pipe_transport;
6028           address_pipe = p->address;
6029           }
6030         else if (p->address[0] == '>')
6031           {
6032           type = US"reply";
6033           tpname = system_filter_reply_transport;
6034           }
6035         else
6036           {
6037           if (p->address[Ustrlen(p->address)-1] == '/')
6038             {
6039             type = US"directory";
6040             tpname = system_filter_directory_transport;
6041             }
6042           else
6043             {
6044             type = US"file";
6045             tpname = system_filter_file_transport;
6046             }
6047           address_file = p->address;
6048           }
6049
6050         /* Now find the actual transport, first expanding the name. We have
6051         set address_file or address_pipe above. */
6052
6053         if (tpname)
6054           {
6055           uschar *tmp = expand_string(tpname);
6056           address_file = address_pipe = NULL;
6057           if (!tmp)
6058             p->message = string_sprintf("failed to expand \"%s\" as a "
6059               "system filter transport name", tpname);
6060           tpname = tmp;
6061           }
6062         else
6063           p->message = string_sprintf("system_filter_%s_transport is unset",
6064             type);
6065
6066         if (tpname)
6067           {
6068           transport_instance *tp;
6069           for (tp = transports; tp; tp = tp->next)
6070             if (Ustrcmp(tp->name, tpname) == 0)
6071               {
6072               p->transport = tp;
6073               break;
6074               }
6075           if (!tp)
6076             p->message = string_sprintf("failed to find \"%s\" transport "
6077               "for system filter delivery", tpname);
6078           }
6079
6080         /* If we couldn't set up a transport, defer the delivery, putting the
6081         error on the panic log as well as the main log. */
6082
6083         if (!p->transport)
6084           {
6085           address_item *badp = p;
6086           p = p->next;
6087           if (!addr_last) addr_new = p; else addr_last->next = p;
6088           badp->local_part = badp->address;   /* Needed for log line */
6089           post_process_one(badp, DEFER, LOG_MAIN|LOG_PANIC, DTYPE_ROUTER, 0);
6090           continue;
6091           }
6092         }    /* End of pfr handling */
6093
6094       /* Either a non-pfr delivery, or we found a transport */
6095
6096       DEBUG(D_deliver|D_filter)
6097         debug_printf("system filter added %s\n", p->address);
6098
6099       addr_last = p;
6100       p = p->next;
6101       }    /* Loop through all addr_new addresses */
6102     }
6103   }
6104
6105
6106 /* Scan the recipients list, and for every one that is not in the non-
6107 recipients tree, add an addr item to the chain of new addresses. If the pno
6108 value is non-negative, we must set the onetime parent from it. This which
6109 points to the relevant entry in the recipients list.
6110
6111 This processing can be altered by the setting of the process_recipients
6112 variable, which is changed if recipients are to be ignored, failed, or
6113 deferred. This can happen as a result of system filter activity, or if the -Mg
6114 option is used to fail all of them.
6115
6116 Duplicate addresses are handled later by a different tree structure; we can't
6117 just extend the non-recipients tree, because that will be re-written to the
6118 spool if the message is deferred, and in any case there are casing
6119 complications for local addresses. */
6120
6121 if (process_recipients != RECIP_IGNORE)
6122   for (i = 0; i < recipients_count; i++)
6123     if (!tree_search(tree_nonrecipients, recipients_list[i].address))
6124       {
6125       recipient_item *r = recipients_list + i;
6126       address_item *new = deliver_make_addr(r->address, FALSE);
6127       new->prop.errors_address = r->errors_to;
6128 #ifdef SUPPORT_I18N
6129       if ((new->prop.utf8_msg = message_smtputf8))
6130         {
6131         new->prop.utf8_downcvt =       message_utf8_downconvert == 1;
6132         new->prop.utf8_downcvt_maybe = message_utf8_downconvert == -1;
6133         DEBUG(D_deliver) debug_printf("utf8, downconvert %s\n",
6134           new->prop.utf8_downcvt ? "yes"
6135           : new->prop.utf8_downcvt_maybe ? "ifneeded"
6136           : "no");
6137         }
6138 #endif
6139
6140       if (r->pno >= 0)
6141         new->onetime_parent = recipients_list[r->pno].address;
6142
6143       /* If DSN support is enabled, set the dsn flags and the original receipt
6144          to be passed on to other DSN enabled MTAs */
6145       new->dsn_flags = r->dsn_flags & rf_dsnflags;
6146       new->dsn_orcpt = r->orcpt;
6147       DEBUG(D_deliver) debug_printf("DSN: set orcpt: %s  flags: %d\n",
6148         new->dsn_orcpt, new->dsn_flags);
6149
6150       switch (process_recipients)
6151         {
6152         /* RECIP_DEFER is set when a system filter freezes a message. */
6153
6154         case RECIP_DEFER:
6155         new->next = addr_defer;
6156         addr_defer = new;
6157         break;
6158
6159
6160         /* RECIP_FAIL_FILTER is set when a system filter has obeyed a "fail"
6161         command. */
6162
6163         case RECIP_FAIL_FILTER:
6164         new->message =
6165           filter_message ? filter_message : US"delivery cancelled";
6166         setflag(new, af_pass_message);
6167         goto RECIP_QUEUE_FAILED;   /* below */
6168
6169
6170         /* RECIP_FAIL_TIMEOUT is set when a message is frozen, but is older
6171         than the value in timeout_frozen_after. Treat non-bounce messages
6172         similarly to -Mg; for bounce messages we just want to discard, so
6173         don't put the address on the failed list. The timeout has already
6174         been logged. */
6175
6176         case RECIP_FAIL_TIMEOUT:
6177         new->message  = US"delivery cancelled; message timed out";
6178         goto RECIP_QUEUE_FAILED;   /* below */
6179
6180
6181         /* RECIP_FAIL is set when -Mg has been used. */
6182
6183         case RECIP_FAIL:
6184         new->message  = US"delivery cancelled by administrator";
6185         /* Fall through */
6186
6187         /* Common code for the failure cases above. If this is not a bounce
6188         message, put the address on the failed list so that it is used to
6189         create a bounce. Otherwise do nothing - this just discards the address.
6190         The incident has already been logged. */
6191
6192         RECIP_QUEUE_FAILED:
6193         if (sender_address[0] != 0)
6194           {
6195           new->next = addr_failed;
6196           addr_failed = new;
6197           }
6198         break;
6199
6200
6201         /* RECIP_FAIL_LOOP is set when there are too many Received: headers
6202         in the message. Process each address as a routing failure; if this
6203         is a bounce message, it will get frozen. */
6204
6205         case RECIP_FAIL_LOOP:
6206         new->message = US"Too many \"Received\" headers - suspected mail loop";
6207         post_process_one(new, FAIL, LOG_MAIN, DTYPE_ROUTER, 0);
6208         break;
6209
6210
6211         /* Value should be RECIP_ACCEPT; take this as the safe default. */
6212
6213         default:
6214         if (!addr_new) addr_new = new; else addr_last->next = new;
6215         addr_last = new;
6216         break;
6217         }
6218
6219 #ifndef DISABLE_EVENT
6220       if (process_recipients != RECIP_ACCEPT)
6221         {
6222         uschar * save_local =  deliver_localpart;
6223         const uschar * save_domain = deliver_domain;
6224
6225         deliver_localpart = expand_string(
6226                       string_sprintf("${local_part:%s}", new->address));
6227         deliver_domain =    expand_string(
6228                       string_sprintf("${domain:%s}", new->address));
6229
6230         (void) event_raise(event_action,
6231                       US"msg:fail:internal", new->message);
6232
6233         deliver_localpart = save_local;
6234         deliver_domain =    save_domain;
6235         }
6236 #endif
6237       }
6238
6239 DEBUG(D_deliver)
6240   {
6241   address_item *p;
6242   debug_printf("Delivery address list:\n");
6243   for (p = addr_new; p; p = p->next)
6244     debug_printf("  %s %s\n", p->address,
6245       p->onetime_parent ? p->onetime_parent : US"");
6246   }
6247
6248 /* Set up the buffers used for copying over the file when delivering. */
6249
6250 deliver_in_buffer = store_malloc(DELIVER_IN_BUFFER_SIZE);
6251 deliver_out_buffer = store_malloc(DELIVER_OUT_BUFFER_SIZE);
6252
6253
6254
6255 /* Until there are no more new addresses, handle each one as follows:
6256
6257  . If this is a generated address (indicated by the presence of a parent
6258    pointer) then check to see whether it is a pipe, file, or autoreply, and
6259    if so, handle it directly here. The router that produced the address will
6260    have set the allow flags into the address, and also set the uid/gid required.
6261    Having the routers generate new addresses and then checking them here at
6262    the outer level is tidier than making each router do the checking, and
6263    means that routers don't need access to the failed address queue.
6264
6265  . Break up the address into local part and domain, and make lowercased
6266    versions of these strings. We also make unquoted versions of the local part.
6267
6268  . Handle the percent hack for those domains for which it is valid.
6269
6270  . For child addresses, determine if any of the parents have the same address.
6271    If so, generate a different string for previous delivery checking. Without
6272    this code, if the address spqr generates spqr via a forward or alias file,
6273    delivery of the generated spqr stops further attempts at the top level spqr,
6274    which is not what is wanted - it may have generated other addresses.
6275
6276  . Check on the retry database to see if routing was previously deferred, but
6277    only if in a queue run. Addresses that are to be routed are put on the
6278    addr_route chain. Addresses that are to be deferred are put on the
6279    addr_defer chain. We do all the checking first, so as not to keep the
6280    retry database open any longer than necessary.
6281
6282  . Now we run the addresses through the routers. A router may put the address
6283    on either the addr_local or the addr_remote chain for local or remote
6284    delivery, respectively, or put it on the addr_failed chain if it is
6285    undeliveable, or it may generate child addresses and put them on the
6286    addr_new chain, or it may defer an address. All the chain anchors are
6287    passed as arguments so that the routers can be called for verification
6288    purposes as well.
6289
6290  . If new addresses have been generated by the routers, da capo.
6291 */
6292
6293 header_rewritten = FALSE;          /* No headers rewritten yet */
6294 while (addr_new)           /* Loop until all addresses dealt with */
6295   {
6296   address_item *addr, *parent;
6297
6298   /* Failure to open the retry database is treated the same as if it does
6299   not exist. In both cases, dbm_file is NULL. */
6300
6301   if (!(dbm_file = dbfn_open(US"retry", O_RDONLY, &dbblock, FALSE)))
6302     DEBUG(D_deliver|D_retry|D_route|D_hints_lookup)
6303       debug_printf("no retry data available\n");
6304
6305   /* Scan the current batch of new addresses, to handle pipes, files and
6306   autoreplies, and determine which others are ready for routing. */
6307
6308   while (addr_new)
6309     {
6310     int rc;
6311     uschar *p;
6312     tree_node *tnode;
6313     dbdata_retry *domain_retry_record;
6314     dbdata_retry *address_retry_record;
6315
6316     addr = addr_new;
6317     addr_new = addr->next;
6318
6319     DEBUG(D_deliver|D_retry|D_route)
6320       {
6321       debug_printf(">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>\n");
6322       debug_printf("Considering: %s\n", addr->address);
6323       }
6324
6325     /* Handle generated address that is a pipe or a file or an autoreply. */
6326
6327     if (testflag(addr, af_pfr))
6328       {
6329       /* If an autoreply in a filter could not generate a syntactically valid
6330       address, give up forthwith. Set af_ignore_error so that we don't try to
6331       generate a bounce. */
6332
6333       if (testflag(addr, af_bad_reply))
6334         {
6335         addr->basic_errno = ERRNO_BADADDRESS2;
6336         addr->local_part = addr->address;
6337         addr->message =
6338           US"filter autoreply generated syntactically invalid recipient";
6339         setflag(addr, af_ignore_error);
6340         (void)post_process_one(addr, FAIL, LOG_MAIN, DTYPE_ROUTER, 0);
6341         continue;   /* with the next new address */
6342         }
6343
6344       /* If two different users specify delivery to the same pipe or file or
6345       autoreply, there should be two different deliveries, so build a unique
6346       string that incorporates the original address, and use this for
6347       duplicate testing and recording delivery, and also for retrying. */
6348
6349       addr->unique =
6350         string_sprintf("%s:%s", addr->address, addr->parent->unique +
6351           (testflag(addr->parent, af_homonym)? 3:0));
6352
6353       addr->address_retry_key = addr->domain_retry_key =
6354         string_sprintf("T:%s", addr->unique);
6355
6356       /* If a filter file specifies two deliveries to the same pipe or file,
6357       we want to de-duplicate, but this is probably not wanted for two mail
6358       commands to the same address, where probably both should be delivered.
6359       So, we have to invent a different unique string in that case. Just
6360       keep piling '>' characters on the front. */
6361
6362       if (addr->address[0] == '>')
6363         {
6364         while (tree_search(tree_duplicates, addr->unique))
6365           addr->unique = string_sprintf(">%s", addr->unique);
6366         }
6367
6368       else if ((tnode = tree_search(tree_duplicates, addr->unique)))
6369         {
6370         DEBUG(D_deliver|D_route)
6371           debug_printf("%s is a duplicate address: discarded\n", addr->address);
6372         addr->dupof = tnode->data.ptr;
6373         addr->next = addr_duplicate;
6374         addr_duplicate = addr;
6375         continue;
6376         }
6377
6378       DEBUG(D_deliver|D_route) debug_printf("unique = %s\n", addr->unique);
6379
6380       /* Check for previous delivery */
6381
6382       if (tree_search(tree_nonrecipients, addr->unique))
6383         {
6384         DEBUG(D_deliver|D_route)
6385           debug_printf("%s was previously delivered: discarded\n", addr->address);
6386         child_done(addr, tod_stamp(tod_log));
6387         continue;
6388         }
6389
6390       /* Save for checking future duplicates */
6391
6392       tree_add_duplicate(addr->unique, addr);
6393
6394       /* Set local part and domain */
6395
6396       addr->local_part = addr->address;
6397       addr->domain = addr->parent->domain;
6398
6399       /* Ensure that the delivery is permitted. */
6400
6401       if (testflag(addr, af_file))
6402         {
6403         if (!testflag(addr, af_allow_file))
6404           {
6405           addr->basic_errno = ERRNO_FORBIDFILE;
6406           addr->message = US"delivery to file forbidden";
6407           (void)post_process_one(addr, FAIL, LOG_MAIN, DTYPE_ROUTER, 0);
6408           continue;   /* with the next new address */
6409           }
6410         }
6411       else if (addr->address[0] == '|')
6412         {
6413         if (!testflag(addr, af_allow_pipe))
6414           {
6415           addr->basic_errno = ERRNO_FORBIDPIPE;
6416           addr->message = US"delivery to pipe forbidden";
6417           (void)post_process_one(addr, FAIL, LOG_MAIN, DTYPE_ROUTER, 0);
6418           continue;   /* with the next new address */
6419           }
6420         }
6421       else if (!testflag(addr, af_allow_reply))
6422         {
6423         addr->basic_errno = ERRNO_FORBIDREPLY;
6424         addr->message = US"autoreply forbidden";
6425         (void)post_process_one(addr, FAIL, LOG_MAIN, DTYPE_ROUTER, 0);
6426         continue;     /* with the next new address */
6427         }
6428
6429       /* If the errno field is already set to BADTRANSPORT, it indicates
6430       failure to expand a transport string, or find the associated transport,
6431       or an unset transport when one is required. Leave this test till now so
6432       that the forbid errors are given in preference. */
6433
6434       if (addr->basic_errno == ERRNO_BADTRANSPORT)
6435         {
6436         (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_ROUTER, 0);
6437         continue;
6438         }
6439
6440       /* Treat /dev/null as a special case and abandon the delivery. This
6441       avoids having to specify a uid on the transport just for this case.
6442       Arrange for the transport name to be logged as "**bypassed**". */
6443
6444       if (Ustrcmp(addr->address, "/dev/null") == 0)
6445         {
6446         uschar *save = addr->transport->name;
6447         addr->transport->name = US"**bypassed**";
6448         (void)post_process_one(addr, OK, LOG_MAIN, DTYPE_TRANSPORT, '=');
6449         addr->transport->name = save;
6450         continue;   /* with the next new address */
6451         }
6452
6453       /* Pipe, file, or autoreply delivery is to go ahead as a normal local
6454       delivery. */
6455
6456       DEBUG(D_deliver|D_route)
6457         debug_printf("queued for %s transport\n", addr->transport->name);
6458       addr->next = addr_local;
6459       addr_local = addr;
6460       continue;       /* with the next new address */
6461       }
6462
6463     /* Handle normal addresses. First, split up into local part and domain,
6464     handling the %-hack if necessary. There is the possibility of a defer from
6465     a lookup in percent_hack_domains. */
6466
6467     if ((rc = deliver_split_address(addr)) == DEFER)
6468       {
6469       addr->message = US"cannot check percent_hack_domains";
6470       addr->basic_errno = ERRNO_LISTDEFER;
6471       (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_NONE, 0);
6472       continue;
6473       }
6474
6475     /* Check to see if the domain is held. If so, proceed only if the
6476     delivery was forced by hand. */
6477
6478     deliver_domain = addr->domain;  /* set $domain */
6479     if (  !forced && hold_domains
6480        && (rc = match_isinlist(addr->domain, (const uschar **)&hold_domains, 0,
6481            &domainlist_anchor, addr->domain_cache, MCL_DOMAIN, TRUE,
6482            NULL)) != FAIL
6483        )
6484       {
6485       if (rc == DEFER)
6486         {
6487         addr->message = US"hold_domains lookup deferred";
6488         addr->basic_errno = ERRNO_LISTDEFER;
6489         }
6490       else
6491         {
6492         addr->message = US"domain is held";
6493         addr->basic_errno = ERRNO_HELD;
6494         }
6495       (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_NONE, 0);
6496       continue;
6497       }
6498
6499     /* Now we can check for duplicates and previously delivered addresses. In
6500     order to do this, we have to generate a "unique" value for each address,
6501     because there may be identical actual addresses in a line of descendents.
6502     The "unique" field is initialized to the same value as the "address" field,
6503     but gets changed here to cope with identically-named descendents. */
6504
6505     for (parent = addr->parent; parent; parent = parent->parent)
6506       if (strcmpic(addr->address, parent->address) == 0) break;
6507
6508     /* If there's an ancestor with the same name, set the homonym flag. This
6509     influences how deliveries are recorded. Then add a prefix on the front of
6510     the unique address. We use \n\ where n starts at 0 and increases each time.
6511     It is unlikely to pass 9, but if it does, it may look odd but will still
6512     work. This means that siblings or cousins with the same names are treated
6513     as duplicates, which is what we want. */
6514
6515     if (parent)
6516       {
6517       setflag(addr, af_homonym);
6518       if (parent->unique[0] != '\\')
6519         addr->unique = string_sprintf("\\0\\%s", addr->address);
6520       else
6521         addr->unique = string_sprintf("\\%c\\%s", parent->unique[1] + 1,
6522           addr->address);
6523       }
6524
6525     /* Ensure that the domain in the unique field is lower cased, because
6526     domains are always handled caselessly. */
6527
6528     p = Ustrrchr(addr->unique, '@');
6529     while (*p != 0) { *p = tolower(*p); p++; }
6530
6531     DEBUG(D_deliver|D_route) debug_printf("unique = %s\n", addr->unique);
6532
6533     if (tree_search(tree_nonrecipients, addr->unique))
6534       {
6535       DEBUG(D_deliver|D_route)
6536         debug_printf("%s was previously delivered: discarded\n", addr->unique);
6537       child_done(addr, tod_stamp(tod_log));
6538       continue;
6539       }
6540
6541     /* Get the routing retry status, saving the two retry keys (with and
6542     without the local part) for subsequent use. If there is no retry record for
6543     the standard address routing retry key, we look for the same key with the
6544     sender attached, because this form is used by the smtp transport after a
6545     4xx response to RCPT when address_retry_include_sender is true. */
6546
6547     addr->domain_retry_key = string_sprintf("R:%s", addr->domain);
6548     addr->address_retry_key = string_sprintf("R:%s@%s", addr->local_part,
6549       addr->domain);
6550
6551     if (dbm_file)
6552       {
6553       domain_retry_record = dbfn_read(dbm_file, addr->domain_retry_key);
6554       if (  domain_retry_record
6555          && now - domain_retry_record->time_stamp > retry_data_expire
6556          )
6557         domain_retry_record = NULL;    /* Ignore if too old */
6558
6559       address_retry_record = dbfn_read(dbm_file, addr->address_retry_key);
6560       if (  address_retry_record
6561          && now - address_retry_record->time_stamp > retry_data_expire
6562          )
6563         address_retry_record = NULL;   /* Ignore if too old */
6564
6565       if (!address_retry_record)
6566         {
6567         uschar *altkey = string_sprintf("%s:<%s>", addr->address_retry_key,
6568           sender_address);
6569         address_retry_record = dbfn_read(dbm_file, altkey);
6570         if (  address_retry_record
6571            && now - address_retry_record->time_stamp > retry_data_expire)
6572           address_retry_record = NULL;   /* Ignore if too old */
6573         }
6574       }
6575     else
6576       domain_retry_record = address_retry_record = NULL;
6577
6578     DEBUG(D_deliver|D_retry)
6579       {
6580       if (!domain_retry_record)
6581         debug_printf("no domain retry record\n");
6582       if (!address_retry_record)
6583         debug_printf("no address retry record\n");
6584       }
6585
6586     /* If we are sending a message down an existing SMTP connection, we must
6587     assume that the message which created the connection managed to route
6588     an address to that connection. We do not want to run the risk of taking
6589     a long time over routing here, because if we do, the server at the other
6590     end of the connection may time it out. This is especially true for messages
6591     with lots of addresses. For this kind of delivery, queue_running is not
6592     set, so we would normally route all addresses. We take a pragmatic approach
6593     and defer routing any addresses that have any kind of domain retry record.
6594     That is, we don't even look at their retry times. It doesn't matter if this
6595     doesn't work occasionally. This is all just an optimization, after all.
6596
6597     The reason for not doing the same for address retries is that they normally
6598     arise from 4xx responses, not DNS timeouts. */
6599
6600     if (continue_hostname && domain_retry_record)
6601       {
6602       addr->message = US"reusing SMTP connection skips previous routing defer";
6603       addr->basic_errno = ERRNO_RRETRY;
6604       (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_ROUTER, 0);
6605       }
6606
6607     /* If we are in a queue run, defer routing unless there is no retry data or
6608     we've passed the next retry time, or this message is forced. In other
6609     words, ignore retry data when not in a queue run.
6610
6611     However, if the domain retry time has expired, always allow the routing
6612     attempt. If it fails again, the address will be failed. This ensures that
6613     each address is routed at least once, even after long-term routing
6614     failures.
6615
6616     If there is an address retry, check that too; just wait for the next
6617     retry time. This helps with the case when the temporary error on the
6618     address was really message-specific rather than address specific, since
6619     it allows other messages through.
6620
6621     We also wait for the next retry time if this is a message sent down an
6622     existing SMTP connection (even though that will be forced). Otherwise there
6623     will be far too many attempts for an address that gets a 4xx error. In
6624     fact, after such an error, we should not get here because, the host should
6625     not be remembered as one this message needs. However, there was a bug that
6626     used to cause this to  happen, so it is best to be on the safe side.
6627
6628     Even if we haven't reached the retry time in the hints, there is one more
6629     check to do, which is for the ultimate address timeout. We only do this
6630     check if there is an address retry record and there is not a domain retry
6631     record; this implies that previous attempts to handle the address had the
6632     retry_use_local_parts option turned on. We use this as an approximation
6633     for the destination being like a local delivery, for example delivery over
6634     LMTP to an IMAP message store. In this situation users are liable to bump
6635     into their quota and thereby have intermittently successful deliveries,
6636     which keep the retry record fresh, which can lead to us perpetually
6637     deferring messages. */
6638
6639     else if (  (  queue_running && !deliver_force
6640                || continue_hostname
6641                )
6642             && (  (  domain_retry_record
6643                   && now < domain_retry_record->next_try
6644                   && !domain_retry_record->expired
6645                   )
6646                || (  address_retry_record
6647                   && now < address_retry_record->next_try
6648                )  )
6649             && (  domain_retry_record
6650                || !address_retry_record
6651                || !retry_ultimate_address_timeout(addr->address_retry_key,
6652                                  addr->domain, address_retry_record, now)
6653             )  )
6654       {
6655       addr->message = US"retry time not reached";
6656       addr->basic_errno = ERRNO_RRETRY;
6657       (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_ROUTER, 0);
6658       }
6659
6660     /* The domain is OK for routing. Remember if retry data exists so it
6661     can be cleaned up after a successful delivery. */
6662
6663     else
6664       {
6665       if (domain_retry_record || address_retry_record)
6666         setflag(addr, af_dr_retry_exists);
6667       addr->next = addr_route;
6668       addr_route = addr;
6669       DEBUG(D_deliver|D_route)
6670         debug_printf("%s: queued for routing\n", addr->address);
6671       }
6672     }
6673
6674   /* The database is closed while routing is actually happening. Requests to
6675   update it are put on a chain and all processed together at the end. */
6676
6677   if (dbm_file) dbfn_close(dbm_file);
6678
6679   /* If queue_domains is set, we don't even want to try routing addresses in
6680   those domains. During queue runs, queue_domains is forced to be unset.
6681   Optimize by skipping this pass through the addresses if nothing is set. */
6682
6683   if (!deliver_force && queue_domains)
6684     {
6685     address_item *okaddr = NULL;
6686     while (addr_route)
6687       {
6688       address_item *addr = addr_route;
6689       addr_route = addr->next;
6690
6691       deliver_domain = addr->domain;  /* set $domain */
6692       if ((rc = match_isinlist(addr->domain, (const uschar **)&queue_domains, 0,
6693             &domainlist_anchor, addr->domain_cache, MCL_DOMAIN, TRUE, NULL))
6694               != OK)
6695         if (rc == DEFER)
6696           {
6697           addr->basic_errno = ERRNO_LISTDEFER;
6698           addr->message = US"queue_domains lookup deferred";
6699           (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_ROUTER, 0);
6700           }
6701         else
6702           {
6703           addr->next = okaddr;
6704           okaddr = addr;
6705           }
6706       else
6707         {
6708         addr->basic_errno = ERRNO_QUEUE_DOMAIN;
6709         addr->message = US"domain is in queue_domains";
6710         (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_ROUTER, 0);
6711         }
6712       }
6713
6714     addr_route = okaddr;
6715     }
6716
6717   /* Now route those addresses that are not deferred. */
6718
6719   while (addr_route)
6720     {
6721     int rc;
6722     address_item *addr = addr_route;
6723     const uschar *old_domain = addr->domain;
6724     uschar *old_unique = addr->unique;
6725     addr_route = addr->next;
6726     addr->next = NULL;
6727
6728     /* Just in case some router parameter refers to it. */
6729
6730     if (!(return_path = addr->prop.errors_address))
6731       return_path = sender_address;
6732
6733     /* If a router defers an address, add a retry item. Whether or not to
6734     use the local part in the key is a property of the router. */
6735
6736     if ((rc = route_address(addr, &addr_local, &addr_remote, &addr_new,
6737          &addr_succeed, v_none)) == DEFER)
6738       retry_add_item(addr,
6739         addr->router->retry_use_local_part
6740         ? string_sprintf("R:%s@%s", addr->local_part, addr->domain)
6741         : string_sprintf("R:%s", addr->domain),
6742         0);
6743
6744     /* Otherwise, if there is an existing retry record in the database, add
6745     retry items to delete both forms. We must also allow for the possibility
6746     of a routing retry that includes the sender address. Since the domain might
6747     have been rewritten (expanded to fully qualified) as a result of routing,
6748     ensure that the rewritten form is also deleted. */
6749
6750     else if (testflag(addr, af_dr_retry_exists))
6751       {
6752       uschar *altkey = string_sprintf("%s:<%s>", addr->address_retry_key,
6753         sender_address);
6754       retry_add_item(addr, altkey, rf_delete);
6755       retry_add_item(addr, addr->address_retry_key, rf_delete);
6756       retry_add_item(addr, addr->domain_retry_key, rf_delete);
6757       if (Ustrcmp(addr->domain, old_domain) != 0)
6758         retry_add_item(addr, string_sprintf("R:%s", old_domain), rf_delete);
6759       }
6760
6761     /* DISCARD is given for :blackhole: and "seen finish". The event has been
6762     logged, but we need to ensure the address (and maybe parents) is marked
6763     done. */
6764
6765     if (rc == DISCARD)
6766       {
6767       address_done(addr, tod_stamp(tod_log));
6768       continue;  /* route next address */
6769       }
6770
6771     /* The address is finished with (failed or deferred). */
6772
6773     if (rc != OK)
6774       {
6775       (void)post_process_one(addr, rc, LOG_MAIN, DTYPE_ROUTER, 0);
6776       continue;  /* route next address */
6777       }
6778
6779     /* The address has been routed. If the router changed the domain, it will
6780     also have changed the unique address. We have to test whether this address
6781     has already been delivered, because it's the unique address that finally
6782     gets recorded. */
6783
6784     if (  addr->unique != old_unique
6785        && tree_search(tree_nonrecipients, addr->unique) != 0
6786        )
6787       {
6788       DEBUG(D_deliver|D_route) debug_printf("%s was previously delivered: "
6789         "discarded\n", addr->address);
6790       if (addr_remote == addr) addr_remote = addr->next;
6791       else if (addr_local == addr) addr_local = addr->next;
6792       }
6793
6794     /* If the router has same_domain_copy_routing set, we are permitted to copy
6795     the routing for any other addresses with the same domain. This is an
6796     optimisation to save repeated DNS lookups for "standard" remote domain
6797     routing. The option is settable only on routers that generate host lists.
6798     We play it very safe, and do the optimization only if the address is routed
6799     to a remote transport, there are no header changes, and the domain was not
6800     modified by the router. */
6801
6802     if (  addr_remote == addr
6803        && addr->router->same_domain_copy_routing
6804        && !addr->prop.extra_headers
6805        && !addr->prop.remove_headers
6806        && old_domain == addr->domain
6807        )
6808       {
6809       address_item **chain = &addr_route;
6810       while (*chain)
6811         {
6812         address_item *addr2 = *chain;
6813         if (Ustrcmp(addr2->domain, addr->domain) != 0)
6814           {
6815           chain = &(addr2->next);
6816           continue;
6817           }
6818
6819         /* Found a suitable address; take it off the routing list and add it to
6820         the remote delivery list. */
6821
6822         *chain = addr2->next;
6823         addr2->next = addr_remote;
6824         addr_remote = addr2;
6825
6826         /* Copy the routing data */
6827
6828         addr2->domain = addr->domain;
6829         addr2->router = addr->router;
6830         addr2->transport = addr->transport;
6831         addr2->host_list = addr->host_list;
6832         addr2->fallback_hosts = addr->fallback_hosts;
6833         addr2->prop.errors_address = addr->prop.errors_address;
6834         copyflag(addr2, addr, af_hide_child | af_local_host_removed);
6835
6836         DEBUG(D_deliver|D_route)
6837           {
6838           debug_printf(">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>\n"
6839                        "routing %s\n"
6840                        "Routing for %s copied from %s\n",
6841             addr2->address, addr2->address, addr->address);
6842           }
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        && !testflag(addr_failed, af_ignore_error))
7408       {
7409       log_write(0, LOG_MAIN|LOG_PANIC, "internal error: bounce message "
7410         "failure is neither frozen nor ignored (it's been ignored)");
7411       }
7412     setflag(addr_failed, af_ignore_error);
7413     }
7414
7415   /* If the first address on the list has af_ignore_error set, just remove
7416   it from the list, throw away any saved message file, log it, and
7417   mark the recipient done. */
7418
7419   if (  testflag(addr_failed, af_ignore_error)
7420      || (  addr_failed->dsn_flags & rf_dsnflags
7421         && (addr_failed->dsn_flags & rf_notify_failure) != rf_notify_failure
7422      )  )
7423     {
7424     addr = addr_failed;
7425     addr_failed = addr->next;
7426     if (addr->return_filename) Uunlink(addr->return_filename);
7427
7428     log_write(0, LOG_MAIN, "%s%s%s%s: error ignored",
7429       addr->address,
7430       !addr->parent ? US"" : US" <",
7431       !addr->parent ? US"" : addr->parent->address,
7432       !addr->parent ? US"" : US">");
7433
7434     address_done(addr, logtod);
7435     child_done(addr, logtod);
7436     /* Panic-dies on error */
7437     (void)spool_write_header(message_id, SW_DELIVERING, NULL);
7438     }
7439
7440   /* Otherwise, handle the sending of a message. Find the error address for
7441   the first address, then send a message that includes all failed addresses
7442   that have the same error address. Note the bounce_recipient is a global so
7443   that it can be accessed by $bounce_recipient while creating a customized
7444   error message. */
7445
7446   else
7447     {
7448     if (!(bounce_recipient = addr_failed->prop.errors_address))
7449       bounce_recipient = sender_address;
7450
7451     /* Make a subprocess to send a message */
7452
7453     if ((pid = child_open_exim(&fd)) < 0)
7454       log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Process %d (parent %d) failed to "
7455         "create child process to send failure message: %s", getpid(),
7456         getppid(), strerror(errno));
7457
7458     /* Creation of child succeeded */
7459
7460     else
7461       {
7462       int ch, rc;
7463       int filecount = 0;
7464       int rcount = 0;
7465       uschar *bcc, *emf_text;
7466       FILE *f = fdopen(fd, "wb");
7467       FILE *emf = NULL;
7468       BOOL to_sender = strcmpic(sender_address, bounce_recipient) == 0;
7469       int max = (bounce_return_size_limit/DELIVER_IN_BUFFER_SIZE + 1) *
7470         DELIVER_IN_BUFFER_SIZE;
7471       uschar * bound;
7472       uschar *dsnlimitmsg;
7473       uschar *dsnnotifyhdr;
7474       int topt;
7475
7476       DEBUG(D_deliver)
7477         debug_printf("sending error message to: %s\n", bounce_recipient);
7478
7479       /* Scan the addresses for all that have the same errors address, removing
7480       them from the addr_failed chain, and putting them on msgchain. */
7481
7482       paddr = &addr_failed;
7483       for (addr = addr_failed; addr; addr = *paddr)
7484         if (Ustrcmp(bounce_recipient, addr->prop.errors_address
7485               ? addr->prop.errors_address : sender_address) == 0)
7486           {                          /* The same - dechain */
7487           *paddr = addr->next;
7488           *pmsgchain = addr;
7489           addr->next = NULL;
7490           pmsgchain = &(addr->next);
7491           }
7492         else
7493           paddr = &addr->next;        /* Not the same; skip */
7494
7495       /* Include X-Failed-Recipients: for automatic interpretation, but do
7496       not let any one header line get too long. We do this by starting a
7497       new header every 50 recipients. Omit any addresses for which the
7498       "hide_child" flag is set. */
7499
7500       for (addr = msgchain; addr; addr = addr->next)
7501         {
7502         if (testflag(addr, af_hide_child)) continue;
7503         if (rcount >= 50)
7504           {
7505           fprintf(f, "\n");
7506           rcount = 0;
7507           }
7508         fprintf(f, "%s%s",
7509           rcount++ == 0
7510           ? "X-Failed-Recipients: "
7511           : ",\n  ",
7512           testflag(addr, af_pfr) && addr->parent
7513           ? string_printing(addr->parent->address)
7514           : string_printing(addr->address));
7515         }
7516       if (rcount > 0) fprintf(f, "\n");
7517
7518       /* Output the standard headers */
7519
7520       if (errors_reply_to)
7521         fprintf(f, "Reply-To: %s\n", errors_reply_to);
7522       fprintf(f, "Auto-Submitted: auto-replied\n");
7523       moan_write_from(f);
7524       fprintf(f, "To: %s\n", bounce_recipient);
7525
7526       /* generate boundary string and output MIME-Headers */
7527       bound = string_sprintf(TIME_T_FMT "-eximdsn-%d", time(NULL), rand());
7528
7529       fprintf(f, "Content-Type: multipart/report;"
7530             " report-type=delivery-status; boundary=%s\n"
7531           "MIME-Version: 1.0\n",
7532         bound);
7533
7534       /* Open a template file if one is provided. Log failure to open, but
7535       carry on - default texts will be used. */
7536
7537       if (bounce_message_file)
7538         if (!(emf = Ufopen(bounce_message_file, "rb")))
7539           log_write(0, LOG_MAIN|LOG_PANIC, "Failed to open %s for error "
7540             "message texts: %s", bounce_message_file, strerror(errno));
7541
7542       /* Quietly copy to configured additional addresses if required. */
7543
7544       if ((bcc = moan_check_errorcopy(bounce_recipient)))
7545         fprintf(f, "Bcc: %s\n", bcc);
7546
7547       /* The texts for the message can be read from a template file; if there
7548       isn't one, or if it is too short, built-in texts are used. The first
7549       emf text is a Subject: and any other headers. */
7550
7551       if ((emf_text = next_emf(emf, US"header")))
7552         fprintf(f, "%s\n", emf_text);
7553       else
7554         fprintf(f, "Subject: Mail delivery failed%s\n\n",
7555           to_sender? ": returning message to sender" : "");
7556
7557       /* output human readable part as text/plain section */
7558       fprintf(f, "--%s\n"
7559           "Content-type: text/plain; charset=us-ascii\n\n",
7560         bound);
7561
7562       if ((emf_text = next_emf(emf, US"intro")))
7563         fprintf(f, "%s", CS emf_text);
7564       else
7565         {
7566         fprintf(f,
7567 /* This message has been reworded several times. It seems to be confusing to
7568 somebody, however it is worded. I have retreated to the original, simple
7569 wording. */
7570 "This message was created automatically by mail delivery software.\n");
7571
7572         if (bounce_message_text)
7573           fprintf(f, "%s", CS bounce_message_text);
7574         if (to_sender)
7575           fprintf(f,
7576 "\nA message that you sent could not be delivered to one or more of its\n"
7577 "recipients. This is a permanent error. The following address(es) failed:\n");
7578         else
7579           fprintf(f,
7580 "\nA message sent by\n\n  <%s>\n\n"
7581 "could not be delivered to one or more of its recipients. The following\n"
7582 "address(es) failed:\n", sender_address);
7583         }
7584       fputc('\n', f);
7585
7586       /* Process the addresses, leaving them on the msgchain if they have a
7587       file name for a return message. (There has already been a check in
7588       post_process_one() for the existence of data in the message file.) A TRUE
7589       return from print_address_information() means that the address is not
7590       hidden. */
7591
7592       paddr = &msgchain;
7593       for (addr = msgchain; addr; addr = *paddr)
7594         {
7595         if (print_address_information(addr, f, US"  ", US"\n    ", US""))
7596           print_address_error(addr, f, US"");
7597
7598         /* End the final line for the address */
7599
7600         fputc('\n', f);
7601
7602         /* Leave on msgchain if there's a return file. */
7603
7604         if (addr->return_file >= 0)
7605           {
7606           paddr = &(addr->next);
7607           filecount++;
7608           }
7609
7610         /* Else save so that we can tick off the recipient when the
7611         message is sent. */
7612
7613         else
7614           {
7615           *paddr = addr->next;
7616           addr->next = handled_addr;
7617           handled_addr = addr;
7618           }
7619         }
7620
7621       fputc('\n', f);
7622
7623       /* Get the next text, whether we need it or not, so as to be
7624       positioned for the one after. */
7625
7626       emf_text = next_emf(emf, US"generated text");
7627
7628       /* If there were any file messages passed by the local transports,
7629       include them in the message. Then put the address on the handled chain.
7630       In the case of a batch of addresses that were all sent to the same
7631       transport, the return_file field in all of them will contain the same
7632       fd, and the return_filename field in the *last* one will be set (to the
7633       name of the file). */
7634
7635       if (msgchain)
7636         {
7637         address_item *nextaddr;
7638
7639         if (emf_text)
7640           fprintf(f, "%s", CS emf_text);
7641         else
7642           fprintf(f,
7643             "The following text was generated during the delivery "
7644             "attempt%s:\n", (filecount > 1)? "s" : "");
7645
7646         for (addr = msgchain; addr; addr = nextaddr)
7647           {
7648           FILE *fm;
7649           address_item *topaddr = addr;
7650
7651           /* List all the addresses that relate to this file */
7652
7653           fputc('\n', f);
7654           while(addr)                   /* Insurance */
7655             {
7656             print_address_information(addr, f, US"------ ",  US"\n       ",
7657               US" ------\n");
7658             if (addr->return_filename) break;
7659             addr = addr->next;
7660             }
7661           fputc('\n', f);
7662
7663           /* Now copy the file */
7664
7665           if (!(fm = Ufopen(addr->return_filename, "rb")))
7666             fprintf(f, "    +++ Exim error... failed to open text file: %s\n",
7667               strerror(errno));
7668           else
7669             {
7670             while ((ch = fgetc(fm)) != EOF) fputc(ch, f);
7671             (void)fclose(fm);
7672             }
7673           Uunlink(addr->return_filename);
7674
7675           /* Can now add to handled chain, first fishing off the next
7676           address on the msgchain. */
7677
7678           nextaddr = addr->next;
7679           addr->next = handled_addr;
7680           handled_addr = topaddr;
7681           }
7682         fputc('\n', f);
7683         }
7684
7685       /* output machine readable part */
7686 #ifdef SUPPORT_I18N
7687       if (message_smtputf8)
7688         fprintf(f, "--%s\n"
7689             "Content-type: message/global-delivery-status\n\n"
7690             "Reporting-MTA: dns; %s\n",
7691           bound, smtp_active_hostname);
7692       else
7693 #endif
7694         fprintf(f, "--%s\n"
7695             "Content-type: message/delivery-status\n\n"
7696             "Reporting-MTA: dns; %s\n",
7697           bound, smtp_active_hostname);
7698
7699       if (dsn_envid)
7700         {
7701         /* must be decoded from xtext: see RFC 3461:6.3a */
7702         uschar *xdec_envid;
7703         if (auth_xtextdecode(dsn_envid, &xdec_envid) > 0)
7704           fprintf(f, "Original-Envelope-ID: %s\n", dsn_envid);
7705         else
7706           fprintf(f, "X-Original-Envelope-ID: error decoding xtext formatted ENVID\n");
7707         }
7708       fputc('\n', f);
7709
7710       for (addr = handled_addr; addr; addr = addr->next)
7711         {
7712         host_item * hu;
7713         fprintf(f, "Action: failed\n"
7714             "Final-Recipient: rfc822;%s\n"
7715             "Status: 5.0.0\n",
7716             addr->address);
7717         if ((hu = addr->host_used) && hu->name)
7718           {
7719           const uschar * s;
7720           fprintf(f, "Remote-MTA: dns; %s\n", hu->name);
7721 #ifdef EXPERIMENTAL_DSN_INFO
7722           if (hu->address)
7723             {
7724             uschar * p = hu->port == 25
7725               ? US"" : string_sprintf(":%d", hu->port);
7726             fprintf(f, "Remote-MTA: X-ip; [%s]%s\n", hu->address, p);
7727             }
7728           if ((s = addr->smtp_greeting) && *s)
7729             fprintf(f, "X-Remote-MTA-smtp-greeting: X-str; %s\n", s);
7730           if ((s = addr->helo_response) && *s)
7731             fprintf(f, "X-Remote-MTA-helo-response: X-str; %s\n", s);
7732           if ((s = addr->message) && *s)
7733             fprintf(f, "X-Exim-Diagnostic: X-str; %s\n", s);
7734 #endif
7735           print_dsn_diagnostic_code(addr, f);
7736           }
7737         fputc('\n', f);
7738         }
7739
7740       /* Now copy the message, trying to give an intelligible comment if
7741       it is too long for it all to be copied. The limit isn't strictly
7742       applied because of the buffering. There is, however, an option
7743       to suppress copying altogether. */
7744
7745       emf_text = next_emf(emf, US"copy");
7746
7747       /* add message body
7748          we ignore the intro text from template and add
7749          the text for bounce_return_size_limit at the end.
7750
7751          bounce_return_message is ignored
7752          in case RET= is defined we honor these values
7753          otherwise bounce_return_body is honored.
7754
7755          bounce_return_size_limit is always honored.
7756       */
7757
7758       fprintf(f, "--%s\n", bound);
7759
7760       dsnlimitmsg = US"X-Exim-DSN-Information: Due to administrative limits only headers are returned";
7761       dsnnotifyhdr = NULL;
7762       topt = topt_add_return_path;
7763
7764       /* RET=HDRS? top priority */
7765       if (dsn_ret == dsn_ret_hdrs)
7766         topt |= topt_no_body;
7767       else
7768         {
7769         struct stat statbuf;
7770
7771         /* no full body return at all? */
7772         if (!bounce_return_body)
7773           {
7774           topt |= topt_no_body;
7775           /* add header if we overrule RET=FULL */
7776           if (dsn_ret == dsn_ret_full)
7777             dsnnotifyhdr = dsnlimitmsg;
7778           }
7779         /* line length limited... return headers only if oversize */
7780         /* size limited ... return headers only if limit reached */
7781         else if (  max_received_linelength > bounce_return_linesize_limit
7782                 || (  bounce_return_size_limit > 0
7783                    && fstat(deliver_datafile, &statbuf) == 0
7784                    && statbuf.st_size > max
7785                 )  )
7786           {
7787           topt |= topt_no_body;
7788           dsnnotifyhdr = dsnlimitmsg;
7789           }
7790         }
7791
7792 #ifdef SUPPORT_I18N
7793       if (message_smtputf8)
7794         fputs(topt & topt_no_body ? "Content-type: message/global-headers\n\n"
7795                                   : "Content-type: message/global\n\n",
7796               f);
7797       else
7798 #endif
7799         fputs(topt & topt_no_body ? "Content-type: text/rfc822-headers\n\n"
7800                                   : "Content-type: message/rfc822\n\n",
7801               f);
7802
7803       fflush(f);
7804       transport_filter_argv = NULL;   /* Just in case */
7805       return_path = sender_address;   /* In case not previously set */
7806         {                             /* Dummy transport for headers add */
7807         transport_ctx tctx = {{0}};
7808         transport_instance tb = {0};
7809
7810         tctx.u.fd = fileno(f);
7811         tctx.tblock = &tb;
7812         tctx.options = topt;
7813         tb.add_headers = dsnnotifyhdr;
7814
7815         transport_write_message(&tctx, 0);
7816         }
7817       fflush(f);
7818
7819       /* we never add the final text. close the file */
7820       if (emf)
7821         (void)fclose(emf);
7822
7823       fprintf(f, "\n--%s--\n", bound);
7824
7825       /* Close the file, which should send an EOF to the child process
7826       that is receiving the message. Wait for it to finish. */
7827
7828       (void)fclose(f);
7829       rc = child_close(pid, 0);     /* Waits for child to close, no timeout */
7830
7831       /* In the test harness, let the child do it's thing first. */
7832
7833       if (running_in_test_harness) millisleep(500);
7834
7835       /* If the process failed, there was some disaster in setting up the
7836       error message. Unless the message is very old, ensure that addr_defer
7837       is non-null, which will have the effect of leaving the message on the
7838       spool. The failed addresses will get tried again next time. However, we
7839       don't really want this to happen too often, so freeze the message unless
7840       there are some genuine deferred addresses to try. To do this we have
7841       to call spool_write_header() here, because with no genuine deferred
7842       addresses the normal code below doesn't get run. */
7843
7844       if (rc != 0)
7845         {
7846         uschar *s = US"";
7847         if (now - received_time.tv_sec < retry_maximum_timeout && !addr_defer)
7848           {
7849           addr_defer = (address_item *)(+1);
7850           deliver_freeze = TRUE;
7851           deliver_frozen_at = time(NULL);
7852           /* Panic-dies on error */
7853           (void)spool_write_header(message_id, SW_DELIVERING, NULL);
7854           s = US" (frozen)";
7855           }
7856         deliver_msglog("Process failed (%d) when writing error message "
7857           "to %s%s", rc, bounce_recipient, s);
7858         log_write(0, LOG_MAIN, "Process failed (%d) when writing error message "
7859           "to %s%s", rc, bounce_recipient, s);
7860         }
7861
7862       /* The message succeeded. Ensure that the recipients that failed are
7863       now marked finished with on the spool and their parents updated. */
7864
7865       else
7866         {
7867         for (addr = handled_addr; addr; addr = addr->next)
7868           {
7869           address_done(addr, logtod);
7870           child_done(addr, logtod);
7871           }
7872         /* Panic-dies on error */
7873         (void)spool_write_header(message_id, SW_DELIVERING, NULL);
7874         }
7875       }
7876     }
7877   }
7878
7879 disable_logging = FALSE;  /* In case left set */
7880
7881 /* Come here from the mua_wrapper case if routing goes wrong */
7882
7883 DELIVERY_TIDYUP:
7884
7885 /* If there are now no deferred addresses, we are done. Preserve the
7886 message log if so configured, and we are using them. Otherwise, sling it.
7887 Then delete the message itself. */
7888
7889 if (!addr_defer)
7890   {
7891   uschar * fname;
7892
7893   if (message_logs)
7894     {
7895     fname = spool_fname(US"msglog", message_subdir, id, US"");
7896     if (preserve_message_logs)
7897       {
7898       int rc;
7899       uschar * moname = spool_fname(US"msglog.OLD", US"", id, US"");
7900
7901       if ((rc = Urename(fname, moname)) < 0)
7902         {
7903         (void)directory_make(spool_directory,
7904                               spool_sname(US"msglog.OLD", US""),
7905                               MSGLOG_DIRECTORY_MODE, TRUE);
7906         rc = Urename(fname, moname);
7907         }
7908       if (rc < 0)
7909         log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to move %s to the "
7910           "msglog.OLD directory", fname);
7911       }
7912     else
7913       if (Uunlink(fname) < 0)
7914         log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s",
7915                   fname, strerror(errno));
7916     }
7917
7918   /* Remove the two message files. */
7919
7920   fname = spool_fname(US"input", message_subdir, id, US"-D");
7921   if (Uunlink(fname) < 0)
7922     log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s",
7923       fname, strerror(errno));
7924   fname = spool_fname(US"input", message_subdir, id, US"-H");
7925   if (Uunlink(fname) < 0)
7926     log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s",
7927       fname, strerror(errno));
7928
7929   /* Log the end of this message, with queue time if requested. */
7930
7931   if (LOGGING(queue_time_overall))
7932     log_write(0, LOG_MAIN, "Completed QT=%s",
7933       string_timesince(&received_time));
7934   else
7935     log_write(0, LOG_MAIN, "Completed");
7936
7937   /* Unset deliver_freeze so that we won't try to move the spool files further down */
7938   deliver_freeze = FALSE;
7939
7940 #ifndef DISABLE_EVENT
7941   (void) event_raise(event_action, US"msg:complete", NULL);
7942 #endif
7943   }
7944
7945 /* If there are deferred addresses, we are keeping this message because it is
7946 not yet completed. Lose any temporary files that were catching output from
7947 pipes for any of the deferred addresses, handle one-time aliases, and see if
7948 the message has been on the queue for so long that it is time to send a warning
7949 message to the sender, unless it is a mailer-daemon. If all deferred addresses
7950 have the same domain, we can set deliver_domain for the expansion of
7951 delay_warning_ condition - if any of them are pipes, files, or autoreplies, use
7952 the parent's domain.
7953
7954 If all the deferred addresses have an error number that indicates "retry time
7955 not reached", skip sending the warning message, because it won't contain the
7956 reason for the delay. It will get sent at the next real delivery attempt.
7957 However, if at least one address has tried, we'd better include all of them in
7958 the message.
7959
7960 If we can't make a process to send the message, don't worry.
7961
7962 For mailing list expansions we want to send the warning message to the
7963 mailing list manager. We can't do a perfect job here, as some addresses may
7964 have different errors addresses, but if we take the errors address from
7965 each deferred address it will probably be right in most cases.
7966
7967 If addr_defer == +1, it means there was a problem sending an error message
7968 for failed addresses, and there were no "real" deferred addresses. The value
7969 was set just to keep the message on the spool, so there is nothing to do here.
7970 */
7971
7972 else if (addr_defer != (address_item *)(+1))
7973   {
7974   address_item *addr;
7975   uschar *recipients = US"";
7976   BOOL delivery_attempted = FALSE;
7977
7978   deliver_domain = testflag(addr_defer, af_pfr)
7979     ? addr_defer->parent->domain : addr_defer->domain;
7980
7981   for (addr = addr_defer; addr; addr = addr->next)
7982     {
7983     address_item *otaddr;
7984
7985     if (addr->basic_errno > ERRNO_RETRY_BASE) delivery_attempted = TRUE;
7986
7987     if (deliver_domain)
7988       {
7989       const uschar *d = testflag(addr, af_pfr)
7990         ? addr->parent->domain : addr->domain;
7991
7992       /* The domain may be unset for an address that has never been routed
7993       because the system filter froze the message. */
7994
7995       if (!d || Ustrcmp(d, deliver_domain) != 0)
7996         deliver_domain = NULL;
7997       }
7998
7999     if (addr->return_filename) Uunlink(addr->return_filename);
8000
8001     /* Handle the case of one-time aliases. If any address in the ancestry
8002     of this one is flagged, ensure it is in the recipients list, suitably
8003     flagged, and that its parent is marked delivered. */
8004
8005     for (otaddr = addr; otaddr; otaddr = otaddr->parent)
8006       if (otaddr->onetime_parent) break;
8007
8008     if (otaddr)
8009       {
8010       int i;
8011       int t = recipients_count;
8012
8013       for (i = 0; i < recipients_count; i++)
8014         {
8015         uschar *r = recipients_list[i].address;
8016         if (Ustrcmp(otaddr->onetime_parent, r) == 0) t = i;
8017         if (Ustrcmp(otaddr->address, r) == 0) break;
8018         }
8019
8020       /* Didn't find the address already in the list, and did find the
8021       ultimate parent's address in the list, and they really are different
8022       (i.e. not from an identity-redirect). After adding the recipient,
8023       update the errors address in the recipients list. */
8024
8025       if (  i >= recipients_count && t < recipients_count
8026          && Ustrcmp(otaddr->address, otaddr->parent->address) != 0)
8027         {
8028         DEBUG(D_deliver) debug_printf("one_time: adding %s in place of %s\n",
8029           otaddr->address, otaddr->parent->address);
8030         receive_add_recipient(otaddr->address, t);
8031         recipients_list[recipients_count-1].errors_to = otaddr->prop.errors_address;
8032         tree_add_nonrecipient(otaddr->parent->address);
8033         update_spool = TRUE;
8034         }
8035       }
8036
8037     /* Except for error messages, ensure that either the errors address for
8038     this deferred address or, if there is none, the sender address, is on the
8039     list of recipients for a warning message. */
8040
8041     if (sender_address[0])
8042       {
8043       uschar * s = addr->prop.errors_address;
8044       if (!s) s = sender_address;
8045       if (Ustrstr(recipients, s) == NULL)
8046         recipients = string_sprintf("%s%s%s", recipients,
8047           recipients[0] ? "," : "", s);
8048       }
8049     }
8050
8051   /* Send a warning message if the conditions are right. If the condition check
8052   fails because of a lookup defer, there is nothing we can do. The warning
8053   is not sent. Another attempt will be made at the next delivery attempt (if
8054   it also defers). */
8055
8056   if (  !queue_2stage
8057      && delivery_attempted
8058      && (  ((addr_defer->dsn_flags & rf_dsnflags) == 0)
8059         || (addr_defer->dsn_flags & rf_notify_delay) == rf_notify_delay
8060         )
8061      && delay_warning[1] > 0
8062      && sender_address[0] != 0
8063      && (  !delay_warning_condition
8064         || expand_check_condition(delay_warning_condition,
8065             US"delay_warning", US"option")
8066         )
8067      )
8068     {
8069     int count;
8070     int show_time;
8071     int queue_time = time(NULL) - received_time.tv_sec;
8072
8073     /* When running in the test harness, there's an option that allows us to
8074     fudge this time so as to get repeatability of the tests. Take the first
8075     time off the list. In queue runs, the list pointer gets updated in the
8076     calling process. */
8077
8078     if (running_in_test_harness && fudged_queue_times[0] != 0)
8079       {
8080       int qt = readconf_readtime(fudged_queue_times, '/', FALSE);
8081       if (qt >= 0)
8082         {
8083         DEBUG(D_deliver) debug_printf("fudged queue_times = %s\n",
8084           fudged_queue_times);
8085         queue_time = qt;
8086         }
8087       }
8088
8089     /* See how many warnings we should have sent by now */
8090
8091     for (count = 0; count < delay_warning[1]; count++)
8092       if (queue_time < delay_warning[count+2]) break;
8093
8094     show_time = delay_warning[count+1];
8095
8096     if (count >= delay_warning[1])
8097       {
8098       int extra;
8099       int last_gap = show_time;
8100       if (count > 1) last_gap -= delay_warning[count];
8101       extra = (queue_time - delay_warning[count+1])/last_gap;
8102       show_time += last_gap * extra;
8103       count += extra;
8104       }
8105
8106     DEBUG(D_deliver)
8107       {
8108       debug_printf("time on queue = %s\n", readconf_printtime(queue_time));
8109       debug_printf("warning counts: required %d done %d\n", count,
8110         warning_count);
8111       }
8112
8113     /* We have computed the number of warnings there should have been by now.
8114     If there haven't been enough, send one, and up the count to what it should
8115     have been. */
8116
8117     if (warning_count < count)
8118       {
8119       header_line *h;
8120       int fd;
8121       pid_t pid = child_open_exim(&fd);
8122
8123       if (pid > 0)
8124         {
8125         uschar *wmf_text;
8126         FILE *wmf = NULL;
8127         FILE *f = fdopen(fd, "wb");
8128         uschar * bound;
8129         transport_ctx tctx = {{0}};
8130
8131         if (warn_message_file)
8132           if (!(wmf = Ufopen(warn_message_file, "rb")))
8133             log_write(0, LOG_MAIN|LOG_PANIC, "Failed to open %s for warning "
8134               "message texts: %s", warn_message_file, strerror(errno));
8135
8136         warnmsg_recipients = recipients;
8137         warnmsg_delay = queue_time < 120*60
8138           ? string_sprintf("%d minutes", show_time/60)
8139           : string_sprintf("%d hours", show_time/3600);
8140
8141         if (errors_reply_to)
8142           fprintf(f, "Reply-To: %s\n", errors_reply_to);
8143         fprintf(f, "Auto-Submitted: auto-replied\n");
8144         moan_write_from(f);
8145         fprintf(f, "To: %s\n", recipients);
8146
8147         /* generated boundary string and output MIME-Headers */
8148         bound = string_sprintf(TIME_T_FMT "-eximdsn-%d", time(NULL), rand());
8149
8150         fprintf(f, "Content-Type: multipart/report;"
8151             " report-type=delivery-status; boundary=%s\n"
8152             "MIME-Version: 1.0\n",
8153           bound);
8154
8155         if ((wmf_text = next_emf(wmf, US"header")))
8156           fprintf(f, "%s\n", wmf_text);
8157         else
8158           fprintf(f, "Subject: Warning: message %s delayed %s\n\n",
8159             message_id, warnmsg_delay);
8160
8161         /* output human readable part as text/plain section */
8162         fprintf(f, "--%s\n"
8163             "Content-type: text/plain; charset=us-ascii\n\n",
8164           bound);
8165
8166         if ((wmf_text = next_emf(wmf, US"intro")))
8167           fprintf(f, "%s", CS wmf_text);
8168         else
8169           {
8170           fprintf(f,
8171 "This message was created automatically by mail delivery software.\n");
8172
8173           if (Ustrcmp(recipients, sender_address) == 0)
8174             fprintf(f,
8175 "A message that you sent has not yet been delivered to one or more of its\n"
8176 "recipients after more than ");
8177
8178           else
8179             fprintf(f,
8180 "A message sent by\n\n  <%s>\n\n"
8181 "has not yet been delivered to one or more of its recipients after more than \n",
8182               sender_address);
8183
8184           fprintf(f, "%s on the queue on %s.\n\n"
8185               "The message identifier is:     %s\n",
8186             warnmsg_delay, primary_hostname, message_id);
8187
8188           for (h = header_list; h; h = h->next)
8189             if (strncmpic(h->text, US"Subject:", 8) == 0)
8190               fprintf(f, "The subject of the message is: %s", h->text + 9);
8191             else if (strncmpic(h->text, US"Date:", 5) == 0)
8192               fprintf(f, "The date of the message is:    %s", h->text + 6);
8193           fputc('\n', f);
8194
8195           fprintf(f, "The address%s to which the message has not yet been "
8196             "delivered %s:\n",
8197             !addr_defer->next ? "" : "es",
8198             !addr_defer->next ? "is": "are");
8199           }
8200
8201         /* List the addresses, with error information if allowed */
8202
8203         /* store addr_defer for machine readable part */
8204         address_item *addr_dsndefer = addr_defer;
8205         fputc('\n', f);
8206         while (addr_defer)
8207           {
8208           address_item *addr = addr_defer;
8209           addr_defer = addr->next;
8210           if (print_address_information(addr, f, US"  ", US"\n    ", US""))
8211             print_address_error(addr, f, US"Delay reason: ");
8212           fputc('\n', f);
8213           }
8214         fputc('\n', f);
8215
8216         /* Final text */
8217
8218         if (wmf)
8219           {
8220           if ((wmf_text = next_emf(wmf, US"final")))
8221             fprintf(f, "%s", CS wmf_text);
8222           (void)fclose(wmf);
8223           }
8224         else
8225           {
8226           fprintf(f,
8227 "No action is required on your part. Delivery attempts will continue for\n"
8228 "some time, and this warning may be repeated at intervals if the message\n"
8229 "remains undelivered. Eventually the mail delivery software will give up,\n"
8230 "and when that happens, the message will be returned to you.\n");
8231           }
8232
8233         /* output machine readable part */
8234         fprintf(f, "\n--%s\n"
8235             "Content-type: message/delivery-status\n\n"
8236             "Reporting-MTA: dns; %s\n",
8237           bound,
8238           smtp_active_hostname);
8239
8240
8241         if (dsn_envid)
8242           {
8243           /* must be decoded from xtext: see RFC 3461:6.3a */
8244           uschar *xdec_envid;
8245           if (auth_xtextdecode(dsn_envid, &xdec_envid) > 0)
8246             fprintf(f,"Original-Envelope-ID: %s\n", dsn_envid);
8247           else
8248             fprintf(f,"X-Original-Envelope-ID: error decoding xtext formatted ENVID\n");
8249           }
8250         fputc('\n', f);
8251
8252         for ( ; addr_dsndefer; addr_dsndefer = addr_dsndefer->next)
8253           {
8254           if (addr_dsndefer->dsn_orcpt)
8255             fprintf(f, "Original-Recipient: %s\n", addr_dsndefer->dsn_orcpt);
8256
8257           fprintf(f, "Action: delayed\n"
8258               "Final-Recipient: rfc822;%s\n"
8259               "Status: 4.0.0\n",
8260             addr_dsndefer->address);
8261           if (addr_dsndefer->host_used && addr_dsndefer->host_used->name)
8262             {
8263             fprintf(f, "Remote-MTA: dns; %s\n",
8264                     addr_dsndefer->host_used->name);
8265             print_dsn_diagnostic_code(addr_dsndefer, f);
8266             }
8267           fputc('\n', f);
8268           }
8269
8270         fprintf(f, "--%s\n"
8271             "Content-type: text/rfc822-headers\n\n",
8272           bound);
8273
8274         fflush(f);
8275         /* header only as required by RFC. only failure DSN needs to honor RET=FULL */
8276         tctx.u.fd = fileno(f);
8277         tctx.options = topt_add_return_path | topt_no_body;
8278         transport_filter_argv = NULL;   /* Just in case */
8279         return_path = sender_address;   /* In case not previously set */
8280
8281         /* Write the original email out */
8282         transport_write_message(&tctx, 0);
8283         fflush(f);
8284
8285         fprintf(f,"\n--%s--\n", bound);
8286
8287         fflush(f);
8288
8289         /* Close and wait for child process to complete, without a timeout.
8290         If there's an error, don't update the count. */
8291
8292         (void)fclose(f);
8293         if (child_close(pid, 0) == 0)
8294           {
8295           warning_count = count;
8296           update_spool = TRUE;    /* Ensure spool rewritten */
8297           }
8298         }
8299       }
8300     }
8301
8302   /* Clear deliver_domain */
8303
8304   deliver_domain = NULL;
8305
8306   /* If this was a first delivery attempt, unset the first time flag, and
8307   ensure that the spool gets updated. */
8308
8309   if (deliver_firsttime)
8310     {
8311     deliver_firsttime = FALSE;
8312     update_spool = TRUE;
8313     }
8314
8315   /* If delivery was frozen and freeze_tell is set, generate an appropriate
8316   message, unless the message is a local error message (to avoid loops). Then
8317   log the freezing. If the text in "frozen_info" came from a system filter,
8318   it has been escaped into printing characters so as not to mess up log lines.
8319   For the "tell" message, we turn \n back into newline. Also, insert a newline
8320   near the start instead of the ": " string. */
8321
8322   if (deliver_freeze)
8323     {
8324     if (freeze_tell && freeze_tell[0] != 0 && !local_error_message)
8325       {
8326       uschar *s = string_copy(frozen_info);
8327       uschar *ss = Ustrstr(s, " by the system filter: ");
8328
8329       if (ss != NULL)
8330         {
8331         ss[21] = '.';
8332         ss[22] = '\n';
8333         }
8334
8335       ss = s;
8336       while (*ss != 0)
8337         {
8338         if (*ss == '\\' && ss[1] == 'n')
8339           {
8340           *ss++ = ' ';
8341           *ss++ = '\n';
8342           }
8343         else ss++;
8344         }
8345       moan_tell_someone(freeze_tell, addr_defer, US"Message frozen",
8346         "Message %s has been frozen%s.\nThe sender is <%s>.\n", message_id,
8347         s, sender_address);
8348       }
8349
8350     /* Log freezing just before we update the -H file, to minimize the chance
8351     of a race problem. */
8352
8353     deliver_msglog("*** Frozen%s\n", frozen_info);
8354     log_write(0, LOG_MAIN, "Frozen%s", frozen_info);
8355     }
8356
8357   /* If there have been any updates to the non-recipients list, or other things
8358   that get written to the spool, we must now update the spool header file so
8359   that it has the right information for the next delivery attempt. If there
8360   was more than one address being delivered, the header_change update is done
8361   earlier, in case one succeeds and then something crashes. */
8362
8363   DEBUG(D_deliver)
8364     debug_printf("delivery deferred: update_spool=%d header_rewritten=%d\n",
8365       update_spool, header_rewritten);
8366
8367   if (update_spool || header_rewritten)
8368     /* Panic-dies on error */
8369     (void)spool_write_header(message_id, SW_DELIVERING, NULL);
8370   }
8371
8372 /* Finished with the message log. If the message is complete, it will have
8373 been unlinked or renamed above. */
8374
8375 if (message_logs) (void)fclose(message_log);
8376
8377 /* Now we can close and remove the journal file. Its only purpose is to record
8378 successfully completed deliveries asap so that this information doesn't get
8379 lost if Exim (or the machine) crashes. Forgetting about a failed delivery is
8380 not serious, as trying it again is not harmful. The journal might not be open
8381 if all addresses were deferred at routing or directing. Nevertheless, we must
8382 remove it if it exists (may have been lying around from a crash during the
8383 previous delivery attempt). We don't remove the journal if a delivery
8384 subprocess failed to pass back delivery information; this is controlled by
8385 the remove_journal flag. When the journal is left, we also don't move the
8386 message off the main spool if frozen and the option is set. It should get moved
8387 at the next attempt, after the journal has been inspected. */
8388
8389 if (journal_fd >= 0) (void)close(journal_fd);
8390
8391 if (remove_journal)
8392   {
8393   uschar * fname = spool_fname(US"input", message_subdir, id, US"-J");
8394
8395   if (Uunlink(fname) < 0 && errno != ENOENT)
8396     log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s", fname,
8397       strerror(errno));
8398
8399   /* Move the message off the spool if requested */
8400
8401 #ifdef SUPPORT_MOVE_FROZEN_MESSAGES
8402   if (deliver_freeze && move_frozen_messages)
8403     (void)spool_move_message(id, message_subdir, US"", US"F");
8404 #endif
8405   }
8406
8407 /* Closing the data file frees the lock; if the file has been unlinked it
8408 will go away. Otherwise the message becomes available for another process
8409 to try delivery. */
8410
8411 (void)close(deliver_datafile);
8412 deliver_datafile = -1;
8413 DEBUG(D_deliver) debug_printf("end delivery of %s\n", id);
8414
8415 /* It is unlikely that there will be any cached resources, since they are
8416 released after routing, and in the delivery subprocesses. However, it's
8417 possible for an expansion for something afterwards (for example,
8418 expand_check_condition) to do a lookup. We must therefore be sure everything is
8419 released. */
8420
8421 search_tidyup();
8422 acl_where = ACL_WHERE_UNKNOWN;
8423 return final_yield;
8424 }
8425
8426
8427
8428 void
8429 deliver_init(void)
8430 {
8431 if (!regex_PIPELINING) regex_PIPELINING =
8432   regex_must_compile(US"\\n250[\\s\\-]PIPELINING(\\s|\\n|$)", FALSE, TRUE);
8433
8434 if (!regex_SIZE) regex_SIZE =
8435   regex_must_compile(US"\\n250[\\s\\-]SIZE(\\s|\\n|$)", FALSE, TRUE);
8436
8437 if (!regex_AUTH) regex_AUTH =
8438   regex_must_compile(US"\\n250[\\s\\-]AUTH\\s+([\\-\\w\\s]+)(?:\\n|$)",
8439     FALSE, TRUE);
8440
8441 #ifdef SUPPORT_TLS
8442 if (!regex_STARTTLS) regex_STARTTLS =
8443   regex_must_compile(US"\\n250[\\s\\-]STARTTLS(\\s|\\n|$)", FALSE, TRUE);
8444 #endif
8445
8446 if (!regex_CHUNKING) regex_CHUNKING =
8447   regex_must_compile(US"\\n250[\\s\\-]CHUNKING(\\s|\\n|$)", FALSE, TRUE);
8448
8449 #ifndef DISABLE_PRDR
8450 if (!regex_PRDR) regex_PRDR =
8451   regex_must_compile(US"\\n250[\\s\\-]PRDR(\\s|\\n|$)", FALSE, TRUE);
8452 #endif
8453
8454 #ifdef SUPPORT_I18N
8455 if (!regex_UTF8) regex_UTF8 =
8456   regex_must_compile(US"\\n250[\\s\\-]SMTPUTF8(\\s|\\n|$)", FALSE, TRUE);
8457 #endif
8458
8459 if (!regex_DSN) regex_DSN  =
8460   regex_must_compile(US"\\n250[\\s\\-]DSN(\\s|\\n|$)", FALSE, TRUE);
8461
8462 if (!regex_IGNOREQUOTA) regex_IGNOREQUOTA =
8463   regex_must_compile(US"\\n250[\\s\\-]IGNOREQUOTA(\\s|\\n|$)", FALSE, TRUE);
8464 }
8465
8466
8467 uschar *
8468 deliver_get_sender_address (uschar * id)
8469 {
8470 int rc;
8471 uschar * new_sender_address,
8472        * save_sender_address;
8473 BOOL save_qr = queue_running;
8474 uschar * spoolname;
8475
8476 /* make spool_open_datafile non-noisy on fail */
8477
8478 queue_running = TRUE;
8479
8480 /* Side effect: message_subdir is set for the (possibly split) spool directory */
8481
8482 deliver_datafile = spool_open_datafile(id);
8483 queue_running = save_qr;
8484 if (deliver_datafile < 0)
8485   return NULL;
8486
8487 /* Save and restore the global sender_address.  I'm not sure if we should
8488 not save/restore all the other global variables too, because
8489 spool_read_header() may change all of them. But OTOH, when this
8490 deliver_get_sender_address() gets called, the current message is done
8491 already and nobody needs the globals anymore. (HS12, 2015-08-21) */
8492
8493 spoolname = string_sprintf("%s-H", id);
8494 save_sender_address = sender_address;
8495
8496 rc = spool_read_header(spoolname, TRUE, TRUE);
8497
8498 new_sender_address = sender_address;
8499 sender_address = save_sender_address;
8500
8501 if (rc != spool_read_OK)
8502   return NULL;
8503
8504 assert(new_sender_address);
8505
8506 (void)close(deliver_datafile);
8507 deliver_datafile = -1;
8508
8509 return new_sender_address;
8510 }
8511
8512
8513
8514 void
8515 delivery_re_exec(int exec_type)
8516 {
8517 uschar * where;
8518
8519 if (cutthrough.fd >= 0 && cutthrough.callout_hold_only)
8520   {
8521   int pfd[2], channel_fd = cutthrough.fd, pid;
8522
8523   smtp_peer_options = cutthrough.peer_options;
8524   continue_sequence = 0;
8525
8526 #ifdef SUPPORT_TLS
8527   if (cutthrough.is_tls)
8528     {
8529     smtp_peer_options |= OPTION_TLS;
8530     sending_ip_address = cutthrough.snd_ip;
8531     sending_port = cutthrough.snd_port;
8532
8533     where = US"socketpair";
8534     if (socketpair(AF_UNIX, SOCK_STREAM, 0, pfd) != 0)
8535       goto fail;
8536
8537     where = US"fork";
8538     if ((pid = fork()) < 0)
8539       goto fail;
8540
8541     else if (pid == 0)          /* child: fork again to totally dosconnect */
8542       {
8543       close(pfd[1]);
8544       if ((pid = fork()))
8545         _exit(pid ? EXIT_FAILURE : EXIT_SUCCESS);
8546       smtp_proxy_tls(big_buffer, big_buffer_size, pfd[0], 5*60);
8547       exim_exit(0);
8548       }
8549
8550     close(pfd[0]);
8551     waitpid(pid, NULL, 0);
8552     (void) close(channel_fd);   /* release the client socket */
8553     channel_fd = pfd[1];
8554     }
8555 #endif
8556
8557   transport_do_pass_socket(cutthrough.transport, cutthrough.host.name,
8558     cutthrough.host.address, message_id, channel_fd);
8559   }
8560 else
8561   {
8562   cancel_cutthrough_connection(TRUE, US"non-continued delivery");
8563   (void) child_exec_exim(exec_type, FALSE, NULL, FALSE, 2, US"-Mc", message_id);
8564   }
8565 return;         /* compiler quietening; control does not reach here. */
8566
8567 fail:
8568   log_write(0,
8569     LOG_MAIN | (exec_type == CEE_EXEC_EXIT ? LOG_PANIC : LOG_PANIC_DIE),
8570     "delivery re-exec %s failed: %s", where, strerror(errno));
8571
8572   /* Get here if exec_type == CEE_EXEC_EXIT.
8573   Note: this must be _exit(), not exit(). */
8574
8575   _exit(EX_EXECFAILED);
8576 }
8577
8578 /* vi: aw ai sw=2
8579 */
8580 /* End of deliver.c */