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