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