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