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