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