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