Compilation warnings shushing
[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
4c04137d 947cases where the transport is going to complete the path. If there is an error
5dac72a7
JH
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 )
a23ff3b4 2363 log_write(0, LOG_MAIN|LOG_PANIC, "Failed writing transport results to pipe: %s",
1ac6b2e7 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 2373 )
a23ff3b4 2374 log_write(0, LOG_MAIN|LOG_PANIC, "Failed writing transport results to pipe: %s",
1ac6b2e7 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 {
d88f0784 2405 if ((len = read(pfd[pipe_read], &status, sizeof(int))) > 0)
059ec3d9
PH
2406 {
2407 int i;
2408 uschar **sptr;
2409
2410 addr2->transport_return = status;
d6c82d7b 2411 len = read(pfd[pipe_read], &transport_count,
059ec3d9 2412 sizeof(transport_count));
d6c82d7b
JH
2413 len = read(pfd[pipe_read], &addr2->flags, sizeof(addr2->flags));
2414 len = read(pfd[pipe_read], &addr2->basic_errno, sizeof(int));
2415 len = read(pfd[pipe_read], &addr2->more_errno, sizeof(int));
2416 len = read(pfd[pipe_read], &addr2->special_action, sizeof(int));
2417 len = read(pfd[pipe_read], &addr2->transport,
059ec3d9
PH
2418 sizeof(transport_instance *));
2419
2420 if (testflag(addr2, af_file))
2421 {
d88f0784
JH
2422 int llen;
2423 if ( read(pfd[pipe_read], &llen, sizeof(int)) != sizeof(int)
2424 || llen > 64*4 /* limit from rfc 5821, times I18N factor */
2425 )
2426 {
2427 log_write(0, LOG_MAIN|LOG_PANIC, "bad local_part length read"
2428 " from delivery subprocess");
2429 break;
2430 }
2431 /* sanity-checked llen so disable the Coverity error */
2432 /* coverity[tainted_data] */
2433 if (read(pfd[pipe_read], big_buffer, llen) != llen)
2434 {
2435 log_write(0, LOG_MAIN|LOG_PANIC, "bad local_part read"
2436 " from delivery subprocess");
2437 break;
2438 }
2439 big_buffer[llen] = 0;
059ec3d9
PH
2440 addr2->local_part = string_copy(big_buffer);
2441 }
2442
d6c82d7b 2443 for (i = 0, sptr = &addr2->message; i < 2; i++, sptr = &addr2->user_message)
059ec3d9
PH
2444 {
2445 int message_length;
d6c82d7b 2446 len = read(pfd[pipe_read], &message_length, sizeof(int));
059ec3d9
PH
2447 if (message_length > 0)
2448 {
d6c82d7b 2449 len = read(pfd[pipe_read], big_buffer, message_length);
dc8091e7 2450 big_buffer[big_buffer_size-1] = '\0'; /* guard byte */
059ec3d9
PH
2451 if (len > 0) *sptr = string_copy(big_buffer);
2452 }
2453 }
2454 }
2455
2456 else
2457 {
2458 log_write(0, LOG_MAIN|LOG_PANIC, "failed to read delivery status for %s "
2459 "from delivery subprocess", addr2->unique);
2460 break;
2461 }
2462 }
2463
f1e894f3 2464(void)close(pfd[pipe_read]);
059ec3d9
PH
2465
2466/* Unless shadowing, write all successful addresses immediately to the journal
2467file, to ensure they are recorded asap. For homonymic addresses, use the base
2468address plus the transport name. Failure to write the journal is panic-worthy,
2469but don't stop, as it may prove possible subsequently to update the spool file
2470in order to record the delivery. */
2471
2472if (!shadowing)
2473 {
d6c82d7b
JH
2474 for (addr2 = addr; addr2; addr2 = addr2->next)
2475 if (addr2->transport_return == OK)
2476 {
2477 if (testflag(addr2, af_homonym))
2478 sprintf(CS big_buffer, "%.500s/%s\n", addr2->unique + 3, tp->name);
2479 else
2480 sprintf(CS big_buffer, "%.500s\n", addr2->unique);
059ec3d9 2481
d6c82d7b
JH
2482 /* In the test harness, wait just a bit to let the subprocess finish off
2483 any debug output etc first. */
059ec3d9 2484
d6c82d7b 2485 if (running_in_test_harness) millisleep(300);
059ec3d9 2486
d6c82d7b
JH
2487 DEBUG(D_deliver) debug_printf("journalling %s", big_buffer);
2488 len = Ustrlen(big_buffer);
2489 if (write(journal_fd, big_buffer, len) != len)
2490 log_write(0, LOG_MAIN|LOG_PANIC, "failed to update journal for %s: %s",
2491 big_buffer, strerror(errno));
2492 }
059ec3d9
PH
2493
2494 /* Ensure the journal file is pushed out to disk. */
2495
54fc8428 2496 if (EXIMfsync(journal_fd) < 0)
059ec3d9
PH
2497 log_write(0, LOG_MAIN|LOG_PANIC, "failed to fsync journal: %s",
2498 strerror(errno));
2499 }
2500
2501/* Wait for the process to finish. If it terminates with a non-zero code,
2502freeze the message (except for SIGTERM, SIGKILL and SIGQUIT), but leave the
2503status values of all the addresses as they are. Take care to handle the case
2504when the subprocess doesn't seem to exist. This has been seen on one system
2505when Exim was called from an MUA that set SIGCHLD to SIG_IGN. When that
2506happens, wait() doesn't recognize the termination of child processes. Exim now
2507resets SIGCHLD to SIG_DFL, but this code should still be robust. */
2508
2509while ((rc = wait(&status)) != pid)
059ec3d9
PH
2510 if (rc < 0 && errno == ECHILD) /* Process has vanished */
2511 {
2512 log_write(0, LOG_MAIN, "%s transport process vanished unexpectedly",
2513 addr->transport->driver_name);
2514 status = 0;
2515 break;
2516 }
059ec3d9
PH
2517
2518if ((status & 0xffff) != 0)
2519 {
2520 int msb = (status >> 8) & 255;
2521 int lsb = status & 255;
2522 int code = (msb == 0)? (lsb & 0x7f) : msb;
2523 if (msb != 0 || (code != SIGTERM && code != SIGKILL && code != SIGQUIT))
2524 addr->special_action = SPECIAL_FREEZE;
2525 log_write(0, LOG_MAIN|LOG_PANIC, "%s transport process returned non-zero "
2526 "status 0x%04x: %s %d",
2527 addr->transport->driver_name,
2528 status,
d6c82d7b 2529 msb == 0 ? "terminated by signal" : "exit code",
059ec3d9
PH
2530 code);
2531 }
2532
2533/* If SPECIAL_WARN is set in the top address, send a warning message. */
2534
d6c82d7b 2535if (addr->special_action == SPECIAL_WARN && addr->transport->warn_message)
059ec3d9
PH
2536 {
2537 int fd;
2538 uschar *warn_message;
d6c82d7b 2539 pid_t pid;
059ec3d9
PH
2540
2541 DEBUG(D_deliver) debug_printf("Warning message requested by transport\n");
2542
d6c82d7b 2543 if (!(warn_message = expand_string(addr->transport->warn_message)))
059ec3d9
PH
2544 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand \"%s\" (warning "
2545 "message for %s transport): %s", addr->transport->warn_message,
2546 addr->transport->name, expand_string_message);
d6c82d7b
JH
2547
2548 else if ((pid = child_open_exim(&fd)) > 0)
059ec3d9 2549 {
d6c82d7b
JH
2550 FILE *f = fdopen(fd, "wb");
2551 if (errors_reply_to && !contains_header(US"Reply-To", warn_message))
2552 fprintf(f, "Reply-To: %s\n", errors_reply_to);
2553 fprintf(f, "Auto-Submitted: auto-replied\n");
2554 if (!contains_header(US"From", warn_message))
2555 moan_write_from(f);
2556 fprintf(f, "%s", CS warn_message);
059ec3d9 2557
d6c82d7b 2558 /* Close and wait for child process to complete, without a timeout. */
059ec3d9 2559
d6c82d7b
JH
2560 (void)fclose(f);
2561 (void)child_close(pid, 0);
059ec3d9
PH
2562 }
2563
2564 addr->special_action = SPECIAL_NONE;
2565 }
2566}
2567
2568
2569
fa41615d 2570
3070ceee
JH
2571/* Check transport for the given concurrency limit. Return TRUE if over
2572the limit (or an expansion failure), else FALSE and if there was a limit,
2573the key for the hints database used for the concurrency count. */
fa41615d 2574
3070ceee
JH
2575static BOOL
2576tpt_parallel_check(transport_instance * tp, address_item * addr, uschar ** key)
fa41615d 2577{
3070ceee
JH
2578unsigned max_parallel;
2579
2580if (!tp->max_parallel) return FALSE;
2581
2582max_parallel = (unsigned) expand_string_integer(tp->max_parallel, TRUE);
2583if (expand_string_message)
2584 {
2585 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand max_parallel option "
2586 "in %s transport (%s): %s", tp->name, addr->address,
2587 expand_string_message);
2588 return TRUE;
2589 }
2590
2591if (max_parallel > 0)
2592 {
2593 uschar * serialize_key = string_sprintf("tpt-serialize-%s", tp->name);
2594 if (!enq_start(serialize_key, max_parallel))
2595 {
2596 address_item * next;
2597 DEBUG(D_transport)
2598 debug_printf("skipping tpt %s because concurrency limit %u reached\n",
2599 tp->name, max_parallel);
2600 do
2601 {
2602 next = addr->next;
2603 addr->message = US"concurrency limit reached for transport";
2604 addr->basic_errno = ERRNO_TRETRY;
2605 post_process_one(addr, DEFER, LOG_MAIN, DTYPE_TRANSPORT, 0);
2606 } while ((addr = next));
2607 return TRUE;
2608 }
2609 *key = serialize_key;
2610 }
2611return FALSE;
fa41615d
JH
2612}
2613
2614
2615
059ec3d9
PH
2616/*************************************************
2617* Do local deliveries *
2618*************************************************/
2619
2620/* This function processes the list of addresses in addr_local. True local
2621deliveries are always done one address at a time. However, local deliveries can
2622be batched up in some cases. Typically this is when writing batched SMTP output
2623files for use by some external transport mechanism, or when running local
2624deliveries over LMTP.
2625
2626Arguments: None
2627Returns: Nothing
2628*/
2629
2630static void
2631do_local_deliveries(void)
2632{
2633open_db dbblock;
2634open_db *dbm_file = NULL;
2635time_t now = time(NULL);
2636
2637/* Loop until we have exhausted the supply of local deliveries */
2638
d6c82d7b 2639while (addr_local)
059ec3d9
PH
2640 {
2641 time_t delivery_start;
2642 int deliver_time;
2643 address_item *addr2, *addr3, *nextaddr;
2644 int logflags = LOG_MAIN;
2645 int logchar = dont_deliver? '*' : '=';
2646 transport_instance *tp;
fa41615d 2647 uschar * serialize_key = NULL;
059ec3d9
PH
2648
2649 /* Pick the first undelivered address off the chain */
2650
2651 address_item *addr = addr_local;
2652 addr_local = addr->next;
2653 addr->next = NULL;
2654
2655 DEBUG(D_deliver|D_transport)
2656 debug_printf("--------> %s <--------\n", addr->address);
2657
2658 /* An internal disaster if there is no transport. Should not occur! */
2659
d6c82d7b 2660 if (!(tp = addr->transport))
059ec3d9
PH
2661 {
2662 logflags |= LOG_PANIC;
2663 disable_logging = FALSE; /* Jic */
d6c82d7b
JH
2664 addr->message = addr->router
2665 ? string_sprintf("No transport set by %s router", addr->router->name)
2666 : string_sprintf("No transport set by system filter");
059ec3d9
PH
2667 post_process_one(addr, DEFER, logflags, DTYPE_TRANSPORT, 0);
2668 continue;
2669 }
2670
2671 /* Check that this base address hasn't previously been delivered to this
2672 transport. The check is necessary at this point to handle homonymic addresses
2673 correctly in cases where the pattern of redirection changes between delivery
2674 attempts. Non-homonymic previous delivery is detected earlier, at routing
2675 time. */
2676
c2c19e9d 2677 if (previously_transported(addr, FALSE)) continue;
059ec3d9
PH
2678
2679 /* There are weird cases where logging is disabled */
2680
2681 disable_logging = tp->disable_logging;
2682
f7fd3850
PH
2683 /* Check for batched addresses and possible amalgamation. Skip all the work
2684 if either batch_max <= 1 or there aren't any other addresses for local
2685 delivery. */
059ec3d9 2686
d6c82d7b 2687 if (tp->batch_max > 1 && addr_local)
059ec3d9
PH
2688 {
2689 int batch_count = 1;
2690 BOOL uses_dom = readconf_depends((driver_instance *)tp, US"domain");
d6c82d7b
JH
2691 BOOL uses_lp = ( testflag(addr, af_pfr)
2692 && (testflag(addr, af_file) || addr->local_part[0] == '|')
2693 )
2694 || readconf_depends((driver_instance *)tp, US"local_part");
059ec3d9
PH
2695 uschar *batch_id = NULL;
2696 address_item **anchor = &addr_local;
2697 address_item *last = addr;
2698 address_item *next;
2699
2700 /* Expand the batch_id string for comparison with other addresses.
2701 Expansion failure suppresses batching. */
2702
d6c82d7b 2703 if (tp->batch_id)
059ec3d9
PH
2704 {
2705 deliver_set_expansions(addr);
2706 batch_id = expand_string(tp->batch_id);
2707 deliver_set_expansions(NULL);
d6c82d7b 2708 if (!batch_id)
059ec3d9
PH
2709 {
2710 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand batch_id option "
2711 "in %s transport (%s): %s", tp->name, addr->address,
2712 expand_string_message);
2713 batch_count = tp->batch_max;
2714 }
2715 }
2716
2717 /* Until we reach the batch_max limit, pick off addresses which have the
2718 same characteristics. These are:
2719
2720 same transport
7816e254 2721 not previously delivered (see comment about 50 lines above)
059ec3d9 2722 same local part if the transport's configuration contains $local_part
f7fd3850 2723 or if this is a file or pipe delivery from a redirection
059ec3d9
PH
2724 same domain if the transport's configuration contains $domain
2725 same errors address
2726 same additional headers
2727 same headers to be removed
2728 same uid/gid for running the transport
2729 same first host if a host list is set
2730 */
2731
d6c82d7b 2732 while ((next = *anchor) && batch_count < tp->batch_max)
059ec3d9
PH
2733 {
2734 BOOL ok =
d6c82d7b
JH
2735 tp == next->transport
2736 && !previously_transported(next, TRUE)
2737 && (addr->flags & (af_pfr|af_file)) == (next->flags & (af_pfr|af_file))
2738 && (!uses_lp || Ustrcmp(next->local_part, addr->local_part) == 0)
2739 && (!uses_dom || Ustrcmp(next->domain, addr->domain) == 0)
2740 && same_strings(next->prop.errors_address, addr->prop.errors_address)
2741 && same_headers(next->prop.extra_headers, addr->prop.extra_headers)
2742 && same_strings(next->prop.remove_headers, addr->prop.remove_headers)
2743 && same_ugid(tp, addr, next)
2744 && ( !addr->host_list && !next->host_list
2745 || addr->host_list
2746 && next->host_list
2747 && Ustrcmp(addr->host_list->name, next->host_list->name) == 0
2748 );
059ec3d9
PH
2749
2750 /* If the transport has a batch_id setting, batch_id will be non-NULL
2751 from the expansion outside the loop. Expand for this address and compare.
2752 Expansion failure makes this address ineligible for batching. */
2753
d6c82d7b 2754 if (ok && batch_id)
059ec3d9
PH
2755 {
2756 uschar *bid;
2757 address_item *save_nextnext = next->next;
2758 next->next = NULL; /* Expansion for a single address */
2759 deliver_set_expansions(next);
2760 next->next = save_nextnext;
2761 bid = expand_string(tp->batch_id);
2762 deliver_set_expansions(NULL);
d6c82d7b 2763 if (!bid)
059ec3d9
PH
2764 {
2765 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand batch_id option "
2766 "in %s transport (%s): %s", tp->name, next->address,
2767 expand_string_message);
2768 ok = FALSE;
2769 }
2770 else ok = (Ustrcmp(batch_id, bid) == 0);
2771 }
2772
2773 /* Take address into batch if OK. */
2774
2775 if (ok)
2776 {
2777 *anchor = next->next; /* Include the address */
2778 next->next = NULL;
2779 last->next = next;
2780 last = next;
2781 batch_count++;
2782 }
fa41615d 2783 else anchor = &next->next; /* Skip the address */
059ec3d9
PH
2784 }
2785 }
2786
2787 /* We now have one or more addresses that can be delivered in a batch. Check
2788 whether the transport is prepared to accept a message of this size. If not,
2789 fail them all forthwith. If the expansion fails, or does not yield an
2790 integer, defer delivery. */
2791
d6c82d7b 2792 if (tp->message_size_limit)
059ec3d9
PH
2793 {
2794 int rc = check_message_size(tp, addr);
2795 if (rc != OK)
2796 {
2797 replicate_status(addr);
d6c82d7b 2798 while (addr)
059ec3d9
PH
2799 {
2800 addr2 = addr->next;
2801 post_process_one(addr, rc, logflags, DTYPE_TRANSPORT, 0);
2802 addr = addr2;
2803 }
2804 continue; /* With next batch of addresses */
2805 }
2806 }
2807
2808 /* If we are not running the queue, or if forcing, all deliveries will be
2809 attempted. Otherwise, we must respect the retry times for each address. Even
2810 when not doing this, we need to set up the retry key string, and determine
2811 whether a retry record exists, because after a successful delivery, a delete
2812 retry item must be set up. Keep the retry database open only for the duration
2813 of these checks, rather than for all local deliveries, because some local
2814 deliveries (e.g. to pipes) can take a substantial time. */
2815
d6c82d7b 2816 if (!(dbm_file = dbfn_open(US"retry", O_RDONLY, &dbblock, FALSE)))
059ec3d9
PH
2817 {
2818 DEBUG(D_deliver|D_retry|D_hints_lookup)
2819 debug_printf("no retry data available\n");
2820 }
2821
2822 addr2 = addr;
2823 addr3 = NULL;
d6c82d7b 2824 while (addr2)
059ec3d9
PH
2825 {
2826 BOOL ok = TRUE; /* to deliver this address */
2827 uschar *retry_key;
2828
2829 /* Set up the retry key to include the domain or not, and change its
2830 leading character from "R" to "T". Must make a copy before doing this,
2831 because the old key may be pointed to from a "delete" retry item after
2832 a routing delay. */
2833
2834 retry_key = string_copy(
d6c82d7b 2835 tp->retry_use_local_part ? addr2->address_retry_key :
059ec3d9
PH
2836 addr2->domain_retry_key);
2837 *retry_key = 'T';
2838
2839 /* Inspect the retry data. If there is no hints file, delivery happens. */
2840
d6c82d7b 2841 if (dbm_file)
059ec3d9
PH
2842 {
2843 dbdata_retry *retry_record = dbfn_read(dbm_file, retry_key);
2844
2845 /* If there is no retry record, delivery happens. If there is,
2846 remember it exists so it can be deleted after a successful delivery. */
2847
d6c82d7b 2848 if (retry_record)
059ec3d9
PH
2849 {
2850 setflag(addr2, af_lt_retry_exists);
2851
2852 /* A retry record exists for this address. If queue running and not
2853 forcing, inspect its contents. If the record is too old, or if its
2854 retry time has come, or if it has passed its cutoff time, delivery
2855 will go ahead. */
2856
2857 DEBUG(D_retry)
2858 {
ea49d0e1
PH
2859 debug_printf("retry record exists: age=%s ",
2860 readconf_printtime(now - retry_record->time_stamp));
2861 debug_printf("(max %s)\n", readconf_printtime(retry_data_expire));
2862 debug_printf(" time to retry = %s expired = %d\n",
2863 readconf_printtime(retry_record->next_try - now),
2864 retry_record->expired);
059ec3d9
PH
2865 }
2866
2867 if (queue_running && !deliver_force)
2868 {
d6c82d7b
JH
2869 ok = (now - retry_record->time_stamp > retry_data_expire)
2870 || (now >= retry_record->next_try)
2871 || retry_record->expired;
059ec3d9
PH
2872
2873 /* If we haven't reached the retry time, there is one more check
1ddeb334 2874 to do, which is for the ultimate address timeout. */
059ec3d9
PH
2875
2876 if (!ok)
ba9af0af
TF
2877 ok = retry_ultimate_address_timeout(retry_key, addr2->domain,
2878 retry_record, now);
059ec3d9
PH
2879 }
2880 }
2881 else DEBUG(D_retry) debug_printf("no retry record exists\n");
2882 }
2883
2884 /* This address is to be delivered. Leave it on the chain. */
2885
2886 if (ok)
2887 {
2888 addr3 = addr2;
2889 addr2 = addr2->next;
2890 }
2891
2892 /* This address is to be deferred. Take it out of the chain, and
2893 post-process it as complete. Must take it out of the chain first,
2894 because post processing puts it on another chain. */
2895
2896 else
2897 {
2898 address_item *this = addr2;
2899 this->message = US"Retry time not yet reached";
2900 this->basic_errno = ERRNO_LRETRY;
d6c82d7b
JH
2901 addr2 = addr3 ? (addr3->next = addr2->next)
2902 : (addr = addr2->next);
059ec3d9
PH
2903 post_process_one(this, DEFER, logflags, DTYPE_TRANSPORT, 0);
2904 }
2905 }
2906
d6c82d7b 2907 if (dbm_file) dbfn_close(dbm_file);
059ec3d9
PH
2908
2909 /* If there are no addresses left on the chain, they all deferred. Loop
2910 for the next set of addresses. */
2911
d6c82d7b 2912 if (!addr) continue;
059ec3d9 2913
fa41615d
JH
2914 /* If the transport is limited for parallellism, enforce that here.
2915 We use a hints DB entry, incremented here and decremented after
2916 the transport (and any shadow transport) completes. */
2917
3070ceee 2918 if (tpt_parallel_check(tp, addr, &serialize_key))
fa41615d 2919 {
fa41615d
JH
2920 if (expand_string_message)
2921 {
2922 logflags |= LOG_PANIC;
3070ceee
JH
2923 do
2924 {
2925 addr = addr->next;
fa41615d 2926 post_process_one(addr, DEFER, logflags, DTYPE_TRANSPORT, 0);
3070ceee 2927 } while ((addr = addr2));
fa41615d 2928 }
3070ceee 2929 continue; /* Loop for the next set of addresses. */
fa41615d
JH
2930 }
2931
2932
059ec3d9
PH
2933 /* So, finally, we do have some addresses that can be passed to the
2934 transport. Before doing so, set up variables that are relevant to a
2935 single delivery. */
2936
2937 deliver_set_expansions(addr);
2938 delivery_start = time(NULL);
2939 deliver_local(addr, FALSE);
2940 deliver_time = (int)(time(NULL) - delivery_start);
2941
2942 /* If a shadow transport (which must perforce be another local transport), is
2943 defined, and its condition is met, we must pass the message to the shadow
2944 too, but only those addresses that succeeded. We do this by making a new
2945 chain of addresses - also to keep the original chain uncontaminated. We must
2946 use a chain rather than doing it one by one, because the shadow transport may
2947 batch.
2948
2949 NOTE: if the condition fails because of a lookup defer, there is nothing we
2950 can do! */
2951
d6c82d7b
JH
2952 if ( tp->shadow
2953 && ( !tp->shadow_condition
2954 || expand_check_condition(tp->shadow_condition, tp->name, US"transport")
2955 ) )
059ec3d9
PH
2956 {
2957 transport_instance *stp;
2958 address_item *shadow_addr = NULL;
2959 address_item **last = &shadow_addr;
2960
d6c82d7b 2961 for (stp = transports; stp; stp = stp->next)
059ec3d9
PH
2962 if (Ustrcmp(stp->name, tp->shadow) == 0) break;
2963
d6c82d7b 2964 if (!stp)
059ec3d9
PH
2965 log_write(0, LOG_MAIN|LOG_PANIC, "shadow transport \"%s\" not found ",
2966 tp->shadow);
2967
2968 /* Pick off the addresses that have succeeded, and make clones. Put into
2969 the shadow_message field a pointer to the shadow_message field of the real
2970 address. */
2971
d6c82d7b
JH
2972 else for (addr2 = addr; addr2; addr2 = addr2->next)
2973 if (addr2->transport_return == OK)
2974 {
2975 addr3 = store_get(sizeof(address_item));
2976 *addr3 = *addr2;
2977 addr3->next = NULL;
2978 addr3->shadow_message = (uschar *) &(addr2->shadow_message);
2979 addr3->transport = stp;
2980 addr3->transport_return = DEFER;
2981 addr3->return_filename = NULL;
2982 addr3->return_file = -1;
2983 *last = addr3;
2984 last = &(addr3->next);
2985 }
059ec3d9
PH
2986
2987 /* If we found any addresses to shadow, run the delivery, and stick any
2988 message back into the shadow_message field in the original. */
2989
d6c82d7b 2990 if (shadow_addr)
059ec3d9
PH
2991 {
2992 int save_count = transport_count;
2993
2994 DEBUG(D_deliver|D_transport)
2995 debug_printf(">>>>>>>>>>>>>>>> Shadow delivery >>>>>>>>>>>>>>>>\n");
2996 deliver_local(shadow_addr, TRUE);
2997
d6c82d7b 2998 for(; shadow_addr; shadow_addr = shadow_addr->next)
059ec3d9
PH
2999 {
3000 int sresult = shadow_addr->transport_return;
d6c82d7b
JH
3001 *(uschar **)shadow_addr->shadow_message =
3002 sresult == OK
3003 ? string_sprintf(" ST=%s", stp->name)
3004 : string_sprintf(" ST=%s (%s%s%s)", stp->name,
3005 shadow_addr->basic_errno <= 0
3006 ? US""
3007 : US strerror(shadow_addr->basic_errno),
3008 shadow_addr->basic_errno <= 0 || !shadow_addr->message
3009 ? US""
3010 : US": ",
3011 shadow_addr->message
3012 ? shadow_addr->message
3013 : shadow_addr->basic_errno <= 0
3014 ? US"unknown error"
3015 : US"");
059ec3d9
PH
3016
3017 DEBUG(D_deliver|D_transport)
3018 debug_printf("%s shadow transport returned %s for %s\n",
3019 stp->name,
d6c82d7b
JH
3020 sresult == OK ? "OK" :
3021 sresult == DEFER ? "DEFER" :
3022 sresult == FAIL ? "FAIL" :
3023 sresult == PANIC ? "PANIC" : "?",
059ec3d9
PH
3024 shadow_addr->address);
3025 }
3026
3027 DEBUG(D_deliver|D_transport)
3028 debug_printf(">>>>>>>>>>>>>>>> End shadow delivery >>>>>>>>>>>>>>>>\n");
3029
3030 transport_count = save_count; /* Restore original transport count */
3031 }
3032 }
3033
3034 /* Cancel the expansions that were set up for the delivery. */
3035
3036 deliver_set_expansions(NULL);
3037
fa41615d
JH
3038 /* If the transport was parallelism-limited, decrement the hints DB record. */
3039
3040 if (serialize_key) enq_end(serialize_key);
3041
059ec3d9
PH
3042 /* Now we can process the results of the real transport. We must take each
3043 address off the chain first, because post_process_one() puts it on another
3044 chain. */
3045
d6c82d7b 3046 for (addr2 = addr; addr2; addr2 = nextaddr)
059ec3d9
PH
3047 {
3048 int result = addr2->transport_return;
3049 nextaddr = addr2->next;
3050
3051 DEBUG(D_deliver|D_transport)
3052 debug_printf("%s transport returned %s for %s\n",
3053 tp->name,
d6c82d7b
JH
3054 result == OK ? "OK" :
3055 result == DEFER ? "DEFER" :
3056 result == FAIL ? "FAIL" :
3057 result == PANIC ? "PANIC" : "?",
059ec3d9
PH
3058 addr2->address);
3059
3060 /* If there is a retry_record, or if delivery is deferred, build a retry
3061 item for setting a new retry time or deleting the old retry record from
3062 the database. These items are handled all together after all addresses
3063 have been handled (so the database is open just for a short time for
3064 updating). */
3065
3066 if (result == DEFER || testflag(addr2, af_lt_retry_exists))
3067 {
d6c82d7b
JH
3068 int flags = result == DEFER ? 0 : rf_delete;
3069 uschar *retry_key = string_copy(tp->retry_use_local_part
3070 ? addr2->address_retry_key : addr2->domain_retry_key);
059ec3d9
PH
3071 *retry_key = 'T';
3072 retry_add_item(addr2, retry_key, flags);
3073 }
3074
3075 /* Done with this address */
3076
3077 if (result == OK) addr2->more_errno = deliver_time;
3078 post_process_one(addr2, result, logflags, DTYPE_TRANSPORT, logchar);
3079
3080 /* If a pipe delivery generated text to be sent back, the result may be
3081 changed to FAIL, and we must copy this for subsequent addresses in the
3082 batch. */
3083
3084 if (addr2->transport_return != result)
3085 {
d6c82d7b 3086 for (addr3 = nextaddr; addr3; addr3 = addr3->next)
059ec3d9
PH
3087 {
3088 addr3->transport_return = addr2->transport_return;
3089 addr3->basic_errno = addr2->basic_errno;
3090 addr3->message = addr2->message;
3091 }
3092 result = addr2->transport_return;
3093 }
3094
3095 /* Whether or not the result was changed to FAIL, we need to copy the
3096 return_file value from the first address into all the addresses of the
3097 batch, so they are all listed in the error message. */
3098
3099 addr2->return_file = addr->return_file;
3100
3101 /* Change log character for recording successful deliveries. */
3102
3103 if (result == OK) logchar = '-';
3104 }
3105 } /* Loop back for next batch of addresses */
3106}
3107
3108
3109
3110
3111/*************************************************
3112* Sort remote deliveries *
3113*************************************************/
3114
3115/* This function is called if remote_sort_domains is set. It arranges that the
3116chain of addresses for remote deliveries is ordered according to the strings
3117specified. Try to make this shuffling reasonably efficient by handling
3118sequences of addresses rather than just single ones.
3119
3120Arguments: None
3121Returns: Nothing
3122*/
3123
3124static void
3125sort_remote_deliveries(void)
3126{
3127int sep = 0;
3128address_item **aptr = &addr_remote;
55414b25 3129const uschar *listptr = remote_sort_domains;
059ec3d9
PH
3130uschar *pattern;
3131uschar patbuf[256];
3132
d6c82d7b
JH
3133while ( *aptr
3134 && (pattern = string_nextinlist(&listptr, &sep, patbuf, sizeof(patbuf)))
3135 )
059ec3d9
PH
3136 {
3137 address_item *moved = NULL;
3138 address_item **bptr = &moved;
3139
d6c82d7b 3140 while (*aptr)
059ec3d9
PH
3141 {
3142 address_item **next;
3143 deliver_domain = (*aptr)->domain; /* set $domain */
55414b25 3144 if (match_isinlist(deliver_domain, (const uschar **)&pattern, UCHAR_MAX+1,
059ec3d9
PH
3145 &domainlist_anchor, NULL, MCL_DOMAIN, TRUE, NULL) == OK)
3146 {
d6c82d7b 3147 aptr = &(*aptr)->next;
059ec3d9
PH
3148 continue;
3149 }
3150
d6c82d7b
JH
3151 next = &(*aptr)->next;
3152 while ( *next
3153 && (deliver_domain = (*next)->domain, /* Set $domain */
55414b25 3154 match_isinlist(deliver_domain, (const uschar **)&pattern, UCHAR_MAX+1,
d6c82d7b
JH
3155 &domainlist_anchor, NULL, MCL_DOMAIN, TRUE, NULL)) != OK
3156 )
3157 next = &(*next)->next;
059ec3d9
PH
3158
3159 /* If the batch of non-matchers is at the end, add on any that were
3160 extracted further up the chain, and end this iteration. Otherwise,
3161 extract them from the chain and hang on the moved chain. */
3162
d6c82d7b 3163 if (!*next)
059ec3d9
PH
3164 {
3165 *next = moved;
3166 break;
3167 }
3168
3169 *bptr = *aptr;
3170 *aptr = *next;
3171 *next = NULL;
3172 bptr = next;
d6c82d7b 3173 aptr = &(*aptr)->next;
059ec3d9
PH
3174 }
3175
3176 /* If the loop ended because the final address matched, *aptr will
3177 be NULL. Add on to the end any extracted non-matching addresses. If
3178 *aptr is not NULL, the loop ended via "break" when *next is null, that
3179 is, there was a string of non-matching addresses at the end. In this
3180 case the extracted addresses have already been added on the end. */
3181
d6c82d7b 3182 if (!*aptr) *aptr = moved;
059ec3d9
PH
3183 }
3184
3185DEBUG(D_deliver)
3186 {
3187 address_item *addr;
3188 debug_printf("remote addresses after sorting:\n");
d6c82d7b 3189 for (addr = addr_remote; addr; addr = addr->next)
059ec3d9
PH
3190 debug_printf(" %s\n", addr->address);
3191 }
3192}
3193
3194
3195
3196/*************************************************
3197* Read from pipe for remote delivery subprocess *
3198*************************************************/
3199
3200/* This function is called when the subprocess is complete, but can also be
3201called before it is complete, in order to empty a pipe that is full (to prevent
3202deadlock). It must therefore keep track of its progress in the parlist data
3203block.
3204
3205We read the pipe to get the delivery status codes and a possible error message
3206for each address, optionally preceded by unusability data for the hosts and
3207also by optional retry data.
3208
3209Read in large chunks into the big buffer and then scan through, interpreting
3210the data therein. In most cases, only a single read will be necessary. No
1c5466b9
PH
3211individual item will ever be anywhere near 2500 bytes in length, so by ensuring
3212that we read the next chunk when there is less than 2500 bytes left in the
3213non-final chunk, we can assume each item is complete in the buffer before
3214handling it. Each item is written using a single write(), which is atomic for
3215small items (less than PIPE_BUF, which seems to be at least 512 in any Unix and
3216often bigger) so even if we are reading while the subprocess is still going, we
3217should never have only a partial item in the buffer.
059ec3d9
PH
3218
3219Argument:
3220 poffset the offset of the parlist item
3221 eop TRUE if the process has completed
3222
3223Returns: TRUE if the terminating 'Z' item has been read,
3224 or there has been a disaster (i.e. no more data needed);
3225 FALSE otherwise
3226*/
3227
3228static BOOL
3229par_read_pipe(int poffset, BOOL eop)
3230{
3231host_item *h;
3232pardata *p = parlist + poffset;
3233address_item *addrlist = p->addrlist;
3234address_item *addr = p->addr;
3235pid_t pid = p->pid;
3236int fd = p->fd;
3237uschar *endptr = big_buffer;
3238uschar *ptr = endptr;
3239uschar *msg = p->msg;
3240BOOL done = p->done;
3241BOOL unfinished = TRUE;
bd21a787
WB
3242/* minimum size to read is header size including id, subid and length */
3243int required = PIPE_HEADER_SIZE;
059ec3d9
PH
3244
3245/* Loop through all items, reading from the pipe when necessary. The pipe
3246is set up to be non-blocking, but there are two different Unix mechanisms in
3247use. Exim uses O_NONBLOCK if it is defined. This returns 0 for end of file,
3248and EAGAIN for no more data. If O_NONBLOCK is not defined, Exim uses O_NDELAY,
3249which returns 0 for both end of file and no more data. We distinguish the
3250two cases by taking 0 as end of file only when we know the process has
3251completed.
3252
3253Each separate item is written to the pipe in a single write(), and as they are
3254all short items, the writes will all be atomic and we should never find
8e669ac1
PH
3255ourselves in the position of having read an incomplete item. "Short" in this
3256case can mean up to about 1K in the case when there is a long error message
1c5466b9 3257associated with an address. */
059ec3d9
PH
3258
3259DEBUG(D_deliver) debug_printf("reading pipe for subprocess %d (%s)\n",
3260 (int)p->pid, eop? "ended" : "not ended");
3261
3262while (!done)
3263 {
3264 retry_item *r, **rp;
3265 int remaining = endptr - ptr;
bd21a787
WB
3266 uschar header[PIPE_HEADER_SIZE + 1];
3267 uschar id, subid;
3268 uschar *endc;
059ec3d9
PH
3269
3270 /* Read (first time) or top up the chars in the buffer if necessary.
3271 There will be only one read if we get all the available data (i.e. don't
3272 fill the buffer completely). */
3273
bd21a787 3274 if (remaining < required && unfinished)
059ec3d9
PH
3275 {
3276 int len;
3277 int available = big_buffer_size - remaining;
3278
3279 if (remaining > 0) memmove(big_buffer, ptr, remaining);
3280
3281 ptr = big_buffer;
3282 endptr = big_buffer + remaining;
3283 len = read(fd, endptr, available);
3284
3285 DEBUG(D_deliver) debug_printf("read() yielded %d\n", len);
3286
3287 /* If the result is EAGAIN and the process is not complete, just
3288 stop reading any more and process what we have already. */
3289
3290 if (len < 0)
3291 {
3292 if (!eop && errno == EAGAIN) len = 0; else
3293 {
3294 msg = string_sprintf("failed to read pipe from transport process "
3295 "%d for transport %s: %s", pid, addr->transport->driver_name,
3296 strerror(errno));
3297 break;
3298 }
3299 }
3300
3301 /* If the length is zero (eof or no-more-data), just process what we
3302 already have. Note that if the process is still running and we have
3303 read all the data in the pipe (but less that "available") then we
3304 won't read any more, as "unfinished" will get set FALSE. */
3305
3306 endptr += len;
bd21a787 3307 remaining += len;
059ec3d9
PH
3308 unfinished = len == available;
3309 }
3310
3311 /* If we are at the end of the available data, exit the loop. */
059ec3d9
PH
3312 if (ptr >= endptr) break;
3313
bd21a787
WB
3314 /* copy and read header */
3315 memcpy(header, ptr, PIPE_HEADER_SIZE);
94431adb 3316 header[PIPE_HEADER_SIZE] = '\0';
bd21a787
WB
3317 id = header[0];
3318 subid = header[1];
3319 required = Ustrtol(header + 2, &endc, 10) + PIPE_HEADER_SIZE; /* header + data */
3320 if (*endc)
3321 {
3322 msg = string_sprintf("failed to read pipe from transport process "
3323 "%d for transport %s: error reading size from header", pid, addr->transport->driver_name);
3324 done = TRUE;
3325 break;
3326 }
3327
3328 DEBUG(D_deliver)
94431adb 3329 debug_printf("header read id:%c,subid:%c,size:%s,required:%d,remaining:%d,unfinished:%d\n",
bd21a787
WB
3330 id, subid, header+2, required, remaining, unfinished);
3331
3332 /* is there room for the dataset we want to read ? */
3333 if (required > big_buffer_size - PIPE_HEADER_SIZE)
3334 {
3335 msg = string_sprintf("failed to read pipe from transport process "
3336 "%d for transport %s: big_buffer too small! required size=%d buffer size=%d", pid, addr->transport->driver_name,
3337 required, big_buffer_size - PIPE_HEADER_SIZE);
3338 done = TRUE;
3339 break;
3340 }
3341
94431adb 3342 /* we wrote all datasets with atomic write() calls
bd21a787 3343 remaining < required only happens if big_buffer was too small
94431adb 3344 to get all available data from pipe. unfinished has to be true
bd21a787
WB
3345 as well. */
3346 if (remaining < required)
8fa0a4d4 3347 {
bd21a787
WB
3348 if (unfinished)
3349 continue;
8fa0a4d4 3350 msg = string_sprintf("failed to read pipe from transport process "
94431adb 3351 "%d for transport %s: required size=%d > remaining size=%d and unfinished=false",
8fa0a4d4
JH
3352 pid, addr->transport->driver_name, required, remaining);
3353 done = TRUE;
3354 break;
3355 }
bd21a787
WB
3356
3357 /* step behind the header */
3358 ptr += PIPE_HEADER_SIZE;
94431adb 3359
059ec3d9
PH
3360 /* Handle each possible type of item, assuming the complete item is
3361 available in store. */
3362
bd21a787 3363 switch (id)
059ec3d9
PH
3364 {
3365 /* Host items exist only if any hosts were marked unusable. Match
3366 up by checking the IP address. */
3367
3368 case 'H':
d6c82d7b 3369 for (h = addrlist->host_list; h; h = h->next)
059ec3d9 3370 {
d6c82d7b 3371 if (!h->address || Ustrcmp(h->address, ptr+2) != 0) continue;
059ec3d9
PH
3372 h->status = ptr[0];
3373 h->why = ptr[1];
3374 }
3375 ptr += 2;
3376 while (*ptr++);
3377 break;
3378
3379 /* Retry items are sent in a preceding R item for each address. This is
3380 kept separate to keep each message short enough to guarantee it won't
3381 be split in the pipe. Hopefully, in the majority of cases, there won't in
3382 fact be any retry items at all.
3383
3384 The complete set of retry items might include an item to delete a
3385 routing retry if there was a previous routing delay. However, routing
3386 retries are also used when a remote transport identifies an address error.
3387 In that case, there may also be an "add" item for the same key. Arrange
3388 that a "delete" item is dropped in favour of an "add" item. */
3389
3390 case 'R':
d6c82d7b 3391 if (!addr) goto ADDR_MISMATCH;
059ec3d9
PH
3392
3393 DEBUG(D_deliver|D_retry)
3394 debug_printf("reading retry information for %s from subprocess\n",
3395 ptr+1);
3396
3397 /* Cut out any "delete" items on the list. */
3398
d6c82d7b 3399 for (rp = &(addr->retries); (r = *rp); rp = &r->next)
059ec3d9
PH
3400 if (Ustrcmp(r->key, ptr+1) == 0) /* Found item with same key */
3401 {
3402 if ((r->flags & rf_delete) == 0) break; /* It was not "delete" */
3403 *rp = r->next; /* Excise a delete item */
3404 DEBUG(D_deliver|D_retry)
3405 debug_printf(" existing delete item dropped\n");
3406 }
059ec3d9
PH
3407
3408 /* We want to add a delete item only if there is no non-delete item;
3409 however we still have to step ptr through the data. */
3410
d6c82d7b 3411 if (!r || (*ptr & rf_delete) == 0)
059ec3d9
PH
3412 {
3413 r = store_get(sizeof(retry_item));
3414 r->next = addr->retries;
3415 addr->retries = r;
3416 r->flags = *ptr++;
3417 r->key = string_copy(ptr);
3418 while (*ptr++);
3419 memcpy(&(r->basic_errno), ptr, sizeof(r->basic_errno));
3420 ptr += sizeof(r->basic_errno);
3421 memcpy(&(r->more_errno), ptr, sizeof(r->more_errno));
3422 ptr += sizeof(r->more_errno);
3423 r->message = (*ptr)? string_copy(ptr) : NULL;
3424 DEBUG(D_deliver|D_retry)
3425 debug_printf(" added %s item\n",
3426 ((r->flags & rf_delete) == 0)? "retry" : "delete");
3427 }
3428
3429 else
3430 {
3431 DEBUG(D_deliver|D_retry)
3432 debug_printf(" delete item not added: non-delete item exists\n");
3433 ptr++;
3434 while(*ptr++);
3435 ptr += sizeof(r->basic_errno) + sizeof(r->more_errno);
3436 }
3437
3438 while(*ptr++);
3439 break;
3440
3441 /* Put the amount of data written into the parlist block */
3442
3443 case 'S':
3444 memcpy(&(p->transport_count), ptr, sizeof(transport_count));
3445 ptr += sizeof(transport_count);
3446 break;
3447
3448 /* Address items are in the order of items on the address chain. We
3449 remember the current address value in case this function is called
3450 several times to empty the pipe in stages. Information about delivery
3451 over TLS is sent in a preceding X item for each address. We don't put
3452 it in with the other info, in order to keep each message short enough to
3453 guarantee it won't be split in the pipe. */
3454
a7538db1 3455#ifdef SUPPORT_TLS
059ec3d9 3456 case 'X':
d6c82d7b 3457 if (!addr) goto ADDR_MISMATCH; /* Below, in 'A' handler */
bd21a787 3458 switch (subid)
9d1c15ef
JH
3459 {
3460 case '1':
3461 addr->cipher = NULL;
3462 addr->peerdn = NULL;
3463
3464 if (*ptr)
3465 addr->cipher = string_copy(ptr);
3466 while (*ptr++);
3467 if (*ptr)
9d1c15ef 3468 addr->peerdn = string_copy(ptr);
9d1c15ef
JH
3469 break;
3470
3471 case '2':
9d1c15ef
JH
3472 if (*ptr)
3473 (void) tls_import_cert(ptr, &addr->peercert);
152e7604
JH
3474 else
3475 addr->peercert = NULL;
9d1c15ef
JH
3476 break;
3477
3478 case '3':
9d1c15ef
JH
3479 if (*ptr)
3480 (void) tls_import_cert(ptr, &addr->ourcert);
152e7604
JH
3481 else
3482 addr->ourcert = NULL;
9d1c15ef 3483 break;
018058b2 3484
a7538db1 3485# ifndef DISABLE_OCSP
018058b2
JH
3486 case '4':
3487 addr->ocsp = OCSP_NOT_REQ;
3488 if (*ptr)
3489 addr->ocsp = *ptr - '0';
3490 break;
a7538db1 3491# endif
9d1c15ef 3492 }
059ec3d9
PH
3493 while (*ptr++);
3494 break;
a7538db1 3495#endif /*SUPPORT_TLS*/
059ec3d9 3496
6f123593 3497 case 'C': /* client authenticator information */
bd21a787 3498 switch (subid)
9d1c15ef
JH
3499 {
3500 case '1':
3501 addr->authenticator = (*ptr)? string_copy(ptr) : NULL;
3502 break;
3503 case '2':
3504 addr->auth_id = (*ptr)? string_copy(ptr) : NULL;
3505 break;
3506 case '3':
3507 addr->auth_sndr = (*ptr)? string_copy(ptr) : NULL;
3508 break;
3509 }
6f123593
JH
3510 while (*ptr++);
3511 break;
3512
8ccd00b1 3513#ifndef DISABLE_PRDR
fd98a5c6 3514 case 'P':
8ccd00b1
JH
3515 addr->flags |= af_prdr_used;
3516 break;
fd98a5c6
JH
3517#endif
3518
e0cc6cda
JH
3519 case 'K':
3520 addr->flags |= af_chunking_used;
3521 break;
3522
6c1c3d1d 3523 case 'D':
d6c82d7b 3524 if (!addr) goto ADDR_MISMATCH;
6c1c3d1d
WB
3525 memcpy(&(addr->dsn_aware), ptr, sizeof(addr->dsn_aware));
3526 ptr += sizeof(addr->dsn_aware);
3527 DEBUG(D_deliver) debug_printf("DSN read: addr->dsn_aware = %d\n", addr->dsn_aware);
3528 break;
6c1c3d1d 3529
059ec3d9 3530 case 'A':
d6c82d7b 3531 if (!addr)
059ec3d9
PH
3532 {
3533 ADDR_MISMATCH:
3534 msg = string_sprintf("address count mismatch for data read from pipe "
3535 "for transport process %d for transport %s", pid,
3536 addrlist->transport->driver_name);
3537 done = TRUE;
3538 break;
3539 }
3540
895fbaf2 3541 switch (subid)
059ec3d9 3542 {
e6d2a989
JH
3543#ifdef SUPPORT_SOCKS
3544 case '2': /* proxy information; must arrive before A0 and applies to that addr XXX oops*/
4c04137d 3545 proxy_session = TRUE; /*XXX should this be cleared somewhere? */
e6d2a989
JH
3546 if (*ptr == 0)
3547 ptr++;
3548 else
3549 {
3550 proxy_local_address = string_copy(ptr);
3551 while(*ptr++);
3552 memcpy(&proxy_local_port, ptr, sizeof(proxy_local_port));
3553 ptr += sizeof(proxy_local_port);
3554 }
3555 break;
3556#endif
3557
895fbaf2
JH
3558#ifdef EXPERIMENTAL_DSN_INFO
3559 case '1': /* must arrive before A0, and applies to that addr */
3560 /* Two strings: smtp_greeting and helo_response */
3561 addr->smtp_greeting = string_copy(ptr);
3562 while(*ptr++);
3563 addr->helo_response = string_copy(ptr);
3564 while(*ptr++);
3565 break;
3566#endif
059ec3d9 3567
895fbaf2
JH
3568 case '0':
3569 addr->transport_return = *ptr++;
3570 addr->special_action = *ptr++;
3571 memcpy(&(addr->basic_errno), ptr, sizeof(addr->basic_errno));
3572 ptr += sizeof(addr->basic_errno);
3573 memcpy(&(addr->more_errno), ptr, sizeof(addr->more_errno));
3574 ptr += sizeof(addr->more_errno);
3575 memcpy(&(addr->flags), ptr, sizeof(addr->flags));
3576 ptr += sizeof(addr->flags);
3577 addr->message = (*ptr)? string_copy(ptr) : NULL;
3578 while(*ptr++);
3579 addr->user_message = (*ptr)? string_copy(ptr) : NULL;
3580 while(*ptr++);
059ec3d9 3581
895fbaf2
JH
3582 /* Always two strings for host information, followed by the port number and DNSSEC mark */
3583
3584 if (*ptr != 0)
3585 {
3586 h = store_get(sizeof(host_item));
3587 h->name = string_copy(ptr);
3588 while (*ptr++);
3589 h->address = string_copy(ptr);
3590 while(*ptr++);
3591 memcpy(&(h->port), ptr, sizeof(h->port));
3592 ptr += sizeof(h->port);
3593 h->dnssec = *ptr == '2' ? DS_YES
3594 : *ptr == '1' ? DS_NO
3595 : DS_UNK;
3596 ptr++;
3597 addr->host_used = h;
3598 }
3599 else ptr++;
3600
3601 /* Finished with this address */
3602
3603 addr = addr->next;
3604 break;
3605 }
059ec3d9
PH
3606 break;
3607
aeaf5db3
JH
3608 /* Local interface address/port */
3609 case 'I':
3610 if (*ptr) sending_ip_address = string_copy(ptr);
3611 while (*ptr++) ;
93a6fce2 3612 if (*ptr) sending_port = atoi(CS ptr);
aeaf5db3
JH
3613 while (*ptr++) ;
3614 break;
3615
059ec3d9
PH
3616 /* Z marks the logical end of the data. It is followed by '0' if
3617 continue_transport was NULL at the end of transporting, otherwise '1'.
3618 We need to know when it becomes NULL during a delivery down a passed SMTP
3619 channel so that we don't try to pass anything more down it. Of course, for
3620 most normal messages it will remain NULL all the time. */
3621
3622 case 'Z':
3623 if (*ptr == '0')
3624 {
3625 continue_transport = NULL;
3626 continue_hostname = NULL;
3627 }
3628 done = TRUE;
bd21a787 3629 DEBUG(D_deliver) debug_printf("Z0%c item read\n", *ptr);
059ec3d9
PH
3630 break;
3631
3632 /* Anything else is a disaster. */
3633
3634 default:
3635 msg = string_sprintf("malformed data (%d) read from pipe for transport "
3636 "process %d for transport %s", ptr[-1], pid,
3637 addr->transport->driver_name);
3638 done = TRUE;
3639 break;
3640 }
3641 }
3642
3643/* The done flag is inspected externally, to determine whether or not to
3644call the function again when the process finishes. */
3645
3646p->done = done;
3647
3648/* If the process hadn't finished, and we haven't seen the end of the data
3649or suffered a disaster, update the rest of the state, and return FALSE to
3650indicate "not finished". */
3651
3652if (!eop && !done)
3653 {
3654 p->addr = addr;
3655 p->msg = msg;
3656 return FALSE;
3657 }
3658
3659/* Close our end of the pipe, to prevent deadlock if the far end is still
3660pushing stuff into it. */
3661
f1e894f3 3662(void)close(fd);
059ec3d9
PH
3663p->fd = -1;
3664
3665/* If we have finished without error, but haven't had data for every address,
3666something is wrong. */
3667
d6c82d7b 3668if (!msg && addr)
059ec3d9
PH
3669 msg = string_sprintf("insufficient address data read from pipe "
3670 "for transport process %d for transport %s", pid,
3671 addr->transport->driver_name);
3672
3673/* If an error message is set, something has gone wrong in getting back
3674the delivery data. Put the message into each address and freeze it. */
3675
d6c82d7b
JH
3676if (msg)
3677 for (addr = addrlist; addr; addr = addr->next)
059ec3d9
PH
3678 {
3679 addr->transport_return = DEFER;
3680 addr->special_action = SPECIAL_FREEZE;
3681 addr->message = msg;
3682 }
059ec3d9
PH
3683
3684/* Return TRUE to indicate we have got all we need from this process, even
3685if it hasn't actually finished yet. */
3686
3687return TRUE;
3688}
3689
3690
3691
3692/*************************************************
3693* Post-process a set of remote addresses *
3694*************************************************/
3695
3696/* Do what has to be done immediately after a remote delivery for each set of
3697addresses, then re-write the spool if necessary. Note that post_process_one
3698puts the address on an appropriate queue; hence we must fish off the next
3699one first. This function is also called if there is a problem with setting
3700up a subprocess to do a remote delivery in parallel. In this case, the final
3701argument contains a message, and the action must be forced to DEFER.
3702
3703Argument:
3704 addr pointer to chain of address items
3705 logflags flags for logging
3706 msg NULL for normal cases; -> error message for unexpected problems
3707 fallback TRUE if processing fallback hosts
3708
3709Returns: nothing
3710*/
3711
3712static void
3713remote_post_process(address_item *addr, int logflags, uschar *msg,
3714 BOOL fallback)
3715{
3716host_item *h;
3717
3718/* If any host addresses were found to be unusable, add them to the unusable
3719tree so that subsequent deliveries don't try them. */
3720
d6c82d7b
JH
3721for (h = addr->host_list; h; h = h->next)
3722 if (h->address)
3723 if (h->status >= hstatus_unusable) tree_add_unusable(h);
059ec3d9
PH
3724
3725/* Now handle each address on the chain. The transport has placed '=' or '-'
3726into the special_action field for each successful delivery. */
3727
d6c82d7b 3728while (addr)
059ec3d9
PH
3729 {
3730 address_item *next = addr->next;
3731
3732 /* If msg == NULL (normal processing) and the result is DEFER and we are
3733 processing the main hosts and there are fallback hosts available, put the
3734 address on the list for fallback delivery. */
3735
d6c82d7b
JH
3736 if ( addr->transport_return == DEFER
3737 && addr->fallback_hosts
3738 && !fallback
3739 && !msg
3740 )
059ec3d9
PH
3741 {
3742 addr->host_list = addr->fallback_hosts;
3743 addr->next = addr_fallback;
3744 addr_fallback = addr;
3745 DEBUG(D_deliver) debug_printf("%s queued for fallback host(s)\n", addr->address);
3746 }
3747
3748 /* If msg is set (=> unexpected problem), set it in the address before
3749 doing the ordinary post processing. */
3750
3751 else
3752 {
d6c82d7b 3753 if (msg)
059ec3d9
PH
3754 {
3755 addr->message = msg;
3756 addr->transport_return = DEFER;
3757 }
3758 (void)post_process_one(addr, addr->transport_return, logflags,
3759 DTYPE_TRANSPORT, addr->special_action);
3760 }
3761
3762 /* Next address */
3763
3764 addr = next;
3765 }
3766
3767/* If we have just delivered down a passed SMTP channel, and that was
3768the last address, the channel will have been closed down. Now that
3769we have logged that delivery, set continue_sequence to 1 so that
3770any subsequent deliveries don't get "*" incorrectly logged. */
3771
d6c82d7b 3772if (!continue_transport) continue_sequence = 1;
059ec3d9
PH
3773}
3774
3775
3776
3777/*************************************************
3778* Wait for one remote delivery subprocess *
3779*************************************************/
3780
3781/* This function is called while doing remote deliveries when either the
3782maximum number of processes exist and we need one to complete so that another
3783can be created, or when waiting for the last ones to complete. It must wait for
3784the completion of one subprocess, empty the control block slot, and return a
3785pointer to the address chain.
3786
3787Arguments: none
3788Returns: pointer to the chain of addresses handled by the process;
3789 NULL if no subprocess found - this is an unexpected error
3790*/
3791
3792static address_item *
3793par_wait(void)
3794{
3795int poffset, status;
3796address_item *addr, *addrlist;
3797pid_t pid;
3798
3799set_process_info("delivering %s: waiting for a remote delivery subprocess "
3800 "to finish", message_id);
3801
3802/* Loop until either a subprocess completes, or there are no subprocesses in
3803existence - in which case give an error return. We cannot proceed just by
3804waiting for a completion, because a subprocess may have filled up its pipe, and
3805be waiting for it to be emptied. Therefore, if no processes have finished, we
3806wait for one of the pipes to acquire some data by calling select(), with a
3807timeout just in case.
3808
3809The simple approach is just to iterate after reading data from a ready pipe.
3810This leads to non-ideal behaviour when the subprocess has written its final Z
3811item, closed the pipe, and is in the process of exiting (the common case). A
3812call to waitpid() yields nothing completed, but select() shows the pipe ready -
3813reading it yields EOF, so you end up with busy-waiting until the subprocess has
3814actually finished.
3815
3816To avoid this, if all the data that is needed has been read from a subprocess
3817after select(), an explicit wait() for it is done. We know that all it is doing
3818is writing to the pipe and then exiting, so the wait should not be long.
3819
3820The non-blocking waitpid() is to some extent just insurance; if we could
3821reliably detect end-of-file on the pipe, we could always know when to do a
3822blocking wait() for a completed process. However, because some systems use
3823NDELAY, which doesn't distinguish between EOF and pipe empty, it is easier to
3824use code that functions without the need to recognize EOF.
3825
3826There's a double loop here just in case we end up with a process that is not in
3827the list of remote delivery processes. Something has obviously gone wrong if
3828this is the case. (For example, a process that is incorrectly left over from
3829routing or local deliveries might be found.) The damage can be minimized by
3830looping back and looking for another process. If there aren't any, the error
3831return will happen. */
3832
3833for (;;) /* Normally we do not repeat this loop */
3834 {
3835 while ((pid = waitpid(-1, &status, WNOHANG)) <= 0)
3836 {
3837 struct timeval tv;
3838 fd_set select_pipes;
3839 int maxpipe, readycount;
3840
3841 /* A return value of -1 can mean several things. If errno != ECHILD, it
3842 either means invalid options (which we discount), or that this process was
3843 interrupted by a signal. Just loop to try the waitpid() again.
3844
3845 If errno == ECHILD, waitpid() is telling us that there are no subprocesses
3846 in existence. This should never happen, and is an unexpected error.
3847 However, there is a nasty complication when running under Linux. If "strace
3848 -f" is being used under Linux to trace this process and its children,
3849 subprocesses are "stolen" from their parents and become the children of the
3850 tracing process. A general wait such as the one we've just obeyed returns
3851 as if there are no children while subprocesses are running. Once a
3852 subprocess completes, it is restored to the parent, and waitpid(-1) finds
3853 it. Thanks to Joachim Wieland for finding all this out and suggesting a
3854 palliative.
3855
3856 This does not happen using "truss" on Solaris, nor (I think) with other
3857 tracing facilities on other OS. It seems to be specific to Linux.
3858
3859 What we do to get round this is to use kill() to see if any of our
3860 subprocesses are still in existence. If kill() gives an OK return, we know
3861 it must be for one of our processes - it can't be for a re-use of the pid,
3862 because if our process had finished, waitpid() would have found it. If any
3863 of our subprocesses are in existence, we proceed to use select() as if
3864 waitpid() had returned zero. I think this is safe. */
3865
3866 if (pid < 0)
3867 {
3868 if (errno != ECHILD) continue; /* Repeats the waitpid() */
3869
3870 DEBUG(D_deliver)
3871 debug_printf("waitpid() returned -1/ECHILD: checking explicitly "
3872 "for process existence\n");
3873
3874 for (poffset = 0; poffset < remote_max_parallel; poffset++)
3875 {
3876 if ((pid = parlist[poffset].pid) != 0 && kill(pid, 0) == 0)
3877 {
3878 DEBUG(D_deliver) debug_printf("process %d still exists: assume "
3879 "stolen by strace\n", (int)pid);
3880 break; /* With poffset set */
3881 }
3882 }
3883
3884 if (poffset >= remote_max_parallel)
3885 {
3886 DEBUG(D_deliver) debug_printf("*** no delivery children found\n");
3887 return NULL; /* This is the error return */
3888 }
3889 }
3890
3891 /* A pid value greater than 0 breaks the "while" loop. A negative value has
3892 been handled above. A return value of zero means that there is at least one
3893 subprocess, but there are no completed subprocesses. See if any pipes are
3894 ready with any data for reading. */
3895
3896 DEBUG(D_deliver) debug_printf("selecting on subprocess pipes\n");
3897
3898 maxpipe = 0;
3899 FD_ZERO(&select_pipes);
3900 for (poffset = 0; poffset < remote_max_parallel; poffset++)
3901 {
3902 if (parlist[poffset].pid != 0)
3903 {
3904 int fd = parlist[poffset].fd;
3905 FD_SET(fd, &select_pipes);
3906 if (fd > maxpipe) maxpipe = fd;
3907 }
3908 }
3909
3910 /* Stick in a 60-second timeout, just in case. */
3911
3912 tv.tv_sec = 60;
3913 tv.tv_usec = 0;
3914
3915 readycount = select(maxpipe + 1, (SELECT_ARG2_TYPE *)&select_pipes,
3916 NULL, NULL, &tv);
3917
3918 /* Scan through the pipes and read any that are ready; use the count
3919 returned by select() to stop when there are no more. Select() can return
3920 with no processes (e.g. if interrupted). This shouldn't matter.
3921
3922 If par_read_pipe() returns TRUE, it means that either the terminating Z was
3923 read, or there was a disaster. In either case, we are finished with this
3924 process. Do an explicit wait() for the process and break the main loop if
3925 it succeeds.
3926
3927 It turns out that we have to deal with the case of an interrupted system
3928 call, which can happen on some operating systems if the signal handling is
3929 set up to do that by default. */
3930
3931 for (poffset = 0;
3932 readycount > 0 && poffset < remote_max_parallel;
3933 poffset++)
3934 {
d6c82d7b
JH
3935 if ( (pid = parlist[poffset].pid) != 0
3936 && FD_ISSET(parlist[poffset].fd, &select_pipes)
3937 )
059ec3d9
PH
3938 {
3939 readycount--;
3940 if (par_read_pipe(poffset, FALSE)) /* Finished with this pipe */
3941 {
3942 for (;;) /* Loop for signals */
3943 {
3944 pid_t endedpid = waitpid(pid, &status, 0);
3945 if (endedpid == pid) goto PROCESS_DONE;
3946 if (endedpid != (pid_t)(-1) || errno != EINTR)
3947 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Unexpected error return "
3948 "%d (errno = %d) from waitpid() for process %d",
3949 (int)endedpid, errno, (int)pid);
3950 }
3951 }
3952 }
3953 }
3954
3955 /* Now go back and look for a completed subprocess again. */
3956 }
3957
3958 /* A completed process was detected by the non-blocking waitpid(). Find the
3959 data block that corresponds to this subprocess. */
3960
3961 for (poffset = 0; poffset < remote_max_parallel; poffset++)
3962 if (pid == parlist[poffset].pid) break;
3963
3964 /* Found the data block; this is a known remote delivery process. We don't
3965 need to repeat the outer loop. This should be what normally happens. */
3966
3967 if (poffset < remote_max_parallel) break;
3968
3969 /* This situation is an error, but it's probably better to carry on looking
3970 for another process than to give up (as we used to do). */
3971
3972 log_write(0, LOG_MAIN|LOG_PANIC, "Process %d finished: not found in remote "
3973 "transport process list", pid);
3974 } /* End of the "for" loop */
3975
3976/* Come here when all the data was completely read after a select(), and
3977the process in pid has been wait()ed for. */
3978
3979PROCESS_DONE:
3980
3981DEBUG(D_deliver)
3982 {
3983 if (status == 0)
3984 debug_printf("remote delivery process %d ended\n", (int)pid);
3985 else
3986 debug_printf("remote delivery process %d ended: status=%04x\n", (int)pid,
3987 status);
3988 }
3989
3990set_process_info("delivering %s", message_id);
3991
3992/* Get the chain of processed addresses */
3993
3994addrlist = parlist[poffset].addrlist;
3995
3996/* If the process did not finish cleanly, record an error and freeze (except
3997for SIGTERM, SIGKILL and SIGQUIT), and also ensure the journal is not removed,
3998in case the delivery did actually happen. */
3999
4000if ((status & 0xffff) != 0)
4001 {
4002 uschar *msg;
4003 int msb = (status >> 8) & 255;
4004 int lsb = status & 255;
4005 int code = (msb == 0)? (lsb & 0x7f) : msb;
4006
4007 msg = string_sprintf("%s transport process returned non-zero status 0x%04x: "
4008 "%s %d",
4009 addrlist->transport->driver_name,
4010 status,
4011 (msb == 0)? "terminated by signal" : "exit code",
4012 code);
4013
4014 if (msb != 0 || (code != SIGTERM && code != SIGKILL && code != SIGQUIT))
4015 addrlist->special_action = SPECIAL_FREEZE;
4016
d6c82d7b 4017 for (addr = addrlist; addr; addr = addr->next)
059ec3d9
PH
4018 {
4019 addr->transport_return = DEFER;
4020 addr->message = msg;
4021 }
4022
4023 remove_journal = FALSE;
4024 }
4025
4026/* Else complete reading the pipe to get the result of the delivery, if all
4027the data has not yet been obtained. */
4028
4029else if (!parlist[poffset].done) (void)par_read_pipe(poffset, TRUE);
4030
4031/* Put the data count and return path into globals, mark the data slot unused,
4032decrement the count of subprocesses, and return the address chain. */
4033
4034transport_count = parlist[poffset].transport_count;
4035used_return_path = parlist[poffset].return_path;
4036parlist[poffset].pid = 0;
4037parcount--;
4038return addrlist;
4039}
4040
4041
4042
4043/*************************************************
4044* Wait for subprocesses and post-process *
4045*************************************************/
4046
4047/* This function waits for subprocesses until the number that are still running
4048is below a given threshold. For each complete subprocess, the addresses are
4049post-processed. If we can't find a running process, there is some shambles.
4050Better not bomb out, as that might lead to multiple copies of the message. Just
4051log and proceed as if all done.
4052
4053Arguments:
4054 max maximum number of subprocesses to leave running
4055 fallback TRUE if processing fallback hosts
4056
4057Returns: nothing
4058*/
4059
4060static void
4061par_reduce(int max, BOOL fallback)
4062{
4063while (parcount > max)
4064 {
4065 address_item *doneaddr = par_wait();
d6c82d7b 4066 if (!doneaddr)
059ec3d9
PH
4067 {
4068 log_write(0, LOG_MAIN|LOG_PANIC,
4069 "remote delivery process count got out of step");
4070 parcount = 0;
4071 }
fa41615d
JH
4072 else
4073 {
4074 transport_instance * tp = doneaddr->transport;
4075 if (tp->max_parallel)
4076 enq_end(string_sprintf("tpt-serialize-%s", tp->name));
4077
4078 remote_post_process(doneaddr, LOG_MAIN, NULL, fallback);
4079 }
059ec3d9
PH
4080 }
4081}
4082
4083
4084
4085
1ac6b2e7 4086static void
bd21a787 4087rmt_dlv_checked_write(int fd, char id, char subid, void * buf, int size)
1ac6b2e7 4088{
bd21a787 4089uschar writebuffer[PIPE_HEADER_SIZE + BIG_BUFFER_SIZE];
dc8091e7
JH
4090int header_length;
4091int ret;
bd21a787
WB
4092
4093/* we assume that size can't get larger then BIG_BUFFER_SIZE which currently is set to 16k */
4094/* complain to log if someone tries with buffer sizes we can't handle*/
4095
4096if (size > 99999)
d6c82d7b 4097 {
94431adb 4098 log_write(0, LOG_MAIN|LOG_PANIC_DIE,
bd21a787
WB
4099 "Failed writing transport result to pipe: can't handle buffers > 99999 bytes. truncating!\n");
4100 size = 99999;
d6c82d7b 4101 }
bd21a787
WB
4102
4103/* to keep the write() atomic we build header in writebuffer and copy buf behind */
4104/* two write() calls would increase the complexity of reading from pipe */
4105
4106/* convert size to human readable string prepended by id and subid */
b75960c8 4107header_length = snprintf(CS writebuffer, PIPE_HEADER_SIZE+1, "%c%c%05d", id, subid, size);
bd21a787 4108if (header_length != PIPE_HEADER_SIZE)
d6c82d7b 4109 {
bd21a787
WB
4110 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "header snprintf failed\n");
4111 writebuffer[0] = '\0';
d6c82d7b 4112 }
bd21a787 4113
94431adb 4114DEBUG(D_deliver) debug_printf("header write id:%c,subid:%c,size:%d,final:%s\n",
bd21a787
WB
4115 id, subid, size, writebuffer);
4116
4117if (buf && size > 0)
4118 memcpy(writebuffer + PIPE_HEADER_SIZE, buf, size);
4119
4120size += PIPE_HEADER_SIZE;
dc8091e7 4121if ((ret = write(fd, writebuffer, size)) != size)
1ac6b2e7
JH
4122 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Failed writing transport result to pipe: %s\n",
4123 ret == -1 ? strerror(errno) : "short write");
4124}
4125
059ec3d9
PH
4126/*************************************************
4127* Do remote deliveries *
4128*************************************************/
4129
4130/* This function is called to process the addresses in addr_remote. We must
4131pick off the queue all addresses that have the same transport, remote
4132destination, and errors address, and hand them to the transport in one go,
4133subject to some configured limitations. If this is a run to continue delivering
4134to an existing delivery channel, skip all but those addresses that can go to
4135that channel. The skipped addresses just get deferred.
4136
4137If mua_wrapper is set, all addresses must be able to be sent in a single
4138transaction. If not, this function yields FALSE.
4139
4140In Exim 4, remote deliveries are always done in separate processes, even
4141if remote_max_parallel = 1 or if there's only one delivery to do. The reason
4142is so that the base process can retain privilege. This makes the
4143implementation of fallback transports feasible (though not initially done.)
4144
4145We create up to the configured number of subprocesses, each of which passes
4146back the delivery state via a pipe. (However, when sending down an existing
4147connection, remote_max_parallel is forced to 1.)
4148
4149Arguments:
4150 fallback TRUE if processing fallback hosts
4151
4152Returns: TRUE normally
4153 FALSE if mua_wrapper is set and the addresses cannot all be sent
4154 in one transaction
4155*/
4156
4157static BOOL
4158do_remote_deliveries(BOOL fallback)
4159{
4160int parmax;
4161int delivery_count;
4162int poffset;
4163
4164parcount = 0; /* Number of executing subprocesses */
4165
4166/* When sending down an existing channel, only do one delivery at a time.
4167We use a local variable (parmax) to hold the maximum number of processes;
4168this gets reduced from remote_max_parallel if we can't create enough pipes. */
4169
d6c82d7b 4170if (continue_transport) remote_max_parallel = 1;
059ec3d9
PH
4171parmax = remote_max_parallel;
4172
4173/* If the data for keeping a list of processes hasn't yet been
4174set up, do so. */
4175
d6c82d7b 4176if (!parlist)
059ec3d9
PH
4177 {
4178 parlist = store_get(remote_max_parallel * sizeof(pardata));
4179 for (poffset = 0; poffset < remote_max_parallel; poffset++)
4180 parlist[poffset].pid = 0;
4181 }
4182
4183/* Now loop for each remote delivery */
4184
d6c82d7b 4185for (delivery_count = 0; addr_remote; delivery_count++)
059ec3d9
PH
4186 {
4187 pid_t pid;
4188 uid_t uid;
4189 gid_t gid;
4190 int pfd[2];
4191 int address_count = 1;
4192 int address_count_max;
4193 BOOL multi_domain;
4194 BOOL use_initgroups;
4195 BOOL pipe_done = FALSE;
4196 transport_instance *tp;
4197 address_item **anchor = &addr_remote;
4198 address_item *addr = addr_remote;
4199 address_item *last = addr;
4200 address_item *next;
d6c82d7b 4201 uschar * panicmsg;
fa41615d 4202 uschar * serialize_key = NULL;
059ec3d9
PH
4203
4204 /* Pull the first address right off the list. */
4205
4206 addr_remote = addr->next;
4207 addr->next = NULL;
4208
4209 DEBUG(D_deliver|D_transport)
4210 debug_printf("--------> %s <--------\n", addr->address);
4211
4212 /* If no transport has been set, there has been a big screw-up somewhere. */
4213
d6c82d7b 4214 if (!(tp = addr->transport))
059ec3d9
PH
4215 {
4216 disable_logging = FALSE; /* Jic */
d6c82d7b
JH
4217 panicmsg = US"No transport set by router";
4218 goto panic_continue;
059ec3d9
PH
4219 }
4220
4221 /* Check that this base address hasn't previously been delivered to this
4222 transport. The check is necessary at this point to handle homonymic addresses
4223 correctly in cases where the pattern of redirection changes between delivery
4224 attempts. Non-homonymic previous delivery is detected earlier, at routing
4225 time. */
4226
c2c19e9d 4227 if (previously_transported(addr, FALSE)) continue;
059ec3d9
PH
4228
4229 /* Force failure if the message is too big. */
4230
d6c82d7b 4231 if (tp->message_size_limit)
059ec3d9
PH
4232 {
4233 int rc = check_message_size(tp, addr);
4234 if (rc != OK)
4235 {
4236 addr->transport_return = rc;
4237 remote_post_process(addr, LOG_MAIN, NULL, fallback);
4238 continue;
4239 }
4240 }
4241
4242 /* Get the flag which specifies whether the transport can handle different
506900af
JH
4243 domains that nevertheless resolve to the same set of hosts. If it needs
4244 expanding, get variables set: $address_data, $domain_data, $localpart_data,
4245 $host, $host_address, $host_port. */
4246 if (tp->expand_multi_domain)
4247 deliver_set_expansions(addr);
4248
4249 if (exp_bool(addr, US"transport", tp->name, D_transport,
4250 US"multi_domain", tp->multi_domain, tp->expand_multi_domain,
4251 &multi_domain) != OK)
4252 {
4253 deliver_set_expansions(NULL);
d6c82d7b
JH
4254 panicmsg = addr->message;
4255 goto panic_continue;
506900af 4256 }
059ec3d9
PH
4257
4258 /* Get the maximum it can handle in one envelope, with zero meaning
4259 unlimited, which is forced for the MUA wrapper case. */
4260
4261 address_count_max = tp->max_addresses;
4262 if (address_count_max == 0 || mua_wrapper) address_count_max = 999999;
4263
4264
4265 /************************************************************************/
4266 /***** This is slightly experimental code, but should be safe. *****/
4267
4268 /* The address_count_max value is the maximum number of addresses that the
4269 transport can send in one envelope. However, the transport must be capable of
4270 dealing with any number of addresses. If the number it gets exceeds its
4271 envelope limitation, it must send multiple copies of the message. This can be
4272 done over a single connection for SMTP, so uses less resources than making
4273 multiple connections. On the other hand, if remote_max_parallel is greater
4274 than one, it is perhaps a good idea to use parallel processing to move the
4275 message faster, even if that results in multiple simultaneous connections to
4276 the same host.
4277
4278 How can we come to some compromise between these two ideals? What we do is to
4279 limit the number of addresses passed to a single instance of a transport to
4280 the greater of (a) its address limit (rcpt_max for SMTP) and (b) the total
4281 number of addresses routed to remote transports divided by
4282 remote_max_parallel. For example, if the message has 100 remote recipients,
4283 remote max parallel is 2, and rcpt_max is 10, we'd never send more than 50 at
4284 once. But if rcpt_max is 100, we could send up to 100.
4285
4286 Of course, not all the remotely addresses in a message are going to go to the
4287 same set of hosts (except in smarthost configurations), so this is just a
4288 heuristic way of dividing up the work.
4289
4290 Furthermore (1), because this may not be wanted in some cases, and also to
4291 cope with really pathological cases, there is also a limit to the number of
4292 messages that are sent over one connection. This is the same limit that is
4293 used when sending several different messages over the same connection.
4294 Continue_sequence is set when in this situation, to the number sent so
4295 far, including this message.
4296
4297 Furthermore (2), when somebody explicitly sets the maximum value to 1, it
4298 is probably because they are using VERP, in which case they want to pass only
4299 one address at a time to the transport, in order to be able to use
4300 $local_part and $domain in constructing a new return path. We could test for
4301 the use of these variables, but as it is so likely they will be used when the
4302 maximum is 1, we don't bother. Just leave the value alone. */
4303
d6c82d7b
JH
4304 if ( address_count_max != 1
4305 && address_count_max < remote_delivery_count/remote_max_parallel
4306 )
059ec3d9
PH
4307 {
4308 int new_max = remote_delivery_count/remote_max_parallel;
4309 int message_max = tp->connection_max_messages;
4310 if (connection_max_messages >= 0) message_max = connection_max_messages;
4311 message_max -= continue_sequence - 1;
4312 if (message_max > 0 && new_max > address_count_max * message_max)
4313 new_max = address_count_max * message_max;
4314 address_count_max = new_max;
4315 }
4316
4317 /************************************************************************/
4318
4319
4320 /* Pick off all addresses which have the same transport, errors address,
4321 destination, and extra headers. In some cases they point to the same host
4322 list, but we also need to check for identical host lists generated from
4323 entirely different domains. The host list pointers can be NULL in the case
4324 where the hosts are defined in the transport. There is also a configured
4325 maximum limit of addresses that can be handled at once (see comments above
506900af
JH
4326 for how it is computed).
4327 If the transport does not handle multiple domains, enforce that also,
4328 and if it might need a per-address check for this, re-evaluate it.
4329 */
059ec3d9 4330
d6c82d7b 4331 while ((next = *anchor) && address_count < address_count_max)
059ec3d9 4332 {
506900af
JH
4333 BOOL md;
4334 if ( (multi_domain || Ustrcmp(next->domain, addr->domain) == 0)
4335 && tp == next->transport
4336 && same_hosts(next->host_list, addr->host_list)
d43cbe25
JH
4337 && same_strings(next->prop.errors_address, addr->prop.errors_address)
4338 && same_headers(next->prop.extra_headers, addr->prop.extra_headers)
506900af 4339 && same_ugid(tp, next, addr)
d43cbe25
JH
4340 && ( next->prop.remove_headers == addr->prop.remove_headers
4341 || ( next->prop.remove_headers
4342 && addr->prop.remove_headers
4343 && Ustrcmp(next->prop.remove_headers, addr->prop.remove_headers) == 0
506900af
JH
4344 ) )
4345 && ( !multi_domain
4346 || ( (
845a3ced 4347 (void)(!tp->expand_multi_domain || ((void)deliver_set_expansions(next), 1)),
506900af
JH
4348 exp_bool(addr,
4349 US"transport", next->transport->name, D_transport,
4350 US"multi_domain", next->transport->multi_domain,
4351 next->transport->expand_multi_domain, &md) == OK
4352 )
4353 && md
4354 ) ) )
059ec3d9
PH
4355 {
4356 *anchor = next->next;
4357 next->next = NULL;
4358 next->first = addr; /* remember top one (for retry processing) */
4359 last->next = next;
4360 last = next;
4361 address_count++;
4362 }
4363 else anchor = &(next->next);
506900af 4364 deliver_set_expansions(NULL);
059ec3d9
PH
4365 }
4366
4367 /* If we are acting as an MUA wrapper, all addresses must go in a single
4368 transaction. If not, put them back on the chain and yield FALSE. */
4369
d6c82d7b 4370 if (mua_wrapper && addr_remote)
059ec3d9
PH
4371 {
4372 last->next = addr_remote;
4373 addr_remote = addr;
4374 return FALSE;
4375 }
4376
fa41615d
JH
4377 /* If the transport is limited for parallellism, enforce that here.
4378 The hints DB entry is decremented in par_reduce(), when we reap the
4379 transport process. */
4380
3070ceee
JH
4381 if (tpt_parallel_check(tp, addr, &serialize_key))
4382 if ((panicmsg = expand_string_message))
fa41615d 4383 goto panic_continue;
3070ceee
JH
4384 else
4385 continue; /* Loop for the next set of addresses. */
fa41615d 4386
059ec3d9
PH
4387 /* Set up the expansion variables for this set of addresses */
4388
4389 deliver_set_expansions(addr);
4390
018c60d7
JH
4391 /* Ensure any transport-set auth info is fresh */
4392 addr->authenticator = addr->auth_id = addr->auth_sndr = NULL;
4393
059ec3d9
PH
4394 /* Compute the return path, expanding a new one if required. The old one
4395 must be set first, as it might be referred to in the expansion. */
4396
d6c82d7b 4397 if(addr->prop.errors_address)
d43cbe25 4398 return_path = addr->prop.errors_address;
384152a6 4399#ifdef EXPERIMENTAL_SRS
d6c82d7b 4400 else if(addr->prop.srs_sender)
d43cbe25 4401 return_path = addr->prop.srs_sender;
384152a6
TK
4402#endif
4403 else
4404 return_path = sender_address;
059ec3d9 4405
d6c82d7b 4406 if (tp->return_path)
059ec3d9
PH
4407 {
4408 uschar *new_return_path = expand_string(tp->return_path);
d6c82d7b
JH
4409 if (new_return_path)
4410 return_path = new_return_path;
4411 else if (!expand_string_forcedfail)
059ec3d9 4412 {
d6c82d7b
JH
4413 panicmsg = string_sprintf("Failed to expand return path \"%s\": %s",
4414 tp->return_path, expand_string_message);
fa41615d 4415 goto enq_continue;
059ec3d9 4416 }
059ec3d9
PH
4417 }
4418
929ba01c
PH
4419 /* Find the uid, gid, and use_initgroups setting for this transport. Failure
4420 logs and sets up error messages, so we just post-process and continue with
4421 the next address. */
4422
4423 if (!findugid(addr, tp, &uid, &gid, &use_initgroups))
4424 {
d6c82d7b 4425 panicmsg = NULL;
fa41615d 4426 goto enq_continue;
929ba01c
PH
4427 }
4428
059ec3d9
PH
4429 /* If this transport has a setup function, call it now so that it gets
4430 run in this process and not in any subprocess. That way, the results of
929ba01c
PH
4431 any setup that are retained by the transport can be reusable. One of the
4432 things the setup does is to set the fallback host lists in the addresses.
4433 That is why it is called at this point, before the continue delivery
4434 processing, because that might use the fallback hosts. */
059ec3d9 4435
d6c82d7b 4436 if (tp->setup)
929ba01c 4437 (void)((tp->setup)(addr->transport, addr, NULL, uid, gid, NULL));
059ec3d9
PH
4438
4439 /* If this is a run to continue delivery down an already-established
4440 channel, check that this set of addresses matches the transport and
4441 the channel. If it does not, defer the addresses. If a host list exists,
4442 we must check that the continue host is on the list. Otherwise, the
4443 host is set in the transport. */
4444
4445 continue_more = FALSE; /* In case got set for the last lot */
d6c82d7b 4446 if (continue_transport)
059ec3d9
PH
4447 {
4448 BOOL ok = Ustrcmp(continue_transport, tp->name) == 0;
d6c82d7b 4449 if (ok && addr->host_list)
059ec3d9
PH
4450 {
4451 host_item *h;
4452 ok = FALSE;
d6c82d7b 4453 for (h = addr->host_list; h; h = h->next)
059ec3d9 4454 if (Ustrcmp(h->name, continue_hostname) == 0)
e3b1f624 4455/*XXX should also check port here */
059ec3d9 4456 { ok = TRUE; break; }
059ec3d9
PH
4457 }
4458
4459 /* Addresses not suitable; defer or queue for fallback hosts (which
4460 might be the continue host) and skip to next address. */
4461
4462 if (!ok)
4463 {
4464 DEBUG(D_deliver) debug_printf("not suitable for continue_transport\n");
fa41615d 4465 if (serialize_key) enq_end(serialize_key);
059ec3d9 4466
d6c82d7b 4467 if (addr->fallback_hosts && !fallback)
059ec3d9 4468 {
fa41615d 4469 for (next = addr; ; next = next->next)
059ec3d9
PH
4470 {
4471 next->host_list = next->fallback_hosts;
4472 DEBUG(D_deliver) debug_printf("%s queued for fallback host(s)\n", next->address);
d6c82d7b 4473 if (!next->next) break;
059ec3d9
PH
4474 }
4475 next->next = addr_fallback;
4476 addr_fallback = addr;
4477 }
4478
e3b1f624 4479 else
3070ceee 4480 {
e3b1f624
JH
4481 for (next = addr; ; next = next->next)
4482 {
4483 DEBUG(D_deliver) debug_printf(" %s to def list\n", next->address);
4484 if (!next->next) break;
4485 }
3070ceee
JH
4486 next->next = addr_defer;
4487 addr_defer = addr;
4488 }
059ec3d9
PH
4489
4490 continue;
4491 }
4492
4493 /* Set a flag indicating whether there are further addresses that list
4494 the continued host. This tells the transport to leave the channel open,
4495 but not to pass it to another delivery process. */
4496
d6c82d7b 4497 for (next = addr_remote; next; next = next->next)
059ec3d9
PH
4498 {
4499 host_item *h;
d6c82d7b 4500 for (h = next->host_list; h; h = h->next)
059ec3d9
PH
4501 if (Ustrcmp(h->name, continue_hostname) == 0)
4502 { continue_more = TRUE; break; }
059ec3d9
PH
4503 }
4504 }
4505
4506 /* The transports set up the process info themselves as they may connect
4507 to more than one remote machine. They also have to set up the filter
4508 arguments, if required, so that the host name and address are available
4509 for expansion. */
4510
4511 transport_filter_argv = NULL;
4512
059ec3d9
PH
4513 /* Create the pipe for inter-process communication. If pipe creation
4514 fails, it is probably because the value of remote_max_parallel is so
4515 large that too many file descriptors for pipes have been created. Arrange
4516 to wait for a process to finish, and then try again. If we still can't
4517 create a pipe when all processes have finished, break the retry loop. */
4518
4519 while (!pipe_done)
4520 {
4521 if (pipe(pfd) == 0) pipe_done = TRUE;
4522 else if (parcount > 0) parmax = parcount;
4523 else break;
4524
4525 /* We need to make the reading end of the pipe non-blocking. There are
4526 two different options for this. Exim is cunningly (I hope!) coded so
4527 that it can use either of them, though it prefers O_NONBLOCK, which
4528 distinguishes between EOF and no-more-data. */
4529
a7538db1 4530#ifdef O_NONBLOCK
ff790e47 4531 (void)fcntl(pfd[pipe_read], F_SETFL, O_NONBLOCK);
a7538db1 4532#else
ff790e47 4533 (void)fcntl(pfd[pipe_read], F_SETFL, O_NDELAY);
a7538db1 4534#endif
059ec3d9
PH
4535
4536 /* If the maximum number of subprocesses already exist, wait for a process
4537 to finish. If we ran out of file descriptors, parmax will have been reduced
4538 from its initial value of remote_max_parallel. */
4539
4540 par_reduce(parmax - 1, fallback);
4541 }
4542
4543 /* If we failed to create a pipe and there were no processes to wait
4544 for, we have to give up on this one. Do this outside the above loop
4545 so that we can continue the main loop. */
4546
4547 if (!pipe_done)
4548 {
d6c82d7b 4549 panicmsg = string_sprintf("unable to create pipe: %s", strerror(errno));
fa41615d 4550 goto enq_continue;
059ec3d9
PH
4551 }
4552
4553 /* Find a free slot in the pardata list. Must do this after the possible
4554 waiting for processes to finish, because a terminating process will free
4555 up a slot. */
4556
4557 for (poffset = 0; poffset < remote_max_parallel; poffset++)
d6c82d7b
JH
4558 if (parlist[poffset].pid == 0)
4559 break;
059ec3d9
PH
4560
4561 /* If there isn't one, there has been a horrible disaster. */
4562
4563 if (poffset >= remote_max_parallel)
4564 {
f1e894f3
PH
4565 (void)close(pfd[pipe_write]);
4566 (void)close(pfd[pipe_read]);
d6c82d7b 4567 panicmsg = US"Unexpectedly no free subprocess slot";
fa41615d 4568 goto enq_continue;
059ec3d9
PH
4569 }
4570
4571 /* Now fork a subprocess to do the remote delivery, but before doing so,
4c04137d 4572 ensure that any cached resources are released so as not to interfere with
059ec3d9
PH
4573 what happens in the subprocess. */
4574
4575 search_tidyup();
4576
4577 if ((pid = fork()) == 0)
4578 {
4579 int fd = pfd[pipe_write];
4580 host_item *h;
4581
2a47f028
JH
4582 /* Setting this global in the subprocess means we need never clear it */
4583 transport_name = tp->name;
059ec3d9 4584
2a47f028 4585 /* There are weird circumstances in which logging is disabled */
059ec3d9
PH
4586 disable_logging = tp->disable_logging;
4587
4588 /* Show pids on debug output if parallelism possible */
4589
d6c82d7b 4590 if (parmax > 1 && (parcount > 0 || addr_remote))
059ec3d9
PH
4591 {
4592 DEBUG(D_any|D_v) debug_selector |= D_pid;
4593 DEBUG(D_deliver) debug_printf("Remote delivery process started\n");
4594 }
4595
4596 /* Reset the random number generator, so different processes don't all
4597 have the same sequence. In the test harness we want different, but
4598 predictable settings for each delivery process, so do something explicit
4599 here rather they rely on the fixed reset in the random number function. */
4600
4601 random_seed = running_in_test_harness? 42 + 2*delivery_count : 0;
4602
4603 /* Set close-on-exec on the pipe so that it doesn't get passed on to
4604 a new process that may be forked to do another delivery down the same
4605 SMTP connection. */
4606
ff790e47 4607 (void)fcntl(fd, F_SETFD, fcntl(fd, F_GETFD) | FD_CLOEXEC);
059ec3d9
PH
4608
4609 /* Close open file descriptors for the pipes of other processes
4610 that are running in parallel. */
4611
4612 for (poffset = 0; poffset < remote_max_parallel; poffset++)
f1e894f3 4613 if (parlist[poffset].pid != 0) (void)close(parlist[poffset].fd);
059ec3d9
PH
4614
4615 /* This process has inherited a copy of the file descriptor
4616 for the data file, but its file pointer is shared with all the
4617 other processes running in parallel. Therefore, we have to re-open
4618 the file in order to get a new file descriptor with its own
4619 file pointer. We don't need to lock it, as the lock is held by
4620 the parent process. There doesn't seem to be any way of doing
4621 a dup-with-new-file-pointer. */
4622
f1e894f3 4623 (void)close(deliver_datafile);
41313d92
JH
4624 {
4625 uschar * fname = spool_fname(US"input", message_subdir, message_id, US"-D");
059ec3d9 4626
92b0827a
JH
4627 if ((deliver_datafile = Uopen(fname,
4628#ifdef O_CLOEXEC
4629 O_CLOEXEC |
4630#endif
4631 O_RDWR | O_APPEND, 0)) < 0)
059ec3d9 4632 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Failed to reopen %s for remote "
41313d92
JH
4633 "parallel delivery: %s", fname, strerror(errno));
4634 }
059ec3d9
PH
4635
4636 /* Set the close-on-exec flag */
92b0827a 4637#ifndef O_CLOEXEC
ff790e47 4638 (void)fcntl(deliver_datafile, F_SETFD, fcntl(deliver_datafile, F_GETFD) |
059ec3d9 4639 FD_CLOEXEC);
92b0827a 4640#endif
059ec3d9
PH
4641
4642 /* Set the uid/gid of this process; bombs out on failure. */
4643
4644 exim_setugid(uid, gid, use_initgroups,
4645 string_sprintf("remote delivery to %s with transport=%s",
4646 addr->address, tp->name));
4647
4648 /* Close the unwanted half of this process' pipe, set the process state,
4649 and run the transport. Afterwards, transport_count will contain the number
4650 of bytes written. */
4651
f1e894f3 4652 (void)close(pfd[pipe_read]);
059ec3d9
PH
4653 set_process_info("delivering %s using %s", message_id, tp->name);
4654 debug_print_string(tp->debug_string);
4655 if (!(tp->info->code)(addr->transport, addr)) replicate_status(addr);
4656
4657 set_process_info("delivering %s (just run %s for %s%s in subprocess)",
d6c82d7b 4658 message_id, tp->name, addr->address, addr->next ? ", ..." : "");
059ec3d9
PH
4659
4660 /* Ensure any cached resources that we used are now released */
4661
4662 search_tidyup();
4663
4664 /* Pass the result back down the pipe. This is a lot more information
4665 than is needed for a local delivery. We have to send back the error
4666 status for each address, the usability status for each host that is
4667 flagged as unusable, and all the retry items. When TLS is in use, we
4668 send also the cipher and peerdn information. Each type of information
4669 is flagged by an identifying byte, and is then in a fixed format (with
4670 strings terminated by zeros), and there is a final terminator at the
4671 end. The host information and retry information is all attached to
4672 the first address, so that gets sent at the start. */
4673
4674 /* Host unusability information: for most success cases this will
4675 be null. */
4676
d6c82d7b 4677 for (h = addr->host_list; h; h = h->next)
059ec3d9 4678 {
d6c82d7b 4679 if (!h->address || h->status < hstatus_unusable) continue;
bd21a787
WB
4680 sprintf(CS big_buffer, "%c%c%s", h->status, h->why, h->address);
4681 rmt_dlv_checked_write(fd, 'H', '0', big_buffer, Ustrlen(big_buffer+2) + 3);
059ec3d9
PH
4682 }
4683
4684 /* The number of bytes written. This is the same for each address. Even
4685 if we sent several copies of the message down the same connection, the
4686 size of each one is the same, and it's that value we have got because
4687 transport_count gets reset before calling transport_write_message(). */
4688
bd21a787
WB
4689 memcpy(big_buffer, &transport_count, sizeof(transport_count));
4690 rmt_dlv_checked_write(fd, 'S', '0', big_buffer, sizeof(transport_count));
059ec3d9 4691
6f123593
JH
4692 /* Information about what happened to each address. Four item types are
4693 used: an optional 'X' item first, for TLS information, then an optional "C"
4694 item for any client-auth info followed by 'R' items for any retry settings,
4695 and finally an 'A' item for the remaining data. */
059ec3d9 4696
d6c82d7b 4697 for(; addr; addr = addr->next)
059ec3d9
PH
4698 {
4699 uschar *ptr;
4700 retry_item *r;
4701
4702 /* The certificate verification status goes into the flags */
817d9f57 4703 if (tls_out.certificate_verified) setflag(addr, af_cert_verified);
a0a2d1ee 4704#ifdef EXPERIMENTAL_DANE
53a7196b 4705 if (tls_out.dane_verified) setflag(addr, af_dane_verified);
a0a2d1ee 4706#endif
059ec3d9
PH
4707
4708 /* Use an X item only if there's something to send */
a7538db1 4709#ifdef SUPPORT_TLS
9d1c15ef 4710 if (addr->cipher)
059ec3d9 4711 {
e6d2a989 4712 ptr = big_buffer + sprintf(CS big_buffer, "%.128s", addr->cipher) + 1;
9d1c15ef
JH
4713 if (!addr->peerdn)
4714 *ptr++ = 0;
4715 else
059ec3d9 4716 {
e6d2a989
JH
4717 ptr += sprintf(CS ptr, "%.512s", addr->peerdn);
4718 ptr++;
059ec3d9 4719 }
9d1c15ef 4720
bd21a787 4721 rmt_dlv_checked_write(fd, 'X', '1', big_buffer, ptr - big_buffer);
059ec3d9 4722 }
9d1c15ef
JH
4723 if (addr->peercert)
4724 {
4725 ptr = big_buffer;
9d1c15ef
JH
4726 if (!tls_export_cert(ptr, big_buffer_size-2, addr->peercert))
4727 while(*ptr++);
4728 else
4729 *ptr++ = 0;
bd21a787 4730 rmt_dlv_checked_write(fd, 'X', '2', big_buffer, ptr - big_buffer);
9d1c15ef
JH
4731 }
4732 if (addr->ourcert)
4733 {
4734 ptr = big_buffer;
9d1c15ef
JH
4735 if (!tls_export_cert(ptr, big_buffer_size-2, addr->ourcert))
4736 while(*ptr++);
4737 else
4738 *ptr++ = 0;
bd21a787 4739 rmt_dlv_checked_write(fd, 'X', '3', big_buffer, ptr - big_buffer);
9d1c15ef 4740 }
a7538db1 4741# ifndef DISABLE_OCSP
018058b2
JH
4742 if (addr->ocsp > OCSP_NOT_REQ)
4743 {
e6d2a989 4744 ptr = big_buffer + sprintf(CS big_buffer, "%c", addr->ocsp + '0') + 1;
bd21a787 4745 rmt_dlv_checked_write(fd, 'X', '4', big_buffer, ptr - big_buffer);
018058b2 4746 }
a7538db1
JH
4747# endif
4748#endif /*SUPPORT_TLS*/
059ec3d9 4749
6f123593
JH
4750 if (client_authenticator)
4751 {
e6d2a989 4752 ptr = big_buffer + sprintf(CS big_buffer, "%.64s", client_authenticator) + 1;
bd21a787 4753 rmt_dlv_checked_write(fd, 'C', '1', big_buffer, ptr - big_buffer);
6f123593
JH
4754 }
4755 if (client_authenticated_id)
4756 {
e6d2a989 4757 ptr = big_buffer + sprintf(CS big_buffer, "%.64s", client_authenticated_id) + 1;
bd21a787 4758 rmt_dlv_checked_write(fd, 'C', '2', big_buffer, ptr - big_buffer);
6f123593 4759 }
c8e2fc1e
JH
4760 if (client_authenticated_sender)
4761 {
e6d2a989 4762 ptr = big_buffer + sprintf(CS big_buffer, "%.64s", client_authenticated_sender) + 1;
bd21a787 4763 rmt_dlv_checked_write(fd, 'C', '3', big_buffer, ptr - big_buffer);
c8e2fc1e 4764 }
6f123593 4765
a7538db1 4766#ifndef DISABLE_PRDR
783b385f 4767 if (addr->flags & af_prdr_used)
bd21a787 4768 rmt_dlv_checked_write(fd, 'P', '0', NULL, 0);
b75960c8 4769#endif
fd98a5c6 4770
e0cc6cda
JH
4771 if (addr->flags & af_chunking_used)
4772 rmt_dlv_checked_write(fd, 'K', '0', NULL, 0);
4773
bd21a787
WB
4774 memcpy(big_buffer, &addr->dsn_aware, sizeof(addr->dsn_aware));
4775 rmt_dlv_checked_write(fd, 'D', '0', big_buffer, sizeof(addr->dsn_aware));
6c1c3d1d 4776 DEBUG(D_deliver) debug_printf("DSN write: addr->dsn_aware = %d\n", addr->dsn_aware);
6c1c3d1d 4777
059ec3d9
PH
4778 /* Retry information: for most success cases this will be null. */
4779
d6c82d7b 4780 for (r = addr->retries; r; r = r->next)
059ec3d9 4781 {
bd21a787 4782 sprintf(CS big_buffer, "%c%.500s", r->flags, r->key);
059ec3d9
PH
4783 ptr = big_buffer + Ustrlen(big_buffer+2) + 3;
4784 memcpy(ptr, &(r->basic_errno), sizeof(r->basic_errno));
4785 ptr += sizeof(r->basic_errno);
4786 memcpy(ptr, &(r->more_errno), sizeof(r->more_errno));
4787 ptr += sizeof(r->more_errno);
d6c82d7b 4788 if (!r->message) *ptr++ = 0; else
059ec3d9
PH
4789 {
4790 sprintf(CS ptr, "%.512s", r->message);
4791 while(*ptr++);
4792 }
bd21a787 4793 rmt_dlv_checked_write(fd, 'R', '0', big_buffer, ptr - big_buffer);
059ec3d9
PH
4794 }
4795
e6d2a989
JH
4796#ifdef SUPPORT_SOCKS
4797 if (LOGGING(proxy) && proxy_session)
4798 {
4799 ptr = big_buffer;
4800 if (proxy_local_address)
4801 {
4802 DEBUG(D_deliver) debug_printf("proxy_local_address '%s'\n", proxy_local_address);
4803 ptr = big_buffer + sprintf(CS ptr, "%.128s", proxy_local_address) + 1;
4804 DEBUG(D_deliver) debug_printf("proxy_local_port %d\n", proxy_local_port);
4805 memcpy(ptr, &proxy_local_port, sizeof(proxy_local_port));
4806 ptr += sizeof(proxy_local_port);
4807 }
4808 else
4809 *ptr++ = '\0';
4810 rmt_dlv_checked_write(fd, 'A', '2', big_buffer, ptr - big_buffer);
4811 }
4812#endif
4813
895fbaf2
JH
4814#ifdef EXPERIMENTAL_DSN_INFO
4815/*um, are they really per-addr? Other per-conn stuff is not (auth, tls). But host_used is! */
4816 if (addr->smtp_greeting)
4817 {
895fbaf2 4818 DEBUG(D_deliver) debug_printf("smtp_greeting '%s'\n", addr->smtp_greeting);
e6d2a989 4819 ptr = big_buffer + sprintf(CS big_buffer, "%.128s", addr->smtp_greeting) + 1;
895fbaf2
JH
4820 if (addr->helo_response)
4821 {
4822 DEBUG(D_deliver) debug_printf("helo_response '%s'\n", addr->helo_response);
e6d2a989 4823 ptr += sprintf(CS ptr, "%.128s", addr->helo_response) + 1;
895fbaf2
JH
4824 }
4825 else
4826 *ptr++ = '\0';
4827 rmt_dlv_checked_write(fd, 'A', '1', big_buffer, ptr - big_buffer);
4828 }
4829#endif
4830
4831 /* The rest of the information goes in an 'A0' item. */
059ec3d9 4832
e6d2a989 4833 sprintf(CS big_buffer, "%c%c", addr->transport_return, addr->special_action);
895fbaf2 4834 ptr = big_buffer + 2;
059ec3d9
PH
4835 memcpy(ptr, &(addr->basic_errno), sizeof(addr->basic_errno));
4836 ptr += sizeof(addr->basic_errno);
4837 memcpy(ptr, &(addr->more_errno), sizeof(addr->more_errno));
4838 ptr += sizeof(addr->more_errno);
4839 memcpy(ptr, &(addr->flags), sizeof(addr->flags));
4840 ptr += sizeof(addr->flags);
4841
d6c82d7b 4842 if (!addr->message) *ptr++ = 0; else
e6d2a989 4843 ptr += sprintf(CS ptr, "%.1024s", addr->message) + 1;
059ec3d9 4844
d6c82d7b 4845 if (!addr->user_message) *ptr++ = 0; else
e6d2a989 4846 ptr += sprintf(CS ptr, "%.1024s", addr->user_message) + 1;
059ec3d9 4847
d6c82d7b 4848 if (!addr->host_used) *ptr++ = 0; else
059ec3d9 4849 {
e6d2a989
JH
4850 ptr += sprintf(CS ptr, "%.256s", addr->host_used->name) + 1;
4851 ptr += sprintf(CS ptr, "%.64s", addr->host_used->address) + 1;
059ec3d9
PH
4852 memcpy(ptr, &(addr->host_used->port), sizeof(addr->host_used->port));
4853 ptr += sizeof(addr->host_used->port);
783b385f
JH
4854
4855 /* DNS lookup status */
4856 *ptr++ = addr->host_used->dnssec==DS_YES ? '2'
4857 : addr->host_used->dnssec==DS_NO ? '1' : '0';
4858
059ec3d9 4859 }
bd21a787 4860 rmt_dlv_checked_write(fd, 'A', '0', big_buffer, ptr - big_buffer);
059ec3d9
PH
4861 }
4862
aeaf5db3 4863 /* Local interface address/port */
895fbaf2
JH
4864#ifdef EXPERIMENTAL_DSN_INFO
4865 if (sending_ip_address)
4866#else
6c6d6e48 4867 if (LOGGING(incoming_interface) && sending_ip_address)
895fbaf2 4868#endif
aeaf5db3 4869 {
e6d2a989
JH
4870 uschar * ptr;
4871 ptr = big_buffer + sprintf(CS big_buffer, "%.128s", sending_ip_address) + 1;
4872 ptr += sprintf(CS ptr, "%d", sending_port) + 1;
aeaf5db3
JH
4873 rmt_dlv_checked_write(fd, 'I', '0', big_buffer, ptr - big_buffer);
4874 }
4875
059ec3d9
PH
4876 /* Add termination flag, close the pipe, and that's it. The character
4877 after 'Z' indicates whether continue_transport is now NULL or not.
4878 A change from non-NULL to NULL indicates a problem with a continuing
4879 connection. */
4880
d6c82d7b 4881 big_buffer[0] = continue_transport ? '1' : '0';
bd21a787 4882 rmt_dlv_checked_write(fd, 'Z', '0', big_buffer, 1);
f1e894f3 4883 (void)close(fd);
059ec3d9
PH
4884 exit(EXIT_SUCCESS);
4885 }
4886
4887 /* Back in the mainline: close the unwanted half of the pipe. */
4888
f1e894f3 4889 (void)close(pfd[pipe_write]);
059ec3d9
PH
4890
4891 /* Fork failed; defer with error message */
4892
4893 if (pid < 0)
4894 {
f1e894f3 4895 (void)close(pfd[pipe_read]);
d6c82d7b
JH
4896 panicmsg = string_sprintf("fork failed for remote delivery to %s: %s",
4897 addr->domain, strerror(errno));
fa41615d 4898 goto enq_continue;
059ec3d9
PH
4899 }
4900
4901 /* Fork succeeded; increment the count, and remember relevant data for
4902 when the process finishes. */
4903
4904 parcount++;
4905 parlist[poffset].addrlist = parlist[poffset].addr = addr;
4906 parlist[poffset].pid = pid;
4907 parlist[poffset].fd = pfd[pipe_read];
4908 parlist[poffset].done = FALSE;
4909 parlist[poffset].msg = NULL;
4910 parlist[poffset].return_path = return_path;
4911
4912 /* If the process we've just started is sending a message down an existing
4913 channel, wait for it now. This ensures that only one such process runs at
4914 once, whatever the value of remote_max parallel. Otherwise, we might try to
4915 send two or more messages simultaneously down the same channel. This could
4916 happen if there are different domains that include the same host in otherwise
4917 different host lists.
4918
4919 Also, if the transport closes down the channel, this information gets back
4920 (continue_transport gets set to NULL) before we consider any other addresses
4921 in this message. */
4922
d6c82d7b 4923 if (continue_transport) par_reduce(0, fallback);
059ec3d9
PH
4924
4925 /* Otherwise, if we are running in the test harness, wait a bit, to let the
4926 newly created process get going before we create another process. This should
4927 ensure repeatability in the tests. We only need to wait a tad. */
4928
4929 else if (running_in_test_harness) millisleep(500);
d6c82d7b
JH
4930
4931 continue;
4932
fa41615d
JH
4933enq_continue:
4934 if (serialize_key) enq_end(serialize_key);
d6c82d7b
JH
4935panic_continue:
4936 remote_post_process(addr, LOG_MAIN|LOG_PANIC, panicmsg, fallback);
4937 continue;
059ec3d9
PH
4938 }
4939
4940/* Reached the end of the list of addresses. Wait for all the subprocesses that
4941are still running and post-process their addresses. */
4942
4943par_reduce(0, fallback);
4944return TRUE;
4945}
4946
4947
4948
4949
4950/*************************************************
4951* Split an address into local part and domain *
4952*************************************************/
4953
4954/* This function initializes an address for routing by splitting it up into a
4955local part and a domain. The local part is set up twice - once in its original
4956casing, and once in lower case, and it is dequoted. We also do the "percent
4957hack" for configured domains. This may lead to a DEFER result if a lookup
4958defers. When a percent-hacking takes place, we insert a copy of the original
4959address as a new parent of this address, as if we have had a redirection.
4960
4961Argument:
4962 addr points to an addr_item block containing the address
4963
4964Returns: OK
4965 DEFER - could not determine if domain is %-hackable
4966*/
4967
4968int
fb5908b1 4969deliver_split_address(address_item * addr)
059ec3d9 4970{
fb5908b1
JH
4971uschar * address = addr->address;
4972uschar * domain;
4973uschar * t;
4974int len;
059ec3d9 4975
fb5908b1
JH
4976if (!(domain = Ustrrchr(address, '@')))
4977 return DEFER; /* should always have a domain, but just in case... */
4978
4979len = domain - address;
059ec3d9
PH
4980addr->domain = string_copylc(domain+1); /* Domains are always caseless */
4981
4982/* The implication in the RFCs (though I can't say I've seen it spelled out
4983explicitly) is that quoting should be removed from local parts at the point
4984where they are locally interpreted. [The new draft "821" is more explicit on
4985this, Jan 1999.] We know the syntax is valid, so this can be done by simply
4986removing quoting backslashes and any unquoted doublequotes. */
4987
4988t = addr->cc_local_part = store_get(len+1);
4989while(len-- > 0)
4990 {
fb5908b1 4991 int c = *address++;
059ec3d9
PH
4992 if (c == '\"') continue;
4993 if (c == '\\')
4994 {
4995 *t++ = *address++;
4996 len--;
4997 }
4998 else *t++ = c;
4999 }
5000*t = 0;
5001
5002/* We do the percent hack only for those domains that are listed in
5003percent_hack_domains. A loop is required, to copy with multiple %-hacks. */
5004
d6c82d7b 5005if (percent_hack_domains)
059ec3d9
PH
5006 {
5007 int rc;
5008 uschar *new_address = NULL;
5009 uschar *local_part = addr->cc_local_part;
5010
5011 deliver_domain = addr->domain; /* set $domain */
5012
d6c82d7b
JH
5013 while ( (rc = match_isinlist(deliver_domain, (const uschar **)&percent_hack_domains, 0,
5014 &domainlist_anchor, addr->domain_cache, MCL_DOMAIN, TRUE, NULL))
5015 == OK
5016 && (t = Ustrrchr(local_part, '%')) != NULL
5017 )
059ec3d9
PH
5018 {
5019 new_address = string_copy(local_part);
5020 new_address[t - local_part] = '@';
5021 deliver_domain = string_copylc(t+1);
5022 local_part = string_copyn(local_part, t - local_part);
5023 }
5024
5025 if (rc == DEFER) return DEFER; /* lookup deferred */
5026
5027 /* If hackery happened, set up new parent and alter the current address. */
5028
d6c82d7b 5029 if (new_address)
059ec3d9
PH
5030 {
5031 address_item *new_parent = store_get(sizeof(address_item));
5032 *new_parent = *addr;
5033 addr->parent = new_parent;
5034 addr->address = new_address;
5035 addr->unique = string_copy(new_address);
5036 addr->domain = deliver_domain;
5037 addr->cc_local_part = local_part;
5038 DEBUG(D_deliver) debug_printf("%%-hack changed address to: %s\n",
5039 addr->address);
5040 }
5041 }
5042
5043/* Create the lowercased version of the final local part, and make that the
5044default one to be used. */
5045
5046addr->local_part = addr->lc_local_part = string_copylc(addr->cc_local_part);
5047return OK;
5048}
5049
5050
5051
5052
5053/*************************************************
5054* Get next error message text *
5055*************************************************/
5056
5057/* If f is not NULL, read the next "paragraph", from a customized error message
5058text file, terminated by a line containing ****, and expand it.
5059
5060Arguments:
5061 f NULL or a file to read from
5062 which string indicating which string (for errors)
5063
5064Returns: NULL or an expanded string
5065*/
5066
5067static uschar *
5068next_emf(FILE *f, uschar *which)
5069{
5070int size = 256;
5071int ptr = 0;
5072uschar *para, *yield;
5073uschar buffer[256];
5074
d6c82d7b 5075if (!f) return NULL;
059ec3d9 5076
d6c82d7b
JH
5077if (!Ufgets(buffer, sizeof(buffer), f) || Ustrcmp(buffer, "****\n") == 0)
5078 return NULL;
059ec3d9
PH
5079
5080para = store_get(size);
5081for (;;)
5082 {
c2f669a4 5083 para = string_cat(para, &size, &ptr, buffer);
d6c82d7b
JH
5084 if (!Ufgets(buffer, sizeof(buffer), f) || Ustrcmp(buffer, "****\n") == 0)
5085 break;
059ec3d9
PH
5086 }
5087para[ptr] = 0;
5088
d6c82d7b
JH
5089if ((yield = expand_string(para)))
5090 return yield;
059ec3d9
PH
5091
5092log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand string from "
5093 "bounce_message_file or warn_message_file (%s): %s", which,
5094 expand_string_message);
5095return NULL;
5096}
5097
5098
5099
5100
5101/*************************************************
5102* Close down a passed transport channel *
5103*************************************************/
5104
5105/* This function is called when a passed transport channel cannot be used.
5106It attempts to close it down tidily. The yield is always DELIVER_NOT_ATTEMPTED
5107so that the function call can be the argument of a "return" statement.
5108
5109Arguments: None
5110Returns: DELIVER_NOT_ATTEMPTED
5111*/
5112
5113static int
5114continue_closedown(void)
5115{
d6c82d7b 5116if (continue_transport)
059ec3d9
PH
5117 {
5118 transport_instance *t;
d6c82d7b 5119 for (t = transports; t; t = t->next)
059ec3d9
PH
5120 if (Ustrcmp(t->name, continue_transport) == 0)
5121 {
d6c82d7b 5122 if (t->info->closedown) (t->info->closedown)(t);
059ec3d9
PH
5123 break;
5124 }
059ec3d9
PH
5125 }
5126return DELIVER_NOT_ATTEMPTED;
5127}
5128
5129
5130
5131
5132/*************************************************
5133* Print address information *
5134*************************************************/
5135
5136/* This function is called to output an address, or information about an
5137address, for bounce or defer messages. If the hide_child flag is set, all we
5138output is the original ancestor address.
5139
5140Arguments:
5141 addr points to the address
5142 f the FILE to print to
5143 si an initial string
5144 sc a continuation string for before "generated"
5145 se an end string
5146
5147Returns: TRUE if the address is not hidden
5148*/
5149
5150static BOOL
5151print_address_information(address_item *addr, FILE *f, uschar *si, uschar *sc,
5152 uschar *se)
5153{
5154BOOL yield = TRUE;
5155uschar *printed = US"";
5156address_item *ancestor = addr;
d6c82d7b 5157while (ancestor->parent) ancestor = ancestor->parent;
059ec3d9
PH
5158
5159fprintf(f, "%s", CS si);
5160
d6c82d7b 5161if (addr->parent && testflag(addr, af_hide_child))
059ec3d9
PH
5162 {
5163 printed = US"an undisclosed address";
5164 yield = FALSE;
5165 }
d6c82d7b 5166else if (!testflag(addr, af_pfr) || !addr->parent)
059ec3d9
PH
5167 printed = addr->address;
5168
5169else
5170 {
5171 uschar *s = addr->address;
5172 uschar *ss;
5173
5174 if (addr->address[0] == '>') { ss = US"mail"; s++; }
5175 else if (addr->address[0] == '|') ss = US"pipe";
5176 else ss = US"save";
5177
5178 fprintf(f, "%s to %s%sgenerated by ", ss, s, sc);
5179 printed = addr->parent->address;
5180 }
5181
5182fprintf(f, "%s", CS string_printing(printed));
5183
5184if (ancestor != addr)
5185 {
d6c82d7b
JH
5186 uschar *original = ancestor->onetime_parent;
5187 if (!original) original= ancestor->address;
059ec3d9
PH
5188 if (strcmpic(original, printed) != 0)
5189 fprintf(f, "%s(%sgenerated from %s)", sc,
d6c82d7b 5190 ancestor != addr->parent ? "ultimately " : "",
059ec3d9
PH
5191 string_printing(original));
5192 }
5193
c562fd30
JH
5194if (addr->host_used)
5195 fprintf(f, "\n host %s [%s]",
5196 addr->host_used->name, addr->host_used->address);
5197
059ec3d9
PH
5198fprintf(f, "%s", CS se);
5199return yield;
5200}
5201
5202
5203
5204
5205
059ec3d9
PH
5206/*************************************************
5207* Print error for an address *
5208*************************************************/
5209
5210/* This function is called to print the error information out of an address for
5211a bounce or a warning message. It tries to format the message reasonably by
5212introducing newlines. All lines are indented by 4; the initial printing
5213position must be set before calling.
5214
447d236c 5215This function used always to print the error. Nowadays we want to restrict it
75def545
PH
5216to cases such as LMTP/SMTP errors from a remote host, and errors from :fail:
5217and filter "fail". We no longer pass other information willy-nilly in bounce
5218and warning messages. Text in user_message is always output; text in message
5219only if the af_pass_message flag is set.
447d236c 5220
059ec3d9 5221Arguments:
447d236c 5222 addr the address
059ec3d9 5223 f the FILE to print on
75def545 5224 t some leading text
059ec3d9
PH
5225
5226Returns: nothing
5227*/
5228
5229static void
447d236c 5230print_address_error(address_item *addr, FILE *f, uschar *t)
059ec3d9 5231{
447d236c 5232int count = Ustrlen(t);
75def545 5233uschar *s = testflag(addr, af_pass_message)? addr->message : NULL;
447d236c 5234
0ba0ee97
JH
5235if (!s && !(s = addr->user_message))
5236 return;
447d236c
PH
5237
5238fprintf(f, "\n %s", t);
5239
0ba0ee97 5240while (*s)
447d236c
PH
5241 if (*s == '\\' && s[1] == 'n')
5242 {
5243 fprintf(f, "\n ");
5244 s += 2;
5245 count = 0;
5246 }
5247 else
059ec3d9 5248 {
447d236c
PH
5249 fputc(*s, f);
5250 count++;
5251 if (*s++ == ':' && isspace(*s) && count > 45)
059ec3d9 5252 {
447d236c 5253 fprintf(f, "\n "); /* sic (because space follows) */
059ec3d9
PH
5254 count = 0;
5255 }
059ec3d9 5256 }
059ec3d9
PH
5257}
5258
5259
21bc4865
WB
5260/***********************************************************
5261* Print Diagnostic-Code for an address *
5262************************************************************/
5263
5264/* This function is called to print the error information out of an address for
5265a bounce or a warning message. It tries to format the message reasonably as
5266required by RFC 3461 by adding a space after each newline
5267
ca410e79
WB
5268it uses the same logic as print_address_error() above. if af_pass_message is true
5269and addr->message is set it uses the remote host answer. if not addr->user_message
5270is used instead if available.
21bc4865
WB
5271
5272Arguments:
5273 addr the address
5274 f the FILE to print on
5275
5276Returns: nothing
5277*/
5278
5279static void
5280print_dsn_diagnostic_code(const address_item *addr, FILE *f)
5281{
ca410e79 5282uschar *s = testflag(addr, af_pass_message) ? addr->message : NULL;
21bc4865 5283
ca410e79
WB
5284/* af_pass_message and addr->message set ? print remote host answer */
5285if (s)
5286 {
5287 DEBUG(D_deliver)
5288 debug_printf("DSN Diagnostic-Code: addr->message = %s\n", addr->message);
447d236c 5289
ca410e79
WB
5290 /* search first ": ". we assume to find the remote-MTA answer there */
5291 if (!(s = Ustrstr(addr->message, ": ")))
5292 return; /* not found, bail out */
5293 s += 2; /* skip ": " */
5294 fprintf(f, "Diagnostic-Code: smtp; ");
5295 }
ca410e79 5296/* no message available. do nothing */
9031f51a 5297else return;
21bc4865 5298
21bc4865
WB
5299while (*s)
5300 if (*s == '\\' && s[1] == 'n')
5301 {
5302 fputs("\n ", f); /* as defined in RFC 3461 */
5303 s += 2;
5304 }
5305 else
5306 fputc(*s++, f);
5307
5308fputc('\n', f);
5309}
447d236c
PH
5310
5311
d7174846
PH
5312/*************************************************
5313* Check list of addresses for duplication *
5314*************************************************/
5315
5316/* This function was introduced when the test for duplicate addresses that are
5317not pipes, files, or autoreplies was moved from the middle of routing to when
5318routing was complete. That was to fix obscure cases when the routing history
dbcef0ea
PH
5319affects the subsequent routing of identical addresses. This function is called
5320after routing, to check that the final routed addresses are not duplicates.
d7174846 5321
dbcef0ea
PH
5322If we detect a duplicate, we remember what it is a duplicate of. Note that
5323pipe, file, and autoreply de-duplication is handled during routing, so we must
5324leave such "addresses" alone here, as otherwise they will incorrectly be
5325discarded.
d7174846
PH
5326
5327Argument: address of list anchor
5328Returns: nothing
5329*/
5330
5331static void
5332do_duplicate_check(address_item **anchor)
5333{
5334address_item *addr;
d6c82d7b 5335while ((addr = *anchor))
d7174846
PH
5336 {
5337 tree_node *tnode;
5338 if (testflag(addr, af_pfr))
5339 {
5340 anchor = &(addr->next);
5341 }
d6c82d7b 5342 else if ((tnode = tree_search(tree_duplicates, addr->unique)))
d7174846
PH
5343 {
5344 DEBUG(D_deliver|D_route)
5345 debug_printf("%s is a duplicate address: discarded\n", addr->unique);
5346 *anchor = addr->next;
5347 addr->dupof = tnode->data.ptr;
5348 addr->next = addr_duplicate;
5349 addr_duplicate = addr;
5350 }
5351 else
5352 {
5353 tree_add_duplicate(addr->unique, addr);
5354 anchor = &(addr->next);
5355 }
5356 }
5357}
5358
5359
5360
059ec3d9
PH
5361
5362/*************************************************
5363* Deliver one message *
5364*************************************************/
5365
5366/* This is the function which is called when a message is to be delivered. It
5367is passed the id of the message. It is possible that the message no longer
5368exists, if some other process has delivered it, and it is also possible that
5369the message is being worked on by another process, in which case the data file
5370will be locked.
5371
5372If no delivery is attempted for any of the above reasons, the function returns
5373DELIVER_NOT_ATTEMPTED.
5374
5375If the give_up flag is set true, do not attempt any deliveries, but instead
5376fail all outstanding addresses and return the message to the sender (or
5377whoever).
5378
5379A delivery operation has a process all to itself; we never deliver more than
5380one message in the same process. Therefore we needn't worry too much about
5381store leakage.
5382
92b0827a
JH
5383Liable to be called as root.
5384
059ec3d9
PH
5385Arguments:
5386 id the id of the message to be delivered
5387 forced TRUE if delivery was forced by an administrator; this overrides
5388 retry delays and causes a delivery to be tried regardless
5389 give_up TRUE if an administrator has requested that delivery attempts
5390 be abandoned
5391
5392Returns: When the global variable mua_wrapper is FALSE:
5393 DELIVER_ATTEMPTED_NORMAL if a delivery attempt was made
5394 DELIVER_NOT_ATTEMPTED otherwise (see comment above)
5395 When the global variable mua_wrapper is TRUE:
5396 DELIVER_MUA_SUCCEEDED if delivery succeeded
5397 DELIVER_MUA_FAILED if delivery failed
5398 DELIVER_NOT_ATTEMPTED if not attempted (should not occur)
5399*/
5400
5401int
5402deliver_message(uschar *id, BOOL forced, BOOL give_up)
5403{
5404int i, rc;
5405int final_yield = DELIVER_ATTEMPTED_NORMAL;
5406time_t now = time(NULL);
5407address_item *addr_last = NULL;
5408uschar *filter_message = NULL;
059ec3d9
PH
5409int process_recipients = RECIP_ACCEPT;
5410open_db dbblock;
5411open_db *dbm_file;
faa05a93 5412extern int acl_where;
059ec3d9 5413
d6c82d7b
JH
5414uschar *info = queue_run_pid == (pid_t)0
5415 ? string_sprintf("delivering %s", id)
5416 : string_sprintf("delivering %s (queue run pid %d)", id, queue_run_pid);
059ec3d9
PH
5417
5418/* If the D_process_info bit is on, set_process_info() will output debugging
5419information. If not, we want to show this initial information if D_deliver or
5420D_queue_run is set or in verbose mode. */
5421
5422set_process_info("%s", info);
5423
d6c82d7b
JH
5424if ( !(debug_selector & D_process_info)
5425 && (debug_selector & (D_deliver|D_queue_run|D_v))
5426 )
059ec3d9
PH
5427 debug_printf("%s\n", info);
5428
5429/* Ensure that we catch any subprocesses that are created. Although Exim
5430sets SIG_DFL as its initial default, some routes through the code end up
5431here with it set to SIG_IGN - cases where a non-synchronous delivery process
5432has been forked, but no re-exec has been done. We use sigaction rather than
5433plain signal() on those OS where SA_NOCLDWAIT exists, because we want to be
5434sure it is turned off. (There was a problem on AIX with this.) */
5435
5436#ifdef SA_NOCLDWAIT
5437 {
5438 struct sigaction act;
5439 act.sa_handler = SIG_DFL;
5440 sigemptyset(&(act.sa_mask));
5441 act.sa_flags = 0;
5442 sigaction(SIGCHLD, &act, NULL);
5443 }
5444#else
5445signal(SIGCHLD, SIG_DFL);
5446#endif
5447
5448/* Make the forcing flag available for routers and transports, set up the
5449global message id field, and initialize the count for returned files and the
5450message size. This use of strcpy() is OK because the length id is checked when
5451it is obtained from a command line (the -M or -q options), and otherwise it is
5452known to be a valid message id. */
5453
5454Ustrcpy(message_id, id);
5455deliver_force = forced;
5456return_count = 0;
5457message_size = 0;
5458
5459/* Initialize some flags */
5460
5461update_spool = FALSE;
5462remove_journal = TRUE;
5463
faa05a93
JH
5464/* Set a known context for any ACLs we call via expansions */
5465acl_where = ACL_WHERE_DELIVERY;
5466
059ec3d9
PH
5467/* Reset the random number generator, so that if several delivery processes are
5468started from a queue runner that has already used random numbers (for sorting),
5469they don't all get the same sequence. */
5470
5471random_seed = 0;
5472
5473/* Open and lock the message's data file. Exim locks on this one because the
5474header file may get replaced as it is re-written during the delivery process.
5475Any failures cause messages to be written to the log, except for missing files
5476while queue running - another process probably completed delivery. As part of
5477opening the data file, message_subdir gets set. */
5478
789f8a4f 5479if ((deliver_datafile = spool_open_datafile(id)) < 0)
059ec3d9
PH
5480 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5481
5482/* The value of message_size at this point has been set to the data length,
5483plus one for the blank line that notionally precedes the data. */
5484
5485/* Now read the contents of the header file, which will set up the headers in
5486store, and also the list of recipients and the tree of non-recipients and
5487assorted flags. It updates message_size. If there is a reading or format error,
5488give up; if the message has been around for sufficiently long, remove it. */
5489
059ec3d9 5490 {
41313d92
JH
5491 uschar * spoolname = string_sprintf("%s-H", id);
5492 if ((rc = spool_read_header(spoolname, TRUE, TRUE)) != spool_read_OK)
059ec3d9 5493 {
41313d92
JH
5494 if (errno == ERRNO_SPOOLFORMAT)
5495 {
5496 struct stat statbuf;
5497 if (Ustat(spool_fname(US"input", message_subdir, spoolname, US""),
5498 &statbuf) == 0)
5499 log_write(0, LOG_MAIN, "Format error in spool file %s: "
5500 "size=" OFF_T_FMT, spoolname, statbuf.st_size);
5501 else
5502 log_write(0, LOG_MAIN, "Format error in spool file %s", spoolname);
5503 }
5504 else
5505 log_write(0, LOG_MAIN, "Error reading spool file %s: %s", spoolname,
5506 strerror(errno));
059ec3d9 5507
41313d92
JH
5508 /* If we managed to read the envelope data, received_time contains the
5509 time the message was received. Otherwise, we can calculate it from the
5510 message id. */
059ec3d9 5511
41313d92
JH
5512 if (rc != spool_read_hdrerror)
5513 {
5514 received_time = 0;
5515 for (i = 0; i < 6; i++)
5516 received_time = received_time * BASE_62 + tab62[id[i] - '0'];
5517 }
059ec3d9 5518
41313d92 5519 /* If we've had this malformed message too long, sling it. */
059ec3d9 5520
41313d92
JH
5521 if (now - received_time > keep_malformed)
5522 {
5523 Uunlink(spool_fname(US"msglog", message_subdir, id, US""));
5524 Uunlink(spool_fname(US"input", message_subdir, id, US"-D"));
5525 Uunlink(spool_fname(US"input", message_subdir, id, US"-H"));
5526 Uunlink(spool_fname(US"input", message_subdir, id, US"-J"));
5527 log_write(0, LOG_MAIN, "Message removed because older than %s",
5528 readconf_printtime(keep_malformed));
5529 }
059ec3d9 5530
41313d92
JH
5531 (void)close(deliver_datafile);
5532 deliver_datafile = -1;
5533 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5534 }
059ec3d9
PH
5535 }
5536
5537/* The spool header file has been read. Look to see if there is an existing
5538journal file for this message. If there is, it means that a previous delivery
5539attempt crashed (program or host) before it could update the spool header file.
5540Read the list of delivered addresses from the journal and add them to the
5541nonrecipients tree. Then update the spool file. We can leave the journal in
5542existence, as it will get further successful deliveries added to it in this
5543run, and it will be deleted if this function gets to its end successfully.
5544Otherwise it might be needed again. */
5545
059ec3d9 5546 {
41313d92 5547 uschar * fname = spool_fname(US"input", message_subdir, id, US"-J");
92b0827a 5548 FILE * jread;
41313d92 5549
92b0827a
JH
5550 if ( (journal_fd = Uopen(fname, O_RDWR|O_APPEND
5551#ifdef O_CLOEXEC
5552 | O_CLOEXEC
5553#endif
5554#ifdef O_NOFOLLOW
5555 | O_NOFOLLOW
5556#endif
5557 , SPOOL_MODE)) >= 0
5558 && lseek(journal_fd, 0, SEEK_SET) == 0
5559 && (jread = fdopen(journal_fd, "rb"))
5560 )
059ec3d9 5561 {
41313d92
JH
5562 while (Ufgets(big_buffer, big_buffer_size, jread))
5563 {
5564 int n = Ustrlen(big_buffer);
5565 big_buffer[n-1] = 0;
5566 tree_add_nonrecipient(big_buffer);
5567 DEBUG(D_deliver) debug_printf("Previously delivered address %s taken from "
5568 "journal file\n", big_buffer);
5569 }
92b0827a 5570 rewind(jread);
c0741086
JH
5571 if ((journal_fd = dup(fileno(jread))) < 0)
5572 journal_fd = fileno(jread);
5573 else
5574 (void) fclose(jread); /* Try to not leak the FILE resource */
5575
41313d92
JH
5576 /* Panic-dies on error */
5577 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
5578 }
5579 else if (errno != ENOENT)
5580 {
5581 log_write(0, LOG_MAIN|LOG_PANIC, "attempt to open journal for reading gave: "
5582 "%s", strerror(errno));
5583 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
059ec3d9 5584 }
059ec3d9 5585
41313d92 5586 /* A null recipients list indicates some kind of disaster. */
059ec3d9 5587
41313d92
JH
5588 if (!recipients_list)
5589 {
5590 (void)close(deliver_datafile);
5591 deliver_datafile = -1;
5592 log_write(0, LOG_MAIN, "Spool error: no recipients for %s", fname);
5593 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5594 }
059ec3d9
PH
5595 }
5596
5597
5598/* Handle a message that is frozen. There are a number of different things that
5599can happen, but in the default situation, unless forced, no delivery is
5600attempted. */
5601
5602if (deliver_freeze)
5603 {
a7538db1 5604#ifdef SUPPORT_MOVE_FROZEN_MESSAGES
059ec3d9
PH
5605 /* Moving to another directory removes the message from Exim's view. Other
5606 tools must be used to deal with it. Logging of this action happens in
5607 spool_move_message() and its subfunctions. */
5608
d6c82d7b
JH
5609 if ( move_frozen_messages
5610 && spool_move_message(id, message_subdir, US"", US"F")
5611 )
059ec3d9 5612 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
a7538db1 5613#endif
059ec3d9
PH
5614
5615 /* For all frozen messages (bounces or not), timeout_frozen_after sets the
5616 maximum time to keep messages that are frozen. Thaw if we reach it, with a
5617 flag causing all recipients to be failed. The time is the age of the
5618 message, not the time since freezing. */
5619
5620 if (timeout_frozen_after > 0 && message_age >= timeout_frozen_after)
5621 {
5622 log_write(0, LOG_MAIN, "cancelled by timeout_frozen_after");
5623 process_recipients = RECIP_FAIL_TIMEOUT;
5624 }
5625
5626 /* For bounce messages (and others with no sender), thaw if the error message
5627 ignore timer is exceeded. The message will be discarded if this delivery
5628 fails. */
5629
10c50704 5630 else if (!*sender_address && message_age >= ignore_bounce_errors_after)
059ec3d9 5631 log_write(0, LOG_MAIN, "Unfrozen by errmsg timer");
059ec3d9 5632
ef213c3b
PH
5633 /* If this is a bounce message, or there's no auto thaw, or we haven't
5634 reached the auto thaw time yet, and this delivery is not forced by an admin
5635 user, do not attempt delivery of this message. Note that forced is set for
5636 continuing messages down the same channel, in order to skip load checking and
5637 ignore hold domains, but we don't want unfreezing in that case. */
059ec3d9
PH
5638
5639 else
5640 {
d6c82d7b
JH
5641 if ( ( sender_address[0] == 0
5642 || auto_thaw <= 0
5643 || now <= deliver_frozen_at + auto_thaw
5644 )
5645 && ( !forced || !deliver_force_thaw
5646 || !admin_user || continue_hostname
5647 ) )
059ec3d9 5648 {
f1e894f3 5649 (void)close(deliver_datafile);
059ec3d9
PH
5650 deliver_datafile = -1;
5651 log_write(L_skip_delivery, LOG_MAIN, "Message is frozen");
5652 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5653 }
5654
5655 /* If delivery was forced (by an admin user), assume a manual thaw.
5656 Otherwise it's an auto thaw. */
5657
5658 if (forced)
5659 {
5660 deliver_manual_thaw = TRUE;
5661 log_write(0, LOG_MAIN, "Unfrozen by forced delivery");
5662 }
5663 else log_write(0, LOG_MAIN, "Unfrozen by auto-thaw");
5664 }
5665
5666 /* We get here if any of the rules for unfreezing have triggered. */
5667
5668 deliver_freeze = FALSE;
5669 update_spool = TRUE;
5670 }
5671
5672
5673/* Open the message log file if we are using them. This records details of
5674deliveries, deferments, and failures for the benefit of the mail administrator.
5675The log is not used by exim itself to track the progress of a message; that is
5676done by rewriting the header spool file. */
5677
5678if (message_logs)
5679 {
41313d92
JH
5680 uschar * fname = spool_fname(US"msglog", message_subdir, id, US"");
5681 uschar * error;
059ec3d9
PH
5682 int fd;
5683
41313d92 5684 if ((fd = open_msglog_file(fname, SPOOL_MODE, &error)) < 0)
059ec3d9
PH
5685 {
5686 log_write(0, LOG_MAIN|LOG_PANIC, "Couldn't %s message log %s: %s", error,
41313d92 5687 fname, strerror(errno));
059ec3d9
PH
5688 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5689 }
5690
5691 /* Make a C stream out of it. */
5692
d6c82d7b 5693 if (!(message_log = fdopen(fd, "a")))
059ec3d9
PH
5694 {
5695 log_write(0, LOG_MAIN|LOG_PANIC, "Couldn't fdopen message log %s: %s",
41313d92 5696 fname, strerror(errno));
059ec3d9
PH
5697 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5698 }
5699 }
5700
5701
5702/* If asked to give up on a message, log who did it, and set the action for all
5703the addresses. */
5704
5705if (give_up)
5706 {
5707 struct passwd *pw = getpwuid(real_uid);
d6c82d7b
JH
5708 log_write(0, LOG_MAIN, "cancelled by %s",
5709 pw ? US pw->pw_name : string_sprintf("uid %ld", (long int)real_uid));
059ec3d9
PH
5710 process_recipients = RECIP_FAIL;
5711 }
5712
5713/* Otherwise, if there are too many Received: headers, fail all recipients. */
5714
5715else if (received_count > received_headers_max)
5716 process_recipients = RECIP_FAIL_LOOP;
5717
5718/* Otherwise, if a system-wide, address-independent message filter is
5719specified, run it now, except in the case when we are failing all recipients as
5720a result of timeout_frozen_after. If the system filter yields "delivered", then
5721ignore the true recipients of the message. Failure of the filter file is
5722logged, and the delivery attempt fails. */
5723
d6c82d7b 5724else if (system_filter && process_recipients != RECIP_FAIL_TIMEOUT)
059ec3d9
PH
5725 {
5726 int rc;
5727 int filtertype;
5728 ugid_block ugid;
5729 redirect_block redirect;
5730
5731 if (system_filter_uid_set)
5732 {
5733 ugid.uid = system_filter_uid;
5734 ugid.gid = system_filter_gid;
5735 ugid.uid_set = ugid.gid_set = TRUE;
5736 }
5737 else
5738 {
5739 ugid.uid_set = ugid.gid_set = FALSE;
5740 }
5741
5742 return_path = sender_address;
5743 enable_dollar_recipients = TRUE; /* Permit $recipients in system filter */
5744 system_filtering = TRUE;
5745
5746 /* Any error in the filter file causes a delivery to be abandoned. */
5747
5748 redirect.string = system_filter;
5749 redirect.isfile = TRUE;
5750 redirect.check_owner = redirect.check_group = FALSE;
5751 redirect.owners = NULL;
5752 redirect.owngroups = NULL;
5753 redirect.pw = NULL;
5754 redirect.modemask = 0;
5755
5756 DEBUG(D_deliver|D_filter) debug_printf("running system filter\n");
5757
5758 rc = rda_interpret(
5759 &redirect, /* Where the data is */
5760 RDO_DEFER | /* Turn on all the enabling options */
5761 RDO_FAIL | /* Leave off all the disabling options */
5762 RDO_FILTER |
5763 RDO_FREEZE |
5764 RDO_REALLOG |
5765 RDO_REWRITE,
5766 NULL, /* No :include: restriction (not used in filter) */
5767 NULL, /* No sieve vacation directory (not sieve!) */
efd9a422 5768 NULL, /* No sieve enotify mailto owner (not sieve!) */
e4a89c47
PH
5769 NULL, /* No sieve user address (not sieve!) */
5770 NULL, /* No sieve subaddress (not sieve!) */
059ec3d9
PH
5771 &ugid, /* uid/gid data */
5772 &addr_new, /* Where to hang generated addresses */
5773 &filter_message, /* Where to put error message */
5774 NULL, /* Don't skip syntax errors */
5775 &filtertype, /* Will always be set to FILTER_EXIM for this call */
5776 US"system filter"); /* For error messages */
5777
5778 DEBUG(D_deliver|D_filter) debug_printf("system filter returned %d\n", rc);
5779
5780 if (rc == FF_ERROR || rc == FF_NONEXIST)
5781 {
f1e894f3 5782 (void)close(deliver_datafile);
059ec3d9
PH
5783 deliver_datafile = -1;
5784 log_write(0, LOG_MAIN|LOG_PANIC, "Error in system filter: %s",
5785 string_printing(filter_message));
5786 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5787 }
5788
5789 /* Reset things. If the filter message is an empty string, which can happen
5790 for a filter "fail" or "freeze" command with no text, reset it to NULL. */
5791
5792 system_filtering = FALSE;
5793 enable_dollar_recipients = FALSE;
d6c82d7b 5794 if (filter_message && filter_message[0] == 0) filter_message = NULL;
059ec3d9
PH
5795
5796 /* Save the values of the system filter variables so that user filters
5797 can use them. */
5798
5799 memcpy(filter_sn, filter_n, sizeof(filter_sn));
5800
5801 /* The filter can request that delivery of the original addresses be
5802 deferred. */
5803
5804 if (rc == FF_DEFER)
5805 {
5806 process_recipients = RECIP_DEFER;
5807 deliver_msglog("Delivery deferred by system filter\n");
5808 log_write(0, LOG_MAIN, "Delivery deferred by system filter");
5809 }
5810
5811 /* The filter can request that a message be frozen, but this does not
5812 take place if the message has been manually thawed. In that case, we must
5813 unset "delivered", which is forced by the "freeze" command to make -bF
5814 work properly. */
5815
5816 else if (rc == FF_FREEZE && !deliver_manual_thaw)
5817 {
5818 deliver_freeze = TRUE;
5819 deliver_frozen_at = time(NULL);
5820 process_recipients = RECIP_DEFER;
5821 frozen_info = string_sprintf(" by the system filter%s%s",
d6c82d7b
JH
5822 filter_message ? US": " : US"",
5823 filter_message ? filter_message : US"");
059ec3d9
PH
5824 }
5825
5826 /* The filter can request that a message be failed. The error message may be
5827 quite long - it is sent back to the sender in the bounce - but we don't want
5828 to fill up the log with repetitions of it. If it starts with << then the text
5829 between << and >> is written to the log, with the rest left for the bounce
5830 message. */
5831
5832 else if (rc == FF_FAIL)
5833 {
5834 uschar *colon = US"";
5835 uschar *logmsg = US"";
5836 int loglen = 0;
5837
5838 process_recipients = RECIP_FAIL_FILTER;
5839
d6c82d7b 5840 if (filter_message)
059ec3d9
PH
5841 {
5842 uschar *logend;
5843 colon = US": ";
d6c82d7b
JH
5844 if ( filter_message[0] == '<'
5845 && filter_message[1] == '<'
5846 && (logend = Ustrstr(filter_message, ">>"))
5847 )
059ec3d9
PH
5848 {
5849 logmsg = filter_message + 2;
5850 loglen = logend - logmsg;
5851 filter_message = logend + 2;
5852 if (filter_message[0] == 0) filter_message = NULL;
5853 }
5854 else
5855 {
5856 logmsg = filter_message;
5857 loglen = Ustrlen(filter_message);
5858 }
5859 }
5860
5861 log_write(0, LOG_MAIN, "cancelled by system filter%s%.*s", colon, loglen,
5862 logmsg);
5863 }
5864
5865 /* Delivery can be restricted only to those recipients (if any) that the
5866 filter specified. */
5867
5868 else if (rc == FF_DELIVERED)
5869 {
5870 process_recipients = RECIP_IGNORE;
d6c82d7b 5871 if (addr_new)
059ec3d9 5872 log_write(0, LOG_MAIN, "original recipients ignored (system filter)");
d6c82d7b
JH
5873 else
5874 log_write(0, LOG_MAIN, "=> discarded (system filter)");
059ec3d9
PH
5875 }
5876
5877 /* If any new addresses were created by the filter, fake up a "parent"
5878 for them. This is necessary for pipes, etc., which are expected to have
5879 parents, and it also gives some sensible logging for others. Allow
5880 pipes, files, and autoreplies, and run them as the filter uid if set,
5881 otherwise as the current uid. */
5882
d6c82d7b 5883 if (addr_new)
059ec3d9
PH
5884 {
5885 int uid = (system_filter_uid_set)? system_filter_uid : geteuid();
5886 int gid = (system_filter_gid_set)? system_filter_gid : getegid();
5887
5888 /* The text "system-filter" is tested in transport_set_up_command() and in
5889 set_up_shell_command() in the pipe transport, to enable them to permit
5890 $recipients, so don't change it here without also changing it there. */
5891
5892 address_item *p = addr_new;
5893 address_item *parent = deliver_make_addr(US"system-filter", FALSE);
5894
5895 parent->domain = string_copylc(qualify_domain_recipient);
5896 parent->local_part = US"system-filter";
5897
5898 /* As part of this loop, we arrange for addr_last to end up pointing
5899 at the final address. This is used if we go on to add addresses for the
5900 original recipients. */
5901
d6c82d7b 5902 while (p)
059ec3d9 5903 {
4362ff0d
PH
5904 if (parent->child_count == SHRT_MAX)
5905 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "system filter generated more "
5906 "than %d delivery addresses", SHRT_MAX);
059ec3d9
PH
5907 parent->child_count++;
5908 p->parent = parent;
5909
5910 if (testflag(p, af_pfr))
5911 {
5912 uschar *tpname;
5913 uschar *type;
5914 p->uid = uid;
5915 p->gid = gid;
5916 setflag(p, af_uid_set |
5917 af_gid_set |
5918 af_allow_file |
5919 af_allow_pipe |
5920 af_allow_reply);
5921
5922 /* Find the name of the system filter's appropriate pfr transport */
5923
5924 if (p->address[0] == '|')
5925 {
5926 type = US"pipe";
5927 tpname = system_filter_pipe_transport;
5928 address_pipe = p->address;
5929 }
5930 else if (p->address[0] == '>')
5931 {
5932 type = US"reply";
5933 tpname = system_filter_reply_transport;
5934 }
5935 else
5936 {
5937 if (p->address[Ustrlen(p->address)-1] == '/')
5938 {
5939 type = US"directory";
5940 tpname = system_filter_directory_transport;
5941 }
5942 else
5943 {
5944 type = US"file";
5945 tpname = system_filter_file_transport;
5946 }
5947 address_file = p->address;
5948 }
5949
5950 /* Now find the actual transport, first expanding the name. We have
5951 set address_file or address_pipe above. */
5952
d6c82d7b 5953 if (tpname)
059ec3d9
PH
5954 {
5955 uschar *tmp = expand_string(tpname);
5956 address_file = address_pipe = NULL;
d6c82d7b 5957 if (!tmp)
059ec3d9
PH
5958 p->message = string_sprintf("failed to expand \"%s\" as a "
5959 "system filter transport name", tpname);
5960 tpname = tmp;
5961 }
5962 else
059ec3d9
PH
5963 p->message = string_sprintf("system_filter_%s_transport is unset",
5964 type);
059ec3d9 5965
d6c82d7b 5966 if (tpname)
059ec3d9
PH
5967 {
5968 transport_instance *tp;
d6c82d7b 5969 for (tp = transports; tp; tp = tp->next)
059ec3d9
PH
5970 if (Ustrcmp(tp->name, tpname) == 0)
5971 {
5972 p->transport = tp;
5973 break;
5974 }
d6c82d7b 5975 if (!tp)
059ec3d9
PH
5976 p->message = string_sprintf("failed to find \"%s\" transport "
5977 "for system filter delivery", tpname);
5978 }
5979
5980 /* If we couldn't set up a transport, defer the delivery, putting the
5981 error on the panic log as well as the main log. */
5982
d6c82d7b 5983 if (!p->transport)
059ec3d9
PH
5984 {
5985 address_item *badp = p;
5986 p = p->next;
d6c82d7b 5987 if (!addr_last) addr_new = p; else addr_last->next = p;
059ec3d9
PH
5988 badp->local_part = badp->address; /* Needed for log line */
5989 post_process_one(badp, DEFER, LOG_MAIN|LOG_PANIC, DTYPE_ROUTER, 0);
5990 continue;
5991 }
5992 } /* End of pfr handling */
5993
5994 /* Either a non-pfr delivery, or we found a transport */
5995
5996 DEBUG(D_deliver|D_filter)
5997 debug_printf("system filter added %s\n", p->address);
5998
5999 addr_last = p;
6000 p = p->next;
6001 } /* Loop through all addr_new addresses */
6002 }
6003 }
6004
6005
6006/* Scan the recipients list, and for every one that is not in the non-
6007recipients tree, add an addr item to the chain of new addresses. If the pno
6008value is non-negative, we must set the onetime parent from it. This which
6009points to the relevant entry in the recipients list.
6010
6011This processing can be altered by the setting of the process_recipients
6012variable, which is changed if recipients are to be ignored, failed, or
6013deferred. This can happen as a result of system filter activity, or if the -Mg
6014option is used to fail all of them.
6015
6016Duplicate addresses are handled later by a different tree structure; we can't
6017just extend the non-recipients tree, because that will be re-written to the
6018spool if the message is deferred, and in any case there are casing
6019complications for local addresses. */
6020
6021if (process_recipients != RECIP_IGNORE)
6022 {
6023 for (i = 0; i < recipients_count; i++)
6024 {
d6c82d7b 6025 if (!tree_search(tree_nonrecipients, recipients_list[i].address))
059ec3d9
PH
6026 {
6027 recipient_item *r = recipients_list + i;
6028 address_item *new = deliver_make_addr(r->address, FALSE);
d43cbe25 6029 new->prop.errors_address = r->errors_to;
8c5d388a 6030#ifdef SUPPORT_I18N
3c8b3577
JH
6031 if ((new->prop.utf8_msg = message_smtputf8))
6032 {
6033 new->prop.utf8_downcvt = message_utf8_downconvert == 1;
6034 new->prop.utf8_downcvt_maybe = message_utf8_downconvert == -1;
0ec7e948
JH
6035 DEBUG(D_deliver) debug_printf("utf8, downconvert %s\n",
6036 new->prop.utf8_downcvt ? "yes"
6037 : new->prop.utf8_downcvt_maybe ? "ifneeded"
6038 : "no");
3c8b3577 6039 }
7ade712c 6040#endif
059ec3d9
PH
6041
6042 if (r->pno >= 0)
6043 new->onetime_parent = recipients_list[r->pno].address;
6044
94431adb 6045 /* If DSN support is enabled, set the dsn flags and the original receipt
6c1c3d1d
WB
6046 to be passed on to other DSN enabled MTAs */
6047 new->dsn_flags = r->dsn_flags & rf_dsnflags;
6048 new->dsn_orcpt = r->orcpt;
f923454a
JH
6049 DEBUG(D_deliver) debug_printf("DSN: set orcpt: %s flags: %d\n",
6050 new->dsn_orcpt, new->dsn_flags);
6c1c3d1d 6051
059ec3d9
PH
6052 switch (process_recipients)
6053 {
6054 /* RECIP_DEFER is set when a system filter freezes a message. */
6055
6056 case RECIP_DEFER:
6057 new->next = addr_defer;
6058 addr_defer = new;
6059 break;
6060
6061
6062 /* RECIP_FAIL_FILTER is set when a system filter has obeyed a "fail"
6063 command. */
6064
6065 case RECIP_FAIL_FILTER:
6066 new->message =
d6c82d7b 6067 filter_message ? filter_message : US"delivery cancelled";
447d236c 6068 setflag(new, af_pass_message);
059ec3d9
PH
6069 goto RECIP_QUEUE_FAILED; /* below */
6070
6071
6072 /* RECIP_FAIL_TIMEOUT is set when a message is frozen, but is older
6073 than the value in timeout_frozen_after. Treat non-bounce messages
6074 similarly to -Mg; for bounce messages we just want to discard, so
6075 don't put the address on the failed list. The timeout has already
6076 been logged. */
6077
6078 case RECIP_FAIL_TIMEOUT:
6079 new->message = US"delivery cancelled; message timed out";
6080 goto RECIP_QUEUE_FAILED; /* below */
6081
6082
6083 /* RECIP_FAIL is set when -Mg has been used. */
6084
6085 case RECIP_FAIL:
6086 new->message = US"delivery cancelled by administrator";
6087 /* Fall through */
6088
6089 /* Common code for the failure cases above. If this is not a bounce
6090 message, put the address on the failed list so that it is used to
6091 create a bounce. Otherwise do nothing - this just discards the address.
6092 The incident has already been logged. */
6093
6094 RECIP_QUEUE_FAILED:
6095 if (sender_address[0] != 0)
6096 {
6097 new->next = addr_failed;
6098 addr_failed = new;
6099 }
6100 break;
6101
6102
6103 /* RECIP_FAIL_LOOP is set when there are too many Received: headers
6104 in the message. Process each address as a routing failure; if this
6105 is a bounce message, it will get frozen. */
6106
6107 case RECIP_FAIL_LOOP:
6108 new->message = US"Too many \"Received\" headers - suspected mail loop";
6109 post_process_one(new, FAIL, LOG_MAIN, DTYPE_ROUTER, 0);
6110 break;
6111
6112
6113 /* Value should be RECIP_ACCEPT; take this as the safe default. */
6114
6115 default:
d6c82d7b 6116 if (!addr_new) addr_new = new; else addr_last->next = new;
059ec3d9
PH
6117 addr_last = new;
6118 break;
6119 }
14a465c3 6120
0cbf2b82 6121#ifndef DISABLE_EVENT
14a465c3
JH
6122 if (process_recipients != RECIP_ACCEPT)
6123 {
6124 uschar * save_local = deliver_localpart;
55414b25 6125 const uschar * save_domain = deliver_domain;
14a465c3
JH
6126
6127 deliver_localpart = expand_string(
6128 string_sprintf("${local_part:%s}", new->address));
6129 deliver_domain = expand_string(
6130 string_sprintf("${domain:%s}", new->address));
6131
774ef2d7 6132 (void) event_raise(event_action,
14a465c3
JH
6133 US"msg:fail:internal", new->message);
6134
6135 deliver_localpart = save_local;
6136 deliver_domain = save_domain;
6137 }
6138#endif
059ec3d9
PH
6139 }
6140 }
6141 }
6142
6143DEBUG(D_deliver)
6144 {
d6c82d7b 6145 address_item *p;
059ec3d9 6146 debug_printf("Delivery address list:\n");
d6c82d7b
JH
6147 for (p = addr_new; p; p = p->next)
6148 debug_printf(" %s %s\n", p->address,
6149 p->onetime_parent ? p->onetime_parent : US"");
059ec3d9
PH
6150 }
6151
6152/* Set up the buffers used for copying over the file when delivering. */
6153
6154deliver_in_buffer = store_malloc(DELIVER_IN_BUFFER_SIZE);
6155deliver_out_buffer = store_malloc(DELIVER_OUT_BUFFER_SIZE);
6156
6157
6158
6159/* Until there are no more new addresses, handle each one as follows:
6160
6161 . If this is a generated address (indicated by the presence of a parent
6162 pointer) then check to see whether it is a pipe, file, or autoreply, and
6163 if so, handle it directly here. The router that produced the address will
6164 have set the allow flags into the address, and also set the uid/gid required.
6165 Having the routers generate new addresses and then checking them here at
6166 the outer level is tidier than making each router do the checking, and
6167 means that routers don't need access to the failed address queue.
6168
6169 . Break up the address into local part and domain, and make lowercased
6170 versions of these strings. We also make unquoted versions of the local part.
6171
6172 . Handle the percent hack for those domains for which it is valid.
6173
6174 . For child addresses, determine if any of the parents have the same address.
6175 If so, generate a different string for previous delivery checking. Without
6176 this code, if the address spqr generates spqr via a forward or alias file,
6177 delivery of the generated spqr stops further attempts at the top level spqr,
6178 which is not what is wanted - it may have generated other addresses.
6179
6180 . Check on the retry database to see if routing was previously deferred, but
6181 only if in a queue run. Addresses that are to be routed are put on the
6182 addr_route chain. Addresses that are to be deferred are put on the
6183 addr_defer chain. We do all the checking first, so as not to keep the
6184 retry database open any longer than necessary.
6185
6186 . Now we run the addresses through the routers. A router may put the address
6187 on either the addr_local or the addr_remote chain for local or remote
6188 delivery, respectively, or put it on the addr_failed chain if it is
6189 undeliveable, or it may generate child addresses and put them on the
6190 addr_new chain, or it may defer an address. All the chain anchors are
6191 passed as arguments so that the routers can be called for verification
6192 purposes as well.
6193
6194 . If new addresses have been generated by the routers, da capo.
6195*/
6196
6197header_rewritten = FALSE; /* No headers rewritten yet */
d6c82d7b 6198while (addr_new) /* Loop until all addresses dealt with */
059ec3d9
PH
6199 {
6200 address_item *addr, *parent;
059ec3d9
PH
6201
6202 /* Failure to open the retry database is treated the same as if it does
6203 not exist. In both cases, dbm_file is NULL. */
6204
d6c82d7b 6205 if (!(dbm_file = dbfn_open(US"retry", O_RDONLY, &dbblock, FALSE)))
059ec3d9
PH
6206 {
6207 DEBUG(D_deliver|D_retry|D_route|D_hints_lookup)
6208 debug_printf("no retry data available\n");
6209 }
6210
6211 /* Scan the current batch of new addresses, to handle pipes, files and
6212 autoreplies, and determine which others are ready for routing. */
6213
d6c82d7b 6214 while (addr_new)
059ec3d9
PH
6215 {
6216 int rc;
6217 uschar *p;
6218 tree_node *tnode;
6219 dbdata_retry *domain_retry_record;
6220 dbdata_retry *address_retry_record;
6221
6222 addr = addr_new;
6223 addr_new = addr->next;
6224
6225 DEBUG(D_deliver|D_retry|D_route)
6226 {
6227 debug_printf(">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>\n");
6228 debug_printf("Considering: %s\n", addr->address);
6229 }
6230
6231 /* Handle generated address that is a pipe or a file or an autoreply. */
6232
6233 if (testflag(addr, af_pfr))
6234 {
424a1c63
PH
6235 /* If an autoreply in a filter could not generate a syntactically valid
6236 address, give up forthwith. Set af_ignore_error so that we don't try to
6237 generate a bounce. */
6238
6239 if (testflag(addr, af_bad_reply))
6240 {
6241 addr->basic_errno = ERRNO_BADADDRESS2;
6242 addr->local_part = addr->address;
6243 addr->message =
6244 US"filter autoreply generated syntactically invalid recipient";
6245 setflag(addr, af_ignore_error);
6246 (void)post_process_one(addr, FAIL, LOG_MAIN, DTYPE_ROUTER, 0);
6247 continue; /* with the next new address */
6248 }
059ec3d9
PH
6249
6250 /* If two different users specify delivery to the same pipe or file or
6251 autoreply, there should be two different deliveries, so build a unique
6252 string that incorporates the original address, and use this for
6253 duplicate testing and recording delivery, and also for retrying. */
6254
6255 addr->unique =
424a1c63
PH
6256 string_sprintf("%s:%s", addr->address, addr->parent->unique +
6257 (testflag(addr->parent, af_homonym)? 3:0));
059ec3d9
PH
6258
6259 addr->address_retry_key = addr->domain_retry_key =
6260 string_sprintf("T:%s", addr->unique);
6261
6262 /* If a filter file specifies two deliveries to the same pipe or file,
6263 we want to de-duplicate, but this is probably not wanted for two mail
6264 commands to the same address, where probably both should be delivered.
6265 So, we have to invent a different unique string in that case. Just
6266 keep piling '>' characters on the front. */
6267
6268 if (addr->address[0] == '>')
6269 {
d6c82d7b 6270 while (tree_search(tree_duplicates, addr->unique))
059ec3d9
PH
6271 addr->unique = string_sprintf(">%s", addr->unique);
6272 }
6273
d6c82d7b 6274 else if ((tnode = tree_search(tree_duplicates, addr->unique)))
059ec3d9
PH
6275 {
6276 DEBUG(D_deliver|D_route)
6277 debug_printf("%s is a duplicate address: discarded\n", addr->address);
6278 addr->dupof = tnode->data.ptr;
6279 addr->next = addr_duplicate;
6280 addr_duplicate = addr;
6281 continue;
6282 }
6283
6284 DEBUG(D_deliver|D_route) debug_printf("unique = %s\n", addr->unique);
6285
6286 /* Check for previous delivery */
6287
d6c82d7b 6288 if (tree_search(tree_nonrecipients, addr->unique))
059ec3d9
PH
6289 {
6290 DEBUG(D_deliver|D_route)
6291 debug_printf("%s was previously delivered: discarded\n", addr->address);
6292 child_done(addr, tod_stamp(tod_log));
6293 continue;
6294 }
6295
6296 /* Save for checking future duplicates */
6297
6298 tree_add_duplicate(addr->unique, addr);
6299
6300 /* Set local part and domain */
6301
6302 addr->local_part = addr->address;
6303 addr->domain = addr->parent->domain;
6304
6305 /* Ensure that the delivery is permitted. */
6306
6307 if (testflag(addr, af_file))
6308 {
6309 if (!testflag(addr, af_allow_file))
6310 {
6311 addr->basic_errno = ERRNO_FORBIDFILE;
6312 addr->message = US"delivery to file forbidden";
6313 (void)post_process_one(addr, FAIL, LOG_MAIN, DTYPE_ROUTER, 0);
6314 continue; /* with the next new address */
6315 }
6316 }
6317 else if (addr->address[0] == '|')
6318 {
6319 if (!testflag(addr, af_allow_pipe))
6320 {
6321 addr->basic_errno = ERRNO_FORBIDPIPE;
6322 addr->message = US"delivery to pipe forbidden";
6323 (void)post_process_one(addr, FAIL, LOG_MAIN, DTYPE_ROUTER, 0);
6324 continue; /* with the next new address */
6325 }
6326 }
6327 else if (!testflag(addr, af_allow_reply))
6328 {
6329 addr->basic_errno = ERRNO_FORBIDREPLY;
6330 addr->message = US"autoreply forbidden";
6331 (void)post_process_one(addr, FAIL, LOG_MAIN, DTYPE_ROUTER, 0);
6332 continue; /* with the next new address */
6333 }
6334
6335 /* If the errno field is already set to BADTRANSPORT, it indicates
6336 failure to expand a transport string, or find the associated transport,
6337 or an unset transport when one is required. Leave this test till now so
6338 that the forbid errors are given in preference. */
6339
6340 if (addr->basic_errno == ERRNO_BADTRANSPORT)
6341 {
6342 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_ROUTER, 0);
6343 continue;
6344 }
6345
6346 /* Treat /dev/null as a special case and abandon the delivery. This
6347 avoids having to specify a uid on the transport just for this case.
6348 Arrange for the transport name to be logged as "**bypassed**". */
6349
6350 if (Ustrcmp(addr->address, "/dev/null") == 0)
6351 {
6352 uschar *save = addr->transport->name;
6353 addr->transport->name = US"**bypassed**";
6354 (void)post_process_one(addr, OK, LOG_MAIN, DTYPE_TRANSPORT, '=');
6355 addr->transport->name = save;
6356 continue; /* with the next new address */
6357 }
6358
6359 /* Pipe, file, or autoreply delivery is to go ahead as a normal local
6360 delivery. */
6361
6362 DEBUG(D_deliver|D_route)
6363 debug_printf("queued for %s transport\n", addr->transport->name);
6364 addr->next = addr_local;
6365 addr_local = addr;
6366 continue; /* with the next new address */
6367 }
6368
6369 /* Handle normal addresses. First, split up into local part and domain,
6370 handling the %-hack if necessary. There is the possibility of a defer from
6371 a lookup in percent_hack_domains. */
6372
6373 if ((rc = deliver_split_address(addr)) == DEFER)
6374 {
6375 addr->message = US"cannot check percent_hack_domains";
6376 addr->basic_errno = ERRNO_LISTDEFER;
6377 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_NONE, 0);
6378 continue;
6379 }
6380
6381 /* Check to see if the domain is held. If so, proceed only if the
6382 delivery was forced by hand. */
6383
6384 deliver_domain = addr->domain; /* set $domain */
d6c82d7b
JH
6385 if ( !forced && hold_domains
6386 && (rc = match_isinlist(addr->domain, (const uschar **)&hold_domains, 0,
059ec3d9 6387 &domainlist_anchor, addr->domain_cache, MCL_DOMAIN, TRUE,
d6c82d7b
JH
6388 NULL)) != FAIL
6389 )
059ec3d9
PH
6390 {
6391 if (rc == DEFER)
6392 {
6393 addr->message = US"hold_domains lookup deferred";
6394 addr->basic_errno = ERRNO_LISTDEFER;
6395 }
6396 else
6397 {
6398 addr->message = US"domain is held";
6399 addr->basic_errno = ERRNO_HELD;
6400 }
6401 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_NONE, 0);
6402 continue;
6403 }
6404
6405 /* Now we can check for duplicates and previously delivered addresses. In
6406 order to do this, we have to generate a "unique" value for each address,
6407 because there may be identical actual addresses in a line of descendents.
6408 The "unique" field is initialized to the same value as the "address" field,
6409 but gets changed here to cope with identically-named descendents. */
6410
d6c82d7b 6411 for (parent = addr->parent; parent; parent = parent->parent)
059ec3d9
PH
6412 if (strcmpic(addr->address, parent->address) == 0) break;
6413
6414 /* If there's an ancestor with the same name, set the homonym flag. This
6415 influences how deliveries are recorded. Then add a prefix on the front of
6416 the unique address. We use \n\ where n starts at 0 and increases each time.
6417 It is unlikely to pass 9, but if it does, it may look odd but will still
6418 work. This means that siblings or cousins with the same names are treated
6419 as duplicates, which is what we want. */
6420
d6c82d7b 6421 if (parent)
059ec3d9
PH
6422 {
6423 setflag(addr, af_homonym);
6424 if (parent->unique[0] != '\\')
6425 addr->unique = string_sprintf("\\0\\%s", addr->address);
6426 else
6427 addr->unique = string_sprintf("\\%c\\%s", parent->unique[1] + 1,
6428 addr->address);
6429 }
6430
6431 /* Ensure that the domain in the unique field is lower cased, because
6432 domains are always handled caselessly. */
6433
6434 p = Ustrrchr(addr->unique, '@');
6435 while (*p != 0) { *p = tolower(*p); p++; }
6436
6437 DEBUG(D_deliver|D_route) debug_printf("unique = %s\n", addr->unique);
6438
d6c82d7b 6439 if (tree_search(tree_nonrecipients, addr->unique))
059ec3d9
PH
6440 {
6441 DEBUG(D_deliver|D_route)
6442 debug_printf("%s was previously delivered: discarded\n", addr->unique);
6443 child_done(addr, tod_stamp(tod_log));
6444 continue;
6445 }
6446
059ec3d9 6447 /* Get the routing retry status, saving the two retry keys (with and
48c7f9e2
PH
6448 without the local part) for subsequent use. If there is no retry record for
6449 the standard address routing retry key, we look for the same key with the
6450 sender attached, because this form is used by the smtp transport after a
6451 4xx response to RCPT when address_retry_include_sender is true. */
059ec3d9
PH
6452
6453 addr->domain_retry_key = string_sprintf("R:%s", addr->domain);
6454 addr->address_retry_key = string_sprintf("R:%s@%s", addr->local_part,
6455 addr->domain);
6456
d6c82d7b 6457 if (dbm_file)
059ec3d9
PH
6458 {
6459 domain_retry_record = dbfn_read(dbm_file, addr->domain_retry_key);
d6c82d7b
JH
6460 if ( domain_retry_record
6461 && now - domain_retry_record->time_stamp > retry_data_expire
6462 )
48c7f9e2 6463 domain_retry_record = NULL; /* Ignore if too old */
059ec3d9
PH
6464
6465 address_retry_record = dbfn_read(dbm_file, addr->address_retry_key);
d6c82d7b
JH
6466 if ( address_retry_record
6467 && now - address_retry_record->time_stamp > retry_data_expire
6468 )
48c7f9e2
PH
6469 address_retry_record = NULL; /* Ignore if too old */
6470
d6c82d7b 6471 if (!address_retry_record)
48c7f9e2 6472 {
09945f1e 6473 uschar *altkey = string_sprintf("%s:<%s>", addr->address_retry_key,
48c7f9e2
PH
6474 sender_address);
6475 address_retry_record = dbfn_read(dbm_file, altkey);
d6c82d7b
JH
6476 if ( address_retry_record
6477 && now - address_retry_record->time_stamp > retry_data_expire)
48c7f9e2
PH
6478 address_retry_record = NULL; /* Ignore if too old */
6479 }
059ec3d9 6480 }
d6c82d7b
JH
6481 else
6482 domain_retry_record = address_retry_record = NULL;
059ec3d9
PH
6483
6484 DEBUG(D_deliver|D_retry)
6485 {
d6c82d7b 6486 if (!domain_retry_record)
059ec3d9 6487 debug_printf("no domain retry record\n");
d6c82d7b 6488 if (!address_retry_record)
059ec3d9
PH
6489 debug_printf("no address retry record\n");
6490 }
6491
6492 /* If we are sending a message down an existing SMTP connection, we must
6493 assume that the message which created the connection managed to route
6494 an address to that connection. We do not want to run the risk of taking
6495 a long time over routing here, because if we do, the server at the other
6496 end of the connection may time it out. This is especially true for messages
6497 with lots of addresses. For this kind of delivery, queue_running is not
6498 set, so we would normally route all addresses. We take a pragmatic approach
6499 and defer routing any addresses that have any kind of domain retry record.
6500 That is, we don't even look at their retry times. It doesn't matter if this
6501 doesn't work occasionally. This is all just an optimization, after all.
6502
6503 The reason for not doing the same for address retries is that they normally
6504 arise from 4xx responses, not DNS timeouts. */
6505
d6c82d7b 6506 if (continue_hostname && domain_retry_record)
059ec3d9
PH
6507 {
6508 addr->message = US"reusing SMTP connection skips previous routing defer";
6509 addr->basic_errno = ERRNO_RRETRY;
6510 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_ROUTER, 0);
6511 }
6512
f6c332bd
PH
6513 /* If we are in a queue run, defer routing unless there is no retry data or
6514 we've passed the next retry time, or this message is forced. In other
6515 words, ignore retry data when not in a queue run.
6516
6517 However, if the domain retry time has expired, always allow the routing
6518 attempt. If it fails again, the address will be failed. This ensures that
059ec3d9
PH
6519 each address is routed at least once, even after long-term routing
6520 failures.
6521
6522 If there is an address retry, check that too; just wait for the next
6523 retry time. This helps with the case when the temporary error on the
6524 address was really message-specific rather than address specific, since
f6c332bd
PH
6525 it allows other messages through.
6526
6527 We also wait for the next retry time if this is a message sent down an
6528 existing SMTP connection (even though that will be forced). Otherwise there
6529 will be far too many attempts for an address that gets a 4xx error. In
6530 fact, after such an error, we should not get here because, the host should
6531 not be remembered as one this message needs. However, there was a bug that
ba9af0af
TF
6532 used to cause this to happen, so it is best to be on the safe side.
6533
1ddeb334
TF
6534 Even if we haven't reached the retry time in the hints, there is one more
6535 check to do, which is for the ultimate address timeout. We only do this
6536 check if there is an address retry record and there is not a domain retry
6537 record; this implies that previous attempts to handle the address had the
6538 retry_use_local_parts option turned on. We use this as an approximation
6539 for the destination being like a local delivery, for example delivery over
6540 LMTP to an IMAP message store. In this situation users are liable to bump
6541 into their quota and thereby have intermittently successful deliveries,
6542 which keep the retry record fresh, which can lead to us perpetually
6543 deferring messages. */
059ec3d9 6544
d6c82d7b
JH
6545 else if ( ( queue_running && !deliver_force
6546 || continue_hostname
6547 )
6548 && ( ( domain_retry_record
6549 && now < domain_retry_record->next_try
6550 && !domain_retry_record->expired
6551 )
6552 || ( address_retry_record
6553 && now < address_retry_record->next_try
6554 ) )
6555 && ( domain_retry_record
6556 || !address_retry_record
6557 || !retry_ultimate_address_timeout(addr->address_retry_key,
6558 addr->domain, address_retry_record, now)
6559 ) )
059ec3d9
PH
6560 {
6561 addr->message = US"retry time not reached";
6562 addr->basic_errno = ERRNO_RRETRY;
6563 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_ROUTER, 0);
6564 }
6565
6566 /* The domain is OK for routing. Remember if retry data exists so it
6567 can be cleaned up after a successful delivery. */
6568
6569 else
6570 {
d6c82d7b 6571 if (domain_retry_record || address_retry_record)
059ec3d9
PH
6572 setflag(addr, af_dr_retry_exists);
6573 addr->next = addr_route;
6574 addr_route = addr;
6575 DEBUG(D_deliver|D_route)
6576 debug_printf("%s: queued for routing\n", addr->address);
6577 }
6578 }
6579
6580 /* The database is closed while routing is actually happening. Requests to
6581 update it are put on a chain and all processed together at the end. */
6582
d6c82d7b 6583 if (dbm_file) dbfn_close(dbm_file);
059ec3d9
PH
6584
6585 /* If queue_domains is set, we don't even want to try routing addresses in
6586 those domains. During queue runs, queue_domains is forced to be unset.
6587 Optimize by skipping this pass through the addresses if nothing is set. */
6588
d6c82d7b 6589 if (!deliver_force && queue_domains)
059ec3d9
PH
6590 {
6591 address_item *okaddr = NULL;
d6c82d7b 6592 while (addr_route)
059ec3d9
PH
6593 {
6594 address_item *addr = addr_route;
6595 addr_route = addr->next;
6596
6597 deliver_domain = addr->domain; /* set $domain */
55414b25 6598 if ((rc = match_isinlist(addr->domain, (const uschar **)&queue_domains, 0,
059ec3d9
PH
6599 &domainlist_anchor, addr->domain_cache, MCL_DOMAIN, TRUE, NULL))
6600 != OK)
6601 {
6602 if (rc == DEFER)
6603 {
6604 addr->basic_errno = ERRNO_LISTDEFER;
6605 addr->message = US"queue_domains lookup deferred";
6606 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_ROUTER, 0);
6607 }
6608 else
6609 {
6610 addr->next = okaddr;
6611 okaddr = addr;
6612 }
6613 }
6614 else
6615 {
6616 addr->basic_errno = ERRNO_QUEUE_DOMAIN;
6617 addr->message = US"domain is in queue_domains";
6618 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_ROUTER, 0);
6619 }
6620 }
6621
6622 addr_route = okaddr;
6623 }
6624
6625 /* Now route those addresses that are not deferred. */
6626
d6c82d7b 6627 while (addr_route)
059ec3d9
PH
6628 {
6629 int rc;
6630 address_item *addr = addr_route;
55414b25 6631 const uschar *old_domain = addr->domain;
059ec3d9
PH
6632 uschar *old_unique = addr->unique;
6633 addr_route = addr->next;
6634 addr->next = NULL;
6635
6636 /* Just in case some router parameter refers to it. */
6637
d6c82d7b
JH
6638 if (!(return_path = addr->prop.errors_address))
6639 return_path = sender_address;
059ec3d9
PH
6640
6641 /* If a router defers an address, add a retry item. Whether or not to
6642 use the local part in the key is a property of the router. */
6643
6644 if ((rc = route_address(addr, &addr_local, &addr_remote, &addr_new,
6645 &addr_succeed, v_none)) == DEFER)
d6c82d7b
JH
6646 retry_add_item(addr,
6647 addr->router->retry_use_local_part
6648 ? string_sprintf("R:%s@%s", addr->local_part, addr->domain)
6649 : string_sprintf("R:%s", addr->domain),
6650 0);
059ec3d9
PH
6651
6652 /* Otherwise, if there is an existing retry record in the database, add
09945f1e
PH
6653 retry items to delete both forms. We must also allow for the possibility
6654 of a routing retry that includes the sender address. Since the domain might
6655 have been rewritten (expanded to fully qualified) as a result of routing,
6656 ensure that the rewritten form is also deleted. */
059ec3d9
PH
6657
6658 else if (testflag(addr, af_dr_retry_exists))
6659 {
09945f1e
PH
6660 uschar *altkey = string_sprintf("%s:<%s>", addr->address_retry_key,
6661 sender_address);
6662 retry_add_item(addr, altkey, rf_delete);
059ec3d9
PH
6663 retry_add_item(addr, addr->address_retry_key, rf_delete);
6664 retry_add_item(addr, addr->domain_retry_key, rf_delete);
6665 if (Ustrcmp(addr->domain, old_domain) != 0)
6666 retry_add_item(addr, string_sprintf("R:%s", old_domain), rf_delete);
6667 }
6668
6669 /* DISCARD is given for :blackhole: and "seen finish". The event has been
6670 logged, but we need to ensure the address (and maybe parents) is marked
6671 done. */
6672
6673 if (rc == DISCARD)
6674 {
6675 address_done(addr, tod_stamp(tod_log));
6676 continue; /* route next address */
6677 }
6678
6679 /* The address is finished with (failed or deferred). */
6680
6681 if (rc != OK)
6682 {
6683 (void)post_process_one(addr, rc, LOG_MAIN, DTYPE_ROUTER, 0);
6684 continue; /* route next address */
6685 }
6686
6687 /* The address has been routed. If the router changed the domain, it will
6688 also have changed the unique address. We have to test whether this address
6689 has already been delivered, because it's the unique address that finally
6690 gets recorded. */
6691
d6c82d7b
JH
6692 if ( addr->unique != old_unique
6693 && tree_search(tree_nonrecipients, addr->unique) != 0
6694 )
059ec3d9
PH
6695 {
6696 DEBUG(D_deliver|D_route) debug_printf("%s was previously delivered: "
6697 "discarded\n", addr->address);
6698 if (addr_remote == addr) addr_remote = addr->next;
6699 else if (addr_local == addr) addr_local = addr->next;
6700 }
6701
6702 /* If the router has same_domain_copy_routing set, we are permitted to copy
6703 the routing for any other addresses with the same domain. This is an
6704 optimisation to save repeated DNS lookups for "standard" remote domain
6705 routing. The option is settable only on routers that generate host lists.
6706 We play it very safe, and do the optimization only if the address is routed
6707 to a remote transport, there are no header changes, and the domain was not
6708 modified by the router. */
6709
d6c82d7b
JH
6710 if ( addr_remote == addr
6711 && addr->router->same_domain_copy_routing
6712 && !addr->prop.extra_headers
6713 && !addr->prop.remove_headers
6714 && old_domain == addr->domain
6715 )
059ec3d9
PH
6716 {
6717 address_item **chain = &addr_route;
d6c82d7b 6718 while (*chain)
059ec3d9
PH
6719 {
6720 address_item *addr2 = *chain;
6721 if (Ustrcmp(addr2->domain, addr->domain) != 0)
6722 {
6723 chain = &(addr2->next);
6724 continue;
6725 }
6726
6727 /* Found a suitable address; take it off the routing list and add it to
6728 the remote delivery list. */
6729
6730 *chain = addr2->next;
6731 addr2->next = addr_remote;
6732 addr_remote = addr2;
6733
6734 /* Copy the routing data */
6735
6736 addr2->domain = addr->domain;
6737 addr2->router = addr->router;
6738 addr2->transport = addr->transport;
6739 addr2->host_list = addr->host_list;
6740 addr2->fallback_hosts = addr->fallback_hosts;
d43cbe25 6741 addr2->prop.errors_address = addr->prop.errors_address;
059ec3d9
PH
6742 copyflag(addr2, addr, af_hide_child | af_local_host_removed);
6743
6744 DEBUG(D_deliver|D_route)
6745 {
6746 debug_printf(">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>\n"
6747 "routing %s\n"
6748 "Routing for %s copied from %s\n",
6749 addr2->address, addr2->address, addr->address);
6750 }
6751 }
6752 }
6753 } /* Continue with routing the next address. */
6754 } /* Loop to process any child addresses that the routers created, and
6755 any rerouted addresses that got put back on the new chain. */
6756
6757
6758/* Debugging: show the results of the routing */
6759
6760DEBUG(D_deliver|D_retry|D_route)
6761 {
d6c82d7b 6762 address_item *p;
059ec3d9
PH
6763 debug_printf(">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>\n");
6764 debug_printf("After routing:\n Local deliveries:\n");
d6c82d7b 6765 for (p = addr_local; p; p = p->next)
059ec3d9 6766 debug_printf(" %s\n", p->address);
059ec3d9 6767
059ec3d9 6768 debug_printf(" Remote deliveries:\n");
d6c82d7b 6769 for (p = addr_remote; p; p = p->next)
059ec3d9 6770 debug_printf(" %s\n", p->address);
059ec3d9 6771
059ec3d9 6772 debug_printf(" Failed addresses:\n");
d6c82d7b 6773 for (p = addr_failed; p; p = p->next)
059ec3d9 6774 debug_printf(" %s\n", p->address);
059ec3d9 6775
059ec3d9 6776 debug_printf(" Deferred addresses:\n");
d6c82d7b 6777 for (p = addr_defer; p; p = p->next)
059ec3d9 6778 debug_printf(" %s\n", p->address);
059ec3d9
PH
6779 }
6780
6781/* Free any resources that were cached during routing. */
6782
6783search_tidyup();
6784route_tidyup();
6785
6786/* These two variables are set only during routing, after check_local_user.
6787Ensure they are not set in transports. */
6788
6789local_user_gid = (gid_t)(-1);
6790local_user_uid = (uid_t)(-1);
6791
d7174846
PH
6792/* Check for any duplicate addresses. This check is delayed until after
6793routing, because the flexibility of the routing configuration means that
6794identical addresses with different parentage may end up being redirected to
6795different addresses. Checking for duplicates too early (as we previously used
6796to) makes this kind of thing not work. */
6797
6798do_duplicate_check(&addr_local);
6799do_duplicate_check(&addr_remote);
6800
059ec3d9
PH
6801/* When acting as an MUA wrapper, we proceed only if all addresses route to a
6802remote transport. The check that they all end up in one transaction happens in
6803the do_remote_deliveries() function. */
6804
d6c82d7b
JH
6805if ( mua_wrapper
6806 && (addr_local || addr_failed || addr_defer)
6807 )
059ec3d9
PH
6808 {
6809 address_item *addr;
6810 uschar *which, *colon, *msg;
6811
d6c82d7b 6812 if (addr_local)
059ec3d9
PH
6813 {
6814 addr = addr_local;
6815 which = US"local";
6816 }
d6c82d7b 6817 else if (addr_defer)
059ec3d9
PH
6818 {
6819 addr = addr_defer;
6820 which = US"deferred";
6821 }
6822 else
6823 {
6824 addr = addr_failed;
6825 which = US"failed";
6826 }
6827
d6c82d7b 6828 while (addr->parent) addr = addr->parent;
059ec3d9 6829
d6c82d7b 6830 if (addr->message)
059ec3d9
PH
6831 {
6832 colon = US": ";
6833 msg = addr->message;
6834 }
6835 else colon = msg = US"";
6836
6837 /* We don't need to log here for a forced failure as it will already
6838 have been logged. Defer will also have been logged, but as a defer, so we do
6839 need to do the failure logging. */
6840
6841 if (addr != addr_failed)
6842 log_write(0, LOG_MAIN, "** %s routing yielded a %s delivery",
6843 addr->address, which);
6844
6845 /* Always write an error to the caller */
6846
6847 fprintf(stderr, "routing %s yielded a %s delivery%s%s\n", addr->address,
6848 which, colon, msg);
6849
6850 final_yield = DELIVER_MUA_FAILED;
6851 addr_failed = addr_defer = NULL; /* So that we remove the message */
6852 goto DELIVERY_TIDYUP;
6853 }
6854
6855
6856/* If this is a run to continue deliveries to an external channel that is
6857already set up, defer any local deliveries. */
6858
d6c82d7b 6859if (continue_transport)
059ec3d9 6860 {
d6c82d7b 6861 if (addr_defer)
059ec3d9
PH
6862 {
6863 address_item *addr = addr_defer;
d6c82d7b 6864 while (addr->next) addr = addr->next;
059ec3d9
PH
6865 addr->next = addr_local;
6866 }
d6c82d7b
JH
6867 else
6868 addr_defer = addr_local;
059ec3d9
PH
6869 addr_local = NULL;
6870 }
6871
6872
6873/* Because address rewriting can happen in the routers, we should not really do
6874ANY deliveries until all addresses have been routed, so that all recipients of
6875the message get the same headers. However, this is in practice not always
6876possible, since sometimes remote addresses give DNS timeouts for days on end.
6877The pragmatic approach is to deliver what we can now, saving any rewritten
6878headers so that at least the next lot of recipients benefit from the rewriting
6879that has already been done.
6880
6881If any headers have been rewritten during routing, update the spool file to
6882remember them for all subsequent deliveries. This can be delayed till later if
6883there is only address to be delivered - if it succeeds the spool write need not
6884happen. */
6885
d6c82d7b 6886if ( header_rewritten
92b0827a
JH
6887 && ( addr_local && (addr_local->next || addr_remote)
6888 || addr_remote && addr_remote->next
d6c82d7b 6889 ) )
059ec3d9
PH
6890 {
6891 /* Panic-dies on error */
6892 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
6893 header_rewritten = FALSE;
6894 }
6895
6896
92b0827a
JH
6897/* If there are any deliveries to be and we do not already have the journal
6898file, create it. This is used to record successful deliveries as soon as
6899possible after each delivery is known to be complete. A file opened with
6900O_APPEND is used so that several processes can run simultaneously.
059ec3d9
PH
6901
6902The journal is just insurance against crashes. When the spool file is
6903ultimately updated at the end of processing, the journal is deleted. If a
6904journal is found to exist at the start of delivery, the addresses listed
6905therein are added to the non-recipients. */
6906
d6c82d7b 6907if (addr_local || addr_remote)
059ec3d9 6908 {
92b0827a 6909 if (journal_fd < 0)
059ec3d9 6910 {
92b0827a
JH
6911 uschar * fname = spool_fname(US"input", message_subdir, id, US"-J");
6912
6913 if ((journal_fd = Uopen(fname,
6914#ifdef O_CLOEXEC
6915 O_CLOEXEC |
6916#endif
6917 O_WRONLY|O_APPEND|O_CREAT|O_EXCL, SPOOL_MODE)) < 0)
6918 {
6919 log_write(0, LOG_MAIN|LOG_PANIC, "Couldn't open journal file %s: %s",
6920 fname, strerror(errno));
6921 return DELIVER_NOT_ATTEMPTED;
6922 }
059ec3d9 6923
92b0827a
JH
6924 /* Set the close-on-exec flag, make the file owned by Exim, and ensure
6925 that the mode is correct - the group setting doesn't always seem to get
6926 set automatically. */
059ec3d9 6927
92b0827a
JH
6928 if( fchown(journal_fd, exim_uid, exim_gid)
6929 || fchmod(journal_fd, SPOOL_MODE)
6930#ifndef O_CLOEXEC
6931 || fcntl(journal_fd, F_SETFD, fcntl(journal_fd, F_GETFD) | FD_CLOEXEC)
6932#endif
6933 )
6934 {
6935 int ret = Uunlink(fname);
6936 log_write(0, LOG_MAIN|LOG_PANIC, "Couldn't set perms on journal file %s: %s",
6937 fname, strerror(errno));
6938 if(ret && errno != ENOENT)
6939 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s",
6940 fname, strerror(errno));
6941 return DELIVER_NOT_ATTEMPTED;
6942 }
1ac6b2e7 6943 }
059ec3d9 6944 }
92b0827a
JH
6945else if (journal_fd >= 0)
6946 {
6947 close(journal_fd);
6948 journal_fd = -1;
6949 }
059ec3d9
PH
6950
6951
1ac6b2e7 6952
059ec3d9
PH
6953/* Now we can get down to the business of actually doing deliveries. Local
6954deliveries are done first, then remote ones. If ever the problems of how to
6955handle fallback transports are figured out, this section can be put into a loop
6956for handling fallbacks, though the uid switching will have to be revised. */
6957
f1513293
PH
6958/* Precompile a regex that is used to recognize a parameter in response
6959to an LHLO command, if is isn't already compiled. This may be used on both
6960local and remote LMTP deliveries. */
6961
d6c82d7b
JH
6962if (!regex_IGNOREQUOTA)
6963 regex_IGNOREQUOTA =
6964 regex_must_compile(US"\\n250[\\s\\-]IGNOREQUOTA(\\s|\\n|$)", FALSE, TRUE);
f1513293
PH
6965
6966/* Handle local deliveries */
6967
d6c82d7b 6968if (addr_local)
059ec3d9
PH
6969 {
6970 DEBUG(D_deliver|D_transport)
6971 debug_printf(">>>>>>>>>>>>>>>> Local deliveries >>>>>>>>>>>>>>>>\n");
6972 do_local_deliveries();
6973 disable_logging = FALSE;
6974 }
6975
6976/* If queue_run_local is set, we do not want to attempt any remote deliveries,
6977so just queue them all. */
6978
6979if (queue_run_local)
d6c82d7b 6980 while (addr_remote)
059ec3d9
PH
6981 {
6982 address_item *addr = addr_remote;
6983 addr_remote = addr->next;
6984 addr->next = NULL;
6985 addr->basic_errno = ERRNO_LOCAL_ONLY;
6986 addr->message = US"remote deliveries suppressed";
6987 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_TRANSPORT, 0);
6988 }
059ec3d9
PH
6989
6990/* Handle remote deliveries */
6991
d6c82d7b 6992if (addr_remote)
059ec3d9
PH
6993 {
6994 DEBUG(D_deliver|D_transport)
6995 debug_printf(">>>>>>>>>>>>>>>> Remote deliveries >>>>>>>>>>>>>>>>\n");
6996
6997 /* Precompile some regex that are used to recognize parameters in response
6998 to an EHLO command, if they aren't already compiled. */
6999
476be7e2 7000 deliver_init();
6c1c3d1d 7001
059ec3d9
PH
7002 /* Now sort the addresses if required, and do the deliveries. The yield of
7003 do_remote_deliveries is FALSE when mua_wrapper is set and all addresses
7004 cannot be delivered in one transaction. */
7005
d6c82d7b 7006 if (remote_sort_domains) sort_remote_deliveries();
059ec3d9
PH
7007 if (!do_remote_deliveries(FALSE))
7008 {
7009 log_write(0, LOG_MAIN, "** mua_wrapper is set but recipients cannot all "
7010 "be delivered in one transaction");
7011 fprintf(stderr, "delivery to smarthost failed (configuration problem)\n");
7012
7013 final_yield = DELIVER_MUA_FAILED;
7014 addr_failed = addr_defer = NULL; /* So that we remove the message */
7015 goto DELIVERY_TIDYUP;
7016 }
7017
7018 /* See if any of the addresses that failed got put on the queue for delivery
7019 to their fallback hosts. We do it this way because often the same fallback
7020 host is used for many domains, so all can be sent in a single transaction
7021 (if appropriately configured). */
7022
d6c82d7b 7023 if (addr_fallback && !mua_wrapper)
059ec3d9
PH
7024 {
7025 DEBUG(D_deliver) debug_printf("Delivering to fallback hosts\n");
7026 addr_remote = addr_fallback;
7027 addr_fallback = NULL;
d6c82d7b 7028 if (remote_sort_domains) sort_remote_deliveries();
059ec3d9
PH
7029 do_remote_deliveries(TRUE);
7030 }
7031 disable_logging = FALSE;
7032 }
7033
7034
7035/* All deliveries are now complete. Ignore SIGTERM during this tidying up
7036phase, to minimize cases of half-done things. */
7037
7038DEBUG(D_deliver)
7039 debug_printf(">>>>>>>>>>>>>>>> deliveries are done >>>>>>>>>>>>>>>>\n");
7040
7041/* Root privilege is no longer needed */
7042
7043exim_setugid(exim_uid, exim_gid, FALSE, US"post-delivery tidying");
7044
7045set_process_info("tidying up after delivering %s", message_id);
7046signal(SIGTERM, SIG_IGN);
7047
7048/* When we are acting as an MUA wrapper, the smtp transport will either have
47c7a64a
PH
7049succeeded for all addresses, or failed them all in normal cases. However, there
7050are some setup situations (e.g. when a named port does not exist) that cause an
7051immediate exit with deferral of all addresses. Convert those into failures. We
7052do not ever want to retry, nor do we want to send a bounce message. */
059ec3d9
PH
7053
7054if (mua_wrapper)
7055 {
d6c82d7b 7056 if (addr_defer)
47c7a64a
PH
7057 {
7058 address_item *addr, *nextaddr;
d6c82d7b 7059 for (addr = addr_defer; addr; addr = nextaddr)
47c7a64a
PH
7060 {
7061 log_write(0, LOG_MAIN, "** %s mua_wrapper forced failure for deferred "
7062 "delivery", addr->address);
7063 nextaddr = addr->next;
7064 addr->next = addr_failed;
7065 addr_failed = addr;
7066 }
7067 addr_defer = NULL;
7068 }
7069
7070 /* Now all should either have succeeded or failed. */
7071
d6c82d7b
JH
7072 if (!addr_failed)
7073 final_yield = DELIVER_MUA_SUCCEEDED;
7074 else
059ec3d9 7075 {
c562fd30 7076 host_item * host;
d6c82d7b
JH
7077 uschar *s = addr_failed->user_message;
7078
7079 if (!s) s = addr_failed->message;
059ec3d9
PH
7080
7081 fprintf(stderr, "Delivery failed: ");
7082 if (addr_failed->basic_errno > 0)
7083 {
7084 fprintf(stderr, "%s", strerror(addr_failed->basic_errno));
d6c82d7b 7085 if (s) fprintf(stderr, ": ");
059ec3d9 7086 }
c562fd30
JH
7087 if ((host = addr_failed->host_used))
7088 fprintf(stderr, "H=%s [%s]: ", host->name, host->address);
d6c82d7b
JH
7089 if (s)
7090 fprintf(stderr, "%s", CS s);
7091 else if (addr_failed->basic_errno <= 0)
7092 fprintf(stderr, "unknown error");
059ec3d9
PH
7093 fprintf(stderr, "\n");
7094
7095 final_yield = DELIVER_MUA_FAILED;
7096 addr_failed = NULL;
7097 }
7098 }
7099
7100/* In a normal configuration, we now update the retry database. This is done in
7101one fell swoop at the end in order not to keep opening and closing (and
7102locking) the database. The code for handling retries is hived off into a
7103separate module for convenience. We pass it the addresses of the various
7104chains, because deferred addresses can get moved onto the failed chain if the
7105retry cutoff time has expired for all alternative destinations. Bypass the
7106updating of the database if the -N flag is set, which is a debugging thing that
7107prevents actual delivery. */
7108
d6c82d7b
JH
7109else if (!dont_deliver)
7110 retry_update(&addr_defer, &addr_failed, &addr_succeed);
059ec3d9 7111
f40d5be3 7112/* Send DSN for successful messages if requested */
6c1c3d1d
WB
7113addr_senddsn = NULL;
7114
f40d5be3 7115for (addr_dsntmp = addr_succeed; addr_dsntmp; addr_dsntmp = addr_dsntmp->next)
6c1c3d1d 7116 {
6c1c3d1d 7117 /* af_ignore_error not honored here. it's not an error */
f40d5be3 7118 DEBUG(D_deliver) debug_printf("DSN: processing router : %s\n"
9671784a
JH
7119 "DSN: processing successful delivery address: %s\n"
7120 "DSN: Sender_address: %s\n"
7121 "DSN: orcpt: %s flags: %d\n"
7122 "DSN: envid: %s ret: %d\n"
7123 "DSN: Final recipient: %s\n"
7124 "DSN: Remote SMTP server supports DSN: %d\n",
7125 addr_dsntmp->router->name,
7126 addr_dsntmp->address,
7127 sender_address,
7128 addr_dsntmp->dsn_orcpt, addr_dsntmp->dsn_flags,
7129 dsn_envid, dsn_ret,
7130 addr_dsntmp->address,
7131 addr_dsntmp->dsn_aware
7132 );
6c1c3d1d
WB
7133
7134 /* send report if next hop not DSN aware or a router flagged "last DSN hop"
7135 and a report was requested */
9671784a
JH
7136 if ( ( addr_dsntmp->dsn_aware != dsn_support_yes
7137 || addr_dsntmp->dsn_flags & rf_dsnlasthop
7138 )
7139 && addr_dsntmp->dsn_flags & rf_dsnflags
7140 && addr_dsntmp->dsn_flags & rf_notify_success
7141 )
6c1c3d1d
WB
7142 {
7143 /* copy and relink address_item and send report with all of them at once later */
7144 address_item *addr_next;
7145 addr_next = addr_senddsn;
7146 addr_senddsn = store_get(sizeof(address_item));
7147 memcpy(addr_senddsn, addr_dsntmp, sizeof(address_item));
7148 addr_senddsn->next = addr_next;
7149 }
7150 else
94431adb 7151 DEBUG(D_deliver) debug_printf("DSN: not sending DSN success message\n");
6c1c3d1d
WB
7152 }
7153
9671784a 7154if (addr_senddsn)
6c1c3d1d
WB
7155 {
7156 pid_t pid;
7157 int fd;
7158
94431adb 7159 /* create exim process to send message */
6c1c3d1d
WB
7160 pid = child_open_exim(&fd);
7161
7162 DEBUG(D_deliver) debug_printf("DSN: child_open_exim returns: %d\n", pid);
94431adb 7163
6c1c3d1d
WB
7164 if (pid < 0) /* Creation of child failed */
7165 {
7166 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Process %d (parent %d) failed to "
7167 "create child process to send failure message: %s", getpid(),
7168 getppid(), strerror(errno));
7169
1c5b1499 7170 DEBUG(D_deliver) debug_printf("DSN: child_open_exim failed\n");
94431adb 7171 }
6c1c3d1d
WB
7172 else /* Creation of child succeeded */
7173 {
7174 FILE *f = fdopen(fd, "wb");
7175 /* header only as required by RFC. only failure DSN needs to honor RET=FULL */
45500060 7176 uschar * bound;
6d5c916c 7177 transport_ctx tctx = {0};
94431adb 7178
1c5b1499
JH
7179 DEBUG(D_deliver)
7180 debug_printf("sending error message to: %s\n", sender_address);
94431adb 7181
6c1c3d1d 7182 /* build unique id for MIME boundary */
45500060
JH
7183 bound = string_sprintf(TIME_T_FMT "-eximdsn-%d", time(NULL), rand());
7184 DEBUG(D_deliver) debug_printf("DSN: MIME boundary: %s\n", bound);
94431adb 7185
c007c974
JH
7186 if (errors_reply_to)
7187 fprintf(f, "Reply-To: %s\n", errors_reply_to);
94431adb 7188
c007c974
JH
7189 fprintf(f, "Auto-Submitted: auto-generated\n"
7190 "From: Mail Delivery System <Mailer-Daemon@%s>\n"
7191 "To: %s\n"
7192 "Subject: Delivery Status Notification\n"
7193 "Content-Type: multipart/report; report-type=delivery-status; boundary=%s\n"
7194 "MIME-Version: 1.0\n\n"
7195
7196 "--%s\n"
7197 "Content-type: text/plain; charset=us-ascii\n\n"
94431adb 7198
c007c974 7199 "This message was created automatically by mail delivery software.\n"
8864c2c4 7200 " ----- The following addresses had successful delivery notifications -----\n",
45500060 7201 qualify_domain_sender, sender_address, bound, bound);
6c1c3d1d 7202
1c5b1499
JH
7203 for (addr_dsntmp = addr_senddsn; addr_dsntmp;
7204 addr_dsntmp = addr_dsntmp->next)
c007c974
JH
7205 fprintf(f, "<%s> (relayed %s)\n\n",
7206 addr_dsntmp->address,
7207 (addr_dsntmp->dsn_flags & rf_dsnlasthop) == 1
7208 ? "via non DSN router"
7209 : addr_dsntmp->dsn_aware == dsn_support_no
7210 ? "to non-DSN-aware mailer"
7211 : "via non \"Remote SMTP\" router"
7212 );
1c5b1499 7213
c007c974
JH
7214 fprintf(f, "--%s\n"
7215 "Content-type: message/delivery-status\n\n"
7216 "Reporting-MTA: dns; %s\n",
45500060 7217 bound, smtp_active_hostname);
c007c974 7218
1c5b1499
JH
7219 if (dsn_envid)
7220 { /* must be decoded from xtext: see RFC 3461:6.3a */
6c1c3d1d
WB
7221 uschar *xdec_envid;
7222 if (auth_xtextdecode(dsn_envid, &xdec_envid) > 0)
c007c974 7223 fprintf(f, "Original-Envelope-ID: %s\n", dsn_envid);
6c1c3d1d 7224 else
968178ac 7225 fprintf(f, "X-Original-Envelope-ID: error decoding xtext formatted ENVID\n");
6c1c3d1d 7226 }
c007c974 7227 fputc('\n', f);
6c1c3d1d 7228
c007c974
JH
7229 for (addr_dsntmp = addr_senddsn;
7230 addr_dsntmp;
7231 addr_dsntmp = addr_dsntmp->next)
6c1c3d1d 7232 {
c007c974 7233 if (addr_dsntmp->dsn_orcpt)
6c1c3d1d 7234 fprintf(f,"Original-Recipient: %s\n", addr_dsntmp->dsn_orcpt);
c007c974
JH
7235
7236 fprintf(f, "Action: delivered\n"
7237 "Final-Recipient: rfc822;%s\n"
7238 "Status: 2.0.0\n",
7239 addr_dsntmp->address);
7240
7241 if (addr_dsntmp->host_used && addr_dsntmp->host_used->name)
1c5b1499 7242 fprintf(f, "Remote-MTA: dns; %s\nDiagnostic-Code: smtp; 250 Ok\n\n",
c007c974 7243 addr_dsntmp->host_used->name);
6c1c3d1d 7244 else
1c5b1499 7245 fprintf(f, "Diagnostic-Code: X-Exim; relayed via non %s router\n\n",
c007c974 7246 (addr_dsntmp->dsn_flags & rf_dsnlasthop) == 1 ? "DSN" : "SMTP");
6c1c3d1d
WB
7247 }
7248
45500060 7249 fprintf(f, "--%s\nContent-type: text/rfc822-headers\n\n", bound);
94431adb 7250
6c1c3d1d
WB
7251 fflush(f);
7252 transport_filter_argv = NULL; /* Just in case */
7253 return_path = sender_address; /* In case not previously set */
94431adb 7254
6c1c3d1d 7255 /* Write the original email out */
6b46ecc6 7256
6b46ecc6
JH
7257 tctx.options = topt_add_return_path | topt_no_body;
7258 transport_write_message(fileno(f), &tctx, 0);
6c1c3d1d
WB
7259 fflush(f);
7260
21bc4865 7261 fprintf(f,"\n--%s--\n", bound);
6c1c3d1d
WB
7262
7263 fflush(f);
7264 fclose(f);
7265 rc = child_close(pid, 0); /* Waits for child to close, no timeout */
7266 }
7267 }
6c1c3d1d 7268
059ec3d9
PH
7269/* If any addresses failed, we must send a message to somebody, unless
7270af_ignore_error is set, in which case no action is taken. It is possible for
7271several messages to get sent if there are addresses with different
7272requirements. */
7273
d6c82d7b 7274while (addr_failed)
059ec3d9
PH
7275 {
7276 pid_t pid;
7277 int fd;
7278 uschar *logtod = tod_stamp(tod_log);
7279 address_item *addr;
7280 address_item *handled_addr = NULL;
7281 address_item **paddr;
7282 address_item *msgchain = NULL;
7283 address_item **pmsgchain = &msgchain;
7284
7285 /* There are weird cases when logging is disabled in the transport. However,
7286 there may not be a transport (address failed by a router). */
7287
7288 disable_logging = FALSE;
d6c82d7b 7289 if (addr_failed->transport)
059ec3d9
PH
7290 disable_logging = addr_failed->transport->disable_logging;
7291
7292 DEBUG(D_deliver)
7293 debug_printf("processing failed address %s\n", addr_failed->address);
7294
7295 /* There are only two ways an address in a bounce message can get here:
7296
7297 (1) When delivery was initially deferred, but has now timed out (in the call
7298 to retry_update() above). We can detect this by testing for
7299 af_retry_timedout. If the address does not have its own errors address,
7300 we arrange to ignore the error.
7301
7302 (2) If delivery failures for bounce messages are being ignored. We can detect
7303 this by testing for af_ignore_error. This will also be set if a bounce
7304 message has been autothawed and the ignore_bounce_errors_after time has
7305 passed. It might also be set if a router was explicitly configured to
7306 ignore errors (errors_to = "").
7307
7308 If neither of these cases obtains, something has gone wrong. Log the
7309 incident, but then ignore the error. */
7310
d6c82d7b 7311 if (sender_address[0] == 0 && !addr_failed->prop.errors_address)
059ec3d9 7312 {
9671784a
JH
7313 if ( !testflag(addr_failed, af_retry_timedout)
7314 && !testflag(addr_failed, af_ignore_error))
059ec3d9
PH
7315 {
7316 log_write(0, LOG_MAIN|LOG_PANIC, "internal error: bounce message "
7317 "failure is neither frozen nor ignored (it's been ignored)");
7318 }
7319 setflag(addr_failed, af_ignore_error);
7320 }
7321
7322 /* If the first address on the list has af_ignore_error set, just remove
7323 it from the list, throw away any saved message file, log it, and
7324 mark the recipient done. */
7325
50dc7409 7326 if ( testflag(addr_failed, af_ignore_error)
9671784a 7327 || ( addr_failed->dsn_flags & rf_dsnflags
d6c82d7b
JH
7328 && (addr_failed->dsn_flags & rf_notify_failure) != rf_notify_failure
7329 ) )
1c5b1499 7330 {
059ec3d9
PH
7331 addr = addr_failed;
7332 addr_failed = addr->next;
d6c82d7b 7333 if (addr->return_filename) Uunlink(addr->return_filename);
059ec3d9
PH
7334
7335 log_write(0, LOG_MAIN, "%s%s%s%s: error ignored",
7336 addr->address,
1c5b1499
JH
7337 !addr->parent ? US"" : US" <",
7338 !addr->parent ? US"" : addr->parent->address,
7339 !addr->parent ? US"" : US">");
059ec3d9
PH
7340
7341 address_done(addr, logtod);
7342 child_done(addr, logtod);
7343 /* Panic-dies on error */
7344 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
7345 }
7346
7347 /* Otherwise, handle the sending of a message. Find the error address for
7348 the first address, then send a message that includes all failed addresses
7349 that have the same error address. Note the bounce_recipient is a global so
4c04137d 7350 that it can be accessed by $bounce_recipient while creating a customized
059ec3d9
PH
7351 error message. */
7352
7353 else
7354 {
d6c82d7b
JH
7355 if (!(bounce_recipient = addr_failed->prop.errors_address))
7356 bounce_recipient = sender_address;
059ec3d9
PH
7357
7358 /* Make a subprocess to send a message */
7359
1c5b1499 7360 if ((pid = child_open_exim(&fd)) < 0)
059ec3d9
PH
7361 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Process %d (parent %d) failed to "
7362 "create child process to send failure message: %s", getpid(),
7363 getppid(), strerror(errno));
7364
7365 /* Creation of child succeeded */
7366
7367 else
7368 {
7369 int ch, rc;
7370 int filecount = 0;
7371 int rcount = 0;
7372 uschar *bcc, *emf_text;
7373 FILE *f = fdopen(fd, "wb");
7374 FILE *emf = NULL;
7375 BOOL to_sender = strcmpic(sender_address, bounce_recipient) == 0;
7376 int max = (bounce_return_size_limit/DELIVER_IN_BUFFER_SIZE + 1) *
7377 DELIVER_IN_BUFFER_SIZE;
45500060 7378 uschar * bound;
0f9d3aea
JH
7379 uschar *dsnlimitmsg;
7380 uschar *dsnnotifyhdr;
7381 int topt;
059ec3d9
PH
7382
7383 DEBUG(D_deliver)
7384 debug_printf("sending error message to: %s\n", bounce_recipient);
7385
7386 /* Scan the addresses for all that have the same errors address, removing
7387 them from the addr_failed chain, and putting them on msgchain. */
7388
7389 paddr = &addr_failed;
d6c82d7b 7390 for (addr = addr_failed; addr; addr = *paddr)
d43cbe25
JH
7391 if (Ustrcmp(bounce_recipient, addr->prop.errors_address
7392 ? addr->prop.errors_address : sender_address) == 0)
1c5b1499 7393 { /* The same - dechain */
059ec3d9
PH
7394 *paddr = addr->next;
7395 *pmsgchain = addr;
7396 addr->next = NULL;
7397 pmsgchain = &(addr->next);
7398 }
1c5b1499
JH
7399 else
7400 paddr = &addr->next; /* Not the same; skip */
059ec3d9
PH
7401
7402 /* Include X-Failed-Recipients: for automatic interpretation, but do
7403 not let any one header line get too long. We do this by starting a
7404 new header every 50 recipients. Omit any addresses for which the
7405 "hide_child" flag is set. */
7406
d6c82d7b 7407 for (addr = msgchain; addr; addr = addr->next)
059ec3d9
PH
7408 {
7409 if (testflag(addr, af_hide_child)) continue;
7410 if (rcount >= 50)
7411 {
7412 fprintf(f, "\n");
7413 rcount = 0;
7414 }
7415 fprintf(f, "%s%s",
d6c82d7b
JH
7416 rcount++ == 0
7417 ? "X-Failed-Recipients: "
7418 : ",\n ",
7419 testflag(addr, af_pfr) && addr->parent
7420 ? string_printing(addr->parent->address)
7421 : string_printing(addr->address));
059ec3d9
PH
7422 }
7423 if (rcount > 0) fprintf(f, "\n");
7424
7425 /* Output the standard headers */
7426
1c5b1499 7427 if (errors_reply_to)
059ec3d9 7428 fprintf(f, "Reply-To: %s\n", errors_reply_to);
456682f5 7429 fprintf(f, "Auto-Submitted: auto-replied\n");
0e22dfd1 7430 moan_write_from(f);
059ec3d9
PH
7431 fprintf(f, "To: %s\n", bounce_recipient);
7432
6c1c3d1d 7433 /* generate boundary string and output MIME-Headers */
45500060 7434 bound = string_sprintf(TIME_T_FMT "-eximdsn-%d", time(NULL), rand());
c007c974
JH
7435
7436 fprintf(f, "Content-Type: multipart/report;"
7437 " report-type=delivery-status; boundary=%s\n"
7438 "MIME-Version: 1.0\n",
45500060 7439 bound);
6c1c3d1d 7440
059ec3d9
PH
7441 /* Open a template file if one is provided. Log failure to open, but
7442 carry on - default texts will be used. */
7443
c007c974
JH
7444 if (bounce_message_file)
7445 if (!(emf = Ufopen(bounce_message_file, "rb")))
059ec3d9
PH
7446 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to open %s for error "
7447 "message texts: %s", bounce_message_file, strerror(errno));
059ec3d9
PH
7448
7449 /* Quietly copy to configured additional addresses if required. */
7450
c007c974
JH
7451 if ((bcc = moan_check_errorcopy(bounce_recipient)))
7452 fprintf(f, "Bcc: %s\n", bcc);
059ec3d9
PH
7453
7454 /* The texts for the message can be read from a template file; if there
7455 isn't one, or if it is too short, built-in texts are used. The first
7456 emf text is a Subject: and any other headers. */
7457
c007c974
JH
7458 if ((emf_text = next_emf(emf, US"header")))
7459 fprintf(f, "%s\n", emf_text);
7460 else
059ec3d9
PH
7461 fprintf(f, "Subject: Mail delivery failed%s\n\n",
7462 to_sender? ": returning message to sender" : "");
059ec3d9 7463
6c1c3d1d 7464 /* output human readable part as text/plain section */
c007c974
JH
7465 fprintf(f, "--%s\n"
7466 "Content-type: text/plain; charset=us-ascii\n\n",
45500060 7467 bound);
6c1c3d1d 7468
c007c974
JH
7469 if ((emf_text = next_emf(emf, US"intro")))
7470 fprintf(f, "%s", CS emf_text);
7471 else
059ec3d9
PH
7472 {
7473 fprintf(f,
7474/* This message has been reworded several times. It seems to be confusing to
7475somebody, however it is worded. I have retreated to the original, simple
7476wording. */
7477"This message was created automatically by mail delivery software.\n");
c007c974
JH
7478
7479 if (bounce_message_text)
7480 fprintf(f, "%s", CS bounce_message_text);
059ec3d9 7481 if (to_sender)
059ec3d9
PH
7482 fprintf(f,
7483"\nA message that you sent could not be delivered to one or more of its\n"
7484"recipients. This is a permanent error. The following address(es) failed:\n");
059ec3d9 7485 else
059ec3d9
PH
7486 fprintf(f,
7487"\nA message sent by\n\n <%s>\n\n"
7488"could not be delivered to one or more of its recipients. The following\n"
7489"address(es) failed:\n", sender_address);
059ec3d9 7490 }
c007c974 7491 fputc('\n', f);
059ec3d9
PH
7492
7493 /* Process the addresses, leaving them on the msgchain if they have a
7494 file name for a return message. (There has already been a check in
447d236c
PH
7495 post_process_one() for the existence of data in the message file.) A TRUE
7496 return from print_address_information() means that the address is not
7497 hidden. */
059ec3d9
PH
7498
7499 paddr = &msgchain;
d6c82d7b 7500 for (addr = msgchain; addr; addr = *paddr)
059ec3d9
PH
7501 {
7502 if (print_address_information(addr, f, US" ", US"\n ", US""))
447d236c 7503 print_address_error(addr, f, US"");
059ec3d9
PH
7504
7505 /* End the final line for the address */
7506
7507 fputc('\n', f);
7508
7509 /* Leave on msgchain if there's a return file. */
7510
7511 if (addr->return_file >= 0)
7512 {
7513 paddr = &(addr->next);
7514 filecount++;
7515 }
7516
7517 /* Else save so that we can tick off the recipient when the
7518 message is sent. */
7519
7520 else
7521 {
7522 *paddr = addr->next;
7523 addr->next = handled_addr;
7524 handled_addr = addr;
7525 }
7526 }
7527
c007c974 7528 fputc('\n', f);
059ec3d9
PH
7529
7530 /* Get the next text, whether we need it or not, so as to be
7531 positioned for the one after. */
7532
7533 emf_text = next_emf(emf, US"generated text");
7534
7535 /* If there were any file messages passed by the local transports,
7536 include them in the message. Then put the address on the handled chain.
7537 In the case of a batch of addresses that were all sent to the same
7538 transport, the return_file field in all of them will contain the same
7539 fd, and the return_filename field in the *last* one will be set (to the
7540 name of the file). */
7541
c007c974 7542 if (msgchain)
059ec3d9
PH
7543 {
7544 address_item *nextaddr;
7545
c007c974
JH
7546 if (emf_text)
7547 fprintf(f, "%s", CS emf_text);
7548 else
059ec3d9
PH
7549 fprintf(f,
7550 "The following text was generated during the delivery "
7551 "attempt%s:\n", (filecount > 1)? "s" : "");
7552
d6c82d7b 7553 for (addr = msgchain; addr; addr = nextaddr)
059ec3d9
PH
7554 {
7555 FILE *fm;
7556 address_item *topaddr = addr;
7557
7558 /* List all the addresses that relate to this file */
7559
c007c974
JH
7560 fputc('\n', f);
7561 while(addr) /* Insurance */
059ec3d9
PH
7562 {
7563 print_address_information(addr, f, US"------ ", US"\n ",
7564 US" ------\n");
c007c974 7565 if (addr->return_filename) break;
059ec3d9
PH
7566 addr = addr->next;
7567 }
c007c974 7568 fputc('\n', f);
059ec3d9
PH
7569
7570 /* Now copy the file */
7571
d6c82d7b 7572 if (!(fm = Ufopen(addr->return_filename, "rb")))
059ec3d9
PH
7573 fprintf(f, " +++ Exim error... failed to open text file: %s\n",
7574 strerror(errno));
7575 else
7576 {
7577 while ((ch = fgetc(fm)) != EOF) fputc(ch, f);
f1e894f3 7578 (void)fclose(fm);
059ec3d9
PH
7579 }
7580 Uunlink(addr->return_filename);
7581
7582 /* Can now add to handled chain, first fishing off the next
7583 address on the msgchain. */
7584
7585 nextaddr = addr->next;
7586 addr->next = handled_addr;
7587 handled_addr = topaddr;
7588 }
c007c974 7589 fputc('\n', f);
059ec3d9
PH
7590 }
7591
6c1c3d1d 7592 /* output machine readable part */
8c5d388a 7593#ifdef SUPPORT_I18N
9671784a
JH
7594 if (message_smtputf8)
7595 fprintf(f, "--%s\n"
7596 "Content-type: message/global-delivery-status\n\n"
7597 "Reporting-MTA: dns; %s\n",
7598 bound, smtp_active_hostname);
7599 else
7600#endif
7601 fprintf(f, "--%s\n"
7602 "Content-type: message/delivery-status\n\n"
7603 "Reporting-MTA: dns; %s\n",
7604 bound, smtp_active_hostname);
c007c974
JH
7605
7606 if (dsn_envid)
7607 {
6c1c3d1d
WB
7608 /* must be decoded from xtext: see RFC 3461:6.3a */
7609 uschar *xdec_envid;
7610 if (auth_xtextdecode(dsn_envid, &xdec_envid) > 0)
c007c974 7611 fprintf(f, "Original-Envelope-ID: %s\n", dsn_envid);
6c1c3d1d 7612 else
968178ac 7613 fprintf(f, "X-Original-Envelope-ID: error decoding xtext formatted ENVID\n");
6c1c3d1d 7614 }
c007c974 7615 fputc('\n', f);
94431adb 7616
c007c974 7617 for (addr = handled_addr; addr; addr = addr->next)
6c1c3d1d 7618 {
895fbaf2 7619 host_item * hu;
c007c974 7620 fprintf(f, "Action: failed\n"
8864c2c4
JH
7621 "Final-Recipient: rfc822;%s\n"
7622 "Status: 5.0.0\n",
7623 addr->address);
895fbaf2
JH
7624 if ((hu = addr->host_used) && hu->name)
7625 {
7626 const uschar * s;
23f3dc67 7627 fprintf(f, "Remote-MTA: dns; %s\n", hu->name);
895fbaf2
JH
7628#ifdef EXPERIMENTAL_DSN_INFO
7629 if (hu->address)
7630 {
7631 uschar * p = hu->port == 25
7632 ? US"" : string_sprintf(":%d", hu->port);
7633 fprintf(f, "Remote-MTA: X-ip; [%s]%s\n", hu->address, p);
7634 }
7635 if ((s = addr->smtp_greeting) && *s)
7636 fprintf(f, "X-Remote-MTA-smtp-greeting: X-str; %s\n", s);
7637 if ((s = addr->helo_response) && *s)
7638 fprintf(f, "X-Remote-MTA-helo-response: X-str; %s\n", s);
7639 if ((s = addr->message) && *s)
7640 fprintf(f, "X-Exim-Diagnostic: X-str; %s\n", s);
7641#endif
7642 print_dsn_diagnostic_code(addr, f);
7643 }
1c5b1499 7644 fputc('\n', f);
6c1c3d1d 7645 }
6c1c3d1d 7646
059ec3d9
PH
7647 /* Now copy the message, trying to give an intelligible comment if
7648 it is too long for it all to be copied. The limit isn't strictly
7649 applied because of the buffering. There is, however, an option
7650 to suppress copying altogether. */
7651
7652 emf_text = next_emf(emf, US"copy");
7653
6c1c3d1d 7654 /* add message body
94431adb 7655 we ignore the intro text from template and add
6c1c3d1d 7656 the text for bounce_return_size_limit at the end.
94431adb 7657
6c1c3d1d
WB
7658 bounce_return_message is ignored
7659 in case RET= is defined we honor these values
7660 otherwise bounce_return_body is honored.
94431adb 7661
6c1c3d1d
WB
7662 bounce_return_size_limit is always honored.
7663 */
94431adb 7664
1c5b1499 7665 fprintf(f, "--%s\n", bound);
6c1c3d1d 7666
0f9d3aea
JH
7667 dsnlimitmsg = US"X-Exim-DSN-Information: Due to administrative limits only headers are returned";
7668 dsnnotifyhdr = NULL;
7669 topt = topt_add_return_path;
7670
6c1c3d1d
WB
7671 /* RET=HDRS? top priority */
7672 if (dsn_ret == dsn_ret_hdrs)
7673 topt |= topt_no_body;
7674 else
62b7cd08
JH
7675 {
7676 struct stat statbuf;
7677
6c1c3d1d
WB
7678 /* no full body return at all? */
7679 if (!bounce_return_body)
7680 {
7681 topt |= topt_no_body;
7682 /* add header if we overrule RET=FULL */
7683 if (dsn_ret == dsn_ret_full)
7684 dsnnotifyhdr = dsnlimitmsg;
7685 }
62b7cd08 7686 /* line length limited... return headers only if oversize */
6c1c3d1d 7687 /* size limited ... return headers only if limit reached */
62b7cd08
JH
7688 else if ( max_received_linelength > bounce_return_linesize_limit
7689 || ( bounce_return_size_limit > 0
7690 && fstat(deliver_datafile, &statbuf) == 0
7691 && statbuf.st_size > max
7692 ) )
7693 {
7694 topt |= topt_no_body;
7695 dsnnotifyhdr = dsnlimitmsg;
6c1c3d1d 7696 }
62b7cd08 7697 }
94431adb 7698
8c5d388a 7699#ifdef SUPPORT_I18N
9671784a
JH
7700 if (message_smtputf8)
7701 fputs(topt & topt_no_body ? "Content-type: message/global-headers\n\n"
7702 : "Content-type: message/global\n\n",
7703 f);
7704 else
7705#endif
7706 fputs(topt & topt_no_body ? "Content-type: text/rfc822-headers\n\n"
7707 : "Content-type: message/rfc822\n\n",
7708 f);
6c1c3d1d
WB
7709
7710 fflush(f);
7711 transport_filter_argv = NULL; /* Just in case */
7712 return_path = sender_address; /* In case not previously set */
6b46ecc6 7713 { /* Dummy transport for headers add */
6d5c916c
JH
7714 transport_ctx tctx = {0};
7715 transport_instance tb = {0};
6b46ecc6 7716
6d5c916c
JH
7717 tctx.tblock = &tb;
7718 tctx.options = topt;
7719 tb.add_headers = dsnnotifyhdr;
6b46ecc6 7720
6d5c916c 7721 transport_write_message(fileno(f), &tctx, 0);
6b46ecc6 7722 }
6c1c3d1d 7723 fflush(f);
94431adb 7724
6c1c3d1d 7725 /* we never add the final text. close the file */
c007c974 7726 if (emf)
6c1c3d1d 7727 (void)fclose(emf);
94431adb 7728
45500060 7729 fprintf(f, "\n--%s--\n", bound);
059ec3d9
PH
7730
7731 /* Close the file, which should send an EOF to the child process
7732 that is receiving the message. Wait for it to finish. */
7733
f1e894f3 7734 (void)fclose(f);
059ec3d9
PH
7735 rc = child_close(pid, 0); /* Waits for child to close, no timeout */
7736
7737 /* In the test harness, let the child do it's thing first. */
7738
7739 if (running_in_test_harness) millisleep(500);
7740
7741 /* If the process failed, there was some disaster in setting up the
7742 error message. Unless the message is very old, ensure that addr_defer
7743 is non-null, which will have the effect of leaving the message on the
7744 spool. The failed addresses will get tried again next time. However, we
7745 don't really want this to happen too often, so freeze the message unless
7746 there are some genuine deferred addresses to try. To do this we have
7747 to call spool_write_header() here, because with no genuine deferred
7748 addresses the normal code below doesn't get run. */
7749
7750 if (rc != 0)
7751 {
7752 uschar *s = US"";
d6c82d7b 7753 if (now - received_time < retry_maximum_timeout && !addr_defer)
059ec3d9
PH
7754 {
7755 addr_defer = (address_item *)(+1);
7756 deliver_freeze = TRUE;
7757 deliver_frozen_at = time(NULL);
7758 /* Panic-dies on error */
7759 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
7760 s = US" (frozen)";
7761 }
7762 deliver_msglog("Process failed (%d) when writing error message "
7763 "to %s%s", rc, bounce_recipient, s);
7764 log_write(0, LOG_MAIN, "Process failed (%d) when writing error message "
7765 "to %s%s", rc, bounce_recipient, s);
7766 }
7767
7768 /* The message succeeded. Ensure that the recipients that failed are
7769 now marked finished with on the spool and their parents updated. */
7770
7771 else
7772 {
d6c82d7b 7773 for (addr = handled_addr; addr; addr = addr->next)
059ec3d9
PH
7774 {
7775 address_done(addr, logtod);
7776 child_done(addr, logtod);
7777 }
7778 /* Panic-dies on error */
7779 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
7780 }
7781 }
7782 }
7783 }
7784
7785disable_logging = FALSE; /* In case left set */
7786
7787/* Come here from the mua_wrapper case if routing goes wrong */
7788
7789DELIVERY_TIDYUP:
7790
7791/* If there are now no deferred addresses, we are done. Preserve the
7792message log if so configured, and we are using them. Otherwise, sling it.
7793Then delete the message itself. */
7794
d6c82d7b 7795if (!addr_defer)
059ec3d9 7796 {
41313d92
JH
7797 uschar * fname;
7798
059ec3d9
PH
7799 if (message_logs)
7800 {
41313d92 7801 fname = spool_fname(US"msglog", message_subdir, id, US"");
059ec3d9
PH
7802 if (preserve_message_logs)
7803 {
7804 int rc;
41313d92
JH
7805 uschar * moname = spool_fname(US"msglog.OLD", US"", id, US"");
7806
7807 if ((rc = Urename(fname, moname)) < 0)
059ec3d9 7808 {
41313d92
JH
7809 (void)directory_make(spool_directory,
7810 spool_sname(US"msglog.OLD", US""),
7811 MSGLOG_DIRECTORY_MODE, TRUE);
7812 rc = Urename(fname, moname);
059ec3d9
PH
7813 }
7814 if (rc < 0)
7815 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to move %s to the "
41313d92 7816 "msglog.OLD directory", fname);
059ec3d9
PH
7817 }
7818 else
41313d92 7819 if (Uunlink(fname) < 0)
0761d44e 7820 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s",
41313d92 7821 fname, strerror(errno));
059ec3d9
PH
7822 }
7823
7824 /* Remove the two message files. */
8e669ac1 7825
41313d92
JH
7826 fname = spool_fname(US"input", message_subdir, id, US"-D");
7827 if (Uunlink(fname) < 0)
0ca0cf52 7828 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s",
41313d92
JH
7829 fname, strerror(errno));
7830 fname = spool_fname(US"input", message_subdir, id, US"-H");
7831 if (Uunlink(fname) < 0)
0ca0cf52 7832 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s",
41313d92 7833 fname, strerror(errno));
2ac0e484
PH
7834
7835 /* Log the end of this message, with queue time if requested. */
7836
6c6d6e48 7837 if (LOGGING(queue_time_overall))
8e669ac1 7838 log_write(0, LOG_MAIN, "Completed QT=%s",
19050083 7839 readconf_printtime( (int) ((long)time(NULL) - (long)received_time)) );
2ac0e484
PH
7840 else
7841 log_write(0, LOG_MAIN, "Completed");
0e8a9471
MH
7842
7843 /* Unset deliver_freeze so that we won't try to move the spool files further down */
7844 deliver_freeze = FALSE;
14a465c3 7845
0cbf2b82 7846#ifndef DISABLE_EVENT
774ef2d7 7847 (void) event_raise(event_action, US"msg:complete", NULL);
14a465c3 7848#endif
fa41615d 7849 }
059ec3d9
PH
7850
7851/* If there are deferred addresses, we are keeping this message because it is
7852not yet completed. Lose any temporary files that were catching output from
7853pipes for any of the deferred addresses, handle one-time aliases, and see if
7854the message has been on the queue for so long that it is time to send a warning
7855message to the sender, unless it is a mailer-daemon. If all deferred addresses
7856have the same domain, we can set deliver_domain for the expansion of
7857delay_warning_ condition - if any of them are pipes, files, or autoreplies, use
7858the parent's domain.
7859
7860If all the deferred addresses have an error number that indicates "retry time
7861not reached", skip sending the warning message, because it won't contain the
7862reason for the delay. It will get sent at the next real delivery attempt.
7863However, if at least one address has tried, we'd better include all of them in
7864the message.
7865
7866If we can't make a process to send the message, don't worry.
7867
7868For mailing list expansions we want to send the warning message to the
7869mailing list manager. We can't do a perfect job here, as some addresses may
7870have different errors addresses, but if we take the errors address from
7871each deferred address it will probably be right in most cases.
7872
7873If addr_defer == +1, it means there was a problem sending an error message
7874for failed addresses, and there were no "real" deferred addresses. The value
7875was set just to keep the message on the spool, so there is nothing to do here.
7876*/
7877
7878else if (addr_defer != (address_item *)(+1))
7879 {
7880 address_item *addr;
7881 uschar *recipients = US"";
7882 BOOL delivery_attempted = FALSE;
7883
d6c82d7b
JH
7884 deliver_domain = testflag(addr_defer, af_pfr)
7885 ? addr_defer->parent->domain : addr_defer->domain;
059ec3d9 7886
d6c82d7b 7887 for (addr = addr_defer; addr; addr = addr->next)
059ec3d9
PH
7888 {
7889 address_item *otaddr;
7890
7891 if (addr->basic_errno > ERRNO_RETRY_BASE) delivery_attempted = TRUE;
7892
d6c82d7b 7893 if (deliver_domain)
059ec3d9 7894 {
55414b25
JH
7895 const uschar *d = testflag(addr, af_pfr)
7896 ? addr->parent->domain : addr->domain;
059ec3d9
PH
7897
7898 /* The domain may be unset for an address that has never been routed
7899 because the system filter froze the message. */
7900
d6c82d7b
JH
7901 if (!d || Ustrcmp(d, deliver_domain) != 0)
7902 deliver_domain = NULL;
059ec3d9
PH
7903 }
7904
d6c82d7b 7905 if (addr->return_filename) Uunlink(addr->return_filename);
059ec3d9
PH
7906
7907 /* Handle the case of one-time aliases. If any address in the ancestry
7908 of this one is flagged, ensure it is in the recipients list, suitably
7909 flagged, and that its parent is marked delivered. */
7910
d6c82d7b
JH
7911 for (otaddr = addr; otaddr; otaddr = otaddr->parent)
7912 if (otaddr->onetime_parent) break;
059ec3d9 7913
d6c82d7b 7914 if (otaddr)
059ec3d9
PH
7915 {
7916 int i;
7917 int t = recipients_count;
7918
7919 for (i = 0; i < recipients_count; i++)
7920 {
7921 uschar *r = recipients_list[i].address;
7922 if (Ustrcmp(otaddr->onetime_parent, r) == 0) t = i;
7923 if (Ustrcmp(otaddr->address, r) == 0) break;
7924 }
7925
7926 /* Didn't find the address already in the list, and did find the
d1f9fb42
JH
7927 ultimate parent's address in the list, and they really are different
7928 (i.e. not from an identity-redirect). After adding the recipient,
059ec3d9
PH
7929 update the errors address in the recipients list. */
7930
d1f9fb42
JH
7931 if ( i >= recipients_count && t < recipients_count
7932 && Ustrcmp(otaddr->address, otaddr->parent->address) != 0)
059ec3d9
PH
7933 {
7934 DEBUG(D_deliver) debug_printf("one_time: adding %s in place of %s\n",
7935 otaddr->address, otaddr->parent->address);
7936 receive_add_recipient(otaddr->address, t);
d43cbe25 7937 recipients_list[recipients_count-1].errors_to = otaddr->prop.errors_address;
059ec3d9
PH
7938 tree_add_nonrecipient(otaddr->parent->address);
7939 update_spool = TRUE;
7940 }
7941 }
7942
7943 /* Except for error messages, ensure that either the errors address for
7944 this deferred address or, if there is none, the sender address, is on the
7945 list of recipients for a warning message. */
7946
d1f9fb42
JH
7947 if (sender_address[0])
7948 {
7949 uschar * s = addr->prop.errors_address;
7950 if (!s) s = sender_address;
7951 if (Ustrstr(recipients, s) == NULL)
7952 recipients = string_sprintf("%s%s%s", recipients,
7953 recipients[0] ? "," : "", s);
7954 }
059ec3d9
PH
7955 }
7956
7957 /* Send a warning message if the conditions are right. If the condition check
7958 fails because of a lookup defer, there is nothing we can do. The warning
7959 is not sent. Another attempt will be made at the next delivery attempt (if
7960 it also defers). */
7961
50dc7409
JH
7962 if ( !queue_2stage
7963 && delivery_attempted
7964 && ( ((addr_defer->dsn_flags & rf_dsnflags) == 0)
7965 || (addr_defer->dsn_flags & rf_notify_delay) == rf_notify_delay
7966 )
7967 && delay_warning[1] > 0
7968 && sender_address[0] != 0
d6c82d7b 7969 && ( !delay_warning_condition
50dc7409
JH
7970 || expand_check_condition(delay_warning_condition,
7971 US"delay_warning", US"option")
7972 )
7973 )
059ec3d9
PH
7974 {
7975 int count;
7976 int show_time;
7977 int queue_time = time(NULL) - received_time;
7978
7979 /* When running in the test harness, there's an option that allows us to
7980 fudge this time so as to get repeatability of the tests. Take the first
7981 time off the list. In queue runs, the list pointer gets updated in the
7982 calling process. */
7983
7984 if (running_in_test_harness && fudged_queue_times[0] != 0)
7985 {
7986 int qt = readconf_readtime(fudged_queue_times, '/', FALSE);
7987 if (qt >= 0)
7988 {
7989 DEBUG(D_deliver) debug_printf("fudged queue_times = %s\n",
7990 fudged_queue_times);
7991 queue_time = qt;
7992 }
7993 }
7994
7995 /* See how many warnings we should have sent by now */
7996
7997 for (count = 0; count < delay_warning[1]; count++)
7998 if (queue_time < delay_warning[count+2]) break;
7999
8000 show_time = delay_warning[count+1];
8001
8002 if (count >= delay_warning[1])
8003 {
8004 int extra;
8005 int last_gap = show_time;
8006 if (count > 1) last_gap -= delay_warning[count];
8007 extra = (queue_time - delay_warning[count+1])/last_gap;
8008 show_time += last_gap * extra;
8009 count += extra;
8010 }
8011
8012 DEBUG(D_deliver)
8013 {
8014 debug_printf("time on queue = %s\n", readconf_printtime(queue_time));
8015 debug_printf("warning counts: required %d done %d\n", count,
8016 warning_count);
8017 }
8018
8019 /* We have computed the number of warnings there should have been by now.
8020 If there haven't been enough, send one, and up the count to what it should
8021 have been. */
8022
8023 if (warning_count < count)
8024 {
8025 header_line *h;
8026 int fd;
8027 pid_t pid = child_open_exim(&fd);
8028
8029 if (pid > 0)
8030 {
8031 uschar *wmf_text;
8032 FILE *wmf = NULL;
8033 FILE *f = fdopen(fd, "wb");
45500060 8034 uschar * bound;
6d5c916c 8035 transport_ctx tctx = {0};
059ec3d9 8036
c007c974 8037 if (warn_message_file)
d6c82d7b 8038 if (!(wmf = Ufopen(warn_message_file, "rb")))
059ec3d9
PH
8039 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to open %s for warning "
8040 "message texts: %s", warn_message_file, strerror(errno));
059ec3d9
PH
8041
8042 warnmsg_recipients = recipients;
d6c82d7b
JH
8043 warnmsg_delay = queue_time < 120*60
8044 ? string_sprintf("%d minutes", show_time/60)
8045 : string_sprintf("%d hours", show_time/3600);
059ec3d9 8046
c007c974 8047 if (errors_reply_to)
059ec3d9 8048 fprintf(f, "Reply-To: %s\n", errors_reply_to);
456682f5 8049 fprintf(f, "Auto-Submitted: auto-replied\n");
0e22dfd1 8050 moan_write_from(f);
059ec3d9
PH
8051 fprintf(f, "To: %s\n", recipients);
8052
6c1c3d1d 8053 /* generated boundary string and output MIME-Headers */
45500060 8054 bound = string_sprintf(TIME_T_FMT "-eximdsn-%d", time(NULL), rand());
c007c974
JH
8055
8056 fprintf(f, "Content-Type: multipart/report;"
8057 " report-type=delivery-status; boundary=%s\n"
8058 "MIME-Version: 1.0\n",
45500060 8059 bound);
6c1c3d1d 8060
c007c974 8061 if ((wmf_text = next_emf(wmf, US"header")))
059ec3d9
PH
8062 fprintf(f, "%s\n", wmf_text);
8063 else
8064 fprintf(f, "Subject: Warning: message %s delayed %s\n\n",
8065 message_id, warnmsg_delay);
8066
6c1c3d1d 8067 /* output human readable part as text/plain section */
c007c974
JH
8068 fprintf(f, "--%s\n"
8069 "Content-type: text/plain; charset=us-ascii\n\n",
45500060 8070 bound);
6c1c3d1d 8071
c007c974
JH
8072 if ((wmf_text = next_emf(wmf, US"intro")))
8073 fprintf(f, "%s", CS wmf_text);
8074 else
059ec3d9
PH
8075 {
8076 fprintf(f,
8077"This message was created automatically by mail delivery software.\n");
8078
8079 if (Ustrcmp(recipients, sender_address) == 0)
8080 fprintf(f,
8081"A message that you sent has not yet been delivered to one or more of its\n"
8082"recipients after more than ");
8083
c007c974
JH
8084 else
8085 fprintf(f,
059ec3d9
PH
8086"A message sent by\n\n <%s>\n\n"
8087"has not yet been delivered to one or more of its recipients after more than \n",
c007c974 8088 sender_address);
059ec3d9 8089
c007c974
JH
8090 fprintf(f, "%s on the queue on %s.\n\n"
8091 "The message identifier is: %s\n",
8092 warnmsg_delay, primary_hostname, message_id);
059ec3d9 8093
d6c82d7b 8094 for (h = header_list; h; h = h->next)
059ec3d9
PH
8095 if (strncmpic(h->text, US"Subject:", 8) == 0)
8096 fprintf(f, "The subject of the message is: %s", h->text + 9);
8097 else if (strncmpic(h->text, US"Date:", 5) == 0)
8098 fprintf(f, "The date of the message is: %s", h->text + 6);
c007c974 8099 fputc('\n', f);
059ec3d9
PH
8100
8101 fprintf(f, "The address%s to which the message has not yet been "
8102 "delivered %s:\n",
c007c974
JH
8103 !addr_defer->next ? "" : "es",
8104 !addr_defer->next ? "is": "are");
059ec3d9
PH
8105 }
8106
447d236c 8107 /* List the addresses, with error information if allowed */
059ec3d9 8108
6c1c3d1d
WB
8109 /* store addr_defer for machine readable part */
8110 address_item *addr_dsndefer = addr_defer;
c007c974
JH
8111 fputc('\n', f);
8112 while (addr_defer)
059ec3d9
PH
8113 {
8114 address_item *addr = addr_defer;
8115 addr_defer = addr->next;
447d236c
PH
8116 if (print_address_information(addr, f, US" ", US"\n ", US""))
8117 print_address_error(addr, f, US"Delay reason: ");
c007c974 8118 fputc('\n', f);
059ec3d9 8119 }
c007c974 8120 fputc('\n', f);
059ec3d9
PH
8121
8122 /* Final text */
8123
c007c974 8124 if (wmf)
059ec3d9 8125 {
c007c974
JH
8126 if ((wmf_text = next_emf(wmf, US"final")))
8127 fprintf(f, "%s", CS wmf_text);
f1e894f3 8128 (void)fclose(wmf);
059ec3d9
PH
8129 }
8130 else
8131 {
8132 fprintf(f,
8133"No action is required on your part. Delivery attempts will continue for\n"
8134"some time, and this warning may be repeated at intervals if the message\n"
8135"remains undelivered. Eventually the mail delivery software will give up,\n"
8136"and when that happens, the message will be returned to you.\n");
8137 }
8138
6c1c3d1d 8139 /* output machine readable part */
c007c974
JH
8140 fprintf(f, "\n--%s\n"
8141 "Content-type: message/delivery-status\n\n"
8142 "Reporting-MTA: dns; %s\n",
45500060 8143 bound,
c007c974 8144 smtp_active_hostname);
94431adb 8145
c007c974
JH
8146
8147 if (dsn_envid)
8148 {
6c1c3d1d
WB
8149 /* must be decoded from xtext: see RFC 3461:6.3a */
8150 uschar *xdec_envid;
8151 if (auth_xtextdecode(dsn_envid, &xdec_envid) > 0)
8152 fprintf(f,"Original-Envelope-ID: %s\n", dsn_envid);
8153 else
968178ac 8154 fprintf(f,"X-Original-Envelope-ID: error decoding xtext formatted ENVID\n");
6c1c3d1d 8155 }
c007c974 8156 fputc('\n', f);
6c1c3d1d 8157
1c5b1499 8158 for ( ; addr_dsndefer; addr_dsndefer = addr_dsndefer->next)
6c1c3d1d 8159 {
c007c974 8160 if (addr_dsndefer->dsn_orcpt)
1c5b1499 8161 fprintf(f, "Original-Recipient: %s\n", addr_dsndefer->dsn_orcpt);
c007c974 8162
1c5b1499
JH
8163 fprintf(f, "Action: delayed\n"
8164 "Final-Recipient: rfc822;%s\n"
8165 "Status: 4.0.0\n",
8166 addr_dsndefer->address);
c007c974 8167 if (addr_dsndefer->host_used && addr_dsndefer->host_used->name)
21bc4865 8168 {
94431adb 8169 fprintf(f, "Remote-MTA: dns; %s\n",
21bc4865
WB
8170 addr_dsndefer->host_used->name);
8171 print_dsn_diagnostic_code(addr_dsndefer, f);
8172 }
1c5b1499 8173 fputc('\n', f);
6c1c3d1d
WB
8174 }
8175
1c5b1499 8176 fprintf(f, "--%s\n"
c007c974 8177 "Content-type: text/rfc822-headers\n\n",
45500060 8178 bound);
6c1c3d1d
WB
8179
8180 fflush(f);
8181 /* header only as required by RFC. only failure DSN needs to honor RET=FULL */
6b46ecc6 8182 tctx.options = topt_add_return_path | topt_no_body;
6c1c3d1d
WB
8183 transport_filter_argv = NULL; /* Just in case */
8184 return_path = sender_address; /* In case not previously set */
6b46ecc6 8185
6c1c3d1d 8186 /* Write the original email out */
6b46ecc6 8187 transport_write_message(fileno(f), &tctx, 0);
6c1c3d1d
WB
8188 fflush(f);
8189
45500060 8190 fprintf(f,"\n--%s--\n", bound);
6c1c3d1d
WB
8191
8192 fflush(f);
6c1c3d1d 8193
059ec3d9
PH
8194 /* Close and wait for child process to complete, without a timeout.
8195 If there's an error, don't update the count. */
8196
f1e894f3 8197 (void)fclose(f);
059ec3d9
PH
8198 if (child_close(pid, 0) == 0)
8199 {
8200 warning_count = count;
8201 update_spool = TRUE; /* Ensure spool rewritten */
8202 }
8203 }
8204 }
8205 }
8206
8207 /* Clear deliver_domain */
8208
8209 deliver_domain = NULL;
8210
8211 /* If this was a first delivery attempt, unset the first time flag, and
8212 ensure that the spool gets updated. */
8213
8214 if (deliver_firsttime)
8215 {
8216 deliver_firsttime = FALSE;
8217 update_spool = TRUE;
8218 }
8219
8220 /* If delivery was frozen and freeze_tell is set, generate an appropriate
8221 message, unless the message is a local error message (to avoid loops). Then
8222 log the freezing. If the text in "frozen_info" came from a system filter,
8223 it has been escaped into printing characters so as not to mess up log lines.
8224 For the "tell" message, we turn \n back into newline. Also, insert a newline
8225 near the start instead of the ": " string. */
8226
8227 if (deliver_freeze)
8228 {
d6c82d7b 8229 if (freeze_tell && freeze_tell[0] != 0 && !local_error_message)
059ec3d9
PH
8230 {
8231 uschar *s = string_copy(frozen_info);
8232 uschar *ss = Ustrstr(s, " by the system filter: ");
8233
8234 if (ss != NULL)
8235 {
8236 ss[21] = '.';
8237 ss[22] = '\n';
8238 }
8239
8240 ss = s;
8241 while (*ss != 0)
8242 {
8243 if (*ss == '\\' && ss[1] == 'n')
8244 {
8245 *ss++ = ' ';
8246 *ss++ = '\n';
8247 }
8248 else ss++;
8249 }
8250 moan_tell_someone(freeze_tell, addr_defer, US"Message frozen",
8251 "Message %s has been frozen%s.\nThe sender is <%s>.\n", message_id,
8252 s, sender_address);
8253 }
8254
8255 /* Log freezing just before we update the -H file, to minimize the chance
8256 of a race problem. */
8257
8258 deliver_msglog("*** Frozen%s\n", frozen_info);
8259 log_write(0, LOG_MAIN, "Frozen%s", frozen_info);
8260 }
8261
8262 /* If there have been any updates to the non-recipients list, or other things
8263 that get written to the spool, we must now update the spool header file so
8264 that it has the right information for the next delivery attempt. If there
8265 was more than one address being delivered, the header_change update is done
8266 earlier, in case one succeeds and then something crashes. */
8267
8268 DEBUG(D_deliver)
8269 debug_printf("delivery deferred: update_spool=%d header_rewritten=%d\n",
8270 update_spool, header_rewritten);
8271
8272 if (update_spool || header_rewritten)
8273 /* Panic-dies on error */
8274 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
8275 }
8276
8277/* Finished with the message log. If the message is complete, it will have
8278been unlinked or renamed above. */
8279
f1e894f3 8280if (message_logs) (void)fclose(message_log);
059ec3d9
PH
8281
8282/* Now we can close and remove the journal file. Its only purpose is to record
8283successfully completed deliveries asap so that this information doesn't get
8284lost if Exim (or the machine) crashes. Forgetting about a failed delivery is
8285not serious, as trying it again is not harmful. The journal might not be open
8286if all addresses were deferred at routing or directing. Nevertheless, we must
8287remove it if it exists (may have been lying around from a crash during the
8288previous delivery attempt). We don't remove the journal if a delivery
8289subprocess failed to pass back delivery information; this is controlled by
8290the remove_journal flag. When the journal is left, we also don't move the
8291message off the main spool if frozen and the option is set. It should get moved
8292at the next attempt, after the journal has been inspected. */
8293
f1e894f3 8294if (journal_fd >= 0) (void)close(journal_fd);
059ec3d9
PH
8295
8296if (remove_journal)
8297 {
41313d92
JH
8298 uschar * fname = spool_fname(US"input", message_subdir, id, US"-J");
8299
8300 if (Uunlink(fname) < 0 && errno != ENOENT)
8301 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s", fname,
059ec3d9
PH
8302 strerror(errno));
8303
4c04137d 8304 /* Move the message off the spool if requested */
059ec3d9 8305
a7538db1 8306#ifdef SUPPORT_MOVE_FROZEN_MESSAGES
059ec3d9
PH
8307 if (deliver_freeze && move_frozen_messages)
8308 (void)spool_move_message(id, message_subdir, US"", US"F");
a7538db1 8309#endif
059ec3d9
PH
8310 }
8311
8312/* Closing the data file frees the lock; if the file has been unlinked it
8313will go away. Otherwise the message becomes available for another process
8314to try delivery. */
8315
f1e894f3 8316(void)close(deliver_datafile);
059ec3d9
PH
8317deliver_datafile = -1;
8318DEBUG(D_deliver) debug_printf("end delivery of %s\n", id);
8319
8320/* It is unlikely that there will be any cached resources, since they are
8321released after routing, and in the delivery subprocesses. However, it's
8322possible for an expansion for something afterwards (for example,
8323expand_check_condition) to do a lookup. We must therefore be sure everything is
8324released. */
8325
8326search_tidyup();
faa05a93 8327acl_where = ACL_WHERE_UNKNOWN;
059ec3d9
PH
8328return final_yield;
8329}
8330
476be7e2
JH
8331
8332
8333void
8334deliver_init(void)
8335{
8336if (!regex_PIPELINING) regex_PIPELINING =
8337 regex_must_compile(US"\\n250[\\s\\-]PIPELINING(\\s|\\n|$)", FALSE, TRUE);
8338
8339if (!regex_SIZE) regex_SIZE =
8340 regex_must_compile(US"\\n250[\\s\\-]SIZE(\\s|\\n|$)", FALSE, TRUE);
8341
8342if (!regex_AUTH) regex_AUTH =
8343 regex_must_compile(US"\\n250[\\s\\-]AUTH\\s+([\\-\\w\\s]+)(?:\\n|$)",
8344 FALSE, TRUE);
8345
8346#ifdef SUPPORT_TLS
8347if (!regex_STARTTLS) regex_STARTTLS =
8348 regex_must_compile(US"\\n250[\\s\\-]STARTTLS(\\s|\\n|$)", FALSE, TRUE);
8349#endif
8350
f98442df
JH
8351if (!regex_CHUNKING) regex_CHUNKING =
8352 regex_must_compile(US"\\n250[\\s\\-]CHUNKING(\\s|\\n|$)", FALSE, TRUE);
8353
476be7e2
JH
8354#ifndef DISABLE_PRDR
8355if (!regex_PRDR) regex_PRDR =
8356 regex_must_compile(US"\\n250[\\s\\-]PRDR(\\s|\\n|$)", FALSE, TRUE);
8357#endif
8358
8c5d388a 8359#ifdef SUPPORT_I18N
7ade712c
JH
8360if (!regex_UTF8) regex_UTF8 =
8361 regex_must_compile(US"\\n250[\\s\\-]SMTPUTF8(\\s|\\n|$)", FALSE, TRUE);
8362#endif
8363
476be7e2
JH
8364if (!regex_DSN) regex_DSN =
8365 regex_must_compile(US"\\n250[\\s\\-]DSN(\\s|\\n|$)", FALSE, TRUE);
8366
8367if (!regex_IGNOREQUOTA) regex_IGNOREQUOTA =
8368 regex_must_compile(US"\\n250[\\s\\-]IGNOREQUOTA(\\s|\\n|$)", FALSE, TRUE);
8369}
8370
8371
a39bd74d
JB
8372uschar *
8373deliver_get_sender_address (uschar * id)
8374{
dadff1d4
HSHR
8375int rc;
8376uschar * new_sender_address,
8377 * save_sender_address;
789f8a4f 8378BOOL save_qr = queue_running;
41313d92 8379uschar * spoolname;
dadff1d4 8380
789f8a4f
JH
8381/* make spool_open_datafile non-noisy on fail */
8382
8383queue_running = TRUE;
8384
8385/* Side effect: message_subdir is set for the (possibly split) spool directory */
8386
8387deliver_datafile = spool_open_datafile(id);
8388queue_running = save_qr;
8389if (deliver_datafile < 0)
a39bd74d
JB
8390 return NULL;
8391
dadff1d4
HSHR
8392/* Save and restore the global sender_address. I'm not sure if we should
8393not save/restore all the other global variables too, because
8394spool_read_header() may change all of them. But OTOH, when this
8395deliver_get_sender_address() gets called, the current message is done
8396already and nobody needs the globals anymore. (HS12, 2015-08-21) */
8397
41313d92 8398spoolname = string_sprintf("%s-H", id);
dadff1d4
HSHR
8399save_sender_address = sender_address;
8400
8401rc = spool_read_header(spoolname, TRUE, TRUE);
8402
8403new_sender_address = sender_address;
8404sender_address = save_sender_address;
8405
8406if (rc != spool_read_OK)
a39bd74d
JB
8407 return NULL;
8408
dadff1d4
HSHR
8409assert(new_sender_address);
8410
a39bd74d
JB
8411(void)close(deliver_datafile);
8412deliver_datafile = -1;
8413
dadff1d4 8414return new_sender_address;
a39bd74d
JB
8415}
8416
67d81c10
JH
8417/* vi: aw ai sw=2
8418*/
059ec3d9 8419/* End of deliver.c */