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