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