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