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