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