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