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