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