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