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