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