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