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