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