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