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