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