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