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