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