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