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