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