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