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