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