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