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