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