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