Fix $local_part_verified for remote-delivery routing following local. Bug 2565
[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 */
1e1ddfac 6/* Copyright (c) The Exim Maintainers 2020 */
059ec3d9
PH
7/* See the file NOTICE for conditions of use and distribution. */
8
9/* The main code for delivering a message. */
10
11
12#include "exim.h"
e39fdc85 13#include "transports/smtp.h"
c29da374 14#include <sys/uio.h>
dadff1d4 15#include <assert.h>
059ec3d9
PH
16
17
18/* Data block for keeping track of subprocesses for parallel remote
19delivery. */
20
21typedef struct pardata {
22 address_item *addrlist; /* chain of addresses */
23 address_item *addr; /* next address data expected for */
24 pid_t pid; /* subprocess pid */
25 int fd; /* pipe fd for getting result from subprocess */
26 int transport_count; /* returned transport count value */
27 BOOL done; /* no more data needed */
28 uschar *msg; /* error message */
29 uschar *return_path; /* return_path for these addresses */
30} pardata;
31
32/* Values for the process_recipients variable */
33
34enum { RECIP_ACCEPT, RECIP_IGNORE, RECIP_DEFER,
35 RECIP_FAIL, RECIP_FAIL_FILTER, RECIP_FAIL_TIMEOUT,
36 RECIP_FAIL_LOOP};
37
38/* Mutually recursive functions for marking addresses done. */
39
40static void child_done(address_item *, uschar *);
41static void address_done(address_item *, uschar *);
42
43/* Table for turning base-62 numbers into binary */
44
45static uschar tab62[] =
46 {0,1,2,3,4,5,6,7,8,9,0,0,0,0,0,0, /* 0-9 */
47 0,10,11,12,13,14,15,16,17,18,19,20, /* A-K */
48 21,22,23,24,25,26,27,28,29,30,31,32, /* L-W */
49 33,34,35, 0, 0, 0, 0, 0, /* X-Z */
50 0,36,37,38,39,40,41,42,43,44,45,46, /* a-k */
51 47,48,49,50,51,52,53,54,55,56,57,58, /* l-w */
52 59,60,61}; /* x-z */
53
54
55/*************************************************
56* Local static variables *
57*************************************************/
58
59/* addr_duplicate is global because it needs to be seen from the Envelope-To
60writing code. */
61
62static address_item *addr_defer = NULL;
63static address_item *addr_failed = NULL;
64static address_item *addr_fallback = NULL;
65static address_item *addr_local = NULL;
66static address_item *addr_new = NULL;
67static address_item *addr_remote = NULL;
68static address_item *addr_route = NULL;
69static address_item *addr_succeed = NULL;
6c1c3d1d 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
83/*************************************************
ee250936
JH
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{
6d95688d
JH
111uschar * next = buffer;
112uschar * end = next + len;
ee250936 113
6d95688d
JH
114while (next < end)
115 {
116 ssize_t got = read(fd, next, end - next);
ee250936 117
6d95688d
JH
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 - US buffer;
122 next += got;
123 }
ee250936 124
6d95688d 125return len;
ee250936
JH
126}
127
128
129/*************************************************
059ec3d9
PH
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{
f3ebb786 148address_item *addr = store_get(sizeof(address_item), FALSE);
059ec3d9
PH
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;
b4f579d1 202router_var = addr->prop.variables;
059ec3d9
PH
203
204/* These may be unset for multiple addresses */
205
206deliver_domain = addr->domain;
207self_hostname = addr->self_hostname;
208
8523533c
TK
209#ifdef EXPERIMENTAL_BRIGHTMAIL
210bmi_deliver = 1; /* deliver by default */
211bmi_alt_location = NULL;
212bmi_base64_verdict = NULL;
213bmi_base64_tracker_verdict = NULL;
214#endif
215
059ec3d9
PH
216/* If there's only one address we can set everything. */
217
d6c82d7b 218if (!addr->next)
059ec3d9
PH
219 {
220 address_item *addr_orig;
221
222 deliver_localpart = addr->local_part;
37c0e209 223 deliver_localpart_verified = addr->local_part_verified;
059ec3d9 224 deliver_localpart_prefix = addr->prefix;
759502e5 225 deliver_localpart_prefix_v = addr->prefix_v;
059ec3d9 226 deliver_localpart_suffix = addr->suffix;
759502e5 227 deliver_localpart_suffix_v = addr->suffix_v;
059ec3d9 228
d6c82d7b 229 for (addr_orig = addr; addr_orig->parent; addr_orig = addr_orig->parent) ;
059ec3d9
PH
230 deliver_domain_orig = addr_orig->domain;
231
232 /* Re-instate any prefix and suffix in the original local part. In all
233 normal cases, the address will have a router associated with it, and we can
234 choose the caseful or caseless version accordingly. However, when a system
235 filter sets up a pipe, file, or autoreply delivery, no router is involved.
236 In this case, though, there won't be any prefix or suffix to worry about. */
237
d6c82d7b
JH
238 deliver_localpart_orig = !addr_orig->router
239 ? addr_orig->local_part
240 : addr_orig->router->caseful_local_part
241 ? addr_orig->cc_local_part
242 : addr_orig->lc_local_part;
059ec3d9
PH
243
244 /* If there's a parent, make its domain and local part available, and if
245 delivering to a pipe or file, or sending an autoreply, get the local
246 part from the parent. For pipes and files, put the pipe or file string
247 into address_pipe and address_file. */
248
d6c82d7b 249 if (addr->parent)
059ec3d9
PH
250 {
251 deliver_domain_parent = addr->parent->domain;
d6c82d7b
JH
252 deliver_localpart_parent = !addr->parent->router
253 ? addr->parent->local_part
254 : addr->parent->router->caseful_local_part
255 ? addr->parent->cc_local_part
256 : addr->parent->lc_local_part;
059ec3d9
PH
257
258 /* File deliveries have their own flag because they need to be picked out
259 as special more often. */
260
261 if (testflag(addr, af_pfr))
262 {
d6c82d7b
JH
263 if (testflag(addr, af_file)) address_file = addr->local_part;
264 else if (deliver_localpart[0] == '|') address_pipe = addr->local_part;
059ec3d9
PH
265 deliver_localpart = addr->parent->local_part;
266 deliver_localpart_prefix = addr->parent->prefix;
759502e5 267 deliver_localpart_prefix_v = addr->parent->prefix_v;
059ec3d9 268 deliver_localpart_suffix = addr->parent->suffix;
759502e5 269 deliver_localpart_suffix_v = addr->parent->suffix_v;
059ec3d9
PH
270 }
271 }
8523533c
TK
272
273#ifdef EXPERIMENTAL_BRIGHTMAIL
274 /* Set expansion variables related to Brightmail AntiSpam */
275 bmi_base64_verdict = bmi_get_base64_verdict(deliver_localpart_orig, deliver_domain_orig);
276 bmi_base64_tracker_verdict = bmi_get_base64_tracker_verdict(bmi_base64_verdict);
277 /* get message delivery status (0 - don't deliver | 1 - deliver) */
278 bmi_deliver = bmi_get_delivery_status(bmi_base64_verdict);
279 /* if message is to be delivered, get eventual alternate location */
d6c82d7b 280 if (bmi_deliver == 1)
8523533c 281 bmi_alt_location = bmi_get_alt_location(bmi_base64_verdict);
8523533c
TK
282#endif
283
059ec3d9
PH
284 }
285
286/* For multiple addresses, don't set local part, and leave the domain and
f7fd3850
PH
287self_hostname set only if it is the same for all of them. It is possible to
288have multiple pipe and file addresses, but only when all addresses have routed
289to the same pipe or file. */
059ec3d9
PH
290
291else
292 {
f7fd3850
PH
293 if (testflag(addr, af_pfr))
294 {
d6c82d7b
JH
295 if (testflag(addr, af_file)) address_file = addr->local_part;
296 else if (addr->local_part[0] == '|') address_pipe = addr->local_part;
f7fd3850 297 }
d7978c0f 298 for (address_item * addr2 = addr->next; addr2; addr2 = addr2->next)
059ec3d9 299 {
d6c82d7b 300 if (deliver_domain && Ustrcmp(deliver_domain, addr2->domain) != 0)
059ec3d9 301 deliver_domain = NULL;
d6c82d7b
JH
302 if ( self_hostname
303 && ( !addr2->self_hostname
304 || Ustrcmp(self_hostname, addr2->self_hostname) != 0
305 ) )
059ec3d9 306 self_hostname = NULL;
d6c82d7b 307 if (!deliver_domain && !self_hostname) break;
059ec3d9
PH
308 }
309 }
310}
311
312
313
314
315/*************************************************
316* Open a msglog file *
317*************************************************/
318
319/* This function is used both for normal message logs, and for files in the
320msglog directory that are used to catch output from pipes. Try to create the
321directory if it does not exist. From release 4.21, normal message logs should
322be created when the message is received.
323
92b0827a
JH
324Called from deliver_message(), can be operating as root.
325
059ec3d9
PH
326Argument:
327 filename the file name
328 mode the mode required
329 error used for saying what failed
330
331Returns: a file descriptor, or -1 (with errno set)
332*/
333
334static int
335open_msglog_file(uschar *filename, int mode, uschar **error)
336{
8f84b06a
JH
337if (Ustrstr(filename, US"/../"))
338 log_write(0, LOG_MAIN|LOG_PANIC,
339 "Attempt to open msglog file path with upward-traversal: '%s'\n", filename);
340
d7978c0f 341for (int i = 2; i > 0; i--)
059ec3d9 342 {
d7978c0f 343 int fd = Uopen(filename,
92b0827a
JH
344#ifdef O_CLOEXEC
345 O_CLOEXEC |
346#endif
347#ifdef O_NOFOLLOW
348 O_NOFOLLOW |
349#endif
350 O_WRONLY|O_APPEND|O_CREAT, mode);
351 if (fd >= 0)
352 {
353 /* Set the close-on-exec flag and change the owner to the exim uid/gid (this
354 function is called as root). Double check the mode, because the group setting
355 doesn't always get set automatically. */
356
357#ifndef O_CLOEXEC
358 (void)fcntl(fd, F_SETFD, fcntl(fd, F_GETFD) | FD_CLOEXEC);
359#endif
b66fecb4 360 if (exim_fchown(fd, exim_uid, exim_gid, filename) < 0)
92b0827a
JH
361 {
362 *error = US"chown";
363 return -1;
364 }
365 if (fchmod(fd, mode) < 0)
366 {
367 *error = US"chmod";
368 return -1;
369 }
370 return fd;
371 }
372 if (errno != ENOENT)
373 break;
374
41313d92
JH
375 (void)directory_make(spool_directory,
376 spool_sname(US"msglog", message_subdir),
377 MSGLOG_DIRECTORY_MODE, TRUE);
059ec3d9 378 }
059ec3d9 379
b66fecb4 380*error = US"create or open";
92b0827a 381return -1;
059ec3d9
PH
382}
383
384
385
386
387/*************************************************
388* Write to msglog if required *
389*************************************************/
390
391/* Write to the message log, if configured. This function may also be called
392from transports.
393
394Arguments:
395 format a string format
396
397Returns: nothing
398*/
399
400void
401deliver_msglog(const char *format, ...)
402{
403va_list ap;
404if (!message_logs) return;
405va_start(ap, format);
406vfprintf(message_log, format, ap);
407fflush(message_log);
408va_end(ap);
409}
410
411
412
413
414/*************************************************
415* Replicate status for batch *
416*************************************************/
417
418/* When a transport handles a batch of addresses, it may treat them
419individually, or it may just put the status in the first one, and return FALSE,
420requesting that the status be copied to all the others externally. This is the
421replication function. As well as the status, it copies the transport pointer,
422which may have changed if appendfile passed the addresses on to a different
423transport.
424
425Argument: pointer to the first address in a chain
426Returns: nothing
427*/
428
429static void
430replicate_status(address_item *addr)
431{
d7978c0f 432for (address_item * addr2 = addr->next; addr2; addr2 = addr2->next)
059ec3d9 433 {
d6c82d7b 434 addr2->transport = addr->transport;
059ec3d9 435 addr2->transport_return = addr->transport_return;
d6c82d7b
JH
436 addr2->basic_errno = addr->basic_errno;
437 addr2->more_errno = addr->more_errno;
a55697ac 438 addr2->delivery_time = addr->delivery_time;
d6c82d7b
JH
439 addr2->special_action = addr->special_action;
440 addr2->message = addr->message;
441 addr2->user_message = addr->user_message;
059ec3d9
PH
442 }
443}
444
445
446
447/*************************************************
448* Compare lists of hosts *
449*************************************************/
450
451/* This function is given two pointers to chains of host items, and it yields
452TRUE if the lists refer to the same hosts in the same order, except that
453
454(1) Multiple hosts with the same non-negative MX values are permitted to appear
455 in different orders. Round-robinning nameservers can cause this to happen.
456
457(2) Multiple hosts with the same negative MX values less than MX_NONE are also
458 permitted to appear in different orders. This is caused by randomizing
459 hosts lists.
460
461This enables Exim to use a single SMTP transaction for sending to two entirely
462different domains that happen to end up pointing at the same hosts.
463
464Arguments:
465 one points to the first host list
466 two points to the second host list
467
468Returns: TRUE if the lists refer to the same host set
469*/
470
471static BOOL
472same_hosts(host_item *one, host_item *two)
473{
d6c82d7b 474while (one && two)
059ec3d9
PH
475 {
476 if (Ustrcmp(one->name, two->name) != 0)
477 {
478 int mx = one->mx;
479 host_item *end_one = one;
480 host_item *end_two = two;
481
482 /* Batch up only if there was no MX and the list was not randomized */
483
484 if (mx == MX_NONE) return FALSE;
485
486 /* Find the ends of the shortest sequence of identical MX values */
487
d6c82d7b
JH
488 while ( end_one->next && end_one->next->mx == mx
489 && end_two->next && end_two->next->mx == mx)
059ec3d9
PH
490 {
491 end_one = end_one->next;
492 end_two = end_two->next;
493 }
494
495 /* If there aren't any duplicates, there's no match. */
496
497 if (end_one == one) return FALSE;
498
499 /* For each host in the 'one' sequence, check that it appears in the 'two'
500 sequence, returning FALSE if not. */
501
502 for (;;)
503 {
504 host_item *hi;
505 for (hi = two; hi != end_two->next; hi = hi->next)
506 if (Ustrcmp(one->name, hi->name) == 0) break;
507 if (hi == end_two->next) return FALSE;
508 if (one == end_one) break;
509 one = one->next;
510 }
511
512 /* All the hosts in the 'one' sequence were found in the 'two' sequence.
513 Ensure both are pointing at the last host, and carry on as for equality. */
514
515 two = end_two;
516 }
517
1c788856
JH
518 /* if the names matched but ports do not, mismatch */
519 else if (one->port != two->port)
520 return FALSE;
521
059ec3d9
PH
522 /* Hosts matched */
523
524 one = one->next;
525 two = two->next;
526 }
527
528/* True if both are NULL */
529
530return (one == two);
531}
532
533
534
535/*************************************************
536* Compare header lines *
537*************************************************/
538
539/* This function is given two pointers to chains of header items, and it yields
540TRUE if they are the same header texts in the same order.
541
542Arguments:
543 one points to the first header list
544 two points to the second header list
545
546Returns: TRUE if the lists refer to the same header set
547*/
548
549static BOOL
550same_headers(header_line *one, header_line *two)
551{
d6c82d7b 552for (;; one = one->next, two = two->next)
059ec3d9
PH
553 {
554 if (one == two) return TRUE; /* Includes the case where both NULL */
d6c82d7b 555 if (!one || !two) return FALSE;
059ec3d9 556 if (Ustrcmp(one->text, two->text) != 0) return FALSE;
059ec3d9
PH
557 }
558}
559
560
561
562/*************************************************
563* Compare string settings *
564*************************************************/
565
566/* This function is given two pointers to strings, and it returns
567TRUE if they are the same pointer, or if the two strings are the same.
568
569Arguments:
570 one points to the first string
571 two points to the second string
572
573Returns: TRUE or FALSE
574*/
575
576static BOOL
577same_strings(uschar *one, uschar *two)
578{
579if (one == two) return TRUE; /* Includes the case where both NULL */
d6c82d7b 580if (!one || !two) return FALSE;
059ec3d9
PH
581return (Ustrcmp(one, two) == 0);
582}
583
584
585
586/*************************************************
587* Compare uid/gid for addresses *
588*************************************************/
589
590/* This function is given a transport and two addresses. It yields TRUE if the
591uid/gid/initgroups settings for the two addresses are going to be the same when
592they are delivered.
593
594Arguments:
595 tp the transort
596 addr1 the first address
597 addr2 the second address
598
599Returns: TRUE or FALSE
600*/
601
602static BOOL
603same_ugid(transport_instance *tp, address_item *addr1, address_item *addr2)
604{
d6c82d7b
JH
605if ( !tp->uid_set && !tp->expand_uid
606 && !tp->deliver_as_creator
607 && ( testflag(addr1, af_uid_set) != testflag(addr2, af_gid_set)
608 || ( testflag(addr1, af_uid_set)
609 && ( addr1->uid != addr2->uid
610 || testflag(addr1, af_initgroups) != testflag(addr2, af_initgroups)
611 ) ) ) )
612 return FALSE;
059ec3d9 613
d6c82d7b
JH
614if ( !tp->gid_set && !tp->expand_gid
615 && ( testflag(addr1, af_gid_set) != testflag(addr2, af_gid_set)
616 || ( testflag(addr1, af_gid_set)
617 && addr1->gid != addr2->gid
618 ) ) )
619 return FALSE;
059ec3d9
PH
620
621return TRUE;
622}
623
624
625
626
627/*************************************************
628* Record that an address is complete *
629*************************************************/
630
631/* This function records that an address is complete. This is straightforward
632for most addresses, where the unique address is just the full address with the
633domain lower cased. For homonyms (addresses that are the same as one of their
634ancestors) their are complications. Their unique addresses have \x\ prepended
635(where x = 0, 1, 2...), so that de-duplication works correctly for siblings and
636cousins.
637
638Exim used to record the unique addresses of homonyms as "complete". This,
639however, fails when the pattern of redirection varies over time (e.g. if taking
640unseen copies at only some times of day) because the prepended numbers may vary
641from one delivery run to the next. This problem is solved by never recording
642prepended unique addresses as complete. Instead, when a homonymic address has
643actually been delivered via a transport, we record its basic unique address
644followed by the name of the transport. This is checked in subsequent delivery
645runs whenever an address is routed to a transport.
646
647If the completed address is a top-level one (has no parent, which means it
648cannot be homonymic) we also add the original address to the non-recipients
649tree, so that it gets recorded in the spool file and therefore appears as
650"done" in any spool listings. The original address may differ from the unique
651address in the case of the domain.
652
653Finally, this function scans the list of duplicates, marks as done any that
654match this address, and calls child_done() for their ancestors.
655
656Arguments:
657 addr address item that has been completed
658 now current time as a string
659
660Returns: nothing
661*/
662
663static void
664address_done(address_item *addr, uschar *now)
665{
059ec3d9
PH
666update_spool = TRUE; /* Ensure spool gets updated */
667
668/* Top-level address */
669
d6c82d7b 670if (!addr->parent)
059ec3d9
PH
671 {
672 tree_add_nonrecipient(addr->unique);
673 tree_add_nonrecipient(addr->address);
674 }
675
676/* Homonymous child address */
677
678else if (testflag(addr, af_homonym))
679 {
d6c82d7b 680 if (addr->transport)
059ec3d9
PH
681 tree_add_nonrecipient(
682 string_sprintf("%s/%s", addr->unique + 3, addr->transport->name));
059ec3d9
PH
683 }
684
685/* Non-homonymous child address */
686
687else tree_add_nonrecipient(addr->unique);
688
689/* Check the list of duplicate addresses and ensure they are now marked
690done as well. */
691
d7978c0f 692for (address_item * dup = addr_duplicate; dup; dup = dup->next)
059ec3d9
PH
693 if (Ustrcmp(addr->unique, dup->unique) == 0)
694 {
57730b52 695 tree_add_nonrecipient(dup->unique);
059ec3d9
PH
696 child_done(dup, now);
697 }
059ec3d9
PH
698}
699
700
701
702
703/*************************************************
704* Decrease counts in parents and mark done *
705*************************************************/
706
707/* This function is called when an address is complete. If there is a parent
708address, its count of children is decremented. If there are still other
709children outstanding, the function exits. Otherwise, if the count has become
710zero, address_done() is called to mark the parent and its duplicates complete.
711Then loop for any earlier ancestors.
712
713Arguments:
714 addr points to the completed address item
715 now the current time as a string, for writing to the message log
716
717Returns: nothing
718*/
719
720static void
721child_done(address_item *addr, uschar *now)
722{
d6c82d7b 723while (addr->parent)
059ec3d9 724 {
d7978c0f
JH
725 address_item *aa;
726
059ec3d9 727 addr = addr->parent;
82f90600 728 if (--addr->child_count > 0) return; /* Incomplete parent */
059ec3d9
PH
729 address_done(addr, now);
730
731 /* Log the completion of all descendents only when there is no ancestor with
732 the same original address. */
733
d6c82d7b 734 for (aa = addr->parent; aa; aa = aa->parent)
059ec3d9 735 if (Ustrcmp(aa->address, addr->address) == 0) break;
d6c82d7b 736 if (aa) continue;
059ec3d9
PH
737
738 deliver_msglog("%s %s: children all complete\n", now, addr->address);
739 DEBUG(D_deliver) debug_printf("%s: children all complete\n", addr->address);
740 }
741}
742
743
744
ac881e27
TF
745/*************************************************
746* Delivery logging support functions *
747*************************************************/
748
749/* The LOGGING() checks in d_log_interface() are complicated for backwards
750compatibility. When outgoing interface logging was originally added, it was
751conditional on just incoming_interface (which is off by default). The
752outgoing_interface option is on by default to preserve this behaviour, but
753you can enable incoming_interface and disable outgoing_interface to get I=
754fields on incoming lines only.
755
756Arguments:
acec9514 757 g The log line
ac881e27
TF
758 addr The address to be logged
759
760Returns: New value for s
761*/
059ec3d9 762
acec9514
JH
763static gstring *
764d_log_interface(gstring * g)
67d81c10 765{
ac881e27 766if (LOGGING(incoming_interface) && LOGGING(outgoing_interface)
d6c82d7b 767 && sending_ip_address)
ac881e27 768 {
d12746bc
JH
769 g = string_fmt_append(g, " I=[%s]", sending_ip_address);
770 if (LOGGING(outgoing_port))
2d5bf097 771 g = string_fmt_append(g, ":%d", sending_port);
ac881e27 772 }
acec9514 773return g;
67d81c10
JH
774}
775
ac881e27
TF
776
777
acec9514
JH
778static gstring *
779d_hostlog(gstring * g, address_item * addr)
ac881e27 780{
fc16abb4
JH
781host_item * h = addr->host_used;
782
acec9514 783g = string_append(g, 2, US" H=", h->name);
fc16abb4
JH
784
785if (LOGGING(dnssec) && h->dnssec == DS_YES)
acec9514 786 g = string_catn(g, US" DS", 3);
fc16abb4 787
acec9514 788g = string_append(g, 3, US" [", h->address, US"]");
fc16abb4 789
ac881e27 790if (LOGGING(outgoing_port))
d12746bc 791 g = string_fmt_append(g, ":%d", h->port);
e6d2a989
JH
792
793#ifdef SUPPORT_SOCKS
794if (LOGGING(proxy) && proxy_local_address)
795 {
acec9514 796 g = string_append(g, 3, US" PRX=[", proxy_local_address, US"]");
e6d2a989 797 if (LOGGING(outgoing_port))
d12746bc 798 g = string_fmt_append(g, ":%d", proxy_local_port);
e6d2a989
JH
799 }
800#endif
801
acec9514 802g = d_log_interface(g);
a2673768
JH
803
804if (testflag(addr, af_tcp_fastopen))
ee8b8090 805 g = string_catn(g, US" TFO*", testflag(addr, af_tcp_fastopen_data) ? 5 : 4);
a2673768 806
acec9514 807return g;
ac881e27
TF
808}
809
810
811
e6d2a989
JH
812
813
01603eec 814#ifndef DISABLE_TLS
acec9514 815static gstring *
b10c87b3 816d_tlslog(gstring * g, address_item * addr)
67d81c10 817{
d6c82d7b 818if (LOGGING(tls_cipher) && addr->cipher)
b10c87b3
JH
819 {
820 g = string_append(g, 2, US" X=", addr->cipher);
821#ifdef EXPERIMENTAL_TLS_RESUME
822 if (LOGGING(tls_resumption) && testflag(addr, af_tls_resume))
823 g = string_catn(g, US"*", 1);
824#endif
825 }
d6c82d7b 826if (LOGGING(tls_certificate_verified) && addr->cipher)
b10c87b3 827 g = string_append(g, 2, US" CV=",
ac881e27
TF
828 testflag(addr, af_cert_verified)
829 ?
c0635b6d 830#ifdef SUPPORT_DANE
ac881e27
TF
831 testflag(addr, af_dane_verified)
832 ? "dane"
833 :
53a7196b 834#endif
ac881e27
TF
835 "yes"
836 : "no");
d6c82d7b 837if (LOGGING(tls_peerdn) && addr->peerdn)
b10c87b3
JH
838 g = string_append(g, 3, US" DN=\"", string_printing(addr->peerdn), US"\"");
839return g;
67d81c10
JH
840}
841#endif
842
a7538db1 843
14a465c3
JH
844
845
0cbf2b82 846#ifndef DISABLE_EVENT
b30275b8 847uschar *
55414b25 848event_raise(uschar * action, const uschar * event, uschar * ev_data)
a7538db1
JH
849{
850uschar * s;
851if (action)
852 {
853 DEBUG(D_deliver)
774ef2d7 854 debug_printf("Event(%s): event_action=|%s| delivery_IP=%s\n",
a7538db1
JH
855 event,
856 action, deliver_host_address);
857
774ef2d7
JH
858 event_name = event;
859 event_data = ev_data;
a7538db1
JH
860
861 if (!(s = expand_string(action)) && *expand_string_message)
862 log_write(0, LOG_MAIN|LOG_PANIC,
774ef2d7 863 "failed to expand event_action %s in %s: %s\n",
7ea1237c 864 event, transport_name ? transport_name : US"main", expand_string_message);
a7538db1 865
774ef2d7 866 event_name = event_data = NULL;
a7538db1
JH
867
868 /* If the expansion returns anything but an empty string, flag for
869 the caller to modify his normal processing
870 */
871 if (s && *s)
872 {
873 DEBUG(D_deliver)
774ef2d7 874 debug_printf("Event(%s): event_action returned \"%s\"\n", event, s);
95938464 875 errno = ERRNO_EVENT;
b30275b8 876 return s;
a7538db1
JH
877 }
878 }
b30275b8 879return NULL;
a7538db1 880}
14a465c3 881
5ef5dd52 882void
55414b25 883msg_event_raise(const uschar * event, const address_item * addr)
14a465c3 884{
55414b25 885const uschar * save_domain = deliver_domain;
14a465c3 886uschar * save_local = deliver_localpart;
55414b25 887const uschar * save_host = deliver_host;
5ef5dd52
JB
888const uschar * save_address = deliver_host_address;
889const int save_port = deliver_host_port;
14a465c3 890
14a465c3 891router_name = addr->router ? addr->router->name : NULL;
14a465c3
JH
892deliver_domain = addr->domain;
893deliver_localpart = addr->local_part;
c562fd30 894deliver_host = addr->host_used ? addr->host_used->name : NULL;
14a465c3 895
4e928780
MK
896if (!addr->transport)
897 {
898 if (Ustrcmp(event, "msg:fail:delivery") == 0)
899 {
900 /* An address failed with no transport involved. This happens when
901 a filter was used which triggered a fail command (in such a case
902 a transport isn't needed). Convert it to an internal fail event. */
903
904 (void) event_raise(event_action, US"msg:fail:internal", addr->message);
905 }
906 }
907else
908 {
909 transport_name = addr->transport->name;
910
911 (void) event_raise(addr->transport->event_action, event,
912 addr->host_used
913 || Ustrcmp(addr->transport->driver_name, "smtp") == 0
914 || Ustrcmp(addr->transport->driver_name, "lmtp") == 0
915 || Ustrcmp(addr->transport->driver_name, "autoreply") == 0
916 ? addr->message : NULL);
917 }
14a465c3 918
5ef5dd52
JB
919deliver_host_port = save_port;
920deliver_host_address = save_address;
c562fd30 921deliver_host = save_host;
14a465c3
JH
922deliver_localpart = save_local;
923deliver_domain = save_domain;
924router_name = transport_name = NULL;
925}
0cbf2b82 926#endif /*DISABLE_EVENT*/
14a465c3
JH
927
928
a7538db1 929
5dac72a7
JH
930/******************************************************************************/
931
932
933/*************************************************
934* Generate local prt for logging *
935*************************************************/
936
937/* This function is a subroutine for use in string_log_address() below.
938
939Arguments:
940 addr the address being logged
941 yield the current dynamic buffer pointer
5dac72a7
JH
942
943Returns: the new value of the buffer pointer
944*/
945
acec9514
JH
946static gstring *
947string_get_localpart(address_item * addr, gstring * yield)
5dac72a7
JH
948{
949uschar * s;
950
951s = addr->prefix;
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
961s = addr->local_part;
962#ifdef SUPPORT_I18N
963if (testflag(addr, af_utf8_downcvt))
964 s = string_localpart_utf8_to_alabel(s, NULL);
965#endif
acec9514 966yield = string_cat(yield, s);
5dac72a7
JH
967
968s = addr->suffix;
969if (testflag(addr, af_include_affixes) && s)
970 {
971#ifdef SUPPORT_I18N
972 if (testflag(addr, af_utf8_downcvt))
973 s = string_localpart_utf8_to_alabel(s, NULL);
974#endif
acec9514 975 yield = string_cat(yield, s);
5dac72a7
JH
976 }
977
978return yield;
979}
980
981
982/*************************************************
983* Generate log address list *
984*************************************************/
985
986/* This function generates a list consisting of an address and its parents, for
987use in logging lines. For saved onetime aliased addresses, the onetime parent
988field is used. If the address was delivered by a transport with rcpt_include_
989affixes set, the af_include_affixes bit will be set in the address. In that
990case, we include the affixes here too.
991
992Arguments:
acec9514 993 g points to growing-string struct
5dac72a7
JH
994 addr bottom (ultimate) address
995 all_parents if TRUE, include all parents
996 success TRUE for successful delivery
997
998Returns: a growable string in dynamic store
999*/
1000
acec9514
JH
1001static gstring *
1002string_log_address(gstring * g,
5dac72a7
JH
1003 address_item *addr, BOOL all_parents, BOOL success)
1004{
1005BOOL add_topaddr = TRUE;
1006address_item *topaddr;
1007
1008/* Find the ultimate parent */
1009
1010for (topaddr = addr; topaddr->parent; topaddr = topaddr->parent) ;
1011
1012/* We start with just the local part for pipe, file, and reply deliveries, and
1013for successful local deliveries from routers that have the log_as_local flag
1014set. File deliveries from filters can be specified as non-absolute paths in
4c04137d 1015cases where the transport is going to complete the path. If there is an error
5dac72a7
JH
1016before this happens (expansion failure) the local part will not be updated, and
1017so won't necessarily look like a path. Add extra text for this case. */
1018
1019if ( testflag(addr, af_pfr)
1020 || ( success
1021 && addr->router && addr->router->log_as_local
1022 && addr->transport && addr->transport->info->local
1023 ) )
1024 {
1025 if (testflag(addr, af_file) && addr->local_part[0] != '/')
acec9514
JH
1026 g = string_catn(g, CUS"save ", 5);
1027 g = string_get_localpart(addr, g);
5dac72a7
JH
1028 }
1029
1030/* Other deliveries start with the full address. It we have split it into local
1031part and domain, use those fields. Some early failures can happen before the
1032splitting is done; in those cases use the original field. */
1033
1034else
1035 {
f3ebb786
JH
1036 uschar * cmp;
1037 int off = g->ptr; /* start of the "full address" */
5dac72a7
JH
1038
1039 if (addr->local_part)
1040 {
1041 const uschar * s;
acec9514
JH
1042 g = string_get_localpart(addr, g);
1043 g = string_catn(g, US"@", 1);
5dac72a7
JH
1044 s = addr->domain;
1045#ifdef SUPPORT_I18N
1046 if (testflag(addr, af_utf8_downcvt))
1047 s = string_localpart_utf8_to_alabel(s, NULL);
1048#endif
acec9514 1049 g = string_cat(g, s);
5dac72a7
JH
1050 }
1051 else
acec9514 1052 g = string_cat(g, addr->address);
5dac72a7
JH
1053
1054 /* If the address we are going to print is the same as the top address,
1055 and all parents are not being included, don't add on the top address. First
1056 of all, do a caseless comparison; if this succeeds, do a caseful comparison
1057 on the local parts. */
1058
f3ebb786 1059 cmp = g->s + off; /* only now, as rebuffer likely done */
306c6c77 1060 string_from_gstring(g); /* ensure nul-terminated */
5dac72a7
JH
1061 if ( strcmpic(cmp, topaddr->address) == 0
1062 && Ustrncmp(cmp, topaddr->address, Ustrchr(cmp, '@') - cmp) == 0
1063 && !addr->onetime_parent
1064 && (!all_parents || !addr->parent || addr->parent == topaddr)
1065 )
1066 add_topaddr = FALSE;
1067 }
1068
1069/* If all parents are requested, or this is a local pipe/file/reply, and
1070there is at least one intermediate parent, show it in brackets, and continue
1071with all of them if all are wanted. */
1072
1073if ( (all_parents || testflag(addr, af_pfr))
1074 && addr->parent
1075 && addr->parent != topaddr)
1076 {
1077 uschar *s = US" (";
d7978c0f 1078 for (address_item * addr2 = addr->parent; addr2 != topaddr; addr2 = addr2->parent)
5dac72a7 1079 {
acec9514
JH
1080 g = string_catn(g, s, 2);
1081 g = string_cat (g, addr2->address);
5dac72a7
JH
1082 if (!all_parents) break;
1083 s = US", ";
1084 }
acec9514 1085 g = string_catn(g, US")", 1);
5dac72a7
JH
1086 }
1087
1088/* Add the top address if it is required */
1089
1090if (add_topaddr)
acec9514 1091 g = string_append(g, 3,
5dac72a7
JH
1092 US" <",
1093 addr->onetime_parent ? addr->onetime_parent : topaddr->address,
1094 US">");
1095
acec9514 1096return g;
5dac72a7
JH
1097}
1098
1099
32dfdf8b 1100
5dac72a7
JH
1101/******************************************************************************/
1102
1103
1104
817d9f57 1105/* If msg is NULL this is a delivery log and logchar is used. Otherwise
67d81c10 1106this is a nonstandard call; no two-character delivery flag is written
817d9f57
JH
1107but sender-host and sender are prefixed and "msg" is inserted in the log line.
1108
1109Arguments:
1110 flags passed to log_write()
1111*/
e4bdf652 1112void
817d9f57 1113delivery_log(int flags, address_item * addr, int logchar, uschar * msg)
e4bdf652 1114{
acec9514 1115gstring * g; /* Used for a temporary, expanding buffer, for building log lines */
f3ebb786 1116rmark reset_point;
e4bdf652 1117
e4bdf652
JH
1118/* Log the delivery on the main log. We use an extensible string to build up
1119the log line, and reset the store afterwards. Remote deliveries should always
1120have a pointer to the host item that succeeded; local deliveries can have a
1121pointer to a single host item in their host list, for use by the transport. */
1122
0cbf2b82 1123#ifndef DISABLE_EVENT
a7538db1 1124 /* presume no successful remote delivery */
783b385f 1125 lookup_dnssec_authenticated = NULL;
d68218c7
JH
1126#endif
1127
f3ebb786
JH
1128reset_point = store_mark();
1129g = string_get_tainted(256, TRUE); /* addrs will be tainted, so avoid copy */
e4bdf652 1130
817d9f57 1131if (msg)
acec9514 1132 g = string_append(g, 2, host_and_ident(TRUE), US" ");
817d9f57
JH
1133else
1134 {
acec9514
JH
1135 g->s[0] = logchar; g->ptr = 1;
1136 g = string_catn(g, US"> ", 2);
817d9f57 1137 }
acec9514 1138g = string_log_address(g, addr, LOGGING(all_parents), TRUE);
e4bdf652 1139
6c6d6e48 1140if (LOGGING(sender_on_delivery) || msg)
acec9514 1141 g = string_append(g, 3, US" F=<",
8c5d388a 1142#ifdef SUPPORT_I18N
3c8b3577
JH
1143 testflag(addr, af_utf8_downcvt)
1144 ? string_address_utf8_to_alabel(sender_address, NULL)
1145 :
1146#endif
1147 sender_address,
1148 US">");
e4bdf652 1149
afa6d3ad 1150if (*queue_name)
acec9514 1151 g = string_append(g, 2, US" Q=", queue_name);
afa6d3ad 1152
e4bdf652 1153#ifdef EXPERIMENTAL_SRS
d43cbe25 1154if(addr->prop.srs_sender)
acec9514 1155 g = string_append(g, 3, US" SRS=<", addr->prop.srs_sender, US">");
e4bdf652
JH
1156#endif
1157
1158/* You might think that the return path must always be set for a successful
1159delivery; indeed, I did for some time, until this statement crashed. The case
1160when it is not set is for a delivery to /dev/null which is optimised by not
1161being run at all. */
1162
d6c82d7b 1163if (used_return_path && LOGGING(return_path_on_delivery))
acec9514 1164 g = string_append(g, 3, US" P=<", used_return_path, US">");
e4bdf652 1165
817d9f57 1166if (msg)
acec9514 1167 g = string_append(g, 2, US" ", msg);
e4bdf652 1168
817d9f57 1169/* For a delivery from a system filter, there may not be a router */
d6c82d7b 1170if (addr->router)
acec9514 1171 g = string_append(g, 2, US" R=", addr->router->name);
e4bdf652 1172
acec9514 1173g = string_append(g, 2, US" T=", addr->transport->name);
e4bdf652 1174
6c6d6e48 1175if (LOGGING(delivery_size))
d12746bc 1176 g = string_fmt_append(g, " S=%d", transport_count);
e4bdf652
JH
1177
1178/* Local delivery */
1179
1180if (addr->transport->info->local)
1181 {
a7538db1 1182 if (addr->host_list)
acec9514
JH
1183 g = string_append(g, 2, US" H=", addr->host_list->name);
1184 g = d_log_interface(g);
d6c82d7b 1185 if (addr->shadow_message)
acec9514 1186 g = string_cat(g, addr->shadow_message);
e4bdf652
JH
1187 }
1188
1189/* Remote delivery */
1190
1191else
1192 {
783b385f 1193 if (addr->host_used)
e4bdf652 1194 {
acec9514 1195 g = d_hostlog(g, addr);
e4bdf652 1196 if (continue_sequence > 1)
acec9514 1197 g = string_catn(g, US"*", 1);
d68218c7 1198
0cbf2b82 1199#ifndef DISABLE_EVENT
a7538db1
JH
1200 deliver_host_address = addr->host_used->address;
1201 deliver_host_port = addr->host_used->port;
029f4192 1202 deliver_host = addr->host_used->name;
783b385f
JH
1203
1204 /* DNS lookup status */
1205 lookup_dnssec_authenticated = addr->host_used->dnssec==DS_YES ? US"yes"
1206 : addr->host_used->dnssec==DS_NO ? US"no"
1207 : NULL;
a7538db1 1208#endif
e4bdf652
JH
1209 }
1210
01603eec 1211#ifndef DISABLE_TLS
acec9514 1212 g = d_tlslog(g, addr);
a7538db1 1213#endif
e4bdf652 1214
018c60d7 1215 if (addr->authenticator)
6f123593 1216 {
acec9514 1217 g = string_append(g, 2, US" A=", addr->authenticator);
018c60d7 1218 if (addr->auth_id)
c8e2fc1e 1219 {
acec9514 1220 g = string_append(g, 2, US":", addr->auth_id);
6c6d6e48 1221 if (LOGGING(smtp_mailauth) && addr->auth_sndr)
acec9514 1222 g = string_append(g, 2, US":", addr->auth_sndr);
c8e2fc1e 1223 }
6f123593
JH
1224 }
1225
ee8b8090
JH
1226 if (LOGGING(pipelining))
1227 {
1228 if (testflag(addr, af_pipelining))
1229 g = string_catn(g, US" L", 2);
81344b40 1230#ifndef DISABLE_PIPE_CONNECT
ee8b8090
JH
1231 if (testflag(addr, af_early_pipe))
1232 g = string_catn(g, US"*", 1);
1233#endif
1234 }
7c576fca 1235
a7538db1 1236#ifndef DISABLE_PRDR
7eb0e5d2 1237 if (testflag(addr, af_prdr_used))
acec9514 1238 g = string_catn(g, US" PRDR", 5);
a7538db1 1239#endif
e0cc6cda 1240
7eb0e5d2 1241 if (testflag(addr, af_chunking_used))
acec9514 1242 g = string_catn(g, US" K", 2);
76f44207
WB
1243 }
1244
1245/* confirmation message (SMTP (host_used) and LMTP (driver_name)) */
fd98a5c6 1246
d6c82d7b
JH
1247if ( LOGGING(smtp_confirmation)
1248 && addr->message
1249 && (addr->host_used || Ustrcmp(addr->transport->driver_name, "lmtp") == 0)
1250 )
76f44207 1251 {
1c5b1499 1252 unsigned lim = big_buffer_size < 1024 ? big_buffer_size : 1024;
76f44207
WB
1253 uschar *p = big_buffer;
1254 uschar *ss = addr->message;
1255 *p++ = '\"';
d7978c0f 1256 for (int i = 0; i < lim && ss[i] != 0; i++) /* limit logged amount */
e4bdf652 1257 {
27520a68 1258 if (ss[i] == '\"' || ss[i] == '\\') *p++ = '\\'; /* quote \ and " */
76f44207 1259 *p++ = ss[i];
e4bdf652 1260 }
76f44207
WB
1261 *p++ = '\"';
1262 *p = 0;
acec9514 1263 g = string_append(g, 2, US" C=", big_buffer);
e4bdf652
JH
1264 }
1265
1266/* Time on queue and actual time taken to deliver */
1267
6c6d6e48 1268if (LOGGING(queue_time))
acec9514 1269 g = string_append(g, 2, US" QT=",
32dfdf8b 1270 string_timesince(&received_time));
e4bdf652 1271
6c6d6e48 1272if (LOGGING(deliver_time))
a55697ac 1273 g = string_append(g, 2, US" DT=", string_timediff(&addr->delivery_time));
e4bdf652
JH
1274
1275/* string_cat() always leaves room for the terminator. Release the
1276store we used to build the line after writing it. */
1277
acec9514 1278log_write(0, flags, "%s", string_from_gstring(g));
d68218c7 1279
0cbf2b82 1280#ifndef DISABLE_EVENT
774ef2d7 1281if (!msg) msg_event_raise(US"msg:delivery", addr);
d68218c7 1282#endif
14a465c3 1283
e4bdf652
JH
1284store_reset(reset_point);
1285return;
1286}
1287
1288
1289
5dac72a7
JH
1290static void
1291deferral_log(address_item * addr, uschar * now,
1292 int logflags, uschar * driver_name, uschar * driver_kind)
1293{
f3ebb786
JH
1294rmark reset_point = store_mark();
1295gstring * g = string_get(256);
5dac72a7
JH
1296
1297/* Build up the line that is used for both the message log and the main
1298log. */
1299
5dac72a7
JH
1300/* Create the address string for logging. Must not do this earlier, because
1301an OK result may be changed to FAIL when a pipe returns text. */
1302
acec9514 1303g = string_log_address(g, addr, LOGGING(all_parents), FALSE);
5dac72a7
JH
1304
1305if (*queue_name)
acec9514 1306 g = string_append(g, 2, US" Q=", queue_name);
5dac72a7
JH
1307
1308/* Either driver_name contains something and driver_kind contains
1309" router" or " transport" (note the leading space), or driver_name is
1310a null string and driver_kind contains "routing" without the leading
1311space, if all routing has been deferred. When a domain has been held,
1312so nothing has been done at all, both variables contain null strings. */
1313
1314if (driver_name)
1315 {
1316 if (driver_kind[1] == 't' && addr->router)
acec9514 1317 g = string_append(g, 2, US" R=", addr->router->name);
d12746bc 1318 g = string_fmt_append(g, " %c=%s", toupper(driver_kind[1]), driver_name);
5dac72a7
JH
1319 }
1320else if (driver_kind)
acec9514 1321 g = string_append(g, 2, US" ", driver_kind);
5dac72a7 1322
d12746bc 1323g = string_fmt_append(g, " defer (%d)", addr->basic_errno);
5dac72a7
JH
1324
1325if (addr->basic_errno > 0)
acec9514 1326 g = string_append(g, 2, US": ",
5dac72a7
JH
1327 US strerror(addr->basic_errno));
1328
1329if (addr->host_used)
1330 {
acec9514 1331 g = string_append(g, 5,
5dac72a7
JH
1332 US" H=", addr->host_used->name,
1333 US" [", addr->host_used->address, US"]");
1334 if (LOGGING(outgoing_port))
1335 {
1336 int port = addr->host_used->port;
d12746bc 1337 g = string_fmt_append(g, ":%d", port == PORT_NONE ? 25 : port);
5dac72a7
JH
1338 }
1339 }
1340
a55697ac
JH
1341if (LOGGING(deliver_time))
1342 g = string_append(g, 2, US" DT=", string_timediff(&addr->delivery_time));
1343
5dac72a7 1344if (addr->message)
acec9514 1345 g = string_append(g, 2, US": ", addr->message);
5dac72a7 1346
acec9514 1347(void) string_from_gstring(g);
5dac72a7
JH
1348
1349/* Log the deferment in the message log, but don't clutter it
1350up with retry-time defers after the first delivery attempt. */
1351
8768d548 1352if (f.deliver_firsttime || addr->basic_errno > ERRNO_RETRY_BASE)
acec9514 1353 deliver_msglog("%s %s\n", now, g->s);
5dac72a7
JH
1354
1355/* Write the main log and reset the store.
1356For errors of the type "retry time not reached" (also remotes skipped
1357on queue run), logging is controlled by L_retry_defer. Note that this kind
1358of error number is negative, and all the retry ones are less than any
1359others. */
1360
1361
1362log_write(addr->basic_errno <= ERRNO_RETRY_BASE ? L_retry_defer : 0, logflags,
acec9514 1363 "== %s", g->s);
5dac72a7
JH
1364
1365store_reset(reset_point);
1366return;
1367}
1368
1369
1370
1371static void
1372failure_log(address_item * addr, uschar * driver_kind, uschar * now)
1373{
f3ebb786
JH
1374rmark reset_point = store_mark();
1375gstring * g = string_get(256);
5dac72a7 1376
ffbc20ed
MK
1377#ifndef DISABLE_EVENT
1378/* Message failures for which we will send a DSN get their event raised
1379later so avoid doing it here. */
1380
1381if ( !addr->prop.ignore_error
1382 && !(addr->dsn_flags & (rf_dsnflags & ~rf_notify_failure))
1383 )
1384 msg_event_raise(US"msg:fail:delivery", addr);
1385#endif
1386
5dac72a7
JH
1387/* Build up the log line for the message and main logs */
1388
5dac72a7
JH
1389/* Create the address string for logging. Must not do this earlier, because
1390an OK result may be changed to FAIL when a pipe returns text. */
1391
acec9514 1392g = string_log_address(g, addr, LOGGING(all_parents), FALSE);
5dac72a7
JH
1393
1394if (LOGGING(sender_on_delivery))
acec9514 1395 g = string_append(g, 3, US" F=<", sender_address, US">");
5dac72a7
JH
1396
1397if (*queue_name)
acec9514 1398 g = string_append(g, 2, US" Q=", queue_name);
5dac72a7
JH
1399
1400/* Return path may not be set if no delivery actually happened */
1401
1402if (used_return_path && LOGGING(return_path_on_delivery))
acec9514 1403 g = string_append(g, 3, US" P=<", used_return_path, US">");
5dac72a7
JH
1404
1405if (addr->router)
acec9514 1406 g = string_append(g, 2, US" R=", addr->router->name);
5dac72a7 1407if (addr->transport)
acec9514 1408 g = string_append(g, 2, US" T=", addr->transport->name);
5dac72a7
JH
1409
1410if (addr->host_used)
acec9514 1411 g = d_hostlog(g, addr);
5dac72a7 1412
01603eec 1413#ifndef DISABLE_TLS
acec9514 1414g = d_tlslog(g, addr);
5dac72a7
JH
1415#endif
1416
1417if (addr->basic_errno > 0)
acec9514 1418 g = string_append(g, 2, US": ", US strerror(addr->basic_errno));
5dac72a7
JH
1419
1420if (addr->message)
acec9514 1421 g = string_append(g, 2, US": ", addr->message);
5dac72a7 1422
a55697ac
JH
1423if (LOGGING(deliver_time))
1424 g = string_append(g, 2, US" DT=", string_timediff(&addr->delivery_time));
1425
acec9514 1426(void) string_from_gstring(g);
5dac72a7
JH
1427
1428/* Do the logging. For the message log, "routing failed" for those cases,
1429just to make it clearer. */
1430
1431if (driver_kind)
acec9514 1432 deliver_msglog("%s %s failed for %s\n", now, driver_kind, g->s);
5dac72a7 1433else
acec9514 1434 deliver_msglog("%s %s\n", now, g->s);
5dac72a7 1435
acec9514 1436log_write(0, LOG_MAIN, "** %s", g->s);
5dac72a7 1437
5dac72a7
JH
1438store_reset(reset_point);
1439return;
1440}
1441
1442
1443
059ec3d9
PH
1444/*************************************************
1445* Actions at the end of handling an address *
1446*************************************************/
1447
1448/* This is a function for processing a single address when all that can be done
1449with it has been done.
1450
1451Arguments:
1452 addr points to the address block
1453 result the result of the delivery attempt
1454 logflags flags for log_write() (LOG_MAIN and/or LOG_PANIC)
1455 driver_type indicates which type of driver (transport, or router) was last
1456 to process the address
1457 logchar '=' or '-' for use when logging deliveries with => or ->
1458
1459Returns: nothing
1460*/
1461
1462static void
1463post_process_one(address_item *addr, int result, int logflags, int driver_type,
1464 int logchar)
1465{
1466uschar *now = tod_stamp(tod_log);
1467uschar *driver_kind = NULL;
1468uschar *driver_name = NULL;
059ec3d9 1469
059ec3d9
PH
1470DEBUG(D_deliver) debug_printf("post-process %s (%d)\n", addr->address, result);
1471
1472/* Set up driver kind and name for logging. Disable logging if the router or
1473transport has disabled it. */
1474
ba936fb8 1475if (driver_type == EXIM_DTYPE_TRANSPORT)
059ec3d9 1476 {
d6c82d7b 1477 if (addr->transport)
059ec3d9
PH
1478 {
1479 driver_name = addr->transport->name;
1480 driver_kind = US" transport";
8768d548 1481 f.disable_logging = addr->transport->disable_logging;
059ec3d9
PH
1482 }
1483 else driver_kind = US"transporting";
1484 }
ba936fb8 1485else if (driver_type == EXIM_DTYPE_ROUTER)
059ec3d9 1486 {
d6c82d7b 1487 if (addr->router)
059ec3d9
PH
1488 {
1489 driver_name = addr->router->name;
1490 driver_kind = US" router";
8768d548 1491 f.disable_logging = addr->router->disable_logging;
059ec3d9
PH
1492 }
1493 else driver_kind = US"routing";
1494 }
1495
1496/* If there's an error message set, ensure that it contains only printing
1497characters - it should, but occasionally things slip in and this at least
49c2d5ea
PH
1498stops the log format from getting wrecked. We also scan the message for an LDAP
1499expansion item that has a password setting, and flatten the password. This is a
1500fudge, but I don't know a cleaner way of doing this. (If the item is badly
1501malformed, it won't ever have gone near LDAP.) */
059ec3d9 1502
d6c82d7b 1503if (addr->message)
49c2d5ea 1504 {
55414b25 1505 const uschar * s = string_printing(addr->message);
f42deca9
JH
1506
1507 /* deconst cast ok as string_printing known to have alloc'n'copied */
1508 addr->message = expand_hide_passwords(US s);
49c2d5ea 1509 }
059ec3d9
PH
1510
1511/* If we used a transport that has one of the "return_output" options set, and
1512if it did in fact generate some output, then for return_output we treat the
1513message as failed if it was not already set that way, so that the output gets
1514returned to the sender, provided there is a sender to send it to. For
1515return_fail_output, do this only if the delivery failed. Otherwise we just
1516unlink the file, and remove the name so that if the delivery failed, we don't
1517try to send back an empty or unwanted file. The log_output options operate only
1518on a non-empty file.
1519
1520In any case, we close the message file, because we cannot afford to leave a
1521file-descriptor for one address while processing (maybe very many) others. */
1522
d6c82d7b 1523if (addr->return_file >= 0 && addr->return_filename)
059ec3d9
PH
1524 {
1525 BOOL return_output = FALSE;
1526 struct stat statbuf;
54fc8428 1527 (void)EXIMfsync(addr->return_file);
059ec3d9
PH
1528
1529 /* If there is no output, do nothing. */
1530
1531 if (fstat(addr->return_file, &statbuf) == 0 && statbuf.st_size > 0)
1532 {
1533 transport_instance *tb = addr->transport;
1534
1535 /* Handle logging options */
1536
d6c82d7b
JH
1537 if ( tb->log_output
1538 || result == FAIL && tb->log_fail_output
1539 || result == DEFER && tb->log_defer_output
1540 )
059ec3d9
PH
1541 {
1542 uschar *s;
1543 FILE *f = Ufopen(addr->return_filename, "rb");
d6c82d7b 1544 if (!f)
059ec3d9
PH
1545 log_write(0, LOG_MAIN|LOG_PANIC, "failed to open %s to log output "
1546 "from %s transport: %s", addr->return_filename, tb->name,
1547 strerror(errno));
1548 else
d6c82d7b 1549 if ((s = US Ufgets(big_buffer, big_buffer_size, f)))
059ec3d9
PH
1550 {
1551 uschar *p = big_buffer + Ustrlen(big_buffer);
55414b25 1552 const uschar * sp;
059ec3d9
PH
1553 while (p > big_buffer && isspace(p[-1])) p--;
1554 *p = 0;
55414b25 1555 sp = string_printing(big_buffer);
059ec3d9 1556 log_write(0, LOG_MAIN, "<%s>: %s transport output: %s",
55414b25 1557 addr->address, tb->name, sp);
059ec3d9 1558 }
0e8aed8a 1559 (void)fclose(f);
059ec3d9
PH
1560 }
1561
1562 /* Handle returning options, but only if there is an address to return
1563 the text to. */
1564
d6c82d7b 1565 if (sender_address[0] != 0 || addr->prop.errors_address)
059ec3d9
PH
1566 if (tb->return_output)
1567 {
1568 addr->transport_return = result = FAIL;
d6c82d7b 1569 if (addr->basic_errno == 0 && !addr->message)
059ec3d9
PH
1570 addr->message = US"return message generated";
1571 return_output = TRUE;
1572 }
1573 else
1574 if (tb->return_fail_output && result == FAIL) return_output = TRUE;
059ec3d9
PH
1575 }
1576
1577 /* Get rid of the file unless it might be returned, but close it in
1578 all cases. */
1579
1580 if (!return_output)
1581 {
1582 Uunlink(addr->return_filename);
1583 addr->return_filename = NULL;
1584 addr->return_file = -1;
1585 }
1586
f1e894f3 1587 (void)close(addr->return_file);
059ec3d9
PH
1588 }
1589
9d1c15ef 1590/* The success case happens only after delivery by a transport. */
059ec3d9
PH
1591
1592if (result == OK)
1593 {
1594 addr->next = addr_succeed;
1595 addr_succeed = addr;
1596
1597 /* Call address_done() to ensure that we don't deliver to this address again,
1598 and write appropriate things to the message log. If it is a child address, we
1599 call child_done() to scan the ancestors and mark them complete if this is the
1600 last child to complete. */
1601
1602 address_done(addr, now);
1603 DEBUG(D_deliver) debug_printf("%s delivered\n", addr->address);
1604
d6c82d7b 1605 if (!addr->parent)
059ec3d9
PH
1606 deliver_msglog("%s %s: %s%s succeeded\n", now, addr->address,
1607 driver_name, driver_kind);
059ec3d9
PH
1608 else
1609 {
1610 deliver_msglog("%s %s <%s>: %s%s succeeded\n", now, addr->address,
1611 addr->parent->address, driver_name, driver_kind);
1612 child_done(addr, now);
1613 }
1614
774ef2d7 1615 /* Certificates for logging (via events) */
01603eec 1616#ifndef DISABLE_TLS
9d1c15ef
JH
1617 tls_out.ourcert = addr->ourcert;
1618 addr->ourcert = NULL;
1619 tls_out.peercert = addr->peercert;
1620 addr->peercert = NULL;
018058b2 1621
da40b1ec 1622 tls_out.ver = addr->tlsver;
018058b2
JH
1623 tls_out.cipher = addr->cipher;
1624 tls_out.peerdn = addr->peerdn;
1625 tls_out.ocsp = addr->ocsp;
c0635b6d 1626# ifdef SUPPORT_DANE
83b27293
JH
1627 tls_out.dane_verified = testflag(addr, af_dane_verified);
1628# endif
a7538db1 1629#endif
9d1c15ef 1630
817d9f57 1631 delivery_log(LOG_MAIN, addr, logchar, NULL);
9d1c15ef 1632
01603eec 1633#ifndef DISABLE_TLS
790fbb71
JH
1634 tls_free_cert(&tls_out.ourcert);
1635 tls_free_cert(&tls_out.peercert);
da40b1ec 1636 tls_out.ver = NULL;
018058b2
JH
1637 tls_out.cipher = NULL;
1638 tls_out.peerdn = NULL;
1639 tls_out.ocsp = OCSP_NOT_REQ;
c0635b6d 1640# ifdef SUPPORT_DANE
83b27293
JH
1641 tls_out.dane_verified = FALSE;
1642# endif
a7538db1 1643#endif
059ec3d9
PH
1644 }
1645
1646
1647/* Soft failure, or local delivery process failed; freezing may be
1648requested. */
1649
1650else if (result == DEFER || result == PANIC)
1651 {
1652 if (result == PANIC) logflags |= LOG_PANIC;
1653
1654 /* This puts them on the chain in reverse order. Do not change this, because
1655 the code for handling retries assumes that the one with the retry
1656 information is last. */
1657
1658 addr->next = addr_defer;
1659 addr_defer = addr;
1660
1661 /* The only currently implemented special action is to freeze the
1662 message. Logging of this is done later, just before the -H file is
1663 updated. */
1664
1665 if (addr->special_action == SPECIAL_FREEZE)
1666 {
8768d548 1667 f.deliver_freeze = TRUE;
059ec3d9
PH
1668 deliver_frozen_at = time(NULL);
1669 update_spool = TRUE;
1670 }
1671
1672 /* If doing a 2-stage queue run, we skip writing to either the message
1673 log or the main log for SMTP defers. */
1674
8768d548 1675 if (!f.queue_2stage || addr->basic_errno != 0)
5dac72a7 1676 deferral_log(addr, now, logflags, driver_name, driver_kind);
059ec3d9
PH
1677 }
1678
1679
1680/* Hard failure. If there is an address to which an error message can be sent,
1681put this address on the failed list. If not, put it on the deferred list and
1682freeze the mail message for human attention. The latter action can also be
1683explicitly requested by a router or transport. */
1684
1685else
1686 {
1687 /* If this is a delivery error, or a message for which no replies are
1688 wanted, and the message's age is greater than ignore_bounce_errors_after,
1689 force the af_ignore_error flag. This will cause the address to be discarded
1690 later (with a log entry). */
1691
10c50704 1692 if (!*sender_address && message_age >= ignore_bounce_errors_after)
7eb0e5d2 1693 addr->prop.ignore_error = TRUE;
059ec3d9
PH
1694
1695 /* Freeze the message if requested, or if this is a bounce message (or other
652e1b65
PH
1696 message with null sender) and this address does not have its own errors
1697 address. However, don't freeze if errors are being ignored. The actual code
1698 to ignore occurs later, instead of sending a message. Logging of freezing
1699 occurs later, just before writing the -H file. */
059ec3d9 1700
7eb0e5d2 1701 if ( !addr->prop.ignore_error
d6c82d7b
JH
1702 && ( addr->special_action == SPECIAL_FREEZE
1703 || (sender_address[0] == 0 && !addr->prop.errors_address)
1704 ) )
059ec3d9 1705 {
d6c82d7b
JH
1706 frozen_info = addr->special_action == SPECIAL_FREEZE
1707 ? US""
8768d548 1708 : f.sender_local && !f.local_error_message
d6c82d7b
JH
1709 ? US" (message created with -f <>)"
1710 : US" (delivery error message)";
8768d548 1711 f.deliver_freeze = TRUE;
059ec3d9
PH
1712 deliver_frozen_at = time(NULL);
1713 update_spool = TRUE;
1714
1715 /* The address is put on the defer rather than the failed queue, because
1716 the message is being retained. */
1717
1718 addr->next = addr_defer;
1719 addr_defer = addr;
1720 }
1721
1722 /* Don't put the address on the nonrecipients tree yet; wait until an
1723 error message has been successfully sent. */
1724
1725 else
1726 {
1727 addr->next = addr_failed;
1728 addr_failed = addr;
1729 }
1730
5dac72a7 1731 failure_log(addr, driver_name ? NULL : driver_kind, now);
059ec3d9
PH
1732 }
1733
1734/* Ensure logging is turned on again in all cases */
1735
8768d548 1736f.disable_logging = FALSE;
059ec3d9
PH
1737}
1738
1739
1740
1741
1742/*************************************************
1743* Address-independent error *
1744*************************************************/
1745
1746/* This function is called when there's an error that is not dependent on a
1747particular address, such as an expansion string failure. It puts the error into
1748all the addresses in a batch, logs the incident on the main and panic logs, and
1749clears the expansions. It is mostly called from local_deliver(), but can be
1750called for a remote delivery via findugid().
1751
1752Arguments:
1753 logit TRUE if (MAIN+PANIC) logging required
1754 addr the first of the chain of addresses
1755 code the error code
1756 format format string for error message, or NULL if already set in addr
1757 ... arguments for the format
1758
1759Returns: nothing
1760*/
1761
1762static void
1763common_error(BOOL logit, address_item *addr, int code, uschar *format, ...)
1764{
059ec3d9
PH
1765addr->basic_errno = code;
1766
d6c82d7b 1767if (format)
059ec3d9
PH
1768 {
1769 va_list ap;
d12746bc
JH
1770 gstring * g;
1771
059ec3d9 1772 va_start(ap, format);
f3ebb786 1773 g = string_vformat(NULL, SVFMT_EXTEND|SVFMT_REBUFFER, CS format, ap);
059ec3d9 1774 va_end(ap);
d12746bc 1775 addr->message = string_from_gstring(g);
059ec3d9
PH
1776 }
1777
d7978c0f 1778for (address_item * addr2 = addr->next; addr2; addr2 = addr2->next)
059ec3d9
PH
1779 {
1780 addr2->basic_errno = code;
1781 addr2->message = addr->message;
1782 }
1783
1784if (logit) log_write(0, LOG_MAIN|LOG_PANIC, "%s", addr->message);
1785deliver_set_expansions(NULL);
1786}
1787
1788
1789
1790
1791/*************************************************
1792* Check a "never users" list *
1793*************************************************/
1794
1795/* This function is called to check whether a uid is on one of the two "never
1796users" lists.
1797
1798Arguments:
1799 uid the uid to be checked
1800 nusers the list to be scanned; the first item in the list is the count
1801
1802Returns: TRUE if the uid is on the list
1803*/
1804
1805static BOOL
1806check_never_users(uid_t uid, uid_t *nusers)
1807{
d6c82d7b 1808if (!nusers) return FALSE;
d7978c0f 1809for (int i = 1; i <= (int)(nusers[0]); i++) if (nusers[i] == uid) return TRUE;
059ec3d9
PH
1810return FALSE;
1811}
1812
1813
1814
1815/*************************************************
1816* Find uid and gid for a transport *
1817*************************************************/
1818
1819/* This function is called for both local and remote deliveries, to find the
1820uid/gid under which to run the delivery. The values are taken preferentially
1821from the transport (either explicit or deliver_as_creator), then from the
1822address (i.e. the router), and if nothing is set, the exim uid/gid are used. If
1823the resulting uid is on the "never_users" or the "fixed_never_users" list, a
1824panic error is logged, and the function fails (which normally leads to delivery
1825deferral).
1826
1827Arguments:
1828 addr the address (possibly a chain)
1829 tp the transport
1830 uidp pointer to uid field
1831 gidp pointer to gid field
1832 igfp pointer to the use_initgroups field
1833
1834Returns: FALSE if failed - error has been set in address(es)
1835*/
1836
1837static BOOL
1838findugid(address_item *addr, transport_instance *tp, uid_t *uidp, gid_t *gidp,
1839 BOOL *igfp)
1840{
d6c82d7b 1841uschar *nuname;
059ec3d9
PH
1842BOOL gid_set = FALSE;
1843
1844/* Default initgroups flag comes from the transport */
1845
1846*igfp = tp->initgroups;
1847
1848/* First see if there's a gid on the transport, either fixed or expandable.
1849The expanding function always logs failure itself. */
1850
1851if (tp->gid_set)
1852 {
1853 *gidp = tp->gid;
1854 gid_set = TRUE;
1855 }
d6c82d7b 1856else if (tp->expand_gid)
059ec3d9 1857 {
d6c82d7b
JH
1858 if (!route_find_expanded_group(tp->expand_gid, tp->name, US"transport", gidp,
1859 &(addr->message)))
059ec3d9
PH
1860 {
1861 common_error(FALSE, addr, ERRNO_GIDFAIL, NULL);
1862 return FALSE;
1863 }
d6c82d7b 1864 gid_set = TRUE;
059ec3d9
PH
1865 }
1866
911f6fde
PH
1867/* If the transport did not set a group, see if the router did. */
1868
1869if (!gid_set && testflag(addr, af_gid_set))
1870 {
1871 *gidp = addr->gid;
1872 gid_set = TRUE;
1873 }
1874
059ec3d9
PH
1875/* Pick up a uid from the transport if one is set. */
1876
1877if (tp->uid_set) *uidp = tp->uid;
1878
1879/* Otherwise, try for an expandable uid field. If it ends up as a numeric id,
1880it does not provide a passwd value from which a gid can be taken. */
1881
d6c82d7b 1882else if (tp->expand_uid)
059ec3d9
PH
1883 {
1884 struct passwd *pw;
1885 if (!route_find_expanded_user(tp->expand_uid, tp->name, US"transport", &pw,
1886 uidp, &(addr->message)))
1887 {
1888 common_error(FALSE, addr, ERRNO_UIDFAIL, NULL);
1889 return FALSE;
1890 }
d6c82d7b 1891 if (!gid_set && pw)
059ec3d9
PH
1892 {
1893 *gidp = pw->pw_gid;
1894 gid_set = TRUE;
1895 }
1896 }
1897
1898/* If the transport doesn't set the uid, test the deliver_as_creator flag. */
1899
1900else if (tp->deliver_as_creator)
1901 {
1902 *uidp = originator_uid;
1903 if (!gid_set)
1904 {
1905 *gidp = originator_gid;
1906 gid_set = TRUE;
1907 }
1908 }
1909
911f6fde
PH
1910/* Otherwise see if the address specifies the uid and if so, take it and its
1911initgroups flag. */
059ec3d9
PH
1912
1913else if (testflag(addr, af_uid_set))
1914 {
1915 *uidp = addr->uid;
1916 *igfp = testflag(addr, af_initgroups);
059ec3d9
PH
1917 }
1918
1919/* Nothing has specified the uid - default to the Exim user, and group if the
1920gid is not set. */
1921
1922else
1923 {
1924 *uidp = exim_uid;
1925 if (!gid_set)
1926 {
1927 *gidp = exim_gid;
1928 gid_set = TRUE;
1929 }
1930 }
1931
911f6fde
PH
1932/* If no gid is set, it is a disaster. We default to the Exim gid only if
1933defaulting to the Exim uid. In other words, if the configuration has specified
1934a uid, it must also provide a gid. */
059ec3d9
PH
1935
1936if (!gid_set)
1937 {
1938 common_error(TRUE, addr, ERRNO_GIDFAIL, US"User set without group for "
1939 "%s transport", tp->name);
1940 return FALSE;
1941 }
1942
1943/* Check that the uid is not on the lists of banned uids that may not be used
1944for delivery processes. */
1945
d6c82d7b
JH
1946nuname = check_never_users(*uidp, never_users)
1947 ? US"never_users"
1948 : check_never_users(*uidp, fixed_never_users)
1949 ? US"fixed_never_users"
1950 : NULL;
1951if (nuname)
059ec3d9
PH
1952 {
1953 common_error(TRUE, addr, ERRNO_UIDFAIL, US"User %ld set for %s transport "
1954 "is on the %s list", (long int)(*uidp), tp->name, nuname);
1955 return FALSE;
1956 }
1957
1958/* All is well */
1959
1960return TRUE;
1961}
1962
1963
1964
1965
1966/*************************************************
1967* Check the size of a message for a transport *
1968*************************************************/
1969
1970/* Checks that the message isn't too big for the selected transport.
1971This is called only when it is known that the limit is set.
1972
1973Arguments:
1974 tp the transport
1975 addr the (first) address being delivered
1976
1977Returns: OK
1978 DEFER expansion failed or did not yield an integer
1979 FAIL message too big
1980*/
1981
1982int
1983check_message_size(transport_instance *tp, address_item *addr)
1984{
1985int rc = OK;
1986int size_limit;
1987
1988deliver_set_expansions(addr);
d45b1de8 1989size_limit = expand_string_integer(tp->message_size_limit, TRUE);
059ec3d9
PH
1990deliver_set_expansions(NULL);
1991
d6c82d7b 1992if (expand_string_message)
059ec3d9
PH
1993 {
1994 rc = DEFER;
d6c82d7b
JH
1995 addr->message = size_limit == -1
1996 ? string_sprintf("failed to expand message_size_limit "
1997 "in %s transport: %s", tp->name, expand_string_message)
1998 : string_sprintf("invalid message_size_limit "
059ec3d9
PH
1999 "in %s transport: %s", tp->name, expand_string_message);
2000 }
2001else if (size_limit > 0 && message_size > size_limit)
2002 {
2003 rc = FAIL;
2004 addr->message =
2005 string_sprintf("message is too big (transport limit = %d)",
2006 size_limit);
2007 }
2008
2009return rc;
2010}
2011
2012
2013
2014/*************************************************
2015* Transport-time check for a previous delivery *
2016*************************************************/
2017
2018/* Check that this base address hasn't previously been delivered to its routed
c2c19e9d
PH
2019transport. If it has been delivered, mark it done. The check is necessary at
2020delivery time in order to handle homonymic addresses correctly in cases where
2021the pattern of redirection changes between delivery attempts (so the unique
2022fields change). Non-homonymic previous delivery is detected earlier, at routing
2023time (which saves unnecessary routing).
2024
2025Arguments:
2026 addr the address item
2027 testing TRUE if testing wanted only, without side effects
059ec3d9 2028
059ec3d9
PH
2029Returns: TRUE if previously delivered by the transport
2030*/
2031
2032static BOOL
c2c19e9d 2033previously_transported(address_item *addr, BOOL testing)
059ec3d9 2034{
f3ebb786 2035uschar * s = string_sprintf("%s/%s",
059ec3d9
PH
2036 addr->unique + (testflag(addr, af_homonym)? 3:0), addr->transport->name);
2037
f3ebb786 2038if (tree_search(tree_nonrecipients, s) != 0)
059ec3d9
PH
2039 {
2040 DEBUG(D_deliver|D_route|D_transport)
2041 debug_printf("%s was previously delivered (%s transport): discarded\n",
2042 addr->address, addr->transport->name);
c2c19e9d 2043 if (!testing) child_done(addr, tod_stamp(tod_log));
059ec3d9
PH
2044 return TRUE;
2045 }
2046
2047return FALSE;
2048}
2049
2050
2051
064a94c9
PH
2052/******************************************************
2053* Check for a given header in a header string *
2054******************************************************/
2055
2056/* This function is used when generating quota warnings. The configuration may
2057specify any header lines it likes in quota_warn_message. If certain of them are
2058missing, defaults are inserted, so we need to be able to test for the presence
2059of a given header.
2060
2061Arguments:
2062 hdr the required header name
2063 hstring the header string
2064
2065Returns: TRUE the header is in the string
2066 FALSE the header is not in the string
2067*/
2068
2069static BOOL
2070contains_header(uschar *hdr, uschar *hstring)
2071{
2072int len = Ustrlen(hdr);
2073uschar *p = hstring;
2074while (*p != 0)
2075 {
2076 if (strncmpic(p, hdr, len) == 0)
2077 {
2078 p += len;
2079 while (*p == ' ' || *p == '\t') p++;
2080 if (*p == ':') return TRUE;
2081 }
2082 while (*p != 0 && *p != '\n') p++;
2083 if (*p == '\n') p++;
2084 }
2085return FALSE;
2086}
2087
2088
2089
059ec3d9
PH
2090
2091/*************************************************
2092* Perform a local delivery *
2093*************************************************/
2094
2095/* Each local delivery is performed in a separate process which sets its
2096uid and gid as specified. This is a safer way than simply changing and
2097restoring using seteuid(); there is a body of opinion that seteuid() cannot be
2098used safely. From release 4, Exim no longer makes any use of it. Besides, not
2099all systems have seteuid().
2100
2101If the uid/gid are specified in the transport_instance, they are used; the
2102transport initialization must ensure that either both or neither are set.
2103Otherwise, the values associated with the address are used. If neither are set,
2104it is a configuration error.
2105
2106The transport or the address may specify a home directory (transport over-
2107rides), and if they do, this is set as $home. If neither have set a working
2108directory, this value is used for that as well. Otherwise $home is left unset
2109and the cwd is set to "/" - a directory that should be accessible to all users.
2110
2111Using a separate process makes it more complicated to get error information
2112back. We use a pipe to pass the return code and also an error code and error
2113text string back to the parent process.
2114
2115Arguments:
2116 addr points to an address block for this delivery; for "normal" local
2117 deliveries this is the only address to be delivered, but for
2118 pseudo-remote deliveries (e.g. by batch SMTP to a file or pipe)
2119 a number of addresses can be handled simultaneously, and in this
2120 case addr will point to a chain of addresses with the same
2121 characteristics.
2122
2123 shadowing TRUE if running a shadow transport; this causes output from pipes
2124 to be ignored.
2125
2126Returns: nothing
2127*/
2128
2129static void
2130deliver_local(address_item *addr, BOOL shadowing)
2131{
2132BOOL use_initgroups;
2133uid_t uid;
2134gid_t gid;
2135int status, len, rc;
2136int pfd[2];
2137pid_t pid;
2138uschar *working_directory;
2139address_item *addr2;
2140transport_instance *tp = addr->transport;
2141
2142/* Set up the return path from the errors or sender address. If the transport
2143has its own return path setting, expand it and replace the existing value. */
2144
d6c82d7b 2145if(addr->prop.errors_address)
d43cbe25 2146 return_path = addr->prop.errors_address;
384152a6 2147#ifdef EXPERIMENTAL_SRS
d6c82d7b 2148else if (addr->prop.srs_sender)
d43cbe25 2149 return_path = addr->prop.srs_sender;
384152a6
TK
2150#endif
2151else
2152 return_path = sender_address;
059ec3d9 2153
d6c82d7b 2154if (tp->return_path)
059ec3d9
PH
2155 {
2156 uschar *new_return_path = expand_string(tp->return_path);
d6c82d7b 2157 if (!new_return_path)
059ec3d9 2158 {
8768d548 2159 if (!f.expand_string_forcedfail)
059ec3d9
PH
2160 {
2161 common_error(TRUE, addr, ERRNO_EXPANDFAIL,
2162 US"Failed to expand return path \"%s\" in %s transport: %s",
2163 tp->return_path, tp->name, expand_string_message);
2164 return;
2165 }
2166 }
2167 else return_path = new_return_path;
2168 }
2169
2170/* For local deliveries, one at a time, the value used for logging can just be
2171set directly, once and for all. */
2172
2173used_return_path = return_path;
2174
2175/* Sort out the uid, gid, and initgroups flag. If an error occurs, the message
2176gets put into the address(es), and the expansions are unset, so we can just
2177return. */
2178
2179if (!findugid(addr, tp, &uid, &gid, &use_initgroups)) return;
2180
5418e93b
PH
2181/* See if either the transport or the address specifies a home directory. A
2182home directory set in the address may already be expanded; a flag is set to
2183indicate that. In other cases we must expand it. */
059ec3d9 2184
d6c82d7b
JH
2185if ( (deliver_home = tp->home_dir) /* Set in transport, or */
2186 || ( (deliver_home = addr->home_dir) /* Set in address and */
2187 && !testflag(addr, af_home_expanded) /* not expanded */
2188 ) )
059ec3d9
PH
2189 {
2190 uschar *rawhome = deliver_home;
2191 deliver_home = NULL; /* in case it contains $home */
d6c82d7b 2192 if (!(deliver_home = expand_string(rawhome)))
059ec3d9
PH
2193 {
2194 common_error(TRUE, addr, ERRNO_EXPANDFAIL, US"home directory \"%s\" failed "
2195 "to expand for %s transport: %s", rawhome, tp->name,
2196 expand_string_message);
2197 return;
2198 }
2199 if (*deliver_home != '/')
2200 {
2201 common_error(TRUE, addr, ERRNO_NOTABSOLUTE, US"home directory path \"%s\" "
2202 "is not absolute for %s transport", deliver_home, tp->name);
2203 return;
2204 }
2205 }
2206
5418e93b
PH
2207/* See if either the transport or the address specifies a current directory,
2208and if so, expand it. If nothing is set, use the home directory, unless it is
2209also unset in which case use "/", which is assumed to be a directory to which
2210all users have access. It is necessary to be in a visible directory for some
2211operating systems when running pipes, as some commands (e.g. "rm" under Solaris
22122.5) require this. */
2213
d6c82d7b
JH
2214working_directory = tp->current_dir ? tp->current_dir : addr->current_dir;
2215if (working_directory)
059ec3d9
PH
2216 {
2217 uschar *raw = working_directory;
d6c82d7b 2218 if (!(working_directory = expand_string(raw)))
059ec3d9
PH
2219 {
2220 common_error(TRUE, addr, ERRNO_EXPANDFAIL, US"current directory \"%s\" "
2221 "failed to expand for %s transport: %s", raw, tp->name,
2222 expand_string_message);
2223 return;
2224 }
2225 if (*working_directory != '/')
2226 {
2227 common_error(TRUE, addr, ERRNO_NOTABSOLUTE, US"current directory path "
2228 "\"%s\" is not absolute for %s transport", working_directory, tp->name);
2229 return;
2230 }
2231 }
d6c82d7b 2232else working_directory = deliver_home ? deliver_home : US"/";
059ec3d9
PH
2233
2234/* If one of the return_output flags is set on the transport, create and open a
2235file in the message log directory for the transport to write its output onto.
2236This is mainly used by pipe transports. The file needs to be unique to the
2237address. This feature is not available for shadow transports. */
2238
d6c82d7b
JH
2239if ( !shadowing
2240 && ( tp->return_output || tp->return_fail_output
ec0eb1a3 2241 || tp->log_output || tp->log_fail_output || tp->log_defer_output
d6c82d7b 2242 ) )
059ec3d9 2243 {
41313d92
JH
2244 uschar * error;
2245
059ec3d9 2246 addr->return_filename =
41313d92
JH
2247 spool_fname(US"msglog", message_subdir, message_id,
2248 string_sprintf("-%d-%d", getpid(), return_count++));
4c0a7a9c 2249
41313d92 2250 if ((addr->return_file = open_msglog_file(addr->return_filename, 0400, &error)) < 0)
059ec3d9
PH
2251 {
2252 common_error(TRUE, addr, errno, US"Unable to %s file for %s transport "
2253 "to return message: %s", error, tp->name, strerror(errno));
2254 return;
2255 }
2256 }
2257
2258/* Create the pipe for inter-process communication. */
2259
2260if (pipe(pfd) != 0)
2261 {
2262 common_error(TRUE, addr, ERRNO_PIPEFAIL, US"Creation of pipe failed: %s",
2263 strerror(errno));
2264 return;
2265 }
2266
2267/* Now fork the process to do the real work in the subprocess, but first
2268ensure that all cached resources are freed so that the subprocess starts with
2269a clean slate and doesn't interfere with the parent process. */
2270
2271search_tidyup();
2272
32393657 2273if ((pid = exim_fork(US"delivery-local")) == 0)
059ec3d9
PH
2274 {
2275 BOOL replicate = TRUE;
2276
2277 /* Prevent core dumps, as we don't want them in users' home directories.
2278 HP-UX doesn't have RLIMIT_CORE; I don't know how to do this in that
2279 system. Some experimental/developing systems (e.g. GNU/Hurd) may define
2280 RLIMIT_CORE but not support it in setrlimit(). For such systems, do not
a29e5231
PP
2281 complain if the error is "not supported".
2282
2283 There are two scenarios where changing the max limit has an effect. In one,
2284 the user is using a .forward and invoking a command of their choice via pipe;
2285 for these, we do need the max limit to be 0 unless the admin chooses to
2286 permit an increased limit. In the other, the command is invoked directly by
2287 the transport and is under administrator control, thus being able to raise
2288 the limit aids in debugging. So there's no general always-right answer.
2289
2290 Thus we inhibit core-dumps completely but let individual transports, while
2291 still root, re-raise the limits back up to aid debugging. We make the
2292 default be no core-dumps -- few enough people can use core dumps in
2293 diagnosis that it's reasonable to make them something that has to be explicitly requested.
2294 */
059ec3d9 2295
a7538db1 2296#ifdef RLIMIT_CORE
059ec3d9
PH
2297 struct rlimit rl;
2298 rl.rlim_cur = 0;
2299 rl.rlim_max = 0;
2300 if (setrlimit(RLIMIT_CORE, &rl) < 0)
2301 {
a7538db1 2302# ifdef SETRLIMIT_NOT_SUPPORTED
059ec3d9 2303 if (errno != ENOSYS && errno != ENOTSUP)
a7538db1 2304# endif
059ec3d9
PH
2305 log_write(0, LOG_MAIN|LOG_PANIC, "setrlimit(RLIMIT_CORE) failed: %s",
2306 strerror(errno));
2307 }
a7538db1 2308#endif
059ec3d9
PH
2309
2310 /* Reset the random number generator, so different processes don't all
2311 have the same sequence. */
2312
2313 random_seed = 0;
2314
2315 /* If the transport has a setup entry, call this first, while still
2316 privileged. (Appendfile uses this to expand quota, for example, while
2317 able to read private files.) */
2318
d6c82d7b 2319 if (addr->transport->setup)
929ba01c 2320 switch((addr->transport->setup)(addr->transport, addr, NULL, uid, gid,
059ec3d9
PH
2321 &(addr->message)))
2322 {
2323 case DEFER:
d6c82d7b
JH
2324 addr->transport_return = DEFER;
2325 goto PASS_BACK;
059ec3d9
PH
2326
2327 case FAIL:
d6c82d7b
JH
2328 addr->transport_return = PANIC;
2329 goto PASS_BACK;
059ec3d9 2330 }
059ec3d9
PH
2331
2332 /* Ignore SIGINT and SIGTERM during delivery. Also ignore SIGUSR1, as
2333 when the process becomes unprivileged, it won't be able to write to the
2334 process log. SIGHUP is ignored throughout exim, except when it is being
2335 run as a daemon. */
2336
2337 signal(SIGINT, SIG_IGN);
2338 signal(SIGTERM, SIG_IGN);
2339 signal(SIGUSR1, SIG_IGN);
2340
2341 /* Close the unwanted half of the pipe, and set close-on-exec for the other
2342 half - for transports that exec things (e.g. pipe). Then set the required
2343 gid/uid. */
2344
f1e894f3 2345 (void)close(pfd[pipe_read]);
ff790e47 2346 (void)fcntl(pfd[pipe_write], F_SETFD, fcntl(pfd[pipe_write], F_GETFD) |
059ec3d9
PH
2347 FD_CLOEXEC);
2348 exim_setugid(uid, gid, use_initgroups,
2349 string_sprintf("local delivery to %s <%s> transport=%s", addr->local_part,
2350 addr->address, addr->transport->name));
2351
2352 DEBUG(D_deliver)
2353 {
059ec3d9 2354 debug_printf(" home=%s current=%s\n", deliver_home, working_directory);
d7978c0f 2355 for (address_item * batched = addr->next; batched; batched = batched->next)
059ec3d9
PH
2356 debug_printf("additional batched address: %s\n", batched->address);
2357 }
2358
2359 /* Set an appropriate working directory. */
2360
2361 if (Uchdir(working_directory) < 0)
2362 {
2363 addr->transport_return = DEFER;
2364 addr->basic_errno = errno;
2365 addr->message = string_sprintf("failed to chdir to %s", working_directory);
2366 }
2367
2368 /* If successful, call the transport */
2369
2370 else
2371 {
2372 BOOL ok = TRUE;
2373 set_process_info("delivering %s to %s using %s", message_id,
2374 addr->local_part, addr->transport->name);
2375
2a47f028
JH
2376 /* Setting this global in the subprocess means we need never clear it */
2377 transport_name = addr->transport->name;
2378
059ec3d9
PH
2379 /* If a transport filter has been specified, set up its argument list.
2380 Any errors will get put into the address, and FALSE yielded. */
2381
d6c82d7b 2382 if (addr->transport->filter_command)
059ec3d9
PH
2383 {
2384 ok = transport_set_up_command(&transport_filter_argv,
2385 addr->transport->filter_command,
2386 TRUE, PANIC, addr, US"transport filter", NULL);
2387 transport_filter_timeout = addr->transport->filter_timeout;
2388 }
2389 else transport_filter_argv = NULL;
2390
2391 if (ok)
2392 {
2393 debug_print_string(addr->transport->debug_string);
2394 replicate = !(addr->transport->info->code)(addr->transport, addr);
2395 }
2396 }
2397
2398 /* Pass the results back down the pipe. If necessary, first replicate the
2399 status in the top address to the others in the batch. The label is the
2400 subject of a goto when a call to the transport's setup function fails. We
2401 pass the pointer to the transport back in case it got changed as a result of
2402 file_format in appendfile. */
2403
2404 PASS_BACK:
2405
2406 if (replicate) replicate_status(addr);
d6c82d7b 2407 for (addr2 = addr; addr2; addr2 = addr2->next)
059ec3d9
PH
2408 {
2409 int i;
2410 int local_part_length = Ustrlen(addr2->local_part);
2411 uschar *s;
1ac6b2e7 2412 int ret;
059ec3d9 2413
847a015a
JH
2414 if( (ret = write(pfd[pipe_write], &addr2->transport_return, sizeof(int))) != sizeof(int)
2415 || (ret = write(pfd[pipe_write], &transport_count, sizeof(transport_count))) != sizeof(transport_count)
2416 || (ret = write(pfd[pipe_write], &addr2->flags, sizeof(addr2->flags))) != sizeof(addr2->flags)
2417 || (ret = write(pfd[pipe_write], &addr2->basic_errno, sizeof(int))) != sizeof(int)
2418 || (ret = write(pfd[pipe_write], &addr2->more_errno, sizeof(int))) != sizeof(int)
a55697ac 2419 || (ret = write(pfd[pipe_write], &addr2->delivery_time, sizeof(struct timeval))) != sizeof(struct timeval)
847a015a
JH
2420 || (ret = write(pfd[pipe_write], &addr2->special_action, sizeof(int))) != sizeof(int)
2421 || (ret = write(pfd[pipe_write], &addr2->transport,
1ac6b2e7 2422 sizeof(transport_instance *))) != sizeof(transport_instance *)
059ec3d9
PH
2423
2424 /* For a file delivery, pass back the local part, in case the original
2425 was only part of the final delivery path. This gives more complete
2426 logging. */
2427
1ac6b2e7 2428 || (testflag(addr2, af_file)
847a015a
JH
2429 && ( (ret = write(pfd[pipe_write], &local_part_length, sizeof(int))) != sizeof(int)
2430 || (ret = write(pfd[pipe_write], addr2->local_part, local_part_length)) != local_part_length
1ac6b2e7
JH
2431 )
2432 )
2433 )
a23ff3b4 2434 log_write(0, LOG_MAIN|LOG_PANIC, "Failed writing transport results to pipe: %s",
1ac6b2e7 2435 ret == -1 ? strerror(errno) : "short write");
059ec3d9
PH
2436
2437 /* Now any messages */
2438
2439 for (i = 0, s = addr2->message; i < 2; i++, s = addr2->user_message)
2440 {
d6c82d7b 2441 int message_length = s ? Ustrlen(s) + 1 : 0;
847a015a
JH
2442 if( (ret = write(pfd[pipe_write], &message_length, sizeof(int))) != sizeof(int)
2443 || message_length > 0 && (ret = write(pfd[pipe_write], s, message_length)) != message_length
1ac6b2e7 2444 )
a23ff3b4 2445 log_write(0, LOG_MAIN|LOG_PANIC, "Failed writing transport results to pipe: %s",
1ac6b2e7 2446 ret == -1 ? strerror(errno) : "short write");
059ec3d9
PH
2447 }
2448 }
2449
2450 /* OK, this process is now done. Free any cached resources that it opened,
2451 and close the pipe we were writing down before exiting. */
2452
f1e894f3 2453 (void)close(pfd[pipe_write]);
059ec3d9
PH
2454 search_tidyup();
2455 exit(EXIT_SUCCESS);
2456 }
2457
2458/* Back in the main process: panic if the fork did not succeed. This seems
2459better than returning an error - if forking is failing it is probably best
2460not to try other deliveries for this message. */
2461
2462if (pid < 0)
2463 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Fork failed for local delivery to %s",
2464 addr->address);
2465
2466/* Read the pipe to get the delivery status codes and error messages. Our copy
2467of the writing end must be closed first, as otherwise read() won't return zero
2468on an empty pipe. We check that a status exists for each address before
2469overwriting the address structure. If data is missing, the default DEFER status
2470will remain. Afterwards, close the reading end. */
2471
f1e894f3 2472(void)close(pfd[pipe_write]);
059ec3d9 2473
d6c82d7b 2474for (addr2 = addr; addr2; addr2 = addr2->next)
059ec3d9 2475 {
847a015a 2476 if ((len = read(pfd[pipe_read], &status, sizeof(int))) > 0)
059ec3d9
PH
2477 {
2478 int i;
2479 uschar **sptr;
2480
2481 addr2->transport_return = status;
847a015a 2482 len = read(pfd[pipe_read], &transport_count,
059ec3d9 2483 sizeof(transport_count));
847a015a
JH
2484 len = read(pfd[pipe_read], &addr2->flags, sizeof(addr2->flags));
2485 len = read(pfd[pipe_read], &addr2->basic_errno, sizeof(int));
2486 len = read(pfd[pipe_read], &addr2->more_errno, sizeof(int));
a55697ac 2487 len = read(pfd[pipe_read], &addr2->delivery_time, sizeof(struct timeval));
847a015a
JH
2488 len = read(pfd[pipe_read], &addr2->special_action, sizeof(int));
2489 len = read(pfd[pipe_read], &addr2->transport,
059ec3d9
PH
2490 sizeof(transport_instance *));
2491
2492 if (testflag(addr2, af_file))
2493 {
d88f0784 2494 int llen;
847a015a 2495 if ( read(pfd[pipe_read], &llen, sizeof(int)) != sizeof(int)
d88f0784
JH
2496 || llen > 64*4 /* limit from rfc 5821, times I18N factor */
2497 )
2498 {
2499 log_write(0, LOG_MAIN|LOG_PANIC, "bad local_part length read"
2500 " from delivery subprocess");
2501 break;
2502 }
2503 /* sanity-checked llen so disable the Coverity error */
2504 /* coverity[tainted_data] */
847a015a 2505 if (read(pfd[pipe_read], big_buffer, llen) != llen)
d88f0784
JH
2506 {
2507 log_write(0, LOG_MAIN|LOG_PANIC, "bad local_part read"
2508 " from delivery subprocess");
2509 break;
2510 }
2511 big_buffer[llen] = 0;
059ec3d9
PH
2512 addr2->local_part = string_copy(big_buffer);
2513 }
2514
d6c82d7b 2515 for (i = 0, sptr = &addr2->message; i < 2; i++, sptr = &addr2->user_message)
059ec3d9
PH
2516 {
2517 int message_length;
847a015a 2518 len = read(pfd[pipe_read], &message_length, sizeof(int));
059ec3d9
PH
2519 if (message_length > 0)
2520 {
847a015a 2521 len = read(pfd[pipe_read], big_buffer, message_length);
dc8091e7 2522 big_buffer[big_buffer_size-1] = '\0'; /* guard byte */
059ec3d9
PH
2523 if (len > 0) *sptr = string_copy(big_buffer);
2524 }
2525 }
2526 }
2527
2528 else
2529 {
2530 log_write(0, LOG_MAIN|LOG_PANIC, "failed to read delivery status for %s "
2531 "from delivery subprocess", addr2->unique);
2532 break;
2533 }
2534 }
2535
f1e894f3 2536(void)close(pfd[pipe_read]);
059ec3d9
PH
2537
2538/* Unless shadowing, write all successful addresses immediately to the journal
2539file, to ensure they are recorded asap. For homonymic addresses, use the base
2540address plus the transport name. Failure to write the journal is panic-worthy,
2541but don't stop, as it may prove possible subsequently to update the spool file
2542in order to record the delivery. */
2543
2544if (!shadowing)
2545 {
d6c82d7b
JH
2546 for (addr2 = addr; addr2; addr2 = addr2->next)
2547 if (addr2->transport_return == OK)
2548 {
2549 if (testflag(addr2, af_homonym))
2550 sprintf(CS big_buffer, "%.500s/%s\n", addr2->unique + 3, tp->name);
2551 else
2552 sprintf(CS big_buffer, "%.500s\n", addr2->unique);
059ec3d9 2553
d6c82d7b
JH
2554 /* In the test harness, wait just a bit to let the subprocess finish off
2555 any debug output etc first. */
059ec3d9 2556
9f01e50d 2557 testharness_pause_ms(300);
059ec3d9 2558
d6c82d7b
JH
2559 DEBUG(D_deliver) debug_printf("journalling %s", big_buffer);
2560 len = Ustrlen(big_buffer);
2561 if (write(journal_fd, big_buffer, len) != len)
2562 log_write(0, LOG_MAIN|LOG_PANIC, "failed to update journal for %s: %s",
2563 big_buffer, strerror(errno));
2564 }
059ec3d9
PH
2565
2566 /* Ensure the journal file is pushed out to disk. */
2567
54fc8428 2568 if (EXIMfsync(journal_fd) < 0)
059ec3d9
PH
2569 log_write(0, LOG_MAIN|LOG_PANIC, "failed to fsync journal: %s",
2570 strerror(errno));
2571 }
2572
2573/* Wait for the process to finish. If it terminates with a non-zero code,
2574freeze the message (except for SIGTERM, SIGKILL and SIGQUIT), but leave the
2575status values of all the addresses as they are. Take care to handle the case
2576when the subprocess doesn't seem to exist. This has been seen on one system
2577when Exim was called from an MUA that set SIGCHLD to SIG_IGN. When that
2578happens, wait() doesn't recognize the termination of child processes. Exim now
2579resets SIGCHLD to SIG_DFL, but this code should still be robust. */
2580
2581while ((rc = wait(&status)) != pid)
059ec3d9
PH
2582 if (rc < 0 && errno == ECHILD) /* Process has vanished */
2583 {
2584 log_write(0, LOG_MAIN, "%s transport process vanished unexpectedly",
2585 addr->transport->driver_name);
2586 status = 0;
2587 break;
2588 }
059ec3d9
PH
2589
2590if ((status & 0xffff) != 0)
2591 {
2592 int msb = (status >> 8) & 255;
2593 int lsb = status & 255;
2594 int code = (msb == 0)? (lsb & 0x7f) : msb;
2595 if (msb != 0 || (code != SIGTERM && code != SIGKILL && code != SIGQUIT))
2596 addr->special_action = SPECIAL_FREEZE;
2597 log_write(0, LOG_MAIN|LOG_PANIC, "%s transport process returned non-zero "
2598 "status 0x%04x: %s %d",
2599 addr->transport->driver_name,
2600 status,
d6c82d7b 2601 msb == 0 ? "terminated by signal" : "exit code",
059ec3d9
PH
2602 code);
2603 }
2604
2605/* If SPECIAL_WARN is set in the top address, send a warning message. */
2606
d6c82d7b 2607if (addr->special_action == SPECIAL_WARN && addr->transport->warn_message)
059ec3d9
PH
2608 {
2609 int fd;
2610 uschar *warn_message;
d6c82d7b 2611 pid_t pid;
059ec3d9
PH
2612
2613 DEBUG(D_deliver) debug_printf("Warning message requested by transport\n");
2614
d6c82d7b 2615 if (!(warn_message = expand_string(addr->transport->warn_message)))
059ec3d9
PH
2616 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand \"%s\" (warning "
2617 "message for %s transport): %s", addr->transport->warn_message,
2618 addr->transport->name, expand_string_message);
d6c82d7b 2619
32393657 2620 else if ((pid = child_open_exim(&fd, US"tpt-warning-message")) > 0)
059ec3d9 2621 {
d6c82d7b
JH
2622 FILE *f = fdopen(fd, "wb");
2623 if (errors_reply_to && !contains_header(US"Reply-To", warn_message))
2624 fprintf(f, "Reply-To: %s\n", errors_reply_to);
2625 fprintf(f, "Auto-Submitted: auto-replied\n");
2626 if (!contains_header(US"From", warn_message))
2627 moan_write_from(f);
2628 fprintf(f, "%s", CS warn_message);
059ec3d9 2629
d6c82d7b 2630 /* Close and wait for child process to complete, without a timeout. */
059ec3d9 2631
d6c82d7b
JH
2632 (void)fclose(f);
2633 (void)child_close(pid, 0);
059ec3d9
PH
2634 }
2635
2636 addr->special_action = SPECIAL_NONE;
2637 }
2638}
2639
2640
2641
fa41615d 2642
3070ceee
JH
2643/* Check transport for the given concurrency limit. Return TRUE if over
2644the limit (or an expansion failure), else FALSE and if there was a limit,
2645the key for the hints database used for the concurrency count. */
fa41615d 2646
3070ceee
JH
2647static BOOL
2648tpt_parallel_check(transport_instance * tp, address_item * addr, uschar ** key)
fa41615d 2649{
3070ceee
JH
2650unsigned max_parallel;
2651
2652if (!tp->max_parallel) return FALSE;
2653
2654max_parallel = (unsigned) expand_string_integer(tp->max_parallel, TRUE);
2655if (expand_string_message)
2656 {
2657 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand max_parallel option "
2658 "in %s transport (%s): %s", tp->name, addr->address,
2659 expand_string_message);
2660 return TRUE;
2661 }
2662
2663if (max_parallel > 0)
2664 {
2665 uschar * serialize_key = string_sprintf("tpt-serialize-%s", tp->name);
2666 if (!enq_start(serialize_key, max_parallel))
2667 {
2668 address_item * next;
2669 DEBUG(D_transport)
2670 debug_printf("skipping tpt %s because concurrency limit %u reached\n",
2671 tp->name, max_parallel);
2672 do
2673 {
2674 next = addr->next;
2675 addr->message = US"concurrency limit reached for transport";
2676 addr->basic_errno = ERRNO_TRETRY;
ba936fb8 2677 post_process_one(addr, DEFER, LOG_MAIN, EXIM_DTYPE_TRANSPORT, 0);
3070ceee
JH
2678 } while ((addr = next));
2679 return TRUE;
2680 }
2681 *key = serialize_key;
2682 }
2683return FALSE;
fa41615d
JH
2684}
2685
2686
2687
059ec3d9
PH
2688/*************************************************
2689* Do local deliveries *
2690*************************************************/
2691
2692/* This function processes the list of addresses in addr_local. True local
2693deliveries are always done one address at a time. However, local deliveries can
2694be batched up in some cases. Typically this is when writing batched SMTP output
2695files for use by some external transport mechanism, or when running local
2696deliveries over LMTP.
2697
2698Arguments: None
2699Returns: Nothing
2700*/
2701
2702static void
2703do_local_deliveries(void)
2704{
2705open_db dbblock;
2706open_db *dbm_file = NULL;
2707time_t now = time(NULL);
2708
2709/* Loop until we have exhausted the supply of local deliveries */
2710
d6c82d7b 2711while (addr_local)
059ec3d9 2712 {
32dfdf8b
JH
2713 struct timeval delivery_start;
2714 struct timeval deliver_time;
059ec3d9
PH
2715 address_item *addr2, *addr3, *nextaddr;
2716 int logflags = LOG_MAIN;
8768d548 2717 int logchar = f.dont_deliver? '*' : '=';
059ec3d9 2718 transport_instance *tp;
fa41615d 2719 uschar * serialize_key = NULL;
059ec3d9
PH
2720
2721 /* Pick the first undelivered address off the chain */
2722
2723 address_item *addr = addr_local;
2724 addr_local = addr->next;
2725 addr->next = NULL;
2726
2727 DEBUG(D_deliver|D_transport)
2728 debug_printf("--------> %s <--------\n", addr->address);
2729
2730 /* An internal disaster if there is no transport. Should not occur! */
2731
d6c82d7b 2732 if (!(tp = addr->transport))
059ec3d9
PH
2733 {
2734 logflags |= LOG_PANIC;
8768d548 2735 f.disable_logging = FALSE; /* Jic */
d6c82d7b
JH
2736 addr->message = addr->router
2737 ? string_sprintf("No transport set by %s router", addr->router->name)
f3ebb786 2738 : US"No transport set by system filter";
ba936fb8 2739 post_process_one(addr, DEFER, logflags, EXIM_DTYPE_TRANSPORT, 0);
059ec3d9
PH
2740 continue;
2741 }
2742
2743 /* Check that this base address hasn't previously been delivered to this
2744 transport. The check is necessary at this point to handle homonymic addresses
2745 correctly in cases where the pattern of redirection changes between delivery
2746 attempts. Non-homonymic previous delivery is detected earlier, at routing
2747 time. */
2748
c2c19e9d 2749 if (previously_transported(addr, FALSE)) continue;
059ec3d9
PH
2750
2751 /* There are weird cases where logging is disabled */
2752
8768d548 2753 f.disable_logging = tp->disable_logging;
059ec3d9 2754
f7fd3850
PH
2755 /* Check for batched addresses and possible amalgamation. Skip all the work
2756 if either batch_max <= 1 or there aren't any other addresses for local
2757 delivery. */
059ec3d9 2758
d6c82d7b 2759 if (tp->batch_max > 1 && addr_local)
059ec3d9
PH
2760 {
2761 int batch_count = 1;
2762 BOOL uses_dom = readconf_depends((driver_instance *)tp, US"domain");
d6c82d7b
JH
2763 BOOL uses_lp = ( testflag(addr, af_pfr)
2764 && (testflag(addr, af_file) || addr->local_part[0] == '|')
2765 )
2766 || readconf_depends((driver_instance *)tp, US"local_part");
059ec3d9
PH
2767 uschar *batch_id = NULL;
2768 address_item **anchor = &addr_local;
2769 address_item *last = addr;
2770 address_item *next;
2771
2772 /* Expand the batch_id string for comparison with other addresses.
2773 Expansion failure suppresses batching. */
2774
d6c82d7b 2775 if (tp->batch_id)
059ec3d9
PH
2776 {
2777 deliver_set_expansions(addr);
2778 batch_id = expand_string(tp->batch_id);
2779 deliver_set_expansions(NULL);
d6c82d7b 2780 if (!batch_id)
059ec3d9
PH
2781 {
2782 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand batch_id option "
2783 "in %s transport (%s): %s", tp->name, addr->address,
2784 expand_string_message);
2785 batch_count = tp->batch_max;
2786 }
2787 }
2788
2789 /* Until we reach the batch_max limit, pick off addresses which have the
2790 same characteristics. These are:
2791
2792 same transport
7816e254 2793 not previously delivered (see comment about 50 lines above)
059ec3d9 2794 same local part if the transport's configuration contains $local_part
f7fd3850 2795 or if this is a file or pipe delivery from a redirection
059ec3d9
PH
2796 same domain if the transport's configuration contains $domain
2797 same errors address
2798 same additional headers
2799 same headers to be removed
2800 same uid/gid for running the transport
2801 same first host if a host list is set
2802 */
2803
d6c82d7b 2804 while ((next = *anchor) && batch_count < tp->batch_max)
059ec3d9
PH
2805 {
2806 BOOL ok =
d6c82d7b
JH
2807 tp == next->transport
2808 && !previously_transported(next, TRUE)
7eb0e5d2
JH
2809 && testflag(addr, af_pfr) == testflag(next, af_pfr)
2810 && testflag(addr, af_file) == testflag(next, af_file)
d6c82d7b
JH
2811 && (!uses_lp || Ustrcmp(next->local_part, addr->local_part) == 0)
2812 && (!uses_dom || Ustrcmp(next->domain, addr->domain) == 0)
2813 && same_strings(next->prop.errors_address, addr->prop.errors_address)
2814 && same_headers(next->prop.extra_headers, addr->prop.extra_headers)
2815 && same_strings(next->prop.remove_headers, addr->prop.remove_headers)
2816 && same_ugid(tp, addr, next)
2817 && ( !addr->host_list && !next->host_list
2818 || addr->host_list
2819 && next->host_list
2820 && Ustrcmp(addr->host_list->name, next->host_list->name) == 0
2821 );
059ec3d9
PH
2822
2823 /* If the transport has a batch_id setting, batch_id will be non-NULL
2824 from the expansion outside the loop. Expand for this address and compare.
2825 Expansion failure makes this address ineligible for batching. */
2826
d6c82d7b 2827 if (ok && batch_id)
059ec3d9
PH
2828 {
2829 uschar *bid;
2830 address_item *save_nextnext = next->next;
2831 next->next = NULL; /* Expansion for a single address */
2832 deliver_set_expansions(next);
2833 next->next = save_nextnext;
2834 bid = expand_string(tp->batch_id);
2835 deliver_set_expansions(NULL);
d6c82d7b 2836 if (!bid)
059ec3d9
PH
2837 {
2838 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand batch_id option "
2839 "in %s transport (%s): %s", tp->name, next->address,
2840 expand_string_message);
2841 ok = FALSE;
2842 }
2843 else ok = (Ustrcmp(batch_id, bid) == 0);
2844 }
2845
2846 /* Take address into batch if OK. */
2847
2848 if (ok)
2849 {
2850 *anchor = next->next; /* Include the address */
2851 next->next = NULL;
2852 last->next = next;
2853 last = next;
2854 batch_count++;
2855 }
fa41615d 2856 else anchor = &next->next; /* Skip the address */
059ec3d9
PH
2857 }
2858 }
2859
2860 /* We now have one or more addresses that can be delivered in a batch. Check
2861 whether the transport is prepared to accept a message of this size. If not,
2862 fail them all forthwith. If the expansion fails, or does not yield an
2863 integer, defer delivery. */
2864
d6c82d7b 2865 if (tp->message_size_limit)
059ec3d9
PH
2866 {
2867 int rc = check_message_size(tp, addr);
2868 if (rc != OK)
2869 {
2870 replicate_status(addr);
d6c82d7b 2871 while (addr)
059ec3d9
PH
2872 {
2873 addr2 = addr->next;
ba936fb8 2874 post_process_one(addr, rc, logflags, EXIM_DTYPE_TRANSPORT, 0);
059ec3d9
PH
2875 addr = addr2;
2876 }
2877 continue; /* With next batch of addresses */
2878 }
2879 }
2880
2881 /* If we are not running the queue, or if forcing, all deliveries will be
2882 attempted. Otherwise, we must respect the retry times for each address. Even
2883 when not doing this, we need to set up the retry key string, and determine
2884 whether a retry record exists, because after a successful delivery, a delete
2885 retry item must be set up. Keep the retry database open only for the duration
2886 of these checks, rather than for all local deliveries, because some local
2887 deliveries (e.g. to pipes) can take a substantial time. */
2888
b10c87b3 2889 if (!(dbm_file = dbfn_open(US"retry", O_RDONLY, &dbblock, FALSE, TRUE)))
059ec3d9
PH
2890 {
2891 DEBUG(D_deliver|D_retry|D_hints_lookup)
2892 debug_printf("no retry data available\n");
2893 }
2894
2895 addr2 = addr;
2896 addr3 = NULL;
d6c82d7b 2897 while (addr2)
059ec3d9
PH
2898 {
2899 BOOL ok = TRUE; /* to deliver this address */
2900 uschar *retry_key;
2901
2902 /* Set up the retry key to include the domain or not, and change its
2903 leading character from "R" to "T". Must make a copy before doing this,
2904 because the old key may be pointed to from a "delete" retry item after
2905 a routing delay. */
2906
2907 retry_key = string_copy(
d6c82d7b 2908 tp->retry_use_local_part ? addr2->address_retry_key :
059ec3d9
PH
2909 addr2->domain_retry_key);
2910 *retry_key = 'T';
2911
2912 /* Inspect the retry data. If there is no hints file, delivery happens. */
2913
d6c82d7b 2914 if (dbm_file)
059ec3d9
PH
2915 {
2916 dbdata_retry *retry_record = dbfn_read(dbm_file, retry_key);
2917
2918 /* If there is no retry record, delivery happens. If there is,
2919 remember it exists so it can be deleted after a successful delivery. */
2920
d6c82d7b 2921 if (retry_record)
059ec3d9
PH
2922 {
2923 setflag(addr2, af_lt_retry_exists);
2924
2925 /* A retry record exists for this address. If queue running and not
2926 forcing, inspect its contents. If the record is too old, or if its
2927 retry time has come, or if it has passed its cutoff time, delivery
2928 will go ahead. */
2929
2930 DEBUG(D_retry)
2931 {
ea49d0e1
PH
2932 debug_printf("retry record exists: age=%s ",
2933 readconf_printtime(now - retry_record->time_stamp));
2934 debug_printf("(max %s)\n", readconf_printtime(retry_data_expire));
2935 debug_printf(" time to retry = %s expired = %d\n",
2936 readconf_printtime(retry_record->next_try - now),
2937 retry_record->expired);
059ec3d9
PH
2938 }
2939
8768d548 2940 if (f.queue_running && !f.deliver_force)
059ec3d9 2941 {
d6c82d7b
JH
2942 ok = (now - retry_record->time_stamp > retry_data_expire)
2943 || (now >= retry_record->next_try)
2944 || retry_record->expired;
059ec3d9
PH
2945
2946 /* If we haven't reached the retry time, there is one more check
1ddeb334 2947 to do, which is for the ultimate address timeout. */
059ec3d9
PH
2948
2949 if (!ok)
ba9af0af
TF
2950 ok = retry_ultimate_address_timeout(retry_key, addr2->domain,
2951 retry_record, now);
059ec3d9
PH
2952 }
2953 }
2954 else DEBUG(D_retry) debug_printf("no retry record exists\n");
2955 }
2956
2957 /* This address is to be delivered. Leave it on the chain. */
2958
2959 if (ok)
2960 {
2961 addr3 = addr2;
2962 addr2 = addr2->next;
2963 }
2964
2965 /* This address is to be deferred. Take it out of the chain, and
2966 post-process it as complete. Must take it out of the chain first,
2967 because post processing puts it on another chain. */
2968
2969 else
2970 {
2971 address_item *this = addr2;
2972 this->message = US"Retry time not yet reached";
2973 this->basic_errno = ERRNO_LRETRY;
d6c82d7b
JH
2974 addr2 = addr3 ? (addr3->next = addr2->next)
2975 : (addr = addr2->next);
ba936fb8 2976 post_process_one(this, DEFER, logflags, EXIM_DTYPE_TRANSPORT, 0);
059ec3d9
PH
2977 }
2978 }
2979
d6c82d7b 2980 if (dbm_file) dbfn_close(dbm_file);
059ec3d9
PH
2981
2982 /* If there are no addresses left on the chain, they all deferred. Loop
2983 for the next set of addresses. */
2984
d6c82d7b 2985 if (!addr) continue;
059ec3d9 2986
fa41615d
JH
2987 /* If the transport is limited for parallellism, enforce that here.
2988 We use a hints DB entry, incremented here and decremented after
2989 the transport (and any shadow transport) completes. */
2990
3070ceee 2991 if (tpt_parallel_check(tp, addr, &serialize_key))
fa41615d 2992 {
fa41615d
JH
2993 if (expand_string_message)
2994 {
2995 logflags |= LOG_PANIC;
3070ceee
JH
2996 do
2997 {
2998 addr = addr->next;
ba936fb8 2999 post_process_one(addr, DEFER, logflags, EXIM_DTYPE_TRANSPORT, 0);
3070ceee 3000 } while ((addr = addr2));
fa41615d 3001 }
3070ceee 3002 continue; /* Loop for the next set of addresses. */
fa41615d
JH
3003 }
3004
3005
059ec3d9
PH
3006 /* So, finally, we do have some addresses that can be passed to the
3007 transport. Before doing so, set up variables that are relevant to a
3008 single delivery. */
3009
3010 deliver_set_expansions(addr);
32dfdf8b
JH
3011
3012 gettimeofday(&delivery_start, NULL);
059ec3d9 3013 deliver_local(addr, FALSE);
32dfdf8b 3014 timesince(&deliver_time, &delivery_start);
059ec3d9
PH
3015
3016 /* If a shadow transport (which must perforce be another local transport), is
3017 defined, and its condition is met, we must pass the message to the shadow
3018 too, but only those addresses that succeeded. We do this by making a new
3019 chain of addresses - also to keep the original chain uncontaminated. We must
3020 use a chain rather than doing it one by one, because the shadow transport may
3021 batch.
3022
3023 NOTE: if the condition fails because of a lookup defer, there is nothing we
3024 can do! */
3025
d6c82d7b
JH
3026 if ( tp->shadow
3027 && ( !tp->shadow_condition
3028 || expand_check_condition(tp->shadow_condition, tp->name, US"transport")
3029 ) )
059ec3d9
PH
3030 {
3031 transport_instance *stp;
3032 address_item *shadow_addr = NULL;
3033 address_item **last = &shadow_addr;
3034
d6c82d7b 3035 for (stp = transports; stp; stp = stp->next)
059ec3d9
PH
3036 if (Ustrcmp(stp->name, tp->shadow) == 0) break;
3037
d6c82d7b 3038 if (!stp)
059ec3d9
PH
3039 log_write(0, LOG_MAIN|LOG_PANIC, "shadow transport \"%s\" not found ",
3040 tp->shadow);
3041
3042 /* Pick off the addresses that have succeeded, and make clones. Put into
3043 the shadow_message field a pointer to the shadow_message field of the real
3044 address. */
3045
d6c82d7b
JH
3046 else for (addr2 = addr; addr2; addr2 = addr2->next)
3047 if (addr2->transport_return == OK)
3048 {
f3ebb786 3049 addr3 = store_get(sizeof(address_item), FALSE);
d6c82d7b
JH
3050 *addr3 = *addr2;
3051 addr3->next = NULL;
82f90600 3052 addr3->shadow_message = US &addr2->shadow_message;
d6c82d7b
JH
3053 addr3->transport = stp;
3054 addr3->transport_return = DEFER;
3055 addr3->return_filename = NULL;
3056 addr3->return_file = -1;
3057 *last = addr3;
82f90600 3058 last = &addr3->next;
d6c82d7b 3059 }
059ec3d9
PH
3060
3061 /* If we found any addresses to shadow, run the delivery, and stick any
3062 message back into the shadow_message field in the original. */
3063
d6c82d7b 3064 if (shadow_addr)
059ec3d9
PH
3065 {
3066 int save_count = transport_count;
3067
3068 DEBUG(D_deliver|D_transport)
3069 debug_printf(">>>>>>>>>>>>>>>> Shadow delivery >>>>>>>>>>>>>>>>\n");
3070 deliver_local(shadow_addr, TRUE);
3071
d6c82d7b 3072 for(; shadow_addr; shadow_addr = shadow_addr->next)
059ec3d9
PH
3073 {
3074 int sresult = shadow_addr->transport_return;
d6c82d7b
JH
3075 *(uschar **)shadow_addr->shadow_message =
3076 sresult == OK
3077 ? string_sprintf(" ST=%s", stp->name)
3078 : string_sprintf(" ST=%s (%s%s%s)", stp->name,
3079 shadow_addr->basic_errno <= 0
3080 ? US""
3081 : US strerror(shadow_addr->basic_errno),
3082 shadow_addr->basic_errno <= 0 || !shadow_addr->message
3083 ? US""
3084 : US": ",
3085 shadow_addr->message
3086 ? shadow_addr->message
3087 : shadow_addr->basic_errno <= 0
3088 ? US"unknown error"
3089 : US"");
059ec3d9
PH
3090
3091 DEBUG(D_deliver|D_transport)
3092 debug_printf("%s shadow transport returned %s for %s\n",
aeb65e91 3093 stp->name, rc_to_string(sresult), shadow_addr->address);
059ec3d9
PH
3094 }
3095
3096 DEBUG(D_deliver|D_transport)
3097 debug_printf(">>>>>>>>>>>>>>>> End shadow delivery >>>>>>>>>>>>>>>>\n");
3098
3099 transport_count = save_count; /* Restore original transport count */
3100 }
3101 }
3102
3103 /* Cancel the expansions that were set up for the delivery. */
3104
3105 deliver_set_expansions(NULL);
3106
fa41615d
JH
3107 /* If the transport was parallelism-limited, decrement the hints DB record. */
3108
3109 if (serialize_key) enq_end(serialize_key);
3110
059ec3d9
PH
3111 /* Now we can process the results of the real transport. We must take each
3112 address off the chain first, because post_process_one() puts it on another
3113 chain. */
3114
d6c82d7b 3115 for (addr2 = addr; addr2; addr2 = nextaddr)
059ec3d9
PH
3116 {
3117 int result = addr2->transport_return;
3118 nextaddr = addr2->next;
3119
3120 DEBUG(D_deliver|D_transport)
3121 debug_printf("%s transport returned %s for %s\n",
aeb65e91 3122 tp->name, rc_to_string(result), addr2->address);
059ec3d9
PH
3123
3124 /* If there is a retry_record, or if delivery is deferred, build a retry
3125 item for setting a new retry time or deleting the old retry record from
3126 the database. These items are handled all together after all addresses
3127 have been handled (so the database is open just for a short time for
3128 updating). */
3129
3130 if (result == DEFER || testflag(addr2, af_lt_retry_exists))
3131 {
d6c82d7b
JH
3132 int flags = result == DEFER ? 0 : rf_delete;
3133 uschar *retry_key = string_copy(tp->retry_use_local_part
3134 ? addr2->address_retry_key : addr2->domain_retry_key);
059ec3d9
PH
3135 *retry_key = 'T';
3136 retry_add_item(addr2, retry_key, flags);
3137 }
3138
3139 /* Done with this address */
3140
a55697ac 3141 addr2->delivery_time = deliver_time;
ba936fb8 3142 post_process_one(addr2, result, logflags, EXIM_DTYPE_TRANSPORT, logchar);
059ec3d9
PH
3143
3144 /* If a pipe delivery generated text to be sent back, the result may be
3145 changed to FAIL, and we must copy this for subsequent addresses in the
3146 batch. */
3147
3148 if (addr2->transport_return != result)
3149 {
d6c82d7b 3150 for (addr3 = nextaddr; addr3; addr3 = addr3->next)
059ec3d9
PH
3151 {
3152 addr3->transport_return = addr2->transport_return;
3153 addr3->basic_errno = addr2->basic_errno;
3154 addr3->message = addr2->message;
3155 }
3156 result = addr2->transport_return;
3157 }
3158
3159 /* Whether or not the result was changed to FAIL, we need to copy the
3160 return_file value from the first address into all the addresses of the
3161 batch, so they are all listed in the error message. */
3162
3163 addr2->return_file = addr->return_file;
3164
3165 /* Change log character for recording successful deliveries. */
3166
3167 if (result == OK) logchar = '-';
3168 }
3169 } /* Loop back for next batch of addresses */
3170}
3171
3172
3173
3174
3175/*************************************************
3176* Sort remote deliveries *
3177*************************************************/
3178
3179/* This function is called if remote_sort_domains is set. It arranges that the
3180chain of addresses for remote deliveries is ordered according to the strings
3181specified. Try to make this shuffling reasonably efficient by handling
3182sequences of addresses rather than just single ones.
3183
3184Arguments: None
3185Returns: Nothing
3186*/
3187
3188static void
3189sort_remote_deliveries(void)
3190{
3191int sep = 0;
3192address_item **aptr = &addr_remote;
55414b25 3193const uschar *listptr = remote_sort_domains;
059ec3d9
PH
3194uschar *pattern;
3195uschar patbuf[256];
3196
d6c82d7b
JH
3197while ( *aptr
3198 && (pattern = string_nextinlist(&listptr, &sep, patbuf, sizeof(patbuf)))
3199 )
059ec3d9
PH
3200 {
3201 address_item *moved = NULL;
3202 address_item **bptr = &moved;
3203
d6c82d7b 3204 while (*aptr)
059ec3d9
PH
3205 {
3206 address_item **next;
3207 deliver_domain = (*aptr)->domain; /* set $domain */
55414b25 3208 if (match_isinlist(deliver_domain, (const uschar **)&pattern, UCHAR_MAX+1,
059ec3d9
PH
3209 &domainlist_anchor, NULL, MCL_DOMAIN, TRUE, NULL) == OK)
3210 {
d6c82d7b 3211 aptr = &(*aptr)->next;
059ec3d9
PH
3212 continue;
3213 }
3214
d6c82d7b
JH
3215 next = &(*aptr)->next;
3216 while ( *next
3217 && (deliver_domain = (*next)->domain, /* Set $domain */
55414b25 3218 match_isinlist(deliver_domain, (const uschar **)&pattern, UCHAR_MAX+1,
d6c82d7b
JH
3219 &domainlist_anchor, NULL, MCL_DOMAIN, TRUE, NULL)) != OK
3220 )
3221 next = &(*next)->next;
059ec3d9
PH
3222
3223 /* If the batch of non-matchers is at the end, add on any that were
3224 extracted further up the chain, and end this iteration. Otherwise,
3225 extract them from the chain and hang on the moved chain. */
3226
d6c82d7b 3227 if (!*next)
059ec3d9
PH
3228 {
3229 *next = moved;
3230 break;
3231 }
3232
3233 *bptr = *aptr;
3234 *aptr = *next;
3235 *next = NULL;
3236 bptr = next;
d6c82d7b 3237 aptr = &(*aptr)->next;
059ec3d9
PH
3238 }
3239
3240 /* If the loop ended because the final address matched, *aptr will
3241 be NULL. Add on to the end any extracted non-matching addresses. If
3242 *aptr is not NULL, the loop ended via "break" when *next is null, that
3243 is, there was a string of non-matching addresses at the end. In this
3244 case the extracted addresses have already been added on the end. */
3245
d6c82d7b 3246 if (!*aptr) *aptr = moved;
059ec3d9
PH
3247 }
3248
3249DEBUG(D_deliver)
3250 {
059ec3d9 3251 debug_printf("remote addresses after sorting:\n");
d7978c0f 3252 for (address_item * addr = addr_remote; addr; addr = addr->next)
059ec3d9
PH
3253 debug_printf(" %s\n", addr->address);
3254 }
3255}
3256
3257
3258
3259/*************************************************
3260* Read from pipe for remote delivery subprocess *
3261*************************************************/
3262
3263/* This function is called when the subprocess is complete, but can also be
3264called before it is complete, in order to empty a pipe that is full (to prevent
3265deadlock). It must therefore keep track of its progress in the parlist data
3266block.
3267
3268We read the pipe to get the delivery status codes and a possible error message
3269for each address, optionally preceded by unusability data for the hosts and
3270also by optional retry data.
3271
3272Read in large chunks into the big buffer and then scan through, interpreting
3273the data therein. In most cases, only a single read will be necessary. No
1c5466b9
PH
3274individual item will ever be anywhere near 2500 bytes in length, so by ensuring
3275that we read the next chunk when there is less than 2500 bytes left in the
3276non-final chunk, we can assume each item is complete in the buffer before
3277handling it. Each item is written using a single write(), which is atomic for
3278small items (less than PIPE_BUF, which seems to be at least 512 in any Unix and
3279often bigger) so even if we are reading while the subprocess is still going, we
3280should never have only a partial item in the buffer.
059ec3d9 3281
0768462d
JH
3282hs12: This assumption is not true anymore, since we get quite large items (certificate
3283information and such).
2cee425a 3284
059ec3d9
PH
3285Argument:
3286 poffset the offset of the parlist item
3287 eop TRUE if the process has completed
3288
3289Returns: TRUE if the terminating 'Z' item has been read,
3290 or there has been a disaster (i.e. no more data needed);
3291 FALSE otherwise
3292*/
3293
3294static BOOL
3295par_read_pipe(int poffset, BOOL eop)
3296{
3297host_item *h;
3298pardata *p = parlist + poffset;
3299address_item *addrlist = p->addrlist;
3300address_item *addr = p->addr;
3301pid_t pid = p->pid;
3302int fd = p->fd;
2cee425a 3303
059ec3d9
PH
3304uschar *msg = p->msg;
3305BOOL done = p->done;
059ec3d9
PH
3306
3307/* Loop through all items, reading from the pipe when necessary. The pipe
2cee425a
HSHR
3308used to be non-blocking. But I do not see a reason for using non-blocking I/O
3309here, as the preceding select() tells us, if data is available for reading.
3310
3311A read() on a "selected" handle should never block, but(!) it may return
3312less data then we expected. (The buffer size we pass to read() shouldn't be
3313understood as a "request", but as a "limit".)
3314
3315Each separate item is written to the pipe in a timely manner. But, especially for
3316larger items, the read(2) may already return partial data from the write(2).
3317
3318The write is atomic mostly (depending on the amount written), but atomic does
3319not imply "all or noting", it just is "not intermixed" with other writes on the
3320same channel (pipe).
6c454556
HSHR
3321
3322*/
059ec3d9
PH
3323
3324DEBUG(D_deliver) debug_printf("reading pipe for subprocess %d (%s)\n",
2cee425a 3325 (int)p->pid, eop? "ended" : "not ended yet");
059ec3d9
PH
3326
3327while (!done)
3328 {
3329 retry_item *r, **rp;
2cee425a
HSHR
3330 uschar pipeheader[PIPE_HEADER_SIZE+1];
3331 uschar *id = &pipeheader[0];
3332 uschar *subid = &pipeheader[1];
3333 uschar *ptr = big_buffer;
3334 size_t required = PIPE_HEADER_SIZE; /* first the pipehaeder, later the data */
3335 ssize_t got;
3336
7845dbb3 3337 DEBUG(D_deliver) debug_printf(
0d68983b 3338 "expect %lu bytes (pipeheader) from tpt process %d\n", (u_long)required, pid);
2cee425a
HSHR
3339
3340 /* We require(!) all the PIPE_HEADER_SIZE bytes here, as we know,
3341 they're written in a timely manner, so waiting for the write shouldn't hurt a lot.
3342 If we get less, we can assume the subprocess do be done and do not expect any further
3343 information from it. */
7845dbb3 3344
ee250936 3345 if ((got = readn(fd, pipeheader, required)) != required)
059ec3d9 3346 {
bb07bcd3
JH
3347 msg = string_sprintf("got " SSIZE_T_FMT " of %d bytes (pipeheader) "
3348 "from transport process %d for transport %s",
3349 got, PIPE_HEADER_SIZE, pid, addr->transport->driver_name);
3350 done = TRUE;
3351 break;
059ec3d9
PH
3352 }
3353
2cee425a
HSHR
3354 pipeheader[PIPE_HEADER_SIZE] = '\0';
3355 DEBUG(D_deliver)
7845dbb3
JH
3356 debug_printf("got %ld bytes (pipeheader) from transport process %d\n",
3357 (long) got, pid);
059ec3d9 3358
2cee425a
HSHR
3359 {
3360 /* If we can't decode the pipeheader, the subprocess seems to have a
3361 problem, we do not expect any furher information from it. */
3362 char *endc;
7845dbb3 3363 required = Ustrtol(pipeheader+2, &endc, 10);
bd21a787
WB
3364 if (*endc)
3365 {
2cee425a
HSHR
3366 msg = string_sprintf("failed to read pipe "
3367 "from transport process %d for transport %s: error decoding size from header",
3368 pid, addr->transport->driver_name);
bd21a787
WB
3369 done = TRUE;
3370 break;
3371 }
2cee425a 3372 }
bd21a787
WB
3373
3374 DEBUG(D_deliver)
7845dbb3 3375 debug_printf("expect %lu bytes (pipedata) from transport process %d\n",
0d68983b 3376 (u_long)required, pid);
2c0f3ea1 3377
2cee425a
HSHR
3378 /* Same as above, the transport process will write the bytes announced
3379 in a timely manner, so we can just wait for the bytes, getting less than expected
3380 is considered a problem of the subprocess, we do not expect anything else from it. */
ee250936 3381 if ((got = readn(fd, big_buffer, required)) != required)
8fa0a4d4 3382 {
bb07bcd3
JH
3383 msg = string_sprintf("got only " SSIZE_T_FMT " of " SIZE_T_FMT
3384 " bytes (pipedata) from transport process %d for transport %s",
3385 got, required, pid, addr->transport->driver_name);
3386 done = TRUE;
3387 break;
8fa0a4d4 3388 }
bd21a787 3389
059ec3d9
PH
3390 /* Handle each possible type of item, assuming the complete item is
3391 available in store. */
3392
2cee425a 3393 switch (*id)
059ec3d9
PH
3394 {
3395 /* Host items exist only if any hosts were marked unusable. Match
3396 up by checking the IP address. */
3397
3398 case 'H':
57cc2785
JH
3399 for (h = addrlist->host_list; h; h = h->next)
3400 {
3401 if (!h->address || Ustrcmp(h->address, ptr+2) != 0) continue;
3402 h->status = ptr[0];
3403 h->why = ptr[1];
3404 }
3405 ptr += 2;
3406 while (*ptr++);
3407 break;
059ec3d9
PH
3408
3409 /* Retry items are sent in a preceding R item for each address. This is
3410 kept separate to keep each message short enough to guarantee it won't
3411 be split in the pipe. Hopefully, in the majority of cases, there won't in
3412 fact be any retry items at all.
3413
3414 The complete set of retry items might include an item to delete a
3415 routing retry if there was a previous routing delay. However, routing
3416 retries are also used when a remote transport identifies an address error.
3417 In that case, there may also be an "add" item for the same key. Arrange
3418 that a "delete" item is dropped in favour of an "add" item. */
3419
3420 case 'R':
57cc2785 3421 if (!addr) goto ADDR_MISMATCH;
059ec3d9 3422
57cc2785
JH
3423 DEBUG(D_deliver|D_retry)
3424 debug_printf("reading retry information for %s from subprocess\n",
3425 ptr+1);
059ec3d9 3426
57cc2785 3427 /* Cut out any "delete" items on the list. */
059ec3d9 3428
57cc2785
JH
3429 for (rp = &addr->retries; (r = *rp); rp = &r->next)
3430 if (Ustrcmp(r->key, ptr+1) == 0) /* Found item with same key */
3431 {
3432 if (!(r->flags & rf_delete)) break; /* It was not "delete" */
3433 *rp = r->next; /* Excise a delete item */
3434 DEBUG(D_deliver|D_retry)
3435 debug_printf(" existing delete item dropped\n");
3436 }
059ec3d9 3437
57cc2785
JH
3438 /* We want to add a delete item only if there is no non-delete item;
3439 however we still have to step ptr through the data. */
059ec3d9 3440
57cc2785
JH
3441 if (!r || !(*ptr & rf_delete))
3442 {
f3ebb786 3443 r = store_get(sizeof(retry_item), FALSE);
57cc2785
JH
3444 r->next = addr->retries;
3445 addr->retries = r;
3446 r->flags = *ptr++;
3447 r->key = string_copy(ptr);
3448 while (*ptr++);
32dfdf8b 3449 memcpy(&r->basic_errno, ptr, sizeof(r->basic_errno));
57cc2785 3450 ptr += sizeof(r->basic_errno);
32dfdf8b 3451 memcpy(&r->more_errno, ptr, sizeof(r->more_errno));
57cc2785
JH
3452 ptr += sizeof(r->more_errno);
3453 r->message = *ptr ? string_copy(ptr) : NULL;
3454 DEBUG(D_deliver|D_retry) debug_printf(" added %s item\n",
3455 r->flags & rf_delete ? "delete" : "retry");
3456 }
059ec3d9 3457
57cc2785
JH
3458 else
3459 {
3460 DEBUG(D_deliver|D_retry)
3461 debug_printf(" delete item not added: non-delete item exists\n");
3462 ptr++;
3463 while(*ptr++);
3464 ptr += sizeof(r->basic_errno) + sizeof(r->more_errno);
3465 }
059ec3d9 3466
57cc2785
JH
3467 while(*ptr++);
3468 break;
059ec3d9
PH
3469
3470 /* Put the amount of data written into the parlist block */
3471
3472 case 'S':
57cc2785
JH
3473 memcpy(&(p->transport_count), ptr, sizeof(transport_count));
3474 ptr += sizeof(transport_count);
3475 break;
059ec3d9
PH
3476
3477 /* Address items are in the order of items on the address chain. We
3478 remember the current address value in case this function is called
3479 several times to empty the pipe in stages. Information about delivery
3480 over TLS is sent in a preceding X item for each address. We don't put
3481 it in with the other info, in order to keep each message short enough to
3482 guarantee it won't be split in the pipe. */
3483
01603eec 3484#ifndef DISABLE_TLS
059ec3d9 3485 case 'X':
57cc2785 3486 if (!addr) goto ADDR_MISMATCH; /* Below, in 'A' handler */
2cee425a 3487 switch (*subid)
57cc2785
JH
3488 {
3489 case '1':
da40b1ec 3490 addr->tlsver = addr->cipher = addr->peerdn = NULL;
9d1c15ef 3491
57cc2785 3492 if (*ptr)
da40b1ec 3493 {
57cc2785 3494 addr->cipher = string_copy(ptr);
da40b1ec
JH
3495 addr->tlsver = string_copyn(ptr, Ustrchr(ptr, ':') - ptr);
3496 }
57cc2785
JH
3497 while (*ptr++);
3498 if (*ptr)
3499 addr->peerdn = string_copy(ptr);
3500 break;
3501
3502 case '2':
3503 if (*ptr)
3504 (void) tls_import_cert(ptr, &addr->peercert);
3505 else
3506 addr->peercert = NULL;
3507 break;
3508
3509 case '3':
3510 if (*ptr)
3511 (void) tls_import_cert(ptr, &addr->ourcert);
3512 else
3513 addr->ourcert = NULL;
3514 break;
018058b2 3515
a7538db1 3516# ifndef DISABLE_OCSP
57cc2785
JH
3517 case '4':
3518 addr->ocsp = *ptr ? *ptr - '0' : OCSP_NOT_REQ;
3519 break;
a7538db1 3520# endif
57cc2785
JH
3521 }
3522 while (*ptr++);
3523 break;