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