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