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