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