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