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