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