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