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