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