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